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