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,
linus.walleij@linaro.org, andy@kernel.org, corbet@lwn.net
Cc: Kent Gibson <warthog618@gmail.com>
Subject: [PATCH v2 5/9] Documentation: gpio: update sysfs documentation to reference new chardev doc
Date: Mon, 15 Jan 2024 08:48:43 +0800 [thread overview]
Message-ID: <20240115004847.22369-6-warthog618@gmail.com> (raw)
In-Reply-To: <20240115004847.22369-1-warthog618@gmail.com>
Update GPIO sysfs interface documentation to reference the new
chardev document rather than gpio.h.
Signed-off-by: Kent Gibson <warthog618@gmail.com>
---
Documentation/userspace-api/gpio/sysfs.rst | 27 ++++++++++++----------
1 file changed, 15 insertions(+), 12 deletions(-)
diff --git a/Documentation/userspace-api/gpio/sysfs.rst b/Documentation/userspace-api/gpio/sysfs.rst
index 35171d15f78d..e12037a0f2b4 100644
--- a/Documentation/userspace-api/gpio/sysfs.rst
+++ b/Documentation/userspace-api/gpio/sysfs.rst
@@ -2,18 +2,18 @@ GPIO Sysfs Interface for Userspace
==================================
.. warning::
+ This API is obsoleted by the chardev.rst and the ABI documentation has
+ been moved to Documentation/ABI/obsolete/sysfs-gpio.
- THIS ABI IS DEPRECATED, THE ABI DOCUMENTATION HAS BEEN MOVED TO
- Documentation/ABI/obsolete/sysfs-gpio AND NEW USERSPACE CONSUMERS
- ARE SUPPOSED TO USE THE CHARACTER DEVICE ABI. THIS OLD SYSFS ABI WILL
- NOT BE DEVELOPED (NO NEW FEATURES), IT WILL JUST BE MAINTAINED.
+ New developments should use the chardev.rst, and existing developments are
+ encouraged to migrate as soon as possible, as this API will be removed
+ in the future.
-Refer to the examples in tools/gpio/* for an introduction to the new
-character device ABI. Also see the userspace header in
-include/uapi/linux/gpio.h
+ This interface will continue to be maintained for the migration period,
+ but new features will only be added to the new API.
-The deprecated sysfs ABI
-------------------------
+The obsolete sysfs ABI
+----------------------
Platforms which use the "gpiolib" implementors framework may choose to
configure a sysfs user interface to GPIOs. This is different from the
debugfs interface, since it provides control over GPIO direction and
@@ -33,9 +33,12 @@ userspace GPIO can be used to determine system configuration data that
standard kernels won't know about. And for some tasks, simple userspace
GPIO drivers could be all that the system really needs.
-DO NOT ABUSE SYSFS TO CONTROL HARDWARE THAT HAS PROPER KERNEL DRIVERS.
-PLEASE READ THE DOCUMENT AT Documentation/driver-api/gpio/drivers-on-gpio.rst
-TO AVOID REINVENTING KERNEL WHEELS IN USERSPACE. I MEAN IT. REALLY.
+.. note::
+ Do NOT abuse sysfs to control hardware that has proper kernel drivers.
+ Please read Documentation/driver-api/gpio/drivers-on-gpio.rst
+ to avoid reinventing kernel wheels in userspace.
+
+ I MEAN IT. REALLY.
Paths in Sysfs
--------------
--
2.39.2
next prev parent reply other threads:[~2024-01-15 0:50 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-15 0:48 [PATCH v2 0/9] Documentation: gpio: add character device userspace API documentation Kent Gibson
2024-01-15 0:48 ` [PATCH v2 1/9] Documentation: gpio: add chardev " Kent Gibson
2024-01-15 1:11 ` Andy Shevchenko
2024-01-15 1:30 ` Kent Gibson
2024-01-15 0:48 ` [PATCH v2 2/9] Documentation: ABI: update gpio-cdev to reference chardev.rst Kent Gibson
2024-01-15 0:48 ` [PATCH v2 3/9] Documentation: ABI: update sysfs-gpio to reference gpio-cdev Kent Gibson
2024-01-15 0:48 ` [PATCH v2 4/9] Documentation: gpio: move sysfs into an obsolete section Kent Gibson
2024-01-15 0:48 ` Kent Gibson [this message]
2024-01-15 0:48 ` [PATCH v2 6/9] Documentation: gpio: add chardev v1 userspace API documentation Kent Gibson
2024-01-15 0:48 ` [PATCH v2 7/9] Documentation: gpio: capitalize GPIO in index title Kent Gibson
2024-01-15 0:48 ` [PATCH v2 8/9] Documentation: gpio: document gpio-mockup as obsoleted by gpio-sim Kent Gibson
2024-01-15 0:48 ` [PATCH v2 9/9] Documentation: gpio: move gpio-mockup into obsolete section Kent Gibson
2024-01-15 1:20 ` Andy Shevchenko
2024-01-15 1:36 ` Kent Gibson
2024-01-22 9:50 ` [PATCH v2 0/9] Documentation: gpio: add character device userspace API documentation 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=20240115004847.22369-6-warthog618@gmail.com \
--to=warthog618@gmail.com \
--cc=andy@kernel.org \
--cc=brgl@bgdev.pl \
--cc=corbet@lwn.net \
--cc=linus.walleij@linaro.org \
--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).