drivers/staging/comedi/drivers/adq12b.c

   1 /*
   2     comedi/drivers/adq12b.c
   3     driver for MicroAxial ADQ12-B data acquisition and control card
   4
   5     COMEDI - Linux Control and Measurement Device Interface
   6     Copyright (C) 2000 David A. Schleef <ds@schleef.org>
   7
   8     This program is free software; you can redistribute it and/or modify
   9     it under the terms of the GNU General Public License as published by
  10     the Free Software Foundation; either version 2 of the License, or
  11     (at your option) any later version.
  12
  13     This program is distributed in the hope that it will be useful,
  14     but WITHOUT ANY WARRANTY; without even the implied warranty of
  15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16     GNU General Public License for more details.
  17
  18     You should have received a copy of the GNU General Public License
  19     along with this program; if not, write to the Free Software
  20     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21
  22 */
  23 /*
  24 Driver: adq12b
  25 Description: driver for MicroAxial ADQ12-B data acquisition and control card
  26 Devices: [MicroAxial] ADQ12-B (adq12b)
  27 Author: jeremy theler <thelerg@ib.cnea.gov.ar>
  28 Updated: Thu, 21 Feb 2008 02:56:27 -0300
  29 Status: works
  30
  31 Driver for the acquisition card ADQ12-B (without any add-on).
  32
  33  - Analog input is subdevice 0 (16 channels single-ended or 8 differential)
  34  - Digital input is subdevice 1 (5 channels)
  35  - Digital output is subdevice 1 (8 channels)
  36  - The PACER is not supported in this version
  37
  38 If you do not specify any options, they will default to
  39
  40   # comedi_config /dev/comedi0 adq12b 0x300,0,0
  41
  42   option 1: I/O base address. The following table is provided as a help
  43    of the hardware jumpers.
  44
  45          address            jumper JADR
  46           0x300                 1 (factory default)
  47           0x320                 2
  48           0x340                 3
  49           0x360                 4
  50           0x380                 5
  51           0x3A0                 6
  52
  53   option 2: unipolar/bipolar ADC selection: 0 -> bipolar, 1 -> unipolar
  54
  55         selection         comedi_config option            JUB
  56          bipolar                0                         2-3 (factory default)
  57          unipolar               1                         1-2
  58
  59   option 3: single-ended/differential AI selection: 0 -> SE, 1 -> differential
  60
  61         selection         comedi_config option     JCHA    JCHB
  62        single-ended             0                  1-2     1-2 (factory default)
  63        differential             1                  2-3     2-3
  64
  65    written by jeremy theler <thelerg@ib.cnea.gov.ar>
  66
  67    instituto balseiro
  68    commission nacional de energia atomica
  69    universidad nacional de cuyo
  70    argentina
  71
  72    21-feb-2008
  73      + changed supported devices string (missused the [] and ())
  74
  75    13-oct-2007
  76      + first try
  77
  78
  79 */
  80
  81 #include "../comedidev.h"
  82
  83 /* address scheme (page 2.17 of the manual) */
  84 #define ADQ12B_SIZE     16
  85
  86 #define ADQ12B_CTREG    0x00
  87 #define ADQ12B_STINR    0x00
  88 #define ADQ12B_OUTBR    0x04
  89 #define ADQ12B_ADLOW    0x08
  90 #define ADQ12B_ADHIG    0x09
  91 #define ADQ12B_CONT0    0x0c
  92 #define ADQ12B_CONT1    0x0d
  93 #define ADQ12B_CONT2    0x0e
  94 #define ADQ12B_COWORD   0x0f
  95
  96 /* mask of the bit at STINR to check end of conversion */
  97 #define ADQ12B_EOC     0x20
  98
  99 #define TIMEOUT        20
 100
 101 /* available ranges through the PGA gains */
 102 static const struct comedi_lrange range_adq12b_ai_bipolar = { 4, {
 103                                                                   BIP_RANGE(5),
 104                                                                   BIP_RANGE(2),
 105                                                                   BIP_RANGE(1),
 106                                                                   BIP_RANGE(0.5)
 107                                                                   }
 108 };
 109
 110 static const struct comedi_lrange range_adq12b_ai_unipolar = { 4, {
 111                                                                    UNI_RANGE(5),
 112                                                                    UNI_RANGE(2),
 113                                                                    UNI_RANGE(1),
 114                                                                    UNI_RANGE
 115                                                                    (0.5)
 116                                                                    }
 117 };
 118
 119 struct adq12b_board {
 120         const char *name;
 121         int ai_se_chans;
 122         int ai_diff_chans;
 123         int ai_bits;
 124         int di_chans;
 125         int do_chans;
 126 };
 127
 128 #define thisboard ((const struct adq12b_board *)dev->board_ptr)
 129
 130 struct adq12b_private {
 131         int unipolar;           /* option 2 of comedi_config (1 is iobase) */
 132         int differential;       /* option 3 of comedi_config */
 133         int last_channel;
 134         int last_range;
 135         unsigned int digital_state;
 136 };
 137
 138 #define devpriv ((struct adq12b_private *)dev->private)
 139
 140 /*
 141  * "instructions" read/write data in "one-shot" or "software-triggered"
 142  * mode.
 143  */
 144
 145 static int adq12b_ai_rinsn(struct comedi_device *dev,
 146                            struct comedi_subdevice *s, struct comedi_insn *insn,
 147                            unsigned int *data)
 148 {
 149         int n, i;
 150         int range, channel;
 151         unsigned char hi, lo, status;
 152
 153         /* change channel and range only if it is different from the previous */
 154         range = CR_RANGE(insn->chanspec);
 155         channel = CR_CHAN(insn->chanspec);
 156         if (channel != devpriv->last_channel || range != devpriv->last_range) {
 157                 outb((range << 4) | channel, dev->iobase + ADQ12B_CTREG);
 158                 udelay(50);     /* wait for the mux to settle */
 159         }
 160
 161         /* trigger conversion */
 162         status = inb(dev->iobase + ADQ12B_ADLOW);
 163
 164         /* convert n samples */
 165         for (n = 0; n < insn->n; n++) {
 166
 167                 /* wait for end of conversion */
 168                 i = 0;
 169                 do {
 170                         /* udelay(1); */
 171                         status = inb(dev->iobase + ADQ12B_STINR);
 172                         status = status & ADQ12B_EOC;
 173                 } while (status == 0 && ++i < TIMEOUT);
 174                 /* } while (++i < 10); */
 175
 176                 /* read data */
 177                 hi = inb(dev->iobase + ADQ12B_ADHIG);
 178                 lo = inb(dev->iobase + ADQ12B_ADLOW);
 179
 180                 /* printk("debug: chan=%d range=%d status=%d hi=%d lo=%d\n",
 181                        channel, range, status,  hi, lo); */
 182                 data[n] = (hi << 8) | lo;
 183
 184         }
 185
 186         /* return the number of samples read/written */
 187         return n;
 188 }
 189
 190 static int adq12b_di_insn_bits(struct comedi_device *dev,
 191                                struct comedi_subdevice *s,
 192                                struct comedi_insn *insn, unsigned int *data)
 193 {
 194
 195         /* only bits 0-4 have information about digital inputs */
 196         data[1] = (inb(dev->iobase + ADQ12B_STINR) & (0x1f));
 197
 198         return 2;
 199 }
 200
 201 static int adq12b_do_insn_bits(struct comedi_device *dev,
 202                                struct comedi_subdevice *s,
 203                                struct comedi_insn *insn, unsigned int *data)
 204 {
 205         int channel;
 206
 207         for (channel = 0; channel < 8; channel++)
 208                 if (((data[0] >> channel) & 0x01) != 0)
 209                         outb((((data[1] >> channel) & 0x01) << 3) | channel,
 210                              dev->iobase + ADQ12B_OUTBR);
 211
 212         /* store information to retrieve when asked for reading */
 213         if (data[0]) {
 214                 devpriv->digital_state &= ~data[0];
 215                 devpriv->digital_state |= (data[0] & data[1]);
 216         }
 217
 218         data[1] = devpriv->digital_state;
 219
 220         return 2;
 221 }
 222
 223 static int adq12b_attach(struct comedi_device *dev, struct comedi_devconfig *it)
 224 {
 225         struct comedi_subdevice *s;
 226         unsigned long iobase;
 227         int unipolar, differential;
 228
 229         iobase = it->options[0];
 230         unipolar = it->options[1];
 231         differential = it->options[2];
 232
 233         printk(KERN_INFO "comedi%d: adq12b called with options base=0x%03lx, "
 234                "%s and %s\n", dev->minor, iobase,
 235                (unipolar == 1) ? "unipolar" : "bipolar",
 236                (differential == 1) ? "differential" : "single-ended");
 237
 238         /* if no address was specified, try the default 0x300 */
 239         if (iobase == 0) {
 240                 printk(KERN_WARNING "comedi%d: adq12b warning: I/O base "
 241                        "address not specified. Trying the default 0x300.\n",
 242                        dev->minor);
 243                 iobase = 0x300;
 244         }
 245
 246         printk("comedi%d: adq12b: 0x%04lx ", dev->minor, iobase);
 247         if (!request_region(iobase, ADQ12B_SIZE, "adq12b")) {
 248                 printk("I/O port conflict\n");
 249                 return -EIO;
 250         }
 251         dev->iobase = iobase;
 252
 253 /*
 254  * Initialize dev->board_name.  Note that we can use the "thisboard"
 255  * macro now, since we just initialized it in the last line.
 256  */
 257         dev->board_name = thisboard->name;
 258
 259 /*
 260  * Allocate the private structure area.  alloc_private() is a
 261  * convenient macro defined in comedidev.h.
 262  */
 263         if (alloc_private(dev, sizeof(struct adq12b_private)) < 0)
 264                 return -ENOMEM;
 265
 266 /* fill in devpriv structure */
 267         devpriv->unipolar = unipolar;
 268         devpriv->differential = differential;
 269         devpriv->digital_state = 0;
 270 /* initialize channel and range to -1 so we make sure we always write
 271    at least once to the CTREG in the instruction */
 272         devpriv->last_channel = -1;
 273         devpriv->last_range = -1;
 274
 275 /*
 276  * Allocate the subdevice structures.  alloc_subdevice() is a
 277  * convenient macro defined in comedidev.h.
 278  */
 279         if (alloc_subdevices(dev, 3) < 0)
 280                 return -ENOMEM;
 281
 282         s = dev->subdevices + 0;
 283         /* analog input subdevice */
 284         s->type = COMEDI_SUBD_AI;
 285         if (differential) {
 286                 s->subdev_flags = SDF_READABLE | SDF_GROUND | SDF_DIFF;
 287                 s->n_chan = thisboard->ai_diff_chans;
 288         } else {
 289                 s->subdev_flags = SDF_READABLE | SDF_GROUND;
 290                 s->n_chan = thisboard->ai_se_chans;
 291         }
 292
 293         if (unipolar)
 294                 s->range_table = &range_adq12b_ai_unipolar;
 295         else
 296                 s->range_table = &range_adq12b_ai_bipolar;
 297
 298         s->maxdata = (1 << thisboard->ai_bits) - 1;
 299
 300         s->len_chanlist = 4;    /* This is the maximum chanlist length that
 301                                    the board can handle */
 302         s->insn_read = adq12b_ai_rinsn;
 303
 304         s = dev->subdevices + 1;
 305         /* digital input subdevice */
 306         s->type = COMEDI_SUBD_DI;
 307         s->subdev_flags = SDF_READABLE;
 308         s->n_chan = thisboard->di_chans;
 309         s->maxdata = 1;
 310         s->range_table = &range_digital;
 311         s->insn_bits = adq12b_di_insn_bits;
 312
 313         s = dev->subdevices + 2;
 314         /* digital output subdevice */
 315         s->type = COMEDI_SUBD_DO;
 316         s->subdev_flags = SDF_WRITABLE;
 317         s->n_chan = thisboard->do_chans;
 318         s->maxdata = 1;
 319         s->range_table = &range_digital;
 320         s->insn_bits = adq12b_do_insn_bits;
 321
 322         printk(KERN_INFO "attached\n");
 323
 324         return 0;
 325 }
 326
 327 static void adq12b_detach(struct comedi_device *dev)
 328 {
 329         if (dev->iobase)
 330                 release_region(dev->iobase, ADQ12B_SIZE);
 331         kfree(devpriv);
 332 }
 333
 334 static const struct adq12b_board adq12b_boards[] = {
 335         {
 336                 .name           = "adq12b",
 337                 .ai_se_chans    = 16,
 338                 .ai_diff_chans  = 8,
 339                 .ai_bits        = 12,
 340                 .di_chans       = 5,
 341                 .do_chans       = 8,
 342         },
 343 };
 344
 345 static struct comedi_driver adq12b_driver = {
 346         .driver_name    = "adq12b",
 347         .module         = THIS_MODULE,
 348         .attach         = adq12b_attach,
 349         .detach         = adq12b_detach,
 350         .board_name     = &adq12b_boards[0].name,
 351         .offset         = sizeof(struct adq12b_board),
 352         .num_names      = ARRAY_SIZE(adq12b_boards),
 353 };
 354 module_comedi_driver(adq12b_driver);
 355
 356 MODULE_AUTHOR("Comedi http://www.comedi.org");
 357 MODULE_DESCRIPTION("Comedi low-level driver");
 358 MODULE_LICENSE("GPL");