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/cistpl.h>
  52 #include <pcmcia/ds.h>
  53
  54 static struct pcmcia_device *cur_dev;
  55
  56 #define thisboard ((const struct das08_board_struct *)dev->board_ptr)
  57
  58 static int das08_cs_attach(struct comedi_device *dev,
  59                            struct comedi_devconfig *it);
  60
  61 static struct comedi_driver driver_das08_cs = {
  62         .driver_name = "das08_cs",
  63         .module = THIS_MODULE,
  64         .attach = das08_cs_attach,
  65         .detach = das08_common_detach,
  66         .board_name = &das08_cs_boards[0].name,
  67         .num_names = ARRAY_SIZE(das08_cs_boards),
  68         .offset = sizeof(struct das08_board_struct),
  69 };
  70
  71 static int das08_cs_attach(struct comedi_device *dev,
  72                            struct comedi_devconfig *it)
  73 {
  74         int ret;
  75         unsigned long iobase;
  76         struct pcmcia_device *link = cur_dev;   /*  XXX hack */
  77
  78         ret = alloc_private(dev, sizeof(struct das08_private_struct));
  79         if (ret < 0)
  80                 return ret;
  81
  82         printk("comedi%d: das08_cs: ", dev->minor);
  83         /*  deal with a pci board */
  84
  85         if (thisboard->bustype == pcmcia) {
  86                 if (link == NULL) {
  87                         printk(" no pcmcia cards found\n");
  88                         return -EIO;
  89                 }
  90                 iobase = link->resource[0]->start;
  91         } else {
  92                 printk(" bug! board does not have PCMCIA bustype\n");
  93                 return -EINVAL;
  94         }
  95
  96         printk("\n");
  97
  98         return das08_common_attach(dev, iobase);
  99 }
 100
 101 /*======================================================================
 102
 103     The following pcmcia code for the pcm-das08 is adapted from the
 104     dummy_cs.c driver of the Linux PCMCIA Card Services package.
 105
 106     The initial developer of the original code is David A. Hinds
 107     <dahinds@users.sourceforge.net>.  Portions created by David A. Hinds
 108     are Copyright (C) 1999 David A. Hinds.  All Rights Reserved.
 109
 110 ======================================================================*/
 111
 112 static void das08_pcmcia_config(struct pcmcia_device *link);
 113 static void das08_pcmcia_release(struct pcmcia_device *link);
 114 static int das08_pcmcia_suspend(struct pcmcia_device *p_dev);
 115 static int das08_pcmcia_resume(struct pcmcia_device *p_dev);
 116
 117 /*
 118    The attach() and detach() entry points are used to create and destroy
 119    "instances" of the driver, where each instance represents everything
 120    needed to manage one actual PCMCIA card.
 121 */
 122
 123 static int das08_pcmcia_attach(struct pcmcia_device *);
 124 static void das08_pcmcia_detach(struct pcmcia_device *);
 125
 126 /*
 127    You'll also need to prototype all the functions that will actually
 128    be used to talk to your device.  See 'memory_cs' for a good example
 129    of a fully self-sufficient driver; the other drivers rely more or
 130    less on other parts of the kernel.
 131 */
 132
 133 struct local_info_t {
 134         struct pcmcia_device *link;
 135         int stop;
 136         struct bus_operations *bus;
 137 };
 138
 139 /*======================================================================
 140
 141     das08_pcmcia_attach() creates an "instance" of the driver, allocating
 142     local data structures for one device.  The device is registered
 143     with Card Services.
 144
 145     The dev_link structure is initialized, but we don't actually
 146     configure the card at this point -- we wait until we receive a
 147     card insertion event.
 148
 149 ======================================================================*/
 150
 151 static int das08_pcmcia_attach(struct pcmcia_device *link)
 152 {
 153         struct local_info_t *local;
 154
 155         dev_dbg(&link->dev, "das08_pcmcia_attach()\n");
 156
 157         /* Allocate space for private device-specific data */
 158         local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
 159         if (!local)
 160                 return -ENOMEM;
 161         local->link = link;
 162         link->priv = local;
 163
 164         cur_dev = link;
 165
 166         das08_pcmcia_config(link);
 167
 168         return 0;
 169 }                               /* das08_pcmcia_attach */
 170
 171 /*======================================================================
 172
 173     This deletes a driver "instance".  The device is de-registered
 174     with Card Services.  If it has been released, all local data
 175     structures are freed.  Otherwise, the structures will be freed
 176     when the device is released.
 177
 178 ======================================================================*/
 179
 180 static void das08_pcmcia_detach(struct pcmcia_device *link)
 181 {
 182
 183         dev_dbg(&link->dev, "das08_pcmcia_detach\n");
 184
 185         ((struct local_info_t *)link->priv)->stop = 1;
 186         das08_pcmcia_release(link);
 187
 188         /* This points to the parent struct local_info_t struct */
 189         kfree(link->priv);
 190
 191 }                               /* das08_pcmcia_detach */
 192
 193
 194 static int das08_pcmcia_config_loop(struct pcmcia_device *p_dev,
 195                                 cistpl_cftable_entry_t *cfg,
 196                                 cistpl_cftable_entry_t *dflt,
 197                                 unsigned int vcc,
 198                                 void *priv_data)
 199 {
 200         if (cfg->index == 0)
 201                 return -ENODEV;
 202
 203         /* Do we need to allocate an interrupt? */
 204         p_dev->config_flags |= CONF_ENABLE_IRQ;
 205
 206         /* IO window settings */
 207         p_dev->resource[0]->end = p_dev->resource[1]->end = 0;
 208         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
 209                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
 210                 p_dev->io_lines = io->flags & CISTPL_IO_LINES_MASK;
 211                 p_dev->resource[0]->flags &= ~IO_DATA_PATH_WIDTH;
 212                 p_dev->resource[0]->flags |=
 213                         pcmcia_io_cfg_data_width(io->flags);
 214                 p_dev->resource[0]->start = io->win[0].base;
 215                 p_dev->resource[0]->end = io->win[0].len;
 216                 if (io->nwin > 1) {
 217                         p_dev->resource[1]->flags = p_dev->resource[0]->flags;
 218                         p_dev->resource[1]->start = io->win[1].base;
 219                         p_dev->resource[1]->end = io->win[1].len;
 220                 }
 221                 /* This reserves IO space but doesn't actually enable it */
 222                 return pcmcia_request_io(p_dev);
 223         }
 224         return 0;
 225 }
 226
 227
 228 /*======================================================================
 229
 230     das08_pcmcia_config() is scheduled to run after a CARD_INSERTION event
 231     is received, to configure the PCMCIA socket, and to make the
 232     device available to the system.
 233
 234 ======================================================================*/
 235
 236 static void das08_pcmcia_config(struct pcmcia_device *link)
 237 {
 238         int ret;
 239
 240         dev_dbg(&link->dev, "das08_pcmcia_config\n");
 241
 242         ret = pcmcia_loop_config(link, das08_pcmcia_config_loop, NULL);
 243         if (ret) {
 244                 dev_warn(&link->dev, "no configuration found\n");
 245                 goto failed;
 246         }
 247
 248         if (!link->irq)
 249                 goto failed;
 250
 251         /*
 252            This actually configures the PCMCIA socket -- setting up
 253            the I/O windows and the interrupt mapping, and putting the
 254            card and host interface into "Memory and IO" mode.
 255          */
 256         ret = pcmcia_enable_device(link);
 257         if (ret)
 258                 goto failed;
 259
 260         /* Finally, report what we've done */
 261         dev_info(&link->dev, "index 0x%02x", link->config_index);
 262         printk(", irq %u", link->irq);
 263         if (link->resource[0])
 264                 printk(", io %pR", link->resource[0]);
 265         if (link->resource[1])
 266                 printk(" & %pR", link->resource[1]);
 267         printk("\n");
 268
 269         return;
 270
 271 failed:
 272         das08_pcmcia_release(link);
 273
 274 }                               /* das08_pcmcia_config */
 275
 276 /*======================================================================
 277
 278     After a card is removed, das08_pcmcia_release() will unregister the
 279     device, and release the PCMCIA configuration.  If the device is
 280     still open, this will be postponed until it is closed.
 281
 282 ======================================================================*/
 283
 284 static void das08_pcmcia_release(struct pcmcia_device *link)
 285 {
 286         dev_dbg(&link->dev, "das08_pcmcia_release\n");
 287         pcmcia_disable_device(link);
 288 }                               /* das08_pcmcia_release */
 289
 290 /*======================================================================
 291
 292     The card status event handler.  Mostly, this schedules other
 293     stuff to run after an event is received.
 294
 295     When a CARD_REMOVAL event is received, we immediately set a
 296     private flag to block future accesses to this device.  All the
 297     functions that actually access the device should check this flag
 298     to make sure the card is still present.
 299
 300 ======================================================================*/
 301
 302 static int das08_pcmcia_suspend(struct pcmcia_device *link)
 303 {
 304         struct local_info_t *local = link->priv;
 305         /* Mark the device as stopped, to block IO until later */
 306         local->stop = 1;
 307
 308         return 0;
 309 }                               /* das08_pcmcia_suspend */
 310
 311 static int das08_pcmcia_resume(struct pcmcia_device *link)
 312 {
 313         struct local_info_t *local = link->priv;
 314
 315         local->stop = 0;
 316         return 0;
 317 }                               /* das08_pcmcia_resume */
 318
 319 /*====================================================================*/
 320
 321 static struct pcmcia_device_id das08_cs_id_table[] = {
 322         PCMCIA_DEVICE_MANF_CARD(0x01c5, 0x4001),
 323         PCMCIA_DEVICE_NULL
 324 };
 325
 326 MODULE_DEVICE_TABLE(pcmcia, das08_cs_id_table);
 327 MODULE_AUTHOR("David A. Schleef <ds@schleef.org>, "
 328               "Frank Mori Hess <fmhess@users.sourceforge.net>");
 329 MODULE_DESCRIPTION("Comedi driver for ComputerBoards DAS-08 PCMCIA boards");
 330 MODULE_LICENSE("GPL");
 331
 332 struct pcmcia_driver das08_cs_driver = {
 333         .probe = das08_pcmcia_attach,
 334         .remove = das08_pcmcia_detach,
 335         .suspend = das08_pcmcia_suspend,
 336         .resume = das08_pcmcia_resume,
 337         .id_table = das08_cs_id_table,
 338         .owner = THIS_MODULE,
 339         .drv = {
 340                 .name = "pcm-das08",
 341                 },
 342 };
 343
 344 static int __init init_das08_pcmcia_cs(void)
 345 {
 346         pcmcia_register_driver(&das08_cs_driver);
 347         return 0;
 348 }
 349
 350 static void __exit exit_das08_pcmcia_cs(void)
 351 {
 352         pr_debug("das08_pcmcia_cs: unloading\n");
 353         pcmcia_unregister_driver(&das08_cs_driver);
 354 }
 355
 356 static int __init das08_cs_init_module(void)
 357 {
 358         int ret;
 359
 360         ret = init_das08_pcmcia_cs();
 361         if (ret < 0)
 362                 return ret;
 363
 364         return comedi_driver_register(&driver_das08_cs);
 365 }
 366
 367 static void __exit das08_cs_exit_module(void)
 368 {
 369         exit_das08_pcmcia_cs();
 370         comedi_driver_unregister(&driver_das08_cs);
 371 }
 372
 373 module_init(das08_cs_init_module);
 374 module_exit(das08_cs_exit_module);