Commit 5ca84d41 authored by Kent Gibson's avatar Kent Gibson Committed by Bartosz Golaszewski

Documentation: gpio: Clarify effect of active low flag on line values

The documentation does not make sufficiently clear that the uAPI deals with
logical line values, nor does it describe the influence of the active low
flag on the mapping between physical and logical line values.

Clarify the relationship between physical and logical line values and the
effect of the active low flag for ioctls passing line values.
Suggested-by: default avatarDavid C. Rankin <drankinatty@gmail.com>
Signed-off-by: default avatarKent Gibson <warthog618@gmail.com>
Link: https://lore.kernel.org/r/20240610092157.9147-2-warthog618@gmail.comSigned-off-by: default avatarBartosz Golaszewski <bartosz.golaszewski@linaro.org>
parent 3ff1180a
...@@ -36,6 +36,13 @@ Description ...@@ -36,6 +36,13 @@ Description
Get the values of all requested lines. Get the values of all requested lines.
The values returned are logical, indicating if the line is active or inactive.
The ``GPIOHANDLE_REQUEST_ACTIVE_LOW`` flag controls the mapping between physical
values (high/low) and logical values (active/inactive).
If ``GPIOHANDLE_REQUEST_ACTIVE_LOW`` is not set then high is active and
low is inactive. If ``GPIOHANDLE_REQUEST_ACTIVE_LOW`` is set then low is active
and high is inactive.
The values of both input and output lines may be read. The values of both input and output lines may be read.
For output lines, the value returned is driver and configuration dependent and For output lines, the value returned is driver and configuration dependent and
......
...@@ -36,6 +36,13 @@ Description ...@@ -36,6 +36,13 @@ Description
Set the values of all requested output lines. Set the values of all requested output lines.
The values set are logical, indicating if the line is to be active or inactive.
The ``GPIOHANDLE_REQUEST_ACTIVE_LOW`` flag controls the mapping between logical
values (active/inactive) and physical values (high/low).
If ``GPIOHANDLE_REQUEST_ACTIVE_LOW`` is not set then active is high and
inactive is low. If ``GPIOHANDLE_REQUEST_ACTIVE_LOW`` is set then active is low
and inactive is high.
Only the values of output lines may be set. Only the values of output lines may be set.
Attempting to set the value of input lines is an error (**EPERM**). Attempting to set the value of input lines is an error (**EPERM**).
......
...@@ -34,6 +34,13 @@ Description ...@@ -34,6 +34,13 @@ Description
Get the values of requested lines. Get the values of requested lines.
The values returned are logical, indicating if the line is active or inactive.
The ``GPIO_V2_LINE_FLAG_ACTIVE_LOW`` flag controls the mapping between physical
values (high/low) and logical values (active/inactive).
If ``GPIO_V2_LINE_FLAG_ACTIVE_LOW`` is not set then high is active and low is
inactive. If ``GPIO_V2_LINE_FLAG_ACTIVE_LOW`` is set then low is active and
high is inactive.
The values of both input and output lines may be read. The values of both input and output lines may be read.
For output lines, the value returned is driver and configuration dependent and For output lines, the value returned is driver and configuration dependent and
......
...@@ -35,6 +35,13 @@ Description ...@@ -35,6 +35,13 @@ Description
Set the values of requested output lines. Set the values of requested output lines.
The values set are logical, indicating if the line is to be active or inactive.
The ``GPIO_V2_LINE_FLAG_ACTIVE_LOW`` flag controls the mapping between logical
values (active/inactive) and physical values (high/low).
If ``GPIO_V2_LINE_FLAG_ACTIVE_LOW`` is not set then active is high and inactive
is low. If ``GPIO_V2_LINE_FLAG_ACTIVE_LOW`` is set then active is low and
inactive is high.
Only the values of output lines may be set. Only the values of output lines may be set.
Attempting to set the value of an input line is an error (**EPERM**). Attempting to set the value of an input line is an error (**EPERM**).
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment