Debian Codegraph @

Documentation/userspace-api/gpio/gpio-v2-line-set-values-ioctl.rst

raw
1 .. SPDX-License-Identifier: GPL-2.0
2
3 .. _GPIO_V2_LINE_SET_VALUES_IOCTL:
4
5 *****************************
6 GPIO_V2_LINE_SET_VALUES_IOCTL
7 *****************************
8
9 Name
10 ====
11
12 GPIO_V2_LINE_SET_VALUES_IOCTL - Set the values of requested output lines.
13
14 Synopsis
15 ========
16
17 .. c:macro:: GPIO_V2_LINE_SET_VALUES_IOCTL
18
19 ``int ioctl(int req_fd, GPIO_V2_LINE_SET_VALUES_IOCTL, struct gpio_v2_line_values *values)``
20
21 Arguments
22 =========
23
24 ``req_fd``
25 The file descriptor of the GPIO character device, as returned in the
26 :c:type:`request.fd<gpio_v2_line_request>` by gpio-v2-get-line-ioctl.rst.
27
28 ``values``
29 The :c:type:`line_values<gpio_v2_line_values>` to set with the ``mask`` set
30 to indicate the subset of requested lines to set and ``bits`` set to
31 indicate the new value.
32
33 Description
34 ===========
35
36 Set the values of requested output lines.
37
38 The values set are logical, indicating if the line is to be active or inactive.
39 The ``GPIO_V2_LINE_FLAG_ACTIVE_LOW`` flag controls the mapping between logical
40 values (active/inactive) and physical values (high/low).
41 If ``GPIO_V2_LINE_FLAG_ACTIVE_LOW`` is not set then active is high and inactive
42 is low. If ``GPIO_V2_LINE_FLAG_ACTIVE_LOW`` is set then active is low and
43 inactive is high.
44
45 Only the values of output lines may be set.
46 Attempting to set the value of an input line is an error (**EPERM**).
47
48 Return Value
49 ============
50
51 On success 0.
52
53 On error -1 and the ``errno`` variable is set appropriately.
54 Common error codes are described in error-codes.rst.