drivers/staging/comedi/drivers/ni_6527.c

   1 /*
   2     comedi/drivers/ni_6527.c
   3     driver for National Instruments PCI-6527
   4
   5     COMEDI - Linux Control and Measurement Device Interface
   6     Copyright (C) 1999,2002,2003 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_6527
  25 Description: National Instruments 6527
  26 Author: ds
  27 Status: works
  28 Devices: [National Instruments] PCI-6527 (ni6527), PXI-6527
  29 Updated: Sat, 25 Jan 2003 13:24:40 -0800
  30
  31
  32 */
  33
  34 /*
  35    Manuals (available from ftp://ftp.natinst.com/support/manuals)
  36
  37         370106b.pdf     6527 Register Level Programmer Manual
  38
  39  */
  40
  41 #define DEBUG 1
  42 #define DEBUG_FLAGS
  43
  44 #include <linux/interrupt.h>
  45 #include "../comedidev.h"
  46
  47 #include "mite.h"
  48
  49 #define NI6527_DIO_SIZE 4096
  50 #define NI6527_MITE_SIZE 4096
  51
  52 #define Port_Register(x)                        (0x00+(x))
  53 #define ID_Register                             0x06
  54
  55 #define Clear_Register                          0x07
  56 #define ClrEdge                         0x08
  57 #define ClrOverflow                     0x04
  58 #define ClrFilter                       0x02
  59 #define ClrInterval                     0x01
  60
  61 #define Filter_Interval(x)                      (0x08+(x))
  62 #define Filter_Enable(x)                        (0x0c+(x))
  63
  64 #define Change_Status                           0x14
  65 #define MasterInterruptStatus           0x04
  66 #define Overflow                        0x02
  67 #define EdgeStatus                      0x01
  68
  69 #define Master_Interrupt_Control                0x15
  70 #define FallingEdgeIntEnable            0x10
  71 #define RisingEdgeIntEnable             0x08
  72 #define MasterInterruptEnable           0x04
  73 #define OverflowIntEnable               0x02
  74 #define EdgeIntEnable                   0x01
  75
  76 #define Rising_Edge_Detection_Enable(x)         (0x018+(x))
  77 #define Falling_Edge_Detection_Enable(x)        (0x020+(x))
  78
  79 static int ni6527_attach(struct comedi_device *dev,
  80                          struct comedi_devconfig *it);
  81 static int ni6527_detach(struct comedi_device *dev);
  82 static struct comedi_driver driver_ni6527 = {
  83         .driver_name = "ni6527",
  84         .module = THIS_MODULE,
  85         .attach = ni6527_attach,
  86         .detach = ni6527_detach,
  87 };
  88
  89 struct ni6527_board {
  90
  91         int dev_id;
  92         const char *name;
  93 };
  94
  95 static const struct ni6527_board ni6527_boards[] = {
  96         {
  97          .dev_id = 0x2b20,
  98          .name = "pci-6527",
  99          },
 100         {
 101          .dev_id = 0x2b10,
 102          .name = "pxi-6527",
 103          },
 104 };
 105
 106 #define n_ni6527_boards ARRAY_SIZE(ni6527_boards)
 107 #define this_board ((const struct ni6527_board *)dev->board_ptr)
 108
 109 static DEFINE_PCI_DEVICE_TABLE(ni6527_pci_table) = {
 110         {
 111         PCI_VENDOR_ID_NATINST, 0x2b10, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0}, {
 112         PCI_VENDOR_ID_NATINST, 0x2b20, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0}, {
 113         0}
 114 };
 115
 116 MODULE_DEVICE_TABLE(pci, ni6527_pci_table);
 117
 118 struct ni6527_private {
 119         struct mite_struct *mite;
 120         unsigned int filter_interval;
 121         unsigned int filter_enable;
 122 };
 123
 124 #define devpriv ((struct ni6527_private *)dev->private)
 125
 126 static int ni6527_find_device(struct comedi_device *dev, int bus, int slot);
 127
 128 static int ni6527_di_insn_config(struct comedi_device *dev,
 129                                  struct comedi_subdevice *s,
 130                                  struct comedi_insn *insn, unsigned int *data)
 131 {
 132         int chan = CR_CHAN(insn->chanspec);
 133         unsigned int interval;
 134
 135         if (insn->n != 2)
 136                 return -EINVAL;
 137
 138         if (data[0] != INSN_CONFIG_FILTER)
 139                 return -EINVAL;
 140
 141         if (data[1]) {
 142                 interval = (data[1] + 100) / 200;
 143                 data[1] = interval * 200;
 144
 145                 if (interval != devpriv->filter_interval) {
 146                         writeb(interval & 0xff,
 147                                devpriv->mite->daq_io_addr + Filter_Interval(0));
 148                         writeb((interval >> 8) & 0xff,
 149                                devpriv->mite->daq_io_addr + Filter_Interval(1));
 150                         writeb((interval >> 16) & 0x0f,
 151                                devpriv->mite->daq_io_addr + Filter_Interval(2));
 152
 153                         writeb(ClrInterval,
 154                                devpriv->mite->daq_io_addr + Clear_Register);
 155
 156                         devpriv->filter_interval = interval;
 157                 }
 158
 159                 devpriv->filter_enable |= 1 << chan;
 160         } else {
 161                 devpriv->filter_enable &= ~(1 << chan);
 162         }
 163
 164         writeb(devpriv->filter_enable,
 165                devpriv->mite->daq_io_addr + Filter_Enable(0));
 166         writeb(devpriv->filter_enable >> 8,
 167                devpriv->mite->daq_io_addr + Filter_Enable(1));
 168         writeb(devpriv->filter_enable >> 16,
 169                devpriv->mite->daq_io_addr + Filter_Enable(2));
 170
 171         return 2;
 172 }
 173
 174 static int ni6527_di_insn_bits(struct comedi_device *dev,
 175                                struct comedi_subdevice *s,
 176                                struct comedi_insn *insn, unsigned int *data)
 177 {
 178         if (insn->n != 2)
 179                 return -EINVAL;
 180
 181         data[1] = readb(devpriv->mite->daq_io_addr + Port_Register(0));
 182         data[1] |= readb(devpriv->mite->daq_io_addr + Port_Register(1)) << 8;
 183         data[1] |= readb(devpriv->mite->daq_io_addr + Port_Register(2)) << 16;
 184
 185         return 2;
 186 }
 187
 188 static int ni6527_do_insn_bits(struct comedi_device *dev,
 189                                struct comedi_subdevice *s,
 190                                struct comedi_insn *insn, unsigned int *data)
 191 {
 192         if (insn->n != 2)
 193                 return -EINVAL;
 194         if (data[0]) {
 195                 s->state &= ~data[0];
 196                 s->state |= (data[0] & data[1]);
 197
 198                 /* The open relay state on the board cooresponds to 1,
 199                  * but in Comedi, it is represented by 0. */
 200                 if (data[0] & 0x0000ff) {
 201                         writeb((s->state ^ 0xff),
 202                                devpriv->mite->daq_io_addr + Port_Register(3));
 203                 }
 204                 if (data[0] & 0x00ff00) {
 205                         writeb((s->state >> 8) ^ 0xff,
 206                                devpriv->mite->daq_io_addr + Port_Register(4));
 207                 }
 208                 if (data[0] & 0xff0000) {
 209                         writeb((s->state >> 16) ^ 0xff,
 210                                devpriv->mite->daq_io_addr + Port_Register(5));
 211                 }
 212         }
 213         data[1] = s->state;
 214
 215         return 2;
 216 }
 217
 218 static irqreturn_t ni6527_interrupt(int irq, void *d)
 219 {
 220         struct comedi_device *dev = d;
 221         struct comedi_subdevice *s = dev->subdevices + 2;
 222         unsigned int status;
 223
 224         status = readb(devpriv->mite->daq_io_addr + Change_Status);
 225         if ((status & MasterInterruptStatus) == 0)
 226                 return IRQ_NONE;
 227         if ((status & EdgeStatus) == 0)
 228                 return IRQ_NONE;
 229
 230         writeb(ClrEdge | ClrOverflow,
 231                devpriv->mite->daq_io_addr + Clear_Register);
 232
 233         comedi_buf_put(s->async, 0);
 234         s->async->events |= COMEDI_CB_EOS;
 235         comedi_event(dev, s);
 236         return IRQ_HANDLED;
 237 }
 238
 239 static int ni6527_intr_cmdtest(struct comedi_device *dev,
 240                                struct comedi_subdevice *s,
 241                                struct comedi_cmd *cmd)
 242 {
 243         int err = 0;
 244         int tmp;
 245
 246         /* step 1: make sure trigger sources are trivially valid */
 247
 248         tmp = cmd->start_src;
 249         cmd->start_src &= TRIG_NOW;
 250         if (!cmd->start_src || tmp != cmd->start_src)
 251                 err++;
 252
 253         tmp = cmd->scan_begin_src;
 254         cmd->scan_begin_src &= TRIG_OTHER;
 255         if (!cmd->scan_begin_src || tmp != cmd->scan_begin_src)
 256                 err++;
 257
 258         tmp = cmd->convert_src;
 259         cmd->convert_src &= TRIG_FOLLOW;
 260         if (!cmd->convert_src || tmp != cmd->convert_src)
 261                 err++;
 262
 263         tmp = cmd->scan_end_src;
 264         cmd->scan_end_src &= TRIG_COUNT;
 265         if (!cmd->scan_end_src || tmp != cmd->scan_end_src)
 266                 err++;
 267
 268         tmp = cmd->stop_src;
 269         cmd->stop_src &= TRIG_COUNT;
 270         if (!cmd->stop_src || tmp != cmd->stop_src)
 271                 err++;
 272
 273         if (err)
 274                 return 1;
 275
 276         /* step 2: make sure trigger sources are unique and */
 277         /*         are mutually compatible */
 278
 279         if (err)
 280                 return 2;
 281
 282         /* step 3: make sure arguments are trivially compatible */
 283
 284         if (cmd->start_arg != 0) {
 285                 cmd->start_arg = 0;
 286                 err++;
 287         }
 288         if (cmd->scan_begin_arg != 0) {
 289                 cmd->scan_begin_arg = 0;
 290                 err++;
 291         }
 292         if (cmd->convert_arg != 0) {
 293                 cmd->convert_arg = 0;
 294                 err++;
 295         }
 296
 297         if (cmd->scan_end_arg != 1) {
 298                 cmd->scan_end_arg = 1;
 299                 err++;
 300         }
 301         if (cmd->stop_arg != 0) {
 302                 cmd->stop_arg = 0;
 303                 err++;
 304         }
 305
 306         if (err)
 307                 return 3;
 308
 309         /* step 4: fix up any arguments */
 310
 311         if (err)
 312                 return 4;
 313
 314         return 0;
 315 }
 316
 317 static int ni6527_intr_cmd(struct comedi_device *dev,
 318                            struct comedi_subdevice *s)
 319 {
 320         /* struct comedi_cmd *cmd = &s->async->cmd; */
 321
 322         writeb(ClrEdge | ClrOverflow,
 323                devpriv->mite->daq_io_addr + Clear_Register);
 324         writeb(FallingEdgeIntEnable | RisingEdgeIntEnable |
 325                MasterInterruptEnable | EdgeIntEnable,
 326                devpriv->mite->daq_io_addr + Master_Interrupt_Control);
 327
 328         return 0;
 329 }
 330
 331 static int ni6527_intr_cancel(struct comedi_device *dev,
 332                               struct comedi_subdevice *s)
 333 {
 334         writeb(0x00, devpriv->mite->daq_io_addr + Master_Interrupt_Control);
 335
 336         return 0;
 337 }
 338
 339 static int ni6527_intr_insn_bits(struct comedi_device *dev,
 340                                  struct comedi_subdevice *s,
 341                                  struct comedi_insn *insn, unsigned int *data)
 342 {
 343         if (insn->n < 1)
 344                 return -EINVAL;
 345
 346         data[1] = 0;
 347         return 2;
 348 }
 349
 350 static int ni6527_intr_insn_config(struct comedi_device *dev,
 351                                    struct comedi_subdevice *s,
 352                                    struct comedi_insn *insn, unsigned int *data)
 353 {
 354         if (insn->n < 1)
 355                 return -EINVAL;
 356         if (data[0] != INSN_CONFIG_CHANGE_NOTIFY)
 357                 return -EINVAL;
 358
 359         writeb(data[1],
 360                devpriv->mite->daq_io_addr + Rising_Edge_Detection_Enable(0));
 361         writeb(data[1] >> 8,
 362                devpriv->mite->daq_io_addr + Rising_Edge_Detection_Enable(1));
 363         writeb(data[1] >> 16,
 364                devpriv->mite->daq_io_addr + Rising_Edge_Detection_Enable(2));
 365
 366         writeb(data[2],
 367                devpriv->mite->daq_io_addr + Falling_Edge_Detection_Enable(0));
 368         writeb(data[2] >> 8,
 369                devpriv->mite->daq_io_addr + Falling_Edge_Detection_Enable(1));
 370         writeb(data[2] >> 16,
 371                devpriv->mite->daq_io_addr + Falling_Edge_Detection_Enable(2));
 372
 373         return 2;
 374 }
 375
 376 static int ni6527_attach(struct comedi_device *dev, struct comedi_devconfig *it)
 377 {
 378         struct comedi_subdevice *s;
 379         int ret;
 380
 381         printk(KERN_INFO "comedi%d: ni6527\n", dev->minor);
 382
 383         ret = alloc_private(dev, sizeof(struct ni6527_private));
 384         if (ret < 0)
 385                 return ret;
 386
 387         ret = ni6527_find_device(dev, it->options[0], it->options[1]);
 388         if (ret < 0)
 389                 return ret;
 390
 391         ret = mite_setup(devpriv->mite);
 392         if (ret < 0) {
 393                 printk(KERN_ERR "comedi: error setting up mite\n");
 394                 return ret;
 395         }
 396
 397         dev->board_name = this_board->name;
 398         printk(KERN_INFO "comedi board: %s, ID=0x%02x\n", dev->board_name,
 399                 readb(devpriv->mite->daq_io_addr + ID_Register));
 400
 401         ret = alloc_subdevices(dev, 3);
 402         if (ret < 0)
 403                 return ret;
 404
 405         s = dev->subdevices + 0;
 406         s->type = COMEDI_SUBD_DI;
 407         s->subdev_flags = SDF_READABLE;
 408         s->n_chan = 24;
 409         s->range_table = &range_digital;
 410         s->maxdata = 1;
 411         s->insn_config = ni6527_di_insn_config;
 412         s->insn_bits = ni6527_di_insn_bits;
 413
 414         s = dev->subdevices + 1;
 415         s->type = COMEDI_SUBD_DO;
 416         s->subdev_flags = SDF_READABLE | SDF_WRITABLE;
 417         s->n_chan = 24;
 418         s->range_table = &range_unknown;  /* FIXME: actually conductance */
 419         s->maxdata = 1;
 420         s->insn_bits = ni6527_do_insn_bits;
 421
 422         s = dev->subdevices + 2;
 423         dev->read_subdev = s;
 424         s->type = COMEDI_SUBD_DI;
 425         s->subdev_flags = SDF_READABLE | SDF_CMD_READ;
 426         s->n_chan = 1;
 427         s->range_table = &range_unknown;
 428         s->maxdata = 1;
 429         s->do_cmdtest = ni6527_intr_cmdtest;
 430         s->do_cmd = ni6527_intr_cmd;
 431         s->cancel = ni6527_intr_cancel;
 432         s->insn_bits = ni6527_intr_insn_bits;
 433         s->insn_config = ni6527_intr_insn_config;
 434
 435         writeb(0x00, devpriv->mite->daq_io_addr + Filter_Enable(0));
 436         writeb(0x00, devpriv->mite->daq_io_addr + Filter_Enable(1));
 437         writeb(0x00, devpriv->mite->daq_io_addr + Filter_Enable(2));
 438
 439         writeb(ClrEdge | ClrOverflow | ClrFilter | ClrInterval,
 440                devpriv->mite->daq_io_addr + Clear_Register);
 441         writeb(0x00, devpriv->mite->daq_io_addr + Master_Interrupt_Control);
 442
 443         ret = request_irq(mite_irq(devpriv->mite), ni6527_interrupt,
 444                           IRQF_SHARED, "ni6527", dev);
 445         if (ret < 0)
 446                 printk(KERN_WARNING "comedi i6527 irq not available\n");
 447         else
 448                 dev->irq = mite_irq(devpriv->mite);
 449
 450         return 0;
 451 }
 452
 453 static int ni6527_detach(struct comedi_device *dev)
 454 {
 455         if (devpriv && devpriv->mite && devpriv->mite->daq_io_addr)
 456                 writeb(0x00,
 457                        devpriv->mite->daq_io_addr + Master_Interrupt_Control);
 458
 459         if (dev->irq)
 460                 free_irq(dev->irq, dev);
 461
 462         if (devpriv && devpriv->mite)
 463                 mite_unsetup(devpriv->mite);
 464
 465         return 0;
 466 }
 467
 468 static int ni6527_find_device(struct comedi_device *dev, int bus, int slot)
 469 {
 470         struct mite_struct *mite;
 471         int i;
 472
 473         for (mite = mite_devices; mite; mite = mite->next) {
 474                 if (mite->used)
 475                         continue;
 476                 if (bus || slot) {
 477                         if (bus != mite->pcidev->bus->number ||
 478                             slot != PCI_SLOT(mite->pcidev->devfn))
 479                                 continue;
 480                 }
 481                 for (i = 0; i < n_ni6527_boards; i++) {
 482                         if (mite_device_id(mite) == ni6527_boards[i].dev_id) {
 483                                 dev->board_ptr = ni6527_boards + i;
 484                                 devpriv->mite = mite;
 485                                 return 0;
 486                         }
 487                 }
 488         }
 489         printk(KERN_ERR "comedi 6527: no device found\n");
 490         mite_list_devices();
 491         return -EIO;
 492 }
 493
 494 COMEDI_PCI_INITCLEANUP(driver_ni6527, ni6527_pci_table);