2 comedi/drivers/ni_atmio.c
3 Hardware driver for NI AT-MIO E series cards
5 COMEDI - Linux Control and Measurement Device Interface
6 Copyright (C) 1997-2001 David A. Schleef <ds@schleef.org>
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
20 Description: National Instruments AT-MIO-E series
22 Devices: [National Instruments] AT-MIO-16E-1 (ni_atmio),
23 AT-MIO-16E-2, AT-MIO-16E-10, AT-MIO-16DE-10, AT-MIO-64E-3,
24 AT-MIO-16XE-50, AT-MIO-16XE-10, AT-AI-16XE-10
26 Updated: Thu May 1 20:03:02 CDT 2003
28 The driver has 2.6 kernel isapnp support, and
29 will automatically probe for a supported board if the
30 I/O base is left unspecified with comedi_config.
32 the isapnp id numbers are unknown. If your board is not
33 recognized, please send the output of 'cat /proc/isapnp'
34 (you may need to modprobe the isa-pnp module for
35 /proc/isapnp to exist) so the
36 id numbers for your board can be added to the driver.
38 Otherwise, you can use the isapnptools package to configure
39 your board. Use isapnp to
40 configure the I/O base and IRQ for the board, and then pass
42 parameters in comedi_config. A sample isapnp.conf file is included
43 in the etc/ directory of Comedilib.
45 Comedilib includes a utility to autocalibrate these boards. The
46 boards seem to boot into a state where the all calibration DACs
47 are at one extreme of their range, thus the default calibration
48 is terrible. Calibration at boot is strongly encouraged.
50 To use the extended digital I/O on some of the boards, enable the
51 8255 driver when configuring the Comedi source tree.
53 External triggering is supported for some events. The channel index
54 (scan_begin_arg, etc.) maps to PFI0 - PFI9.
56 Some of the more esoteric triggering possibilities of these boards
60 The real guts of the driver is in ni_mio_common.c, which is included
61 both here and in ni_pcimio.c
63 Interrupt support added by Truxton Fulton <trux@truxton.com>
65 References for specifications:
67 340747b.pdf Register Level Programmer Manual (obsolete)
68 340747c.pdf Register Level Programmer Manual (new)
69 DAQ-STC reference manual
71 Other possibly relevant info:
73 320517c.pdf User manual (obsolete)
74 320517f.pdf User manual (new)
76 320906c.pdf maximum signal ratings
78 321791a.pdf discontinuation of at-mio-16e-10 rev. c
79 321808a.pdf about at-mio-16e-10 rev P
80 321837a.pdf discontinuation of at-mio-16de-10 rev d
81 321838a.pdf about at-mio-16de-10 rev N
85 need to deal with external reference for DAC, and other DAC
86 properties in board properties
88 deal with at-mio-16de-10 revision D to N changes, etc.
92 #include <linux/module.h>
93 #include <linux/interrupt.h>
94 #include "../comedidev.h"
96 #include <linux/isapnp.h>
110 #define MAX_N_CALDACS 32
112 static const struct ni_board_struct ni_boards[] = {
114 .isapnp_id = 0x0000, /* XXX unknown */
115 .name = "at-mio-16e-1",
118 .ai_fifo_depth = 8192,
120 .gainlkup = ai_gain_16,
124 .ao_fifo_depth = 2048,
125 .ao_range_table = &range_ni_E_ao_ext,
129 .num_p0_dio_channels = 8,
134 .name = "at-mio-16e-2",
137 .ai_fifo_depth = 2048,
139 .gainlkup = ai_gain_16,
143 .ao_fifo_depth = 2048,
144 .ao_range_table = &range_ni_E_ao_ext,
148 .num_p0_dio_channels = 8,
153 .name = "at-mio-16e-10",
156 .ai_fifo_depth = 512,
158 .gainlkup = ai_gain_16,
163 .ao_range_table = &range_ni_E_ao_ext,
166 .num_p0_dio_channels = 8,
167 .caldac = {ad8804_debug},
172 .name = "at-mio-16de-10",
175 .ai_fifo_depth = 512,
177 .gainlkup = ai_gain_16,
182 .ao_range_table = &range_ni_E_ao_ext,
185 .num_p0_dio_channels = 8,
186 .caldac = {ad8804_debug},
191 .name = "at-mio-64e-3",
194 .ai_fifo_depth = 2048,
196 .gainlkup = ai_gain_16,
200 .ao_fifo_depth = 2048,
201 .ao_range_table = &range_ni_E_ao_ext,
205 .num_p0_dio_channels = 8,
206 .caldac = {ad8804_debug},
210 .name = "at-mio-16xe-50",
213 .ai_fifo_depth = 512,
215 .gainlkup = ai_gain_8,
220 .ao_range_table = &range_bipolar10,
223 .num_p0_dio_channels = 8,
224 .caldac = {dac8800, dac8043},
228 .isapnp_id = 0x0000, /* XXX unknown */
229 .name = "at-mio-16xe-10",
232 .ai_fifo_depth = 512,
234 .gainlkup = ai_gain_14,
238 .ao_fifo_depth = 2048,
239 .ao_range_table = &range_ni_E_ao_ext,
242 .num_p0_dio_channels = 8,
243 .caldac = {dac8800, dac8043, ad8522},
247 .isapnp_id = 0x0000, /* XXX unknown */
248 .name = "at-ai-16xe-10",
251 .ai_fifo_depth = 512,
252 .alwaysdither = 1, /* unknown */
253 .gainlkup = ai_gain_14,
259 .num_p0_dio_channels = 8,
260 .caldac = {dac8800, dac8043, ad8522},
265 static const int ni_irqpin[] = {
266 -1, -1, -1, 0, 1, 2, -1, 3, -1, -1, 4, 5, 6, -1, -1, 7
269 #define interrupt_pin(a) (ni_irqpin[(a)])
271 #define IRQ_POLARITY 0
273 #define NI_E_IRQ_FLAGS 0
276 struct pnp_dev *isapnp_dev;
281 /* How we access registers */
283 #define ni_writel(a, b) (outl((a), (b)+dev->iobase))
284 #define ni_readl(a) (inl((a)+dev->iobase))
285 #define ni_writew(a, b) (outw((a), (b)+dev->iobase))
286 #define ni_readw(a) (inw((a)+dev->iobase))
287 #define ni_writeb(a, b) (outb((a), (b)+dev->iobase))
288 #define ni_readb(a) (inb((a)+dev->iobase))
290 /* How we access windowed registers */
292 /* We automatically take advantage of STC registers that can be
293 * read/written directly in the I/O space of the board. The
294 * AT-MIO devices map the low 8 STC registers to iobase+addr*2. */
296 static void ni_atmio_win_out(struct comedi_device *dev, uint16_t data, int addr)
298 struct ni_private *devpriv = dev->private;
301 spin_lock_irqsave(&devpriv->window_lock, flags);
303 ni_writew(data, addr * 2);
305 ni_writew(addr, Window_Address);
306 ni_writew(data, Window_Data);
308 spin_unlock_irqrestore(&devpriv->window_lock, flags);
311 static uint16_t ni_atmio_win_in(struct comedi_device *dev, int addr)
313 struct ni_private *devpriv = dev->private;
317 spin_lock_irqsave(&devpriv->window_lock, flags);
319 ret = ni_readw(addr * 2);
321 ni_writew(addr, Window_Address);
322 ret = ni_readw(Window_Data);
324 spin_unlock_irqrestore(&devpriv->window_lock, flags);
329 static struct pnp_device_id device_ids[] = {
330 {.id = "NIC1900", .driver_data = 0},
331 {.id = "NIC2400", .driver_data = 0},
332 {.id = "NIC2500", .driver_data = 0},
333 {.id = "NIC2600", .driver_data = 0},
334 {.id = "NIC2700", .driver_data = 0},
338 MODULE_DEVICE_TABLE(pnp, device_ids);
340 #include "ni_mio_common.c"
342 static int ni_isapnp_find_board(struct pnp_dev **dev)
344 struct pnp_dev *isapnp_dev = NULL;
347 for (i = 0; i < ARRAY_SIZE(ni_boards); i++) {
348 isapnp_dev = pnp_find_dev(NULL,
349 ISAPNP_VENDOR('N', 'I', 'C'),
350 ISAPNP_FUNCTION(ni_boards[i].
353 if (isapnp_dev == NULL || isapnp_dev->card == NULL)
356 if (pnp_device_attach(isapnp_dev) < 0) {
358 ("ni_atmio: %s found but already active, skipping.\n",
362 if (pnp_activate_dev(isapnp_dev) < 0) {
363 pnp_device_detach(isapnp_dev);
366 if (!pnp_port_valid(isapnp_dev, 0)
367 || !pnp_irq_valid(isapnp_dev, 0)) {
368 pnp_device_detach(isapnp_dev);
369 printk("ni_atmio: pnp invalid port or irq, aborting\n");
374 if (i == ARRAY_SIZE(ni_boards))
380 static int ni_getboardtype(struct comedi_device *dev)
382 int device_id = ni_read_eeprom(dev, 511);
385 for (i = 0; i < ARRAY_SIZE(ni_boards); i++) {
386 if (ni_boards[i].device_id == device_id)
390 if (device_id == 255)
391 printk(" can't find board\n");
392 else if (device_id == 0)
393 printk(" EEPROM read error (?) or device not found\n");
395 printk(" unknown device ID %d -- contact author\n", device_id);
400 static int ni_atmio_attach(struct comedi_device *dev,
401 struct comedi_devconfig *it)
403 const struct ni_board_struct *boardtype;
404 struct ni_private *devpriv;
405 struct pnp_dev *isapnp_dev;
407 unsigned long iobase;
411 ret = ni_alloc_private(dev);
414 devpriv = dev->private;
416 devpriv->stc_writew = &ni_atmio_win_out;
417 devpriv->stc_readw = &ni_atmio_win_in;
418 devpriv->stc_writel = &win_out2;
419 devpriv->stc_readl = &win_in2;
421 iobase = it->options[0];
422 irq = it->options[1];
425 ret = ni_isapnp_find_board(&isapnp_dev);
429 iobase = pnp_port_start(isapnp_dev, 0);
430 irq = pnp_irq(isapnp_dev, 0);
431 devpriv->isapnp_dev = isapnp_dev;
434 ret = comedi_request_region(dev, iobase, NI_SIZE);
440 board = ni_getboardtype(dev);
444 dev->board_ptr = ni_boards + board;
445 boardtype = comedi_board(dev);
447 printk(" %s", boardtype->name);
448 dev->board_name = boardtype->name;
453 if (irq > 15 || ni_irqpin[irq] == -1) {
454 printk(" invalid irq %u\n", irq);
457 printk(" ( irq = %u )", irq);
458 ret = request_irq(irq, ni_E_interrupt, NI_E_IRQ_FLAGS,
462 printk(" irq not available\n");
468 /* generic E series stuff in ni_mio_common.c */
470 ret = ni_E_init(dev);
478 static void ni_atmio_detach(struct comedi_device *dev)
480 struct ni_private *devpriv = dev->private;
482 mio_common_detach(dev);
483 comedi_legacy_detach(dev);
484 if (devpriv->isapnp_dev)
485 pnp_device_detach(devpriv->isapnp_dev);
488 static struct comedi_driver ni_atmio_driver = {
489 .driver_name = "ni_atmio",
490 .module = THIS_MODULE,
491 .attach = ni_atmio_attach,
492 .detach = ni_atmio_detach,
494 module_comedi_driver(ni_atmio_driver);