xref: /netbsd-src/sys/dev/pci/viornd.c (revision e89934bbf778a6d6d6894877c4da59d0c7835b0f)
1 /* 	$NetBSD: viornd.c,v 1.10 2016/11/30 01:36:38 christos Exp $ */
2 /*	$OpenBSD: viornd.c,v 1.1 2014/01/21 21:14:58 sf Exp $	*/
3 
4 /*
5  * Copyright (c) 2014 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Thor Lancelot Simon (tls@NetBSD.org).
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 2014 Stefan Fritsch <sf@sfritsch.de>
35  *
36  * Permission to use, copy, modify, and distribute this software for any
37  * purpose with or without fee is hereby granted, provided that the above
38  * copyright notice and this permission notice appear in all copies.
39  *
40  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
41  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
42  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
43  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
44  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
45  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
46  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
47  */
48 
49 #include <sys/param.h>
50 #include <sys/systm.h>
51 #include <sys/kernel.h>
52 #include <sys/device.h>
53 #include <sys/callout.h>
54 #include <sys/rndsource.h>
55 #include <sys/mutex.h>
56 #include <dev/pci/pcidevs.h>
57 #include <dev/pci/pcivar.h>
58 #include <dev/pci/pcivar.h>
59 #include <dev/pci/virtioreg.h>
60 #include <dev/pci/virtiovar.h>
61 
62 #define	VIORND_BUFSIZE			32
63 
64 #define VIORND_DEBUG 0
65 
66 struct viornd_softc {
67 	device_t		sc_dev;
68 	struct virtio_softc	*sc_virtio;
69 
70 	kmutex_t		sc_mutex;
71 	bool			sc_active;
72 
73 	void			*sc_buf;
74 	struct virtqueue	sc_vq;
75 	bus_dmamap_t		sc_dmamap;
76 	krndsource_t		sc_rndsource;
77 };
78 
79 int	viornd_match(device_t, cfdata_t, void *);
80 void	viornd_attach(device_t, device_t, void *);
81 int	viornd_vq_done(struct virtqueue *);
82 
83 CFATTACH_DECL_NEW(viornd, sizeof(struct viornd_softc),
84 		  viornd_match, viornd_attach, NULL, NULL);
85 
86 static void
87 viornd_get(size_t bytes, void *priv)
88 {
89         struct viornd_softc *sc = priv;
90         struct virtio_softc *vsc = sc->sc_virtio;
91         struct virtqueue *vq = &sc->sc_vq;
92         int slot;
93 
94 #if VIORND_DEBUG
95 	aprint_normal("%s: asked for %d bytes of entropy\n", __func__,
96 		      VIORND_BUFSIZE);
97 #endif
98 	mutex_enter(&sc->sc_mutex);
99 
100 	if (sc->sc_active) {
101 		goto out;
102 	}
103 
104         bus_dmamap_sync(vsc->sc_dmat, sc->sc_dmamap, 0, VIORND_BUFSIZE,
105             BUS_DMASYNC_PREREAD);
106 	if (virtio_enqueue_prep(vsc, vq, &slot)) {
107 		goto out;
108 	}
109         if (virtio_enqueue_reserve(vsc, vq, slot, 1)) {
110 		goto out;
111 	}
112         virtio_enqueue(vsc, vq, slot, sc->sc_dmamap, 0);
113         virtio_enqueue_commit(vsc, vq, slot, 1);
114 	sc->sc_active = true;
115 out:
116 	mutex_exit(&sc->sc_mutex);
117 }
118 
119 int
120 viornd_match(device_t parent, cfdata_t match, void *aux)
121 {
122 	struct virtio_softc *va = aux;
123 	if (va->sc_childdevid == PCI_PRODUCT_VIRTIO_ENTROPY)
124 		return 1;
125 	return 0;
126 }
127 
128 void
129 viornd_attach( device_t parent, device_t self, void *aux)
130 {
131 	struct viornd_softc *sc = device_private(self);
132 	struct virtio_softc *vsc = device_private(parent);
133 	bus_dma_segment_t segs[1];
134 	int nsegs;
135 	int error;
136 	uint32_t features;
137 	char buf[256];
138 
139 	vsc->sc_vqs = &sc->sc_vq;
140 	vsc->sc_nvqs = 1;
141 	vsc->sc_config_change = NULL;
142 	if (vsc->sc_child != NULL)
143 		panic("already attached to something else");
144 	vsc->sc_child = self;
145 	vsc->sc_ipl = IPL_NET;
146 	vsc->sc_intrhand = virtio_vq_intr;
147 	sc->sc_virtio = vsc;
148 	sc->sc_dev = self;
149 
150 	features = virtio_negotiate_features(vsc, 0);
151 	snprintb(buf, sizeof(buf), VIRTIO_COMMON_FLAG_BITS, features);
152 	aprint_normal(": Features: %s\n", buf);
153 	aprint_naive("\n");
154 
155 
156 	mutex_init(&sc->sc_mutex, MUTEX_DEFAULT, IPL_VM);
157 
158 	error = bus_dmamem_alloc(vsc->sc_dmat,
159 				 VIRTIO_PAGE_SIZE, 0, 0, segs, 1, &nsegs,
160 				 BUS_DMA_NOWAIT|BUS_DMA_ALLOCNOW);
161 	if (error) {
162 		aprint_error_dev(sc->sc_dev, "can't alloc dmamem: %d\n",
163 				 error);
164 		goto alloc_failed;
165 	}
166 
167 	error = bus_dmamem_map(vsc->sc_dmat, segs, nsegs, VIORND_BUFSIZE,
168 			       &sc->sc_buf, BUS_DMA_NOWAIT);
169 	if (error) {
170 		aprint_error_dev(sc->sc_dev, "can't map dmamem: %d\n", error);
171 		goto map_failed;
172 	}
173 
174 	error = bus_dmamap_create(vsc->sc_dmat, VIORND_BUFSIZE, 1,
175 				  VIORND_BUFSIZE, 0,
176 				  BUS_DMA_NOWAIT|BUS_DMA_ALLOCNOW,
177 				  &sc->sc_dmamap);
178 	if (error) {
179 		aprint_error_dev(sc->sc_dev, "can't alloc dmamap: %d\n",
180 				 error);
181 		goto create_failed;
182 	}
183 
184 	error = bus_dmamap_load(vsc->sc_dmat, sc->sc_dmamap,
185 	    			sc->sc_buf, VIORND_BUFSIZE, NULL,
186 				BUS_DMA_NOWAIT|BUS_DMA_READ);
187 	if (error) {
188 		aprint_error_dev(sc->sc_dev, "can't load dmamap: %d\n",
189 				 error);
190 		goto load_failed;
191 	}
192 
193 	error = virtio_alloc_vq(vsc, &sc->sc_vq, 0, VIORND_BUFSIZE, 1,
194 	    "Entropy request");
195 	if (error) {
196 		aprint_error_dev(sc->sc_dev, "can't alloc virtqueue: %d\n",
197 				 error);
198 		goto vio_failed;
199 	}
200 
201 	sc->sc_vq.vq_done = viornd_vq_done;
202 	virtio_start_vq_intr(vsc, &sc->sc_vq);
203 	rndsource_setcb(&sc->sc_rndsource, viornd_get, sc);
204 	rnd_attach_source(&sc->sc_rndsource, device_xname(sc->sc_dev),
205 			  RND_TYPE_RNG,
206 			  RND_FLAG_COLLECT_VALUE|RND_FLAG_HASCB);
207 	viornd_get(VIORND_BUFSIZE, sc);
208 	return;
209 vio_failed:
210 	bus_dmamap_unload(vsc->sc_dmat, sc->sc_dmamap);
211 load_failed:
212 	bus_dmamap_destroy(vsc->sc_dmat, sc->sc_dmamap);
213 create_failed:
214 	bus_dmamem_unmap(vsc->sc_dmat, sc->sc_buf, VIORND_BUFSIZE);
215 map_failed:
216 	bus_dmamem_free(vsc->sc_dmat, segs, nsegs);
217 alloc_failed:
218 	vsc->sc_child = (void *)1;	/* XXX bare constant 1 */
219 	return;
220 }
221 
222 int
223 viornd_vq_done(struct virtqueue *vq)
224 {
225 	struct virtio_softc *vsc = vq->vq_owner;
226 	struct viornd_softc *sc = device_private(vsc->sc_child);
227 	int slot, len;
228 
229 	mutex_enter(&sc->sc_mutex);
230 
231 	if (virtio_dequeue(vsc, vq, &slot, &len) != 0) {
232 		mutex_exit(&sc->sc_mutex);
233 		return 0;
234 	}
235 
236 	sc->sc_active = false;
237 
238 	bus_dmamap_sync(vsc->sc_dmat, sc->sc_dmamap, 0, VIORND_BUFSIZE,
239 	    BUS_DMASYNC_POSTREAD);
240 	if (len > VIORND_BUFSIZE) {
241 		aprint_error_dev(sc->sc_dev,
242 				 "inconsistent descriptor length %d > %d\n",
243 				 len, VIORND_BUFSIZE);
244 		goto out;
245 	}
246 
247 #if VIORND_DEBUG
248 	aprint_normal("%s: got %d bytes of entropy\n", __func__, len);
249 #endif
250 	rnd_add_data(&sc->sc_rndsource, sc->sc_buf, VIORND_BUFSIZE,
251 		     VIORND_BUFSIZE * NBBY);
252 out:
253 	virtio_dequeue_commit(vsc, vq, slot);
254 	mutex_exit(&sc->sc_mutex);
255 
256 	return 1;
257 }
258