mirror of
https://mirrors.bfsu.edu.cn/git/linux.git
synced 2024-09-21 12:11:49 +08:00
32a0a0da53
Add documentation for the GPIO character device userspace API. Added to the userspace-api book, but also provide a link from the admin-guide book, as historically the GPIO documentation has been there. Signed-off-by: Kent Gibson <warthog618@gmail.com> Reviewed-by: Linus Walleij <linus.walleij@linaro.org> Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
42 lines
841 B
ReStructuredText
42 lines
841 B
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0
|
|
|
|
.. _GPIO_GET_CHIPINFO_IOCTL:
|
|
|
|
***********************
|
|
GPIO_GET_CHIPINFO_IOCTL
|
|
***********************
|
|
|
|
Name
|
|
====
|
|
|
|
GPIO_GET_CHIPINFO_IOCTL - Get the publicly available information for a chip.
|
|
|
|
Synopsis
|
|
========
|
|
|
|
.. c:macro:: GPIO_GET_CHIPINFO_IOCTL
|
|
|
|
``int ioctl(int chip_fd, GPIO_GET_CHIPINFO_IOCTL, struct gpiochip_info *info)``
|
|
|
|
Arguments
|
|
=========
|
|
|
|
``chip_fd``
|
|
The file descriptor of the GPIO character device returned by `open()`.
|
|
|
|
``info``
|
|
The :c:type:`chip_info<gpiochip_info>` to be populated.
|
|
|
|
Description
|
|
===========
|
|
|
|
Gets the publicly available information for a particular GPIO chip.
|
|
|
|
Return Value
|
|
============
|
|
|
|
On success 0 and ``info`` is populated with the chip info.
|
|
|
|
On error -1 and the ``errno`` variable is set appropriately.
|
|
Common error codes are described in error-codes.rst.
|