drivers/staging/comedi/drivers/addi_apci_1032.c

   1 /*
   2  * addi_apci_1032.c
   3  * Copyright (C) 2004,2005  ADDI-DATA GmbH for the source code of this module.
   4  * Project manager: Eric Stolz
   5  *
   6  *      ADDI-DATA GmbH
   7  *      Dieselstrasse 3
   8  *      D-77833 Ottersweier
   9  *      Tel: +19(0)7223/9493-0
  10  *      Fax: +49(0)7223/9493-92
  11  *      http://www.addi-data.com
  12  *      info@addi-data.com
  13  *
  14  * This program is free software; you can redistribute it and/or modify it
  15  * under the terms of the GNU General Public License as published by the
  16  * Free Software Foundation; either version 2 of the License, or (at your
  17  * option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful, but WITHOUT
  20  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  21  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  22  * more details.
  23  */
  24
  25 /*
  26  * Driver: addi_apci_1032
  27  * Description: ADDI-DATA APCI-1032 Digital Input Board
  28  * Author: ADDI-DATA GmbH <info@addi-data.com>,
  29  *   H Hartley Sweeten <hsweeten@visionengravers.com>
  30  * Status: untested
  31  * Devices: [ADDI-DATA] APCI-1032 (addi_apci_1032)
  32  *
  33  * Configuration options:
  34  *   None; devices are configured automatically.
  35  *
  36  * This driver models the APCI-1032 as a 32-channel, digital input subdevice
  37  * plus an additional digital input subdevice to handle change-of-state (COS)
  38  * interrupts (if an interrupt handler can be set up successfully).
  39  *
  40  * The COS subdevice supports comedi asynchronous read commands.
  41  *
  42  * Change-Of-State (COS) interrupt configuration:
  43  *
  44  * Channels 0 to 15 are interruptible. These channels can be configured
  45  * to generate interrupts based on AND/OR logic for the desired channels.
  46  *
  47  *   OR logic:
  48  *   - reacts to rising or falling edges
  49  *   - interrupt is generated when any enabled channel meets the desired
  50  *     interrupt condition
  51  *
  52  *   AND logic:
  53  *   - reacts to changes in level of the selected inputs
  54  *   - interrupt is generated when all enabled channels meet the desired
  55  *     interrupt condition
  56  *   - after an interrupt, a change in level must occur on the selected
  57  *     inputs to release the IRQ logic
  58  *
  59  * The COS subdevice must be configured before setting up a comedi
  60  * asynchronous command:
  61  *
  62  *   data[0] : INSN_CONFIG_DIGITAL_TRIG
  63  *   data[1] : trigger number (= 0)
  64  *   data[2] : configuration operation:
  65  *             - COMEDI_DIGITAL_TRIG_DISABLE = no interrupts
  66  *             - COMEDI_DIGITAL_TRIG_ENABLE_EDGES = OR (edge) interrupts
  67  *             - COMEDI_DIGITAL_TRIG_ENABLE_LEVELS = AND (level) interrupts
  68  *   data[3] : left-shift for data[4] and data[5]
  69  *   data[4] : rising-edge/high level channels
  70  *   data[5] : falling-edge/low level channels
  71  */
  72
  73 #include <linux/module.h>
  74 #include <linux/interrupt.h>
  75
  76 #include "../comedi_pci.h"
  77 #include "amcc_s5933.h"
  78
  79 /*
  80  * I/O Register Map
  81  */
  82 #define APCI1032_DI_REG                 0x00
  83 #define APCI1032_MODE1_REG              0x04
  84 #define APCI1032_MODE2_REG              0x08
  85 #define APCI1032_STATUS_REG             0x0c
  86 #define APCI1032_CTRL_REG               0x10
  87 #define APCI1032_CTRL_INT_MODE(x)       (((x) & 0x1) << 1)
  88 #define APCI1032_CTRL_INT_OR            APCI1032_CTRL_INT_MODE(0)
  89 #define APCI1032_CTRL_INT_AND           APCI1032_CTRL_INT_MODE(1)
  90 #define APCI1032_CTRL_INT_ENA           BIT(2)
  91
  92 struct apci1032_private {
  93         unsigned long amcc_iobase;      /* base of AMCC I/O registers */
  94         unsigned int mode1;     /* rising-edge/high level channels */
  95         unsigned int mode2;     /* falling-edge/low level channels */
  96         unsigned int ctrl;      /* interrupt mode OR (edge) . AND (level) */
  97 };
  98
  99 static int apci1032_reset(struct comedi_device *dev)
 100 {
 101         /* disable the interrupts */
 102         outl(0x0, dev->iobase + APCI1032_CTRL_REG);
 103         /* Reset the interrupt status register */
 104         inl(dev->iobase + APCI1032_STATUS_REG);
 105         /* Disable the and/or interrupt */
 106         outl(0x0, dev->iobase + APCI1032_MODE1_REG);
 107         outl(0x0, dev->iobase + APCI1032_MODE2_REG);
 108
 109         return 0;
 110 }
 111
 112 static int apci1032_cos_insn_config(struct comedi_device *dev,
 113                                     struct comedi_subdevice *s,
 114                                     struct comedi_insn *insn,
 115                                     unsigned int *data)
 116 {
 117         struct apci1032_private *devpriv = dev->private;
 118         unsigned int shift, oldmask;
 119
 120         switch (data[0]) {
 121         case INSN_CONFIG_DIGITAL_TRIG:
 122                 if (data[1] != 0)
 123                         return -EINVAL;
 124                 shift = data[3];
 125                 oldmask = (1U << shift) - 1;
 126                 switch (data[2]) {
 127                 case COMEDI_DIGITAL_TRIG_DISABLE:
 128                         devpriv->ctrl = 0;
 129                         devpriv->mode1 = 0;
 130                         devpriv->mode2 = 0;
 131                         apci1032_reset(dev);
 132                         break;
 133                 case COMEDI_DIGITAL_TRIG_ENABLE_EDGES:
 134                         if (devpriv->ctrl != (APCI1032_CTRL_INT_ENA |
 135                                               APCI1032_CTRL_INT_OR)) {
 136                                 /* switching to 'OR' mode */
 137                                 devpriv->ctrl = APCI1032_CTRL_INT_ENA |
 138                                                 APCI1032_CTRL_INT_OR;
 139                                 /* wipe old channels */
 140                                 devpriv->mode1 = 0;
 141                                 devpriv->mode2 = 0;
 142                         } else {
 143                                 /* preserve unspecified channels */
 144                                 devpriv->mode1 &= oldmask;
 145                                 devpriv->mode2 &= oldmask;
 146                         }
 147                         /* configure specified channels */
 148                         devpriv->mode1 |= data[4] << shift;
 149                         devpriv->mode2 |= data[5] << shift;
 150                         break;
 151                 case COMEDI_DIGITAL_TRIG_ENABLE_LEVELS:
 152                         if (devpriv->ctrl != (APCI1032_CTRL_INT_ENA |
 153                                               APCI1032_CTRL_INT_AND)) {
 154                                 /* switching to 'AND' mode */
 155                                 devpriv->ctrl = APCI1032_CTRL_INT_ENA |
 156                                                 APCI1032_CTRL_INT_AND;
 157                                 /* wipe old channels */
 158                                 devpriv->mode1 = 0;
 159                                 devpriv->mode2 = 0;
 160                         } else {
 161                                 /* preserve unspecified channels */
 162                                 devpriv->mode1 &= oldmask;
 163                                 devpriv->mode2 &= oldmask;
 164                         }
 165                         /* configure specified channels */
 166                         devpriv->mode1 |= data[4] << shift;
 167                         devpriv->mode2 |= data[5] << shift;
 168                         break;
 169                 default:
 170                         return -EINVAL;
 171                 }
 172                 break;
 173         default:
 174                 return -EINVAL;
 175         }
 176
 177         return insn->n;
 178 }
 179
 180 static int apci1032_cos_insn_bits(struct comedi_device *dev,
 181                                   struct comedi_subdevice *s,
 182                                   struct comedi_insn *insn,
 183                                   unsigned int *data)
 184 {
 185         data[1] = s->state;
 186
 187         return 0;
 188 }
 189
 190 static int apci1032_cos_cmdtest(struct comedi_device *dev,
 191                                 struct comedi_subdevice *s,
 192                                 struct comedi_cmd *cmd)
 193 {
 194         int err = 0;
 195
 196         /* Step 1 : check if triggers are trivially valid */
 197
 198         err |= comedi_check_trigger_src(&cmd->start_src, TRIG_NOW);
 199         err |= comedi_check_trigger_src(&cmd->scan_begin_src, TRIG_EXT);
 200         err |= comedi_check_trigger_src(&cmd->convert_src, TRIG_FOLLOW);
 201         err |= comedi_check_trigger_src(&cmd->scan_end_src, TRIG_COUNT);
 202         err |= comedi_check_trigger_src(&cmd->stop_src, TRIG_NONE);
 203
 204         if (err)
 205                 return 1;
 206
 207         /* Step 2a : make sure trigger sources are unique */
 208         /* Step 2b : and mutually compatible */
 209
 210         /* Step 3: check if arguments are trivially valid */
 211
 212         err |= comedi_check_trigger_arg_is(&cmd->start_arg, 0);
 213         err |= comedi_check_trigger_arg_is(&cmd->scan_begin_arg, 0);
 214         err |= comedi_check_trigger_arg_is(&cmd->convert_arg, 0);
 215         err |= comedi_check_trigger_arg_is(&cmd->scan_end_arg,
 216                                            cmd->chanlist_len);
 217         err |= comedi_check_trigger_arg_is(&cmd->stop_arg, 0);
 218
 219         if (err)
 220                 return 3;
 221
 222         /* Step 4: fix up any arguments */
 223
 224         /* Step 5: check channel list if it exists */
 225
 226         return 0;
 227 }
 228
 229 /*
 230  * Change-Of-State (COS) 'do_cmd' operation
 231  *
 232  * Enable the COS interrupt as configured by apci1032_cos_insn_config().
 233  */
 234 static int apci1032_cos_cmd(struct comedi_device *dev,
 235                             struct comedi_subdevice *s)
 236 {
 237         struct apci1032_private *devpriv = dev->private;
 238
 239         if (!devpriv->ctrl) {
 240                 dev_warn(dev->class_dev,
 241                          "Interrupts disabled due to mode configuration!\n");
 242                 return -EINVAL;
 243         }
 244
 245         outl(devpriv->mode1, dev->iobase + APCI1032_MODE1_REG);
 246         outl(devpriv->mode2, dev->iobase + APCI1032_MODE2_REG);
 247         outl(devpriv->ctrl, dev->iobase + APCI1032_CTRL_REG);
 248
 249         return 0;
 250 }
 251
 252 static int apci1032_cos_cancel(struct comedi_device *dev,
 253                                struct comedi_subdevice *s)
 254 {
 255         return apci1032_reset(dev);
 256 }
 257
 258 static irqreturn_t apci1032_interrupt(int irq, void *d)
 259 {
 260         struct comedi_device *dev = d;
 261         struct apci1032_private *devpriv = dev->private;
 262         struct comedi_subdevice *s = dev->read_subdev;
 263         unsigned int ctrl;
 264
 265         /* check interrupt is from this device */
 266         if ((inl(devpriv->amcc_iobase + AMCC_OP_REG_INTCSR) &
 267              INTCSR_INTR_ASSERTED) == 0)
 268                 return IRQ_NONE;
 269
 270         /* check interrupt is enabled */
 271         ctrl = inl(dev->iobase + APCI1032_CTRL_REG);
 272         if ((ctrl & APCI1032_CTRL_INT_ENA) == 0)
 273                 return IRQ_HANDLED;
 274
 275         /* disable the interrupt */
 276         outl(ctrl & ~APCI1032_CTRL_INT_ENA, dev->iobase + APCI1032_CTRL_REG);
 277
 278         s->state = inl(dev->iobase + APCI1032_STATUS_REG) & 0xffff;
 279         comedi_buf_write_samples(s, &s->state, 1);
 280         comedi_handle_events(dev, s);
 281
 282         /* enable the interrupt */
 283         outl(ctrl, dev->iobase + APCI1032_CTRL_REG);
 284
 285         return IRQ_HANDLED;
 286 }
 287
 288 static int apci1032_di_insn_bits(struct comedi_device *dev,
 289                                  struct comedi_subdevice *s,
 290                                  struct comedi_insn *insn,
 291                                  unsigned int *data)
 292 {
 293         data[1] = inl(dev->iobase + APCI1032_DI_REG);
 294
 295         return insn->n;
 296 }
 297
 298 static int apci1032_auto_attach(struct comedi_device *dev,
 299                                 unsigned long context_unused)
 300 {
 301         struct pci_dev *pcidev = comedi_to_pci_dev(dev);
 302         struct apci1032_private *devpriv;
 303         struct comedi_subdevice *s;
 304         int ret;
 305
 306         devpriv = comedi_alloc_devpriv(dev, sizeof(*devpriv));
 307         if (!devpriv)
 308                 return -ENOMEM;
 309
 310         ret = comedi_pci_enable(dev);
 311         if (ret)
 312                 return ret;
 313
 314         devpriv->amcc_iobase = pci_resource_start(pcidev, 0);
 315         dev->iobase = pci_resource_start(pcidev, 1);
 316         apci1032_reset(dev);
 317         if (pcidev->irq > 0) {
 318                 ret = request_irq(pcidev->irq, apci1032_interrupt, IRQF_SHARED,
 319                                   dev->board_name, dev);
 320                 if (ret == 0)
 321                         dev->irq = pcidev->irq;
 322         }
 323
 324         ret = comedi_alloc_subdevices(dev, 2);
 325         if (ret)
 326                 return ret;
 327
 328         /*  Allocate and Initialise DI Subdevice Structures */
 329         s = &dev->subdevices[0];
 330         s->type         = COMEDI_SUBD_DI;
 331         s->subdev_flags = SDF_READABLE;
 332         s->n_chan       = 32;
 333         s->maxdata      = 1;
 334         s->range_table  = &range_digital;
 335         s->insn_bits    = apci1032_di_insn_bits;
 336
 337         /* Change-Of-State (COS) interrupt subdevice */
 338         s = &dev->subdevices[1];
 339         if (dev->irq) {
 340                 dev->read_subdev = s;
 341                 s->type         = COMEDI_SUBD_DI;
 342                 s->subdev_flags = SDF_READABLE | SDF_CMD_READ;
 343                 s->n_chan       = 1;
 344                 s->maxdata      = 1;
 345                 s->range_table  = &range_digital;
 346                 s->insn_config  = apci1032_cos_insn_config;
 347                 s->insn_bits    = apci1032_cos_insn_bits;
 348                 s->len_chanlist = 1;
 349                 s->do_cmdtest   = apci1032_cos_cmdtest;
 350                 s->do_cmd       = apci1032_cos_cmd;
 351                 s->cancel       = apci1032_cos_cancel;
 352         } else {
 353                 s->type         = COMEDI_SUBD_UNUSED;
 354         }
 355
 356         return 0;
 357 }
 358
 359 static void apci1032_detach(struct comedi_device *dev)
 360 {
 361         if (dev->iobase)
 362                 apci1032_reset(dev);
 363         comedi_pci_detach(dev);
 364 }
 365
 366 static struct comedi_driver apci1032_driver = {
 367         .driver_name    = "addi_apci_1032",
 368         .module         = THIS_MODULE,
 369         .auto_attach    = apci1032_auto_attach,
 370         .detach         = apci1032_detach,
 371 };
 372
 373 static int apci1032_pci_probe(struct pci_dev *dev,
 374                               const struct pci_device_id *id)
 375 {
 376         return comedi_pci_auto_config(dev, &apci1032_driver, id->driver_data);
 377 }
 378
 379 static const struct pci_device_id apci1032_pci_table[] = {
 380         { PCI_DEVICE(PCI_VENDOR_ID_ADDIDATA, 0x1003) },
 381         { 0 }
 382 };
 383 MODULE_DEVICE_TABLE(pci, apci1032_pci_table);
 384
 385 static struct pci_driver apci1032_pci_driver = {
 386         .name           = "addi_apci_1032",
 387         .id_table       = apci1032_pci_table,
 388         .probe          = apci1032_pci_probe,
 389         .remove         = comedi_pci_auto_unconfig,
 390 };
 391 module_comedi_pci_driver(apci1032_driver, apci1032_pci_driver);
 392
 393 MODULE_AUTHOR("Comedi http://www.comedi.org");
 394 MODULE_DESCRIPTION("ADDI-DATA APCI-1032, 32 channel DI boards");
 395 MODULE_LICENSE("GPL");