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_types.h>
  75 #include <pcmcia/cs.h>
  76 #include <pcmcia/cistpl.h>
  77 #include <pcmcia/cisreg.h>
  78 #include <pcmcia/ds.h>
  79
  80 static struct pcmcia_device *pcmcia_cur_dev;
  81
  82 static int labpc_attach(struct comedi_device *dev, struct comedi_devconfig *it);
  83
  84 static const struct labpc_board_struct labpc_cs_boards[] = {
  85         {
  86          .name = "daqcard-1200",
  87          .device_id = 0x103,    /* 0x10b is manufacturer id,
  88                                    0x103 is device id */
  89          .ai_speed = 10000,
  90          .bustype = pcmcia_bustype,
  91          .register_layout = labpc_1200_layout,
  92          .has_ao = 1,
  93          .ai_range_table = &range_labpc_1200_ai,
  94          .ai_range_code = labpc_1200_ai_gain_bits,
  95          .ai_range_is_unipolar = labpc_1200_is_unipolar,
  96          .ai_scan_up = 0,
  97          .memory_mapped_io = 0,
  98          },
  99         /* duplicate entry, to support using alternate name */
 100         {
 101          .name = "ni_labpc_cs",
 102          .device_id = 0x103,
 103          .ai_speed = 10000,
 104          .bustype = pcmcia_bustype,
 105          .register_layout = labpc_1200_layout,
 106          .has_ao = 1,
 107          .ai_range_table = &range_labpc_1200_ai,
 108          .ai_range_code = labpc_1200_ai_gain_bits,
 109          .ai_range_is_unipolar = labpc_1200_is_unipolar,
 110          .ai_scan_up = 0,
 111          .memory_mapped_io = 0,
 112          },
 113 };
 114
 115 /*
 116  * Useful for shorthand access to the particular board structure
 117  */
 118 #define thisboard ((const struct labpc_board_struct *)dev->board_ptr)
 119
 120 static struct comedi_driver driver_labpc_cs = {
 121         .driver_name = "ni_labpc_cs",
 122         .module = THIS_MODULE,
 123         .attach = &labpc_attach,
 124         .detach = &labpc_common_detach,
 125         .num_names = ARRAY_SIZE(labpc_cs_boards),
 126         .board_name = &labpc_cs_boards[0].name,
 127         .offset = sizeof(struct labpc_board_struct),
 128 };
 129
 130 static int labpc_attach(struct comedi_device *dev, struct comedi_devconfig *it)
 131 {
 132         unsigned long iobase = 0;
 133         unsigned int irq = 0;
 134         struct pcmcia_device *link;
 135
 136         /* allocate and initialize dev->private */
 137         if (alloc_private(dev, sizeof(struct labpc_private)) < 0)
 138                 return -ENOMEM;
 139
 140         /*  get base address, irq etc. based on bustype */
 141         switch (thisboard->bustype) {
 142         case pcmcia_bustype:
 143                 link = pcmcia_cur_dev;  /* XXX hack */
 144                 if (!link)
 145                         return -EIO;
 146                 iobase = link->io.BasePort1;
 147                 irq = link->irq;
 148                 break;
 149         default:
 150                 printk("bug! couldn't determine board type\n");
 151                 return -EINVAL;
 152                 break;
 153         }
 154         return labpc_common_attach(dev, iobase, irq, 0);
 155 }
 156
 157 /*====================================================================*/
 158
 159 /*
 160    The event() function is this driver's Card Services event handler.
 161    It will be called by Card Services when an appropriate card status
 162    event is received.  The config() and release() entry points are
 163    used to configure or release a socket, in response to card
 164    insertion and ejection events.  They are invoked from the dummy
 165    event handler.
 166
 167    Kernel version 2.6.16 upwards uses suspend() and resume() functions
 168    instead of an event() function.
 169 */
 170
 171 static void labpc_config(struct pcmcia_device *link);
 172 static void labpc_release(struct pcmcia_device *link);
 173 static int labpc_cs_suspend(struct pcmcia_device *p_dev);
 174 static int labpc_cs_resume(struct pcmcia_device *p_dev);
 175
 176 /*
 177    The attach() and detach() entry points are used to create and destroy
 178    "instances" of the driver, where each instance represents everything
 179    needed to manage one actual PCMCIA card.
 180 */
 181
 182 static int labpc_cs_attach(struct pcmcia_device *);
 183 static void labpc_cs_detach(struct pcmcia_device *);
 184
 185 /*
 186    You'll also need to prototype all the functions that will actually
 187    be used to talk to your device.  See 'memory_cs' for a good example
 188    of a fully self-sufficient driver; the other drivers rely more or
 189    less on other parts of the kernel.
 190 */
 191
 192 /*
 193    The dev_info variable is the "key" that is used to match up this
 194    device driver with appropriate cards, through the card configuration
 195    database.
 196 */
 197
 198 static const dev_info_t dev_info = "daqcard-1200";
 199
 200 struct local_info_t {
 201         struct pcmcia_device *link;
 202         int stop;
 203         struct bus_operations *bus;
 204 };
 205
 206 /*======================================================================
 207
 208     labpc_cs_attach() creates an "instance" of the driver, allocating
 209     local data structures for one device.  The device is registered
 210     with Card Services.
 211
 212     The dev_link structure is initialized, but we don't actually
 213     configure the card at this point -- we wait until we receive a
 214     card insertion event.
 215
 216 ======================================================================*/
 217
 218 static int labpc_cs_attach(struct pcmcia_device *link)
 219 {
 220         struct local_info_t *local;
 221
 222         dev_dbg(&link->dev, "labpc_cs_attach()\n");
 223
 224         /* Allocate space for private device-specific data */
 225         local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
 226         if (!local)
 227                 return -ENOMEM;
 228         local->link = link;
 229         link->priv = local;
 230
 231         /*
 232            General socket configuration defaults can go here.  In this
 233            client, we assume very little, and rely on the CIS for almost
 234            everything.  In most clients, many details (i.e., number, sizes,
 235            and attributes of IO windows) are fixed by the nature of the
 236            device, and can be hard-wired here.
 237          */
 238         link->conf.Attributes = 0;
 239         link->conf.IntType = INT_MEMORY_AND_IO;
 240
 241         pcmcia_cur_dev = link;
 242
 243         labpc_config(link);
 244
 245         return 0;
 246 }                               /* labpc_cs_attach */
 247
 248 /*======================================================================
 249
 250     This deletes a driver "instance".  The device is de-registered
 251     with Card Services.  If it has been released, all local data
 252     structures are freed.  Otherwise, the structures will be freed
 253     when the device is released.
 254
 255 ======================================================================*/
 256
 257 static void labpc_cs_detach(struct pcmcia_device *link)
 258 {
 259         dev_dbg(&link->dev, "labpc_cs_detach\n");
 260
 261         /*
 262            If the device is currently configured and active, we won't
 263            actually delete it yet.  Instead, it is marked so that when
 264            the release() function is called, that will trigger a proper
 265            detach().
 266          */
 267         ((struct local_info_t *)link->priv)->stop = 1;
 268         labpc_release(link);
 269
 270         /* This points to the parent local_info_t struct (may be null) */
 271         kfree(link->priv);
 272
 273 }                               /* labpc_cs_detach */
 274
 275 /*======================================================================
 276
 277     labpc_config() is scheduled to run after a CARD_INSERTION event
 278     is received, to configure the PCMCIA socket, and to make the
 279     device available to the system.
 280
 281 ======================================================================*/
 282
 283 static int labpc_pcmcia_config_loop(struct pcmcia_device *p_dev,
 284                                 cistpl_cftable_entry_t *cfg,
 285                                 cistpl_cftable_entry_t *dflt,
 286                                 unsigned int vcc,
 287                                 void *priv_data)
 288 {
 289         win_req_t *req = priv_data;
 290         memreq_t map;
 291
 292         if (cfg->index == 0)
 293                 return -ENODEV;
 294
 295         /* Does this card need audio output? */
 296         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
 297                 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
 298                 p_dev->conf.Status = CCSR_AUDIO_ENA;
 299         }
 300
 301         /* Do we need to allocate an interrupt? */
 302         p_dev->conf.Attributes |= CONF_ENABLE_IRQ | CONF_ENABLE_PULSE_IRQ;
 303
 304         /* IO window settings */
 305         p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
 306         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
 307                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
 308                 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 309                 if (!(io->flags & CISTPL_IO_8BIT))
 310                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
 311                 if (!(io->flags & CISTPL_IO_16BIT))
 312                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 313                 p_dev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
 314                 p_dev->io.BasePort1 = io->win[0].base;
 315                 p_dev->io.NumPorts1 = io->win[0].len;
 316                 if (io->nwin > 1) {
 317                         p_dev->io.Attributes2 = p_dev->io.Attributes1;
 318                         p_dev->io.BasePort2 = io->win[1].base;
 319                         p_dev->io.NumPorts2 = io->win[1].len;
 320                 }
 321                 /* This reserves IO space but doesn't actually enable it */
 322                 if (pcmcia_request_io(p_dev, &p_dev->io) != 0)
 323                         return -ENODEV;
 324         }
 325
 326         if ((cfg->mem.nwin > 0) || (dflt->mem.nwin > 0)) {
 327                 cistpl_mem_t *mem =
 328                         (cfg->mem.nwin) ? &cfg->mem : &dflt->mem;
 329                 req->Attributes = WIN_DATA_WIDTH_16 | WIN_MEMORY_TYPE_CM;
 330                 req->Attributes |= WIN_ENABLE;
 331                 req->Base = mem->win[0].host_addr;
 332                 req->Size = mem->win[0].len;
 333                 if (req->Size < 0x1000)
 334                         req->Size = 0x1000;
 335                 req->AccessSpeed = 0;
 336                 if (pcmcia_request_window(p_dev, req, &p_dev->win))
 337                         return -ENODEV;
 338                 map.Page = 0;
 339                 map.CardOffset = mem->win[0].card_addr;
 340                 if (pcmcia_map_mem_page(p_dev, p_dev->win, &map))
 341                         return -ENODEV;
 342         }
 343         /* If we got this far, we're cool! */
 344         return 0;
 345 }
 346
 347
 348 static void labpc_config(struct pcmcia_device *link)
 349 {
 350         int ret;
 351         win_req_t req;
 352
 353         dev_dbg(&link->dev, "labpc_config\n");
 354
 355         ret = pcmcia_loop_config(link, labpc_pcmcia_config_loop, &req);
 356         if (ret) {
 357                 dev_warn(&link->dev, "no configuration found\n");
 358                 goto failed;
 359         }
 360
 361         if (!link->irq)
 362                 goto failed;
 363
 364         /*
 365            This actually configures the PCMCIA socket -- setting up
 366            the I/O windows and the interrupt mapping, and putting the
 367            card and host interface into "Memory and IO" mode.
 368          */
 369         ret = pcmcia_request_configuration(link, &link->conf);
 370         if (ret)
 371                 goto failed;
 372
 373         /* Finally, report what we've done */
 374         dev_info(&link->dev, "index 0x%02x", link->conf.ConfigIndex);
 375         if (link->conf.Attributes & CONF_ENABLE_IRQ)
 376                 printk(", irq %d", link->irq);
 377         if (link->io.NumPorts1)
 378                 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
 379                        link->io.BasePort1 + link->io.NumPorts1 - 1);
 380         if (link->io.NumPorts2)
 381                 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
 382                        link->io.BasePort2 + link->io.NumPorts2 - 1);
 383         if (link->win)
 384                 printk(", mem 0x%06lx-0x%06lx", req.Base,
 385                        req.Base + req.Size - 1);
 386         printk("\n");
 387
 388         return;
 389
 390 failed:
 391         labpc_release(link);
 392
 393 }                               /* labpc_config */
 394
 395 static void labpc_release(struct pcmcia_device *link)
 396 {
 397         dev_dbg(&link->dev, "labpc_release\n");
 398
 399         pcmcia_disable_device(link);
 400 }                               /* labpc_release */
 401
 402 /*======================================================================
 403
 404     The card status event handler.  Mostly, this schedules other
 405     stuff to run after an event is received.
 406
 407     When a CARD_REMOVAL event is received, we immediately set a
 408     private flag to block future accesses to this device.  All the
 409     functions that actually access the device should check this flag
 410     to make sure the card is still present.
 411
 412 ======================================================================*/
 413
 414 static int labpc_cs_suspend(struct pcmcia_device *link)
 415 {
 416         struct local_info_t *local = link->priv;
 417
 418         /* Mark the device as stopped, to block IO until later */
 419         local->stop = 1;
 420         return 0;
 421 }                               /* labpc_cs_suspend */
 422
 423 static int labpc_cs_resume(struct pcmcia_device *link)
 424 {
 425         struct local_info_t *local = link->priv;
 426
 427         local->stop = 0;
 428         return 0;
 429 }                               /* labpc_cs_resume */
 430
 431 /*====================================================================*/
 432
 433 static struct pcmcia_device_id labpc_cs_ids[] = {
 434         /* N.B. These IDs should match those in labpc_cs_boards (ni_labpc.c) */
 435         PCMCIA_DEVICE_MANF_CARD(0x010b, 0x0103),        /* daqcard-1200 */
 436         PCMCIA_DEVICE_NULL
 437 };
 438
 439 MODULE_DEVICE_TABLE(pcmcia, labpc_cs_ids);
 440 MODULE_AUTHOR("Frank Mori Hess <fmhess@users.sourceforge.net>");
 441 MODULE_DESCRIPTION("Comedi driver for National Instruments Lab-PC");
 442 MODULE_LICENSE("GPL");
 443
 444 struct pcmcia_driver labpc_cs_driver = {
 445         .probe = labpc_cs_attach,
 446         .remove = labpc_cs_detach,
 447         .suspend = labpc_cs_suspend,
 448         .resume = labpc_cs_resume,
 449         .id_table = labpc_cs_ids,
 450         .owner = THIS_MODULE,
 451         .drv = {
 452                 .name = dev_info,
 453                 },
 454 };
 455
 456 static int __init init_labpc_cs(void)
 457 {
 458         pcmcia_register_driver(&labpc_cs_driver);
 459         return 0;
 460 }
 461
 462 static void __exit exit_labpc_cs(void)
 463 {
 464         pcmcia_unregister_driver(&labpc_cs_driver);
 465 }
 466
 467 int __init labpc_init_module(void)
 468 {
 469         int ret;
 470
 471         ret = init_labpc_cs();
 472         if (ret < 0)
 473                 return ret;
 474
 475         return comedi_driver_register(&driver_labpc_cs);
 476 }
 477
 478 void __exit labpc_exit_module(void)
 479 {
 480         exit_labpc_cs();
 481         comedi_driver_unregister(&driver_labpc_cs);
 482 }
 483
 484 module_init(labpc_init_module);
 485 module_exit(labpc_exit_module);