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 /*
  19 Driver: ni_6527
  20 Description: National Instruments 6527
  21 Author: ds
  22 Status: works
  23 Devices: [National Instruments] PCI-6527 (ni6527), PXI-6527
  24 Updated: Sat, 25 Jan 2003 13:24:40 -0800
  25
  26
  27 */
  28
  29 /*
  30    Manuals (available from ftp://ftp.natinst.com/support/manuals)
  31
  32         370106b.pdf     6527 Register Level Programmer Manual
  33
  34  */
  35
  36 #include <linux/module.h>
  37 #include <linux/pci.h>
  38 #include <linux/interrupt.h>
  39
  40 #include "../comedidev.h"
  41
  42 #include "comedi_fc.h"
  43 #include "mite.h"
  44
  45 #define NI6527_DI_REG(x)                (0x00 + (x))
  46 #define NI6527_DO_REG(x)                (0x03 + (x))
  47 #define NI6527_ID_REG                   0x06
  48
  49 #define Clear_Register                          0x07
  50 #define ClrEdge                         0x08
  51 #define ClrOverflow                     0x04
  52 #define ClrFilter                       0x02
  53 #define ClrInterval                     0x01
  54
  55 #define NI6527_FILT_INTERVAL_REG(x)     (0x08 + (x))
  56 #define NI6527_FILT_ENA_REG(x)          (0x0c + (x))
  57
  58 #define Change_Status                           0x14
  59 #define MasterInterruptStatus           0x04
  60 #define Overflow                        0x02
  61 #define EdgeStatus                      0x01
  62
  63 #define Master_Interrupt_Control                0x15
  64 #define FallingEdgeIntEnable            0x10
  65 #define RisingEdgeIntEnable             0x08
  66 #define MasterInterruptEnable           0x04
  67 #define OverflowIntEnable               0x02
  68 #define EdgeIntEnable                   0x01
  69
  70 #define Rising_Edge_Detection_Enable(x)         (0x018+(x))
  71 #define Falling_Edge_Detection_Enable(x)        (0x020+(x))
  72
  73 enum ni6527_boardid {
  74         BOARD_PCI6527,
  75         BOARD_PXI6527,
  76 };
  77
  78 struct ni6527_board {
  79         const char *name;
  80 };
  81
  82 static const struct ni6527_board ni6527_boards[] = {
  83         [BOARD_PCI6527] = {
  84                 .name           = "pci-6527",
  85         },
  86         [BOARD_PXI6527] = {
  87                 .name           = "pxi-6527",
  88         },
  89 };
  90
  91 struct ni6527_private {
  92         struct mite_struct *mite;
  93         unsigned int filter_interval;
  94         unsigned int filter_enable;
  95 };
  96
  97 static void ni6527_set_filter_interval(struct comedi_device *dev,
  98                                        unsigned int val)
  99 {
 100         struct ni6527_private *devpriv = dev->private;
 101         void __iomem *mmio = devpriv->mite->daq_io_addr;
 102
 103         if (val != devpriv->filter_interval) {
 104                 writeb(val & 0xff, mmio + NI6527_FILT_INTERVAL_REG(0));
 105                 writeb((val >> 8) & 0xff, mmio + NI6527_FILT_INTERVAL_REG(1));
 106                 writeb((val >> 16) & 0x0f, mmio + NI6527_FILT_INTERVAL_REG(2));
 107
 108                 writeb(ClrInterval, mmio + Clear_Register);
 109
 110                 devpriv->filter_interval = val;
 111         }
 112 }
 113
 114 static void ni6527_set_filter_enable(struct comedi_device *dev,
 115                                      unsigned int val)
 116 {
 117         struct ni6527_private *devpriv = dev->private;
 118         void __iomem *mmio = devpriv->mite->daq_io_addr;
 119
 120         writeb(val & 0xff, mmio + NI6527_FILT_ENA_REG(0));
 121         writeb((val >> 8) & 0xff, mmio + NI6527_FILT_ENA_REG(1));
 122         writeb((val >> 16) & 0xff, mmio + NI6527_FILT_ENA_REG(2));
 123 }
 124
 125 static int ni6527_di_insn_config(struct comedi_device *dev,
 126                                  struct comedi_subdevice *s,
 127                                  struct comedi_insn *insn,
 128                                  unsigned int *data)
 129 {
 130         struct ni6527_private *devpriv = dev->private;
 131         unsigned int chan = CR_CHAN(insn->chanspec);
 132         unsigned int interval;
 133
 134         switch (data[0]) {
 135         case INSN_CONFIG_FILTER:
 136                 /*
 137                  * The deglitch filter interval is specified in nanoseconds.
 138                  * The hardware supports intervals in 200ns increments. Round
 139                  * the user values up and return the actual interval.
 140                  */
 141                 interval = (data[1] + 100) / 200;
 142                 data[1] = interval * 200;
 143
 144                 if (interval) {
 145                         ni6527_set_filter_interval(dev, interval);
 146                         devpriv->filter_enable |= 1 << chan;
 147                 } else {
 148                         devpriv->filter_enable &= ~(1 << chan);
 149                 }
 150                 ni6527_set_filter_enable(dev, devpriv->filter_enable);
 151                 break;
 152         default:
 153                 return -EINVAL;
 154         }
 155
 156         return insn->n;
 157 }
 158
 159 static int ni6527_di_insn_bits(struct comedi_device *dev,
 160                                struct comedi_subdevice *s,
 161                                struct comedi_insn *insn,
 162                                unsigned int *data)
 163 {
 164         struct ni6527_private *devpriv = dev->private;
 165         void __iomem *mmio = devpriv->mite->daq_io_addr;
 166         unsigned int val;
 167
 168         val = readb(mmio + NI6527_DI_REG(0));
 169         val |= (readb(mmio + NI6527_DI_REG(1)) << 8);
 170         val |= (readb(mmio + NI6527_DI_REG(2)) << 16);
 171
 172         data[1] = val;
 173
 174         return insn->n;
 175 }
 176
 177 static int ni6527_do_insn_bits(struct comedi_device *dev,
 178                                struct comedi_subdevice *s,
 179                                struct comedi_insn *insn,
 180                                unsigned int *data)
 181 {
 182         struct ni6527_private *devpriv = dev->private;
 183         void __iomem *mmio = devpriv->mite->daq_io_addr;
 184         unsigned int mask;
 185
 186         mask = comedi_dio_update_state(s, data);
 187         if (mask) {
 188                 /* Outputs are inverted */
 189                 unsigned int val = s->state ^ 0xffffff;
 190
 191                 if (mask & 0x0000ff)
 192                         writeb(val & 0xff, mmio + NI6527_DO_REG(0));
 193                 if (mask & 0x00ff00)
 194                         writeb((val >> 8) & 0xff, mmio + NI6527_DO_REG(1));
 195                 if (mask & 0xff0000)
 196                         writeb((val >> 16) & 0xff, mmio + NI6527_DO_REG(2));
 197         }
 198
 199         data[1] = s->state;
 200
 201         return insn->n;
 202 }
 203
 204 static irqreturn_t ni6527_interrupt(int irq, void *d)
 205 {
 206         struct comedi_device *dev = d;
 207         struct ni6527_private *devpriv = dev->private;
 208         struct comedi_subdevice *s = dev->read_subdev;
 209         unsigned int status;
 210
 211         status = readb(devpriv->mite->daq_io_addr + Change_Status);
 212         if ((status & MasterInterruptStatus) == 0)
 213                 return IRQ_NONE;
 214         if ((status & EdgeStatus) == 0)
 215                 return IRQ_NONE;
 216
 217         writeb(ClrEdge | ClrOverflow,
 218                devpriv->mite->daq_io_addr + Clear_Register);
 219
 220         comedi_buf_put(s->async, 0);
 221         s->async->events |= COMEDI_CB_EOS;
 222         comedi_event(dev, s);
 223         return IRQ_HANDLED;
 224 }
 225
 226 static int ni6527_intr_cmdtest(struct comedi_device *dev,
 227                                struct comedi_subdevice *s,
 228                                struct comedi_cmd *cmd)
 229 {
 230         int err = 0;
 231
 232         /* Step 1 : check if triggers are trivially valid */
 233
 234         err |= cfc_check_trigger_src(&cmd->start_src, TRIG_NOW);
 235         err |= cfc_check_trigger_src(&cmd->scan_begin_src, TRIG_OTHER);
 236         err |= cfc_check_trigger_src(&cmd->convert_src, TRIG_FOLLOW);
 237         err |= cfc_check_trigger_src(&cmd->scan_end_src, TRIG_COUNT);
 238         err |= cfc_check_trigger_src(&cmd->stop_src, TRIG_COUNT);
 239
 240         if (err)
 241                 return 1;
 242
 243         /* Step 2a : make sure trigger sources are unique */
 244         /* Step 2b : and mutually compatible */
 245
 246         if (err)
 247                 return 2;
 248
 249         /* Step 3: check if arguments are trivially valid */
 250
 251         err |= cfc_check_trigger_arg_is(&cmd->start_arg, 0);
 252         err |= cfc_check_trigger_arg_is(&cmd->scan_begin_arg, 0);
 253         err |= cfc_check_trigger_arg_is(&cmd->convert_arg, 0);
 254         err |= cfc_check_trigger_arg_is(&cmd->scan_end_arg, 1);
 255         err |= cfc_check_trigger_arg_is(&cmd->stop_arg, 0);
 256
 257         if (err)
 258                 return 3;
 259
 260         /* step 4: fix up any arguments */
 261
 262         if (err)
 263                 return 4;
 264
 265         return 0;
 266 }
 267
 268 static int ni6527_intr_cmd(struct comedi_device *dev,
 269                            struct comedi_subdevice *s)
 270 {
 271         struct ni6527_private *devpriv = dev->private;
 272         /* struct comedi_cmd *cmd = &s->async->cmd; */
 273
 274         writeb(ClrEdge | ClrOverflow,
 275                devpriv->mite->daq_io_addr + Clear_Register);
 276         writeb(FallingEdgeIntEnable | RisingEdgeIntEnable |
 277                MasterInterruptEnable | EdgeIntEnable,
 278                devpriv->mite->daq_io_addr + Master_Interrupt_Control);
 279
 280         return 0;
 281 }
 282
 283 static int ni6527_intr_cancel(struct comedi_device *dev,
 284                               struct comedi_subdevice *s)
 285 {
 286         struct ni6527_private *devpriv = dev->private;
 287
 288         writeb(0x00, devpriv->mite->daq_io_addr + Master_Interrupt_Control);
 289
 290         return 0;
 291 }
 292
 293 static int ni6527_intr_insn_bits(struct comedi_device *dev,
 294                                  struct comedi_subdevice *s,
 295                                  struct comedi_insn *insn, unsigned int *data)
 296 {
 297         data[1] = 0;
 298         return insn->n;
 299 }
 300
 301 static int ni6527_intr_insn_config(struct comedi_device *dev,
 302                                    struct comedi_subdevice *s,
 303                                    struct comedi_insn *insn, unsigned int *data)
 304 {
 305         struct ni6527_private *devpriv = dev->private;
 306
 307         if (insn->n < 1)
 308                 return -EINVAL;
 309         if (data[0] != INSN_CONFIG_CHANGE_NOTIFY)
 310                 return -EINVAL;
 311
 312         writeb(data[1],
 313                devpriv->mite->daq_io_addr + Rising_Edge_Detection_Enable(0));
 314         writeb(data[1] >> 8,
 315                devpriv->mite->daq_io_addr + Rising_Edge_Detection_Enable(1));
 316         writeb(data[1] >> 16,
 317                devpriv->mite->daq_io_addr + Rising_Edge_Detection_Enable(2));
 318
 319         writeb(data[2],
 320                devpriv->mite->daq_io_addr + Falling_Edge_Detection_Enable(0));
 321         writeb(data[2] >> 8,
 322                devpriv->mite->daq_io_addr + Falling_Edge_Detection_Enable(1));
 323         writeb(data[2] >> 16,
 324                devpriv->mite->daq_io_addr + Falling_Edge_Detection_Enable(2));
 325
 326         return 2;
 327 }
 328
 329 static int ni6527_auto_attach(struct comedi_device *dev,
 330                               unsigned long context)
 331 {
 332         struct pci_dev *pcidev = comedi_to_pci_dev(dev);
 333         const struct ni6527_board *board = NULL;
 334         struct ni6527_private *devpriv;
 335         struct comedi_subdevice *s;
 336         int ret;
 337
 338         if (context < ARRAY_SIZE(ni6527_boards))
 339                 board = &ni6527_boards[context];
 340         if (!board)
 341                 return -ENODEV;
 342         dev->board_ptr = board;
 343         dev->board_name = board->name;
 344
 345         ret = comedi_pci_enable(dev);
 346         if (ret)
 347                 return ret;
 348
 349         devpriv = comedi_alloc_devpriv(dev, sizeof(*devpriv));
 350         if (!devpriv)
 351                 return -ENOMEM;
 352
 353         devpriv->mite = mite_alloc(pcidev);
 354         if (!devpriv->mite)
 355                 return -ENOMEM;
 356
 357         ret = mite_setup(devpriv->mite);
 358         if (ret < 0) {
 359                 dev_err(dev->class_dev, "error setting up mite\n");
 360                 return ret;
 361         }
 362
 363         /* make sure this is actually a 6527 device */
 364         if (readb(devpriv->mite->daq_io_addr + NI6527_ID_REG) != 0x27)
 365                 return -ENODEV;
 366
 367         ret = comedi_alloc_subdevices(dev, 3);
 368         if (ret)
 369                 return ret;
 370
 371         s = &dev->subdevices[0];
 372         s->type = COMEDI_SUBD_DI;
 373         s->subdev_flags = SDF_READABLE;
 374         s->n_chan = 24;
 375         s->range_table = &range_digital;
 376         s->maxdata = 1;
 377         s->insn_config = ni6527_di_insn_config;
 378         s->insn_bits = ni6527_di_insn_bits;
 379
 380         s = &dev->subdevices[1];
 381         s->type = COMEDI_SUBD_DO;
 382         s->subdev_flags = SDF_READABLE | SDF_WRITABLE;
 383         s->n_chan = 24;
 384         s->range_table = &range_unknown;  /* FIXME: actually conductance */
 385         s->maxdata = 1;
 386         s->insn_bits = ni6527_do_insn_bits;
 387
 388         s = &dev->subdevices[2];
 389         dev->read_subdev = s;
 390         s->type = COMEDI_SUBD_DI;
 391         s->subdev_flags = SDF_READABLE | SDF_CMD_READ;
 392         s->n_chan = 1;
 393         s->range_table = &range_unknown;
 394         s->maxdata = 1;
 395         s->do_cmdtest = ni6527_intr_cmdtest;
 396         s->do_cmd = ni6527_intr_cmd;
 397         s->cancel = ni6527_intr_cancel;
 398         s->insn_bits = ni6527_intr_insn_bits;
 399         s->insn_config = ni6527_intr_insn_config;
 400
 401         ni6527_set_filter_enable(dev, 0);
 402
 403         writeb(ClrEdge | ClrOverflow | ClrFilter | ClrInterval,
 404                devpriv->mite->daq_io_addr + Clear_Register);
 405         writeb(0x00, devpriv->mite->daq_io_addr + Master_Interrupt_Control);
 406
 407         ret = request_irq(mite_irq(devpriv->mite), ni6527_interrupt,
 408                           IRQF_SHARED, dev->board_name, dev);
 409         if (ret < 0)
 410                 dev_warn(dev->class_dev, "irq not available\n");
 411         else
 412                 dev->irq = mite_irq(devpriv->mite);
 413
 414         return 0;
 415 }
 416
 417 static void ni6527_detach(struct comedi_device *dev)
 418 {
 419         struct ni6527_private *devpriv = dev->private;
 420
 421         if (devpriv && devpriv->mite && devpriv->mite->daq_io_addr)
 422                 writeb(0x00,
 423                        devpriv->mite->daq_io_addr + Master_Interrupt_Control);
 424         if (dev->irq)
 425                 free_irq(dev->irq, dev);
 426         if (devpriv && devpriv->mite) {
 427                 mite_unsetup(devpriv->mite);
 428                 mite_free(devpriv->mite);
 429         }
 430         comedi_pci_disable(dev);
 431 }
 432
 433 static struct comedi_driver ni6527_driver = {
 434         .driver_name = "ni_6527",
 435         .module = THIS_MODULE,
 436         .auto_attach = ni6527_auto_attach,
 437         .detach = ni6527_detach,
 438 };
 439
 440 static int ni6527_pci_probe(struct pci_dev *dev,
 441                             const struct pci_device_id *id)
 442 {
 443         return comedi_pci_auto_config(dev, &ni6527_driver, id->driver_data);
 444 }
 445
 446 static DEFINE_PCI_DEVICE_TABLE(ni6527_pci_table) = {
 447         { PCI_VDEVICE(NI, 0x2b10), BOARD_PXI6527 },
 448         { PCI_VDEVICE(NI, 0x2b20), BOARD_PCI6527 },
 449         { 0 }
 450 };
 451 MODULE_DEVICE_TABLE(pci, ni6527_pci_table);
 452
 453 static struct pci_driver ni6527_pci_driver = {
 454         .name           = "ni_6527",
 455         .id_table       = ni6527_pci_table,
 456         .probe          = ni6527_pci_probe,
 457         .remove         = comedi_pci_auto_unconfig,
 458 };
 459 module_comedi_pci_driver(ni6527_driver, ni6527_pci_driver);
 460
 461 MODULE_AUTHOR("Comedi http://www.comedi.org");
 462 MODULE_DESCRIPTION("Comedi low-level driver");
 463 MODULE_LICENSE("GPL");