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

Source file repositories/reference/linux-study-clean/Documentation/userspace-api/gpio/gpio-v2-line-get-values-ioctl.rst

File Facts

System
Linux kernel
Corpus path
Documentation/userspace-api/gpio/gpio-v2-line-get-values-ioctl.rst
Extension
.rst
Size
1741 bytes
Lines
59
Domain
Support Tooling And Documentation
Bucket
Documentation
Inferred role
Support Tooling And Documentation: documentation
Status
atlas-only

Why This File Exists

Repository support layer: documentation, build tooling, samples, user-space helper tools, generated initramfs support, licenses, and validation utilities.

Dependency Surface

Detected Declarations

Annotated Snippet

.. SPDX-License-Identifier: GPL-2.0

.. _GPIO_V2_LINE_GET_VALUES_IOCTL:

*****************************
GPIO_V2_LINE_GET_VALUES_IOCTL
*****************************

Name
====

GPIO_V2_LINE_GET_VALUES_IOCTL - Get the values of requested lines.

Synopsis
========

.. c:macro:: GPIO_V2_LINE_GET_VALUES_IOCTL

``int ioctl(int req_fd, GPIO_V2_LINE_GET_VALUES_IOCTL, struct gpio_v2_line_values *values)``

Arguments
=========

``req_fd``
    The file descriptor of the GPIO character device, as returned in the
    :c:type:`request.fd<gpio_v2_line_request>` by gpio-v2-get-line-ioctl.rst.

``values``
    The :c:type:`line_values<gpio_v2_line_values>` to get with the ``mask`` set
    to indicate the subset of requested lines to get.

Description
===========

Get the values of requested lines.

The values returned are logical, indicating if the line is active or inactive.
The ``GPIO_V2_LINE_FLAG_ACTIVE_LOW`` flag controls the mapping between physical
values (high/low) and logical values (active/inactive).
If ``GPIO_V2_LINE_FLAG_ACTIVE_LOW`` is not set then high is active and low is
inactive.  If ``GPIO_V2_LINE_FLAG_ACTIVE_LOW`` is set then low is active and
high is inactive.

The values of both input and output lines may be read.

For output lines, the value returned is driver and configuration dependent and
may be either the output buffer (the last requested value set) or the input
buffer (the actual level of the line), and depending on the hardware and
configuration these may differ.

Return Value
============

On success 0 and the corresponding :c:type:`values.bits<gpio_v2_line_values>`
contain the value read.

On error -1 and the ``errno`` variable is set appropriately.
Common error codes are described in error-codes.rst.

Annotation

Implementation Notes