xref: /linux/Documentation/userspace-api/gpio/gpio-handle-set-line-values-ioctl.rst (revision f5c31bcf604db54470868f3118a60dc4a9ba8813)
1.. SPDX-License-Identifier: GPL-2.0
2
3.. _GPIO_HANDLE_SET_LINE_VALUES_IOCTL:
4
5*********************************
6GPIO_HANDLE_SET_LINE_VALUES_IOCTL
7*********************************
8.. warning::
9    This ioctl is part of chardev_v1.rst and is obsoleted by
10    gpio-v2-line-set-values-ioctl.rst.
11
12Name
13====
14
15GPIO_HANDLE_SET_LINE_VALUES_IOCTL - Set the values of all requested output lines.
16
17Synopsis
18========
19
20.. c:macro:: GPIO_HANDLE_SET_LINE_VALUES_IOCTL
21
22``int ioctl(int handle_fd, GPIO_HANDLE_SET_LINE_VALUES_IOCTL, struct gpiohandle_data *values)``
23
24Arguments
25=========
26
27``handle_fd``
28    The file descriptor of the GPIO character device, as returned in the
29    :c:type:`request.fd<gpiohandle_request>` by gpio-get-linehandle-ioctl.rst.
30
31``values``
32    The :c:type:`line_values<gpiohandle_data>` to set.
33
34Description
35===========
36
37Set the values of all requested output lines.
38
39Only the values of output lines may be set.
40Attempting to set the value of input lines is an error (**EPERM**).
41
42Return Value
43============
44
45On success 0.
46
47On error -1 and the ``errno`` variable is set appropriately.
48Common error codes are described in error-codes.rst.
49