mbox series

[libgpiod,v2,v2,0/6] tools: improvements for v2

Message ID 20220708120626.89844-1-warthog618@gmail.com
Headers show
Series tools: improvements for v2 | expand

Message

Kent Gibson July 8, 2022, 12:06 p.m. UTC 
This patch series is an optimistic reimagining of the tools intended to
simplify usage for well configured systems, i.e. for systems where lines
can be uniquely identified by name.  In such systems the chip and offset
location of the line is no longer of relevance to the user, so the tools
should be able to operate without mentioning them.
e.g.
  gpioget GPIO17

  gpioset GPIO17=active

  gpiomon --localtime GPIO17 GPIO18 

It is accepted that the kernel does not guarantee line name uniqueness
within the system, or even within a chip, and not all systems are well
configured, so the tools retain the option to identify lines by chip
and offset.  The hope and expectation is that over time systems will
become more well configured, not less, and identification of GPIO lines
by name will become the norm.

The core of the series is patch 1 which is a reworking of the tools to
support identifying lines by name, and to operate across multiple GPIO
chips if named lines are located on different chips.
The gpioset tool is extended to support toggling lines and interactive
control of line values, so some common use cases can be trivially
implemented from the command line.
e.g.
  gpioset --toggle 500ms LED=on

will blink the LED line at 1Hz, indefinitely.
More complex outputs can be generated by adding more entries to the
toggle sequence:
  gpioset --toggle 1s,2s,1s,300ms LED=on

Even more complex outputs can be generated by driving gpioset in
interactive mode from another script.

Those are the major changes.  A more complete list of the changes can be
found in the patch description.

The core tool changes are contained in patch 2.  To simplify review,
patch 1 removes old code replaced by that in patch 2 and 3.

Patch 3 updates and extends the tool tests to cover the reworked tools,
including demonstrating gpioset being driven interactively via a script.

Patch 4 adds a gpiowatch tool that monitors changes to the state line
information, similar to the gpio-watch tool in the kernel, and
patch 5 extends the test suite to cover it.

Patch 6 removes the gpiofind tool, as the other tools now perform
the name to offset search themselves.

Cheers,
Kent.

Changes V1 -> v2:
  - code formatting, particularly trying to keep to the 80 character
    limit and C style comments.
  - move global config fields into the struct config for each tool.
  - switch gpioset from readline to libedit.
  - add tests for symlink chip path behaviour.
  - long lived tools flush stdout before blocking.
  - fix copyrights
  - replace gpiosim attr lookup functions with cached values.
  - remove gpiofind


Kent Gibson (6):
  tools: remove old code to simplify review
  tools: line name focussed rework
  tools: tests for line name focussed rework
  tools: add gpiowatch
  tools: gpiowatch tests
  tools: remove gpiofind

 configure.ac               |    8 +-
 man/Makefile.am            |    2 +-
 tools/.gitignore           |    1 +
 tools/Makefile.am          |    6 +-
 tools/gpio-tools-test      |    3 -
 tools/gpio-tools-test.bats | 2639 +++++++++++++++++++++++++++---------
 tools/gpiodetect.c         |  122 +-
 tools/gpiofind.c           |   93 --
 tools/gpioget.c            |  214 +--
 tools/gpioinfo.c           |  363 +++--
 tools/gpiomon.c            |  524 ++++---
 tools/gpioset.c            |  944 +++++++++----
 tools/gpiowatch.c          |  231 ++++
 tools/tools-common.c       |  679 +++++++++-
 tools/tools-common.h       |   63 +-
 15 files changed, 4355 insertions(+), 1537 deletions(-)
 delete mode 100644 tools/gpiofind.c
 create mode 100644 tools/gpiowatch.c