xref: /openbmc/linux/Documentation/ABI/testing/sysfs-bus-counter (revision c900529f3d9161bfde5cca0754f83b4d3c3e0220)
17bb985acSBiju DasWhat:		/sys/bus/counter/devices/counterX/cascade_counts_enable
27bb985acSBiju DasKernelVersion:	6.4
37bb985acSBiju DasContact:	linux-iio@vger.kernel.org
47bb985acSBiju DasDescription:
57bb985acSBiju Das		Indicates the cascading of Counts on Counter X.
67bb985acSBiju Das
77bb985acSBiju Das		Valid attribute values are boolean.
87bb985acSBiju Das
97bb985acSBiju DasWhat:		/sys/bus/counter/devices/counterX/external_input_phase_clock_select
107bb985acSBiju DasKernelVersion:	6.4
117bb985acSBiju DasContact:	linux-iio@vger.kernel.org
127bb985acSBiju DasDescription:
137bb985acSBiju Das		Selects the external clock pin for phase counting mode of
147bb985acSBiju Das		Counter X.
157bb985acSBiju Das
167bb985acSBiju Das		MTCLKA-MTCLKB:
177bb985acSBiju Das			MTCLKA and MTCLKB pins are selected for the external
187bb985acSBiju Das			phase clock.
197bb985acSBiju Das
207bb985acSBiju Das		MTCLKC-MTCLKD:
217bb985acSBiju Das			MTCLKC and MTCLKD pins are selected for the external
227bb985acSBiju Das			phase clock.
237bb985acSBiju Das
247bb985acSBiju DasWhat:		/sys/bus/counter/devices/counterX/external_input_phase_clock_select_available
257bb985acSBiju DasKernelVersion:	6.4
267bb985acSBiju DasContact:	linux-iio@vger.kernel.org
277bb985acSBiju DasDescription:
287bb985acSBiju Das		Discrete set of available values for the respective device
297bb985acSBiju Das		configuration are listed in this file.
307bb985acSBiju Das
31ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/count
32ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
33ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
34ea2b23b8SWilliam Breathitt GrayDescription:
35ea2b23b8SWilliam Breathitt Gray		Count data of Count Y represented as a string.
36ea2b23b8SWilliam Breathitt Gray
3745d29185SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/capture
3845d29185SWilliam Breathitt GrayKernelVersion:	6.1
3945d29185SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
4045d29185SWilliam Breathitt GrayDescription:
4145d29185SWilliam Breathitt Gray		Historical capture of the Count Y count data.
4245d29185SWilliam Breathitt Gray
43ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/ceiling
44ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
45ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
46ea2b23b8SWilliam Breathitt GrayDescription:
47ea2b23b8SWilliam Breathitt Gray		Count value ceiling for Count Y. This is the upper limit for the
48ea2b23b8SWilliam Breathitt Gray		respective counter.
49ea2b23b8SWilliam Breathitt Gray
50ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/floor
51ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
52ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
53ea2b23b8SWilliam Breathitt GrayDescription:
54ea2b23b8SWilliam Breathitt Gray		Count value floor for Count Y. This is the lower limit for the
55ea2b23b8SWilliam Breathitt Gray		respective counter.
56ea2b23b8SWilliam Breathitt Gray
57ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/count_mode
58ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
59ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
60ea2b23b8SWilliam Breathitt GrayDescription:
61ea2b23b8SWilliam Breathitt Gray		Count mode for channel Y. The ceiling and floor values for
62ea2b23b8SWilliam Breathitt Gray		Count Y are used by the count mode where required. The following
63ea2b23b8SWilliam Breathitt Gray		count modes are available:
64ea2b23b8SWilliam Breathitt Gray
65ea2b23b8SWilliam Breathitt Gray		normal:
66ea2b23b8SWilliam Breathitt Gray			Counting is continuous in either direction.
67ea2b23b8SWilliam Breathitt Gray
68ea2b23b8SWilliam Breathitt Gray		range limit:
69ea2b23b8SWilliam Breathitt Gray			An upper or lower limit is set, mimicking limit switches
70ea2b23b8SWilliam Breathitt Gray			in the mechanical counterpart. The upper limit is set to
71ea2b23b8SWilliam Breathitt Gray			the Count Y ceiling value, while the lower limit is set
72ea2b23b8SWilliam Breathitt Gray			to the Count Y floor value. The counter freezes at
73ea2b23b8SWilliam Breathitt Gray			count = ceiling when counting up, and at count = floor
74ea2b23b8SWilliam Breathitt Gray			when counting down. At either of these limits, the
75ea2b23b8SWilliam Breathitt Gray			counting is resumed only when the count direction is
76ea2b23b8SWilliam Breathitt Gray			reversed.
77ea2b23b8SWilliam Breathitt Gray
78ea2b23b8SWilliam Breathitt Gray		non-recycle:
79ea2b23b8SWilliam Breathitt Gray			The counter is disabled whenever a counter overflow or
80ea2b23b8SWilliam Breathitt Gray			underflow takes place. The counter is re-enabled when a
81ea2b23b8SWilliam Breathitt Gray			new count value is loaded to the counter via a preset
82ea2b23b8SWilliam Breathitt Gray			operation or direct write.
83ea2b23b8SWilliam Breathitt Gray
84ea2b23b8SWilliam Breathitt Gray		modulo-n:
85ea2b23b8SWilliam Breathitt Gray			A count value boundary is set between the Count Y floor
86ea2b23b8SWilliam Breathitt Gray			value and the Count Y ceiling value. The counter is
87ea2b23b8SWilliam Breathitt Gray			reset to the Count Y floor value at count = ceiling when
88ea2b23b8SWilliam Breathitt Gray			counting up, while the counter is set to the Count Y
89ea2b23b8SWilliam Breathitt Gray			ceiling value at count = floor when counting down; the
90ea2b23b8SWilliam Breathitt Gray			counter does not freeze at the boundary points, but
91ea2b23b8SWilliam Breathitt Gray			counts continuously throughout.
92ea2b23b8SWilliam Breathitt Gray
93*d4284874SWilliam Breathitt Gray		interrupt on terminal count:
94*d4284874SWilliam Breathitt Gray			The output signal is initially low, and will remain low
95*d4284874SWilliam Breathitt Gray			until the counter reaches zero. The output signal then
96*d4284874SWilliam Breathitt Gray			goes high and remains high until a new preset value is
97*d4284874SWilliam Breathitt Gray			set.
98*d4284874SWilliam Breathitt Gray
99*d4284874SWilliam Breathitt Gray		hardware retriggerable one-shot:
100*d4284874SWilliam Breathitt Gray			The output signal is initially high. The output signal
101*d4284874SWilliam Breathitt Gray			will go low by a trigger input signal, and will remain
102*d4284874SWilliam Breathitt Gray			low until the counter reaches zero. The output will then
103*d4284874SWilliam Breathitt Gray			go high and remain high until the next trigger. A
104*d4284874SWilliam Breathitt Gray			trigger results in loading the counter to the preset
105*d4284874SWilliam Breathitt Gray			value and setting the output signal low, thus starting
106*d4284874SWilliam Breathitt Gray			the one-shot pulse.
107*d4284874SWilliam Breathitt Gray
108*d4284874SWilliam Breathitt Gray		rate generator:
109*d4284874SWilliam Breathitt Gray			The output signal is initially high. When the counter
110*d4284874SWilliam Breathitt Gray			has decremented to 1, the output signal goes low for one
111*d4284874SWilliam Breathitt Gray			clock pulse. The output signal then goes high again, the
112*d4284874SWilliam Breathitt Gray			counter is reloaded to the preset value, and the process
113*d4284874SWilliam Breathitt Gray			repeats in a periodic manner as such.
114*d4284874SWilliam Breathitt Gray
115*d4284874SWilliam Breathitt Gray		square wave mode:
116*d4284874SWilliam Breathitt Gray			The output signal is initially high.
117*d4284874SWilliam Breathitt Gray
118*d4284874SWilliam Breathitt Gray			If the initial count is even, the counter is decremented
119*d4284874SWilliam Breathitt Gray			by two on succeeding clock pulses. When the count
120*d4284874SWilliam Breathitt Gray			expires, the output signal changes value and the
121*d4284874SWilliam Breathitt Gray			counter is reloaded to the preset value. The process
122*d4284874SWilliam Breathitt Gray			repeats in periodic manner as such.
123*d4284874SWilliam Breathitt Gray
124*d4284874SWilliam Breathitt Gray			If the initial count is odd, the initial count minus one
125*d4284874SWilliam Breathitt Gray			(an even number) is loaded and then is decremented by
126*d4284874SWilliam Breathitt Gray			two on succeeding clock pulses. One clock pulse after
127*d4284874SWilliam Breathitt Gray			the count expires, the output signal goes low and the
128*d4284874SWilliam Breathitt Gray			counter is reloaded to the preset value minus one.
129*d4284874SWilliam Breathitt Gray			Succeeding clock pulses decrement the count by two. When
130*d4284874SWilliam Breathitt Gray			the count expires, the output goes high again and the
131*d4284874SWilliam Breathitt Gray			counter is reloaded to the preset value minus one. The
132*d4284874SWilliam Breathitt Gray			process repeats in a periodic manner as such.
133*d4284874SWilliam Breathitt Gray
134*d4284874SWilliam Breathitt Gray		software triggered strobe:
135*d4284874SWilliam Breathitt Gray			The output signal is initially high. When the count
136*d4284874SWilliam Breathitt Gray			expires, the output will go low for one clock pulse and
137*d4284874SWilliam Breathitt Gray			then go high again. The counting sequence is "triggered"
138*d4284874SWilliam Breathitt Gray			by setting the preset value.
139*d4284874SWilliam Breathitt Gray
140*d4284874SWilliam Breathitt Gray		hardware triggered strobe:
141*d4284874SWilliam Breathitt Gray			The output signal is initially high. Counting is started
142*d4284874SWilliam Breathitt Gray			by a trigger input signal. When the count expires, the
143*d4284874SWilliam Breathitt Gray			output signal will go low for one clock pulse and then
144*d4284874SWilliam Breathitt Gray			go high again. A trigger results in loading the counter
145*d4284874SWilliam Breathitt Gray			to the preset value.
146*d4284874SWilliam Breathitt Gray
147ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/count_mode_available
148ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/error_noise_available
149ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/function_available
150769841c9SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/prescaler_available
151ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/signalZ_action_available
152ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
153ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
154ea2b23b8SWilliam Breathitt GrayDescription:
155ea2b23b8SWilliam Breathitt Gray		Discrete set of available values for the respective Count Y
156ea2b23b8SWilliam Breathitt Gray		configuration are listed in this file. Values are delimited by
157ea2b23b8SWilliam Breathitt Gray		newline characters.
158ea2b23b8SWilliam Breathitt Gray
159ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/direction
160ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
161ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
162ea2b23b8SWilliam Breathitt GrayDescription:
163ea2b23b8SWilliam Breathitt Gray		Read-only attribute that indicates the count direction of Count
164ea2b23b8SWilliam Breathitt Gray		Y. Two count directions are available: forward and backward.
165ea2b23b8SWilliam Breathitt Gray
166ea2b23b8SWilliam Breathitt Gray		Some counter devices are able to determine the direction of
167ea2b23b8SWilliam Breathitt Gray		their counting. For example, quadrature encoding counters can
168ea2b23b8SWilliam Breathitt Gray		determine the direction of movement by evaluating the leading
169ea2b23b8SWilliam Breathitt Gray		phase of the respective A and B quadrature encoding signals.
170ea2b23b8SWilliam Breathitt Gray		This attribute exposes such count directions.
171ea2b23b8SWilliam Breathitt Gray
172ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/enable
173ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
174ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
175ea2b23b8SWilliam Breathitt GrayDescription:
176ea2b23b8SWilliam Breathitt Gray		Whether channel Y counter is enabled. Valid attribute values are
177ea2b23b8SWilliam Breathitt Gray		boolean.
178ea2b23b8SWilliam Breathitt Gray
179ea2b23b8SWilliam Breathitt Gray		This attribute is intended to serve as a pause/unpause mechanism
180ea2b23b8SWilliam Breathitt Gray		for Count Y. Suppose a counter device is used to count the total
181ea2b23b8SWilliam Breathitt Gray		movement of a conveyor belt: this attribute allows an operator
182ea2b23b8SWilliam Breathitt Gray		to temporarily pause the counter, service the conveyor belt,
183ea2b23b8SWilliam Breathitt Gray		and then finally unpause the counter to continue where it had
184ea2b23b8SWilliam Breathitt Gray		left off.
185ea2b23b8SWilliam Breathitt Gray
186ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/error_noise
187ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
188ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
189ea2b23b8SWilliam Breathitt GrayDescription:
190ea2b23b8SWilliam Breathitt Gray		Read-only attribute that indicates whether excessive noise is
191ea2b23b8SWilliam Breathitt Gray		present at the channel Y counter inputs.
192ea2b23b8SWilliam Breathitt Gray
193ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/function
194ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
195ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
196ea2b23b8SWilliam Breathitt GrayDescription:
197ea2b23b8SWilliam Breathitt Gray		Count function mode of Count Y; count function evaluation is
198ea2b23b8SWilliam Breathitt Gray		triggered by conditions specified by the Count Y signalZ_action
199ea2b23b8SWilliam Breathitt Gray		attributes. The following count functions are available:
200ea2b23b8SWilliam Breathitt Gray
201ea2b23b8SWilliam Breathitt Gray		increase:
202ea2b23b8SWilliam Breathitt Gray			Accumulated count is incremented.
203ea2b23b8SWilliam Breathitt Gray
204ea2b23b8SWilliam Breathitt Gray		decrease:
205ea2b23b8SWilliam Breathitt Gray			Accumulated count is decremented.
206ea2b23b8SWilliam Breathitt Gray
207ea2b23b8SWilliam Breathitt Gray		pulse-direction:
208ea2b23b8SWilliam Breathitt Gray			Rising edges on signal A updates the respective count.
209ea2b23b8SWilliam Breathitt Gray			The input level of signal B determines direction.
210ea2b23b8SWilliam Breathitt Gray
211ea2b23b8SWilliam Breathitt Gray		quadrature x1 a:
212ea2b23b8SWilliam Breathitt Gray			If direction is forward, rising edges on quadrature pair
213ea2b23b8SWilliam Breathitt Gray			signal A updates the respective count; if the direction
214ea2b23b8SWilliam Breathitt Gray			is backward, falling edges on quadrature pair signal A
215ea2b23b8SWilliam Breathitt Gray			updates the respective count. Quadrature encoding
216ea2b23b8SWilliam Breathitt Gray			determines the direction.
217ea2b23b8SWilliam Breathitt Gray
218ea2b23b8SWilliam Breathitt Gray		quadrature x1 b:
219ea2b23b8SWilliam Breathitt Gray			If direction is forward, rising edges on quadrature pair
220ea2b23b8SWilliam Breathitt Gray			signal B updates the respective count; if the direction
221ea2b23b8SWilliam Breathitt Gray			is backward, falling edges on quadrature pair signal B
222ea2b23b8SWilliam Breathitt Gray			updates the respective count. Quadrature encoding
223ea2b23b8SWilliam Breathitt Gray			determines the direction.
224ea2b23b8SWilliam Breathitt Gray
225ea2b23b8SWilliam Breathitt Gray		quadrature x2 a:
226ea2b23b8SWilliam Breathitt Gray			Any state transition on quadrature pair signal A updates
227ea2b23b8SWilliam Breathitt Gray			the respective count. Quadrature encoding determines the
228ea2b23b8SWilliam Breathitt Gray			direction.
229ea2b23b8SWilliam Breathitt Gray
230ea2b23b8SWilliam Breathitt Gray		quadrature x2 b:
231ea2b23b8SWilliam Breathitt Gray			Any state transition on quadrature pair signal B updates
232ea2b23b8SWilliam Breathitt Gray			the respective count. Quadrature encoding determines the
233ea2b23b8SWilliam Breathitt Gray			direction.
234ea2b23b8SWilliam Breathitt Gray
235ea2b23b8SWilliam Breathitt Gray		quadrature x4:
236ea2b23b8SWilliam Breathitt Gray			Any state transition on either quadrature pair signals
237ea2b23b8SWilliam Breathitt Gray			updates	the respective count. Quadrature encoding
238ea2b23b8SWilliam Breathitt Gray			determines the direction.
239ea2b23b8SWilliam Breathitt Gray
240ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/name
241ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
242ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
243ea2b23b8SWilliam Breathitt GrayDescription:
244ea2b23b8SWilliam Breathitt Gray		Read-only attribute that indicates the device-specific name of
245ea2b23b8SWilliam Breathitt Gray		Count Y. If possible, this should match the name of the
246ea2b23b8SWilliam Breathitt Gray		respective channel as it appears in the device datasheet.
247ea2b23b8SWilliam Breathitt Gray
248769841c9SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/prescaler
249769841c9SWilliam Breathitt GrayKernelVersion:	5.2
250769841c9SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
251769841c9SWilliam Breathitt GrayDescription:
252769841c9SWilliam Breathitt Gray		Configure the prescaler value associated with Count Y.
253769841c9SWilliam Breathitt Gray		On the FlexTimer, the counter clock source passes through a
254769841c9SWilliam Breathitt Gray		prescaler (i.e. a counter). This acts like a clock
255769841c9SWilliam Breathitt Gray		divider.
256769841c9SWilliam Breathitt Gray
257ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/preset
258ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
259ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
260ea2b23b8SWilliam Breathitt GrayDescription:
261ea2b23b8SWilliam Breathitt Gray		If the counter device supports preset registers -- registers
262ea2b23b8SWilliam Breathitt Gray		used to load counter channels to a set count upon device-defined
263ea2b23b8SWilliam Breathitt Gray		preset operation trigger events -- the preset count for channel
264ea2b23b8SWilliam Breathitt Gray		Y is provided by this attribute.
265ea2b23b8SWilliam Breathitt Gray
266ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/preset_enable
267ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
268ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
269ea2b23b8SWilliam Breathitt GrayDescription:
270ea2b23b8SWilliam Breathitt Gray		Whether channel Y counter preset operation is enabled. Valid
271ea2b23b8SWilliam Breathitt Gray		attribute values are boolean.
272ea2b23b8SWilliam Breathitt Gray
273ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/signalZ_action
274ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
275ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
276ea2b23b8SWilliam Breathitt GrayDescription:
277ea2b23b8SWilliam Breathitt Gray		Action mode of Count Y for Signal Z. This attribute indicates
278ea2b23b8SWilliam Breathitt Gray		the condition of Signal Z that triggers the count function
279ea2b23b8SWilliam Breathitt Gray		evaluation for Count Y. The following action modes are
280ea2b23b8SWilliam Breathitt Gray		available:
281ea2b23b8SWilliam Breathitt Gray
282ea2b23b8SWilliam Breathitt Gray		none:
283ea2b23b8SWilliam Breathitt Gray			Signal does not trigger the count function. In
284ea2b23b8SWilliam Breathitt Gray			Pulse-Direction count function mode, this Signal is
285ea2b23b8SWilliam Breathitt Gray			evaluated as Direction.
286ea2b23b8SWilliam Breathitt Gray
287ea2b23b8SWilliam Breathitt Gray		rising edge:
288ea2b23b8SWilliam Breathitt Gray			Low state transitions to high state.
289ea2b23b8SWilliam Breathitt Gray
290ea2b23b8SWilliam Breathitt Gray		falling edge:
291ea2b23b8SWilliam Breathitt Gray			High state transitions to low state.
292ea2b23b8SWilliam Breathitt Gray
293ea2b23b8SWilliam Breathitt Gray		both edges:
294ea2b23b8SWilliam Breathitt Gray			Any state transition.
295ea2b23b8SWilliam Breathitt Gray
2965a47aed0SJulien PanisWhat:		/sys/bus/counter/devices/counterX/countY/num_overflows
2975a47aed0SJulien PanisKernelVersion:	6.1
2985a47aed0SJulien PanisContact:	linux-iio@vger.kernel.org
2995a47aed0SJulien PanisDescription:
3005a47aed0SJulien Panis		This attribute indicates the number of overflows of count Y.
3015a47aed0SJulien Panis
3027bb985acSBiju DasWhat:		/sys/bus/counter/devices/counterX/cascade_counts_enable_component_id
3037bb985acSBiju DasWhat:		/sys/bus/counter/devices/counterX/external_input_phase_clock_select_component_id
30445d29185SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/capture_component_id
3054bdec61dSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/ceiling_component_id
3064bdec61dSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/floor_component_id
3074bdec61dSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/count_mode_component_id
3084bdec61dSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/direction_component_id
3094bdec61dSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/enable_component_id
3104bdec61dSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/error_noise_component_id
3114bdec61dSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/prescaler_component_id
3124bdec61dSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/preset_component_id
3134bdec61dSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/preset_enable_component_id
314bb6264a6SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/signalZ_action_component_id
3155a47aed0SJulien PanisWhat:		/sys/bus/counter/devices/counterX/countY/num_overflows_component_id
3164bdec61dSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/cable_fault_component_id
3174bdec61dSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/cable_fault_enable_component_id
3184bdec61dSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/filter_clock_prescaler_component_id
3194bdec61dSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/index_polarity_component_id
320650ae67bSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/polarity_component_id
3214bdec61dSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/synchronous_mode_component_id
3225a47aed0SJulien PanisWhat:		/sys/bus/counter/devices/counterX/signalY/frequency_component_id
323bb6264a6SWilliam Breathitt GrayKernelVersion:	5.16
324bb6264a6SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
325bb6264a6SWilliam Breathitt GrayDescription:
326bb6264a6SWilliam Breathitt Gray		Read-only attribute that indicates the component ID of the
3274bdec61dSWilliam Breathitt Gray		respective extension or Synapse.
328bb6264a6SWilliam Breathitt Gray
329b711f687SJarkko NikulaWhat:		/sys/bus/counter/devices/counterX/countY/spike_filter_ns
330b711f687SJarkko NikulaKernelVersion:	5.14
331b711f687SJarkko NikulaContact:	linux-iio@vger.kernel.org
332b711f687SJarkko NikulaDescription:
333b711f687SJarkko Nikula		If the counter device supports programmable spike filter this
334b711f687SJarkko Nikula		attribute indicates the value in nanoseconds where noise pulses
335b711f687SJarkko Nikula		shorter or equal to configured value are ignored. Value 0 means
336b711f687SJarkko Nikula		filter is disabled.
337b711f687SJarkko Nikula
338feff17a5SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/events_queue_size
339feff17a5SWilliam Breathitt GrayKernelVersion:	5.16
340feff17a5SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
341feff17a5SWilliam Breathitt GrayDescription:
342feff17a5SWilliam Breathitt Gray		Size of the Counter events queue in number of struct
343feff17a5SWilliam Breathitt Gray		counter_event data structures. The number of elements will be
344feff17a5SWilliam Breathitt Gray		rounded-up to a power of 2.
345feff17a5SWilliam Breathitt Gray
346ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/name
347ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
348ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
349ea2b23b8SWilliam Breathitt GrayDescription:
350ea2b23b8SWilliam Breathitt Gray		Read-only attribute that indicates the device-specific name of
351ea2b23b8SWilliam Breathitt Gray		the Counter. This should match the name of the device as it
352ea2b23b8SWilliam Breathitt Gray		appears in its respective datasheet.
353ea2b23b8SWilliam Breathitt Gray
354ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/num_counts
355ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
356ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
357ea2b23b8SWilliam Breathitt GrayDescription:
358ea2b23b8SWilliam Breathitt Gray		Read-only attribute that indicates the total number of Counts
359ea2b23b8SWilliam Breathitt Gray		belonging to the Counter.
360ea2b23b8SWilliam Breathitt Gray
361ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/num_signals
362ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
363ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
364ea2b23b8SWilliam Breathitt GrayDescription:
365ea2b23b8SWilliam Breathitt Gray		Read-only attribute that indicates the total number of Signals
366ea2b23b8SWilliam Breathitt Gray		belonging to the Counter.
367ea2b23b8SWilliam Breathitt Gray
368769841c9SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/cable_fault
369769841c9SWilliam Breathitt GrayKernelVersion:	5.7
370769841c9SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
371769841c9SWilliam Breathitt GrayDescription:
372769841c9SWilliam Breathitt Gray		Read-only attribute that indicates whether a differential
373769841c9SWilliam Breathitt Gray		encoder cable fault (not connected or loose wires) is detected
374769841c9SWilliam Breathitt Gray		for the respective channel of Signal Y. Valid attribute values
375769841c9SWilliam Breathitt Gray		are boolean. Detection must first be enabled via the
376769841c9SWilliam Breathitt Gray		corresponding cable_fault_enable attribute.
377769841c9SWilliam Breathitt Gray
378769841c9SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/cable_fault_enable
379769841c9SWilliam Breathitt GrayKernelVersion:	5.7
380769841c9SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
381769841c9SWilliam Breathitt GrayDescription:
382769841c9SWilliam Breathitt Gray		Whether detection of differential encoder cable faults for the
383769841c9SWilliam Breathitt Gray		respective channel of Signal Y is enabled. Valid attribute
384769841c9SWilliam Breathitt Gray		values are boolean.
385769841c9SWilliam Breathitt Gray
386769841c9SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/filter_clock_prescaler
387769841c9SWilliam Breathitt GrayKernelVersion:	5.7
388769841c9SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
389769841c9SWilliam Breathitt GrayDescription:
390769841c9SWilliam Breathitt Gray		Filter clock factor for input Signal Y. This prescaler value
391769841c9SWilliam Breathitt Gray		affects the inputs of both quadrature pair signals.
392769841c9SWilliam Breathitt Gray
393769841c9SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/index_polarity
394ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
395ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
396ea2b23b8SWilliam Breathitt GrayDescription:
397769841c9SWilliam Breathitt Gray		Active level of index input Signal Y; irrelevant in
398769841c9SWilliam Breathitt Gray		non-synchronous load mode.
399769841c9SWilliam Breathitt Gray
400769841c9SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/index_polarity_available
401769841c9SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/synchronous_mode_available
402769841c9SWilliam Breathitt GrayKernelVersion:	5.2
403769841c9SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
404769841c9SWilliam Breathitt GrayDescription:
405769841c9SWilliam Breathitt Gray		Discrete set of available values for the respective Signal Y
406769841c9SWilliam Breathitt Gray		configuration are listed in this file.
407ea2b23b8SWilliam Breathitt Gray
408650ae67bSWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/polarity
409650ae67bSWilliam Breathitt GrayKernelVersion:	6.1
410650ae67bSWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
411650ae67bSWilliam Breathitt GrayDescription:
412650ae67bSWilliam Breathitt Gray		Active level of Signal Y. The following polarity values are
413650ae67bSWilliam Breathitt Gray		available:
414650ae67bSWilliam Breathitt Gray
415650ae67bSWilliam Breathitt Gray		positive:
416650ae67bSWilliam Breathitt Gray			Signal high state considered active level (rising edge).
417650ae67bSWilliam Breathitt Gray
418650ae67bSWilliam Breathitt Gray		negative:
419650ae67bSWilliam Breathitt Gray			Signal low state considered active level (falling edge).
420650ae67bSWilliam Breathitt Gray
421ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/name
422ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
423ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
424ea2b23b8SWilliam Breathitt GrayDescription:
425ea2b23b8SWilliam Breathitt Gray		Read-only attribute that indicates the device-specific name of
426ea2b23b8SWilliam Breathitt Gray		Signal Y. If possible, this should match the name of the
427ea2b23b8SWilliam Breathitt Gray		respective signal as it appears in the device datasheet.
428769841c9SWilliam Breathitt Gray
429769841c9SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/signal
430769841c9SWilliam Breathitt GrayKernelVersion:	5.2
431769841c9SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
432769841c9SWilliam Breathitt GrayDescription:
433de8daf30SWilliam Breathitt Gray		Signal level state of Signal Y. The following signal level
434de8daf30SWilliam Breathitt Gray		states are available:
435de8daf30SWilliam Breathitt Gray
436de8daf30SWilliam Breathitt Gray		low:
437de8daf30SWilliam Breathitt Gray			Low level state.
438de8daf30SWilliam Breathitt Gray
439de8daf30SWilliam Breathitt Gray		high:
440de8daf30SWilliam Breathitt Gray			High level state.
441769841c9SWilliam Breathitt Gray
442769841c9SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/synchronous_mode
443769841c9SWilliam Breathitt GrayKernelVersion:	5.2
444769841c9SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
445769841c9SWilliam Breathitt GrayDescription:
446769841c9SWilliam Breathitt Gray		Configure the counter associated with Signal Y for
447769841c9SWilliam Breathitt Gray		non-synchronous or synchronous load mode. Synchronous load mode
448769841c9SWilliam Breathitt Gray		cannot be selected in non-quadrature (Pulse-Direction) clock
449769841c9SWilliam Breathitt Gray		mode.
450769841c9SWilliam Breathitt Gray
451769841c9SWilliam Breathitt Gray		non-synchronous:
452769841c9SWilliam Breathitt Gray			A logic low level is the active level at this index
453769841c9SWilliam Breathitt Gray			input. The index function (as enabled via preset_enable)
454769841c9SWilliam Breathitt Gray			is performed directly on the active level of the index
455769841c9SWilliam Breathitt Gray			input.
456769841c9SWilliam Breathitt Gray
457769841c9SWilliam Breathitt Gray		synchronous:
458769841c9SWilliam Breathitt Gray			Intended for interfacing with encoder Index output in
459769841c9SWilliam Breathitt Gray			quadrature clock mode. The active level is configured
460769841c9SWilliam Breathitt Gray			via index_polarity. The index function (as enabled via
461769841c9SWilliam Breathitt Gray			preset_enable) is performed synchronously with the
462769841c9SWilliam Breathitt Gray			quadrature clock on the active level of the index input.
4635a47aed0SJulien Panis
4645a47aed0SJulien PanisWhat:		/sys/bus/counter/devices/counterX/signalY/frequency
4655a47aed0SJulien PanisKernelVersion:	6.1
4665a47aed0SJulien PanisContact:	linux-iio@vger.kernel.org
4675a47aed0SJulien PanisDescription:
4685a47aed0SJulien Panis		Read-only attribute that indicates the signal Y frequency, in Hz.
469