From: Jonathan Cameron <jic23@kernel.org>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: "Linux Doc Mailing List" <linux-doc@vger.kernel.org>,
"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
"Mauro Carvalho Chehab" <mchehab+samsung@kernel.org>,
"Gautham R. Shenoy" <ego@linux.vnet.ibm.com>,
"Jason A. Donenfeld" <Jason@zx2c4.com>,
"Javier González" <javier@javigon.com>,
"Jonathan Corbet" <corbet@lwn.net>,
"Martin K. Petersen" <martin.petersen@oracle.com>,
"Rafael J. Wysocki" <rjw@rjwysocki.net>,
"Alexander Shishkin" <alexander.shishkin@linux.intel.com>,
"Alexandre Belloni" <alexandre.belloni@bootlin.com>,
"Alexandre Torgue" <alexandre.torgue@st.com>,
"Andrew Donnellan" <ajd@linux.ibm.com>,
"Andy Shevchenko" <andriy.shevchenko@linux.intel.com>,
"Baolin Wang" <baolin.wang7@gmail.com>,
"Benson Leung" <bleung@chromium.org>,
"Boris Ostrovsky" <boris.ostrovsky@oracle.com>,
"Bruno Meneguele" <bmeneg@redhat.com>,
"Chunyan Zhang" <zhang.lyra@gmail.com>,
"Dan Murphy" <dmurphy@ti.com>,
"Dan Williams" <dan.j.williams@intel.com>,
"Enric Balletbo i Serra" <enric.balletbo@collabora.com>,
"Fabrice Gasnier" <fabrice.gasnier@st.com>,
"Felipe Balbi" <balbi@kernel.org>,
"Frederic Barrat" <fbarrat@linux.ibm.com>,
"Guenter Roeck" <groeck@chromium.org>,
"Hanjun Guo" <guohanjun@huawei.com>,
"Heikki Krogerus" <heikki.krogerus@linux.intel.com>,
"Jens Axboe" <axboe@kernel.dk>,
"Johannes Thumshirn" <johannes.thumshirn@wdc.com>,
"Juergen Gross" <jgross@suse.com>,
"Konstantin Khlebnikov" <koct9i@gmail.com>,
"Kranthi Kuntala" <kranthi.kuntala@intel.com>,
"Lakshmi Ramasubramanian" <nramas@linux.microsoft.com>,
"Lars-Peter Clausen" <lars@metafoo.de>,
"Len Brown" <lenb@kernel.org>,
"Leonid Maksymchuk" <leonmaxx@gmail.com>,
"Ludovic Desroches" <ludovic.desroches@microchip.com>,
"Mario Limonciello" <mario.limonciello@dell.com>,
"Maxime Coquelin" <mcoquelin.stm32@gmail.com>,
"Michael Ellerman" <mpe@ellerman.id.au>,
"Mika Westerberg" <mika.westerberg@linux.intel.com>,
"Mike Kravetz" <mike.kravetz@oracle.com>,
"Mimi Zohar" <zohar@linux.ibm.com>,
"Nayna Jain" <nayna@linux.ibm.com>,
"Nicolas Ferre" <nicolas.ferre@microchip.com>,
"Niklas Cassel" <niklas.cassel@wdc.com>,
"Oleh Kravchenko" <oleg@kaa.org.ua>,
"Orson Zhai" <orsonzhai@gmail.com>, "Pavel Machek" <pavel@ucw.cz>,
"Pawan Gupta" <pawan.kumar.gupta@linux.intel.com>,
"Peter Meerwald-Stadler" <pmeerw@pmeerw.net>,
"Peter Rosin" <peda@axentia.se>, "Petr Mladek" <pmladek@suse.com>,
"Philippe Bergheaud" <felix@linux.ibm.com>,
"Richard Cochran" <richardcochran@gmail.com>,
"Sebastian Reichel" <sre@kernel.org>,
"Sergey Senozhatsky" <sergey.senozhatsky@gmail.com>,
"Stefano Stabellini" <sstabellini@kernel.org>,
"Thinh Nguyen" <Thinh.Nguyen@synopsys.com>,
"Thomas Gleixner" <tglx@linutronix.de>,
"Vineela Tummalapalli" <vineela.tummalapalli@intel.com>,
"Vishal Verma" <vishal.l.verma@intel.com>,
linux-acpi@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-mm@kvack.org, linux-pm@vger.kernel.org,
linux-stm32@st-md-mailman.stormreply.com,
linux-usb@vger.kernel.org, linuxppc-dev@lists.ozlabs.org,
netdev@vger.kernel.org, xen-devel@lists.xenproject.org
Subject: Re: [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output
Date: Thu, 29 Oct 2020 14:49:12 +0000 [thread overview]
Message-ID: <20201029144912.3c0a239b@archlinux> (raw)
In-Reply-To: <4ebaaa0320101479e392ce2db4b62e24fdf15ef1.1603893146.git.mchehab+huawei@kernel.org>
On Wed, 28 Oct 2020 15:23:18 +0100
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
>
> Some files over there won't parse well by Sphinx.
>
> Fix them.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Query below... I'm going to guess a rebase issue?
Other than that
Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.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@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.
> + 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@st.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@st.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@st.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.
>
next prev parent reply other threads:[~2020-10-29 14:49 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <cover.1603893146.git.mchehab+huawei@kernel.org>
2020-10-28 14:23 ` [PATCH 26/33] docs: ABI: convert testing/configfs-acpi to ReST Mauro Carvalho Chehab
[not found] ` <4ebaaa0320101479e392ce2db4b62e24fdf15ef1.1603893146.git.mchehab+huawei@kernel.org>
2020-10-28 17:44 ` [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output Richard Cochran
2020-10-29 7:21 ` Mauro Carvalho Chehab
2020-10-29 14:49 ` Jonathan Cameron [this message]
2020-10-30 7:11 ` Mauro Carvalho Chehab
2020-11-02 15:06 ` Gautham R Shenoy
[not found] ` <95ef2cf3a58f4e50f17d9e58e0d9440ad14d0427.1603893146.git.mchehab+huawei@kernel.org>
2020-10-30 6:33 ` [PATCH 30/33] docs: ABI: cleanup several ABI documents Vaibhav Jain
2020-11-03 15:24 ` Bjorn Andersson
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201029144912.3c0a239b@archlinux \
--to=jic23@kernel.org \
--cc=Jason@zx2c4.com \
--cc=Thinh.Nguyen@synopsys.com \
--cc=ajd@linux.ibm.com \
--cc=alexander.shishkin@linux.intel.com \
--cc=alexandre.belloni@bootlin.com \
--cc=alexandre.torgue@st.com \
--cc=andriy.shevchenko@linux.intel.com \
--cc=axboe@kernel.dk \
--cc=balbi@kernel.org \
--cc=baolin.wang7@gmail.com \
--cc=bleung@chromium.org \
--cc=bmeneg@redhat.com \
--cc=boris.ostrovsky@oracle.com \
--cc=corbet@lwn.net \
--cc=dan.j.williams@intel.com \
--cc=dmurphy@ti.com \
--cc=ego@linux.vnet.ibm.com \
--cc=enric.balletbo@collabora.com \
--cc=fabrice.gasnier@st.com \
--cc=fbarrat@linux.ibm.com \
--cc=felix@linux.ibm.com \
--cc=gregkh@linuxfoundation.org \
--cc=groeck@chromium.org \
--cc=guohanjun@huawei.com \
--cc=heikki.krogerus@linux.intel.com \
--cc=javier@javigon.com \
--cc=jgross@suse.com \
--cc=johannes.thumshirn@wdc.com \
--cc=koct9i@gmail.com \
--cc=kranthi.kuntala@intel.com \
--cc=lars@metafoo.de \
--cc=lenb@kernel.org \
--cc=leonmaxx@gmail.com \
--cc=linux-acpi@vger.kernel.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=linux-pm@vger.kernel.org \
--cc=linux-stm32@st-md-mailman.stormreply.com \
--cc=linux-usb@vger.kernel.org \
--cc=linuxppc-dev@lists.ozlabs.org \
--cc=ludovic.desroches@microchip.com \
--cc=mario.limonciello@dell.com \
--cc=martin.petersen@oracle.com \
--cc=mchehab+huawei@kernel.org \
--cc=mchehab+samsung@kernel.org \
--cc=mcoquelin.stm32@gmail.com \
--cc=mika.westerberg@linux.intel.com \
--cc=mike.kravetz@oracle.com \
--cc=mpe@ellerman.id.au \
--cc=nayna@linux.ibm.com \
--cc=netdev@vger.kernel.org \
--cc=nicolas.ferre@microchip.com \
--cc=niklas.cassel@wdc.com \
--cc=nramas@linux.microsoft.com \
--cc=oleg@kaa.org.ua \
--cc=orsonzhai@gmail.com \
--cc=pavel@ucw.cz \
--cc=pawan.kumar.gupta@linux.intel.com \
--cc=peda@axentia.se \
--cc=pmeerw@pmeerw.net \
--cc=pmladek@suse.com \
--cc=richardcochran@gmail.com \
--cc=rjw@rjwysocki.net \
--cc=sergey.senozhatsky@gmail.com \
--cc=sre@kernel.org \
--cc=sstabellini@kernel.org \
--cc=tglx@linutronix.de \
--cc=vineela.tummalapalli@intel.com \
--cc=vishal.l.verma@intel.com \
--cc=xen-devel@lists.xenproject.org \
--cc=zhang.lyra@gmail.com \
--cc=zohar@linux.ibm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).