drivers/staging/comedi/drivers/pcl726.c

   1 /*
   2     comedi/drivers/pcl726.c
   3
   4     hardware driver for Advantech cards:
   5      card:   PCL-726, PCL-727, PCL-728
   6      driver: pcl726,  pcl727,  pcl728
   7     and for ADLink cards:
   8      card:   ACL-6126, ACL-6128
   9      driver: acl6126,  acl6128
  10
  11     COMEDI - Linux Control and Measurement Device Interface
  12     Copyright (C) 1998 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 /*
  25 Driver: pcl726
  26 Description: Advantech PCL-726 & compatibles
  27 Author: ds
  28 Status: untested
  29 Devices: [Advantech] PCL-726 (pcl726), PCL-727 (pcl727), PCL-728 (pcl728),
  30   [ADLink] ACL-6126 (acl6126), ACL-6128 (acl6128)
  31
  32 Interrupts are not supported.
  33
  34     Options for PCL-726:
  35      [0] - IO Base
  36      [2]...[7] - D/A output range for channel 1-6:
  37                 0: 0-5V, 1: 0-10V, 2: +/-5V, 3: +/-10V,
  38                 4: 4-20mA, 5: unknown (external reference)
  39
  40     Options for PCL-727:
  41      [0] - IO Base
  42      [2]...[13] - D/A output range for channel 1-12:
  43                 0: 0-5V, 1: 0-10V, 2: +/-5V,
  44                 3: 4-20mA
  45
  46     Options for PCL-728 and ACL-6128:
  47      [0] - IO Base
  48      [2], [3] - D/A output range for channel 1 and 2:
  49                 0: 0-5V, 1: 0-10V, 2: +/-5V, 3: +/-10V,
  50                 4: 4-20mA, 5: 0-20mA
  51
  52     Options for ACL-6126:
  53      [0] - IO Base
  54      [1] - IRQ (0=disable, 3, 5, 6, 7, 9, 10, 11, 12, 15) (currently ignored)
  55      [2]...[7] - D/A output range for channel 1-6:
  56                 0: 0-5V, 1: 0-10V, 2: +/-5V, 3: +/-10V,
  57                 4: 4-20mA
  58 */
  59
  60 /*
  61     Thanks to Circuit Specialists for having programming info (!) on
  62     their web page.  (http://www.cir.com/)
  63 */
  64
  65 #include <linux/module.h>
  66 #include <linux/interrupt.h>
  67
  68 #include "../comedidev.h"
  69
  70 #include "comedi_fc.h"
  71
  72 #define PCL726_AO_MSB_REG(x)    (0x00 + ((x) * 2))
  73 #define PCL726_AO_LSB_REG(x)    (0x01 + ((x) * 2))
  74 #define PCL726_DO_MSB_REG       0x0c
  75 #define PCL726_DO_LSB_REG       0x0d
  76 #define PCL726_DI_MSB_REG       0x0e
  77 #define PCL726_DI_LSB_REG       0x0f
  78
  79 #define PCL727_DI_MSB_REG       0x00
  80 #define PCL727_DI_LSB_REG       0x01
  81 #define PCL727_DO_MSB_REG       0x18
  82 #define PCL727_DO_LSB_REG       0x19
  83
  84 static const struct comedi_lrange *const rangelist_726[] = {
  85         &range_unipolar5,
  86         &range_unipolar10,
  87         &range_bipolar5,
  88         &range_bipolar10,
  89         &range_4_20mA,
  90         &range_unknown
  91 };
  92
  93 static const struct comedi_lrange *const rangelist_727[] = {
  94         &range_unipolar5,
  95         &range_unipolar10,
  96         &range_bipolar5,
  97         &range_4_20mA
  98 };
  99
 100 static const struct comedi_lrange *const rangelist_728[] = {
 101         &range_unipolar5,
 102         &range_unipolar10,
 103         &range_bipolar5,
 104         &range_bipolar10,
 105         &range_4_20mA,
 106         &range_0_20mA
 107 };
 108
 109 struct pcl726_board {
 110         const char *name;
 111         unsigned long io_len;
 112         unsigned int irq_mask;
 113         const struct comedi_lrange *const *ao_ranges;
 114         int ao_num_ranges;
 115         int ao_nchan;
 116         unsigned int have_dio:1;
 117         unsigned int is_pcl727:1;
 118 };
 119
 120 static const struct pcl726_board boardtypes[] = {
 121         {
 122                 .name           = "pcl726",
 123                 .io_len         = 0x10,
 124                 .ao_ranges      = &rangelist_726[0],
 125                 .ao_num_ranges  = ARRAY_SIZE(rangelist_726),
 126                 .ao_nchan       = 6,
 127                 .have_dio       = 1,
 128         }, {
 129                 .name           = "pcl727",
 130                 .io_len         = 0x20,
 131                 .ao_ranges      = &rangelist_727[0],
 132                 .ao_num_ranges  = ARRAY_SIZE(rangelist_727),
 133                 .ao_nchan       = 12,
 134                 .have_dio       = 1,
 135                 .is_pcl727      = 1,
 136         }, {
 137                 .name           = "pcl728",
 138                 .io_len         = 0x08,
 139                 .ao_num_ranges  = ARRAY_SIZE(rangelist_728),
 140                 .ao_ranges      = &rangelist_728[0],
 141                 .ao_nchan       = 2,
 142         }, {
 143                 .name           = "acl6126",
 144                 .io_len         = 0x10,
 145                 .irq_mask       = 0x96e8,
 146                 .ao_num_ranges  = ARRAY_SIZE(rangelist_726),
 147                 .ao_ranges      = &rangelist_726[0],
 148                 .ao_nchan       = 6,
 149                 .have_dio       = 1,
 150         }, {
 151                 .name           = "acl6128",
 152                 .io_len         = 0x08,
 153                 .ao_num_ranges  = ARRAY_SIZE(rangelist_728),
 154                 .ao_ranges      = &rangelist_728[0],
 155                 .ao_nchan       = 2,
 156         },
 157 };
 158
 159 struct pcl726_private {
 160         const struct comedi_lrange *rangelist[12];
 161         unsigned int ao_readback[12];
 162         unsigned int cmd_running:1;
 163 };
 164
 165 static int pcl818_intr_insn_bits(struct comedi_device *dev,
 166                                  struct comedi_subdevice *s,
 167                                  struct comedi_insn *insn,
 168                                  unsigned int *data)
 169 {
 170         data[1] = 0;
 171         return insn->n;
 172 }
 173
 174 static int pcl818_intr_cmdtest(struct comedi_device *dev,
 175                                struct comedi_subdevice *s,
 176                                struct comedi_cmd *cmd)
 177 {
 178         int err = 0;
 179
 180         /* Step 1 : check if triggers are trivially valid */
 181
 182         err |= cfc_check_trigger_src(&cmd->start_src, TRIG_NOW);
 183         err |= cfc_check_trigger_src(&cmd->scan_begin_src, TRIG_EXT);
 184         err |= cfc_check_trigger_src(&cmd->convert_src, TRIG_FOLLOW);
 185         err |= cfc_check_trigger_src(&cmd->scan_end_src, TRIG_COUNT);
 186         err |= cfc_check_trigger_src(&cmd->stop_src, TRIG_NONE);
 187
 188         if (err)
 189                 return 1;
 190
 191         /* Step 2a : make sure trigger sources are unique */
 192         /* Step 2b : and mutually compatible */
 193
 194         if (err)
 195                 return 2;
 196
 197         /* Step 3: check if arguments are trivially valid */
 198
 199         err |= cfc_check_trigger_arg_is(&cmd->start_arg, 0);
 200         err |= cfc_check_trigger_arg_is(&cmd->scan_begin_arg, 0);
 201         err |= cfc_check_trigger_arg_is(&cmd->convert_arg, 0);
 202         err |= cfc_check_trigger_arg_is(&cmd->scan_end_arg, 1);
 203         err |= cfc_check_trigger_arg_is(&cmd->stop_arg, 0);
 204
 205         if (err)
 206                 return 3;
 207
 208         /* step 4: ignored */
 209
 210         if (err)
 211                 return 4;
 212
 213         return 0;
 214 }
 215
 216 static int pcl818_intr_cmd(struct comedi_device *dev,
 217                            struct comedi_subdevice *s)
 218 {
 219         struct pcl726_private *devpriv = dev->private;
 220
 221         devpriv->cmd_running = 1;
 222
 223         return 0;
 224 }
 225
 226 static int pcl818_intr_cancel(struct comedi_device *dev,
 227                               struct comedi_subdevice *s)
 228 {
 229         struct pcl726_private *devpriv = dev->private;
 230
 231         devpriv->cmd_running = 0;
 232
 233         return 0;
 234 }
 235
 236 static irqreturn_t pcl818_interrupt(int irq, void *d)
 237 {
 238         struct comedi_device *dev = d;
 239         struct comedi_subdevice *s = dev->read_subdev;
 240         struct pcl726_private *devpriv = dev->private;
 241
 242         if (devpriv->cmd_running) {
 243                 pcl818_intr_cancel(dev, s);
 244
 245                 comedi_buf_put(s->async, 0);
 246                 s->async->events |= (COMEDI_CB_BLOCK | COMEDI_CB_EOS);
 247                 comedi_event(dev, s);
 248         }
 249
 250         return IRQ_HANDLED;
 251 }
 252
 253 static int pcl726_ao_insn_write(struct comedi_device *dev,
 254                                 struct comedi_subdevice *s,
 255                                 struct comedi_insn *insn,
 256                                 unsigned int *data)
 257 {
 258         struct pcl726_private *devpriv = dev->private;
 259         unsigned int chan = CR_CHAN(insn->chanspec);
 260         unsigned int range = CR_RANGE(insn->chanspec);
 261         unsigned int val;
 262         int i;
 263
 264         for (i = 0; i < insn->n; i++) {
 265                 val = data[i];
 266                 devpriv->ao_readback[chan] = val;
 267
 268                 /* bipolar data to the DAC is two's complement */
 269                 if (comedi_chan_range_is_bipolar(s, chan, range))
 270                         val = comedi_offset_munge(s, val);
 271
 272                 /* order is important, MSB then LSB */
 273                 outb((val >> 8) & 0xff, dev->iobase + PCL726_AO_MSB_REG(chan));
 274                 outb(val & 0xff, dev->iobase + PCL726_AO_LSB_REG(chan));
 275         }
 276
 277         return insn->n;
 278 }
 279
 280 static int pcl726_ao_insn_read(struct comedi_device *dev,
 281                                struct comedi_subdevice *s,
 282                                struct comedi_insn *insn,
 283                                unsigned int *data)
 284 {
 285         struct pcl726_private *devpriv = dev->private;
 286         unsigned int chan = CR_CHAN(insn->chanspec);
 287         int i;
 288
 289         for (i = 0; i < insn->n; i++)
 290                 data[i] = devpriv->ao_readback[chan];
 291
 292         return insn->n;
 293 }
 294
 295 static int pcl726_di_insn_bits(struct comedi_device *dev,
 296                                struct comedi_subdevice *s,
 297                                struct comedi_insn *insn,
 298                                unsigned int *data)
 299 {
 300         const struct pcl726_board *board = comedi_board(dev);
 301         unsigned int val;
 302
 303         if (board->is_pcl727) {
 304                 val = inb(dev->iobase + PCL727_DI_LSB_REG);
 305                 val |= (inb(dev->iobase + PCL727_DI_MSB_REG) << 8);
 306         } else {
 307                 val = inb(dev->iobase + PCL726_DI_LSB_REG);
 308                 val |= (inb(dev->iobase + PCL726_DI_MSB_REG) << 8);
 309         }
 310
 311         data[1] = val;
 312
 313         return insn->n;
 314 }
 315
 316 static int pcl726_do_insn_bits(struct comedi_device *dev,
 317                                struct comedi_subdevice *s,
 318                                struct comedi_insn *insn,
 319                                unsigned int *data)
 320 {
 321         const struct pcl726_board *board = comedi_board(dev);
 322         unsigned long io = dev->iobase;
 323         unsigned int mask;
 324
 325         mask = comedi_dio_update_state(s, data);
 326         if (mask) {
 327                 if (board->is_pcl727) {
 328                         if (mask & 0x00ff)
 329                                 outb(s->state & 0xff, io + PCL727_DO_LSB_REG);
 330                         if (mask & 0xff00)
 331                                 outb((s->state >> 8), io + PCL727_DO_MSB_REG);
 332                 } else {
 333                         if (mask & 0x00ff)
 334                                 outb(s->state & 0xff, io + PCL726_DO_LSB_REG);
 335                         if (mask & 0xff00)
 336                                 outb((s->state >> 8), io + PCL726_DO_MSB_REG);
 337                 }
 338         }
 339
 340         data[1] = s->state;
 341
 342         return insn->n;
 343 }
 344
 345 static int pcl726_attach(struct comedi_device *dev,
 346                          struct comedi_devconfig *it)
 347 {
 348         const struct pcl726_board *board = comedi_board(dev);
 349         struct pcl726_private *devpriv;
 350         struct comedi_subdevice *s;
 351         int subdev;
 352         int ret;
 353         int i;
 354
 355         ret = comedi_request_region(dev, it->options[0], board->io_len);
 356         if (ret)
 357                 return ret;
 358
 359         devpriv = comedi_alloc_devpriv(dev, sizeof(*devpriv));
 360         if (!devpriv)
 361                 return -ENOMEM;
 362
 363         /*
 364          * Hook up the external trigger source interrupt only if the
 365          * user config option is valid and the board supports interrupts.
 366          */
 367         if (it->options[1] && (board->irq_mask & (1 << it->options[1]))) {
 368                 ret = request_irq(it->options[1], pcl818_interrupt, 0,
 369                                   dev->board_name, dev);
 370                 if (ret == 0) {
 371                         /* External trigger source is from Pin-17 of CN3 */
 372                         dev->irq = it->options[1];
 373                 }
 374         }
 375
 376         /* setup the per-channel analog output range_table_list */
 377         for (i = 0; i < 12; i++) {
 378                 unsigned int opt = it->options[2 + i];
 379
 380                 if (opt < board->ao_num_ranges && i < board->ao_nchan)
 381                         devpriv->rangelist[i] = board->ao_ranges[opt];
 382                 else
 383                         devpriv->rangelist[i] = &range_unknown;
 384         }
 385
 386         subdev = board->have_dio ? 3 : 1;
 387         if (dev->irq)
 388                 subdev++;
 389         ret = comedi_alloc_subdevices(dev, subdev);
 390         if (ret)
 391                 return ret;
 392
 393         subdev = 0;
 394
 395         /* Analog Output subdevice */
 396         s = &dev->subdevices[subdev++];
 397         s->type         = COMEDI_SUBD_AO;
 398         s->subdev_flags = SDF_WRITABLE | SDF_GROUND;
 399         s->n_chan       = board->ao_nchan;
 400         s->maxdata      = 0x0fff;
 401         s->range_table_list = devpriv->rangelist;
 402         s->insn_write   = pcl726_ao_insn_write;
 403         s->insn_read    = pcl726_ao_insn_read;
 404
 405         if (board->have_dio) {
 406                 /* Digital Input subdevice */
 407                 s = &dev->subdevices[subdev++];
 408                 s->type         = COMEDI_SUBD_DI;
 409                 s->subdev_flags = SDF_READABLE;
 410                 s->n_chan       = 16;
 411                 s->maxdata      = 1;
 412                 s->insn_bits    = pcl726_di_insn_bits;
 413                 s->range_table  = &range_digital;
 414
 415                 /* Digital Output subdevice */
 416                 s = &dev->subdevices[subdev++];
 417                 s->type         = COMEDI_SUBD_DO;
 418                 s->subdev_flags = SDF_WRITABLE;
 419                 s->n_chan       = 16;
 420                 s->maxdata      = 1;
 421                 s->insn_bits    = pcl726_do_insn_bits;
 422                 s->range_table  = &range_digital;
 423         }
 424
 425         if (dev->irq) {
 426                 /* Digial Input subdevice - Interrupt support */
 427                 s = &dev->subdevices[subdev++];
 428                 dev->read_subdev = s;
 429                 s->type         = COMEDI_SUBD_DI;
 430                 s->subdev_flags = SDF_READABLE | SDF_CMD_READ;
 431                 s->n_chan       = 1;
 432                 s->maxdata      = 1;
 433                 s->range_table  = &range_digital;
 434                 s->insn_bits    = pcl818_intr_insn_bits;
 435                 s->do_cmdtest   = pcl818_intr_cmdtest;
 436                 s->do_cmd       = pcl818_intr_cmd;
 437                 s->cancel       = pcl818_intr_cancel;
 438         }
 439
 440         return 0;
 441 }
 442
 443 static struct comedi_driver pcl726_driver = {
 444         .driver_name    = "pcl726",
 445         .module         = THIS_MODULE,
 446         .attach         = pcl726_attach,
 447         .detach         = comedi_legacy_detach,
 448         .board_name     = &boardtypes[0].name,
 449         .num_names      = ARRAY_SIZE(boardtypes),
 450         .offset         = sizeof(struct pcl726_board),
 451 };
 452 module_comedi_driver(pcl726_driver);
 453
 454 MODULE_AUTHOR("Comedi http://www.comedi.org");
 455 MODULE_DESCRIPTION("Comedi low-level driver");
 456 MODULE_LICENSE("GPL");