mbox series

[0/2] Documentation: gpio: clarify that line values are logical

Message ID 20240610092157.9147-1-warthog618@gmail.com
Headers show
Series Documentation: gpio: clarify that line values are logical | expand

Message

Kent Gibson June 10, 2024, 9:21 a.m. UTC 
The line values passed by the GPIO uAPI are logical values, and the edges
returned are based on changes to logical line values.  While the
documentation consistently uses active/inactive terminology to identify
the values as logical, this is never explicitly spelt out.
This series clarifies those points, with paricular emphasis on the
effect the active low flag has on values and edge polarity.

Patch 1 provides clarification for ioctls passing line values.

Patch 2 provides clarification for functions returning edge events.

Cheers,
Kent.

Kent Gibson (2):
  Documentation: gpio: Clarify effect of active low flag on line values
  Documentation: gpio: Clarify effect of active low flag on line edges

 .../gpio/gpio-handle-get-line-values-ioctl.rst             | 7 +++++++
 .../gpio/gpio-handle-set-line-values-ioctl.rst             | 7 +++++++
 .../userspace-api/gpio/gpio-lineevent-data-read.rst        | 5 +++++
 .../userspace-api/gpio/gpio-v2-line-event-read.rst         | 5 +++++
 .../userspace-api/gpio/gpio-v2-line-get-values-ioctl.rst   | 7 +++++++
 .../userspace-api/gpio/gpio-v2-line-set-values-ioctl.rst   | 7 +++++++
 6 files changed, 38 insertions(+)

--
2.39.2

Comments

Bartosz Golaszewski June 12, 2024, 12:03 p.m. UTC | #1 
From: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>


On Mon, 10 Jun 2024 17:21:55 +0800, Kent Gibson wrote:
> The line values passed by the GPIO uAPI are logical values, and the edges
> returned are based on changes to logical line values.  While the
> documentation consistently uses active/inactive terminology to identify
> the values as logical, this is never explicitly spelt out.
> This series clarifies those points, with paricular emphasis on the
> effect the active low flag has on values and edge polarity.
> 
> [...]

Applied, thanks!

[1/2] Documentation: gpio: Clarify effect of active low flag on line values
      commit: 5ca84d416e1ca82ca068906fc1386f61a57b17f2
[2/2] Documentation: gpio: Clarify effect of active low flag on line edges
      commit: 08d94c7428680715527757585a6c4575fcf571b9

Best regards,