xref: /freebsd/sys/dev/beri/virtio/virtio.c (revision e0c4386e7e71d93b0edc0c8fa156263fc4a8b0b6)
1 /*-
2  * Copyright (c) 2014 Ruslan Bukin <br@bsdpad.com>
3  * All rights reserved.
4  *
5  * This software was developed by SRI International and the University of
6  * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
7  * ("CTSRD"), as part of the DARPA CRASH research programme.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 /*
32  * BERI virtio mmio backend common methods
33  */
34 
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/bus.h>
38 #include <sys/cdefs.h>
39 #include <sys/kernel.h>
40 #include <sys/module.h>
41 #include <sys/malloc.h>
42 #include <sys/rman.h>
43 #include <sys/timeet.h>
44 #include <sys/timetc.h>
45 #include <sys/conf.h>
46 #include <sys/uio.h>
47 #include <sys/stat.h>
48 #include <sys/time.h>
49 #include <sys/event.h>
50 #include <sys/selinfo.h>
51 #include <sys/endian.h>
52 #include <sys/rwlock.h>
53 
54 #include <machine/bus.h>
55 #include <machine/fdt.h>
56 #include <machine/cpu.h>
57 #include <machine/intr.h>
58 
59 #include <dev/fdt/fdt_common.h>
60 #include <dev/ofw/openfirm.h>
61 #include <dev/ofw/ofw_bus.h>
62 #include <dev/ofw/ofw_bus_subr.h>
63 
64 #include <dev/beri/virtio/virtio.h>
65 #include <dev/virtio/virtqueue.h>
66 #include <dev/virtio/virtio_ring.h>
67 #include <dev/altera/pio/pio.h>
68 
69 #include "pio_if.h"
70 
71 int
72 vq_ring_ready(struct vqueue_info *vq)
73 {
74 
75 	return (vq->vq_flags & VQ_ALLOC);
76 }
77 
78 int
79 vq_has_descs(struct vqueue_info *vq)
80 {
81 
82 	return (vq_ring_ready(vq) && vq->vq_last_avail !=
83 		be16toh(vq->vq_avail->idx));
84 }
85 
86 void *
87 paddr_map(uint32_t offset, uint32_t phys, uint32_t size)
88 {
89 	bus_space_handle_t bsh;
90 
91 	if (bus_space_map(fdtbus_bs_tag, (phys + offset),
92 			size, 0, &bsh) != 0) {
93 		panic("Couldn't map 0x%08x\n", (phys + offset));
94 	}
95 
96 	return (void *)(bsh);
97 }
98 
99 void
100 paddr_unmap(void *phys, uint32_t size)
101 {
102 
103 	bus_space_unmap(fdtbus_bs_tag, (bus_space_handle_t)phys, size);
104 }
105 
106 static inline void
107 _vq_record(uint32_t offs, int i, volatile struct vring_desc *vd,
108 	struct iovec *iov, int n_iov, uint16_t *flags) {
109 	if (i >= n_iov)
110 		return;
111 
112 	iov[i].iov_base = paddr_map(offs, be64toh(vd->addr),
113 				be32toh(vd->len));
114 	iov[i].iov_len = be32toh(vd->len);
115 	if (flags != NULL)
116 		flags[i] = be16toh(vd->flags);
117 }
118 
119 int
120 vq_getchain(uint32_t offs, struct vqueue_info *vq,
121 	struct iovec *iov, int n_iov, uint16_t *flags)
122 {
123 	volatile struct vring_desc *vdir, *vindir, *vp;
124 	int idx, ndesc, n_indir;
125 	int head, next;
126 	int i;
127 
128 	idx = vq->vq_last_avail;
129 	ndesc = (be16toh(vq->vq_avail->idx) - idx);
130 	if (ndesc == 0)
131 		return (0);
132 
133 	head = be16toh(vq->vq_avail->ring[idx & (vq->vq_qsize - 1)]);
134 	next = head;
135 
136 	for (i = 0; i < VQ_MAX_DESCRIPTORS; next = be16toh(vdir->next)) {
137 		vdir = &vq->vq_desc[next];
138 		if ((be16toh(vdir->flags) & VRING_DESC_F_INDIRECT) == 0) {
139 			_vq_record(offs, i, vdir, iov, n_iov, flags);
140 			i++;
141 		} else {
142 			n_indir = be32toh(vdir->len) / 16;
143 			vindir = paddr_map(offs, be64toh(vdir->addr),
144 					be32toh(vdir->len));
145 			next = 0;
146 			for (;;) {
147 				vp = &vindir[next];
148 				_vq_record(offs, i, vp, iov, n_iov, flags);
149 				i+=1;
150 				if ((be16toh(vp->flags) & \
151 					VRING_DESC_F_NEXT) == 0)
152 					break;
153 				next = be16toh(vp->next);
154 			}
155 			paddr_unmap(__DEVOLATILE(void *, vindir), be32toh(vdir->len));
156 		}
157 
158 		if ((be16toh(vdir->flags) & VRING_DESC_F_NEXT) == 0)
159 			return (i);
160 	}
161 
162 	return (i);
163 }
164 
165 void
166 vq_relchain(struct vqueue_info *vq, struct iovec *iov, int n, uint32_t iolen)
167 {
168 	volatile struct vring_used_elem *vue;
169 	volatile struct vring_used *vu;
170 	uint16_t head, uidx, mask;
171 	int i;
172 
173 	mask = vq->vq_qsize - 1;
174 	vu = vq->vq_used;
175 	head = be16toh(vq->vq_avail->ring[vq->vq_last_avail++ & mask]);
176 
177 	uidx = be16toh(vu->idx);
178 	vue = &vu->ring[uidx++ & mask];
179 	vue->id = htobe32(head);
180 
181 	vue->len = htobe32(iolen);
182 	vu->idx = htobe16(uidx);
183 
184 	/* Clean up */
185 	for (i = 0; i < n; i++) {
186 		paddr_unmap((void *)iov[i].iov_base, iov[i].iov_len);
187 	}
188 }
189 
190 int
191 setup_pio(device_t dev, char *name, device_t *pio_dev)
192 {
193 	phandle_t pio_node;
194 	struct fdt_ic *ic;
195 	phandle_t xref;
196 	phandle_t node;
197 
198 	if ((node = ofw_bus_get_node(dev)) == -1)
199 		return (ENXIO);
200 
201 	if (OF_searchencprop(node, name, &xref,
202 		sizeof(xref)) == -1) {
203 		return (ENXIO);
204 	}
205 
206 	pio_node = OF_node_from_xref(xref);
207 	SLIST_FOREACH(ic, &fdt_ic_list_head, fdt_ics) {
208 		if (ic->iph == pio_node) {
209 			*pio_dev = ic->dev;
210 			return (0);
211 		}
212 	}
213 
214 	return (ENXIO);
215 }
216 
217 int
218 setup_offset(device_t dev, uint32_t *offset)
219 {
220 	pcell_t dts_value[2];
221 	phandle_t mem_node;
222 	phandle_t xref;
223 	phandle_t node;
224 	int len;
225 
226 	if ((node = ofw_bus_get_node(dev)) == -1)
227 		return (ENXIO);
228 
229 	if (OF_searchencprop(node, "beri-mem", &xref,
230 		sizeof(xref)) == -1) {
231 		return (ENXIO);
232 	}
233 
234 	mem_node = OF_node_from_xref(xref);
235 	if ((len = OF_getproplen(mem_node, "reg")) <= 0)
236 		return (ENXIO);
237 	OF_getencprop(mem_node, "reg", dts_value, len);
238 	*offset = dts_value[0];
239 
240 	return (0);
241 }
242 
243 struct iovec *
244 getcopy(struct iovec *iov, int n)
245 {
246 	struct iovec *tiov;
247 	int i;
248 
249 	tiov = malloc(n * sizeof(struct iovec), M_DEVBUF, M_NOWAIT);
250 	for (i = 0; i < n; i++) {
251 		tiov[i].iov_base = iov[i].iov_base;
252 		tiov[i].iov_len = iov[i].iov_len;
253 	}
254 
255 	return (tiov);
256 }
257