staging: comedi: amplc_dio200: reformat driver comment
authorIan Abbott <abbotti@mev.co.uk>
Wed, 24 Oct 2012 15:47:45 +0000 (16:47 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Wed, 24 Oct 2012 22:25:10 +0000 (15:25 -0700)
Reformat the driver description comment to use the preferred block
comment style so that future changes are acceptable to the checkpatch.pl
script.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/staging/comedi/drivers/amplc_dio200.c

index 35cd3cbb3bec359456d80c1550193838b32fdcd0..d08bab4d3f243db9b9639863f9a218cf2ada423f 100644 (file)
 
 */
 /*
-Driver: amplc_dio200
-Description: Amplicon 200 Series Digital I/O
-Author: Ian Abbott <abbotti@mev.co.uk>
-Devices: [Amplicon] PC212E (pc212e), PC214E (pc214e), PC215E (pc215e),
-  PCI215 (pci215 or amplc_dio200), PC218E (pc218e), PC272E (pc272e),
-  PCI272 (pci272 or amplc_dio200)
-Updated: Wed, 22 Oct 2008 13:36:02 +0100
-Status: works
-
-Configuration options - PC212E, PC214E, PC215E, PC218E, PC272E:
-  [0] - I/O port base address
-  [1] - IRQ (optional, but commands won't work without it)
-
-Configuration options - PCI215, PCI272:
-  [0] - PCI bus of device (optional)
-  [1] - PCI slot of device (optional)
-  If bus/slot is not specified, the first available PCI device will
-  be used.
-
-Passing a zero for an option is the same as leaving it unspecified.
-
-SUBDEVICES
-
-                   PC218E         PC212E      PC215E/PCI215
-                -------------  -------------  -------------
-  Subdevices           7              6              5
-   0                 CTR-X1         PPI-X          PPI-X
-   1                 CTR-X2         CTR-Y1         PPI-Y
-   2                 CTR-Y1         CTR-Y2         CTR-Z1
-   3                 CTR-Y2         CTR-Z1         CTR-Z2
-   4                 CTR-Z1         CTR-Z2       INTERRUPT
-   5                 CTR-Z2       INTERRUPT
-   6               INTERRUPT
-
-                   PC214E      PC272E/PCI272
-                -------------  -------------
-  Subdevices           4              4
-   0                 PPI-X          PPI-X
-   1                 PPI-Y          PPI-Y
-   2                 CTR-Z1*        PPI-Z
-   3               INTERRUPT*     INTERRUPT
-
-Each PPI is a 8255 chip providing 24 DIO channels.  The DIO channels
-are configurable as inputs or outputs in four groups:
-
-  Port A  - channels  0 to  7
-  Port B  - channels  8 to 15
-  Port CL - channels 16 to 19
-  Port CH - channels 20 to 23
-
-Only mode 0 of the 8255 chips is supported.
-
-Each CTR is a 8254 chip providing 3 16-bit counter channels.  Each
-channel is configured individually with INSN_CONFIG instructions.  The
-specific type of configuration instruction is specified in data[0].
-Some configuration instructions expect an additional parameter in
-data[1]; others return a value in data[1].  The following configuration
-instructions are supported:
-
-  INSN_CONFIG_SET_COUNTER_MODE.  Sets the counter channel's mode and
-    BCD/binary setting specified in data[1].
-
-  INSN_CONFIG_8254_READ_STATUS.  Reads the status register value for the
-    counter channel into data[1].
-
-  INSN_CONFIG_SET_CLOCK_SRC.  Sets the counter channel's clock source as
-    specified in data[1] (this is a hardware-specific value).  Not
-    supported on PC214E.  For the other boards, valid clock sources are
-    0 to 7 as follows:
-
-      0.  CLK n, the counter channel's dedicated CLK input from the SK1
-       connector.  (N.B. for other values, the counter channel's CLKn
-       pin on the SK1 connector is an output!)
-      1.  Internal 10 MHz clock.
-      2.  Internal 1 MHz clock.
-      3.  Internal 100 kHz clock.
-      4.  Internal 10 kHz clock.
-      5.  Internal 1 kHz clock.
-      6.  OUT n-1, the output of counter channel n-1 (see note 1 below).
-      7.  Ext Clock, the counter chip's dedicated Ext Clock input from
-       the SK1 connector.  This pin is shared by all three counter
-       channels on the chip.
-
-  INSN_CONFIG_GET_CLOCK_SRC.  Returns the counter channel's current
-    clock source in data[1].  For internal clock sources, data[2] is set
-    to the period in ns.
-
-  INSN_CONFIG_SET_GATE_SRC.  Sets the counter channel's gate source as
-    specified in data[2] (this is a hardware-specific value).  Not
-    supported on PC214E.  For the other boards, valid gate sources are 0
-    to 7 as follows:
-
-      0.  VCC (internal +5V d.c.), i.e. gate permanently enabled.
-      1.  GND (internal 0V d.c.), i.e. gate permanently disabled.
-      2.  GAT n, the counter channel's dedicated GAT input from the SK1
-       connector.  (N.B. for other values, the counter channel's GATn
-       pin on the SK1 connector is an output!)
-      3.  /OUT n-2, the inverted output of counter channel n-2 (see note
-       2 below).
-      4.  Reserved.
-      5.  Reserved.
-      6.  Reserved.
-      7.  Reserved.
-
-  INSN_CONFIG_GET_GATE_SRC.  Returns the counter channel's current gate
-    source in data[2].
-
-Clock and gate interconnection notes:
-
-  1.  Clock source OUT n-1 is the output of the preceding channel on the
-  same counter subdevice if n > 0, or the output of channel 2 on the
-  preceding counter subdevice (see note 3) if n = 0.
-
-  2.  Gate source /OUT n-2 is the inverted output of channel 0 on the
-  same counter subdevice if n = 2, or the inverted output of channel n+1
-  on the preceding counter subdevice (see note 3) if n < 2.
-
-  3.  The counter subdevices are connected in a ring, so the highest
-  counter subdevice precedes the lowest.
-
-The 'INTERRUPT' subdevice pretends to be a digital input subdevice.  The
-digital inputs come from the interrupt status register.  The number of
-channels matches the number of interrupt sources.  The PC214E does not
-have an interrupt status register; see notes on 'INTERRUPT SOURCES'
-below.
-
-INTERRUPT SOURCES
-
-                   PC218E         PC212E      PC215E/PCI215
-                -------------  -------------  -------------
-  Sources              6              6              6
-   0              CTR-X1-OUT      PPI-X-C0       PPI-X-C0
-   1              CTR-X2-OUT      PPI-X-C3       PPI-X-C3
-   2              CTR-Y1-OUT     CTR-Y1-OUT      PPI-Y-C0
-   3              CTR-Y2-OUT     CTR-Y2-OUT      PPI-Y-C3
-   4              CTR-Z1-OUT     CTR-Z1-OUT     CTR-Z1-OUT
-   5              CTR-Z2-OUT     CTR-Z2-OUT     CTR-Z2-OUT
-
-                   PC214E      PC272E/PCI272
-                -------------  -------------
-  Sources              1              6
-   0               JUMPER-J5      PPI-X-C0
-   1                              PPI-X-C3
-   2                              PPI-Y-C0
-   3                              PPI-Y-C3
-   4                              PPI-Z-C0
-   5                              PPI-Z-C3
-
-When an interrupt source is enabled in the interrupt source enable
-register, a rising edge on the source signal latches the corresponding
-bit to 1 in the interrupt status register.
-
-When the interrupt status register value as a whole (actually, just the
-6 least significant bits) goes from zero to non-zero, the board will
-generate an interrupt.  For level-triggered hardware interrupts (PCI
-card), the interrupt will remain asserted until the interrupt status
-register is cleared to zero.  For edge-triggered hardware interrupts
-(ISA card), no further interrupts will occur until the interrupt status
-register is cleared to zero.  To clear a bit to zero in the interrupt
-status register, the corresponding interrupt source must be disabled
-in the interrupt source enable register (there is no separate interrupt
-clear register).
-
-The PC214E does not have an interrupt source enable register or an
-interrupt status register; its 'INTERRUPT' subdevice has a single
-channel and its interrupt source is selected by the position of jumper
-J5.
-
-COMMANDS
-
-The driver supports a read streaming acquisition command on the
-'INTERRUPT' subdevice.  The channel list selects the interrupt sources
-to be enabled.  All channels will be sampled together (convert_src ==
-TRIG_NOW).  The scan begins a short time after the hardware interrupt
-occurs, subject to interrupt latencies (scan_begin_src == TRIG_EXT,
-scan_begin_arg == 0).  The value read from the interrupt status register
-is packed into a short value, one bit per requested channel, in the
-order they appear in the channel list.
-*/
+ * Driver: amplc_dio200
+ * Description: Amplicon 200 Series Digital I/O
+ * Author: Ian Abbott <abbotti@mev.co.uk>
+ * Devices: [Amplicon] PC212E (pc212e), PC214E (pc214e), PC215E (pc215e),
*   PCI215 (pci215 or amplc_dio200), PC218E (pc218e), PC272E (pc272e),
*   PCI272 (pci272 or amplc_dio200)
+ * Updated: Wed, 22 Oct 2008 13:36:02 +0100
+ * Status: works
+ *
+ * Configuration options - PC212E, PC214E, PC215E, PC218E, PC272E:
*   [0] - I/O port base address
*   [1] - IRQ (optional, but commands won't work without it)
+ *
+ * Configuration options - PCI215, PCI272:
*   [0] - PCI bus of device (optional)
*   [1] - PCI slot of device (optional)
*   If bus/slot is not specified, the first available PCI device will
*   be used.
+ *
+ * Passing a zero for an option is the same as leaving it unspecified.
+ *
+ * SUBDEVICES
+ *
*                     PC218E         PC212E      PC215E/PCI215
*                  -------------  -------------  -------------
*   Subdevices           7              6              5
*    0                 CTR-X1         PPI-X          PPI-X
*    1                 CTR-X2         CTR-Y1         PPI-Y
*    2                 CTR-Y1         CTR-Y2         CTR-Z1
*    3                 CTR-Y2         CTR-Z1         CTR-Z2
*    4                 CTR-Z1         CTR-Z2       INTERRUPT
*    5                 CTR-Z2       INTERRUPT
*    6               INTERRUPT
+ *
*                     PC214E      PC272E/PCI272
*                  -------------  -------------
*   Subdevices           4              4
*    0                 PPI-X          PPI-X
*    1                 PPI-Y          PPI-Y
*    2                 CTR-Z1*        PPI-Z
*    3               INTERRUPT*     INTERRUPT
+ *
+ * Each PPI is a 8255 chip providing 24 DIO channels.  The DIO channels
+ * are configurable as inputs or outputs in four groups:
+ *
*   Port A  - channels  0 to  7
*   Port B  - channels  8 to 15
*   Port CL - channels 16 to 19
*   Port CH - channels 20 to 23
+ *
+ * Only mode 0 of the 8255 chips is supported.
+ *
+ * Each CTR is a 8254 chip providing 3 16-bit counter channels.  Each
+ * channel is configured individually with INSN_CONFIG instructions.  The
+ * specific type of configuration instruction is specified in data[0].
+ * Some configuration instructions expect an additional parameter in
+ * data[1]; others return a value in data[1].  The following configuration
+ * instructions are supported:
+ *
*   INSN_CONFIG_SET_COUNTER_MODE.  Sets the counter channel's mode and
*     BCD/binary setting specified in data[1].
+ *
*   INSN_CONFIG_8254_READ_STATUS.  Reads the status register value for the
*     counter channel into data[1].
+ *
*   INSN_CONFIG_SET_CLOCK_SRC.  Sets the counter channel's clock source as
*     specified in data[1] (this is a hardware-specific value).  Not
*     supported on PC214E.  For the other boards, valid clock sources are
*     0 to 7 as follows:
+ *
*       0.  CLK n, the counter channel's dedicated CLK input from the SK1
*         connector.  (N.B. for other values, the counter channel's CLKn
*         pin on the SK1 connector is an output!)
*       1.  Internal 10 MHz clock.
*       2.  Internal 1 MHz clock.
*       3.  Internal 100 kHz clock.
*       4.  Internal 10 kHz clock.
*       5.  Internal 1 kHz clock.
*       6.  OUT n-1, the output of counter channel n-1 (see note 1 below).
*       7.  Ext Clock, the counter chip's dedicated Ext Clock input from
*         the SK1 connector.  This pin is shared by all three counter
*         channels on the chip.
+ *
*   INSN_CONFIG_GET_CLOCK_SRC.  Returns the counter channel's current
*     clock source in data[1].  For internal clock sources, data[2] is set
*     to the period in ns.
+ *
*   INSN_CONFIG_SET_GATE_SRC.  Sets the counter channel's gate source as
*     specified in data[2] (this is a hardware-specific value).  Not
*     supported on PC214E.  For the other boards, valid gate sources are 0
*     to 7 as follows:
+ *
*       0.  VCC (internal +5V d.c.), i.e. gate permanently enabled.
*       1.  GND (internal 0V d.c.), i.e. gate permanently disabled.
*       2.  GAT n, the counter channel's dedicated GAT input from the SK1
*         connector.  (N.B. for other values, the counter channel's GATn
*         pin on the SK1 connector is an output!)
*       3.  /OUT n-2, the inverted output of counter channel n-2 (see note
*         2 below).
*       4.  Reserved.
*       5.  Reserved.
*       6.  Reserved.
*       7.  Reserved.
+ *
*   INSN_CONFIG_GET_GATE_SRC.  Returns the counter channel's current gate
*     source in data[2].
+ *
+ * Clock and gate interconnection notes:
+ *
*   1.  Clock source OUT n-1 is the output of the preceding channel on the
*   same counter subdevice if n > 0, or the output of channel 2 on the
*   preceding counter subdevice (see note 3) if n = 0.
+ *
*   2.  Gate source /OUT n-2 is the inverted output of channel 0 on the
*   same counter subdevice if n = 2, or the inverted output of channel n+1
*   on the preceding counter subdevice (see note 3) if n < 2.
+ *
*   3.  The counter subdevices are connected in a ring, so the highest
*   counter subdevice precedes the lowest.
+ *
+ * The 'INTERRUPT' subdevice pretends to be a digital input subdevice.  The
+ * digital inputs come from the interrupt status register.  The number of
+ * channels matches the number of interrupt sources.  The PC214E does not
+ * have an interrupt status register; see notes on 'INTERRUPT SOURCES'
+ * below.
+ *
+ * INTERRUPT SOURCES
+ *
*                     PC218E         PC212E      PC215E/PCI215
*                  -------------  -------------  -------------
*   Sources              6              6              6
*    0              CTR-X1-OUT      PPI-X-C0       PPI-X-C0
*    1              CTR-X2-OUT      PPI-X-C3       PPI-X-C3
*    2              CTR-Y1-OUT     CTR-Y1-OUT      PPI-Y-C0
*    3              CTR-Y2-OUT     CTR-Y2-OUT      PPI-Y-C3
*    4              CTR-Z1-OUT     CTR-Z1-OUT     CTR-Z1-OUT
*    5              CTR-Z2-OUT     CTR-Z2-OUT     CTR-Z2-OUT
+ *
*                     PC214E      PC272E/PCI272
*                  -------------  -------------
*   Sources              1              6
*    0               JUMPER-J5      PPI-X-C0
*    1                              PPI-X-C3
*    2                              PPI-Y-C0
*    3                              PPI-Y-C3
*    4                              PPI-Z-C0
*    5                              PPI-Z-C3
+ *
+ * When an interrupt source is enabled in the interrupt source enable
+ * register, a rising edge on the source signal latches the corresponding
+ * bit to 1 in the interrupt status register.
+ *
+ * When the interrupt status register value as a whole (actually, just the
+ * 6 least significant bits) goes from zero to non-zero, the board will
+ * generate an interrupt.  For level-triggered hardware interrupts (PCI
+ * card), the interrupt will remain asserted until the interrupt status
+ * register is cleared to zero.  For edge-triggered hardware interrupts
+ * (ISA card), no further interrupts will occur until the interrupt status
+ * register is cleared to zero.  To clear a bit to zero in the interrupt
+ * status register, the corresponding interrupt source must be disabled
+ * in the interrupt source enable register (there is no separate interrupt
+ * clear register).
+ *
+ * The PC214E does not have an interrupt source enable register or an
+ * interrupt status register; its 'INTERRUPT' subdevice has a single
+ * channel and its interrupt source is selected by the position of jumper
+ * J5.
+ *
+ * COMMANDS
+ *
+ * The driver supports a read streaming acquisition command on the
+ * 'INTERRUPT' subdevice.  The channel list selects the interrupt sources
+ * to be enabled.  All channels will be sampled together (convert_src ==
+ * TRIG_NOW).  The scan begins a short time after the hardware interrupt
+ * occurs, subject to interrupt latencies (scan_begin_src == TRIG_EXT,
+ * scan_begin_arg == 0).  The value read from the interrupt status register
+ * is packed into a short value, one bit per requested channel, in the
+ * order they appear in the channel list.
+ */
 
 #include <linux/interrupt.h>
 #include <linux/slab.h>