From: Linus Walleij <linus.walleij@linaro.org>
To: linux-gpio@vger.kernel.org, Johan Hovold <johan@kernel.org>,
Alexandre Courbot <acourbot@nvidia.com>,
Arnd Bergmann <arnd@arndb.de>,
Michael Welling <mwelling@ieee.org>,
Markus Pargmann <mpa@pengutronix.de>
Cc: Mark Brown <broonie@kernel.org>,
Amit Kucheria <amit.kucheria@linaro.org>,
Linus Walleij <linus.walleij@linaro.org>
Subject: [PATCH 5/6] gpio: add a userspace character device ABI
Date: Thu, 22 Oct 2015 10:32:29 +0200 [thread overview]
Message-ID: <1445502750-22672-6-git-send-email-linus.walleij@linaro.org> (raw)
In-Reply-To: <1445502750-22672-1-git-send-email-linus.walleij@linaro.org>
Put in some documentation for the new character device ABI
so we can properly etch it in stone.
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
---
Documentation/ABI/testing/gpio-cdev | 26 ++++++++++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 27 insertions(+)
create mode 100644 Documentation/ABI/testing/gpio-cdev
diff --git a/Documentation/ABI/testing/gpio-cdev b/Documentation/ABI/testing/gpio-cdev
new file mode 100644
index 000000000000..7b265fbb47e3
--- /dev/null
+++ b/Documentation/ABI/testing/gpio-cdev
@@ -0,0 +1,26 @@
+What: /dev/gpiochip[0-9]+
+Date: November 2015
+KernelVersion: 4.4
+Contact: linux-gpio@vger.kernel.org
+Description:
+ The character device files /dev/gpiochip* are the interface
+ between GPIO chips and userspace.
+
+ The ioctl(2)-based ABI is defined and documented in
+ [include/uapi]<linux/gpio.h>.
+
+ The following file operations are supported:
+
+ open(2)
+ Currently the only useful flags are O_RDWR.
+
+ ioctl(2)
+ Initiate various actions.
+ See the inline documentation in [include/uapi]<linux/gpio.h>
+ for descriptions of all ioctls.
+
+ close(2)
+ Stops and free up the I/O contexts that was associated
+ with the file descriptor.
+
+Users: TBD
diff --git a/MAINTAINERS b/MAINTAINERS
index 3bb1f52d54e0..23cd966cb974 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -4642,6 +4642,7 @@ L: linux-gpio@vger.kernel.org
T: git git://git.kernel.org/pub/scm/linux/kernel/git/linusw/linux-gpio.git
S: Maintained
F: Documentation/gpio/
+F: Documentation/ABI/testing/gpio-cdev
F: drivers/gpio/
F: include/linux/gpio/
F: include/linux/gpio.h
--
2.4.3
next prev parent reply other threads:[~2015-10-22 8:33 UTC|newest]
Thread overview: 71+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-10-22 8:32 [PATCH 0/6] GPIO character device skeleton Linus Walleij
2015-10-22 8:32 ` [PATCH 1/6] gpio: make the gpiochip a real device Linus Walleij
2015-10-24 18:09 ` Markus Pargmann
2015-10-25 7:06 ` Alexandre Courbot
2015-10-26 2:12 ` Mark Brown
2015-11-03 21:20 ` Linus Walleij
2015-11-02 10:31 ` Johan Hovold
2015-11-02 12:25 ` Mark Brown
2015-11-02 12:43 ` Johan Hovold
2015-11-02 12:47 ` Mark Brown
2015-11-02 12:53 ` Johan Hovold
2015-11-02 13:06 ` Mark Brown
2015-11-02 13:14 ` Johan Hovold
2015-11-02 13:17 ` Mark Brown
2015-11-02 13:25 ` Johan Hovold
2015-11-03 21:24 ` Linus Walleij
2015-11-04 10:48 ` Linus Walleij
2015-11-05 9:44 ` Johan Hovold
2015-11-05 10:29 ` Mark Brown
2015-11-16 14:27 ` Linus Walleij
2015-12-03 14:04 ` Linus Walleij
2015-12-03 14:06 ` Linus Walleij
2015-12-03 21:26 ` Michael Welling
2015-12-04 22:31 ` Michael Welling
2015-12-11 17:58 ` Linus Walleij
2015-12-08 9:29 ` Johan Hovold
2015-12-11 18:06 ` Linus Walleij
2015-10-22 8:32 ` [PATCH 2/6] gpio: refer to gpio device in prints and debugfs Linus Walleij
2015-10-22 8:32 ` [PATCH 3/6] gpio: add a userspace chardev ABI for GPIOs Linus Walleij
2015-10-22 20:35 ` Michael Welling
2015-10-24 0:30 ` Greg Kroah-Hartman
2016-01-28 11:13 ` Linus Walleij
2015-10-26 1:34 ` Mark Brown
2016-01-27 10:05 ` Bamvor Zhang Jian
2016-01-28 11:14 ` Linus Walleij
2016-01-29 10:24 ` Bamvor Zhang Jian
2016-02-10 10:04 ` Linus Walleij
2015-10-22 8:32 ` [PATCH 4/6] tools/gpio: create GPIO tools Linus Walleij
2015-10-25 8:23 ` Alexandre Courbot
2015-10-22 8:32 ` Linus Walleij [this message]
2015-10-24 18:46 ` [PATCH 5/6] gpio: add a userspace character device ABI Markus Pargmann
2015-10-22 8:32 ` [PATCH 6/6] gpio: ABI: mark the sysfs ABI as obsolete Linus Walleij
2015-10-22 18:57 ` [PATCH 0/6] GPIO character device skeleton Michael Welling
2015-10-24 17:53 ` Markus Pargmann
2015-10-30 14:40 ` Linus Walleij
2015-11-02 10:00 ` Johan Hovold
2015-10-24 18:42 ` Markus Pargmann
2015-10-30 1:55 ` Alexandre Courbot
2015-10-30 19:48 ` Linus Walleij
2015-11-02 10:13 ` Johan Hovold
2015-11-03 7:23 ` Markus Pargmann
2015-11-03 12:06 ` Johan Hovold
2015-11-03 17:18 ` Linus Walleij
2015-11-04 19:44 ` Michael Welling
2015-11-05 9:40 ` Johan Hovold
2015-11-05 14:11 ` Linus Walleij
2015-11-06 10:21 ` Johan Hovold
2015-11-16 13:33 ` Linus Walleij
2015-11-03 17:05 ` Linus Walleij
2015-10-30 14:43 ` Linus Walleij
2015-10-30 22:54 ` Arnd Bergmann
2015-11-01 9:37 ` Linus Walleij
2015-11-02 10:16 ` Johan Hovold
2015-10-26 2:18 ` Mark Brown
2015-10-30 1:55 ` Alexandre Courbot
2015-10-30 19:47 ` Linus Walleij
2015-11-01 2:41 ` Mark Brown
2015-11-03 7:39 ` Markus Pargmann
2015-11-03 8:50 ` Mark Brown
2015-11-03 10:21 ` Amit Kucheria
2015-11-03 17:06 ` Linus Walleij
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=1445502750-22672-6-git-send-email-linus.walleij@linaro.org \
--to=linus.walleij@linaro.org \
--cc=acourbot@nvidia.com \
--cc=amit.kucheria@linaro.org \
--cc=arnd@arndb.de \
--cc=broonie@kernel.org \
--cc=johan@kernel.org \
--cc=linux-gpio@vger.kernel.org \
--cc=mpa@pengutronix.de \
--cc=mwelling@ieee.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).