xref: /linux/Documentation/ABI/testing/sysfs-bus-counter (revision b711f687a1c1c14c2da589e84e4f61b975196951)
1ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/count
2ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
3ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
4ea2b23b8SWilliam Breathitt GrayDescription:
5ea2b23b8SWilliam Breathitt Gray		Count data of Count Y represented as a string.
6ea2b23b8SWilliam Breathitt Gray
7ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/ceiling
8ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
9ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
10ea2b23b8SWilliam Breathitt GrayDescription:
11ea2b23b8SWilliam Breathitt Gray		Count value ceiling for Count Y. This is the upper limit for the
12ea2b23b8SWilliam Breathitt Gray		respective counter.
13ea2b23b8SWilliam Breathitt Gray
14ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/floor
15ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
16ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
17ea2b23b8SWilliam Breathitt GrayDescription:
18ea2b23b8SWilliam Breathitt Gray		Count value floor for Count Y. This is the lower limit for the
19ea2b23b8SWilliam Breathitt Gray		respective counter.
20ea2b23b8SWilliam Breathitt Gray
21ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/count_mode
22ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
23ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
24ea2b23b8SWilliam Breathitt GrayDescription:
25ea2b23b8SWilliam Breathitt Gray		Count mode for channel Y. The ceiling and floor values for
26ea2b23b8SWilliam Breathitt Gray		Count Y are used by the count mode where required. The following
27ea2b23b8SWilliam Breathitt Gray		count modes are available:
28ea2b23b8SWilliam Breathitt Gray
29ea2b23b8SWilliam Breathitt Gray		normal:
30ea2b23b8SWilliam Breathitt Gray			Counting is continuous in either direction.
31ea2b23b8SWilliam Breathitt Gray
32ea2b23b8SWilliam Breathitt Gray		range limit:
33ea2b23b8SWilliam Breathitt Gray			An upper or lower limit is set, mimicking limit switches
34ea2b23b8SWilliam Breathitt Gray			in the mechanical counterpart. The upper limit is set to
35ea2b23b8SWilliam Breathitt Gray			the Count Y ceiling value, while the lower limit is set
36ea2b23b8SWilliam Breathitt Gray			to the Count Y floor value. The counter freezes at
37ea2b23b8SWilliam Breathitt Gray			count = ceiling when counting up, and at count = floor
38ea2b23b8SWilliam Breathitt Gray			when counting down. At either of these limits, the
39ea2b23b8SWilliam Breathitt Gray			counting is resumed only when the count direction is
40ea2b23b8SWilliam Breathitt Gray			reversed.
41ea2b23b8SWilliam Breathitt Gray
42ea2b23b8SWilliam Breathitt Gray		non-recycle:
43ea2b23b8SWilliam Breathitt Gray			The counter is disabled whenever a counter overflow or
44ea2b23b8SWilliam Breathitt Gray			underflow takes place. The counter is re-enabled when a
45ea2b23b8SWilliam Breathitt Gray			new count value is loaded to the counter via a preset
46ea2b23b8SWilliam Breathitt Gray			operation or direct write.
47ea2b23b8SWilliam Breathitt Gray
48ea2b23b8SWilliam Breathitt Gray		modulo-n:
49ea2b23b8SWilliam Breathitt Gray			A count value boundary is set between the Count Y floor
50ea2b23b8SWilliam Breathitt Gray			value and the Count Y ceiling value. The counter is
51ea2b23b8SWilliam Breathitt Gray			reset to the Count Y floor value at count = ceiling when
52ea2b23b8SWilliam Breathitt Gray			counting up, while the counter is set to the Count Y
53ea2b23b8SWilliam Breathitt Gray			ceiling value at count = floor when counting down; the
54ea2b23b8SWilliam Breathitt Gray			counter does not freeze at the boundary points, but
55ea2b23b8SWilliam Breathitt Gray			counts continuously throughout.
56ea2b23b8SWilliam Breathitt Gray
57ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/count_mode_available
58ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/error_noise_available
59ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/function_available
60ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/signalZ_action_available
61ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
62ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
63ea2b23b8SWilliam Breathitt GrayDescription:
64ea2b23b8SWilliam Breathitt Gray		Discrete set of available values for the respective Count Y
65ea2b23b8SWilliam Breathitt Gray		configuration are listed in this file. Values are delimited by
66ea2b23b8SWilliam Breathitt Gray		newline characters.
67ea2b23b8SWilliam Breathitt Gray
68ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/direction
69ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
70ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
71ea2b23b8SWilliam Breathitt GrayDescription:
72ea2b23b8SWilliam Breathitt Gray		Read-only attribute that indicates the count direction of Count
73ea2b23b8SWilliam Breathitt Gray		Y. Two count directions are available: forward and backward.
74ea2b23b8SWilliam Breathitt Gray
75ea2b23b8SWilliam Breathitt Gray		Some counter devices are able to determine the direction of
76ea2b23b8SWilliam Breathitt Gray		their counting. For example, quadrature encoding counters can
77ea2b23b8SWilliam Breathitt Gray		determine the direction of movement by evaluating the leading
78ea2b23b8SWilliam Breathitt Gray		phase of the respective A and B quadrature encoding signals.
79ea2b23b8SWilliam Breathitt Gray		This attribute exposes such count directions.
80ea2b23b8SWilliam Breathitt Gray
81ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/enable
82ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
83ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
84ea2b23b8SWilliam Breathitt GrayDescription:
85ea2b23b8SWilliam Breathitt Gray		Whether channel Y counter is enabled. Valid attribute values are
86ea2b23b8SWilliam Breathitt Gray		boolean.
87ea2b23b8SWilliam Breathitt Gray
88ea2b23b8SWilliam Breathitt Gray		This attribute is intended to serve as a pause/unpause mechanism
89ea2b23b8SWilliam Breathitt Gray		for Count Y. Suppose a counter device is used to count the total
90ea2b23b8SWilliam Breathitt Gray		movement of a conveyor belt: this attribute allows an operator
91ea2b23b8SWilliam Breathitt Gray		to temporarily pause the counter, service the conveyor belt,
92ea2b23b8SWilliam Breathitt Gray		and then finally unpause the counter to continue where it had
93ea2b23b8SWilliam Breathitt Gray		left off.
94ea2b23b8SWilliam Breathitt Gray
95ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/error_noise
96ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
97ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
98ea2b23b8SWilliam Breathitt GrayDescription:
99ea2b23b8SWilliam Breathitt Gray		Read-only attribute that indicates whether excessive noise is
100ea2b23b8SWilliam Breathitt Gray		present at the channel Y counter inputs.
101ea2b23b8SWilliam Breathitt Gray
102ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/function
103ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
104ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
105ea2b23b8SWilliam Breathitt GrayDescription:
106ea2b23b8SWilliam Breathitt Gray		Count function mode of Count Y; count function evaluation is
107ea2b23b8SWilliam Breathitt Gray		triggered by conditions specified by the Count Y signalZ_action
108ea2b23b8SWilliam Breathitt Gray		attributes. The following count functions are available:
109ea2b23b8SWilliam Breathitt Gray
110ea2b23b8SWilliam Breathitt Gray		increase:
111ea2b23b8SWilliam Breathitt Gray			Accumulated count is incremented.
112ea2b23b8SWilliam Breathitt Gray
113ea2b23b8SWilliam Breathitt Gray		decrease:
114ea2b23b8SWilliam Breathitt Gray			Accumulated count is decremented.
115ea2b23b8SWilliam Breathitt Gray
116ea2b23b8SWilliam Breathitt Gray		pulse-direction:
117ea2b23b8SWilliam Breathitt Gray			Rising edges on signal A updates the respective count.
118ea2b23b8SWilliam Breathitt Gray			The input level of signal B determines direction.
119ea2b23b8SWilliam Breathitt Gray
120ea2b23b8SWilliam Breathitt Gray		quadrature x1 a:
121ea2b23b8SWilliam Breathitt Gray			If direction is forward, rising edges on quadrature pair
122ea2b23b8SWilliam Breathitt Gray			signal A updates the respective count; if the direction
123ea2b23b8SWilliam Breathitt Gray			is backward, falling edges on quadrature pair signal A
124ea2b23b8SWilliam Breathitt Gray			updates the respective count. Quadrature encoding
125ea2b23b8SWilliam Breathitt Gray			determines the direction.
126ea2b23b8SWilliam Breathitt Gray
127ea2b23b8SWilliam Breathitt Gray		quadrature x1 b:
128ea2b23b8SWilliam Breathitt Gray			If direction is forward, rising edges on quadrature pair
129ea2b23b8SWilliam Breathitt Gray			signal B updates the respective count; if the direction
130ea2b23b8SWilliam Breathitt Gray			is backward, falling edges on quadrature pair signal B
131ea2b23b8SWilliam Breathitt Gray			updates the respective count. Quadrature encoding
132ea2b23b8SWilliam Breathitt Gray			determines the direction.
133ea2b23b8SWilliam Breathitt Gray
134ea2b23b8SWilliam Breathitt Gray		quadrature x2 a:
135ea2b23b8SWilliam Breathitt Gray			Any state transition on quadrature pair signal A updates
136ea2b23b8SWilliam Breathitt Gray			the respective count. Quadrature encoding determines the
137ea2b23b8SWilliam Breathitt Gray			direction.
138ea2b23b8SWilliam Breathitt Gray
139ea2b23b8SWilliam Breathitt Gray		quadrature x2 b:
140ea2b23b8SWilliam Breathitt Gray			Any state transition on quadrature pair signal B updates
141ea2b23b8SWilliam Breathitt Gray			the respective count. Quadrature encoding determines the
142ea2b23b8SWilliam Breathitt Gray			direction.
143ea2b23b8SWilliam Breathitt Gray
144ea2b23b8SWilliam Breathitt Gray		quadrature x4:
145ea2b23b8SWilliam Breathitt Gray			Any state transition on either quadrature pair signals
146ea2b23b8SWilliam Breathitt Gray			updates	the respective count. Quadrature encoding
147ea2b23b8SWilliam Breathitt Gray			determines the direction.
148ea2b23b8SWilliam Breathitt Gray
149ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/name
150ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
151ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
152ea2b23b8SWilliam Breathitt GrayDescription:
153ea2b23b8SWilliam Breathitt Gray		Read-only attribute that indicates the device-specific name of
154ea2b23b8SWilliam Breathitt Gray		Count Y. If possible, this should match the name of the
155ea2b23b8SWilliam Breathitt Gray		respective channel as it appears in the device datasheet.
156ea2b23b8SWilliam Breathitt Gray
157ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/preset
158ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
159ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
160ea2b23b8SWilliam Breathitt GrayDescription:
161ea2b23b8SWilliam Breathitt Gray		If the counter device supports preset registers -- registers
162ea2b23b8SWilliam Breathitt Gray		used to load counter channels to a set count upon device-defined
163ea2b23b8SWilliam Breathitt Gray		preset operation trigger events -- the preset count for channel
164ea2b23b8SWilliam Breathitt Gray		Y is provided by this attribute.
165ea2b23b8SWilliam Breathitt Gray
166ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/preset_enable
167ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
168ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
169ea2b23b8SWilliam Breathitt GrayDescription:
170ea2b23b8SWilliam Breathitt Gray		Whether channel Y counter preset operation is enabled. Valid
171ea2b23b8SWilliam Breathitt Gray		attribute values are boolean.
172ea2b23b8SWilliam Breathitt Gray
173ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/countY/signalZ_action
174ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
175ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
176ea2b23b8SWilliam Breathitt GrayDescription:
177ea2b23b8SWilliam Breathitt Gray		Action mode of Count Y for Signal Z. This attribute indicates
178ea2b23b8SWilliam Breathitt Gray		the condition of Signal Z that triggers the count function
179ea2b23b8SWilliam Breathitt Gray		evaluation for Count Y. The following action modes are
180ea2b23b8SWilliam Breathitt Gray		available:
181ea2b23b8SWilliam Breathitt Gray
182ea2b23b8SWilliam Breathitt Gray		none:
183ea2b23b8SWilliam Breathitt Gray			Signal does not trigger the count function. In
184ea2b23b8SWilliam Breathitt Gray			Pulse-Direction count function mode, this Signal is
185ea2b23b8SWilliam Breathitt Gray			evaluated as Direction.
186ea2b23b8SWilliam Breathitt Gray
187ea2b23b8SWilliam Breathitt Gray		rising edge:
188ea2b23b8SWilliam Breathitt Gray			Low state transitions to high state.
189ea2b23b8SWilliam Breathitt Gray
190ea2b23b8SWilliam Breathitt Gray		falling edge:
191ea2b23b8SWilliam Breathitt Gray			High state transitions to low state.
192ea2b23b8SWilliam Breathitt Gray
193ea2b23b8SWilliam Breathitt Gray		both edges:
194ea2b23b8SWilliam Breathitt Gray			Any state transition.
195ea2b23b8SWilliam Breathitt Gray
196*b711f687SJarkko NikulaWhat:		/sys/bus/counter/devices/counterX/countY/spike_filter_ns
197*b711f687SJarkko NikulaKernelVersion:	5.14
198*b711f687SJarkko NikulaContact:	linux-iio@vger.kernel.org
199*b711f687SJarkko NikulaDescription:
200*b711f687SJarkko Nikula		If the counter device supports programmable spike filter this
201*b711f687SJarkko Nikula		attribute indicates the value in nanoseconds where noise pulses
202*b711f687SJarkko Nikula		shorter or equal to configured value are ignored. Value 0 means
203*b711f687SJarkko Nikula		filter is disabled.
204*b711f687SJarkko Nikula
205ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/name
206ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
207ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
208ea2b23b8SWilliam Breathitt GrayDescription:
209ea2b23b8SWilliam Breathitt Gray		Read-only attribute that indicates the device-specific name of
210ea2b23b8SWilliam Breathitt Gray		the Counter. This should match the name of the device as it
211ea2b23b8SWilliam Breathitt Gray		appears in its respective datasheet.
212ea2b23b8SWilliam Breathitt Gray
213ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/num_counts
214ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
215ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
216ea2b23b8SWilliam Breathitt GrayDescription:
217ea2b23b8SWilliam Breathitt Gray		Read-only attribute that indicates the total number of Counts
218ea2b23b8SWilliam Breathitt Gray		belonging to the Counter.
219ea2b23b8SWilliam Breathitt Gray
220ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/num_signals
221ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
222ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
223ea2b23b8SWilliam Breathitt GrayDescription:
224ea2b23b8SWilliam Breathitt Gray		Read-only attribute that indicates the total number of Signals
225ea2b23b8SWilliam Breathitt Gray		belonging to the Counter.
226ea2b23b8SWilliam Breathitt Gray
227ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/signal
228ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
229ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
230ea2b23b8SWilliam Breathitt GrayDescription:
231ea2b23b8SWilliam Breathitt Gray		Signal data of Signal Y represented as a string.
232ea2b23b8SWilliam Breathitt Gray
233ea2b23b8SWilliam Breathitt GrayWhat:		/sys/bus/counter/devices/counterX/signalY/name
234ea2b23b8SWilliam Breathitt GrayKernelVersion:	5.2
235ea2b23b8SWilliam Breathitt GrayContact:	linux-iio@vger.kernel.org
236ea2b23b8SWilliam Breathitt GrayDescription:
237ea2b23b8SWilliam Breathitt Gray		Read-only attribute that indicates the device-specific name of
238ea2b23b8SWilliam Breathitt Gray		Signal Y. If possible, this should match the name of the
239ea2b23b8SWilliam Breathitt Gray		respective signal as it appears in the device datasheet.
240