| 1 |
.. SPDX-License-Identifier: GPL-2.0 |
| 2 |
|
| 3 |
.. _GPIOHANDLE_SET_CONFIG_IOCTL: |
| 4 |
|
| 5 |
*************************** |
| 6 |
GPIOHANDLE_SET_CONFIG_IOCTL |
| 7 |
*************************** |
| 8 |
|
| 9 |
.. warning:: |
| 10 |
This ioctl is part of chardev_v1.rst and is obsoleted by |
| 11 |
gpio-v2-line-set-config-ioctl.rst. |
| 12 |
|
| 13 |
Name |
| 14 |
==== |
| 15 |
|
| 16 |
GPIOHANDLE_SET_CONFIG_IOCTL - Update the configuration of previously requested lines. |
| 17 |
|
| 18 |
Synopsis |
| 19 |
======== |
| 20 |
|
| 21 |
.. c:macro:: GPIOHANDLE_SET_CONFIG_IOCTL |
| 22 |
|
| 23 |
``int ioctl(int handle_fd, GPIOHANDLE_SET_CONFIG_IOCTL, struct gpiohandle_config *config)`` |
| 24 |
|
| 25 |
Arguments |
| 26 |
========= |
| 27 |
|
| 28 |
``handle_fd`` |
| 29 |
The file descriptor of the GPIO character device, as returned in the |
| 30 |
:c:type:`request.fd<gpiohandle_request>` by gpio-get-linehandle-ioctl.rst. |
| 31 |
|
| 32 |
``config`` |
| 33 |
The new :c:type:`configuration<gpiohandle_config>` to apply to the |
| 34 |
requested lines. |
| 35 |
|
| 36 |
Description |
| 37 |
=========== |
| 38 |
|
| 39 |
Update the configuration of previously requested lines, without releasing the |
| 40 |
line or introducing potential glitches. |
| 41 |
|
| 42 |
The configuration applies to all requested lines. |
| 43 |
|
| 44 |
The same :ref:`gpio-get-linehandle-config-rules` and |
| 45 |
:ref:`gpio-get-linehandle-config-support` that apply when requesting the |
| 46 |
lines also apply when updating the line configuration, with the additional |
| 47 |
restriction that a direction flag must be set. Requesting an invalid |
| 48 |
configuration, including without a direction flag set, is an error |
| 49 |
(**EINVAL**). |
| 50 |
|
| 51 |
The motivating use case for this command is changing direction of |
| 52 |
bi-directional lines between input and output, but it may be used more |
| 53 |
generally to move lines seamlessly from one configuration state to another. |
| 54 |
|
| 55 |
To only change the value of output lines, use |
| 56 |
gpio-handle-set-line-values-ioctl.rst. |
| 57 |
|
| 58 |
First added in 5.5. |
| 59 |
|
| 60 |
Return Value |
| 61 |
============ |
| 62 |
|
| 63 |
On success 0. |
| 64 |
|
| 65 |
On error -1 and the ``errno`` variable is set appropriately. |
| 66 |
Common error codes are described in error-codes.rst. |