xref: /linux/Documentation/ABI/testing/sysfs-bus-iio-timer-stm32 (revision 2a830a45ffb05d1aa8d7866235501f635678bec6)
193fbe91bSBenjamin GaignardWhat:		/sys/bus/iio/devices/triggerX/master_mode_available
293fbe91bSBenjamin GaignardKernelVersion:	4.11
393fbe91bSBenjamin GaignardContact:	benjamin.gaignard@st.com
493fbe91bSBenjamin GaignardDescription:
593fbe91bSBenjamin Gaignard		Reading returns the list possible master modes which are:
64adec7daSBenjamin Gaignard		- "reset"     :	The UG bit from the TIMx_EGR register is
74adec7daSBenjamin Gaignard				used as trigger output (TRGO).
84adec7daSBenjamin Gaignard		- "enable"    : The Counter Enable signal CNT_EN is used
94adec7daSBenjamin Gaignard				as trigger output.
1093fbe91bSBenjamin Gaignard		- "update"    : The update event is selected as trigger output.
114adec7daSBenjamin Gaignard				For instance a master timer can then be used
124adec7daSBenjamin Gaignard				as a prescaler for a slave timer.
134adec7daSBenjamin Gaignard		- "compare_pulse" : The trigger output send a positive pulse
144adec7daSBenjamin Gaignard				    when the CC1IF flag is to be set.
1593fbe91bSBenjamin Gaignard		- "OC1REF"    : OC1REF signal is used as trigger output.
1693fbe91bSBenjamin Gaignard		- "OC2REF"    : OC2REF signal is used as trigger output.
1793fbe91bSBenjamin Gaignard		- "OC3REF"    : OC3REF signal is used as trigger output.
1893fbe91bSBenjamin Gaignard		- "OC4REF"    : OC4REF signal is used as trigger output.
1993fbe91bSBenjamin Gaignard
2093fbe91bSBenjamin GaignardWhat:		/sys/bus/iio/devices/triggerX/master_mode
2193fbe91bSBenjamin GaignardKernelVersion:	4.11
2293fbe91bSBenjamin GaignardContact:	benjamin.gaignard@st.com
2393fbe91bSBenjamin GaignardDescription:
2493fbe91bSBenjamin Gaignard		Reading returns the current master modes.
2593fbe91bSBenjamin Gaignard		Writing set the master mode
2693fbe91bSBenjamin Gaignard
2793fbe91bSBenjamin GaignardWhat:		/sys/bus/iio/devices/triggerX/sampling_frequency
2893fbe91bSBenjamin GaignardKernelVersion:	4.11
2993fbe91bSBenjamin GaignardContact:	benjamin.gaignard@st.com
3093fbe91bSBenjamin GaignardDescription:
3193fbe91bSBenjamin Gaignard		Reading returns the current sampling frequency.
3293fbe91bSBenjamin Gaignard		Writing an value different of 0 set and start sampling.
3393fbe91bSBenjamin Gaignard		Writing 0 stop sampling.
344adec7daSBenjamin Gaignard
354adec7daSBenjamin GaignardWhat:		/sys/bus/iio/devices/iio:deviceX/in_count0_preset
364adec7daSBenjamin GaignardKernelVersion:	4.12
374adec7daSBenjamin GaignardContact:	benjamin.gaignard@st.com
384adec7daSBenjamin GaignardDescription:
394adec7daSBenjamin Gaignard		Reading returns the current preset value.
404adec7daSBenjamin Gaignard		Writing sets the preset value.
414adec7daSBenjamin Gaignard		When counting up the counter starts from 0 and fires an
424adec7daSBenjamin Gaignard		event when reach preset value.
434adec7daSBenjamin Gaignard		When counting down the counter start from preset value
444adec7daSBenjamin Gaignard		and fire event when reach 0.
454adec7daSBenjamin Gaignard
464adec7daSBenjamin GaignardWhat:		/sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
474adec7daSBenjamin GaignardKernelVersion:	4.12
484adec7daSBenjamin GaignardContact:	benjamin.gaignard@st.com
494adec7daSBenjamin GaignardDescription:
504adec7daSBenjamin Gaignard		Reading returns the list possible quadrature modes.
514adec7daSBenjamin Gaignard
524adec7daSBenjamin GaignardWhat:		/sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode
534adec7daSBenjamin GaignardKernelVersion:	4.12
544adec7daSBenjamin GaignardContact:	benjamin.gaignard@st.com
554adec7daSBenjamin GaignardDescription:
564adec7daSBenjamin Gaignard		Configure the device counter quadrature modes:
574adec7daSBenjamin Gaignard		channel_A:
584adec7daSBenjamin Gaignard			Encoder A input servers as the count input and B as
594adec7daSBenjamin Gaignard			the UP/DOWN direction control input.
604adec7daSBenjamin Gaignard
614adec7daSBenjamin Gaignard		channel_B:
624adec7daSBenjamin Gaignard			Encoder B input serves as the count input and A as
634adec7daSBenjamin Gaignard			the UP/DOWN direction control input.
644adec7daSBenjamin Gaignard
654adec7daSBenjamin Gaignard		quadrature:
664adec7daSBenjamin Gaignard			Encoder A and B inputs are mixed to get direction
674adec7daSBenjamin Gaignard			and count with a scale of 0.25.
68*2a830a45SBenjamin Gaignard
69*2a830a45SBenjamin GaignardWhat:		/sys/bus/iio/devices/iio:deviceX/in_count_enable_mode_available
70*2a830a45SBenjamin GaignardKernelVersion:	4.12
71*2a830a45SBenjamin GaignardContact:	benjamin.gaignard@st.com
72*2a830a45SBenjamin GaignardDescription:
73*2a830a45SBenjamin Gaignard		Reading returns the list possible enable modes.
74*2a830a45SBenjamin Gaignard
75*2a830a45SBenjamin GaignardWhat:		/sys/bus/iio/devices/iio:deviceX/in_count0_enable_mode
76*2a830a45SBenjamin GaignardKernelVersion:	4.12
77*2a830a45SBenjamin GaignardContact:	benjamin.gaignard@st.com
78*2a830a45SBenjamin GaignardDescription:
79*2a830a45SBenjamin Gaignard		Configure the device counter enable modes, in all case
80*2a830a45SBenjamin Gaignard		counting direction is set by in_count0_count_direction
81*2a830a45SBenjamin Gaignard		attribute and the counter is clocked by the internal clock.
82*2a830a45SBenjamin Gaignard		always:
83*2a830a45SBenjamin Gaignard			Counter is always ON.
84*2a830a45SBenjamin Gaignard
85*2a830a45SBenjamin Gaignard		gated:
86*2a830a45SBenjamin Gaignard			Counting is enabled when connected trigger signal
87*2a830a45SBenjamin Gaignard			level is high else counting is disabled.
88*2a830a45SBenjamin Gaignard
89*2a830a45SBenjamin Gaignard		triggered:
90*2a830a45SBenjamin Gaignard			Counting is enabled on rising edge of the connected
91*2a830a45SBenjamin Gaignard			trigger, and remains enabled for the duration of this
92*2a830a45SBenjamin Gaignard			selected mode.
93