469 lines · plain
1What: /sys/bus/counter/devices/counterX/cascade_counts_enable2KernelVersion: 6.43Contact: linux-iio@vger.kernel.org4Description:5 Indicates the cascading of Counts on Counter X.6 7 Valid attribute values are boolean.8 9What: /sys/bus/counter/devices/counterX/external_input_phase_clock_select10KernelVersion: 6.411Contact: linux-iio@vger.kernel.org12Description:13 Selects the external clock pin for phase counting mode of14 Counter X.15 16 MTCLKA-MTCLKB:17 MTCLKA and MTCLKB pins are selected for the external18 phase clock.19 20 MTCLKC-MTCLKD:21 MTCLKC and MTCLKD pins are selected for the external22 phase clock.23 24What: /sys/bus/counter/devices/counterX/external_input_phase_clock_select_available25KernelVersion: 6.426Contact: linux-iio@vger.kernel.org27Description:28 Discrete set of available values for the respective device29 configuration are listed in this file.30 31What: /sys/bus/counter/devices/counterX/countY/count32KernelVersion: 5.233Contact: linux-iio@vger.kernel.org34Description:35 Count data of Count Y represented as a string.36 37What: /sys/bus/counter/devices/counterX/countY/capture38KernelVersion: 6.139Contact: linux-iio@vger.kernel.org40Description:41 Historical capture of the Count Y count data.42 43What: /sys/bus/counter/devices/counterX/countY/ceiling44KernelVersion: 5.245Contact: linux-iio@vger.kernel.org46Description:47 Count value ceiling for Count Y. This is the upper limit for the48 respective counter.49 50What: /sys/bus/counter/devices/counterX/countY/floor51KernelVersion: 5.252Contact: linux-iio@vger.kernel.org53Description:54 Count value floor for Count Y. This is the lower limit for the55 respective counter.56 57What: /sys/bus/counter/devices/counterX/countY/count_mode58KernelVersion: 5.259Contact: linux-iio@vger.kernel.org60Description:61 Count mode for channel Y. The ceiling and floor values for62 Count Y are used by the count mode where required. The following63 count modes are available:64 65 normal:66 Counting is continuous in either direction.67 68 range limit:69 An upper or lower limit is set, mimicking limit switches70 in the mechanical counterpart. The upper limit is set to71 the Count Y ceiling value, while the lower limit is set72 to the Count Y floor value. The counter freezes at73 count = ceiling when counting up, and at count = floor74 when counting down. At either of these limits, the75 counting is resumed only when the count direction is76 reversed.77 78 non-recycle:79 The counter is disabled whenever a counter overflow or80 underflow takes place. The counter is re-enabled when a81 new count value is loaded to the counter via a preset82 operation or direct write.83 84 modulo-n:85 A count value boundary is set between the Count Y floor86 value and the Count Y ceiling value. The counter is87 reset to the Count Y floor value at count = ceiling when88 counting up, while the counter is set to the Count Y89 ceiling value at count = floor when counting down; the90 counter does not freeze at the boundary points, but91 counts continuously throughout.92 93 interrupt on terminal count:94 The output signal is initially low, and will remain low95 until the counter reaches zero. The output signal then96 goes high and remains high until a new preset value is97 set.98 99 hardware retriggerable one-shot:100 The output signal is initially high. The output signal101 will go low by a trigger input signal, and will remain102 low until the counter reaches zero. The output will then103 go high and remain high until the next trigger. A104 trigger results in loading the counter to the preset105 value and setting the output signal low, thus starting106 the one-shot pulse.107 108 rate generator:109 The output signal is initially high. When the counter110 has decremented to 1, the output signal goes low for one111 clock pulse. The output signal then goes high again, the112 counter is reloaded to the preset value, and the process113 repeats in a periodic manner as such.114 115 square wave mode:116 The output signal is initially high.117 118 If the initial count is even, the counter is decremented119 by two on succeeding clock pulses. When the count120 expires, the output signal changes value and the121 counter is reloaded to the preset value. The process122 repeats in periodic manner as such.123 124 If the initial count is odd, the initial count minus one125 (an even number) is loaded and then is decremented by126 two on succeeding clock pulses. One clock pulse after127 the count expires, the output signal goes low and the128 counter is reloaded to the preset value minus one.129 Succeeding clock pulses decrement the count by two. When130 the count expires, the output goes high again and the131 counter is reloaded to the preset value minus one. The132 process repeats in a periodic manner as such.133 134 software triggered strobe:135 The output signal is initially high. When the count136 expires, the output will go low for one clock pulse and137 then go high again. The counting sequence is "triggered"138 by setting the preset value.139 140 hardware triggered strobe:141 The output signal is initially high. Counting is started142 by a trigger input signal. When the count expires, the143 output signal will go low for one clock pulse and then144 go high again. A trigger results in loading the counter145 to the preset value.146 147What: /sys/bus/counter/devices/counterX/countY/count_mode_available148What: /sys/bus/counter/devices/counterX/countY/error_noise_available149What: /sys/bus/counter/devices/counterX/countY/function_available150What: /sys/bus/counter/devices/counterX/countY/prescaler_available151What: /sys/bus/counter/devices/counterX/countY/signalZ_action_available152KernelVersion: 5.2153Contact: linux-iio@vger.kernel.org154Description:155 Discrete set of available values for the respective Count Y156 configuration are listed in this file. Values are delimited by157 newline characters.158 159What: /sys/bus/counter/devices/counterX/countY/direction160KernelVersion: 5.2161Contact: linux-iio@vger.kernel.org162Description:163 Read-only attribute that indicates the count direction of Count164 Y. Two count directions are available: forward and backward.165 166 Some counter devices are able to determine the direction of167 their counting. For example, quadrature encoding counters can168 determine the direction of movement by evaluating the leading169 phase of the respective A and B quadrature encoding signals.170 This attribute exposes such count directions.171 172What: /sys/bus/counter/devices/counterX/countY/enable173KernelVersion: 5.2174Contact: linux-iio@vger.kernel.org175Description:176 Whether channel Y counter is enabled. Valid attribute values are177 boolean.178 179 This attribute is intended to serve as a pause/unpause mechanism180 for Count Y. Suppose a counter device is used to count the total181 movement of a conveyor belt: this attribute allows an operator182 to temporarily pause the counter, service the conveyor belt,183 and then finally unpause the counter to continue where it had184 left off.185 186What: /sys/bus/counter/devices/counterX/countY/error_noise187KernelVersion: 5.2188Contact: linux-iio@vger.kernel.org189Description:190 Read-only attribute that indicates whether excessive noise is191 present at the channel Y counter inputs.192 193What: /sys/bus/counter/devices/counterX/countY/function194KernelVersion: 5.2195Contact: linux-iio@vger.kernel.org196Description:197 Count function mode of Count Y; count function evaluation is198 triggered by conditions specified by the Count Y signalZ_action199 attributes. The following count functions are available:200 201 increase:202 Accumulated count is incremented.203 204 decrease:205 Accumulated count is decremented.206 207 pulse-direction:208 Rising edges on signal A updates the respective count.209 The input level of signal B determines direction.210 211 quadrature x1 a:212 If direction is forward, rising edges on quadrature pair213 signal A updates the respective count; if the direction214 is backward, falling edges on quadrature pair signal A215 updates the respective count. Quadrature encoding216 determines the direction.217 218 quadrature x1 b:219 If direction is forward, rising edges on quadrature pair220 signal B updates the respective count; if the direction221 is backward, falling edges on quadrature pair signal B222 updates the respective count. Quadrature encoding223 determines the direction.224 225 quadrature x2 a:226 Any state transition on quadrature pair signal A updates227 the respective count. Quadrature encoding determines the228 direction.229 230 quadrature x2 b:231 Any state transition on quadrature pair signal B updates232 the respective count. Quadrature encoding determines the233 direction.234 235 quadrature x4:236 Any state transition on either quadrature pair signals237 updates the respective count. Quadrature encoding238 determines the direction.239 240What: /sys/bus/counter/devices/counterX/countY/name241KernelVersion: 5.2242Contact: linux-iio@vger.kernel.org243Description:244 Read-only attribute that indicates the device-specific name of245 Count Y. If possible, this should match the name of the246 respective channel as it appears in the device datasheet.247 248What: /sys/bus/counter/devices/counterX/countY/prescaler249KernelVersion: 5.2250Contact: linux-iio@vger.kernel.org251Description:252 Configure the prescaler value associated with Count Y.253 On the FlexTimer, the counter clock source passes through a254 prescaler (i.e. a counter). This acts like a clock255 divider.256 257What: /sys/bus/counter/devices/counterX/countY/preset258KernelVersion: 5.2259Contact: linux-iio@vger.kernel.org260Description:261 If the counter device supports preset registers -- registers262 used to load counter channels to a set count upon device-defined263 preset operation trigger events -- the preset count for channel264 Y is provided by this attribute.265 266What: /sys/bus/counter/devices/counterX/countY/preset_enable267KernelVersion: 5.2268Contact: linux-iio@vger.kernel.org269Description:270 Whether channel Y counter preset operation is enabled. Valid271 attribute values are boolean.272 273What: /sys/bus/counter/devices/counterX/countY/signalZ_action274KernelVersion: 5.2275Contact: linux-iio@vger.kernel.org276Description:277 Action mode of Count Y for Signal Z. This attribute indicates278 the condition of Signal Z that triggers the count function279 evaluation for Count Y. The following action modes are280 available:281 282 none:283 Signal does not trigger the count function. In284 Pulse-Direction count function mode, this Signal is285 evaluated as Direction.286 287 rising edge:288 Low state transitions to high state.289 290 falling edge:291 High state transitions to low state.292 293 both edges:294 Any state transition.295 296What: /sys/bus/counter/devices/counterX/countY/num_overflows297KernelVersion: 6.1298Contact: linux-iio@vger.kernel.org299Description:300 This attribute indicates the number of overflows of count Y.301 302What: /sys/bus/counter/devices/counterX/cascade_counts_enable_component_id303What: /sys/bus/counter/devices/counterX/external_input_phase_clock_select_component_id304What: /sys/bus/counter/devices/counterX/countY/capture_component_id305What: /sys/bus/counter/devices/counterX/countY/ceiling_component_id306What: /sys/bus/counter/devices/counterX/countY/floor_component_id307What: /sys/bus/counter/devices/counterX/countY/count_mode_component_id308What: /sys/bus/counter/devices/counterX/countY/direction_component_id309What: /sys/bus/counter/devices/counterX/countY/enable_component_id310What: /sys/bus/counter/devices/counterX/countY/error_noise_component_id311What: /sys/bus/counter/devices/counterX/countY/prescaler_component_id312What: /sys/bus/counter/devices/counterX/countY/preset_component_id313What: /sys/bus/counter/devices/counterX/countY/preset_enable_component_id314What: /sys/bus/counter/devices/counterX/countY/signalZ_action_component_id315What: /sys/bus/counter/devices/counterX/countY/num_overflows_component_id316What: /sys/bus/counter/devices/counterX/signalY/cable_fault_component_id317What: /sys/bus/counter/devices/counterX/signalY/cable_fault_enable_component_id318What: /sys/bus/counter/devices/counterX/signalY/filter_clock_prescaler_component_id319What: /sys/bus/counter/devices/counterX/signalY/index_polarity_component_id320What: /sys/bus/counter/devices/counterX/signalY/polarity_component_id321What: /sys/bus/counter/devices/counterX/signalY/synchronous_mode_component_id322What: /sys/bus/counter/devices/counterX/signalY/frequency_component_id323KernelVersion: 5.16324Contact: linux-iio@vger.kernel.org325Description:326 Read-only attribute that indicates the component ID of the327 respective extension or Synapse.328 329What: /sys/bus/counter/devices/counterX/countY/spike_filter_ns330KernelVersion: 5.14331Contact: linux-iio@vger.kernel.org332Description:333 If the counter device supports programmable spike filter this334 attribute indicates the value in nanoseconds where noise pulses335 shorter or equal to configured value are ignored. Value 0 means336 filter is disabled.337 338What: /sys/bus/counter/devices/counterX/events_queue_size339KernelVersion: 5.16340Contact: linux-iio@vger.kernel.org341Description:342 Size of the Counter events queue in number of struct343 counter_event data structures. The number of elements will be344 rounded-up to a power of 2.345 346What: /sys/bus/counter/devices/counterX/name347KernelVersion: 5.2348Contact: linux-iio@vger.kernel.org349Description:350 Read-only attribute that indicates the device-specific name of351 the Counter. This should match the name of the device as it352 appears in its respective datasheet.353 354What: /sys/bus/counter/devices/counterX/num_counts355KernelVersion: 5.2356Contact: linux-iio@vger.kernel.org357Description:358 Read-only attribute that indicates the total number of Counts359 belonging to the Counter.360 361What: /sys/bus/counter/devices/counterX/num_signals362KernelVersion: 5.2363Contact: linux-iio@vger.kernel.org364Description:365 Read-only attribute that indicates the total number of Signals366 belonging to the Counter.367 368What: /sys/bus/counter/devices/counterX/signalY/cable_fault369KernelVersion: 5.7370Contact: linux-iio@vger.kernel.org371Description:372 Read-only attribute that indicates whether a differential373 encoder cable fault (not connected or loose wires) is detected374 for the respective channel of Signal Y. Valid attribute values375 are boolean. Detection must first be enabled via the376 corresponding cable_fault_enable attribute.377 378What: /sys/bus/counter/devices/counterX/signalY/cable_fault_enable379KernelVersion: 5.7380Contact: linux-iio@vger.kernel.org381Description:382 Whether detection of differential encoder cable faults for the383 respective channel of Signal Y is enabled. Valid attribute384 values are boolean.385 386What: /sys/bus/counter/devices/counterX/signalY/filter_clock_prescaler387KernelVersion: 5.7388Contact: linux-iio@vger.kernel.org389Description:390 Filter clock factor for input Signal Y. This prescaler value391 affects the inputs of both quadrature pair signals.392 393What: /sys/bus/counter/devices/counterX/signalY/index_polarity394KernelVersion: 5.2395Contact: linux-iio@vger.kernel.org396Description:397 Active level of index input Signal Y; irrelevant in398 non-synchronous load mode.399 400What: /sys/bus/counter/devices/counterX/signalY/index_polarity_available401What: /sys/bus/counter/devices/counterX/signalY/synchronous_mode_available402KernelVersion: 5.2403Contact: linux-iio@vger.kernel.org404Description:405 Discrete set of available values for the respective Signal Y406 configuration are listed in this file.407 408What: /sys/bus/counter/devices/counterX/signalY/polarity409KernelVersion: 6.1410Contact: linux-iio@vger.kernel.org411Description:412 Active level of Signal Y. The following polarity values are413 available:414 415 positive:416 Signal high state considered active level (rising edge).417 418 negative:419 Signal low state considered active level (falling edge).420 421What: /sys/bus/counter/devices/counterX/signalY/name422KernelVersion: 5.2423Contact: linux-iio@vger.kernel.org424Description:425 Read-only attribute that indicates the device-specific name of426 Signal Y. If possible, this should match the name of the427 respective signal as it appears in the device datasheet.428 429What: /sys/bus/counter/devices/counterX/signalY/signal430KernelVersion: 5.2431Contact: linux-iio@vger.kernel.org432Description:433 Signal level state of Signal Y. The following signal level434 states are available:435 436 low:437 Low level state.438 439 high:440 High level state.441 442What: /sys/bus/counter/devices/counterX/signalY/synchronous_mode443KernelVersion: 5.2444Contact: linux-iio@vger.kernel.org445Description:446 Configure the counter associated with Signal Y for447 non-synchronous or synchronous load mode. Synchronous load mode448 cannot be selected in non-quadrature (Pulse-Direction) clock449 mode.450 451 non-synchronous:452 A logic low level is the active level at this index453 input. The index function (as enabled via preset_enable)454 is performed directly on the active level of the index455 input.456 457 synchronous:458 Intended for interfacing with encoder Index output in459 quadrature clock mode. The active level is configured460 via index_polarity. The index function (as enabled via461 preset_enable) is performed synchronously with the462 quadrature clock on the active level of the index input.463 464What: /sys/bus/counter/devices/counterX/signalY/frequency465KernelVersion: 6.1466Contact: linux-iio@vger.kernel.org467Description:468 Read-only attribute that indicates the signal Y frequency, in Hz.469