gpio: uapi: document possible values of gpioevent_data.id
authorKent Gibson <warthog618@gmail.com>
Tue, 9 Jan 2024 14:02:20 +0000 (22:02 +0800)
committerBartosz Golaszewski <bartosz.golaszewski@linaro.org>
Mon, 22 Jan 2024 08:52:15 +0000 (09:52 +0100)
Clarify the possible values of event id, rather than requiring the
reader to infer.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Reviewed-by: Andy Shevchenko <andy@kernel.org>
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
include/uapi/linux/gpio.h

index 3ba8996e496cc8de8c211c79ec6ca6b0c58f36d9..e68a56969f363cf48545943c2ec71661ffce9c64 100644 (file)
@@ -490,7 +490,8 @@ 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
+ * @id: event identifier, one of %GPIOEVENT_EVENT_RISING_EDGE or
+ *  %GPIOEVENT_EVENT_FALLING_EDGE
  *
  * Note: This struct is part of ABI v1 and is deprecated.
  * Use &struct gpio_v2_line_event instead.