1 .. SPDX-License-Identifier: GPL-2.0 1 .. SPDX-License-Identifier: GPL-2.0
2 2
3 .. _GPIO_V2_GET_LINEINFO_IOCTL: 3 .. _GPIO_V2_GET_LINEINFO_IOCTL:
4 4
5 ************************** 5 **************************
6 GPIO_V2_GET_LINEINFO_IOCTL 6 GPIO_V2_GET_LINEINFO_IOCTL
7 ************************** 7 **************************
8 8
9 Name 9 Name
10 ==== 10 ====
11 11
12 GPIO_V2_GET_LINEINFO_IOCTL - Get the publicly 12 GPIO_V2_GET_LINEINFO_IOCTL - Get the publicly available information for a line.
13 13
14 Synopsis 14 Synopsis
15 ======== 15 ========
16 16
17 .. c:macro:: GPIO_V2_GET_LINEINFO_IOCTL 17 .. c:macro:: GPIO_V2_GET_LINEINFO_IOCTL
18 18
19 ``int ioctl(int chip_fd, GPIO_V2_GET_LINEINFO_ 19 ``int ioctl(int chip_fd, GPIO_V2_GET_LINEINFO_IOCTL, struct gpio_v2_line_info *info)``
20 20
21 Arguments 21 Arguments
22 ========= 22 =========
23 23
24 ``chip_fd`` 24 ``chip_fd``
25 The file descriptor of the GPIO character 25 The file descriptor of the GPIO character device returned by `open()`.
26 26
27 ``info`` 27 ``info``
28 The :c:type:`line_info<gpio_v2_line_info>` 28 The :c:type:`line_info<gpio_v2_line_info>` to be populated, with the
29 ``offset`` field set to indicate the line 29 ``offset`` field set to indicate the line to be collected.
30 30
31 Description 31 Description
32 =========== 32 ===========
33 33
34 Get the publicly available information for a l 34 Get the publicly available information for a line.
35 35
36 This information is available independent of w 36 This information is available independent of whether the line is in use.
37 37
38 .. note:: 38 .. note::
39 The line info does not include the line va 39 The line info does not include the line value.
40 40
41 The line must be requested using gpio-v2-g 41 The line must be requested using gpio-v2-get-line-ioctl.rst to access its
42 value. 42 value.
43 43
44 Return Value 44 Return Value
45 ============ 45 ============
46 46
47 On success 0 and ``info`` is populated with th 47 On success 0 and ``info`` is populated with the chip info.
48 48
49 On error -1 and the ``errno`` variable is set 49 On error -1 and the ``errno`` variable is set appropriately.
50 Common error codes are described in error-code 50 Common error codes are described in error-codes.rst.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.