Module gpiocdev_uapi::v1

This module implements GPIO ABI v1 which was released in Linux v4.8.

This ABI version is deprecated.

ABI v2 adds features and overcomes a number of bugs and limitations present in v1. Use ABI v2 instead where possible.

Structs

• ChipInfo
  Information about a particular GPIO chip.
• Errno
  An error number returned by a kernel ioctl call.
• EventRequest
  Information about a GPIO event request.
• EventRequestFlags
  Additional configuration flags for event requests.
• HandleConfig
  Updated configuration for an existing GPIO handle request.
• HandleRequest
  Information about a GPIO line handle request.
• HandleRequestFlags
  Configuration flags for requested lines.
• LineEdgeEvent
  Information about an edge event on a requested line.
• LineInfo
  Information about a certain GPIO line.
• LineInfoChangeEvent
  Information about a change in status of a GPIO line.
• LineInfoFlags
  Flags indicating the configuration of a line.
• LineValues
  The logical values of the requested lines.
• Name
  A uAPI name string, common to ABI v1 and v2.
• Offsets
  A collection of line offsets.
• UnderReadError
  A failure to read sufficient bytes to construct an object.
• ValidationError
  A failure to validate a struct returned from a system call.

Enums

• Error
  Errors returned by gpiocdev_uapi functions.
• LineEdgeEventKind
  The trigger identifier for a LineEdgeEvent.
• LineInfoChangeKind
  The trigger identifier for a LineInfoChangeEvent.

Constants

• NAME_LEN_MAX
  The maximum number of bytes stored in a Name.
• NUM_LINES_MAX
  The maximum number of lines that may be requested in a single request.

Functions

• get_chip_info
  Get the publicly available information for a chip.
• get_line_event
  Request a line with edge detection enabled.
• get_line_handle
  Request a line or set of lines for exclusive access.
• get_line_info
  Get the publicly available information for a line.
• get_line_values
  Read the values of requested lines.
• has_event
  Check if the file has an event available to read.
• read_event
  Read an event from a chip or request file descriptor.
• set_line_config
  Update the configuration of an existing handle or event request.
• set_line_values
  Set the values of requested lines.
• unwatch_line_info
  Remove any watch on changes to the LineInfo for a line.
• wait_event
  Wait for the file to have an event available to read.
• watch_line_info
  Add a watch on changes to the LineInfo for a line.

Type Aliases

• Offset
  An identifier for a line on a particular chip.
• Result
  The result returned by gpiocdev_uapi functions.
• ValidationResult
  Result returned by struct validators.