From: Kent Gibson <warthog618@gmail.com>
To: linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org,
bgolaszewski@baylibre.com, linus.walleij@linaro.org
Cc: Kent Gibson <warthog618@gmail.com>
Subject: [PATCH 19/22] gpio: uapi: document uAPI V1 as deprecated
Date: Tue, 23 Jun 2020 12:01:04 +0800 [thread overview]
Message-ID: <20200623040107.22270-20-warthog618@gmail.com> (raw)
In-Reply-To: <20200623040107.22270-1-warthog618@gmail.com>
Update uAPI documentation to deprecate V1 structs and ioctls.
Signed-off-by: Kent Gibson <warthog618@gmail.com>
---
include/uapi/linux/gpio.h | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
diff --git a/include/uapi/linux/gpio.h b/include/uapi/linux/gpio.h
index e4ed6f79e332..752d63f56b0d 100644
--- a/include/uapi/linux/gpio.h
+++ b/include/uapi/linux/gpio.h
@@ -238,6 +238,9 @@ struct gpioline_event {
/*
* ABI V1
+ *
+ * This version of the ABI is deprecated and will be removed in the future.
+ * Use the latest version if the ABI, defined above, instead.
*/
/* Informational flags */
@@ -261,6 +264,9 @@ struct gpioline_event {
* @consumer: a functional name for the consumer of this GPIO line as set by
* whatever is using it, will be empty if there is no current user but may
* also be empty if the consumer doesn't set this up
+ *
+ * This struct part of ABI V1 and is deprecated.
+ * Use struct gpioline_info_v2 instead.
*/
struct gpioline_info {
__u32 line_offset;
@@ -292,6 +298,9 @@ enum {
* guarantee there are no implicit holes between it and subsequent members.
* The 20-byte padding at the end makes sure we don't add any implicit padding
* at the end of the structure on 64-bit architectures.
+ *
+ * This struct part of ABI V1 and is deprecated.
+ * Use struct gpioline_info_changed_v2 instead.
*/
struct gpioline_info_changed {
struct gpioline_info info;
@@ -331,6 +340,9 @@ struct gpioline_info_changed {
* @fd: if successful this field will contain a valid anonymous file handle
* after a GPIO_GET_LINEHANDLE_IOCTL operation, zero or negative value
* means error
+ *
+ * This struct part of ABI V1 and is deprecated.
+ * Use struct gpioline_request instead.
*/
struct gpiohandle_request {
__u32 lineoffsets[GPIOHANDLES_MAX];
@@ -350,6 +362,9 @@ struct gpiohandle_request {
* this specifies the default output value, should be 0 (low) or
* 1 (high), anything else than 0 or 1 will be interpreted as 1 (high)
* @padding: reserved for future use and should be zero filled
+ *
+ * This struct part of ABI V1 and is deprecated.
+ * Use struct gpioline_config instead.
*/
struct gpiohandle_config {
__u32 flags;
@@ -362,6 +377,9 @@ struct gpiohandle_config {
* @values: when getting the state of lines this contains the current
* state of a line, when setting the state of lines these should contain
* the desired target state
+ *
+ * This struct part of ABI V1 and is deprecated.
+ * Use struct gpioline_values instead.
*/
struct gpiohandle_data {
__u8 values[GPIOHANDLES_MAX];
@@ -385,6 +403,9 @@ struct gpiohandle_data {
* @fd: if successful this field will contain a valid anonymous file handle
* after a GPIO_GET_LINEEVENT_IOCTL operation, zero or negative value
* means error
+ *
+ * This struct part of ABI V1 and is deprecated.
+ * Use struct gpioline_request instead.
*/
struct gpioevent_request {
__u32 lineoffset;
@@ -404,6 +425,9 @@ struct gpioevent_request {
* struct gpioevent_data - The actual event being pushed to userspace
* @timestamp: best estimate of time of event occurrence, in nanoseconds
* @id: event identifier
+ *
+ * This struct part of ABI V1 and is deprecated.
+ * Use struct gpioline_event instead.
*/
struct gpioevent_data {
__u64 timestamp;
@@ -428,6 +452,8 @@ struct gpioevent_data {
/*
* V1 ioctl()s
+ *
+ * These ioctl()s are deprecated. Use the V2 equivalent instead.
*/
#define GPIO_GET_LINEINFO_IOCTL _IOWR(0xB4, 0x02, struct gpioline_info)
#define GPIO_GET_LINEHANDLE_IOCTL _IOWR(0xB4, 0x03, struct gpiohandle_request)
--
2.27.0
next prev parent reply other threads:[~2020-06-23 4:03 UTC|newest]
Thread overview: 61+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-23 4:00 [PATCH 00/22] gpio: cdev: add uAPI V2 Kent Gibson
2020-06-23 4:00 ` [PATCH 01/22] gpiolib: move gpiolib-sysfs function declarations into their own header Kent Gibson
2020-06-24 13:34 ` Bartosz Golaszewski
2020-06-24 13:38 ` Kent Gibson
2020-06-23 4:00 ` [PATCH 02/22] gpiolib: cdev: sort includes Kent Gibson
2020-06-24 13:34 ` Bartosz Golaszewski
2020-06-23 4:00 ` [PATCH 03/22] gpiolib: cdev: minor indentation fixes Kent Gibson
2020-06-24 13:35 ` Bartosz Golaszewski
2020-06-23 4:00 ` [PATCH 04/22] gpiolib: cdev: refactor gpiohandle_flags_to_desc_flags Kent Gibson
2020-06-24 13:51 ` Bartosz Golaszewski
2020-06-23 4:00 ` [PATCH 05/22] gpiolib: cdev: rename 'filep' and 'filp' to 'file' to be consistent with other use Kent Gibson
2020-06-24 13:52 ` Bartosz Golaszewski
2020-06-23 4:00 ` [PATCH 06/22] gpiolib: cdev: rename numdescs to num_descs Kent Gibson
2020-06-24 13:53 ` Bartosz Golaszewski
2020-06-23 4:00 ` [PATCH 07/22] gpiolib: cdev: remove pointless decrement of i Kent Gibson
2020-06-24 13:53 ` Bartosz Golaszewski
2020-06-23 4:00 ` [PATCH 08/22] gpiolib: cdev: complete the irq/thread timestamp handshake Kent Gibson
2020-06-24 14:00 ` Bartosz Golaszewski
2020-06-24 14:08 ` Kent Gibson
2020-06-25 9:44 ` Bartosz Golaszewski
2020-06-25 10:01 ` Kent Gibson
2020-06-30 9:08 ` Bartosz Golaszewski
2020-06-23 4:00 ` [PATCH 09/22] gpiolib: cdev: rename priv to gcdev Kent Gibson
2020-06-24 14:04 ` Bartosz Golaszewski
2020-06-24 14:19 ` Kent Gibson
2020-06-24 14:20 ` Bartosz Golaszewski
2020-06-24 23:16 ` Kent Gibson
2020-06-25 10:26 ` Bartosz Golaszewski
2020-06-23 4:00 ` [PATCH 10/22] gpiolib: cdev: fix minor race in GET_LINEINFO_WATCH Kent Gibson
2020-06-24 14:05 ` Bartosz Golaszewski
2020-06-24 14:46 ` Andy Shevchenko
2020-06-24 15:57 ` Kent Gibson
2020-06-24 22:58 ` Kent Gibson
2020-06-25 8:44 ` Andy Shevchenko
2020-06-25 9:13 ` Kent Gibson
2020-06-25 9:23 ` Andy Shevchenko
2020-06-25 9:36 ` Kent Gibson
2020-06-23 4:00 ` [PATCH 11/22] gpiolib: cdev: remove recalculation of offset Kent Gibson
2020-06-30 8:56 ` Bartosz Golaszewski
2020-06-23 4:00 ` [PATCH 12/22] gpio: uapi: define GPIO_MAX_NAME_SIZE for array sizes Kent Gibson
2020-06-24 14:13 ` Bartosz Golaszewski
2020-06-23 4:00 ` [PATCH 13/22] gpio: uapi: define uAPI V2 Kent Gibson
2020-06-24 14:33 ` Andy Shevchenko
2020-06-24 15:40 ` Kent Gibson
2020-06-26 14:02 ` Kent Gibson
2020-06-24 14:36 ` Bartosz Golaszewski
2020-06-24 23:58 ` Kent Gibson
2020-06-23 4:00 ` [PATCH 14/22] gpiolib: make cdev a build option Kent Gibson
2020-06-29 14:25 ` Bartosz Golaszewski
2020-06-23 4:01 ` [PATCH 15/22] gpiolib: add build option for CDEV V1 ABI Kent Gibson
2020-06-29 14:26 ` Bartosz Golaszewski
2020-06-23 4:01 ` [PATCH 16/22] gpiolib: cdev: add V2 uAPI implementation to parity with V1 Kent Gibson
2020-06-23 17:44 ` Dan Carpenter
2020-06-23 23:23 ` Kent Gibson
2020-06-23 4:01 ` [PATCH 17/22] gpiolib: cdev: report edge detection in lineinfo Kent Gibson
2020-06-23 4:01 ` [PATCH 18/22] gpiolib: cdev: support setting debounce Kent Gibson
2020-06-23 4:01 ` Kent Gibson [this message]
2020-06-23 4:01 ` [PATCH 20/22] tools: gpio: switch tools to V2 uAPI Kent Gibson
2020-06-23 4:01 ` [PATCH 21/22] tools: gpio: add debounce support to gpio-event-mon Kent Gibson
2020-06-23 4:01 ` [PATCH 22/22] tools: gpio: support monitoring multiple lines Kent Gibson
2020-06-30 10:43 ` 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=20200623040107.22270-20-warthog618@gmail.com \
--to=warthog618@gmail.com \
--cc=bgolaszewski@baylibre.com \
--cc=linus.walleij@linaro.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).