[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output



On Wed, 28 Oct 2020 15:23:18 +0100
Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> wrote:

> From: Mauro Carvalho Chehab <mchehab+samsung@xxxxxxxxxx>
> 
> Some files over there won't parse well by Sphinx.
> 
> Fix them.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@xxxxxxxxxx>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>

Query below...  I'm going to guess a rebase issue?

Other than that
Acked-by: Jonathan Cameron <Jonathan.Cameron@xxxxxxxxxx> # for IIO


> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-timer-stm32 
> b/Documentation/ABI/testing/sysfs-bus-iio-timer-stm32
> index b7259234ad70..a10a4de3e5fe 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio-timer-stm32
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-timer-stm32
> @@ -3,67 +3,85 @@ KernelVersion:      4.11
>  Contact:     benjamin.gaignard@xxxxxx
>  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.
> +                             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":
> +               +-----------+   +-------------+            +---------+
> +               | Prescaler +-> | Counter     |        +-> | Master  | TRGO(2)
> +               +-----------+   +--+--------+-+        |-> | Control +-->
> +                                  |        |          ||  +---------+
> +                               +--v--------+-+ OCxREF ||  +---------+
> +                               | Chx compare +----------> | Output  | ChX
> +                               +-----------+-+         |  | Control +-->
> +                                     .     |           |  +---------+
> +                                     .     |           |    .
> +                               +-----------v-+ OC6REF  |    .
> +                               | Ch6 compare +---------+>
> +                               +-------------+
>  
> -                             X
> -                           X   X
> -                         X .   . X
> -                       X   .   .   X
> -                     X     .   .     X
> -             count X .     .   .     . X
> -                     .     .   .     .
> -                     .     .   .     .
> -                     +---------------+
> -             OC4REF  |     .   .     |
> -                   +-+     .   .     +-+
> -                     .     +---+     .
> -             OC6REF  .     |   |     .
> -                   +-------+   +-------+
> -                     +-+   +-+
> -             TRGO2   | |   | |
> -                   +-+ +---+ +---------+
> +             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
> @@ -91,6 +109,30 @@ Description:
>               When counting down the counter start from preset value
>               and fire event when reach 0.
>  

Where did these come from?

> +What:                
> /sys/bus/iio/devices/iio:deviceX/in_count_quadrature_mode_available
> +KernelVersion:       4.12
> +Contact:     benjamin.gaignard@xxxxxx
> +Description:
> +             Reading returns the list possible quadrature modes.
> +
> +What:                
> /sys/bus/iio/devices/iio:deviceX/in_count0_quadrature_mode
> +KernelVersion:       4.12
> +Contact:     benjamin.gaignard@xxxxxx
> +Description:
> +             Configure the device counter quadrature modes:
> +
> +             channel_A:
> +                     Encoder A input servers as the count input and B as
> +                     the UP/DOWN direction control input.
> +
> +             channel_B:
> +                     Encoder B input serves as the count input and A as
> +                     the UP/DOWN direction control input.
> +
> +             quadrature:
> +                     Encoder A and B inputs are mixed to get direction
> +                     and count with a scale of 0.25.
> +
>  What:                
> /sys/bus/iio/devices/iio:deviceX/in_count_enable_mode_available
>  KernelVersion:       4.12
>  Contact:     benjamin.gaignard@xxxxxx
> @@ -104,6 +146,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.
>  



 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.