pcmcia: introduce autoconfiguration feature
[linux-2.6.git] / drivers / staging / comedi / drivers / das08_cs.c
1 /*
2     comedi/drivers/das08_cs.c
3     DAS08 driver
4
5     COMEDI - Linux Control and Measurement Device Interface
6     Copyright (C) 2000 David A. Schleef <ds@schleef.org>
7     Copyright (C) 2001,2002,2003 Frank Mori Hess <fmhess@users.sourceforge.net>
8
9     This program is free software; you can redistribute it and/or modify
10     it under the terms of the GNU General Public License as published by
11     the Free Software Foundation; either version 2 of the License, or
12     (at your option) any later version.
13
14     This program is distributed in the hope that it will be useful,
15     but WITHOUT ANY WARRANTY; without even the implied warranty of
16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17     GNU General Public License for more details.
18
19     You should have received a copy of the GNU General Public License
20     along with this program; if not, write to the Free Software
21     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22
23 *****************************************************************
24
25 */
26 /*
27 Driver: das08_cs
28 Description: DAS-08 PCMCIA boards
29 Author: Warren Jasper, ds, Frank Hess
30 Devices: [ComputerBoards] PCM-DAS08 (pcm-das08)
31 Status: works
32
33 This is the PCMCIA-specific support split off from the
34 das08 driver.
35
36 Options (for pcm-das08):
37         NONE
38
39 Command support does not exist, but could be added for this board.
40 */
41
42 #include "../comedidev.h"
43
44 #include <linux/delay.h>
45 #include <linux/pci.h>
46 #include <linux/slab.h>
47
48 #include "das08.h"
49
50 /* pcmcia includes */
51 #include <pcmcia/cistpl.h>
52 #include <pcmcia/ds.h>
53
54 static struct pcmcia_device *cur_dev;
55
56 #define thisboard ((const struct das08_board_struct *)dev->board_ptr)
57
58 static int das08_cs_attach(struct comedi_device *dev,
59                            struct comedi_devconfig *it);
60
61 static struct comedi_driver driver_das08_cs = {
62         .driver_name = "das08_cs",
63         .module = THIS_MODULE,
64         .attach = das08_cs_attach,
65         .detach = das08_common_detach,
66         .board_name = &das08_cs_boards[0].name,
67         .num_names = ARRAY_SIZE(das08_cs_boards),
68         .offset = sizeof(struct das08_board_struct),
69 };
70
71 static int das08_cs_attach(struct comedi_device *dev,
72                            struct comedi_devconfig *it)
73 {
74         int ret;
75         unsigned long iobase;
76         struct pcmcia_device *link = cur_dev;   /*  XXX hack */
77
78         ret = alloc_private(dev, sizeof(struct das08_private_struct));
79         if (ret < 0)
80                 return ret;
81
82         printk("comedi%d: das08_cs: ", dev->minor);
83         /*  deal with a pci board */
84
85         if (thisboard->bustype == pcmcia) {
86                 if (link == NULL) {
87                         printk(" no pcmcia cards found\n");
88                         return -EIO;
89                 }
90                 iobase = link->resource[0]->start;
91         } else {
92                 printk(" bug! board does not have PCMCIA bustype\n");
93                 return -EINVAL;
94         }
95
96         printk("\n");
97
98         return das08_common_attach(dev, iobase);
99 }
100
101 /*======================================================================
102
103     The following pcmcia code for the pcm-das08 is adapted from the
104     dummy_cs.c driver of the Linux PCMCIA Card Services package.
105
106     The initial developer of the original code is David A. Hinds
107     <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
108     are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
109
110 ======================================================================*/
111
112 static void das08_pcmcia_config(struct pcmcia_device *link);
113 static void das08_pcmcia_release(struct pcmcia_device *link);
114 static int das08_pcmcia_suspend(struct pcmcia_device *p_dev);
115 static int das08_pcmcia_resume(struct pcmcia_device *p_dev);
116
117 /*
118    The attach() and detach() entry points are used to create and destroy
119    "instances" of the driver, where each instance represents everything
120    needed to manage one actual PCMCIA card.
121 */
122
123 static int das08_pcmcia_attach(struct pcmcia_device *);
124 static void das08_pcmcia_detach(struct pcmcia_device *);
125
126 /*
127    You'll also need to prototype all the functions that will actually
128    be used to talk to your device.  See 'memory_cs' for a good example
129    of a fully self-sufficient driver; the other drivers rely more or
130    less on other parts of the kernel.
131 */
132
133 struct local_info_t {
134         struct pcmcia_device *link;
135         int stop;
136         struct bus_operations *bus;
137 };
138
139 /*======================================================================
140
141     das08_pcmcia_attach() creates an "instance" of the driver, allocating
142     local data structures for one device.  The device is registered
143     with Card Services.
144
145     The dev_link structure is initialized, but we don't actually
146     configure the card at this point -- we wait until we receive a
147     card insertion event.
148
149 ======================================================================*/
150
151 static int das08_pcmcia_attach(struct pcmcia_device *link)
152 {
153         struct local_info_t *local;
154
155         dev_dbg(&link->dev, "das08_pcmcia_attach()\n");
156
157         /* Allocate space for private device-specific data */
158         local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
159         if (!local)
160                 return -ENOMEM;
161         local->link = link;
162         link->priv = local;
163
164         cur_dev = link;
165
166         das08_pcmcia_config(link);
167
168         return 0;
169 }                               /* das08_pcmcia_attach */
170
171 /*======================================================================
172
173     This deletes a driver "instance".  The device is de-registered
174     with Card Services.  If it has been released, all local data
175     structures are freed.  Otherwise, the structures will be freed
176     when the device is released.
177
178 ======================================================================*/
179
180 static void das08_pcmcia_detach(struct pcmcia_device *link)
181 {
182
183         dev_dbg(&link->dev, "das08_pcmcia_detach\n");
184
185         ((struct local_info_t *)link->priv)->stop = 1;
186         das08_pcmcia_release(link);
187
188         /* This points to the parent struct local_info_t struct */
189         kfree(link->priv);
190
191 }                               /* das08_pcmcia_detach */
192
193
194 static int das08_pcmcia_config_loop(struct pcmcia_device *p_dev,
195                                 cistpl_cftable_entry_t *cfg,
196                                 cistpl_cftable_entry_t *dflt,
197                                 void *priv_data)
198 {
199         if (cfg->index == 0)
200                 return -ENODEV;
201
202         /* Do we need to allocate an interrupt? */
203         p_dev->config_flags |= CONF_ENABLE_IRQ;
204
205         /* IO window settings */
206         p_dev->resource[0]->end = p_dev->resource[1]->end = 0;
207         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
208                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
209                 p_dev->io_lines = io->flags & CISTPL_IO_LINES_MASK;
210                 p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
211                 p_dev->resource[0]->flags |=
212                         pcmcia_io_cfg_data_width(io->flags);
213                 p_dev->resource[0]->start = io->win[0].base;
214                 p_dev->resource[0]->end = io->win[0].len;
215                 if (io->nwin > 1) {
216                         p_dev->resource[1]->flags = p_dev->resource[0]->flags;
217                         p_dev->resource[1]->start = io->win[1].base;
218                         p_dev->resource[1]->end = io->win[1].len;
219                 }
220                 /* This reserves IO space but doesn't actually enable it */
221                 return pcmcia_request_io(p_dev);
222         }
223         return 0;
224 }
225
226
227 /*======================================================================
228
229     das08_pcmcia_config() is scheduled to run after a CARD_INSERTION event
230     is received, to configure the PCMCIA socket, and to make the
231     device available to the system.
232
233 ======================================================================*/
234
235 static void das08_pcmcia_config(struct pcmcia_device *link)
236 {
237         int ret;
238
239         dev_dbg(&link->dev, "das08_pcmcia_config\n");
240
241         ret = pcmcia_loop_config(link, das08_pcmcia_config_loop, NULL);
242         if (ret) {
243                 dev_warn(&link->dev, "no configuration found\n");
244                 goto failed;
245         }
246
247         if (!link->irq)
248                 goto failed;
249
250         /*
251            This actually configures the PCMCIA socket -- setting up
252            the I/O windows and the interrupt mapping, and putting the
253            card and host interface into "Memory and IO" mode.
254          */
255         ret = pcmcia_enable_device(link);
256         if (ret)
257                 goto failed;
258
259         /* Finally, report what we've done */
260         dev_info(&link->dev, "index 0x%02x", link->config_index);
261         printk(", irq %u", link->irq);
262         if (link->resource[0])
263                 printk(", io %pR", link->resource[0]);
264         if (link->resource[1])
265                 printk(" & %pR", link->resource[1]);
266         printk("\n");
267
268         return;
269
270 failed:
271         das08_pcmcia_release(link);
272
273 }                               /* das08_pcmcia_config */
274
275 /*======================================================================
276
277     After a card is removed, das08_pcmcia_release() will unregister the
278     device, and release the PCMCIA configuration.  If the device is
279     still open, this will be postponed until it is closed.
280
281 ======================================================================*/
282
283 static void das08_pcmcia_release(struct pcmcia_device *link)
284 {
285         dev_dbg(&link->dev, "das08_pcmcia_release\n");
286         pcmcia_disable_device(link);
287 }                               /* das08_pcmcia_release */
288
289 /*======================================================================
290
291     The card status event handler.  Mostly, this schedules other
292     stuff to run after an event is received.
293
294     When a CARD_REMOVAL event is received, we immediately set a
295     private flag to block future accesses to this device.  All the
296     functions that actually access the device should check this flag
297     to make sure the card is still present.
298
299 ======================================================================*/
300
301 static int das08_pcmcia_suspend(struct pcmcia_device *link)
302 {
303         struct local_info_t *local = link->priv;
304         /* Mark the device as stopped, to block IO until later */
305         local->stop = 1;
306
307         return 0;
308 }                               /* das08_pcmcia_suspend */
309
310 static int das08_pcmcia_resume(struct pcmcia_device *link)
311 {
312         struct local_info_t *local = link->priv;
313
314         local->stop = 0;
315         return 0;
316 }                               /* das08_pcmcia_resume */
317
318 /*====================================================================*/
319
320 static struct pcmcia_device_id das08_cs_id_table[] = {
321         PCMCIA_DEVICE_MANF_CARD(0x01c5, 0x4001),
322         PCMCIA_DEVICE_NULL
323 };
324
325 MODULE_DEVICE_TABLE(pcmcia, das08_cs_id_table);
326 MODULE_AUTHOR("David A. Schleef <ds@schleef.org>, "
327               "Frank Mori Hess <fmhess@users.sourceforge.net>");
328 MODULE_DESCRIPTION("Comedi driver for ComputerBoards DAS-08 PCMCIA boards");
329 MODULE_LICENSE("GPL");
330
331 struct pcmcia_driver das08_cs_driver = {
332         .probe = das08_pcmcia_attach,
333         .remove = das08_pcmcia_detach,
334         .suspend = das08_pcmcia_suspend,
335         .resume = das08_pcmcia_resume,
336         .id_table = das08_cs_id_table,
337         .owner = THIS_MODULE,
338         .drv = {
339                 .name = "pcm-das08",
340                 },
341 };
342
343 static int __init init_das08_pcmcia_cs(void)
344 {
345         pcmcia_register_driver(&das08_cs_driver);
346         return 0;
347 }
348
349 static void __exit exit_das08_pcmcia_cs(void)
350 {
351         pr_debug("das08_pcmcia_cs: unloading\n");
352         pcmcia_unregister_driver(&das08_cs_driver);
353 }
354
355 static int __init das08_cs_init_module(void)
356 {
357         int ret;
358
359         ret = init_das08_pcmcia_cs();
360         if (ret < 0)
361                 return ret;
362
363         return comedi_driver_register(&driver_das08_cs);
364 }
365
366 static void __exit das08_cs_exit_module(void)
367 {
368         exit_das08_pcmcia_cs();
369         comedi_driver_unregister(&driver_das08_cs);
370 }
371
372 module_init(das08_cs_init_module);
373 module_exit(das08_cs_exit_module);