drivers/staging/comedi/drivers/ni_tio_internal.h

   1 /*
   2  * Header file for NI general purpose counter support code (ni_tio.c and
   3  * ni_tiocmd.c)
   4  *
   5  * COMEDI - Linux Control and Measurement Device Interface
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  */
  17
  18 #ifndef _COMEDI_NI_TIO_INTERNAL_H
  19 #define _COMEDI_NI_TIO_INTERNAL_H
  20
  21 #include "ni_tio.h"
  22
  23 #define NITIO_AUTO_INC_REG(x)           (NITIO_G0_AUTO_INC + (x))
  24 #define GI_AUTO_INC_MASK                0xff
  25 #define NITIO_CMD_REG(x)                (NITIO_G0_CMD + (x))
  26 #define GI_ARM                          BIT(0)
  27 #define GI_SAVE_TRACE                   BIT(1)
  28 #define GI_LOAD                         BIT(2)
  29 #define GI_DISARM                       BIT(4)
  30 #define GI_CNT_DIR(x)                   (((x) & 0x3) << 5)
  31 #define GI_CNT_DIR_MASK                 GI_CNT_DIR(3)
  32 #define GI_WRITE_SWITCH                 BIT(7)
  33 #define GI_SYNC_GATE                    BIT(8)
  34 #define GI_LITTLE_BIG_ENDIAN            BIT(9)
  35 #define GI_BANK_SWITCH_START            BIT(10)
  36 #define GI_BANK_SWITCH_MODE             BIT(11)
  37 #define GI_BANK_SWITCH_ENABLE           BIT(12)
  38 #define GI_ARM_COPY                     BIT(13)
  39 #define GI_SAVE_TRACE_COPY              BIT(14)
  40 #define GI_DISARM_COPY                  BIT(15)
  41 #define NITIO_HW_SAVE_REG(x)            (NITIO_G0_HW_SAVE + (x))
  42 #define NITIO_SW_SAVE_REG(x)            (NITIO_G0_SW_SAVE + (x))
  43 #define NITIO_MODE_REG(x)               (NITIO_G0_MODE + (x))
  44 #define GI_GATING_MODE(x)               (((x) & 0x3) << 0)
  45 #define GI_GATING_DISABLED              GI_GATING_MODE(0)
  46 #define GI_LEVEL_GATING                 GI_GATING_MODE(1)
  47 #define GI_RISING_EDGE_GATING           GI_GATING_MODE(2)
  48 #define GI_FALLING_EDGE_GATING          GI_GATING_MODE(3)
  49 #define GI_GATING_MODE_MASK             GI_GATING_MODE(3)
  50 #define GI_GATE_ON_BOTH_EDGES           BIT(2)
  51 #define GI_EDGE_GATE_MODE(x)            (((x) & 0x3) << 3)
  52 #define GI_EDGE_GATE_STARTS_STOPS       GI_EDGE_GATE_MODE(0)
  53 #define GI_EDGE_GATE_STOPS_STARTS       GI_EDGE_GATE_MODE(1)
  54 #define GI_EDGE_GATE_STARTS             GI_EDGE_GATE_MODE(2)
  55 #define GI_EDGE_GATE_NO_STARTS_OR_STOPS GI_EDGE_GATE_MODE(3)
  56 #define GI_EDGE_GATE_MODE_MASK          GI_EDGE_GATE_MODE(3)
  57 #define GI_STOP_MODE(x)                 (((x) & 0x3) << 5)
  58 #define GI_STOP_ON_GATE                 GI_STOP_MODE(0)
  59 #define GI_STOP_ON_GATE_OR_TC           GI_STOP_MODE(1)
  60 #define GI_STOP_ON_GATE_OR_SECOND_TC    GI_STOP_MODE(2)
  61 #define GI_STOP_MODE_MASK               GI_STOP_MODE(3)
  62 #define GI_LOAD_SRC_SEL                 BIT(7)
  63 #define GI_OUTPUT_MODE(x)               (((x) & 0x3) << 8)
  64 #define GI_OUTPUT_TC_PULSE              GI_OUTPUT_MODE(1)
  65 #define GI_OUTPUT_TC_TOGGLE             GI_OUTPUT_MODE(2)
  66 #define GI_OUTPUT_TC_OR_GATE_TOGGLE     GI_OUTPUT_MODE(3)
  67 #define GI_OUTPUT_MODE_MASK             GI_OUTPUT_MODE(3)
  68 #define GI_COUNTING_ONCE(x)             (((x) & 0x3) << 10)
  69 #define GI_NO_HARDWARE_DISARM           GI_COUNTING_ONCE(0)
  70 #define GI_DISARM_AT_TC                 GI_COUNTING_ONCE(1)
  71 #define GI_DISARM_AT_GATE               GI_COUNTING_ONCE(2)
  72 #define GI_DISARM_AT_TC_OR_GATE         GI_COUNTING_ONCE(3)
  73 #define GI_COUNTING_ONCE_MASK           GI_COUNTING_ONCE(3)
  74 #define GI_LOADING_ON_TC                BIT(12)
  75 #define GI_GATE_POL_INVERT              BIT(13)
  76 #define GI_LOADING_ON_GATE              BIT(14)
  77 #define GI_RELOAD_SRC_SWITCHING         BIT(15)
  78 #define NITIO_LOADA_REG(x)              (NITIO_G0_LOADA + (x))
  79 #define NITIO_LOADB_REG(x)              (NITIO_G0_LOADB + (x))
  80 #define NITIO_INPUT_SEL_REG(x)          (NITIO_G0_INPUT_SEL + (x))
  81 #define GI_READ_ACKS_IRQ                BIT(0)
  82 #define GI_WRITE_ACKS_IRQ               BIT(1)
  83 #define GI_BITS_TO_SRC(x)               (((x) >> 2) & 0x1f)
  84 #define GI_SRC_SEL(x)                   (((x) & 0x1f) << 2)
  85 #define GI_SRC_SEL_MASK                 GI_SRC_SEL(0x1f)
  86 #define GI_BITS_TO_GATE(x)              (((x) >> 7) & 0x1f)
  87 #define GI_GATE_SEL(x)                  (((x) & 0x1f) << 7)
  88 #define GI_GATE_SEL_MASK                GI_GATE_SEL(0x1f)
  89 #define GI_GATE_SEL_LOAD_SRC            BIT(12)
  90 #define GI_OR_GATE                      BIT(13)
  91 #define GI_OUTPUT_POL_INVERT            BIT(14)
  92 #define GI_SRC_POL_INVERT               BIT(15)
  93 #define NITIO_CNT_MODE_REG(x)           (NITIO_G0_CNT_MODE + (x))
  94 #define GI_CNT_MODE(x)                  (((x) & 0x7) << 0)
  95 #define GI_CNT_MODE_NORMAL              GI_CNT_MODE(0)
  96 #define GI_CNT_MODE_QUADX1              GI_CNT_MODE(1)
  97 #define GI_CNT_MODE_QUADX2              GI_CNT_MODE(2)
  98 #define GI_CNT_MODE_QUADX4              GI_CNT_MODE(3)
  99 #define GI_CNT_MODE_TWO_PULSE           GI_CNT_MODE(4)
 100 #define GI_CNT_MODE_SYNC_SRC            GI_CNT_MODE(6)
 101 #define GI_CNT_MODE_MASK                GI_CNT_MODE(7)
 102 #define GI_INDEX_MODE                   BIT(4)
 103 #define GI_INDEX_PHASE(x)               (((x) & 0x3) << 5)
 104 #define GI_INDEX_PHASE_MASK             GI_INDEX_PHASE(3)
 105 #define GI_HW_ARM_ENA                   BIT(7)
 106 #define GI_HW_ARM_SEL(x)                ((x) << 8)
 107 #define GI_660X_HW_ARM_SEL_MASK         GI_HW_ARM_SEL(0x7)
 108 #define GI_M_HW_ARM_SEL_MASK            GI_HW_ARM_SEL(0x1f)
 109 #define GI_660X_PRESCALE_X8             BIT(12)
 110 #define GI_M_PRESCALE_X8                BIT(13)
 111 #define GI_660X_ALT_SYNC                BIT(13)
 112 #define GI_M_ALT_SYNC                   BIT(14)
 113 #define GI_660X_PRESCALE_X2             BIT(14)
 114 #define GI_M_PRESCALE_X2                BIT(15)
 115 #define NITIO_GATE2_REG(x)              (NITIO_G0_GATE2 + (x))
 116 #define GI_GATE2_MODE                   BIT(0)
 117 #define GI_BITS_TO_GATE2(x)             (((x) >> 7) & 0x1f)
 118 #define GI_GATE2_SEL(x)                 (((x) & 0x1f) << 7)
 119 #define GI_GATE2_SEL_MASK               GI_GATE2_SEL(0x1f)
 120 #define GI_GATE2_POL_INVERT             BIT(13)
 121 #define GI_GATE2_SUBSEL                 BIT(14)
 122 #define GI_SRC_SUBSEL                   BIT(15)
 123 #define NITIO_SHARED_STATUS_REG(x)      (NITIO_G01_STATUS + ((x) / 2))
 124 #define GI_SAVE(x)                      (((x) % 2) ? BIT(1) : BIT(0))
 125 #define GI_COUNTING(x)                  (((x) % 2) ? BIT(3) : BIT(2))
 126 #define GI_NEXT_LOAD_SRC(x)             (((x) % 2) ? BIT(5) : BIT(4))
 127 #define GI_STALE_DATA(x)                (((x) % 2) ? BIT(7) : BIT(6))
 128 #define GI_ARMED(x)                     (((x) % 2) ? BIT(9) : BIT(8))
 129 #define GI_NO_LOAD_BETWEEN_GATES(x)     (((x) % 2) ? BIT(11) : BIT(10))
 130 #define GI_TC_ERROR(x)                  (((x) % 2) ? BIT(13) : BIT(12))
 131 #define GI_GATE_ERROR(x)                (((x) % 2) ? BIT(15) : BIT(14))
 132 #define NITIO_RESET_REG(x)              (NITIO_G01_RESET + ((x) / 2))
 133 #define GI_RESET(x)                     BIT(2 + ((x) % 2))
 134 #define NITIO_STATUS1_REG(x)            (NITIO_G01_STATUS1 + ((x) / 2))
 135 #define NITIO_STATUS2_REG(x)            (NITIO_G01_STATUS2 + ((x) / 2))
 136 #define GI_OUTPUT(x)                    (((x) % 2) ? BIT(1) : BIT(0))
 137 #define GI_HW_SAVE(x)                   (((x) % 2) ? BIT(13) : BIT(12))
 138 #define GI_PERMANENT_STALE(x)           (((x) % 2) ? BIT(15) : BIT(14))
 139 #define NITIO_DMA_CFG_REG(x)            (NITIO_G0_DMA_CFG + (x))
 140 #define GI_DMA_ENABLE                   BIT(0)
 141 #define GI_DMA_WRITE                    BIT(1)
 142 #define GI_DMA_INT_ENA                  BIT(2)
 143 #define GI_DMA_RESET                    BIT(3)
 144 #define GI_DMA_BANKSW_ERROR             BIT(4)
 145 #define NITIO_DMA_STATUS_REG(x)         (NITIO_G0_DMA_STATUS + (x))
 146 #define GI_DMA_READBANK                 BIT(13)
 147 #define GI_DRQ_ERROR                    BIT(14)
 148 #define GI_DRQ_STATUS                   BIT(15)
 149 #define NITIO_ABZ_REG(x)                (NITIO_G0_ABZ + (x))
 150 #define NITIO_INT_ACK_REG(x)            (NITIO_G0_INT_ACK + (x))
 151 #define GI_GATE_ERROR_CONFIRM(x)        (((x) % 2) ? BIT(1) : BIT(5))
 152 #define GI_TC_ERROR_CONFIRM(x)          (((x) % 2) ? BIT(2) : BIT(6))
 153 #define GI_TC_INTERRUPT_ACK             BIT(14)
 154 #define GI_GATE_INTERRUPT_ACK           BIT(15)
 155 #define NITIO_STATUS_REG(x)             (NITIO_G0_STATUS + (x))
 156 #define GI_GATE_INTERRUPT               BIT(2)
 157 #define GI_TC                           BIT(3)
 158 #define GI_INTERRUPT                    BIT(15)
 159 #define NITIO_INT_ENA_REG(x)            (NITIO_G0_INT_ENA + (x))
 160 #define GI_TC_INTERRUPT_ENABLE(x)       (((x) % 2) ? BIT(9) : BIT(6))
 161 #define GI_GATE_INTERRUPT_ENABLE(x)     (((x) % 2) ? BIT(10) : BIT(8))
 162
 163 void ni_tio_write(struct ni_gpct *, unsigned int value, enum ni_gpct_register);
 164 unsigned int ni_tio_read(struct ni_gpct *, enum ni_gpct_register);
 165
 166 static inline bool
 167 ni_tio_counting_mode_registers_present(const struct ni_gpct_device *counter_dev)
 168 {
 169         /* m series and 660x variants have counting mode registers */
 170         return counter_dev->variant != ni_gpct_variant_e_series;
 171 }
 172
 173 void ni_tio_set_bits(struct ni_gpct *, enum ni_gpct_register reg,
 174                      unsigned int mask, unsigned int value);
 175 unsigned int ni_tio_get_soft_copy(const struct ni_gpct *,
 176                                   enum ni_gpct_register reg);
 177
 178 int ni_tio_arm(struct ni_gpct *, bool arm, unsigned int start_trigger);
 179 int ni_tio_set_gate_src(struct ni_gpct *, unsigned int gate, unsigned int src);
 180
 181 #endif /* _COMEDI_NI_TIO_INTERNAL_H */