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.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 Description: National Instruments AT-MIO-E series
26 Devices: [National Instruments] AT-MIO-16E-1 (ni_atmio),
27 AT-MIO-16E-2, AT-MIO-16E-10, AT-MIO-16DE-10, AT-MIO-64E-3,
28 AT-MIO-16XE-50, AT-MIO-16XE-10, AT-AI-16XE-10
30 Updated: Thu May 1 20:03:02 CDT 2003
32 The driver has 2.6 kernel isapnp support, and
33 will automatically probe for a supported board if the
34 I/O base is left unspecified with comedi_config.
36 the isapnp id numbers are unknown. If your board is not
37 recognized, please send the output of 'cat /proc/isapnp'
38 (you may need to modprobe the isa-pnp module for
39 /proc/isapnp to exist) so the
40 id numbers for your board can be added to the driver.
42 Otherwise, you can use the isapnptools package to configure
43 your board. Use isapnp to
44 configure the I/O base and IRQ for the board, and then pass
46 parameters in comedi_config. A sample isapnp.conf file is included
47 in the etc/ directory of Comedilib.
49 Comedilib includes a utility to autocalibrate these boards. The
50 boards seem to boot into a state where the all calibration DACs
51 are at one extreme of their range, thus the default calibration
52 is terrible. Calibration at boot is strongly encouraged.
54 To use the extended digital I/O on some of the boards, enable the
55 8255 driver when configuring the Comedi source tree.
57 External triggering is supported for some events. The channel index
58 (scan_begin_arg, etc.) maps to PFI0 - PFI9.
60 Some of the more esoteric triggering possibilities of these boards
64 The real guts of the driver is in ni_mio_common.c, which is included
65 both here and in ni_pcimio.c
67 Interrupt support added by Truxton Fulton <trux@truxton.com>
69 References for specifications:
71 340747b.pdf Register Level Programmer Manual (obsolete)
72 340747c.pdf Register Level Programmer Manual (new)
73 DAQ-STC reference manual
75 Other possibly relevant info:
77 320517c.pdf User manual (obsolete)
78 320517f.pdf User manual (new)
80 320906c.pdf maximum signal ratings
82 321791a.pdf discontinuation of at-mio-16e-10 rev. c
83 321808a.pdf about at-mio-16e-10 rev P
84 321837a.pdf discontinuation of at-mio-16de-10 rev d
85 321838a.pdf about at-mio-16de-10 rev N
89 need to deal with external reference for DAC, and other DAC
90 properties in board properties
92 deal with at-mio-16de-10 revision D to N changes, etc.
96 #include <linux/interrupt.h>
97 #include "../comedidev.h"
99 #include <linux/delay.h>
100 #include <linux/isapnp.h>
116 #define MAX_N_CALDACS 32
118 static const struct ni_board_struct ni_boards[] = {
120 .isapnp_id = 0x0000, /* XXX unknown */
121 .name = "at-mio-16e-1",
124 .ai_fifo_depth = 8192,
126 .gainlkup = ai_gain_16,
130 .ao_fifo_depth = 2048,
131 .ao_range_table = &range_ni_E_ao_ext,
135 .num_p0_dio_channels = 8,
140 .name = "at-mio-16e-2",
143 .ai_fifo_depth = 2048,
145 .gainlkup = ai_gain_16,
149 .ao_fifo_depth = 2048,
150 .ao_range_table = &range_ni_E_ao_ext,
154 .num_p0_dio_channels = 8,
159 .name = "at-mio-16e-10",
162 .ai_fifo_depth = 512,
164 .gainlkup = ai_gain_16,
169 .ao_range_table = &range_ni_E_ao_ext,
172 .num_p0_dio_channels = 8,
173 .caldac = {ad8804_debug},
178 .name = "at-mio-16de-10",
181 .ai_fifo_depth = 512,
183 .gainlkup = ai_gain_16,
188 .ao_range_table = &range_ni_E_ao_ext,
191 .num_p0_dio_channels = 8,
192 .caldac = {ad8804_debug},
197 .name = "at-mio-64e-3",
200 .ai_fifo_depth = 2048,
202 .gainlkup = ai_gain_16,
206 .ao_fifo_depth = 2048,
207 .ao_range_table = &range_ni_E_ao_ext,
211 .num_p0_dio_channels = 8,
212 .caldac = {ad8804_debug},
216 .name = "at-mio-16xe-50",
219 .ai_fifo_depth = 512,
221 .gainlkup = ai_gain_8,
226 .ao_range_table = &range_bipolar10,
229 .num_p0_dio_channels = 8,
230 .caldac = {dac8800, dac8043},
234 .isapnp_id = 0x0000, /* XXX unknown */
235 .name = "at-mio-16xe-10",
238 .ai_fifo_depth = 512,
240 .gainlkup = ai_gain_14,
244 .ao_fifo_depth = 2048,
245 .ao_range_table = &range_ni_E_ao_ext,
248 .num_p0_dio_channels = 8,
249 .caldac = {dac8800, dac8043, ad8522},
253 .isapnp_id = 0x0000, /* XXX unknown */
254 .name = "at-ai-16xe-10",
257 .ai_fifo_depth = 512,
258 .alwaysdither = 1, /* unknown */
259 .gainlkup = ai_gain_14,
265 .num_p0_dio_channels = 8,
266 .caldac = {dac8800, dac8043, ad8522},
271 static const int ni_irqpin[] = {
272 -1, -1, -1, 0, 1, 2, -1, 3, -1, -1, 4, 5, 6, -1, -1, 7
275 #define interrupt_pin(a) (ni_irqpin[(a)])
277 #define IRQ_POLARITY 0
279 #define NI_E_IRQ_FLAGS 0
282 struct pnp_dev *isapnp_dev;
287 /* How we access registers */
289 #define ni_writel(a, b) (outl((a), (b)+dev->iobase))
290 #define ni_readl(a) (inl((a)+dev->iobase))
291 #define ni_writew(a, b) (outw((a), (b)+dev->iobase))
292 #define ni_readw(a) (inw((a)+dev->iobase))
293 #define ni_writeb(a, b) (outb((a), (b)+dev->iobase))
294 #define ni_readb(a) (inb((a)+dev->iobase))
296 /* How we access windowed registers */
298 /* We automatically take advantage of STC registers that can be
299 * read/written directly in the I/O space of the board. The
300 * AT-MIO devices map the low 8 STC registers to iobase+addr*2. */
302 static void ni_atmio_win_out(struct comedi_device *dev, uint16_t data, int addr)
304 struct ni_private *devpriv = dev->private;
307 spin_lock_irqsave(&devpriv->window_lock, flags);
309 ni_writew(data, addr * 2);
311 ni_writew(addr, Window_Address);
312 ni_writew(data, Window_Data);
314 spin_unlock_irqrestore(&devpriv->window_lock, flags);
317 static uint16_t ni_atmio_win_in(struct comedi_device *dev, int addr)
319 struct ni_private *devpriv = dev->private;
323 spin_lock_irqsave(&devpriv->window_lock, flags);
325 ret = ni_readw(addr * 2);
327 ni_writew(addr, Window_Address);
328 ret = ni_readw(Window_Data);
330 spin_unlock_irqrestore(&devpriv->window_lock, flags);
335 static struct pnp_device_id device_ids[] = {
336 {.id = "NIC1900", .driver_data = 0},
337 {.id = "NIC2400", .driver_data = 0},
338 {.id = "NIC2500", .driver_data = 0},
339 {.id = "NIC2600", .driver_data = 0},
340 {.id = "NIC2700", .driver_data = 0},
344 MODULE_DEVICE_TABLE(pnp, device_ids);
346 #include "ni_mio_common.c"
348 static int ni_isapnp_find_board(struct pnp_dev **dev)
350 struct pnp_dev *isapnp_dev = NULL;
353 for (i = 0; i < ARRAY_SIZE(ni_boards); i++) {
354 isapnp_dev = pnp_find_dev(NULL,
355 ISAPNP_VENDOR('N', 'I', 'C'),
356 ISAPNP_FUNCTION(ni_boards[i].
359 if (isapnp_dev == NULL || isapnp_dev->card == NULL)
362 if (pnp_device_attach(isapnp_dev) < 0) {
364 ("ni_atmio: %s found but already active, skipping.\n",
368 if (pnp_activate_dev(isapnp_dev) < 0) {
369 pnp_device_detach(isapnp_dev);
372 if (!pnp_port_valid(isapnp_dev, 0)
373 || !pnp_irq_valid(isapnp_dev, 0)) {
374 pnp_device_detach(isapnp_dev);
375 printk("ni_atmio: pnp invalid port or irq, aborting\n");
380 if (i == ARRAY_SIZE(ni_boards))
386 static int ni_getboardtype(struct comedi_device *dev)
388 int device_id = ni_read_eeprom(dev, 511);
391 for (i = 0; i < ARRAY_SIZE(ni_boards); i++) {
392 if (ni_boards[i].device_id == device_id)
396 if (device_id == 255)
397 printk(" can't find board\n");
398 else if (device_id == 0)
399 printk(" EEPROM read error (?) or device not found\n");
401 printk(" unknown device ID %d -- contact author\n", device_id);
406 static int ni_atmio_attach(struct comedi_device *dev,
407 struct comedi_devconfig *it)
409 const struct ni_board_struct *boardtype;
410 struct ni_private *devpriv;
411 struct pnp_dev *isapnp_dev;
413 unsigned long iobase;
417 ret = ni_alloc_private(dev);
420 devpriv = dev->private;
422 devpriv->stc_writew = &ni_atmio_win_out;
423 devpriv->stc_readw = &ni_atmio_win_in;
424 devpriv->stc_writel = &win_out2;
425 devpriv->stc_readl = &win_in2;
427 iobase = it->options[0];
428 irq = it->options[1];
431 ret = ni_isapnp_find_board(&isapnp_dev);
435 iobase = pnp_port_start(isapnp_dev, 0);
436 irq = pnp_irq(isapnp_dev, 0);
437 devpriv->isapnp_dev = isapnp_dev;
440 ret = comedi_request_region(dev, iobase, NI_SIZE);
445 /* board existence sanity check */
449 printk(" board fingerprint:");
450 for (i = 0; i < 16; i += 2) {
451 printk(" %04x %02x", inw(dev->iobase + i),
452 inb(dev->iobase + i + 1));
459 board = ni_getboardtype(dev);
463 dev->board_ptr = ni_boards + board;
464 boardtype = comedi_board(dev);
466 printk(" %s", boardtype->name);
467 dev->board_name = boardtype->name;
472 if (irq > 15 || ni_irqpin[irq] == -1) {
473 printk(" invalid irq %u\n", irq);
476 printk(" ( irq = %u )", irq);
477 ret = request_irq(irq, ni_E_interrupt, NI_E_IRQ_FLAGS,
481 printk(" irq not available\n");
487 /* generic E series stuff in ni_mio_common.c */
489 ret = ni_E_init(dev);
497 static void ni_atmio_detach(struct comedi_device *dev)
499 struct ni_private *devpriv = dev->private;
501 mio_common_detach(dev);
502 comedi_legacy_detach(dev);
503 if (devpriv->isapnp_dev)
504 pnp_device_detach(devpriv->isapnp_dev);
507 static struct comedi_driver ni_atmio_driver = {
508 .driver_name = "ni_atmio",
509 .module = THIS_MODULE,
510 .attach = ni_atmio_attach,
511 .detach = ni_atmio_detach,
513 module_comedi_driver(ni_atmio_driver);