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         if (link->priv)
 293                 kfree(link->priv);
 294
 295 }                               /* dio24_cs_detach */
 296
 297 /*======================================================================
 298
 299     dio24_config() is scheduled to run after a CARD_INSERTION event
 300     is received, to configure the PCMCIA socket, and to make the
 301     device available to the system.
 302
 303 ======================================================================*/
 304
 305 static int dio24_pcmcia_config_loop(struct pcmcia_device *p_dev,
 306                                 cistpl_cftable_entry_t *cfg,
 307                                 cistpl_cftable_entry_t *dflt,
 308                                 unsigned int vcc,
 309                                 void *priv_data)
 310 {
 311         win_req_t *req = priv_data;
 312         memreq_t map;
 313
 314         if (cfg->index == 0)
 315                 return -ENODEV;
 316
 317         /* Does this card need audio output? */
 318         if (cfg->flags & CISTPL_CFTABLE_AUDIO) {
 319                 p_dev->conf.Attributes |= CONF_ENABLE_SPKR;
 320                 p_dev->conf.Status = CCSR_AUDIO_ENA;
 321         }
 322
 323         /* Do we need to allocate an interrupt? */
 324         p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
 325
 326         /* IO window settings */
 327         p_dev->io.NumPorts1 = p_dev->io.NumPorts2 = 0;
 328         if ((cfg->io.nwin > 0) || (dflt->io.nwin > 0)) {
 329                 cistpl_io_t *io = (cfg->io.nwin) ? &cfg->io : &dflt->io;
 330                 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
 331                 if (!(io->flags & CISTPL_IO_8BIT))
 332                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
 333                 if (!(io->flags & CISTPL_IO_16BIT))
 334                         p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
 335                 p_dev->io.IOAddrLines = io->flags & CISTPL_IO_LINES_MASK;
 336                 p_dev->io.BasePort1 = io->win[0].base;
 337                 p_dev->io.NumPorts1 = io->win[0].len;
 338                 if (io->nwin > 1) {
 339                         p_dev->io.Attributes2 = p_dev->io.Attributes1;
 340                         p_dev->io.BasePort2 = io->win[1].base;
 341                         p_dev->io.NumPorts2 = io->win[1].len;
 342                 }
 343                 /* This reserves IO space but doesn't actually enable it */
 344                 if (pcmcia_request_io(p_dev, &p_dev->io) != 0)
 345                         return -ENODEV;
 346         }
 347
 348         if ((cfg->mem.nwin > 0) || (dflt->mem.nwin > 0)) {
 349                 cistpl_mem_t *mem =
 350                         (cfg->mem.nwin) ? &cfg->mem : &dflt->mem;
 351                 req->Attributes = WIN_DATA_WIDTH_16 | WIN_MEMORY_TYPE_CM;
 352                 req->Attributes |= WIN_ENABLE;
 353                 req->Base = mem->win[0].host_addr;
 354                 req->Size = mem->win[0].len;
 355                 if (req->Size < 0x1000)
 356                         req->Size = 0x1000;
 357                 req->AccessSpeed = 0;
 358                 if (pcmcia_request_window(p_dev, req, &p_dev->win))
 359                         return -ENODEV;
 360                 map.Page = 0;
 361                 map.CardOffset = mem->win[0].card_addr;
 362                 if (pcmcia_map_mem_page(p_dev, p_dev->win, &map))
 363                         return -ENODEV;
 364         }
 365         /* If we got this far, we're cool! */
 366         return 0;
 367 }
 368
 369 static void dio24_config(struct pcmcia_device *link)
 370 {
 371         int ret;
 372         win_req_t req;
 373
 374         printk(KERN_INFO "ni_daq_dio24: HOLA SOY YO! - config\n");
 375
 376         dev_dbg(&link->dev, "dio24_config\n");
 377
 378         ret = pcmcia_loop_config(link, dio24_pcmcia_config_loop, &req);
 379         if (ret) {
 380                 dev_warn(&link->dev, "no configuration found\n");
 381                 goto failed;
 382         }
 383
 384         if (!link->irq)
 385                 goto failed;
 386
 387         /*
 388            This actually configures the PCMCIA socket -- setting up
 389            the I/O windows and the interrupt mapping, and putting the
 390            card and host interface into "Memory and IO" mode.
 391          */
 392         ret = pcmcia_request_configuration(link, &link->conf);
 393         if (ret)
 394                 goto failed;
 395
 396         /* Finally, report what we've done */
 397         dev_info(&link->dev, "index 0x%02x", link->conf.ConfigIndex);
 398         if (link->conf.Attributes & CONF_ENABLE_IRQ)
 399                 printk(", irq %d", link->irq);
 400         if (link->io.NumPorts1)
 401                 printk(", io 0x%04x-0x%04x", link->io.BasePort1,
 402                        link->io.BasePort1 + link->io.NumPorts1 - 1);
 403         if (link->io.NumPorts2)
 404                 printk(" & 0x%04x-0x%04x", link->io.BasePort2,
 405                        link->io.BasePort2 + link->io.NumPorts2 - 1);
 406         if (link->win)
 407                 printk(", mem 0x%06lx-0x%06lx", req.Base,
 408                        req.Base + req.Size - 1);
 409         printk("\n");
 410
 411         return;
 412
 413 failed:
 414         printk(KERN_INFO "Fallo");
 415         dio24_release(link);
 416
 417 }                               /* dio24_config */
 418
 419 static void dio24_release(struct pcmcia_device *link)
 420 {
 421         dev_dbg(&link->dev, "dio24_release\n");
 422
 423         pcmcia_disable_device(link);
 424 }                               /* dio24_release */
 425
 426 /*======================================================================
 427
 428     The card status event handler.  Mostly, this schedules other
 429     stuff to run after an event is received.
 430
 431     When a CARD_REMOVAL event is received, we immediately set a
 432     private flag to block future accesses to this device.  All the
 433     functions that actually access the device should check this flag
 434     to make sure the card is still present.
 435
 436 ======================================================================*/
 437
 438 static int dio24_cs_suspend(struct pcmcia_device *link)
 439 {
 440         struct local_info_t *local = link->priv;
 441
 442         /* Mark the device as stopped, to block IO until later */
 443         local->stop = 1;
 444         return 0;
 445 }                               /* dio24_cs_suspend */
 446
 447 static int dio24_cs_resume(struct pcmcia_device *link)
 448 {
 449         struct local_info_t *local = link->priv;
 450
 451         local->stop = 0;
 452         return 0;
 453 }                               /* dio24_cs_resume */
 454
 455 /*====================================================================*/
 456
 457 static struct pcmcia_device_id dio24_cs_ids[] = {
 458         /* N.B. These IDs should match those in dio24_boards */
 459         PCMCIA_DEVICE_MANF_CARD(0x010b, 0x475c),        /* daqcard-dio24 */
 460         PCMCIA_DEVICE_NULL
 461 };
 462
 463 MODULE_DEVICE_TABLE(pcmcia, dio24_cs_ids);
 464 MODULE_AUTHOR("Daniel Vecino Castel <dvecino@able.es>");
 465 MODULE_DESCRIPTION("Comedi driver for National Instruments "
 466                    "PCMCIA DAQ-Card DIO-24");
 467 MODULE_LICENSE("GPL");
 468
 469 struct pcmcia_driver dio24_cs_driver = {
 470         .probe = dio24_cs_attach,
 471         .remove = dio24_cs_detach,
 472         .suspend = dio24_cs_suspend,
 473         .resume = dio24_cs_resume,
 474         .id_table = dio24_cs_ids,
 475         .owner = THIS_MODULE,
 476         .drv = {
 477                 .name = dev_info,
 478                 },
 479 };
 480
 481 static int __init init_dio24_cs(void)
 482 {
 483         printk("ni_daq_dio24: HOLA SOY YO!\n");
 484         pcmcia_register_driver(&dio24_cs_driver);
 485         return 0;
 486 }
 487
 488 static void __exit exit_dio24_cs(void)
 489 {
 490         pcmcia_unregister_driver(&dio24_cs_driver);
 491 }
 492
 493 int __init init_module(void)
 494 {
 495         int ret;
 496
 497         ret = init_dio24_cs();
 498         if (ret < 0)
 499                 return ret;
 500
 501         return comedi_driver_register(&driver_dio24);
 502 }
 503
 504 void __exit cleanup_module(void)
 505 {
 506         exit_dio24_cs();
 507         comedi_driver_unregister(&driver_dio24);
 508 }