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,
	bgolaszewski@baylibre.com, linus.walleij@linaro.org
Cc: Kent Gibson <warthog618@gmail.com>
Subject: [PATCH v8 13/20] gpio: uapi: document uAPI v1 as deprecated
Date: Wed,  9 Sep 2020 18:26:33 +0800	[thread overview]
Message-ID: <20200909102640.1657622-14-warthog618@gmail.com> (raw)
In-Reply-To: <20200909102640.1657622-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 87074886e73d..8f768c66fa96 100644
--- a/include/uapi/linux/gpio.h
+++ b/include/uapi/linux/gpio.h
@@ -275,6 +275,9 @@ struct gpio_v2_line_event {
 
 /*
  *  ABI v1
+ *
+ * This version of the ABI is deprecated and will be removed in the future.
+ * Use the latest version of the ABI, defined above, instead.
  */
 
 /* Informational flags */
@@ -298,6 +301,9 @@ struct gpio_v2_line_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 is part of ABI v1 and is deprecated.
+ * Use struct gpio_v2_line_info instead.
  */
 struct gpioline_info {
 	__u32 line_offset;
@@ -329,6 +335,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 is part of ABI v1 and is deprecated.
+ * Use struct gpio_v2_line_info_changed instead.
  */
 struct gpioline_info_changed {
 	struct gpioline_info info;
@@ -368,6 +377,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 is part of ABI v1 and is deprecated.
+ * Use struct gpio_v2_line_request instead.
  */
 struct gpiohandle_request {
 	__u32 lineoffsets[GPIOHANDLES_MAX];
@@ -387,6 +399,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 is part of ABI v1 and is deprecated.
+ * Use struct gpio_v2_line_config instead.
  */
 struct gpiohandle_config {
 	__u32 flags;
@@ -399,6 +414,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 is part of ABI v1 and is deprecated.
+ * Use struct gpio_v2_line_values instead.
  */
 struct gpiohandle_data {
 	__u8 values[GPIOHANDLES_MAX];
@@ -422,6 +440,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 is part of ABI v1 and is deprecated.
+ * Use struct gpio_v2_line_request instead.
  */
 struct gpioevent_request {
 	__u32 lineoffset;
@@ -441,6 +462,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 is part of ABI v1 and is deprecated.
+ * Use struct gpio_v2_line_event instead.
  */
 struct gpioevent_data {
 	__u64 timestamp;
@@ -465,6 +489,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.28.0


  parent reply	other threads:[~2020-09-09 10:28 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-09 10:26 [PATCH v8 00/20] gpio: cdev: add uAPI v2 Kent Gibson
2020-09-09 10:26 ` [PATCH v8 01/20] gpiolib: cdev: desc_to_lineinfo should set info offset Kent Gibson
2020-09-15 10:08   ` Andy Shevchenko
2020-09-09 10:26 ` [PATCH v8 02/20] gpiolib: cdev: replace strncpy with strscpy Kent Gibson
2020-09-15 10:11   ` Andy Shevchenko
2020-09-09 10:26 ` [PATCH v8 03/20] gpio: uapi: define GPIO_MAX_NAME_SIZE for array sizes Kent Gibson
2020-09-15 10:12   ` Andy Shevchenko
2020-09-09 10:26 ` [PATCH v8 04/20] gpio: uapi: define uAPI v2 Kent Gibson
2020-09-15 10:06   ` Andy Shevchenko
2020-09-20 10:48     ` Kent Gibson
2020-09-09 10:26 ` [PATCH v8 05/20] gpiolib: make cdev a build option Kent Gibson
2020-09-15 10:12   ` Andy Shevchenko
2020-09-09 10:26 ` [PATCH v8 06/20] gpiolib: add build option for CDEV v1 ABI Kent Gibson
2020-09-15 10:15   ` Andy Shevchenko
2020-09-09 10:26 ` [PATCH v8 07/20] gpiolib: cdev: support GPIO_V2_GET_LINE_IOCTL and GPIO_V2_LINE_GET_VALUES_IOCTL Kent Gibson
2020-09-15 15:29   ` Andy Shevchenko
2020-09-09 10:26 ` [PATCH v8 08/20] gpiolib: cdev: support GPIO_V2_GET_LINEINFO_IOCTL and GPIO_V2_GET_LINEINFO_WATCH_IOCTL Kent Gibson
2020-09-09 10:26 ` [PATCH v8 09/20] gpiolib: cdev: support edge detection for uAPI v2 Kent Gibson
2020-09-15 10:39   ` Andy Shevchenko
2020-09-18 12:44     ` Kent Gibson
2020-09-18 14:00       ` Andy Shevchenko
2020-09-20 11:23     ` Kent Gibson
2020-09-09 10:26 ` [PATCH v8 10/20] gpiolib: cdev: support GPIO_V2_LINE_SET_CONFIG_IOCTL Kent Gibson
2020-09-09 10:26 ` [PATCH v8 11/20] gpiolib: cdev: support GPIO_V2_LINE_SET_VALUES_IOCTL Kent Gibson
2020-09-09 10:26 ` [PATCH v8 12/20] gpiolib: cdev: support setting debounce Kent Gibson
2020-09-09 10:26 ` Kent Gibson [this message]
2020-09-09 10:26 ` [PATCH v8 14/20] tools: gpio: port lsgpio to v2 uAPI Kent Gibson
2020-09-09 10:26 ` [PATCH v8 15/20] tools: gpio: port gpio-watch " Kent Gibson
2020-09-09 10:26 ` [PATCH v8 16/20] tools: gpio: rename nlines to num_lines Kent Gibson
2020-09-09 10:26 ` [PATCH v8 17/20] tools: gpio: port gpio-hammer to v2 uAPI Kent Gibson
2020-09-09 10:26 ` [PATCH v8 18/20] tools: gpio: port gpio-event-mon " Kent Gibson
2020-09-09 10:26 ` [PATCH v8 19/20] tools: gpio: add multi-line monitoring to gpio-event-mon Kent Gibson
2020-09-09 10:26 ` [PATCH v8 20/20] tools: gpio: add debounce support " Kent Gibson
2020-09-14 12:45 ` [PATCH v8 00/20] gpio: cdev: add uAPI v2 Bartosz Golaszewski
2020-09-14 12:47 ` 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=20200909102640.1657622-14-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).