Messages in this thread Patch in this message | | | Date | Wed, 29 Dec 2021 17:19:16 +0900 | From | William Breathitt Gray <> | Subject | Re: [PATCH v2 14/23] counter: Update documentation for new counter registration functions |
| |
On Tue, Dec 28, 2021 at 06:12:22PM +0000, Jonathan Cameron wrote: > On Mon, 27 Dec 2021 10:45:17 +0100 > Uwe Kleine-König <u.kleine-koenig@pengutronix.de> wrote: > > > In order to replace the counter registration API also update the > > documentation to the new way. > > > > Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> > Fine either way, but a suggestion below. > > Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> > > > --- > > Documentation/driver-api/generic-counter.rst | 10 +++++----- > > 1 file changed, 5 insertions(+), 5 deletions(-) > > > > diff --git a/Documentation/driver-api/generic-counter.rst b/Documentation/driver-api/generic-counter.rst > > index 1b487a331467..991b180c7b47 100644 > > --- a/Documentation/driver-api/generic-counter.rst > > +++ b/Documentation/driver-api/generic-counter.rst > > @@ -262,11 +262,11 @@ order to communicate with the device: to read and write various Signals > > and Counts, and to set and get the "action mode" and "function mode" for > > various Synapses and Counts respectively. > > > > -A defined counter_device structure may be registered to the system by > > -passing it to the counter_register function, and unregistered by passing > > -it to the counter_unregister function. Similarly, the > > -devm_counter_register function may be used if device memory-managed > > -registration is desired. > > +A counter_device structure is supposed to be allocated using counter_alloc() > > +and may be registered to the system by passing it to the counter_add() > > +function, and unregistered by passing it to the counter_unregister function. > > I'd avoid the supposed to and the odd vague use of structure in the origin > text and just go with > > A struct counter_device is allocated using counter_alloc()...
I like this simpler wording as well.
Acked-by: William Breathitt Gray <vilhelm.gray@gmail.com>
> > > > +There are device managed variants of these functions: devm_counter_alloc() and > > +devm_counter_add(). > > > > The struct counter_comp structure is used to define counter extensions > > for Signals, Synapses, and Counts. > [unhandled content-type:application/pgp-signature] | |