drivers/staging/comedi/drivers/das08_cs.c

   1 /*
   2     comedi/drivers/das08_cs.c
   3     DAS08 driver
   4
   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>
   8
   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.
  13
  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.
  18
  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.
  22
  23 *****************************************************************
  24
  25 */
  26 /*
  27 Driver: das08_cs
  28 Description: DAS-08 PCMCIA boards
  29 Author: Warren Jasper, ds, Frank Hess
  30 Devices: [ComputerBoards] PCM-DAS08 (pcm-das08)
  31 Status: works
  32
  33 This is the PCMCIA-specific support split off from the
  34 das08 driver.
  35
  36 Options (for pcm-das08):
  37         NONE
  38
  39 Command support does not exist, but could be added for this board.
  40 */
  41
  42 #include "../comedidev.h"
  43
  44 #include <linux/delay.h>
  45 #include <linux/pci.h>
  46 #include <linux/slab.h>
  47
  48 #include "das08.h"
  49
  50 /* pcmcia includes */
  51 #include <pcmcia/cs_types.h>
  52 #include <pcmcia/cs.h>
  53 #include <pcmcia/cistpl.h>
  54 #include <pcmcia/ds.h>
  55
  56 static struct pcmcia_device *cur_dev;
  57
  58 #define thisboard ((const struct das08_board_struct *)dev->board_ptr)
  59
  60 static int das08_cs_attach(struct comedi_device *dev,
  61                            struct comedi_devconfig *it);
  62
  63 static struct comedi_driver driver_das08_cs = {
  64         .driver_name = "das08_cs",
  65         .module = THIS_MODULE,
  66         .attach = das08_cs_attach,
  67         .detach = das08_common_detach,
  68         .board_name = &das08_cs_boards[0].name,
  69         .num_names = ARRAY_SIZE(das08_cs_boards),
  70         .offset = sizeof(struct das08_board_struct),
  71 };
  72
  73 static int das08_cs_attach(struct comedi_device *dev,
  74                            struct comedi_devconfig *it)
  75 {
  76         int ret;
  77         unsigned long iobase;
  78         struct pcmcia_device *link = cur_dev;   /*  XXX hack */
  79
  80         ret = alloc_private(dev, sizeof(struct das08_private_struct));
  81         if (ret < 0)
  82                 return ret;
  83
  84         printk("comedi%d: das08_cs: ", dev->minor);
  85         /*  deal with a pci board */
  86
  87         if (thisboard->bustype == pcmcia) {
  88                 if (link == NULL) {
  89                         printk(" no pcmcia cards found\n");
  90                         return -EIO;
  91                 }
  92                 iobase = link->io.BasePort1;
  93         } else {
  94                 printk(" bug! board does not have PCMCIA bustype\n");
  95                 return -EINVAL;
  96         }
  97
  98         printk("\n");
  99
 100         return das08_common_attach(dev, iobase);
 101 }
 102
 103 /*======================================================================
 104
 105     The following pcmcia code for the pcm-das08 is adapted from the
 106     dummy_cs.c driver of the Linux PCMCIA Card Services package.
 107
 108     The initial developer of the original code is David A. Hinds
 109     <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
 110     are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
 111
 112 ======================================================================*/
 113
 114 static void das08_pcmcia_config(struct pcmcia_device *link);
 115 static void das08_pcmcia_release(struct pcmcia_device *link);
 116 static int das08_pcmcia_suspend(struct pcmcia_device *p_dev);
 117 static int das08_pcmcia_resume(struct pcmcia_device *p_dev);
 118
 119 /*
 120    The attach() and detach() entry points are used to create and destroy
 121    "instances" of the driver, where each instance represents everything
 122    needed to manage one actual PCMCIA card.
 123 */
 124
 125 static int das08_pcmcia_attach(struct pcmcia_device *);
 126 static void das08_pcmcia_detach(struct pcmcia_device *);
 127
 128 /*
 129    You'll also need to prototype all the functions that will actually
 130    be used to talk to your device.  See 'memory_cs' for a good example
 131    of a fully self-sufficient driver; the other drivers rely more or
 132    less on other parts of the kernel.
 133 */
 134
 135 /*
 136    The dev_info variable is the "key" that is used to match up this
 137    device driver with appropriate cards, through the card configuration
 138    database.
 139 */
 140
 141 static const dev_info_t dev_info = "pcm-das08";
 142
 143 struct local_info_t {
 144         struct pcmcia_device *link;
 145         dev_node_t node;
 146         int stop;
 147         struct bus_operations *bus;
 148 };
 149
 150 /*======================================================================
 151
 152     das08_pcmcia_attach() creates an "instance" of the driver, allocating
 153     local data structures for one device.  The device is registered
 154     with Card Services.
 155
 156     The dev_link structure is initialized, but we don't actually
 157     configure the card at this point -- we wait until we receive a
 158     card insertion event.
 159
 160 ======================================================================*/
 161
 162 static int das08_pcmcia_attach(struct pcmcia_device *link)
 163 {
 164         struct local_info_t *local;
 165
 166         dev_dbg(&link->dev, "das08_pcmcia_attach()\n");
 167
 168         /* Allocate space for private device-specific data */
 169         local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
 170         if (!local)
 171                 return -ENOMEM;
 172         local->link = link;
 173         link->priv = local;
 174
 175         /* Interrupt setup */
 176         link->irq.Attributes = IRQ_TYPE_EXCLUSIVE;
 177         link->irq.Handler = NULL;
 178
 179         /*
 180            General socket configuration defaults can go here.  In this
 181            client, we assume very little, and rely on the CIS for almost
 182            everything.  In most clients, many details (i.e., number, sizes,
 183            and attributes of IO windows) are fixed by the nature of the
 184            device, and can be hard-wired here.
 185          */
 186         link->conf.Attributes = 0;
 187         link->conf.IntType = INT_MEMORY_AND_IO;
 188
 189         cur_dev = link;
 190
 191         das08_pcmcia_config(link);
 192
 193         return 0;
 194 }                               /* das08_pcmcia_attach */
 195
 196 /*======================================================================
 197
 198     This deletes a driver "instance".  The device is de-registered
 199     with Card Services.  If it has been released, all local data
 200     structures are freed.  Otherwise, the structures will be freed
 201     when the device is released.
 202
 203 ======================================================================*/
 204
 205 static void das08_pcmcia_detach(struct pcmcia_device *link)
 206 {
 207
 208         dev_dbg(&link->dev, "das08_pcmcia_detach\n");
 209
 210         if (link->dev_node) {
 211                 ((struct local_info_t *)link->priv)->stop = 1;
 212                 das08_pcmcia_release(link);
 213         }
 214
 215         /* This points to the parent struct local_info_t struct */
 216         if (link->priv)
 217                 kfree(link->priv);
 218
 219 }                               /* das08_pcmcia_detach */
 220
 221
 222 static int das08_pcmcia_config_loop(struct pcmcia_device *p_dev,
 223                                 cistpl_cftable_entry_t *cfg,
 224                                 cistpl_cftable_entry_t *dflt,
 225                                 unsigned int vcc,
 226                                 void *priv_data)
 227 {
 228         if (cfg->index == 0)
 229                 return -ENODEV;
 230
 231         /* Do we need to allocate an interrupt? */
 232         if (cfg->irq.IRQInfo1 || dflt->irq.IRQInfo1)
 233                 p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
 234
 235         /* IO window settings */
 236         p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
 237         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
 238                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
 239                 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 240                 if (!(io->flags & CISTPL_IO_8BIT))
 241                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
 242                 if (!(io->flags & CISTPL_IO_16BIT))
 243                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 244                 p_dev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
 245                 p_dev->io.BasePort1 = io->win[0].base;
 246                 p_dev->io.NumPorts1 = io->win[0].len;
 247                 if (io->nwin > 1) {
 248                         p_dev->io.Attributes2 = p_dev->io.Attributes1;
 249                         p_dev->io.BasePort2 = io->win[1].base;
 250                         p_dev->io.NumPorts2 = io->win[1].len;
 251                 }
 252                 /* This reserves IO space but doesn't actually enable it */
 253                 return pcmcia_request_io(p_dev, &p_dev->io);
 254         }
 255         return 0;
 256 }
 257
 258
 259 /*======================================================================
 260
 261     das08_pcmcia_config() is scheduled to run after a CARD_INSERTION event
 262     is received, to configure the PCMCIA socket, and to make the
 263     device available to the system.
 264
 265 ======================================================================*/
 266
 267 static void das08_pcmcia_config(struct pcmcia_device *link)
 268 {
 269         struct local_info_t *dev = link->priv;
 270         int ret;
 271
 272         dev_dbg(&link->dev, "das08_pcmcia_config\n");
 273
 274         ret = pcmcia_loop_config(link, das08_pcmcia_config_loop, NULL);
 275         if (ret) {
 276                 dev_warn(&link->dev, "no configuration found\n");
 277                 goto failed;
 278         }
 279
 280         if (link->conf.Attributes & CONF_ENABLE_IRQ) {
 281                 ret = pcmcia_request_irq(link, &link->irq);
 282                 if (ret)
 283                         goto failed;
 284         }
 285
 286         /*
 287            This actually configures the PCMCIA socket -- setting up
 288            the I/O windows and the interrupt mapping, and putting the
 289            card and host interface into "Memory and IO" mode.
 290          */
 291         ret = pcmcia_request_configuration(link, &link->conf);
 292         if (ret)
 293                 goto failed;
 294
 295         /*
 296            At this point, the dev_node_t structure(s) need to be
 297            initialized and arranged in a linked list at link->dev.
 298          */
 299         sprintf(dev->node.dev_name, "pcm-das08");
 300         dev->node.major = dev->node.minor = 0;
 301         link->dev_node = &dev->node;
 302
 303         /* Finally, report what we've done */
 304         printk(KERN_INFO "%s: index 0x%02x",
 305                dev->node.dev_name, link->conf.ConfigIndex);
 306         if (link->conf.Attributes & CONF_ENABLE_IRQ)
 307                 printk(", irq %u", link->irq.AssignedIRQ);
 308         if (link->io.NumPorts1)
 309                 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
 310                        link->io.BasePort1 + link->io.NumPorts1 - 1);
 311         if (link->io.NumPorts2)
 312                 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
 313                        link->io.BasePort2 + link->io.NumPorts2 - 1);
 314         printk("\n");
 315
 316         return;
 317
 318 failed:
 319         das08_pcmcia_release(link);
 320
 321 }                               /* das08_pcmcia_config */
 322
 323 /*======================================================================
 324
 325     After a card is removed, das08_pcmcia_release() will unregister the
 326     device, and release the PCMCIA configuration.  If the device is
 327     still open, this will be postponed until it is closed.
 328
 329 ======================================================================*/
 330
 331 static void das08_pcmcia_release(struct pcmcia_device *link)
 332 {
 333         dev_dbg(&link->dev, "das08_pcmcia_release\n");
 334         pcmcia_disable_device(link);
 335 }                               /* das08_pcmcia_release */
 336
 337 /*======================================================================
 338
 339     The card status event handler.  Mostly, this schedules other
 340     stuff to run after an event is received.
 341
 342     When a CARD_REMOVAL event is received, we immediately set a
 343     private flag to block future accesses to this device.  All the
 344     functions that actually access the device should check this flag
 345     to make sure the card is still present.
 346
 347 ======================================================================*/
 348
 349 static int das08_pcmcia_suspend(struct pcmcia_device *link)
 350 {
 351         struct local_info_t *local = link->priv;
 352         /* Mark the device as stopped, to block IO until later */
 353         local->stop = 1;
 354
 355         return 0;
 356 }                               /* das08_pcmcia_suspend */
 357
 358 static int das08_pcmcia_resume(struct pcmcia_device *link)
 359 {
 360         struct local_info_t *local = link->priv;
 361
 362         local->stop = 0;
 363         return 0;
 364 }                               /* das08_pcmcia_resume */
 365
 366 /*====================================================================*/
 367
 368 static struct pcmcia_device_id das08_cs_id_table[] = {
 369         PCMCIA_DEVICE_MANF_CARD(0x01c5, 0x4001),
 370         PCMCIA_DEVICE_NULL
 371 };
 372
 373 MODULE_DEVICE_TABLE(pcmcia, das08_cs_id_table);
 374
 375 struct pcmcia_driver das08_cs_driver = {
 376         .probe = das08_pcmcia_attach,
 377         .remove = das08_pcmcia_detach,
 378         .suspend = das08_pcmcia_suspend,
 379         .resume = das08_pcmcia_resume,
 380         .id_table = das08_cs_id_table,
 381         .owner = THIS_MODULE,
 382         .drv = {
 383                 .name = dev_info,
 384                 },
 385 };
 386
 387 static int __init init_das08_pcmcia_cs(void)
 388 {
 389         pcmcia_register_driver(&das08_cs_driver);
 390         return 0;
 391 }
 392
 393 static void __exit exit_das08_pcmcia_cs(void)
 394 {
 395         pr_debug("das08_pcmcia_cs: unloading\n");
 396         pcmcia_unregister_driver(&das08_cs_driver);
 397 }
 398
 399 static int __init das08_cs_init_module(void)
 400 {
 401         int ret;
 402
 403         ret = init_das08_pcmcia_cs();
 404         if (ret < 0)
 405                 return ret;
 406
 407         return comedi_driver_register(&driver_das08_cs);
 408 }
 409
 410 static void __exit das08_cs_exit_module(void)
 411 {
 412         exit_das08_pcmcia_cs();
 413         comedi_driver_unregister(&driver_das08_cs);
 414 }
 415
 416 MODULE_LICENSE("GPL");
 417 module_init(das08_cs_init_module);
 418 module_exit(das08_cs_exit_module);