drivers/staging/comedi/drivers/ni_daq_dio24.c

   1 /*
   2     comedi/drivers/ni_daq_dio24.c
   3     Driver for National Instruments PCMCIA DAQ-Card DIO-24
   4     Copyright (C) 2002 Daniel Vecino Castel <dvecino@able.es>
   5
   6     PCMCIA crap at end of file 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.  All Rights Reserved.
  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_daq_dio24
  30 Description: National Instruments PCMCIA DAQ-Card DIO-24
  31 Author: Daniel Vecino Castel <dvecino@able.es>
  32 Devices: [National Instruments] PCMCIA DAQ-Card DIO-24 (ni_daq_dio24)
  33 Status: ?
  34 Updated: Thu, 07 Nov 2002 21:53:06 -0800
  35
  36 This is just a wrapper around the 8255.o driver to properly handle
  37 the PCMCIA interface.
  38 */
  39
  40                             /* #define LABPC_DEBUG *//*  enable debugging messages */
  41 #undef LABPC_DEBUG
  42
  43 #include <linux/interrupt.h>
  44 #include <linux/slab.h>
  45 #include "../comedidev.h"
  46
  47 #include <linux/ioport.h>
  48
  49 #include "8255.h"
  50
  51 #include <pcmcia/cs_types.h>
  52 #include <pcmcia/cs.h>
  53 #include <pcmcia/cistpl.h>
  54 #include <pcmcia/cisreg.h>
  55 #include <pcmcia/ds.h>
  56
  57 static struct pcmcia_device *pcmcia_cur_dev = NULL;
  58
  59 #define DIO24_SIZE 4            /*  size of io region used by board */
  60
  61 static int dio24_attach(struct comedi_device *dev, struct comedi_devconfig *it);
  62 static int dio24_detach(struct comedi_device *dev);
  63
  64 enum dio24_bustype { pcmcia_bustype };
  65
  66 struct dio24_board_struct {
  67         const char *name;
  68         int device_id;          /*  device id for pcmcia board */
  69         enum dio24_bustype bustype;     /*  PCMCIA */
  70         int have_dio;           /*  have 8255 chip */
  71         /*  function pointers so we can use inb/outb or readb/writeb as appropriate */
  72         unsigned int (*read_byte) (unsigned int address);
  73         void (*write_byte) (unsigned int byte, unsigned int address);
  74 };
  75
  76 static const struct dio24_board_struct dio24_boards[] = {
  77         {
  78          .name = "daqcard-dio24",
  79          .device_id = 0x475c,   /*  0x10b is manufacturer id, 0x475c is device id */
  80          .bustype = pcmcia_bustype,
  81          .have_dio = 1,
  82          },
  83         {
  84          .name = "ni_daq_dio24",
  85          .device_id = 0x475c,   /*  0x10b is manufacturer id, 0x475c is device id */
  86          .bustype = pcmcia_bustype,
  87          .have_dio = 1,
  88          },
  89 };
  90
  91 /*
  92  * Useful for shorthand access to the particular board structure
  93  */
  94 #define thisboard ((const struct dio24_board_struct *)dev->board_ptr)
  95
  96 struct dio24_private {
  97
  98         int data;               /* number of data points left to be taken */
  99 };
 100
 101 #define devpriv ((struct dio24_private *)dev->private)
 102
 103 static struct comedi_driver driver_dio24 = {
 104         .driver_name = "ni_daq_dio24",
 105         .module = THIS_MODULE,
 106         .attach = dio24_attach,
 107         .detach = dio24_detach,
 108         .num_names = ARRAY_SIZE(dio24_boards),
 109         .board_name = &dio24_boards[0].name,
 110         .offset = sizeof(struct dio24_board_struct),
 111 };
 112
 113 static int dio24_attach(struct comedi_device *dev, struct comedi_devconfig *it)
 114 {
 115         struct comedi_subdevice *s;
 116         unsigned long iobase = 0;
 117 #ifdef incomplete
 118         unsigned int irq = 0;
 119 #endif
 120         struct pcmcia_device *link;
 121
 122         /* allocate and initialize dev->private */
 123         if (alloc_private(dev, sizeof(struct dio24_private)) < 0)
 124                 return -ENOMEM;
 125
 126         /*  get base address, irq etc. based on bustype */
 127         switch (thisboard->bustype) {
 128         case pcmcia_bustype:
 129                 link = pcmcia_cur_dev;  /* XXX hack */
 130                 if (!link)
 131                         return -EIO;
 132                 iobase = link->io.BasePort1;
 133 #ifdef incomplete
 134                 irq = link->irq;
 135 #endif
 136                 break;
 137         default:
 138                 printk("bug! couldn't determine board type\n");
 139                 return -EINVAL;
 140                 break;
 141         }
 142         printk("comedi%d: ni_daq_dio24: %s, io 0x%lx", dev->minor,
 143                thisboard->name, iobase);
 144 #ifdef incomplete
 145         if (irq) {
 146                 printk(", irq %u", irq);
 147         }
 148 #endif
 149
 150         printk("\n");
 151
 152         if (iobase == 0) {
 153                 printk("io base address is zero!\n");
 154                 return -EINVAL;
 155         }
 156
 157         dev->iobase = iobase;
 158
 159 #ifdef incomplete
 160         /* grab our IRQ */
 161         dev->irq = irq;
 162 #endif
 163
 164         dev->board_name = thisboard->name;
 165
 166         if (alloc_subdevices(dev, 1) < 0)
 167                 return -ENOMEM;
 168
 169         /* 8255 dio */
 170         s = dev->subdevices + 0;
 171         subdev_8255_init(dev, s, NULL, dev->iobase);
 172
 173         return 0;
 174 };
 175
 176 static int dio24_detach(struct comedi_device *dev)
 177 {
 178         printk("comedi%d: ni_daq_dio24: remove\n", dev->minor);
 179
 180         if (dev->subdevices)
 181                 subdev_8255_cleanup(dev, dev->subdevices + 0);
 182
 183         if (thisboard->bustype != pcmcia_bustype && dev->iobase)
 184                 release_region(dev->iobase, DIO24_SIZE);
 185         if (dev->irq)
 186                 free_irq(dev->irq, dev);
 187
 188         return 0;
 189 };
 190
 191 /* PCMCIA crap -- watch your words! */
 192
 193 static void dio24_config(struct pcmcia_device *link);
 194 static void dio24_release(struct pcmcia_device *link);
 195 static int dio24_cs_suspend(struct pcmcia_device *p_dev);
 196 static int dio24_cs_resume(struct pcmcia_device *p_dev);
 197
 198 /*
 199    The attach() and detach() entry points are used to create and destroy
 200    "instances" of the driver, where each instance represents everything
 201    needed to manage one actual PCMCIA card.
 202 */
 203
 204 static int dio24_cs_attach(struct pcmcia_device *);
 205 static void dio24_cs_detach(struct pcmcia_device *);
 206
 207 /*
 208    You'll also need to prototype all the functions that will actually
 209    be used to talk to your device.  See 'memory_cs' for a good example
 210    of a fully self-sufficient driver; the other drivers rely more or
 211    less on other parts of the kernel.
 212 */
 213
 214 /*
 215    The dev_info variable is the "key" that is used to match up this
 216    device driver with appropriate cards, through the card configuration
 217    database.
 218 */
 219
 220 static const dev_info_t dev_info = "ni_daq_dio24";
 221
 222 struct local_info_t {
 223         struct pcmcia_device *link;
 224         int stop;
 225         struct bus_operations *bus;
 226 };
 227
 228 /*======================================================================
 229
 230     dio24_cs_attach() creates an "instance" of the driver, allocating
 231     local data structures for one device.  The device is registered
 232     with Card Services.
 233
 234     The dev_link structure is initialized, but we don't actually
 235     configure the card at this point -- we wait until we receive a
 236     card insertion event.
 237
 238 ======================================================================*/
 239
 240 static int dio24_cs_attach(struct pcmcia_device *link)
 241 {
 242         struct local_info_t *local;
 243
 244         printk(KERN_INFO "ni_daq_dio24: HOLA SOY YO - CS-attach!\n");
 245
 246         dev_dbg(&link->dev, "dio24_cs_attach()\n");
 247
 248         /* Allocate space for private device-specific data */
 249         local = kzalloc(sizeof(struct local_info_t), GFP_KERNEL);
 250         if (!local)
 251                 return -ENOMEM;
 252         local->link = link;
 253         link->priv = local;
 254
 255         /*
 256            General socket configuration defaults can go here.  In this
 257            client, we assume very little, and rely on the CIS for almost
 258            everything.  In most clients, many details (i.e., number, sizes,
 259            and attributes of IO windows) are fixed by the nature of the
 260            device, and can be hard-wired here.
 261          */
 262         link->conf.Attributes = 0;
 263         link->conf.IntType = INT_MEMORY_AND_IO;
 264
 265         pcmcia_cur_dev = link;
 266
 267         dio24_config(link);
 268
 269         return 0;
 270 }                               /* dio24_cs_attach */
 271
 272 /*======================================================================
 273
 274     This deletes a driver "instance".  The device is de-registered
 275     with Card Services.  If it has been released, all local data
 276     structures are freed.  Otherwise, the structures will be freed
 277     when the device is released.
 278
 279 ======================================================================*/
 280
 281 static void dio24_cs_detach(struct pcmcia_device *link)
 282 {
 283
 284         printk(KERN_INFO "ni_daq_dio24: HOLA SOY YO - cs-detach!\n");
 285
 286         dev_dbg(&link->dev, "dio24_cs_detach\n");
 287
 288         ((struct local_info_t *)link->priv)->stop = 1;
 289         dio24_release(link);
 290
 291         /* This points to the parent local_info_t struct */
 292         kfree(link->priv);
 293
 294 }                               /* dio24_cs_detach */
 295
 296 /*======================================================================
 297
 298     dio24_config() is scheduled to run after a CARD_INSERTION event
 299     is received, to configure the PCMCIA socket, and to make the
 300     device available to the system.
 301
 302 ======================================================================*/
 303
 304 static int dio24_pcmcia_config_loop(struct pcmcia_device *p_dev,
 305                                 cistpl_cftable_entry_t *cfg,
 306                                 cistpl_cftable_entry_t *dflt,
 307                                 unsigned int vcc,
 308                                 void *priv_data)
 309 {
 310         win_req_t *req = priv_data;
 311         memreq_t map;
 312
 313         if (cfg->index == 0)
 314                 return -ENODEV;
 315
 316         /* Does this card need audio output? */
 317         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
 318                 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
 319                 p_dev->conf.Status = CCSR_AUDIO_ENA;
 320         }
 321
 322         /* Do we need to allocate an interrupt? */
 323         p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
 324
 325         /* IO window settings */
 326         p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
 327         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
 328                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
 329                 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 330                 if (!(io->flags & CISTPL_IO_8BIT))
 331                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
 332                 if (!(io->flags & CISTPL_IO_16BIT))
 333                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 334                 p_dev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
 335                 p_dev->io.BasePort1 = io->win[0].base;
 336                 p_dev->io.NumPorts1 = io->win[0].len;
 337                 if (io->nwin > 1) {
 338                         p_dev->io.Attributes2 = p_dev->io.Attributes1;
 339                         p_dev->io.BasePort2 = io->win[1].base;
 340                         p_dev->io.NumPorts2 = io->win[1].len;
 341                 }
 342                 /* This reserves IO space but doesn't actually enable it */
 343                 if (pcmcia_request_io(p_dev, &p_dev->io) != 0)
 344                         return -ENODEV;
 345         }
 346
 347         if ((cfg->mem.nwin > 0) || (dflt->mem.nwin > 0)) {
 348                 cistpl_mem_t *mem =
 349                         (cfg->mem.nwin) ? &cfg->mem : &dflt->mem;
 350                 req->Attributes = WIN_DATA_WIDTH_16 | WIN_MEMORY_TYPE_CM;
 351                 req->Attributes |= WIN_ENABLE;
 352                 req->Base = mem->win[0].host_addr;
 353                 req->Size = mem->win[0].len;
 354                 if (req->Size < 0x1000)
 355                         req->Size = 0x1000;
 356                 req->AccessSpeed = 0;
 357                 if (pcmcia_request_window(p_dev, req, &p_dev->win))
 358                         return -ENODEV;
 359                 map.Page = 0;
 360                 map.CardOffset = mem->win[0].card_addr;
 361                 if (pcmcia_map_mem_page(p_dev, p_dev->win, &map))
 362                         return -ENODEV;
 363         }
 364         /* If we got this far, we're cool! */
 365         return 0;
 366 }
 367
 368 static void dio24_config(struct pcmcia_device *link)
 369 {
 370         int ret;
 371         win_req_t req;
 372
 373         printk(KERN_INFO "ni_daq_dio24: HOLA SOY YO! - config\n");
 374
 375         dev_dbg(&link->dev, "dio24_config\n");
 376
 377         ret = pcmcia_loop_config(link, dio24_pcmcia_config_loop, &req);
 378         if (ret) {
 379                 dev_warn(&link->dev, "no configuration found\n");
 380                 goto failed;
 381         }
 382
 383         if (!link->irq)
 384                 goto failed;
 385
 386         /*
 387            This actually configures the PCMCIA socket -- setting up
 388            the I/O windows and the interrupt mapping, and putting the
 389            card and host interface into "Memory and IO" mode.
 390          */
 391         ret = pcmcia_request_configuration(link, &link->conf);
 392         if (ret)
 393                 goto failed;
 394
 395         /* Finally, report what we've done */
 396         dev_info(&link->dev, "index 0x%02x", link->conf.ConfigIndex);
 397         if (link->conf.Attributes & CONF_ENABLE_IRQ)
 398                 printk(", irq %d", link->irq);
 399         if (link->io.NumPorts1)
 400                 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
 401                        link->io.BasePort1 + link->io.NumPorts1 - 1);
 402         if (link->io.NumPorts2)
 403                 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
 404                        link->io.BasePort2 + link->io.NumPorts2 - 1);
 405         if (link->win)
 406                 printk(", mem 0x%06lx-0x%06lx", req.Base,
 407                        req.Base + req.Size - 1);
 408         printk("\n");
 409
 410         return;
 411
 412 failed:
 413         printk(KERN_INFO "Fallo");
 414         dio24_release(link);
 415
 416 }                               /* dio24_config */
 417
 418 static void dio24_release(struct pcmcia_device *link)
 419 {
 420         dev_dbg(&link->dev, "dio24_release\n");
 421
 422         pcmcia_disable_device(link);
 423 }                               /* dio24_release */
 424
 425 /*======================================================================
 426
 427     The card status event handler.  Mostly, this schedules other
 428     stuff to run after an event is received.
 429
 430     When a CARD_REMOVAL event is received, we immediately set a
 431     private flag to block future accesses to this device.  All the
 432     functions that actually access the device should check this flag
 433     to make sure the card is still present.
 434
 435 ======================================================================*/
 436
 437 static int dio24_cs_suspend(struct pcmcia_device *link)
 438 {
 439         struct local_info_t *local = link->priv;
 440
 441         /* Mark the device as stopped, to block IO until later */
 442         local->stop = 1;
 443         return 0;
 444 }                               /* dio24_cs_suspend */
 445
 446 static int dio24_cs_resume(struct pcmcia_device *link)
 447 {
 448         struct local_info_t *local = link->priv;
 449
 450         local->stop = 0;
 451         return 0;
 452 }                               /* dio24_cs_resume */
 453
 454 /*====================================================================*/
 455
 456 static struct pcmcia_device_id dio24_cs_ids[] = {
 457         /* N.B. These IDs should match those in dio24_boards */
 458         PCMCIA_DEVICE_MANF_CARD(0x010b, 0x475c),        /* daqcard-dio24 */
 459         PCMCIA_DEVICE_NULL
 460 };
 461
 462 MODULE_DEVICE_TABLE(pcmcia, dio24_cs_ids);
 463 MODULE_AUTHOR("Daniel Vecino Castel <dvecino@able.es>");
 464 MODULE_DESCRIPTION("Comedi driver for National Instruments "
 465                    "PCMCIA DAQ-Card DIO-24");
 466 MODULE_LICENSE("GPL");
 467
 468 struct pcmcia_driver dio24_cs_driver = {
 469         .probe = dio24_cs_attach,
 470         .remove = dio24_cs_detach,
 471         .suspend = dio24_cs_suspend,
 472         .resume = dio24_cs_resume,
 473         .id_table = dio24_cs_ids,
 474         .owner = THIS_MODULE,
 475         .drv = {
 476                 .name = dev_info,
 477                 },
 478 };
 479
 480 static int __init init_dio24_cs(void)
 481 {
 482         printk("ni_daq_dio24: HOLA SOY YO!\n");
 483         pcmcia_register_driver(&dio24_cs_driver);
 484         return 0;
 485 }
 486
 487 static void __exit exit_dio24_cs(void)
 488 {
 489         pcmcia_unregister_driver(&dio24_cs_driver);
 490 }
 491
 492 int __init init_module(void)
 493 {
 494         int ret;
 495
 496         ret = init_dio24_cs();
 497         if (ret < 0)
 498                 return ret;
 499
 500         return comedi_driver_register(&driver_dio24);
 501 }
 502
 503 void __exit cleanup_module(void)
 504 {
 505         exit_dio24_cs();
 506         comedi_driver_unregister(&driver_dio24);
 507 }