Merge branch 'for-5.11/elecom' into for-linus
[linux-2.6-microblaze.git] / Documentation / ABI / testing / sysfs-bus-iio-timer-stm32
index b725923..c4a4497 100644 (file)
@@ -3,67 +3,85 @@ KernelVersion:        4.11
 Contact:       benjamin.gaignard@st.com
 Description:
                Reading returns the list possible master modes which are:
-               - "reset"     : The UG bit from the TIMx_EGR register is
+
+
+               - "reset"
+                               The UG bit from the TIMx_EGR register is
                                used as trigger output (TRGO).
-               - "enable"    : The Counter Enable signal CNT_EN is used
+               - "enable"
+                               The Counter Enable signal CNT_EN is used
                                as trigger output.
-               - "update"    : The update event is selected as trigger output.
+               - "update"
+                               The update event is selected as trigger output.
                                For instance a master timer can then be used
                                as a prescaler for a slave timer.
-               - "compare_pulse" : The trigger output send a positive pulse
-                                   when the CC1IF flag is to be set.
-               - "OC1REF"    : OC1REF signal is used as trigger output.
-               - "OC2REF"    : OC2REF signal is used as trigger output.
-               - "OC3REF"    : OC3REF signal is used as trigger output.
-               - "OC4REF"    : OC4REF signal is used as trigger output.
+               - "compare_pulse"
+                               The trigger output send a positive pulse
+                               when the CC1IF flag is to be set.
+               - "OC1REF"
+                               OC1REF signal is used as trigger output.
+               - "OC2REF"
+                               OC2REF signal is used as trigger output.
+               - "OC3REF"
+                               OC3REF signal is used as trigger output.
+               - "OC4REF"
+                               OC4REF signal is used as trigger output.
+
                Additional modes (on TRGO2 only):
-               - "OC5REF"    : OC5REF signal is used as trigger output.
-               - "OC6REF"    : OC6REF signal is used as trigger output.
+
+               - "OC5REF"
+                               OC5REF signal is used as trigger output.
+               - "OC6REF"
+                               OC6REF signal is used as trigger output.
                - "compare_pulse_OC4REF":
-                 OC4REF rising or falling edges generate pulses.
+                               OC4REF rising or falling edges generate pulses.
                - "compare_pulse_OC6REF":
-                 OC6REF rising or falling edges generate pulses.
+                               OC6REF rising or falling edges generate pulses.
                - "compare_pulse_OC4REF_r_or_OC6REF_r":
-                 OC4REF or OC6REF rising edges generate pulses.
+                               OC4REF or OC6REF rising edges generate pulses.
                - "compare_pulse_OC4REF_r_or_OC6REF_f":
-                 OC4REF rising or OC6REF falling edges generate pulses.
+                               OC4REF rising or OC6REF falling edges generate
+                               pulses.
                - "compare_pulse_OC5REF_r_or_OC6REF_r":
-                 OC5REF or OC6REF rising edges generate pulses.
+                               OC5REF or OC6REF rising edges generate pulses.
                - "compare_pulse_OC5REF_r_or_OC6REF_f":
-                 OC5REF rising or OC6REF falling edges generate pulses.
-
-               +-----------+   +-------------+            +---------+
-               | Prescaler +-> | Counter     |        +-> | Master  | TRGO(2)
-               +-----------+   +--+--------+-+        |-> | Control +-->
-                                  |        |          ||  +---------+
-                               +--v--------+-+ OCxREF ||  +---------+
-                               | Chx compare +----------> | Output  | ChX
-                               +-----------+-+         |  | Control +-->
-                                     .     |           |  +---------+
-                                     .     |           |    .
-                               +-----------v-+ OC6REF  |    .
-                               | Ch6 compare +---------+>
-                               +-------------+
-
-               Example with: "compare_pulse_OC4REF_r_or_OC6REF_r":
-
-                               X
-                             X   X
-                           X .   . X
-                         X   .   .   X
-                       X     .   .     X
-               count X .     .   .     . X
-                       .     .   .     .
-                       .     .   .     .
-                       +---------------+
-               OC4REF  |     .   .     |
-                     +-+     .   .     +-+
-                       .     +---+     .
-               OC6REF  .     |   |     .
-                     +-------+   +-------+
-                       +-+   +-+
-               TRGO2   | |   | |
-                     +-+ +---+ +---------+
+                               OC5REF rising or OC6REF falling edges generate
+                               pulses.
+
+               ::
+
+                 +-----------+   +-------------+            +---------+
+                 | Prescaler +-> | Counter     |        +-> | Master  | TRGO(2)
+                 +-----------+   +--+--------+-+        |-> | Control +-->
+                                    |        |          ||  +---------+
+                                 +--v--------+-+ OCxREF ||  +---------+
+                                 | Chx compare +----------> | Output  | ChX
+                                 +-----------+-+         |  | Control +-->
+                                       .     |           |  +---------+
+                                       .     |           |    .
+                                 +-----------v-+ OC6REF  |    .
+                                 | Ch6 compare +---------+>
+                                 +-------------+
+
+               Example with: "compare_pulse_OC4REF_r_or_OC6REF_r"::
+
+                                 X
+                               X   X
+                             X .   . X
+                           X   .   .   X
+                         X     .   .     X
+                 count X .     .   .     . X
+                         .     .   .     .
+                         .     .   .     .
+                         +---------------+
+                 OC4REF  |     .   .     |
+                       +-+     .   .     +-+
+                         .     +---+     .
+                 OC6REF  .     |   |     .
+                       +-------+   +-------+
+                         +-+   +-+
+                 TRGO2   | |   | |
+                       +-+ +---+ +---------+
 
 What:          /sys/bus/iio/devices/triggerX/master_mode
 KernelVersion: 4.11
@@ -104,6 +122,7 @@ Description:
                Configure the device counter enable modes, in all case
                counting direction is set by in_count0_count_direction
                attribute and the counter is clocked by the internal clock.
+
                always:
                        Counter is always ON.