drivers/staging/comedi/drivers/cb_pcimdda.c

   1 /*
   2     comedi/drivers/cb_pcimdda.c
   3     Computer Boards PCIM-DDA06-16 Comedi driver
   4     Author: Calin Culianu <calin@ajvar.org>
   5
   6     COMEDI - Linux Control and Measurement Device Interface
   7     Copyright (C) 2000 David A. Schleef <ds@schleef.org>
   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 Driver: cb_pcimdda
  26 Description: Measurement Computing PCIM-DDA06-16
  27 Devices: [Measurement Computing] PCIM-DDA06-16 (cb_pcimdda)
  28 Author: Calin Culianu <calin@ajvar.org>
  29 Updated: Mon, 14 Apr 2008 15:15:51 +0100
  30 Status: works
  31
  32 All features of the PCIM-DDA06-16 board are supported.  This board
  33 has 6 16-bit AO channels, and the usual 8255 DIO setup.  (24 channels,
  34 configurable in banks of 8 and 4, etc.).  This board does not support commands.
  35
  36 The board has a peculiar way of specifying AO gain/range settings -- You have
  37 1 jumper bank on the card, which either makes all 6 AO channels either
  38 5 Volt unipolar, 5V bipolar, 10 Volt unipolar or 10V bipolar.
  39
  40 Since there is absolutely _no_ way to tell in software how this jumper is set
  41 (well, at least according  to the rather thin spec. from Measurement Computing
  42  that comes with the board), the driver assumes the jumper is at its factory
  43 default setting of +/-5V.
  44
  45 Also of note is the fact that this board features another jumper, whose
  46 state is also completely invisible to software.  It toggles two possible AO
  47 output modes on the board:
  48
  49   - Update Mode: Writing to an AO channel instantaneously updates the actual
  50     signal output by the DAC on the board (this is the factory default).
  51   - Simultaneous XFER Mode: Writing to an AO channel has no effect until
  52     you read from any one of the AO channels.  This is useful for loading
  53     all 6 AO values, and then reading from any one of the AO channels on the
  54     device to instantly update all 6 AO values in unison.  Useful for some
  55     control apps, I would assume?  If your jumper is in this setting, then you
  56     need to issue your comedi_data_write()s to load all the values you want,
  57     then issue one comedi_data_read() on any channel on the AO subdevice
  58     to initiate the simultaneous XFER.
  59
  60 Configuration Options:
  61   [0] PCI bus (optional)
  62   [1] PCI slot (optional)
  63   [2] analog output range jumper setting
  64       0 == +/- 5 V
  65       1 == +/- 10 V
  66 */
  67
  68 /*
  69     This is a driver for the Computer Boards PCIM-DDA06-16 Analog Output
  70     card.  This board has a unique register layout and as such probably
  71     deserves its own driver file.
  72
  73     It is theoretically possible to integrate this board into the cb_pcidda
  74     file, but since that isn't my code, I didn't want to significantly
  75     modify that file to support this board (I thought it impolite to do so).
  76
  77     At any rate, if you feel ambitious, please feel free to take
  78     the code out of this file and combine it with a more unified driver
  79     file.
  80
  81     I would like to thank Timothy Curry <Timothy.Curry@rdec.redstone.army.mil>
  82     for lending me a board so that I could write this driver.
  83
  84     -Calin Culianu <calin@ajvar.org>
  85  */
  86
  87 #include "../comedidev.h"
  88
  89 #include "comedi_pci.h"
  90
  91 #include "8255.h"
  92
  93 /* device ids of the cards we support -- currently only 1 card supported */
  94 #define PCI_VENDOR_ID_COMPUTERBOARDS    0x1307
  95 #define PCI_ID_PCIM_DDA06_16            0x0053
  96
  97 /*
  98  * This is straight from skel.c -- I did this in case this source file
  99  * will someday support more than 1 board...
 100  */
 101 struct board_struct {
 102         const char *name;
 103         unsigned short device_id;
 104         int ao_chans;
 105         int ao_bits;
 106         int dio_chans;
 107         int dio_method;
 108         int dio_offset;         /* how many bytes into the BADR are the DIO ports */
 109         int regs_badrindex;     /* IO Region for the control, analog output,
 110                                    and DIO registers */
 111         int reg_sz;             /* number of bytes of registers in io region */
 112 };
 113
 114 enum DIO_METHODS {
 115         DIO_NONE = 0,
 116         DIO_8255,
 117         DIO_INTERNAL            /* unimplemented */
 118 };
 119
 120 static const struct board_struct boards[] = {
 121         {
 122          .name = "cb_pcimdda06-16",
 123          .device_id = PCI_ID_PCIM_DDA06_16,
 124          .ao_chans = 6,
 125          .ao_bits = 16,
 126          .dio_chans = 24,
 127          .dio_method = DIO_8255,
 128          .dio_offset = 12,
 129          .regs_badrindex = 3,
 130          .reg_sz = 16,
 131          }
 132 };
 133
 134 /*
 135  * Useful for shorthand access to the particular board structure
 136  */
 137 #define thisboard    ((const struct board_struct *)dev->board_ptr)
 138
 139 #define REG_SZ (thisboard->reg_sz)
 140 #define REGS_BADRINDEX (thisboard->regs_badrindex)
 141
 142 /* This is used by modprobe to translate PCI IDs to drivers.  Should
 143  * only be used for PCI and ISA-PnP devices */
 144 /* Please add your PCI vendor ID to comedidev.h, and it will be forwarded
 145  * upstream. */
 146 static DEFINE_PCI_DEVICE_TABLE(pci_table) = {
 147         {
 148         PCI_VENDOR_ID_COMPUTERBOARDS, PCI_ID_PCIM_DDA06_16, PCI_ANY_ID,
 149                     PCI_ANY_ID, 0, 0, 0}, {
 150         0}
 151 };
 152
 153 MODULE_DEVICE_TABLE(pci, pci_table);
 154
 155 /* this structure is for data unique to this hardware driver.  If
 156    several hardware drivers keep similar information in this structure,
 157    feel free to suggest moving the variable to the struct comedi_device struct.  */
 158 struct board_private_struct {
 159         unsigned long registers;        /* set by probe */
 160         unsigned long dio_registers;
 161         char attached_to_8255;  /* boolean */
 162         char attached_successfully;     /* boolean */
 163         /* would be useful for a PCI device */
 164         struct pci_dev *pci_dev;
 165
 166 #define MAX_AO_READBACK_CHANNELS 6
 167         /* Used for AO readback */
 168         unsigned int ao_readback[MAX_AO_READBACK_CHANNELS];
 169
 170 };
 171
 172 /*
 173  * most drivers define the following macro to make it easy to
 174  * access the private structure.
 175  */
 176 #define devpriv ((struct board_private_struct *)dev->private)
 177
 178 /*
 179  * The struct comedi_driver structure tells the Comedi core module
 180  * which functions to call to configure/deconfigure (attach/detach)
 181  * the board, and also about the kernel module that contains
 182  * the device code.
 183  */
 184 static int attach(struct comedi_device *dev, struct comedi_devconfig *it);
 185 static int detach(struct comedi_device *dev);
 186 static struct comedi_driver cb_pcimdda_driver = {
 187         .driver_name = "cb_pcimdda",
 188         .module = THIS_MODULE,
 189         .attach = attach,
 190         .detach = detach,
 191 };
 192
 193 MODULE_AUTHOR("Calin A. Culianu <calin@rtlab.org>");
 194 MODULE_DESCRIPTION("Comedi low-level driver for the Computerboards PCIM-DDA "
 195                    "series.  Currently only supports PCIM-DDA06-16 (which "
 196                    "also happens to be the only board in this series. :) ) ");
 197 MODULE_LICENSE("GPL");
 198 COMEDI_PCI_INITCLEANUP_NOMODULE(cb_pcimdda_driver, pci_table);
 199
 200 static int ao_winsn(struct comedi_device *dev, struct comedi_subdevice *s,
 201                     struct comedi_insn *insn, unsigned int *data);
 202 static int ao_rinsn(struct comedi_device *dev, struct comedi_subdevice *s,
 203                     struct comedi_insn *insn, unsigned int *data);
 204
 205 /*---------------------------------------------------------------------------
 206   HELPER FUNCTION DECLARATIONS
 207 -----------------------------------------------------------------------------*/
 208
 209 /* returns a maxdata value for a given n_bits */
 210 static inline unsigned int figure_out_maxdata(int bits)
 211 {
 212         return ((unsigned int)1 << bits) - 1;
 213 }
 214
 215 /*
 216  *  Probes for a supported device.
 217  *
 218  *  Prerequisite: private be allocated already inside dev
 219  *
 220  *  If the device is found, it returns 0 and has the following side effects:
 221  *
 222  *  o  assigns a struct pci_dev * to dev->private->pci_dev
 223  *  o  assigns a struct board * to dev->board_ptr
 224  *  o  sets dev->private->registers
 225  *  o  sets dev->private->dio_registers
 226  *
 227  *  Otherwise, returns a -errno on error
 228  */
 229 static int probe(struct comedi_device *dev, const struct comedi_devconfig *it);
 230
 231 /*---------------------------------------------------------------------------
 232   FUNCTION DEFINITIONS
 233 -----------------------------------------------------------------------------*/
 234
 235 /*
 236  * Attach is called by the Comedi core to configure the driver
 237  * for a particular board.  If you specified a board_name array
 238  * in the driver structure, dev->board_ptr contains that
 239  * address.
 240  */
 241 static int attach(struct comedi_device *dev, struct comedi_devconfig *it)
 242 {
 243         struct comedi_subdevice *s;
 244         int err;
 245
 246 /*
 247  * Allocate the private structure area.  alloc_private() is a
 248  * convenient macro defined in comedidev.h.
 249  * if this function fails (returns negative) then the private area is
 250  * kfree'd by comedi
 251  */
 252         if (alloc_private(dev, sizeof(struct board_private_struct)) < 0)
 253                 return -ENOMEM;
 254
 255 /*
 256  * If you can probe the device to determine what device in a series
 257  * it is, this is the place to do it.  Otherwise, dev->board_ptr
 258  * should already be initialized.
 259  */
 260         err = probe(dev, it);
 261         if (err)
 262                 return err;
 263
 264 /* Output some info */
 265         printk("comedi%d: %s: ", dev->minor, thisboard->name);
 266
 267 /*
 268  * Initialize dev->board_name.  Note that we can use the "thisboard"
 269  * macro now, since we just initialized it in the last line.
 270  */
 271         dev->board_name = thisboard->name;
 272
 273 /*
 274  * Allocate the subdevice structures.  alloc_subdevice() is a
 275  * convenient macro defined in comedidev.h.
 276  */
 277         if (alloc_subdevices(dev, 2) < 0)
 278                 return -ENOMEM;
 279
 280         s = dev->subdevices + 0;
 281
 282         /* analog output subdevice */
 283         s->type = COMEDI_SUBD_AO;
 284         s->subdev_flags = SDF_WRITABLE | SDF_READABLE;
 285         s->n_chan = thisboard->ao_chans;
 286         s->maxdata = figure_out_maxdata(thisboard->ao_bits);
 287         /* this is hard-coded here */
 288         if (it->options[2])
 289                 s->range_table = &range_bipolar10;
 290         else
 291                 s->range_table = &range_bipolar5;
 292         s->insn_write = &ao_winsn;
 293         s->insn_read = &ao_rinsn;
 294
 295         s = dev->subdevices + 1;
 296         /* digital i/o subdevice */
 297         if (thisboard->dio_chans) {
 298                 switch (thisboard->dio_method) {
 299                 case DIO_8255:
 300                         /* this is a straight 8255, so register us with the 8255 driver */
 301                         subdev_8255_init(dev, s, NULL, devpriv->dio_registers);
 302                         devpriv->attached_to_8255 = 1;
 303                         break;
 304                 case DIO_INTERNAL:
 305                 default:
 306                         printk("DIO_INTERNAL not implemented yet!\n");
 307                         return -ENXIO;
 308                         break;
 309                 }
 310         } else {
 311                 s->type = COMEDI_SUBD_UNUSED;
 312         }
 313
 314         devpriv->attached_successfully = 1;
 315
 316         printk("attached\n");
 317
 318         return 1;
 319 }
 320
 321 /*
 322  * _detach is called to deconfigure a device.  It should deallocate
 323  * resources.
 324  * This function is also called when _attach() fails, so it should be
 325  * careful not to release resources that were not necessarily
 326  * allocated by _attach().  dev->private and dev->subdevices are
 327  * deallocated automatically by the core.
 328  */
 329 static int detach(struct comedi_device *dev)
 330 {
 331         if (devpriv) {
 332
 333                 if (dev->subdevices && devpriv->attached_to_8255) {
 334                         /* de-register us from the 8255 driver */
 335                         subdev_8255_cleanup(dev, dev->subdevices + 2);
 336                         devpriv->attached_to_8255 = 0;
 337                 }
 338
 339                 if (devpriv->pci_dev) {
 340                         if (devpriv->registers)
 341                                 comedi_pci_disable(devpriv->pci_dev);
 342                         pci_dev_put(devpriv->pci_dev);
 343                 }
 344
 345                 if (devpriv->attached_successfully && thisboard)
 346                         printk("comedi%d: %s: detached\n", dev->minor,
 347                                thisboard->name);
 348
 349         }
 350
 351         return 0;
 352 }
 353
 354 static int ao_winsn(struct comedi_device *dev, struct comedi_subdevice *s,
 355                     struct comedi_insn *insn, unsigned int *data)
 356 {
 357         int i;
 358         int chan = CR_CHAN(insn->chanspec);
 359         unsigned long offset = devpriv->registers + chan * 2;
 360
 361         /* Writing a list of values to an AO channel is probably not
 362          * very useful, but that's how the interface is defined. */
 363         for (i = 0; i < insn->n; i++) {
 364                 /*  first, load the low byte */
 365                 outb((char)(data[i] & 0x00ff), offset);
 366                 /*  next, write the high byte -- only after this is written is
 367                    the channel voltage updated in the DAC, unless
 368                    we're in simultaneous xfer mode (jumper on card)
 369                    then a rinsn is necessary to actually update the DAC --
 370                    see ao_rinsn() below... */
 371                 outb((char)(data[i] >> 8 & 0x00ff), offset + 1);
 372
 373                 /* for testing only.. the actual rinsn SHOULD do an inw!
 374                    (see the stuff about simultaneous XFER mode on this board) */
 375                 devpriv->ao_readback[chan] = data[i];
 376         }
 377
 378         /* return the number of samples read/written */
 379         return i;
 380 }
 381
 382 /* AO subdevices should have a read insn as well as a write insn.
 383
 384    Usually this means copying a value stored in devpriv->ao_readback.
 385    However, since this board has this jumper setting called "Simultaneous
 386    Xfer mode" (off by default), we will support it.  Simultaneaous xfer
 387    mode is accomplished by loading ALL the values you want for AO in all the
 388    channels, then READing off one of the AO registers to initiate the
 389    instantaneous simultaneous update of all DAC outputs, which makes
 390    all AO channels update simultaneously.  This is useful for some control
 391    applications, I would imagine.
 392 */
 393 static int ao_rinsn(struct comedi_device *dev, struct comedi_subdevice *s,
 394                     struct comedi_insn *insn, unsigned int *data)
 395 {
 396         int i;
 397         int chan = CR_CHAN(insn->chanspec);
 398
 399         for (i = 0; i < insn->n; i++) {
 400                 inw(devpriv->registers + chan * 2);
 401                 /* should I set data[i] to the result of the actual read on the register
 402                    or the cached unsigned int in devpriv->ao_readback[]? */
 403                 data[i] = devpriv->ao_readback[chan];
 404         }
 405
 406         return i;
 407 }
 408
 409 /*---------------------------------------------------------------------------
 410   HELPER FUNCTION DEFINITIONS
 411 -----------------------------------------------------------------------------*/
 412
 413 /*
 414  *  Probes for a supported device.
 415  *
 416  *  Prerequisite: private be allocated already inside dev
 417  *
 418  *  If the device is found, it returns 0 and has the following side effects:
 419  *
 420  *  o  assigns a struct pci_dev * to dev->private->pci_dev
 421  *  o  assigns a struct board * to dev->board_ptr
 422  *  o  sets dev->private->registers
 423  *  o  sets dev->private->dio_registers
 424  *
 425  *  Otherwise, returns a -errno on error
 426  */
 427 static int probe(struct comedi_device *dev, const struct comedi_devconfig *it)
 428 {
 429         struct pci_dev *pcidev;
 430         int index;
 431         unsigned long registers;
 432
 433         for (pcidev = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, NULL);
 434              pcidev != NULL;
 435              pcidev = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, pcidev)) {
 436                 /*  is it not a computer boards card? */
 437                 if (pcidev->vendor != PCI_VENDOR_ID_COMPUTERBOARDS)
 438                         continue;
 439                 /*  loop through cards supported by this driver */
 440                 for (index = 0; index < ARRAY_SIZE(boards); index++) {
 441                         if (boards[index].device_id != pcidev->device)
 442                                 continue;
 443                         /*  was a particular bus/slot requested? */
 444                         if (it->options[0] || it->options[1]) {
 445                                 /*  are we on the wrong bus/slot? */
 446                                 if (pcidev->bus->number != it->options[0] ||
 447                                     PCI_SLOT(pcidev->devfn) != it->options[1]) {
 448                                         continue;
 449                                 }
 450                         }
 451                         /* found ! */
 452
 453                         devpriv->pci_dev = pcidev;
 454                         dev->board_ptr = boards + index;
 455                         if (comedi_pci_enable(pcidev, thisboard->name)) {
 456                                 printk
 457                                     ("cb_pcimdda: Failed to enable PCI device and request regions\n");
 458                                 return -EIO;
 459                         }
 460                         registers =
 461                             pci_resource_start(devpriv->pci_dev,
 462                                                REGS_BADRINDEX);
 463                         devpriv->registers = registers;
 464                         devpriv->dio_registers
 465                             = devpriv->registers + thisboard->dio_offset;
 466                         return 0;
 467                 }
 468         }
 469
 470         printk("cb_pcimdda: No supported ComputerBoards/MeasurementComputing "
 471                "card found at the requested position\n");
 472         return -ENODEV;
 473 }