* [libgpiod v2][PATCH v3 0/5] tools: improvements for v2
@ 2022-10-11 0:29 Kent Gibson
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 1/5] tools: remove old code to simplify review Kent Gibson
` (4 more replies)
0 siblings, 5 replies; 16+ messages in thread
From: Kent Gibson @ 2022-10-11 0:29 UTC (permalink / raw)
To: linux-gpio, brgl; +Cc: Kent Gibson
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 1 also removes gpiofind, as that tools functionality is absorbed
by the other commands, particularly gpioinfo.
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.
Cheers,
Kent.
Changes v2 -> v3:
- squash removal of gpiofind into patch 1 (was patch 6).
- rebase to C API line_config changes.
- rework line name to chip/offset resolution to improve clarity and
better handle corner cases.
- drop bias=as-is as a command line option as that is the default
behaviour.
- revise gpioinfo output format to combine the used flag and consumer
name, and to remove the brackets around the list of attributes.
- gpiowatch: rework so it is more like gpiomon than the Linux gpio-watch
tool. More details in patch 4.
- quote text from the command line when used in error messages.
- improve test suite coverage of corner cases.
- gpiomon: rename --edge option to --edges, and drop "-edges" from the
possible values, e.g. --edges=rising.
- add hte support to gpiomon.
- gpiomon: decouple selection of event clock from timestamp output
formatting.
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 (5):
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
configure.ac | 8 +-
man/Makefile.am | 2 +-
tools/.gitignore | 2 +-
tools/Makefile.am | 6 +-
tools/gpio-tools-test | 3 -
tools/gpio-tools-test.bats | 2970 ++++++++++++++++++++++++++++--------
tools/gpiodetect.c | 122 +-
tools/gpiofind.c | 93 --
tools/gpioget.c | 231 +--
tools/gpioinfo.c | 373 +++--
tools/gpiomon.c | 566 ++++---
tools/gpioset.c | 955 +++++++++---
tools/gpiowatch.c | 433 ++++++
tools/tools-common.c | 732 ++++++++-
tools/tools-common.h | 99 +-
15 files changed, 4993 insertions(+), 1602 deletions(-)
delete mode 100644 tools/gpiofind.c
create mode 100644 tools/gpiowatch.c
--
2.38.0
^ permalink raw reply [flat|nested] 16+ messages in thread
* [libgpiod v2][PATCH v3 1/5] tools: remove old code to simplify review
2022-10-11 0:29 [libgpiod v2][PATCH v3 0/5] tools: improvements for v2 Kent Gibson
@ 2022-10-11 0:29 ` Kent Gibson
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 2/5] tools: line name focussed rework Kent Gibson
` (3 subsequent siblings)
4 siblings, 0 replies; 16+ messages in thread
From: Kent Gibson @ 2022-10-11 0:29 UTC (permalink / raw)
To: linux-gpio, brgl; +Cc: Kent Gibson
Remove functions that are so heavily modified in the subsequent patch
that they are effectively complete re-writes, so the old code just
obfuscates the new.
The gpiofind tool is removed completely, as its functionality is
absorbed into the other tools.
Signed-off-by: Kent Gibson <warthog618@gmail.com>
---
man/Makefile.am | 2 +-
tools/.gitignore | 1 -
tools/Makefile.am | 4 +-
tools/gpio-tools-test.bats | 893 -------------------------------------
tools/gpiodetect.c | 79 ----
tools/gpiofind.c | 93 ----
tools/gpioget.c | 153 -------
tools/gpioinfo.c | 240 ----------
tools/gpiomon.c | 314 -------------
tools/gpioset.c | 330 --------------
tools/tools-common.c | 81 ----
11 files changed, 2 insertions(+), 2188 deletions(-)
delete mode 100644 tools/gpiofind.c
diff --git a/man/Makefile.am b/man/Makefile.am
index 4d2c29b..8d1d9b3 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -3,7 +3,7 @@
if WITH_MANPAGES
-dist_man1_MANS = gpiodetect.man gpioinfo.man gpioget.man gpioset.man gpiofind.man gpiomon.man
+dist_man1_MANS = gpiodetect.man gpioinfo.man gpioget.man gpioset.man gpiomon.man
%.man: $(top_builddir)/tools/$(*F)
help2man $(top_builddir)/tools/$(*F) --include=$(srcdir)/template --output=$(builddir)/$@ --no-info
diff --git a/tools/.gitignore b/tools/.gitignore
index 0d53de9..d6b2f44 100644
--- a/tools/.gitignore
+++ b/tools/.gitignore
@@ -6,4 +6,3 @@ gpioinfo
gpioget
gpioset
gpiomon
-gpiofind
diff --git a/tools/Makefile.am b/tools/Makefile.am
index 4a13266..fc074b9 100644
--- a/tools/Makefile.am
+++ b/tools/Makefile.am
@@ -9,7 +9,7 @@ libtools_common_la_SOURCES = tools-common.c tools-common.h
LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la
-bin_PROGRAMS = gpiodetect gpioinfo gpioget gpioset gpiomon gpiofind
+bin_PROGRAMS = gpiodetect gpioinfo gpioget gpioset gpiomon
gpiodetect_SOURCES = gpiodetect.c
@@ -21,8 +21,6 @@ gpioset_SOURCES = gpioset.c
gpiomon_SOURCES = gpiomon.c
-gpiofind_SOURCES = gpiofind.c
-
EXTRA_DIST = gpio-tools-test gpio-tools-test.bats
if WITH_TESTS
diff --git a/tools/gpio-tools-test.bats b/tools/gpio-tools-test.bats
index a259eae..d200df1 100755
--- a/tools/gpio-tools-test.bats
+++ b/tools/gpio-tools-test.bats
@@ -220,896 +220,3 @@ teardown() {
gpiosim_cleanup
}
-#
-# gpiodetect test cases
-#
-
-@test "gpiodetect: list chips" {
- gpiosim_chip sim0 num_lines=4
- gpiosim_chip sim1 num_lines=8
- gpiosim_chip sim2 num_lines=16
-
- run_tool gpiodetect
-
- test "$status" -eq 0
- output_contains_line "$(gpiosim_chip_name sim0) [$(gpiosim_dev_name sim0)-node0] (4 lines)"
- output_contains_line "$(gpiosim_chip_name sim1) [$(gpiosim_dev_name sim1)-node0] (8 lines)"
- output_contains_line "$(gpiosim_chip_name sim2) [$(gpiosim_dev_name sim2)-node0] (16 lines)"
-}
-
-@test "gpiodetect: invalid args" {
- run_tool gpiodetect unimplemented-arg
- test "$status" -eq 1
-}
-
-#
-# gpioinfo test cases
-#
-
-@test "gpioinfo: dump all chips" {
- gpiosim_chip sim0 num_lines=4
- gpiosim_chip sim1 num_lines=8
-
- run_tool gpioinfo
-
- test "$status" -eq 0
- output_contains_line "$(gpiosim_chip_name sim0) - 4 lines:"
- output_contains_line "$(gpiosim_chip_name sim1) - 8 lines:"
-
- output_regex_match "\\s+line\\s+0:\\s+unnamed\\s+unused\\s+input\\s+active-high"
- output_regex_match "\\s+line\\s+7:\\s+unnamed\\s+unused\\s+input\\s+active-high"
-}
-
-@test "gpioinfo: dump all chips with one line exported" {
- gpiosim_chip sim0 num_lines=4
- gpiosim_chip sim1 num_lines=8
-
- coproc_run_tool gpioset --mode=signal --active-low "$(gpiosim_chip_name sim1)" 7=1
-
- run_tool gpioinfo
-
- test "$status" -eq 0
- output_contains_line "$(gpiosim_chip_name sim0) - 4 lines:"
- output_contains_line "$(gpiosim_chip_name sim1) - 8 lines:"
- output_regex_match "\\s+line\\s+0:\\s+unnamed\\s+unused\\s+input\\s+active-high"
- output_regex_match "\\s+line\\s+7:\\s+unnamed\\s+\\\"gpioset\\\"\\s+output\\s+active-low"
-
- coproc_tool_kill
- coproc_tool_wait
-}
-
-@test "gpioinfo: dump one chip" {
- gpiosim_chip sim0 num_lines=8
- gpiosim_chip sim1 num_lines=4
-
- run_tool gpioinfo "$(gpiosim_chip_name sim1)"
-
- test "$status" -eq 0
- assert_fail output_contains_line "$(gpiosim_chip_name sim0) - 8 lines:"
- output_contains_line "$(gpiosim_chip_name sim1) - 4 lines:"
- output_regex_match "\\s+line\\s+0:\\s+unnamed\\s+unused\\s+input\\s+active-high"
- assert_fail output_regex_match "\\s+line\\s+7:\\s+unnamed\\s+unused\\s+input\\s+active-high"
-}
-
-@test "gpioinfo: dump all but one chip" {
- gpiosim_chip sim0 num_lines=4
- gpiosim_chip sim1 num_lines=4
- gpiosim_chip sim2 num_lines=8
- gpiosim_chip sim3 num_lines=4
-
- run_tool gpioinfo "$(gpiosim_chip_name sim0)" \
- "$(gpiosim_chip_name sim1)" "$(gpiosim_chip_name sim3)"
-
- test "$status" -eq 0
- output_contains_line "$(gpiosim_chip_name sim0) - 4 lines:"
- output_contains_line "$(gpiosim_chip_name sim1) - 4 lines:"
- assert_fail output_contains_line "$(gpiosim_chip_name sim2) - 8 lines:"
- output_contains_line "$(gpiosim_chip_name sim3) - 4 lines:"
- output_regex_match "\\s+line\\s+0:\\s+unnamed\\s+unused\\s+input\\s+active-high"
- assert_fail output_regex_match "\\s+line\\s+7:\\s+unnamed\\s+unused\\s+input\\s+active-high"
-}
-
-@test "gpioinfo: inexistent chip" {
- run_tool gpioinfo "inexistent"
-
- test "$status" -eq 1
-}
-
-#
-# gpiofind test cases
-#
-
-@test "gpiofind: line found" {
- gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=3:bar
- gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=4:xyz line_name=7:foobar
- gpiosim_chip sim2 num_lines=16
-
- run_tool gpiofind foobar
-
- test "$status" -eq "0"
- test "$output" = "$(gpiosim_chip_name sim1) 7"
-}
-
-@test "gpiofind: line not found" {
- gpiosim_chip sim0 num_lines=4
- gpiosim_chip sim1 num_lines=8
- gpiosim_chip sim2 num_lines=16
-
- run_tool gpiofind nonexistent-line
-
- test "$status" -eq "1"
-}
-
-@test "gpiofind: invalid args" {
- run_tool gpiodetect unimplemented-arg
- test "$status" -eq 1
-}
-
-#
-# gpioget test cases
-#
-
-@test "gpioget: read all lines" {
- gpiosim_chip sim0 num_lines=8
-
- gpiosim_set_pull sim0 2 pull-up
- gpiosim_set_pull sim0 3 pull-up
- gpiosim_set_pull sim0 5 pull-up
- gpiosim_set_pull sim0 7 pull-up
-
- run_tool gpioget "$(gpiosim_chip_name sim0)" 0 1 2 3 4 5 6 7
-
- test "$status" -eq "0"
- test "$output" = "0 0 1 1 0 1 0 1"
-}
-
-@test "gpioget: read all lines (active-low)" {
- gpiosim_chip sim0 num_lines=8
-
- gpiosim_set_pull sim0 2 pull-up
- gpiosim_set_pull sim0 3 pull-up
- gpiosim_set_pull sim0 5 pull-up
- gpiosim_set_pull sim0 7 pull-up
-
- run_tool gpioget --active-low "$(gpiosim_chip_name sim0)" 0 1 2 3 4 5 6 7
-
- test "$status" -eq "0"
- test "$output" = "1 1 0 0 1 0 1 0"
-}
-
-@test "gpioget: read all lines (pull-up)" {
- gpiosim_chip sim0 num_lines=8
-
- gpiosim_set_pull sim0 2 pull-up
- gpiosim_set_pull sim0 3 pull-up
- gpiosim_set_pull sim0 5 pull-up
- gpiosim_set_pull sim0 7 pull-up
-
- run_tool gpioget --bias=pull-up "$(gpiosim_chip_name sim0)" 0 1 2 3 4 5 6 7
-
- test "$status" -eq "0"
- test "$output" = "1 1 1 1 1 1 1 1"
-}
-
-@test "gpioget: read all lines (pull-down)" {
- gpiosim_chip sim0 num_lines=8
-
- gpiosim_set_pull sim0 2 pull-up
- gpiosim_set_pull sim0 3 pull-up
- gpiosim_set_pull sim0 5 pull-up
- gpiosim_set_pull sim0 7 pull-up
-
- run_tool gpioget --bias=pull-down "$(gpiosim_chip_name sim0)" 0 1 2 3 4 5 6 7
-
- test "$status" -eq "0"
- test "$output" = "0 0 0 0 0 0 0 0"
-}
-
-@test "gpioget: read some lines" {
- gpiosim_chip sim0 num_lines=8
-
- gpiosim_set_pull sim0 1 pull-up
- gpiosim_set_pull sim0 4 pull-up
- gpiosim_set_pull sim0 6 pull-up
-
- run_tool gpioget "$(gpiosim_chip_name sim0)" 0 1 4 6
-
- test "$status" -eq "0"
- test "$output" = "0 1 1 1"
-}
-
-@test "gpioget: no arguments" {
- run_tool gpioget
-
- test "$status" -eq "1"
- output_regex_match ".*gpiochip must be specified"
-}
-
-@test "gpioget: no lines specified" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpioget "$(gpiosim_chip_name sim0)"
-
- test "$status" -eq "1"
- output_regex_match ".*at least one GPIO line offset must be specified"
-}
-
-@test "gpioget: too many lines specified" {
- gpiosim_chip sim0 num_lines=4
-
- run_tool gpioget "$(gpiosim_chip_name sim0)" 0 1 2 3 4
-
- test "$status" -eq "1"
- output_regex_match ".*unable to request lines.*"
-}
-
-@test "gpioget: same line twice" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpioget "$(gpiosim_chip_name sim0)" 0 0
-
- test "$status" -eq "1"
- output_regex_match ".*offsets must be unique"
-}
-
-@test "gpioget: invalid bias" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpioget --bias=bad "$(gpiosim_chip_name sim0)" 0 1
-
- test "$status" -eq "1"
- output_regex_match ".*invalid bias.*"
-}
-
-#
-# gpioset test cases
-#
-
-@test "gpioset: set lines and wait for SIGTERM" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpioset --mode=signal "$(gpiosim_chip_name sim0)" \
- 0=0 1=0 2=1 3=1 4=1 5=1 6=0 7=1
-
- gpiosim_check_value sim0 0 0
- gpiosim_check_value sim0 1 0
- gpiosim_check_value sim0 2 1
- gpiosim_check_value sim0 3 1
- gpiosim_check_value sim0 4 1
- gpiosim_check_value sim0 5 1
- gpiosim_check_value sim0 6 0
- gpiosim_check_value sim0 7 1
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
-}
-
-@test "gpioset: set lines and wait for SIGTERM (active-low)" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpioset --active-low --mode=signal "$(gpiosim_chip_name sim0)" \
- 0=0 1=0 2=1 3=1 4=1 5=1 6=0 7=1
-
- gpiosim_check_value sim0 0 1
- gpiosim_check_value sim0 1 1
- gpiosim_check_value sim0 2 0
- gpiosim_check_value sim0 3 0
- gpiosim_check_value sim0 4 0
- gpiosim_check_value sim0 5 0
- gpiosim_check_value sim0 6 1
- gpiosim_check_value sim0 7 0
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
-}
-
-@test "gpioset: set lines and wait for SIGTERM (push-pull)" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpioset --drive=push-pull --mode=signal "$(gpiosim_chip_name sim0)" \
- 0=0 1=0 2=1 3=1 4=1 5=1 6=0 7=1
-
- gpiosim_check_value sim0 0 0
- gpiosim_check_value sim0 1 0
- gpiosim_check_value sim0 2 1
- gpiosim_check_value sim0 3 1
- gpiosim_check_value sim0 4 1
- gpiosim_check_value sim0 5 1
- gpiosim_check_value sim0 6 0
- gpiosim_check_value sim0 7 1
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
-}
-
-@test "gpioset: set lines and wait for SIGTERM (open-drain)" {
- gpiosim_chip sim0 num_lines=8
-
- gpiosim_set_pull sim0 2 pull-up
- gpiosim_set_pull sim0 3 pull-up
- gpiosim_set_pull sim0 5 pull-up
- gpiosim_set_pull sim0 7 pull-up
-
- coproc_run_tool gpioset --drive=open-drain --mode=signal "$(gpiosim_chip_name sim0)" \
- 0=0 1=0 2=1 3=1 4=1 5=1 6=0 7=1
-
- gpiosim_check_value sim0 0 0
- gpiosim_check_value sim0 1 0
- gpiosim_check_value sim0 2 1
- gpiosim_check_value sim0 3 1
- gpiosim_check_value sim0 4 0
- gpiosim_check_value sim0 5 1
- gpiosim_check_value sim0 6 0
- gpiosim_check_value sim0 7 1
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
-}
-
-@test "gpioset: set lines and wait for SIGTERM (open-source)" {
- gpiosim_chip sim0 num_lines=8
-
- gpiosim_set_pull sim0 2 pull-up
- gpiosim_set_pull sim0 3 pull-up
- gpiosim_set_pull sim0 5 pull-up
- gpiosim_set_pull sim0 7 pull-up
-
- coproc_run_tool gpioset --drive=open-source --mode=signal "$(gpiosim_chip_name sim0)" \
- 0=0 1=0 2=1 3=0 4=1 5=1 6=0 7=1
-
- gpiosim_check_value sim0 0 0
- gpiosim_check_value sim0 1 0
- gpiosim_check_value sim0 2 1
- gpiosim_check_value sim0 3 1
- gpiosim_check_value sim0 4 1
- gpiosim_check_value sim0 5 1
- gpiosim_check_value sim0 6 0
- gpiosim_check_value sim0 7 1
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
-}
-
-@test "gpioset: set some lines and wait for ENTER" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpioset --mode=wait "$(gpiosim_chip_name sim0)" \
- 1=0 2=1 5=1 6=0 7=1
-
- gpiosim_check_value sim0 1 0
- gpiosim_check_value sim0 2 1
- gpiosim_check_value sim0 5 1
- gpiosim_check_value sim0 6 0
- gpiosim_check_value sim0 7 1
-
- coproc_tool_stdin_write ""
- coproc_tool_wait
-
- test "$status" -eq "0"
-}
-
-@test "gpioset: set some lines and wait for SIGINT" {
- gpiosim_chip sim0 num_lines=4
-
- coproc_run_tool gpioset --mode=signal "$(gpiosim_chip_name sim0)" 0=1
-
- gpiosim_check_value sim0 0 1
-
- coproc_tool_kill -SIGINT
- coproc_tool_wait
-
- test "$status" -eq "0"
-}
-
-@test "gpioset: set some lines and wait with --mode=time" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpioset --mode=time --sec=1 --usec=200000 \
- "$(gpiosim_chip_name sim0)" 0=1 5=0 7=1
-
- gpiosim_check_value sim0 0 1
- gpiosim_check_value sim0 5 0
- gpiosim_check_value sim0 7 1
-
- coproc_tool_wait
-
- test "$status" -eq "0"
-}
-
-@test "gpioset: no arguments" {
- run_tool gpioset
-
- test "$status" -eq "1"
- output_regex_match ".*gpiochip must be specified"
-}
-
-@test "gpioset: no lines specified" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpioset "$(gpiosim_chip_name sim1)"
-
- test "$status" -eq "1"
- output_regex_match ".*at least one GPIO line offset to value mapping must be specified"
-}
-
-@test "gpioset: too many lines specified" {
- gpiosim_chip sim0 num_lines=4
-
- run_tool gpioset "$(gpiosim_chip_name sim0)" 0=1 1=1 2=1 3=1 4=1 5=1
-
- test "$status" -eq "1"
- output_regex_match ".*unable to request lines.*"
-}
-
-@test "gpioset: use --sec without --mode=time" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpioset --mode=exit --sec=1 "$(gpiosim_chip_name sim0)" 0=1
-
- test "$status" -eq "1"
- output_regex_match ".*can't specify wait time in this mode"
-}
-
-@test "gpioset: use --usec without --mode=time" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpioset --mode=exit --usec=1 "$(gpiosim_chip_name sim1)" 0=1
-
- test "$status" -eq "1"
- output_regex_match ".*can't specify wait time in this mode"
-}
-
-@test "gpioset: default mode" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpioset "$(gpiosim_chip_name sim0)" 0=1
-
- test "$status" -eq "0"
-}
-
-@test "gpioset: invalid mapping" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpioset "$(gpiosim_chip_name sim1)" 0=c
-
- test "$status" -eq "1"
- output_regex_match ".*invalid offset<->value mapping"
-}
-
-@test "gpioset: invalid value" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpioset "$(gpiosim_chip_name sim1)" 0=3
-
- test "$status" -eq "1"
- output_regex_match ".*value must be 0 or 1"
-}
-
-@test "gpioset: invalid offset" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpioset "$(gpiosim_chip_name sim1)" 4000000000=0
-
- test "$status" -eq "1"
- output_regex_match ".*invalid offset"
-}
-
-@test "gpioset: invalid bias" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpioset --bias=bad "$(gpiosim_chip_name sim1)" 0=1 1=1
-
- test "$status" -eq "1"
- output_regex_match ".*invalid bias.*"
-}
-
-@test "gpioset: invalid drive" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpioset --drive=bad "$(gpiosim_chip_name sim1)" 0=1 1=1
-
- test "$status" -eq "1"
- output_regex_match ".*invalid drive.*"
-}
-
-@test "gpioset: daemonize in invalid mode" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpioset --background "$(gpiosim_chip_name sim1)" 0=1
-
- test "$status" -eq "1"
- output_regex_match ".*can't daemonize in this mode"
-}
-
-@test "gpioset: same line twice" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpioset "$(gpiosim_chip_name sim0)" 0=1 0=1
-
- test "$status" -eq "1"
- output_regex_match ".*offsets must be unique"
-}
-
-#
-# gpiomon test cases
-#
-
-@test "gpiomon: single rising edge event" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon --rising-edge "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- output_regex_match \
-"event:\\s+RISING\\s+EDGE\\s+offset:\\s+4\\s+timestamp:\\s+\[\s*[0-9]+\.[0-9]+\]"
-}
-
-@test "gpiomon: single falling edge event" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon --falling-edge "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-up
- gpiosim_set_pull sim0 4 pull-down
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- output_regex_match \
-"event:\\s+FALLING\\s+EDGE\\s+offset:\\s+4\\s+timestamp:\\s+\[\s*[0-9]+\.[0-9]+\]"
-}
-
-@test "gpiomon: single falling edge event (pull-up)" {
- gpiosim_chip sim0 num_lines=8
-
- gpiosim_set_pull sim0 4 pull-down
-
- coproc_run_tool gpiomon --bias=pull-up "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-down
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- output_regex_match \
-"event:\\s+FALLING\\s+EDGE\\s+offset:\\s+4\\s+timestamp:\\s+\[\s*[0-9]+\.[0-9]+\]"
-}
-
-@test "gpiomon: single rising edge event (pull-down)" {
- gpiosim_chip sim0 num_lines=8
-
- gpiosim_set_pull sim0 4 pull-up
-
- coproc_run_tool gpiomon --bias=pull-down "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- output_regex_match \
-"event:\\s+RISING\\s+EDGE\\s+offset:\\s+4\\s+timestamp:\\s+\[\s*[0-9]+\.[0-9]+\]"
-}
-
-@test "gpiomon: single rising edge event (active-low)" {
- gpiosim_chip sim0 num_lines=8
-
- gpiosim_set_pull sim0 4 pull-up
-
- coproc_run_tool gpiomon --rising-edge --active-low "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-down
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- output_regex_match \
-"event:\\s+RISING\\s+EDGE\\s+offset:\\s+4\\s+timestamp:\\s+\[\s*[0-9]+\.[0-9]+\]"
-}
-
-@test "gpiomon: single rising edge event (silent mode)" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon --rising-edge --silent "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- test -z "$output"
-}
-
-@test "gpiomon: four alternating events" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon --num-events=4 "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
- gpiosim_set_pull sim0 4 pull-down
- sleep 0.2
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
- gpiosim_set_pull sim0 4 pull-down
- sleep 0.2
-
- coproc_tool_wait
-
- test "$status" -eq "0"
- output_regex_match \
-"event\\:\\s+FALLING\\s+EDGE\\s+offset\\:\\s+4\\s+timestamp:\\s+\\[\s*[0-9]+\\.[0-9]+\\]"
- output_regex_match \
-"event\\:\\s+RISING\\s+EDGE\\s+offset\\:\\s+4\\s+timestamp:\\s+\\[\s*[0-9]+\\.[0-9]+\\]"
-}
-
-@test "gpiomon: exit after SIGINT" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon "$(gpiosim_chip_name sim0)" 4
-
- coproc_tool_kill -SIGINT
- coproc_tool_wait
-
- test "$status" -eq "0"
- test -z "$output"
-}
-
-@test "gpiomon: exit after SIGTERM" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon "$(gpiosim_chip_name sim0)" 4
-
- coproc_tool_kill -SIGTERM
- coproc_tool_wait
-
- test "$status" -eq "0"
- test -z "$output"
-}
-
-@test "gpiomon: both event flags" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon --falling-edge --rising-edge "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
- gpiosim_set_pull sim0 4 pull-down
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- output_regex_match \
-"event\\:\\s+FALLING\\s+EDGE\\s+offset\\:\\s+4\\s+timestamp:\\s+\\[\s*[0-9]+\\.[0-9]+\\]"
- output_regex_match \
-"event\\:\\s+RISING\\s+EDGE\\s+offset\\:\\s+4\\s+timestamp:\\s+\\[\s*[0-9]+\\.[0-9]+\\]"
-}
-
-@test "gpiomon: watch multiple lines" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon --format=%o "$(gpiosim_chip_name sim0)" 1 2 3 4 5
-
- gpiosim_set_pull sim0 2 pull-up
- gpiosim_set_pull sim0 3 pull-up
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- test "${lines[0]}" = "2"
- test "${lines[1]}" = "3"
- test "${lines[2]}" = "4"
-}
-
-@test "gpiomon: watch multiple lines (lines in mixed-up order)" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon --format=%o "$(gpiosim_chip_name sim0)" 5 2 7 1 6
-
- gpiosim_set_pull sim0 2 pull-up
- gpiosim_set_pull sim0 1 pull-up
- gpiosim_set_pull sim0 6 pull-up
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- test "${lines[0]}" = "2"
- test "${lines[1]}" = "1"
- test "${lines[2]}" = "6"
-}
-
-@test "gpiomon: same line twice" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpiomon "$(gpiosim_chip_name sim0)" 0 0
-
- test "$status" -eq "1"
- output_regex_match ".*offsets must be unique"
-}
-
-@test "gpiomon: no arguments" {
- run_tool gpiomon
-
- test "$status" -eq "1"
- output_regex_match ".*gpiochip must be specified"
-}
-
-@test "gpiomon: line not specified" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpiomon "$(gpiosim_chip_name sim0)"
-
- test "$status" -eq "1"
- output_regex_match ".*GPIO line offset must be specified"
-}
-
-@test "gpiomon: line out of range" {
- gpiosim_chip sim0 num_lines=4
-
- run_tool gpiomon "$(gpiosim_chip_name sim0)" 5
-
- test "$status" -eq "1"
- output_regex_match ".*unable to request lines"
-}
-
-@test "gpiomon: invalid bias" {
- gpiosim_chip sim0 num_lines=8
-
- run_tool gpiomon --bias=bad "$(gpiosim_chip_name sim0)" 0 1
-
- test "$status" -eq "1"
- output_regex_match ".*invalid bias.*"
-}
-
-@test "gpiomon: custom format (event type + offset)" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon "--format=%e %o" "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- test "$output" = "1 4"
-}
-
-@test "gpiomon: custom format (event type + offset joined)" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon "--format=%e%o" "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- test "$output" = "14"
-}
-
-@test "gpiomon: custom format (timestamp)" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon "--format=%e %o %s.%n" "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- output_regex_match "1 4 [0-9]+\\.[0-9]+"
-}
-
-@test "gpiomon: custom format (double percent sign)" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon "--format=%%" "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- test "$output" = "%"
-}
-
-@test "gpiomon: custom format (double percent sign + event type specifier)" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon "--format=%%e" "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- test "$output" = "%e"
-}
-
-@test "gpiomon: custom format (single percent sign)" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon "--format=%" "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- test "$output" = "%"
-}
-
-@test "gpiomon: custom format (single percent sign between other characters)" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon "--format=foo % bar" "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- test "$output" = "foo % bar"
-}
-
-@test "gpiomon: custom format (unknown specifier)" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon "--format=%x" "$(gpiosim_chip_name sim0)" 4
-
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
-
- coproc_tool_kill
- coproc_tool_wait
-
- test "$status" -eq "0"
- test "$output" = "%x"
-}
diff --git a/tools/gpiodetect.c b/tools/gpiodetect.c
index 8f6e8b3..30bde32 100644
--- a/tools/gpiodetect.c
+++ b/tools/gpiodetect.c
@@ -11,82 +11,3 @@
#include "tools-common.h"
-static const struct option longopts[] = {
- { "help", no_argument, NULL, 'h' },
- { "version", no_argument, NULL, 'v' },
- { GETOPT_NULL_LONGOPT },
-};
-
-static const char *const shortopts = "+hv";
-
-static void print_help(void)
-{
- printf("Usage: %s [OPTIONS]\n", get_progname());
- printf("\n");
- printf("List all GPIO chips, print their labels and number of GPIO lines.\n");
- printf("\n");
- printf("Options:\n");
- printf(" -h, --help:\t\tdisplay this message and exit\n");
- printf(" -v, --version:\tdisplay the version and exit\n");
-}
-
-int main(int argc, char **argv)
-{
- int optc, opti, num_chips, i;
- struct gpiod_chip *chip;
- struct gpiod_chip_info *info;
- struct dirent **entries;
-
- for (;;) {
- optc = getopt_long(argc, argv, shortopts, longopts, &opti);
- if (optc < 0)
- break;
-
- switch (optc) {
- case 'h':
- print_help();
- return EXIT_SUCCESS;
- case 'v':
- print_version();
- return EXIT_SUCCESS;
- case '?':
- die("try %s --help", get_progname());
- default:
- abort();
- }
- }
-
- argc -= optind;
- argv += optind;
-
- if (argc > 0)
- die("unrecognized argument: %s", argv[0]);
-
- num_chips = scandir("/dev/", &entries, chip_dir_filter, alphasort);
- if (num_chips < 0)
- die_perror("unable to scan /dev");
-
- for (i = 0; i < num_chips; i++) {
- chip = chip_open_by_name(entries[i]->d_name);
- if (!chip)
- die_perror("unable to open %s", entries[i]->d_name);
-
- info = gpiod_chip_get_info(chip);
- if (!info)
- die_perror("unable to get info for %s", entries[i]->d_name);
-
-
- printf("%s [%s] (%zu lines)\n",
- gpiod_chip_info_get_name(info),
- gpiod_chip_info_get_label(info),
- gpiod_chip_info_get_num_lines(info));
-
- gpiod_chip_info_free(info);
- gpiod_chip_close(chip);
- free(entries[i]);
- }
-
- free(entries);
-
- return EXIT_SUCCESS;
-}
diff --git a/tools/gpiofind.c b/tools/gpiofind.c
deleted file mode 100644
index 03b15c9..0000000
--- a/tools/gpiofind.c
+++ /dev/null
@@ -1,93 +0,0 @@
-// SPDX-License-Identifier: GPL-2.0-or-later
-// SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
-
-#include <dirent.h>
-#include <errno.h>
-#include <getopt.h>
-#include <gpiod.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-
-#include "tools-common.h"
-
-static const struct option longopts[] = {
- { "help", no_argument, NULL, 'h' },
- { "version", no_argument, NULL, 'v' },
- { GETOPT_NULL_LONGOPT },
-};
-
-static const char *const shortopts = "+hv";
-
-static void print_help(void)
-{
- printf("Usage: %s [OPTIONS] <name>\n", get_progname());
- printf("\n");
- printf("Find a GPIO line by name. The output of this command can be used as input for gpioget/set.\n");
- printf("\n");
- printf("Options:\n");
- printf(" -h, --help:\t\tdisplay this message and exit\n");
- printf(" -v, --version:\tdisplay the version and exit\n");
-}
-
-int main(int argc, char **argv)
-{
- int i, num_chips, optc, opti, offset;
- struct gpiod_chip *chip;
- struct gpiod_chip_info *info;
- struct dirent **entries;
-
- for (;;) {
- optc = getopt_long(argc, argv, shortopts, longopts, &opti);
- if (optc < 0)
- break;
-
- switch (optc) {
- case 'h':
- print_help();
- return EXIT_SUCCESS;
- case 'v':
- print_version();
- return EXIT_SUCCESS;
- case '?':
- die("try %s --help", get_progname());
- default:
- abort();
- }
- }
-
- argc -= optind;
- argv += optind;
-
- if (argc != 1)
- die("exactly one GPIO line name must be specified");
-
- num_chips = scandir("/dev/", &entries, chip_dir_filter, alphasort);
- if (num_chips < 0)
- die_perror("unable to scan /dev");
-
- for (i = 0; i < num_chips; i++) {
- chip = chip_open_by_name(entries[i]->d_name);
- if (!chip) {
- if (errno == EACCES)
- continue;
-
- die_perror("unable to open %s", entries[i]->d_name);
- }
-
- offset = gpiod_chip_get_line_offset_from_name(chip, argv[0]);
- if (offset >= 0) {
- info = gpiod_chip_get_info(chip);
- if (!info)
- die_perror("unable to get info for %s", entries[i]->d_name);
-
- printf("%s %u\n",
- gpiod_chip_info_get_name(info), offset);
- gpiod_chip_info_free(info);
- gpiod_chip_close(chip);
- return EXIT_SUCCESS;
- }
- }
-
- return EXIT_FAILURE;
-}
diff --git a/tools/gpioget.c b/tools/gpioget.c
index b68212d..1b3e666 100644
--- a/tools/gpioget.c
+++ b/tools/gpioget.c
@@ -10,156 +10,3 @@
#include "tools-common.h"
-static const struct option longopts[] = {
- { "help", no_argument, NULL, 'h' },
- { "version", no_argument, NULL, 'v' },
- { "active-low", no_argument, NULL, 'l' },
- { "dir-as-is", no_argument, NULL, 'n' },
- { "bias", required_argument, NULL, 'B' },
- { GETOPT_NULL_LONGOPT },
-};
-
-static const char *const shortopts = "+hvlnB:";
-
-static void print_help(void)
-{
- printf("Usage: %s [OPTIONS] <chip name/number> <offset 1> <offset 2> ...\n",
- get_progname());
- printf("\n");
- printf("Read line value(s) from a GPIO chip\n");
- printf("\n");
- printf("Options:\n");
- printf(" -h, --help:\t\tdisplay this message and exit\n");
- printf(" -v, --version:\tdisplay the version and exit\n");
- printf(" -l, --active-low:\tset the line active state to low\n");
- printf(" -n, --dir-as-is:\tdon't force-reconfigure line direction\n");
- printf(" -B, --bias=[as-is|disable|pull-down|pull-up] (defaults to 'as-is'):\n");
- printf(" set the line bias\n");
- printf("\n");
- print_bias_help();
-}
-
-int main(int argc, char **argv)
-{
- int direction = GPIOD_LINE_DIRECTION_INPUT;
- int optc, opti, bias = 0, ret, *values;
- struct gpiod_line_settings *settings;
- struct gpiod_request_config *req_cfg;
- struct gpiod_line_request *request;
- struct gpiod_line_config *line_cfg;
- struct gpiod_chip *chip;
- bool active_low = false;
- unsigned int *offsets;
- size_t i, num_lines;
- char *device, *end;
-
- for (;;) {
- optc = getopt_long(argc, argv, shortopts, longopts, &opti);
- if (optc < 0)
- break;
-
- switch (optc) {
- case 'h':
- print_help();
- return EXIT_SUCCESS;
- case 'v':
- print_version();
- return EXIT_SUCCESS;
- case 'l':
- active_low = true;
- break;
- case 'n':
- direction = GPIOD_LINE_DIRECTION_AS_IS;
- break;
- case 'B':
- bias = parse_bias(optarg);
- break;
- case '?':
- die("try %s --help", get_progname());
- default:
- abort();
- }
- }
-
- argc -= optind;
- argv += optind;
-
- if (argc < 1)
- die("gpiochip must be specified");
-
- if (argc < 2)
- die("at least one GPIO line offset must be specified");
-
- device = argv[0];
- num_lines = argc - 1;
-
- offsets = calloc(num_lines, sizeof(*offsets));
- values = calloc(num_lines, sizeof(*values));
- if (!offsets || ! values)
- die("out of memory");
-
- for (i = 0; i < num_lines; i++) {
- offsets[i] = strtoul(argv[i + 1], &end, 10);
- if (*end != '\0' || offsets[i] > INT_MAX)
- die("invalid GPIO offset: %s", argv[i + 1]);
- }
-
- if (has_duplicate_offsets(num_lines, offsets))
- die("offsets must be unique");
-
- chip = chip_open_lookup(device);
- if (!chip)
- die_perror("unable to open %s", device);
-
- settings = gpiod_line_settings_new();
- if (!settings)
- die_perror("unable to allocate line settings");
-
- gpiod_line_settings_set_direction(settings, direction);
-
- if (bias)
- gpiod_line_settings_set_bias(settings, bias);
-
- if (active_low)
- gpiod_line_settings_set_active_low(settings, active_low);
-
- req_cfg = gpiod_request_config_new();
- if (!req_cfg)
- die_perror("unable to allocate the request config structure");
-
- gpiod_request_config_set_consumer(req_cfg, "gpioget");
-
- line_cfg = gpiod_line_config_new();
- if (!line_cfg)
- die_perror("unable to allocate the line config structure");
-
- ret = gpiod_line_config_add_line_settings(line_cfg, offsets,
- num_lines, settings);
- if (ret)
- die_perror("unable to add line settings");
-
- request = gpiod_chip_request_lines(chip, req_cfg, line_cfg);
- if (!request)
- die_perror("unable to request lines");
-
- ret = gpiod_line_request_get_values(request, values);
- if (ret)
- die_perror("unable to read GPIO line values");
-
- for (i = 0; i < num_lines; i++) {
- printf("%d", values[i]);
- if (i != num_lines - 1)
- printf(" ");
- }
- printf("\n");
-
- gpiod_line_request_release(request);
- gpiod_request_config_free(req_cfg);
- gpiod_line_config_free(line_cfg);
- gpiod_line_settings_free(settings);
- gpiod_chip_close(chip);
- free(offsets);
- free(values);
-
- return EXIT_SUCCESS;
-}
diff --git a/tools/gpioinfo.c b/tools/gpioinfo.c
index fbe2a13..ae368fa 100644
--- a/tools/gpioinfo.c
+++ b/tools/gpioinfo.c
@@ -12,243 +12,3 @@
#include "tools-common.h"
-typedef bool (*is_set_func)(struct gpiod_line_info *);
-
-struct flag {
- const char *name;
- is_set_func is_set;
-};
-
-static bool line_bias_is_pullup(struct gpiod_line_info *info)
-{
- return gpiod_line_info_get_bias(info) == GPIOD_LINE_BIAS_PULL_UP;
-}
-
-static bool line_bias_is_pulldown(struct gpiod_line_info *info)
-{
- return gpiod_line_info_get_bias(info) == GPIOD_LINE_BIAS_PULL_DOWN;
-}
-
-static bool line_bias_is_disabled(struct gpiod_line_info *info)
-{
- return gpiod_line_info_get_bias(info) == GPIOD_LINE_BIAS_DISABLED;
-}
-
-static bool line_drive_is_open_drain(struct gpiod_line_info *info)
-{
- return gpiod_line_info_get_drive(info) == GPIOD_LINE_DRIVE_OPEN_DRAIN;
-}
-
-static bool line_drive_is_open_source(struct gpiod_line_info *info)
-{
- return gpiod_line_info_get_drive(info) == GPIOD_LINE_DRIVE_OPEN_SOURCE;
-}
-
-static const struct flag flags[] = {
- {
- .name = "used",
- .is_set = gpiod_line_info_is_used,
- },
- {
- .name = "open-drain",
- .is_set = line_drive_is_open_drain,
- },
- {
- .name = "open-source",
- .is_set = line_drive_is_open_source,
- },
- {
- .name = "pull-up",
- .is_set = line_bias_is_pullup,
- },
- {
- .name = "pull-down",
- .is_set = line_bias_is_pulldown,
- },
- {
- .name = "bias-disabled",
- .is_set = line_bias_is_disabled,
- },
-};
-
-static const struct option longopts[] = {
- { "help", no_argument, NULL, 'h' },
- { "version", no_argument, NULL, 'v' },
- { GETOPT_NULL_LONGOPT },
-};
-
-static const char *const shortopts = "+hv";
-
-static void print_help(void)
-{
- printf("Usage: %s [OPTIONS] <gpiochip1> ...\n", get_progname());
- printf("\n");
- printf("Print information about all lines of the specified GPIO chip(s) (or all gpiochips if none are specified).\n");
- printf("\n");
- printf("Options:\n");
- printf(" -h, --help:\t\tdisplay this message and exit\n");
- printf(" -v, --version:\tdisplay the version and exit\n");
-}
-
-static PRINTF(3, 4) void prinfo(bool *of,
- unsigned int prlen, const char *fmt, ...)
-{
- char *buf, *buffmt = NULL;
- size_t len;
- va_list va;
- int rv;
-
- va_start(va, fmt);
- rv = vasprintf(&buf, fmt, va);
- va_end(va);
- if (rv < 0)
- die("vasprintf: %s\n", strerror(errno));
-
- len = strlen(buf) - 1;
-
- if (len >= prlen || *of) {
- *of = true;
- printf("%s", buf);
- } else {
- rv = asprintf(&buffmt, "%%%us", prlen);
- if (rv < 0)
- die("asprintf: %s\n", strerror(errno));
-
- printf(buffmt, buf);
- }
-
- free(buf);
- if (fmt)
- free(buffmt);
-}
-
-static void list_lines(struct gpiod_chip *chip)
-{
- bool flag_printed, of, active_low;
- struct gpiod_chip_info *chip_info;
- struct gpiod_line_info *info;
- const char *name, *consumer;
- size_t i, offset, num_lines;
- int direction;
-
- chip_info = gpiod_chip_get_info(chip);
- if (!chip_info)
- die_perror("unable to retrieve the chip info from chip");
-
- num_lines = gpiod_chip_info_get_num_lines(chip_info);
- printf("%s - %zu lines:\n",
- gpiod_chip_info_get_name(chip_info), num_lines);
-
- for (offset = 0; offset < num_lines; offset++) {
- info = gpiod_chip_get_line_info(chip, offset);
- if (!info)
- die_perror("unable to retrieve the line info from chip");
- name = gpiod_line_info_get_name(info);
- consumer = gpiod_line_info_get_consumer(info);
- direction = gpiod_line_info_get_direction(info);
- active_low = gpiod_line_info_is_active_low(info);
-
- of = false;
-
- printf("\tline ");
- prinfo(&of, 3, "%zu", offset);
- printf(": ");
-
- name ? prinfo(&of, 12, "\"%s\"", name)
- : prinfo(&of, 12, "unnamed");
- printf(" ");
-
- if (!gpiod_line_info_is_used(info))
- prinfo(&of, 12, "unused");
- else
- consumer ? prinfo(&of, 12, "\"%s\"", consumer)
- : prinfo(&of, 12, "kernel");
-
- printf(" ");
-
- prinfo(&of, 8, "%s ", direction == GPIOD_LINE_DIRECTION_INPUT
- ? "input" : "output");
- prinfo(&of, 13, "%s ",
- active_low ? "active-low" : "active-high");
-
- flag_printed = false;
- for (i = 0; i < ARRAY_SIZE(flags); i++) {
- if (flags[i].is_set(info)) {
- if (flag_printed)
- printf(" ");
- else
- printf("[");
- printf("%s", flags[i].name);
- flag_printed = true;
- }
- }
- if (flag_printed)
- printf("]");
-
- printf("\n");
-
- gpiod_line_info_free(info);
- }
- gpiod_chip_info_free(chip_info);
-}
-
-int main(int argc, char **argv)
-{
- int num_chips, i, optc, opti;
- struct gpiod_chip *chip;
- struct dirent **entries;
-
- for (;;) {
- optc = getopt_long(argc, argv, shortopts, longopts, &opti);
- if (optc < 0)
- break;
-
- switch (optc) {
- case 'h':
- print_help();
- return EXIT_SUCCESS;
- case 'v':
- print_version();
- return EXIT_SUCCESS;
- case '?':
- die("try %s --help", get_progname());
- default:
- abort();
- }
- }
-
- argc -= optind;
- argv += optind;
-
- if (argc == 0) {
- num_chips = scandir("/dev/", &entries,
- chip_dir_filter, alphasort);
- if (num_chips < 0)
- die_perror("unable to scan /dev");
-
- for (i = 0; i < num_chips; i++) {
- chip = chip_open_by_name(entries[i]->d_name);
- if (!chip)
- die_perror("unable to open %s",
- entries[i]->d_name);
-
- list_lines(chip);
-
- gpiod_chip_close(chip);
- free(entries[i]);
- }
- free(entries);
- } else {
- for (i = 0; i < argc; i++) {
- chip = chip_open_lookup(argv[i]);
- if (!chip)
- die_perror("looking up chip %s", argv[i]);
-
- list_lines(chip);
-
- gpiod_chip_close(chip);
- }
- }
-
- return EXIT_SUCCESS;
-}
diff --git a/tools/gpiomon.c b/tools/gpiomon.c
index dff12ea..6fa19b6 100644
--- a/tools/gpiomon.c
+++ b/tools/gpiomon.c
@@ -17,317 +17,3 @@
#define EVENT_BUF_SIZE 32
-static const struct option longopts[] = {
- { "help", no_argument, NULL, 'h' },
- { "version", no_argument, NULL, 'v' },
- { "active-low", no_argument, NULL, 'l' },
- { "bias", required_argument, NULL, 'B' },
- { "num-events", required_argument, NULL, 'n' },
- { "silent", no_argument, NULL, 's' },
- { "rising-edge", no_argument, NULL, 'r' },
- { "falling-edge", no_argument, NULL, 'f' },
- { "line-buffered", no_argument, NULL, 'b' },
- { "format", required_argument, NULL, 'F' },
- { GETOPT_NULL_LONGOPT },
-};
-
-static const char *const shortopts = "+hvlB:n:srfbF:";
-
-static void print_help(void)
-{
- printf("Usage: %s [OPTIONS] <chip name/number> <offset 1> <offset 2> ...\n",
- get_progname());
- printf("\n");
- printf("Wait for events on GPIO lines and print them to standard output\n");
- printf("\n");
- printf("Options:\n");
- printf(" -h, --help:\t\tdisplay this message and exit\n");
- printf(" -v, --version:\tdisplay the version and exit\n");
- printf(" -l, --active-low:\tset the line active state to low\n");
- printf(" -B, --bias=[as-is|disable|pull-down|pull-up] (defaults to 'as-is'):\n");
- printf(" set the line bias\n");
- printf(" -n, --num-events=NUM:\texit after processing NUM events\n");
- printf(" -s, --silent:\t\tdon't print event info\n");
- printf(" -r, --rising-edge:\tonly process rising edge events\n");
- printf(" -f, --falling-edge:\tonly process falling edge events\n");
- printf(" -b, --line-buffered:\tset standard output as line buffered\n");
- printf(" -F, --format=FMT\tspecify custom output format\n");
- printf("\n");
- print_bias_help();
- printf("\n");
- printf("Format specifiers:\n");
- printf(" %%o: GPIO line offset\n");
- printf(" %%e: event type (0 - falling edge, 1 rising edge)\n");
- printf(" %%s: seconds part of the event timestamp\n");
- printf(" %%n: nanoseconds part of the event timestamp\n");
-}
-
-struct mon_ctx {
- unsigned int offset;
- bool silent;
- char *fmt;
-};
-
-static void event_print_custom(unsigned int offset, uint64_t timeout,
- int event_type, struct mon_ctx *ctx)
-{
- char *prev, *curr, fmt;
-
- for (prev = curr = ctx->fmt;;) {
- curr = strchr(curr, '%');
- if (!curr) {
- fputs(prev, stdout);
- break;
- }
-
- if (prev != curr)
- fwrite(prev, curr - prev, 1, stdout);
-
- fmt = *(curr + 1);
-
- switch (fmt) {
- case 'o':
- printf("%u", offset);
- break;
- case 'e':
- if (event_type == GPIOD_EDGE_EVENT_RISING_EDGE)
- fputc('1', stdout);
- else
- fputc('0', stdout);
- break;
- case 's':
- printf("%"PRIu64, timeout / 1000000000);
- break;
- case 'n':
- printf("%"PRIu64, timeout % 1000000000);
- break;
- case '%':
- fputc('%', stdout);
- break;
- case '\0':
- fputc('%', stdout);
- goto end;
- default:
- fwrite(curr, 2, 1, stdout);
- break;
- }
-
- curr += 2;
- prev = curr;
- }
-
-end:
- fputc('\n', stdout);
-}
-
-static void event_print_human_readable(unsigned int offset,
- uint64_t timeout, int event_type)
-{
- char *evname;
-
- if (event_type == GPIOD_EDGE_EVENT_RISING_EDGE)
- evname = " RISING EDGE";
- else
- evname = "FALLING EDGE";
-
- printf("event: %s offset: %u timestamp: [%8"PRIu64".%09"PRIu64"]\n",
- evname, offset, timeout / 1000000000, timeout % 1000000000);
-}
-
-static void handle_event(unsigned int line_offset, unsigned int event_type,
- uint64_t timestamp, struct mon_ctx *ctx)
-{
- if (!ctx->silent) {
- if (ctx->fmt)
- event_print_custom(line_offset, timestamp,
- event_type, ctx);
- else
- event_print_human_readable(line_offset,
- timestamp, event_type);
- }
-}
-
-static void handle_signal(int signum UNUSED)
-{
- exit(EXIT_SUCCESS);
-}
-
-int main(int argc, char **argv)
-{
- bool watch_rising = false, watch_falling = false, active_low = false;
- size_t num_lines = 0, events_wanted = 0, events_done = 0;
- struct gpiod_edge_event_buffer *event_buffer;
- int optc, opti, ret, i, edge, bias = 0;
- uint64_t timeout = 10 * 1000000000LLU;
- struct gpiod_line_settings *settings;
- struct gpiod_request_config *req_cfg;
- struct gpiod_line_request *request;
- struct gpiod_line_config *line_cfg;
- unsigned int offsets[64], offset;
- struct gpiod_edge_event *event;
- struct gpiod_chip *chip;
- struct mon_ctx ctx;
- char *end;
-
- /*
- * FIXME: use signalfd once the API has been converted to using a single file
- * descriptor as provided by uAPI v2.
- */
- signal(SIGINT, handle_signal);
- signal(SIGTERM, handle_signal);
-
- memset(&ctx, 0, sizeof(ctx));
-
- for (;;) {
- optc = getopt_long(argc, argv, shortopts, longopts, &opti);
- if (optc < 0)
- break;
-
- switch (optc) {
- case 'h':
- print_help();
- return EXIT_SUCCESS;
- case 'v':
- print_version();
- return EXIT_SUCCESS;
- case 'l':
- active_low = true;
- break;
- case 'B':
- bias = parse_bias(optarg);
- break;
- case 'n':
- events_wanted = strtoul(optarg, &end, 10);
- if (*end != '\0')
- die("invalid number: %s", optarg);
- break;
- case 's':
- ctx.silent = true;
- break;
- case 'r':
- watch_rising = true;
- break;
- case 'f':
- watch_falling = true;
- break;
- case 'b':
- setlinebuf(stdout);
- break;
- case 'F':
- ctx.fmt = optarg;
- break;
- case '?':
- die("try %s --help", get_progname());
- default:
- abort();
- }
- }
-
- argc -= optind;
- argv += optind;
-
- if (watch_rising && !watch_falling)
- edge = GPIOD_LINE_EDGE_RISING;
- else if (watch_falling && !watch_rising)
- edge = GPIOD_LINE_EDGE_FALLING;
- else
- edge = GPIOD_LINE_EDGE_BOTH;
-
- if (argc < 1)
- die("gpiochip must be specified");
-
- if (argc < 2)
- die("at least one GPIO line offset must be specified");
-
- if (argc > 65)
- die("too many offsets given");
-
- for (i = 1; i < argc; i++) {
- offset = strtoul(argv[i], &end, 10);
- if (*end != '\0' || offset > INT_MAX)
- die("invalid GPIO offset: %s", argv[i]);
-
- offsets[i - 1] = offset;
- num_lines++;
- }
-
- if (has_duplicate_offsets(num_lines, offsets))
- die("offsets must be unique");
-
- chip = chip_open_lookup(argv[0]);
- if (!chip)
- die_perror("unable to open %s", argv[0]);
-
- settings = gpiod_line_settings_new();
- if (!settings)
- die_perror("unable to allocate line settings");
-
- if (bias)
- gpiod_line_settings_set_bias(settings, bias);
- if (active_low)
- gpiod_line_settings_set_active_low(settings, active_low);
- gpiod_line_settings_set_edge_detection(settings, edge);
-
- req_cfg = gpiod_request_config_new();
- if (!req_cfg)
- die_perror("unable to allocate the request config structure");
-
- gpiod_request_config_set_consumer(req_cfg, "gpiomon");
-
- line_cfg = gpiod_line_config_new();
- if (!line_cfg)
- die_perror("unable to allocate the line config structure");
-
- ret = gpiod_line_config_add_line_settings(line_cfg, offsets,
- num_lines, settings);
- if (ret)
- die_perror("unable to add line settings");
-
- request = gpiod_chip_request_lines(chip, req_cfg, line_cfg);
- if (!request)
- die_perror("unable to request lines");
-
- event_buffer = gpiod_edge_event_buffer_new(EVENT_BUF_SIZE);
- if (!event_buffer)
- die_perror("unable to allocate the line event buffer");
-
- for (;;) {
- ret = gpiod_line_request_wait_edge_event(request, timeout);
- if (ret < 0)
- die_perror("error waiting for events");
- if (ret == 0)
- continue;
-
- ret = gpiod_line_request_read_edge_event(request, event_buffer,
- EVENT_BUF_SIZE);
- if (ret < 0)
- die_perror("error reading line events");
-
- for (i = 0; i < ret; i++) {
- event = gpiod_edge_event_buffer_get_event(event_buffer,
- i);
- if (!event)
- die_perror("unable to retrieve the event from the buffer");
-
- handle_event(gpiod_edge_event_get_line_offset(event),
- gpiod_edge_event_get_event_type(event),
- gpiod_edge_event_get_timestamp_ns(event),
- &ctx);
-
- events_done++;
-
- if (events_wanted && events_done >= events_wanted)
- goto done;
- }
- }
-
-done:
- gpiod_edge_event_buffer_free(event_buffer);
- gpiod_line_request_release(request);
- gpiod_request_config_free(req_cfg);
- gpiod_line_config_free(line_cfg);
- gpiod_line_settings_free(settings);
- gpiod_chip_close(chip);
-
- return EXIT_SUCCESS;
-}
diff --git a/tools/gpioset.c b/tools/gpioset.c
index 290d1a3..0e3a1e4 100644
--- a/tools/gpioset.c
+++ b/tools/gpioset.c
@@ -14,333 +14,3 @@
#include "tools-common.h"
-static const struct option longopts[] = {
- { "help", no_argument, NULL, 'h' },
- { "version", no_argument, NULL, 'v' },
- { "active-low", no_argument, NULL, 'l' },
- { "bias", required_argument, NULL, 'B' },
- { "drive", required_argument, NULL, 'D' },
- { "mode", required_argument, NULL, 'm' },
- { "sec", required_argument, NULL, 's' },
- { "usec", required_argument, NULL, 'u' },
- { "background", no_argument, NULL, 'b' },
- { GETOPT_NULL_LONGOPT },
-};
-
-static const char *const shortopts = "+hvlB:D:m:s:u:b";
-
-static void print_help(void)
-{
- printf("Usage: %s [OPTIONS] <chip name/number> <offset1>=<value1> <offset2>=<value2> ...\n",
- get_progname());
- printf("\n");
- printf("Set GPIO line values of a GPIO chip and maintain the state until the process exits\n");
- printf("\n");
- printf("Options:\n");
- printf(" -h, --help:\t\tdisplay this message and exit\n");
- printf(" -v, --version:\tdisplay the version and exit\n");
- printf(" -l, --active-low:\tset the line active state to low\n");
- printf(" -B, --bias=[as-is|disable|pull-down|pull-up] (defaults to 'as-is'):\n");
- printf(" set the line bias\n");
- printf(" -D, --drive=[push-pull|open-drain|open-source] (defaults to 'push-pull'):\n");
- printf(" set the line drive mode\n");
- printf(" -m, --mode=[exit|wait|time|signal] (defaults to 'exit'):\n");
- printf(" tell the program what to do after setting values\n");
- printf(" -s, --sec=SEC:\tspecify the number of seconds to wait (only valid for --mode=time)\n");
- printf(" -u, --usec=USEC:\tspecify the number of microseconds to wait (only valid for --mode=time)\n");
- printf(" -b, --background:\tafter setting values: detach from the controlling terminal\n");
- printf("\n");
- print_bias_help();
- printf("\n");
- printf("Drives:\n");
- printf(" push-pull:\tdrive the line both high and low\n");
- printf(" open-drain:\tdrive the line low or go high impedance\n");
- printf(" open-source:\tdrive the line high or go high impedance\n");
- printf("\n");
- printf("Modes:\n");
- printf(" exit:\t\tset values and exit immediately\n");
- printf(" wait:\t\tset values and wait for user to press ENTER\n");
- printf(" time:\t\tset values and sleep for a specified amount of time\n");
- printf(" signal:\tset values and wait for SIGINT or SIGTERM\n");
- printf("\n");
- printf("Note: the state of a GPIO line controlled over the character device reverts to default\n");
- printf("when the last process referencing the file descriptor representing the device file exits.\n");
- printf("This means that it's wrong to run gpioset, have it exit and expect the line to continue\n");
- printf("being driven high or low. It may happen if given pin is floating but it must be interpreted\n");
- printf("as undefined behavior.\n");
-}
-
-struct callback_data {
- /* Replace with a union once we have more modes using callback data. */
- struct timeval tv;
- bool daemonize;
-};
-
-static void maybe_daemonize(bool daemonize)
-{
- int rv;
-
- if (daemonize) {
- rv = daemon(0, 0);
- if (rv < 0)
- die("unable to daemonize: %s", strerror(errno));
- }
-}
-
-static void wait_enter(void *data UNUSED)
-{
- getchar();
-}
-
-static void wait_time(void *data)
-{
- struct callback_data *cbdata = data;
-
- maybe_daemonize(cbdata->daemonize);
- select(0, NULL, NULL, NULL, &cbdata->tv);
-}
-
-static void wait_signal(void *data)
-{
- struct callback_data *cbdata = data;
- struct pollfd pfd;
- int sigfd, rv;
-
- sigfd = make_signalfd();
-
- memset(&pfd, 0, sizeof(pfd));
- pfd.fd = sigfd;
- pfd.events = POLLIN | POLLPRI;
-
- maybe_daemonize(cbdata->daemonize);
-
- for (;;) {
- rv = poll(&pfd, 1, 1000 /* one second */);
- if (rv < 0)
- die("error polling for signals: %s", strerror(errno));
- else if (rv > 0)
- break;
- }
-
- /*
- * Don't bother reading siginfo - it's enough to know that we
- * received any signal.
- */
- close(sigfd);
-}
-
-enum {
- MODE_EXIT = 0,
- MODE_WAIT,
- MODE_TIME,
- MODE_SIGNAL,
-};
-
-struct mode_mapping {
- int id;
- const char *name;
- void (*callback)(void *);
-};
-
-static const struct mode_mapping modes[] = {
- [MODE_EXIT] = {
- .id = MODE_EXIT,
- .name = "exit",
- .callback = NULL,
- },
- [MODE_WAIT] = {
- .id = MODE_WAIT,
- .name = "wait",
- .callback = wait_enter,
- },
- [MODE_TIME] = {
- .id = MODE_TIME,
- .name = "time",
- .callback = wait_time,
- },
- [MODE_SIGNAL] = {
- .id = MODE_SIGNAL,
- .name = "signal",
- .callback = wait_signal,
- },
-};
-
-static const struct mode_mapping *parse_mode(const char *mode)
-{
- size_t i;
-
- for (i = 0; i < ARRAY_SIZE(modes); i++)
- if (strcmp(mode, modes[i].name) == 0)
- return &modes[i];
-
- return NULL;
-}
-
-static int parse_drive(const char *option)
-{
- if (strcmp(option, "open-drain") == 0)
- return GPIOD_LINE_DRIVE_OPEN_DRAIN;
- if (strcmp(option, "open-source") == 0)
- return GPIOD_LINE_DRIVE_OPEN_SOURCE;
- if (strcmp(option, "push-pull") != 0)
- die("invalid drive: %s", option);
- return 0;
-}
-
-int main(int argc, char **argv)
-{
- const struct mode_mapping *mode = &modes[MODE_EXIT];
- int ret, optc, opti, bias = 0, drive = 0, *values;
- struct gpiod_line_settings *settings;
- struct gpiod_request_config *req_cfg;
- struct gpiod_line_request *request;
- struct gpiod_line_config *line_cfg;
- struct callback_data cbdata;
- struct gpiod_chip *chip;
- bool active_low = false;
- unsigned int *offsets;
- size_t i, num_lines;
- char *device, *end;
-
- memset(&cbdata, 0, sizeof(cbdata));
-
- for (;;) {
- optc = getopt_long(argc, argv, shortopts, longopts, &opti);
- if (optc < 0)
- break;
-
- switch (optc) {
- case 'h':
- print_help();
- return EXIT_SUCCESS;
- case 'v':
- print_version();
- return EXIT_SUCCESS;
- case 'l':
- active_low = true;
- break;
- case 'B':
- bias = parse_bias(optarg);
- break;
- case 'D':
- drive = parse_drive(optarg);
- break;
- case 'm':
- mode = parse_mode(optarg);
- if (!mode)
- die("invalid mode: %s", optarg);
- break;
- case 's':
- cbdata.tv.tv_sec = strtoul(optarg, &end, 10);
- if (*end != '\0')
- die("invalid time value in seconds: %s", optarg);
- break;
- case 'u':
- cbdata.tv.tv_usec = strtoul(optarg, &end, 10);
- if (*end != '\0')
- die("invalid time value in microseconds: %s",
- optarg);
- break;
- case 'b':
- cbdata.daemonize = true;
- break;
- case '?':
- die("try %s --help", get_progname());
- default:
- abort();
- }
- }
-
- argc -= optind;
- argv += optind;
-
- if (mode->id != MODE_TIME && (cbdata.tv.tv_sec || cbdata.tv.tv_usec))
- die("can't specify wait time in this mode");
-
- if (mode->id != MODE_SIGNAL &&
- mode->id != MODE_TIME &&
- cbdata.daemonize)
- die("can't daemonize in this mode");
-
- if (argc < 1)
- die("gpiochip must be specified");
-
- if (argc < 2)
- die("at least one GPIO line offset to value mapping must be specified");
-
- device = argv[0];
-
- num_lines = argc - 1;
-
- offsets = calloc(num_lines, sizeof(*offsets));
- values = calloc(num_lines, sizeof(*values));
- if (!offsets)
- die("out of memory");
-
- for (i = 0; i < num_lines; i++) {
- ret = sscanf(argv[i + 1], "%u=%d", &offsets[i], &values[i]);
- if (ret != 2)
- die("invalid offset<->value mapping: %s", argv[i + 1]);
-
- if (values[i] != 0 && values[i] != 1)
- die("value must be 0 or 1: %s", argv[i + 1]);
-
- if (offsets[i] > INT_MAX)
- die("invalid offset: %s", argv[i + 1]);
- }
-
- if (has_duplicate_offsets(num_lines, offsets))
- die("offsets must be unique");
-
- chip = chip_open_lookup(device);
- if (!chip)
- die_perror("unable to open %s", device);
-
- settings = gpiod_line_settings_new();
- if (!settings)
- die_perror("unable to allocate line settings");
-
- if (bias)
- gpiod_line_settings_set_bias(settings, bias);
- if (drive)
- gpiod_line_settings_set_drive(settings, drive);
- if (active_low)
- gpiod_line_settings_set_active_low(settings, active_low);
- gpiod_line_settings_set_direction(settings,
- GPIOD_LINE_DIRECTION_OUTPUT);
-
- req_cfg = gpiod_request_config_new();
- if (!req_cfg)
- die_perror("unable to allocate the request config structure");
-
- gpiod_request_config_set_consumer(req_cfg, "gpioset");
-
- line_cfg = gpiod_line_config_new();
- if (!line_cfg)
- die_perror("unable to allocate the line config structure");
-
- for (i = 0; i < num_lines; i++) {
- gpiod_line_settings_set_output_value(settings, values[i]);
-
- ret = gpiod_line_config_add_line_settings(line_cfg, &offsets[i],
- 1, settings);
- if (ret)
- die_perror("unable to add line settings");
- }
-
- request = gpiod_chip_request_lines(chip, req_cfg, line_cfg);
- if (!request)
- die_perror("unable to request lines");
-
- if (mode->callback)
- mode->callback(&cbdata);
-
- gpiod_line_request_release(request);
- gpiod_request_config_free(req_cfg);
- gpiod_line_config_free(line_cfg);
- gpiod_line_settings_free(settings);
- gpiod_chip_close(chip);
- free(offsets);
-
- return EXIT_SUCCESS;
-}
diff --git a/tools/tools-common.c b/tools/tools-common.c
index 8957293..ea7dfa8 100644
--- a/tools/tools-common.c
+++ b/tools/tools-common.c
@@ -79,26 +79,6 @@ void print_bias_help(void)
printf(" pull-down:\tenable pull-down\n");
}
-int make_signalfd(void)
-{
- sigset_t sigmask;
- int sigfd, rv;
-
- sigemptyset(&sigmask);
- sigaddset(&sigmask, SIGTERM);
- sigaddset(&sigmask, SIGINT);
-
- rv = sigprocmask(SIG_BLOCK, &sigmask, NULL);
- if (rv < 0)
- die("error masking signals: %s", strerror(errno));
-
- sigfd = signalfd(-1, &sigmask, 0);
- if (sigfd < 0)
- die("error creating signalfd: %s", strerror(errno));
-
- return sigfd;
-}
-
int chip_dir_filter(const struct dirent *entry)
{
bool is_chip;
@@ -114,38 +94,6 @@ int chip_dir_filter(const struct dirent *entry)
return !!is_chip;
}
-struct gpiod_chip *chip_open_by_name(const char *name)
-{
- struct gpiod_chip *chip;
- char *path;
- int ret;
-
- ret = asprintf(&path, "/dev/%s", name);
- if (ret < 0)
- return NULL;
-
- chip = gpiod_chip_open(path);
- free(path);
-
- return chip;
-}
-
-static struct gpiod_chip *chip_open_by_number(unsigned int num)
-{
- struct gpiod_chip *chip;
- char *path;
- int ret;
-
- ret = asprintf(&path, "/dev/gpiochip%u", num);
- if (!ret)
- return NULL;
-
- chip = gpiod_chip_open(path);
- free(path);
-
- return chip;
-}
-
static bool isuint(const char *str)
{
for (; *str && isdigit(*str); str++)
@@ -153,32 +101,3 @@ static bool isuint(const char *str)
return *str == '\0';
}
-
-struct gpiod_chip *chip_open_lookup(const char *device)
-{
- struct gpiod_chip *chip;
-
- if (isuint(device)) {
- chip = chip_open_by_number(strtoul(device, NULL, 10));
- } else {
- if (strncmp(device, "/dev/", 5))
- chip = chip_open_by_name(device);
- else
- chip = gpiod_chip_open(device);
- }
-
- return chip;
-}
-
-bool has_duplicate_offsets(size_t num_offsets, unsigned int *offsets)
-{
- size_t i, j;
-
- for (i = 0; i < num_offsets; i++) {
- for (j = i + 1; j < num_offsets; j++)
- if (offsets[i] == offsets[j])
- return true;
- }
-
- return false;
-}
--
2.38.0
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [libgpiod v2][PATCH v3 2/5] tools: line name focussed rework
2022-10-11 0:29 [libgpiod v2][PATCH v3 0/5] tools: improvements for v2 Kent Gibson
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 1/5] tools: remove old code to simplify review Kent Gibson
@ 2022-10-11 0:29 ` Kent Gibson
2022-11-08 13:13 ` Bartosz Golaszewski
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 3/5] tools: tests for " Kent Gibson
` (2 subsequent siblings)
4 siblings, 1 reply; 16+ messages in thread
From: Kent Gibson @ 2022-10-11 0:29 UTC (permalink / raw)
To: linux-gpio, brgl; +Cc: Kent Gibson
Rework the tool suite to support identifying lines by name and to
support operating on the GPIO lines available to the user at once, rather
than on one particular GPIO chip.
All tools, other than gpiodetect, now provide the name to (chip,offset)
mapping that was previously only performed by gpiofind. As names are not
guaranteed to be unique, a --strict option is provided for all tools to
either abort the operation or report all lines with the matching name, as
appropriate.
By default the tools operate on the first line found with a matching name.
Selection of line by (chip,offset) is still supported with a --chip
option, though it restricts the scope of the operation to an individual
chip. When the --chip option is specified, the lines are assumed to be
identified by offset where they parse as an integer, else by name.
To cater for the unusual case where a line name parses as an integer,
but is different from the offset, the --by-name option forces the lines
to be identified by name.
The updated tools are intentionally NOT backwardly compatible with the
previous tools. Using old command lines with the updated tools will
almost certainly fail, though migrating old command lines is generally as
simple as adding a '-c' before the chip.
In addition the individual tools are modified as follows:
gpiodetect:
Add the option to select individual chips.
gpioinfo:
Change the focus from chips to lines, so the scope can be
an individual line, a subset of lines, all lines on a particular chip,
or all the lines available to the user. For line scope a single line
summary is output for each line. For chip scope the existing format
displaying a summary of the chip and each of its lines is retained.
Line attributes are consolidated into a list format, and are extended
to cover all attributes supported by uAPI v2.
gpioget:
The default output format is becomes line=value, as per the
input for gpioset, and the value is reported as active or inactive,
rather than 0 or 1.
The previous format is available using the --numeric option.
Add an optional hold period between requesting a line and reading the
value to allow the line to settle once the requested configuration has
been applied (e.g. bias).
gpiomon:
Consolidate the edge options into a single option.
Add a debounce period option.
Add options to report event times as UTC or localtime.
Add format specifiers for GPIO chip path, line name, stringified event
type, and event time as a datetime.
Rearrange default output format to place fields with more predicable
widths to the left, and to separate major field groups with tabs.
Lines are identified consistent with the command line.
gpioset:
Add a hold period option that specifies the minimum period the line
value must be held for. This applies to all set options.
Support line values specified as active/inactive, on/off and
true/false, as well as 1/0.
Add a toggle option that specifies a time sequence over which the
requested lines should be toggled. If the sequence is 0 terminated then
gpioset exits when the sequence completes, else it repeats the sequence.
This allows for anything from simple blinkers to bit bashing from the
command line. e.g. gpioset -t 500ms LED=on
Add an interactive option to provide a shell-like interface to allow
manual or scripted manipulation of requested lines. A basic command set
allows lines to be get, set, or toggled, and to insert sleeps between
operations.
Remove the --mode, --sec, and --usec options.
The combination of hold period and interactive mode provide functionality
equivalent to the old --mode options.
Signed-off-by: Kent Gibson <warthog618@gmail.com>
---
configure.ac | 8 +-
tools/Makefile.am | 2 +-
tools/gpiodetect.c | 113 +++++-
tools/gpioget.c | 204 ++++++++++-
tools/gpioinfo.c | 223 +++++++++++-
tools/gpiomon.c | 450 +++++++++++++++++++++++-
tools/gpioset.c | 815 ++++++++++++++++++++++++++++++++++++++++++-
tools/tools-common.c | 713 ++++++++++++++++++++++++++++++++++++-
tools/tools-common.h | 99 +++++-
9 files changed, 2585 insertions(+), 42 deletions(-)
diff --git a/configure.ac b/configure.ac
index 6ac1d8e..c8033c5 100644
--- a/configure.ac
+++ b/configure.ac
@@ -106,14 +106,14 @@ AC_DEFUN([FUNC_NOT_FOUND_TOOLS],
AC_DEFUN([HEADER_NOT_FOUND_TOOLS],
[ERR_NOT_FOUND([$1 header], [tools])])
+AC_DEFUN([LIB_NOT_FOUND_TOOLS],
+ [ERR_NOT_FOUND([lib$1], [tools])])
+
if test "x$with_tools" = xtrue
then
# These are only needed to build tools
- AC_CHECK_FUNC([basename], [], [FUNC_NOT_FOUND_TOOLS([basename])])
AC_CHECK_FUNC([daemon], [], [FUNC_NOT_FOUND_TOOLS([daemon])])
- AC_CHECK_FUNC([signalfd], [], [FUNC_NOT_FOUND_TOOLS([signalfd])])
- AC_CHECK_FUNC([setlinebuf], [], [FUNC_NOT_FOUND_TOOLS([setlinebuf])])
- AC_CHECK_HEADERS([sys/signalfd.h], [], [HEADER_NOT_FOUND_TOOLS([sys/signalfd.h])])
+ PKG_CHECK_MODULES(LIBEDIT, libedit)
fi
AC_ARG_ENABLE([tests],
diff --git a/tools/Makefile.am b/tools/Makefile.am
index fc074b9..c956314 100644
--- a/tools/Makefile.am
+++ b/tools/Makefile.am
@@ -7,7 +7,7 @@ AM_CFLAGS += -Wall -Wextra -g -std=gnu89
noinst_LTLIBRARIES = libtools-common.la
libtools_common_la_SOURCES = tools-common.c tools-common.h
-LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la
+LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la $(LIBEDIT_LIBS)
bin_PROGRAMS = gpiodetect gpioinfo gpioget gpioset gpiomon
diff --git a/tools/gpiodetect.c b/tools/gpiodetect.c
index 30bde32..910fe9e 100644
--- a/tools/gpiodetect.c
+++ b/tools/gpiodetect.c
@@ -1,8 +1,7 @@
// SPDX-License-Identifier: GPL-2.0-or-later
// SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
+// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
-#include <dirent.h>
-#include <errno.h>
#include <getopt.h>
#include <gpiod.h>
#include <stdio.h>
@@ -11,3 +10,113 @@
#include "tools-common.h"
+static void print_help(void)
+{
+ printf("Usage: %s [OPTIONS] [chip]...\n", get_progname());
+ printf("\n");
+ printf("List GPIO chips, print their labels and number of GPIO lines.\n");
+ printf("\n");
+ printf("Chips may be identified by number, name, or path.\n");
+ printf("e.g. '0', 'gpiochip0', and '/dev/gpiochip0' all refer to the same chip.\n");
+ printf("\n");
+ printf("If no chips are specified then all chips are listed.\n");
+ printf("\n");
+ printf("Options:\n");
+ printf(" -h, --help\t\tdisplay this help and exit\n");
+ printf(" -v, --version\t\toutput version information and exit\n");
+}
+
+int parse_config(int argc, char **argv)
+{
+ int optc, opti;
+ const char *const shortopts = "+hv";
+ const struct option longopts[] = {
+ { "help", no_argument, NULL, 'h' },
+ { "version", no_argument, NULL, 'v' },
+ { GETOPT_NULL_LONGOPT },
+ };
+
+ for (;;) {
+ optc = getopt_long(argc, argv, shortopts, longopts, &opti);
+ if (optc < 0)
+ break;
+
+ switch (optc) {
+ case 'h':
+ print_help();
+ exit(EXIT_SUCCESS);
+ case 'v':
+ print_version();
+ exit(EXIT_SUCCESS);
+ case '?':
+ die("try %s --help", get_progname());
+ default:
+ abort();
+ }
+ }
+ return optind;
+}
+
+int print_chip_info(const char *path)
+{
+ struct gpiod_chip *chip;
+ struct gpiod_chip_info *info;
+
+ chip = gpiod_chip_open(path);
+ if (!chip) {
+ print_perror("unable to open chip '%s'", path);
+ return 1;
+ }
+
+ info = gpiod_chip_get_info(chip);
+ if (!info)
+ die_perror("unable to read info for '%s'", path);
+
+ printf("%s [%s] (%zu lines)\n",
+ gpiod_chip_info_get_name(info),
+ gpiod_chip_info_get_label(info),
+ gpiod_chip_info_get_num_lines(info));
+
+ gpiod_chip_info_free(info);
+ gpiod_chip_close(chip);
+ return 0;
+}
+
+int main(int argc, char **argv)
+{
+ int num_chips, i;
+ char **paths;
+ char *path;
+ int ret = EXIT_SUCCESS;
+
+ i = parse_config(argc, argv);
+ argc -= i;
+ argv += i;
+
+ if (argc == 0) {
+ num_chips = all_chip_paths(&paths);
+ for (i = 0; i < num_chips; i++) {
+ if (print_chip_info(paths[i]))
+ ret = EXIT_FAILURE;
+
+ free(paths[i]);
+ }
+ free(paths);
+ }
+
+ for (i = 0; i < argc; i++) {
+ if (chip_path_lookup(argv[i], &path)) {
+ if (print_chip_info(path))
+ ret = EXIT_FAILURE;
+
+ free(path);
+ } else {
+ print_error(
+ "cannot find GPIO chip character device '%s'",
+ argv[i]);
+ ret = EXIT_FAILURE;
+ }
+ }
+
+ return ret;
+}
diff --git a/tools/gpioget.c b/tools/gpioget.c
index 1b3e666..7a26066 100644
--- a/tools/gpioget.c
+++ b/tools/gpioget.c
@@ -1,12 +1,214 @@
// SPDX-License-Identifier: GPL-2.0-or-later
// SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
+// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
#include <getopt.h>
#include <gpiod.h>
-#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
+#include <unistd.h>
#include "tools-common.h"
+static void print_help(void)
+{
+ printf("Usage: %s [OPTIONS] <line>...\n", get_progname());
+ printf("\n");
+ printf("Read values of GPIO lines.\n");
+ printf("\n");
+ printf("Lines are specified by name, or optionally by offset if the chip option\n");
+ printf("is provided.\n");
+ printf("\n");
+ printf("Options:\n");
+ printf(" -a, --as-is\t\tleave the line direction unchanged, not forced to input\n");
+ print_bias_help();
+ printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n");
+ printf(" -c, --chip <chip>\trestrict scope to a particular chip\n");
+ printf(" -h, --help\t\tdisplay this help and exit\n");
+ printf(" -l, --active-low\ttreat the line as active low\n");
+ printf(" -p, --hold-period <period>\n");
+ printf("\t\t\twait between requesting the lines and reading the values\n");
+ printf(" --numeric\t\tdisplay line values as '0' (inactive) or '1' (active)\n");
+ printf(" -s, --strict\t\tabort if requested line names are not unique\n");
+ printf(" -v, --version\t\toutput version information and exit\n");
+ print_chip_help();
+ print_period_help();
+}
+struct config {
+ bool active_low;
+ bool strict;
+ int bias;
+ int direction;
+ unsigned int hold_period_us;
+ const char *chip_id;
+ int by_name;
+ int numeric;
+};
+
+int parse_config(int argc, char **argv, struct config *cfg)
+{
+ int opti, optc;
+ const char *const shortopts = "+ab:c:hlp:sv";
+ const struct option longopts[] = {
+ { "active-low", no_argument, NULL, 'l' },
+ { "as-is", no_argument, NULL, 'a' },
+ { "bias", required_argument, NULL, 'b' },
+ { "by-name", no_argument, &cfg->by_name, 1 },
+ { "chip", required_argument, NULL, 'c' },
+ { "help", no_argument, NULL, 'h' },
+ { "hold-period", required_argument, NULL, 'p' },
+ { "numeric", no_argument, &cfg->numeric, 1 },
+ { "strict", no_argument, NULL, 's' },
+ { "version", no_argument, NULL, 'v' },
+ { GETOPT_NULL_LONGOPT },
+ };
+
+ memset(cfg, 0, sizeof(*cfg));
+ cfg->direction = GPIOD_LINE_DIRECTION_INPUT;
+
+ for (;;) {
+ optc = getopt_long(argc, argv, shortopts, longopts, &opti);
+ if (optc < 0)
+ break;
+
+ switch (optc) {
+ case 'a':
+ cfg->direction = GPIOD_LINE_DIRECTION_AS_IS;
+ break;
+ case 'b':
+ cfg->bias = parse_bias_or_die(optarg);
+ break;
+ case 'c':
+ cfg->chip_id = optarg;
+ break;
+ case 'l':
+ cfg->active_low = true;
+ break;
+ case 'p':
+ cfg->hold_period_us = parse_period_or_die(optarg);
+ break;
+ case 's':
+ cfg->strict = true;
+ break;
+ case 'h':
+ print_help();
+ exit(EXIT_SUCCESS);
+ case 'v':
+ print_version();
+ exit(EXIT_SUCCESS);
+ case '?':
+ die("try %s --help", get_progname());
+ case 0:
+ break;
+ default:
+ abort();
+ }
+ }
+
+ return optind;
+}
+
+int main(int argc, char **argv)
+{
+ int i, num_lines, ret, *values;
+ struct gpiod_line_settings *settings;
+ struct gpiod_request_config *req_cfg;
+ struct gpiod_line_request *request;
+ struct gpiod_line_config *line_cfg;
+ struct gpiod_chip *chip;
+ unsigned int *offsets;
+ struct line_resolver *resolver;
+ struct resolved_line *line;
+ struct config cfg;
+
+ i = parse_config(argc, argv, &cfg);
+ argc -= i;
+ argv += i;
+
+ if (argc < 1)
+ die("at least one GPIO line must be specified");
+
+ resolver = resolve_lines(argc, argv, cfg.chip_id, cfg.strict,
+ cfg.by_name);
+ validate_resolution(resolver, cfg.chip_id);
+
+ offsets = calloc(resolver->num_lines, sizeof(*offsets));
+ values = calloc(resolver->num_lines, sizeof(*values));
+ if (!offsets || !values)
+ die("out of memory");
+
+ settings = gpiod_line_settings_new();
+ if (!settings)
+ die_perror("unable to allocate line settings");
+
+ gpiod_line_settings_set_direction(settings, cfg.direction);
+
+ if (cfg.bias)
+ gpiod_line_settings_set_bias(settings, cfg.bias);
+
+ if (cfg.active_low)
+ gpiod_line_settings_set_active_low(settings, true);
+
+ req_cfg = gpiod_request_config_new();
+ if (!req_cfg)
+ die_perror("unable to allocate the request config structure");
+
+ line_cfg = gpiod_line_config_new();
+ if (!line_cfg)
+ die_perror("unable to allocate the line config structure");
+
+ gpiod_request_config_set_consumer(req_cfg, "gpioget");
+ for (i = 0; i < resolver->num_chips; i++) {
+ chip = gpiod_chip_open(resolver->chips[i].path);
+ if (!chip)
+ die_perror("unable to open chip '%s'",
+ resolver->chips[i].path);
+
+ num_lines = get_line_offsets_and_values(resolver, i, offsets,
+ NULL);
+
+ gpiod_line_config_reset(line_cfg);
+ ret = gpiod_line_config_add_line_settings(line_cfg, offsets,
+ num_lines, settings);
+ if (ret)
+ die_perror("unable to add line settings");
+
+ request = gpiod_chip_request_lines(chip, req_cfg, line_cfg);
+ if (!request)
+ die_perror("unable to request lines");
+
+ if (cfg.hold_period_us)
+ usleep(cfg.hold_period_us);
+
+ ret = gpiod_line_request_get_values(request, values);
+ if (ret)
+ die_perror("unable to read GPIO line values");
+
+ set_line_values(resolver, i, values);
+
+ gpiod_line_request_release(request);
+ gpiod_chip_close(chip);
+ }
+ for (i = 0; i < resolver->num_lines; i++) {
+ line = &resolver->lines[i];
+ if (cfg.numeric)
+ printf("%d", line->value);
+ else
+ printf("%s=%s", line->id,
+ line->value ? "active" : "inactive");
+
+ if (i != resolver->num_lines - 1)
+ printf(" ");
+ }
+ printf("\n");
+
+ free_line_resolver(resolver);
+ gpiod_request_config_free(req_cfg);
+ gpiod_line_config_free(line_cfg);
+ gpiod_line_settings_free(settings);
+ free(offsets);
+ free(values);
+
+ return EXIT_SUCCESS;
+}
diff --git a/tools/gpioinfo.c b/tools/gpioinfo.c
index ae368fa..5dc28f8 100644
--- a/tools/gpioinfo.c
+++ b/tools/gpioinfo.c
@@ -1,8 +1,7 @@
// SPDX-License-Identifier: GPL-2.0-or-later
// SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
+// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
-#include <dirent.h>
-#include <errno.h>
#include <getopt.h>
#include <gpiod.h>
#include <stdarg.h>
@@ -12,3 +11,223 @@
#include "tools-common.h"
+static void print_help(void)
+{
+ printf("Usage: %s [OPTIONS] [line]...\n", get_progname());
+ printf("\n");
+ printf("Print information about GPIO lines.\n");
+ printf("\n");
+ printf("Lines are specified by name, or optionally by offset if the chip option\n");
+ printf("is provided.\n");
+ printf("\n");
+ printf("If no lines are specified than all lines are displayed.\n");
+ printf("\n");
+ printf("Options:\n");
+ printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n");
+ printf(" -c, --chip <chip>\trestrict scope to a particular chip\n");
+ printf(" -h, --help\t\tdisplay this help and exit\n");
+ printf(" -s, --strict\t\tcheck all lines - don't assume line names are unique\n");
+ printf(" -v, --version\t\toutput version information and exit\n");
+ print_chip_help();
+}
+
+struct config {
+ bool strict;
+ const char *chip_id;
+ int by_name;
+};
+
+int parse_config(int argc, char **argv, struct config *cfg)
+{
+ int opti, optc;
+ const char *const shortopts = "+c:hsv";
+ const struct option longopts[] = {
+ { "by-name", no_argument, &cfg->by_name, 1 },
+ { "chip", required_argument, NULL, 'c' },
+ { "help", no_argument, NULL, 'h' },
+ { "strict", no_argument, NULL, 's' },
+ { "version", no_argument, NULL, 'v' },
+ { GETOPT_NULL_LONGOPT },
+ };
+
+ memset(cfg, 0, sizeof(*cfg));
+
+ for (;;) {
+ optc = getopt_long(argc, argv, shortopts, longopts, &opti);
+ if (optc < 0)
+ break;
+
+ switch (optc) {
+ case 'c':
+ cfg->chip_id = optarg;
+ break;
+ case 's':
+ cfg->strict = true;
+ break;
+ case 'h':
+ print_help();
+ exit(EXIT_SUCCESS);
+ case 'v':
+ print_version();
+ exit(EXIT_SUCCESS);
+ case '?':
+ die("try %s --help", get_progname());
+ case 0:
+ break;
+ default:
+ abort();
+ }
+ }
+
+ return optind;
+}
+
+
+// minimal version similar to tools-common that indicates if a line should be
+// printed rather than storing details into the resolver.
+// Does not die on non-unique lines.
+static bool resolve_line(struct line_resolver *resolver,
+ struct gpiod_line_info *info, int chip_num)
+{
+ struct resolved_line *line;
+ const char *name;
+ int i;
+ unsigned int offset;
+ bool resolved = false;
+
+ offset = gpiod_line_info_get_offset(info);
+ for (i = 0; i < resolver->num_lines; i++) {
+ line = &resolver->lines[i];
+ // already resolved by offset?
+ if (line->resolved &&
+ (line->offset == offset) &&
+ (line->chip_num == chip_num)) {
+ resolved = true;
+ }
+ if (line->resolved && !resolver->strict)
+ continue;
+
+ // else resolve by name
+ name = gpiod_line_info_get_name(info);
+ if (name && (strcmp(line->id, name) == 0)) {
+ line->resolved = true;
+ line->offset = offset;
+ line->chip_num = chip_num;
+ resolved = true;
+ }
+ }
+
+ return resolved;
+}
+
+static void print_line_info(struct gpiod_line_info *info)
+{
+ const char *name;
+
+ name = gpiod_line_info_get_name(info);
+ if (!name)
+ name = "unnamed";
+
+ printf("%-16s\t", name);
+ print_line_attributes(info);
+}
+
+// based on resolve_lines, but prints lines immediately rather than collecting
+// details in the resolver.
+static void list_lines(struct line_resolver *resolver, struct gpiod_chip *chip,
+ int chip_num, bool offsets_ok)
+{
+ struct gpiod_chip_info *chip_info;
+ struct gpiod_line_info *info;
+ int offset, num_lines;
+
+ chip_info = gpiod_chip_get_info(chip);
+ if (!chip_info)
+ die_perror("unable to read info from chip %s",
+ gpiod_chip_get_path(chip));
+
+ num_lines = gpiod_chip_info_get_num_lines(chip_info);
+
+ if ((chip_num == 0) && offsets_ok)
+ resolve_lines_by_offset(resolver, num_lines);
+
+ for (offset = 0;
+ ((offset < num_lines) &&
+ !(resolver->num_lines && resolve_done(resolver)));
+ offset++) {
+ info = gpiod_chip_get_line_info(chip, offset);
+ if (!info)
+ die_perror("unable to read info for line %d from %s",
+ offset, gpiod_chip_info_get_name(chip_info));
+
+ if (resolver->num_lines &&
+ !resolve_line(resolver, info, chip_num))
+ continue;
+
+ if (resolver->num_lines) {
+ printf("%s %u", gpiod_chip_info_get_name(chip_info),
+ offset);
+ } else {
+ if (offset == 0)
+ printf("%s - %u lines:\n",
+ gpiod_chip_info_get_name(chip_info),
+ num_lines);
+
+ printf("\tline %3u:", offset);
+ }
+ fputc('\t', stdout);
+ print_line_info(info);
+ fputc('\n', stdout);
+ gpiod_line_info_free(info);
+ resolver->num_found++;
+ }
+ gpiod_chip_info_free(chip_info);
+}
+
+int main(int argc, char **argv)
+{
+ struct gpiod_chip *chip;
+ struct line_resolver *resolver = NULL;
+ struct config cfg;
+ char **paths;
+ int num_chips, i, ret = EXIT_SUCCESS;
+ bool offsets_ok;
+
+ i = parse_config(argc, argv, &cfg);
+ argc -= i;
+ argv += i;
+
+ if (!cfg.chip_id)
+ cfg.by_name = true;
+
+ num_chips = chip_paths(cfg.chip_id, &paths);
+ if (cfg.chip_id && (num_chips == 0))
+ die("cannot find GPIO chip character device '%s'", cfg.chip_id);
+
+ resolver = resolver_init(argc, argv, num_chips, cfg.strict,
+ cfg.by_name);
+
+ for (i = 0; i < num_chips; i++) {
+ chip = gpiod_chip_open(paths[i]);
+ if (chip) {
+ offsets_ok = (cfg.chip_id && !cfg.by_name);
+ list_lines(resolver, chip, i, offsets_ok);
+ gpiod_chip_close(chip);
+ } else {
+ print_perror("unable to open chip '%s'", paths[i]);
+
+ if (cfg.chip_id)
+ return EXIT_FAILURE;
+
+ ret = EXIT_FAILURE;
+ }
+ free(paths[i]);
+ }
+ free(paths);
+
+ validate_resolution(resolver, cfg.chip_id);
+ if (argc && resolver->num_found != argc)
+ ret = EXIT_FAILURE;
+ free(resolver);
+ return ret;
+}
diff --git a/tools/gpiomon.c b/tools/gpiomon.c
index 6fa19b6..8a725f5 100644
--- a/tools/gpiomon.c
+++ b/tools/gpiomon.c
@@ -1,19 +1,461 @@
// SPDX-License-Identifier: GPL-2.0-or-later
// SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
+// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
-#include <errno.h>
#include <getopt.h>
#include <gpiod.h>
#include <inttypes.h>
-#include <limits.h>
#include <poll.h>
-#include <signal.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
-#include <unistd.h>
#include "tools-common.h"
#define EVENT_BUF_SIZE 32
+static void print_help(void)
+{
+ printf("Usage: %s [OPTIONS] <line>...\n", get_progname());
+ printf("\n");
+ printf("Wait for events on GPIO lines and print them to standard output.\n");
+ printf("\n");
+ printf("Lines are specified by name, or optionally by offset if the chip option\n");
+ printf("is provided.\n");
+ printf("\n");
+ printf("Options:\n");
+ printf(" --banner\t\tdisplay a banner on successful startup\n");
+ print_bias_help();
+ printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n");
+ printf(" -c, --chip <chip>\trestrict scope to a particular chip\n");
+ printf(" -C, --event-clock <clock>\tspecify the source clock for event timestamps.\n");
+ printf("\t\t\tPossible values: 'monotonic', 'realtime', 'hte'.\n");
+ printf("\t\t\t(default is 'monotonic')\n");
+ printf("\t\t\tBy default 'realtime' is formatted as UTC, others as raw u64\n");
+ printf(" -e, --edges <edges>\tspecify the edges to monitor.\n");
+ printf("\t\t\tPossible values: 'falling', 'rising', 'both'.\n");
+ printf("\t\t\t(default is 'both')\n");
+ printf(" -h, --help\t\tdisplay this help and exit\n");
+ printf(" -F, --format <fmt>\tspecify a custom output format\n");
+ printf(" -l, --active-low\ttreat the line as active low, flipping the sense of\n");
+ printf("\t\t\trising and falling edges\n");
+ printf(" --localtime\tformat event timestamps as local time\n");
+ printf(" -n, --num-events <num>\n");
+ printf("\t\t\texit after processing num events\n");
+ printf(" -p, --debounce-period <period>\n");
+ printf("\t\t\tdebounce the line(s) with the specified period\n");
+ printf(" -q, --quiet\t\tdon't generate any output\n");
+ printf(" -s, --strict\t\tabort if requested line names are not unique\n");
+ printf(" --utc\t\tformat event timestamps as UTC (default for 'realtime')\n");
+ printf(" -v, --version\t\toutput version information and exit\n");
+ print_chip_help();
+ print_period_help();
+ printf("\n");
+ printf("Format specifiers:\n");
+ printf(" %%o GPIO line offset\n");
+ printf(" %%l GPIO line name\n");
+ printf(" %%c GPIO chip name\n");
+ printf(" %%e numeric edge event type ('1' - rising or '2' - falling)\n");
+ printf(" %%E edge event type ('rising' or 'falling')\n");
+ printf(" %%S event timestamp as seconds\n");
+ printf(" %%U event timestamp as UTC\n");
+ printf(" %%L event timestamp as local time\n");
+}
+
+static int parse_edges_or_die(const char *option)
+{
+ if (strcmp(option, "rising") == 0)
+ return GPIOD_LINE_EDGE_RISING;
+ if (strcmp(option, "falling") == 0)
+ return GPIOD_LINE_EDGE_FALLING;
+ if (strcmp(option, "both") != 0)
+ die("invalid edges: %s", option);
+ return GPIOD_LINE_EDGE_BOTH;
+}
+
+static int parse_event_clock_or_die(const char *option)
+{
+ if (strcmp(option, "realtime") == 0)
+ return GPIOD_LINE_EVENT_CLOCK_REALTIME;
+ if (strcmp(option, "hte") != 0)
+ return GPIOD_LINE_EVENT_CLOCK_HTE;
+ if (strcmp(option, "monotonic") != 0)
+ die("invalid event clock: %s", option);
+ return GPIOD_LINE_EVENT_CLOCK_MONOTONIC;
+}
+
+struct config {
+ bool active_low;
+ bool quiet;
+ bool strict;
+ int bias;
+ int edges;
+ int events_wanted;
+ unsigned int debounce_period_us;
+ const char *chip_id;
+ const char *fmt;
+ int by_name;
+ int event_clock;
+ int timestamp_fmt;
+ int banner;
+};
+
+int parse_config(int argc, char **argv, struct config *cfg)
+{
+ int opti, optc;
+ const char *const shortopts = "+b:c:C:e:hF:ln:p:qshv";
+ const struct option longopts[] = {
+ { "active-low", no_argument, NULL, 'l' },
+ { "banner", no_argument, &cfg->banner, 1 },
+ { "bias", required_argument, NULL, 'b' },
+ { "by-name", no_argument, &cfg->by_name, 1 },
+ { "chip", required_argument, NULL, 'c' },
+ { "debounce-period", required_argument, NULL, 'p' },
+ { "edges", required_argument, NULL, 'e' },
+ { "event-clock", required_argument, NULL, 'C' },
+ { "format", required_argument, NULL, 'F' },
+ { "help", no_argument, NULL, 'h' },
+ { "localtime", no_argument, &cfg->timestamp_fmt, 2 },
+ { "num-events", required_argument, NULL, 'n' },
+ { "quiet", no_argument, NULL, 'q' },
+ { "silent", no_argument, NULL, 'q' },
+ { "strict", no_argument, NULL, 's' },
+ { "utc", no_argument, &cfg->timestamp_fmt, 1 },
+ { "version", no_argument, NULL, 'v' },
+ { GETOPT_NULL_LONGOPT },
+ };
+
+ memset(cfg, 0, sizeof(*cfg));
+ cfg->edges = GPIOD_LINE_EDGE_BOTH;
+
+ for (;;) {
+ optc = getopt_long(argc, argv, shortopts, longopts, &opti);
+ if (optc < 0)
+ break;
+
+ switch (optc) {
+ case 'b':
+ cfg->bias = parse_bias_or_die(optarg);
+ break;
+ case 'c':
+ cfg->chip_id = optarg;
+ break;
+ case 'C':
+ cfg->event_clock = parse_event_clock_or_die(optarg);
+ break;
+ case 'e':
+ cfg->edges = parse_edges_or_die(optarg);
+ break;
+ case 'F':
+ cfg->fmt = optarg;
+ break;
+ case 'l':
+ cfg->active_low = true;
+ break;
+ case 'n':
+ cfg->events_wanted = parse_uint_or_die(optarg);
+ break;
+ case 'p':
+ cfg->debounce_period_us = parse_period_or_die(optarg);
+ break;
+ case 'q':
+ cfg->quiet = true;
+ break;
+ case 's':
+ cfg->strict = true;
+ break;
+ case 'h':
+ print_help();
+ exit(EXIT_SUCCESS);
+ case 'v':
+ print_version();
+ exit(EXIT_SUCCESS);
+ case '?':
+ die("try %s --help", get_progname());
+ case 0:
+ break;
+ default:
+ abort();
+ }
+ }
+
+ // setup default clock/format combinations, where not overridden
+ if (cfg->event_clock == 0) {
+ if (cfg->timestamp_fmt)
+ cfg->event_clock = GPIOD_LINE_EVENT_CLOCK_REALTIME;
+ else
+ cfg->event_clock = GPIOD_LINE_EVENT_CLOCK_MONOTONIC;
+ } else if ((cfg->event_clock == GPIOD_LINE_EVENT_CLOCK_REALTIME) &&
+ (cfg->timestamp_fmt == 0)) {
+ cfg->timestamp_fmt = 1;
+ }
+
+ return optind;
+}
+
+static void print_banner(int num_lines, char **lines)
+{
+ int i;
+
+ if (num_lines > 1) {
+ printf("Monitoring lines ");
+
+ for (i = 0; i < num_lines - 1; i++)
+ printf("%s, ", lines[i]);
+
+ printf("and %s...\n", lines[i]);
+ } else {
+ printf("Monitoring line %s...\n", lines[0]);
+ }
+}
+
+static void event_print_formatted(struct gpiod_edge_event *event,
+ struct line_resolver *resolver, int chip_num,
+ struct config *cfg)
+{
+ const char *lname, *prev, *curr;
+ char fmt;
+ uint64_t evtime;
+ int evtype;
+ unsigned int offset;
+
+ offset = gpiod_edge_event_get_line_offset(event);
+ evtime = gpiod_edge_event_get_timestamp_ns(event);
+ evtype = gpiod_edge_event_get_event_type(event);
+
+ for (prev = curr = cfg->fmt;;) {
+ curr = strchr(curr, '%');
+ if (!curr) {
+ fputs(prev, stdout);
+ break;
+ }
+
+ if (prev != curr)
+ fwrite(prev, curr - prev, 1, stdout);
+
+ fmt = *(curr + 1);
+
+ switch (fmt) {
+ case 'c':
+ fputs(get_chip_name(resolver, chip_num), stdout);
+ break;
+ case 'e':
+ printf("%d", evtype);
+ break;
+ case 'E':
+ if (evtype == GPIOD_EDGE_EVENT_RISING_EDGE)
+ fputs("rising", stdout);
+ else
+ fputs("falling", stdout);
+ break;
+ case 'l':
+ lname = get_line_name(resolver, chip_num, offset);
+ if (!lname)
+ lname = "unnamed";
+ fputs(lname, stdout);
+ break;
+ case 'L':
+ print_event_time(evtime, 2);
+ break;
+ case 'o':
+ printf("%u", offset);
+ break;
+ case 'S':
+ print_event_time(evtime, 0);
+ break;
+ case 'U':
+ print_event_time(evtime, 1);
+ break;
+ case '%':
+ fputc('%', stdout);
+ break;
+ case '\0':
+ fputc('%', stdout);
+ goto end;
+ default:
+ fwrite(curr, 2, 1, stdout);
+ break;
+ }
+
+ curr += 2;
+ prev = curr;
+ }
+
+end:
+ fputc('\n', stdout);
+}
+
+static void event_print_human_readable(struct gpiod_edge_event *event,
+ struct line_resolver *resolver,
+ int chip_num, struct config *cfg)
+{
+ unsigned int offset;
+ uint64_t evtime;
+
+ offset = gpiod_edge_event_get_line_offset(event);
+ evtime = gpiod_edge_event_get_timestamp_ns(event);
+
+ print_event_time(evtime, cfg->timestamp_fmt);
+
+ if (gpiod_edge_event_get_event_type(event) ==
+ GPIOD_EDGE_EVENT_RISING_EDGE)
+ fputs("\trising\t", stdout);
+ else
+ fputs("\tfalling\t", stdout);
+
+ print_line_id(resolver, chip_num, offset, cfg->chip_id);
+ fputc('\n', stdout);
+}
+
+static void event_print(struct gpiod_edge_event *event,
+ struct line_resolver *resolver, int chip_num,
+ struct config *cfg)
+{
+ if (cfg->quiet)
+ return;
+
+ if (cfg->fmt)
+ event_print_formatted(event, resolver, chip_num, cfg);
+ else
+ event_print_human_readable(event, resolver, chip_num, cfg);
+}
+
+int main(int argc, char **argv)
+{
+ int num_lines, events_done = 0;
+ struct gpiod_edge_event_buffer *event_buffer;
+ int ret, i, j;
+ struct gpiod_line_settings *settings;
+ struct gpiod_request_config *req_cfg;
+ struct gpiod_line_request **requests;
+ struct pollfd *pollfds;
+ struct gpiod_line_config *line_cfg;
+ unsigned int *offsets;
+ struct gpiod_edge_event *event;
+ struct gpiod_chip *chip;
+ struct line_resolver *resolver;
+ struct config cfg;
+
+ i = parse_config(argc, argv, &cfg);
+ argc -= i;
+ argv += i;
+
+ if (argc < 1)
+ die("at least one GPIO line must be specified");
+
+ if (argc > 64)
+ die("too many lines given");
+
+ settings = gpiod_line_settings_new();
+ if (!settings)
+ die_perror("unable to allocate line settings");
+
+ if (cfg.bias)
+ gpiod_line_settings_set_bias(settings, cfg.bias);
+
+ if (cfg.active_low)
+ gpiod_line_settings_set_active_low(settings, true);
+
+ if (cfg.debounce_period_us)
+ gpiod_line_settings_set_debounce_period_us(settings,
+ cfg.debounce_period_us);
+
+ gpiod_line_settings_set_event_clock(settings, cfg.event_clock);
+ gpiod_line_settings_set_edge_detection(settings, cfg.edges);
+
+ line_cfg = gpiod_line_config_new();
+ if (!line_cfg)
+ die_perror("unable to allocate the line config structure");
+
+ req_cfg = gpiod_request_config_new();
+ if (!req_cfg)
+ die_perror("unable to allocate the request config structure");
+
+ gpiod_request_config_set_consumer(req_cfg, "gpiomon");
+
+ event_buffer = gpiod_edge_event_buffer_new(EVENT_BUF_SIZE);
+ if (!event_buffer)
+ die_perror("unable to allocate the line event buffer");
+
+ resolver = resolve_lines(argc, argv, cfg.chip_id, cfg.strict,
+ cfg.by_name);
+ validate_resolution(resolver, cfg.chip_id);
+ requests = calloc(resolver->num_chips, sizeof(*requests));
+ pollfds = calloc(resolver->num_chips, sizeof(*pollfds));
+ offsets = calloc(resolver->num_lines, sizeof(*offsets));
+ if (!requests || !pollfds || !offsets)
+ die("out of memory");
+
+ for (i = 0; i < resolver->num_chips; i++) {
+ num_lines = get_line_offsets_and_values(resolver, i, offsets,
+ NULL);
+ gpiod_line_config_reset(line_cfg);
+ ret = gpiod_line_config_add_line_settings(line_cfg, offsets,
+ num_lines, settings);
+ if (ret)
+ die_perror("unable to add line settings");
+
+ chip = gpiod_chip_open(resolver->chips[i].path);
+ if (!chip)
+ die_perror("unable to open chip '%s'",
+ resolver->chips[i].path);
+
+ requests[i] = gpiod_chip_request_lines(chip, req_cfg, line_cfg);
+ if (!requests[i])
+ die_perror("unable to request lines on chip %s",
+ resolver->chips[i].path);
+
+ pollfds[i].fd = gpiod_line_request_get_fd(requests[i]);
+ pollfds[i].events = POLLIN;
+ gpiod_chip_close(chip);
+ }
+ gpiod_request_config_free(req_cfg);
+ gpiod_line_config_free(line_cfg);
+ gpiod_line_settings_free(settings);
+
+ if (cfg.banner)
+ print_banner(argc, argv);
+
+ for (;;) {
+ fflush(stdout);
+
+ if (poll(pollfds, resolver->num_chips, -1) < 0)
+ die_perror("error polling for events");
+
+ for (i = 0; i < resolver->num_chips; i++) {
+ if (pollfds[i].revents == 0)
+ continue;
+
+ ret = gpiod_line_request_read_edge_event(requests[i],
+ event_buffer, EVENT_BUF_SIZE);
+ if (ret < 0)
+ die_perror("error reading line events");
+
+ for (j = 0; j < ret; j++) {
+ event = gpiod_edge_event_buffer_get_event(
+ event_buffer, j);
+ if (!event)
+ die_perror("unable to retrieve event from buffer");
+
+ event_print(event, resolver, i, &cfg);
+
+ events_done++;
+
+ if (cfg.events_wanted &&
+ events_done >= cfg.events_wanted)
+ goto done;
+ }
+ }
+ }
+done:
+ for (i = 0; i < resolver->num_chips; i++)
+ gpiod_line_request_release(requests[i]);
+
+ free(requests);
+ free_line_resolver(resolver);
+ gpiod_edge_event_buffer_free(event_buffer);
+ free(offsets);
+
+ return EXIT_SUCCESS;
+}
+
diff --git a/tools/gpioset.c b/tools/gpioset.c
index 0e3a1e4..1dc1728 100644
--- a/tools/gpioset.c
+++ b/tools/gpioset.c
@@ -1,7 +1,8 @@
// SPDX-License-Identifier: GPL-2.0-or-later
// SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
+// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
-#include <errno.h>
+#include <ctype.h>
#include <gpiod.h>
#include <getopt.h>
#include <limits.h>
@@ -9,8 +10,818 @@
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
-#include <sys/select.h>
#include <unistd.h>
+#include <editline/readline.h>
#include "tools-common.h"
+static void print_help(void)
+{
+ printf("Usage: %s [OPTIONS] <line=value>...\n", get_progname());
+ printf("\n");
+ printf("Set values of GPIO lines.\n");
+ printf("\n");
+ printf("Lines are specified by name, or optionally by offset if the chip option\n");
+ printf("is provided.\n");
+ printf("Values may be '1' or '0', or equivalently 'active'/'inactive' or 'on'/'off'.\n");
+ printf("\n");
+ printf("The line output state is maintained until the process exits, but after that\n");
+ printf("is not guaranteed.\n");
+ printf("\n");
+ printf("Options:\n");
+ print_bias_help();
+ printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n");
+ printf(" -c, --chip <chip>\trestrict scope to a particular chip\n");
+ printf(" -d, --drive <drive>\tspecify the line drive mode.\n");
+ printf("\t\t\tPossible values: 'push-pull', 'open-drain', 'open-source'.\n");
+ printf("\t\t\t(default is 'push-pull')\n");
+ printf(" -h, --help\t\tdisplay this help and exit\n");
+ printf(" -i, --interactive\tset the lines then wait for additional set commands.\n");
+ printf("\t\t\tUse the 'help' command at the interactive prompt to get help\n");
+ printf("\t\t\tfor the supported commands.\n");
+ printf(" -l, --active-low\ttreat the line as active low\n");
+ printf(" -p, --hold-period <period>\n");
+ printf("\t\t\tthe minimum time period to hold lines at the requested values\n");
+ printf(" -s, --strict\t\tabort if requested line names are not unique\n");
+ printf(" -t, --toggle <period>[,period]...\n");
+ printf("\t\t\ttoggle the line(s) after the specified period(s).\n");
+ printf("\t\t\tIf the last period is non-zero then the sequence repeats.\n");
+ printf(" -v, --version\t\toutput version information and exit\n");
+ printf(" -z, --daemonize\tset values then detach from the controlling terminal\n");
+ print_chip_help();
+ print_period_help();
+ printf("\n");
+ printf("*Note*\n");
+ printf(" The state of a GPIO line controlled over the character device reverts to default\n");
+ printf(" when the last process referencing the file descriptor representing the device file exits.\n");
+ printf(" This means that it's wrong to run gpioset, have it exit and expect the line to continue\n");
+ printf(" being driven high or low. It may happen if given pin is floating but it must be interpreted\n");
+ printf(" as undefined behavior.\n");
+}
+
+static int parse_drive_or_die(const char *option)
+{
+ if (strcmp(option, "open-drain") == 0)
+ return GPIOD_LINE_DRIVE_OPEN_DRAIN;
+ if (strcmp(option, "open-source") == 0)
+ return GPIOD_LINE_DRIVE_OPEN_SOURCE;
+ if (strcmp(option, "push-pull") != 0)
+ die("invalid drive: %s", option);
+ return 0;
+}
+
+struct config {
+ bool active_low;
+ bool interactive;
+ bool strict;
+ bool daemonize;
+ int bias;
+ int drive;
+ int toggles;
+ unsigned int *toggle_periods;
+ unsigned int hold_period_us;
+ const char *chip_id;
+ int by_name;
+};
+
+int parse_config(int argc, char **argv, struct config *cfg)
+{
+ int opti, optc;
+ const char *const shortopts = "+b:c:d:hilp:st:vz";
+ const struct option longopts[] = {
+ { "active-low", no_argument, NULL, 'l' },
+ { "bias", required_argument, NULL, 'b' },
+ { "by-name", no_argument, &cfg->by_name, 1 },
+ { "chip", required_argument, NULL, 'c' },
+ { "daemonize", no_argument, NULL, 'z' },
+ { "drive", required_argument, NULL, 'd' },
+ { "help", no_argument, NULL, 'h' },
+ { "hold-period", required_argument, NULL, 'p' },
+ { "interactive", no_argument, NULL, 'i' },
+ { "strict", no_argument, NULL, 's' },
+ { "toggle", required_argument, NULL, 't' },
+ { "version", no_argument, NULL, 'v' },
+ { GETOPT_NULL_LONGOPT },
+ };
+
+ memset(cfg, 0, sizeof(*cfg));
+ for (;;) {
+ optc = getopt_long(argc, argv, shortopts, longopts, &opti);
+ if (optc < 0)
+ break;
+
+ switch (optc) {
+ case 'b':
+ cfg->bias = parse_bias_or_die(optarg);
+ break;
+ case 'c':
+ cfg->chip_id = optarg;
+ break;
+ case 'd':
+ cfg->drive = parse_drive_or_die(optarg);
+ break;
+ case 'i':
+ cfg->interactive = true;
+ break;
+ case 'l':
+ cfg->active_low = true;
+ break;
+ case 'p':
+ cfg->hold_period_us = parse_period_or_die(optarg);
+ break;
+ case 's':
+ cfg->strict = true;
+ break;
+ case 't':
+ cfg->toggles = parse_periods_or_die(optarg,
+ &cfg->toggle_periods);
+ break;
+ case 'z':
+ cfg->daemonize = true;
+ break;
+ case 'h':
+ print_help();
+ exit(EXIT_SUCCESS);
+ case 'v':
+ print_version();
+ exit(EXIT_SUCCESS);
+ case '?':
+ die("try %s --help", get_progname());
+ case 0:
+ break;
+ default:
+ abort();
+ }
+ }
+ if (cfg->daemonize && cfg->interactive)
+ die("can't combine daemonize with interactive");
+
+ if (cfg->toggles && cfg->interactive)
+ die("can't combine interactive with toggle");
+
+ return optind;
+}
+
+static int parse_value(const char *option)
+{
+ if (strcmp(option, "0") == 0)
+ return 0;
+ if (strcmp(option, "1") == 0)
+ return 1;
+ if (strcmp(option, "inactive") == 0)
+ return 0;
+ if (strcmp(option, "active") == 0)
+ return 1;
+ if (strcmp(option, "off") == 0)
+ return 0;
+ if (strcmp(option, "on") == 0)
+ return 1;
+ if (strcmp(option, "false") == 0)
+ return 0;
+ if (strcmp(option, "true") == 0)
+ return 1;
+ return -1;
+}
+
+// parse num_lines line id and values from lvs into lines and values
+static bool parse_line_values(int num_lines, char **lvs, char **lines,
+ int *values, bool interactive)
+{
+ int i;
+ char *value;
+
+ for (i = 0; i < num_lines; i++) {
+ value = strchr(lvs[i], '=');
+ if (!value) {
+ if (interactive)
+ printf("invalid line value: '%s'\n", lvs[i]);
+ else
+ print_error("invalid line value: '%s'", lvs[i]);
+
+ return false;
+ }
+ *value = '\0';
+ value++;
+ values[i] = parse_value(value);
+ if (values[i] < 0) {
+ if (interactive)
+ printf("invalid line value: '%s'\n", value);
+ else
+ print_error("invalid line value: '%s'", value);
+
+ return false;
+ }
+ lines[i] = lvs[i];
+ }
+ return true;
+}
+
+/*
+ * parse num_lines line id and values from lvs into lines and values,
+ * or die trying.
+ */
+static void parse_line_values_or_die(int num_lines, char **lvs, char **lines,
+ int *values)
+{
+ if (!parse_line_values(num_lines, lvs, lines, values, false))
+ exit(EXIT_FAILURE);
+}
+
+static void wait_fd(int fd)
+{
+ struct pollfd pfd;
+
+ pfd.fd = fd;
+ pfd.events = POLLERR;
+
+ if (poll(&pfd, 1, -1) < 0)
+ die_perror("error waiting on request");
+}
+
+/*
+ * Apply values from the resolver to the requests.
+ * offset and values are scratch pads for working.
+ */
+static void apply_values(struct gpiod_line_request **requests,
+ struct line_resolver *resolver,
+ unsigned int *offsets, int *values)
+{
+ int i;
+
+ for (i = 0; i < resolver->num_chips; i++) {
+ get_line_offsets_and_values(resolver, i, offsets, values);
+ if (gpiod_line_request_set_values(requests[i], values))
+ print_perror("unable to set values on '%s'",
+ get_chip_name(resolver, i));
+ }
+}
+
+/*
+ * set the values in the resolver for the line values specified by
+ * the remaining parameters.
+ */
+static void set_line_values_subset(struct line_resolver *resolver,
+ int num_lines, char **lines, int *values)
+{
+ int l, i;
+
+ for (l = 0; l < num_lines; l++)
+ for (i = 0; i < resolver->num_lines; i++)
+ if (strcmp(lines[l], resolver->lines[i].id) == 0) {
+ resolver->lines[i].value = values[l];
+ break;
+ }
+}
+
+static void print_all_line_values(struct line_resolver *resolver)
+{
+ int i;
+ char *fmt = "%s=%s ";
+
+ for (i = 0; i < resolver->num_lines; i++) {
+ if (i == resolver->num_lines - 1)
+ fmt = "%s=%s\n";
+
+ printf(fmt, resolver->lines[i].id,
+ resolver->lines[i].value ? "active" : "inactive");
+ }
+}
+
+/*
+ * print the resovler line values for a subset of lines,
+ * specified by num_lines and lines.
+ */
+static void print_line_values(struct line_resolver *resolver, int num_lines,
+ char **lines)
+{
+ int i, j;
+ char *fmt = "%s=%s ";
+ struct resolved_line *line;
+
+ for (i = 0; i < num_lines; i++) {
+ if (i == num_lines - 1)
+ fmt = "%s=%s\n";
+
+ for (j = 0; j < resolver->num_lines; j++) {
+ line = &resolver->lines[j];
+ if (strcmp(lines[i], line->id) == 0) {
+ printf(fmt, line->id,
+ line->value ? "active" : "inactive");
+ break;
+ }
+ }
+ }
+}
+
+/* toggle the values of all lines in the resolver */
+static void toggle_all_lines(struct line_resolver *resolver)
+{
+ int i;
+
+ for (i = 0; i < resolver->num_lines; i++)
+ resolver->lines[i].value = !resolver->lines[i].value;
+}
+
+/*
+ * toggle a subset of lines, specified by num_lines and lines,
+ * in the resolver.
+ */
+static void toggle_lines(struct line_resolver *resolver, int num_lines,
+ char **lines)
+{
+ int i, j;
+ struct resolved_line *line;
+
+ for (i = 0; i < num_lines; i++)
+ for (j = 0; j < resolver->num_lines; j++) {
+ line = &resolver->lines[j];
+ if (strcmp(lines[i], line->id) == 0) {
+ line->value = !line->value;
+ break;
+ }
+ }
+}
+
+/*
+ * toggle the resolved lines as specified by the toggle_periods,
+ * and apply the values to the requests.
+ * offset and values are scratch pads for working.
+ */
+static void toggle_sequence(int toggles, unsigned int *toggle_periods,
+ struct gpiod_line_request **requests,
+ struct line_resolver *resolver,
+ unsigned int *offsets, int *values)
+{
+ int i = 0;
+
+ for (;;) {
+ usleep(toggle_periods[i]);
+ toggle_all_lines(resolver);
+ apply_values(requests, resolver, offsets, values);
+
+ i++;
+ if ((i == toggles - 1) && (toggle_periods[i] == 0))
+ return;
+
+ if (i == toggles)
+ i = 0;
+ }
+}
+
+/*
+ * check that a set of lines, specified by num_lines and lines,
+ * are all resolved lines.
+ */
+static bool valid_lines(struct line_resolver *resolver, int num_lines,
+ char **lines)
+{
+ bool ret = true;
+ int i, l;
+ bool found;
+
+ for (l = 0; l < num_lines; l++) {
+ found = false;
+ for (i = 0; i < resolver->num_lines; i++) {
+ if (strcmp(lines[l], resolver->lines[i].id) == 0) {
+ found = true;
+ break;
+ }
+ }
+ if (!found) {
+ printf("unknown line: '%s'\n", lines[l]);
+ ret = false;
+ }
+ }
+ return ret;
+}
+
+static void print_interactive_help(void)
+{
+ printf("COMMANDS:\n\n");
+ printf(" exit\n");
+ printf(" Exit the program\n");
+ printf(" get [line]...\n");
+ printf(" Display the output values of the given requested lines\n\n");
+ printf(" If no lines are specified then all requested lines are displayed\n\n");
+ printf(" help\n");
+ printf(" Print this help\n\n");
+ printf(" set <line=value>...\n");
+ printf(" Update the output values of the given requested lines\n\n");
+ printf(" sleep <period>\n");
+ printf(" Sleep for the specified period\n\n");
+ printf(" toggle [line]...\n");
+ printf(" Toggle the output values of the given requested lines\n\n");
+ printf(" If no lines are specified then all requested lines are toggled\n\n");
+}
+
+/*
+ * split a line into words, returning the each of the words and the count.
+ *
+ * max_words specifies the max number of words that may be returned in words.
+ */
+static int split_words(char *line, int max_words, char **words)
+{
+ int num_words = 0;
+ bool in_word = false;
+
+ while (*line != '\0') {
+ if (!in_word && !isspace(*line)) {
+ in_word = true;
+
+ /* count all words, but only store max_words */
+ if (num_words < max_words)
+ words[num_words] = line;
+
+ } else if (isspace(*line)) {
+ if (in_word) {
+ num_words++;
+ in_word = false;
+ }
+ *line = '\0';
+ }
+ line++;
+ }
+ if (in_word)
+ num_words++;
+
+ return num_words;
+}
+
+/* check if a line is specified somewhere in the rl_line_buffer */
+static bool in_line_buffer(const char *id)
+{
+ int len = strlen(id);
+ char *match = rl_line_buffer;
+
+ while ((match = strstr(rl_line_buffer, id))) {
+ if ((match > rl_line_buffer && isspace(match[-1])) &&
+ (isspace(match[len]) || (match[len] == '=')))
+ return true;
+
+ match += len;
+ }
+
+ return false;
+}
+
+/* context for complete_line_id, so it can provide valid line ids */
+static struct line_resolver *completion_context;
+
+/* tab completion helper for line ids */
+static char *complete_line_id(const char *text, int state)
+{
+ static int idx, len;
+ const char *id;
+
+ if (!state) {
+ idx = 0;
+ len = strlen(text);
+ }
+ while (idx < completion_context->num_lines) {
+ id = completion_context->lines[idx].id;
+ idx++;
+ if ((strncmp(id, text, len) == 0) &&
+ (!in_line_buffer(id)))
+ return strdup(id);
+ }
+ return NULL;
+}
+
+/* tab completion helper for line values (just the value component) */
+static char *complete_value(const char *text, int state)
+{
+ static const char * const values[] = {
+ "1", "0", "active", "inactive", "on", "off", "true", "false",
+ NULL
+ };
+ static int idx, len;
+ const char *value;
+
+ if (!state) {
+ idx = 0;
+ len = strlen(text);
+ }
+ while ((value = values[idx])) {
+ idx++;
+ if (strncmp(value, text, len) == 0)
+ return strdup(value);
+ }
+ return NULL;
+}
+
+/* tab completion help for interactive commands */
+static char *complete_command(const char *text, int state)
+{
+ static const char * const commands[] = {
+ "get", "set", "toggle", "sleep", "help", "exit", NULL
+ };
+ static int idx, len;
+ const char *cmd;
+
+ if (!state) {
+ idx = 0;
+ len = strlen(text);
+ }
+
+ while ((cmd = commands[idx])) {
+ idx++;
+ if (strncmp(cmd, text, len) == 0)
+ return strdup(cmd);
+ }
+ return NULL;
+}
+
+/* tab completion for interactive command lines */
+static char **tab_completion(const char *text, int start, int end)
+{
+ char **matches = NULL;
+ int cmd_start, cmd_end, len;
+
+ rl_attempted_completion_over = true;
+ rl_completion_type = '@';
+
+ for (cmd_start = 0;
+ isspace(rl_line_buffer[cmd_start]) && cmd_start < end;
+ cmd_start++)
+ ;
+
+ if (cmd_start == start)
+ matches = rl_completion_matches(text, complete_command);
+
+ for (cmd_end = cmd_start + 1;
+ !isspace(rl_line_buffer[cmd_end]) && cmd_end < end;
+ cmd_end++)
+ ;
+
+ len = cmd_end - cmd_start;
+ if (len == 3 && strncmp("set", &rl_line_buffer[cmd_start], 3) == 0) {
+ if (rl_line_buffer[start - 1] == '=') {
+ matches = rl_completion_matches(text, complete_value);
+ } else {
+ rl_completion_append_character = '=';
+ matches = rl_completion_matches(text, complete_line_id);
+ }
+ }
+
+ if ((len == 3 && strncmp("get", &rl_line_buffer[cmd_start], 3) == 0) ||
+ (len == 6 && strncmp("toggle", &rl_line_buffer[cmd_start], 6) == 0))
+ matches = rl_completion_matches(text, complete_line_id);
+
+ return matches;
+}
+
+static void interact(struct gpiod_line_request **requests,
+ struct line_resolver *resolver,
+ char **lines, unsigned int *offsets, int *values)
+{
+ char *line;
+ int num_words, num_lines, max_words;
+ char **words;
+ int period_us, i;
+ char *line_buf;
+ bool done;
+
+ stifle_history(20);
+ rl_attempted_completion_function = tab_completion;
+ completion_context = resolver;
+
+ max_words = resolver->num_lines + 1;
+ words = calloc(max_words, sizeof(*words));
+ if (!words)
+ die("out of memory");
+
+ for (done = false; !done;) {
+ /*
+ * manually print the prompt, as libedit doesn't if stdout
+ * is not a tty. And fflush to ensure the prompt and any
+ * output buffered from the previous command is sent.
+ */
+ printf("gpioset> ");
+ fflush(stdout);
+
+ line = readline(NULL);
+ if (!line || line[0] == '\0')
+ continue;
+
+ for (i = strlen(line) - 1; (i > 0) && isspace(line[i]); i--)
+ line[i] = '\0';
+
+ line_buf = strdup(line);
+ num_words = split_words(line_buf, max_words, words);
+ if (num_words > max_words) {
+ printf("too many command parameters provided\n");
+ goto cmd_done;
+ }
+ num_lines = num_words - 1;
+ if (strcmp(words[0], "get") == 0) {
+ if (num_lines == 0)
+ print_all_line_values(resolver);
+ else if (valid_lines(resolver, num_lines, &words[1]))
+ print_line_values(resolver, num_lines,
+ &words[1]);
+ goto cmd_ok;
+ }
+ if (strcmp(words[0], "set") == 0) {
+ if (num_lines == 0)
+ printf("at least one GPIO line value must be specified\n");
+ else if (parse_line_values(num_lines, &words[1], lines,
+ values, true) &&
+ valid_lines(resolver, num_lines, lines)) {
+ set_line_values_subset(resolver, num_lines,
+ lines, values);
+ apply_values(requests, resolver, offsets,
+ values);
+ }
+ goto cmd_ok;
+ }
+ if (strcmp(words[0], "toggle") == 0) {
+ if (num_lines == 0)
+ toggle_all_lines(resolver);
+ else if (valid_lines(resolver, num_lines, &words[1]))
+ toggle_lines(resolver, num_lines, &words[1]);
+
+ apply_values(requests, resolver, offsets, values);
+ goto cmd_ok;
+ }
+ if (strcmp(words[0], "sleep") == 0) {
+ if (num_lines == 0) {
+ printf("a period must be specified\n");
+ goto cmd_ok;
+ }
+ if (num_lines > 1) {
+ printf("only one period can be specified\n");
+ goto cmd_ok;
+ }
+ period_us = parse_period(words[1]);
+ if (period_us < 0) {
+ printf("invalid period: '%s'\n", words[1]);
+ goto cmd_ok;
+ }
+ usleep(period_us);
+ goto cmd_ok;
+ }
+
+ if (strcmp(words[0], "exit") == 0) {
+ done = true;
+ goto cmd_done;
+ }
+
+ if (strcmp(words[0], "help") == 0) {
+ print_interactive_help();
+ goto cmd_done;
+ }
+
+ printf("unknown command: '%s'\n", words[0]);
+ printf("Try the 'help' command\n")
+ ;
+
+cmd_ok:
+ for (i = 0; isspace(line[i]); i++)
+ ;
+
+ if ((history_length) == 0 ||
+ (strcmp(history_list()[history_length - 1]->line,
+ &line[i]) != 0))
+ add_history(&line[i]);
+
+cmd_done:
+ free(line);
+ free(line_buf);
+ }
+ free(words);
+}
+
+int main(int argc, char **argv)
+{
+ int i, j, num_lines, ret, *values;
+ struct gpiod_line_settings *settings;
+ struct gpiod_request_config *req_cfg;
+ struct gpiod_line_request **requests;
+ struct gpiod_line_config *line_cfg;
+ struct gpiod_chip *chip;
+ unsigned int *offsets;
+ struct line_resolver *resolver;
+ char **lines;
+ struct config cfg;
+
+ i = parse_config(argc, argv, &cfg);
+ argc -= i;
+ argv += i;
+
+ if (argc < 1)
+ die("at least one GPIO line value must be specified");
+
+ num_lines = argc;
+
+ lines = calloc(num_lines, sizeof(*lines));
+ values = calloc(num_lines, sizeof(*values));
+ if (!lines || !values)
+ die("out of memory");
+
+ parse_line_values_or_die(argc, argv, lines, values);
+
+ settings = gpiod_line_settings_new();
+ if (!settings)
+ die_perror("unable to allocate line settings");
+
+ if (cfg.bias)
+ gpiod_line_settings_set_bias(settings, cfg.bias);
+
+ if (cfg.drive)
+ gpiod_line_settings_set_drive(settings, cfg.drive);
+
+ if (cfg.active_low)
+ gpiod_line_settings_set_active_low(settings, true);
+
+ gpiod_line_settings_set_direction(settings,
+ GPIOD_LINE_DIRECTION_OUTPUT);
+
+ req_cfg = gpiod_request_config_new();
+ if (!req_cfg)
+ die_perror("unable to allocate the request config structure");
+
+ gpiod_request_config_set_consumer(req_cfg, "gpioset");
+ resolver = resolve_lines(num_lines, lines, cfg.chip_id, cfg.strict,
+ cfg.by_name);
+ validate_resolution(resolver, cfg.chip_id);
+ for (i = 0; i < num_lines; i++)
+ resolver->lines[i].value = values[i];
+
+ requests = calloc(resolver->num_chips, sizeof(*requests));
+ offsets = calloc(num_lines, sizeof(*offsets));
+ if (!requests || !offsets)
+ die("out of memory");
+
+ line_cfg = gpiod_line_config_new();
+ if (!line_cfg)
+ die_perror("unable to allocate the line config structure");
+
+ for (i = 0; i < resolver->num_chips; i++) {
+ num_lines = get_line_offsets_and_values(resolver, i,
+ offsets, values);
+
+ gpiod_line_config_reset(line_cfg);
+ for (j = 0; j < num_lines; j++) {
+ gpiod_line_settings_set_output_value(settings,
+ values[j]);
+
+ ret = gpiod_line_config_add_line_settings(line_cfg,
+ &offsets[j], 1, settings);
+ if (ret)
+ die_perror("unable to add line settings");
+ }
+
+ chip = gpiod_chip_open(resolver->chips[i].path);
+ if (!chip)
+ die_perror("unable to open chip '%s'",
+ resolver->chips[i].path);
+
+ requests[i] = gpiod_chip_request_lines(chip, req_cfg, line_cfg);
+ if (!requests[i])
+ die_perror("unable to request lines on chip '%s'",
+ resolver->chips[i].path);
+
+ gpiod_chip_close(chip);
+ }
+
+ gpiod_request_config_free(req_cfg);
+ gpiod_line_config_free(line_cfg);
+ gpiod_line_settings_free(settings);
+
+ if (cfg.daemonize)
+ if (daemon(0, 0) < 0)
+ die_perror("unable to daemonize");
+
+ if (cfg.toggles) {
+ for (i = 0; i < cfg.toggles; i++)
+ if ((cfg.hold_period_us > cfg.toggle_periods[i]) &&
+ ((i != cfg.toggles - 1) ||
+ cfg.toggle_periods[i] != 0))
+ cfg.toggle_periods[i] = cfg.hold_period_us;
+
+ toggle_sequence(cfg.toggles, cfg.toggle_periods, requests,
+ resolver, offsets, values);
+ free(cfg.toggle_periods);
+ }
+
+ if (cfg.hold_period_us)
+ usleep(cfg.hold_period_us);
+
+ if (cfg.interactive)
+ interact(requests, resolver, lines, offsets, values);
+
+ if (cfg.daemonize)
+ wait_fd(gpiod_line_request_get_fd(requests[0]));
+
+ for (i = 0; i < resolver->num_chips; i++)
+ gpiod_line_request_release(requests[i]);
+
+ free(requests);
+ free_line_resolver(resolver);
+ free(lines);
+ free(values);
+ free(offsets);
+
+ return EXIT_SUCCESS;
+}
+
diff --git a/tools/tools-common.c b/tools/tools-common.c
index ea7dfa8..85ee687 100644
--- a/tools/tools-common.c
+++ b/tools/tools-common.c
@@ -1,18 +1,22 @@
// SPDX-License-Identifier: GPL-2.0-or-later
// SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
+// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
/* Common code for GPIO tools. */
#include <ctype.h>
+#include <dirent.h>
#include <errno.h>
#include <gpiod.h>
+#include <inttypes.h>
#include <libgen.h>
-#include <signal.h>
+#include <limits.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
-#include <sys/signalfd.h>
+#include <sys/stat.h>
+#include <time.h>
#include "tools-common.h"
@@ -21,6 +25,28 @@ const char *get_progname(void)
return program_invocation_name;
}
+void print_error(const char *fmt, ...)
+{
+ va_list va;
+
+ va_start(va, fmt);
+ fprintf(stderr, "%s: ", program_invocation_name);
+ vfprintf(stderr, fmt, va);
+ fprintf(stderr, "\n");
+ va_end(va);
+}
+
+void print_perror(const char *fmt, ...)
+{
+ va_list va;
+
+ va_start(va, fmt);
+ fprintf(stderr, "%s: ", program_invocation_name);
+ vfprintf(stderr, fmt, va);
+ fprintf(stderr, ": %s\n", strerror(errno));
+ va_end(va);
+}
+
void die(const char *fmt, ...)
{
va_list va;
@@ -57,41 +83,327 @@ void print_version(void)
printf("There is NO WARRANTY, to the extent permitted by law.\n");
}
-int parse_bias(const char *option)
+int parse_bias_or_die(const char *option)
{
if (strcmp(option, "pull-down") == 0)
return GPIOD_LINE_BIAS_PULL_DOWN;
if (strcmp(option, "pull-up") == 0)
return GPIOD_LINE_BIAS_PULL_UP;
- if (strcmp(option, "disable") == 0)
- return GPIOD_LINE_BIAS_DISABLED;
- if (strcmp(option, "as-is") != 0)
+ if (strcmp(option, "disabled") != 0)
die("invalid bias: %s", option);
- return 0;
+ return GPIOD_LINE_BIAS_DISABLED;
+}
+
+int parse_period(const char *option)
+{
+ unsigned long p, m = 0;
+ char *end;
+
+ p = strtoul(option, &end, 10);
+ switch (*end) {
+ case 'u':
+ m = 1;
+ end++;
+ break;
+ case 'm':
+ m = 1000;
+ end++;
+ break;
+ case 's':
+ m = 1000000;
+ break;
+ case '\0':
+ break;
+ default:
+ return -1;
+ }
+
+ if (m) {
+ if (*end != 's')
+ return -1;
+
+ end++;
+ } else {
+ m = 1000;
+ }
+
+ p *= m;
+ if (*end != '\0' || p > INT_MAX)
+ return -1;
+
+ return p;
+}
+
+unsigned int parse_period_or_die(const char *option)
+{
+ int period = parse_period(option);
+
+ if (period < 0)
+ die("invalid period: %s", option);
+
+ return period;
+}
+
+int parse_periods_or_die(char *option, unsigned int **periods)
+{
+ int i, num_periods = 1;
+ unsigned int *pp;
+ char *end;
+
+ for (i = 0; option[i] != '\0'; i++)
+ if (option[i] == ',')
+ num_periods++;
+
+ pp = calloc(num_periods, sizeof(*pp));
+ if (pp == NULL)
+ die("out of memory");
+
+ for (i = 0; i < num_periods - 1; i++) {
+ for (end = option; *end != ','; end++)
+ ;
+
+ *end = '\0';
+ pp[i] = parse_period_or_die(option);
+ option = end + 1;
+ }
+ pp[i] = parse_period_or_die(option);
+ *periods = pp;
+
+ return num_periods;
+}
+
+int parse_uint(const char *option)
+{
+ unsigned long o;
+ char *end;
+
+ o = strtoul(option, &end, 10);
+ if (*end == '\0' && o <= INT_MAX)
+ return o;
+
+ return -1;
+}
+
+unsigned int parse_uint_or_die(const char *option)
+{
+ int i = parse_uint(option);
+
+ if (i < 0)
+ die("invalid number: '%s'", option);
+
+ return i;
}
void print_bias_help(void)
{
- printf("Biases:\n");
- printf(" as-is:\tleave bias unchanged\n");
- printf(" disable:\tdisable bias\n");
- printf(" pull-up:\tenable pull-up\n");
- printf(" pull-down:\tenable pull-down\n");
+ printf(" -b, --bias <bias>\tspecify the line bias.\n");
+ printf("\t\t\tPossible values: 'pull-down', 'pull-up', 'disabled'.\n");
+ printf("\t\t\t(default is to leave bias unchanged)\n");
}
-int chip_dir_filter(const struct dirent *entry)
+void print_chip_help(void)
+{
+ printf("\nChips:\n");
+ printf(" A GPIO chip may be identified by number, name, or path.\n");
+ printf(" e.g. '0', 'gpiochip0', and '/dev/gpiochip0' all refer to the same chip.\n");
+}
+
+void print_period_help(void)
+{
+ printf("\nPeriods:\n");
+ printf(" Periods are taken as milliseconds unless units are specified. e.g. 10us.\n");
+ printf(" Supported units are 's', 'ms', and 'us'.\n");
+}
+
+#define TIME_BUFFER_SIZE 20
+
+/*
+ * format:
+ * 0: raw seconds
+ * 1: utc time
+ * 2: local time
+ */
+void print_event_time(uint64_t evtime, int format)
+{
+ time_t evtsec;
+ struct tm t;
+ char tbuf[TIME_BUFFER_SIZE];
+ char *tz;
+
+ if (format) {
+ evtsec = evtime / 1000000000;
+ if (format == 2) {
+ localtime_r(&evtsec, &t);
+ tz = "";
+ } else {
+ gmtime_r(&evtsec, &t);
+ tz = "Z";
+ }
+ strftime(tbuf, TIME_BUFFER_SIZE, "%FT%T", &t);
+ printf("%s.%09"PRIu64"%s", tbuf, evtime % 1000000000, tz);
+ } else {
+ printf("%"PRIu64".%09"PRIu64,
+ evtime / 1000000000, evtime % 1000000000);
+ }
+}
+
+static void print_bias(struct gpiod_line_info *info)
+{
+ const char *name;
+
+ switch (gpiod_line_info_get_bias(info)) {
+ case GPIOD_LINE_BIAS_PULL_UP:
+ name = "pull-up";
+ break;
+ case GPIOD_LINE_BIAS_PULL_DOWN:
+ name = "pull-down";
+ break;
+ case GPIOD_LINE_BIAS_DISABLED:
+ name = "disabled";
+ break;
+ default:
+ return;
+ }
+ printf(" bias=%s", name);
+}
+
+static void print_drive(struct gpiod_line_info *info)
+{
+ const char *name;
+
+ switch (gpiod_line_info_get_drive(info)) {
+ case GPIOD_LINE_DRIVE_OPEN_DRAIN:
+ name = "open-drain";
+ break;
+ case GPIOD_LINE_DRIVE_OPEN_SOURCE:
+ name = "open-source";
+ break;
+ default:
+ return;
+ }
+ printf(" drive=%s", name);
+}
+
+static void print_edge_detection(struct gpiod_line_info *info)
+{
+ const char *name;
+
+ switch (gpiod_line_info_get_edge_detection(info)) {
+ case GPIOD_LINE_EDGE_BOTH:
+ name = "both";
+ break;
+ case GPIOD_LINE_EDGE_RISING:
+ name = "rising";
+ break;
+ case GPIOD_LINE_EDGE_FALLING:
+ name = "falling";
+ break;
+ default:
+ return;
+ }
+ printf(" edges=%s", name);
+}
+
+static void print_event_clock(struct gpiod_line_info *info)
+{
+ const char *name;
+
+ switch (gpiod_line_info_get_event_clock(info)) {
+ case GPIOD_LINE_EVENT_CLOCK_REALTIME:
+ name = "realtime";
+ break;
+ case GPIOD_LINE_EVENT_CLOCK_HTE:
+ name = "hte";
+ break;
+ default:
+ return;
+ }
+ printf(" event-clock=%s", name);
+}
+
+static void print_debounce(struct gpiod_line_info *info)
+{
+ unsigned long debounce;
+ const char *units = "us";
+
+ debounce = gpiod_line_info_get_debounce_period_us(info);
+ if (!debounce)
+ return;
+ if (debounce % 1000000 == 0) {
+ debounce /= 1000000;
+ units = "s";
+ } else if (debounce % 1000 == 0) {
+ debounce /= 1000;
+ units = "ms";
+ }
+ printf(" debounce-period=%lu%s", debounce, units);
+}
+
+static void print_consumer(struct gpiod_line_info *info)
+{
+ const char *consumer;
+
+ if (!gpiod_line_info_is_used(info))
+ return;
+
+ consumer = gpiod_line_info_get_consumer(info);
+ if (!consumer)
+ consumer = "kernel";
+ printf(" consumer=%s", consumer);
+}
+
+void print_line_attributes(struct gpiod_line_info *info)
+{
+ int direction;
+
+ direction = gpiod_line_info_get_direction(info);
+
+ printf("%s", direction == GPIOD_LINE_DIRECTION_INPUT ?
+ "input" : "output");
+
+ if (gpiod_line_info_is_active_low(info))
+ printf(" active-low");
+
+ print_drive(info);
+ print_bias(info);
+ print_edge_detection(info);
+ print_event_clock(info);
+ print_debounce(info);
+ print_consumer(info);
+}
+
+void print_line_id(struct line_resolver *resolver, int chip_num,
+ unsigned int offset, const char *chip_id)
+{
+ const char *lname;
+
+ lname = get_line_name(resolver, chip_num, offset);
+ if (lname)
+ if (chip_id)
+ printf("%s %u %s", get_chip_name(resolver, chip_num),
+ offset, lname);
+ else
+ fputs(lname, stdout);
+ else
+ printf("%s %u", get_chip_name(resolver, chip_num), offset);
+}
+
+static int chip_dir_filter(const struct dirent *entry)
{
- bool is_chip;
char *path;
- int ret;
+ int ret = 0;
+ struct stat sb;
- ret = asprintf(&path, "/dev/%s", entry->d_name);
- if (ret < 0)
+ if (asprintf(&path, "/dev/%s", entry->d_name) < 0)
return 0;
- is_chip = gpiod_is_gpiochip_device(path);
+ if ((lstat(path, &sb) == 0) &&
+ (!S_ISLNK(sb.st_mode)) &&
+ gpiod_is_gpiochip_device(path))
+ ret = 1;
+
free(path);
- return !!is_chip;
+ return ret;
}
static bool isuint(const char *str)
@@ -101,3 +413,366 @@ static bool isuint(const char *str)
return *str == '\0';
}
+
+bool chip_path_lookup(const char *id, char **path_ptr)
+{
+ char *path;
+
+ if (isuint(id)) {
+ /* by number */
+ if (asprintf(&path, "/dev/gpiochip%s", id) < 0)
+ return false;
+ } else if (strchr(id, '/')) {
+ /* by path */
+ if (asprintf(&path, "%s", id) < 0)
+ return false;
+ } else {
+ /* by device name */
+ if (asprintf(&path, "/dev/%s", id) < 0)
+ return false;
+ }
+
+ if (!gpiod_is_gpiochip_device(path)) {
+ free(path);
+ return false;
+ }
+
+ *path_ptr = path;
+
+ return true;
+}
+
+int chip_paths(const char *id, char ***paths_ptr)
+{
+ char *path;
+ char **paths;
+
+ if (id == NULL)
+ return all_chip_paths(paths_ptr);
+
+ if (!chip_path_lookup(id, &path))
+ return 0;
+
+ paths = malloc(sizeof(*paths));
+ if (paths == NULL)
+ die("out of memory");
+
+ paths[0] = path;
+ *paths_ptr = paths;
+
+ return 1;
+}
+
+int all_chip_paths(char ***paths_ptr)
+{
+ int i, j, num_chips, ret = 0;
+ struct dirent **entries;
+ char **paths;
+
+ num_chips = scandir("/dev/", &entries, chip_dir_filter, alphasort);
+ if (num_chips < 0)
+ die_perror("unable to scan /dev");
+
+ paths = calloc(num_chips, sizeof(*paths));
+ if (paths == NULL)
+ die("out of memory");
+
+ for (i = 0; i < num_chips; i++) {
+ if (asprintf(&paths[i], "/dev/%s", entries[i]->d_name) < 0) {
+ for (j = 0; j < i; j++)
+ free(paths[j]);
+
+ free(paths);
+ return 0;
+ }
+ }
+
+ *paths_ptr = paths;
+ ret = num_chips;
+
+ for (i = 0; i < num_chips; i++)
+ free(entries[i]);
+
+ free(entries);
+ return ret;
+}
+
+static bool resolve_line(struct line_resolver *resolver,
+ struct gpiod_line_info *info,
+ int chip_num)
+{
+ struct resolved_line *line;
+ const char *name;
+ int i;
+ unsigned int offset;
+ bool resolved = false;
+
+ offset = gpiod_line_info_get_offset(info);
+ for (i = 0; i < resolver->num_lines; i++) {
+ line = &resolver->lines[i];
+ // already resolved by offset?
+ if (line->resolved &&
+ (line->offset == offset) &&
+ (line->chip_num == chip_num)) {
+ line->info = info;
+ resolver->num_found++;
+ resolved = true;
+ }
+ if (line->resolved && !resolver->strict)
+ continue;
+
+ // else resolve by name
+ name = gpiod_line_info_get_name(info);
+ if (name && (strcmp(line->id, name) == 0)) {
+ if (resolver->strict && line->resolved)
+ die("line '%s' is not unique", line->id);
+ line->offset = offset;
+ line->info = info;
+ line->chip_num = resolver->num_chips;
+ line->resolved = true;
+ resolver->num_found++;
+ resolved = true;
+ }
+ }
+
+ return resolved;
+}
+
+// check for lines that can be identified by offset
+//
+// This only applies to the first chip, as otherwise the lines must be
+// identified by name.
+bool resolve_lines_by_offset(struct line_resolver *resolver,
+ unsigned int num_lines)
+{
+ int i;
+ struct resolved_line *line;
+ bool used = false;
+
+ for (i = 0; i < resolver->num_lines; i++) {
+ line = &resolver->lines[i];
+ if ((line->id_as_offset != -1) &&
+ (line->id_as_offset < (int)num_lines)) {
+ line->chip_num = 0;
+ line->offset = line->id_as_offset;
+ line->resolved = true;
+ used = true;
+ }
+ }
+ return used;
+}
+
+
+bool resolve_done(struct line_resolver *resolver)
+{
+ return (!resolver->strict &&
+ resolver->num_found >= resolver->num_lines);
+}
+
+struct line_resolver *resolver_init(int num_lines, char **lines, int num_chips,
+ bool strict, bool by_name)
+{
+ struct line_resolver *resolver;
+ struct resolved_line *line;
+ size_t resolver_size;
+ int i;
+
+ resolver_size = sizeof(*resolver) + num_lines * sizeof(*line);
+ resolver = malloc(resolver_size);
+ if (resolver == NULL)
+ die("out of memory");
+
+ memset(resolver, 0, resolver_size);
+
+ resolver->chips = calloc(num_chips, sizeof(struct resolved_chip));
+ if (resolver->chips == NULL)
+ die("out of memory");
+ memset(resolver->chips, 0, num_chips * sizeof(struct resolved_chip));
+
+ resolver->num_lines = num_lines;
+ resolver->strict = strict;
+ for (i = 0; i < num_lines; i++) {
+ line = &resolver->lines[i];
+ line->id = lines[i];
+ line->id_as_offset = by_name ? -1 : parse_uint(lines[i]);
+ line->chip_num = -1;
+ }
+ return resolver;
+}
+
+struct line_resolver *resolve_lines(int num_lines, char **lines,
+ const char *chip_id, bool strict, bool by_name)
+{
+ struct line_resolver *resolver;
+ struct gpiod_chip *chip;
+ struct gpiod_chip_info *chip_info;
+ struct gpiod_line_info *line_info;
+ char **paths;
+ int num_chips, i, offset;
+ bool chip_used;
+
+ if (chip_id == NULL)
+ by_name = true;
+
+ num_chips = chip_paths(chip_id, &paths);
+ if (chip_id && (num_chips == 0))
+ die("cannot find GPIO chip character device '%s'", chip_id);
+
+ resolver = resolver_init(num_lines, lines, num_chips, strict, by_name);
+
+ for (i = 0; (i < num_chips) && !resolve_done(resolver); i++) {
+ chip_used = false;
+ chip = gpiod_chip_open(paths[i]);
+ if (!chip) {
+ if ((errno == EACCES) && (chip_id == NULL)) {
+ free(paths[i]);
+ continue;
+ }
+
+ die_perror("unable to open chip '%s'", paths[i]);
+ }
+
+ chip_info = gpiod_chip_get_info(chip);
+ if (!chip_info)
+ die_perror("unable to get info for '%s'", paths[i]);
+
+ num_lines = gpiod_chip_info_get_num_lines(chip_info);
+
+ if (i == 0 && chip_id && !by_name)
+ chip_used = resolve_lines_by_offset(resolver, num_lines);
+
+ for (offset = 0;
+ (offset < num_lines) && !resolve_done(resolver);
+ offset++) {
+ line_info = gpiod_chip_get_line_info(chip, offset);
+ if (!line_info)
+ die_perror("unable to read the info for line %d from %s",
+ offset,
+ gpiod_chip_info_get_name(chip_info));
+
+ if (resolve_line(resolver, line_info, i))
+ chip_used = true;
+ else
+ gpiod_line_info_free(line_info);
+
+ }
+
+ gpiod_chip_close(chip);
+
+ if (chip_used) {
+ resolver->chips[resolver->num_chips].info = chip_info;
+ resolver->chips[resolver->num_chips].path = paths[i];
+ resolver->num_chips++;
+ } else {
+ gpiod_chip_info_free(chip_info);
+ free(paths[i]);
+ }
+ }
+ free(paths);
+
+ return resolver;
+}
+
+void validate_resolution(struct line_resolver *resolver, const char *chip_id)
+{
+ struct resolved_line *line, *prev;
+ int i, j;
+ bool valid = true;
+
+ for (i = 0 ; i < resolver->num_lines; i++) {
+ line = &resolver->lines[i];
+ if (line->resolved) {
+ for (j = 0; j < i; j++) {
+ prev = &resolver->lines[j];
+ if (prev->resolved &&
+ (prev->chip_num == line->chip_num) &&
+ (prev->offset == line->offset)) {
+ print_error("lines '%s' and '%s' are the same line",
+ prev->id, line->id);
+ valid = false;
+ break;
+ }
+ }
+ continue;
+ }
+ valid = false;
+ if (chip_id && line->id_as_offset != -1)
+ print_error("offset %s is out of range on chip '%s'",
+ line->id, chip_id);
+ else
+ print_error("cannot find line '%s'", line->id);
+ }
+ if (!valid)
+ exit(EXIT_FAILURE);
+}
+
+void free_line_resolver(struct line_resolver *resolver)
+{
+ int i;
+
+ if (!resolver)
+ return;
+
+ for (i = 0; i < resolver->num_lines; i++)
+ gpiod_line_info_free(resolver->lines[i].info);
+
+ for (i = 0; i < resolver->num_chips; i++) {
+ gpiod_chip_info_free(resolver->chips[i].info);
+ free(resolver->chips[i].path);
+ }
+
+ free(resolver->chips);
+ free(resolver);
+}
+
+int get_line_offsets_and_values(struct line_resolver *resolver,
+ int chip_num, unsigned int *offsets, int *values)
+{
+ struct resolved_line *line;
+ int i, num_lines = 0;
+
+ for (i = 0; i < resolver->num_lines; i++) {
+ line = &resolver->lines[i];
+ if (line->chip_num == chip_num) {
+ offsets[num_lines] = line->offset;
+ if (values)
+ values[num_lines] = line->value;
+
+ num_lines++;
+ }
+ }
+ return num_lines;
+}
+
+const char *get_chip_name(struct line_resolver *resolver, int chip_num)
+{
+ return gpiod_chip_info_get_name(resolver->chips[chip_num].info);
+}
+
+const char *get_line_name(struct line_resolver *resolver,
+ int chip_num, unsigned int offset)
+{
+ struct resolved_line *line;
+ int i;
+
+ for (i = 0; i < resolver->num_lines; i++) {
+ line = &resolver->lines[i];
+ if (line->info && (line->offset == offset) &&
+ (line->chip_num == chip_num))
+ return gpiod_line_info_get_name(resolver->lines[i].info);
+ }
+
+ return 0;
+}
+
+void set_line_values(struct line_resolver *resolver, int chip_num, int *values)
+{
+ int i, j;
+
+ for (i = 0, j = 0; i < resolver->num_lines; i++) {
+ if (resolver->lines[i].chip_num == chip_num) {
+ resolver->lines[i].value = values[j];
+ j++;
+ }
+ }
+}
diff --git a/tools/tools-common.h b/tools/tools-common.h
index cb61d54..77946e5 100644
--- a/tools/tools-common.h
+++ b/tools/tools-common.h
@@ -1,10 +1,10 @@
/* SPDX-License-Identifier: GPL-2.0-or-later */
/* SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> */
+/* SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> */
#ifndef __GPIOD_TOOLS_COMMON_H__
#define __GPIOD_TOOLS_COMMON_H__
-#include <dirent.h>
#include <gpiod.h>
/*
@@ -21,16 +21,101 @@
#define GETOPT_NULL_LONGOPT NULL, 0, NULL, 0
+struct resolved_line {
+ /* from the command line */
+ const char *id;
+
+ /*
+ * id parsed as int, if that is an option, or -1 if line must be
+ * resolved by name
+ */
+ int id_as_offset;
+
+ /* line has been located on a chip */
+ bool resolved;
+
+ /* remaining fields only valid once resolved... */
+
+ /* info for the line */
+ struct gpiod_line_info *info;
+
+ /* num of relevant chip in line_resolver */
+ int chip_num;
+
+ /* offset of line on chip */
+ uint offset;
+
+ /* line value for gpioget/set */
+ int value;
+};
+
+struct resolved_chip {
+ /* info of the relevant chips */
+ struct gpiod_chip_info *info;
+
+ /* path to the chip */
+ char *path;
+};
+
+/* a resolver from requested line names/offsets to lines on the system */
+struct line_resolver {
+ /*
+ * number of chips the lines span, and number of entries in chips
+ */
+ int num_chips;
+
+ /* number of lines in lines */
+ int num_lines;
+
+ /* number of lines found */
+ int num_found;
+
+ /* perform exhaustive search to check line names are unique */
+ bool strict;
+
+ /* details of the relevant chips */
+ struct resolved_chip *chips;
+
+ /* descriptors for the requested lines */
+ struct resolved_line lines[];
+};
+
const char *get_progname(void);
+void print_error(const char *fmt, ...) PRINTF(1, 2);
+void print_perror(const char *fmt, ...) PRINTF(1, 2);
void die(const char *fmt, ...) NORETURN PRINTF(1, 2);
void die_perror(const char *fmt, ...) NORETURN PRINTF(1, 2);
void print_version(void);
-int parse_bias(const char *option);
+int parse_bias_or_die(const char *option);
+int parse_period(const char *option);
+unsigned int parse_period_or_die(const char *option);
+int parse_periods_or_die(char *option, unsigned int **periods);
+int parse_uint(const char *option);
+unsigned int parse_uint_or_die(const char *option);
void print_bias_help(void);
-int make_signalfd(void);
-int chip_dir_filter(const struct dirent *entry);
-struct gpiod_chip *chip_open_by_name(const char *name);
-struct gpiod_chip *chip_open_lookup(const char *device);
-bool has_duplicate_offsets(size_t num_offsets, unsigned int *offsets);
+void print_chip_help(void);
+void print_period_help(void);
+void print_event_time(uint64_t evtime, int format);
+void print_line_attributes(struct gpiod_line_info *info);
+void print_line_id(struct line_resolver *resolver, int chip_num,
+ unsigned int offset, const char *chip_id);
+bool chip_path_lookup(const char *id, char **path_ptr);
+int chip_paths(const char *id, char ***paths_ptr);
+int all_chip_paths(char ***paths_ptr);
+struct line_resolver *resolve_lines(int num_lines, char **lines,
+ const char *chip_id, bool strict, bool by_name);
+struct line_resolver *resolver_init(int num_lines, char **lines, int num_chips,
+ bool strict, bool by_name);
+bool resolve_lines_by_offset(struct line_resolver *resolver,
+ unsigned int num_lines);
+bool resolve_done(struct line_resolver *resolver);
+void validate_resolution(struct line_resolver *resolver, const char *chip_id);
+void free_line_resolver(struct line_resolver *resolver);
+int get_line_offsets_and_values(struct line_resolver *resolver,
+ int chip_num, unsigned int *offsets, int *values);
+const char *get_chip_name(struct line_resolver *resolver, int chip_num);
+const char *get_line_name(struct line_resolver *resolver, int chip_num,
+ unsigned int offset);
+void set_line_values(struct line_resolver *resolver, int chip_num, int *values);
#endif /* __GPIOD_TOOLS_COMMON_H__ */
--
2.38.0
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [libgpiod v2][PATCH v3 3/5] tools: tests for line name focussed rework
2022-10-11 0:29 [libgpiod v2][PATCH v3 0/5] tools: improvements for v2 Kent Gibson
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 1/5] tools: remove old code to simplify review Kent Gibson
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 2/5] tools: line name focussed rework Kent Gibson
@ 2022-10-11 0:29 ` Kent Gibson
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 4/5] tools: add gpiowatch Kent Gibson
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 5/5] tools: gpiowatch tests Kent Gibson
4 siblings, 0 replies; 16+ messages in thread
From: Kent Gibson @ 2022-10-11 0:29 UTC (permalink / raw)
To: linux-gpio, brgl; +Cc: Kent Gibson
Rework the tools tests and expand to cover new functionality.
Signed-off-by: Kent Gibson <warthog618@gmail.com>
---
tools/gpio-tools-test | 3 -
tools/gpio-tools-test.bats | 2268 ++++++++++++++++++++++++++++++++++--
2 files changed, 2183 insertions(+), 88 deletions(-)
diff --git a/tools/gpio-tools-test b/tools/gpio-tools-test
index 234f9bd..1a012dc 100755
--- a/tools/gpio-tools-test
+++ b/tools/gpio-tools-test
@@ -37,9 +37,6 @@ check_prog() {
# Check all required non-coreutils tools
check_prog bats
check_prog modprobe
-check_prog rmmod
-check_prog udevadm
-check_prog timeout
# Check if we're running a kernel at the required version or later
check_kernel $MIN_KERNEL_VERSION
diff --git a/tools/gpio-tools-test.bats b/tools/gpio-tools-test.bats
index d200df1..6c12ffc 100755
--- a/tools/gpio-tools-test.bats
+++ b/tools/gpio-tools-test.bats
@@ -1,18 +1,24 @@
#!/usr/bin/env bats
# SPDX-License-Identifier: GPL-2.0-or-later
# SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
+# SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
# Simple test harness for the gpio-tools.
-# Where output from coprocesses is stored
-COPROC_OUTPUT=$BATS_TMPDIR/gpio-tools-test-output
+# Where output from the dut is stored
+DUT_OUTPUT=$BATS_TMPDIR/gpio-tools-test-output
# Save the PID of coprocess - otherwise we won't be able to wait for it
# once it exits as the COPROC_PID will be cleared.
-COPROC_SAVED_PID=""
+DUT_PID=""
-GPIOSIM_CHIPS=""
-GPIOSIM_CONFIGFS="/sys/kernel/config/gpio-sim/"
+# mappings from local name to system chip name, path, dev name
+# -g required for the associative arrays, cos BATS...
+declare -g -A GPIOSIM_CHIP_NAME
+declare -g -A GPIOSIM_CHIP_PATH
+declare -g -A GPIOSIM_DEV_NAME
+GPIOSIM_CONFIGFS="/sys/kernel/config/gpio-sim"
GPIOSIM_SYSFS="/sys/devices/platform/"
+GPIOSIM_APP_NAME="gpio-tools-test"
# Run the command in $* and return 0 if the command failed. The way we do it
# here is a workaround for the way bats handles failing processes.
@@ -23,10 +29,7 @@ assert_fail() {
# Check if the string in $2 matches against the pattern in $1.
regex_matches() {
- local PATTERN=$1
- local STRING=$2
-
- [[ $STRING =~ $PATTERN ]]
+ [[ $2 =~ $1 ]] || (echo "Mismatched: \"$2\"" && false)
}
# Iterate over all lines in the output of the last command invoked with bats'
@@ -38,31 +41,39 @@ output_contains_line() {
do
test "$line" = "$LINE" && return 0
done
-
+ echo "Mismatched:"
+ echo "$output"
return 1
}
+output_is() {
+ test "$output" = "$1" || (echo "Mismatched: \"$output\"" && false)
+}
+
+num_lines_is() {
+ test ${#lines[@]} -eq $1 || (echo "Num lines is: ${#lines[@]}" && false)
+}
+
+status_is() {
+ test "$status" -eq "$1"
+}
+
# Same as above but match against the regex pattern in $1.
output_regex_match() {
- local PATTERN=$1
-
for line in "${lines[@]}"
do
- regex_matches "$PATTERN" "$line" && return 0
+ [[ "$line" =~ $1 ]] && return 0
done
-
+ echo "Mismatched:"
+ echo "$output"
return 1
}
-random_name() {
- cat /proc/sys/kernel/random/uuid
-}
-
gpiosim_chip() {
local VAR=$1
- local NAME=$(random_name)
+ local NAME=${GPIOSIM_APP_NAME}-$$-${VAR}
local DEVPATH=$GPIOSIM_CONFIGFS/$NAME
- local BANKPATH=$DEVPATH/$NAME
+ local BANKPATH=$DEVPATH/bank0
mkdir -p $BANKPATH
@@ -87,75 +98,60 @@ gpiosim_chip() {
echo 1 > $DEVPATH/live
- GPIOSIM_CHIPS="$VAR:$NAME $GPIOSIM_CHIPS"
+ local chip_name=$(<$BANKPATH/chip_name)
+ GPIOSIM_CHIP_NAME[$1]=$chip_name
+ GPIOSIM_CHIP_PATH[$1]="/dev/$chip_name"
+ GPIOSIM_DEV_NAME[$1]=$(<$DEVPATH/dev_name)
}
-gpiosim_chip_map_name() {
- local VAR=$1
-
- for CHIP in $GPIOSIM_CHIPS
- do
- KEY=$(echo $CHIP | cut -d":" -f1)
- VAL=$(echo $CHIP | cut -d":" -f2)
-
- if [ "$KEY" = "$VAR" ]
- then
- echo $VAL
- fi
- done
+gpiosim_chip_number() {
+ local NAME=${GPIOSIM_CHIP_NAME[$1]}
+ echo ${NAME#"gpiochip"}
}
-gpiosim_chip_name() {
- local VAR=$1
- local NAME=$(gpiosim_chip_map_name $VAR)
-
- cat $GPIOSIM_CONFIGFS/$NAME/$NAME/chip_name
+gpiosim_chip_symlink() {
+ GPIOSIM_CHIP_LINK="$2/${GPIOSIM_APP_NAME}-$$-lnk"
+ ln -s ${GPIOSIM_CHIP_PATH[$1]} "$GPIOSIM_CHIP_LINK"
}
-gpiosim_dev_name() {
- local VAR=$1
- local NAME=$(gpiosim_chip_map_name $VAR)
-
- cat $GPIOSIM_CONFIGFS/$NAME/dev_name
+gpiosim_chip_symlink_cleanup() {
+ if [ -n "$GPIOSIM_CHIP_LINK" ]
+ then
+ rm "$GPIOSIM_CHIP_LINK"
+ fi
+ unset GPIOSIM_CHIP_LINK
}
gpiosim_set_pull() {
- local VAR=$1
local OFFSET=$2
local PULL=$3
- local DEVNAME=$(gpiosim_dev_name $VAR)
- local CHIPNAME=$(gpiosim_chip_name $VAR)
+ local DEVNAME=${GPIOSIM_DEV_NAME[$1]}
+ local CHIPNAME=${GPIOSIM_CHIP_NAME[$1]}
echo $PULL > $GPIOSIM_SYSFS/$DEVNAME/$CHIPNAME/sim_gpio$OFFSET/pull
}
gpiosim_check_value() {
- local VAR=$1
local OFFSET=$2
local EXPECTED=$3
- local DEVNAME=$(gpiosim_dev_name $VAR)
- local CHIPNAME=$(gpiosim_chip_name $VAR)
-
- VAL=$(cat $GPIOSIM_SYSFS/$DEVNAME/$CHIPNAME/sim_gpio$OFFSET/value)
- if [ "$VAL" = "$EXPECTED" ]
- then
- return 0
- fi
+ local DEVNAME=${GPIOSIM_DEV_NAME[$1]}
+ local CHIPNAME=${GPIOSIM_CHIP_NAME[$1]}
- return 1
+ VAL=$(<$GPIOSIM_SYSFS/$DEVNAME/$CHIPNAME/sim_gpio$OFFSET/value)
+ [ "$VAL" = "$EXPECTED" ]
}
gpiosim_cleanup() {
- for CHIP in $GPIOSIM_CHIPS
+ for CHIP in ${!GPIOSIM_CHIP_NAME[@]}
do
- local NAME=$(echo $CHIP | cut -d":" -f2)
+ local NAME=${GPIOSIM_APP_NAME}-$$-$CHIP
local DEVPATH=$GPIOSIM_CONFIGFS/$NAME
- local BANKPATH=$DEVPATH/$NAME
+ local BANKPATH=$DEVPATH/bank0
echo 0 > $DEVPATH/live
- ls $BANKPATH/line* 2> /dev/null
+ ls $BANKPATH/line* > /dev/null 2>&1
if [ "$?" = "0" ]
then
for LINE in $(find $BANKPATH/ | egrep "line[0-9]+$")
@@ -169,7 +165,11 @@ gpiosim_cleanup() {
rmdir $DEVPATH
done
- GPIOSIM_CHIPS=""
+ gpiosim_chip_symlink_cleanup
+
+ GPIOSIM_CHIP_NAME=()
+ GPIOSIM_CHIP_PATH=()
+ GPIOSIM_DEV_NAME=()
}
run_tool() {
@@ -178,45 +178,2143 @@ run_tool() {
run timeout 10s $BATS_TEST_DIRNAME/"$@"
}
-coproc_run_tool() {
- rm -f $BR_PROC_OUTPUT
- coproc timeout 10s $BATS_TEST_DIRNAME/"$@" > $COPROC_OUTPUT 2> $COPROC_OUTPUT
- COPROC_SAVED_PID=$COPROC_PID
- # FIXME We're giving the background process some time to get up, but really this
- # should be more reliable...
+dut_run() {
+ coproc timeout 10s $BATS_TEST_DIRNAME/"$@" 2>&1
+ DUT_PID=$COPROC_PID
+ read -t1 -n1 -u ${COPROC[0]} DUT_FIRST_CHAR
+}
+
+dut_run_redirect() {
+ coproc timeout 10s $BATS_TEST_DIRNAME/"$@" > $DUT_OUTPUT 2>&1
+ DUT_PID=$COPROC_PID
+ # give the process time to spin up
+ # FIXME - find a better solution
sleep 0.2
}
-coproc_tool_stdin_write() {
+dut_read_redirect() {
+ output=$(<$DUT_OUTPUT)
+ local ORIG_IFS="$IFS"
+ IFS=$'\n' lines=($output)
+ IFS="$ORIG_IFS"
+}
+
+dut_read() {
+ local LINE
+ lines=()
+ while read -t 0.2 -u ${COPROC[0]} LINE;
+ do
+ if [ -n "$DUT_FIRST_CHAR" ]
+ then
+ LINE=${DUT_FIRST_CHAR}${LINE}
+ unset DUT_FIRST_CHAR
+ fi
+ lines+=("$LINE")
+ done
+ output="${lines[@]}"
+}
+
+dut_readable() {
+ read -t 0 -u ${COPROC[0]} LINE
+}
+
+dut_flush() {
+ local JUNK
+ lines=()
+ output=
+ unset DUT_FIRST_CHAR
+ while read -t 0 -u ${COPROC[0]} JUNK;
+ do
+ read -t 0.1 -u ${COPROC[0]} JUNK || true
+ done
+}
+
+# check the next line of output matches the regex
+dut_regex_match() {
+ PATTERN=$1
+
+ read -t 0.2 -u ${COPROC[0]} LINE || (echo Timeout && false)
+ if [ -n "$DUT_FIRST_CHAR" ]
+ then
+ LINE=${DUT_FIRST_CHAR}${LINE}
+ unset DUT_FIRST_CHAR
+ fi
+ [[ $LINE =~ $PATTERN ]] || (echo "Mismatched: \"$LINE\"" && false)
+}
+
+dut_write() {
echo $* >&${COPROC[1]}
}
-coproc_tool_kill() {
+dut_kill() {
SIGNUM=$1
- kill $SIGNUM $COPROC_SAVED_PID
+ kill $SIGNUM $DUT_PID
}
-coproc_tool_wait() {
+dut_wait() {
status="0"
# A workaround for the way bats handles command failures.
- wait $COPROC_SAVED_PID || export status=$?
+ wait $DUT_PID || export status=$?
test "$status" -ne 0 || export status="0"
- output=$(cat $COPROC_OUTPUT)
- local ORIG_IFS="$IFS"
- IFS=$'\n' lines=($output)
- IFS="$ORIG_IFS"
- rm -f $COPROC_OUTPUT
+ unset DUT_PID
}
-teardown() {
- if [ -n "$BG_PROC_PID" ]
- then
- kill -9 $BG_PROC_PID
- run wait $BG_PROC_PID
- BG_PROC_PID=""
- fi
+dut_cleanup() {
+ if [ -n "$DUT_PID" ]
+ then
+ kill -SIGTERM $DUT_PID
+ wait $DUT_PID || false
+ fi
+ rm -f $DUT_OUTPUT
+}
+teardown() {
+ dut_cleanup
gpiosim_cleanup
}
+request_release_line() {
+ $BATS_TEST_DIRNAME/gpioget -c $* >/dev/null
+}
+
+#
+# gpiodetect test cases
+#
+
+@test "gpiodetect: all chips" {
+ gpiosim_chip sim0 num_lines=4
+ gpiosim_chip sim1 num_lines=8
+ gpiosim_chip sim2 num_lines=16
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
+ local sim2=${GPIOSIM_CHIP_NAME[sim2]}
+ local sim0dev=${GPIOSIM_DEV_NAME[sim0]}
+ local sim1dev=${GPIOSIM_DEV_NAME[sim1]}
+ local sim2dev=${GPIOSIM_DEV_NAME[sim2]}
+
+ run_tool gpiodetect
+
+ output_contains_line "$sim0 [${sim0dev}-node0] (4 lines)"
+ output_contains_line "$sim1 [${sim1dev}-node0] (8 lines)"
+ output_contains_line "$sim2 [${sim2dev}-node0] (16 lines)"
+ status_is 0
+
+ # ignoring symlinks
+ local initial_output=$output
+ gpiosim_chip_symlink sim1 /dev
+
+ run_tool gpiodetect
+
+ output_is "$initial_output"
+ status_is 0
+}
+
+@test "gpiodetect: a chip" {
+ gpiosim_chip sim0 num_lines=4
+ gpiosim_chip sim1 num_lines=8
+ gpiosim_chip sim2 num_lines=16
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
+ local sim2=${GPIOSIM_CHIP_NAME[sim2]}
+ local sim0dev=${GPIOSIM_DEV_NAME[sim0]}
+ local sim1dev=${GPIOSIM_DEV_NAME[sim1]}
+ local sim2dev=${GPIOSIM_DEV_NAME[sim2]}
+
+ # by name
+ run_tool gpiodetect $sim0
+
+ output_contains_line "$sim0 [${sim0dev}-node0] (4 lines)"
+ num_lines_is 1
+ status_is 0
+
+ # by path
+ run_tool gpiodetect ${GPIOSIM_CHIP_PATH[sim1]}
+
+ output_contains_line "$sim1 [${sim1dev}-node0] (8 lines)"
+ num_lines_is 1
+ status_is 0
+
+ # by number
+ run_tool gpiodetect $(gpiosim_chip_number sim2)
+
+ output_contains_line "$sim2 [${sim2dev}-node0] (16 lines)"
+ num_lines_is 1
+ status_is 0
+
+ # by symlink
+ gpiosim_chip_symlink sim2 .
+ run_tool gpiodetect $GPIOSIM_CHIP_LINK
+
+ output_contains_line "$sim2 [${sim2dev}-node0] (16 lines)"
+ num_lines_is 1
+ status_is 0
+}
+
+@test "gpiodetect: multiple chips" {
+ gpiosim_chip sim0 num_lines=4
+ gpiosim_chip sim1 num_lines=8
+ gpiosim_chip sim2 num_lines=16
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
+ local sim2=${GPIOSIM_CHIP_NAME[sim2]}
+ local sim0dev=${GPIOSIM_DEV_NAME[sim0]}
+ local sim1dev=${GPIOSIM_DEV_NAME[sim1]}
+ local sim2dev=${GPIOSIM_DEV_NAME[sim2]}
+
+ run_tool gpiodetect $sim0 $sim1 $sim2
+
+ output_contains_line "$sim0 [${sim0dev}-node0] (4 lines)"
+ output_contains_line "$sim1 [${sim1dev}-node0] (8 lines)"
+ output_contains_line "$sim2 [${sim2dev}-node0] (16 lines)"
+ num_lines_is 3
+ status_is 0
+}
+
+@test "gpiodetect: with nonexistent chip" {
+ run_tool gpiodetect nonexistent-chip
+
+ status_is 1
+ output_regex_match \
+".*cannot find GPIO chip character device 'nonexistent-chip'"
+}
+
+#
+# gpioinfo test cases
+#
+
+@test "gpioinfo: all chips" {
+ gpiosim_chip sim0 num_lines=4
+ gpiosim_chip sim1 num_lines=8
+
+ run_tool gpioinfo
+
+ echo "$output"
+ output_contains_line "${GPIOSIM_CHIP_NAME[sim0]} - 4 lines:"
+ output_contains_line "${GPIOSIM_CHIP_NAME[sim1]} - 8 lines:"
+ output_regex_match "\\s+line\\s+0:\\s+unnamed\\s+input"
+ output_regex_match "\\s+line\\s+7:\\s+unnamed\\s+input"
+ status_is 0
+
+ # ignoring symlinks
+ local initial_output=$output
+ gpiosim_chip_symlink sim1 /dev
+
+ run_tool gpioinfo
+
+ output_is "$initial_output"
+ status_is 0
+}
+
+@test "gpioinfo: all chips with some used lines" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar
+ gpiosim_chip sim1 num_lines=8 line_name=3:baz line_name=4:xyz
+
+ dut_run gpioset -i --active-low foo=1 baz=0
+
+ run_tool gpioinfo
+
+ output_contains_line "${GPIOSIM_CHIP_NAME[sim0]} - 4 lines:"
+ output_contains_line "${GPIOSIM_CHIP_NAME[sim1]} - 8 lines:"
+ output_regex_match "\\s+line\\s+0:\\s+unnamed\\s+input"
+ output_regex_match \
+"\\s+line\\s+1:\\s+foo\\s+output active-low consumer=gpioset"
+ output_regex_match \
+"\\s+line\\s+3:\\s+baz\\s+output active-low consumer=gpioset"
+ status_is 0
+}
+
+@test "gpioinfo: a chip" {
+ gpiosim_chip sim0 num_lines=8
+ gpiosim_chip sim1 num_lines=4
+
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
+
+ # by name
+ run_tool gpioinfo --chip $sim1
+
+ output_contains_line "$sim1 - 4 lines:"
+ output_regex_match "\\s+line\\s+0:\\s+unnamed\\s+input"
+ output_regex_match "\\s+line\\s+1:\\s+unnamed\\s+input"
+ output_regex_match "\\s+line\\s+2:\\s+unnamed\\s+input"
+ output_regex_match "\\s+line\\s+3:\\s+unnamed\\s+input"
+ num_lines_is 5
+ status_is 0
+
+ # by path
+ run_tool gpioinfo --chip $sim1
+
+ output_contains_line "$sim1 - 4 lines:"
+ output_regex_match "\\s+line\\s+0:\\s+unnamed\\s+input"
+ output_regex_match "\\s+line\\s+1:\\s+unnamed\\s+input"
+ output_regex_match "\\s+line\\s+2:\\s+unnamed\\s+input"
+ output_regex_match "\\s+line\\s+3:\\s+unnamed\\s+input"
+ num_lines_is 5
+ status_is 0
+
+ # by number
+ run_tool gpioinfo --chip $sim1
+
+ output_contains_line "$sim1 - 4 lines:"
+ output_regex_match "\\s+line\\s+0:\\s+unnamed\\s+input"
+ output_regex_match "\\s+line\\s+1:\\s+unnamed\\s+input"
+ output_regex_match "\\s+line\\s+2:\\s+unnamed\\s+input"
+ output_regex_match "\\s+line\\s+3:\\s+unnamed\\s+input"
+ num_lines_is 5
+ status_is 0
+
+ # by symlink
+ gpiosim_chip_symlink sim1 .
+ run_tool gpioinfo --chip $GPIOSIM_CHIP_LINK
+
+ output_contains_line "$sim1 - 4 lines:"
+ output_regex_match "\\s+line\\s+0:\\s+unnamed\\s+input"
+ output_regex_match "\\s+line\\s+1:\\s+unnamed\\s+input"
+ output_regex_match "\\s+line\\s+2:\\s+unnamed\\s+input"
+ output_regex_match "\\s+line\\s+3:\\s+unnamed\\s+input"
+ num_lines_is 5
+ status_is 0
+}
+
+@test "gpioinfo: a line" {
+ gpiosim_chip sim0 num_lines=8 line_name=5:bar
+ gpiosim_chip sim1 num_lines=4 line_name=2:bar
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
+
+ # by offset
+ run_tool gpioinfo --chip $sim1 2
+
+ output_regex_match "$sim1 2\\s+bar\\s+input"
+ num_lines_is 1
+ status_is 0
+
+ # by name
+ run_tool gpioinfo bar
+
+ output_regex_match "$sim0 5\\s+bar\\s+input"
+ num_lines_is 1
+ status_is 0
+
+ # by chip and name
+ run_tool gpioinfo --chip $sim1 2
+
+ output_regex_match "$sim1 2\\s+bar\\s+input"
+ num_lines_is 1
+ status_is 0
+}
+
+@test "gpioinfo: first matching named line" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar \
+ line_name=3:foobar
+ gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=2:foobar \
+ line_name=4:xyz line_name=7:foobar
+ gpiosim_chip sim2 num_lines=16
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpioinfo foobar
+
+ output_regex_match "$sim0 3\\s+foobar\\s+input"
+ num_lines_is 1
+ status_is 0
+}
+
+@test "gpioinfo: multiple lines" {
+ gpiosim_chip sim0 num_lines=8 line_name=5:bar
+ gpiosim_chip sim1 num_lines=4 line_name=2:baz
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
+
+ # by offset
+ run_tool gpioinfo --chip $sim1 1 2
+
+ output_regex_match "$sim1 1\\s+unnamed\\s+input"
+ output_regex_match "$sim1 2\\s+baz\\s+input"
+ num_lines_is 2
+ status_is 0
+
+ # by name
+ run_tool gpioinfo bar baz
+
+ output_regex_match "$sim0 5\\s+bar\\s+input"
+ output_regex_match "$sim1 2\\s+baz\\s+input"
+ num_lines_is 2
+ status_is 0
+
+ # by name and offset
+ run_tool gpioinfo --chip $sim0 bar 3
+
+ output_regex_match "$sim0 5\\s+bar\\s+input"
+ output_regex_match "$sim0 3\\s+unnamed\\s+input"
+ num_lines_is 2
+ status_is 0
+}
+
+@test "gpioinfo: line attribute menagerie" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo
+ gpiosim_chip sim1 num_lines=8 line_name=3:baz
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
+
+ dut_run gpioset -i --active-low --bias=pull-up --drive=open-source foo=1 baz=0
+
+ run_tool gpioinfo foo baz
+
+ output_regex_match \
+"$sim0 1\\s+foo\\s+output active-low drive=open-source bias=pull-up consumer=gpioset"
+ output_regex_match \
+"$sim1 3\\s+baz\\s+output active-low drive=open-source bias=pull-up consumer=gpioset"
+ num_lines_is 2
+ status_is 0
+
+ dut_kill
+ dut_wait
+
+ dut_run gpioset -i --bias=pull-down --drive=open-drain foo=1 baz=0
+
+ run_tool gpioinfo foo baz
+
+ output_regex_match \
+"$sim0 1\\s+foo\\s+output drive=open-drain bias=pull-down consumer=gpioset"
+ output_regex_match \
+"$sim1 3\\s+baz\\s+output drive=open-drain bias=pull-down consumer=gpioset"
+ num_lines_is 2
+ status_is 0
+
+ dut_kill
+ dut_wait
+
+ dut_run gpiomon --banner --bias=disabled --utc -p 10ms foo baz
+
+ run_tool gpioinfo foo baz
+
+ output_regex_match \
+"$sim0 1\\s+foo\\s+input bias=disabled edges=both event-clock=realtime debounce-period=10ms consumer=gpiomon"
+ output_regex_match \
+"$sim1 3\\s+baz\\s+input bias=disabled edges=both event-clock=realtime debounce-period=10ms consumer=gpiomon"
+ num_lines_is 2
+ status_is 0
+
+ dut_kill
+ dut_wait
+
+ dut_run gpiomon --banner --edges=rising --localtime foo baz
+
+ run_tool gpioinfo foo baz
+
+ output_regex_match \
+"$sim0 1\\s+foo\\s+input edges=rising event-clock=realtime consumer=gpiomon"
+ output_regex_match \
+"$sim1 3\\s+baz\\s+input edges=rising event-clock=realtime consumer=gpiomon"
+ num_lines_is 2
+ status_is 0
+
+ dut_kill
+ dut_wait
+
+ dut_run gpiomon --banner --edges=falling foo baz
+
+ run_tool gpioinfo foo baz
+
+ output_regex_match \
+"$sim0 1\\s+foo\\s+input edges=falling consumer=gpiomon"
+ output_regex_match \
+"$sim1 3\\s+baz\\s+input edges=falling consumer=gpiomon"
+ num_lines_is 2
+ status_is 0
+}
+
+@test "gpioinfo: with same line twice" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ # by offset
+ run_tool gpioinfo --chip $sim0 1 1
+
+ output_regex_match "$sim0 1\\s+foo\\s+input"
+ output_regex_match ".*lines '1' and '1' are the same line"
+ num_lines_is 2
+ status_is 1
+
+ # by name
+ run_tool gpioinfo foo foo
+
+ output_regex_match "$sim0 1\\s+foo\\s+input"
+ output_regex_match ".*lines 'foo' and 'foo' are the same line"
+ num_lines_is 2
+ status_is 1
+
+ # by name and offset
+ run_tool gpioinfo --chip $sim0 foo 1
+
+ output_regex_match "$sim0 1\\s+foo\\s+input"
+ output_regex_match ".*lines 'foo' and '1' are the same line"
+ num_lines_is 2
+ status_is 1
+}
+
+@test "gpioinfo: all lines matching name" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar \
+ line_name=3:foobar
+ gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=2:foobar \
+ line_name=4:xyz line_name=7:foobar
+ gpiosim_chip sim2 num_lines=16
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
+
+ run_tool gpioinfo --strict foobar
+
+ output_regex_match "$sim0 3\\s+foobar\\s+input"
+ output_regex_match "$sim1 2\\s+foobar\\s+input"
+ output_regex_match "$sim1 7\\s+foobar\\s+input"
+ num_lines_is 3
+ status_is 1
+}
+
+@test "gpioinfo: with lines strictly by name" {
+ # not suggesting this setup makes any sense
+ # - just test that we can deal with it
+ gpiosim_chip sim0 num_lines=8 line_name=1:6 line_name=6:1
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ # first by offset (to show offsets match first)
+ run_tool gpioinfo --chip $sim0 1 6
+
+ output_regex_match "$sim0 1\\s+6\\s+input"
+ output_regex_match "$sim0 6\\s+1\\s+input"
+ num_lines_is 2
+ status_is 0
+
+ # then strictly by name
+ run_tool gpioinfo --by-name --chip $sim0 1
+
+ output_regex_match "$sim0 6\\s+1\\s+input"
+ num_lines_is 1
+ status_is 0
+}
+
+@test "gpioinfo: with nonexistent chip" {
+ run_tool gpioinfo --chip nonexistent-chip
+
+ output_regex_match \
+".*cannot find GPIO chip character device 'nonexistent-chip'"
+ status_is 1
+}
+
+@test "gpioinfo: with nonexistent line" {
+ gpiosim_chip sim0 num_lines=8
+
+ run_tool gpioinfo nonexistent-line
+
+ output_regex_match ".*cannot find line 'nonexistent-line'"
+ status_is 1
+
+ run_tool gpioinfo --chip ${GPIOSIM_CHIP_NAME[sim0]} nonexistent-line
+
+ output_regex_match ".*cannot find line 'nonexistent-line'"
+ status_is 1
+}
+
+@test "gpioinfo: with offset out of range" {
+ gpiosim_chip sim0 num_lines=4
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpioinfo --chip $sim0 0 1 2 3 4 5
+
+ output_regex_match "$sim0 0\\s+unnamed\\s+input"
+ output_regex_match "$sim0 1\\s+unnamed\\s+input"
+ output_regex_match "$sim0 2\\s+unnamed\\s+input"
+ output_regex_match "$sim0 3\\s+unnamed\\s+input"
+ output_regex_match ".*offset 4 is out of range on chip '$sim0'"
+ output_regex_match ".*offset 5 is out of range on chip '$sim0'"
+ num_lines_is 6
+ status_is 1
+}
+
+#
+# gpioget test cases
+#
+
+@test "gpioget: by name" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
+
+ gpiosim_set_pull sim0 1 pull-up
+
+ run_tool gpioget foo
+
+ output_is "foo=active"
+ status_is 0
+}
+
+@test "gpioget: by offset" {
+ gpiosim_chip sim0 num_lines=8
+
+ gpiosim_set_pull sim0 1 pull-up
+
+ run_tool gpioget --chip ${GPIOSIM_CHIP_NAME[sim0]} 1
+
+ output_is "1=active"
+ status_is 0
+}
+
+@test "gpioget: by symlink" {
+ gpiosim_chip sim0 num_lines=8
+ gpiosim_chip_symlink sim0 .
+
+ gpiosim_set_pull sim0 1 pull-up
+
+ run_tool gpioget --chip $GPIOSIM_CHIP_LINK 1
+
+ output_is "1=active"
+ status_is 0
+}
+
+@test "gpioget: by chip and name" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
+ gpiosim_chip sim1 num_lines=8 line_name=3:foo
+
+ gpiosim_set_pull sim1 3 pull-up
+
+ run_tool gpioget --chip ${GPIOSIM_CHIP_NAME[sim1]} foo
+
+ output_is "foo=active"
+ status_is 0
+}
+
+@test "gpioget: first matching named line" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar \
+ line_name=3:foobar line_name=7:foobar
+ gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=2:foobar \
+ line_name=4:xyz
+ gpiosim_chip sim2 num_lines=16
+
+ gpiosim_set_pull sim0 3 pull-up
+
+ run_tool gpioget foobar
+
+ output_is "foobar=active"
+ status_is 0
+}
+
+@test "gpioget: multiple lines" {
+ gpiosim_chip sim0 num_lines=8
+
+ gpiosim_set_pull sim0 2 pull-up
+ gpiosim_set_pull sim0 3 pull-up
+ gpiosim_set_pull sim0 5 pull-up
+ gpiosim_set_pull sim0 7 pull-up
+
+ run_tool gpioget --chip ${GPIOSIM_CHIP_NAME[sim0]} 0 1 2 3 4 5 6 7
+
+ output_is \
+"0=inactive 1=inactive 2=active 3=active 4=inactive 5=active 6=inactive 7=active"
+ status_is 0
+}
+
+@test "gpioget: multiple lines by name and offset" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo line_name=6:bar
+ gpiosim_chip sim1 num_lines=8 line_name=1:baz line_name=3:bar
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 1 pull-up
+ gpiosim_set_pull sim0 4 pull-up
+ gpiosim_set_pull sim0 6 pull-up
+
+ run_tool gpioget --chip $sim0 0 foo 4 bar
+
+ output_is "0=inactive foo=active 4=active bar=active"
+ status_is 0
+}
+
+@test "gpioget: multiple lines across multiple chips" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar
+ gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=4:xyz
+
+ gpiosim_set_pull sim0 1 pull-up
+ gpiosim_set_pull sim1 4 pull-up
+
+ run_tool gpioget baz bar foo xyz
+
+ output_is "baz=inactive bar=inactive foo=active xyz=active"
+ status_is 0
+}
+
+@test "gpioget: with numeric values" {
+ gpiosim_chip sim0 num_lines=8
+
+ gpiosim_set_pull sim0 2 pull-up
+ gpiosim_set_pull sim0 3 pull-up
+ gpiosim_set_pull sim0 5 pull-up
+ gpiosim_set_pull sim0 7 pull-up
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpioget --numeric --chip $sim0 0 1 2 3 4 5 6 7
+
+ output_is "0 0 1 1 0 1 0 1"
+ status_is 0
+}
+
+@test "gpioget: with active-low" {
+ gpiosim_chip sim0 num_lines=8
+
+ gpiosim_set_pull sim0 2 pull-up
+ gpiosim_set_pull sim0 3 pull-up
+ gpiosim_set_pull sim0 5 pull-up
+ gpiosim_set_pull sim0 7 pull-up
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpioget --active-low --chip $sim0 0 1 2 3 4 5 6 7
+
+ output_is \
+"0=active 1=active 2=inactive 3=inactive 4=active 5=inactive 6=active 7=inactive"
+ status_is 0
+}
+
+@test "gpioget: with pull-up" {
+ gpiosim_chip sim0 num_lines=8
+
+ gpiosim_set_pull sim0 2 pull-up
+ gpiosim_set_pull sim0 3 pull-up
+ gpiosim_set_pull sim0 5 pull-up
+ gpiosim_set_pull sim0 7 pull-up
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpioget --bias=pull-up --chip $sim0 0 1 2 3 4 5 6 7
+
+ output_is \
+"0=active 1=active 2=active 3=active 4=active 5=active 6=active 7=active"
+ status_is 0
+}
+
+@test "gpioget: with pull-down" {
+ gpiosim_chip sim0 num_lines=8
+
+ gpiosim_set_pull sim0 2 pull-up
+ gpiosim_set_pull sim0 3 pull-up
+ gpiosim_set_pull sim0 5 pull-up
+ gpiosim_set_pull sim0 7 pull-up
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpioget --bias=pull-down --chip $sim0 0 1 2 3 4 5 6 7
+
+ output_is \
+"0=inactive 1=inactive 2=inactive 3=inactive 4=inactive 5=inactive 6=inactive 7=inactive"
+ status_is 0
+}
+
+@test "gpioget: with direction as-is" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ # flip to output
+ run_tool gpioset foo=1
+
+ status_is 0
+
+ run_tool gpioinfo foo
+ output_regex_match "$sim0 1\\s+foo\\s+output"
+ status_is 0
+
+ run_tool gpioget --as-is foo
+ # note gpio-sim reverts line to its pull when released
+ output_is "foo=inactive"
+ status_is 0
+
+ run_tool gpioinfo foo
+ output_regex_match "$sim0 1\\s+foo\\s+output"
+ status_is 0
+
+ # whereas the default behaviour forces to input
+ run_tool gpioget foo
+ # note gpio-sim reverts line to its pull when released
+ # (defaults to pull-down)
+ output_is "foo=inactive"
+ status_is 0
+
+ run_tool gpioinfo foo
+ output_regex_match "$sim0 1\\s+foo\\s+input"
+ status_is 0
+}
+
+@test "gpioget: with hold-period" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
+
+ # only test parsing - testing the hold-period itself is tricky
+ run_tool gpioget --hold-period=100ms foo
+ output_is "foo=inactive"
+ status_is 0
+}
+
+@test "gpioget: with strict named line check" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar \
+ line_name=3:foobar
+ gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=2:foobar \
+ line_name=4:xyz line_name=7:foobar
+ gpiosim_chip sim2 num_lines=16
+
+ run_tool gpioget --strict foobar
+
+ output_regex_match ".*line 'foobar' is not unique"
+ status_is 1
+}
+
+@test "gpioget: with lines by offset" {
+ # not suggesting this setup makes any sense
+ # - just test that we can deal with it
+ gpiosim_chip sim0 num_lines=8 line_name=1:6 line_name=6:1
+
+ gpiosim_set_pull sim0 1 pull-up
+ gpiosim_set_pull sim0 6 pull-down
+
+ # first by offset
+ run_tool gpioget --chip ${GPIOSIM_CHIP_NAME[sim0]} 1 6
+
+ output_is "1=active 6=inactive"
+ status_is 0
+}
+
+@test "gpioget: with lines strictly by name" {
+ # not suggesting this setup makes any sense
+ # - just test that we can deal with it
+ gpiosim_chip sim0 num_lines=8 line_name=1:6 line_name=6:1
+
+ gpiosim_set_pull sim0 1 pull-up
+ gpiosim_set_pull sim0 6 pull-down
+
+ run_tool gpioget --by-name --chip ${GPIOSIM_CHIP_NAME[sim0]} 1 6
+
+ output_is "1=inactive 6=active"
+ status_is 0
+}
+
+@test "gpioget: with no arguments" {
+ run_tool gpioget
+
+ output_regex_match ".*at least one GPIO line must be specified"
+ status_is 1
+}
+
+@test "gpioget: with chip but no line specified" {
+ gpiosim_chip sim0 num_lines=8
+
+ run_tool gpioget --chip ${GPIOSIM_CHIP_NAME[sim0]}
+
+ output_regex_match ".*at least one GPIO line must be specified"
+ status_is 1
+}
+
+@test "gpioget: with offset out of range" {
+ gpiosim_chip sim0 num_lines=4
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpioget --chip $sim0 0 1 2 3 4 5
+
+ output_regex_match ".*offset 4 is out of range on chip '$sim0'"
+ output_regex_match ".*offset 5 is out of range on chip '$sim0'"
+ status_is 1
+}
+
+@test "gpioget: with nonexistent line" {
+ run_tool gpioget nonexistent-line
+
+ output_regex_match ".*cannot find line 'nonexistent-line'"
+ status_is 1
+}
+
+@test "gpioget: with same line twice" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ # by offset
+ run_tool gpioget --chip $sim0 0 0
+
+ output_regex_match ".*lines '0' and '0' are the same line"
+ status_is 1
+
+ # by name
+ run_tool gpioget foo foo
+
+ output_regex_match ".*lines 'foo' and 'foo' are the same line"
+ status_is 1
+
+ # by chip and name
+ run_tool gpioget --chip $sim0 foo foo
+
+ output_regex_match ".*lines 'foo' and 'foo' are the same line"
+ status_is 1
+
+ # by name and offset
+ run_tool gpioget --chip $sim0 foo 1
+
+ output_regex_match ".*lines 'foo' and '1' are the same line"
+ status_is 1
+
+ # by offset and name
+ run_tool gpioget --chip $sim0 1 foo
+
+ output_regex_match ".*lines '1' and 'foo' are the same line"
+ status_is 1
+}
+
+@test "gpioget: with invalid bias" {
+ gpiosim_chip sim0 num_lines=8
+
+ run_tool gpioget --bias=bad --chip ${GPIOSIM_CHIP_NAME[sim0]} 0 1
+
+ output_regex_match ".*invalid bias.*"
+ status_is 1
+}
+
+@test "gpioget: with invalid hold-period" {
+ gpiosim_chip sim0 num_lines=8
+
+ run_tool gpioget --hold-period=bad --chip ${GPIOSIM_CHIP_NAME[sim0]} 0
+
+ output_regex_match ".*invalid period.*"
+ status_is 1
+}
+
+#
+# gpioset test cases
+#
+
+@test "gpioset: by name" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
+
+ dut_run gpioset -i foo=1
+
+ gpiosim_check_value sim0 1 1
+}
+
+@test "gpioset: by offset" {
+ gpiosim_chip sim0 num_lines=8
+
+ dut_run gpioset -i --chip ${GPIOSIM_CHIP_NAME[sim0]} 1=1
+
+ gpiosim_check_value sim0 1 1
+}
+
+@test "gpioset: by symlink" {
+ gpiosim_chip sim0 num_lines=8
+ gpiosim_chip_symlink sim0 .
+
+ dut_run gpioset -i --chip $GPIOSIM_CHIP_LINK 1=1
+
+ gpiosim_check_value sim0 1 1
+}
+
+@test "gpioset: by chip and name" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
+ gpiosim_chip sim1 num_lines=8 line_name=3:foo
+
+ dut_run gpioset -i --chip ${GPIOSIM_CHIP_NAME[sim1]} foo=1
+
+ gpiosim_check_value sim1 3 1
+}
+
+@test "gpioset: first matching named line" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar \
+ line_name=3:foobar
+ gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=2:foobar \
+ line_name=4:xyz line_name=7:foobar
+ gpiosim_chip sim2 num_lines=16
+
+ dut_run gpioset -i foobar=1
+
+ gpiosim_check_value sim0 3 1
+}
+
+@test "gpioset: multiple lines" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpioset -i --chip $sim0 0=0 1=0 2=1 3=1 4=1 5=1 6=0 7=1
+
+ gpiosim_check_value sim0 0 0
+ gpiosim_check_value sim0 1 0
+ gpiosim_check_value sim0 2 1
+ gpiosim_check_value sim0 3 1
+ gpiosim_check_value sim0 4 1
+ gpiosim_check_value sim0 5 1
+ gpiosim_check_value sim0 6 0
+ gpiosim_check_value sim0 7 1
+}
+
+@test "gpioset: multiple lines by name and offset" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar
+
+ dut_run gpioset -i --chip ${GPIOSIM_CHIP_NAME[sim0]} 0=1 foo=1 bar=1 3=1
+
+ gpiosim_check_value sim0 0 1
+ gpiosim_check_value sim0 1 1
+ gpiosim_check_value sim0 2 1
+ gpiosim_check_value sim0 3 1
+}
+
+
+@test "gpioset: multiple lines across multiple chips" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar
+ gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=4:xyz
+
+ dut_run gpioset -i foo=1 bar=1 baz=1 xyz=1
+
+ gpiosim_check_value sim0 1 1
+ gpiosim_check_value sim0 2 1
+ gpiosim_check_value sim1 0 1
+ gpiosim_check_value sim1 4 1
+}
+
+@test "gpioset: with active-low" {
+ gpiosim_chip sim0 num_lines=8
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpioset -i --active-low -c $sim0 0=0 1=0 2=1 3=1 4=1 5=1 6=0 7=1
+
+ gpiosim_check_value sim0 0 1
+ gpiosim_check_value sim0 1 1
+ gpiosim_check_value sim0 2 0
+ gpiosim_check_value sim0 3 0
+ gpiosim_check_value sim0 4 0
+ gpiosim_check_value sim0 5 0
+ gpiosim_check_value sim0 6 1
+ gpiosim_check_value sim0 7 0
+}
+
+@test "gpioset: with push-pull" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpioset -i --drive=push-pull --chip $sim0 \
+ 0=0 1=0 2=1 3=1 4=1 5=1 6=0 7=1
+
+ gpiosim_check_value sim0 0 0
+ gpiosim_check_value sim0 1 0
+ gpiosim_check_value sim0 2 1
+ gpiosim_check_value sim0 3 1
+ gpiosim_check_value sim0 4 1
+ gpiosim_check_value sim0 5 1
+ gpiosim_check_value sim0 6 0
+ gpiosim_check_value sim0 7 1
+}
+
+@test "gpioset: with open-drain" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 2 pull-up
+ gpiosim_set_pull sim0 3 pull-up
+ gpiosim_set_pull sim0 5 pull-up
+ gpiosim_set_pull sim0 7 pull-up
+
+ dut_run gpioset -i --drive=open-drain --chip $sim0 \
+ 0=0 1=0 2=1 3=1 4=1 5=1 6=0 7=1
+
+ gpiosim_check_value sim0 0 0
+ gpiosim_check_value sim0 1 0
+ gpiosim_check_value sim0 2 1
+ gpiosim_check_value sim0 3 1
+ gpiosim_check_value sim0 4 0
+ gpiosim_check_value sim0 5 1
+ gpiosim_check_value sim0 6 0
+ gpiosim_check_value sim0 7 1
+}
+
+@test "gpioset: with open-source" {
+ gpiosim_chip sim0 num_lines=8
+
+ gpiosim_set_pull sim0 2 pull-up
+ gpiosim_set_pull sim0 3 pull-up
+ gpiosim_set_pull sim0 5 pull-up
+ gpiosim_set_pull sim0 7 pull-up
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpioset -i --drive=open-source --chip $sim0 \
+ 0=0 1=0 2=1 3=0 4=1 5=1 6=0 7=1
+
+ gpiosim_check_value sim0 0 0
+ gpiosim_check_value sim0 1 0
+ gpiosim_check_value sim0 2 1
+ gpiosim_check_value sim0 3 1
+ gpiosim_check_value sim0 4 1
+ gpiosim_check_value sim0 5 1
+ gpiosim_check_value sim0 6 0
+ gpiosim_check_value sim0 7 1
+}
+
+@test "gpioset: with pull-up" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpioset -i --bias=pull-up --drive=open-drain \
+ --chip $sim0 0=0 1=0 2=1 3=0 4=1 5=1 6=0 7=1
+
+ gpiosim_check_value sim0 0 0
+ gpiosim_check_value sim0 1 0
+ gpiosim_check_value sim0 2 1
+ gpiosim_check_value sim0 3 0
+ gpiosim_check_value sim0 4 1
+ gpiosim_check_value sim0 5 1
+ gpiosim_check_value sim0 6 0
+ gpiosim_check_value sim0 7 1
+}
+
+@test "gpioset: with pull-down" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpioset -i --bias=pull-down --drive=open-source \
+ --chip $sim0 0=0 1=0 2=1 3=0 4=1 5=1 6=0 7=1
+
+ gpiosim_check_value sim0 0 0
+ gpiosim_check_value sim0 1 0
+ gpiosim_check_value sim0 2 1
+ gpiosim_check_value sim0 3 0
+ gpiosim_check_value sim0 4 1
+ gpiosim_check_value sim0 5 1
+ gpiosim_check_value sim0 6 0
+ gpiosim_check_value sim0 7 1
+}
+
+@test "gpioset: with value variants" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 0 pull-up
+ gpiosim_set_pull sim0 1 pull-down
+ gpiosim_set_pull sim0 2 pull-down
+ gpiosim_set_pull sim0 3 pull-up
+ gpiosim_set_pull sim0 4 pull-down
+ gpiosim_set_pull sim0 5 pull-up
+ gpiosim_set_pull sim0 6 pull-up
+ gpiosim_set_pull sim0 7 pull-down
+
+ dut_run gpioset -i --chip $sim0 0=0 1=1 2=active \
+ 3=inactive 4=on 5=off 6=false 7=true
+
+ gpiosim_check_value sim0 0 0
+ gpiosim_check_value sim0 1 1
+ gpiosim_check_value sim0 2 1
+ gpiosim_check_value sim0 3 0
+ gpiosim_check_value sim0 4 1
+ gpiosim_check_value sim0 5 0
+ gpiosim_check_value sim0 6 0
+ gpiosim_check_value sim0 7 1
+}
+
+@test "gpioset: with hold-period" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 5 pull-up
+
+ # redirect as no startup output for dut_run
+ dut_run_redirect gpioset --hold-period=1200ms --chip $sim0 0=1 5=0 7=1
+
+ gpiosim_check_value sim0 0 1
+ gpiosim_check_value sim0 5 0
+ gpiosim_check_value sim0 7 1
+
+ dut_wait
+
+ status_is 0
+}
+
+@test "gpioset: interactive exit" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpioset --interactive --chip $sim0 1=0 2=1 5=1 6=0 7=1
+
+ gpiosim_check_value sim0 1 0
+ gpiosim_check_value sim0 2 1
+ gpiosim_check_value sim0 5 1
+ gpiosim_check_value sim0 6 0
+ gpiosim_check_value sim0 7 1
+
+ dut_write "exit"
+ dut_wait
+
+ status_is 0
+}
+
+@test "gpioset: interactive help" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo line_name=4:bar \
+ line_name=7:baz
+
+ dut_run gpioset --interactive foo=1 bar=0 baz=0
+
+ gpiosim_check_value sim0 1 1
+ gpiosim_check_value sim0 4 0
+ gpiosim_check_value sim0 7 0
+
+ dut_write "help"
+
+ dut_read
+ output_regex_match "COMMANDS:.*"
+ output_regex_match ".*get \[line\]\.\.\..*"
+ output_regex_match ".*set <line=value>\.\.\..*"
+ output_regex_match ".*toggle \[line\]\.\.\..*"
+ output_regex_match ".*sleep <period>.*"
+}
+
+@test "gpioset: interactive get" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo line_name=4:bar \
+ line_name=7:baz
+
+ dut_run gpioset --interactive foo=1 bar=0 baz=0
+
+ gpiosim_check_value sim0 1 1
+ gpiosim_check_value sim0 4 0
+ gpiosim_check_value sim0 7 0
+
+ dut_write "get"
+
+ dut_read
+ output_regex_match "foo=active bar=inactive baz=inactive"
+
+ dut_write "get bar"
+
+ dut_read
+ output_regex_match "bar=inactive"
+}
+
+@test "gpioset: interactive set" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo line_name=4:bar \
+ line_name=7:baz
+
+ dut_run gpioset --interactive foo=1 bar=0 baz=0
+
+ gpiosim_check_value sim0 1 1
+ gpiosim_check_value sim0 4 0
+ gpiosim_check_value sim0 7 0
+
+ dut_write "set bar=active"
+
+ gpiosim_check_value sim0 1 1
+ gpiosim_check_value sim0 4 1
+ gpiosim_check_value sim0 7 0
+ dut_write "get"
+ dut_read
+ output_regex_match "foo=active bar=active baz=inactive"
+}
+
+@test "gpioset: interactive toggle" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo line_name=4:bar \
+ line_name=7:baz
+
+ gpiosim_set_pull sim0 4 pull-up
+ gpiosim_set_pull sim0 7 pull-up
+
+ dut_run gpioset --interactive foo=1 bar=0 baz=0
+
+ gpiosim_check_value sim0 1 1
+ gpiosim_check_value sim0 4 0
+ gpiosim_check_value sim0 7 0
+
+ dut_write "toggle"
+
+ gpiosim_check_value sim0 1 0
+ gpiosim_check_value sim0 4 1
+ gpiosim_check_value sim0 7 1
+ dut_write "get"
+ dut_read
+ output_regex_match "foo=inactive\\s+bar=active\\s+baz=active\\s*"
+
+ dut_write "toggle baz"
+
+ gpiosim_check_value sim0 1 0
+ gpiosim_check_value sim0 4 1
+ gpiosim_check_value sim0 7 0
+ dut_write "get"
+ dut_read
+ output_regex_match "foo=inactive\\s+bar=active\\s+baz=inactive\\s*"
+}
+
+@test "gpioset: interactive sleep" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo line_name=4:bar \
+ line_name=7:baz
+
+ dut_run gpioset --interactive foo=1 bar=0 baz=0
+
+ dut_write "sleep 500ms"
+ dut_flush
+
+ assert_fail dut_readable
+
+ sleep 1
+
+ # prompt, but not a full line...
+ dut_readable
+}
+
+@test "gpioset: toggle (continuous)" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo line_name=4:bar \
+ line_name=7:baz
+
+ gpiosim_set_pull sim0 4 pull-up
+ gpiosim_set_pull sim0 7 pull-up
+
+ # redirect as gpioset has no banner
+ dut_run_redirect gpioset --toggle 1s foo=1 bar=0 baz=0
+
+ gpiosim_check_value sim0 1 1
+ gpiosim_check_value sim0 4 0
+ gpiosim_check_value sim0 7 0
+
+ sleep 1
+
+ gpiosim_check_value sim0 1 0
+ gpiosim_check_value sim0 4 1
+ gpiosim_check_value sim0 7 1
+
+ sleep 1
+
+ gpiosim_check_value sim0 1 1
+ gpiosim_check_value sim0 4 0
+ gpiosim_check_value sim0 7 0
+}
+
+@test "gpioset: toggle (terminated)" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo line_name=4:bar \
+ line_name=7:baz
+
+ gpiosim_set_pull sim0 4 pull-up
+
+ # redirect as gpioset has no banner
+ # hold-period to allow test to sample before gpioset exits
+ dut_run_redirect gpioset --toggle 1s,0 -p 600ms foo=1 bar=0 baz=1
+
+ gpiosim_check_value sim0 1 1
+ gpiosim_check_value sim0 4 0
+ gpiosim_check_value sim0 7 1
+
+ sleep 1
+
+ gpiosim_check_value sim0 1 0
+ gpiosim_check_value sim0 4 1
+ gpiosim_check_value sim0 7 0
+
+ dut_wait
+
+ status_is 0
+}
+
+@test "gpioset: with invalid toggle period" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo line_name=4:bar \
+ line_name=7:baz
+
+ run_tool gpioset --toggle 1ns foo=1 bar=0 baz=0
+
+ output_regex_match ".*invalid period.*"
+ status_is 1
+}
+
+@test "gpioset: with strict named line check" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar \
+ line_name=3:foobar
+ gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=2:foobar \
+ line_name=4:xyz line_name=7:foobar
+ gpiosim_chip sim2 num_lines=16
+
+ run_tool gpioset --strict foobar=active
+
+ output_regex_match ".*line 'foobar' is not unique"
+ status_is 1
+}
+
+@test "gpioset: with lines by offset" {
+ # not suggesting this setup makes any sense
+ # - just test that we can deal with it
+ gpiosim_chip sim0 num_lines=8 line_name=1:6 line_name=6:1
+
+ gpiosim_set_pull sim0 1 pull-down
+ gpiosim_set_pull sim0 6 pull-up
+
+ dut_run gpioset -i --chip ${GPIOSIM_CHIP_NAME[sim0]} 6=1 1=0
+
+ gpiosim_check_value sim0 1 0
+ gpiosim_check_value sim0 6 1
+}
+
+@test "gpioset: with lines strictly by name" {
+ # not suggesting this setup makes any sense
+ # - just test that we can deal with it
+ gpiosim_chip sim0 num_lines=8 line_name=1:6 line_name=6:1
+
+ gpiosim_set_pull sim0 1 pull-down
+ gpiosim_set_pull sim0 6 pull-up
+
+ dut_run gpioset -i --by-name --chip ${GPIOSIM_CHIP_NAME[sim0]} 6=1 1=0
+
+ gpiosim_check_value sim0 1 1
+ gpiosim_check_value sim0 6 0
+}
+
+@test "gpioset: interactive after SIGINT" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
+
+ dut_run gpioset -i foo=1
+
+ dut_kill -SIGINT
+ dut_wait
+
+ status_is 130
+}
+
+@test "gpioset: interactive after SIGTERM" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
+
+ dut_run gpioset -i foo=1
+
+ dut_kill -SIGTERM
+ dut_wait
+
+ status_is 143
+}
+
+@test "gpioset: with no arguments" {
+ run_tool gpioset
+
+ status_is 1
+ output_regex_match ".*at least one GPIO line value must be specified"
+}
+
+@test "gpioset: with chip but no line specified" {
+ gpiosim_chip sim0 num_lines=8
+
+ run_tool gpioset --chip ${GPIOSIM_CHIP_NAME[sim0]}
+
+ output_regex_match ".*at least one GPIO line value must be specified"
+ status_is 1
+}
+
+@test "gpioset: with offset out of range" {
+ gpiosim_chip sim0 num_lines=4
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpioset --chip $sim0 0=1 1=1 2=1 3=1 4=1 5=1
+
+ output_regex_match ".*offset 4 is out of range on chip '$sim0'"
+ output_regex_match ".*offset 5 is out of range on chip '$sim0'"
+ status_is 1
+}
+
+@test "gpioset: with invalid hold-period" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpioset --hold-period=bad --chip $sim0 0=1
+
+ output_regex_match ".*invalid period.*"
+ status_is 1
+}
+
+@test "gpioset: with invalid value" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ # by name
+ run_tool gpioset --chip $sim0 0=c
+
+ output_regex_match ".*invalid line value.*"
+ status_is 1
+
+ # by value
+ run_tool gpioset --chip $sim0 0=3
+
+ output_regex_match ".*invalid line value.*"
+ status_is 1
+}
+
+@test "gpioset: with invalid offset" {
+ gpiosim_chip sim0 num_lines=8
+
+ run_tool gpioset --chip ${GPIOSIM_CHIP_NAME[sim0]} 4000000000=0
+
+ output_regex_match ".*cannot find line '4000000000'"
+ status_is 1
+}
+
+@test "gpioset: with invalid bias" {
+ gpiosim_chip sim0 num_lines=8
+
+ run_tool gpioset --bias=bad --chip ${GPIOSIM_CHIP_NAME[sim0]} 0=1 1=1
+
+ output_regex_match ".*invalid bias.*"
+ status_is 1
+}
+
+@test "gpioset: with invalid drive" {
+ gpiosim_chip sim0 num_lines=8
+
+ run_tool gpioset --drive=bad --chip ${GPIOSIM_CHIP_NAME[sim0]} 0=1 1=1
+
+ output_regex_match ".*invalid drive.*"
+ status_is 1
+}
+
+@test "gpioset: with daemonize and interactive" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpioset --interactive --daemonize --chip $sim0 0=1
+
+ output_regex_match ".*can't combine daemonize with interactive"
+ status_is 1
+}
+
+@test "gpioset: with interactive and toggle" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpioset --interactive --toggle 1s --chip $sim0 0=1
+
+ output_regex_match ".*can't combine interactive with toggle"
+ status_is 1
+}
+
+@test "gpioset: with nonexistent line" {
+ run_tool gpioset nonexistent-line=0
+
+ output_regex_match ".*cannot find line 'nonexistent-line'"
+ status_is 1
+}
+
+@test "gpioset: with same line twice" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ # by offset
+ run_tool gpioset --chip $sim0 0=1 0=1
+
+ output_regex_match ".*lines '0' and '0' are the same line"
+ status_is 1
+
+ # by name
+ run_tool gpioset --chip $sim0 foo=1 foo=1
+
+ output_regex_match ".*lines 'foo' and 'foo' are the same line"
+ status_is 1
+
+ # by name and offset
+ run_tool gpioset --chip $sim0 foo=1 1=1
+
+ output_regex_match ".*lines 'foo' and '1' are the same line"
+ status_is 1
+
+ # by offset and name
+ run_tool gpioset --chip $sim0 1=1 foo=1
+
+ output_regex_match ".*lines '1' and 'foo' are the same line"
+ status_is 1
+}
+
+#
+# gpiomon test cases
+#
+
+@test "gpiomon: by name" {
+ gpiosim_chip sim0 num_lines=8 line_name=4:foo
+
+ gpiosim_set_pull sim0 4 pull-up
+
+ dut_run gpiomon --banner --edges=rising foo
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-down
+ gpiosim_set_pull sim0 4 pull-up
+ gpiosim_set_pull sim0 4 pull-down
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+foo"
+ assert_fail dut_readable
+}
+
+@test "gpiomon: by offset" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 4 pull-up
+
+ dut_run gpiomon --banner --edges=rising --chip $sim0 4
+ dut_regex_match "Monitoring line .*"
+
+ gpiosim_set_pull sim0 4 pull-down
+ gpiosim_set_pull sim0 4 pull-up
+ gpiosim_set_pull sim0 4 pull-down
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+$sim0 4"
+ assert_fail dut_readable
+}
+
+@test "gpiomon: by symlink" {
+ gpiosim_chip sim0 num_lines=8
+ gpiosim_chip_symlink sim0 .
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 4 pull-up
+
+ dut_run gpiomon --banner --edges=rising --chip $GPIOSIM_CHIP_LINK 4
+ dut_regex_match "Monitoring line .*"
+
+ gpiosim_set_pull sim0 4 pull-down
+ gpiosim_set_pull sim0 4 pull-up
+ gpiosim_set_pull sim0 4 pull-down
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+$sim0\\s+4"
+ assert_fail dut_readable
+}
+
+
+@test "gpiomon: by chip and name" {
+ gpiosim_chip sim0 num_lines=8 line_name=0:foo
+ gpiosim_chip sim1 num_lines=8 line_name=2:foo
+
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
+
+ gpiosim_set_pull sim1 0 pull-up
+
+ dut_run gpiomon --banner --edges=rising --chip $sim1 foo
+ dut_regex_match "Monitoring line .*"
+
+ gpiosim_set_pull sim1 2 pull-down
+ gpiosim_set_pull sim1 2 pull-up
+ gpiosim_set_pull sim1 2 pull-down
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+$sim1 2 foo"
+ assert_fail dut_readable
+}
+
+@test "gpiomon: first matching named line" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar \
+ line_name=3:foobar
+ gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=2:foobar \
+ line_name=4:xyz line_name=7:foobar
+ gpiosim_chip sim2 num_lines=16
+
+ dut_run gpiomon --banner foobar
+ dut_regex_match "Monitoring line .*"
+
+ gpiosim_set_pull sim0 3 pull-up
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+foobar"
+ assert_fail dut_readable
+}
+
+@test "gpiomon: rising edge" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 4 pull-up
+
+ dut_run gpiomon --banner --edges=rising --chip $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-down
+ gpiosim_set_pull sim0 4 pull-up
+ gpiosim_set_pull sim0 4 pull-down
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+$sim0 4"
+ assert_fail dut_readable
+}
+
+@test "gpiomon: falling edge" {
+ gpiosim_chip sim0 num_lines=8
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 4 pull-down
+
+ dut_run gpiomon --banner --edges=falling --chip $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+ gpiosim_set_pull sim0 4 pull-down
+ gpiosim_set_pull sim0 4 pull-up
+ dut_regex_match "[0-9]+\.[0-9]+\\s+falling\\s+$sim0 4"
+ assert_fail dut_readable
+}
+
+@test "gpiomon: both edges" {
+ gpiosim_chip sim0 num_lines=8
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner --edges=both --chip $sim0 4
+ dut_regex_match "Monitoring line .*"
+
+ gpiosim_set_pull sim0 4 pull-up
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+$sim0 4"
+
+ gpiosim_set_pull sim0 4 pull-down
+ dut_regex_match "[0-9]+\.[0-9]+\\s+falling\\s+$sim0 4"
+}
+
+@test "gpiomon: with pull-up" {
+ gpiosim_chip sim0 num_lines=8
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 4 pull-down
+
+ dut_run gpiomon --banner --bias=pull-up --chip $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-down
+ dut_regex_match "[0-9]+\.[0-9]+\\s+falling\\s+$sim0 4"
+
+ assert_fail dut_readable
+}
+
+@test "gpiomon: with pull-down" {
+ gpiosim_chip sim0 num_lines=8
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 4 pull-up
+
+ dut_run gpiomon --banner --bias=pull-down --chip $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+$sim0 4"
+
+ assert_fail dut_readable
+}
+
+@test "gpiomon: with active-low" {
+ gpiosim_chip sim0 num_lines=8
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 4 pull-up
+
+ dut_run gpiomon --banner --active-low --chip $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-down
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+$sim0 4"
+
+ gpiosim_set_pull sim0 4 pull-up
+ dut_regex_match "[0-9]+\.[0-9]+\\s+falling\\s+$sim0 4"
+
+ assert_fail dut_readable
+}
+
+@test "gpiomon: with quiet mode" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner --edges=rising --quiet --chip $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+ assert_fail dut_readable
+}
+
+@test "gpiomon: with num-events" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ # redirect, as gpiomon exits after 4 events
+ dut_run_redirect gpiomon --num-events=4 --chip $sim0 4
+
+ gpiosim_set_pull sim0 4 pull-up
+ gpiosim_set_pull sim0 4 pull-down
+ gpiosim_set_pull sim0 4 pull-up
+ gpiosim_set_pull sim0 4 pull-down
+
+ dut_wait
+ status_is 0
+ dut_read_redirect
+
+ regex_matches "[0-9]+\.[0-9]+\\s+rising\\s+$sim0 4" "${lines[0]}"
+ regex_matches "[0-9]+\.[0-9]+\\s+falling\\s+$sim0 4" "${lines[1]}"
+ regex_matches "[0-9]+\.[0-9]+\\s+rising\\s+$sim0 4" "${lines[2]}"
+ regex_matches "[0-9]+\.[0-9]+\\s+falling\\s+$sim0 4" "${lines[3]}"
+ num_lines_is 4
+}
+
+@test "gpiomon: multiple lines" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner --format=%o --chip $sim0 1 3 2 5 4
+ dut_regex_match "Monitoring lines .*"
+
+ gpiosim_set_pull sim0 2 pull-up
+ dut_regex_match "2"
+ gpiosim_set_pull sim0 3 pull-up
+ dut_regex_match "3"
+ gpiosim_set_pull sim0 4 pull-up
+ dut_regex_match "4"
+
+ assert_fail dut_readable
+}
+
+@test "gpiomon: multiple lines by name and offset" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner --format=%o --chip $sim0 foo bar 3
+ dut_regex_match "Monitoring lines .*"
+
+ gpiosim_set_pull sim0 2 pull-up
+ dut_regex_match "2"
+ gpiosim_set_pull sim0 3 pull-up
+ dut_regex_match "3"
+ gpiosim_set_pull sim0 1 pull-up
+ dut_regex_match "1"
+
+ assert_fail dut_readable
+}
+
+@test "gpiomon: multiple lines across multiple chips" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar
+ gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=4:xyz
+
+ dut_run gpiomon --banner --format=%l foo bar baz
+ dut_regex_match "Monitoring lines .*"
+
+ gpiosim_set_pull sim0 2 pull-up
+ dut_regex_match "bar"
+ gpiosim_set_pull sim1 0 pull-up
+ dut_regex_match "baz"
+ gpiosim_set_pull sim0 1 pull-up
+ dut_regex_match "foo"
+
+ assert_fail dut_readable
+}
+
+@test "gpiomon: exit after SIGINT" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner --chip $sim0 4
+ dut_regex_match "Monitoring line .*"
+
+ dut_kill -SIGINT
+ dut_wait
+
+ status_is 130
+}
+
+@test "gpiomon: exit after SIGTERM" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner --chip $sim0 4
+ dut_regex_match "Monitoring line .*"
+
+ dut_kill -SIGTERM
+ dut_wait
+
+ status_is 143
+}
+
+@test "gpiomon: with nonexistent line" {
+ run_tool gpiomon nonexistent-line
+
+ status_is 1
+ output_regex_match ".*cannot find line 'nonexistent-line'"
+}
+
+@test "gpiomon: with same line twice" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ # by offset
+ run_tool gpiomon --chip $sim0 0 0
+
+ output_regex_match ".*lines '0' and '0' are the same line"
+ status_is 1
+
+ # by name
+ run_tool gpiomon foo foo
+
+ output_regex_match ".*lines 'foo' and 'foo' are the same line"
+ status_is 1
+
+ # by name and offset
+ run_tool gpiomon --chip $sim0 1 foo
+
+ output_regex_match ".*lines '1' and 'foo' are the same line"
+ status_is 1
+}
+
+@test "gpiomon: with strict named line check" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar \
+ line_name=3:foobar
+ gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=2:foobar \
+ line_name=4:xyz line_name=7:foobar
+ gpiosim_chip sim2 num_lines=16
+
+ run_tool gpiomon --strict foobar
+
+ output_regex_match ".*line 'foobar' is not unique"
+ status_is 1
+}
+@test "gpiomon: with lines by offset" {
+ # not suggesting this setup makes any sense
+ # - just test that we can deal with it
+ gpiosim_chip sim0 num_lines=8 line_name=1:6 line_name=6:1
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 1 pull-up
+
+ dut_run gpiomon --banner --chip $sim0 6 1
+ dut_flush
+
+ gpiosim_set_pull sim0 1 pull-down
+ dut_regex_match "[0-9]+\.[0-9]+\\s+falling\\s+$sim0 1"
+
+ gpiosim_set_pull sim0 1 pull-up
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+$sim0 1"
+
+ gpiosim_set_pull sim0 6 pull-up
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+$sim0 6"
+
+ gpiosim_set_pull sim0 6 pull-down
+ dut_regex_match "[0-9]+\.[0-9]+\\s+falling\\s+$sim0 6"
+
+ assert_fail dut_readable
+}
+
+@test "gpiomon: with lines strictly by name" {
+ # not suggesting this setup makes sense
+ # - just test that we can deal with it
+ gpiosim_chip sim0 num_lines=8 line_name=1:42 line_name=6:13
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 1 pull-up
+
+ dut_run gpiomon --banner --by-name --chip $sim0 42 13
+ dut_flush
+
+ gpiosim_set_pull sim0 1 pull-down
+ dut_regex_match "[0-9]+\.[0-9]+\\s+falling\\s+$sim0 1"
+
+ gpiosim_set_pull sim0 1 pull-up
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+$sim0 1"
+
+ gpiosim_set_pull sim0 6 pull-up
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+$sim0 6"
+
+ gpiosim_set_pull sim0 6 pull-down
+ dut_regex_match "[0-9]+\.[0-9]+\\s+falling\\s+$sim0 6"
+
+ assert_fail dut_readable
+}
+
+@test "gpiomon: with no arguments" {
+ run_tool gpiomon
+
+ output_regex_match ".*at least one GPIO line must be specified"
+ status_is 1
+}
+
+@test "gpiomon: with no line specified" {
+ gpiosim_chip sim0 num_lines=8
+
+ run_tool gpiomon --chip ${GPIOSIM_CHIP_NAME[sim0]}
+
+ output_regex_match ".*at least one GPIO line must be specified"
+ status_is 1
+}
+
+@test "gpiomon: with offset out of range" {
+ gpiosim_chip sim0 num_lines=4
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpiomon --chip $sim0 5
+
+ output_regex_match ".*offset 5 is out of range on chip '$sim0'"
+ status_is 1
+}
+
+@test "gpiomon: with invalid bias" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpiomon --bias=bad -c $sim0 0 1
+
+ output_regex_match ".*invalid bias.*"
+ status_is 1
+}
+
+@test "gpiomon: with custom format (event type + offset)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner "--format=%e %o" -c $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+ dut_read
+ output_is "1 4"
+}
+
+@test "gpiomon: with custom format (event type + offset joined)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner "--format=%e%o" -c $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+ dut_read
+ output_is "14"
+}
+
+@test "gpiomon: with custom format (edge, chip and line)" {
+ gpiosim_chip sim0 num_lines=8 line_name=4:baz
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner "--format=%e %o %E %c %l" -c $sim0 baz
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+ dut_regex_match "1 4 rising $sim0 baz"
+}
+
+@test "gpiomon: with custom format (seconds timestamp)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner "--format=%e %o %S" -c $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+ dut_regex_match "1 4 [0-9]+\\.[0-9]+"
+}
+
+@test "gpiomon: with custom format (UTC timestamp)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner "--format=%U %e %o " --event-clock=realtime \
+ -c $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+ dut_regex_match \
+"[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\\.[0-9]+Z 1 4"
+}
+
+@test "gpiomon: with custom format (localtime timestamp)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner "--format=%L %e %o" --event-clock=realtime \
+ -c $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+ dut_regex_match \
+"[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\\.[0-9]+ 1 4"
+}
+
+@test "gpiomon: with custom format (double percent sign)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner "--format=start%%end" -c $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+ dut_read
+ output_is "start%end"
+}
+
+@test "gpiomon: with custom format (double percent sign + event type specifier)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner "--format=%%e" -c $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+ dut_read
+ output_is "%e"
+}
+
+@test "gpiomon: with custom format (single percent sign)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner "--format=%" -c $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+ dut_read
+ output_is "%"
+}
+
+@test "gpiomon: with custom format (single percent sign between other characters)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner "--format=foo % bar" -c $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+ dut_read
+ output_is "foo % bar"
+}
+
+@test "gpiomon: with custom format (unknown specifier)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner "--format=%x" -c $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+ dut_read
+ output_is "%x"
+}
--
2.38.0
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [libgpiod v2][PATCH v3 4/5] tools: add gpiowatch
2022-10-11 0:29 [libgpiod v2][PATCH v3 0/5] tools: improvements for v2 Kent Gibson
` (2 preceding siblings ...)
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 3/5] tools: tests for " Kent Gibson
@ 2022-10-11 0:29 ` Kent Gibson
2022-11-08 15:00 ` Bartosz Golaszewski
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 5/5] tools: gpiowatch tests Kent Gibson
4 siblings, 1 reply; 16+ messages in thread
From: Kent Gibson @ 2022-10-11 0:29 UTC (permalink / raw)
To: linux-gpio, brgl; +Cc: Kent Gibson
Add a gpiowatch tool, based on gpiomon, to report line info change
events read from chip file descriptors.
Inspired by the gpio-watch tool in the linux kernel, but with gpiomon
features such as custom formatted output, filtering events of
interest and exiting after a number of events, so more useful for
scripting.
Default output is minimalist, so just time, event type and line id.
Full event details are available using the custom formatted output.
Signed-off-by: Kent Gibson <warthog618@gmail.com>
---
Changes v2 -> v3:
- Minimise the default output to more closely match gpiomon.
- Add --format option for when more detail is required.
- Add --num-events option to exit after a number of events.
- Add --event option to report only specific event types.
- Add --quiet option to not print events.
- fix monotonic to realtime conversion on 32 bit platforms.
man/Makefile.am | 2 +-
tools/.gitignore | 1 +
tools/Makefile.am | 4 +-
tools/gpiowatch.c | 433 ++++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 438 insertions(+), 2 deletions(-)
create mode 100644 tools/gpiowatch.c
diff --git a/man/Makefile.am b/man/Makefile.am
index 8d1d9b3..032ed4e 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -3,7 +3,7 @@
if WITH_MANPAGES
-dist_man1_MANS = gpiodetect.man gpioinfo.man gpioget.man gpioset.man gpiomon.man
+dist_man1_MANS = gpiodetect.man gpioinfo.man gpioget.man gpioset.man gpiomon.man gpiowatch.man
%.man: $(top_builddir)/tools/$(*F)
help2man $(top_builddir)/tools/$(*F) --include=$(srcdir)/template --output=$(builddir)/$@ --no-info
diff --git a/tools/.gitignore b/tools/.gitignore
index d6b2f44..ad0800b 100644
--- a/tools/.gitignore
+++ b/tools/.gitignore
@@ -6,3 +6,4 @@ gpioinfo
gpioget
gpioset
gpiomon
+gpiowatch
diff --git a/tools/Makefile.am b/tools/Makefile.am
index c956314..1097fea 100644
--- a/tools/Makefile.am
+++ b/tools/Makefile.am
@@ -9,7 +9,7 @@ libtools_common_la_SOURCES = tools-common.c tools-common.h
LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la $(LIBEDIT_LIBS)
-bin_PROGRAMS = gpiodetect gpioinfo gpioget gpioset gpiomon
+bin_PROGRAMS = gpiodetect gpioinfo gpioget gpioset gpiomon gpiowatch
gpiodetect_SOURCES = gpiodetect.c
@@ -21,6 +21,8 @@ gpioset_SOURCES = gpioset.c
gpiomon_SOURCES = gpiomon.c
+gpiowatch_SOURCES = gpiowatch.c
+
EXTRA_DIST = gpio-tools-test gpio-tools-test.bats
if WITH_TESTS
diff --git a/tools/gpiowatch.c b/tools/gpiowatch.c
new file mode 100644
index 0000000..dfcf14a
--- /dev/null
+++ b/tools/gpiowatch.c
@@ -0,0 +1,433 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
+
+#include <getopt.h>
+#include <gpiod.h>
+#include <inttypes.h>
+#include <poll.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <time.h>
+
+#include "tools-common.h"
+
+static void print_help(void)
+{
+ printf("Usage: %s [OPTIONS] <line>...\n", get_progname());
+ printf("\n");
+ printf("Wait for changes to info on GPIO lines and print them to standard output.\n");
+ printf("\n");
+ printf("Lines are specified by name, or optionally by offset if the chip option\n");
+ printf("is provided.\n");
+ printf("\n");
+ printf("Options:\n");
+ printf(" --banner\t\tdisplay a banner on successful startup\n");
+ printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n");
+ printf(" -c, --chip <chip>\trestrict scope to a particular chip\n");
+ printf(" -e, --event <event>\tspecify the events to monitor.\n");
+ printf("\t\t\tPossible values: 'requested', 'released', 'reconfigured'.\n");
+ printf("\t\t\t(default is all events)\n");
+ printf(" -h, --help\t\tdisplay this help and exit\n");
+ printf(" -F, --format <fmt>\tspecify a custom output format\n");
+ printf(" --localtime\tconvert event timestamps to local time\n");
+ printf(" -n, --num-events <num>\n");
+ printf("\t\t\texit after processing num events\n");
+ printf(" -q, --quiet\t\tdon't generate any output\n");
+ printf(" -s, --strict\t\tabort if requested line names are not unique\n");
+ printf(" --utc\t\tconvert event timestamps to UTC\n");
+ printf(" -v, --version\t\toutput version information and exit\n");
+ print_chip_help();
+ printf("\n");
+ printf("Format specifiers:\n");
+ printf(" %%o GPIO line offset\n");
+ printf(" %%l GPIO line name\n");
+ printf(" %%c GPIO chip name\n");
+ printf(" %%e numeric info event type ('1' - requested, '2' - released or '3' - reconfigured)\n");
+ printf(" %%E info event type ('requested', 'released' or 'reconfigured')\n");
+ printf(" %%a line attributes\n");
+ printf(" %%C consumer\n");
+ printf(" %%S event timestamp as seconds\n");
+ printf(" %%U event timestamp as UTC\n");
+ printf(" %%L event timestamp as local time\n");
+}
+
+static int parse_event_type_or_die(const char *option)
+{
+ if (strcmp(option, "requested") == 0)
+ return GPIOD_INFO_EVENT_LINE_REQUESTED;
+ if (strcmp(option, "released") == 0)
+ return GPIOD_INFO_EVENT_LINE_RELEASED;
+ if (strcmp(option, "reconfigured") != 0)
+ die("invalid edge: %s", option);
+ return GPIOD_INFO_EVENT_LINE_CONFIG_CHANGED;
+}
+
+struct config {
+ bool quiet;
+ bool strict;
+ int event_type;
+ int events_wanted;
+ const char *chip_id;
+ const char *fmt;
+ int by_name;
+ int timestamp_fmt;
+ int banner;
+};
+
+int parse_config(int argc, char **argv, struct config *cfg)
+{
+ int opti, optc;
+ const char *const shortopts = "+b:c:C:e:hF:ln:p:qshv";
+ const struct option longopts[] = {
+ { "banner", no_argument, &cfg->banner, 1 },
+ { "by-name", no_argument, &cfg->by_name, 1 },
+ { "chip", required_argument, NULL, 'c' },
+ { "event", required_argument, NULL, 'e' },
+ { "format", required_argument, NULL, 'F' },
+ { "help", no_argument, NULL, 'h' },
+ { "localtime", no_argument, &cfg->timestamp_fmt, 2 },
+ { "num-events", required_argument, NULL, 'n' },
+ { "quiet", no_argument, NULL, 'q' },
+ { "silent", no_argument, NULL, 'q' },
+ { "strict", no_argument, NULL, 's' },
+ { "utc", no_argument, &cfg->timestamp_fmt, 1 },
+ { "version", no_argument, NULL, 'v' },
+ { GETOPT_NULL_LONGOPT },
+ };
+
+ memset(cfg, 0, sizeof(*cfg));
+
+ for (;;) {
+ optc = getopt_long(argc, argv, shortopts, longopts, &opti);
+ if (optc < 0)
+ break;
+
+ switch (optc) {
+ case 'c':
+ cfg->chip_id = optarg;
+ break;
+ case 'e':
+ cfg->event_type = parse_event_type_or_die(optarg);
+ break;
+ case 'F':
+ cfg->fmt = optarg;
+ break;
+ case 'n':
+ cfg->events_wanted = parse_uint_or_die(optarg);
+ break;
+ case 'q':
+ cfg->quiet = true;
+ break;
+ case 's':
+ cfg->strict = true;
+ break;
+ case 'h':
+ print_help();
+ exit(EXIT_SUCCESS);
+ case 'v':
+ print_version();
+ exit(EXIT_SUCCESS);
+ case '?':
+ die("try %s --help", get_progname());
+ case 0:
+ break;
+ default:
+ abort();
+ }
+ }
+
+ return optind;
+}
+
+static void print_banner(int num_lines, char **lines)
+{
+ int i;
+
+ if (num_lines > 1) {
+ printf("Watching lines ");
+
+ for (i = 0; i < num_lines - 1; i++)
+ printf("%s, ", lines[i]);
+
+ printf("and %s...\n", lines[i]);
+ } else {
+ printf("Watching line %s...\n", lines[0]);
+ }
+}
+
+static void print_event_type(int evtype)
+{
+ switch (evtype) {
+ case GPIOD_INFO_EVENT_LINE_REQUESTED:
+ fputs("requested", stdout);
+ break;
+ case GPIOD_INFO_EVENT_LINE_RELEASED:
+ fputs("released", stdout);
+ break;
+ case GPIOD_INFO_EVENT_LINE_CONFIG_CHANGED:
+ fputs("reconfigured", stdout);
+ break;
+ default:
+ fputs("unknown", stdout);
+ break;
+ }
+}
+
+/*
+ * A convenience function to map clock monotonic to realtime, as uAPI only
+ * supports CLOCK_MONOTONIC.
+ *
+ * Samples the realtime clock on either side of a monotonic sample and averages
+ * the realtime samples to estimate the offset between the two clocks.
+ * Any time shifts between the two realtime samples will result in the
+ * monotonic time being mapped to the average of the before and after, so
+ * half way between the old and new times.
+ *
+ * Any CPU suspension between the event being generated and converted will
+ * result in the returned time being shifted by the period of suspension.
+ */
+static uint64_t monotonic_to_realtime(uint64_t evtime)
+{
+ struct timespec ts;
+ uint64_t before, after, mono;
+
+ clock_gettime(CLOCK_REALTIME, &ts);
+ before = ts.tv_nsec + ((uint64_t)ts.tv_sec) * 1000000000;
+
+ clock_gettime(CLOCK_MONOTONIC, &ts);
+ mono = ts.tv_nsec + ((uint64_t)ts.tv_sec) * 1000000000;
+
+ clock_gettime(CLOCK_REALTIME, &ts);
+ after = ts.tv_nsec + ((uint64_t)ts.tv_sec) * 1000000000;
+
+ evtime += (after/2 - mono + before/2);
+ return evtime;
+}
+
+static void event_print_formatted(struct gpiod_info_event *event,
+ struct line_resolver *resolver, int chip_num,
+ struct config *cfg)
+{
+ struct gpiod_line_info *info;
+ const char *lname, *prev, *curr, *consumer;
+ char fmt;
+ uint64_t evtime;
+ int evtype;
+ unsigned int offset;
+
+ info = gpiod_info_event_get_line_info(event);
+ evtime = gpiod_info_event_get_timestamp_ns(event);
+ evtype = gpiod_info_event_get_event_type(event);
+ offset = gpiod_line_info_get_offset(info);
+
+ for (prev = curr = cfg->fmt;;) {
+ curr = strchr(curr, '%');
+ if (!curr) {
+ fputs(prev, stdout);
+ break;
+ }
+
+ if (prev != curr)
+ fwrite(prev, curr - prev, 1, stdout);
+
+ fmt = *(curr + 1);
+
+ switch (fmt) {
+ case 'a':
+ print_line_attributes(info);
+ break;
+ case 'c':
+ fputs(get_chip_name(resolver, chip_num), stdout);
+ break;
+ case 'C':
+ if (!gpiod_line_info_is_used(info)) {
+ consumer = "unused";
+ } else {
+ consumer = gpiod_line_info_get_consumer(info);
+ if (!consumer)
+ consumer = "kernel";
+ }
+ fputs(consumer, stdout);
+ break;
+ case 'e':
+ printf("%d", evtype);
+ break;
+ case 'E':
+ print_event_type(evtype);
+ break;
+ case 'l':
+ lname = gpiod_line_info_get_name(info);
+ if (!lname)
+ lname = "unnamed";
+ fputs(lname, stdout);
+ break;
+ case 'L':
+ print_event_time(monotonic_to_realtime(evtime), 2);
+ break;
+ case 'o':
+ printf("%u", offset);
+ break;
+ case 'S':
+ print_event_time(evtime, 0);
+ break;
+ case 'U':
+ print_event_time(monotonic_to_realtime(evtime), 1);
+ break;
+ case '%':
+ fputc('%', stdout);
+ break;
+ case '\0':
+ fputc('%', stdout);
+ goto end;
+ default:
+ fwrite(curr, 2, 1, stdout);
+ break;
+ }
+
+ curr += 2;
+ prev = curr;
+ }
+
+end:
+ fputc('\n', stdout);
+}
+
+static void event_print_human_readable(struct gpiod_info_event *event,
+ struct line_resolver *resolver, int chip_num,
+ struct config *cfg)
+{
+ struct gpiod_line_info *info;
+ uint64_t evtime;
+ int evtype;
+ unsigned int offset;
+ char *evname;
+
+ info = gpiod_info_event_get_line_info(event);
+ evtime = gpiod_info_event_get_timestamp_ns(event);
+ evtype = gpiod_info_event_get_event_type(event);
+ offset = gpiod_line_info_get_offset(info);
+
+ switch (evtype) {
+ case GPIOD_INFO_EVENT_LINE_REQUESTED:
+ evname = "requested";
+ break;
+ case GPIOD_INFO_EVENT_LINE_RELEASED:
+ evname = "released";
+ break;
+ case GPIOD_INFO_EVENT_LINE_CONFIG_CHANGED:
+ evname = "reconfigured";
+ break;
+ default:
+ evname = "unknown";
+ }
+
+ if (cfg->timestamp_fmt)
+ evtime = monotonic_to_realtime(evtime);
+
+ print_event_time(evtime, cfg->timestamp_fmt);
+ printf("\t%s\t", evname);
+ print_line_id(resolver, chip_num, offset, cfg->chip_id);
+ fputc('\n', stdout);
+}
+
+static void event_print(struct gpiod_info_event *event,
+ struct line_resolver *resolver, int chip_num,
+ struct config *cfg)
+{
+ if (cfg->quiet)
+ return;
+
+ if (cfg->fmt)
+ event_print_formatted(event, resolver, chip_num, cfg);
+ else
+ event_print_human_readable(event, resolver, chip_num, cfg);
+}
+
+int main(int argc, char **argv)
+{
+ int i, j, events_done = 0, evtype;
+ struct gpiod_chip **chips;
+ struct pollfd *pollfds;
+ struct gpiod_chip *chip;
+ struct line_resolver *resolver;
+ struct gpiod_info_event *event;
+ struct config cfg;
+
+ i = parse_config(argc, argv, &cfg);
+ argc -= optind;
+ argv += optind;
+
+ if (argc < 1)
+ die("at least one GPIO line must be specified");
+
+ if (argc > 64)
+ die("too many lines given");
+
+ resolver = resolve_lines(argc, argv, cfg.chip_id, cfg.strict,
+ cfg.by_name);
+ validate_resolution(resolver, cfg.chip_id);
+ chips = calloc(resolver->num_chips, sizeof(*chips));
+ pollfds = calloc(resolver->num_chips, sizeof(*pollfds));
+ if (!pollfds)
+ die("out of memory");
+
+ for (i = 0; i < resolver->num_chips; i++) {
+ chip = gpiod_chip_open(resolver->chips[i].path);
+ if (!chip)
+ die_perror("unable to open chip '%s'",
+ resolver->chips[i].path);
+
+ for (j = 0; j < resolver->num_lines; j++)
+ if ((resolver->lines[j].chip_num == i) &&
+ !gpiod_chip_watch_line_info(
+ chip, resolver->lines[j].offset))
+ die_perror("unable to watch line on chip '%s'",
+ resolver->chips[i].path);
+
+ chips[i] = chip;
+ pollfds[i].fd = gpiod_chip_get_fd(chip);
+ pollfds[i].events = POLLIN;
+ }
+
+ if (cfg.banner)
+ print_banner(argc, argv);
+
+ for (;;) {
+ fflush(stdout);
+
+ if (poll(pollfds, resolver->num_chips, -1) < 0)
+ die_perror("error polling for events");
+
+ for (i = 0; i < resolver->num_chips; i++) {
+ if (pollfds[i].revents == 0)
+ continue;
+
+ event = gpiod_chip_read_info_event(chips[i]);
+ if (!event)
+ die_perror("unable to retrieve chip event");
+
+ if (cfg.event_type) {
+ evtype = gpiod_info_event_get_event_type(event);
+ if (evtype != cfg.event_type)
+ continue;
+ }
+
+ event_print(event, resolver, i, &cfg);
+
+ events_done++;
+
+ if (cfg.events_wanted &&
+ events_done >= cfg.events_wanted)
+ goto done;
+ }
+ }
+done:
+ for (i = 0; i < resolver->num_chips; i++)
+ gpiod_chip_close(chips[i]);
+
+ free(chips);
+ free_line_resolver(resolver);
+
+ return EXIT_SUCCESS;
+}
--
2.38.0
^ permalink raw reply related [flat|nested] 16+ messages in thread
* [libgpiod v2][PATCH v3 5/5] tools: gpiowatch tests
2022-10-11 0:29 [libgpiod v2][PATCH v3 0/5] tools: improvements for v2 Kent Gibson
` (3 preceding siblings ...)
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 4/5] tools: add gpiowatch Kent Gibson
@ 2022-10-11 0:29 ` Kent Gibson
4 siblings, 0 replies; 16+ messages in thread
From: Kent Gibson @ 2022-10-11 0:29 UTC (permalink / raw)
To: linux-gpio, brgl; +Cc: Kent Gibson
Extend the tool test suite to cover the gpiowatch tool.
Signed-off-by: Kent Gibson <warthog618@gmail.com>
---
tools/gpio-tools-test.bats | 503 +++++++++++++++++++++++++++++++++++++
1 file changed, 503 insertions(+)
diff --git a/tools/gpio-tools-test.bats b/tools/gpio-tools-test.bats
index 6c12ffc..e42576b 100755
--- a/tools/gpio-tools-test.bats
+++ b/tools/gpio-tools-test.bats
@@ -2318,3 +2318,506 @@ request_release_line() {
dut_read
output_is "%x"
}
+
+#
+# gpiowatch test cases
+#
+
+@test "gpiowatch: by name" {
+ gpiosim_chip sim0 num_lines=8 line_name=4:foo
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner foo
+ dut_regex_match "Watching line .*"
+
+ request_release_line $sim0 4
+
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+foo"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+foo"
+ # tools currently have no way to generate a reconfig event
+}
+
+@test "gpiowatch: by offset" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --chip $sim0 4
+ dut_regex_match "Watching line .*"
+
+ request_release_line $sim0 4
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+$sim0 4"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+$sim0 4"
+
+ assert_fail dut_readable
+}
+
+@test "gpiowatch: by symlink" {
+ gpiosim_chip sim0 num_lines=8
+ gpiosim_chip_symlink sim0 .
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --chip $GPIOSIM_CHIP_LINK 4
+ dut_regex_match "Watching line .*"
+
+ request_release_line $sim0 4
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+$sim0\\s+4"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+$sim0\\s+4"
+
+ assert_fail dut_readable
+}
+
+@test "gpiowatch: by chip and name" {
+ gpiosim_chip sim0 num_lines=8 line_name=4:foo
+ gpiosim_chip sim1 num_lines=8 line_name=2:foo
+
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
+
+ dut_run gpiowatch --banner --chip $sim1 foo
+ dut_regex_match "Watching line .*"
+
+ request_release_line $sim1 2
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+$sim1 2 foo"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+$sim1 2 foo"
+
+ assert_fail dut_readable
+}
+
+@test "gpiowatch: first matching named line" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar \
+ line_name=3:foobar
+ gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=2:foobar \
+ line_name=4:xyz line_name=7:foobar
+ gpiosim_chip sim2 num_lines=16
+
+ dut_run gpiowatch --banner foobar
+ dut_regex_match "Watching line .*"
+
+ request_release_line ${GPIOSIM_CHIP_NAME[sim0]} 3
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+foobar"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+foobar"
+
+ assert_fail dut_readable
+}
+
+@test "gpiowatch: with requested" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 4 pull-up
+
+ dut_run gpiowatch --banner --event=requested --chip $sim0 4
+ dut_flush
+
+ request_release_line ${GPIOSIM_CHIP_NAME[sim0]} 4
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+$sim0 4"
+ assert_fail dut_readable
+}
+
+@test "gpiowatch: with released" {
+ gpiosim_chip sim0 num_lines=8
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 4 pull-down
+
+ dut_run gpiowatch --banner --event=released --chip $sim0 4
+ dut_flush
+
+ request_release_line ${GPIOSIM_CHIP_NAME[sim0]} 4
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+$sim0 4"
+ assert_fail dut_readable
+}
+
+@test "gpiowatch: with quiet mode" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --quiet --chip $sim0 4
+ dut_flush
+
+ request_release_line ${GPIOSIM_CHIP_NAME[sim0]} 4
+ assert_fail dut_readable
+}
+
+@test "gpiowatch: with num-events" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ # redirect, as gpiowatch exits after 4 events
+ dut_run_redirect gpiowatch --num-events=4 --chip $sim0 3 4
+
+
+ request_release_line ${GPIOSIM_CHIP_NAME[sim0]} 4
+ request_release_line ${GPIOSIM_CHIP_NAME[sim0]} 3
+
+ dut_wait
+ status_is 0
+ dut_read_redirect
+
+ regex_matches "[0-9]+\.[0-9]+\\s+requested\\s+$sim0 4" "${lines[0]}"
+ regex_matches "[0-9]+\.[0-9]+\\s+released\\s+$sim0 4" "${lines[1]}"
+ regex_matches "[0-9]+\.[0-9]+\\s+requested\\s+$sim0 3" "${lines[2]}"
+ regex_matches "[0-9]+\.[0-9]+\\s+released\\s+$sim0 3" "${lines[3]}"
+ num_lines_is 4
+}
+
+@test "gpiowatch: multiple lines" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --chip $sim0 1 2 3 4 5
+ dut_regex_match "Watching lines .*"
+
+ request_release_line $sim0 2
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+$sim0 2"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+$sim0 2"
+
+ request_release_line $sim0 3
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+$sim0 3"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+$sim0 3"
+
+ request_release_line $sim0 4
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+$sim0 4"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+$sim0 4"
+
+ assert_fail dut_readable
+}
+
+@test "gpiowatch: multiple lines by name and offset" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --chip $sim0 bar foo 3
+ dut_regex_match "Watching lines .*"
+
+ request_release_line $sim0 2
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+$sim0 2\\s+bar"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+$sim0 2\\s+bar"
+
+ request_release_line $sim0 1
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+$sim0 1\\s+foo"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+$sim0 1\\s+foo"
+
+ request_release_line $sim0 3
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+$sim0 3"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+$sim0 3"
+
+ assert_fail dut_readable
+}
+
+@test "gpiowatch: multiple lines across multiple chips" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar
+ gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=4:xyz
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
+
+ dut_run gpiowatch --banner baz bar foo xyz
+ dut_regex_match "Watching lines .*"
+
+ request_release_line $sim0 2
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+bar"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+bar"
+
+ request_release_line $sim0 1
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+foo"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+foo"
+
+ request_release_line $sim1 4
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+xyz"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+xyz"
+
+ request_release_line $sim1 0
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+baz"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+baz"
+
+ assert_fail dut_readable
+}
+
+@test "gpiowatch: exit after SIGINT" {
+ gpiosim_chip sim0 num_lines=8
+
+ dut_run gpiowatch --banner --chip ${GPIOSIM_CHIP_NAME[sim0]} 4
+ dut_regex_match "Watching line .*"
+
+ dut_kill -SIGINT
+ dut_wait
+
+ status_is 130
+}
+
+@test "gpiowatch: exit after SIGTERM" {
+ gpiosim_chip sim0 num_lines=8
+
+ dut_run gpiowatch --banner --chip ${GPIOSIM_CHIP_NAME[sim0]} 4
+ dut_regex_match "Watching line .*"
+
+ dut_kill -SIGTERM
+ dut_wait
+
+ status_is 143
+}
+
+@test "gpiowatch: with nonexistent line" {
+ run_tool gpiowatch nonexistent-line
+
+ status_is 1
+ output_regex_match ".*cannot find line 'nonexistent-line'"
+}
+
+@test "gpiowatch: with same line twice" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ # by offset
+ run_tool gpiowatch --chip $sim0 0 0
+
+ output_regex_match ".*lines '0' and '0' are the same line"
+ num_lines_is 1
+ status_is 1
+
+ # by name
+ run_tool gpiowatch foo foo
+
+ output_regex_match ".*lines 'foo' and 'foo' are the same line"
+ num_lines_is 1
+ status_is 1
+
+ # by name and offset
+ run_tool gpiowatch --chip $sim0 1 foo
+
+ output_regex_match ".*lines '1' and 'foo' are the same line"
+ num_lines_is 1
+ status_is 1
+}
+
+@test "gpiowatch: with strict named line check" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo line_name=2:bar \
+ line_name=3:foobar
+ gpiosim_chip sim1 num_lines=8 line_name=0:baz line_name=2:foobar \
+ line_name=4:xyz line_name=7:foobar
+ gpiosim_chip sim2 num_lines=16
+
+ run_tool gpiowatch --strict foobar
+
+ output_regex_match ".*line 'foobar' is not unique"
+ status_is 1
+}
+
+@test "gpiowatch: with lines by offset" {
+ # not suggesting this setup makes any sense
+ # - just test that we can deal with it
+ gpiosim_chip sim0 num_lines=8 line_name=1:6 line_name=6:1
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --chip $sim0 1
+ dut_flush
+
+ request_release_line $sim0 1
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+$sim0 1"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+$sim0 1"
+
+ request_release_line $sim0 6
+
+ assert_fail dut_readable
+}
+
+@test "gpiowatch: with lines strictly by name" {
+ # not suggesting this setup makes any sense
+ # - just test that we can deal with it
+ gpiosim_chip sim0 num_lines=8 line_name=1:6 line_name=6:1
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --by-name --chip $sim0 1
+ dut_flush
+
+ request_release_line $sim0 6
+ dut_regex_match "[0-9]+\.[0-9]+\\s+requested\\s+$sim0 6 1"
+ dut_regex_match "[0-9]+\.[0-9]+\\s+released\\s+$sim0 6 1"
+
+ request_release_line $sim0 1
+ assert_fail dut_readable
+}
+
+@test "gpiowatch: with no arguments" {
+ run_tool gpiowatch
+
+ output_regex_match ".*at least one GPIO line must be specified"
+ status_is 1
+}
+
+@test "gpiowatch: with no line specified" {
+ gpiosim_chip sim0 num_lines=8
+
+ run_tool gpiowatch --chip ${GPIOSIM_CHIP_NAME[sim0]}
+
+ output_regex_match ".*at least one GPIO line must be specified"
+ status_is 1
+}
+
+@test "gpiowatch: with offset out of range" {
+ gpiosim_chip sim0 num_lines=4
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpiowatch --chip $sim0 5
+
+ output_regex_match ".*offset 5 is out of range on chip '$sim0'"
+ status_is 1
+}
+
+@test "gpiowatch: with custom format (event type + offset)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --event=requested "--format=%e %o" -c $sim0 4
+ dut_flush
+
+ request_release_line $sim0 4
+ dut_read
+ output_is "1 4"
+}
+
+@test "gpiowatch: with custom format (event type + offset joined)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --event=requested "--format=%e%o" -c $sim0 4
+ dut_flush
+
+ request_release_line $sim0 4
+ dut_read
+ output_is "14"
+}
+
+@test "gpiowatch: with custom format (event, chip and line)" {
+ gpiosim_chip sim0 num_lines=8 line_name=4:baz
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --event=released \
+ "--format=%e %o %E %c %l" -c $sim0 baz
+ dut_flush
+
+ request_release_line $sim0 4
+ dut_regex_match "2 4 released $sim0 baz"
+}
+
+@test "gpiowatch: with custom format (seconds timestamp)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --event=requested "--format=%e %o %S" \
+ -c $sim0 4
+ dut_flush
+
+ request_release_line $sim0 4
+ dut_regex_match "1 4 [0-9]+\\.[0-9]+"
+}
+
+@test "gpiowatch: with custom format (UTC timestamp)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --event=released \
+ "--format=%U %e %o" -c $sim0 4
+ dut_flush
+
+ request_release_line $sim0 4
+ dut_regex_match \
+"[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\\.[0-9]+Z 2 4"
+}
+
+@test "gpiowatch: with custom format (localtime timestamp)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --event=released \
+ "--format=%L %e %o" -c $sim0 4
+ dut_flush
+
+ request_release_line $sim0 4
+ dut_regex_match \
+"[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9]\\.[0-9]+ 2 4"
+}
+
+@test "gpiowatch: with custom format (double percent sign)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --event=requested "--format=start%%end" \
+ -c $sim0 4
+ dut_flush
+
+ request_release_line $sim0 4
+ dut_read
+ output_is "start%end"
+}
+
+@test "gpiowatch: with custom format (double percent sign + event type specifier)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --event=requested "--format=%%e" -c $sim0 4
+ dut_flush
+
+ request_release_line $sim0 4
+ dut_read
+ output_is "%e"
+}
+
+@test "gpiowatch: with custom format (single percent sign)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --event=requested "--format=%" -c $sim0 4
+ dut_flush
+
+ request_release_line $sim0 4
+ dut_read
+ output_is "%"
+}
+
+@test "gpiowatch: with custom format (single percent sign between other characters)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --event=requested "--format=foo % bar" -c $sim0 4
+ dut_flush
+
+ request_release_line $sim0 4
+ dut_read
+ output_is "foo % bar"
+}
+
+@test "gpiowatch: with custom format (unknown specifier)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiowatch --banner --event=requested "--format=%x" -c $sim0 4
+ dut_flush
+
+ request_release_line $sim0 4
+ dut_read
+ output_is "%x"
+}
--
2.38.0
^ permalink raw reply related [flat|nested] 16+ messages in thread
* Re: [libgpiod v2][PATCH v3 2/5] tools: line name focussed rework
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 2/5] tools: line name focussed rework Kent Gibson
@ 2022-11-08 13:13 ` Bartosz Golaszewski
2022-11-08 15:33 ` Kent Gibson
0 siblings, 1 reply; 16+ messages in thread
From: Bartosz Golaszewski @ 2022-11-08 13:13 UTC (permalink / raw)
To: Kent Gibson; +Cc: linux-gpio
On Tue, Oct 11, 2022 at 2:29 AM Kent Gibson <warthog618@gmail.com> wrote:
>
> Rework the tool suite to support identifying lines by name and to
> support operating on the GPIO lines available to the user at once, rather
> than on one particular GPIO chip.
>
> All tools, other than gpiodetect, now provide the name to (chip,offset)
> mapping that was previously only performed by gpiofind. As names are not
> guaranteed to be unique, a --strict option is provided for all tools to
> either abort the operation or report all lines with the matching name, as
> appropriate.
> By default the tools operate on the first line found with a matching name.
>
> Selection of line by (chip,offset) is still supported with a --chip
> option, though it restricts the scope of the operation to an individual
> chip. When the --chip option is specified, the lines are assumed to be
> identified by offset where they parse as an integer, else by name.
> To cater for the unusual case where a line name parses as an integer,
> but is different from the offset, the --by-name option forces the lines
> to be identified by name.
>
> The updated tools are intentionally NOT backwardly compatible with the
> previous tools. Using old command lines with the updated tools will
> almost certainly fail, though migrating old command lines is generally as
> simple as adding a '-c' before the chip.
>
While at it: how about adding the --consumer/-C switch to specify a
consumer string other than the name of the program?
> In addition the individual tools are modified as follows:
>
> gpiodetect:
>
> Add the option to select individual chips.
>
> gpioinfo:
>
> Change the focus from chips to lines, so the scope can be
> an individual line, a subset of lines, all lines on a particular chip,
> or all the lines available to the user. For line scope a single line
> summary is output for each line. For chip scope the existing format
> displaying a summary of the chip and each of its lines is retained.
>
> Line attributes are consolidated into a list format, and are extended
> to cover all attributes supported by uAPI v2.
>
One change in the output that bothers me is the removal of quotation
marks around the line name and consumer. I did that in v1 to visually
distinguish between unnamed/unused lines and those that are named. I
know it's highly unlikely that a line would be named "unnamed" (sic!)
but still:
line 0: "foo"
line 1: unnamed
looks more intuitive to me. Same for the consumer as with your current
version, if the consumer string has spaces in it, it will look like
this: consumer=foo bar. I think consumer="foo bar" would be easier to
parse.
> gpioget:
>
> The default output format is becomes line=value, as per the
> input for gpioset, and the value is reported as active or inactive,
> rather than 0 or 1.
> The previous format is available using the --numeric option.
>
> Add an optional hold period between requesting a line and reading the
> value to allow the line to settle once the requested configuration has
> been applied (e.g. bias).
>
> gpiomon:
>
> Consolidate the edge options into a single option.
>
> Add a debounce period option.
>
> Add options to report event times as UTC or localtime.
>
> Add format specifiers for GPIO chip path, line name, stringified event
> type, and event time as a datetime.
>
> Rearrange default output format to place fields with more predicable
> widths to the left, and to separate major field groups with tabs.
> Lines are identified consistent with the command line.
>
> gpioset:
>
> Add a hold period option that specifies the minimum period the line
> value must be held for. This applies to all set options.
>
> Support line values specified as active/inactive, on/off and
> true/false, as well as 1/0.
>
> Add a toggle option that specifies a time sequence over which the
> requested lines should be toggled. If the sequence is 0 terminated then
> gpioset exits when the sequence completes, else it repeats the sequence.
> This allows for anything from simple blinkers to bit bashing from the
> command line. e.g. gpioset -t 500ms LED=on
>
> Add an interactive option to provide a shell-like interface to allow
> manual or scripted manipulation of requested lines. A basic command set
> allows lines to be get, set, or toggled, and to insert sleeps between
> operations.
>
As discussed elsewhere - it would be great if this part was optional
and configurable at build-time so that the dependency on libedit could
be dropped if unavailable.
> Remove the --mode, --sec, and --usec options.
> The combination of hold period and interactive mode provide functionality
> equivalent to the old --mode options.
>
I have one problem with that - I think the basic functionality of:
"take a line, set its value and wait for a signal" would still be
useful. As it is now, I'm not sure how to make gpioset just hold a
line without calling the GPIO_V2_LINE_SET_VALUES_IOCTL ioctl
periodically.
> Signed-off-by: Kent Gibson <warthog618@gmail.com>
> ---
> configure.ac | 8 +-
> tools/Makefile.am | 2 +-
> tools/gpiodetect.c | 113 +++++-
> tools/gpioget.c | 204 ++++++++++-
> tools/gpioinfo.c | 223 +++++++++++-
> tools/gpiomon.c | 450 +++++++++++++++++++++++-
> tools/gpioset.c | 815 ++++++++++++++++++++++++++++++++++++++++++-
> tools/tools-common.c | 713 ++++++++++++++++++++++++++++++++++++-
> tools/tools-common.h | 99 +++++-
> 9 files changed, 2585 insertions(+), 42 deletions(-)
>
> diff --git a/configure.ac b/configure.ac
> index 6ac1d8e..c8033c5 100644
> --- a/configure.ac
> +++ b/configure.ac
> @@ -106,14 +106,14 @@ AC_DEFUN([FUNC_NOT_FOUND_TOOLS],
> AC_DEFUN([HEADER_NOT_FOUND_TOOLS],
> [ERR_NOT_FOUND([$1 header], [tools])])
>
> +AC_DEFUN([LIB_NOT_FOUND_TOOLS],
> + [ERR_NOT_FOUND([lib$1], [tools])])
> +
> if test "x$with_tools" = xtrue
> then
> # These are only needed to build tools
> - AC_CHECK_FUNC([basename], [], [FUNC_NOT_FOUND_TOOLS([basename])])
> AC_CHECK_FUNC([daemon], [], [FUNC_NOT_FOUND_TOOLS([daemon])])
> - AC_CHECK_FUNC([signalfd], [], [FUNC_NOT_FOUND_TOOLS([signalfd])])
> - AC_CHECK_FUNC([setlinebuf], [], [FUNC_NOT_FOUND_TOOLS([setlinebuf])])
> - AC_CHECK_HEADERS([sys/signalfd.h], [], [HEADER_NOT_FOUND_TOOLS([sys/signalfd.h])])
> + PKG_CHECK_MODULES(LIBEDIT, libedit)
> fi
>
> AC_ARG_ENABLE([tests],
> diff --git a/tools/Makefile.am b/tools/Makefile.am
> index fc074b9..c956314 100644
> --- a/tools/Makefile.am
> +++ b/tools/Makefile.am
> @@ -7,7 +7,7 @@ AM_CFLAGS += -Wall -Wextra -g -std=gnu89
> noinst_LTLIBRARIES = libtools-common.la
> libtools_common_la_SOURCES = tools-common.c tools-common.h
>
> -LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la
> +LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la $(LIBEDIT_LIBS)
>
> bin_PROGRAMS = gpiodetect gpioinfo gpioget gpioset gpiomon
>
> diff --git a/tools/gpiodetect.c b/tools/gpiodetect.c
> index 30bde32..910fe9e 100644
> --- a/tools/gpiodetect.c
> +++ b/tools/gpiodetect.c
> @@ -1,8 +1,7 @@
> // SPDX-License-Identifier: GPL-2.0-or-later
> // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
> +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
>
> -#include <dirent.h>
> -#include <errno.h>
> #include <getopt.h>
> #include <gpiod.h>
> #include <stdio.h>
> @@ -11,3 +10,113 @@
>
> #include "tools-common.h"
>
> +static void print_help(void)
> +{
> + printf("Usage: %s [OPTIONS] [chip]...\n", get_progname());
> + printf("\n");
> + printf("List GPIO chips, print their labels and number of GPIO lines.\n");
> + printf("\n");
> + printf("Chips may be identified by number, name, or path.\n");
> + printf("e.g. '0', 'gpiochip0', and '/dev/gpiochip0' all refer to the same chip.\n");
> + printf("\n");
> + printf("If no chips are specified then all chips are listed.\n");
> + printf("\n");
> + printf("Options:\n");
> + printf(" -h, --help\t\tdisplay this help and exit\n");
> + printf(" -v, --version\t\toutput version information and exit\n");
> +}
> +
> +int parse_config(int argc, char **argv)
> +{
> + int optc, opti;
> + const char *const shortopts = "+hv";
> + const struct option longopts[] = {
> + { "help", no_argument, NULL, 'h' },
> + { "version", no_argument, NULL, 'v' },
> + { GETOPT_NULL_LONGOPT },
> + };
This can be static as there are no addresses of flag variables assigned.
> +
> + for (;;) {
> + optc = getopt_long(argc, argv, shortopts, longopts, &opti);
> + if (optc < 0)
> + break;
> +
> + switch (optc) {
> + case 'h':
> + print_help();
> + exit(EXIT_SUCCESS);
> + case 'v':
> + print_version();
> + exit(EXIT_SUCCESS);
> + case '?':
> + die("try %s --help", get_progname());
> + default:
> + abort();
> + }
> + }
> + return optind;
> +}
> +
> +int print_chip_info(const char *path)
> +{
> + struct gpiod_chip *chip;
> + struct gpiod_chip_info *info;
> +
> + chip = gpiod_chip_open(path);
> + if (!chip) {
> + print_perror("unable to open chip '%s'", path);
> + return 1;
> + }
> +
> + info = gpiod_chip_get_info(chip);
> + if (!info)
> + die_perror("unable to read info for '%s'", path);
> +
> + printf("%s [%s] (%zu lines)\n",
> + gpiod_chip_info_get_name(info),
> + gpiod_chip_info_get_label(info),
> + gpiod_chip_info_get_num_lines(info));
> +
> + gpiod_chip_info_free(info);
> + gpiod_chip_close(chip);
> + return 0;
> +}
> +
> +int main(int argc, char **argv)
> +{
> + int num_chips, i;
> + char **paths;
> + char *path;
> + int ret = EXIT_SUCCESS;
> +
> + i = parse_config(argc, argv);
> + argc -= i;
> + argv += i;
> +
> + if (argc == 0) {
> + num_chips = all_chip_paths(&paths);
> + for (i = 0; i < num_chips; i++) {
> + if (print_chip_info(paths[i]))
> + ret = EXIT_FAILURE;
> +
> + free(paths[i]);
> + }
> + free(paths);
> + }
> +
> + for (i = 0; i < argc; i++) {
> + if (chip_path_lookup(argv[i], &path)) {
> + if (print_chip_info(path))
> + ret = EXIT_FAILURE;
> +
> + free(path);
> + } else {
> + print_error(
> + "cannot find GPIO chip character device '%s'",
> + argv[i]);
> + ret = EXIT_FAILURE;
> + }
> + }
> +
> + return ret;
> +}
> diff --git a/tools/gpioget.c b/tools/gpioget.c
> index 1b3e666..7a26066 100644
> --- a/tools/gpioget.c
> +++ b/tools/gpioget.c
> @@ -1,12 +1,214 @@
> // SPDX-License-Identifier: GPL-2.0-or-later
> // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
> +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
>
> #include <getopt.h>
> #include <gpiod.h>
> -#include <limits.h>
> #include <stdio.h>
> #include <stdlib.h>
> #include <string.h>
> +#include <unistd.h>
>
> #include "tools-common.h"
>
> +static void print_help(void)
> +{
> + printf("Usage: %s [OPTIONS] <line>...\n", get_progname());
> + printf("\n");
> + printf("Read values of GPIO lines.\n");
> + printf("\n");
> + printf("Lines are specified by name, or optionally by offset if the chip option\n");
> + printf("is provided.\n");
> + printf("\n");
> + printf("Options:\n");
> + printf(" -a, --as-is\t\tleave the line direction unchanged, not forced to input\n");
> + print_bias_help();
> + printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n");
> + printf(" -c, --chip <chip>\trestrict scope to a particular chip\n");
> + printf(" -h, --help\t\tdisplay this help and exit\n");
> + printf(" -l, --active-low\ttreat the line as active low\n");
> + printf(" -p, --hold-period <period>\n");
> + printf("\t\t\twait between requesting the lines and reading the values\n");
> + printf(" --numeric\t\tdisplay line values as '0' (inactive) or '1' (active)\n");
> + printf(" -s, --strict\t\tabort if requested line names are not unique\n");
> + printf(" -v, --version\t\toutput version information and exit\n");
> + print_chip_help();
> + print_period_help();
> +}
> +struct config {
> + bool active_low;
> + bool strict;
> + int bias;
> + int direction;
> + unsigned int hold_period_us;
> + const char *chip_id;
> + int by_name;
> + int numeric;
> +};
> +
> +int parse_config(int argc, char **argv, struct config *cfg)
> +{
> + int opti, optc;
> + const char *const shortopts = "+ab:c:hlp:sv";
> + const struct option longopts[] = {
> + { "active-low", no_argument, NULL, 'l' },
> + { "as-is", no_argument, NULL, 'a' },
> + { "bias", required_argument, NULL, 'b' },
> + { "by-name", no_argument, &cfg->by_name, 1 },
> + { "chip", required_argument, NULL, 'c' },
> + { "help", no_argument, NULL, 'h' },
> + { "hold-period", required_argument, NULL, 'p' },
> + { "numeric", no_argument, &cfg->numeric, 1 },
> + { "strict", no_argument, NULL, 's' },
> + { "version", no_argument, NULL, 'v' },
> + { GETOPT_NULL_LONGOPT },
> + };
> +
> + memset(cfg, 0, sizeof(*cfg));
> + cfg->direction = GPIOD_LINE_DIRECTION_INPUT;
> +
> + for (;;) {
> + optc = getopt_long(argc, argv, shortopts, longopts, &opti);
> + if (optc < 0)
> + break;
> +
> + switch (optc) {
> + case 'a':
> + cfg->direction = GPIOD_LINE_DIRECTION_AS_IS;
> + break;
> + case 'b':
> + cfg->bias = parse_bias_or_die(optarg);
> + break;
> + case 'c':
> + cfg->chip_id = optarg;
> + break;
> + case 'l':
> + cfg->active_low = true;
> + break;
> + case 'p':
> + cfg->hold_period_us = parse_period_or_die(optarg);
> + break;
> + case 's':
> + cfg->strict = true;
> + break;
> + case 'h':
> + print_help();
> + exit(EXIT_SUCCESS);
> + case 'v':
> + print_version();
> + exit(EXIT_SUCCESS);
> + case '?':
> + die("try %s --help", get_progname());
> + case 0:
> + break;
> + default:
> + abort();
> + }
> + }
> +
> + return optind;
> +}
> +
> +int main(int argc, char **argv)
> +{
> + int i, num_lines, ret, *values;
> + struct gpiod_line_settings *settings;
> + struct gpiod_request_config *req_cfg;
> + struct gpiod_line_request *request;
> + struct gpiod_line_config *line_cfg;
> + struct gpiod_chip *chip;
> + unsigned int *offsets;
> + struct line_resolver *resolver;
> + struct resolved_line *line;
> + struct config cfg;
> +
> + i = parse_config(argc, argv, &cfg);
> + argc -= i;
> + argv += i;
> +
> + if (argc < 1)
> + die("at least one GPIO line must be specified");
> +
> + resolver = resolve_lines(argc, argv, cfg.chip_id, cfg.strict,
> + cfg.by_name);
> + validate_resolution(resolver, cfg.chip_id);
> +
> + offsets = calloc(resolver->num_lines, sizeof(*offsets));
> + values = calloc(resolver->num_lines, sizeof(*values));
> + if (!offsets || !values)
> + die("out of memory");
> +
> + settings = gpiod_line_settings_new();
> + if (!settings)
> + die_perror("unable to allocate line settings");
> +
> + gpiod_line_settings_set_direction(settings, cfg.direction);
> +
> + if (cfg.bias)
> + gpiod_line_settings_set_bias(settings, cfg.bias);
> +
> + if (cfg.active_low)
> + gpiod_line_settings_set_active_low(settings, true);
> +
> + req_cfg = gpiod_request_config_new();
> + if (!req_cfg)
> + die_perror("unable to allocate the request config structure");
> +
> + line_cfg = gpiod_line_config_new();
> + if (!line_cfg)
> + die_perror("unable to allocate the line config structure");
> +
> + gpiod_request_config_set_consumer(req_cfg, "gpioget");
> + for (i = 0; i < resolver->num_chips; i++) {
> + chip = gpiod_chip_open(resolver->chips[i].path);
> + if (!chip)
> + die_perror("unable to open chip '%s'",
> + resolver->chips[i].path);
> +
> + num_lines = get_line_offsets_and_values(resolver, i, offsets,
> + NULL);
> +
> + gpiod_line_config_reset(line_cfg);
> + ret = gpiod_line_config_add_line_settings(line_cfg, offsets,
> + num_lines, settings);
> + if (ret)
> + die_perror("unable to add line settings");
> +
> + request = gpiod_chip_request_lines(chip, req_cfg, line_cfg);
> + if (!request)
> + die_perror("unable to request lines");
> +
> + if (cfg.hold_period_us)
> + usleep(cfg.hold_period_us);
> +
> + ret = gpiod_line_request_get_values(request, values);
> + if (ret)
> + die_perror("unable to read GPIO line values");
> +
> + set_line_values(resolver, i, values);
> +
> + gpiod_line_request_release(request);
> + gpiod_chip_close(chip);
> + }
> + for (i = 0; i < resolver->num_lines; i++) {
> + line = &resolver->lines[i];
> + if (cfg.numeric)
> + printf("%d", line->value);
> + else
> + printf("%s=%s", line->id,
> + line->value ? "active" : "inactive");
> +
> + if (i != resolver->num_lines - 1)
> + printf(" ");
> + }
> + printf("\n");
> +
> + free_line_resolver(resolver);
> + gpiod_request_config_free(req_cfg);
> + gpiod_line_config_free(line_cfg);
> + gpiod_line_settings_free(settings);
> + free(offsets);
> + free(values);
> +
> + return EXIT_SUCCESS;
> +}
> diff --git a/tools/gpioinfo.c b/tools/gpioinfo.c
> index ae368fa..5dc28f8 100644
> --- a/tools/gpioinfo.c
> +++ b/tools/gpioinfo.c
> @@ -1,8 +1,7 @@
> // SPDX-License-Identifier: GPL-2.0-or-later
> // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
> +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
>
> -#include <dirent.h>
> -#include <errno.h>
> #include <getopt.h>
> #include <gpiod.h>
> #include <stdarg.h>
> @@ -12,3 +11,223 @@
>
> #include "tools-common.h"
>
> +static void print_help(void)
> +{
> + printf("Usage: %s [OPTIONS] [line]...\n", get_progname());
> + printf("\n");
> + printf("Print information about GPIO lines.\n");
> + printf("\n");
> + printf("Lines are specified by name, or optionally by offset if the chip option\n");
> + printf("is provided.\n");
> + printf("\n");
> + printf("If no lines are specified than all lines are displayed.\n");
> + printf("\n");
> + printf("Options:\n");
> + printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n");
> + printf(" -c, --chip <chip>\trestrict scope to a particular chip\n");
> + printf(" -h, --help\t\tdisplay this help and exit\n");
> + printf(" -s, --strict\t\tcheck all lines - don't assume line names are unique\n");
> + printf(" -v, --version\t\toutput version information and exit\n");
> + print_chip_help();
> +}
> +
> +struct config {
> + bool strict;
> + const char *chip_id;
> + int by_name;
> +};
> +
> +int parse_config(int argc, char **argv, struct config *cfg)
> +{
> + int opti, optc;
> + const char *const shortopts = "+c:hsv";
> + const struct option longopts[] = {
> + { "by-name", no_argument, &cfg->by_name, 1 },
> + { "chip", required_argument, NULL, 'c' },
> + { "help", no_argument, NULL, 'h' },
> + { "strict", no_argument, NULL, 's' },
> + { "version", no_argument, NULL, 'v' },
> + { GETOPT_NULL_LONGOPT },
> + };
> +
> + memset(cfg, 0, sizeof(*cfg));
> +
> + for (;;) {
> + optc = getopt_long(argc, argv, shortopts, longopts, &opti);
> + if (optc < 0)
> + break;
> +
> + switch (optc) {
> + case 'c':
> + cfg->chip_id = optarg;
> + break;
> + case 's':
> + cfg->strict = true;
> + break;
> + case 'h':
> + print_help();
> + exit(EXIT_SUCCESS);
> + case 'v':
> + print_version();
> + exit(EXIT_SUCCESS);
> + case '?':
> + die("try %s --help", get_progname());
> + case 0:
> + break;
> + default:
> + abort();
> + }
> + }
> +
> + return optind;
> +}
> +
> +
> +// minimal version similar to tools-common that indicates if a line should be
> +// printed rather than storing details into the resolver.
> +// Does not die on non-unique lines.
C-style comments only please. Same elsewhere.
<snip>
I like the new tools in general. I don't have many issues with the
code - you are a much better coder than I am. I would change the
coding style here and there but I will probably just spend some time
on a good clang-format config and use it indiscriminately like I did
with black for Python.
Bart
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [libgpiod v2][PATCH v3 4/5] tools: add gpiowatch
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 4/5] tools: add gpiowatch Kent Gibson
@ 2022-11-08 15:00 ` Bartosz Golaszewski
2022-11-08 15:38 ` Kent Gibson
0 siblings, 1 reply; 16+ messages in thread
From: Bartosz Golaszewski @ 2022-11-08 15:00 UTC (permalink / raw)
To: Kent Gibson; +Cc: linux-gpio
On Tue, Oct 11, 2022 at 2:29 AM Kent Gibson <warthog618@gmail.com> wrote:
>
> Add a gpiowatch tool, based on gpiomon, to report line info change
> events read from chip file descriptors.
>
> Inspired by the gpio-watch tool in the linux kernel, but with gpiomon
> features such as custom formatted output, filtering events of
> interest and exiting after a number of events, so more useful for
> scripting.
>
> Default output is minimalist, so just time, event type and line id.
> Full event details are available using the custom formatted output.
>
> Signed-off-by: Kent Gibson <warthog618@gmail.com>
> ---
>
> Changes v2 -> v3:
> - Minimise the default output to more closely match gpiomon.
> - Add --format option for when more detail is required.
> - Add --num-events option to exit after a number of events.
> - Add --event option to report only specific event types.
> - Add --quiet option to not print events.
> - fix monotonic to realtime conversion on 32 bit platforms.
>
Nice and clean, I don't have any issues other than the regular
coding-style bikeshedding.
What happened to the idea we've been floating about creating a single,
busyboxy executable with links rather than separate executables? Have
we ever agreed on it?
Bart
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [libgpiod v2][PATCH v3 2/5] tools: line name focussed rework
2022-11-08 13:13 ` Bartosz Golaszewski
@ 2022-11-08 15:33 ` Kent Gibson
2022-11-08 18:25 ` Bartosz Golaszewski
0 siblings, 1 reply; 16+ messages in thread
From: Kent Gibson @ 2022-11-08 15:33 UTC (permalink / raw)
To: Bartosz Golaszewski; +Cc: linux-gpio
On Tue, Nov 08, 2022 at 02:13:20PM +0100, Bartosz Golaszewski wrote:
> On Tue, Oct 11, 2022 at 2:29 AM Kent Gibson <warthog618@gmail.com> wrote:
> >
> > Rework the tool suite to support identifying lines by name and to
> > support operating on the GPIO lines available to the user at once, rather
> > than on one particular GPIO chip.
> >
> > All tools, other than gpiodetect, now provide the name to (chip,offset)
> > mapping that was previously only performed by gpiofind. As names are not
> > guaranteed to be unique, a --strict option is provided for all tools to
> > either abort the operation or report all lines with the matching name, as
> > appropriate.
> > By default the tools operate on the first line found with a matching name.
> >
> > Selection of line by (chip,offset) is still supported with a --chip
> > option, though it restricts the scope of the operation to an individual
> > chip. When the --chip option is specified, the lines are assumed to be
> > identified by offset where they parse as an integer, else by name.
> > To cater for the unusual case where a line name parses as an integer,
> > but is different from the offset, the --by-name option forces the lines
> > to be identified by name.
> >
> > The updated tools are intentionally NOT backwardly compatible with the
> > previous tools. Using old command lines with the updated tools will
> > almost certainly fail, though migrating old command lines is generally as
> > simple as adding a '-c' before the chip.
> >
>
> While at it: how about adding the --consumer/-C switch to specify a
> consumer string other than the name of the program?
>
Ironically I added that to the Rust version, for the long lived
commands anyway, so it could better emulate the C version for testing
purposes.
But could be generally useful, so ok.
I only used the long form there to avoid confusion with -c (as they are
visually very similar) and following the principle that rarely used
options only get a long form, so I will omit the short -C option - unless
you insist.
> > In addition the individual tools are modified as follows:
> >
> > gpiodetect:
> >
> > Add the option to select individual chips.
> >
> > gpioinfo:
> >
> > Change the focus from chips to lines, so the scope can be
> > an individual line, a subset of lines, all lines on a particular chip,
> > or all the lines available to the user. For line scope a single line
> > summary is output for each line. For chip scope the existing format
> > displaying a summary of the chip and each of its lines is retained.
> >
> > Line attributes are consolidated into a list format, and are extended
> > to cover all attributes supported by uAPI v2.
> >
>
> One change in the output that bothers me is the removal of quotation
> marks around the line name and consumer. I did that in v1 to visually
> distinguish between unnamed/unused lines and those that are named. I
> know it's highly unlikely that a line would be named "unnamed" (sic!)
> but still:
>
> line 0: "foo"
> line 1: unnamed
>
> looks more intuitive to me.
I disagree on this one. In the longer term all lines should be named
and then the quotes just become pointless noise, and require more
work to parse.
>Same for the consumer as with your current
> version, if the consumer string has spaces in it, it will look like
> this: consumer=foo bar. I think consumer="foo bar" would be easier to
> parse.
For this very reason, the consumer is explicitly listed last, so the
consumer name matches everything between the "consumer=" and end of
line.
Unless consumer names with spaces are very common in the wild then
quotes only add more clutter.
>
> > gpioget:
> >
> > The default output format is becomes line=value, as per the
> > input for gpioset, and the value is reported as active or inactive,
> > rather than 0 or 1.
> > The previous format is available using the --numeric option.
> >
> > Add an optional hold period between requesting a line and reading the
> > value to allow the line to settle once the requested configuration has
> > been applied (e.g. bias).
> >
> > gpiomon:
> >
> > Consolidate the edge options into a single option.
> >
> > Add a debounce period option.
> >
> > Add options to report event times as UTC or localtime.
> >
> > Add format specifiers for GPIO chip path, line name, stringified event
> > type, and event time as a datetime.
> >
> > Rearrange default output format to place fields with more predicable
> > widths to the left, and to separate major field groups with tabs.
> > Lines are identified consistent with the command line.
> >
> > gpioset:
> >
> > Add a hold period option that specifies the minimum period the line
> > value must be held for. This applies to all set options.
> >
> > Support line values specified as active/inactive, on/off and
> > true/false, as well as 1/0.
> >
> > Add a toggle option that specifies a time sequence over which the
> > requested lines should be toggled. If the sequence is 0 terminated then
> > gpioset exits when the sequence completes, else it repeats the sequence.
> > This allows for anything from simple blinkers to bit bashing from the
> > command line. e.g. gpioset -t 500ms LED=on
> >
> > Add an interactive option to provide a shell-like interface to allow
> > manual or scripted manipulation of requested lines. A basic command set
> > allows lines to be get, set, or toggled, and to insert sleeps between
> > operations.
> >
>
> As discussed elsewhere - it would be great if this part was optional
> and configurable at build-time so that the dependency on libedit could
> be dropped if unavailable.
>
Agreed.
> > Remove the --mode, --sec, and --usec options.
> > The combination of hold period and interactive mode provide functionality
> > equivalent to the old --mode options.
> >
>
> I have one problem with that - I think the basic functionality of:
> "take a line, set its value and wait for a signal" would still be
> useful. As it is now, I'm not sure how to make gpioset just hold a
> line without calling the GPIO_V2_LINE_SET_VALUES_IOCTL ioctl
> periodically.
>
I forgot to mention the daemonize option here, so
gpioset -z myline=1
will do that.
(or
gpioset -i myline=1
if you want to keep the process in the foreground.)
I'll add something to the daemonize help to highlight that it will hold
the line until killed. Is that sufficient?
> > Signed-off-by: Kent Gibson <warthog618@gmail.com>
> > ---
> > configure.ac | 8 +-
> > tools/Makefile.am | 2 +-
> > tools/gpiodetect.c | 113 +++++-
> > tools/gpioget.c | 204 ++++++++++-
> > tools/gpioinfo.c | 223 +++++++++++-
> > tools/gpiomon.c | 450 +++++++++++++++++++++++-
> > tools/gpioset.c | 815 ++++++++++++++++++++++++++++++++++++++++++-
> > tools/tools-common.c | 713 ++++++++++++++++++++++++++++++++++++-
> > tools/tools-common.h | 99 +++++-
> > 9 files changed, 2585 insertions(+), 42 deletions(-)
> >
> > diff --git a/configure.ac b/configure.ac
> > index 6ac1d8e..c8033c5 100644
> > --- a/configure.ac
> > +++ b/configure.ac
> > @@ -106,14 +106,14 @@ AC_DEFUN([FUNC_NOT_FOUND_TOOLS],
> > AC_DEFUN([HEADER_NOT_FOUND_TOOLS],
> > [ERR_NOT_FOUND([$1 header], [tools])])
> >
> > +AC_DEFUN([LIB_NOT_FOUND_TOOLS],
> > + [ERR_NOT_FOUND([lib$1], [tools])])
> > +
> > if test "x$with_tools" = xtrue
> > then
> > # These are only needed to build tools
> > - AC_CHECK_FUNC([basename], [], [FUNC_NOT_FOUND_TOOLS([basename])])
> > AC_CHECK_FUNC([daemon], [], [FUNC_NOT_FOUND_TOOLS([daemon])])
> > - AC_CHECK_FUNC([signalfd], [], [FUNC_NOT_FOUND_TOOLS([signalfd])])
> > - AC_CHECK_FUNC([setlinebuf], [], [FUNC_NOT_FOUND_TOOLS([setlinebuf])])
> > - AC_CHECK_HEADERS([sys/signalfd.h], [], [HEADER_NOT_FOUND_TOOLS([sys/signalfd.h])])
> > + PKG_CHECK_MODULES(LIBEDIT, libedit)
> > fi
> >
> > AC_ARG_ENABLE([tests],
> > diff --git a/tools/Makefile.am b/tools/Makefile.am
> > index fc074b9..c956314 100644
> > --- a/tools/Makefile.am
> > +++ b/tools/Makefile.am
> > @@ -7,7 +7,7 @@ AM_CFLAGS += -Wall -Wextra -g -std=gnu89
> > noinst_LTLIBRARIES = libtools-common.la
> > libtools_common_la_SOURCES = tools-common.c tools-common.h
> >
> > -LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la
> > +LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la $(LIBEDIT_LIBS)
> >
> > bin_PROGRAMS = gpiodetect gpioinfo gpioget gpioset gpiomon
> >
> > diff --git a/tools/gpiodetect.c b/tools/gpiodetect.c
> > index 30bde32..910fe9e 100644
> > --- a/tools/gpiodetect.c
> > +++ b/tools/gpiodetect.c
> > @@ -1,8 +1,7 @@
> > // SPDX-License-Identifier: GPL-2.0-or-later
> > // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
> > +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
> >
> > -#include <dirent.h>
> > -#include <errno.h>
> > #include <getopt.h>
> > #include <gpiod.h>
> > #include <stdio.h>
> > @@ -11,3 +10,113 @@
> >
> > #include "tools-common.h"
> >
> > +static void print_help(void)
> > +{
> > + printf("Usage: %s [OPTIONS] [chip]...\n", get_progname());
> > + printf("\n");
> > + printf("List GPIO chips, print their labels and number of GPIO lines.\n");
> > + printf("\n");
> > + printf("Chips may be identified by number, name, or path.\n");
> > + printf("e.g. '0', 'gpiochip0', and '/dev/gpiochip0' all refer to the same chip.\n");
> > + printf("\n");
> > + printf("If no chips are specified then all chips are listed.\n");
> > + printf("\n");
> > + printf("Options:\n");
> > + printf(" -h, --help\t\tdisplay this help and exit\n");
> > + printf(" -v, --version\t\toutput version information and exit\n");
> > +}
> > +
> > +int parse_config(int argc, char **argv)
> > +{
> > + int optc, opti;
> > + const char *const shortopts = "+hv";
> > + const struct option longopts[] = {
> > + { "help", no_argument, NULL, 'h' },
> > + { "version", no_argument, NULL, 'v' },
> > + { GETOPT_NULL_LONGOPT },
> > + };
>
> This can be static as there are no addresses of flag variables assigned.
>
Indeed - and now you mention it I notice a few other things that should be
static too.
> > +
> > + for (;;) {
> > + optc = getopt_long(argc, argv, shortopts, longopts, &opti);
> > + if (optc < 0)
> > + break;
> > +
> > + switch (optc) {
> > + case 'h':
> > + print_help();
> > + exit(EXIT_SUCCESS);
> > + case 'v':
> > + print_version();
> > + exit(EXIT_SUCCESS);
> > + case '?':
> > + die("try %s --help", get_progname());
> > + default:
> > + abort();
> > + }
> > + }
> > + return optind;
> > +}
> > +
> > +int print_chip_info(const char *path)
> > +{
> > + struct gpiod_chip *chip;
> > + struct gpiod_chip_info *info;
> > +
> > + chip = gpiod_chip_open(path);
> > + if (!chip) {
> > + print_perror("unable to open chip '%s'", path);
> > + return 1;
> > + }
> > +
> > + info = gpiod_chip_get_info(chip);
> > + if (!info)
> > + die_perror("unable to read info for '%s'", path);
> > +
> > + printf("%s [%s] (%zu lines)\n",
> > + gpiod_chip_info_get_name(info),
> > + gpiod_chip_info_get_label(info),
> > + gpiod_chip_info_get_num_lines(info));
> > +
> > + gpiod_chip_info_free(info);
> > + gpiod_chip_close(chip);
> > + return 0;
> > +}
> > +
> > +int main(int argc, char **argv)
> > +{
> > + int num_chips, i;
> > + char **paths;
> > + char *path;
> > + int ret = EXIT_SUCCESS;
> > +
> > + i = parse_config(argc, argv);
> > + argc -= i;
> > + argv += i;
> > +
> > + if (argc == 0) {
> > + num_chips = all_chip_paths(&paths);
> > + for (i = 0; i < num_chips; i++) {
> > + if (print_chip_info(paths[i]))
> > + ret = EXIT_FAILURE;
> > +
> > + free(paths[i]);
> > + }
> > + free(paths);
> > + }
> > +
> > + for (i = 0; i < argc; i++) {
> > + if (chip_path_lookup(argv[i], &path)) {
> > + if (print_chip_info(path))
> > + ret = EXIT_FAILURE;
> > +
> > + free(path);
> > + } else {
> > + print_error(
> > + "cannot find GPIO chip character device '%s'",
> > + argv[i]);
> > + ret = EXIT_FAILURE;
> > + }
> > + }
> > +
> > + return ret;
> > +}
> > diff --git a/tools/gpioget.c b/tools/gpioget.c
> > index 1b3e666..7a26066 100644
> > --- a/tools/gpioget.c
> > +++ b/tools/gpioget.c
> > @@ -1,12 +1,214 @@
> > // SPDX-License-Identifier: GPL-2.0-or-later
> > // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
> > +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
> >
> > #include <getopt.h>
> > #include <gpiod.h>
> > -#include <limits.h>
> > #include <stdio.h>
> > #include <stdlib.h>
> > #include <string.h>
> > +#include <unistd.h>
> >
> > #include "tools-common.h"
> >
> > +static void print_help(void)
> > +{
> > + printf("Usage: %s [OPTIONS] <line>...\n", get_progname());
> > + printf("\n");
> > + printf("Read values of GPIO lines.\n");
> > + printf("\n");
> > + printf("Lines are specified by name, or optionally by offset if the chip option\n");
> > + printf("is provided.\n");
> > + printf("\n");
> > + printf("Options:\n");
> > + printf(" -a, --as-is\t\tleave the line direction unchanged, not forced to input\n");
> > + print_bias_help();
> > + printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n");
> > + printf(" -c, --chip <chip>\trestrict scope to a particular chip\n");
> > + printf(" -h, --help\t\tdisplay this help and exit\n");
> > + printf(" -l, --active-low\ttreat the line as active low\n");
> > + printf(" -p, --hold-period <period>\n");
> > + printf("\t\t\twait between requesting the lines and reading the values\n");
> > + printf(" --numeric\t\tdisplay line values as '0' (inactive) or '1' (active)\n");
> > + printf(" -s, --strict\t\tabort if requested line names are not unique\n");
> > + printf(" -v, --version\t\toutput version information and exit\n");
> > + print_chip_help();
> > + print_period_help();
> > +}
> > +struct config {
> > + bool active_low;
> > + bool strict;
> > + int bias;
> > + int direction;
> > + unsigned int hold_period_us;
> > + const char *chip_id;
> > + int by_name;
> > + int numeric;
> > +};
> > +
> > +int parse_config(int argc, char **argv, struct config *cfg)
> > +{
> > + int opti, optc;
> > + const char *const shortopts = "+ab:c:hlp:sv";
> > + const struct option longopts[] = {
> > + { "active-low", no_argument, NULL, 'l' },
> > + { "as-is", no_argument, NULL, 'a' },
> > + { "bias", required_argument, NULL, 'b' },
> > + { "by-name", no_argument, &cfg->by_name, 1 },
> > + { "chip", required_argument, NULL, 'c' },
> > + { "help", no_argument, NULL, 'h' },
> > + { "hold-period", required_argument, NULL, 'p' },
> > + { "numeric", no_argument, &cfg->numeric, 1 },
> > + { "strict", no_argument, NULL, 's' },
> > + { "version", no_argument, NULL, 'v' },
> > + { GETOPT_NULL_LONGOPT },
> > + };
> > +
> > + memset(cfg, 0, sizeof(*cfg));
> > + cfg->direction = GPIOD_LINE_DIRECTION_INPUT;
> > +
> > + for (;;) {
> > + optc = getopt_long(argc, argv, shortopts, longopts, &opti);
> > + if (optc < 0)
> > + break;
> > +
> > + switch (optc) {
> > + case 'a':
> > + cfg->direction = GPIOD_LINE_DIRECTION_AS_IS;
> > + break;
> > + case 'b':
> > + cfg->bias = parse_bias_or_die(optarg);
> > + break;
> > + case 'c':
> > + cfg->chip_id = optarg;
> > + break;
> > + case 'l':
> > + cfg->active_low = true;
> > + break;
> > + case 'p':
> > + cfg->hold_period_us = parse_period_or_die(optarg);
> > + break;
> > + case 's':
> > + cfg->strict = true;
> > + break;
> > + case 'h':
> > + print_help();
> > + exit(EXIT_SUCCESS);
> > + case 'v':
> > + print_version();
> > + exit(EXIT_SUCCESS);
> > + case '?':
> > + die("try %s --help", get_progname());
> > + case 0:
> > + break;
> > + default:
> > + abort();
> > + }
> > + }
> > +
> > + return optind;
> > +}
> > +
> > +int main(int argc, char **argv)
> > +{
> > + int i, num_lines, ret, *values;
> > + struct gpiod_line_settings *settings;
> > + struct gpiod_request_config *req_cfg;
> > + struct gpiod_line_request *request;
> > + struct gpiod_line_config *line_cfg;
> > + struct gpiod_chip *chip;
> > + unsigned int *offsets;
> > + struct line_resolver *resolver;
> > + struct resolved_line *line;
> > + struct config cfg;
> > +
> > + i = parse_config(argc, argv, &cfg);
> > + argc -= i;
> > + argv += i;
> > +
> > + if (argc < 1)
> > + die("at least one GPIO line must be specified");
> > +
> > + resolver = resolve_lines(argc, argv, cfg.chip_id, cfg.strict,
> > + cfg.by_name);
> > + validate_resolution(resolver, cfg.chip_id);
> > +
> > + offsets = calloc(resolver->num_lines, sizeof(*offsets));
> > + values = calloc(resolver->num_lines, sizeof(*values));
> > + if (!offsets || !values)
> > + die("out of memory");
> > +
> > + settings = gpiod_line_settings_new();
> > + if (!settings)
> > + die_perror("unable to allocate line settings");
> > +
> > + gpiod_line_settings_set_direction(settings, cfg.direction);
> > +
> > + if (cfg.bias)
> > + gpiod_line_settings_set_bias(settings, cfg.bias);
> > +
> > + if (cfg.active_low)
> > + gpiod_line_settings_set_active_low(settings, true);
> > +
> > + req_cfg = gpiod_request_config_new();
> > + if (!req_cfg)
> > + die_perror("unable to allocate the request config structure");
> > +
> > + line_cfg = gpiod_line_config_new();
> > + if (!line_cfg)
> > + die_perror("unable to allocate the line config structure");
> > +
> > + gpiod_request_config_set_consumer(req_cfg, "gpioget");
> > + for (i = 0; i < resolver->num_chips; i++) {
> > + chip = gpiod_chip_open(resolver->chips[i].path);
> > + if (!chip)
> > + die_perror("unable to open chip '%s'",
> > + resolver->chips[i].path);
> > +
> > + num_lines = get_line_offsets_and_values(resolver, i, offsets,
> > + NULL);
> > +
> > + gpiod_line_config_reset(line_cfg);
> > + ret = gpiod_line_config_add_line_settings(line_cfg, offsets,
> > + num_lines, settings);
> > + if (ret)
> > + die_perror("unable to add line settings");
> > +
> > + request = gpiod_chip_request_lines(chip, req_cfg, line_cfg);
> > + if (!request)
> > + die_perror("unable to request lines");
> > +
> > + if (cfg.hold_period_us)
> > + usleep(cfg.hold_period_us);
> > +
> > + ret = gpiod_line_request_get_values(request, values);
> > + if (ret)
> > + die_perror("unable to read GPIO line values");
> > +
> > + set_line_values(resolver, i, values);
> > +
> > + gpiod_line_request_release(request);
> > + gpiod_chip_close(chip);
> > + }
> > + for (i = 0; i < resolver->num_lines; i++) {
> > + line = &resolver->lines[i];
> > + if (cfg.numeric)
> > + printf("%d", line->value);
> > + else
> > + printf("%s=%s", line->id,
> > + line->value ? "active" : "inactive");
> > +
> > + if (i != resolver->num_lines - 1)
> > + printf(" ");
> > + }
> > + printf("\n");
> > +
> > + free_line_resolver(resolver);
> > + gpiod_request_config_free(req_cfg);
> > + gpiod_line_config_free(line_cfg);
> > + gpiod_line_settings_free(settings);
> > + free(offsets);
> > + free(values);
> > +
> > + return EXIT_SUCCESS;
> > +}
> > diff --git a/tools/gpioinfo.c b/tools/gpioinfo.c
> > index ae368fa..5dc28f8 100644
> > --- a/tools/gpioinfo.c
> > +++ b/tools/gpioinfo.c
> > @@ -1,8 +1,7 @@
> > // SPDX-License-Identifier: GPL-2.0-or-later
> > // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
> > +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
> >
> > -#include <dirent.h>
> > -#include <errno.h>
> > #include <getopt.h>
> > #include <gpiod.h>
> > #include <stdarg.h>
> > @@ -12,3 +11,223 @@
> >
> > #include "tools-common.h"
> >
> > +static void print_help(void)
> > +{
> > + printf("Usage: %s [OPTIONS] [line]...\n", get_progname());
> > + printf("\n");
> > + printf("Print information about GPIO lines.\n");
> > + printf("\n");
> > + printf("Lines are specified by name, or optionally by offset if the chip option\n");
> > + printf("is provided.\n");
> > + printf("\n");
> > + printf("If no lines are specified than all lines are displayed.\n");
> > + printf("\n");
> > + printf("Options:\n");
> > + printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n");
> > + printf(" -c, --chip <chip>\trestrict scope to a particular chip\n");
> > + printf(" -h, --help\t\tdisplay this help and exit\n");
> > + printf(" -s, --strict\t\tcheck all lines - don't assume line names are unique\n");
> > + printf(" -v, --version\t\toutput version information and exit\n");
> > + print_chip_help();
> > +}
> > +
> > +struct config {
> > + bool strict;
> > + const char *chip_id;
> > + int by_name;
> > +};
> > +
> > +int parse_config(int argc, char **argv, struct config *cfg)
> > +{
> > + int opti, optc;
> > + const char *const shortopts = "+c:hsv";
> > + const struct option longopts[] = {
> > + { "by-name", no_argument, &cfg->by_name, 1 },
> > + { "chip", required_argument, NULL, 'c' },
> > + { "help", no_argument, NULL, 'h' },
> > + { "strict", no_argument, NULL, 's' },
> > + { "version", no_argument, NULL, 'v' },
> > + { GETOPT_NULL_LONGOPT },
> > + };
> > +
> > + memset(cfg, 0, sizeof(*cfg));
> > +
> > + for (;;) {
> > + optc = getopt_long(argc, argv, shortopts, longopts, &opti);
> > + if (optc < 0)
> > + break;
> > +
> > + switch (optc) {
> > + case 'c':
> > + cfg->chip_id = optarg;
> > + break;
> > + case 's':
> > + cfg->strict = true;
> > + break;
> > + case 'h':
> > + print_help();
> > + exit(EXIT_SUCCESS);
> > + case 'v':
> > + print_version();
> > + exit(EXIT_SUCCESS);
> > + case '?':
> > + die("try %s --help", get_progname());
> > + case 0:
> > + break;
> > + default:
> > + abort();
> > + }
> > + }
> > +
> > + return optind;
> > +}
> > +
> > +
> > +// minimal version similar to tools-common that indicates if a line should be
> > +// printed rather than storing details into the resolver.
> > +// Does not die on non-unique lines.
>
> C-style comments only please. Same elsewhere.
>
Yeah - sorry again - I'm so used to that style that I don't even notice
I'm doing it.
> <snip>
>
> I like the new tools in general. I don't have many issues with the
> code - you are a much better coder than I am.
That's being a bit harsh.
One thing I was considering was reworking the resolver so it would be
more suitable for general use, and move it to core libgpiod so apps
could more readily perform line name discovery.
> I would change the
> coding style here and there but I will probably just spend some time
> on a good clang-format config and use it indiscriminately like I did
> with black for Python.
>
That could be useful. Why doesn't the kernel do that?
And that reminds me - I still need to circle back and take another look
through the Python bindings.
Cheers,
Kent.
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [libgpiod v2][PATCH v3 4/5] tools: add gpiowatch
2022-11-08 15:00 ` Bartosz Golaszewski
@ 2022-11-08 15:38 ` Kent Gibson
2022-11-08 18:04 ` Bartosz Golaszewski
0 siblings, 1 reply; 16+ messages in thread
From: Kent Gibson @ 2022-11-08 15:38 UTC (permalink / raw)
To: Bartosz Golaszewski; +Cc: linux-gpio
On Tue, Nov 08, 2022 at 04:00:08PM +0100, Bartosz Golaszewski wrote:
> On Tue, Oct 11, 2022 at 2:29 AM Kent Gibson <warthog618@gmail.com> wrote:
> >
> > Add a gpiowatch tool, based on gpiomon, to report line info change
> > events read from chip file descriptors.
> >
> > Inspired by the gpio-watch tool in the linux kernel, but with gpiomon
> > features such as custom formatted output, filtering events of
> > interest and exiting after a number of events, so more useful for
> > scripting.
> >
> > Default output is minimalist, so just time, event type and line id.
> > Full event details are available using the custom formatted output.
> >
> > Signed-off-by: Kent Gibson <warthog618@gmail.com>
> > ---
> >
> > Changes v2 -> v3:
> > - Minimise the default output to more closely match gpiomon.
> > - Add --format option for when more detail is required.
> > - Add --num-events option to exit after a number of events.
> > - Add --event option to report only specific event types.
> > - Add --quiet option to not print events.
> > - fix monotonic to realtime conversion on 32 bit platforms.
> >
>
> Nice and clean, I don't have any issues other than the regular
> coding-style bikeshedding.
>
Will be renamed to gpionotify for v5, ok?
> What happened to the idea we've been floating about creating a single,
> busyboxy executable with links rather than separate executables? Have
> we ever agreed on it?
>
Yeah, last we spoke on it we agreed it was of dubious value and a low
priority, so I didn't go anywhere with it. You've reconsidered?
Cheers,
Kent.
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [libgpiod v2][PATCH v3 4/5] tools: add gpiowatch
2022-11-08 15:38 ` Kent Gibson
@ 2022-11-08 18:04 ` Bartosz Golaszewski
2022-11-09 1:57 ` Kent Gibson
0 siblings, 1 reply; 16+ messages in thread
From: Bartosz Golaszewski @ 2022-11-08 18:04 UTC (permalink / raw)
To: Kent Gibson; +Cc: linux-gpio
On Tue, Nov 8, 2022 at 4:38 PM Kent Gibson <warthog618@gmail.com> wrote:
>
> On Tue, Nov 08, 2022 at 04:00:08PM +0100, Bartosz Golaszewski wrote:
> > On Tue, Oct 11, 2022 at 2:29 AM Kent Gibson <warthog618@gmail.com> wrote:
> > >
> > > Add a gpiowatch tool, based on gpiomon, to report line info change
> > > events read from chip file descriptors.
> > >
> > > Inspired by the gpio-watch tool in the linux kernel, but with gpiomon
> > > features such as custom formatted output, filtering events of
> > > interest and exiting after a number of events, so more useful for
> > > scripting.
> > >
> > > Default output is minimalist, so just time, event type and line id.
> > > Full event details are available using the custom formatted output.
> > >
> > > Signed-off-by: Kent Gibson <warthog618@gmail.com>
> > > ---
> > >
> > > Changes v2 -> v3:
> > > - Minimise the default output to more closely match gpiomon.
> > > - Add --format option for when more detail is required.
> > > - Add --num-events option to exit after a number of events.
> > > - Add --event option to report only specific event types.
> > > - Add --quiet option to not print events.
> > > - fix monotonic to realtime conversion on 32 bit platforms.
> > >
> >
> > Nice and clean, I don't have any issues other than the regular
> > coding-style bikeshedding.
> >
>
> Will be renamed to gpionotify for v5, ok?
Yes, sure, just like discussed.
>
> > What happened to the idea we've been floating about creating a single,
> > busyboxy executable with links rather than separate executables? Have
> > we ever agreed on it?
> >
>
> Yeah, last we spoke on it we agreed it was of dubious value and a low
> priority, so I didn't go anywhere with it. You've reconsidered?
>
I'm seeing that the tools-common.c file grew quite a bit after your
rework (which is good, a lot of stuff has been generalized) which
makes me think it wouldn't be a bad idea to not include it 6 times
separately. It's either a libgpio-tools or putting this stuff into the
same executable?
Anyway, we can do it later.
Bart
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [libgpiod v2][PATCH v3 2/5] tools: line name focussed rework
2022-11-08 15:33 ` Kent Gibson
@ 2022-11-08 18:25 ` Bartosz Golaszewski
2022-11-09 2:00 ` Kent Gibson
0 siblings, 1 reply; 16+ messages in thread
From: Bartosz Golaszewski @ 2022-11-08 18:25 UTC (permalink / raw)
To: Kent Gibson; +Cc: linux-gpio
On Tue, Nov 8, 2022 at 4:33 PM Kent Gibson <warthog618@gmail.com> wrote:
>
> On Tue, Nov 08, 2022 at 02:13:20PM +0100, Bartosz Golaszewski wrote:
> > On Tue, Oct 11, 2022 at 2:29 AM Kent Gibson <warthog618@gmail.com> wrote:
> > >
> > > Rework the tool suite to support identifying lines by name and to
> > > support operating on the GPIO lines available to the user at once, rather
> > > than on one particular GPIO chip.
> > >
> > > All tools, other than gpiodetect, now provide the name to (chip,offset)
> > > mapping that was previously only performed by gpiofind. As names are not
> > > guaranteed to be unique, a --strict option is provided for all tools to
> > > either abort the operation or report all lines with the matching name, as
> > > appropriate.
> > > By default the tools operate on the first line found with a matching name.
> > >
> > > Selection of line by (chip,offset) is still supported with a --chip
> > > option, though it restricts the scope of the operation to an individual
> > > chip. When the --chip option is specified, the lines are assumed to be
> > > identified by offset where they parse as an integer, else by name.
> > > To cater for the unusual case where a line name parses as an integer,
> > > but is different from the offset, the --by-name option forces the lines
> > > to be identified by name.
> > >
> > > The updated tools are intentionally NOT backwardly compatible with the
> > > previous tools. Using old command lines with the updated tools will
> > > almost certainly fail, though migrating old command lines is generally as
> > > simple as adding a '-c' before the chip.
> > >
> >
> > While at it: how about adding the --consumer/-C switch to specify a
> > consumer string other than the name of the program?
> >
>
> Ironically I added that to the Rust version, for the long lived
> commands anyway, so it could better emulate the C version for testing
> purposes.
> But could be generally useful, so ok.
>
> I only used the long form there to avoid confusion with -c (as they are
> visually very similar) and following the principle that rarely used
> options only get a long form, so I will omit the short -C option - unless
> you insist.
>
I don't see why it would hurt but I'm fine either way.
> > > In addition the individual tools are modified as follows:
> > >
> > > gpiodetect:
> > >
> > > Add the option to select individual chips.
> > >
> > > gpioinfo:
> > >
> > > Change the focus from chips to lines, so the scope can be
> > > an individual line, a subset of lines, all lines on a particular chip,
> > > or all the lines available to the user. For line scope a single line
> > > summary is output for each line. For chip scope the existing format
> > > displaying a summary of the chip and each of its lines is retained.
> > >
> > > Line attributes are consolidated into a list format, and are extended
> > > to cover all attributes supported by uAPI v2.
> > >
> >
> > One change in the output that bothers me is the removal of quotation
> > marks around the line name and consumer. I did that in v1 to visually
> > distinguish between unnamed/unused lines and those that are named. I
> > know it's highly unlikely that a line would be named "unnamed" (sic!)
> > but still:
> >
> > line 0: "foo"
> > line 1: unnamed
> >
> > looks more intuitive to me.
>
> I disagree on this one. In the longer term all lines should be named
> and then the quotes just become pointless noise, and require more
> work to parse.
>
I insist on this one as just a quick glance at the current values of
gpio-line-names DT properties in the kernel show all kinds of funky
names - not only including spaces but also various other characters
like [, ], #, /, - and that not. I think it makes a lot of sense to
delimit them visually with quotes.
> >Same for the consumer as with your current
> > version, if the consumer string has spaces in it, it will look like
> > this: consumer=foo bar. I think consumer="foo bar" would be easier to
> > parse.
>
> For this very reason, the consumer is explicitly listed last, so the
> consumer name matches everything between the "consumer=" and end of
> line.
>
> Unless consumer names with spaces are very common in the wild then
> quotes only add more clutter.
>
We can't know, but instead of putting it last, I'd just treat it like
every other flag and instead delimit the name with "".
The tool is mostly aimed at humans anyway and if someone's brave
enough to parse the output with a script then a cut-based one-liner is
all they need, no?
> >
> > > gpioget:
> > >
> > > The default output format is becomes line=value, as per the
> > > input for gpioset, and the value is reported as active or inactive,
> > > rather than 0 or 1.
> > > The previous format is available using the --numeric option.
> > >
> > > Add an optional hold period between requesting a line and reading the
> > > value to allow the line to settle once the requested configuration has
> > > been applied (e.g. bias).
> > >
> > > gpiomon:
> > >
> > > Consolidate the edge options into a single option.
> > >
> > > Add a debounce period option.
> > >
> > > Add options to report event times as UTC or localtime.
> > >
> > > Add format specifiers for GPIO chip path, line name, stringified event
> > > type, and event time as a datetime.
> > >
> > > Rearrange default output format to place fields with more predicable
> > > widths to the left, and to separate major field groups with tabs.
> > > Lines are identified consistent with the command line.
> > >
> > > gpioset:
> > >
> > > Add a hold period option that specifies the minimum period the line
> > > value must be held for. This applies to all set options.
> > >
> > > Support line values specified as active/inactive, on/off and
> > > true/false, as well as 1/0.
> > >
> > > Add a toggle option that specifies a time sequence over which the
> > > requested lines should be toggled. If the sequence is 0 terminated then
> > > gpioset exits when the sequence completes, else it repeats the sequence.
> > > This allows for anything from simple blinkers to bit bashing from the
> > > command line. e.g. gpioset -t 500ms LED=on
> > >
> > > Add an interactive option to provide a shell-like interface to allow
> > > manual or scripted manipulation of requested lines. A basic command set
> > > allows lines to be get, set, or toggled, and to insert sleeps between
> > > operations.
> > >
> >
> > As discussed elsewhere - it would be great if this part was optional
> > and configurable at build-time so that the dependency on libedit could
> > be dropped if unavailable.
> >
>
> Agreed.
>
> > > Remove the --mode, --sec, and --usec options.
> > > The combination of hold period and interactive mode provide functionality
> > > equivalent to the old --mode options.
> > >
> >
> > I have one problem with that - I think the basic functionality of:
> > "take a line, set its value and wait for a signal" would still be
> > useful. As it is now, I'm not sure how to make gpioset just hold a
> > line without calling the GPIO_V2_LINE_SET_VALUES_IOCTL ioctl
> > periodically.
> >
>
> I forgot to mention the daemonize option here, so
>
> gpioset -z myline=1
>
> will do that.
>
> (or
>
> gpioset -i myline=1
>
> if you want to keep the process in the foreground.)
>
> I'll add something to the daemonize help to highlight that it will hold
> the line until killed. Is that sufficient?
>
What if I don't want to daemonize the program nor open the interactive
mode? Why not just make the default behavior of `gpioset foo=active`
be: stay alive until interrupted? The current immediate exiting is
mostly useless anyway.
> > > Signed-off-by: Kent Gibson <warthog618@gmail.com>
> > > ---
> > > configure.ac | 8 +-
> > > tools/Makefile.am | 2 +-
> > > tools/gpiodetect.c | 113 +++++-
> > > tools/gpioget.c | 204 ++++++++++-
> > > tools/gpioinfo.c | 223 +++++++++++-
> > > tools/gpiomon.c | 450 +++++++++++++++++++++++-
> > > tools/gpioset.c | 815 ++++++++++++++++++++++++++++++++++++++++++-
> > > tools/tools-common.c | 713 ++++++++++++++++++++++++++++++++++++-
> > > tools/tools-common.h | 99 +++++-
> > > 9 files changed, 2585 insertions(+), 42 deletions(-)
> > >
> > > diff --git a/configure.ac b/configure.ac
> > > index 6ac1d8e..c8033c5 100644
> > > --- a/configure.ac
> > > +++ b/configure.ac
> > > @@ -106,14 +106,14 @@ AC_DEFUN([FUNC_NOT_FOUND_TOOLS],
> > > AC_DEFUN([HEADER_NOT_FOUND_TOOLS],
> > > [ERR_NOT_FOUND([$1 header], [tools])])
> > >
> > > +AC_DEFUN([LIB_NOT_FOUND_TOOLS],
> > > + [ERR_NOT_FOUND([lib$1], [tools])])
> > > +
> > > if test "x$with_tools" = xtrue
> > > then
> > > # These are only needed to build tools
> > > - AC_CHECK_FUNC([basename], [], [FUNC_NOT_FOUND_TOOLS([basename])])
> > > AC_CHECK_FUNC([daemon], [], [FUNC_NOT_FOUND_TOOLS([daemon])])
> > > - AC_CHECK_FUNC([signalfd], [], [FUNC_NOT_FOUND_TOOLS([signalfd])])
> > > - AC_CHECK_FUNC([setlinebuf], [], [FUNC_NOT_FOUND_TOOLS([setlinebuf])])
> > > - AC_CHECK_HEADERS([sys/signalfd.h], [], [HEADER_NOT_FOUND_TOOLS([sys/signalfd.h])])
> > > + PKG_CHECK_MODULES(LIBEDIT, libedit)
> > > fi
> > >
> > > AC_ARG_ENABLE([tests],
> > > diff --git a/tools/Makefile.am b/tools/Makefile.am
> > > index fc074b9..c956314 100644
> > > --- a/tools/Makefile.am
> > > +++ b/tools/Makefile.am
> > > @@ -7,7 +7,7 @@ AM_CFLAGS += -Wall -Wextra -g -std=gnu89
> > > noinst_LTLIBRARIES = libtools-common.la
> > > libtools_common_la_SOURCES = tools-common.c tools-common.h
> > >
> > > -LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la
> > > +LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la $(LIBEDIT_LIBS)
> > >
> > > bin_PROGRAMS = gpiodetect gpioinfo gpioget gpioset gpiomon
> > >
> > > diff --git a/tools/gpiodetect.c b/tools/gpiodetect.c
> > > index 30bde32..910fe9e 100644
> > > --- a/tools/gpiodetect.c
> > > +++ b/tools/gpiodetect.c
> > > @@ -1,8 +1,7 @@
> > > // SPDX-License-Identifier: GPL-2.0-or-later
> > > // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com>
> > > +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com>
> > >
> > > -#include <dirent.h>
> > > -#include <errno.h>
> > > #include <getopt.h>
> > > #include <gpiod.h>
> > > #include <stdio.h>
> > > @@ -11,3 +10,113 @@
> > >
> > > #include "tools-common.h"
> > >
> > > +static void print_help(void)
> > > +{
> > > + printf("Usage: %s [OPTIONS] [chip]...\n", get_progname());
> > > + printf("\n");
> > > + printf("List GPIO chips, print their labels and number of GPIO lines.\n");
> > > + printf("\n");
> > > + printf("Chips may be identified by number, name, or path.\n");
> > > + printf("e.g. '0', 'gpiochip0', and '/dev/gpiochip0' all refer to the same chip.\n");
> > > + printf("\n");
> > > + printf("If no chips are specified then all chips are listed.\n");
> > > + printf("\n");
> > > + printf("Options:\n");
> > > + printf(" -h, --help\t\tdisplay this help and exit\n");
> > > + printf(" -v, --version\t\toutput version information and exit\n");
> > > +}
> > > +
> > > +int parse_config(int argc, char **argv)
> > > +{
> > > + int optc, opti;
> > > + const char *const shortopts = "+hv";
> > > + const struct option longopts[] = {
> > > + { "help", no_argument, NULL, 'h' },
> > > + { "version", no_argument, NULL, 'v' },
> > > + { GETOPT_NULL_LONGOPT },
> > > + };
> >
> > This can be static as there are no addresses of flag variables assigned.
> >
>
> Indeed - and now you mention it I notice a few other things that should be
> static too.
>
<snip>
> > > +
> > > +// minimal version similar to tools-common that indicates if a line should be
> > > +// printed rather than storing details into the resolver.
> > > +// Does not die on non-unique lines.
> >
> > C-style comments only please. Same elsewhere.
> >
>
> Yeah - sorry again - I'm so used to that style that I don't even notice
> I'm doing it.
>
> > <snip>
> >
> > I like the new tools in general. I don't have many issues with the
> > code - you are a much better coder than I am.
>
> That's being a bit harsh.
>
> One thing I was considering was reworking the resolver so it would be
> more suitable for general use, and move it to core libgpiod so apps
> could more readily perform line name discovery.
>
Hmm, I think it's unnecessary clutter in the library. I was thinking
about whether to put the upcoming fdinfo parsing into the library and
figured that it's more of a suitable candidate for a new command-line
tool as the library should focus on the character device exclusively
IMO.
> > I would change the
> > coding style here and there but I will probably just spend some time
> > on a good clang-format config and use it indiscriminately like I did
> > with black for Python.
> >
>
> That could be useful. Why doesn't the kernel do that?
Probably for the same reason it doesn't use
__attribute__((cleanup(x))) etc. linux kernel inertia. :)
> And that reminds me - I still need to circle back and take another look
> through the Python bindings.
>
Thanks!
Bart
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [libgpiod v2][PATCH v3 4/5] tools: add gpiowatch
2022-11-08 18:04 ` Bartosz Golaszewski
@ 2022-11-09 1:57 ` Kent Gibson
0 siblings, 0 replies; 16+ messages in thread
From: Kent Gibson @ 2022-11-09 1:57 UTC (permalink / raw)
To: Bartosz Golaszewski; +Cc: linux-gpio
On Tue, Nov 08, 2022 at 07:04:36PM +0100, Bartosz Golaszewski wrote:
> On Tue, Nov 8, 2022 at 4:38 PM Kent Gibson <warthog618@gmail.com> wrote:
> >
> > On Tue, Nov 08, 2022 at 04:00:08PM +0100, Bartosz Golaszewski wrote:
> > > On Tue, Oct 11, 2022 at 2:29 AM Kent Gibson <warthog618@gmail.com> wrote:
> > > >
> > > > Add a gpiowatch tool, based on gpiomon, to report line info change
> > > > events read from chip file descriptors.
> > > >
> > > > Inspired by the gpio-watch tool in the linux kernel, but with gpiomon
> > > > features such as custom formatted output, filtering events of
> > > > interest and exiting after a number of events, so more useful for
> > > > scripting.
> > > >
> > > > Default output is minimalist, so just time, event type and line id.
> > > > Full event details are available using the custom formatted output.
> > > >
> > > > Signed-off-by: Kent Gibson <warthog618@gmail.com>
> > > > ---
> > > >
> > > > Changes v2 -> v3:
> > > > - Minimise the default output to more closely match gpiomon.
> > > > - Add --format option for when more detail is required.
> > > > - Add --num-events option to exit after a number of events.
> > > > - Add --event option to report only specific event types.
> > > > - Add --quiet option to not print events.
> > > > - fix monotonic to realtime conversion on 32 bit platforms.
> > > >
> > >
> > > Nice and clean, I don't have any issues other than the regular
> > > coding-style bikeshedding.
> > >
> >
> > Will be renamed to gpionotify for v5, ok?
>
> Yes, sure, just like discussed.
>
> >
> > > What happened to the idea we've been floating about creating a single,
> > > busyboxy executable with links rather than separate executables? Have
> > > we ever agreed on it?
> > >
> >
> > Yeah, last we spoke on it we agreed it was of dubious value and a low
> > priority, so I didn't go anywhere with it. You've reconsidered?
> >
>
> I'm seeing that the tools-common.c file grew quite a bit after your
> rework (which is good, a lot of stuff has been generalized) which
> makes me think it wouldn't be a bad idea to not include it 6 times
> separately. It's either a libgpio-tools or putting this stuff into the
> same executable?
>
Fair enough - for some reason I was thinking tools-common did get linked
into a libgpiod-tools lib, but I guess not.
The bulk of the rework is the resolver, and I was thinking that some
form of that should go in core libgpiod - that would also reduce the
duplication problem.
> Anyway, we can do it later.
>
Agreed - not for this series.
Cheers,
Kent.
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [libgpiod v2][PATCH v3 2/5] tools: line name focussed rework
2022-11-08 18:25 ` Bartosz Golaszewski
@ 2022-11-09 2:00 ` Kent Gibson
2022-11-09 11:16 ` Bartosz Golaszewski
0 siblings, 1 reply; 16+ messages in thread
From: Kent Gibson @ 2022-11-09 2:00 UTC (permalink / raw)
To: Bartosz Golaszewski; +Cc: linux-gpio
On Tue, Nov 08, 2022 at 07:25:27PM +0100, Bartosz Golaszewski wrote:
> On Tue, Nov 8, 2022 at 4:33 PM Kent Gibson <warthog618@gmail.com> wrote:
> >
> > On Tue, Nov 08, 2022 at 02:13:20PM +0100, Bartosz Golaszewski wrote:
> > > On Tue, Oct 11, 2022 at 2:29 AM Kent Gibson <warthog618@gmail.com> wrote:
> > > >
> > > > Rework the tool suite to support identifying lines by name and to
> > > > support operating on the GPIO lines available to the user at once, rather
> > > > than on one particular GPIO chip.
> > > >
> > > > All tools, other than gpiodetect, now provide the name to (chip,offset)
> > > > mapping that was previously only performed by gpiofind. As names are not
> > > > guaranteed to be unique, a --strict option is provided for all tools to
> > > > either abort the operation or report all lines with the matching name, as
> > > > appropriate.
> > > > By default the tools operate on the first line found with a matching name.
> > > >
> > > > Selection of line by (chip,offset) is still supported with a --chip
> > > > option, though it restricts the scope of the operation to an individual
> > > > chip. When the --chip option is specified, the lines are assumed to be
> > > > identified by offset where they parse as an integer, else by name.
> > > > To cater for the unusual case where a line name parses as an integer,
> > > > but is different from the offset, the --by-name option forces the lines
> > > > to be identified by name.
> > > >
> > > > The updated tools are intentionally NOT backwardly compatible with the
> > > > previous tools. Using old command lines with the updated tools will
> > > > almost certainly fail, though migrating old command lines is generally as
> > > > simple as adding a '-c' before the chip.
> > > >
> > >
> > > While at it: how about adding the --consumer/-C switch to specify a
> > > consumer string other than the name of the program?
> > >
> >
> > Ironically I added that to the Rust version, for the long lived
> > commands anyway, so it could better emulate the C version for testing
> > purposes.
> > But could be generally useful, so ok.
> >
> > I only used the long form there to avoid confusion with -c (as they are
> > visually very similar) and following the principle that rarely used
> > options only get a long form, so I will omit the short -C option - unless
> > you insist.
> >
>
> I don't see why it would hurt but I'm fine either way.
>
It would only be a problem if the consumer name matched with a gpiochip,
and that seems unlikely. And no other use for -C seems likely either, so I
guess you are right - it wouldn't hurt.
> > > > In addition the individual tools are modified as follows:
> > > >
> > > > gpiodetect:
> > > >
> > > > Add the option to select individual chips.
> > > >
> > > > gpioinfo:
> > > >
> > > > Change the focus from chips to lines, so the scope can be
> > > > an individual line, a subset of lines, all lines on a particular chip,
> > > > or all the lines available to the user. For line scope a single line
> > > > summary is output for each line. For chip scope the existing format
> > > > displaying a summary of the chip and each of its lines is retained.
> > > >
> > > > Line attributes are consolidated into a list format, and are extended
> > > > to cover all attributes supported by uAPI v2.
> > > >
> > >
> > > One change in the output that bothers me is the removal of quotation
> > > marks around the line name and consumer. I did that in v1 to visually
> > > distinguish between unnamed/unused lines and those that are named. I
> > > know it's highly unlikely that a line would be named "unnamed" (sic!)
> > > but still:
> > >
> > > line 0: "foo"
> > > line 1: unnamed
> > >
> > > looks more intuitive to me.
> >
> > I disagree on this one. In the longer term all lines should be named
> > and then the quotes just become pointless noise, and require more
> > work to parse.
> >
>
> I insist on this one as just a quick glance at the current values of
> gpio-line-names DT properties in the kernel show all kinds of funky
> names - not only including spaces but also various other characters
> like [, ], #, /, - and that not. I think it makes a lot of sense to
> delimit them visually with quotes.
>
Good grief, what a mess. Would've been nice to have some naming
conventions in place, but too late now...
Which reminds me - any guarantees the name, particularly the consumer
name, is valid UTF-8?
If not then need to double check how the Rust bindings deal with that.
Throwing a utf8_error would not be appropriate if it isn't guaranteed to
be UTF-8.
> > >Same for the consumer as with your current
> > > version, if the consumer string has spaces in it, it will look like
> > > this: consumer=foo bar. I think consumer="foo bar" would be easier to
> > > parse.
> >
> > For this very reason, the consumer is explicitly listed last, so the
> > consumer name matches everything between the "consumer=" and end of
> > line.
> >
> > Unless consumer names with spaces are very common in the wild then
> > quotes only add more clutter.
> >
>
> We can't know, but instead of putting it last, I'd just treat it like
> every other flag and instead delimit the name with "".
It is also last based on length predicatability - more predicatable
first, and the other attributes are more predictable.
>
> The tool is mostly aimed at humans anyway and if someone's brave
> enough to parse the output with a script then a cut-based one-liner is
> all they need, no?
>
Sure, but don't underestimate the ability of users to complain when a
tool isn't quite as easy to use as they would like.
Hmmm, how about an option to quote all string attributes?
Say --quoted?
Or if quoted is the default then --unquoted to remove the clutter?
<snip>
> >
> > > > Remove the --mode, --sec, and --usec options.
> > > > The combination of hold period and interactive mode provide functionality
> > > > equivalent to the old --mode options.
> > > >
> > >
> > > I have one problem with that - I think the basic functionality of:
> > > "take a line, set its value and wait for a signal" would still be
> > > useful. As it is now, I'm not sure how to make gpioset just hold a
> > > line without calling the GPIO_V2_LINE_SET_VALUES_IOCTL ioctl
> > > periodically.
> > >
> >
> > I forgot to mention the daemonize option here, so
> >
> > gpioset -z myline=1
> >
> > will do that.
> >
> > (or
> >
> > gpioset -i myline=1
> >
> > if you want to keep the process in the foreground.)
> >
> > I'll add something to the daemonize help to highlight that it will hold
> > the line until killed. Is that sufficient?
> >
>
> What if I don't want to daemonize the program nor open the interactive
> mode? Why not just make the default behavior of `gpioset foo=active`
> be: stay alive until interrupted? The current immediate exiting is
> mostly useless anyway.
>
Hmmm, not when used with the --hold-period, so a script could call a
series of gpiosets to generate a waveform. Though that doesn't work
well, as the line is released between sets, and the whole point of
the toggle option and interactive modes is to provide better
alternatives for doing that.
So yeah, true - I guess I just blindly followed the v1 behaviour on that.
- the standard behaviour should be to not exit.
The only exception being a zero-terminated toggle sequence.
That should also reduce the chance of users complaining that gpioset
doesn't work where they assume the set persists after gpioset exists.
OTOH I'm willing to bet we get at least one complaint that gpioset
hangs... :|.
<snip>
>
> > > > +
> > > > +// minimal version similar to tools-common that indicates if a line should be
> > > > +// printed rather than storing details into the resolver.
> > > > +// Does not die on non-unique lines.
> > >
> > > C-style comments only please. Same elsewhere.
> > >
> >
> > Yeah - sorry again - I'm so used to that style that I don't even notice
> > I'm doing it.
> >
> > > <snip>
> > >
> > > I like the new tools in general. I don't have many issues with the
> > > code - you are a much better coder than I am.
> >
> > That's being a bit harsh.
> >
> > One thing I was considering was reworking the resolver so it would be
> > more suitable for general use, and move it to core libgpiod so apps
> > could more readily perform line name discovery.
> >
>
> Hmm, I think it's unnecessary clutter in the library. I was thinking
> about whether to put the upcoming fdinfo parsing into the library and
> figured that it's more of a suitable candidate for a new command-line
> tool as the library should focus on the character device exclusively
> IMO.
>
I think you were right the first time. The fdinfo is another aspect of
the cdev GPIO uAPI - it isn't just the ioctls.
If the GPIO uAPI were extended to use AIO, would that not go in libgpiod as
well?
And agreed that fdinfo warrants another tool.
It makes sense to me to add higher level abstractions or functionality
where that greatly simplifies apps.
Speaking from experience, looking up up the line chip/offset based on
name is at best tedious and at worst a serious PITA.
If it isn't available in libgpiod then apps are more likely to do it
out-of-band, such as by using gpioinfo to generate app configuration,
or just stick to specifying lines by chip/offset, which is a bit sad.
But, as per the unified tool binary, this can always be added later.
Cheers,
Kent.
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [libgpiod v2][PATCH v3 2/5] tools: line name focussed rework
2022-11-09 2:00 ` Kent Gibson
@ 2022-11-09 11:16 ` Bartosz Golaszewski
2022-11-09 11:40 ` Kent Gibson
0 siblings, 1 reply; 16+ messages in thread
From: Bartosz Golaszewski @ 2022-11-09 11:16 UTC (permalink / raw)
To: Kent Gibson; +Cc: linux-gpio
On Wed, Nov 9, 2022 at 3:00 AM Kent Gibson <warthog618@gmail.com> wrote:
>
[snip]
> >
> > I insist on this one as just a quick glance at the current values of
> > gpio-line-names DT properties in the kernel show all kinds of funky
> > names - not only including spaces but also various other characters
> > like [, ], #, /, - and that not. I think it makes a lot of sense to
> > delimit them visually with quotes.
> >
>
> Good grief, what a mess. Would've been nice to have some naming
> conventions in place, but too late now...
>
> Which reminds me - any guarantees the name, particularly the consumer
> name, is valid UTF-8?
> If not then need to double check how the Rust bindings deal with that.
> Throwing a utf8_error would not be appropriate if it isn't guaranteed to
> be UTF-8.
>
There's nothing that technically prohibits anyone from using non-UTF8
characters and also current libgpiod seems to be handling such chars
just fine (just tested to make sure).
> > > >Same for the consumer as with your current
> > > > version, if the consumer string has spaces in it, it will look like
> > > > this: consumer=foo bar. I think consumer="foo bar" would be easier to
> > > > parse.
> > >
> > > For this very reason, the consumer is explicitly listed last, so the
> > > consumer name matches everything between the "consumer=" and end of
> > > line.
> > >
> > > Unless consumer names with spaces are very common in the wild then
> > > quotes only add more clutter.
> > >
> >
> > We can't know, but instead of putting it last, I'd just treat it like
> > every other flag and instead delimit the name with "".
>
> It is also last based on length predicatability - more predicatable
> first, and the other attributes are more predictable.
>
> >
> > The tool is mostly aimed at humans anyway and if someone's brave
> > enough to parse the output with a script then a cut-based one-liner is
> > all they need, no?
> >
>
> Sure, but don't underestimate the ability of users to complain when a
> tool isn't quite as easy to use as they would like.
>
> Hmmm, how about an option to quote all string attributes?
> Say --quoted?
> Or if quoted is the default then --unquoted to remove the clutter?
>
I don't feel like it's necessary. How would you handle line names with
spaces? It would add an additional column? That would be actually
harder to parse than quoted names IMO.
> <snip>
> > >
> > > > > Remove the --mode, --sec, and --usec options.
> > > > > The combination of hold period and interactive mode provide functionality
> > > > > equivalent to the old --mode options.
> > > > >
> > > >
> > > > I have one problem with that - I think the basic functionality of:
> > > > "take a line, set its value and wait for a signal" would still be
> > > > useful. As it is now, I'm not sure how to make gpioset just hold a
> > > > line without calling the GPIO_V2_LINE_SET_VALUES_IOCTL ioctl
> > > > periodically.
> > > >
> > >
> > > I forgot to mention the daemonize option here, so
> > >
> > > gpioset -z myline=1
> > >
> > > will do that.
> > >
> > > (or
> > >
> > > gpioset -i myline=1
> > >
> > > if you want to keep the process in the foreground.)
> > >
> > > I'll add something to the daemonize help to highlight that it will hold
> > > the line until killed. Is that sufficient?
> > >
> >
> > What if I don't want to daemonize the program nor open the interactive
> > mode? Why not just make the default behavior of `gpioset foo=active`
> > be: stay alive until interrupted? The current immediate exiting is
> > mostly useless anyway.
> >
>
> Hmmm, not when used with the --hold-period, so a script could call a
> series of gpiosets to generate a waveform. Though that doesn't work
> well, as the line is released between sets, and the whole point of
> the toggle option and interactive modes is to provide better
> alternatives for doing that.
>
> So yeah, true - I guess I just blindly followed the v1 behaviour on that.
> - the standard behaviour should be to not exit.
> The only exception being a zero-terminated toggle sequence.
>
> That should also reduce the chance of users complaining that gpioset
> doesn't work where they assume the set persists after gpioset exists.
> OTOH I'm willing to bet we get at least one complaint that gpioset
> hangs... :|.
>
> <snip>
> >
> > > > > +
> > > > > +// minimal version similar to tools-common that indicates if a line should be
> > > > > +// printed rather than storing details into the resolver.
> > > > > +// Does not die on non-unique lines.
> > > >
> > > > C-style comments only please. Same elsewhere.
> > > >
> > >
> > > Yeah - sorry again - I'm so used to that style that I don't even notice
> > > I'm doing it.
> > >
> > > > <snip>
> > > >
> > > > I like the new tools in general. I don't have many issues with the
> > > > code - you are a much better coder than I am.
> > >
> > > That's being a bit harsh.
> > >
> > > One thing I was considering was reworking the resolver so it would be
> > > more suitable for general use, and move it to core libgpiod so apps
> > > could more readily perform line name discovery.
> > >
> >
> > Hmm, I think it's unnecessary clutter in the library. I was thinking
> > about whether to put the upcoming fdinfo parsing into the library and
> > figured that it's more of a suitable candidate for a new command-line
> > tool as the library should focus on the character device exclusively
> > IMO.
> >
>
> I think you were right the first time. The fdinfo is another aspect of
> the cdev GPIO uAPI - it isn't just the ioctls.
> If the GPIO uAPI were extended to use AIO, would that not go in libgpiod as
> well?
>
> And agreed that fdinfo warrants another tool.
>
I was thinking that both gpioinfo could use that (e.g.
consumer="foobar",consumer_pid=12345) and we could have something
like:
# gpioowner foobar
12345
> It makes sense to me to add higher level abstractions or functionality
> where that greatly simplifies apps.
> Speaking from experience, looking up up the line chip/offset based on
> name is at best tedious and at worst a serious PITA.
> If it isn't available in libgpiod then apps are more likely to do it
> out-of-band, such as by using gpioinfo to generate app configuration,
> or just stick to specifying lines by chip/offset, which is a bit sad.
>
> But, as per the unified tool binary, this can always be added later.
>
Ok, I'm buying this. Let's think about adding this to the core library.
Bart
^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [libgpiod v2][PATCH v3 2/5] tools: line name focussed rework
2022-11-09 11:16 ` Bartosz Golaszewski
@ 2022-11-09 11:40 ` Kent Gibson
0 siblings, 0 replies; 16+ messages in thread
From: Kent Gibson @ 2022-11-09 11:40 UTC (permalink / raw)
To: Bartosz Golaszewski; +Cc: linux-gpio
On Wed, Nov 09, 2022 at 12:16:22PM +0100, Bartosz Golaszewski wrote:
> On Wed, Nov 9, 2022 at 3:00 AM Kent Gibson <warthog618@gmail.com> wrote:
> >
>
> [snip]
>
>
> > >
> > > I insist on this one as just a quick glance at the current values of
> > > gpio-line-names DT properties in the kernel show all kinds of funky
> > > names - not only including spaces but also various other characters
> > > like [, ], #, /, - and that not. I think it makes a lot of sense to
> > > delimit them visually with quotes.
> > >
> >
> > Good grief, what a mess. Would've been nice to have some naming
> > conventions in place, but too late now...
> >
> > Which reminds me - any guarantees the name, particularly the consumer
> > name, is valid UTF-8?
> > If not then need to double check how the Rust bindings deal with that.
> > Throwing a utf8_error would not be appropriate if it isn't guaranteed to
> > be UTF-8.
> >
>
> There's nothing that technically prohibits anyone from using non-UTF8
> characters and also current libgpiod seems to be handling such chars
> just fine (just tested to make sure).
>
Exactly - AIUI the names are simply 32 bytes - any 32 bytes.
There is also the possibility of UTF-8 being truncated mid-character due
to the 32 byte limit - so even if you put UTF-8 in, it might come out
invalid when you read it back.
> > > > >Same for the consumer as with your current
> > > > > version, if the consumer string has spaces in it, it will look like
> > > > > this: consumer=foo bar. I think consumer="foo bar" would be easier to
> > > > > parse.
> > > >
> > > > For this very reason, the consumer is explicitly listed last, so the
> > > > consumer name matches everything between the "consumer=" and end of
> > > > line.
> > > >
> > > > Unless consumer names with spaces are very common in the wild then
> > > > quotes only add more clutter.
> > > >
> > >
> > > We can't know, but instead of putting it last, I'd just treat it like
> > > every other flag and instead delimit the name with "".
> >
> > It is also last based on length predicatability - more predicatable
> > first, and the other attributes are more predictable.
> >
> > >
> > > The tool is mostly aimed at humans anyway and if someone's brave
> > > enough to parse the output with a script then a cut-based one-liner is
> > > all they need, no?
> > >
> >
> > Sure, but don't underestimate the ability of users to complain when a
> > tool isn't quite as easy to use as they would like.
> >
> > Hmmm, how about an option to quote all string attributes?
> > Say --quoted?
> > Or if quoted is the default then --unquoted to remove the clutter?
> >
>
> I don't feel like it's necessary. How would you handle line names with
> spaces? It would add an additional column? That would be actually
> harder to parse than quoted names IMO.
>
Line names are surrounded by tabs, so the actual issue is line names
containing tabs. Are there any of those?
And this is just targetting humans (well me at least) anyway.
<snip>
> > > > One thing I was considering was reworking the resolver so it would be
> > > > more suitable for general use, and move it to core libgpiod so apps
> > > > could more readily perform line name discovery.
> > > >
> > >
> > > Hmm, I think it's unnecessary clutter in the library. I was thinking
> > > about whether to put the upcoming fdinfo parsing into the library and
> > > figured that it's more of a suitable candidate for a new command-line
> > > tool as the library should focus on the character device exclusively
> > > IMO.
> > >
> >
> > I think you were right the first time. The fdinfo is another aspect of
> > the cdev GPIO uAPI - it isn't just the ioctls.
> > If the GPIO uAPI were extended to use AIO, would that not go in libgpiod as
> > well?
> >
> > And agreed that fdinfo warrants another tool.
> >
>
> I was thinking that both gpioinfo could use that (e.g.
> consumer="foobar",consumer_pid=12345) and we could have something
> like:
>
> # gpioowner foobar
> 12345
>
Both those make sense to me.
> > It makes sense to me to add higher level abstractions or functionality
> > where that greatly simplifies apps.
> > Speaking from experience, looking up up the line chip/offset based on
> > name is at best tedious and at worst a serious PITA.
> > If it isn't available in libgpiod then apps are more likely to do it
> > out-of-band, such as by using gpioinfo to generate app configuration,
> > or just stick to specifying lines by chip/offset, which is a bit sad.
> >
> > But, as per the unified tool binary, this can always be added later.
> >
>
> Ok, I'm buying this. Let's think about adding this to the core library.
>
Oh great - I should've kept my trap shut ;-).
Cheers,
Kent.
^ permalink raw reply [flat|nested] 16+ messages in thread
end of thread, other threads:[~2022-11-09 11:41 UTC | newest]
Thread overview: 16+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-10-11 0:29 [libgpiod v2][PATCH v3 0/5] tools: improvements for v2 Kent Gibson
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 1/5] tools: remove old code to simplify review Kent Gibson
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 2/5] tools: line name focussed rework Kent Gibson
2022-11-08 13:13 ` Bartosz Golaszewski
2022-11-08 15:33 ` Kent Gibson
2022-11-08 18:25 ` Bartosz Golaszewski
2022-11-09 2:00 ` Kent Gibson
2022-11-09 11:16 ` Bartosz Golaszewski
2022-11-09 11:40 ` Kent Gibson
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 3/5] tools: tests for " Kent Gibson
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 4/5] tools: add gpiowatch Kent Gibson
2022-11-08 15:00 ` Bartosz Golaszewski
2022-11-08 15:38 ` Kent Gibson
2022-11-08 18:04 ` Bartosz Golaszewski
2022-11-09 1:57 ` Kent Gibson
2022-10-11 0:29 ` [libgpiod v2][PATCH v3 5/5] tools: gpiowatch tests Kent Gibson
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).