Re: [PATCH v4 2/2] docs: driver-api: generic-counter: Update Count and Signal data types

William Breathitt Gray
2019-10-06T19:00:21Z

On Sun, Oct 06, 2019 at 01:41:42PM -0500, David Lechner wrote:
> On 10/6/19 11:03 AM, William Breathitt Gray wrote:
> > Count data is now always represented as an unsigned integer, while
> > Signal data is either SIGNAL_LOW or SIGNAL_HIGH.
> >
> > Signed-off-by: William Breathitt Gray <vilhelm.gray@gmail.com>
> > ---
> > Documentation/driver-api/generic-counter.rst | 22 +++++++-------------
> > 1 file changed, 8 insertions(+), 14 deletions(-)
> >
> > diff --git a/Documentation/driver-api/generic-counter.rst b/Documentation/driver-api/generic-counter.rst
> > index 8382f01a53e3..161652fc1025 100644
> > --- a/Documentation/driver-api/generic-counter.rst
> > +++ b/Documentation/driver-api/generic-counter.rst
> > @@ -39,10 +39,7 @@ There are three core components to a counter:
> > COUNT
> > -----
> > A Count represents the count data for a set of Signals. The Generic
> > -Counter interface provides the following available count data types:
> > -
> > -* COUNT_POSITION:
> > - Unsigned integer value representing position.
> > +Counter interface represents the count data as an unsigned integer.
>
> The previous patch looks like it is using unsigned long instead of
> unsigned integer.

Thank you for the heads-up. Actually, this section of the
documentation describes the theoretical representation of counter
devices, as opposed to the in-kernel implementation of the Generic
Counter interface. As such, the phrase "unsigned integer" here means a
natural number and not the C language "unsigned int" data type.

I'm going to update this line to state that clearer since it can be
easily confused in the context of the rest of the document.

William Breathitt Gray