xref: /freebsd-14.2/sys/dev/beri/virtio/virtio.c (revision ac0776ec)
1 /*-
2  * Copyright (c) 2014 Ruslan Bukin <[email protected]>
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/cdefs.h>
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/bus.h>
39 #include <sys/cdefs.h>
40 #include <sys/kernel.h>
41 #include <sys/module.h>
42 #include <sys/malloc.h>
43 #include <sys/rman.h>
44 #include <sys/timeet.h>
45 #include <sys/timetc.h>
46 #include <sys/conf.h>
47 #include <sys/uio.h>
48 #include <sys/stat.h>
49 #include <sys/time.h>
50 #include <sys/event.h>
51 #include <sys/selinfo.h>
52 #include <sys/endian.h>
53 #include <sys/rwlock.h>
54 
55 #include <machine/bus.h>
56 #include <machine/fdt.h>
57 #include <machine/cpu.h>
58 #include <machine/intr.h>
59 
60 #include <dev/fdt/fdt_common.h>
61 #include <dev/ofw/openfirm.h>
62 #include <dev/ofw/ofw_bus.h>
63 #include <dev/ofw/ofw_bus_subr.h>
64 
65 #include <dev/beri/virtio/virtio.h>
66 #include <dev/virtio/virtqueue.h>
67 #include <dev/virtio/virtio_ring.h>
68 #include <dev/altera/pio/pio.h>
69 
70 #include "pio_if.h"
71 
72 int
73 vq_ring_ready(struct vqueue_info *vq)
74 {
75 
76 	return (vq->vq_flags & VQ_ALLOC);
77 }
78 
79 int
80 vq_has_descs(struct vqueue_info *vq)
81 {
82 
83 	return (vq_ring_ready(vq) && vq->vq_last_avail !=
84 		be16toh(vq->vq_avail->idx));
85 }
86 
87 void *
88 paddr_map(uint32_t offset, uint32_t phys, uint32_t size)
89 {
90 	bus_space_handle_t bsh;
91 
92 	if (bus_space_map(fdtbus_bs_tag, (phys + offset),
93 			size, 0, &bsh) != 0) {
94 		panic("Couldn't map 0x%08x\n", (phys + offset));
95 	}
96 
97 	return (void *)(bsh);
98 }
99 
100 void
101 paddr_unmap(void *phys, uint32_t size)
102 {
103 
104 	bus_space_unmap(fdtbus_bs_tag, (bus_space_handle_t)phys, size);
105 }
106 
107 static inline void
108 _vq_record(uint32_t offs, int i, volatile struct vring_desc *vd,
109 	struct iovec *iov, int n_iov, uint16_t *flags) {
110 	if (i >= n_iov)
111 		return;
112 
113 	iov[i].iov_base = paddr_map(offs, be64toh(vd->addr),
114 				be32toh(vd->len));
115 	iov[i].iov_len = be32toh(vd->len);
116 	if (flags != NULL)
117 		flags[i] = be16toh(vd->flags);
118 }
119 
120 int
121 vq_getchain(uint32_t offs, struct vqueue_info *vq,
122 	struct iovec *iov, int n_iov, uint16_t *flags)
123 {
124 	volatile struct vring_desc *vdir, *vindir, *vp;
125 	int idx, ndesc, n_indir;
126 	int head, next;
127 	int i;
128 
129 	idx = vq->vq_last_avail;
130 	ndesc = (be16toh(vq->vq_avail->idx) - idx);
131 	if (ndesc == 0)
132 		return (0);
133 
134 	head = be16toh(vq->vq_avail->ring[idx & (vq->vq_qsize - 1)]);
135 	next = head;
136 
137 	for (i = 0; i < VQ_MAX_DESCRIPTORS; next = be16toh(vdir->next)) {
138 		vdir = &vq->vq_desc[next];
139 		if ((be16toh(vdir->flags) & VRING_DESC_F_INDIRECT) == 0) {
140 			_vq_record(offs, i, vdir, iov, n_iov, flags);
141 			i++;
142 		} else {
143 			n_indir = be32toh(vdir->len) / 16;
144 			vindir = paddr_map(offs, be64toh(vdir->addr),
145 					be32toh(vdir->len));
146 			next = 0;
147 			for (;;) {
148 				vp = &vindir[next];
149 				_vq_record(offs, i, vp, iov, n_iov, flags);
150 				i+=1;
151 				if ((be16toh(vp->flags) & \
152 					VRING_DESC_F_NEXT) == 0)
153 					break;
154 				next = be16toh(vp->next);
155 			}
156 			paddr_unmap(__DEVOLATILE(void *, vindir), be32toh(vdir->len));
157 		}
158 
159 		if ((be16toh(vdir->flags) & VRING_DESC_F_NEXT) == 0)
160 			return (i);
161 	}
162 
163 	return (i);
164 }
165 
166 void
167 vq_relchain(struct vqueue_info *vq, struct iovec *iov, int n, uint32_t iolen)
168 {
169 	volatile struct vring_used_elem *vue;
170 	volatile struct vring_used *vu;
171 	uint16_t head, uidx, mask;
172 	int i;
173 
174 	mask = vq->vq_qsize - 1;
175 	vu = vq->vq_used;
176 	head = be16toh(vq->vq_avail->ring[vq->vq_last_avail++ & mask]);
177 
178 	uidx = be16toh(vu->idx);
179 	vue = &vu->ring[uidx++ & mask];
180 	vue->id = htobe32(head);
181 
182 	vue->len = htobe32(iolen);
183 	vu->idx = htobe16(uidx);
184 
185 	/* Clean up */
186 	for (i = 0; i < n; i++) {
187 		paddr_unmap((void *)iov[i].iov_base, iov[i].iov_len);
188 	}
189 }
190 
191 int
192 setup_pio(device_t dev, char *name, device_t *pio_dev)
193 {
194 	phandle_t pio_node;
195 	struct fdt_ic *ic;
196 	phandle_t xref;
197 	phandle_t node;
198 
199 	if ((node = ofw_bus_get_node(dev)) == -1)
200 		return (ENXIO);
201 
202 	if (OF_searchencprop(node, name, &xref,
203 		sizeof(xref)) == -1) {
204 		return (ENXIO);
205 	}
206 
207 	pio_node = OF_node_from_xref(xref);
208 	SLIST_FOREACH(ic, &fdt_ic_list_head, fdt_ics) {
209 		if (ic->iph == pio_node) {
210 			*pio_dev = ic->dev;
211 			return (0);
212 		}
213 	}
214 
215 	return (ENXIO);
216 }
217 
218 int
219 setup_offset(device_t dev, uint32_t *offset)
220 {
221 	pcell_t dts_value[2];
222 	phandle_t mem_node;
223 	phandle_t xref;
224 	phandle_t node;
225 	int len;
226 
227 	if ((node = ofw_bus_get_node(dev)) == -1)
228 		return (ENXIO);
229 
230 	if (OF_searchencprop(node, "beri-mem", &xref,
231 		sizeof(xref)) == -1) {
232 		return (ENXIO);
233 	}
234 
235 	mem_node = OF_node_from_xref(xref);
236 	if ((len = OF_getproplen(mem_node, "reg")) <= 0)
237 		return (ENXIO);
238 	OF_getencprop(mem_node, "reg", dts_value, len);
239 	*offset = dts_value[0];
240 
241 	return (0);
242 }
243 
244 struct iovec *
245 getcopy(struct iovec *iov, int n)
246 {
247 	struct iovec *tiov;
248 	int i;
249 
250 	tiov = malloc(n * sizeof(struct iovec), M_DEVBUF, M_NOWAIT);
251 	for (i = 0; i < n; i++) {
252 		tiov[i].iov_base = iov[i].iov_base;
253 		tiov[i].iov_len = iov[i].iov_len;
254 	}
255 
256 	return (tiov);
257 }
258