In this case however the goal is to have as few dependencies as possible. This
is because for some small systems dbus is overkill. Since we won't be using any
standardized protocol, it will take much more effort to implement it correctly.
+
+----------
+
+* improve gpioset --interactive tab completion
+
+The existing tab completion uses libedit's readline emulation layer which
+has a few limitations, including not being able to correctly handle quoted
+line names and being disabled when stdin/stdout are not a tty (which makes
+testing with gpio-tools-test.bats using coproc problematic).
+
+One approach that could address both these problems is to bypass the readline
+emulation and use the libedit API (histedit.h) directly.
AC_DEFUN([FUNC_NOT_FOUND_TOOLS],
[ERR_NOT_FOUND([$1()], [tools])])
-AC_DEFUN([HEADER_NOT_FOUND_TOOLS],
- [ERR_NOT_FOUND([$1 header], [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_ARG_ENABLE([gpioset-interactive],
+ [AS_HELP_STRING([--enable-gpioset-interactive],
+ [enable gpioset interactive mode [default=no]])],
+ [if test "x$enableval" = xyes; then with_gpioset_interactive=true; fi],
+ [with_gpioset_interactive=false])
+AM_CONDITIONAL([WITH_GPIOSET_INTERACTIVE],
+ [test "x$with_gpioset_interactive" = xtrue])
+
+AS_IF([test "x$with_tools" = xtrue],
+ [# These are only needed to build tools
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])])
-fi
+ AS_IF([test "x$with_gpioset_interactive" = xtrue],
+ [PKG_CHECK_MODULES([LIBEDIT], [libedit >= 3.1])])
+ ])
AC_ARG_ENABLE([tests],
[AS_HELP_STRING([--enable-tests],[enable libgpiod tests [default=no]])],
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
gpioget
gpioset
gpiomon
-gpiofind
LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la
-bin_PROGRAMS = gpiodetect gpioinfo gpioget gpioset gpiomon gpiofind
+if WITH_GPIOSET_INTERACTIVE
+
+AM_CFLAGS += -DGPIOSET_INTERACTIVE
+LDADD += $(LIBEDIT_LIBS)
+
+endif
+
+bin_PROGRAMS = gpiodetect gpioinfo gpioget gpioset gpiomon
gpiodetect_SOURCES = gpiodetect.c
gpiomon_SOURCES = gpiomon.c
-gpiofind_SOURCES = gpiofind.c
-
EXTRA_DIST = gpio-tools-test gpio-tools-test.bats
if WITH_TESTS
# 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
#!/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=""
-
-GPIOSIM_CHIPS=""
-GPIOSIM_CONFIGFS="/sys/kernel/config/gpio-sim/"
+DUT_PID=""
+
+# 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.
# 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'
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
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)
+ local DEVNAME=${GPIOSIM_DEV_NAME[$1]}
+ local CHIPNAME=${GPIOSIM_CHIP_NAME[$1]}
- VAL=$(cat $GPIOSIM_SYSFS/$DEVNAME/$CHIPNAME/sim_gpio$OFFSET/value)
- if [ "$VAL" = "$EXPECTED" ]
- then
- return 0
- fi
-
- 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]+$")
rmdir $DEVPATH
done
- GPIOSIM_CHIPS=""
+ gpiosim_chip_symlink_cleanup
+
+ GPIOSIM_CHIP_NAME=()
+ GPIOSIM_CHIP_PATH=()
+ GPIOSIM_DEV_NAME=()
}
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: list chips" {
+@test "gpiodetect: all 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
-}
+ 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]}
-#
-# gpioinfo test cases
-#
+ run_tool gpiodetect
-@test "gpioinfo: dump all chips" {
- gpiosim_chip sim0 num_lines=4
- gpiosim_chip sim1 num_lines=8
+ 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
- run_tool gpioinfo
+ # ignoring symlinks
+ local initial_output=$output
+ gpiosim_chip_symlink sim1 /dev
- test "$status" -eq 0
- output_contains_line "$(gpiosim_chip_name sim0) - 4 lines:"
- output_contains_line "$(gpiosim_chip_name sim1) - 8 lines:"
+ run_tool gpiodetect
- 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"
+ output_is "$initial_output"
+ status_is 0
}
-@test "gpioinfo: dump all chips with one line exported" {
+@test "gpiodetect: a chip" {
gpiosim_chip sim0 num_lines=4
gpiosim_chip sim1 num_lines=8
+ gpiosim_chip sim2 num_lines=16
- coproc_run_tool gpioset --mode=signal --active-low "$(gpiosim_chip_name sim1)" 7=1
+ 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 gpioinfo
+ # by name
+ run_tool gpiodetect $sim0
- 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"
+ output_contains_line "$sim0 [${sim0dev}-node0] (4 lines)"
+ num_lines_is 1
+ status_is 0
- coproc_tool_kill
- coproc_tool_wait
-}
+ # by path
+ run_tool gpiodetect ${GPIOSIM_CHIP_PATH[sim1]}
-@test "gpioinfo: dump one chip" {
- gpiosim_chip sim0 num_lines=8
- gpiosim_chip sim1 num_lines=4
+ output_contains_line "$sim1 [${sim1dev}-node0] (8 lines)"
+ num_lines_is 1
+ status_is 0
+
+ # by number
+ run_tool gpiodetect $(gpiosim_chip_number sim2)
- run_tool gpioinfo "$(gpiosim_chip_name sim1)"
+ output_contains_line "$sim2 [${sim2dev}-node0] (16 lines)"
+ num_lines_is 1
+ status_is 0
- 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"
+ # 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 "gpioinfo: dump all but one chip" {
+@test "gpiodetect: multiple chips" {
gpiosim_chip sim0 num_lines=4
- gpiosim_chip sim1 num_lines=4
- gpiosim_chip sim2 num_lines=8
- gpiosim_chip sim3 num_lines=4
+ gpiosim_chip sim1 num_lines=8
+ gpiosim_chip sim2 num_lines=16
- run_tool gpioinfo "$(gpiosim_chip_name sim0)" \
- "$(gpiosim_chip_name sim1)" "$(gpiosim_chip_name sim3)"
+ 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]}
- 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"
+ 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 "gpioinfo: inexistent chip" {
- run_tool gpioinfo "inexistent"
+@test "gpiodetect: with nonexistent chip" {
+ run_tool gpiodetect nonexistent-chip
- test "$status" -eq 1
+ status_is 1
+ output_regex_match \
+".*cannot find GPIO chip character device 'nonexistent-chip'"
}
#
-# gpiofind test cases
+# gpioinfo 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" {
+@test "gpioinfo: all chips" {
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
-#
+ run_tool gpioinfo
-@test "gpioget: read all lines" {
- gpiosim_chip sim0 num_lines=8
+ 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
- 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
+ # ignoring symlinks
+ local initial_output=$output
+ gpiosim_chip_symlink sim1 /dev
- run_tool gpioget "$(gpiosim_chip_name sim0)" 0 1 2 3 4 5 6 7
+ run_tool gpioinfo
- test "$status" -eq "0"
- test "$output" = "0 0 1 1 0 1 0 1"
+ output_is "$initial_output"
+ status_is 0
}
-@test "gpioget: read all lines (active-low)" {
- gpiosim_chip sim0 num_lines=8
+@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
- 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 --banner --active-low foo=1 baz=0
- run_tool gpioget --active-low "$(gpiosim_chip_name sim0)" 0 1 2 3 4 5 6 7
+ run_tool gpioinfo
- test "$status" -eq "0"
- test "$output" = "1 1 0 0 1 0 1 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+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 "gpioget: read all lines (pull-up)" {
+@test "gpioinfo: a chip" {
gpiosim_chip sim0 num_lines=8
+ gpiosim_chip sim1 num_lines=4
- 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"
-}
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
-@test "gpioget: read all lines (pull-down)" {
- gpiosim_chip sim0 num_lines=8
+ # by name
+ run_tool gpioinfo --chip $sim1
- 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
+ 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
- run_tool gpioget --bias=pull-down "$(gpiosim_chip_name sim0)" 0 1 2 3 4 5 6 7
+ # by path
+ run_tool gpioinfo --chip $sim1
- test "$status" -eq "0"
- test "$output" = "0 0 0 0 0 0 0 0"
-}
+ 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 "gpioget: read some lines" {
- gpiosim_chip sim0 num_lines=8
+ # by number
+ run_tool gpioinfo --chip $sim1
- gpiosim_set_pull sim0 1 pull-up
- gpiosim_set_pull sim0 4 pull-up
- gpiosim_set_pull sim0 6 pull-up
+ 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
- run_tool gpioget "$(gpiosim_chip_name sim0)" 0 1 4 6
+ # by symlink
+ gpiosim_chip_symlink sim1 .
+ run_tool gpioinfo --chip $GPIOSIM_CHIP_LINK
- test "$status" -eq "0"
- test "$output" = "0 1 1 1"
+ 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 "gpioget: no arguments" {
- run_tool gpioget
+@test "gpioinfo: a line" {
+ gpiosim_chip sim0 num_lines=8 line_name=5:bar
+ gpiosim_chip sim1 num_lines=4 line_name=2:bar
- test "$status" -eq "1"
- output_regex_match ".*gpiochip must be specified"
-}
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
-@test "gpioget: no lines specified" {
- gpiosim_chip sim0 num_lines=8
+ # by offset
+ run_tool gpioinfo --chip $sim1 2
- run_tool gpioget "$(gpiosim_chip_name sim0)"
+ output_regex_match "$sim1 2\\s+\"bar\"\\s+input"
+ num_lines_is 1
+ status_is 0
- test "$status" -eq "1"
- output_regex_match ".*at least one GPIO line offset must be specified"
-}
+ # by name
+ run_tool gpioinfo bar
-@test "gpioget: too many lines specified" {
- gpiosim_chip sim0 num_lines=4
+ output_regex_match "$sim0 5\\s+\"bar\"\\s+input"
+ num_lines_is 1
+ status_is 0
- run_tool gpioget "$(gpiosim_chip_name sim0)" 0 1 2 3 4
+ # by chip and name
+ run_tool gpioinfo --chip $sim1 2
- test "$status" -eq "1"
- output_regex_match ".*unable to request lines.*"
-}
+ output_regex_match "$sim1 2\\s+\"bar\"\\s+input"
+ num_lines_is 1
+ status_is 0
-@test "gpioget: same line twice" {
- gpiosim_chip sim0 num_lines=8
+ # unquoted
+ run_tool gpioinfo --unquoted --chip $sim1 2
- run_tool gpioget "$(gpiosim_chip_name sim0)" 0 0
+ output_regex_match "$sim1 2\\s+bar\\s+input"
+ num_lines_is 1
+ status_is 0
- test "$status" -eq "1"
- output_regex_match ".*offsets must be unique"
}
-@test "gpioget: invalid bias" {
- gpiosim_chip sim0 num_lines=8
+@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
- run_tool gpioget --bias=bad "$(gpiosim_chip_name sim0)" 0 1
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- test "$status" -eq "1"
- output_regex_match ".*invalid bias.*"
+ run_tool gpioinfo foobar
+
+ output_regex_match "$sim0 3\\s+\"foobar\"\\s+input"
+ num_lines_is 1
+ status_is 0
}
-#
-# gpioset test cases
-#
+@test "gpioinfo: multiple lines" {
+ gpiosim_chip sim0 num_lines=8 line_name=5:bar
+ gpiosim_chip sim1 num_lines=4 line_name=2:baz
-@test "gpioset: set lines and wait for SIGTERM" {
- gpiosim_chip sim0 num_lines=8
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
- 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
+ # by offset
+ run_tool gpioinfo --chip $sim1 1 2
- 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
+ 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
- coproc_tool_kill
- coproc_tool_wait
+ # by name
+ run_tool gpioinfo bar baz
- test "$status" -eq "0"
-}
+ 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
-@test "gpioset: set lines and wait for SIGTERM (active-low)" {
- gpiosim_chip sim0 num_lines=8
+ # by name and offset
+ run_tool gpioinfo --chip $sim0 bar 3
- 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
+ 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
+}
- 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 "gpioinfo: line attribute menagerie" {
+ gpiosim_chip sim0 num_lines=4 line_name=1:foo
+ gpiosim_chip sim1 num_lines=8 line_name=3:baz
- coproc_tool_kill
- coproc_tool_wait
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+ local sim1=${GPIOSIM_CHIP_NAME[sim1]}
- test "$status" -eq "0"
-}
+ dut_run gpioset --banner --active-low --bias=pull-up --drive=open-source foo=1 baz=0
-@test "gpioset: set lines and wait for SIGTERM (push-pull)" {
- gpiosim_chip sim0 num_lines=8
+ run_tool gpioinfo foo baz
- 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
+ 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
- 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
+ dut_kill
+ dut_wait
- coproc_tool_kill
- coproc_tool_wait
+ dut_run gpioset --banner --bias=pull-down --drive=open-drain foo=1 baz=0
- test "$status" -eq "0"
-}
+ run_tool gpioinfo foo baz
-@test "gpioset: set lines and wait for SIGTERM (open-drain)" {
- gpiosim_chip sim0 num_lines=8
+ 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
- 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_kill
+ dut_wait
- 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
+ dut_run gpiomon --banner --bias=disabled --utc -p 10ms foo baz
- 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
+ run_tool gpioinfo foo baz
- coproc_tool_kill
- coproc_tool_wait
+ 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
- test "$status" -eq "0"
-}
+ dut_kill
+ dut_wait
-@test "gpioset: set lines and wait for SIGTERM (open-source)" {
- gpiosim_chip sim0 num_lines=8
+ dut_run gpiomon --banner --edges=rising --localtime foo baz
- 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 gpioinfo foo baz
- 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
+ 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
- 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
+ dut_kill
+ dut_wait
- coproc_tool_kill
- coproc_tool_wait
+ dut_run gpiomon --banner --edges=falling foo baz
- test "$status" -eq "0"
+ 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 "gpioset: set some lines and wait for ENTER" {
- gpiosim_chip sim0 num_lines=8
+@test "gpioinfo: with same line twice" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
- coproc_run_tool gpioset --mode=wait "$(gpiosim_chip_name sim0)" \
- 1=0 2=1 5=1 6=0 7=1
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- 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
+ # by offset
+ run_tool gpioinfo --chip $sim0 1 1
- coproc_tool_stdin_write ""
- coproc_tool_wait
+ 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
- test "$status" -eq "0"
-}
+ # by name
+ run_tool gpioinfo foo foo
-@test "gpioset: set some lines and wait for SIGINT" {
- gpiosim_chip sim0 num_lines=4
+ 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
- coproc_run_tool gpioset --mode=signal "$(gpiosim_chip_name sim0)" 0=1
+ # by name and offset
+ run_tool gpioinfo --chip $sim0 foo 1
- gpiosim_check_value sim0 0 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]}
- coproc_tool_kill -SIGINT
- coproc_tool_wait
+ run_tool gpioinfo --strict foobar
- test "$status" -eq "0"
+ 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 "gpioset: set some lines and wait with --mode=time" {
- gpiosim_chip sim0 num_lines=8
+@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
- coproc_run_tool gpioset --mode=time --sec=1 --usec=200000 \
- "$(gpiosim_chip_name sim0)" 0=1 5=0 7=1
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- gpiosim_check_value sim0 0 1
- gpiosim_check_value sim0 5 0
- gpiosim_check_value sim0 7 1
+ # first by offset (to show offsets match first)
+ run_tool gpioinfo --chip $sim0 1 6
- coproc_tool_wait
+ 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
- test "$status" -eq "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 "gpioset: no arguments" {
- run_tool gpioset
+@test "gpioinfo: with nonexistent chip" {
+ run_tool gpioinfo --chip nonexistent-chip
- test "$status" -eq "1"
- output_regex_match ".*gpiochip must be specified"
+ output_regex_match \
+".*cannot find GPIO chip character device 'nonexistent-chip'"
+ status_is 1
}
-@test "gpioset: no lines specified" {
+@test "gpioinfo: with nonexistent line" {
gpiosim_chip sim0 num_lines=8
- run_tool gpioset "$(gpiosim_chip_name sim1)"
+ run_tool gpioinfo nonexistent-line
+
+ output_regex_match ".*cannot find line 'nonexistent-line'"
+ status_is 1
- test "$status" -eq "1"
- output_regex_match ".*at least one GPIO line offset to value mapping must be specified"
+ run_tool gpioinfo --chip ${GPIOSIM_CHIP_NAME[sim0]} nonexistent-line
+
+ output_regex_match ".*cannot find line 'nonexistent-line'"
+ status_is 1
}
-@test "gpioset: too many lines specified" {
+@test "gpioinfo: with offset out of range" {
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
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ run_tool gpioinfo --chip $sim0 0 1 2 3 4 5
- test "$status" -eq "1"
- output_regex_match ".*unable to request lines.*"
+ 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
}
-@test "gpioset: use --sec without --mode=time" {
- gpiosim_chip sim0 num_lines=8
+#
+# gpioget test cases
+#
- run_tool gpioset --mode=exit --sec=1 "$(gpiosim_chip_name sim0)" 0=1
+@test "gpioget: by name" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
- test "$status" -eq "1"
- output_regex_match ".*can't specify wait time in this mode"
-}
+ gpiosim_set_pull sim0 1 pull-up
-@test "gpioset: use --usec without --mode=time" {
- gpiosim_chip sim0 num_lines=8
+ run_tool gpioget foo
+
+ output_is "\"foo\"=active"
+ status_is 0
- run_tool gpioset --mode=exit --usec=1 "$(gpiosim_chip_name sim1)" 0=1
+ run_tool gpioget --unquoted foo
- test "$status" -eq "1"
- output_regex_match ".*can't specify wait time in this mode"
+ output_is "foo=active"
+ status_is 0
}
-@test "gpioset: default mode" {
+@test "gpioget: by offset" {
gpiosim_chip sim0 num_lines=8
- run_tool gpioset "$(gpiosim_chip_name sim0)" 0=1
+ gpiosim_set_pull sim0 1 pull-up
- test "$status" -eq "0"
-}
+ run_tool gpioget --chip ${GPIOSIM_CHIP_NAME[sim0]} 1
-@test "gpioset: invalid mapping" {
- gpiosim_chip sim0 num_lines=8
+ output_is "\"1\"=active"
+ status_is 0
- run_tool gpioset "$(gpiosim_chip_name sim1)" 0=c
+ run_tool gpioget --unquoted --chip ${GPIOSIM_CHIP_NAME[sim0]} 1
- test "$status" -eq "1"
- output_regex_match ".*invalid offset<->value mapping"
+ output_is "1=active"
+ status_is 0
}
-@test "gpioset: invalid value" {
+@test "gpioget: by symlink" {
gpiosim_chip sim0 num_lines=8
+ gpiosim_chip_symlink sim0 .
+
+ gpiosim_set_pull sim0 1 pull-up
- run_tool gpioset "$(gpiosim_chip_name sim1)" 0=3
+ run_tool gpioget --chip $GPIOSIM_CHIP_LINK 1
- test "$status" -eq "1"
- output_regex_match ".*value must be 0 or 1"
+ output_is "\"1\"=active"
+ status_is 0
}
-@test "gpioset: invalid offset" {
- gpiosim_chip sim0 num_lines=8
+@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
- run_tool gpioset "$(gpiosim_chip_name sim1)" 4000000000=0
+ gpiosim_set_pull sim1 3 pull-up
- test "$status" -eq "1"
- output_regex_match ".*invalid offset"
-}
+ run_tool gpioget --chip ${GPIOSIM_CHIP_NAME[sim1]} foo
-@test "gpioset: invalid bias" {
- gpiosim_chip sim0 num_lines=8
+ output_is "\"foo\"=active"
+ status_is 0
- run_tool gpioset --bias=bad "$(gpiosim_chip_name sim1)" 0=1 1=1
+ run_tool gpioget --unquoted --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 --unquoted --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 --unquoted --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 --unquoted --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 --unquoted --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 -t0 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
+
+ run_tool gpioget --chip ${GPIOSIM_CHIP_NAME[sim0]} 1 6
+
+ output_is "\"1\"=active \"6\"=inactive"
+ status_is 0
+
+ run_tool gpioget --unquoted --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
+
+ run_tool gpioget --by-name --unquoted --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 --banner foo=1
+
+ gpiosim_check_value sim0 1 1
+}
+
+@test "gpioset: by offset" {
+ gpiosim_chip sim0 num_lines=8
+
+ dut_run gpioset --banner --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 --banner --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 --banner --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 --banner 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 --banner --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 --banner --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 --banner 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 --banner --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 consumer" {
+ 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 --banner --consumer gpio-tools-tests foo=1 baz=0
+
+ run_tool gpioinfo
+
+ output_regex_match "\\s+line\\s+0:\\s+unnamed\\s+input"
+ output_regex_match \
+"\\s+line\\s+1:\\s+\"foo\"\\s+output consumer=\"gpio-tools-tests\""
+ output_regex_match \
+"\\s+line\\s+3:\\s+\"baz\"\\s+output consumer=\"gpio-tools-tests\""
+ status_is 0
+}
+
+@test "gpioset: with push-pull" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpioset --banner --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 --banner --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 --banner --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 --banner --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 --banner --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 --banner --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
+
+ dut_run gpioset --banner --hold-period=1200ms -t0 --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 get unquoted" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo line_name=4:bar \
+ line_name=7:baz
+
+ dut_run gpioset --interactive --unquoted 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 -i 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
+
+ dut_run gpioset --banner --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
+
+ # hold-period to allow test to sample before gpioset exits
+ dut_run gpioset --banner --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
+
+ # using --toggle 0 to exit
+ # hold-period to allow test to sample before gpioset exits
+ dut_run gpioset --banner -t0 -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
+
+ 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 --banner --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 --banner --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
- test "$status" -eq "1"
output_regex_match ".*invalid bias.*"
+ status_is 1
}
-@test "gpioset: invalid drive" {
+@test "gpioset: with invalid drive" {
gpiosim_chip sim0 num_lines=8
- run_tool gpioset --drive=bad "$(gpiosim_chip_name sim1)" 0=1 1=1
+ run_tool gpioset --drive=bad --chip ${GPIOSIM_CHIP_NAME[sim0]} 0=1 1=1
- test "$status" -eq "1"
output_regex_match ".*invalid drive.*"
+ status_is 1
}
-@test "gpioset: daemonize in invalid mode" {
+@test "gpioset: with interactive and toggle" {
gpiosim_chip sim0 num_lines=8
- run_tool gpioset --background "$(gpiosim_chip_name sim1)" 0=1
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- test "$status" -eq "1"
- output_regex_match ".*can't daemonize in this mode"
+ run_tool gpioset --interactive --toggle 1s --chip $sim0 0=1
+
+ output_regex_match ".*can't combine interactive with toggle"
+ status_is 1
}
-@test "gpioset: same line twice" {
- gpiosim_chip sim0 num_lines=8
+@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
- run_tool gpioset "$(gpiosim_chip_name sim0)" 0=1 0=1
+ # by name and offset
+ run_tool gpioset --chip $sim0 foo=1 1=1
- test "$status" -eq "1"
- output_regex_match ".*offsets must be unique"
+ 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: single rising edge event" {
- gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon --rising-edge "$(gpiosim_chip_name sim0)" 4
+@test "gpiomon: by name" {
+ gpiosim_chip sim0 num_lines=8 line_name=4:foo
gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
- coproc_tool_kill
- coproc_tool_wait
+ dut_run gpiomon --banner --edges=rising foo
+ dut_flush
- test "$status" -eq "0"
- output_regex_match \
-"event:\\s+RISING\\s+EDGE\\s+offset:\\s+4\\s+timestamp:\\s+\[\s*[0-9]+\.[0-9]+\]"
+ 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: single falling edge event" {
+@test "gpiomon: by offset" {
gpiosim_chip sim0 num_lines=8
- coproc_run_tool gpiomon --falling-edge "$(gpiosim_chip_name sim0)" 4
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
gpiosim_set_pull sim0 4 pull-up
- gpiosim_set_pull sim0 4 pull-down
- sleep 0.2
- coproc_tool_kill
- coproc_tool_wait
+ dut_run gpiomon --banner --edges=rising --chip $sim0 4
+ dut_regex_match "Monitoring line .*"
- test "$status" -eq "0"
- output_regex_match \
-"event:\\s+FALLING\\s+EDGE\\s+offset:\\s+4\\s+timestamp:\\s+\[\s*[0-9]+\.[0-9]+\]"
+ 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: single falling edge event (pull-up)" {
+@test "gpiomon: by symlink" {
gpiosim_chip sim0 num_lines=8
+ gpiosim_chip_symlink sim0 .
- gpiosim_set_pull sim0 4 pull-down
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- coproc_run_tool gpiomon --bias=pull-up "$(gpiosim_chip_name sim0)" 4
+ 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
- sleep 0.2
+ 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
+}
- 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: 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: single rising edge event (pull-down)" {
+@test "gpiomon: rising edge" {
gpiosim_chip sim0 num_lines=8
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
gpiosim_set_pull sim0 4 pull-up
- coproc_run_tool gpiomon --bias=pull-down "$(gpiosim_chip_name sim0)" 4
+ 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
- sleep 0.2
+ gpiosim_set_pull sim0 4 pull-down
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+$sim0 4"
+ assert_fail dut_readable
+}
- coproc_tool_kill
- coproc_tool_wait
+@test "gpiomon: falling edge" {
+ gpiosim_chip sim0 num_lines=8
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- test "$status" -eq "0"
- output_regex_match \
-"event:\\s+RISING\\s+EDGE\\s+offset:\\s+4\\s+timestamp:\\s+\[\s*[0-9]+\.[0-9]+\]"
+ 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: single rising edge event (active-low)" {
+@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"
+}
- coproc_run_tool gpiomon --rising-edge --active-low "$(gpiosim_chip_name 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
- sleep 0.2
- coproc_tool_kill
- coproc_tool_wait
+ dut_run gpiomon --banner --bias=pull-up --chip $sim0 4
+ dut_flush
- test "$status" -eq "0"
- output_regex_match \
-"event:\\s+RISING\\s+EDGE\\s+offset:\\s+4\\s+timestamp:\\s+\[\s*[0-9]+\.[0-9]+\]"
+ 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: single rising edge event (silent mode)" {
+@test "gpiomon: with pull-down" {
gpiosim_chip sim0 num_lines=8
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ gpiosim_set_pull sim0 4 pull-up
- coproc_run_tool gpiomon --rising-edge --silent "$(gpiosim_chip_name sim0)" 4
+ dut_run gpiomon --banner --bias=pull-down --chip $sim0 4
+ dut_flush
gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
- coproc_tool_kill
- coproc_tool_wait
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+$sim0 4"
- test "$status" -eq "0"
- test -z "$output"
+ assert_fail dut_readable
}
-@test "gpiomon: four alternating events" {
+@test "gpiomon: with active-low" {
gpiosim_chip sim0 num_lines=8
-
- coproc_run_tool gpiomon --num-events=4 "$(gpiosim_chip_name sim0)" 4
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
+
+ dut_run gpiomon --banner --active-low --chip $sim0 4
+ dut_flush
+
gpiosim_set_pull sim0 4 pull-down
- sleep 0.2
+ dut_regex_match "[0-9]+\.[0-9]+\\s+rising\\s+$sim0 4"
+
gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
- gpiosim_set_pull sim0 4 pull-down
- sleep 0.2
+ dut_regex_match "[0-9]+\.[0-9]+\\s+falling\\s+$sim0 4"
+
+ assert_fail dut_readable
+}
+
+@test "gpiomon: with consumer" {
+ 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
- coproc_tool_wait
+ dut_run gpiomon --banner --consumer gpio-tools-tests foo baz
+
+ run_tool gpioinfo
- test "$status" -eq "0"
+ output_regex_match "\\s+line\\s+0:\\s+unnamed\\s+input"
output_regex_match \
-"event\\:\\s+FALLING\\s+EDGE\\s+offset\\:\\s+4\\s+timestamp:\\s+\\[\s*[0-9]+\\.[0-9]+\\]"
+"\\s+line\\s+1:\\s+\"foo\"\\s+input edges=both consumer=\"gpio-tools-tests\""
output_regex_match \
-"event\\:\\s+RISING\\s+EDGE\\s+offset\\:\\s+4\\s+timestamp:\\s+\\[\s*[0-9]+\\.[0-9]+\\]"
+"\\s+line\\s+3:\\s+\"baz\"\\s+input edges=both consumer=\"gpio-tools-tests\""
+ status_is 0
}
-@test "gpiomon: exit after SIGINT" {
+@test "gpiomon: with quiet mode" {
gpiosim_chip sim0 num_lines=8
- coproc_run_tool gpiomon "$(gpiosim_chip_name sim0)" 4
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- coproc_tool_kill -SIGINT
- coproc_tool_wait
+ dut_run gpiomon --banner --edges=rising --quiet --chip $sim0 4
+ dut_flush
- test "$status" -eq "0"
- test -z "$output"
+ gpiosim_set_pull sim0 4 pull-up
+ assert_fail dut_readable
}
-@test "gpiomon: exit after SIGTERM" {
- gpiosim_chip sim0 num_lines=8
+@test "gpiomon: with unquoted" {
+ gpiosim_chip sim0 num_lines=8 line_name=4:foo
- coproc_run_tool gpiomon "$(gpiosim_chip_name sim0)" 4
+ gpiosim_set_pull sim0 4 pull-up
- coproc_tool_kill -SIGTERM
- coproc_tool_wait
+ dut_run gpiomon --banner --unquoted --edges=rising foo
+ dut_flush
- test "$status" -eq "0"
- test -z "$output"
+ 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: both event flags" {
+@test "gpiomon: with num-events" {
gpiosim_chip sim0 num_lines=8
- coproc_run_tool gpiomon --falling-edge --rising-edge "$(gpiosim_chip_name sim0)" 4
+ 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
- sleep 0.2
gpiosim_set_pull sim0 4 pull-down
- sleep 0.2
+ gpiosim_set_pull sim0 4 pull-up
+ gpiosim_set_pull sim0 4 pull-down
- coproc_tool_kill
- coproc_tool_wait
+ dut_wait
+ status_is 0
+ dut_read_redirect
- 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]+\\]"
+ 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: watch multiple lines" {
+@test "gpiomon: multiple lines" {
gpiosim_chip sim0 num_lines=8
- coproc_run_tool gpiomon --format=%o "$(gpiosim_chip_name sim0)" 1 2 3 4 5
+ 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
- sleep 0.2
+ 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
- coproc_tool_kill
- coproc_tool_wait
+ 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"
- test "$status" -eq "0"
- test "${lines[0]}" = "2"
- test "${lines[1]}" = "3"
- test "${lines[2]}" = "4"
+ assert_fail dut_readable
}
-@test "gpiomon: watch multiple lines (lines in mixed-up order)" {
- gpiosim_chip sim0 num_lines=8
+@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
- coproc_run_tool gpiomon --format=%o "$(gpiosim_chip_name sim0)" 5 2 7 1 6
+ 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
- gpiosim_set_pull sim0 6 pull-up
- sleep 0.2
+ 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]}
- coproc_tool_kill
- coproc_tool_wait
+ dut_run gpiomon --banner --chip $sim0 4
+ dut_regex_match "Monitoring line .*"
- test "$status" -eq "0"
- test "${lines[0]}" = "2"
- test "${lines[1]}" = "1"
- test "${lines[2]}" = "6"
+ dut_kill -SIGINT
+ dut_wait
+
+ status_is 130
}
-@test "gpiomon: same line twice" {
+@test "gpiomon: exit after SIGTERM" {
gpiosim_chip sim0 num_lines=8
- run_tool gpiomon "$(gpiosim_chip_name sim0)" 0 0
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- test "$status" -eq "1"
- output_regex_match ".*offsets must be unique"
+ dut_run gpiomon --banner --chip $sim0 4
+ dut_regex_match "Monitoring line .*"
+
+ dut_kill -SIGTERM
+ dut_wait
+
+ status_is 143
}
-@test "gpiomon: no arguments" {
- run_tool gpiomon
+@test "gpiomon: with nonexistent line" {
+ run_tool gpiomon nonexistent-line
- test "$status" -eq "1"
- output_regex_match ".*gpiochip must be specified"
+ status_is 1
+ output_regex_match ".*cannot find line 'nonexistent-line'"
}
-@test "gpiomon: line not specified" {
- gpiosim_chip sim0 num_lines=8
+@test "gpiomon: with same line twice" {
+ gpiosim_chip sim0 num_lines=8 line_name=1:foo
- run_tool gpiomon "$(gpiosim_chip_name sim0)"
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- test "$status" -eq "1"
- output_regex_match ".*GPIO line offset must be specified"
+ # 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: line out of range" {
- gpiosim_chip sim0 num_lines=4
+@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 "$(gpiosim_chip_name sim0)" 5
+ run_tool gpiomon --strict foobar
- test "$status" -eq "1"
- output_regex_match ".*unable to request lines"
+ 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
-@test "gpiomon: invalid bias" {
- gpiosim_chip sim0 num_lines=8
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- run_tool gpiomon --bias=bad "$(gpiosim_chip_name sim0)" 0 1
+ gpiosim_set_pull sim0 1 pull-up
- test "$status" -eq "1"
- output_regex_match ".*invalid bias.*"
+ 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: custom format (event type + offset)" {
- gpiosim_chip sim0 num_lines=8
+@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
- coproc_run_tool gpiomon "--format=%e %o" "$(gpiosim_chip_name sim0)" 4
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
+ 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"
- coproc_tool_kill
- coproc_tool_wait
+ assert_fail dut_readable
+}
+
+@test "gpiomon: with no arguments" {
+ run_tool gpiomon
- test "$status" -eq "0"
- test "$output" = "1 4"
+ output_regex_match ".*at least one GPIO line must be specified"
+ status_is 1
}
-@test "gpiomon: custom format (event type + offset joined)" {
+@test "gpiomon: with no line specified" {
gpiosim_chip sim0 num_lines=8
- coproc_run_tool gpiomon "--format=%e%o" "$(gpiosim_chip_name sim0)" 4
+ run_tool gpiomon --chip ${GPIOSIM_CHIP_NAME[sim0]}
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
+ 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
- coproc_tool_kill
- coproc_tool_wait
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- test "$status" -eq "0"
- test "$output" = "14"
+ run_tool gpiomon --chip $sim0 5
+
+ output_regex_match ".*offset 5 is out of range on chip '$sim0'"
+ status_is 1
}
-@test "gpiomon: custom format (timestamp)" {
+@test "gpiomon: with invalid bias" {
gpiosim_chip sim0 num_lines=8
- coproc_run_tool gpiomon "--format=%e %o %s.%n" "$(gpiosim_chip_name sim0)" 4
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
+ 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
- coproc_tool_kill
- coproc_tool_wait
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- test "$status" -eq "0"
- output_regex_match "1 4 [0-9]+\\.[0-9]+"
+ 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: custom format (double percent sign)" {
+@test "gpiomon: with custom format (event type + offset joined)" {
gpiosim_chip sim0 num_lines=8
- coproc_run_tool gpiomon "--format=%%" "$(gpiosim_chip_name sim0)" 4
+ 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
- sleep 0.2
+ dut_read
+ output_is "14"
+}
+
+@test "gpiomon: with custom format (edge, chip and line)" {
+ gpiosim_chip sim0 num_lines=8 line_name=4:baz
- coproc_tool_kill
- coproc_tool_wait
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- test "$status" -eq "0"
- test "$output" = "%"
+ 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: custom format (double percent sign + event type specifier)" {
+@test "gpiomon: with custom format (seconds timestamp)" {
gpiosim_chip sim0 num_lines=8
- coproc_run_tool gpiomon "--format=%%e" "$(gpiosim_chip_name sim0)" 4
+ 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
- sleep 0.2
+ 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]}
- coproc_tool_kill
- coproc_tool_wait
+ dut_run gpiomon --banner "--format=%U %e %o " --event-clock=realtime \
+ -c $sim0 4
+ dut_flush
- test "$status" -eq "0"
- test "$output" = "%e"
+ 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: custom format (single percent sign)" {
+@test "gpiomon: with custom format (localtime timestamp)" {
gpiosim_chip sim0 num_lines=8
- coproc_run_tool gpiomon "--format=%" "$(gpiosim_chip_name sim0)" 4
+ 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
- sleep 0.2
+ 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
- coproc_tool_kill
- coproc_tool_wait
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- test "$status" -eq "0"
- test "$output" = "%"
+ 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: custom format (single percent sign between other characters)" {
+@test "gpiomon: with custom format (double percent sign + event type specifier)" {
gpiosim_chip sim0 num_lines=8
- coproc_run_tool gpiomon "--format=foo % bar" "$(gpiosim_chip_name sim0)" 4
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
+
+ dut_run gpiomon --banner "--format=%%e" -c $sim0 4
+ dut_flush
gpiosim_set_pull sim0 4 pull-up
- sleep 0.2
+ 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]}
- coproc_tool_kill
- coproc_tool_wait
+ dut_run gpiomon --banner "--format=%" -c $sim0 4
+ dut_flush
- test "$status" -eq "0"
- test "$output" = "foo % bar"
+ gpiosim_set_pull sim0 4 pull-up
+ dut_read
+ output_is "%"
}
-@test "gpiomon: custom format (unknown specifier)" {
+@test "gpiomon: with custom format (single percent sign between other characters)" {
gpiosim_chip sim0 num_lines=8
- coproc_run_tool gpiomon "--format=%x" "$(gpiosim_chip_name sim0)" 4
+ 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
- sleep 0.2
+ dut_read
+ output_is "foo % bar"
+}
- coproc_tool_kill
- coproc_tool_wait
+@test "gpiomon: with custom format (unknown specifier)" {
+ gpiosim_chip sim0 num_lines=8
+
+ local sim0=${GPIOSIM_CHIP_NAME[sim0]}
- test "$status" -eq "0"
- test "$output" = "%x"
+ dut_run gpiomon --banner "--format=%x" -c $sim0 4
+ dut_flush
+
+ gpiosim_set_pull sim0 4 pull-up
+ dut_read
+ output_is "%x"
}
// 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>
#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("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("List all GPIO chips, print their labels and number of GPIO lines.\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 message and exit\n");
- printf(" -v, --version:\tdisplay the version and exit\n");
+ printf(" -h, --help\t\tdisplay this help and exit\n");
+ printf(" -v, --version\t\toutput version information and exit\n");
}
-int main(int argc, char **argv)
+static int parse_config(int argc, char **argv)
{
- int optc, opti, num_chips, i;
- struct gpiod_chip *chip;
- struct gpiod_chip_info *info;
- struct dirent **entries;
+ static const struct option longopts[] = {
+ { "help", no_argument, NULL, 'h' },
+ { "version", no_argument, NULL, 'v' },
+ { GETOPT_NULL_LONGOPT },
+ };
+
+ static const char *const shortopts = "+hv";
+
+ int optc, opti;
for (;;) {
optc = getopt_long(argc, argv, shortopts, longopts, &opti);
switch (optc) {
case 'h':
print_help();
- return EXIT_SUCCESS;
+ exit(EXIT_SUCCESS);
case 'v':
print_version();
- return EXIT_SUCCESS;
+ exit(EXIT_SUCCESS);
case '?':
die("try %s --help", get_progname());
default:
abort();
}
}
+ return optind;
+}
- argc -= optind;
- argv += optind;
+static int print_chip_info(const char *path)
+{
+ struct gpiod_chip_info *info;
+ struct gpiod_chip *chip;
+
+ chip = gpiod_chip_open(path);
+ if (!chip) {
+ print_perror("unable to open chip '%s'", path);
+ return 1;
+ }
- if (argc > 0)
- die("unrecognized argument: %s", argv[0]);
+ info = gpiod_chip_get_info(chip);
+ if (!info)
+ die_perror("unable to read info for '%s'", path);
- num_chips = scandir("/dev/", &entries, chip_dir_filter, alphasort);
- if (num_chips < 0)
- die_perror("unable to scan /dev");
+ 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));
- 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);
+ gpiod_chip_info_free(info);
+ gpiod_chip_close(chip);
- info = gpiod_chip_get_info(chip);
- if (!info)
- die_perror("unable to get info for %s", entries[i]->d_name);
+ return 0;
+}
+int main(int argc, char **argv)
+{
+ int num_chips, i, ret = EXIT_SUCCESS;
+ char **paths, *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));
+ i = parse_config(argc, argv);
+ argc -= i;
+ argv += i;
- gpiod_chip_info_free(info);
- gpiod_chip_close(chip);
- free(entries[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);
}
- free(entries);
+ 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 EXIT_SUCCESS;
+ return ret;
}
+++ /dev/null
-// 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;
-}
// 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 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 },
+struct config {
+ bool active_low;
+ bool by_name;
+ bool numeric;
+ bool strict;
+ bool unquoted;
+ int bias;
+ int direction;
+ unsigned int hold_period_us;
+ const char *chip_id;
+ const char *consumer;
};
-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("Usage: %s [OPTIONS] <line>...\n", get_progname());
printf("\n");
- printf("Read line value(s) from a GPIO chip\n");
+ printf("Read values 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");
- 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("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(" -C, --consumer <name>\tconsumer name applied to requested lines (default is 'gpioget')\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(" --unquoted\tdon't quote line names\n");
+ printf(" -v, --version\t\toutput version information and exit\n");
+ print_chip_help();
+ print_period_help();
}
-int main(int argc, char **argv)
+static int parse_config(int argc, char **argv, struct config *cfg)
{
- 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;
+ static 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, NULL, 'B' },
+ { "chip", required_argument, NULL, 'c' },
+ { "consumer", required_argument, NULL, 'C' },
+ { "help", no_argument, NULL, 'h' },
+ { "hold-period", required_argument, NULL, 'p' },
+ { "numeric", no_argument, NULL, 'N' },
+ { "strict", no_argument, NULL, 's' },
+ { "unquoted", no_argument, NULL, 'Q' },
+ { "version", no_argument, NULL, 'v' },
+ { GETOPT_NULL_LONGOPT },
+ };
+
+ static const char *const shortopts = "+ab:c:C:hlp:sv";
+
+ int opti, optc;
+
+ memset(cfg, 0, sizeof(*cfg));
+ cfg->direction = GPIOD_LINE_DIRECTION_INPUT;
+ cfg->consumer = "gpioget";
for (;;) {
optc = getopt_long(argc, argv, shortopts, longopts, &opti);
break;
switch (optc) {
- case 'h':
- print_help();
- return EXIT_SUCCESS;
- case 'v':
- print_version();
- return EXIT_SUCCESS;
- case 'l':
- active_low = true;
+ case 'a':
+ cfg->direction = GPIOD_LINE_DIRECTION_AS_IS;
break;
- case 'n':
- direction = GPIOD_LINE_DIRECTION_AS_IS;
+ case 'b':
+ cfg->bias = parse_bias_or_die(optarg);
break;
case 'B':
- bias = parse_bias(optarg);
+ cfg->by_name = true;
+ break;
+ case 'c':
+ cfg->chip_id = optarg;
+ break;
+ case 'C':
+ cfg->consumer = optarg;
+ break;
+ case 'l':
+ cfg->active_low = true;
+ break;
+ case 'N':
+ cfg->numeric = true;
+ break;
+ case 'p':
+ cfg->hold_period_us = parse_period_or_die(optarg);
break;
+ case 'Q':
+ cfg->unquoted = 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();
}
}
- 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");
+ return optind;
+}
- device = argv[0];
- num_lines = argc - 1;
+int main(int argc, char **argv)
+{
+ struct gpiod_line_settings *settings;
+ struct gpiod_request_config *req_cfg;
+ struct gpiod_line_request *request;
+ struct gpiod_line_config *line_cfg;
+ int i, num_lines, ret, *values;
+ struct line_resolver *resolver;
+ struct resolved_line *line;
+ struct gpiod_chip *chip;
+ unsigned int *offsets;
+ struct config cfg;
+ const char *fmt;
- offsets = calloc(num_lines, sizeof(*offsets));
- values = calloc(num_lines, sizeof(*values));
- if (!offsets || ! values)
- die("out of memory");
+ i = parse_config(argc, argv, &cfg);
+ argc -= i;
+ argv += i;
- 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 (argc < 1)
+ die("at least one GPIO line must be specified");
- if (has_duplicate_offsets(num_lines, offsets))
- die("offsets must be unique");
+ resolver = resolve_lines(argc, argv, cfg.chip_id, cfg.strict,
+ cfg.by_name);
+ validate_resolution(resolver, cfg.chip_id);
- chip = chip_open_lookup(device);
- if (!chip)
- die_perror("unable to open %s", device);
+ 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, direction);
+ gpiod_line_settings_set_direction(settings, cfg.direction);
- if (bias)
- gpiod_line_settings_set_bias(settings, bias);
+ if (cfg.bias)
+ gpiod_line_settings_set_bias(settings, cfg.bias);
- if (active_low)
- gpiod_line_settings_set_active_low(settings, active_low);
+ 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");
- 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");
+ gpiod_request_config_set_consumer(req_cfg, cfg.consumer);
+
+ 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);
+ }
- request = gpiod_chip_request_lines(chip, req_cfg, line_cfg);
- if (!request)
- die_perror("unable to request lines");
+ fmt = cfg.unquoted ? "%s=%s" : "\"%s\"=%s";
- ret = gpiod_line_request_get_values(request, values);
- if (ret)
- die_perror("unable to read GPIO line values");
+ for (i = 0; i < resolver->num_lines; i++) {
+ line = &resolver->lines[i];
+ if (cfg.numeric)
+ printf("%d", line->value);
+ else
+ printf(fmt, line->id,
+ line->value ? "active" : "inactive");
- for (i = 0; i < num_lines; i++) {
- printf("%d", values[i]);
- if (i != num_lines - 1)
+ if (i != resolver->num_lines - 1)
printf(" ");
}
printf("\n");
- gpiod_line_request_release(request);
+ free_line_resolver(resolver);
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);
// 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>
#include "tools-common.h"
-typedef bool (*is_set_func)(struct gpiod_line_info *);
-
-struct flag {
- const char *name;
- is_set_func is_set;
+struct config {
+ bool by_name;
+ bool strict;
+ bool unquoted_strings;
+ const char *chip_id;
};
-static bool line_bias_is_pullup(struct gpiod_line_info *info)
+static void print_help(void)
{
- return gpiod_line_info_get_bias(info) == GPIOD_LINE_BIAS_PULL_UP;
+ 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 then 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(" --unquoted\tdon't quote line or consumer names\n");
+ printf(" -v, --version\t\toutput version information and exit\n");
+ print_chip_help();
}
-static bool line_bias_is_pulldown(struct gpiod_line_info *info)
+static int parse_config(int argc, char **argv, struct config *cfg)
{
- return gpiod_line_info_get_bias(info) == GPIOD_LINE_BIAS_PULL_DOWN;
-}
+ static const struct option longopts[] = {
+ { "by-name", no_argument, NULL, 'B' },
+ { "chip", required_argument, NULL, 'c' },
+ { "help", no_argument, NULL, 'h' },
+ { "strict", no_argument, NULL, 's' },
+ { "unquoted", no_argument, NULL, 'Q' },
+ { "version", no_argument, NULL, 'v' },
+ { GETOPT_NULL_LONGOPT },
+ };
-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 const char *const shortopts = "+c:hsv";
+
+ int opti, optc;
+
+ memset(cfg, 0, sizeof(*cfg));
+
+ for (;;) {
+ optc = getopt_long(argc, argv, shortopts, longopts, &opti);
+ if (optc < 0)
+ break;
+
+ switch (optc) {
+ case 'B':
+ cfg->by_name = true;
+ break;
+ case 'c':
+ cfg->chip_id = optarg;
+ break;
+ case 's':
+ cfg->strict = true;
+ break;
+ case 'h':
+ print_help();
+ exit(EXIT_SUCCESS);
+ case 'Q':
+ cfg->unquoted_strings = true;
+ break;
+ case 'v':
+ print_version();
+ exit(EXIT_SUCCESS);
+ case '?':
+ die("try %s --help", get_progname());
+ case 0:
+ break;
+ default:
+ abort();
+ }
+ }
+
+ return optind;
}
-static bool line_drive_is_open_source(struct gpiod_line_info *info)
+/*
+ * 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)
{
- return gpiod_line_info_get_drive(info) == GPIOD_LINE_DRIVE_OPEN_SOURCE;
-}
+ struct resolved_line *line;
+ bool resolved = false;
+ unsigned int offset;
+ const char *name;
+ int i;
-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,
- },
-};
+ offset = gpiod_line_info_get_offset(info);
-static const struct option longopts[] = {
- { "help", no_argument, NULL, 'h' },
- { "version", no_argument, NULL, 'v' },
- { GETOPT_NULL_LONGOPT },
-};
+ for (i = 0; i < resolver->num_lines; i++) {
+ line = &resolver->lines[i];
-static const char *const shortopts = "+hv";
+ /* already resolved by offset? */
+ if (line->resolved &&
+ (line->offset == offset) &&
+ (line->chip_num == chip_num)) {
+ resolved = true;
+ }
-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");
+ 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 PRINTF(3, 4) void prinfo(bool *of,
- unsigned int prlen, const char *fmt, ...)
+static void print_line_info(struct gpiod_line_info *info, bool unquoted_strings)
{
- 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));
+ char quoted_name[17];
+ const char *name;
+ int len;
+
+ name = gpiod_line_info_get_name(info);
+ if (!name) {
+ name = "unnamed";
+ unquoted_strings = true;
+ }
- printf(buffmt, buf);
+ if (unquoted_strings) {
+ printf("%-16s\t", name);
+ } else {
+ len = strlen(name);
+ if (len <= 14) {
+ quoted_name[0] = '"';
+ memcpy("ed_name[1], name, len);
+ quoted_name[len + 1] = '"';
+ quoted_name[len + 2] = '\0';
+ printf("%-16s\t", quoted_name);
+ } else {
+ printf("\"%s\"\t", name);
+ }
}
- free(buf);
- if (fmt)
- free(buffmt);
+ print_line_attributes(info, unquoted_strings);
}
-static void list_lines(struct gpiod_chip *chip)
+/*
+ * 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, struct config *cfg)
{
- 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;
+ int offset, num_lines;
chip_info = gpiod_chip_get_info(chip);
if (!chip_info)
- die_perror("unable to retrieve the chip info from chip");
+ die_perror("unable to read info from chip %s",
+ gpiod_chip_get_path(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++) {
+ if ((chip_num == 0) && (cfg->chip_id && !cfg->by_name))
+ 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 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;
- }
+ 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);
}
- if (flag_printed)
- printf("]");
-
- printf("\n");
+ fputc('\t', stdout);
+ print_line_info(info, cfg->unquoted_strings);
+ fputc('\n', stdout);
gpiod_line_info_free(info);
+ resolver->num_found++;
}
+
gpiod_chip_info_free(chip_info);
}
int main(int argc, char **argv)
{
- int num_chips, i, optc, opti;
+ struct line_resolver *resolver = NULL;
+ int num_chips, i, ret = EXIT_SUCCESS;
struct gpiod_chip *chip;
- struct dirent **entries;
+ struct config cfg;
+ char **paths;
- 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();
- }
- }
+ i = parse_config(argc, argv, &cfg);
+ argc -= i;
+ argv += i;
- argc -= optind;
- argv += optind;
+ if (!cfg.chip_id)
+ cfg.by_name = true;
- if (argc == 0) {
- num_chips = scandir("/dev/", &entries,
- chip_dir_filter, alphasort);
- if (num_chips < 0)
- die_perror("unable to scan /dev");
+ 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);
- 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);
+ 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) {
+ list_lines(resolver, chip, i, &cfg);
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]);
+ } else {
+ print_perror("unable to open chip '%s'", paths[i]);
- list_lines(chip);
+ if (cfg.chip_id)
+ return EXIT_FAILURE;
- gpiod_chip_close(chip);
+ 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 EXIT_SUCCESS;
+ return ret;
}
// 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 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 },
+struct config {
+ bool active_low;
+ bool banner;
+ bool by_name;
+ bool quiet;
+ bool strict;
+ bool unquoted;
+ int bias;
+ int edges;
+ int events_wanted;
+ unsigned int debounce_period_us;
+ const char *chip_id;
+ const char *consumer;
+ const char *fmt;
+ int event_clock;
+ int timestamp_fmt;
};
-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("Usage: %s [OPTIONS] <line>...\n", get_progname());
printf("\n");
- printf("Wait for events on GPIO lines and print them to standard output\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("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, --consumer <name>\tconsumer name applied to requested lines (default is 'gpiomon')\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(" -E, --event-clock <clock>\n");
+ printf("\t\t\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(" -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(" --unquoted\tdon't quote line or consumer names\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(" %%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");
+ 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");
}
-struct mon_ctx {
- unsigned int offset;
- bool silent;
- char *fmt;
-};
+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;
+}
+
+static int parse_config(int argc, char **argv, struct config *cfg)
+{
+ static const char *const shortopts = "+b:c:C:e:E:hF:ln:p:qshv";
+
+ const struct option longopts[] = {
+ { "active-low", no_argument, NULL, 'l' },
+ { "banner", no_argument, NULL, '-'},
+ { "bias", required_argument, NULL, 'b' },
+ { "by-name", no_argument, NULL, 'B'},
+ { "chip", required_argument, NULL, 'c' },
+ { "consumer", required_argument, NULL, 'C' },
+ { "debounce-period", required_argument, NULL, 'p' },
+ { "edges", required_argument, NULL, 'e' },
+ { "event-clock", 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' },
+ { "unquoted", no_argument, NULL, 'Q' },
+ { "utc", no_argument, &cfg->timestamp_fmt, 1 },
+ { "version", no_argument, NULL, 'v' },
+ { GETOPT_NULL_LONGOPT },
+ };
+
+ int opti, optc;
+
+ memset(cfg, 0, sizeof(*cfg));
+ cfg->edges = GPIOD_LINE_EDGE_BOTH;
+ cfg->consumer = "gpiomon";
+
+ for (;;) {
+ optc = getopt_long(argc, argv, shortopts, longopts, &opti);
+ if (optc < 0)
+ break;
+
+ switch (optc) {
+ case '-':
+ cfg->banner = true;
+ break;
+ case 'b':
+ cfg->bias = parse_bias_or_die(optarg);
+ break;
+ case 'B':
+ cfg->by_name = true;
+ break;
+ case 'c':
+ cfg->chip_id = optarg;
+ break;
+ case 'C':
+ cfg->consumer = optarg;
+ break;
+ case 'e':
+ cfg->edges = parse_edges_or_die(optarg);
+ break;
+ case 'E':
+ cfg->event_clock = parse_event_clock_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 'Q':
+ cfg->unquoted = 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_custom(unsigned int offset, uint64_t timeout,
- int event_type, struct mon_ctx *ctx)
+static void event_print_formatted(struct gpiod_edge_event *event,
+ struct line_resolver *resolver, int chip_num,
+ struct config *cfg)
{
- char *prev, *curr, fmt;
+ const char *lname, *prev, *curr;
+ unsigned int offset;
+ uint64_t evtime;
+ int evtype;
+ char fmt;
+
+ 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 = ctx->fmt;;) {
+ for (prev = curr = cfg->fmt;;) {
curr = strchr(curr, '%');
if (!curr) {
fputs(prev, stdout);
fmt = *(curr + 1);
switch (fmt) {
- case 'o':
- printf("%u", offset);
+ case 'c':
+ fputs(get_chip_name(resolver, chip_num), stdout);
break;
case 'e':
- if (event_type == GPIOD_EDGE_EVENT_RISING_EDGE)
- fputc('1', stdout);
+ printf("%d", evtype);
+ break;
+ case 'E':
+ if (evtype == GPIOD_EDGE_EVENT_RISING_EDGE)
+ fputs("rising", stdout);
else
- fputc('0', stdout);
+ fputs("falling", stdout);
break;
- case 's':
- printf("%"PRIu64, timeout / 1000000000);
+ case 'l':
+ lname = get_line_name(resolver, chip_num, offset);
+ if (!lname)
+ lname = "unnamed";
+ fputs(lname, stdout);
break;
- case 'n':
- printf("%"PRIu64, timeout % 1000000000);
+ 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);
fputc('\n', stdout);
}
-static void event_print_human_readable(unsigned int offset,
- uint64_t timeout, int event_type)
+static void event_print_human_readable(struct gpiod_edge_event *event,
+ struct line_resolver *resolver,
+ int chip_num, struct config *cfg)
{
- char *evname;
+ 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 (event_type == GPIOD_EDGE_EVENT_RISING_EDGE)
- evname = " RISING EDGE";
+ if (gpiod_edge_event_get_event_type(event) ==
+ GPIOD_EDGE_EVENT_RISING_EDGE)
+ fputs("\trising\t", stdout);
else
- evname = "FALLING EDGE";
+ fputs("\tfalling\t", stdout);
- printf("event: %s offset: %u timestamp: [%8"PRIu64".%09"PRIu64"]\n",
- evname, offset, timeout / 1000000000, timeout % 1000000000);
+ print_line_id(resolver, chip_num, offset, cfg->chip_id, cfg->unquoted);
+ fputc('\n', stdout);
}
-static void handle_event(unsigned int line_offset, unsigned int event_type,
- uint64_t timestamp, struct mon_ctx *ctx)
+static void event_print(struct gpiod_edge_event *event,
+ struct line_resolver *resolver, int chip_num,
+ struct config *cfg)
{
- 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);
- }
-}
+ if (cfg->quiet)
+ return;
-static void handle_signal(int signum UNUSED)
-{
- exit(EXIT_SUCCESS);
+ 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)
{
- 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_request **requests;
struct gpiod_line_config *line_cfg;
- unsigned int offsets[64], offset;
+ int num_lines, events_done = 0;
struct gpiod_edge_event *event;
+ struct line_resolver *resolver;
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;
+ struct pollfd *pollfds;
+ unsigned int *offsets;
+ struct config cfg;
+ int ret, i, j;
- 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;
+ i = parse_config(argc, argv, &cfg);
+ argc -= i;
+ argv += i;
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");
+ die("at least one GPIO line must be specified");
- 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]);
+ if (argc > 64)
+ die("too many lines given");
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);
+ if (cfg.bias)
+ gpiod_line_settings_set_bias(settings, cfg.bias);
- req_cfg = gpiod_request_config_new();
- if (!req_cfg)
- die_perror("unable to allocate the request config structure");
+ if (cfg.active_low)
+ gpiod_line_settings_set_active_low(settings, true);
- gpiod_request_config_set_consumer(req_cfg, "gpiomon");
+ 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");
- ret = gpiod_line_config_add_line_settings(line_cfg, offsets,
- num_lines, settings);
- if (ret)
- die_perror("unable to add line settings");
+ req_cfg = gpiod_request_config_new();
+ if (!req_cfg)
+ die_perror("unable to allocate the request config structure");
- request = gpiod_chip_request_lines(chip, req_cfg, line_cfg);
- if (!request)
- die_perror("unable to request lines");
+ gpiod_request_config_set_consumer(req_cfg, cfg.consumer);
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 (;;) {
- 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;
+ 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);
- 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;
}
+
// 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>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
-#include <sys/select.h>
#include <unistd.h>
+#if GPIOSET_INTERACTIVE
+#include <editline/readline.h>
+#endif
#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 },
+struct config {
+ bool active_low;
+ bool banner;
+ bool by_name;
+ bool daemonize;
+ bool interactive;
+ bool strict;
+ bool unquoted;
+ int bias;
+ int drive;
+ int toggles;
+ unsigned int *toggle_periods;
+ unsigned int hold_period_us;
+ const char *chip_id;
+ const char *consumer;
};
-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("Usage: %s [OPTIONS] <line=value>...\n", get_progname());
printf("\n");
- printf("Set GPIO line values of a GPIO chip and maintain the state until the process exits\n");
+ printf("Set values 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");
- 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("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("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("The line output state is maintained until the process exits, but after that\n");
+ printf("is not guaranteed.\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("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, --consumer <name>\tconsumer name applied to requested lines (default is 'gpioset')\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");
+#ifdef GPIOSET_INTERACTIVE
+ 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");
+#endif
+ 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(" --unquoted\tdon't quote line names\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: 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");
+ 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");
}
-struct callback_data {
- /* Replace with a union once we have more modes using callback data. */
- struct timeval tv;
- bool daemonize;
-};
+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;
+}
-static void maybe_daemonize(bool daemonize)
+static int parse_periods_or_die(char *option, unsigned int **periods)
{
- int rv;
+ 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");
- if (daemonize) {
- rv = daemon(0, 0);
- if (rv < 0)
- die("unable to daemonize: %s", strerror(errno));
+ 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;
}
-static void wait_enter(void *data UNUSED)
+static int parse_config(int argc, char **argv, struct config *cfg)
{
- getchar();
+ static const struct option longopts[] = {
+ { "active-low", no_argument, NULL, 'l' },
+ { "banner", no_argument, NULL, '-'},
+ { "bias", required_argument, NULL, 'b' },
+ { "by-name", no_argument, NULL, 'B' },
+ { "chip", required_argument, NULL, 'c' },
+ { "consumer", 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' },
+#ifdef GPIOSET_INTERACTIVE
+ { "interactive", no_argument, NULL, 'i' },
+#endif
+ { "strict", no_argument, NULL, 's' },
+ { "toggle", required_argument, NULL, 't' },
+ { "unquoted", no_argument, NULL, 'Q' },
+ { "version", no_argument, NULL, 'v' },
+ { GETOPT_NULL_LONGOPT },
+ };
+
+#ifdef GPIOSET_INTERACTIVE
+ static const char *const shortopts = "+b:c:C:d:hilp:st:vz";
+#else
+ static const char *const shortopts = "+b:c:C:d:hlp:st:vz";
+#endif
+
+ int opti, optc;
+
+ memset(cfg, 0, sizeof(*cfg));
+ cfg->consumer = "gpioset";
+
+ for (;;) {
+ optc = getopt_long(argc, argv, shortopts, longopts, &opti);
+ if (optc < 0)
+ break;
+
+ switch (optc) {
+ case '-':
+ cfg->banner = true;
+ break;
+ case 'b':
+ cfg->bias = parse_bias_or_die(optarg);
+ break;
+ case 'B':
+ cfg->by_name = true;
+ break;
+ case 'c':
+ cfg->chip_id = optarg;
+ break;
+ case 'C':
+ cfg->consumer = optarg;
+ break;
+ case 'd':
+ cfg->drive = parse_drive_or_die(optarg);
+ break;
+#ifdef GPIOSET_INTERACTIVE
+ case 'i':
+ cfg->interactive = true;
+ break;
+#endif
+ case 'l':
+ cfg->active_low = true;
+ break;
+ case 'p':
+ cfg->hold_period_us = parse_period_or_die(optarg);
+ break;
+ case 'Q':
+ cfg->unquoted = true;
+ 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();
+ }
+ }
+
+#ifdef GPIOSET_INTERACTIVE
+ if (cfg->toggles && cfg->interactive)
+ die("can't combine interactive with toggle");
+#endif
+
+ 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;
}
-static void wait_time(void *data)
+/*
+ * Parse line id and values from lvs into lines and values.
+ *
+ * Accepted forms:
+ * 'line=value'
+ * '"line"=value'
+ *
+ * If line id is quoted then it is returned unquoted.
+ */
+static bool parse_line_values(int num_lines, char **lvs, char **lines,
+ int *values, bool interactive)
{
- struct callback_data *cbdata = data;
+ char *value;
+ char *line;
+ int i;
+
+ for (i = 0; i < num_lines; i++) {
+ line = lvs[i];
+
+ if (*line != '"') {
+ value = strchr(line, '=');
+ } else {
+ line++;
+ value = strstr(line, "\"=");
+ if (value) {
+ *value = '\0';
+ value++;
+ }
- maybe_daemonize(cbdata->daemonize);
- select(0, NULL, NULL, NULL, &cbdata->tv);
+ }
+
+ 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] = line;
+ }
+
+ return true;
+}
+
+/*
+ * Parse 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_signal(void *data)
+static void print_banner(int num_lines, char **lines)
+{
+ int i;
+
+ if (num_lines > 1) {
+ printf("Setting lines ");
+
+ for (i = 0; i < num_lines - 1; i++)
+ printf("'%s', ", lines[i]);
+
+ printf("and '%s'...\n", lines[i]);
+ } else {
+ printf("Setting line '%s'...\n", lines[0]);
+ }
+ fflush(stdout);
+}
+
+static void wait_fd(int fd)
{
- struct callback_data *cbdata = data;
struct pollfd pfd;
- int sigfd, rv;
- sigfd = make_signalfd();
+ 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));
+ }
+}
+
+/* Toggle the values of all lines in the resolver */
+static void toggle_all_lines(struct line_resolver *resolver)
+{
+ int i;
- memset(&pfd, 0, sizeof(pfd));
- pfd.fd = sigfd;
- pfd.events = POLLIN | POLLPRI;
+ for (i = 0; i < resolver->num_lines; i++)
+ resolver->lines[i].value = !resolver->lines[i].value;
+}
+
+/*
+ * 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;
- maybe_daemonize(cbdata->daemonize);
+ if ((toggles == 1) && (toggle_periods[0] == 0))
+ return;
for (;;) {
- rv = poll(&pfd, 1, 1000 /* one second */);
- if (rv < 0)
- die("error polling for signals: %s", strerror(errno));
- else if (rv > 0)
- break;
+ 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;
}
+}
- /*
- * Don't bother reading siginfo - it's enough to know that we
- * received any signal.
- */
- close(sigfd);
+#ifdef GPIOSET_INTERACTIVE
+
+/*
+ * Parse line id from words into lines.
+ *
+ * If line id is quoted then it is returned unquoted.
+ */
+static bool parse_line_ids(int num_lines, char **words, char **lines)
+{
+ int i, len;
+ char *line;
+
+ for (i = 0; i < num_lines; i++) {
+ line = words[i];
+ if (*line == '"') {
+ line++;
+ len = strlen(line);
+ if ((len == 0) || line[len - 1] != '"') {
+ printf("invalid line id: '%s'\n", words[i]);
+ return false;
+ }
+ line[len - 1] = '\0';
+ }
+ lines[i] = line;
+ }
+
+ return true;
}
-enum {
- MODE_EXIT = 0,
- MODE_WAIT,
- MODE_TIME,
- MODE_SIGNAL,
-};
+/*
+ * 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;
+ }
+ }
+ }
+}
-struct mode_mapping {
- int id;
- const char *name;
- void (*callback)(void *);
-};
+static void print_all_line_values(struct line_resolver *resolver, bool unquoted)
+{
+ char *fmt = unquoted ? "%s=%s " : "\"%s\"=%s ";
+ int i;
-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,
- },
-};
+ for (i = 0; i < resolver->num_lines; i++) {
+ if (i == resolver->num_lines - 1)
+ fmt = unquoted ? "%s=%s\n" : "\"%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, bool unquoted)
+{
+ char *fmt = unquoted ? "%s=%s " : "\"%s\"=%s ";
+ struct resolved_line *line;
+ int i, j;
+
+ for (i = 0; i < num_lines; i++) {
+ if (i == num_lines - 1)
+ fmt = unquoted ? "%s=%s\n" : "\"%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 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)
+{
+ struct resolved_line *line;
+ int i, j;
+
+ 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;
+ }
+ }
+}
+
+/*
+ * 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, found;
+ int i, l;
+
+ 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.
+ *
+ * Any escaping is ignored, on the assumption that the only escaped
+ * character of consequence is '"', and that names won't include quotes.
+ */
+static int split_words(char *line, int max_words, char **words)
+{
+ bool in_quotes = false;
+ bool in_word = false;
+ int num_words = 0;
+
+ for (; (*line != '\0'); line++) {
+ if (!in_word) {
+ if (isspace(*line))
+ continue;
+
+ in_word = true;
+ in_quotes = (*line == '"');
+
+ /* count all words, but only store max_words */
+ if (num_words < max_words)
+ words[num_words] = line;
+ } else {
+ if (in_quotes) {
+ if (*line == '"')
+ in_quotes = false;
+ continue;
+ }
+ if (isspace(*line)) {
+ num_words++;
+ in_word = false;
+ *line = '\0';
+ }
+ }
+ }
+
+ if (in_word)
+ num_words++;
-static const struct mode_mapping *parse_mode(const char *mode)
+ return num_words;
+}
+
+/* check if a line is specified somewhere in the rl_line_buffer */
+static bool in_line_buffer(const char *id)
{
- size_t i;
+ char *match = rl_line_buffer;
+ int len = strlen(id);
+
+ while ((match = strstr(match, id))) {
+ if ((match > rl_line_buffer && isspace(match[-1])) &&
+ ((match[len] == '=') || isspace(match[len])))
+ return true;
+
+ match += len;
+ }
- for (i = 0; i < ARRAY_SIZE(modes); i++)
- if (strcmp(mode, modes[i].name) == 0)
- return &modes[i];
+ 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;
}
-static int parse_drive(const char *option)
+/* tab completion helper for line values (just the value component) */
+static char *complete_value(const char *text, int state)
{
- 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;
+ 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;
}
-int main(int argc, char **argv)
+/* tab completion help for interactive commands */
+static char *complete_command(const char *text, int state)
{
- 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;
+ static const char * const commands[] = {
+ "get", "set", "toggle", "sleep", "help", "exit", NULL
+ };
- memset(&cbdata, 0, sizeof(cbdata));
+ static int idx, len;
- for (;;) {
- optc = getopt_long(argc, argv, shortopts, longopts, &opti);
- if (optc < 0)
- break;
+ const char *cmd;
- 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();
+ 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)
+{
+ int cmd_start, cmd_end, len;
+ char **matches = NULL;
+
+ rl_attempted_completion_over = true;
+ rl_completion_type = '@';
+ rl_completion_append_character = ' ';
+
+ 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], 4) == 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);
}
}
- argc -= optind;
- argv += optind;
+ if ((len == 3 && strncmp("get ", &rl_line_buffer[cmd_start], 4) == 0) ||
+ (len == 6 && strncmp("toggle ", &rl_line_buffer[cmd_start], 7) == 0))
+ matches = rl_completion_matches(text, complete_line_id);
- if (mode->id != MODE_TIME && (cbdata.tv.tv_sec || cbdata.tv.tv_usec))
- die("can't specify wait time in this mode");
+ return matches;
+}
- if (mode->id != MODE_SIGNAL &&
- mode->id != MODE_TIME &&
- cbdata.daemonize)
- die("can't daemonize in this mode");
+#define PROMPT "gpioset> "
- if (argc < 1)
- die("gpiochip must be specified");
+static void interact(struct gpiod_line_request **requests,
+ struct line_resolver *resolver,
+ char **lines, unsigned int *offsets, int *values,
+ bool unquoted)
+{
+ int num_words, num_lines, max_words, period_us, i;
+ char *line, **words, *line_buf;
+ bool done, stdout_is_tty;
+
+ stifle_history(20);
+ rl_attempted_completion_function = tab_completion;
+ rl_basic_word_break_characters = " =\"";
+ completion_context = resolver;
+ stdout_is_tty = isatty(1);
+
+ max_words = resolver->num_lines + 1;
+ words = calloc(max_words, sizeof(*words));
+ if (!words)
+ die("out of memory");
- if (argc < 2)
- die("at least one GPIO line offset to value mapping must be specified");
+ 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.
+ */
+ if (!stdout_is_tty)
+ printf(PROMPT);
+ fflush(stdout);
+
+ line = readline(PROMPT);
+ 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, unquoted);
+ else if (parse_line_ids(num_lines, &words[1], lines) &&
+ valid_lines(resolver, num_lines, lines))
+ print_line_values(resolver, num_lines,
+ lines, unquoted);
+ 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 (parse_line_ids(num_lines, &words[1], lines) &&
+ valid_lines(resolver, num_lines, lines))
+ toggle_lines(resolver, num_lines, lines);
+
+ 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;
+ }
- device = argv[0];
+ if (strcmp(words[0], "exit") == 0) {
+ done = true;
+ goto cmd_done;
+ }
- num_lines = argc - 1;
+ if (strcmp(words[0], "help") == 0) {
+ print_interactive_help();
+ goto cmd_done;
+ }
- offsets = calloc(num_lines, sizeof(*offsets));
- values = calloc(num_lines, sizeof(*values));
- if (!offsets)
- die("out of memory");
+ printf("unknown command: '%s'\n", words[0]);
+ printf("Try the 'help' command\n")
+ ;
- 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]);
+cmd_ok:
+ for (i = 0; isspace(line[i]); i++)
+ ;
- if (values[i] != 0 && values[i] != 1)
- die("value must be 0 or 1: %s", argv[i + 1]);
+ if ((history_length) == 0 ||
+ (strcmp(history_list()[history_length - 1]->line,
+ &line[i]) != 0))
+ add_history(&line[i]);
- if (offsets[i] > INT_MAX)
- die("invalid offset: %s", argv[i + 1]);
+cmd_done:
+ free(line);
+ free(line_buf);
}
+ free(words);
+}
+
+#endif /* GPIOSET_INTERACTIVE */
- if (has_duplicate_offsets(num_lines, offsets))
- die("offsets must be unique");
+int main(int argc, char **argv)
+{
+ struct gpiod_line_settings *settings;
+ struct gpiod_request_config *req_cfg;
+ struct gpiod_line_request **requests;
+ struct gpiod_line_config *line_cfg;
+ int i, j, num_lines, ret, *values;
+ struct line_resolver *resolver;
+ struct gpiod_chip *chip;
+ unsigned int *offsets;
+ struct config cfg;
+ char **lines;
- chip = chip_open_lookup(device);
- if (!chip)
- die_perror("unable to open %s", device);
+ 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 (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);
+ 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);
if (!req_cfg)
die_perror("unable to allocate the request config structure");
- gpiod_request_config_set_consumer(req_cfg, "gpioset");
+ gpiod_request_config_set_consumer(req_cfg, cfg.consumer);
+ 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 < num_lines; i++) {
- gpiod_line_settings_set_output_value(settings, values[i]);
+ for (i = 0; i < resolver->num_chips; i++) {
+ num_lines = get_line_offsets_and_values(resolver, i,
+ offsets, values);
- ret = gpiod_line_config_add_line_settings(line_cfg, &offsets[i],
- 1, settings);
- if (ret)
- die_perror("unable to add line settings");
- }
+ 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);
- request = gpiod_chip_request_lines(chip, req_cfg, line_cfg);
- if (!request)
- die_perror("unable to request lines");
+ 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);
- if (mode->callback)
- mode->callback(&cbdata);
+ gpiod_chip_close(chip);
+ }
- 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);
+
+ if (cfg.banner)
+ print_banner(argc, lines);
+
+ if (cfg.daemonize)
+ if (daemon(0, cfg.interactive) < 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);
+
+#ifdef GPIOSET_INTERACTIVE
+ if (cfg.interactive)
+ interact(requests, resolver, lines, offsets, values,
+ cfg.unquoted);
+ else if (!cfg.toggles)
+ wait_fd(gpiod_line_request_get_fd(requests[0]));
+#else
+ if (!cfg.toggles)
+ wait_fd(gpiod_line_request_get_fd(requests[0]));
+#endif
+
+ 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;
}
+
// 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"
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;
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_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 make_signalfd(void)
+void print_chip_help(void)
{
- sigset_t sigmask;
- int sigfd, rv;
+ 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");
+}
- sigemptyset(&sigmask);
- sigaddset(&sigmask, SIGTERM);
- sigaddset(&sigmask, SIGINT);
+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");
+}
- rv = sigprocmask(SIG_BLOCK, &sigmask, NULL);
- if (rv < 0)
- die("error masking signals: %s", strerror(errno));
+#define TIME_BUFFER_SIZE 20
- sigfd = signalfd(-1, &sigmask, 0);
- if (sigfd < 0)
- die("error creating signalfd: %s", strerror(errno));
+/*
+ * format:
+ * 0: raw seconds
+ * 1: utc time
+ * 2: local time
+ */
+void print_event_time(uint64_t evtime, int format)
+{
+ char tbuf[TIME_BUFFER_SIZE];
+ time_t evtsec;
+ struct tm t;
+ 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);
+ }
+}
- return sigfd;
+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);
}
-int chip_dir_filter(const struct dirent *entry)
+static void print_drive(struct gpiod_line_info *info)
{
- bool is_chip;
- char *path;
- int ret;
+ 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;
+ }
- ret = asprintf(&path, "/dev/%s", entry->d_name);
- if (ret < 0)
- return 0;
+ printf(" drive=%s", name);
+}
- is_chip = gpiod_is_gpiochip_device(path);
- free(path);
- return !!is_chip;
+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);
}
-struct gpiod_chip *chip_open_by_name(const char *name)
+static void print_event_clock(struct gpiod_line_info *info)
{
- struct gpiod_chip *chip;
- char *path;
- int ret;
+ 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;
+ }
- ret = asprintf(&path, "/dev/%s", name);
- if (ret < 0)
- return NULL;
+ printf(" event-clock=%s", name);
+}
- chip = gpiod_chip_open(path);
- free(path);
+static void print_debounce(struct gpiod_line_info *info)
+{
+ const char *units = "us";
+ unsigned long debounce;
+
+ 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);
+}
- return chip;
+static void print_consumer(struct gpiod_line_info *info, bool unquoted)
+{
+ const char *consumer;
+ const char *fmt;
+
+ if (!gpiod_line_info_is_used(info))
+ return;
+
+ consumer = gpiod_line_info_get_consumer(info);
+ if (!consumer)
+ consumer = "kernel";
+
+ fmt = unquoted ? " consumer=%s" : " consumer=\"%s\"";
+
+ printf(fmt, consumer);
}
-static struct gpiod_chip *chip_open_by_number(unsigned int num)
+void print_line_attributes(struct gpiod_line_info *info, bool unquoted_strings)
{
- struct gpiod_chip *chip;
+ 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, unquoted_strings);
+}
+
+void print_line_id(struct line_resolver *resolver, int chip_num,
+ unsigned int offset, const char *chip_id, bool unquoted)
+{
+ const char *lname, *fmt;
+
+ lname = get_line_name(resolver, chip_num, offset);
+ if (!lname) {
+ printf("%s %u", get_chip_name(resolver, chip_num), offset);
+ return;
+ }
+ if (chip_id)
+ printf("%s %u ", get_chip_name(resolver, chip_num), offset);
+
+ fmt = unquoted ? "%s" : "\"%s\"";
+ printf(fmt, lname);
+}
+
+static int chip_dir_filter(const struct dirent *entry)
+{
+ struct stat sb;
+ int ret = 0;
char *path;
- int ret;
- ret = asprintf(&path, "/dev/gpiochip%u", num);
- if (!ret)
- return NULL;
+ if (asprintf(&path, "/dev/%s", entry->d_name) < 0)
+ return 0;
+
+ if ((lstat(path, &sb) == 0) &&
+ (!S_ISLNK(sb.st_mode)) &&
+ gpiod_is_gpiochip_device(path))
+ ret = 1;
- chip = gpiod_chip_open(path);
free(path);
- return chip;
+ return ret;
}
static bool isuint(const char *str)
return *str == '\0';
}
-struct gpiod_chip *chip_open_lookup(const char *device)
+bool chip_path_lookup(const char *id, char **path_ptr)
{
- struct gpiod_chip *chip;
+ char *path;
- if (isuint(device)) {
- chip = chip_open_by_number(strtoul(device, NULL, 10));
+ 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 {
- if (strncmp(device, "/dev/", 5))
- chip = chip_open_by_name(device);
+ /* 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 **paths;
+ char *path;
+
+ 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;
+ bool resolved = false;
+ unsigned int offset;
+ const char *name;
+ int i;
+
+ 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)
+{
+ struct resolved_line *line;
+ bool used = false;
+ int i;
+
+ 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 gpiod_chip_info *chip_info;
+ struct gpiod_line_info *line_info;
+ struct line_resolver *resolver;
+ int num_chips, i, offset;
+ struct gpiod_chip *chip;
+ bool chip_used;
+ char **paths;
+
+ 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;
+ bool valid = true;
+ int i, j;
+
+ 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
- chip = gpiod_chip_open(device);
+ 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 chip;
+ return num_lines;
}
-bool has_duplicate_offsets(size_t num_offsets, unsigned int *offsets)
+const char *get_chip_name(struct line_resolver *resolver, int chip_num)
{
- size_t i, j;
+ return gpiod_chip_info_get_name(resolver->chips[chip_num].info);
+}
- for (i = 0; i < num_offsets; i++) {
- for (j = i + 1; j < num_offsets; j++)
- if (offsets[i] == offsets[j])
- return true;
+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 false;
+ 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++;
+ }
+ }
}
/* 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>
/*
#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_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, bool unquoted_strings);
+void print_line_id(struct line_resolver *resolver, int chip_num,
+ unsigned int offset, const char *chip_id, bool unquoted);
+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__ */
projects / qemu-gpiodev / libgpiod.git / commitdiff