pcmcia: do not use io_req_t after call to pcmcia_request_io()
[linux-2.6.git] / drivers / staging / comedi / drivers / ni_daq_dio24.c
1 /*
2     comedi/drivers/ni_daq_dio24.c
3     Driver for National Instruments PCMCIA DAQ-Card DIO-24
4     Copyright (C) 2002 Daniel Vecino Castel <dvecino@able.es>
5
6     PCMCIA crap at end of file is adapted from dummy_cs.c 1.31 2001/08/24 12:13:13
7     from the pcmcia package.
8     The initial developer of the pcmcia dummy_cs.c code is David A. Hinds
9     <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
10     are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
11
12     This program is free software; you can redistribute it and/or modify
13     it under the terms of the GNU General Public License as published by
14     the Free Software Foundation; either version 2 of the License, or
15     (at your option) any later version.
16
17     This program is distributed in the hope that it will be useful,
18     but WITHOUT ANY WARRANTY; without even the implied warranty of
19     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20     GNU General Public License for more details.
21
22     You should have received a copy of the GNU General Public License
23     along with this program; if not, write to the Free Software
24     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25
26 ************************************************************************
27 */
28 /*
29 Driver: ni_daq_dio24
30 Description: National Instruments PCMCIA DAQ-Card DIO-24
31 Author: Daniel Vecino Castel <dvecino@able.es>
32 Devices: [National Instruments] PCMCIA DAQ-Card DIO-24 (ni_daq_dio24)
33 Status: ?
34 Updated: Thu, 07 Nov 2002 21:53:06 -0800
35
36 This is just a wrapper around the 8255.o driver to properly handle
37 the PCMCIA interface.
38 */
39
40                             /* #define LABPC_DEBUG *//*  enable debugging messages */
41 #undef LABPC_DEBUG
42
43 #include <linux/interrupt.h>
44 #include <linux/slab.h>
45 #include "../comedidev.h"
46
47 #include <linux/ioport.h>
48
49 #include "8255.h"
50
51 #include <pcmcia/cs.h>
52 #include <pcmcia/cistpl.h>
53 #include <pcmcia/cisreg.h>
54 #include <pcmcia/ds.h>
55
56 static struct pcmcia_device *pcmcia_cur_dev = NULL;
57
58 #define DIO24_SIZE 4            /*  size of io region used by board */
59
60 static int dio24_attach(struct comedi_device *dev, struct comedi_devconfig *it);
61 static int dio24_detach(struct comedi_device *dev);
62
63 enum dio24_bustype { pcmcia_bustype };
64
65 struct dio24_board_struct {
66         const char *name;
67         int device_id;          /*  device id for pcmcia board */
68         enum dio24_bustype bustype;     /*  PCMCIA */
69         int have_dio;           /*  have 8255 chip */
70         /*  function pointers so we can use inb/outb or readb/writeb as appropriate */
71         unsigned int (*read_byte) (unsigned int address);
72         void (*write_byte) (unsigned int byte, unsigned int address);
73 };
74
75 static const struct dio24_board_struct dio24_boards[] = {
76         {
77          .name = "daqcard-dio24",
78          .device_id = 0x475c,   /*  0x10b is manufacturer id, 0x475c is device id */
79          .bustype = pcmcia_bustype,
80          .have_dio = 1,
81          },
82         {
83          .name = "ni_daq_dio24",
84          .device_id = 0x475c,   /*  0x10b is manufacturer id, 0x475c is device id */
85          .bustype = pcmcia_bustype,
86          .have_dio = 1,
87          },
88 };
89
90 /*
91  * Useful for shorthand access to the particular board structure
92  */
93 #define thisboard ((const struct dio24_board_struct *)dev->board_ptr)
94
95 struct dio24_private {
96
97         int data;               /* number of data points left to be taken */
98 };
99
100 #define devpriv ((struct dio24_private *)dev->private)
101
102 static struct comedi_driver driver_dio24 = {
103         .driver_name = "ni_daq_dio24",
104         .module = THIS_MODULE,
105         .attach = dio24_attach,
106         .detach = dio24_detach,
107         .num_names = ARRAY_SIZE(dio24_boards),
108         .board_name = &dio24_boards[0].name,
109         .offset = sizeof(struct dio24_board_struct),
110 };
111
112 static int dio24_attach(struct comedi_device *dev, struct comedi_devconfig *it)
113 {
114         struct comedi_subdevice *s;
115         unsigned long iobase = 0;
116 #ifdef incomplete
117         unsigned int irq = 0;
118 #endif
119         struct pcmcia_device *link;
120
121         /* allocate and initialize dev->private */
122         if (alloc_private(dev, sizeof(struct dio24_private)) < 0)
123                 return -ENOMEM;
124
125         /*  get base address, irq etc. based on bustype */
126         switch (thisboard->bustype) {
127         case pcmcia_bustype:
128                 link = pcmcia_cur_dev;  /* XXX hack */
129                 if (!link)
130                         return -EIO;
131                 iobase = link->resource[0]->start;
132 #ifdef incomplete
133                 irq = link->irq;
134 #endif
135                 break;
136         default:
137                 printk("bug! couldn't determine board type\n");
138                 return -EINVAL;
139                 break;
140         }
141         printk("comedi%d: ni_daq_dio24: %s, io 0x%lx", dev->minor,
142                thisboard->name, iobase);
143 #ifdef incomplete
144         if (irq) {
145                 printk(", irq %u", irq);
146         }
147 #endif
148
149         printk("\n");
150
151         if (iobase == 0) {
152                 printk("io base address is zero!\n");
153                 return -EINVAL;
154         }
155
156         dev->iobase = iobase;
157
158 #ifdef incomplete
159         /* grab our IRQ */
160         dev->irq = irq;
161 #endif
162
163         dev->board_name = thisboard->name;
164
165         if (alloc_subdevices(dev, 1) < 0)
166                 return -ENOMEM;
167
168         /* 8255 dio */
169         s = dev->subdevices + 0;
170         subdev_8255_init(dev, s, NULL, dev->iobase);
171
172         return 0;
173 };
174
175 static int dio24_detach(struct comedi_device *dev)
176 {
177         printk("comedi%d: ni_daq_dio24: remove\n", dev->minor);
178
179         if (dev->subdevices)
180                 subdev_8255_cleanup(dev, dev->subdevices + 0);
181
182         if (thisboard->bustype != pcmcia_bustype && dev->iobase)
183                 release_region(dev->iobase, DIO24_SIZE);
184         if (dev->irq)
185                 free_irq(dev->irq, dev);
186
187         return 0;
188 };
189
190 /* PCMCIA crap -- watch your words! */
191
192 static void dio24_config(struct pcmcia_device *link);
193 static void dio24_release(struct pcmcia_device *link);
194 static int dio24_cs_suspend(struct pcmcia_device *p_dev);
195 static int dio24_cs_resume(struct pcmcia_device *p_dev);
196
197 /*
198    The attach() and detach() entry points are used to create and destroy
199    "instances" of the driver, where each instance represents everything
200    needed to manage one actual PCMCIA card.
201 */
202
203 static int dio24_cs_attach(struct pcmcia_device *);
204 static void dio24_cs_detach(struct pcmcia_device *);
205
206 /*
207    You'll also need to prototype all the functions that will actually
208    be used to talk to your device.  See 'memory_cs' for a good example
209    of a fully self-sufficient driver; the other drivers rely more or
210    less on other parts of the kernel.
211 */
212
213 /*
214    The dev_info variable is the "key" that is used to match up this
215    device driver with appropriate cards, through the card configuration
216    database.
217 */
218
219 static const dev_info_t dev_info = "ni_daq_dio24";
220
221 struct local_info_t {
222         struct pcmcia_device *link;
223         int stop;
224         struct bus_operations *bus;
225 };
226
227 /*======================================================================
228
229     dio24_cs_attach() creates an "instance" of the driver, allocating
230     local data structures for one device.  The device is registered
231     with Card Services.
232
233     The dev_link structure is initialized, but we don't actually
234     configure the card at this point -- we wait until we receive a
235     card insertion event.
236
237 ======================================================================*/
238
239 static int dio24_cs_attach(struct pcmcia_device *link)
240 {
241         struct local_info_t *local;
242
243         printk(KERN_INFO "ni_daq_dio24: HOLA SOY YO - CS-attach!\n");
244
245         dev_dbg(&link->dev, "dio24_cs_attach()\n");
246
247         /* Allocate space for private device-specific data */
248         local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
249         if (!local)
250                 return -ENOMEM;
251         local->link = link;
252         link->priv = local;
253
254         /*
255            General socket configuration defaults can go here.  In this
256            client, we assume very little, and rely on the CIS for almost
257            everything.  In most clients, many details (i.e., number, sizes,
258            and attributes of IO windows) are fixed by the nature of the
259            device, and can be hard-wired here.
260          */
261         link->conf.Attributes = 0;
262         link->conf.IntType = INT_MEMORY_AND_IO;
263
264         pcmcia_cur_dev = link;
265
266         dio24_config(link);
267
268         return 0;
269 }                               /* dio24_cs_attach */
270
271 /*======================================================================
272
273     This deletes a driver "instance".  The device is de-registered
274     with Card Services.  If it has been released, all local data
275     structures are freed.  Otherwise, the structures will be freed
276     when the device is released.
277
278 ======================================================================*/
279
280 static void dio24_cs_detach(struct pcmcia_device *link)
281 {
282
283         printk(KERN_INFO "ni_daq_dio24: HOLA SOY YO - cs-detach!\n");
284
285         dev_dbg(&link->dev, "dio24_cs_detach\n");
286
287         ((struct local_info_t *)link->priv)->stop = 1;
288         dio24_release(link);
289
290         /* This points to the parent local_info_t struct */
291         if (link->priv)
292                 kfree(link->priv);
293
294 }                               /* dio24_cs_detach */
295
296 /*======================================================================
297
298     dio24_config() is scheduled to run after a CARD_INSERTION event
299     is received, to configure the PCMCIA socket, and to make the
300     device available to the system.
301
302 ======================================================================*/
303
304 static int dio24_pcmcia_config_loop(struct pcmcia_device *p_dev,
305                                 cistpl_cftable_entry_t *cfg,
306                                 cistpl_cftable_entry_t *dflt,
307                                 unsigned int vcc,
308                                 void *priv_data)
309 {
310         win_req_t *req = priv_data;
311         memreq_t map;
312
313         if (cfg->index == 0)
314                 return -ENODEV;
315
316         /* Does this card need audio output? */
317         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
318                 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
319                 p_dev->conf.Status = CCSR_AUDIO_ENA;
320         }
321
322         /* Do we need to allocate an interrupt? */
323         p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
324
325         /* IO window settings */
326         p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
327         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
328                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
329                 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
330                 if (!(io->flags & CISTPL_IO_8BIT))
331                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
332                 if (!(io->flags & CISTPL_IO_16BIT))
333                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
334                 p_dev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
335                 p_dev->io.BasePort1 = io->win[0].base;
336                 p_dev->io.NumPorts1 = io->win[0].len;
337                 if (io->nwin > 1) {
338                         p_dev->io.Attributes2 = p_dev->io.Attributes1;
339                         p_dev->io.BasePort2 = io->win[1].base;
340                         p_dev->io.NumPorts2 = io->win[1].len;
341                 }
342                 /* This reserves IO space but doesn't actually enable it */
343                 if (pcmcia_request_io(p_dev, &p_dev->io) != 0)
344                         return -ENODEV;
345         }
346
347         if ((cfg->mem.nwin > 0) || (dflt->mem.nwin > 0)) {
348                 cistpl_mem_t *mem =
349                         (cfg->mem.nwin) ? &cfg->mem : &dflt->mem;
350                 req->Attributes = WIN_DATA_WIDTH_16 | WIN_MEMORY_TYPE_CM;
351                 req->Attributes |= WIN_ENABLE;
352                 req->Base = mem->win[0].host_addr;
353                 req->Size = mem->win[0].len;
354                 if (req->Size < 0x1000)
355                         req->Size = 0x1000;
356                 req->AccessSpeed = 0;
357                 if (pcmcia_request_window(p_dev, req, &p_dev->win))
358                         return -ENODEV;
359                 map.Page = 0;
360                 map.CardOffset = mem->win[0].card_addr;
361                 if (pcmcia_map_mem_page(p_dev, p_dev->win, &map))
362                         return -ENODEV;
363         }
364         /* If we got this far, we're cool! */
365         return 0;
366 }
367
368 static void dio24_config(struct pcmcia_device *link)
369 {
370         int ret;
371         win_req_t req;
372
373         printk(KERN_INFO "ni_daq_dio24: HOLA SOY YO! - config\n");
374
375         dev_dbg(&link->dev, "dio24_config\n");
376
377         ret = pcmcia_loop_config(link, dio24_pcmcia_config_loop, &req);
378         if (ret) {
379                 dev_warn(&link->dev, "no configuration found\n");
380                 goto failed;
381         }
382
383         if (!link->irq)
384                 goto failed;
385
386         /*
387            This actually configures the PCMCIA socket -- setting up
388            the I/O windows and the interrupt mapping, and putting the
389            card and host interface into "Memory and IO" mode.
390          */
391         ret = pcmcia_request_configuration(link, &link->conf);
392         if (ret)
393                 goto failed;
394
395         /* Finally, report what we've done */
396         dev_info(&link->dev, "index 0x%02x", link->conf.ConfigIndex);
397         if (link->conf.Attributes & CONF_ENABLE_IRQ)
398                 printk(", irq %d", link->irq);
399         if (link->resource[0])
400                 printk(" & %pR", link->resource[0]);
401         if (link->resource[1])
402                 printk(" & %pR", link->resource[1]);
403         if (link->win)
404                 printk(", mem 0x%06lx-0x%06lx", req.Base,
405                        req.Base + req.Size - 1);
406         printk("\n");
407
408         return;
409
410 failed:
411         printk(KERN_INFO "Fallo");
412         dio24_release(link);
413
414 }                               /* dio24_config */
415
416 static void dio24_release(struct pcmcia_device *link)
417 {
418         dev_dbg(&link->dev, "dio24_release\n");
419
420         pcmcia_disable_device(link);
421 }                               /* dio24_release */
422
423 /*======================================================================
424
425     The card status event handler.  Mostly, this schedules other
426     stuff to run after an event is received.
427
428     When a CARD_REMOVAL event is received, we immediately set a
429     private flag to block future accesses to this device.  All the
430     functions that actually access the device should check this flag
431     to make sure the card is still present.
432
433 ======================================================================*/
434
435 static int dio24_cs_suspend(struct pcmcia_device *link)
436 {
437         struct local_info_t *local = link->priv;
438
439         /* Mark the device as stopped, to block IO until later */
440         local->stop = 1;
441         return 0;
442 }                               /* dio24_cs_suspend */
443
444 static int dio24_cs_resume(struct pcmcia_device *link)
445 {
446         struct local_info_t *local = link->priv;
447
448         local->stop = 0;
449         return 0;
450 }                               /* dio24_cs_resume */
451
452 /*====================================================================*/
453
454 static struct pcmcia_device_id dio24_cs_ids[] = {
455         /* N.B. These IDs should match those in dio24_boards */
456         PCMCIA_DEVICE_MANF_CARD(0x010b, 0x475c),        /* daqcard-dio24 */
457         PCMCIA_DEVICE_NULL
458 };
459
460 MODULE_DEVICE_TABLE(pcmcia, dio24_cs_ids);
461 MODULE_AUTHOR("Daniel Vecino Castel <dvecino@able.es>");
462 MODULE_DESCRIPTION("Comedi driver for National Instruments "
463                    "PCMCIA DAQ-Card DIO-24");
464 MODULE_LICENSE("GPL");
465
466 struct pcmcia_driver dio24_cs_driver = {
467         .probe = dio24_cs_attach,
468         .remove = dio24_cs_detach,
469         .suspend = dio24_cs_suspend,
470         .resume = dio24_cs_resume,
471         .id_table = dio24_cs_ids,
472         .owner = THIS_MODULE,
473         .drv = {
474                 .name = dev_info,
475                 },
476 };
477
478 static int __init init_dio24_cs(void)
479 {
480         printk("ni_daq_dio24: HOLA SOY YO!\n");
481         pcmcia_register_driver(&dio24_cs_driver);
482         return 0;
483 }
484
485 static void __exit exit_dio24_cs(void)
486 {
487         pcmcia_unregister_driver(&dio24_cs_driver);
488 }
489
490 int __init init_module(void)
491 {
492         int ret;
493
494         ret = init_dio24_cs();
495         if (ret < 0)
496                 return ret;
497
498         return comedi_driver_register(&driver_dio24);
499 }
500
501 void __exit cleanup_module(void)
502 {
503         exit_dio24_cs();
504         comedi_driver_unregister(&driver_dio24);
505 }