2 * Copyright (c) 2014 Ruslan Bukin <br@bsdpad.com>
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.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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
32 * SRI-Cambridge BERI soft processor <-> ARM core ring buffer.
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
38 #include <sys/param.h>
39 #include <sys/systm.h>
41 #include <sys/kernel.h>
42 #include <sys/module.h>
43 #include <sys/malloc.h>
45 #include <sys/timeet.h>
46 #include <sys/timetc.h>
51 #include <sys/event.h>
52 #include <sys/selinfo.h>
54 #include <dev/fdt/fdt_common.h>
55 #include <dev/ofw/openfirm.h>
56 #include <dev/ofw/ofw_bus.h>
57 #include <dev/ofw/ofw_bus_subr.h>
59 #include <machine/bus.h>
60 #include <machine/fdt.h>
61 #include <machine/cpu.h>
62 #include <machine/intr.h>
64 #define READ4(_sc, _reg) \
65 bus_read_4((_sc)->res[0], _reg)
66 #define WRITE4(_sc, _reg, _val) \
67 bus_write_4((_sc)->res[0], _reg, _val)
69 #define CDES_INT_EN (1 << 15)
70 #define CDES_CAUSE_MASK 0x3
71 #define CDES_CAUSE_SHIFT 13
72 #define DEVNAME_MAXLEN 256
77 uint16_t interrupt_level;
83 struct resource *res[3];
85 bus_space_handle_t bsh;
90 struct selinfo beri_rsel;
94 char devname[DEVNAME_MAXLEN];
102 static struct resource_spec beri_spec[] = {
103 { SYS_RES_MEMORY, 0, RF_ACTIVE },
104 { SYS_RES_IRQ, 0, RF_ACTIVE },
105 { SYS_RES_IRQ, 1, RF_ACTIVE },
110 get_control_reg(struct beri_softc *sc, int dir)
120 offset = dir ? sc->control_write : sc->control_read;
121 ((uint32_t *)dst)[0] = READ4(sc, offset);
122 ((uint32_t *)dst)[1] = READ4(sc, offset + 4);
124 for (i = 0; i < 4; i++)
131 set_control_reg(struct beri_softc *sc, int dir, control_reg_t *c)
140 for (i = 0; i < 4; i++)
143 offset = dir ? sc->control_write : sc->control_read;
144 WRITE4(sc, offset + 0, ((uint32_t *)src)[0]);
145 WRITE4(sc, offset + 4, ((uint32_t *)src)[1]);
149 get_stock(struct beri_softc *sc, int dir, control_reg_t *c)
153 fill = (c->in - c->out + sc->data_size) % sc->data_size;
156 return (sc->data_size - fill - 1);
162 beri_intr_write(void *arg)
164 struct beri_softc *sc;
169 c = get_control_reg(sc, 1);
170 if (c.cdes & CDES_INT_EN) {
171 c.cdes &= ~(CDES_INT_EN);
172 set_control_reg(sc, 1, &c);
175 mtx_lock(&sc->beri_mtx);
176 selwakeuppri(&sc->beri_rsel, PZERO + 1);
177 KNOTE_LOCKED(&sc->beri_rsel.si_note, 0);
178 mtx_unlock(&sc->beri_mtx);
182 beri_intr_read(void *arg)
184 struct beri_softc *sc;
189 c = get_control_reg(sc, 0);
190 if (c.cdes & CDES_INT_EN) {
191 c.cdes &= ~(CDES_INT_EN);
192 set_control_reg(sc, 0, &c);
195 mtx_lock(&sc->beri_mtx);
196 selwakeuppri(&sc->beri_rsel, PZERO + 1);
197 KNOTE_LOCKED(&sc->beri_rsel.si_note, 0);
198 mtx_unlock(&sc->beri_mtx);
202 beri_open(struct cdev *dev, int flags __unused,
203 int fmt __unused, struct thread *td __unused)
205 struct beri_softc *sc;
213 /* Setup interrupt handlers */
214 if (bus_setup_intr(sc->dev, sc->res[1], INTR_TYPE_BIO | INTR_MPSAFE,
215 NULL, beri_intr_read, sc, &sc->read_ih)) {
216 device_printf(sc->dev, "Unable to setup read intr\n");
219 if (bus_setup_intr(sc->dev, sc->res[2], INTR_TYPE_BIO | INTR_MPSAFE,
220 NULL, beri_intr_write, sc, &sc->write_ih)) {
221 device_printf(sc->dev, "Unable to setup write intr\n");
227 /* Clear write buffer */
228 c = get_control_reg(sc, 1);
231 set_control_reg(sc, 1, &c);
233 /* Clear read buffer */
234 c = get_control_reg(sc, 0);
237 set_control_reg(sc, 0, &c);
243 beri_close(struct cdev *dev, int flags __unused,
244 int fmt __unused, struct thread *td __unused)
246 struct beri_softc *sc;
253 /* Unsetup interrupt handlers */
254 bus_teardown_intr(sc->dev, sc->res[1], sc->read_ih);
255 bus_teardown_intr(sc->dev, sc->res[2], sc->write_ih);
262 beri_rdwr(struct cdev *dev, struct uio *uio, int ioflag)
264 struct beri_softc *sc;
276 dir = uio->uio_rw ? 1 : 0;
278 c = get_control_reg(sc, dir);
279 stock = get_stock(sc, dir, &c);
280 if (stock < uio->uio_resid) {
281 device_printf(sc->dev, "Err: no data/space available\n");
285 amount = uio->uio_resid;
286 ptr = dir ? &c.in : &c.out;
287 count = (sc->data_size - *ptr);
289 offset = dir ? sc->data_write : sc->data_read;
290 dst = (uint8_t *)(sc->bsh + offset);
292 if (amount <= count) {
293 uiomove(dst + *ptr, amount, uio);
295 uiomove(dst + *ptr, count, uio);
296 uiomove(dst, (amount - count), uio);
299 *ptr = (*ptr + amount) % sc->data_size;
300 set_control_reg(sc, dir, &c);
306 beri_kqread(struct knote *kn, long hint)
308 struct beri_softc *sc;
314 c = get_control_reg(sc, 0);
315 stock = get_stock(sc, 0, &c);
323 /* Wait at least one new byte in buffer */
324 c.interrupt_level = 1;
326 /* Enable interrupts */
327 c.cdes |= (CDES_INT_EN);
328 set_control_reg(sc, 0, &c);
334 beri_kqwrite(struct knote *kn, long hint)
336 struct beri_softc *sc;
342 c = get_control_reg(sc, 1);
343 stock = get_stock(sc, 1, &c);
351 /* Wait at least one free position in buffer */
352 c.interrupt_level = sc->data_size - 2;
354 /* Enable interrupts */
355 c.cdes |= (CDES_INT_EN);
356 set_control_reg(sc, 1, &c);
362 beri_kqdetach(struct knote *kn)
364 struct beri_softc *sc;
368 knlist_remove(&sc->beri_rsel.si_note, kn, 0);
371 static struct filterops beri_read_filterops = {
374 .f_detach = beri_kqdetach,
375 .f_event = beri_kqread,
378 static struct filterops beri_write_filterops = {
381 .f_detach = beri_kqdetach,
382 .f_event = beri_kqwrite,
386 beri_kqfilter(struct cdev *dev, struct knote *kn)
388 struct beri_softc *sc;
392 switch(kn->kn_filter) {
394 kn->kn_fop = &beri_read_filterops;
397 kn->kn_fop = &beri_write_filterops;
404 knlist_add(&sc->beri_rsel.si_note, kn, 0);
409 static struct cdevsw beri_cdevsw = {
410 .d_version = D_VERSION,
412 .d_close = beri_close,
413 .d_write = beri_rdwr,
415 .d_kqfilter = beri_kqfilter,
416 .d_name = "beri ring buffer",
420 parse_fdt(struct beri_softc *sc)
422 pcell_t dts_value[0];
426 if ((node = ofw_bus_get_node(sc->dev)) == -1)
429 /* get device name */
430 if (OF_getprop(ofw_bus_get_node(sc->dev), "device_name",
431 &sc->devname, sizeof(sc->devname)) <= 0) {
432 device_printf(sc->dev, "Can't get device_name\n");
436 if ((len = OF_getproplen(node, "data_size")) <= 0)
438 OF_getencprop(node, "data_size", dts_value, len);
439 sc->data_size = dts_value[0];
441 if ((len = OF_getproplen(node, "data_read")) <= 0)
443 OF_getencprop(node, "data_read", dts_value, len);
444 sc->data_read = dts_value[0];
446 if ((len = OF_getproplen(node, "data_write")) <= 0)
448 OF_getencprop(node, "data_write", dts_value, len);
449 sc->data_write = dts_value[0];
451 if ((len = OF_getproplen(node, "control_read")) <= 0)
453 OF_getencprop(node, "control_read", dts_value, len);
454 sc->control_read = dts_value[0];
456 if ((len = OF_getproplen(node, "control_write")) <= 0)
458 OF_getencprop(node, "control_write", dts_value, len);
459 sc->control_write = dts_value[0];
465 beri_probe(device_t dev)
468 if (!ofw_bus_status_okay(dev))
471 if (!ofw_bus_is_compatible(dev, "sri-cambridge,beri-ring"))
474 device_set_desc(dev, "SRI-Cambridge BERI ring buffer");
475 return (BUS_PROBE_DEFAULT);
479 beri_attach(device_t dev)
481 struct beri_softc *sc;
483 sc = device_get_softc(dev);
486 if (bus_alloc_resources(dev, beri_spec, sc->res)) {
487 device_printf(dev, "could not allocate resources\n");
491 /* Memory interface */
492 sc->bst = rman_get_bustag(sc->res[0]);
493 sc->bsh = rman_get_bushandle(sc->res[0]);
496 device_printf(sc->dev, "Can't get FDT values\n");
500 sc->cdev = make_dev(&beri_cdevsw, 0, UID_ROOT, GID_WHEEL,
501 S_IRWXU, "%s", sc->devname);
502 if (sc->cdev == NULL) {
503 device_printf(dev, "Failed to create character device.\n");
507 sc->cdev->si_drv1 = sc;
509 mtx_init(&sc->beri_mtx, "beri_mtx", NULL, MTX_DEF);
510 knlist_init_mtx(&sc->beri_rsel.si_note, &sc->beri_mtx);
515 static device_method_t beri_methods[] = {
516 DEVMETHOD(device_probe, beri_probe),
517 DEVMETHOD(device_attach, beri_attach),
521 static driver_t beri_driver = {
524 sizeof(struct beri_softc),
527 static devclass_t beri_devclass;
529 DRIVER_MODULE(beri_ring, simplebus, beri_driver, beri_devclass, 0, 0);