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         /*
 176            General socket configuration defaults can go here.  In this
 177            client, we assume very little, and rely on the CIS for almost
 178            everything.  In most clients, many details (i.e., number, sizes,
 179            and attributes of IO windows) are fixed by the nature of the
 180            device, and can be hard-wired here.
 181          */
 182         link->conf.Attributes = 0;
 183         link->conf.IntType = INT_MEMORY_AND_IO;
 184
 185         cur_dev = link;
 186
 187         das08_pcmcia_config(link);
 188
 189         return 0;
 190 }                               /* das08_pcmcia_attach */
 191
 192 /*======================================================================
 193
 194     This deletes a driver "instance".  The device is de-registered
 195     with Card Services.  If it has been released, all local data
 196     structures are freed.  Otherwise, the structures will be freed
 197     when the device is released.
 198
 199 ======================================================================*/
 200
 201 static void das08_pcmcia_detach(struct pcmcia_device *link)
 202 {
 203
 204         dev_dbg(&link->dev, "das08_pcmcia_detach\n");
 205
 206         if (link->dev_node) {
 207                 ((struct local_info_t *)link->priv)->stop = 1;
 208                 das08_pcmcia_release(link);
 209         }
 210
 211         /* This points to the parent struct local_info_t struct */
 212         if (link->priv)
 213                 kfree(link->priv);
 214
 215 }                               /* das08_pcmcia_detach */
 216
 217
 218 static int das08_pcmcia_config_loop(struct pcmcia_device *p_dev,
 219                                 cistpl_cftable_entry_t *cfg,
 220                                 cistpl_cftable_entry_t *dflt,
 221                                 unsigned int vcc,
 222                                 void *priv_data)
 223 {
 224         if (cfg->index == 0)
 225                 return -ENODEV;
 226
 227         /* Do we need to allocate an interrupt? */
 228         p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
 229
 230         /* IO window settings */
 231         p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
 232         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
 233                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
 234                 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 235                 if (!(io->flags & CISTPL_IO_8BIT))
 236                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
 237                 if (!(io->flags & CISTPL_IO_16BIT))
 238                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 239                 p_dev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
 240                 p_dev->io.BasePort1 = io->win[0].base;
 241                 p_dev->io.NumPorts1 = io->win[0].len;
 242                 if (io->nwin > 1) {
 243                         p_dev->io.Attributes2 = p_dev->io.Attributes1;
 244                         p_dev->io.BasePort2 = io->win[1].base;
 245                         p_dev->io.NumPorts2 = io->win[1].len;
 246                 }
 247                 /* This reserves IO space but doesn't actually enable it */
 248                 return pcmcia_request_io(p_dev, &p_dev->io);
 249         }
 250         return 0;
 251 }
 252
 253
 254 /*======================================================================
 255
 256     das08_pcmcia_config() is scheduled to run after a CARD_INSERTION event
 257     is received, to configure the PCMCIA socket, and to make the
 258     device available to the system.
 259
 260 ======================================================================*/
 261
 262 static void das08_pcmcia_config(struct pcmcia_device *link)
 263 {
 264         struct local_info_t *dev = link->priv;
 265         int ret;
 266
 267         dev_dbg(&link->dev, "das08_pcmcia_config\n");
 268
 269         ret = pcmcia_loop_config(link, das08_pcmcia_config_loop, NULL);
 270         if (ret) {
 271                 dev_warn(&link->dev, "no configuration found\n");
 272                 goto failed;
 273         }
 274
 275         if (!link->irq)
 276                 goto failed;
 277
 278         /*
 279            This actually configures the PCMCIA socket -- setting up
 280            the I/O windows and the interrupt mapping, and putting the
 281            card and host interface into "Memory and IO" mode.
 282          */
 283         ret = pcmcia_request_configuration(link, &link->conf);
 284         if (ret)
 285                 goto failed;
 286
 287         /*
 288            At this point, the dev_node_t structure(s) need to be
 289            initialized and arranged in a linked list at link->dev.
 290          */
 291         sprintf(dev->node.dev_name, "pcm-das08");
 292         dev->node.major = dev->node.minor = 0;
 293         link->dev_node = &dev->node;
 294
 295         /* Finally, report what we've done */
 296         printk(KERN_INFO "%s: index 0x%02x",
 297                dev->node.dev_name, link->conf.ConfigIndex);
 298         if (link->conf.Attributes & CONF_ENABLE_IRQ)
 299                 printk(", irq %u", link->irq);
 300         if (link->io.NumPorts1)
 301                 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
 302                        link->io.BasePort1 + link->io.NumPorts1 - 1);
 303         if (link->io.NumPorts2)
 304                 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
 305                        link->io.BasePort2 + link->io.NumPorts2 - 1);
 306         printk("\n");
 307
 308         return;
 309
 310 failed:
 311         das08_pcmcia_release(link);
 312
 313 }                               /* das08_pcmcia_config */
 314
 315 /*======================================================================
 316
 317     After a card is removed, das08_pcmcia_release() will unregister the
 318     device, and release the PCMCIA configuration.  If the device is
 319     still open, this will be postponed until it is closed.
 320
 321 ======================================================================*/
 322
 323 static void das08_pcmcia_release(struct pcmcia_device *link)
 324 {
 325         dev_dbg(&link->dev, "das08_pcmcia_release\n");
 326         pcmcia_disable_device(link);
 327 }                               /* das08_pcmcia_release */
 328
 329 /*======================================================================
 330
 331     The card status event handler.  Mostly, this schedules other
 332     stuff to run after an event is received.
 333
 334     When a CARD_REMOVAL event is received, we immediately set a
 335     private flag to block future accesses to this device.  All the
 336     functions that actually access the device should check this flag
 337     to make sure the card is still present.
 338
 339 ======================================================================*/
 340
 341 static int das08_pcmcia_suspend(struct pcmcia_device *link)
 342 {
 343         struct local_info_t *local = link->priv;
 344         /* Mark the device as stopped, to block IO until later */
 345         local->stop = 1;
 346
 347         return 0;
 348 }                               /* das08_pcmcia_suspend */
 349
 350 static int das08_pcmcia_resume(struct pcmcia_device *link)
 351 {
 352         struct local_info_t *local = link->priv;
 353
 354         local->stop = 0;
 355         return 0;
 356 }                               /* das08_pcmcia_resume */
 357
 358 /*====================================================================*/
 359
 360 static struct pcmcia_device_id das08_cs_id_table[] = {
 361         PCMCIA_DEVICE_MANF_CARD(0x01c5, 0x4001),
 362         PCMCIA_DEVICE_NULL
 363 };
 364
 365 MODULE_DEVICE_TABLE(pcmcia, das08_cs_id_table);
 366
 367 struct pcmcia_driver das08_cs_driver = {
 368         .probe = das08_pcmcia_attach,
 369         .remove = das08_pcmcia_detach,
 370         .suspend = das08_pcmcia_suspend,
 371         .resume = das08_pcmcia_resume,
 372         .id_table = das08_cs_id_table,
 373         .owner = THIS_MODULE,
 374         .drv = {
 375                 .name = dev_info,
 376                 },
 377 };
 378
 379 static int __init init_das08_pcmcia_cs(void)
 380 {
 381         pcmcia_register_driver(&das08_cs_driver);
 382         return 0;
 383 }
 384
 385 static void __exit exit_das08_pcmcia_cs(void)
 386 {
 387         pr_debug("das08_pcmcia_cs: unloading\n");
 388         pcmcia_unregister_driver(&das08_cs_driver);
 389 }
 390
 391 static int __init das08_cs_init_module(void)
 392 {
 393         int ret;
 394
 395         ret = init_das08_pcmcia_cs();
 396         if (ret < 0)
 397                 return ret;
 398
 399         return comedi_driver_register(&driver_das08_cs);
 400 }
 401
 402 static void __exit das08_cs_exit_module(void)
 403 {
 404         exit_das08_pcmcia_cs();
 405         comedi_driver_unregister(&driver_das08_cs);
 406 }
 407
 408 MODULE_LICENSE("GPL");
 409 module_init(das08_cs_init_module);
 410 module_exit(das08_cs_exit_module);