1 /*- 2 * Copyright (c) 2003-2004 Poul-Henning Kamp 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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 15 * permission. 16 * 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 27 * SUCH DAMAGE. 28 * 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 32 * 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. 37 * 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 40 * Celeron PC. 41 * 42 */ 43 44 #ifdef _KERNEL 45 #include <sys/cdefs.h> 46 __FBSDID("$FreeBSD$"); 47 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> 54 #include <sys/conf.h> 55 #include <sys/bus.h> 56 #include <machine/bus.h> 57 #include <machine/resource.h> 58 #include <sys/rman.h> 59 #include <dev/pci/pcireg.h> 60 #include <dev/pci/pcivar.h> 61 #include <pci_if.h> 62 #include <vm/vm.h> 63 #include <vm/pmap.h> 64 65 #endif /* _KERNEL */ 66 67 #include <sys/ioccom.h> 68 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 */ 75 76 struct page0 { 77 u_int version; 78 int state; 79 # define STATE_RESET -1 80 # define STATE_RUN 0 81 u_int divisor; /* int */ 82 u_int chunksize; /* bytes */ 83 u_int ringsize; /* chunks */ 84 u_int o_sample; /* 85 * offset of ring generation 86 * array 87 */ 88 u_int o_ring; /* offset of ring */ 89 }; 90 91 #define PAGE0VERSION 20050219 92 93 #ifdef _KERNEL 94 95 struct pgstat { 96 uint64_t *sample; 97 vm_paddr_t phys; 98 void *virt; 99 struct pgstat *next; 100 }; 101 102 struct softc { 103 device_t device; 104 void *intrhand; 105 struct resource *res[3]; 106 struct cdev *dev; 107 off_t mapvir; 108 int error; 109 struct page0 *p0; 110 u_int nchunks; 111 struct pgstat *chunks; 112 struct pgstat *next; 113 uint64_t sample; 114 }; 115 116 static d_ioctl_t adlink_ioctl; 117 static d_mmap_t adlink_mmap; 118 static void adlink_intr(void *arg); 119 120 static struct cdevsw adlink_cdevsw = { 121 .d_version = D_VERSION, 122 .d_ioctl = adlink_ioctl, 123 .d_mmap = adlink_mmap, 124 .d_name = "adlink", 125 }; 126 127 static void 128 adlink_intr(void *arg) 129 { 130 struct softc *sc; 131 struct pgstat *pg; 132 uint32_t u; 133 134 sc = arg; 135 u = bus_read_4(sc->res[0], 0x38); 136 if (!(u & 0x00800000)) 137 return; 138 bus_write_4(sc->res[0], 0x38, u | 0x003f4000); 139 140 sc->sample += sc->p0->chunksize / 2; 141 pg = sc->next; 142 *(pg->sample) = sc->sample; 143 144 u = bus_read_4(sc->res[1], 0x18); 145 if (u & 1) 146 sc->p0->state = EIO; 147 148 if (sc->p0->state != STATE_RUN) { 149 printf("adlink: stopping %d\n", sc->p0->state); 150 return; 151 } 152 153 pg = pg->next; 154 sc->next = pg; 155 *(pg->sample) = 0; 156 bus_write_4(sc->res[0], 0x24, pg->phys); 157 bus_write_4(sc->res[0], 0x28, sc->p0->chunksize); 158 wakeup(sc); 159 } 160 161 static int 162 adlink_mmap(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr, int nprot) 163 { 164 struct softc *sc; 165 vm_offset_t o; 166 int i; 167 struct pgstat *pg; 168 169 sc = dev->si_drv1; 170 if (nprot != VM_PROT_READ) 171 return (-1); 172 if (offset == 0) { 173 *paddr = vtophys(sc->p0); 174 return (0); 175 } 176 o = PAGE_SIZE; 177 pg = sc->chunks; 178 for (i = 0; i < sc->nchunks; i++, pg++) { 179 if (offset - o >= sc->p0->chunksize) { 180 o += sc->p0->chunksize; 181 continue; 182 } 183 *paddr = pg->phys + (offset - o); 184 return (0); 185 } 186 return (-1); 187 } 188 189 static int 190 adlink_ioctl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td) 191 { 192 struct softc *sc; 193 int i, error; 194 u_int u; 195 struct pgstat *pg; 196 uint64_t *sample; 197 198 sc = dev->si_drv1; 199 u = *(u_int*)data; 200 error = 0; 201 switch (cmd) { 202 case ADLINK_SETDIVISOR: 203 if (sc->p0->state == STATE_RUN) 204 return (EBUSY); 205 if (u & 1) 206 return (EINVAL); 207 sc->p0->divisor = u; 208 break; 209 case ADLINK_SETCHUNKSIZE: 210 if (sc->p0->state != STATE_RESET) 211 return (EBUSY); 212 if (u % PAGE_SIZE) 213 return (EINVAL); 214 if (sc->p0->ringsize != 0 && sc->p0->ringsize % u) 215 return (EINVAL); 216 sc->p0->chunksize = u; 217 break; 218 case ADLINK_SETRINGSIZE: 219 if (sc->p0->state != STATE_RESET) 220 return (EBUSY); 221 if (u % PAGE_SIZE) 222 return (EINVAL); 223 if (sc->p0->chunksize != 0 && u % sc->p0->chunksize) 224 return (EINVAL); 225 sc->p0->ringsize = u; 226 break; 227 case ADLINK_START: 228 if (sc->p0->state == STATE_RUN) 229 return (EBUSY); 230 if (sc->p0->state == STATE_RESET) { 231 232 if (sc->p0->chunksize == 0) 233 sc->p0->chunksize = 4 * PAGE_SIZE; 234 if (sc->p0->ringsize == 0) 235 sc->p0->ringsize = 16 * sc->p0->chunksize; 236 if (sc->p0->divisor == 0) 237 sc->p0->divisor = 4; 238 239 sc->nchunks = sc->p0->ringsize / sc->p0->chunksize; 240 if (sc->nchunks * sizeof (*pg->sample) + 241 sizeof *sc->p0 > PAGE_SIZE) 242 return (EINVAL); 243 sc->p0->o_ring = PAGE_SIZE; 244 sample = (uint64_t *)(sc->p0 + 1); 245 sc->p0->o_sample = 246 (uintptr_t)sample - (uintptr_t)(sc->p0); 247 pg = malloc(sizeof *pg * sc->nchunks, 248 M_DEVBUF, M_WAITOK | M_ZERO); 249 sc->chunks = pg; 250 for (i = 0; i < sc->nchunks; i++) { 251 pg->sample = sample; 252 *pg->sample = 0; 253 sample++; 254 pg->virt = contigmalloc(sc->p0->chunksize, 255 M_DEVBUF, M_WAITOK, 256 0ul, 0xfffffffful, 257 PAGE_SIZE, 0); 258 pg->phys = vtophys(pg->virt); 259 if (i == sc->nchunks - 1) 260 pg->next = sc->chunks; 261 else 262 pg->next = pg + 1; 263 pg++; 264 } 265 sc->next = sc->chunks; 266 } 267 268 /* Reset generation numbers */ 269 pg = sc->chunks; 270 for (i = 0; i < sc->nchunks; i++) { 271 *pg->sample = 0; 272 pg++; 273 } 274 275 /* Enable interrupts on write complete */ 276 bus_write_4(sc->res[0], 0x38, 0x00004000); 277 278 /* Sample CH0 only */ 279 bus_write_4(sc->res[1], 0x00, 1); 280 281 /* Divide clock by four */ 282 bus_write_4(sc->res[1], 0x04, sc->p0->divisor); 283 284 /* Software trigger mode: software */ 285 bus_write_4(sc->res[1], 0x08, 0); 286 287 /* Trigger level zero */ 288 bus_write_4(sc->res[1], 0x0c, 0); 289 290 /* Trigger source CH0 (not used) */ 291 bus_write_4(sc->res[1], 0x10, 0); 292 293 /* Fifo control/status: flush */ 294 bus_write_4(sc->res[1], 0x18, 3); 295 296 /* Clock source: external sine */ 297 bus_write_4(sc->res[1], 0x20, 2); 298 299 /* Chipmunks are go! */ 300 sc->p0->state = STATE_RUN; 301 302 /* Set up Write DMA */ 303 pg = sc->next = sc->chunks; 304 *(pg->sample) = 0; 305 bus_write_4(sc->res[0], 0x24, pg->phys); 306 bus_write_4(sc->res[0], 0x28, sc->p0->chunksize); 307 u = bus_read_4(sc->res[0], 0x3c); 308 bus_write_4(sc->res[0], 0x3c, u | 0x00000600); 309 310 /* Acquisition Enable Register: go! */ 311 bus_write_4(sc->res[1], 0x1c, 1); 312 313 break; 314 case ADLINK_STOP: 315 if (sc->p0->state == STATE_RESET) 316 break; 317 sc->p0->state = EINTR; 318 while (*(sc->next->sample) == 0) 319 tsleep(sc, PUSER | PCATCH, "adstop", 1); 320 break; 321 #ifdef notyet 322 /* 323 * I'm not sure we can actually do this. How do we revoke 324 * the mmap'ed pages from any process having them mmapped ? 325 */ 326 case ADLINK_RESET: 327 if (sc->p0->state == STATE_RESET) 328 break; 329 sc->p0->state = EINTR; 330 while (*(sc->next->samp) == 0) 331 tsleep(sc, PUSER | PCATCH, "adreset", 1); 332 /* deallocate ring buffer */ 333 break; 334 #endif 335 default: 336 error = ENOIOCTL; 337 break; 338 } 339 return (error); 340 } 341 342 static devclass_t adlink_devclass; 343 344 static int 345 adlink_probe(device_t self) 346 { 347 348 if (pci_get_devid(self) != 0x80da10e8) 349 return (ENXIO); 350 device_set_desc(self, "Adlink PCI-9812 4 ch 12 bit 20 msps"); 351 return (BUS_PROBE_DEFAULT); 352 } 353 354 static struct resource_spec adlink_res_spec[] = { 355 { SYS_RES_IOPORT, PCIR_BAR(0), RF_ACTIVE}, 356 { SYS_RES_IOPORT, PCIR_BAR(1), RF_ACTIVE}, 357 { SYS_RES_IRQ, 0, RF_ACTIVE | RF_SHAREABLE}, 358 { -1, 0, 0 } 359 }; 360 361 static int 362 adlink_attach(device_t self) 363 { 364 struct softc *sc; 365 int i, error; 366 367 sc = device_get_softc(self); 368 bzero(sc, sizeof *sc); 369 sc->device = self; 370 371 error = bus_alloc_resources(self, adlink_res_spec, sc->res); 372 if (error) 373 return (error); 374 375 i = bus_setup_intr(self, sc->res[2], 376 INTR_MPSAFE | INTR_TYPE_MISC | INTR_FAST, 377 adlink_intr, sc, &sc->intrhand); 378 if (i) { 379 printf("adlink: Couldn't get FAST intr\n"); 380 i = bus_setup_intr(self, sc->res[2], 381 INTR_MPSAFE | INTR_TYPE_MISC, 382 adlink_intr, sc, &sc->intrhand); 383 } 384 385 if (i) { 386 bus_release_resources(self, adlink_res_spec, sc->res); 387 return (ENODEV); 388 } 389 390 sc->p0 = malloc(PAGE_SIZE, M_DEVBUF, M_WAITOK | M_ZERO); 391 sc->p0->version = PAGE0VERSION; 392 sc->p0->state = STATE_RESET; 393 394 sc->dev = make_dev(&adlink_cdevsw, device_get_unit(self), 395 UID_ROOT, GID_WHEEL, 0444, "adlink%d", device_get_unit(self)); 396 sc->dev->si_drv1 = sc; 397 398 return (0); 399 } 400 401 static device_method_t adlink_methods[] = { 402 /* Device interface */ 403 DEVMETHOD(device_probe, adlink_probe), 404 DEVMETHOD(device_attach, adlink_attach), 405 DEVMETHOD(device_suspend, bus_generic_suspend), 406 DEVMETHOD(device_resume, bus_generic_resume), 407 DEVMETHOD(device_shutdown, bus_generic_shutdown), 408 {0, 0} 409 }; 410 411 static driver_t adlink_driver = { 412 "adlink", 413 adlink_methods, 414 sizeof(struct softc) 415 }; 416 417 DRIVER_MODULE(adlink, pci, adlink_driver, adlink_devclass, 0, 0); 418 419 #endif /* _KERNEL */ 420