lkml.org 
[lkml]   [2020]   [Sep]   [21]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v9 13/20] gpio: uapi: document uAPI v1 as deprecated
    Date
    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 5904f49399de..98d5aa88870b 100644
    --- a/include/uapi/linux/gpio.h
    +++ b/include/uapi/linux/gpio.h
    @@ -292,6 +292,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 */
    @@ -315,6 +318,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;
    @@ -346,6 +352,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;
    @@ -385,6 +394,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];
    @@ -404,6 +416,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;
    @@ -416,6 +431,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];
    @@ -439,6 +457,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;
    @@ -458,6 +479,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;
    @@ -482,6 +506,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
    \
     
     \ /
      Last update: 2020-09-22 04:36    [W:2.516 / U:0.164 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site