2 comedi/drivers/das08_cs.c
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>
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.
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.
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.
23 *****************************************************************
28 Description: DAS-08 PCMCIA boards
29 Author: Warren Jasper, ds, Frank Hess
30 Devices: [ComputerBoards] PCM-DAS08 (pcm-das08)
33 This is the PCMCIA-specific support split off from the
36 Options (for pcm-das08):
39 Command support does not exist, but could be added for this board.
42 #include "../comedidev.h"
44 #include <linux/delay.h>
45 #include <linux/pci.h>
50 #include <pcmcia/cs_types.h>
51 #include <pcmcia/cs.h>
52 #include <pcmcia/cistpl.h>
53 #include <pcmcia/ds.h>
55 static struct pcmcia_device *cur_dev = NULL;
57 #define thisboard ((const struct das08_board_struct *)dev->board_ptr)
59 static int das08_cs_attach(struct comedi_device * dev, struct comedi_devconfig * it);
61 static struct comedi_driver driver_das08_cs = {
62 driver_name:"das08_cs",
64 attach:das08_cs_attach,
65 detach:das08_common_detach,
66 board_name:&das08_cs_boards[0].name,
67 num_names:sizeof(das08_cs_boards) /
68 sizeof(struct das08_board_struct),
69 offset:sizeof(struct das08_board_struct),
72 static int das08_cs_attach(struct comedi_device * dev, struct comedi_devconfig * it)
76 struct pcmcia_device *link = cur_dev; // XXX hack
78 if ((ret = alloc_private(dev, sizeof(struct das08_private_struct))) < 0)
81 printk("comedi%d: das08_cs: ", dev->minor);
82 // deal with a pci board
84 if (thisboard->bustype == pcmcia) {
86 printk(" no pcmcia cards found\n");
89 iobase = link->io.BasePort1;
91 printk(" bug! board does not have PCMCIA bustype\n");
97 return das08_common_attach(dev, iobase);
100 /*======================================================================
102 The following pcmcia code for the pcm-das08 is adapted from the
103 dummy_cs.c driver of the Linux PCMCIA Card Services package.
105 The initial developer of the original code is David A. Hinds
106 <dahinds@users.sourceforge.net>. Portions created by David A. Hinds
107 are Copyright (C) 1999 David A. Hinds. All Rights Reserved.
109 ======================================================================*/
112 All the PCMCIA modules use PCMCIA_DEBUG to control debugging. If
113 you do not define PCMCIA_DEBUG at all, all the debug code will be
114 left out. If you compile with PCMCIA_DEBUG=0, the debug code will
115 be present but disabled -- but it can then be enabled for specific
116 modules at load time with a 'pc_debug=#' option to insmod.
120 static int pc_debug = PCMCIA_DEBUG;
121 module_param(pc_debug, int, 0644);
122 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
123 static const char *version =
124 "das08.c pcmcia code (Frank Hess), modified from dummy_cs.c 1.31 2001/08/24 12:13:13 (David Hinds)";
126 #define DEBUG(n, args...)
129 /*====================================================================*/
130 static void das08_pcmcia_config(struct pcmcia_device *link);
131 static void das08_pcmcia_release(struct pcmcia_device *link);
132 static int das08_pcmcia_suspend(struct pcmcia_device *p_dev);
133 static int das08_pcmcia_resume(struct pcmcia_device *p_dev);
136 The attach() and detach() entry points are used to create and destroy
137 "instances" of the driver, where each instance represents everything
138 needed to manage one actual PCMCIA card.
141 static int das08_pcmcia_attach(struct pcmcia_device *);
142 static void das08_pcmcia_detach(struct pcmcia_device *);
145 You'll also need to prototype all the functions that will actually
146 be used to talk to your device. See 'memory_cs' for a good example
147 of a fully self-sufficient driver; the other drivers rely more or
148 less on other parts of the kernel.
152 The dev_info variable is the "key" that is used to match up this
153 device driver with appropriate cards, through the card configuration
157 static const dev_info_t dev_info = "pcm-das08";
159 struct local_info_t {
160 struct pcmcia_device *link;
163 struct bus_operations *bus;
166 /*======================================================================
168 das08_pcmcia_attach() creates an "instance" of the driver, allocating
169 local data structures for one device. The device is registered
172 The dev_link structure is initialized, but we don't actually
173 configure the card at this point -- we wait until we receive a
174 card insertion event.
176 ======================================================================*/
178 static int das08_pcmcia_attach(struct pcmcia_device *link)
180 struct local_info_t *local;
182 DEBUG(0, "das08_pcmcia_attach()\n");
184 /* Allocate space for private device-specific data */
185 local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
191 /* Interrupt setup */
192 link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
193 link->irq.IRQInfo1 = IRQ_LEVEL_ID;
194 link->irq.Handler = NULL;
197 General socket configuration defaults can go here. In this
198 client, we assume very little, and rely on the CIS for almost
199 everything. In most clients, many details (i.e., number, sizes,
200 and attributes of IO windows) are fixed by the nature of the
201 device, and can be hard-wired here.
203 link->conf.Attributes = 0;
204 link->conf.IntType = INT_MEMORY_AND_IO;
208 das08_pcmcia_config(link);
211 } /* das08_pcmcia_attach */
213 /*======================================================================
215 This deletes a driver "instance". The device is de-registered
216 with Card Services. If it has been released, all local data
217 structures are freed. Otherwise, the structures will be freed
218 when the device is released.
220 ======================================================================*/
222 static void das08_pcmcia_detach(struct pcmcia_device *link)
225 DEBUG(0, "das08_pcmcia_detach(0x%p)\n", link);
227 if (link->dev_node) {
228 ((struct local_info_t *) link->priv)->stop = 1;
229 das08_pcmcia_release(link);
232 /* This points to the parent struct local_info_t struct */
236 } /* das08_pcmcia_detach */
238 /*======================================================================
240 das08_pcmcia_config() is scheduled to run after a CARD_INSERTION event
241 is received, to configure the PCMCIA socket, and to make the
242 device available to the system.
244 ======================================================================*/
246 static void das08_pcmcia_config(struct pcmcia_device *link)
248 struct local_info_t *dev = link->priv;
251 int last_fn, last_ret;
253 cistpl_cftable_entry_t dflt = { 0 };
255 DEBUG(0, "das08_pcmcia_config(0x%p)\n", link);
258 This reads the card's CONFIG tuple to find its configuration
261 tuple.DesiredTuple = CISTPL_CONFIG;
262 tuple.Attributes = 0;
263 tuple.TupleData = buf;
264 tuple.TupleDataMax = sizeof(buf);
265 tuple.TupleOffset = 0;
266 last_fn = GetFirstTuple;
267 if ((last_ret = pcmcia_get_first_tuple(link, &tuple)) != 0)
269 last_fn = GetTupleData;
270 if ((last_ret = pcmcia_get_tuple_data(link, &tuple)) != 0)
272 last_fn = ParseTuple;
273 if ((last_ret = pcmcia_parse_tuple(&tuple, &parse)) != 0)
275 link->conf.ConfigBase = parse.config.base;
276 link->conf.Present = parse.config.rmask[0];
279 In this loop, we scan the CIS for configuration table entries,
280 each of which describes a valid card configuration, including
281 voltage, IO window, memory window, and interrupt settings.
283 We make no assumptions about the card to be configured: we use
284 just the information available in the CIS. In an ideal world,
285 this would work for any PCMCIA card, but it requires a complete
286 and accurate CIS. In practice, a driver usually "knows" most of
287 these things without consulting the CIS, and most client drivers
288 will only use the CIS to fill in implementation-defined details.
290 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
291 last_fn = GetFirstTuple;
292 if ((last_ret = pcmcia_get_first_tuple(link, &tuple)) != 0)
295 cistpl_cftable_entry_t *cfg = &(parse.cftable_entry);
296 if ((last_ret = pcmcia_get_tuple_data(link, &tuple)) != 0)
298 if ((last_ret = pcmcia_parse_tuple(&tuple, &parse)) != 0)
301 if (cfg->flags & CISTPL_CFTABLE_DEFAULT)
305 link->conf.ConfigIndex = cfg->index;
307 /* Does this card need audio output? */
308 /* if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
309 link->conf.Attributes |= CONF_ENABLE_SPKR;
310 link->conf.Status = CCSR_AUDIO_ENA;
313 /* Do we need to allocate an interrupt? */
314 if (cfg->irq.IRQInfo1 || dflt.irq.IRQInfo1)
315 link->conf.Attributes |= CONF_ENABLE_IRQ;
317 /* IO window settings */
318 link->io.NumPorts1 = link->io.NumPorts2 = 0;
319 if ((cfg->io.nwin > 0) || (dflt.io.nwin > 0)) {
320 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt.io;
321 link->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
322 if (!(io->flags & CISTPL_IO_8BIT))
323 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
324 if (!(io->flags & CISTPL_IO_16BIT))
325 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
326 link->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
327 link->io.BasePort1 = io->win[0].base;
328 link->io.NumPorts1 = io->win[0].len;
330 link->io.Attributes2 = link->io.Attributes1;
331 link->io.BasePort2 = io->win[1].base;
332 link->io.NumPorts2 = io->win[1].len;
334 /* This reserves IO space but doesn't actually enable it */
335 if (pcmcia_request_io(link, &link->io) != 0)
339 /* If we got this far, we're cool! */
343 last_fn = GetNextTuple;
344 if ((last_ret = pcmcia_get_next_tuple(link, &tuple)) != 0)
348 if (link->conf.Attributes & CONF_ENABLE_IRQ) {
349 last_fn = RequestIRQ;
350 if ((last_ret = pcmcia_request_irq(link, &link->irq)) != 0)
355 This actually configures the PCMCIA socket -- setting up
356 the I/O windows and the interrupt mapping, and putting the
357 card and host interface into "Memory and IO" mode.
359 last_fn = RequestConfiguration;
360 if ((last_ret = pcmcia_request_configuration(link, &link->conf)) != 0)
364 At this point, the dev_node_t structure(s) need to be
365 initialized and arranged in a linked list at link->dev.
367 sprintf(dev->node.dev_name, "pcm-das08");
368 dev->node.major = dev->node.minor = 0;
369 link->dev_node = &dev->node;
371 /* Finally, report what we've done */
372 printk(KERN_INFO "%s: index 0x%02x",
373 dev->node.dev_name, link->conf.ConfigIndex);
374 if (link->conf.Attributes & CONF_ENABLE_IRQ)
375 printk(", irq %u", link->irq.AssignedIRQ);
376 if (link->io.NumPorts1)
377 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
378 link->io.BasePort1 + link->io.NumPorts1 - 1);
379 if (link->io.NumPorts2)
380 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
381 link->io.BasePort2 + link->io.NumPorts2 - 1);
387 cs_error(link, last_fn, last_ret);
388 das08_pcmcia_release(link);
390 } /* das08_pcmcia_config */
392 /*======================================================================
394 After a card is removed, das08_pcmcia_release() will unregister the
395 device, and release the PCMCIA configuration. If the device is
396 still open, this will be postponed until it is closed.
398 ======================================================================*/
400 static void das08_pcmcia_release(struct pcmcia_device *link)
402 DEBUG(0, "das08_pcmcia_release(0x%p)\n", link);
403 pcmcia_disable_device(link);
404 } /* das08_pcmcia_release */
406 /*======================================================================
408 The card status event handler. Mostly, this schedules other
409 stuff to run after an event is received.
411 When a CARD_REMOVAL event is received, we immediately set a
412 private flag to block future accesses to this device. All the
413 functions that actually access the device should check this flag
414 to make sure the card is still present.
416 ======================================================================*/
418 static int das08_pcmcia_suspend(struct pcmcia_device *link)
420 struct local_info_t *local = link->priv;
421 /* Mark the device as stopped, to block IO until later */
425 } /* das08_pcmcia_suspend */
427 static int das08_pcmcia_resume(struct pcmcia_device *link)
429 struct local_info_t *local = link->priv;
433 } /* das08_pcmcia_resume */
435 /*====================================================================*/
437 static struct pcmcia_device_id das08_cs_id_table[] = {
438 PCMCIA_DEVICE_MANF_CARD(0x01c5, 0x4001),
442 MODULE_DEVICE_TABLE(pcmcia, das08_cs_id_table);
444 struct pcmcia_driver das08_cs_driver = {
445 .probe = das08_pcmcia_attach,
446 .remove = das08_pcmcia_detach,
447 .suspend = das08_pcmcia_suspend,
448 .resume = das08_pcmcia_resume,
449 .id_table = das08_cs_id_table,
450 .owner = THIS_MODULE,
456 static int __init init_das08_pcmcia_cs(void)
458 DEBUG(0, "%s\n", version);
459 pcmcia_register_driver(&das08_cs_driver);
463 static void __exit exit_das08_pcmcia_cs(void)
465 DEBUG(0, "das08_pcmcia_cs: unloading\n");
466 pcmcia_unregister_driver(&das08_cs_driver);
469 static int __init das08_cs_init_module(void)
473 ret = init_das08_pcmcia_cs();
477 return comedi_driver_register(&driver_das08_cs);
480 static void __exit das08_cs_exit_module(void)
482 exit_das08_pcmcia_cs();
483 comedi_driver_unregister(&driver_das08_cs);
486 MODULE_LICENSE("GPL");
487 module_init(das08_cs_init_module);
488 module_exit(das08_cs_exit_module);