ni_labpc_cs.c revision 37979e1546a790c44adbc7f27a85569944480ebc
1/* 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> 5 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. 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/* 29Driver: ni_labpc_cs 30Description: National Instruments Lab-PC (& compatibles) 31Author: Frank Mori Hess <fmhess@users.sourceforge.net> 32Devices: [National Instruments] DAQCard-1200 (daqcard-1200) 33Status: works 34 35Thanks go to Fredrik Lingvall for much testing and perseverance in 36helping to debug daqcard-1200 support. 37 38The 1200 series boards have onboard calibration dacs for correcting 39analog input/output offsets and gains. The proper settings for these 40caldacs are stored on the board's eeprom. To read the caldac values 41from the eeprom and store them into a file that can be then be used by 42comedilib, use the comedi_calibrate program. 43 44Configuration options: 45 none 46 47The daqcard-1200 has quirky chanlist requirements 48when scanning multiple channels. Multiple channel scan 49sequence must start at highest channel, then decrement down to 50channel 0. Chanlists consisting of all one channel 51are also legal, and allow you to pace conversions in bursts. 52 53*/ 54 55/* 56 57NI manuals: 58340988a (daqcard-1200) 59 60*/ 61 62#undef LABPC_DEBUG /* debugging messages */ 63 64#include "../comedidev.h" 65 66#include <linux/delay.h> 67#include <linux/slab.h> 68 69#include "8253.h" 70#include "8255.h" 71#include "comedi_fc.h" 72#include "ni_labpc.h" 73 74#include <pcmcia/cs.h> 75#include <pcmcia/cistpl.h> 76#include <pcmcia/cisreg.h> 77#include <pcmcia/ds.h> 78 79static struct pcmcia_device *pcmcia_cur_dev; 80 81static int labpc_attach(struct comedi_device *dev, struct comedi_devconfig *it); 82 83static const struct labpc_board_struct labpc_cs_boards[] = { 84 { 85 .name = "daqcard-1200", 86 .device_id = 0x103, /* 0x10b is manufacturer id, 87 0x103 is device id */ 88 .ai_speed = 10000, 89 .bustype = pcmcia_bustype, 90 .register_layout = labpc_1200_layout, 91 .has_ao = 1, 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, 95 .ai_scan_up = 0, 96 .memory_mapped_io = 0, 97 }, 98 /* duplicate entry, to support using alternate name */ 99 { 100 .name = "ni_labpc_cs", 101 .device_id = 0x103, 102 .ai_speed = 10000, 103 .bustype = pcmcia_bustype, 104 .register_layout = labpc_1200_layout, 105 .has_ao = 1, 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, 109 .ai_scan_up = 0, 110 .memory_mapped_io = 0, 111 }, 112}; 113 114/* 115 * Useful for shorthand access to the particular board structure 116 */ 117#define thisboard ((const struct labpc_board_struct *)dev->board_ptr) 118 119static 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), 127}; 128 129static int labpc_attach(struct comedi_device *dev, struct comedi_devconfig *it) 130{ 131 unsigned long iobase = 0; 132 unsigned int irq = 0; 133 struct pcmcia_device *link; 134 135 /* allocate and initialize dev->private */ 136 if (alloc_private(dev, sizeof(struct labpc_private)) < 0) 137 return -ENOMEM; 138 139 /* get base address, irq etc. based on bustype */ 140 switch (thisboard->bustype) { 141 case pcmcia_bustype: 142 link = pcmcia_cur_dev; /* XXX hack */ 143 if (!link) 144 return -EIO; 145 iobase = link->resource[0]->start; 146 irq = link->irq; 147 break; 148 default: 149 printk("bug! couldn't determine board type\n"); 150 return -EINVAL; 151 break; 152 } 153 return labpc_common_attach(dev, iobase, irq, 0); 154} 155 156/*====================================================================*/ 157 158/* 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 164 event handler. 165 166 Kernel version 2.6.16 upwards uses suspend() and resume() functions 167 instead of an event() function. 168*/ 169 170static void labpc_config(struct pcmcia_device *link); 171static void labpc_release(struct pcmcia_device *link); 172static int labpc_cs_suspend(struct pcmcia_device *p_dev); 173static int labpc_cs_resume(struct pcmcia_device *p_dev); 174 175/* 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. 179*/ 180 181static int labpc_cs_attach(struct pcmcia_device *); 182static void labpc_cs_detach(struct pcmcia_device *); 183 184/* 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. 189*/ 190 191struct local_info_t { 192 struct pcmcia_device *link; 193 int stop; 194 struct bus_operations *bus; 195}; 196 197/*====================================================================== 198 199 labpc_cs_attach() creates an "instance" of the driver, allocating 200 local data structures for one device. The device is registered 201 with Card Services. 202 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. 206 207======================================================================*/ 208 209static int labpc_cs_attach(struct pcmcia_device *link) 210{ 211 struct local_info_t *local; 212 213 dev_dbg(&link->dev, "labpc_cs_attach()\n"); 214 215 /* Allocate space for private device-specific data */ 216 local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL); 217 if (!local) 218 return -ENOMEM; 219 local->link = link; 220 link->priv = local; 221 222 /* 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. 228 */ 229 link->conf.Attributes = 0; 230 231 pcmcia_cur_dev = link; 232 233 labpc_config(link); 234 235 return 0; 236} /* labpc_cs_attach */ 237 238/*====================================================================== 239 240 This deletes a driver "instance". The device is de-registered 241 with Card Services. If it has been released, all local data 242 structures are freed. Otherwise, the structures will be freed 243 when the device is released. 244 245======================================================================*/ 246 247static void labpc_cs_detach(struct pcmcia_device *link) 248{ 249 dev_dbg(&link->dev, "labpc_cs_detach\n"); 250 251 /* 252 If the device is currently configured and active, we won't 253 actually delete it yet. Instead, it is marked so that when 254 the release() function is called, that will trigger a proper 255 detach(). 256 */ 257 ((struct local_info_t *)link->priv)->stop = 1; 258 labpc_release(link); 259 260 /* This points to the parent local_info_t struct (may be null) */ 261 kfree(link->priv); 262 263} /* labpc_cs_detach */ 264 265/*====================================================================== 266 267 labpc_config() is scheduled to run after a CARD_INSERTION event 268 is received, to configure the PCMCIA socket, and to make the 269 device available to the system. 270 271======================================================================*/ 272 273static int labpc_pcmcia_config_loop(struct pcmcia_device *p_dev, 274 cistpl_cftable_entry_t *cfg, 275 cistpl_cftable_entry_t *dflt, 276 unsigned int vcc, 277 void *priv_data) 278{ 279 if (cfg->index == 0) 280 return -ENODEV; 281 282 /* Does this card need audio output? */ 283 if (cfg->flags & CISTPL_CFTABLE_AUDIO) 284 p_dev->conf.Attributes |= CONF_ENABLE_SPKR; 285 286 /* Do we need to allocate an interrupt? */ 287 p_dev->conf.Attributes |= CONF_ENABLE_IRQ | CONF_ENABLE_PULSE_IRQ; 288 289 /* IO window settings */ 290 p_dev->resource[0]->end = p_dev->resource[1]->end = 0; 291 if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) { 292 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io; 293 p_dev->io_lines = io->flags & CISTPL_IO_LINES_MASK; 294 p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH; 295 p_dev->resource[0]->flags |= 296 pcmcia_io_cfg_data_width(io->flags); 297 p_dev->resource[0]->start = io->win[0].base; 298 p_dev->resource[0]->end = io->win[0].len; 299 if (io->nwin > 1) { 300 p_dev->resource[1]->flags = p_dev->resource[0]->flags; 301 p_dev->resource[1]->start = io->win[1].base; 302 p_dev->resource[1]->end = io->win[1].len; 303 } 304 /* This reserves IO space but doesn't actually enable it */ 305 if (pcmcia_request_io(p_dev) != 0) 306 return -ENODEV; 307 } 308 309 /* If we got this far, we're cool! */ 310 return 0; 311} 312 313 314static void labpc_config(struct pcmcia_device *link) 315{ 316 int ret; 317 318 dev_dbg(&link->dev, "labpc_config\n"); 319 320 ret = pcmcia_loop_config(link, labpc_pcmcia_config_loop, NULL); 321 if (ret) { 322 dev_warn(&link->dev, "no configuration found\n"); 323 goto failed; 324 } 325 326 if (!link->irq) 327 goto failed; 328 329 /* 330 This actually configures the PCMCIA socket -- setting up 331 the I/O windows and the interrupt mapping, and putting the 332 card and host interface into "Memory and IO" mode. 333 */ 334 ret = pcmcia_request_configuration(link, &link->conf); 335 if (ret) 336 goto failed; 337 338 /* Finally, report what we've done */ 339 dev_info(&link->dev, "index 0x%02x", link->conf.ConfigIndex); 340 if (link->conf.Attributes & CONF_ENABLE_IRQ) 341 printk(", irq %d", link->irq); 342 if (link->resource[0]) 343 printk(" & %pR", link->resource[0]); 344 if (link->resource[1]) 345 printk(" & %pR", link->resource[1]); 346 printk("\n"); 347 348 return; 349 350failed: 351 labpc_release(link); 352 353} /* labpc_config */ 354 355static void labpc_release(struct pcmcia_device *link) 356{ 357 dev_dbg(&link->dev, "labpc_release\n"); 358 359 pcmcia_disable_device(link); 360} /* labpc_release */ 361 362/*====================================================================== 363 364 The card status event handler. Mostly, this schedules other 365 stuff to run after an event is received. 366 367 When a CARD_REMOVAL event is received, we immediately set a 368 private flag to block future accesses to this device. All the 369 functions that actually access the device should check this flag 370 to make sure the card is still present. 371 372======================================================================*/ 373 374static int labpc_cs_suspend(struct pcmcia_device *link) 375{ 376 struct local_info_t *local = link->priv; 377 378 /* Mark the device as stopped, to block IO until later */ 379 local->stop = 1; 380 return 0; 381} /* labpc_cs_suspend */ 382 383static int labpc_cs_resume(struct pcmcia_device *link) 384{ 385 struct local_info_t *local = link->priv; 386 387 local->stop = 0; 388 return 0; 389} /* labpc_cs_resume */ 390 391/*====================================================================*/ 392 393static struct pcmcia_device_id labpc_cs_ids[] = { 394 /* N.B. These IDs should match those in labpc_cs_boards (ni_labpc.c) */ 395 PCMCIA_DEVICE_MANF_CARD(0x010b, 0x0103), /* daqcard-1200 */ 396 PCMCIA_DEVICE_NULL 397}; 398 399MODULE_DEVICE_TABLE(pcmcia, labpc_cs_ids); 400MODULE_AUTHOR("Frank Mori Hess <fmhess@users.sourceforge.net>"); 401MODULE_DESCRIPTION("Comedi driver for National Instruments Lab-PC"); 402MODULE_LICENSE("GPL"); 403 404struct pcmcia_driver labpc_cs_driver = { 405 .probe = labpc_cs_attach, 406 .remove = labpc_cs_detach, 407 .suspend = labpc_cs_suspend, 408 .resume = labpc_cs_resume, 409 .id_table = labpc_cs_ids, 410 .owner = THIS_MODULE, 411 .drv = { 412 .name = "daqcard-1200", 413 }, 414}; 415 416static int __init init_labpc_cs(void) 417{ 418 pcmcia_register_driver(&labpc_cs_driver); 419 return 0; 420} 421 422static void __exit exit_labpc_cs(void) 423{ 424 pcmcia_unregister_driver(&labpc_cs_driver); 425} 426 427int __init labpc_init_module(void) 428{ 429 int ret; 430 431 ret = init_labpc_cs(); 432 if (ret < 0) 433 return ret; 434 435 return comedi_driver_register(&driver_labpc_cs); 436} 437 438void __exit labpc_exit_module(void) 439{ 440 exit_labpc_cs(); 441 comedi_driver_unregister(&driver_labpc_cs); 442} 443 444module_init(labpc_init_module); 445module_exit(labpc_exit_module); 446