[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <20201029144912.3c0a239b@archlinux>
Date: Thu, 29 Oct 2020 14:49:12 +0000
From: Jonathan Cameron <jic23@...nel.org>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc: Linux Doc Mailing List <linux-doc@...r.kernel.org>,
Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
Mauro Carvalho Chehab <mchehab+samsung@...nel.org>,
"Gautham R. Shenoy" <ego@...ux.vnet.ibm.com>,
"Jason A. Donenfeld" <Jason@...c4.com>,
Javier González <javier@...igon.com>,
"Jonathan Corbet" <corbet@....net>,
"Martin K. Petersen" <martin.petersen@...cle.com>,
"Rafael J. Wysocki" <rjw@...ysocki.net>,
Alexander Shishkin <alexander.shishkin@...ux.intel.com>,
Alexandre Belloni <alexandre.belloni@...tlin.com>,
Alexandre Torgue <alexandre.torgue@...com>,
Andrew Donnellan <ajd@...ux.ibm.com>,
Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
Baolin Wang <baolin.wang7@...il.com>,
Benson Leung <bleung@...omium.org>,
Boris Ostrovsky <boris.ostrovsky@...cle.com>,
Bruno Meneguele <bmeneg@...hat.com>,
Chunyan Zhang <zhang.lyra@...il.com>,
Dan Murphy <dmurphy@...com>,
Dan Williams <dan.j.williams@...el.com>,
Enric Balletbo i Serra <enric.balletbo@...labora.com>,
Fabrice Gasnier <fabrice.gasnier@...com>,
Felipe Balbi <balbi@...nel.org>,
Frederic Barrat <fbarrat@...ux.ibm.com>,
Guenter Roeck <groeck@...omium.org>,
Hanjun Guo <guohanjun@...wei.com>,
Heikki Krogerus <heikki.krogerus@...ux.intel.com>,
Jens Axboe <axboe@...nel.dk>,
Johannes Thumshirn <johannes.thumshirn@....com>,
Juergen Gross <jgross@...e.com>,
Konstantin Khlebnikov <koct9i@...il.com>,
Kranthi Kuntala <kranthi.kuntala@...el.com>,
Lakshmi Ramasubramanian <nramas@...ux.microsoft.com>,
Lars-Peter Clausen <lars@...afoo.de>,
Len Brown <lenb@...nel.org>,
Leonid Maksymchuk <leonmaxx@...il.com>,
Ludovic Desroches <ludovic.desroches@...rochip.com>,
Mario Limonciello <mario.limonciello@...l.com>,
Maxime Coquelin <mcoquelin.stm32@...il.com>,
Michael Ellerman <mpe@...erman.id.au>,
Mika Westerberg <mika.westerberg@...ux.intel.com>,
Mike Kravetz <mike.kravetz@...cle.com>,
Mimi Zohar <zohar@...ux.ibm.com>,
Nayna Jain <nayna@...ux.ibm.com>,
Nicolas Ferre <nicolas.ferre@...rochip.com>,
Niklas Cassel <niklas.cassel@....com>,
Oleh Kravchenko <oleg@....org.ua>,
Orson Zhai <orsonzhai@...il.com>, Pavel Machek <pavel@....cz>,
Pawan Gupta <pawan.kumar.gupta@...ux.intel.com>,
Peter Meerwald-Stadler <pmeerw@...erw.net>,
Peter Rosin <peda@...ntia.se>, Petr Mladek <pmladek@...e.com>,
Philippe Bergheaud <felix@...ux.ibm.com>,
Richard Cochran <richardcochran@...il.com>,
Sebastian Reichel <sre@...nel.org>,
Sergey Senozhatsky <sergey.senozhatsky@...il.com>,
Stefano Stabellini <sstabellini@...nel.org>,
Thinh Nguyen <Thinh.Nguyen@...opsys.com>,
Thomas Gleixner <tglx@...utronix.de>,
Vineela Tummalapalli <vineela.tummalapalli@...el.com>,
Vishal Verma <vishal.l.verma@...el.com>,
linux-acpi@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
linux-iio@...r.kernel.org, linux-kernel@...r.kernel.org,
linux-mm@...ck.org, linux-pm@...r.kernel.org,
linux-stm32@...md-mailman.stormreply.com,
linux-usb@...r.kernel.org, linuxppc-dev@...ts.ozlabs.org,
netdev@...r.kernel.org, xen-devel@...ts.xenproject.org
Subject: 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@...nel.org> wrote:
> From: Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
>
> Some files over there won't parse well by Sphinx.
>
> Fix them.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Query below... I'm going to guess a rebase issue?
Other than that
Acked-by: Jonathan Cameron <Jonathan.Cameron@...wei.com> # 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@...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.
> + 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@...com
> +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@...com
> +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@...com
> @@ -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.
>
Powered by blists - more mailing lists