linux-gpio.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Kent Gibson <warthog618@gmail.com>
To: linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org,
	linux-doc@vger.kernel.org, brgl@bgdev.pl, corbet@lwn.net,
	drankinatty@gmail.com
Cc: Kent Gibson <warthog618@gmail.com>
Subject: [PATCH 0/2] Documentation: gpio: clarify that line values are logical
Date: Mon, 10 Jun 2024 17:21:55 +0800	[thread overview]
Message-ID: <20240610092157.9147-1-warthog618@gmail.com> (raw)

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


             reply	other threads:[~2024-06-10  9:23 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-06-10  9:21 Kent Gibson [this message]
2024-06-10  9:21 ` [PATCH 1/2] Documentation: gpio: Clarify effect of active low flag on line values Kent Gibson
2024-06-10  9:21 ` [PATCH 2/2] Documentation: gpio: Clarify effect of active low flag on line edges Kent Gibson
2024-06-12 12:03 ` [PATCH 0/2] Documentation: gpio: clarify that line values are logical Bartosz Golaszewski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240610092157.9147-1-warthog618@gmail.com \
    --to=warthog618@gmail.com \
    --cc=brgl@bgdev.pl \
    --cc=corbet@lwn.net \
    --cc=drankinatty@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-gpio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).