ni_mio_cs.c revision eb14120f743d29744d9475bffec56ff4ad43a749
1/*
2    comedi/drivers/ni_mio_cs.c
3    Hardware driver for NI PCMCIA MIO E series cards
4
5    COMEDI - Linux Control and Measurement Device Interface
6    Copyright (C) 1997-2000 David A. Schleef <ds@schleef.org>
7
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.
12
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.
17
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.
21
22*/
23/*
24Driver: ni_mio_cs
25Description: National Instruments DAQCard E series
26Author: ds
27Status: works
28Devices: [National Instruments] DAQCard-AI-16XE-50 (ni_mio_cs),
29  DAQCard-AI-16E-4, DAQCard-6062E, DAQCard-6024E, DAQCard-6036E
30Updated: Thu Oct 23 19:43:17 CDT 2003
31
32See the notes in the ni_atmio.o driver.
33*/
34/*
35	The real guts of the driver is in ni_mio_common.c, which is
36	included by all the E series drivers.
37
38	References for specifications:
39
40	   341080a.pdf  DAQCard E Series Register Level Programmer Manual
41
42*/
43
44#include "../comedidev.h"
45
46#include <linux/delay.h>
47
48#include "ni_stc.h"
49#include "8255.h"
50
51#include <pcmcia/cs_types.h>
52#include <pcmcia/cs.h>
53#include <pcmcia/cistpl.h>
54#include <pcmcia/ds.h>
55
56#undef DEBUG
57
58#define ATMIO 1
59#undef PCIMIO
60
61/*
62 *  AT specific setup
63 */
64
65#define NI_SIZE 0x20
66
67#define MAX_N_CALDACS 32
68
69static const struct ni_board_struct ni_boards[] = {
70	{.device_id = 0x010d,
71	 .name = "DAQCard-ai-16xe-50",
72	 .n_adchan = 16,
73	 .adbits = 16,
74	 .ai_fifo_depth = 1024,
75	 .alwaysdither = 0,
76	 .gainlkup = ai_gain_8,
77	 .ai_speed = 5000,
78	 .n_aochan = 0,
79	 .aobits = 0,
80	 .ao_fifo_depth = 0,
81	 .ao_unipolar = 0,
82	 .num_p0_dio_channels = 8,
83	 .has_8255 = 0,
84	 .caldac = {dac8800, dac8043},
85	 },
86	{.device_id = 0x010c,
87	 .name = "DAQCard-ai-16e-4",
88	 .n_adchan = 16,
89	 .adbits = 12,
90	 .ai_fifo_depth = 1024,
91	 .alwaysdither = 0,
92	 .gainlkup = ai_gain_16,
93	 .ai_speed = 4000,
94	 .n_aochan = 0,
95	 .aobits = 0,
96	 .ao_fifo_depth = 0,
97	 .ao_unipolar = 0,
98	 .num_p0_dio_channels = 8,
99	 .has_8255 = 0,
100	 .caldac = {mb88341},	/* verified */
101	 },
102	{.device_id = 0x02c4,
103	 .name = "DAQCard-6062E",
104	 .n_adchan = 16,
105	 .adbits = 12,
106	 .ai_fifo_depth = 8192,
107	 .alwaysdither = 0,
108	 .gainlkup = ai_gain_16,
109	 .ai_speed = 2000,
110	 .n_aochan = 2,
111	 .aobits = 12,
112	 .ao_fifo_depth = 2048,
113	 .ao_range_table = &range_bipolar10,
114	 .ao_unipolar = 0,
115	 .ao_speed = 1176,
116	 .num_p0_dio_channels = 8,
117	 .has_8255 = 0,
118	 .caldac = {ad8804_debug},	/* verified */
119	 },
120	{.device_id = 0x075e,
121	 .name = "DAQCard-6024E",	/* specs incorrect! */
122	 .n_adchan = 16,
123	 .adbits = 12,
124	 .ai_fifo_depth = 1024,
125	 .alwaysdither = 0,
126	 .gainlkup = ai_gain_16,
127	 .ai_speed = 5000,
128	 .n_aochan = 2,
129	 .aobits = 12,
130	 .ao_fifo_depth = 0,
131	 .ao_range_table = &range_bipolar10,
132	 .ao_unipolar = 0,
133	 .ao_speed = 1000000,
134	 .num_p0_dio_channels = 8,
135	 .has_8255 = 0,
136	 .caldac = {ad8804_debug},
137	 },
138	{.device_id = 0x0245,
139	 .name = "DAQCard-6036E",	/* specs incorrect! */
140	 .n_adchan = 16,
141	 .adbits = 16,
142	 .ai_fifo_depth = 1024,
143	 .alwaysdither = 1,
144	 .gainlkup = ai_gain_4,
145	 .ai_speed = 5000,
146	 .n_aochan = 2,
147	 .aobits = 16,
148	 .ao_fifo_depth = 0,
149	 .ao_range_table = &range_bipolar10,
150	 .ao_unipolar = 0,
151	 .ao_speed = 1000000,
152	 .num_p0_dio_channels = 8,
153	 .has_8255 = 0,
154	 .caldac = {ad8804_debug},
155	 },
156#if 0
157	{.device_id = 0x0000,	/* unknown */
158	 .name = "DAQCard-6715",
159	 .n_adchan = 0,
160	 .n_aochan = 8,
161	 .aobits = 12,
162	 .ao_671x = 8192,
163	 .num_p0_dio_channels = 8,
164	 .caldac = {mb88341, mb88341},
165	 },
166#endif
167	/* N.B. Update ni_mio_cs_ids[] when entries added above. */
168};
169
170#define interrupt_pin(a)	0
171
172#define IRQ_POLARITY 1
173
174#define NI_E_IRQ_FLAGS		IRQF_SHARED
175
176struct ni_private {
177
178	struct pcmcia_device *link;
179
180 NI_PRIVATE_COMMON};
181
182#define devpriv ((struct ni_private *)dev->private)
183
184/* How we access registers */
185
186#define ni_writel(a, b)		(outl((a), (b)+dev->iobase))
187#define ni_readl(a)		(inl((a)+dev->iobase))
188#define ni_writew(a, b)		(outw((a), (b)+dev->iobase))
189#define ni_readw(a)		(inw((a)+dev->iobase))
190#define ni_writeb(a, b)		(outb((a), (b)+dev->iobase))
191#define ni_readb(a)		(inb((a)+dev->iobase))
192
193/* How we access windowed registers */
194
195/* We automatically take advantage of STC registers that can be
196 * read/written directly in the I/O space of the board.  The
197 * DAQCard devices map the low 8 STC registers to iobase+addr*2. */
198
199static void mio_cs_win_out(struct comedi_device *dev, uint16_t data, int addr)
200{
201	unsigned long flags;
202
203	spin_lock_irqsave(&devpriv->window_lock, flags);
204	if (addr < 8) {
205		ni_writew(data, addr * 2);
206	} else {
207		ni_writew(addr, Window_Address);
208		ni_writew(data, Window_Data);
209	}
210	spin_unlock_irqrestore(&devpriv->window_lock, flags);
211}
212
213static uint16_t mio_cs_win_in(struct comedi_device *dev, int addr)
214{
215	unsigned long flags;
216	uint16_t ret;
217
218	spin_lock_irqsave(&devpriv->window_lock, flags);
219	if (addr < 8) {
220		ret = ni_readw(addr * 2);
221	} else {
222		ni_writew(addr, Window_Address);
223		ret = ni_readw(Window_Data);
224	}
225	spin_unlock_irqrestore(&devpriv->window_lock, flags);
226
227	return ret;
228}
229
230static int mio_cs_attach(struct comedi_device *dev,
231			 struct comedi_devconfig *it);
232static int mio_cs_detach(struct comedi_device *dev);
233static struct comedi_driver driver_ni_mio_cs = {
234	.driver_name = "ni_mio_cs",
235	.module = THIS_MODULE,
236	.attach = mio_cs_attach,
237	.detach = mio_cs_detach,
238};
239
240#include "ni_mio_common.c"
241
242static int ni_getboardtype(struct comedi_device *dev,
243			   struct pcmcia_device *link);
244
245/* clean up allocated resources */
246/* called when driver is removed */
247static int mio_cs_detach(struct comedi_device *dev)
248{
249	mio_common_detach(dev);
250
251	/* PCMCIA layer frees the IO region */
252
253	if (dev->irq)
254		free_irq(dev->irq, dev);
255
256	return 0;
257}
258
259static void mio_cs_config(struct pcmcia_device *link);
260static void cs_release(struct pcmcia_device *link);
261static void cs_detach(struct pcmcia_device *);
262
263static struct pcmcia_device *cur_dev = NULL;
264static const dev_info_t dev_info = "ni_mio_cs";
265static dev_node_t dev_node = {
266	"ni_mio_cs",
267	COMEDI_MAJOR, 0,
268	NULL
269};
270
271static int cs_attach(struct pcmcia_device *link)
272{
273	link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
274	link->io.NumPorts1 = 16;
275	link->conf.Attributes = CONF_ENABLE_IRQ;
276	link->conf.IntType = INT_MEMORY_AND_IO;
277
278	cur_dev = link;
279
280	mio_cs_config(link);
281
282	return 0;
283}
284
285static void cs_release(struct pcmcia_device *link)
286{
287	pcmcia_disable_device(link);
288}
289
290static void cs_detach(struct pcmcia_device *link)
291{
292	DPRINTK("cs_detach(link=%p)\n", link);
293
294	if (link->dev_node)
295		cs_release(link);
296}
297
298static int mio_cs_suspend(struct pcmcia_device *link)
299{
300	DPRINTK("pm suspend\n");
301
302	return 0;
303}
304
305static int mio_cs_resume(struct pcmcia_device *link)
306{
307	DPRINTK("pm resume\n");
308	return 0;
309}
310
311
312static int mio_pcmcia_config_loop(struct pcmcia_device *p_dev,
313				cistpl_cftable_entry_t *cfg,
314				cistpl_cftable_entry_t *dflt,
315				unsigned int vcc,
316				void *priv_data)
317{
318	int base, ret;
319
320	p_dev->io.NumPorts1 = cfg->io.win[0].len;
321	p_dev->io.IOAddrLines = cfg->io.flags & CISTPL_IO_LINES_MASK;
322	p_dev->io.NumPorts2 = 0;
323
324	for (base = 0x000; base < 0x400; base += 0x20) {
325		p_dev->io.BasePort1 = base;
326		ret = pcmcia_request_io(p_dev, &p_dev->io);
327		if (!ret)
328			return 0;
329	}
330	return -ENODEV;
331}
332
333
334static void mio_cs_config(struct pcmcia_device *link)
335{
336	int ret;
337
338	DPRINTK("mio_cs_config(link=%p)\n", link);
339
340	ret = pcmcia_loop_config(link, mio_pcmcia_config_loop, NULL);
341	if (ret) {
342		dev_warn(&link->dev, "no configuration found\n");
343		return;
344	}
345
346	if (!link->irq)
347		dev_info(&link->dev, "no IRQ available\n");
348
349	ret = pcmcia_request_configuration(link, &link->conf);
350
351	link->dev_node = &dev_node;
352}
353
354static int mio_cs_attach(struct comedi_device *dev, struct comedi_devconfig *it)
355{
356	struct pcmcia_device *link;
357	unsigned int irq;
358	int ret;
359
360	DPRINTK("mio_cs_attach(dev=%p,it=%p)\n", dev, it);
361
362	link = cur_dev;		/* XXX hack */
363	if (!link)
364		return -EIO;
365
366	dev->driver = &driver_ni_mio_cs;
367	dev->iobase = link->io.BasePort1;
368
369	irq = link->irq;
370
371	printk("comedi%d: %s: DAQCard: io 0x%04lx, irq %u, ",
372	       dev->minor, dev->driver->driver_name, dev->iobase, irq);
373
374#if 0
375	{
376		int i;
377
378		printk(" board fingerprint:");
379		for (i = 0; i < 32; i += 2) {
380			printk(" %04x %02x", inw(dev->iobase + i),
381			       inb(dev->iobase + i + 1));
382		}
383		printk("\n");
384		printk(" board fingerprint (windowed):");
385		for (i = 0; i < 10; i++)
386			printk(" 0x%04x", win_in(i));
387		printk("\n");
388	}
389#endif
390
391	dev->board_ptr = ni_boards + ni_getboardtype(dev, link);
392
393	printk(" %s", boardtype.name);
394	dev->board_name = boardtype.name;
395
396	ret = request_irq(irq, ni_E_interrupt, NI_E_IRQ_FLAGS,
397			  "ni_mio_cs", dev);
398	if (ret < 0) {
399		printk(" irq not available\n");
400		return -EINVAL;
401	}
402	dev->irq = irq;
403
404	/* allocate private area */
405	ret = ni_alloc_private(dev);
406	if (ret < 0)
407		return ret;
408
409	devpriv->stc_writew = &mio_cs_win_out;
410	devpriv->stc_readw = &mio_cs_win_in;
411	devpriv->stc_writel = &win_out2;
412	devpriv->stc_readl = &win_in2;
413
414	ret = ni_E_init(dev, it);
415
416	if (ret < 0)
417		return ret;
418
419	return 0;
420}
421
422static int ni_getboardtype(struct comedi_device *dev,
423			   struct pcmcia_device *link)
424{
425	int i;
426
427	for (i = 0; i < n_ni_boards; i++) {
428		if (ni_boards[i].device_id == link->card_id)
429			return i;
430	}
431
432	printk("unknown board 0x%04x -- pretend it is a ", link->card_id);
433
434	return 0;
435}
436
437#ifdef MODULE
438
439MODULE_LICENSE("GPL");
440
441static struct pcmcia_device_id ni_mio_cs_ids[] = {
442	PCMCIA_DEVICE_MANF_CARD(0x010b, 0x010d),	/* DAQCard-ai-16xe-50 */
443	PCMCIA_DEVICE_MANF_CARD(0x010b, 0x010c),	/* DAQCard-ai-16e-4 */
444	PCMCIA_DEVICE_MANF_CARD(0x010b, 0x02c4),	/* DAQCard-6062E */
445	PCMCIA_DEVICE_MANF_CARD(0x010b, 0x075e),	/* DAQCard-6024E */
446	PCMCIA_DEVICE_MANF_CARD(0x010b, 0x0245),	/* DAQCard-6036E */
447	PCMCIA_DEVICE_NULL
448};
449
450MODULE_DEVICE_TABLE(pcmcia, ni_mio_cs_ids);
451
452struct pcmcia_driver ni_mio_cs_driver = {
453	.probe = &cs_attach,
454	.remove = &cs_detach,
455	.suspend = &mio_cs_suspend,
456	.resume = &mio_cs_resume,
457	.id_table = ni_mio_cs_ids,
458	.owner = THIS_MODULE,
459	.drv = {
460		.name = dev_info,
461		},
462};
463
464int init_module(void)
465{
466	pcmcia_register_driver(&ni_mio_cs_driver);
467	comedi_driver_register(&driver_ni_mio_cs);
468	return 0;
469}
470
471void cleanup_module(void)
472{
473	pcmcia_unregister_driver(&ni_mio_cs_driver);
474#if 0
475	while (cur_dev != NULL)
476		cs_detach(cur_dev->handle);
477#endif
478	comedi_driver_unregister(&driver_ni_mio_cs);
479}
480#endif
481