drivers/staging/comedi/drivers/adl_pci6208.c

   1 /*
   2     comedi/drivers/adl_pci6208.c
   3
   4     Hardware driver for ADLink 6208 series cards:
   5         card         | voltage output    | current output
   6         -------------+-------------------+---------------
   7         PCI-6208V    |  8 channels       | -
   8         PCI-6216V    | 16 channels       | -
   9         PCI-6208A    |  8 channels       | 8 channels
  10
  11     COMEDI - Linux Control and Measurement Device Interface
  12     Copyright (C) 2000 David A. Schleef <ds@schleef.org>
  13
  14     This program is free software; you can redistribute it and/or modify
  15     it under the terms of the GNU General Public License as published by
  16     the Free Software Foundation; either version 2 of the License, or
  17     (at your option) any later version.
  18
  19     This program is distributed in the hope that it will be useful,
  20     but WITHOUT ANY WARRANTY; without even the implied warranty of
  21     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22     GNU General Public License for more details.
  23
  24     You should have received a copy of the GNU General Public License
  25     along with this program; if not, write to the Free Software
  26     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  27 */
  28 /*
  29 Driver: adl_pci6208
  30 Description: ADLink PCI-6208A
  31 Devices: [ADLink] PCI-6208A (adl_pci6208)
  32 Author: nsyeow <nsyeow@pd.jaring.my>
  33 Updated: Fri, 30 Jan 2004 14:44:27 +0800
  34 Status: untested
  35
  36 Configuration Options:
  37   none
  38
  39 References:
  40         - ni_660x.c
  41         - adl_pci9111.c         copied the entire pci setup section
  42         - adl_pci9118.c
  43 */
  44 /*
  45  * These headers should be followed by a blank line, and any comments
  46  * you wish to say about the driver.  The comment area is the place
  47  * to put any known bugs, limitations, unsupported features, supported
  48  * command triggers, whether or not commands are supported on particular
  49  * subdevices, etc.
  50  *
  51  * Somewhere in the comment should be information about configuration
  52  * options that are used with comedi_config.
  53  */
  54 #include "../comedidev.h"
  55 #include "comedi_pci.h"
  56
  57 #define PCI6208_DRIVER_NAME     "adl_pci6208"
  58
  59 /* Board descriptions */
  60 struct pci6208_board {
  61         const char *name;
  62         unsigned short dev_id;  /* `lspci` will show you this */
  63         int ao_chans;
  64         /* int ao_bits; */
  65 };
  66
  67 static const struct pci6208_board pci6208_boards[] = {
  68         /*{
  69            .name = "pci6208v",
  70            .dev_id = 0x6208,      // not sure
  71            .ao_chans = 8
  72            // , .ao_bits = 16
  73            },
  74            {
  75            .name = "pci6216v",
  76            .dev_id = 0x6208,      // not sure
  77            .ao_chans = 16
  78            // , .ao_bits = 16
  79            }, */
  80         {
  81          .name = "pci6208a",
  82          .dev_id = 0x6208,
  83          .ao_chans = 8
  84          /* ,    .ao_bits = 16 */
  85          }
  86 };
  87
  88 /* This is used by modprobe to translate PCI IDs to drivers.  Should
  89  * only be used for PCI and ISA-PnP devices */
  90 static DEFINE_PCI_DEVICE_TABLE(pci6208_pci_table) = {
  91         /* { PCI_VENDOR_ID_ADLINK, 0x6208, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 }, */
  92         /* { PCI_VENDOR_ID_ADLINK, 0x6208, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 }, */
  93         {
  94         PCI_VENDOR_ID_ADLINK, 0x6208, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0}, {
  95         0}
  96 };
  97
  98 MODULE_DEVICE_TABLE(pci, pci6208_pci_table);
  99
 100 /* Will be initialized in pci6208_find device(). */
 101 #define thisboard ((const struct pci6208_board *)dev->board_ptr)
 102
 103 struct pci6208_private {
 104         int data;
 105         struct pci_dev *pci_dev;        /* for a PCI device */
 106         unsigned int ao_readback[2];    /* Used for AO readback */
 107 };
 108
 109 #define devpriv ((struct pci6208_private *)dev->private)
 110
 111 static int pci6208_attach(struct comedi_device *dev,
 112                           struct comedi_devconfig *it);
 113 static int pci6208_detach(struct comedi_device *dev);
 114
 115 static struct comedi_driver driver_pci6208 = {
 116         .driver_name = PCI6208_DRIVER_NAME,
 117         .module = THIS_MODULE,
 118         .attach = pci6208_attach,
 119         .detach = pci6208_detach,
 120 };
 121
 122 static int __devinit driver_pci6208_pci_probe(struct pci_dev *dev,
 123                                               const struct pci_device_id *ent)
 124 {
 125         return comedi_pci_auto_config(dev, driver_pci6208.driver_name);
 126 }
 127
 128 static void __devexit driver_pci6208_pci_remove(struct pci_dev *dev)
 129 {
 130         comedi_pci_auto_unconfig(dev);
 131 }
 132
 133 static struct pci_driver driver_pci6208_pci_driver = {
 134         .id_table = pci6208_pci_table,
 135         .probe = &driver_pci6208_pci_probe,
 136         .remove = __devexit_p(&driver_pci6208_pci_remove)
 137 };
 138
 139 static int __init driver_pci6208_init_module(void)
 140 {
 141         int retval;
 142
 143         retval = comedi_driver_register(&driver_pci6208);
 144         if (retval < 0)
 145                 return retval;
 146
 147         driver_pci6208_pci_driver.name = (char *)driver_pci6208.driver_name;
 148         return pci_register_driver(&driver_pci6208_pci_driver);
 149 }
 150
 151 static void __exit driver_pci6208_cleanup_module(void)
 152 {
 153         pci_unregister_driver(&driver_pci6208_pci_driver);
 154         comedi_driver_unregister(&driver_pci6208);
 155 }
 156
 157 module_init(driver_pci6208_init_module);
 158 module_exit(driver_pci6208_cleanup_module);
 159
 160 static int pci6208_find_device(struct comedi_device *dev, int bus, int slot);
 161 static int
 162 pci6208_pci_setup(struct pci_dev *pci_dev, unsigned long *io_base_ptr,
 163                   int dev_minor);
 164
 165 /*read/write functions*/
 166 static int pci6208_ao_winsn(struct comedi_device *dev,
 167                             struct comedi_subdevice *s,
 168                             struct comedi_insn *insn, unsigned int *data);
 169 static int pci6208_ao_rinsn(struct comedi_device *dev,
 170                             struct comedi_subdevice *s,
 171                             struct comedi_insn *insn, unsigned int *data);
 172 /* static int pci6208_dio_insn_bits (struct comedi_device *dev,
 173  *                                      struct comedi_subdevice *s, */
 174 /* struct comedi_insn *insn,unsigned int *data); */
 175 /* static int pci6208_dio_insn_config(struct comedi_device *dev,
 176  *                                      struct comedi_subdevice *s, */
 177 /* struct comedi_insn *insn,unsigned int *data); */
 178
 179 /*
 180  * Attach is called by the Comedi core to configure the driver
 181  * for a particular board.  If you specified a board_name array
 182  * in the driver structure, dev->board_ptr contains that
 183  * address.
 184  */
 185 static int pci6208_attach(struct comedi_device *dev,
 186                           struct comedi_devconfig *it)
 187 {
 188         struct comedi_subdevice *s;
 189         int retval;
 190         unsigned long io_base;
 191
 192         printk(KERN_INFO "comedi%d: pci6208: ", dev->minor);
 193
 194         retval = alloc_private(dev, sizeof(struct pci6208_private));
 195         if (retval < 0)
 196                 return retval;
 197
 198         retval = pci6208_find_device(dev, it->options[0], it->options[1]);
 199         if (retval < 0)
 200                 return retval;
 201
 202         retval = pci6208_pci_setup(devpriv->pci_dev, &io_base, dev->minor);
 203         if (retval < 0)
 204                 return retval;
 205
 206         dev->iobase = io_base;
 207         dev->board_name = thisboard->name;
 208
 209 /*
 210  * Allocate the subdevice structures.  alloc_subdevice() is a
 211  * convenient macro defined in comedidev.h.
 212  */
 213         if (alloc_subdevices(dev, 2) < 0)
 214                 return -ENOMEM;
 215
 216         s = dev->subdevices + 0;
 217         /* analog output subdevice */
 218         s->type = COMEDI_SUBD_AO;
 219         s->subdev_flags = SDF_WRITABLE; /* anything else to add here?? */
 220         s->n_chan = thisboard->ao_chans;
 221         s->maxdata = 0xffff;    /* 16-bit DAC */
 222         s->range_table = &range_bipolar10;      /* this needs to be checked. */
 223         s->insn_write = pci6208_ao_winsn;
 224         s->insn_read = pci6208_ao_rinsn;
 225
 226         /* s=dev->subdevices+1; */
 227         /* digital i/o subdevice */
 228         /* s->type=COMEDI_SUBD_DIO; */
 229         /* s->subdev_flags=SDF_READABLE|SDF_WRITABLE; */
 230         /* s->n_chan=16; */
 231         /* s->maxdata=1; */
 232         /* s->range_table=&range_digital; */
 233         /* s->insn_bits = pci6208_dio_insn_bits; */
 234         /* s->insn_config = pci6208_dio_insn_config; */
 235
 236         printk(KERN_INFO "attached\n");
 237
 238         return 1;
 239 }
 240
 241 /*
 242  * _detach is called to deconfigure a device.  It should deallocate
 243  * resources.
 244  * This function is also called when _attach() fails, so it should be
 245  * careful not to release resources that were not necessarily
 246  * allocated by _attach().  dev->private and dev->subdevices are
 247  * deallocated automatically by the core.
 248  */
 249 static int pci6208_detach(struct comedi_device *dev)
 250 {
 251         printk(KERN_INFO "comedi%d: pci6208: remove\n", dev->minor);
 252
 253         if (devpriv && devpriv->pci_dev) {
 254                 if (dev->iobase)
 255                         comedi_pci_disable(devpriv->pci_dev);
 256                 pci_dev_put(devpriv->pci_dev);
 257         }
 258
 259         return 0;
 260 }
 261
 262 static int pci6208_ao_winsn(struct comedi_device *dev,
 263                             struct comedi_subdevice *s,
 264                             struct comedi_insn *insn, unsigned int *data)
 265 {
 266         int i = 0, Data_Read;
 267         unsigned short chan = CR_CHAN(insn->chanspec);
 268         unsigned long invert = 1 << (16 - 1);
 269         unsigned long out_value;
 270         /* Writing a list of values to an AO channel is probably not
 271          * very useful, but that's how the interface is defined. */
 272         for (i = 0; i < insn->n; i++) {
 273                 out_value = data[i] ^ invert;
 274                 /* a typical programming sequence */
 275                 do {
 276                         Data_Read = (inw(dev->iobase) & 1);
 277                 } while (Data_Read);
 278                 outw(out_value, dev->iobase + (0x02 * chan));
 279                 devpriv->ao_readback[chan] = out_value;
 280         }
 281
 282         /* return the number of samples read/written */
 283         return i;
 284 }
 285
 286 /* AO subdevices should have a read insn as well as a write insn.
 287  * Usually this means copying a value stored in devpriv. */
 288 static int pci6208_ao_rinsn(struct comedi_device *dev,
 289                             struct comedi_subdevice *s,
 290                             struct comedi_insn *insn, unsigned int *data)
 291 {
 292         int i;
 293         int chan = CR_CHAN(insn->chanspec);
 294
 295         for (i = 0; i < insn->n; i++)
 296                 data[i] = devpriv->ao_readback[chan];
 297
 298         return i;
 299 }
 300
 301 /* DIO devices are slightly special.  Although it is possible to
 302  * implement the insn_read/insn_write interface, it is much more
 303  * useful to applications if you implement the insn_bits interface.
 304  * This allows packed reading/writing of the DIO channels.  The
 305  * comedi core can convert between insn_bits and insn_read/write */
 306 /* static int pci6208_dio_insn_bits(struct comedi_device *dev,
 307  *                                      struct comedi_subdevice *s, */
 308 /* struct comedi_insn *insn,unsigned int *data) */
 309 /* { */
 310 /* if(insn->n!=2)return -EINVAL; */
 311
 312         /* The insn data is a mask in data[0] and the new data
 313          * in data[1], each channel cooresponding to a bit. */
 314 /* if(data[0]){ */
 315 /* s->state &= ~data[0]; */
 316 /* s->state |= data[0]&data[1]; */
 317                 /* Write out the new digital output lines */
 318                 /* outw(s->state,dev->iobase + SKEL_DIO); */
 319 /* } */
 320
 321         /* on return, data[1] contains the value of the digital
 322          * input and output lines. */
 323         /* data[1]=inw(dev->iobase + SKEL_DIO); */
 324         /* or we could just return the software copy of the output values if
 325          * it was a purely digital output subdevice */
 326         /* data[1]=s->state; */
 327
 328 /* return 2; */
 329 /* } */
 330
 331 /* static int pci6208_dio_insn_config(struct comedi_device *dev,
 332  *                                      struct comedi_subdevice *s, */
 333 /* struct comedi_insn *insn,unsigned int *data) */
 334 /* { */
 335 /* int chan=CR_CHAN(insn->chanspec); */
 336
 337         /* The input or output configuration of each digital line is
 338          * configured by a special insn_config instruction.  chanspec
 339          * contains the channel to be changed, and data[0] contains the
 340          * value COMEDI_INPUT or COMEDI_OUTPUT. */
 341
 342 /* if(data[0]==COMEDI_OUTPUT){ */
 343 /* s->io_bits |= 1<<chan; */
 344 /* }else{ */
 345 /* s->io_bits &= ~(1<<chan); */
 346 /* } */
 347         /* outw(s->io_bits,dev->iobase + SKEL_DIO_CONFIG); */
 348
 349 /* return 1; */
 350 /* } */
 351
 352 static int pci6208_find_device(struct comedi_device *dev, int bus, int slot)
 353 {
 354         struct pci_dev *pci_dev;
 355         int i;
 356
 357         for (pci_dev = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, NULL);
 358              pci_dev != NULL;
 359              pci_dev = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, pci_dev)) {
 360                 if (pci_dev->vendor == PCI_VENDOR_ID_ADLINK) {
 361                         for (i = 0; i < ARRAY_SIZE(pci6208_boards); i++) {
 362                                 if (pci6208_boards[i].dev_id ==
 363                                         pci_dev->device) {
 364                                         /*
 365                                          * was a particular bus/slot requested?
 366                                         */
 367                                         if ((bus != 0) || (slot != 0)) {
 368                                                 /*
 369                                                  * are we on the
 370                                                  * wrong bus/slot?
 371                                                 */
 372                                                 if (pci_dev->bus->number
 373                                                     != bus ||
 374                                                     PCI_SLOT(pci_dev->devfn)
 375                                                     != slot) {
 376                                                         continue;
 377                                                 }
 378                                         }
 379                                         dev->board_ptr = pci6208_boards + i;
 380                                         goto found;
 381                                 }
 382                         }
 383                 }
 384         }
 385
 386         printk(KERN_ERR "comedi%d: no supported board found! "
 387                         "(req. bus/slot : %d/%d)\n",
 388                         dev->minor, bus, slot);
 389         return -EIO;
 390
 391 found:
 392         printk("comedi%d: found %s (b:s:f=%d:%d:%d) , irq=%d\n",
 393                dev->minor,
 394                pci6208_boards[i].name,
 395                pci_dev->bus->number,
 396                PCI_SLOT(pci_dev->devfn),
 397                PCI_FUNC(pci_dev->devfn), pci_dev->irq);
 398
 399         /*  TODO: Warn about non-tested boards. */
 400         /* switch(board->device_id) */
 401         /* { */
 402         /* }; */
 403
 404         devpriv->pci_dev = pci_dev;
 405
 406         return 0;
 407 }
 408
 409 static int
 410 pci6208_pci_setup(struct pci_dev *pci_dev, unsigned long *io_base_ptr,
 411                   int dev_minor)
 412 {
 413         unsigned long io_base, io_range, lcr_io_base, lcr_io_range;
 414
 415         /*  Enable PCI device and request regions */
 416         if (comedi_pci_enable(pci_dev, PCI6208_DRIVER_NAME) < 0) {
 417                 printk(KERN_ERR "comedi%d: Failed to enable PCI device "
 418                         "and request regions\n",
 419                         dev_minor);
 420                 return -EIO;
 421         }
 422         /* Read local configuration register
 423          * base address [PCI_BASE_ADDRESS #1].
 424          */
 425         lcr_io_base = pci_resource_start(pci_dev, 1);
 426         lcr_io_range = pci_resource_len(pci_dev, 1);
 427
 428         printk(KERN_INFO "comedi%d: local config registers at address"
 429                         " 0x%4lx [0x%4lx]\n",
 430                         dev_minor, lcr_io_base, lcr_io_range);
 431
 432         /*  Read PCI6208 register base address [PCI_BASE_ADDRESS #2]. */
 433         io_base = pci_resource_start(pci_dev, 2);
 434         io_range = pci_resource_end(pci_dev, 2) - io_base + 1;
 435
 436         printk("comedi%d: 6208 registers at address 0x%4lx [0x%4lx]\n",
 437                dev_minor, io_base, io_range);
 438
 439         *io_base_ptr = io_base;
 440         /* devpriv->io_range = io_range; */
 441         /* devpriv->is_valid=0; */
 442         /* devpriv->lcr_io_base=lcr_io_base; */
 443         /* devpriv->lcr_io_range=lcr_io_range; */
 444
 445         return 0;
 446 }
 447
 448 MODULE_AUTHOR("Comedi http://www.comedi.org");
 449 MODULE_DESCRIPTION("Comedi low-level driver");
 450 MODULE_LICENSE("GPL");