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