linux-kernel - Re: [PATCH] docs: add a reset controller chapter to the driver API docs

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <48b0c216-69de-5c3b-1d2d-9cb23e0bc8bf@infradead.org>
Date:   Thu, 19 Nov 2020 10:31:37 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Philipp Zabel <p.zabel@...gutronix.de>, linux-doc@...r.kernel.org
Cc:     linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Vivek Gautam <vivek.gautam@...eaurora.org>,
        Masahiro Yamada <yamada.masahiro@...ionext.com>,
        Bartosz Golaszewski <bgolaszewski@...libre.com>,
        Hans de Goede <hdegoede@...hat.com>,
        Martin Blumenstingl <martin.blumenstingl@...glemail.com>,
        Ramiro Oliveira <Ramiro.Oliveira@...opsys.com>,
        Dinh Nguyen <dinguyen@...nel.org>,
        Thierry Reding <treding@...dia.com>,
        Geert Uytterhoeven <geert@...ux-m68k.org>,
        Lee Jones <lee.jones@...aro.org>,
        Amjad Ouled-Ameur <aouledameur@...libre.com>,
        kernel@...gutronix.de
Subject: Re: [PATCH] docs: add a reset controller chapter to the driver API
 docs

Hi,

On 11/17/20 2:33 AM, Philipp Zabel wrote:
> Add initial reset controller API documentation. This is mostly intended
> to describe the concepts to users of the consumer API, and to tie the
> kerneldoc comments we already have into the driver API documentation.
> 
> Signed-off-by: Philipp Zabel <p.zabel@...gutronix.de>
> ---
> Changes since the RFC [1]:
> - Replaced all :c:func:`function` with function() (Jonathan Corbet)
> - Typo fixes and wording improvements (Randy Dunlap)
> - Mention new reset_control_rearm() API as a counterpart to
>   reset_control_reset() for shared resets in the Triggering section
> - Grammar fix in the Querying section
> - Add reset.rst to MAINTAINERS
> 
> [1] https://lore.kernel.org/lkml/20191022164547.22632-1-p.zabel@pengutronix.de/
> ---
>  Documentation/driver-api/index.rst |   1 +
>  Documentation/driver-api/reset.rst | 219 +++++++++++++++++++++++++++++
>  MAINTAINERS                        |   1 +
>  3 files changed, 221 insertions(+)
>  create mode 100644 Documentation/driver-api/reset.rst


> diff --git a/Documentation/driver-api/reset.rst b/Documentation/driver-api/reset.rst
> new file mode 100644
> index 000000000000..00a6ad79dd6c
> --- /dev/null
> +++ b/Documentation/driver-api/reset.rst
> @@ -0,0 +1,219 @@


> +Querying
> +--------
> +
> +Only some reset controllers support querying the current status of a reset
> +line, via reset_control_status().
> +This function returns a positive non-zero value if the given reset line is
> +asserted.

Maybe note that reset_control_status() does not accept a reset control array
as its input parameter.

> +
> +Reset control arrays
> +--------------------
> +
> +Some drivers need to assert a bunch of reset lines in no particular order.
> +devm_reset_control_array_get() returns an opaque reset control handle that can
> +be used to assert, deassert, or trigger all specified reset controls at once.
> +The reset control API does not guarantee the order in which the individual
> +controls therein are handled.


Reviewed-by: Randy Dunlap <rdunlap@...radead.org>

thanks.
-- 
~Randy