2 comedi/drivers/ni_labpc_cs.c
3 Driver for National Instruments daqcard-1200 boards
4 Copyright (C) 2001, 2002, 2003 Frank Mori Hess <fmhess@users.sourceforge.net>
6 PCMCIA crap 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.
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.
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.
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.
26 ************************************************************************
30 Description: National Instruments Lab-PC (& compatibles)
31 Author: Frank Mori Hess <fmhess@users.sourceforge.net>
32 Devices: [National Instruments] DAQCard-1200 (daqcard-1200)
35 Thanks go to Fredrik Lingvall for much testing and perseverance in
36 helping to debug daqcard-1200 support.
38 The 1200 series boards have onboard calibration dacs for correcting
39 analog input/output offsets and gains. The proper settings for these
40 caldacs are stored on the board's eeprom. To read the caldac values
41 from the eeprom and store them into a file that can be then be used by
42 comedilib, use the comedi_calibrate program.
44 Configuration options:
47 The daqcard-1200 has quirky chanlist requirements
48 when scanning multiple channels. Multiple channel scan
49 sequence must start at highest channel, then decrement down to
50 channel 0. Chanlists consisting of all one channel
51 are also legal, and allow you to pace conversions in bursts.
58 340988a (daqcard-1200)
62 #undef LABPC_DEBUG /* debugging messages */
64 #include "../comedidev.h"
66 #include <linux/delay.h>
67 #include <linux/slab.h>
71 #include "comedi_fc.h"
74 #include <pcmcia/cs.h>
75 #include <pcmcia/cistpl.h>
76 #include <pcmcia/cisreg.h>
77 #include <pcmcia/ds.h>
79 static struct pcmcia_device *pcmcia_cur_dev;
81 static int labpc_attach(struct comedi_device *dev, struct comedi_devconfig *it);
83 static const struct labpc_board_struct labpc_cs_boards[] = {
85 .name = "daqcard-1200",
86 .device_id = 0x103, /* 0x10b is manufacturer id,
89 .bustype = pcmcia_bustype,
90 .register_layout = labpc_1200_layout,
92 .ai_range_table = &range_labpc_1200_ai,
93 .ai_range_code = labpc_1200_ai_gain_bits,
94 .ai_range_is_unipolar = labpc_1200_is_unipolar,
96 .memory_mapped_io = 0,
98 /* duplicate entry, to support using alternate name */
100 .name = "ni_labpc_cs",
103 .bustype = pcmcia_bustype,
104 .register_layout = labpc_1200_layout,
106 .ai_range_table = &range_labpc_1200_ai,
107 .ai_range_code = labpc_1200_ai_gain_bits,
108 .ai_range_is_unipolar = labpc_1200_is_unipolar,
110 .memory_mapped_io = 0,
115 * Useful for shorthand access to the particular board structure
117 #define thisboard ((const struct labpc_board_struct *)dev->board_ptr)
119 static struct comedi_driver driver_labpc_cs = {
120 .driver_name = "ni_labpc_cs",
121 .module = THIS_MODULE,
122 .attach = &labpc_attach,
123 .detach = &labpc_common_detach,
124 .num_names = ARRAY_SIZE(labpc_cs_boards),
125 .board_name = &labpc_cs_boards[0].name,
126 .offset = sizeof(struct labpc_board_struct),
129 static int labpc_attach(struct comedi_device *dev, struct comedi_devconfig *it)
131 unsigned long iobase = 0;
132 unsigned int irq = 0;
133 struct pcmcia_device *link;
135 /* allocate and initialize dev->private */
136 if (alloc_private(dev, sizeof(struct labpc_private)) < 0)
139 /* get base address, irq etc. based on bustype */
140 switch (thisboard->bustype) {
142 link = pcmcia_cur_dev; /* XXX hack */
145 iobase = link->resource[0]->start;
149 printk("bug! couldn't determine board type\n");
153 return labpc_common_attach(dev, iobase, irq, 0);
156 /*====================================================================*/
159 The event() function is this driver's Card Services event handler.
160 It will be called by Card Services when an appropriate card status
161 event is received. The config() and release() entry points are
162 used to configure or release a socket, in response to card
163 insertion and ejection events. They are invoked from the dummy
166 Kernel version 2.6.16 upwards uses suspend() and resume() functions
167 instead of an event() function.
170 static void labpc_config(struct pcmcia_device *link);
171 static void labpc_release(struct pcmcia_device *link);
172 static int labpc_cs_suspend(struct pcmcia_device *p_dev);
173 static int labpc_cs_resume(struct pcmcia_device *p_dev);
176 The attach() and detach() entry points are used to create and destroy
177 "instances" of the driver, where each instance represents everything
178 needed to manage one actual PCMCIA card.
181 static int labpc_cs_attach(struct pcmcia_device *);
182 static void labpc_cs_detach(struct pcmcia_device *);
185 You'll also need to prototype all the functions that will actually
186 be used to talk to your device. See 'memory_cs' for a good example
187 of a fully self-sufficient driver; the other drivers rely more or
188 less on other parts of the kernel.
191 struct local_info_t {
192 struct pcmcia_device *link;
194 struct bus_operations *bus;
197 /*======================================================================
199 labpc_cs_attach() creates an "instance" of the driver, allocating
200 local data structures for one device. The device is registered
203 The dev_link structure is initialized, but we don't actually
204 configure the card at this point -- we wait until we receive a
205 card insertion event.
207 ======================================================================*/
209 static int labpc_cs_attach(struct pcmcia_device *link)
211 struct local_info_t *local;
213 dev_dbg(&link->dev, "labpc_cs_attach()\n");
215 /* Allocate space for private device-specific data */
216 local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
223 General socket configuration defaults can go here. In this
224 client, we assume very little, and rely on the CIS for almost
225 everything. In most clients, many details (i.e., number, sizes,
226 and attributes of IO windows) are fixed by the nature of the
227 device, and can be hard-wired here.
229 link->conf.Attributes = 0;
230 link->conf.IntType = INT_MEMORY_AND_IO;
232 pcmcia_cur_dev = link;
237 } /* labpc_cs_attach */
239 /*======================================================================
241 This deletes a driver "instance". The device is de-registered
242 with Card Services. If it has been released, all local data
243 structures are freed. Otherwise, the structures will be freed
244 when the device is released.
246 ======================================================================*/
248 static void labpc_cs_detach(struct pcmcia_device *link)
250 dev_dbg(&link->dev, "labpc_cs_detach\n");
253 If the device is currently configured and active, we won't
254 actually delete it yet. Instead, it is marked so that when
255 the release() function is called, that will trigger a proper
258 ((struct local_info_t *)link->priv)->stop = 1;
261 /* This points to the parent local_info_t struct (may be null) */
264 } /* labpc_cs_detach */
266 /*======================================================================
268 labpc_config() is scheduled to run after a CARD_INSERTION event
269 is received, to configure the PCMCIA socket, and to make the
270 device available to the system.
272 ======================================================================*/
274 static int labpc_pcmcia_config_loop(struct pcmcia_device *p_dev,
275 cistpl_cftable_entry_t *cfg,
276 cistpl_cftable_entry_t *dflt,
283 /* Does this card need audio output? */
284 if (cfg->flags & CISTPL_CFTABLE_AUDIO)
285 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
287 /* Do we need to allocate an interrupt? */
288 p_dev->conf.Attributes |= CONF_ENABLE_IRQ | CONF_ENABLE_PULSE_IRQ;
290 /* IO window settings */
291 p_dev->resource[0]->end = p_dev->resource[1]->end = 0;
292 if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
293 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
294 p_dev->io_lines = io->flags & CISTPL_IO_LINES_MASK;
295 p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
296 p_dev->resource[0]->flags |=
297 pcmcia_io_cfg_data_width(io->flags);
298 p_dev->resource[0]->start = io->win[0].base;
299 p_dev->resource[0]->end = io->win[0].len;
301 p_dev->resource[1]->flags = p_dev->resource[0]->flags;
302 p_dev->resource[1]->start = io->win[1].base;
303 p_dev->resource[1]->end = io->win[1].len;
305 /* This reserves IO space but doesn't actually enable it */
306 if (pcmcia_request_io(p_dev) != 0)
310 /* If we got this far, we're cool! */
315 static void labpc_config(struct pcmcia_device *link)
319 dev_dbg(&link->dev, "labpc_config\n");
321 ret = pcmcia_loop_config(link, labpc_pcmcia_config_loop, NULL);
323 dev_warn(&link->dev, "no configuration found\n");
331 This actually configures the PCMCIA socket -- setting up
332 the I/O windows and the interrupt mapping, and putting the
333 card and host interface into "Memory and IO" mode.
335 ret = pcmcia_request_configuration(link, &link->conf);
339 /* Finally, report what we've done */
340 dev_info(&link->dev, "index 0x%02x", link->conf.ConfigIndex);
341 if (link->conf.Attributes & CONF_ENABLE_IRQ)
342 printk(", irq %d", link->irq);
343 if (link->resource[0])
344 printk(" & %pR", link->resource[0]);
345 if (link->resource[1])
346 printk(" & %pR", link->resource[1]);
356 static void labpc_release(struct pcmcia_device *link)
358 dev_dbg(&link->dev, "labpc_release\n");
360 pcmcia_disable_device(link);
361 } /* labpc_release */
363 /*======================================================================
365 The card status event handler. Mostly, this schedules other
366 stuff to run after an event is received.
368 When a CARD_REMOVAL event is received, we immediately set a
369 private flag to block future accesses to this device. All the
370 functions that actually access the device should check this flag
371 to make sure the card is still present.
373 ======================================================================*/
375 static int labpc_cs_suspend(struct pcmcia_device *link)
377 struct local_info_t *local = link->priv;
379 /* Mark the device as stopped, to block IO until later */
382 } /* labpc_cs_suspend */
384 static int labpc_cs_resume(struct pcmcia_device *link)
386 struct local_info_t *local = link->priv;
390 } /* labpc_cs_resume */
392 /*====================================================================*/
394 static struct pcmcia_device_id labpc_cs_ids[] = {
395 /* N.B. These IDs should match those in labpc_cs_boards (ni_labpc.c) */
396 PCMCIA_DEVICE_MANF_CARD(0x010b, 0x0103), /* daqcard-1200 */
400 MODULE_DEVICE_TABLE(pcmcia, labpc_cs_ids);
401 MODULE_AUTHOR("Frank Mori Hess <fmhess@users.sourceforge.net>");
402 MODULE_DESCRIPTION("Comedi driver for National Instruments Lab-PC");
403 MODULE_LICENSE("GPL");
405 struct pcmcia_driver labpc_cs_driver = {
406 .probe = labpc_cs_attach,
407 .remove = labpc_cs_detach,
408 .suspend = labpc_cs_suspend,
409 .resume = labpc_cs_resume,
410 .id_table = labpc_cs_ids,
411 .owner = THIS_MODULE,
413 .name = "daqcard-1200",
417 static int __init init_labpc_cs(void)
419 pcmcia_register_driver(&labpc_cs_driver);
423 static void __exit exit_labpc_cs(void)
425 pcmcia_unregister_driver(&labpc_cs_driver);
428 int __init labpc_init_module(void)
432 ret = init_labpc_cs();
436 return comedi_driver_register(&driver_labpc_cs);
439 void __exit labpc_exit_module(void)
442 comedi_driver_unregister(&driver_labpc_cs);
445 module_init(labpc_init_module);
446 module_exit(labpc_exit_module);