drivers/staging/comedi/drivers/amplc_dio200.c

   1 /*
   2     comedi/drivers/amplc_dio200.c
   3
   4     Driver for Amplicon PC212E, PC214E, PC215E, PC218E, PC272E.
   5
   6     Copyright (C) 2005-2013 MEV Ltd. <http://www.mev.co.uk/>
   7
   8     COMEDI - Linux Control and Measurement Device Interface
   9     Copyright (C) 1998,2000 David A. Schleef <ds@schleef.org>
  10
  11     This program is free software; you can redistribute it and/or modify
  12     it under the terms of the GNU General Public License as published by
  13     the Free Software Foundation; either version 2 of the License, or
  14     (at your option) any later version.
  15
  16     This program is distributed in the hope that it will be useful,
  17     but WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19     GNU General Public License for more details.
  20 */
  21 /*
  22  * Driver: amplc_dio200
  23  * Description: Amplicon 200 Series ISA Digital I/O
  24  * Author: Ian Abbott <abbotti@mev.co.uk>
  25  * Devices: [Amplicon] PC212E (pc212e), PC214E (pc214e), PC215E (pc215e),
  26  *   PC218E (pc218e), PC272E (pc272e)
  27  * Updated: Mon, 18 Mar 2013 14:40:41 +0000
  28  *
  29  * Status: works
  30  *
  31  * Configuration options:
  32  *   [0] - I/O port base address
  33  *   [1] - IRQ (optional, but commands won't work without it)
  34  *
  35  * Passing a zero for an option is the same as leaving it unspecified.
  36  *
  37  * SUBDEVICES
  38  *
  39  *                     PC212E         PC214E         PC215E
  40  *                  -------------  -------------  -------------
  41  *   Subdevices           6              4              5
  42  *    0                 PPI-X          PPI-X          PPI-X
  43  *    1                 CTR-Y1         PPI-Y          PPI-Y
  44  *    2                 CTR-Y2         CTR-Z1*        CTR-Z1
  45  *    3                 CTR-Z1       INTERRUPT*       CTR-Z2
  46  *    4                 CTR-Z2                      INTERRUPT
  47  *    5               INTERRUPT
  48  *
  49  *                     PC218E         PC272E
  50  *                  -------------  -------------
  51  *   Subdevices           7              4
  52  *    0                 CTR-X1         PPI-X
  53  *    1                 CTR-X2         PPI-Y
  54  *    2                 CTR-Y1         PPI-Z
  55  *    3                 CTR-Y2       INTERRUPT
  56  *    4                 CTR-Z1
  57  *    5                 CTR-Z2
  58  *    6               INTERRUPT
  59  *
  60  * Each PPI is a 8255 chip providing 24 DIO channels.  The DIO channels
  61  * are configurable as inputs or outputs in four groups:
  62  *
  63  *   Port A  - channels  0 to  7
  64  *   Port B  - channels  8 to 15
  65  *   Port CL - channels 16 to 19
  66  *   Port CH - channels 20 to 23
  67  *
  68  * Only mode 0 of the 8255 chips is supported.
  69  *
  70  * Each CTR is a 8254 chip providing 3 16-bit counter channels.  Each
  71  * channel is configured individually with INSN_CONFIG instructions.  The
  72  * specific type of configuration instruction is specified in data[0].
  73  * Some configuration instructions expect an additional parameter in
  74  * data[1]; others return a value in data[1].  The following configuration
  75  * instructions are supported:
  76  *
  77  *   INSN_CONFIG_SET_COUNTER_MODE.  Sets the counter channel's mode and
  78  *     BCD/binary setting specified in data[1].
  79  *
  80  *   INSN_CONFIG_8254_READ_STATUS.  Reads the status register value for the
  81  *     counter channel into data[1].
  82  *
  83  *   INSN_CONFIG_SET_CLOCK_SRC.  Sets the counter channel's clock source as
  84  *     specified in data[1] (this is a hardware-specific value).  Not
  85  *     supported on PC214E.  For the other boards, valid clock sources are
  86  *     0 to 7 as follows:
  87  *
  88  *       0.  CLK n, the counter channel's dedicated CLK input from the SK1
  89  *         connector.  (N.B. for other values, the counter channel's CLKn
  90  *         pin on the SK1 connector is an output!)
  91  *       1.  Internal 10 MHz clock.
  92  *       2.  Internal 1 MHz clock.
  93  *       3.  Internal 100 kHz clock.
  94  *       4.  Internal 10 kHz clock.
  95  *       5.  Internal 1 kHz clock.
  96  *       6.  OUT n-1, the output of counter channel n-1 (see note 1 below).
  97  *       7.  Ext Clock, the counter chip's dedicated Ext Clock input from
  98  *         the SK1 connector.  This pin is shared by all three counter
  99  *         channels on the chip.
 100  *
 101  *   INSN_CONFIG_GET_CLOCK_SRC.  Returns the counter channel's current
 102  *     clock source in data[1].  For internal clock sources, data[2] is set
 103  *     to the period in ns.
 104  *
 105  *   INSN_CONFIG_SET_GATE_SRC.  Sets the counter channel's gate source as
 106  *     specified in data[2] (this is a hardware-specific value).  Not
 107  *     supported on PC214E.  For the other boards, valid gate sources are 0
 108  *     to 7 as follows:
 109  *
 110  *       0.  VCC (internal +5V d.c.), i.e. gate permanently enabled.
 111  *       1.  GND (internal 0V d.c.), i.e. gate permanently disabled.
 112  *       2.  GAT n, the counter channel's dedicated GAT input from the SK1
 113  *         connector.  (N.B. for other values, the counter channel's GATn
 114  *         pin on the SK1 connector is an output!)
 115  *       3.  /OUT n-2, the inverted output of counter channel n-2 (see note
 116  *         2 below).
 117  *       4.  Reserved.
 118  *       5.  Reserved.
 119  *       6.  Reserved.
 120  *       7.  Reserved.
 121  *
 122  *   INSN_CONFIG_GET_GATE_SRC.  Returns the counter channel's current gate
 123  *     source in data[2].
 124  *
 125  * Clock and gate interconnection notes:
 126  *
 127  *   1.  Clock source OUT n-1 is the output of the preceding channel on the
 128  *   same counter subdevice if n > 0, or the output of channel 2 on the
 129  *   preceding counter subdevice (see note 3) if n = 0.
 130  *
 131  *   2.  Gate source /OUT n-2 is the inverted output of channel 0 on the
 132  *   same counter subdevice if n = 2, or the inverted output of channel n+1
 133  *   on the preceding counter subdevice (see note 3) if n < 2.
 134  *
 135  *   3.  The counter subdevices are connected in a ring, so the highest
 136  *   counter subdevice precedes the lowest.
 137  *
 138  * The 'INTERRUPT' subdevice pretends to be a digital input subdevice.  The
 139  * digital inputs come from the interrupt status register.  The number of
 140  * channels matches the number of interrupt sources.  The PC214E does not
 141  * have an interrupt status register; see notes on 'INTERRUPT SOURCES'
 142  * below.
 143  *
 144  * INTERRUPT SOURCES
 145  *
 146  *                     PC212E         PC214E         PC215E
 147  *                  -------------  -------------  -------------
 148  *   Sources              6              1              6
 149  *    0               PPI-X-C0       JUMPER-J5      PPI-X-C0
 150  *    1               PPI-X-C3                      PPI-X-C3
 151  *    2              CTR-Y1-OUT1                    PPI-Y-C0
 152  *    3              CTR-Y2-OUT1                    PPI-Y-C3
 153  *    4              CTR-Z1-OUT1                   CTR-Z1-OUT1
 154  *    5              CTR-Z2-OUT1                   CTR-Z2-OUT1
 155  *
 156  *                     PC218E         PC272E
 157  *                  -------------  -------------
 158  *   Sources              6              6
 159  *    0              CTR-X1-OUT1     PPI-X-C0
 160  *    1              CTR-X2-OUT1     PPI-X-C3
 161  *    2              CTR-Y1-OUT1     PPI-Y-C0
 162  *    3              CTR-Y2-OUT1     PPI-Y-C3
 163  *    4              CTR-Z1-OUT1     PPI-Z-C0
 164  *    5              CTR-Z2-OUT1     PPI-Z-C3
 165  *
 166  * When an interrupt source is enabled in the interrupt source enable
 167  * register, a rising edge on the source signal latches the corresponding
 168  * bit to 1 in the interrupt status register.
 169  *
 170  * When the interrupt status register value as a whole (actually, just the
 171  * 6 least significant bits) goes from zero to non-zero, the board will
 172  * generate an interrupt.  No further interrupts will occur until the
 173  * interrupt status register is cleared to zero.  To clear a bit to zero in
 174  * the interrupt status register, the corresponding interrupt source must
 175  * be disabled in the interrupt source enable register (there is no
 176  * separate interrupt clear register).
 177  *
 178  * The PC214E does not have an interrupt source enable register or an
 179  * interrupt status register; its 'INTERRUPT' subdevice has a single
 180  * channel and its interrupt source is selected by the position of jumper
 181  * J5.
 182  *
 183  * COMMANDS
 184  *
 185  * The driver supports a read streaming acquisition command on the
 186  * 'INTERRUPT' subdevice.  The channel list selects the interrupt sources
 187  * to be enabled.  All channels will be sampled together (convert_src ==
 188  * TRIG_NOW).  The scan begins a short time after the hardware interrupt
 189  * occurs, subject to interrupt latencies (scan_begin_src == TRIG_EXT,
 190  * scan_begin_arg == 0).  The value read from the interrupt status register
 191  * is packed into a short value, one bit per requested channel, in the
 192  * order they appear in the channel list.
 193  */
 194
 195 #include <linux/module.h>
 196 #include "../comedidev.h"
 197
 198 #include "amplc_dio200.h"
 199
 200 /*
 201  * Board descriptions.
 202  */
 203 static const struct dio200_board dio200_isa_boards[] = {
 204         {
 205                 .name = "pc212e",
 206                 .bustype = isa_bustype,
 207                 .mainsize = DIO200_IO_SIZE,
 208                 .layout = {
 209                         .n_subdevs = 6,
 210                         .sdtype = {sd_8255, sd_8254, sd_8254, sd_8254, sd_8254,
 211                                    sd_intr},
 212                         .sdinfo = {0x00, 0x08, 0x0C, 0x10, 0x14, 0x3F},
 213                         .has_int_sce = true,
 214                         .has_clk_gat_sce = true,
 215                 },
 216         },
 217         {
 218                 .name = "pc214e",
 219                 .bustype = isa_bustype,
 220                 .mainsize = DIO200_IO_SIZE,
 221                 .layout = {
 222                         .n_subdevs = 4,
 223                         .sdtype = {sd_8255, sd_8255, sd_8254, sd_intr},
 224                         .sdinfo = {0x00, 0x08, 0x10, 0x01},
 225                 },
 226         },
 227         {
 228                 .name = "pc215e",
 229                 .bustype = isa_bustype,
 230                 .mainsize = DIO200_IO_SIZE,
 231                 .layout = {
 232                         .n_subdevs = 5,
 233                         .sdtype = {sd_8255, sd_8255, sd_8254, sd_8254, sd_intr},
 234                         .sdinfo = {0x00, 0x08, 0x10, 0x14, 0x3F},
 235                         .has_int_sce = true,
 236                         .has_clk_gat_sce = true,
 237                 },
 238         },
 239         {
 240                 .name = "pc218e",
 241                 .bustype = isa_bustype,
 242                 .mainsize = DIO200_IO_SIZE,
 243                 .layout = {
 244                         .n_subdevs = 7,
 245                         .sdtype = {sd_8254, sd_8254, sd_8255, sd_8254, sd_8254,
 246                                    sd_intr},
 247                         .sdinfo = {0x00, 0x04, 0x08, 0x0C, 0x10, 0x14, 0x3F},
 248                         .has_int_sce = true,
 249                         .has_clk_gat_sce = true,
 250                 },
 251         },
 252         {
 253                 .name = "pc272e",
 254                 .bustype = isa_bustype,
 255                 .mainsize = DIO200_IO_SIZE,
 256                 .layout = {
 257                         .n_subdevs = 4,
 258                         .sdtype = {sd_8255, sd_8255, sd_8255, sd_intr},
 259                         .sdinfo = {0x00, 0x08, 0x10, 0x3F},
 260                         .has_int_sce = true,
 261                 },
 262         },
 263 };
 264
 265 static int dio200_attach(struct comedi_device *dev, struct comedi_devconfig *it)
 266 {
 267         const struct dio200_board *thisboard = comedi_board(dev);
 268         struct dio200_private *devpriv;
 269         unsigned int irq;
 270         int ret;
 271
 272         irq = it->options[1];
 273
 274         devpriv = comedi_alloc_devpriv(dev, sizeof(*devpriv));
 275         if (!devpriv)
 276                 return -ENOMEM;
 277
 278         ret = comedi_request_region(dev, it->options[0], thisboard->mainsize);
 279         if (ret)
 280                 return ret;
 281         devpriv->io.u.iobase = dev->iobase;
 282         devpriv->io.regtype = io_regtype;
 283         return amplc_dio200_common_attach(dev, irq, 0);
 284 }
 285
 286 static void dio200_detach(struct comedi_device *dev)
 287 {
 288         amplc_dio200_common_detach(dev);
 289         comedi_legacy_detach(dev);
 290 }
 291
 292 static struct comedi_driver amplc_dio200_driver = {
 293         .driver_name = "amplc_dio200",
 294         .module = THIS_MODULE,
 295         .attach = dio200_attach,
 296         .detach = dio200_detach,
 297         .board_name = &dio200_isa_boards[0].name,
 298         .offset = sizeof(struct dio200_board),
 299         .num_names = ARRAY_SIZE(dio200_isa_boards),
 300 };
 301 module_comedi_driver(amplc_dio200_driver);
 302
 303 MODULE_AUTHOR("Comedi http://www.comedi.org");
 304 MODULE_DESCRIPTION("Comedi driver for Amplicon 200 Series ISA DIO boards");
 305 MODULE_LICENSE("GPL");