renegade-project/linux-next
2
0
Fork 0
mirror of https://github.com/edk2-porting/linux-next.git synced 2025-01-04 03:33:58 +08:00
Code

gpio: uapi: document uAPI v1 as deprecated

Browse Source 
Update uAPI documentation to deprecate v1 structs and ioctls.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>
This commit is contained in:
Kent Gibson 2020-09-28 08:28:00 +08:00 committed by Bartosz Golaszewski
parent 65cff70464
commit b234d233fe
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
include/uapi/linux/gpio.h
View File

@ -292,6 +292,9 @@ struct gpio_v2_line_event {
/* /*
* ABI v1 * ABI v1
*
* This version of the ABI is deprecated.
* Use the latest version of the ABI, defined above, instead.
*/ */
/* Informational flags */ /* Informational flags */
@ -315,6 +318,9 @@ struct gpio_v2_line_event {
* @consumer: a functional name for the consumer of this GPIO line as set by * @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 * 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 * 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 { struct gpioline_info {
__u32 line_offset; __u32 line_offset;
@ -346,6 +352,9 @@ enum {
* guarantee there are no implicit holes between it and subsequent members. * 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 * 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. * 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_changed {
struct gpioline_info info; struct gpioline_info info;
@ -385,6 +394,9 @@ struct gpioline_info_changed {
* @fd: if successful this field will contain a valid anonymous file handle * @fd: if successful this field will contain a valid anonymous file handle
* after a GPIO_GET_LINEHANDLE_IOCTL operation, zero or negative value * after a GPIO_GET_LINEHANDLE_IOCTL operation, zero or negative value
* means error * means error
*
* This struct is part of ABI v1 and is deprecated.
* Use struct gpio_v2_line_request instead.
*/ */
struct gpiohandle_request { struct gpiohandle_request {
__u32 lineoffsets[GPIOHANDLES_MAX]; __u32 lineoffsets[GPIOHANDLES_MAX];
@ -404,6 +416,9 @@ struct gpiohandle_request {
* this specifies the default output value, should be 0 (low) or * 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) * 1 (high), anything else than 0 or 1 will be interpreted as 1 (high)
* @padding: reserved for future use and should be zero filled * @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 { struct gpiohandle_config {
__u32 flags; __u32 flags;
@ -416,6 +431,9 @@ struct gpiohandle_config {
* @values: when getting the state of lines this contains the current * @values: when getting the state of lines this contains the current
* state of a line, when setting the state of lines these should contain * state of a line, when setting the state of lines these should contain
* the desired target state * the desired target state
*
* This struct is part of ABI v1 and is deprecated.
* Use struct gpio_v2_line_values instead.
*/ */
struct gpiohandle_data { struct gpiohandle_data {
__u8 values[GPIOHANDLES_MAX]; __u8 values[GPIOHANDLES_MAX];
@ -439,6 +457,9 @@ struct gpiohandle_data {
* @fd: if successful this field will contain a valid anonymous file handle * @fd: if successful this field will contain a valid anonymous file handle
* after a GPIO_GET_LINEEVENT_IOCTL operation, zero or negative value * after a GPIO_GET_LINEEVENT_IOCTL operation, zero or negative value
* means error * means error
*
* This struct is part of ABI v1 and is deprecated.
* Use struct gpio_v2_line_request instead.
*/ */
struct gpioevent_request { struct gpioevent_request {
__u32 lineoffset; __u32 lineoffset;
@ -458,6 +479,9 @@ struct gpioevent_request {
* struct gpioevent_data - The actual event being pushed to userspace * struct gpioevent_data - The actual event being pushed to userspace
* @timestamp: best estimate of time of event occurrence, in nanoseconds * @timestamp: best estimate of time of event occurrence, in nanoseconds
* @id: event identifier * @id: event identifier
*
* This struct is part of ABI v1 and is deprecated.
* Use struct gpio_v2_line_event instead.
*/ */
struct gpioevent_data { struct gpioevent_data {
__u64 timestamp; __u64 timestamp;
@ -482,6 +506,8 @@ struct gpioevent_data {
/* /*
* v1 ioctl()s * 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_LINEINFO_IOCTL _IOWR(0xB4, 0x02, struct gpioline_info)
#define GPIO_GET_LINEHANDLE_IOCTL _IOWR(0xB4, 0x03, struct gpiohandle_request) #define GPIO_GET_LINEHANDLE_IOCTL _IOWR(0xB4, 0x03, struct gpiohandle_request)