Documentation: gpio: describe uAPI behaviour for unsupported config
authorKent Gibson <warthog618@gmail.com>
Tue, 23 Jan 2024 13:38:28 +0000 (21:38 +0800)
committerBartosz Golaszewski <bartosz.golaszewski@linaro.org>
Thu, 25 Jan 2024 08:42:25 +0000 (09:42 +0100)
commit42969726a19f796f0e731ec74347fd8a0e4e91a2
tree1765cae3feb5d2b52c780389d26ed39f027e60ee
parent3473765920eaa4e7d71a0e4869937d2117bb0398
Documentation: gpio: describe uAPI behaviour for unsupported config

The existing uAPI documentation does not adequately describe how the kernel
handles the case where the underlying hardware or driver does not support
the requested configuration.

Add a Configuration Support section describing that behaviour to both the
v1 and v2 documentation, and better document the errors returned where the
requested configuration cannot be supported.

Signed-off-by: Kent Gibson <warthog618@gmail.com>
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
Documentation/userspace-api/gpio/error-codes.rst
Documentation/userspace-api/gpio/gpio-get-lineevent-ioctl.rst
Documentation/userspace-api/gpio/gpio-get-linehandle-ioctl.rst
Documentation/userspace-api/gpio/gpio-handle-set-config-ioctl.rst
Documentation/userspace-api/gpio/gpio-v2-get-line-ioctl.rst
Documentation/userspace-api/gpio/gpio-v2-line-set-config-ioctl.rst