2 * Copyright (c) 2003-2004 Poul-Henning Kamp
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. The names of the authors may not be used to endorse or promote
14 * products derived from this software without specific prior written
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * This is a device driver or the Adlink 9812 and 9810 ADC cards, mainly
30 * intended to support Software Defined Radio reception of timesignals
31 * in the VLF band. See http://phk.freebsd.dk/loran-c
33 * The driver is configured with ioctls which define a ringbuffer with
34 * a given number of chunks in it. The a control structure and the
35 * ringbuffer can then be mmap(2)'ed into userland and the application
36 * can operate on the data directly.
38 * Tested with 10MHz external clock, divisor of 2 (ie: 5MHz sampling),
39 * One channel active (ie: 2 bytes per sample = 10MB/sec) on a 660MHz
45 #include <sys/cdefs.h>
46 __FBSDID("$FreeBSD$");
48 #include <sys/param.h>
49 #include <sys/systm.h>
50 #include <sys/malloc.h>
51 #include <sys/kernel.h>
52 #include <sys/module.h>
53 #include <sys/kthread.h>
56 #include <machine/bus.h>
57 #include <machine/resource.h>
59 #include <dev/pci/pcireg.h>
60 #include <dev/pci/pcivar.h>
67 #include <sys/ioccom.h>
69 #define ADLINK_SETDIVISOR _IOWR('A', 255, u_int) /* divisor */
70 #define ADLINK_SETCHUNKSIZE _IOWR('A', 254, u_int) /* bytes */
71 #define ADLINK_SETRINGSIZE _IOWR('A', 253, u_int) /* bytes */
72 #define ADLINK_START _IOWR('A', 252, u_int) /* dummy */
73 #define ADLINK_STOP _IOWR('A', 251, u_int) /* dummy */
74 #define ADLINK_RESET _IOWR('A', 250, u_int) /* dummy */
79 # define STATE_RESET -1
81 u_int divisor; /* int */
82 u_int chunksize; /* bytes */
83 u_int ringsize; /* chunks */
85 * offset of ring generation
88 u_int o_ring; /* offset of ring */
91 #define PAGE0VERSION 20050219
105 struct resource *res[3];
111 struct pgstat *chunks;
116 static d_ioctl_t adlink_ioctl;
117 static d_mmap_t adlink_mmap;
118 static int adlink_intr(void *arg);
120 static struct cdevsw adlink_cdevsw = {
121 .d_version = D_VERSION,
122 .d_flags = D_NEEDGIANT,
123 .d_ioctl = adlink_ioctl,
124 .d_mmap = adlink_mmap,
129 adlink_intr(void *arg)
136 u = bus_read_4(sc->res[0], 0x38);
137 if (!(u & 0x00800000))
138 return; // XXX - FILTER_STRAY?
139 bus_write_4(sc->res[0], 0x38, u | 0x003f4000);
141 sc->sample += sc->p0->chunksize / 2;
143 *(pg->sample) = sc->sample;
145 u = bus_read_4(sc->res[1], 0x18);
149 if (sc->p0->state != STATE_RUN) {
150 printf("adlink: stopping %d\n", sc->p0->state);
151 return; // XXX - FILTER_STRAY?
157 bus_write_4(sc->res[0], 0x24, pg->phys);
158 bus_write_4(sc->res[0], 0x28, sc->p0->chunksize);
160 return (FILTER_HANDLED);
164 adlink_mmap(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
165 int nprot, vm_memattr_t *memattr)
173 if (nprot != VM_PROT_READ)
176 *paddr = vtophys(sc->p0);
181 for (i = 0; i < sc->nchunks; i++, pg++) {
182 if (offset - o >= sc->p0->chunksize) {
183 o += sc->p0->chunksize;
186 *paddr = pg->phys + (offset - o);
193 adlink_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
205 case ADLINK_SETDIVISOR:
206 if (sc->p0->state == STATE_RUN)
212 case ADLINK_SETCHUNKSIZE:
213 if (sc->p0->state != STATE_RESET)
217 if (sc->p0->ringsize != 0 && sc->p0->ringsize % u)
219 sc->p0->chunksize = u;
221 case ADLINK_SETRINGSIZE:
222 if (sc->p0->state != STATE_RESET)
226 if (sc->p0->chunksize != 0 && u % sc->p0->chunksize)
228 sc->p0->ringsize = u;
231 if (sc->p0->state == STATE_RUN)
233 if (sc->p0->state == STATE_RESET) {
235 if (sc->p0->chunksize == 0)
236 sc->p0->chunksize = 4 * PAGE_SIZE;
237 if (sc->p0->ringsize == 0)
238 sc->p0->ringsize = 16 * sc->p0->chunksize;
239 if (sc->p0->divisor == 0)
242 sc->nchunks = sc->p0->ringsize / sc->p0->chunksize;
243 if (sc->nchunks * sizeof (*pg->sample) +
244 sizeof *sc->p0 > PAGE_SIZE)
246 sc->p0->o_ring = PAGE_SIZE;
247 sample = (uint64_t *)(sc->p0 + 1);
249 (uintptr_t)sample - (uintptr_t)(sc->p0);
250 pg = malloc(sizeof *pg * sc->nchunks,
251 M_DEVBUF, M_WAITOK | M_ZERO);
253 for (i = 0; i < sc->nchunks; i++) {
257 pg->virt = contigmalloc(sc->p0->chunksize,
261 pg->phys = vtophys(pg->virt);
262 if (i == sc->nchunks - 1)
263 pg->next = sc->chunks;
268 sc->next = sc->chunks;
271 /* Reset generation numbers */
273 for (i = 0; i < sc->nchunks; i++) {
278 /* Enable interrupts on write complete */
279 bus_write_4(sc->res[0], 0x38, 0x00004000);
281 /* Sample CH0 only */
282 bus_write_4(sc->res[1], 0x00, 1);
284 /* Divide clock by four */
285 bus_write_4(sc->res[1], 0x04, sc->p0->divisor);
287 /* Software trigger mode: software */
288 bus_write_4(sc->res[1], 0x08, 0);
290 /* Trigger level zero */
291 bus_write_4(sc->res[1], 0x0c, 0);
293 /* Trigger source CH0 (not used) */
294 bus_write_4(sc->res[1], 0x10, 0);
296 /* Fifo control/status: flush */
297 bus_write_4(sc->res[1], 0x18, 3);
299 /* Clock source: external sine */
300 bus_write_4(sc->res[1], 0x20, 2);
302 /* Chipmunks are go! */
303 sc->p0->state = STATE_RUN;
305 /* Set up Write DMA */
306 pg = sc->next = sc->chunks;
308 bus_write_4(sc->res[0], 0x24, pg->phys);
309 bus_write_4(sc->res[0], 0x28, sc->p0->chunksize);
310 u = bus_read_4(sc->res[0], 0x3c);
311 bus_write_4(sc->res[0], 0x3c, u | 0x00000600);
313 /* Acquisition Enable Register: go! */
314 bus_write_4(sc->res[1], 0x1c, 1);
318 if (sc->p0->state == STATE_RESET)
320 sc->p0->state = EINTR;
321 while (*(sc->next->sample) == 0)
322 tsleep(sc, PUSER | PCATCH, "adstop", 1);
326 * I'm not sure we can actually do this. How do we revoke
327 * the mmap'ed pages from any process having them mmapped ?
330 if (sc->p0->state == STATE_RESET)
332 sc->p0->state = EINTR;
333 while (*(sc->next->samp) == 0)
334 tsleep(sc, PUSER | PCATCH, "adreset", 1);
335 /* deallocate ring buffer */
345 static devclass_t adlink_devclass;
348 adlink_probe(device_t self)
351 if (pci_get_devid(self) != 0x80da10e8)
353 device_set_desc(self, "Adlink PCI-9812 4 ch 12 bit 20 msps");
354 return (BUS_PROBE_DEFAULT);
357 static struct resource_spec adlink_res_spec[] = {
358 { SYS_RES_IOPORT, PCIR_BAR(0), RF_ACTIVE},
359 { SYS_RES_IOPORT, PCIR_BAR(1), RF_ACTIVE},
360 { SYS_RES_IRQ, 0, RF_ACTIVE | RF_SHAREABLE},
365 adlink_attach(device_t self)
370 sc = device_get_softc(self);
371 bzero(sc, sizeof *sc);
374 error = bus_alloc_resources(self, adlink_res_spec, sc->res);
378 i = bus_setup_intr(self, sc->res[2], INTR_TYPE_MISC,
379 adlink_intr, NULL, sc, &sc->intrhand);
381 printf("adlink: Couldn't get FAST intr\n");
382 i = bus_setup_intr(self, sc->res[2],
383 INTR_MPSAFE | INTR_TYPE_MISC,
384 NULL, (driver_intr_t *)adlink_intr, sc, &sc->intrhand);
388 bus_release_resources(self, adlink_res_spec, sc->res);
392 sc->p0 = malloc(PAGE_SIZE, M_DEVBUF, M_WAITOK | M_ZERO);
393 sc->p0->version = PAGE0VERSION;
394 sc->p0->state = STATE_RESET;
396 sc->dev = make_dev(&adlink_cdevsw, device_get_unit(self),
397 UID_ROOT, GID_WHEEL, 0444, "adlink%d", device_get_unit(self));
398 sc->dev->si_drv1 = sc;
403 static device_method_t adlink_methods[] = {
404 /* Device interface */
405 DEVMETHOD(device_probe, adlink_probe),
406 DEVMETHOD(device_attach, adlink_attach),
407 DEVMETHOD(device_suspend, bus_generic_suspend),
408 DEVMETHOD(device_resume, bus_generic_resume),
409 DEVMETHOD(device_shutdown, bus_generic_shutdown),
413 static driver_t adlink_driver = {
419 DRIVER_MODULE(adlink, pci, adlink_driver, adlink_devclass, 0, 0);