linux-kernel - Re: [RFC] 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: <d3c9bbc44167009f647772e38168a51d2def36d5.camel@pengutronix.de>
Date:   Thu, 24 Oct 2019 10:18:14 +0200
From:   Philipp Zabel <p.zabel@...gutronix.de>
To:     Jonathan Corbet <corbet@....net>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        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>, kernel@...gutronix.de
Subject: Re: [RFC] docs: add a reset controller chapter to the driver API
 docs

Hi Jonathan,

On Tue, 2019-10-22 at 11:00 -0600, Jonathan Corbet wrote:
> On Tue, 22 Oct 2019 18:45:47 +0200
> Philipp Zabel <p.zabel@...gutronix.de> wrote:
> 
> > Add initial reset controller API documentation. This is mostly indented
> > 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>
> 
> One quick comment...
> 
> >  Documentation/driver-api/index.rst |   1 +
> >  Documentation/driver-api/reset.rst | 217 +++++++++++++++++++++++++++++
> >  2 files changed, 218 insertions(+)
> >  create mode 100644 Documentation/driver-api/reset.rst
> > 
> 
> [...]
> 
> > +Shared and exclusive resets
> > +---------------------------
> > +
> > +The reset controller API provides either reference counted deassertion and
> > +assertion or direct, exclusive control.
> > +The distinction between shared and exclusive reset controls is made at the time
> > +the reset control is requested, either via :c:func:`devm_reset_control_get_shared`
> > +or via :c:func:`devm_reset_control_get_exclusive`.
> 
> :c:func: isn't needed anymore, and is actively discouraged - the function
> references will be linked anyway.  So just say function() rather than
> :c:func:`function` everywhere, please.

That is great, thank you! I'll change them all in the next version.

regards
Philipp