drivers/staging/comedi/drivers/ni_at_ao.c

   1 /*
   2     comedi/drivers/ni_at_ao.c
   3     Driver for NI AT-AO-6/10 boards
   4
   5     COMEDI - Linux Control and Measurement Device Interface
   6     Copyright (C) 2000,2002 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: ni_at_ao
  25 Description: National Instruments AT-AO-6/10
  26 Devices: [National Instruments] AT-AO-6 (at-ao-6), AT-AO-10 (at-ao-10)
  27 Status: should work
  28 Author: ds
  29 Updated: Sun Dec 26 12:26:28 EST 2004
  30
  31 Configuration options:
  32   [0] - I/O port base address
  33   [1] - IRQ (unused)
  34   [2] - DMA (unused)
  35   [3] - analog output range, set by jumpers on hardware (0 for -10 to 10V
  36         bipolar, 1 for 0V to 10V unipolar)
  37
  38 */
  39 /*
  40  * Register-level programming information can be found in NI
  41  * document 320379.pdf.
  42  */
  43
  44 #include "../comedidev.h"
  45
  46 #include <linux/ioport.h>
  47
  48 /* board egisters */
  49 /* registers with _2_ are accessed when GRP2WR is set in CFG1 */
  50
  51 #define ATAO_SIZE 0x20
  52
  53 #define ATAO_2_DMATCCLR         0x00    /* W 16 */
  54 #define ATAO_DIN                0x00    /* R 16 */
  55 #define ATAO_DOUT               0x00    /* W 16 */
  56
  57 #define ATAO_CFG2               0x02    /* W 16 */
  58 #define CALLD1  0x8000
  59 #define CALLD0  0x4000
  60 #define FFRTEN  0x2000
  61 #define DAC2S8  0x1000
  62 #define DAC2S6  0x0800
  63 #define DAC2S4  0x0400
  64 #define DAC2S2  0x0200
  65 #define DAC2S0  0x0100
  66 #define LDAC8           0x0080
  67 #define LDAC6           0x0040
  68 #define LDAC4           0x0020
  69 #define LDAC2           0x0010
  70 #define LDAC0           0x0008
  71 #define PROMEN  0x0004
  72 #define SCLK            0x0002
  73 #define SDATA           0x0001
  74
  75 #define ATAO_2_INT1CLR          0x02    /* W 16 */
  76
  77 #define ATAO_CFG3               0x04    /* W 16 */
  78 #define DMAMODE 0x0040
  79 #define CLKOUT  0x0020
  80 #define RCLKEN  0x0010
  81 #define DOUTEN2 0x0008
  82 #define DOUTEN1 0x0004
  83 #define EN2_5V  0x0002
  84 #define SCANEN  0x0001
  85
  86 #define ATAO_2_INT2CLR          0x04    /* W 16 */
  87
  88 #define ATAO_82C53_BASE         0x06    /* RW 8 */
  89
  90 #define ATAO_82C53_CNTR1        0x06    /* RW 8 */
  91 #define ATAO_82C53_CNTR2        0x07    /* RW 8 */
  92 #define ATAO_82C53_CNTR3        0x08    /* RW 8 */
  93 #define ATAO_82C53_CNTRCMD      0x09    /* W 8 */
  94 #define CNTRSEL1        0x80
  95 #define CNTRSEL0        0x40
  96 #define RWSEL1  0x20
  97 #define RWSEL0  0x10
  98 #define MODESEL2        0x08
  99 #define MODESEL1        0x04
 100 #define MODESEL0        0x02
 101 #define BCDSEL  0x01
 102   /* read-back command */
 103 #define COUNT           0x20
 104 #define STATUS  0x10
 105 #define CNTR3           0x08
 106 #define CNTR2           0x04
 107 #define CNTR1           0x02
 108   /* status */
 109 #define OUT             0x80
 110 #define _NULL           0x40
 111 #define RW1             0x20
 112 #define RW0             0x10
 113 #define MODE2           0x08
 114 #define MODE1           0x04
 115 #define MODE0           0x02
 116 #define BCD             0x01
 117
 118 #define ATAO_2_RTSISHFT         0x06    /* W 8 */
 119 #define RSI             0x01
 120
 121 #define ATAO_2_RTSISTRB         0x07    /* W 8 */
 122
 123 #define ATAO_CFG1               0x0a    /* W 16 */
 124 #define EXTINT2EN       0x8000
 125 #define EXTINT1EN       0x4000
 126 #define CNTINT2EN       0x2000
 127 #define CNTINT1EN       0x1000
 128 #define TCINTEN 0x0800
 129 #define CNT1SRC 0x0400
 130 #define CNT2SRC 0x0200
 131 #define FIFOEN  0x0100
 132 #define GRP2WR  0x0080
 133 #define EXTUPDEN        0x0040
 134 #define DMARQ           0x0020
 135 #define DMAEN           0x0010
 136 #define CH_mask 0x000f
 137 #define ATAO_STATUS             0x0a    /* R 16 */
 138 #define FH              0x0040
 139 #define FE              0x0020
 140 #define FF              0x0010
 141 #define INT2            0x0008
 142 #define INT1            0x0004
 143 #define TCINT           0x0002
 144 #define PROMOUT 0x0001
 145
 146 #define ATAO_FIFO_WRITE         0x0c    /* W 16 */
 147 #define ATAO_FIFO_CLEAR         0x0c    /* R 16 */
 148 #define ATAO_DACn(x)            (0x0c + 2*(x))  /* W */
 149
 150 /*
 151  * Board descriptions for two imaginary boards.  Describing the
 152  * boards in this way is optional, and completely driver-dependent.
 153  * Some drivers use arrays such as this, other do not.
 154  */
 155 struct atao_board {
 156         const char *name;
 157         int n_ao_chans;
 158 };
 159
 160 static const struct atao_board atao_boards[] = {
 161         {
 162          .name = "ai-ao-6",
 163          .n_ao_chans = 6,
 164          },
 165         {
 166          .name = "ai-ao-10",
 167          .n_ao_chans = 10,
 168          },
 169 };
 170
 171 #define thisboard ((struct atao_board *)dev->board_ptr)
 172
 173 struct atao_private {
 174
 175         unsigned short cfg1;
 176         unsigned short cfg2;
 177         unsigned short cfg3;
 178
 179         /* Used for AO readback */
 180         unsigned int ao_readback[10];
 181 };
 182
 183 #define devpriv ((struct atao_private *)dev->private)
 184
 185 static int atao_attach(struct comedi_device *dev, struct comedi_devconfig *it);
 186 static int atao_detach(struct comedi_device *dev);
 187 static struct comedi_driver driver_atao = {
 188         .driver_name = "ni_at_ao",
 189         .module = THIS_MODULE,
 190         .attach = atao_attach,
 191         .detach = atao_detach,
 192         .board_name = &atao_boards[0].name,
 193         .offset = sizeof(struct atao_board),
 194         .num_names = ARRAY_SIZE(atao_boards),
 195 };
 196
 197 COMEDI_INITCLEANUP(driver_atao);
 198
 199 static void atao_reset(struct comedi_device *dev);
 200
 201 static int atao_ao_winsn(struct comedi_device *dev, struct comedi_subdevice *s,
 202                          struct comedi_insn *insn, unsigned int *data);
 203 static int atao_ao_rinsn(struct comedi_device *dev, struct comedi_subdevice *s,
 204                          struct comedi_insn *insn, unsigned int *data);
 205 static int atao_dio_insn_bits(struct comedi_device *dev,
 206                               struct comedi_subdevice *s,
 207                               struct comedi_insn *insn, unsigned int *data);
 208 static int atao_dio_insn_config(struct comedi_device *dev,
 209                                 struct comedi_subdevice *s,
 210                                 struct comedi_insn *insn, unsigned int *data);
 211 static int atao_calib_insn_read(struct comedi_device *dev,
 212                                 struct comedi_subdevice *s,
 213                                 struct comedi_insn *insn, unsigned int *data);
 214 static int atao_calib_insn_write(struct comedi_device *dev,
 215                                  struct comedi_subdevice *s,
 216                                  struct comedi_insn *insn, unsigned int *data);
 217
 218 static int atao_attach(struct comedi_device *dev, struct comedi_devconfig *it)
 219 {
 220         struct comedi_subdevice *s;
 221         unsigned long iobase;
 222         int ao_unipolar;
 223
 224         iobase = it->options[0];
 225         if (iobase == 0)
 226                 iobase = 0x1c0;
 227         ao_unipolar = it->options[3];
 228
 229         printk("comedi%d: ni_at_ao: 0x%04lx", dev->minor, iobase);
 230
 231         if (!request_region(iobase, ATAO_SIZE, "ni_at_ao")) {
 232                 printk(" I/O port conflict\n");
 233                 return -EIO;
 234         }
 235         dev->iobase = iobase;
 236
 237         /* dev->board_ptr = atao_probe(dev); */
 238
 239         dev->board_name = thisboard->name;
 240
 241         if (alloc_private(dev, sizeof(struct atao_private)) < 0)
 242                 return -ENOMEM;
 243
 244         if (alloc_subdevices(dev, 4) < 0)
 245                 return -ENOMEM;
 246
 247         s = dev->subdevices + 0;
 248         /* analog output subdevice */
 249         s->type = COMEDI_SUBD_AO;
 250         s->subdev_flags = SDF_WRITABLE;
 251         s->n_chan = thisboard->n_ao_chans;
 252         s->maxdata = (1 << 12) - 1;
 253         if (ao_unipolar)
 254                 s->range_table = &range_unipolar10;
 255         else
 256                 s->range_table = &range_bipolar10;
 257         s->insn_write = &atao_ao_winsn;
 258         s->insn_read = &atao_ao_rinsn;
 259
 260         s = dev->subdevices + 1;
 261         /* digital i/o subdevice */
 262         s->type = COMEDI_SUBD_DIO;
 263         s->subdev_flags = SDF_READABLE | SDF_WRITABLE;
 264         s->n_chan = 8;
 265         s->maxdata = 1;
 266         s->range_table = &range_digital;
 267         s->insn_bits = atao_dio_insn_bits;
 268         s->insn_config = atao_dio_insn_config;
 269
 270         s = dev->subdevices + 2;
 271         /* caldac subdevice */
 272         s->type = COMEDI_SUBD_CALIB;
 273         s->subdev_flags = SDF_WRITABLE | SDF_INTERNAL;
 274         s->n_chan = 21;
 275         s->maxdata = 0xff;
 276         s->insn_read = atao_calib_insn_read;
 277         s->insn_write = atao_calib_insn_write;
 278
 279         s = dev->subdevices + 3;
 280         /* eeprom subdevice */
 281         /* s->type=COMEDI_SUBD_EEPROM; */
 282         s->type = COMEDI_SUBD_UNUSED;
 283
 284         atao_reset(dev);
 285
 286         printk("\n");
 287
 288         return 0;
 289 }
 290
 291 static int atao_detach(struct comedi_device *dev)
 292 {
 293         printk("comedi%d: atao: remove\n", dev->minor);
 294
 295         if (dev->iobase)
 296                 release_region(dev->iobase, ATAO_SIZE);
 297
 298         return 0;
 299 }
 300
 301 static void atao_reset(struct comedi_device *dev)
 302 {
 303         /* This is the reset sequence described in the manual */
 304
 305         devpriv->cfg1 = 0;
 306         outw(devpriv->cfg1, dev->iobase + ATAO_CFG1);
 307
 308         outb(RWSEL0 | MODESEL2, dev->iobase + ATAO_82C53_CNTRCMD);
 309         outb(0x03, dev->iobase + ATAO_82C53_CNTR1);
 310         outb(CNTRSEL0 | RWSEL0 | MODESEL2, dev->iobase + ATAO_82C53_CNTRCMD);
 311
 312         devpriv->cfg2 = 0;
 313         outw(devpriv->cfg2, dev->iobase + ATAO_CFG2);
 314
 315         devpriv->cfg3 = 0;
 316         outw(devpriv->cfg3, dev->iobase + ATAO_CFG3);
 317
 318         inw(dev->iobase + ATAO_FIFO_CLEAR);
 319
 320         devpriv->cfg1 |= GRP2WR;
 321         outw(devpriv->cfg1, dev->iobase + ATAO_CFG1);
 322
 323         outw(0, dev->iobase + ATAO_2_INT1CLR);
 324         outw(0, dev->iobase + ATAO_2_INT2CLR);
 325         outw(0, dev->iobase + ATAO_2_DMATCCLR);
 326
 327         devpriv->cfg1 &= ~GRP2WR;
 328         outw(devpriv->cfg1, dev->iobase + ATAO_CFG1);
 329 }
 330
 331 static int atao_ao_winsn(struct comedi_device *dev, struct comedi_subdevice *s,
 332                          struct comedi_insn *insn, unsigned int *data)
 333 {
 334         int i;
 335         int chan = CR_CHAN(insn->chanspec);
 336         short bits;
 337
 338         for (i = 0; i < insn->n; i++) {
 339                 bits = data[i] - 0x800;
 340                 if (chan == 0) {
 341                         devpriv->cfg1 |= GRP2WR;
 342                         outw(devpriv->cfg1, dev->iobase + ATAO_CFG1);
 343                 }
 344                 outw(bits, dev->iobase + ATAO_DACn(chan));
 345                 if (chan == 0) {
 346                         devpriv->cfg1 &= ~GRP2WR;
 347                         outw(devpriv->cfg1, dev->iobase + ATAO_CFG1);
 348                 }
 349                 devpriv->ao_readback[chan] = data[i];
 350         }
 351
 352         return i;
 353 }
 354
 355 static int atao_ao_rinsn(struct comedi_device *dev, struct comedi_subdevice *s,
 356                          struct comedi_insn *insn, unsigned int *data)
 357 {
 358         int i;
 359         int chan = CR_CHAN(insn->chanspec);
 360
 361         for (i = 0; i < insn->n; i++)
 362                 data[i] = devpriv->ao_readback[chan];
 363
 364         return i;
 365 }
 366
 367 static int atao_dio_insn_bits(struct comedi_device *dev,
 368                               struct comedi_subdevice *s,
 369                               struct comedi_insn *insn, unsigned int *data)
 370 {
 371         if (insn->n != 2)
 372                 return -EINVAL;
 373
 374         if (data[0]) {
 375                 s->state &= ~data[0];
 376                 s->state |= data[0] & data[1];
 377                 outw(s->state, dev->iobase + ATAO_DOUT);
 378         }
 379
 380         data[1] = inw(dev->iobase + ATAO_DIN);
 381
 382         return 2;
 383 }
 384
 385 static int atao_dio_insn_config(struct comedi_device *dev,
 386                                 struct comedi_subdevice *s,
 387                                 struct comedi_insn *insn, unsigned int *data)
 388 {
 389         int chan = CR_CHAN(insn->chanspec);
 390         unsigned int mask, bit;
 391
 392         /* The input or output configuration of each digital line is
 393          * configured by a special insn_config instruction.  chanspec
 394          * contains the channel to be changed, and data[0] contains the
 395          * value COMEDI_INPUT or COMEDI_OUTPUT. */
 396
 397         mask = (chan < 4) ? 0x0f : 0xf0;
 398         bit = (chan < 4) ? DOUTEN1 : DOUTEN2;
 399
 400         switch (data[0]) {
 401         case INSN_CONFIG_DIO_OUTPUT:
 402                 s->io_bits |= mask;
 403                 devpriv->cfg3 |= bit;
 404                 break;
 405         case INSN_CONFIG_DIO_INPUT:
 406                 s->io_bits &= ~mask;
 407                 devpriv->cfg3 &= ~bit;
 408                 break;
 409         case INSN_CONFIG_DIO_QUERY:
 410                 data[1] =
 411                     (s->io_bits & (1 << chan)) ? COMEDI_OUTPUT : COMEDI_INPUT;
 412                 return insn->n;
 413                 break;
 414         default:
 415                 return -EINVAL;
 416                 break;
 417         }
 418
 419         outw(devpriv->cfg3, dev->iobase + ATAO_CFG3);
 420
 421         return 1;
 422 }
 423
 424 /*
 425  * Figure 2-1 in the manual shows 3 chips labeled DAC8800, which
 426  * are 8-channel 8-bit DACs.  These are most likely the calibration
 427  * DACs.  It is not explicitly stated in the manual how to access
 428  * the caldacs, but we can guess.
 429  */
 430 static int atao_calib_insn_read(struct comedi_device *dev,
 431                                 struct comedi_subdevice *s,
 432                                 struct comedi_insn *insn, unsigned int *data)
 433 {
 434         int i;
 435         for (i = 0; i < insn->n; i++)
 436                 data[i] = 0;    /* XXX */
 437         return insn->n;
 438 }
 439
 440 static int atao_calib_insn_write(struct comedi_device *dev,
 441                                  struct comedi_subdevice *s,
 442                                  struct comedi_insn *insn, unsigned int *data)
 443 {
 444         unsigned int bitstring, bit;
 445         unsigned int chan = CR_CHAN(insn->chanspec);
 446
 447         bitstring = ((chan & 0x7) << 8) | (data[insn->n - 1] & 0xff);
 448
 449         for (bit = 1 << (11 - 1); bit; bit >>= 1) {
 450                 outw(devpriv->cfg2 | ((bit & bitstring) ? SDATA : 0),
 451                      dev->iobase + ATAO_CFG2);
 452                 outw(devpriv->cfg2 | SCLK | ((bit & bitstring) ? SDATA : 0),
 453                      dev->iobase + ATAO_CFG2);
 454         }
 455         /* strobe the appropriate caldac */
 456         outw(devpriv->cfg2 | (((chan >> 3) + 1) << 14),
 457              dev->iobase + ATAO_CFG2);
 458         outw(devpriv->cfg2, dev->iobase + ATAO_CFG2);
 459
 460         return insn->n;
 461 }