drivers/staging/comedi/drivers/ni_labpc_cs.c

   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 /*
  29 Driver: ni_labpc_cs
  30 Description: National Instruments Lab-PC (& compatibles)
  31 Author: Frank Mori Hess <fmhess@users.sourceforge.net>
  32 Devices: [National Instruments] DAQCard-1200 (daqcard-1200)
  33 Status: works
  34
  35 Thanks go to Fredrik Lingvall for much testing and perseverance in
  36 helping to debug daqcard-1200 support.
  37
  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.
  43
  44 Configuration options:
  45   none
  46
  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.
  52
  53 */
  54
  55 /*
  56
  57 NI manuals:
  58 340988a (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
  79 static struct pcmcia_device *pcmcia_cur_dev;
  80
  81 static int labpc_attach(struct comedi_device *dev, struct comedi_devconfig *it);
  82
  83 static 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
 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),
 127 };
 128
 129 static 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
 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);
 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
 181 static int labpc_cs_attach(struct pcmcia_device *);
 182 static 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
 191 struct 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
 209 static 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         link->conf.IntType = INT_MEMORY_AND_IO;
 231
 232         pcmcia_cur_dev = link;
 233
 234         labpc_config(link);
 235
 236         return 0;
 237 }                               /* labpc_cs_attach */
 238
 239 /*======================================================================
 240
 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.
 245
 246 ======================================================================*/
 247
 248 static void labpc_cs_detach(struct pcmcia_device *link)
 249 {
 250         dev_dbg(&link->dev, "labpc_cs_detach\n");
 251
 252         /*
 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
 256            detach().
 257          */
 258         ((struct local_info_t *)link->priv)->stop = 1;
 259         labpc_release(link);
 260
 261         /* This points to the parent local_info_t struct (may be null) */
 262         kfree(link->priv);
 263
 264 }                               /* labpc_cs_detach */
 265
 266 /*======================================================================
 267
 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.
 271
 272 ======================================================================*/
 273
 274 static int labpc_pcmcia_config_loop(struct pcmcia_device *p_dev,
 275                                 cistpl_cftable_entry_t *cfg,
 276                                 cistpl_cftable_entry_t *dflt,
 277                                 unsigned int vcc,
 278                                 void *priv_data)
 279 {
 280         if (cfg->index == 0)
 281                 return -ENODEV;
 282
 283         /* Does this card need audio output? */
 284         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
 285                 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
 286                 p_dev->conf.Status = CCSR_AUDIO_ENA;
 287         }
 288
 289         /* Do we need to allocate an interrupt? */
 290         p_dev->conf.Attributes |= CONF_ENABLE_IRQ | CONF_ENABLE_PULSE_IRQ;
 291
 292         /* IO window settings */
 293         p_dev->resource[0]->end = p_dev->resource[1]->end = 0;
 294         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
 295                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
 296                 p_dev->io_lines = io->flags & CISTPL_IO_LINES_MASK;
 297                 p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
 298                 p_dev->resource[0]->flags |=
 299                         pcmcia_io_cfg_data_width(io->flags);
 300                 p_dev->resource[0]->start = io->win[0].base;
 301                 p_dev->resource[0]->end = io->win[0].len;
 302                 if (io->nwin > 1) {
 303                         p_dev->resource[1]->flags = p_dev->resource[0]->flags;
 304                         p_dev->resource[1]->start = io->win[1].base;
 305                         p_dev->resource[1]->end = io->win[1].len;
 306                 }
 307                 /* This reserves IO space but doesn't actually enable it */
 308                 if (pcmcia_request_io(p_dev) != 0)
 309                         return -ENODEV;
 310         }
 311
 312         /* If we got this far, we're cool! */
 313         return 0;
 314 }
 315
 316
 317 static void labpc_config(struct pcmcia_device *link)
 318 {
 319         int ret;
 320
 321         dev_dbg(&link->dev, "labpc_config\n");
 322
 323         ret = pcmcia_loop_config(link, labpc_pcmcia_config_loop, NULL);
 324         if (ret) {
 325                 dev_warn(&link->dev, "no configuration found\n");
 326                 goto failed;
 327         }
 328
 329         if (!link->irq)
 330                 goto failed;
 331
 332         /*
 333            This actually configures the PCMCIA socket -- setting up
 334            the I/O windows and the interrupt mapping, and putting the
 335            card and host interface into "Memory and IO" mode.
 336          */
 337         ret = pcmcia_request_configuration(link, &link->conf);
 338         if (ret)
 339                 goto failed;
 340
 341         /* Finally, report what we've done */
 342         dev_info(&link->dev, "index 0x%02x", link->conf.ConfigIndex);
 343         if (link->conf.Attributes & CONF_ENABLE_IRQ)
 344                 printk(", irq %d", link->irq);
 345         if (link->resource[0])
 346                 printk(" & %pR", link->resource[0]);
 347         if (link->resource[1])
 348                 printk(" & %pR", link->resource[1]);
 349         printk("\n");
 350
 351         return;
 352
 353 failed:
 354         labpc_release(link);
 355
 356 }                               /* labpc_config */
 357
 358 static void labpc_release(struct pcmcia_device *link)
 359 {
 360         dev_dbg(&link->dev, "labpc_release\n");
 361
 362         pcmcia_disable_device(link);
 363 }                               /* labpc_release */
 364
 365 /*======================================================================
 366
 367     The card status event handler.  Mostly, this schedules other
 368     stuff to run after an event is received.
 369
 370     When a CARD_REMOVAL event is received, we immediately set a
 371     private flag to block future accesses to this device.  All the
 372     functions that actually access the device should check this flag
 373     to make sure the card is still present.
 374
 375 ======================================================================*/
 376
 377 static int labpc_cs_suspend(struct pcmcia_device *link)
 378 {
 379         struct local_info_t *local = link->priv;
 380
 381         /* Mark the device as stopped, to block IO until later */
 382         local->stop = 1;
 383         return 0;
 384 }                               /* labpc_cs_suspend */
 385
 386 static int labpc_cs_resume(struct pcmcia_device *link)
 387 {
 388         struct local_info_t *local = link->priv;
 389
 390         local->stop = 0;
 391         return 0;
 392 }                               /* labpc_cs_resume */
 393
 394 /*====================================================================*/
 395
 396 static struct pcmcia_device_id labpc_cs_ids[] = {
 397         /* N.B. These IDs should match those in labpc_cs_boards (ni_labpc.c) */
 398         PCMCIA_DEVICE_MANF_CARD(0x010b, 0x0103),        /* daqcard-1200 */
 399         PCMCIA_DEVICE_NULL
 400 };
 401
 402 MODULE_DEVICE_TABLE(pcmcia, labpc_cs_ids);
 403 MODULE_AUTHOR("Frank Mori Hess <fmhess@users.sourceforge.net>");
 404 MODULE_DESCRIPTION("Comedi driver for National Instruments Lab-PC");
 405 MODULE_LICENSE("GPL");
 406
 407 struct pcmcia_driver labpc_cs_driver = {
 408         .probe = labpc_cs_attach,
 409         .remove = labpc_cs_detach,
 410         .suspend = labpc_cs_suspend,
 411         .resume = labpc_cs_resume,
 412         .id_table = labpc_cs_ids,
 413         .owner = THIS_MODULE,
 414         .drv = {
 415                 .name = "daqcard-1200",
 416                 },
 417 };
 418
 419 static int __init init_labpc_cs(void)
 420 {
 421         pcmcia_register_driver(&labpc_cs_driver);
 422         return 0;
 423 }
 424
 425 static void __exit exit_labpc_cs(void)
 426 {
 427         pcmcia_unregister_driver(&labpc_cs_driver);
 428 }
 429
 430 int __init labpc_init_module(void)
 431 {
 432         int ret;
 433
 434         ret = init_labpc_cs();
 435         if (ret < 0)
 436                 return ret;
 437
 438         return comedi_driver_register(&driver_labpc_cs);
 439 }
 440
 441 void __exit labpc_exit_module(void)
 442 {
 443         exit_labpc_cs();
 444         comedi_driver_unregister(&driver_labpc_cs);
 445 }
 446
 447 module_init(labpc_init_module);
 448 module_exit(labpc_exit_module);