Back to Linux

GPIO_HANDLE_SET_LINE_VALUES_IOCTL

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

latest1.5 KB
Original Source

.. SPDX-License-Identifier: GPL-2.0

.. _GPIO_HANDLE_SET_LINE_VALUES_IOCTL:


GPIO_HANDLE_SET_LINE_VALUES_IOCTL


.. warning:: This ioctl is part of chardev_v1.rst and is obsoleted by gpio-v2-line-set-values-ioctl.rst.

Name

GPIO_HANDLE_SET_LINE_VALUES_IOCTL - Set the values of all requested output lines.

Synopsis

.. c:macro:: GPIO_HANDLE_SET_LINE_VALUES_IOCTL

int ioctl(int handle_fd, GPIO_HANDLE_SET_LINE_VALUES_IOCTL, struct gpiohandle_data *values)

Arguments

handle_fd The file descriptor of the GPIO character device, as returned in the :c:type:request.fd<gpiohandle_request> by gpio-get-linehandle-ioctl.rst.

values The :c:type:line_values<gpiohandle_data> to set.

Description

Set the values of all requested output lines.

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

Only the values of output lines may be set. Attempting to set the value of input lines is an error (EPERM).

Return Value

On success 0.

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