| Message ID | 20221011002909.26987-3-warthog618@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | tools: improvements for v2 | expand |
On Tue, Oct 11, 2022 at 2:29 AM Kent Gibson <warthog618@gmail.com> wrote: > > Rework the tool suite to support identifying lines by name and to > support operating on the GPIO lines available to the user at once, rather > than on one particular GPIO chip. > > All tools, other than gpiodetect, now provide the name to (chip,offset) > mapping that was previously only performed by gpiofind. As names are not > guaranteed to be unique, a --strict option is provided for all tools to > either abort the operation or report all lines with the matching name, as > appropriate. > By default the tools operate on the first line found with a matching name. > > Selection of line by (chip,offset) is still supported with a --chip > option, though it restricts the scope of the operation to an individual > chip. When the --chip option is specified, the lines are assumed to be > identified by offset where they parse as an integer, else by name. > To cater for the unusual case where a line name parses as an integer, > but is different from the offset, the --by-name option forces the lines > to be identified by name. > > The updated tools are intentionally NOT backwardly compatible with the > previous tools. Using old command lines with the updated tools will > almost certainly fail, though migrating old command lines is generally as > simple as adding a '-c' before the chip. > While at it: how about adding the --consumer/-C switch to specify a consumer string other than the name of the program? > In addition the individual tools are modified as follows: > > gpiodetect: > > Add the option to select individual chips. > > gpioinfo: > > Change the focus from chips to lines, so the scope can be > an individual line, a subset of lines, all lines on a particular chip, > or all the lines available to the user. For line scope a single line > summary is output for each line. For chip scope the existing format > displaying a summary of the chip and each of its lines is retained. > > Line attributes are consolidated into a list format, and are extended > to cover all attributes supported by uAPI v2. > One change in the output that bothers me is the removal of quotation marks around the line name and consumer. I did that in v1 to visually distinguish between unnamed/unused lines and those that are named. I know it's highly unlikely that a line would be named "unnamed" (sic!) but still: line 0: "foo" line 1: unnamed looks more intuitive to me. Same for the consumer as with your current version, if the consumer string has spaces in it, it will look like this: consumer=foo bar. I think consumer="foo bar" would be easier to parse. > gpioget: > > The default output format is becomes line=value, as per the > input for gpioset, and the value is reported as active or inactive, > rather than 0 or 1. > The previous format is available using the --numeric option. > > Add an optional hold period between requesting a line and reading the > value to allow the line to settle once the requested configuration has > been applied (e.g. bias). > > gpiomon: > > Consolidate the edge options into a single option. > > Add a debounce period option. > > Add options to report event times as UTC or localtime. > > Add format specifiers for GPIO chip path, line name, stringified event > type, and event time as a datetime. > > Rearrange default output format to place fields with more predicable > widths to the left, and to separate major field groups with tabs. > Lines are identified consistent with the command line. > > gpioset: > > Add a hold period option that specifies the minimum period the line > value must be held for. This applies to all set options. > > Support line values specified as active/inactive, on/off and > true/false, as well as 1/0. > > Add a toggle option that specifies a time sequence over which the > requested lines should be toggled. If the sequence is 0 terminated then > gpioset exits when the sequence completes, else it repeats the sequence. > This allows for anything from simple blinkers to bit bashing from the > command line. e.g. gpioset -t 500ms LED=on > > Add an interactive option to provide a shell-like interface to allow > manual or scripted manipulation of requested lines. A basic command set > allows lines to be get, set, or toggled, and to insert sleeps between > operations. > As discussed elsewhere - it would be great if this part was optional and configurable at build-time so that the dependency on libedit could be dropped if unavailable. > Remove the --mode, --sec, and --usec options. > The combination of hold period and interactive mode provide functionality > equivalent to the old --mode options. > I have one problem with that - I think the basic functionality of: "take a line, set its value and wait for a signal" would still be useful. As it is now, I'm not sure how to make gpioset just hold a line without calling the GPIO_V2_LINE_SET_VALUES_IOCTL ioctl periodically. > Signed-off-by: Kent Gibson <warthog618@gmail.com> > --- > configure.ac | 8 +- > tools/Makefile.am | 2 +- > tools/gpiodetect.c | 113 +++++- > tools/gpioget.c | 204 ++++++++++- > tools/gpioinfo.c | 223 +++++++++++- > tools/gpiomon.c | 450 +++++++++++++++++++++++- > tools/gpioset.c | 815 ++++++++++++++++++++++++++++++++++++++++++- > tools/tools-common.c | 713 ++++++++++++++++++++++++++++++++++++- > tools/tools-common.h | 99 +++++- > 9 files changed, 2585 insertions(+), 42 deletions(-) > > diff --git a/configure.ac b/configure.ac > index 6ac1d8e..c8033c5 100644 > --- a/configure.ac > +++ b/configure.ac > @@ -106,14 +106,14 @@ AC_DEFUN([FUNC_NOT_FOUND_TOOLS], > AC_DEFUN([HEADER_NOT_FOUND_TOOLS], > [ERR_NOT_FOUND([$1 header], [tools])]) > > +AC_DEFUN([LIB_NOT_FOUND_TOOLS], > + [ERR_NOT_FOUND([lib$1], [tools])]) > + > if test "x$with_tools" = xtrue > then > # These are only needed to build tools > - AC_CHECK_FUNC([basename], [], [FUNC_NOT_FOUND_TOOLS([basename])]) > AC_CHECK_FUNC([daemon], [], [FUNC_NOT_FOUND_TOOLS([daemon])]) > - AC_CHECK_FUNC([signalfd], [], [FUNC_NOT_FOUND_TOOLS([signalfd])]) > - AC_CHECK_FUNC([setlinebuf], [], [FUNC_NOT_FOUND_TOOLS([setlinebuf])]) > - AC_CHECK_HEADERS([sys/signalfd.h], [], [HEADER_NOT_FOUND_TOOLS([sys/signalfd.h])]) > + PKG_CHECK_MODULES(LIBEDIT, libedit) > fi > > AC_ARG_ENABLE([tests], > diff --git a/tools/Makefile.am b/tools/Makefile.am > index fc074b9..c956314 100644 > --- a/tools/Makefile.am > +++ b/tools/Makefile.am > @@ -7,7 +7,7 @@ AM_CFLAGS += -Wall -Wextra -g -std=gnu89 > noinst_LTLIBRARIES = libtools-common.la > libtools_common_la_SOURCES = tools-common.c tools-common.h > > -LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la > +LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la $(LIBEDIT_LIBS) > > bin_PROGRAMS = gpiodetect gpioinfo gpioget gpioset gpiomon > > diff --git a/tools/gpiodetect.c b/tools/gpiodetect.c > index 30bde32..910fe9e 100644 > --- a/tools/gpiodetect.c > +++ b/tools/gpiodetect.c > @@ -1,8 +1,7 @@ > // SPDX-License-Identifier: GPL-2.0-or-later > // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> > +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> > > -#include <dirent.h> > -#include <errno.h> > #include <getopt.h> > #include <gpiod.h> > #include <stdio.h> > @@ -11,3 +10,113 @@ > > #include "tools-common.h" > > +static void print_help(void) > +{ > + printf("Usage: %s [OPTIONS] [chip]...\n", get_progname()); > + printf("\n"); > + printf("List GPIO chips, print their labels and number of GPIO lines.\n"); > + printf("\n"); > + printf("Chips may be identified by number, name, or path.\n"); > + printf("e.g. '0', 'gpiochip0', and '/dev/gpiochip0' all refer to the same chip.\n"); > + printf("\n"); > + printf("If no chips are specified then all chips are listed.\n"); > + printf("\n"); > + printf("Options:\n"); > + printf(" -h, --help\t\tdisplay this help and exit\n"); > + printf(" -v, --version\t\toutput version information and exit\n"); > +} > + > +int parse_config(int argc, char **argv) > +{ > + int optc, opti; > + const char *const shortopts = "+hv"; > + const struct option longopts[] = { > + { "help", no_argument, NULL, 'h' }, > + { "version", no_argument, NULL, 'v' }, > + { GETOPT_NULL_LONGOPT }, > + }; This can be static as there are no addresses of flag variables assigned. > + > + for (;;) { > + optc = getopt_long(argc, argv, shortopts, longopts, &opti); > + if (optc < 0) > + break; > + > + switch (optc) { > + case 'h': > + print_help(); > + exit(EXIT_SUCCESS); > + case 'v': > + print_version(); > + exit(EXIT_SUCCESS); > + case '?': > + die("try %s --help", get_progname()); > + default: > + abort(); > + } > + } > + return optind; > +} > + > +int print_chip_info(const char *path) > +{ > + struct gpiod_chip *chip; > + struct gpiod_chip_info *info; > + > + chip = gpiod_chip_open(path); > + if (!chip) { > + print_perror("unable to open chip '%s'", path); > + return 1; > + } > + > + info = gpiod_chip_get_info(chip); > + if (!info) > + die_perror("unable to read info for '%s'", path); > + > + printf("%s [%s] (%zu lines)\n", > + gpiod_chip_info_get_name(info), > + gpiod_chip_info_get_label(info), > + gpiod_chip_info_get_num_lines(info)); > + > + gpiod_chip_info_free(info); > + gpiod_chip_close(chip); > + return 0; > +} > + > +int main(int argc, char **argv) > +{ > + int num_chips, i; > + char **paths; > + char *path; > + int ret = EXIT_SUCCESS; > + > + i = parse_config(argc, argv); > + argc -= i; > + argv += i; > + > + if (argc == 0) { > + num_chips = all_chip_paths(&paths); > + for (i = 0; i < num_chips; i++) { > + if (print_chip_info(paths[i])) > + ret = EXIT_FAILURE; > + > + free(paths[i]); > + } > + free(paths); > + } > + > + for (i = 0; i < argc; i++) { > + if (chip_path_lookup(argv[i], &path)) { > + if (print_chip_info(path)) > + ret = EXIT_FAILURE; > + > + free(path); > + } else { > + print_error( > + "cannot find GPIO chip character device '%s'", > + argv[i]); > + ret = EXIT_FAILURE; > + } > + } > + > + return ret; > +} > diff --git a/tools/gpioget.c b/tools/gpioget.c > index 1b3e666..7a26066 100644 > --- a/tools/gpioget.c > +++ b/tools/gpioget.c > @@ -1,12 +1,214 @@ > // SPDX-License-Identifier: GPL-2.0-or-later > // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> > +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> > > #include <getopt.h> > #include <gpiod.h> > -#include <limits.h> > #include <stdio.h> > #include <stdlib.h> > #include <string.h> > +#include <unistd.h> > > #include "tools-common.h" > > +static void print_help(void) > +{ > + printf("Usage: %s [OPTIONS] <line>...\n", get_progname()); > + printf("\n"); > + printf("Read values of GPIO lines.\n"); > + printf("\n"); > + printf("Lines are specified by name, or optionally by offset if the chip option\n"); > + printf("is provided.\n"); > + printf("\n"); > + printf("Options:\n"); > + printf(" -a, --as-is\t\tleave the line direction unchanged, not forced to input\n"); > + print_bias_help(); > + printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n"); > + printf(" -c, --chip <chip>\trestrict scope to a particular chip\n"); > + printf(" -h, --help\t\tdisplay this help and exit\n"); > + printf(" -l, --active-low\ttreat the line as active low\n"); > + printf(" -p, --hold-period <period>\n"); > + printf("\t\t\twait between requesting the lines and reading the values\n"); > + printf(" --numeric\t\tdisplay line values as '0' (inactive) or '1' (active)\n"); > + printf(" -s, --strict\t\tabort if requested line names are not unique\n"); > + printf(" -v, --version\t\toutput version information and exit\n"); > + print_chip_help(); > + print_period_help(); > +} > +struct config { > + bool active_low; > + bool strict; > + int bias; > + int direction; > + unsigned int hold_period_us; > + const char *chip_id; > + int by_name; > + int numeric; > +}; > + > +int parse_config(int argc, char **argv, struct config *cfg) > +{ > + int opti, optc; > + const char *const shortopts = "+ab:c:hlp:sv"; > + const struct option longopts[] = { > + { "active-low", no_argument, NULL, 'l' }, > + { "as-is", no_argument, NULL, 'a' }, > + { "bias", required_argument, NULL, 'b' }, > + { "by-name", no_argument, &cfg->by_name, 1 }, > + { "chip", required_argument, NULL, 'c' }, > + { "help", no_argument, NULL, 'h' }, > + { "hold-period", required_argument, NULL, 'p' }, > + { "numeric", no_argument, &cfg->numeric, 1 }, > + { "strict", no_argument, NULL, 's' }, > + { "version", no_argument, NULL, 'v' }, > + { GETOPT_NULL_LONGOPT }, > + }; > + > + memset(cfg, 0, sizeof(*cfg)); > + cfg->direction = GPIOD_LINE_DIRECTION_INPUT; > + > + for (;;) { > + optc = getopt_long(argc, argv, shortopts, longopts, &opti); > + if (optc < 0) > + break; > + > + switch (optc) { > + case 'a': > + cfg->direction = GPIOD_LINE_DIRECTION_AS_IS; > + break; > + case 'b': > + cfg->bias = parse_bias_or_die(optarg); > + break; > + case 'c': > + cfg->chip_id = optarg; > + break; > + case 'l': > + cfg->active_low = true; > + break; > + case 'p': > + cfg->hold_period_us = parse_period_or_die(optarg); > + break; > + case 's': > + cfg->strict = true; > + break; > + case 'h': > + print_help(); > + exit(EXIT_SUCCESS); > + case 'v': > + print_version(); > + exit(EXIT_SUCCESS); > + case '?': > + die("try %s --help", get_progname()); > + case 0: > + break; > + default: > + abort(); > + } > + } > + > + return optind; > +} > + > +int main(int argc, char **argv) > +{ > + int i, num_lines, ret, *values; > + struct gpiod_line_settings *settings; > + struct gpiod_request_config *req_cfg; > + struct gpiod_line_request *request; > + struct gpiod_line_config *line_cfg; > + struct gpiod_chip *chip; > + unsigned int *offsets; > + struct line_resolver *resolver; > + struct resolved_line *line; > + struct config cfg; > + > + i = parse_config(argc, argv, &cfg); > + argc -= i; > + argv += i; > + > + if (argc < 1) > + die("at least one GPIO line must be specified"); > + > + resolver = resolve_lines(argc, argv, cfg.chip_id, cfg.strict, > + cfg.by_name); > + validate_resolution(resolver, cfg.chip_id); > + > + offsets = calloc(resolver->num_lines, sizeof(*offsets)); > + values = calloc(resolver->num_lines, sizeof(*values)); > + if (!offsets || !values) > + die("out of memory"); > + > + settings = gpiod_line_settings_new(); > + if (!settings) > + die_perror("unable to allocate line settings"); > + > + gpiod_line_settings_set_direction(settings, cfg.direction); > + > + if (cfg.bias) > + gpiod_line_settings_set_bias(settings, cfg.bias); > + > + if (cfg.active_low) > + gpiod_line_settings_set_active_low(settings, true); > + > + req_cfg = gpiod_request_config_new(); > + if (!req_cfg) > + die_perror("unable to allocate the request config structure"); > + > + line_cfg = gpiod_line_config_new(); > + if (!line_cfg) > + die_perror("unable to allocate the line config structure"); > + > + gpiod_request_config_set_consumer(req_cfg, "gpioget"); > + for (i = 0; i < resolver->num_chips; i++) { > + chip = gpiod_chip_open(resolver->chips[i].path); > + if (!chip) > + die_perror("unable to open chip '%s'", > + resolver->chips[i].path); > + > + num_lines = get_line_offsets_and_values(resolver, i, offsets, > + NULL); > + > + gpiod_line_config_reset(line_cfg); > + ret = gpiod_line_config_add_line_settings(line_cfg, offsets, > + num_lines, settings); > + if (ret) > + die_perror("unable to add line settings"); > + > + request = gpiod_chip_request_lines(chip, req_cfg, line_cfg); > + if (!request) > + die_perror("unable to request lines"); > + > + if (cfg.hold_period_us) > + usleep(cfg.hold_period_us); > + > + ret = gpiod_line_request_get_values(request, values); > + if (ret) > + die_perror("unable to read GPIO line values"); > + > + set_line_values(resolver, i, values); > + > + gpiod_line_request_release(request); > + gpiod_chip_close(chip); > + } > + for (i = 0; i < resolver->num_lines; i++) { > + line = &resolver->lines[i]; > + if (cfg.numeric) > + printf("%d", line->value); > + else > + printf("%s=%s", line->id, > + line->value ? "active" : "inactive"); > + > + if (i != resolver->num_lines - 1) > + printf(" "); > + } > + printf("\n"); > + > + free_line_resolver(resolver); > + gpiod_request_config_free(req_cfg); > + gpiod_line_config_free(line_cfg); > + gpiod_line_settings_free(settings); > + free(offsets); > + free(values); > + > + return EXIT_SUCCESS; > +} > diff --git a/tools/gpioinfo.c b/tools/gpioinfo.c > index ae368fa..5dc28f8 100644 > --- a/tools/gpioinfo.c > +++ b/tools/gpioinfo.c > @@ -1,8 +1,7 @@ > // SPDX-License-Identifier: GPL-2.0-or-later > // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> > +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> > > -#include <dirent.h> > -#include <errno.h> > #include <getopt.h> > #include <gpiod.h> > #include <stdarg.h> > @@ -12,3 +11,223 @@ > > #include "tools-common.h" > > +static void print_help(void) > +{ > + printf("Usage: %s [OPTIONS] [line]...\n", get_progname()); > + printf("\n"); > + printf("Print information about GPIO lines.\n"); > + printf("\n"); > + printf("Lines are specified by name, or optionally by offset if the chip option\n"); > + printf("is provided.\n"); > + printf("\n"); > + printf("If no lines are specified than all lines are displayed.\n"); > + printf("\n"); > + printf("Options:\n"); > + printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n"); > + printf(" -c, --chip <chip>\trestrict scope to a particular chip\n"); > + printf(" -h, --help\t\tdisplay this help and exit\n"); > + printf(" -s, --strict\t\tcheck all lines - don't assume line names are unique\n"); > + printf(" -v, --version\t\toutput version information and exit\n"); > + print_chip_help(); > +} > + > +struct config { > + bool strict; > + const char *chip_id; > + int by_name; > +}; > + > +int parse_config(int argc, char **argv, struct config *cfg) > +{ > + int opti, optc; > + const char *const shortopts = "+c:hsv"; > + const struct option longopts[] = { > + { "by-name", no_argument, &cfg->by_name, 1 }, > + { "chip", required_argument, NULL, 'c' }, > + { "help", no_argument, NULL, 'h' }, > + { "strict", no_argument, NULL, 's' }, > + { "version", no_argument, NULL, 'v' }, > + { GETOPT_NULL_LONGOPT }, > + }; > + > + memset(cfg, 0, sizeof(*cfg)); > + > + for (;;) { > + optc = getopt_long(argc, argv, shortopts, longopts, &opti); > + if (optc < 0) > + break; > + > + switch (optc) { > + case 'c': > + cfg->chip_id = optarg; > + break; > + case 's': > + cfg->strict = true; > + break; > + case 'h': > + print_help(); > + exit(EXIT_SUCCESS); > + case 'v': > + print_version(); > + exit(EXIT_SUCCESS); > + case '?': > + die("try %s --help", get_progname()); > + case 0: > + break; > + default: > + abort(); > + } > + } > + > + return optind; > +} > + > + > +// minimal version similar to tools-common that indicates if a line should be > +// printed rather than storing details into the resolver. > +// Does not die on non-unique lines. C-style comments only please. Same elsewhere. <snip> I like the new tools in general. I don't have many issues with the code - you are a much better coder than I am. I would change the coding style here and there but I will probably just spend some time on a good clang-format config and use it indiscriminately like I did with black for Python. Bart
On Tue, Nov 08, 2022 at 02:13:20PM +0100, Bartosz Golaszewski wrote: > On Tue, Oct 11, 2022 at 2:29 AM Kent Gibson <warthog618@gmail.com> wrote: > > > > Rework the tool suite to support identifying lines by name and to > > support operating on the GPIO lines available to the user at once, rather > > than on one particular GPIO chip. > > > > All tools, other than gpiodetect, now provide the name to (chip,offset) > > mapping that was previously only performed by gpiofind. As names are not > > guaranteed to be unique, a --strict option is provided for all tools to > > either abort the operation or report all lines with the matching name, as > > appropriate. > > By default the tools operate on the first line found with a matching name. > > > > Selection of line by (chip,offset) is still supported with a --chip > > option, though it restricts the scope of the operation to an individual > > chip. When the --chip option is specified, the lines are assumed to be > > identified by offset where they parse as an integer, else by name. > > To cater for the unusual case where a line name parses as an integer, > > but is different from the offset, the --by-name option forces the lines > > to be identified by name. > > > > The updated tools are intentionally NOT backwardly compatible with the > > previous tools. Using old command lines with the updated tools will > > almost certainly fail, though migrating old command lines is generally as > > simple as adding a '-c' before the chip. > > > > While at it: how about adding the --consumer/-C switch to specify a > consumer string other than the name of the program? > Ironically I added that to the Rust version, for the long lived commands anyway, so it could better emulate the C version for testing purposes. But could be generally useful, so ok. I only used the long form there to avoid confusion with -c (as they are visually very similar) and following the principle that rarely used options only get a long form, so I will omit the short -C option - unless you insist. > > In addition the individual tools are modified as follows: > > > > gpiodetect: > > > > Add the option to select individual chips. > > > > gpioinfo: > > > > Change the focus from chips to lines, so the scope can be > > an individual line, a subset of lines, all lines on a particular chip, > > or all the lines available to the user. For line scope a single line > > summary is output for each line. For chip scope the existing format > > displaying a summary of the chip and each of its lines is retained. > > > > Line attributes are consolidated into a list format, and are extended > > to cover all attributes supported by uAPI v2. > > > > One change in the output that bothers me is the removal of quotation > marks around the line name and consumer. I did that in v1 to visually > distinguish between unnamed/unused lines and those that are named. I > know it's highly unlikely that a line would be named "unnamed" (sic!) > but still: > > line 0: "foo" > line 1: unnamed > > looks more intuitive to me. I disagree on this one. In the longer term all lines should be named and then the quotes just become pointless noise, and require more work to parse. >Same for the consumer as with your current > version, if the consumer string has spaces in it, it will look like > this: consumer=foo bar. I think consumer="foo bar" would be easier to > parse. For this very reason, the consumer is explicitly listed last, so the consumer name matches everything between the "consumer=" and end of line. Unless consumer names with spaces are very common in the wild then quotes only add more clutter. > > > gpioget: > > > > The default output format is becomes line=value, as per the > > input for gpioset, and the value is reported as active or inactive, > > rather than 0 or 1. > > The previous format is available using the --numeric option. > > > > Add an optional hold period between requesting a line and reading the > > value to allow the line to settle once the requested configuration has > > been applied (e.g. bias). > > > > gpiomon: > > > > Consolidate the edge options into a single option. > > > > Add a debounce period option. > > > > Add options to report event times as UTC or localtime. > > > > Add format specifiers for GPIO chip path, line name, stringified event > > type, and event time as a datetime. > > > > Rearrange default output format to place fields with more predicable > > widths to the left, and to separate major field groups with tabs. > > Lines are identified consistent with the command line. > > > > gpioset: > > > > Add a hold period option that specifies the minimum period the line > > value must be held for. This applies to all set options. > > > > Support line values specified as active/inactive, on/off and > > true/false, as well as 1/0. > > > > Add a toggle option that specifies a time sequence over which the > > requested lines should be toggled. If the sequence is 0 terminated then > > gpioset exits when the sequence completes, else it repeats the sequence. > > This allows for anything from simple blinkers to bit bashing from the > > command line. e.g. gpioset -t 500ms LED=on > > > > Add an interactive option to provide a shell-like interface to allow > > manual or scripted manipulation of requested lines. A basic command set > > allows lines to be get, set, or toggled, and to insert sleeps between > > operations. > > > > As discussed elsewhere - it would be great if this part was optional > and configurable at build-time so that the dependency on libedit could > be dropped if unavailable. > Agreed. > > Remove the --mode, --sec, and --usec options. > > The combination of hold period and interactive mode provide functionality > > equivalent to the old --mode options. > > > > I have one problem with that - I think the basic functionality of: > "take a line, set its value and wait for a signal" would still be > useful. As it is now, I'm not sure how to make gpioset just hold a > line without calling the GPIO_V2_LINE_SET_VALUES_IOCTL ioctl > periodically. > I forgot to mention the daemonize option here, so gpioset -z myline=1 will do that. (or gpioset -i myline=1 if you want to keep the process in the foreground.) I'll add something to the daemonize help to highlight that it will hold the line until killed. Is that sufficient? > > Signed-off-by: Kent Gibson <warthog618@gmail.com> > > --- > > configure.ac | 8 +- > > tools/Makefile.am | 2 +- > > tools/gpiodetect.c | 113 +++++- > > tools/gpioget.c | 204 ++++++++++- > > tools/gpioinfo.c | 223 +++++++++++- > > tools/gpiomon.c | 450 +++++++++++++++++++++++- > > tools/gpioset.c | 815 ++++++++++++++++++++++++++++++++++++++++++- > > tools/tools-common.c | 713 ++++++++++++++++++++++++++++++++++++- > > tools/tools-common.h | 99 +++++- > > 9 files changed, 2585 insertions(+), 42 deletions(-) > > > > diff --git a/configure.ac b/configure.ac > > index 6ac1d8e..c8033c5 100644 > > --- a/configure.ac > > +++ b/configure.ac > > @@ -106,14 +106,14 @@ AC_DEFUN([FUNC_NOT_FOUND_TOOLS], > > AC_DEFUN([HEADER_NOT_FOUND_TOOLS], > > [ERR_NOT_FOUND([$1 header], [tools])]) > > > > +AC_DEFUN([LIB_NOT_FOUND_TOOLS], > > + [ERR_NOT_FOUND([lib$1], [tools])]) > > + > > if test "x$with_tools" = xtrue > > then > > # These are only needed to build tools > > - AC_CHECK_FUNC([basename], [], [FUNC_NOT_FOUND_TOOLS([basename])]) > > AC_CHECK_FUNC([daemon], [], [FUNC_NOT_FOUND_TOOLS([daemon])]) > > - AC_CHECK_FUNC([signalfd], [], [FUNC_NOT_FOUND_TOOLS([signalfd])]) > > - AC_CHECK_FUNC([setlinebuf], [], [FUNC_NOT_FOUND_TOOLS([setlinebuf])]) > > - AC_CHECK_HEADERS([sys/signalfd.h], [], [HEADER_NOT_FOUND_TOOLS([sys/signalfd.h])]) > > + PKG_CHECK_MODULES(LIBEDIT, libedit) > > fi > > > > AC_ARG_ENABLE([tests], > > diff --git a/tools/Makefile.am b/tools/Makefile.am > > index fc074b9..c956314 100644 > > --- a/tools/Makefile.am > > +++ b/tools/Makefile.am > > @@ -7,7 +7,7 @@ AM_CFLAGS += -Wall -Wextra -g -std=gnu89 > > noinst_LTLIBRARIES = libtools-common.la > > libtools_common_la_SOURCES = tools-common.c tools-common.h > > > > -LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la > > +LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la $(LIBEDIT_LIBS) > > > > bin_PROGRAMS = gpiodetect gpioinfo gpioget gpioset gpiomon > > > > diff --git a/tools/gpiodetect.c b/tools/gpiodetect.c > > index 30bde32..910fe9e 100644 > > --- a/tools/gpiodetect.c > > +++ b/tools/gpiodetect.c > > @@ -1,8 +1,7 @@ > > // SPDX-License-Identifier: GPL-2.0-or-later > > // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> > > +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> > > > > -#include <dirent.h> > > -#include <errno.h> > > #include <getopt.h> > > #include <gpiod.h> > > #include <stdio.h> > > @@ -11,3 +10,113 @@ > > > > #include "tools-common.h" > > > > +static void print_help(void) > > +{ > > + printf("Usage: %s [OPTIONS] [chip]...\n", get_progname()); > > + printf("\n"); > > + printf("List GPIO chips, print their labels and number of GPIO lines.\n"); > > + printf("\n"); > > + printf("Chips may be identified by number, name, or path.\n"); > > + printf("e.g. '0', 'gpiochip0', and '/dev/gpiochip0' all refer to the same chip.\n"); > > + printf("\n"); > > + printf("If no chips are specified then all chips are listed.\n"); > > + printf("\n"); > > + printf("Options:\n"); > > + printf(" -h, --help\t\tdisplay this help and exit\n"); > > + printf(" -v, --version\t\toutput version information and exit\n"); > > +} > > + > > +int parse_config(int argc, char **argv) > > +{ > > + int optc, opti; > > + const char *const shortopts = "+hv"; > > + const struct option longopts[] = { > > + { "help", no_argument, NULL, 'h' }, > > + { "version", no_argument, NULL, 'v' }, > > + { GETOPT_NULL_LONGOPT }, > > + }; > > This can be static as there are no addresses of flag variables assigned. > Indeed - and now you mention it I notice a few other things that should be static too. > > + > > + for (;;) { > > + optc = getopt_long(argc, argv, shortopts, longopts, &opti); > > + if (optc < 0) > > + break; > > + > > + switch (optc) { > > + case 'h': > > + print_help(); > > + exit(EXIT_SUCCESS); > > + case 'v': > > + print_version(); > > + exit(EXIT_SUCCESS); > > + case '?': > > + die("try %s --help", get_progname()); > > + default: > > + abort(); > > + } > > + } > > + return optind; > > +} > > + > > +int print_chip_info(const char *path) > > +{ > > + struct gpiod_chip *chip; > > + struct gpiod_chip_info *info; > > + > > + chip = gpiod_chip_open(path); > > + if (!chip) { > > + print_perror("unable to open chip '%s'", path); > > + return 1; > > + } > > + > > + info = gpiod_chip_get_info(chip); > > + if (!info) > > + die_perror("unable to read info for '%s'", path); > > + > > + printf("%s [%s] (%zu lines)\n", > > + gpiod_chip_info_get_name(info), > > + gpiod_chip_info_get_label(info), > > + gpiod_chip_info_get_num_lines(info)); > > + > > + gpiod_chip_info_free(info); > > + gpiod_chip_close(chip); > > + return 0; > > +} > > + > > +int main(int argc, char **argv) > > +{ > > + int num_chips, i; > > + char **paths; > > + char *path; > > + int ret = EXIT_SUCCESS; > > + > > + i = parse_config(argc, argv); > > + argc -= i; > > + argv += i; > > + > > + if (argc == 0) { > > + num_chips = all_chip_paths(&paths); > > + for (i = 0; i < num_chips; i++) { > > + if (print_chip_info(paths[i])) > > + ret = EXIT_FAILURE; > > + > > + free(paths[i]); > > + } > > + free(paths); > > + } > > + > > + for (i = 0; i < argc; i++) { > > + if (chip_path_lookup(argv[i], &path)) { > > + if (print_chip_info(path)) > > + ret = EXIT_FAILURE; > > + > > + free(path); > > + } else { > > + print_error( > > + "cannot find GPIO chip character device '%s'", > > + argv[i]); > > + ret = EXIT_FAILURE; > > + } > > + } > > + > > + return ret; > > +} > > diff --git a/tools/gpioget.c b/tools/gpioget.c > > index 1b3e666..7a26066 100644 > > --- a/tools/gpioget.c > > +++ b/tools/gpioget.c > > @@ -1,12 +1,214 @@ > > // SPDX-License-Identifier: GPL-2.0-or-later > > // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> > > +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> > > > > #include <getopt.h> > > #include <gpiod.h> > > -#include <limits.h> > > #include <stdio.h> > > #include <stdlib.h> > > #include <string.h> > > +#include <unistd.h> > > > > #include "tools-common.h" > > > > +static void print_help(void) > > +{ > > + printf("Usage: %s [OPTIONS] <line>...\n", get_progname()); > > + printf("\n"); > > + printf("Read values of GPIO lines.\n"); > > + printf("\n"); > > + printf("Lines are specified by name, or optionally by offset if the chip option\n"); > > + printf("is provided.\n"); > > + printf("\n"); > > + printf("Options:\n"); > > + printf(" -a, --as-is\t\tleave the line direction unchanged, not forced to input\n"); > > + print_bias_help(); > > + printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n"); > > + printf(" -c, --chip <chip>\trestrict scope to a particular chip\n"); > > + printf(" -h, --help\t\tdisplay this help and exit\n"); > > + printf(" -l, --active-low\ttreat the line as active low\n"); > > + printf(" -p, --hold-period <period>\n"); > > + printf("\t\t\twait between requesting the lines and reading the values\n"); > > + printf(" --numeric\t\tdisplay line values as '0' (inactive) or '1' (active)\n"); > > + printf(" -s, --strict\t\tabort if requested line names are not unique\n"); > > + printf(" -v, --version\t\toutput version information and exit\n"); > > + print_chip_help(); > > + print_period_help(); > > +} > > +struct config { > > + bool active_low; > > + bool strict; > > + int bias; > > + int direction; > > + unsigned int hold_period_us; > > + const char *chip_id; > > + int by_name; > > + int numeric; > > +}; > > + > > +int parse_config(int argc, char **argv, struct config *cfg) > > +{ > > + int opti, optc; > > + const char *const shortopts = "+ab:c:hlp:sv"; > > + const struct option longopts[] = { > > + { "active-low", no_argument, NULL, 'l' }, > > + { "as-is", no_argument, NULL, 'a' }, > > + { "bias", required_argument, NULL, 'b' }, > > + { "by-name", no_argument, &cfg->by_name, 1 }, > > + { "chip", required_argument, NULL, 'c' }, > > + { "help", no_argument, NULL, 'h' }, > > + { "hold-period", required_argument, NULL, 'p' }, > > + { "numeric", no_argument, &cfg->numeric, 1 }, > > + { "strict", no_argument, NULL, 's' }, > > + { "version", no_argument, NULL, 'v' }, > > + { GETOPT_NULL_LONGOPT }, > > + }; > > + > > + memset(cfg, 0, sizeof(*cfg)); > > + cfg->direction = GPIOD_LINE_DIRECTION_INPUT; > > + > > + for (;;) { > > + optc = getopt_long(argc, argv, shortopts, longopts, &opti); > > + if (optc < 0) > > + break; > > + > > + switch (optc) { > > + case 'a': > > + cfg->direction = GPIOD_LINE_DIRECTION_AS_IS; > > + break; > > + case 'b': > > + cfg->bias = parse_bias_or_die(optarg); > > + break; > > + case 'c': > > + cfg->chip_id = optarg; > > + break; > > + case 'l': > > + cfg->active_low = true; > > + break; > > + case 'p': > > + cfg->hold_period_us = parse_period_or_die(optarg); > > + break; > > + case 's': > > + cfg->strict = true; > > + break; > > + case 'h': > > + print_help(); > > + exit(EXIT_SUCCESS); > > + case 'v': > > + print_version(); > > + exit(EXIT_SUCCESS); > > + case '?': > > + die("try %s --help", get_progname()); > > + case 0: > > + break; > > + default: > > + abort(); > > + } > > + } > > + > > + return optind; > > +} > > + > > +int main(int argc, char **argv) > > +{ > > + int i, num_lines, ret, *values; > > + struct gpiod_line_settings *settings; > > + struct gpiod_request_config *req_cfg; > > + struct gpiod_line_request *request; > > + struct gpiod_line_config *line_cfg; > > + struct gpiod_chip *chip; > > + unsigned int *offsets; > > + struct line_resolver *resolver; > > + struct resolved_line *line; > > + struct config cfg; > > + > > + i = parse_config(argc, argv, &cfg); > > + argc -= i; > > + argv += i; > > + > > + if (argc < 1) > > + die("at least one GPIO line must be specified"); > > + > > + resolver = resolve_lines(argc, argv, cfg.chip_id, cfg.strict, > > + cfg.by_name); > > + validate_resolution(resolver, cfg.chip_id); > > + > > + offsets = calloc(resolver->num_lines, sizeof(*offsets)); > > + values = calloc(resolver->num_lines, sizeof(*values)); > > + if (!offsets || !values) > > + die("out of memory"); > > + > > + settings = gpiod_line_settings_new(); > > + if (!settings) > > + die_perror("unable to allocate line settings"); > > + > > + gpiod_line_settings_set_direction(settings, cfg.direction); > > + > > + if (cfg.bias) > > + gpiod_line_settings_set_bias(settings, cfg.bias); > > + > > + if (cfg.active_low) > > + gpiod_line_settings_set_active_low(settings, true); > > + > > + req_cfg = gpiod_request_config_new(); > > + if (!req_cfg) > > + die_perror("unable to allocate the request config structure"); > > + > > + line_cfg = gpiod_line_config_new(); > > + if (!line_cfg) > > + die_perror("unable to allocate the line config structure"); > > + > > + gpiod_request_config_set_consumer(req_cfg, "gpioget"); > > + for (i = 0; i < resolver->num_chips; i++) { > > + chip = gpiod_chip_open(resolver->chips[i].path); > > + if (!chip) > > + die_perror("unable to open chip '%s'", > > + resolver->chips[i].path); > > + > > + num_lines = get_line_offsets_and_values(resolver, i, offsets, > > + NULL); > > + > > + gpiod_line_config_reset(line_cfg); > > + ret = gpiod_line_config_add_line_settings(line_cfg, offsets, > > + num_lines, settings); > > + if (ret) > > + die_perror("unable to add line settings"); > > + > > + request = gpiod_chip_request_lines(chip, req_cfg, line_cfg); > > + if (!request) > > + die_perror("unable to request lines"); > > + > > + if (cfg.hold_period_us) > > + usleep(cfg.hold_period_us); > > + > > + ret = gpiod_line_request_get_values(request, values); > > + if (ret) > > + die_perror("unable to read GPIO line values"); > > + > > + set_line_values(resolver, i, values); > > + > > + gpiod_line_request_release(request); > > + gpiod_chip_close(chip); > > + } > > + for (i = 0; i < resolver->num_lines; i++) { > > + line = &resolver->lines[i]; > > + if (cfg.numeric) > > + printf("%d", line->value); > > + else > > + printf("%s=%s", line->id, > > + line->value ? "active" : "inactive"); > > + > > + if (i != resolver->num_lines - 1) > > + printf(" "); > > + } > > + printf("\n"); > > + > > + free_line_resolver(resolver); > > + gpiod_request_config_free(req_cfg); > > + gpiod_line_config_free(line_cfg); > > + gpiod_line_settings_free(settings); > > + free(offsets); > > + free(values); > > + > > + return EXIT_SUCCESS; > > +} > > diff --git a/tools/gpioinfo.c b/tools/gpioinfo.c > > index ae368fa..5dc28f8 100644 > > --- a/tools/gpioinfo.c > > +++ b/tools/gpioinfo.c > > @@ -1,8 +1,7 @@ > > // SPDX-License-Identifier: GPL-2.0-or-later > > // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> > > +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> > > > > -#include <dirent.h> > > -#include <errno.h> > > #include <getopt.h> > > #include <gpiod.h> > > #include <stdarg.h> > > @@ -12,3 +11,223 @@ > > > > #include "tools-common.h" > > > > +static void print_help(void) > > +{ > > + printf("Usage: %s [OPTIONS] [line]...\n", get_progname()); > > + printf("\n"); > > + printf("Print information about GPIO lines.\n"); > > + printf("\n"); > > + printf("Lines are specified by name, or optionally by offset if the chip option\n"); > > + printf("is provided.\n"); > > + printf("\n"); > > + printf("If no lines are specified than all lines are displayed.\n"); > > + printf("\n"); > > + printf("Options:\n"); > > + printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n"); > > + printf(" -c, --chip <chip>\trestrict scope to a particular chip\n"); > > + printf(" -h, --help\t\tdisplay this help and exit\n"); > > + printf(" -s, --strict\t\tcheck all lines - don't assume line names are unique\n"); > > + printf(" -v, --version\t\toutput version information and exit\n"); > > + print_chip_help(); > > +} > > + > > +struct config { > > + bool strict; > > + const char *chip_id; > > + int by_name; > > +}; > > + > > +int parse_config(int argc, char **argv, struct config *cfg) > > +{ > > + int opti, optc; > > + const char *const shortopts = "+c:hsv"; > > + const struct option longopts[] = { > > + { "by-name", no_argument, &cfg->by_name, 1 }, > > + { "chip", required_argument, NULL, 'c' }, > > + { "help", no_argument, NULL, 'h' }, > > + { "strict", no_argument, NULL, 's' }, > > + { "version", no_argument, NULL, 'v' }, > > + { GETOPT_NULL_LONGOPT }, > > + }; > > + > > + memset(cfg, 0, sizeof(*cfg)); > > + > > + for (;;) { > > + optc = getopt_long(argc, argv, shortopts, longopts, &opti); > > + if (optc < 0) > > + break; > > + > > + switch (optc) { > > + case 'c': > > + cfg->chip_id = optarg; > > + break; > > + case 's': > > + cfg->strict = true; > > + break; > > + case 'h': > > + print_help(); > > + exit(EXIT_SUCCESS); > > + case 'v': > > + print_version(); > > + exit(EXIT_SUCCESS); > > + case '?': > > + die("try %s --help", get_progname()); > > + case 0: > > + break; > > + default: > > + abort(); > > + } > > + } > > + > > + return optind; > > +} > > + > > + > > +// minimal version similar to tools-common that indicates if a line should be > > +// printed rather than storing details into the resolver. > > +// Does not die on non-unique lines. > > C-style comments only please. Same elsewhere. > Yeah - sorry again - I'm so used to that style that I don't even notice I'm doing it. > <snip> > > I like the new tools in general. I don't have many issues with the > code - you are a much better coder than I am. That's being a bit harsh. One thing I was considering was reworking the resolver so it would be more suitable for general use, and move it to core libgpiod so apps could more readily perform line name discovery. > I would change the > coding style here and there but I will probably just spend some time > on a good clang-format config and use it indiscriminately like I did > with black for Python. > That could be useful. Why doesn't the kernel do that? And that reminds me - I still need to circle back and take another look through the Python bindings. Cheers, Kent.
On Tue, Nov 8, 2022 at 4:33 PM Kent Gibson <warthog618@gmail.com> wrote: > > On Tue, Nov 08, 2022 at 02:13:20PM +0100, Bartosz Golaszewski wrote: > > On Tue, Oct 11, 2022 at 2:29 AM Kent Gibson <warthog618@gmail.com> wrote: > > > > > > Rework the tool suite to support identifying lines by name and to > > > support operating on the GPIO lines available to the user at once, rather > > > than on one particular GPIO chip. > > > > > > All tools, other than gpiodetect, now provide the name to (chip,offset) > > > mapping that was previously only performed by gpiofind. As names are not > > > guaranteed to be unique, a --strict option is provided for all tools to > > > either abort the operation or report all lines with the matching name, as > > > appropriate. > > > By default the tools operate on the first line found with a matching name. > > > > > > Selection of line by (chip,offset) is still supported with a --chip > > > option, though it restricts the scope of the operation to an individual > > > chip. When the --chip option is specified, the lines are assumed to be > > > identified by offset where they parse as an integer, else by name. > > > To cater for the unusual case where a line name parses as an integer, > > > but is different from the offset, the --by-name option forces the lines > > > to be identified by name. > > > > > > The updated tools are intentionally NOT backwardly compatible with the > > > previous tools. Using old command lines with the updated tools will > > > almost certainly fail, though migrating old command lines is generally as > > > simple as adding a '-c' before the chip. > > > > > > > While at it: how about adding the --consumer/-C switch to specify a > > consumer string other than the name of the program? > > > > Ironically I added that to the Rust version, for the long lived > commands anyway, so it could better emulate the C version for testing > purposes. > But could be generally useful, so ok. > > I only used the long form there to avoid confusion with -c (as they are > visually very similar) and following the principle that rarely used > options only get a long form, so I will omit the short -C option - unless > you insist. > I don't see why it would hurt but I'm fine either way. > > > In addition the individual tools are modified as follows: > > > > > > gpiodetect: > > > > > > Add the option to select individual chips. > > > > > > gpioinfo: > > > > > > Change the focus from chips to lines, so the scope can be > > > an individual line, a subset of lines, all lines on a particular chip, > > > or all the lines available to the user. For line scope a single line > > > summary is output for each line. For chip scope the existing format > > > displaying a summary of the chip and each of its lines is retained. > > > > > > Line attributes are consolidated into a list format, and are extended > > > to cover all attributes supported by uAPI v2. > > > > > > > One change in the output that bothers me is the removal of quotation > > marks around the line name and consumer. I did that in v1 to visually > > distinguish between unnamed/unused lines and those that are named. I > > know it's highly unlikely that a line would be named "unnamed" (sic!) > > but still: > > > > line 0: "foo" > > line 1: unnamed > > > > looks more intuitive to me. > > I disagree on this one. In the longer term all lines should be named > and then the quotes just become pointless noise, and require more > work to parse. > I insist on this one as just a quick glance at the current values of gpio-line-names DT properties in the kernel show all kinds of funky names - not only including spaces but also various other characters like [, ], #, /, - and that not. I think it makes a lot of sense to delimit them visually with quotes. > >Same for the consumer as with your current > > version, if the consumer string has spaces in it, it will look like > > this: consumer=foo bar. I think consumer="foo bar" would be easier to > > parse. > > For this very reason, the consumer is explicitly listed last, so the > consumer name matches everything between the "consumer=" and end of > line. > > Unless consumer names with spaces are very common in the wild then > quotes only add more clutter. > We can't know, but instead of putting it last, I'd just treat it like every other flag and instead delimit the name with "". The tool is mostly aimed at humans anyway and if someone's brave enough to parse the output with a script then a cut-based one-liner is all they need, no? > > > > > gpioget: > > > > > > The default output format is becomes line=value, as per the > > > input for gpioset, and the value is reported as active or inactive, > > > rather than 0 or 1. > > > The previous format is available using the --numeric option. > > > > > > Add an optional hold period between requesting a line and reading the > > > value to allow the line to settle once the requested configuration has > > > been applied (e.g. bias). > > > > > > gpiomon: > > > > > > Consolidate the edge options into a single option. > > > > > > Add a debounce period option. > > > > > > Add options to report event times as UTC or localtime. > > > > > > Add format specifiers for GPIO chip path, line name, stringified event > > > type, and event time as a datetime. > > > > > > Rearrange default output format to place fields with more predicable > > > widths to the left, and to separate major field groups with tabs. > > > Lines are identified consistent with the command line. > > > > > > gpioset: > > > > > > Add a hold period option that specifies the minimum period the line > > > value must be held for. This applies to all set options. > > > > > > Support line values specified as active/inactive, on/off and > > > true/false, as well as 1/0. > > > > > > Add a toggle option that specifies a time sequence over which the > > > requested lines should be toggled. If the sequence is 0 terminated then > > > gpioset exits when the sequence completes, else it repeats the sequence. > > > This allows for anything from simple blinkers to bit bashing from the > > > command line. e.g. gpioset -t 500ms LED=on > > > > > > Add an interactive option to provide a shell-like interface to allow > > > manual or scripted manipulation of requested lines. A basic command set > > > allows lines to be get, set, or toggled, and to insert sleeps between > > > operations. > > > > > > > As discussed elsewhere - it would be great if this part was optional > > and configurable at build-time so that the dependency on libedit could > > be dropped if unavailable. > > > > Agreed. > > > > Remove the --mode, --sec, and --usec options. > > > The combination of hold period and interactive mode provide functionality > > > equivalent to the old --mode options. > > > > > > > I have one problem with that - I think the basic functionality of: > > "take a line, set its value and wait for a signal" would still be > > useful. As it is now, I'm not sure how to make gpioset just hold a > > line without calling the GPIO_V2_LINE_SET_VALUES_IOCTL ioctl > > periodically. > > > > I forgot to mention the daemonize option here, so > > gpioset -z myline=1 > > will do that. > > (or > > gpioset -i myline=1 > > if you want to keep the process in the foreground.) > > I'll add something to the daemonize help to highlight that it will hold > the line until killed. Is that sufficient? > What if I don't want to daemonize the program nor open the interactive mode? Why not just make the default behavior of `gpioset foo=active` be: stay alive until interrupted? The current immediate exiting is mostly useless anyway. > > > Signed-off-by: Kent Gibson <warthog618@gmail.com> > > > --- > > > configure.ac | 8 +- > > > tools/Makefile.am | 2 +- > > > tools/gpiodetect.c | 113 +++++- > > > tools/gpioget.c | 204 ++++++++++- > > > tools/gpioinfo.c | 223 +++++++++++- > > > tools/gpiomon.c | 450 +++++++++++++++++++++++- > > > tools/gpioset.c | 815 ++++++++++++++++++++++++++++++++++++++++++- > > > tools/tools-common.c | 713 ++++++++++++++++++++++++++++++++++++- > > > tools/tools-common.h | 99 +++++- > > > 9 files changed, 2585 insertions(+), 42 deletions(-) > > > > > > diff --git a/configure.ac b/configure.ac > > > index 6ac1d8e..c8033c5 100644 > > > --- a/configure.ac > > > +++ b/configure.ac > > > @@ -106,14 +106,14 @@ AC_DEFUN([FUNC_NOT_FOUND_TOOLS], > > > AC_DEFUN([HEADER_NOT_FOUND_TOOLS], > > > [ERR_NOT_FOUND([$1 header], [tools])]) > > > > > > +AC_DEFUN([LIB_NOT_FOUND_TOOLS], > > > + [ERR_NOT_FOUND([lib$1], [tools])]) > > > + > > > if test "x$with_tools" = xtrue > > > then > > > # These are only needed to build tools > > > - AC_CHECK_FUNC([basename], [], [FUNC_NOT_FOUND_TOOLS([basename])]) > > > AC_CHECK_FUNC([daemon], [], [FUNC_NOT_FOUND_TOOLS([daemon])]) > > > - AC_CHECK_FUNC([signalfd], [], [FUNC_NOT_FOUND_TOOLS([signalfd])]) > > > - AC_CHECK_FUNC([setlinebuf], [], [FUNC_NOT_FOUND_TOOLS([setlinebuf])]) > > > - AC_CHECK_HEADERS([sys/signalfd.h], [], [HEADER_NOT_FOUND_TOOLS([sys/signalfd.h])]) > > > + PKG_CHECK_MODULES(LIBEDIT, libedit) > > > fi > > > > > > AC_ARG_ENABLE([tests], > > > diff --git a/tools/Makefile.am b/tools/Makefile.am > > > index fc074b9..c956314 100644 > > > --- a/tools/Makefile.am > > > +++ b/tools/Makefile.am > > > @@ -7,7 +7,7 @@ AM_CFLAGS += -Wall -Wextra -g -std=gnu89 > > > noinst_LTLIBRARIES = libtools-common.la > > > libtools_common_la_SOURCES = tools-common.c tools-common.h > > > > > > -LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la > > > +LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la $(LIBEDIT_LIBS) > > > > > > bin_PROGRAMS = gpiodetect gpioinfo gpioget gpioset gpiomon > > > > > > diff --git a/tools/gpiodetect.c b/tools/gpiodetect.c > > > index 30bde32..910fe9e 100644 > > > --- a/tools/gpiodetect.c > > > +++ b/tools/gpiodetect.c > > > @@ -1,8 +1,7 @@ > > > // SPDX-License-Identifier: GPL-2.0-or-later > > > // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> > > > +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> > > > > > > -#include <dirent.h> > > > -#include <errno.h> > > > #include <getopt.h> > > > #include <gpiod.h> > > > #include <stdio.h> > > > @@ -11,3 +10,113 @@ > > > > > > #include "tools-common.h" > > > > > > +static void print_help(void) > > > +{ > > > + printf("Usage: %s [OPTIONS] [chip]...\n", get_progname()); > > > + printf("\n"); > > > + printf("List GPIO chips, print their labels and number of GPIO lines.\n"); > > > + printf("\n"); > > > + printf("Chips may be identified by number, name, or path.\n"); > > > + printf("e.g. '0', 'gpiochip0', and '/dev/gpiochip0' all refer to the same chip.\n"); > > > + printf("\n"); > > > + printf("If no chips are specified then all chips are listed.\n"); > > > + printf("\n"); > > > + printf("Options:\n"); > > > + printf(" -h, --help\t\tdisplay this help and exit\n"); > > > + printf(" -v, --version\t\toutput version information and exit\n"); > > > +} > > > + > > > +int parse_config(int argc, char **argv) > > > +{ > > > + int optc, opti; > > > + const char *const shortopts = "+hv"; > > > + const struct option longopts[] = { > > > + { "help", no_argument, NULL, 'h' }, > > > + { "version", no_argument, NULL, 'v' }, > > > + { GETOPT_NULL_LONGOPT }, > > > + }; > > > > This can be static as there are no addresses of flag variables assigned. > > > > Indeed - and now you mention it I notice a few other things that should be > static too. > <snip> > > > + > > > +// minimal version similar to tools-common that indicates if a line should be > > > +// printed rather than storing details into the resolver. > > > +// Does not die on non-unique lines. > > > > C-style comments only please. Same elsewhere. > > > > Yeah - sorry again - I'm so used to that style that I don't even notice > I'm doing it. > > > <snip> > > > > I like the new tools in general. I don't have many issues with the > > code - you are a much better coder than I am. > > That's being a bit harsh. > > One thing I was considering was reworking the resolver so it would be > more suitable for general use, and move it to core libgpiod so apps > could more readily perform line name discovery. > Hmm, I think it's unnecessary clutter in the library. I was thinking about whether to put the upcoming fdinfo parsing into the library and figured that it's more of a suitable candidate for a new command-line tool as the library should focus on the character device exclusively IMO. > > I would change the > > coding style here and there but I will probably just spend some time > > on a good clang-format config and use it indiscriminately like I did > > with black for Python. > > > > That could be useful. Why doesn't the kernel do that? Probably for the same reason it doesn't use __attribute__((cleanup(x))) etc. linux kernel inertia. :) > And that reminds me - I still need to circle back and take another look > through the Python bindings. > Thanks! Bart
On Tue, Nov 08, 2022 at 07:25:27PM +0100, Bartosz Golaszewski wrote: > On Tue, Nov 8, 2022 at 4:33 PM Kent Gibson <warthog618@gmail.com> wrote: > > > > On Tue, Nov 08, 2022 at 02:13:20PM +0100, Bartosz Golaszewski wrote: > > > On Tue, Oct 11, 2022 at 2:29 AM Kent Gibson <warthog618@gmail.com> wrote: > > > > > > > > Rework the tool suite to support identifying lines by name and to > > > > support operating on the GPIO lines available to the user at once, rather > > > > than on one particular GPIO chip. > > > > > > > > All tools, other than gpiodetect, now provide the name to (chip,offset) > > > > mapping that was previously only performed by gpiofind. As names are not > > > > guaranteed to be unique, a --strict option is provided for all tools to > > > > either abort the operation or report all lines with the matching name, as > > > > appropriate. > > > > By default the tools operate on the first line found with a matching name. > > > > > > > > Selection of line by (chip,offset) is still supported with a --chip > > > > option, though it restricts the scope of the operation to an individual > > > > chip. When the --chip option is specified, the lines are assumed to be > > > > identified by offset where they parse as an integer, else by name. > > > > To cater for the unusual case where a line name parses as an integer, > > > > but is different from the offset, the --by-name option forces the lines > > > > to be identified by name. > > > > > > > > The updated tools are intentionally NOT backwardly compatible with the > > > > previous tools. Using old command lines with the updated tools will > > > > almost certainly fail, though migrating old command lines is generally as > > > > simple as adding a '-c' before the chip. > > > > > > > > > > While at it: how about adding the --consumer/-C switch to specify a > > > consumer string other than the name of the program? > > > > > > > Ironically I added that to the Rust version, for the long lived > > commands anyway, so it could better emulate the C version for testing > > purposes. > > But could be generally useful, so ok. > > > > I only used the long form there to avoid confusion with -c (as they are > > visually very similar) and following the principle that rarely used > > options only get a long form, so I will omit the short -C option - unless > > you insist. > > > > I don't see why it would hurt but I'm fine either way. > It would only be a problem if the consumer name matched with a gpiochip, and that seems unlikely. And no other use for -C seems likely either, so I guess you are right - it wouldn't hurt. > > > > In addition the individual tools are modified as follows: > > > > > > > > gpiodetect: > > > > > > > > Add the option to select individual chips. > > > > > > > > gpioinfo: > > > > > > > > Change the focus from chips to lines, so the scope can be > > > > an individual line, a subset of lines, all lines on a particular chip, > > > > or all the lines available to the user. For line scope a single line > > > > summary is output for each line. For chip scope the existing format > > > > displaying a summary of the chip and each of its lines is retained. > > > > > > > > Line attributes are consolidated into a list format, and are extended > > > > to cover all attributes supported by uAPI v2. > > > > > > > > > > One change in the output that bothers me is the removal of quotation > > > marks around the line name and consumer. I did that in v1 to visually > > > distinguish between unnamed/unused lines and those that are named. I > > > know it's highly unlikely that a line would be named "unnamed" (sic!) > > > but still: > > > > > > line 0: "foo" > > > line 1: unnamed > > > > > > looks more intuitive to me. > > > > I disagree on this one. In the longer term all lines should be named > > and then the quotes just become pointless noise, and require more > > work to parse. > > > > I insist on this one as just a quick glance at the current values of > gpio-line-names DT properties in the kernel show all kinds of funky > names - not only including spaces but also various other characters > like [, ], #, /, - and that not. I think it makes a lot of sense to > delimit them visually with quotes. > Good grief, what a mess. Would've been nice to have some naming conventions in place, but too late now... Which reminds me - any guarantees the name, particularly the consumer name, is valid UTF-8? If not then need to double check how the Rust bindings deal with that. Throwing a utf8_error would not be appropriate if it isn't guaranteed to be UTF-8. > > >Same for the consumer as with your current > > > version, if the consumer string has spaces in it, it will look like > > > this: consumer=foo bar. I think consumer="foo bar" would be easier to > > > parse. > > > > For this very reason, the consumer is explicitly listed last, so the > > consumer name matches everything between the "consumer=" and end of > > line. > > > > Unless consumer names with spaces are very common in the wild then > > quotes only add more clutter. > > > > We can't know, but instead of putting it last, I'd just treat it like > every other flag and instead delimit the name with "". It is also last based on length predicatability - more predicatable first, and the other attributes are more predictable. > > The tool is mostly aimed at humans anyway and if someone's brave > enough to parse the output with a script then a cut-based one-liner is > all they need, no? > Sure, but don't underestimate the ability of users to complain when a tool isn't quite as easy to use as they would like. Hmmm, how about an option to quote all string attributes? Say --quoted? Or if quoted is the default then --unquoted to remove the clutter? <snip> > > > > > > Remove the --mode, --sec, and --usec options. > > > > The combination of hold period and interactive mode provide functionality > > > > equivalent to the old --mode options. > > > > > > > > > > I have one problem with that - I think the basic functionality of: > > > "take a line, set its value and wait for a signal" would still be > > > useful. As it is now, I'm not sure how to make gpioset just hold a > > > line without calling the GPIO_V2_LINE_SET_VALUES_IOCTL ioctl > > > periodically. > > > > > > > I forgot to mention the daemonize option here, so > > > > gpioset -z myline=1 > > > > will do that. > > > > (or > > > > gpioset -i myline=1 > > > > if you want to keep the process in the foreground.) > > > > I'll add something to the daemonize help to highlight that it will hold > > the line until killed. Is that sufficient? > > > > What if I don't want to daemonize the program nor open the interactive > mode? Why not just make the default behavior of `gpioset foo=active` > be: stay alive until interrupted? The current immediate exiting is > mostly useless anyway. > Hmmm, not when used with the --hold-period, so a script could call a series of gpiosets to generate a waveform. Though that doesn't work well, as the line is released between sets, and the whole point of the toggle option and interactive modes is to provide better alternatives for doing that. So yeah, true - I guess I just blindly followed the v1 behaviour on that. - the standard behaviour should be to not exit. The only exception being a zero-terminated toggle sequence. That should also reduce the chance of users complaining that gpioset doesn't work where they assume the set persists after gpioset exists. OTOH I'm willing to bet we get at least one complaint that gpioset hangs... :|. <snip> > > > > > + > > > > +// minimal version similar to tools-common that indicates if a line should be > > > > +// printed rather than storing details into the resolver. > > > > +// Does not die on non-unique lines. > > > > > > C-style comments only please. Same elsewhere. > > > > > > > Yeah - sorry again - I'm so used to that style that I don't even notice > > I'm doing it. > > > > > <snip> > > > > > > I like the new tools in general. I don't have many issues with the > > > code - you are a much better coder than I am. > > > > That's being a bit harsh. > > > > One thing I was considering was reworking the resolver so it would be > > more suitable for general use, and move it to core libgpiod so apps > > could more readily perform line name discovery. > > > > Hmm, I think it's unnecessary clutter in the library. I was thinking > about whether to put the upcoming fdinfo parsing into the library and > figured that it's more of a suitable candidate for a new command-line > tool as the library should focus on the character device exclusively > IMO. > I think you were right the first time. The fdinfo is another aspect of the cdev GPIO uAPI - it isn't just the ioctls. If the GPIO uAPI were extended to use AIO, would that not go in libgpiod as well? And agreed that fdinfo warrants another tool. It makes sense to me to add higher level abstractions or functionality where that greatly simplifies apps. Speaking from experience, looking up up the line chip/offset based on name is at best tedious and at worst a serious PITA. If it isn't available in libgpiod then apps are more likely to do it out-of-band, such as by using gpioinfo to generate app configuration, or just stick to specifying lines by chip/offset, which is a bit sad. But, as per the unified tool binary, this can always be added later. Cheers, Kent.
On Wed, Nov 9, 2022 at 3:00 AM Kent Gibson <warthog618@gmail.com> wrote: > [snip] > > > > I insist on this one as just a quick glance at the current values of > > gpio-line-names DT properties in the kernel show all kinds of funky > > names - not only including spaces but also various other characters > > like [, ], #, /, - and that not. I think it makes a lot of sense to > > delimit them visually with quotes. > > > > Good grief, what a mess. Would've been nice to have some naming > conventions in place, but too late now... > > Which reminds me - any guarantees the name, particularly the consumer > name, is valid UTF-8? > If not then need to double check how the Rust bindings deal with that. > Throwing a utf8_error would not be appropriate if it isn't guaranteed to > be UTF-8. > There's nothing that technically prohibits anyone from using non-UTF8 characters and also current libgpiod seems to be handling such chars just fine (just tested to make sure). > > > >Same for the consumer as with your current > > > > version, if the consumer string has spaces in it, it will look like > > > > this: consumer=foo bar. I think consumer="foo bar" would be easier to > > > > parse. > > > > > > For this very reason, the consumer is explicitly listed last, so the > > > consumer name matches everything between the "consumer=" and end of > > > line. > > > > > > Unless consumer names with spaces are very common in the wild then > > > quotes only add more clutter. > > > > > > > We can't know, but instead of putting it last, I'd just treat it like > > every other flag and instead delimit the name with "". > > It is also last based on length predicatability - more predicatable > first, and the other attributes are more predictable. > > > > > The tool is mostly aimed at humans anyway and if someone's brave > > enough to parse the output with a script then a cut-based one-liner is > > all they need, no? > > > > Sure, but don't underestimate the ability of users to complain when a > tool isn't quite as easy to use as they would like. > > Hmmm, how about an option to quote all string attributes? > Say --quoted? > Or if quoted is the default then --unquoted to remove the clutter? > I don't feel like it's necessary. How would you handle line names with spaces? It would add an additional column? That would be actually harder to parse than quoted names IMO. > <snip> > > > > > > > > Remove the --mode, --sec, and --usec options. > > > > > The combination of hold period and interactive mode provide functionality > > > > > equivalent to the old --mode options. > > > > > > > > > > > > > I have one problem with that - I think the basic functionality of: > > > > "take a line, set its value and wait for a signal" would still be > > > > useful. As it is now, I'm not sure how to make gpioset just hold a > > > > line without calling the GPIO_V2_LINE_SET_VALUES_IOCTL ioctl > > > > periodically. > > > > > > > > > > I forgot to mention the daemonize option here, so > > > > > > gpioset -z myline=1 > > > > > > will do that. > > > > > > (or > > > > > > gpioset -i myline=1 > > > > > > if you want to keep the process in the foreground.) > > > > > > I'll add something to the daemonize help to highlight that it will hold > > > the line until killed. Is that sufficient? > > > > > > > What if I don't want to daemonize the program nor open the interactive > > mode? Why not just make the default behavior of `gpioset foo=active` > > be: stay alive until interrupted? The current immediate exiting is > > mostly useless anyway. > > > > Hmmm, not when used with the --hold-period, so a script could call a > series of gpiosets to generate a waveform. Though that doesn't work > well, as the line is released between sets, and the whole point of > the toggle option and interactive modes is to provide better > alternatives for doing that. > > So yeah, true - I guess I just blindly followed the v1 behaviour on that. > - the standard behaviour should be to not exit. > The only exception being a zero-terminated toggle sequence. > > That should also reduce the chance of users complaining that gpioset > doesn't work where they assume the set persists after gpioset exists. > OTOH I'm willing to bet we get at least one complaint that gpioset > hangs... :|. > > <snip> > > > > > > > + > > > > > +// minimal version similar to tools-common that indicates if a line should be > > > > > +// printed rather than storing details into the resolver. > > > > > +// Does not die on non-unique lines. > > > > > > > > C-style comments only please. Same elsewhere. > > > > > > > > > > Yeah - sorry again - I'm so used to that style that I don't even notice > > > I'm doing it. > > > > > > > <snip> > > > > > > > > I like the new tools in general. I don't have many issues with the > > > > code - you are a much better coder than I am. > > > > > > That's being a bit harsh. > > > > > > One thing I was considering was reworking the resolver so it would be > > > more suitable for general use, and move it to core libgpiod so apps > > > could more readily perform line name discovery. > > > > > > > Hmm, I think it's unnecessary clutter in the library. I was thinking > > about whether to put the upcoming fdinfo parsing into the library and > > figured that it's more of a suitable candidate for a new command-line > > tool as the library should focus on the character device exclusively > > IMO. > > > > I think you were right the first time. The fdinfo is another aspect of > the cdev GPIO uAPI - it isn't just the ioctls. > If the GPIO uAPI were extended to use AIO, would that not go in libgpiod as > well? > > And agreed that fdinfo warrants another tool. > I was thinking that both gpioinfo could use that (e.g. consumer="foobar",consumer_pid=12345) and we could have something like: # gpioowner foobar 12345 > It makes sense to me to add higher level abstractions or functionality > where that greatly simplifies apps. > Speaking from experience, looking up up the line chip/offset based on > name is at best tedious and at worst a serious PITA. > If it isn't available in libgpiod then apps are more likely to do it > out-of-band, such as by using gpioinfo to generate app configuration, > or just stick to specifying lines by chip/offset, which is a bit sad. > > But, as per the unified tool binary, this can always be added later. > Ok, I'm buying this. Let's think about adding this to the core library. Bart
On Wed, Nov 09, 2022 at 12:16:22PM +0100, Bartosz Golaszewski wrote: > On Wed, Nov 9, 2022 at 3:00 AM Kent Gibson <warthog618@gmail.com> wrote: > > > > [snip] > > > > > > > > I insist on this one as just a quick glance at the current values of > > > gpio-line-names DT properties in the kernel show all kinds of funky > > > names - not only including spaces but also various other characters > > > like [, ], #, /, - and that not. I think it makes a lot of sense to > > > delimit them visually with quotes. > > > > > > > Good grief, what a mess. Would've been nice to have some naming > > conventions in place, but too late now... > > > > Which reminds me - any guarantees the name, particularly the consumer > > name, is valid UTF-8? > > If not then need to double check how the Rust bindings deal with that. > > Throwing a utf8_error would not be appropriate if it isn't guaranteed to > > be UTF-8. > > > > There's nothing that technically prohibits anyone from using non-UTF8 > characters and also current libgpiod seems to be handling such chars > just fine (just tested to make sure). > Exactly - AIUI the names are simply 32 bytes - any 32 bytes. There is also the possibility of UTF-8 being truncated mid-character due to the 32 byte limit - so even if you put UTF-8 in, it might come out invalid when you read it back. > > > > >Same for the consumer as with your current > > > > > version, if the consumer string has spaces in it, it will look like > > > > > this: consumer=foo bar. I think consumer="foo bar" would be easier to > > > > > parse. > > > > > > > > For this very reason, the consumer is explicitly listed last, so the > > > > consumer name matches everything between the "consumer=" and end of > > > > line. > > > > > > > > Unless consumer names with spaces are very common in the wild then > > > > quotes only add more clutter. > > > > > > > > > > We can't know, but instead of putting it last, I'd just treat it like > > > every other flag and instead delimit the name with "". > > > > It is also last based on length predicatability - more predicatable > > first, and the other attributes are more predictable. > > > > > > > > The tool is mostly aimed at humans anyway and if someone's brave > > > enough to parse the output with a script then a cut-based one-liner is > > > all they need, no? > > > > > > > Sure, but don't underestimate the ability of users to complain when a > > tool isn't quite as easy to use as they would like. > > > > Hmmm, how about an option to quote all string attributes? > > Say --quoted? > > Or if quoted is the default then --unquoted to remove the clutter? > > > > I don't feel like it's necessary. How would you handle line names with > spaces? It would add an additional column? That would be actually > harder to parse than quoted names IMO. > Line names are surrounded by tabs, so the actual issue is line names containing tabs. Are there any of those? And this is just targetting humans (well me at least) anyway. <snip> > > > > One thing I was considering was reworking the resolver so it would be > > > > more suitable for general use, and move it to core libgpiod so apps > > > > could more readily perform line name discovery. > > > > > > > > > > Hmm, I think it's unnecessary clutter in the library. I was thinking > > > about whether to put the upcoming fdinfo parsing into the library and > > > figured that it's more of a suitable candidate for a new command-line > > > tool as the library should focus on the character device exclusively > > > IMO. > > > > > > > I think you were right the first time. The fdinfo is another aspect of > > the cdev GPIO uAPI - it isn't just the ioctls. > > If the GPIO uAPI were extended to use AIO, would that not go in libgpiod as > > well? > > > > And agreed that fdinfo warrants another tool. > > > > I was thinking that both gpioinfo could use that (e.g. > consumer="foobar",consumer_pid=12345) and we could have something > like: > > # gpioowner foobar > 12345 > Both those make sense to me. > > It makes sense to me to add higher level abstractions or functionality > > where that greatly simplifies apps. > > Speaking from experience, looking up up the line chip/offset based on > > name is at best tedious and at worst a serious PITA. > > If it isn't available in libgpiod then apps are more likely to do it > > out-of-band, such as by using gpioinfo to generate app configuration, > > or just stick to specifying lines by chip/offset, which is a bit sad. > > > > But, as per the unified tool binary, this can always be added later. > > > > Ok, I'm buying this. Let's think about adding this to the core library. > Oh great - I should've kept my trap shut ;-). Cheers, Kent.
diff --git a/configure.ac b/configure.ac index 6ac1d8e..c8033c5 100644 --- a/configure.ac +++ b/configure.ac @@ -106,14 +106,14 @@ AC_DEFUN([FUNC_NOT_FOUND_TOOLS], AC_DEFUN([HEADER_NOT_FOUND_TOOLS], [ERR_NOT_FOUND([$1 header], [tools])]) +AC_DEFUN([LIB_NOT_FOUND_TOOLS], + [ERR_NOT_FOUND([lib$1], [tools])]) + if test "x$with_tools" = xtrue then # These are only needed to build tools - AC_CHECK_FUNC([basename], [], [FUNC_NOT_FOUND_TOOLS([basename])]) AC_CHECK_FUNC([daemon], [], [FUNC_NOT_FOUND_TOOLS([daemon])]) - AC_CHECK_FUNC([signalfd], [], [FUNC_NOT_FOUND_TOOLS([signalfd])]) - AC_CHECK_FUNC([setlinebuf], [], [FUNC_NOT_FOUND_TOOLS([setlinebuf])]) - AC_CHECK_HEADERS([sys/signalfd.h], [], [HEADER_NOT_FOUND_TOOLS([sys/signalfd.h])]) + PKG_CHECK_MODULES(LIBEDIT, libedit) fi AC_ARG_ENABLE([tests], diff --git a/tools/Makefile.am b/tools/Makefile.am index fc074b9..c956314 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -7,7 +7,7 @@ AM_CFLAGS += -Wall -Wextra -g -std=gnu89 noinst_LTLIBRARIES = libtools-common.la libtools_common_la_SOURCES = tools-common.c tools-common.h -LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la +LDADD = libtools-common.la $(top_builddir)/lib/libgpiod.la $(LIBEDIT_LIBS) bin_PROGRAMS = gpiodetect gpioinfo gpioget gpioset gpiomon diff --git a/tools/gpiodetect.c b/tools/gpiodetect.c index 30bde32..910fe9e 100644 --- a/tools/gpiodetect.c +++ b/tools/gpiodetect.c @@ -1,8 +1,7 @@ // SPDX-License-Identifier: GPL-2.0-or-later // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> -#include <dirent.h> -#include <errno.h> #include <getopt.h> #include <gpiod.h> #include <stdio.h> @@ -11,3 +10,113 @@ #include "tools-common.h" +static void print_help(void) +{ + printf("Usage: %s [OPTIONS] [chip]...\n", get_progname()); + printf("\n"); + printf("List GPIO chips, print their labels and number of GPIO lines.\n"); + printf("\n"); + printf("Chips may be identified by number, name, or path.\n"); + printf("e.g. '0', 'gpiochip0', and '/dev/gpiochip0' all refer to the same chip.\n"); + printf("\n"); + printf("If no chips are specified then all chips are listed.\n"); + printf("\n"); + printf("Options:\n"); + printf(" -h, --help\t\tdisplay this help and exit\n"); + printf(" -v, --version\t\toutput version information and exit\n"); +} + +int parse_config(int argc, char **argv) +{ + int optc, opti; + const char *const shortopts = "+hv"; + const struct option longopts[] = { + { "help", no_argument, NULL, 'h' }, + { "version", no_argument, NULL, 'v' }, + { GETOPT_NULL_LONGOPT }, + }; + + for (;;) { + optc = getopt_long(argc, argv, shortopts, longopts, &opti); + if (optc < 0) + break; + + switch (optc) { + case 'h': + print_help(); + exit(EXIT_SUCCESS); + case 'v': + print_version(); + exit(EXIT_SUCCESS); + case '?': + die("try %s --help", get_progname()); + default: + abort(); + } + } + return optind; +} + +int print_chip_info(const char *path) +{ + struct gpiod_chip *chip; + struct gpiod_chip_info *info; + + chip = gpiod_chip_open(path); + if (!chip) { + print_perror("unable to open chip '%s'", path); + return 1; + } + + info = gpiod_chip_get_info(chip); + if (!info) + die_perror("unable to read info for '%s'", path); + + printf("%s [%s] (%zu lines)\n", + gpiod_chip_info_get_name(info), + gpiod_chip_info_get_label(info), + gpiod_chip_info_get_num_lines(info)); + + gpiod_chip_info_free(info); + gpiod_chip_close(chip); + return 0; +} + +int main(int argc, char **argv) +{ + int num_chips, i; + char **paths; + char *path; + int ret = EXIT_SUCCESS; + + i = parse_config(argc, argv); + argc -= i; + argv += i; + + if (argc == 0) { + num_chips = all_chip_paths(&paths); + for (i = 0; i < num_chips; i++) { + if (print_chip_info(paths[i])) + ret = EXIT_FAILURE; + + free(paths[i]); + } + free(paths); + } + + for (i = 0; i < argc; i++) { + if (chip_path_lookup(argv[i], &path)) { + if (print_chip_info(path)) + ret = EXIT_FAILURE; + + free(path); + } else { + print_error( + "cannot find GPIO chip character device '%s'", + argv[i]); + ret = EXIT_FAILURE; + } + } + + return ret; +} diff --git a/tools/gpioget.c b/tools/gpioget.c index 1b3e666..7a26066 100644 --- a/tools/gpioget.c +++ b/tools/gpioget.c @@ -1,12 +1,214 @@ // SPDX-License-Identifier: GPL-2.0-or-later // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> #include <getopt.h> #include <gpiod.h> -#include <limits.h> #include <stdio.h> #include <stdlib.h> #include <string.h> +#include <unistd.h> #include "tools-common.h" +static void print_help(void) +{ + printf("Usage: %s [OPTIONS] <line>...\n", get_progname()); + printf("\n"); + printf("Read values of GPIO lines.\n"); + printf("\n"); + printf("Lines are specified by name, or optionally by offset if the chip option\n"); + printf("is provided.\n"); + printf("\n"); + printf("Options:\n"); + printf(" -a, --as-is\t\tleave the line direction unchanged, not forced to input\n"); + print_bias_help(); + printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n"); + printf(" -c, --chip <chip>\trestrict scope to a particular chip\n"); + printf(" -h, --help\t\tdisplay this help and exit\n"); + printf(" -l, --active-low\ttreat the line as active low\n"); + printf(" -p, --hold-period <period>\n"); + printf("\t\t\twait between requesting the lines and reading the values\n"); + printf(" --numeric\t\tdisplay line values as '0' (inactive) or '1' (active)\n"); + printf(" -s, --strict\t\tabort if requested line names are not unique\n"); + printf(" -v, --version\t\toutput version information and exit\n"); + print_chip_help(); + print_period_help(); +} +struct config { + bool active_low; + bool strict; + int bias; + int direction; + unsigned int hold_period_us; + const char *chip_id; + int by_name; + int numeric; +}; + +int parse_config(int argc, char **argv, struct config *cfg) +{ + int opti, optc; + const char *const shortopts = "+ab:c:hlp:sv"; + const struct option longopts[] = { + { "active-low", no_argument, NULL, 'l' }, + { "as-is", no_argument, NULL, 'a' }, + { "bias", required_argument, NULL, 'b' }, + { "by-name", no_argument, &cfg->by_name, 1 }, + { "chip", required_argument, NULL, 'c' }, + { "help", no_argument, NULL, 'h' }, + { "hold-period", required_argument, NULL, 'p' }, + { "numeric", no_argument, &cfg->numeric, 1 }, + { "strict", no_argument, NULL, 's' }, + { "version", no_argument, NULL, 'v' }, + { GETOPT_NULL_LONGOPT }, + }; + + memset(cfg, 0, sizeof(*cfg)); + cfg->direction = GPIOD_LINE_DIRECTION_INPUT; + + for (;;) { + optc = getopt_long(argc, argv, shortopts, longopts, &opti); + if (optc < 0) + break; + + switch (optc) { + case 'a': + cfg->direction = GPIOD_LINE_DIRECTION_AS_IS; + break; + case 'b': + cfg->bias = parse_bias_or_die(optarg); + break; + case 'c': + cfg->chip_id = optarg; + break; + case 'l': + cfg->active_low = true; + break; + case 'p': + cfg->hold_period_us = parse_period_or_die(optarg); + break; + case 's': + cfg->strict = true; + break; + case 'h': + print_help(); + exit(EXIT_SUCCESS); + case 'v': + print_version(); + exit(EXIT_SUCCESS); + case '?': + die("try %s --help", get_progname()); + case 0: + break; + default: + abort(); + } + } + + return optind; +} + +int main(int argc, char **argv) +{ + int i, num_lines, ret, *values; + struct gpiod_line_settings *settings; + struct gpiod_request_config *req_cfg; + struct gpiod_line_request *request; + struct gpiod_line_config *line_cfg; + struct gpiod_chip *chip; + unsigned int *offsets; + struct line_resolver *resolver; + struct resolved_line *line; + struct config cfg; + + i = parse_config(argc, argv, &cfg); + argc -= i; + argv += i; + + if (argc < 1) + die("at least one GPIO line must be specified"); + + resolver = resolve_lines(argc, argv, cfg.chip_id, cfg.strict, + cfg.by_name); + validate_resolution(resolver, cfg.chip_id); + + offsets = calloc(resolver->num_lines, sizeof(*offsets)); + values = calloc(resolver->num_lines, sizeof(*values)); + if (!offsets || !values) + die("out of memory"); + + settings = gpiod_line_settings_new(); + if (!settings) + die_perror("unable to allocate line settings"); + + gpiod_line_settings_set_direction(settings, cfg.direction); + + if (cfg.bias) + gpiod_line_settings_set_bias(settings, cfg.bias); + + if (cfg.active_low) + gpiod_line_settings_set_active_low(settings, true); + + req_cfg = gpiod_request_config_new(); + if (!req_cfg) + die_perror("unable to allocate the request config structure"); + + line_cfg = gpiod_line_config_new(); + if (!line_cfg) + die_perror("unable to allocate the line config structure"); + + gpiod_request_config_set_consumer(req_cfg, "gpioget"); + for (i = 0; i < resolver->num_chips; i++) { + chip = gpiod_chip_open(resolver->chips[i].path); + if (!chip) + die_perror("unable to open chip '%s'", + resolver->chips[i].path); + + num_lines = get_line_offsets_and_values(resolver, i, offsets, + NULL); + + gpiod_line_config_reset(line_cfg); + ret = gpiod_line_config_add_line_settings(line_cfg, offsets, + num_lines, settings); + if (ret) + die_perror("unable to add line settings"); + + request = gpiod_chip_request_lines(chip, req_cfg, line_cfg); + if (!request) + die_perror("unable to request lines"); + + if (cfg.hold_period_us) + usleep(cfg.hold_period_us); + + ret = gpiod_line_request_get_values(request, values); + if (ret) + die_perror("unable to read GPIO line values"); + + set_line_values(resolver, i, values); + + gpiod_line_request_release(request); + gpiod_chip_close(chip); + } + for (i = 0; i < resolver->num_lines; i++) { + line = &resolver->lines[i]; + if (cfg.numeric) + printf("%d", line->value); + else + printf("%s=%s", line->id, + line->value ? "active" : "inactive"); + + if (i != resolver->num_lines - 1) + printf(" "); + } + printf("\n"); + + free_line_resolver(resolver); + gpiod_request_config_free(req_cfg); + gpiod_line_config_free(line_cfg); + gpiod_line_settings_free(settings); + free(offsets); + free(values); + + return EXIT_SUCCESS; +} diff --git a/tools/gpioinfo.c b/tools/gpioinfo.c index ae368fa..5dc28f8 100644 --- a/tools/gpioinfo.c +++ b/tools/gpioinfo.c @@ -1,8 +1,7 @@ // SPDX-License-Identifier: GPL-2.0-or-later // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> -#include <dirent.h> -#include <errno.h> #include <getopt.h> #include <gpiod.h> #include <stdarg.h> @@ -12,3 +11,223 @@ #include "tools-common.h" +static void print_help(void) +{ + printf("Usage: %s [OPTIONS] [line]...\n", get_progname()); + printf("\n"); + printf("Print information about GPIO lines.\n"); + printf("\n"); + printf("Lines are specified by name, or optionally by offset if the chip option\n"); + printf("is provided.\n"); + printf("\n"); + printf("If no lines are specified than all lines are displayed.\n"); + printf("\n"); + printf("Options:\n"); + printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n"); + printf(" -c, --chip <chip>\trestrict scope to a particular chip\n"); + printf(" -h, --help\t\tdisplay this help and exit\n"); + printf(" -s, --strict\t\tcheck all lines - don't assume line names are unique\n"); + printf(" -v, --version\t\toutput version information and exit\n"); + print_chip_help(); +} + +struct config { + bool strict; + const char *chip_id; + int by_name; +}; + +int parse_config(int argc, char **argv, struct config *cfg) +{ + int opti, optc; + const char *const shortopts = "+c:hsv"; + const struct option longopts[] = { + { "by-name", no_argument, &cfg->by_name, 1 }, + { "chip", required_argument, NULL, 'c' }, + { "help", no_argument, NULL, 'h' }, + { "strict", no_argument, NULL, 's' }, + { "version", no_argument, NULL, 'v' }, + { GETOPT_NULL_LONGOPT }, + }; + + memset(cfg, 0, sizeof(*cfg)); + + for (;;) { + optc = getopt_long(argc, argv, shortopts, longopts, &opti); + if (optc < 0) + break; + + switch (optc) { + case 'c': + cfg->chip_id = optarg; + break; + case 's': + cfg->strict = true; + break; + case 'h': + print_help(); + exit(EXIT_SUCCESS); + case 'v': + print_version(); + exit(EXIT_SUCCESS); + case '?': + die("try %s --help", get_progname()); + case 0: + break; + default: + abort(); + } + } + + return optind; +} + + +// minimal version similar to tools-common that indicates if a line should be +// printed rather than storing details into the resolver. +// Does not die on non-unique lines. +static bool resolve_line(struct line_resolver *resolver, + struct gpiod_line_info *info, int chip_num) +{ + struct resolved_line *line; + const char *name; + int i; + unsigned int offset; + bool resolved = false; + + offset = gpiod_line_info_get_offset(info); + for (i = 0; i < resolver->num_lines; i++) { + line = &resolver->lines[i]; + // already resolved by offset? + if (line->resolved && + (line->offset == offset) && + (line->chip_num == chip_num)) { + resolved = true; + } + if (line->resolved && !resolver->strict) + continue; + + // else resolve by name + name = gpiod_line_info_get_name(info); + if (name && (strcmp(line->id, name) == 0)) { + line->resolved = true; + line->offset = offset; + line->chip_num = chip_num; + resolved = true; + } + } + + return resolved; +} + +static void print_line_info(struct gpiod_line_info *info) +{ + const char *name; + + name = gpiod_line_info_get_name(info); + if (!name) + name = "unnamed"; + + printf("%-16s\t", name); + print_line_attributes(info); +} + +// based on resolve_lines, but prints lines immediately rather than collecting +// details in the resolver. +static void list_lines(struct line_resolver *resolver, struct gpiod_chip *chip, + int chip_num, bool offsets_ok) +{ + struct gpiod_chip_info *chip_info; + struct gpiod_line_info *info; + int offset, num_lines; + + chip_info = gpiod_chip_get_info(chip); + if (!chip_info) + die_perror("unable to read info from chip %s", + gpiod_chip_get_path(chip)); + + num_lines = gpiod_chip_info_get_num_lines(chip_info); + + if ((chip_num == 0) && offsets_ok) + resolve_lines_by_offset(resolver, num_lines); + + for (offset = 0; + ((offset < num_lines) && + !(resolver->num_lines && resolve_done(resolver))); + offset++) { + info = gpiod_chip_get_line_info(chip, offset); + if (!info) + die_perror("unable to read info for line %d from %s", + offset, gpiod_chip_info_get_name(chip_info)); + + if (resolver->num_lines && + !resolve_line(resolver, info, chip_num)) + continue; + + if (resolver->num_lines) { + printf("%s %u", gpiod_chip_info_get_name(chip_info), + offset); + } else { + if (offset == 0) + printf("%s - %u lines:\n", + gpiod_chip_info_get_name(chip_info), + num_lines); + + printf("\tline %3u:", offset); + } + fputc('\t', stdout); + print_line_info(info); + fputc('\n', stdout); + gpiod_line_info_free(info); + resolver->num_found++; + } + gpiod_chip_info_free(chip_info); +} + +int main(int argc, char **argv) +{ + struct gpiod_chip *chip; + struct line_resolver *resolver = NULL; + struct config cfg; + char **paths; + int num_chips, i, ret = EXIT_SUCCESS; + bool offsets_ok; + + i = parse_config(argc, argv, &cfg); + argc -= i; + argv += i; + + if (!cfg.chip_id) + cfg.by_name = true; + + num_chips = chip_paths(cfg.chip_id, &paths); + if (cfg.chip_id && (num_chips == 0)) + die("cannot find GPIO chip character device '%s'", cfg.chip_id); + + resolver = resolver_init(argc, argv, num_chips, cfg.strict, + cfg.by_name); + + for (i = 0; i < num_chips; i++) { + chip = gpiod_chip_open(paths[i]); + if (chip) { + offsets_ok = (cfg.chip_id && !cfg.by_name); + list_lines(resolver, chip, i, offsets_ok); + gpiod_chip_close(chip); + } else { + print_perror("unable to open chip '%s'", paths[i]); + + if (cfg.chip_id) + return EXIT_FAILURE; + + ret = EXIT_FAILURE; + } + free(paths[i]); + } + free(paths); + + validate_resolution(resolver, cfg.chip_id); + if (argc && resolver->num_found != argc) + ret = EXIT_FAILURE; + free(resolver); + return ret; +} diff --git a/tools/gpiomon.c b/tools/gpiomon.c index 6fa19b6..8a725f5 100644 --- a/tools/gpiomon.c +++ b/tools/gpiomon.c @@ -1,19 +1,461 @@ // SPDX-License-Identifier: GPL-2.0-or-later // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> -#include <errno.h> #include <getopt.h> #include <gpiod.h> #include <inttypes.h> -#include <limits.h> #include <poll.h> -#include <signal.h> #include <stdio.h> #include <stdlib.h> #include <string.h> -#include <unistd.h> #include "tools-common.h" #define EVENT_BUF_SIZE 32 +static void print_help(void) +{ + printf("Usage: %s [OPTIONS] <line>...\n", get_progname()); + printf("\n"); + printf("Wait for events on GPIO lines and print them to standard output.\n"); + printf("\n"); + printf("Lines are specified by name, or optionally by offset if the chip option\n"); + printf("is provided.\n"); + printf("\n"); + printf("Options:\n"); + printf(" --banner\t\tdisplay a banner on successful startup\n"); + print_bias_help(); + printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n"); + printf(" -c, --chip <chip>\trestrict scope to a particular chip\n"); + printf(" -C, --event-clock <clock>\tspecify the source clock for event timestamps.\n"); + printf("\t\t\tPossible values: 'monotonic', 'realtime', 'hte'.\n"); + printf("\t\t\t(default is 'monotonic')\n"); + printf("\t\t\tBy default 'realtime' is formatted as UTC, others as raw u64\n"); + printf(" -e, --edges <edges>\tspecify the edges to monitor.\n"); + printf("\t\t\tPossible values: 'falling', 'rising', 'both'.\n"); + printf("\t\t\t(default is 'both')\n"); + printf(" -h, --help\t\tdisplay this help and exit\n"); + printf(" -F, --format <fmt>\tspecify a custom output format\n"); + printf(" -l, --active-low\ttreat the line as active low, flipping the sense of\n"); + printf("\t\t\trising and falling edges\n"); + printf(" --localtime\tformat event timestamps as local time\n"); + printf(" -n, --num-events <num>\n"); + printf("\t\t\texit after processing num events\n"); + printf(" -p, --debounce-period <period>\n"); + printf("\t\t\tdebounce the line(s) with the specified period\n"); + printf(" -q, --quiet\t\tdon't generate any output\n"); + printf(" -s, --strict\t\tabort if requested line names are not unique\n"); + printf(" --utc\t\tformat event timestamps as UTC (default for 'realtime')\n"); + printf(" -v, --version\t\toutput version information and exit\n"); + print_chip_help(); + print_period_help(); + printf("\n"); + printf("Format specifiers:\n"); + printf(" %%o GPIO line offset\n"); + printf(" %%l GPIO line name\n"); + printf(" %%c GPIO chip name\n"); + printf(" %%e numeric edge event type ('1' - rising or '2' - falling)\n"); + printf(" %%E edge event type ('rising' or 'falling')\n"); + printf(" %%S event timestamp as seconds\n"); + printf(" %%U event timestamp as UTC\n"); + printf(" %%L event timestamp as local time\n"); +} + +static int parse_edges_or_die(const char *option) +{ + if (strcmp(option, "rising") == 0) + return GPIOD_LINE_EDGE_RISING; + if (strcmp(option, "falling") == 0) + return GPIOD_LINE_EDGE_FALLING; + if (strcmp(option, "both") != 0) + die("invalid edges: %s", option); + return GPIOD_LINE_EDGE_BOTH; +} + +static int parse_event_clock_or_die(const char *option) +{ + if (strcmp(option, "realtime") == 0) + return GPIOD_LINE_EVENT_CLOCK_REALTIME; + if (strcmp(option, "hte") != 0) + return GPIOD_LINE_EVENT_CLOCK_HTE; + if (strcmp(option, "monotonic") != 0) + die("invalid event clock: %s", option); + return GPIOD_LINE_EVENT_CLOCK_MONOTONIC; +} + +struct config { + bool active_low; + bool quiet; + bool strict; + int bias; + int edges; + int events_wanted; + unsigned int debounce_period_us; + const char *chip_id; + const char *fmt; + int by_name; + int event_clock; + int timestamp_fmt; + int banner; +}; + +int parse_config(int argc, char **argv, struct config *cfg) +{ + int opti, optc; + const char *const shortopts = "+b:c:C:e:hF:ln:p:qshv"; + const struct option longopts[] = { + { "active-low", no_argument, NULL, 'l' }, + { "banner", no_argument, &cfg->banner, 1 }, + { "bias", required_argument, NULL, 'b' }, + { "by-name", no_argument, &cfg->by_name, 1 }, + { "chip", required_argument, NULL, 'c' }, + { "debounce-period", required_argument, NULL, 'p' }, + { "edges", required_argument, NULL, 'e' }, + { "event-clock", required_argument, NULL, 'C' }, + { "format", required_argument, NULL, 'F' }, + { "help", no_argument, NULL, 'h' }, + { "localtime", no_argument, &cfg->timestamp_fmt, 2 }, + { "num-events", required_argument, NULL, 'n' }, + { "quiet", no_argument, NULL, 'q' }, + { "silent", no_argument, NULL, 'q' }, + { "strict", no_argument, NULL, 's' }, + { "utc", no_argument, &cfg->timestamp_fmt, 1 }, + { "version", no_argument, NULL, 'v' }, + { GETOPT_NULL_LONGOPT }, + }; + + memset(cfg, 0, sizeof(*cfg)); + cfg->edges = GPIOD_LINE_EDGE_BOTH; + + for (;;) { + optc = getopt_long(argc, argv, shortopts, longopts, &opti); + if (optc < 0) + break; + + switch (optc) { + case 'b': + cfg->bias = parse_bias_or_die(optarg); + break; + case 'c': + cfg->chip_id = optarg; + break; + case 'C': + cfg->event_clock = parse_event_clock_or_die(optarg); + break; + case 'e': + cfg->edges = parse_edges_or_die(optarg); + break; + case 'F': + cfg->fmt = optarg; + break; + case 'l': + cfg->active_low = true; + break; + case 'n': + cfg->events_wanted = parse_uint_or_die(optarg); + break; + case 'p': + cfg->debounce_period_us = parse_period_or_die(optarg); + break; + case 'q': + cfg->quiet = true; + break; + case 's': + cfg->strict = true; + break; + case 'h': + print_help(); + exit(EXIT_SUCCESS); + case 'v': + print_version(); + exit(EXIT_SUCCESS); + case '?': + die("try %s --help", get_progname()); + case 0: + break; + default: + abort(); + } + } + + // setup default clock/format combinations, where not overridden + if (cfg->event_clock == 0) { + if (cfg->timestamp_fmt) + cfg->event_clock = GPIOD_LINE_EVENT_CLOCK_REALTIME; + else + cfg->event_clock = GPIOD_LINE_EVENT_CLOCK_MONOTONIC; + } else if ((cfg->event_clock == GPIOD_LINE_EVENT_CLOCK_REALTIME) && + (cfg->timestamp_fmt == 0)) { + cfg->timestamp_fmt = 1; + } + + return optind; +} + +static void print_banner(int num_lines, char **lines) +{ + int i; + + if (num_lines > 1) { + printf("Monitoring lines "); + + for (i = 0; i < num_lines - 1; i++) + printf("%s, ", lines[i]); + + printf("and %s...\n", lines[i]); + } else { + printf("Monitoring line %s...\n", lines[0]); + } +} + +static void event_print_formatted(struct gpiod_edge_event *event, + struct line_resolver *resolver, int chip_num, + struct config *cfg) +{ + const char *lname, *prev, *curr; + char fmt; + uint64_t evtime; + int evtype; + unsigned int offset; + + offset = gpiod_edge_event_get_line_offset(event); + evtime = gpiod_edge_event_get_timestamp_ns(event); + evtype = gpiod_edge_event_get_event_type(event); + + for (prev = curr = cfg->fmt;;) { + curr = strchr(curr, '%'); + if (!curr) { + fputs(prev, stdout); + break; + } + + if (prev != curr) + fwrite(prev, curr - prev, 1, stdout); + + fmt = *(curr + 1); + + switch (fmt) { + case 'c': + fputs(get_chip_name(resolver, chip_num), stdout); + break; + case 'e': + printf("%d", evtype); + break; + case 'E': + if (evtype == GPIOD_EDGE_EVENT_RISING_EDGE) + fputs("rising", stdout); + else + fputs("falling", stdout); + break; + case 'l': + lname = get_line_name(resolver, chip_num, offset); + if (!lname) + lname = "unnamed"; + fputs(lname, stdout); + break; + case 'L': + print_event_time(evtime, 2); + break; + case 'o': + printf("%u", offset); + break; + case 'S': + print_event_time(evtime, 0); + break; + case 'U': + print_event_time(evtime, 1); + break; + case '%': + fputc('%', stdout); + break; + case '\0': + fputc('%', stdout); + goto end; + default: + fwrite(curr, 2, 1, stdout); + break; + } + + curr += 2; + prev = curr; + } + +end: + fputc('\n', stdout); +} + +static void event_print_human_readable(struct gpiod_edge_event *event, + struct line_resolver *resolver, + int chip_num, struct config *cfg) +{ + unsigned int offset; + uint64_t evtime; + + offset = gpiod_edge_event_get_line_offset(event); + evtime = gpiod_edge_event_get_timestamp_ns(event); + + print_event_time(evtime, cfg->timestamp_fmt); + + if (gpiod_edge_event_get_event_type(event) == + GPIOD_EDGE_EVENT_RISING_EDGE) + fputs("\trising\t", stdout); + else + fputs("\tfalling\t", stdout); + + print_line_id(resolver, chip_num, offset, cfg->chip_id); + fputc('\n', stdout); +} + +static void event_print(struct gpiod_edge_event *event, + struct line_resolver *resolver, int chip_num, + struct config *cfg) +{ + if (cfg->quiet) + return; + + if (cfg->fmt) + event_print_formatted(event, resolver, chip_num, cfg); + else + event_print_human_readable(event, resolver, chip_num, cfg); +} + +int main(int argc, char **argv) +{ + int num_lines, events_done = 0; + struct gpiod_edge_event_buffer *event_buffer; + int ret, i, j; + struct gpiod_line_settings *settings; + struct gpiod_request_config *req_cfg; + struct gpiod_line_request **requests; + struct pollfd *pollfds; + struct gpiod_line_config *line_cfg; + unsigned int *offsets; + struct gpiod_edge_event *event; + struct gpiod_chip *chip; + struct line_resolver *resolver; + struct config cfg; + + i = parse_config(argc, argv, &cfg); + argc -= i; + argv += i; + + if (argc < 1) + die("at least one GPIO line must be specified"); + + if (argc > 64) + die("too many lines given"); + + settings = gpiod_line_settings_new(); + if (!settings) + die_perror("unable to allocate line settings"); + + if (cfg.bias) + gpiod_line_settings_set_bias(settings, cfg.bias); + + if (cfg.active_low) + gpiod_line_settings_set_active_low(settings, true); + + if (cfg.debounce_period_us) + gpiod_line_settings_set_debounce_period_us(settings, + cfg.debounce_period_us); + + gpiod_line_settings_set_event_clock(settings, cfg.event_clock); + gpiod_line_settings_set_edge_detection(settings, cfg.edges); + + line_cfg = gpiod_line_config_new(); + if (!line_cfg) + die_perror("unable to allocate the line config structure"); + + req_cfg = gpiod_request_config_new(); + if (!req_cfg) + die_perror("unable to allocate the request config structure"); + + gpiod_request_config_set_consumer(req_cfg, "gpiomon"); + + event_buffer = gpiod_edge_event_buffer_new(EVENT_BUF_SIZE); + if (!event_buffer) + die_perror("unable to allocate the line event buffer"); + + resolver = resolve_lines(argc, argv, cfg.chip_id, cfg.strict, + cfg.by_name); + validate_resolution(resolver, cfg.chip_id); + requests = calloc(resolver->num_chips, sizeof(*requests)); + pollfds = calloc(resolver->num_chips, sizeof(*pollfds)); + offsets = calloc(resolver->num_lines, sizeof(*offsets)); + if (!requests || !pollfds || !offsets) + die("out of memory"); + + for (i = 0; i < resolver->num_chips; i++) { + num_lines = get_line_offsets_and_values(resolver, i, offsets, + NULL); + gpiod_line_config_reset(line_cfg); + ret = gpiod_line_config_add_line_settings(line_cfg, offsets, + num_lines, settings); + if (ret) + die_perror("unable to add line settings"); + + chip = gpiod_chip_open(resolver->chips[i].path); + if (!chip) + die_perror("unable to open chip '%s'", + resolver->chips[i].path); + + requests[i] = gpiod_chip_request_lines(chip, req_cfg, line_cfg); + if (!requests[i]) + die_perror("unable to request lines on chip %s", + resolver->chips[i].path); + + pollfds[i].fd = gpiod_line_request_get_fd(requests[i]); + pollfds[i].events = POLLIN; + gpiod_chip_close(chip); + } + gpiod_request_config_free(req_cfg); + gpiod_line_config_free(line_cfg); + gpiod_line_settings_free(settings); + + if (cfg.banner) + print_banner(argc, argv); + + for (;;) { + fflush(stdout); + + if (poll(pollfds, resolver->num_chips, -1) < 0) + die_perror("error polling for events"); + + for (i = 0; i < resolver->num_chips; i++) { + if (pollfds[i].revents == 0) + continue; + + ret = gpiod_line_request_read_edge_event(requests[i], + event_buffer, EVENT_BUF_SIZE); + if (ret < 0) + die_perror("error reading line events"); + + for (j = 0; j < ret; j++) { + event = gpiod_edge_event_buffer_get_event( + event_buffer, j); + if (!event) + die_perror("unable to retrieve event from buffer"); + + event_print(event, resolver, i, &cfg); + + events_done++; + + if (cfg.events_wanted && + events_done >= cfg.events_wanted) + goto done; + } + } + } +done: + for (i = 0; i < resolver->num_chips; i++) + gpiod_line_request_release(requests[i]); + + free(requests); + free_line_resolver(resolver); + gpiod_edge_event_buffer_free(event_buffer); + free(offsets); + + return EXIT_SUCCESS; +} + diff --git a/tools/gpioset.c b/tools/gpioset.c index 0e3a1e4..1dc1728 100644 --- a/tools/gpioset.c +++ b/tools/gpioset.c @@ -1,7 +1,8 @@ // SPDX-License-Identifier: GPL-2.0-or-later // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> -#include <errno.h> +#include <ctype.h> #include <gpiod.h> #include <getopt.h> #include <limits.h> @@ -9,8 +10,818 @@ #include <stdio.h> #include <stdlib.h> #include <string.h> -#include <sys/select.h> #include <unistd.h> +#include <editline/readline.h> #include "tools-common.h" +static void print_help(void) +{ + printf("Usage: %s [OPTIONS] <line=value>...\n", get_progname()); + printf("\n"); + printf("Set values of GPIO lines.\n"); + printf("\n"); + printf("Lines are specified by name, or optionally by offset if the chip option\n"); + printf("is provided.\n"); + printf("Values may be '1' or '0', or equivalently 'active'/'inactive' or 'on'/'off'.\n"); + printf("\n"); + printf("The line output state is maintained until the process exits, but after that\n"); + printf("is not guaranteed.\n"); + printf("\n"); + printf("Options:\n"); + print_bias_help(); + printf(" --by-name\t\ttreat lines as names even if they would parse as an offset\n"); + printf(" -c, --chip <chip>\trestrict scope to a particular chip\n"); + printf(" -d, --drive <drive>\tspecify the line drive mode.\n"); + printf("\t\t\tPossible values: 'push-pull', 'open-drain', 'open-source'.\n"); + printf("\t\t\t(default is 'push-pull')\n"); + printf(" -h, --help\t\tdisplay this help and exit\n"); + printf(" -i, --interactive\tset the lines then wait for additional set commands.\n"); + printf("\t\t\tUse the 'help' command at the interactive prompt to get help\n"); + printf("\t\t\tfor the supported commands.\n"); + printf(" -l, --active-low\ttreat the line as active low\n"); + printf(" -p, --hold-period <period>\n"); + printf("\t\t\tthe minimum time period to hold lines at the requested values\n"); + printf(" -s, --strict\t\tabort if requested line names are not unique\n"); + printf(" -t, --toggle <period>[,period]...\n"); + printf("\t\t\ttoggle the line(s) after the specified period(s).\n"); + printf("\t\t\tIf the last period is non-zero then the sequence repeats.\n"); + printf(" -v, --version\t\toutput version information and exit\n"); + printf(" -z, --daemonize\tset values then detach from the controlling terminal\n"); + print_chip_help(); + print_period_help(); + printf("\n"); + printf("*Note*\n"); + printf(" The state of a GPIO line controlled over the character device reverts to default\n"); + printf(" when the last process referencing the file descriptor representing the device file exits.\n"); + printf(" This means that it's wrong to run gpioset, have it exit and expect the line to continue\n"); + printf(" being driven high or low. It may happen if given pin is floating but it must be interpreted\n"); + printf(" as undefined behavior.\n"); +} + +static int parse_drive_or_die(const char *option) +{ + if (strcmp(option, "open-drain") == 0) + return GPIOD_LINE_DRIVE_OPEN_DRAIN; + if (strcmp(option, "open-source") == 0) + return GPIOD_LINE_DRIVE_OPEN_SOURCE; + if (strcmp(option, "push-pull") != 0) + die("invalid drive: %s", option); + return 0; +} + +struct config { + bool active_low; + bool interactive; + bool strict; + bool daemonize; + int bias; + int drive; + int toggles; + unsigned int *toggle_periods; + unsigned int hold_period_us; + const char *chip_id; + int by_name; +}; + +int parse_config(int argc, char **argv, struct config *cfg) +{ + int opti, optc; + const char *const shortopts = "+b:c:d:hilp:st:vz"; + const struct option longopts[] = { + { "active-low", no_argument, NULL, 'l' }, + { "bias", required_argument, NULL, 'b' }, + { "by-name", no_argument, &cfg->by_name, 1 }, + { "chip", required_argument, NULL, 'c' }, + { "daemonize", no_argument, NULL, 'z' }, + { "drive", required_argument, NULL, 'd' }, + { "help", no_argument, NULL, 'h' }, + { "hold-period", required_argument, NULL, 'p' }, + { "interactive", no_argument, NULL, 'i' }, + { "strict", no_argument, NULL, 's' }, + { "toggle", required_argument, NULL, 't' }, + { "version", no_argument, NULL, 'v' }, + { GETOPT_NULL_LONGOPT }, + }; + + memset(cfg, 0, sizeof(*cfg)); + for (;;) { + optc = getopt_long(argc, argv, shortopts, longopts, &opti); + if (optc < 0) + break; + + switch (optc) { + case 'b': + cfg->bias = parse_bias_or_die(optarg); + break; + case 'c': + cfg->chip_id = optarg; + break; + case 'd': + cfg->drive = parse_drive_or_die(optarg); + break; + case 'i': + cfg->interactive = true; + break; + case 'l': + cfg->active_low = true; + break; + case 'p': + cfg->hold_period_us = parse_period_or_die(optarg); + break; + case 's': + cfg->strict = true; + break; + case 't': + cfg->toggles = parse_periods_or_die(optarg, + &cfg->toggle_periods); + break; + case 'z': + cfg->daemonize = true; + break; + case 'h': + print_help(); + exit(EXIT_SUCCESS); + case 'v': + print_version(); + exit(EXIT_SUCCESS); + case '?': + die("try %s --help", get_progname()); + case 0: + break; + default: + abort(); + } + } + if (cfg->daemonize && cfg->interactive) + die("can't combine daemonize with interactive"); + + if (cfg->toggles && cfg->interactive) + die("can't combine interactive with toggle"); + + return optind; +} + +static int parse_value(const char *option) +{ + if (strcmp(option, "0") == 0) + return 0; + if (strcmp(option, "1") == 0) + return 1; + if (strcmp(option, "inactive") == 0) + return 0; + if (strcmp(option, "active") == 0) + return 1; + if (strcmp(option, "off") == 0) + return 0; + if (strcmp(option, "on") == 0) + return 1; + if (strcmp(option, "false") == 0) + return 0; + if (strcmp(option, "true") == 0) + return 1; + return -1; +} + +// parse num_lines line id and values from lvs into lines and values +static bool parse_line_values(int num_lines, char **lvs, char **lines, + int *values, bool interactive) +{ + int i; + char *value; + + for (i = 0; i < num_lines; i++) { + value = strchr(lvs[i], '='); + if (!value) { + if (interactive) + printf("invalid line value: '%s'\n", lvs[i]); + else + print_error("invalid line value: '%s'", lvs[i]); + + return false; + } + *value = '\0'; + value++; + values[i] = parse_value(value); + if (values[i] < 0) { + if (interactive) + printf("invalid line value: '%s'\n", value); + else + print_error("invalid line value: '%s'", value); + + return false; + } + lines[i] = lvs[i]; + } + return true; +} + +/* + * parse num_lines line id and values from lvs into lines and values, + * or die trying. + */ +static void parse_line_values_or_die(int num_lines, char **lvs, char **lines, + int *values) +{ + if (!parse_line_values(num_lines, lvs, lines, values, false)) + exit(EXIT_FAILURE); +} + +static void wait_fd(int fd) +{ + struct pollfd pfd; + + pfd.fd = fd; + pfd.events = POLLERR; + + if (poll(&pfd, 1, -1) < 0) + die_perror("error waiting on request"); +} + +/* + * Apply values from the resolver to the requests. + * offset and values are scratch pads for working. + */ +static void apply_values(struct gpiod_line_request **requests, + struct line_resolver *resolver, + unsigned int *offsets, int *values) +{ + int i; + + for (i = 0; i < resolver->num_chips; i++) { + get_line_offsets_and_values(resolver, i, offsets, values); + if (gpiod_line_request_set_values(requests[i], values)) + print_perror("unable to set values on '%s'", + get_chip_name(resolver, i)); + } +} + +/* + * set the values in the resolver for the line values specified by + * the remaining parameters. + */ +static void set_line_values_subset(struct line_resolver *resolver, + int num_lines, char **lines, int *values) +{ + int l, i; + + for (l = 0; l < num_lines; l++) + for (i = 0; i < resolver->num_lines; i++) + if (strcmp(lines[l], resolver->lines[i].id) == 0) { + resolver->lines[i].value = values[l]; + break; + } +} + +static void print_all_line_values(struct line_resolver *resolver) +{ + int i; + char *fmt = "%s=%s "; + + for (i = 0; i < resolver->num_lines; i++) { + if (i == resolver->num_lines - 1) + fmt = "%s=%s\n"; + + printf(fmt, resolver->lines[i].id, + resolver->lines[i].value ? "active" : "inactive"); + } +} + +/* + * print the resovler line values for a subset of lines, + * specified by num_lines and lines. + */ +static void print_line_values(struct line_resolver *resolver, int num_lines, + char **lines) +{ + int i, j; + char *fmt = "%s=%s "; + struct resolved_line *line; + + for (i = 0; i < num_lines; i++) { + if (i == num_lines - 1) + fmt = "%s=%s\n"; + + for (j = 0; j < resolver->num_lines; j++) { + line = &resolver->lines[j]; + if (strcmp(lines[i], line->id) == 0) { + printf(fmt, line->id, + line->value ? "active" : "inactive"); + break; + } + } + } +} + +/* toggle the values of all lines in the resolver */ +static void toggle_all_lines(struct line_resolver *resolver) +{ + int i; + + for (i = 0; i < resolver->num_lines; i++) + resolver->lines[i].value = !resolver->lines[i].value; +} + +/* + * toggle a subset of lines, specified by num_lines and lines, + * in the resolver. + */ +static void toggle_lines(struct line_resolver *resolver, int num_lines, + char **lines) +{ + int i, j; + struct resolved_line *line; + + for (i = 0; i < num_lines; i++) + for (j = 0; j < resolver->num_lines; j++) { + line = &resolver->lines[j]; + if (strcmp(lines[i], line->id) == 0) { + line->value = !line->value; + break; + } + } +} + +/* + * toggle the resolved lines as specified by the toggle_periods, + * and apply the values to the requests. + * offset and values are scratch pads for working. + */ +static void toggle_sequence(int toggles, unsigned int *toggle_periods, + struct gpiod_line_request **requests, + struct line_resolver *resolver, + unsigned int *offsets, int *values) +{ + int i = 0; + + for (;;) { + usleep(toggle_periods[i]); + toggle_all_lines(resolver); + apply_values(requests, resolver, offsets, values); + + i++; + if ((i == toggles - 1) && (toggle_periods[i] == 0)) + return; + + if (i == toggles) + i = 0; + } +} + +/* + * check that a set of lines, specified by num_lines and lines, + * are all resolved lines. + */ +static bool valid_lines(struct line_resolver *resolver, int num_lines, + char **lines) +{ + bool ret = true; + int i, l; + bool found; + + for (l = 0; l < num_lines; l++) { + found = false; + for (i = 0; i < resolver->num_lines; i++) { + if (strcmp(lines[l], resolver->lines[i].id) == 0) { + found = true; + break; + } + } + if (!found) { + printf("unknown line: '%s'\n", lines[l]); + ret = false; + } + } + return ret; +} + +static void print_interactive_help(void) +{ + printf("COMMANDS:\n\n"); + printf(" exit\n"); + printf(" Exit the program\n"); + printf(" get [line]...\n"); + printf(" Display the output values of the given requested lines\n\n"); + printf(" If no lines are specified then all requested lines are displayed\n\n"); + printf(" help\n"); + printf(" Print this help\n\n"); + printf(" set <line=value>...\n"); + printf(" Update the output values of the given requested lines\n\n"); + printf(" sleep <period>\n"); + printf(" Sleep for the specified period\n\n"); + printf(" toggle [line]...\n"); + printf(" Toggle the output values of the given requested lines\n\n"); + printf(" If no lines are specified then all requested lines are toggled\n\n"); +} + +/* + * split a line into words, returning the each of the words and the count. + * + * max_words specifies the max number of words that may be returned in words. + */ +static int split_words(char *line, int max_words, char **words) +{ + int num_words = 0; + bool in_word = false; + + while (*line != '\0') { + if (!in_word && !isspace(*line)) { + in_word = true; + + /* count all words, but only store max_words */ + if (num_words < max_words) + words[num_words] = line; + + } else if (isspace(*line)) { + if (in_word) { + num_words++; + in_word = false; + } + *line = '\0'; + } + line++; + } + if (in_word) + num_words++; + + return num_words; +} + +/* check if a line is specified somewhere in the rl_line_buffer */ +static bool in_line_buffer(const char *id) +{ + int len = strlen(id); + char *match = rl_line_buffer; + + while ((match = strstr(rl_line_buffer, id))) { + if ((match > rl_line_buffer && isspace(match[-1])) && + (isspace(match[len]) || (match[len] == '='))) + return true; + + match += len; + } + + return false; +} + +/* context for complete_line_id, so it can provide valid line ids */ +static struct line_resolver *completion_context; + +/* tab completion helper for line ids */ +static char *complete_line_id(const char *text, int state) +{ + static int idx, len; + const char *id; + + if (!state) { + idx = 0; + len = strlen(text); + } + while (idx < completion_context->num_lines) { + id = completion_context->lines[idx].id; + idx++; + if ((strncmp(id, text, len) == 0) && + (!in_line_buffer(id))) + return strdup(id); + } + return NULL; +} + +/* tab completion helper for line values (just the value component) */ +static char *complete_value(const char *text, int state) +{ + static const char * const values[] = { + "1", "0", "active", "inactive", "on", "off", "true", "false", + NULL + }; + static int idx, len; + const char *value; + + if (!state) { + idx = 0; + len = strlen(text); + } + while ((value = values[idx])) { + idx++; + if (strncmp(value, text, len) == 0) + return strdup(value); + } + return NULL; +} + +/* tab completion help for interactive commands */ +static char *complete_command(const char *text, int state) +{ + static const char * const commands[] = { + "get", "set", "toggle", "sleep", "help", "exit", NULL + }; + static int idx, len; + const char *cmd; + + if (!state) { + idx = 0; + len = strlen(text); + } + + while ((cmd = commands[idx])) { + idx++; + if (strncmp(cmd, text, len) == 0) + return strdup(cmd); + } + return NULL; +} + +/* tab completion for interactive command lines */ +static char **tab_completion(const char *text, int start, int end) +{ + char **matches = NULL; + int cmd_start, cmd_end, len; + + rl_attempted_completion_over = true; + rl_completion_type = '@'; + + for (cmd_start = 0; + isspace(rl_line_buffer[cmd_start]) && cmd_start < end; + cmd_start++) + ; + + if (cmd_start == start) + matches = rl_completion_matches(text, complete_command); + + for (cmd_end = cmd_start + 1; + !isspace(rl_line_buffer[cmd_end]) && cmd_end < end; + cmd_end++) + ; + + len = cmd_end - cmd_start; + if (len == 3 && strncmp("set", &rl_line_buffer[cmd_start], 3) == 0) { + if (rl_line_buffer[start - 1] == '=') { + matches = rl_completion_matches(text, complete_value); + } else { + rl_completion_append_character = '='; + matches = rl_completion_matches(text, complete_line_id); + } + } + + if ((len == 3 && strncmp("get", &rl_line_buffer[cmd_start], 3) == 0) || + (len == 6 && strncmp("toggle", &rl_line_buffer[cmd_start], 6) == 0)) + matches = rl_completion_matches(text, complete_line_id); + + return matches; +} + +static void interact(struct gpiod_line_request **requests, + struct line_resolver *resolver, + char **lines, unsigned int *offsets, int *values) +{ + char *line; + int num_words, num_lines, max_words; + char **words; + int period_us, i; + char *line_buf; + bool done; + + stifle_history(20); + rl_attempted_completion_function = tab_completion; + completion_context = resolver; + + max_words = resolver->num_lines + 1; + words = calloc(max_words, sizeof(*words)); + if (!words) + die("out of memory"); + + for (done = false; !done;) { + /* + * manually print the prompt, as libedit doesn't if stdout + * is not a tty. And fflush to ensure the prompt and any + * output buffered from the previous command is sent. + */ + printf("gpioset> "); + fflush(stdout); + + line = readline(NULL); + if (!line || line[0] == '\0') + continue; + + for (i = strlen(line) - 1; (i > 0) && isspace(line[i]); i--) + line[i] = '\0'; + + line_buf = strdup(line); + num_words = split_words(line_buf, max_words, words); + if (num_words > max_words) { + printf("too many command parameters provided\n"); + goto cmd_done; + } + num_lines = num_words - 1; + if (strcmp(words[0], "get") == 0) { + if (num_lines == 0) + print_all_line_values(resolver); + else if (valid_lines(resolver, num_lines, &words[1])) + print_line_values(resolver, num_lines, + &words[1]); + goto cmd_ok; + } + if (strcmp(words[0], "set") == 0) { + if (num_lines == 0) + printf("at least one GPIO line value must be specified\n"); + else if (parse_line_values(num_lines, &words[1], lines, + values, true) && + valid_lines(resolver, num_lines, lines)) { + set_line_values_subset(resolver, num_lines, + lines, values); + apply_values(requests, resolver, offsets, + values); + } + goto cmd_ok; + } + if (strcmp(words[0], "toggle") == 0) { + if (num_lines == 0) + toggle_all_lines(resolver); + else if (valid_lines(resolver, num_lines, &words[1])) + toggle_lines(resolver, num_lines, &words[1]); + + apply_values(requests, resolver, offsets, values); + goto cmd_ok; + } + if (strcmp(words[0], "sleep") == 0) { + if (num_lines == 0) { + printf("a period must be specified\n"); + goto cmd_ok; + } + if (num_lines > 1) { + printf("only one period can be specified\n"); + goto cmd_ok; + } + period_us = parse_period(words[1]); + if (period_us < 0) { + printf("invalid period: '%s'\n", words[1]); + goto cmd_ok; + } + usleep(period_us); + goto cmd_ok; + } + + if (strcmp(words[0], "exit") == 0) { + done = true; + goto cmd_done; + } + + if (strcmp(words[0], "help") == 0) { + print_interactive_help(); + goto cmd_done; + } + + printf("unknown command: '%s'\n", words[0]); + printf("Try the 'help' command\n") + ; + +cmd_ok: + for (i = 0; isspace(line[i]); i++) + ; + + if ((history_length) == 0 || + (strcmp(history_list()[history_length - 1]->line, + &line[i]) != 0)) + add_history(&line[i]); + +cmd_done: + free(line); + free(line_buf); + } + free(words); +} + +int main(int argc, char **argv) +{ + int i, j, num_lines, ret, *values; + struct gpiod_line_settings *settings; + struct gpiod_request_config *req_cfg; + struct gpiod_line_request **requests; + struct gpiod_line_config *line_cfg; + struct gpiod_chip *chip; + unsigned int *offsets; + struct line_resolver *resolver; + char **lines; + struct config cfg; + + i = parse_config(argc, argv, &cfg); + argc -= i; + argv += i; + + if (argc < 1) + die("at least one GPIO line value must be specified"); + + num_lines = argc; + + lines = calloc(num_lines, sizeof(*lines)); + values = calloc(num_lines, sizeof(*values)); + if (!lines || !values) + die("out of memory"); + + parse_line_values_or_die(argc, argv, lines, values); + + settings = gpiod_line_settings_new(); + if (!settings) + die_perror("unable to allocate line settings"); + + if (cfg.bias) + gpiod_line_settings_set_bias(settings, cfg.bias); + + if (cfg.drive) + gpiod_line_settings_set_drive(settings, cfg.drive); + + if (cfg.active_low) + gpiod_line_settings_set_active_low(settings, true); + + gpiod_line_settings_set_direction(settings, + GPIOD_LINE_DIRECTION_OUTPUT); + + req_cfg = gpiod_request_config_new(); + if (!req_cfg) + die_perror("unable to allocate the request config structure"); + + gpiod_request_config_set_consumer(req_cfg, "gpioset"); + resolver = resolve_lines(num_lines, lines, cfg.chip_id, cfg.strict, + cfg.by_name); + validate_resolution(resolver, cfg.chip_id); + for (i = 0; i < num_lines; i++) + resolver->lines[i].value = values[i]; + + requests = calloc(resolver->num_chips, sizeof(*requests)); + offsets = calloc(num_lines, sizeof(*offsets)); + if (!requests || !offsets) + die("out of memory"); + + line_cfg = gpiod_line_config_new(); + if (!line_cfg) + die_perror("unable to allocate the line config structure"); + + for (i = 0; i < resolver->num_chips; i++) { + num_lines = get_line_offsets_and_values(resolver, i, + offsets, values); + + gpiod_line_config_reset(line_cfg); + for (j = 0; j < num_lines; j++) { + gpiod_line_settings_set_output_value(settings, + values[j]); + + ret = gpiod_line_config_add_line_settings(line_cfg, + &offsets[j], 1, settings); + if (ret) + die_perror("unable to add line settings"); + } + + chip = gpiod_chip_open(resolver->chips[i].path); + if (!chip) + die_perror("unable to open chip '%s'", + resolver->chips[i].path); + + requests[i] = gpiod_chip_request_lines(chip, req_cfg, line_cfg); + if (!requests[i]) + die_perror("unable to request lines on chip '%s'", + resolver->chips[i].path); + + gpiod_chip_close(chip); + } + + gpiod_request_config_free(req_cfg); + gpiod_line_config_free(line_cfg); + gpiod_line_settings_free(settings); + + if (cfg.daemonize) + if (daemon(0, 0) < 0) + die_perror("unable to daemonize"); + + if (cfg.toggles) { + for (i = 0; i < cfg.toggles; i++) + if ((cfg.hold_period_us > cfg.toggle_periods[i]) && + ((i != cfg.toggles - 1) || + cfg.toggle_periods[i] != 0)) + cfg.toggle_periods[i] = cfg.hold_period_us; + + toggle_sequence(cfg.toggles, cfg.toggle_periods, requests, + resolver, offsets, values); + free(cfg.toggle_periods); + } + + if (cfg.hold_period_us) + usleep(cfg.hold_period_us); + + if (cfg.interactive) + interact(requests, resolver, lines, offsets, values); + + if (cfg.daemonize) + wait_fd(gpiod_line_request_get_fd(requests[0])); + + for (i = 0; i < resolver->num_chips; i++) + gpiod_line_request_release(requests[i]); + + free(requests); + free_line_resolver(resolver); + free(lines); + free(values); + free(offsets); + + return EXIT_SUCCESS; +} + diff --git a/tools/tools-common.c b/tools/tools-common.c index ea7dfa8..85ee687 100644 --- a/tools/tools-common.c +++ b/tools/tools-common.c @@ -1,18 +1,22 @@ // SPDX-License-Identifier: GPL-2.0-or-later // SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> +// SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> /* Common code for GPIO tools. */ #include <ctype.h> +#include <dirent.h> #include <errno.h> #include <gpiod.h> +#include <inttypes.h> #include <libgen.h> -#include <signal.h> +#include <limits.h> #include <stdarg.h> #include <stdio.h> #include <stdlib.h> #include <string.h> -#include <sys/signalfd.h> +#include <sys/stat.h> +#include <time.h> #include "tools-common.h" @@ -21,6 +25,28 @@ const char *get_progname(void) return program_invocation_name; } +void print_error(const char *fmt, ...) +{ + va_list va; + + va_start(va, fmt); + fprintf(stderr, "%s: ", program_invocation_name); + vfprintf(stderr, fmt, va); + fprintf(stderr, "\n"); + va_end(va); +} + +void print_perror(const char *fmt, ...) +{ + va_list va; + + va_start(va, fmt); + fprintf(stderr, "%s: ", program_invocation_name); + vfprintf(stderr, fmt, va); + fprintf(stderr, ": %s\n", strerror(errno)); + va_end(va); +} + void die(const char *fmt, ...) { va_list va; @@ -57,41 +83,327 @@ void print_version(void) printf("There is NO WARRANTY, to the extent permitted by law.\n"); } -int parse_bias(const char *option) +int parse_bias_or_die(const char *option) { if (strcmp(option, "pull-down") == 0) return GPIOD_LINE_BIAS_PULL_DOWN; if (strcmp(option, "pull-up") == 0) return GPIOD_LINE_BIAS_PULL_UP; - if (strcmp(option, "disable") == 0) - return GPIOD_LINE_BIAS_DISABLED; - if (strcmp(option, "as-is") != 0) + if (strcmp(option, "disabled") != 0) die("invalid bias: %s", option); - return 0; + return GPIOD_LINE_BIAS_DISABLED; +} + +int parse_period(const char *option) +{ + unsigned long p, m = 0; + char *end; + + p = strtoul(option, &end, 10); + switch (*end) { + case 'u': + m = 1; + end++; + break; + case 'm': + m = 1000; + end++; + break; + case 's': + m = 1000000; + break; + case '\0': + break; + default: + return -1; + } + + if (m) { + if (*end != 's') + return -1; + + end++; + } else { + m = 1000; + } + + p *= m; + if (*end != '\0' || p > INT_MAX) + return -1; + + return p; +} + +unsigned int parse_period_or_die(const char *option) +{ + int period = parse_period(option); + + if (period < 0) + die("invalid period: %s", option); + + return period; +} + +int parse_periods_or_die(char *option, unsigned int **periods) +{ + int i, num_periods = 1; + unsigned int *pp; + char *end; + + for (i = 0; option[i] != '\0'; i++) + if (option[i] == ',') + num_periods++; + + pp = calloc(num_periods, sizeof(*pp)); + if (pp == NULL) + die("out of memory"); + + for (i = 0; i < num_periods - 1; i++) { + for (end = option; *end != ','; end++) + ; + + *end = '\0'; + pp[i] = parse_period_or_die(option); + option = end + 1; + } + pp[i] = parse_period_or_die(option); + *periods = pp; + + return num_periods; +} + +int parse_uint(const char *option) +{ + unsigned long o; + char *end; + + o = strtoul(option, &end, 10); + if (*end == '\0' && o <= INT_MAX) + return o; + + return -1; +} + +unsigned int parse_uint_or_die(const char *option) +{ + int i = parse_uint(option); + + if (i < 0) + die("invalid number: '%s'", option); + + return i; } void print_bias_help(void) { - printf("Biases:\n"); - printf(" as-is:\tleave bias unchanged\n"); - printf(" disable:\tdisable bias\n"); - printf(" pull-up:\tenable pull-up\n"); - printf(" pull-down:\tenable pull-down\n"); + printf(" -b, --bias <bias>\tspecify the line bias.\n"); + printf("\t\t\tPossible values: 'pull-down', 'pull-up', 'disabled'.\n"); + printf("\t\t\t(default is to leave bias unchanged)\n"); } -int chip_dir_filter(const struct dirent *entry) +void print_chip_help(void) +{ + printf("\nChips:\n"); + printf(" A GPIO chip may be identified by number, name, or path.\n"); + printf(" e.g. '0', 'gpiochip0', and '/dev/gpiochip0' all refer to the same chip.\n"); +} + +void print_period_help(void) +{ + printf("\nPeriods:\n"); + printf(" Periods are taken as milliseconds unless units are specified. e.g. 10us.\n"); + printf(" Supported units are 's', 'ms', and 'us'.\n"); +} + +#define TIME_BUFFER_SIZE 20 + +/* + * format: + * 0: raw seconds + * 1: utc time + * 2: local time + */ +void print_event_time(uint64_t evtime, int format) +{ + time_t evtsec; + struct tm t; + char tbuf[TIME_BUFFER_SIZE]; + char *tz; + + if (format) { + evtsec = evtime / 1000000000; + if (format == 2) { + localtime_r(&evtsec, &t); + tz = ""; + } else { + gmtime_r(&evtsec, &t); + tz = "Z"; + } + strftime(tbuf, TIME_BUFFER_SIZE, "%FT%T", &t); + printf("%s.%09"PRIu64"%s", tbuf, evtime % 1000000000, tz); + } else { + printf("%"PRIu64".%09"PRIu64, + evtime / 1000000000, evtime % 1000000000); + } +} + +static void print_bias(struct gpiod_line_info *info) +{ + const char *name; + + switch (gpiod_line_info_get_bias(info)) { + case GPIOD_LINE_BIAS_PULL_UP: + name = "pull-up"; + break; + case GPIOD_LINE_BIAS_PULL_DOWN: + name = "pull-down"; + break; + case GPIOD_LINE_BIAS_DISABLED: + name = "disabled"; + break; + default: + return; + } + printf(" bias=%s", name); +} + +static void print_drive(struct gpiod_line_info *info) +{ + const char *name; + + switch (gpiod_line_info_get_drive(info)) { + case GPIOD_LINE_DRIVE_OPEN_DRAIN: + name = "open-drain"; + break; + case GPIOD_LINE_DRIVE_OPEN_SOURCE: + name = "open-source"; + break; + default: + return; + } + printf(" drive=%s", name); +} + +static void print_edge_detection(struct gpiod_line_info *info) +{ + const char *name; + + switch (gpiod_line_info_get_edge_detection(info)) { + case GPIOD_LINE_EDGE_BOTH: + name = "both"; + break; + case GPIOD_LINE_EDGE_RISING: + name = "rising"; + break; + case GPIOD_LINE_EDGE_FALLING: + name = "falling"; + break; + default: + return; + } + printf(" edges=%s", name); +} + +static void print_event_clock(struct gpiod_line_info *info) +{ + const char *name; + + switch (gpiod_line_info_get_event_clock(info)) { + case GPIOD_LINE_EVENT_CLOCK_REALTIME: + name = "realtime"; + break; + case GPIOD_LINE_EVENT_CLOCK_HTE: + name = "hte"; + break; + default: + return; + } + printf(" event-clock=%s", name); +} + +static void print_debounce(struct gpiod_line_info *info) +{ + unsigned long debounce; + const char *units = "us"; + + debounce = gpiod_line_info_get_debounce_period_us(info); + if (!debounce) + return; + if (debounce % 1000000 == 0) { + debounce /= 1000000; + units = "s"; + } else if (debounce % 1000 == 0) { + debounce /= 1000; + units = "ms"; + } + printf(" debounce-period=%lu%s", debounce, units); +} + +static void print_consumer(struct gpiod_line_info *info) +{ + const char *consumer; + + if (!gpiod_line_info_is_used(info)) + return; + + consumer = gpiod_line_info_get_consumer(info); + if (!consumer) + consumer = "kernel"; + printf(" consumer=%s", consumer); +} + +void print_line_attributes(struct gpiod_line_info *info) +{ + int direction; + + direction = gpiod_line_info_get_direction(info); + + printf("%s", direction == GPIOD_LINE_DIRECTION_INPUT ? + "input" : "output"); + + if (gpiod_line_info_is_active_low(info)) + printf(" active-low"); + + print_drive(info); + print_bias(info); + print_edge_detection(info); + print_event_clock(info); + print_debounce(info); + print_consumer(info); +} + +void print_line_id(struct line_resolver *resolver, int chip_num, + unsigned int offset, const char *chip_id) +{ + const char *lname; + + lname = get_line_name(resolver, chip_num, offset); + if (lname) + if (chip_id) + printf("%s %u %s", get_chip_name(resolver, chip_num), + offset, lname); + else + fputs(lname, stdout); + else + printf("%s %u", get_chip_name(resolver, chip_num), offset); +} + +static int chip_dir_filter(const struct dirent *entry) { - bool is_chip; char *path; - int ret; + int ret = 0; + struct stat sb; - ret = asprintf(&path, "/dev/%s", entry->d_name); - if (ret < 0) + if (asprintf(&path, "/dev/%s", entry->d_name) < 0) return 0; - is_chip = gpiod_is_gpiochip_device(path); + if ((lstat(path, &sb) == 0) && + (!S_ISLNK(sb.st_mode)) && + gpiod_is_gpiochip_device(path)) + ret = 1; + free(path); - return !!is_chip; + return ret; } static bool isuint(const char *str) @@ -101,3 +413,366 @@ static bool isuint(const char *str) return *str == '\0'; } + +bool chip_path_lookup(const char *id, char **path_ptr) +{ + char *path; + + if (isuint(id)) { + /* by number */ + if (asprintf(&path, "/dev/gpiochip%s", id) < 0) + return false; + } else if (strchr(id, '/')) { + /* by path */ + if (asprintf(&path, "%s", id) < 0) + return false; + } else { + /* by device name */ + if (asprintf(&path, "/dev/%s", id) < 0) + return false; + } + + if (!gpiod_is_gpiochip_device(path)) { + free(path); + return false; + } + + *path_ptr = path; + + return true; +} + +int chip_paths(const char *id, char ***paths_ptr) +{ + char *path; + char **paths; + + if (id == NULL) + return all_chip_paths(paths_ptr); + + if (!chip_path_lookup(id, &path)) + return 0; + + paths = malloc(sizeof(*paths)); + if (paths == NULL) + die("out of memory"); + + paths[0] = path; + *paths_ptr = paths; + + return 1; +} + +int all_chip_paths(char ***paths_ptr) +{ + int i, j, num_chips, ret = 0; + struct dirent **entries; + char **paths; + + num_chips = scandir("/dev/", &entries, chip_dir_filter, alphasort); + if (num_chips < 0) + die_perror("unable to scan /dev"); + + paths = calloc(num_chips, sizeof(*paths)); + if (paths == NULL) + die("out of memory"); + + for (i = 0; i < num_chips; i++) { + if (asprintf(&paths[i], "/dev/%s", entries[i]->d_name) < 0) { + for (j = 0; j < i; j++) + free(paths[j]); + + free(paths); + return 0; + } + } + + *paths_ptr = paths; + ret = num_chips; + + for (i = 0; i < num_chips; i++) + free(entries[i]); + + free(entries); + return ret; +} + +static bool resolve_line(struct line_resolver *resolver, + struct gpiod_line_info *info, + int chip_num) +{ + struct resolved_line *line; + const char *name; + int i; + unsigned int offset; + bool resolved = false; + + offset = gpiod_line_info_get_offset(info); + for (i = 0; i < resolver->num_lines; i++) { + line = &resolver->lines[i]; + // already resolved by offset? + if (line->resolved && + (line->offset == offset) && + (line->chip_num == chip_num)) { + line->info = info; + resolver->num_found++; + resolved = true; + } + if (line->resolved && !resolver->strict) + continue; + + // else resolve by name + name = gpiod_line_info_get_name(info); + if (name && (strcmp(line->id, name) == 0)) { + if (resolver->strict && line->resolved) + die("line '%s' is not unique", line->id); + line->offset = offset; + line->info = info; + line->chip_num = resolver->num_chips; + line->resolved = true; + resolver->num_found++; + resolved = true; + } + } + + return resolved; +} + +// check for lines that can be identified by offset +// +// This only applies to the first chip, as otherwise the lines must be +// identified by name. +bool resolve_lines_by_offset(struct line_resolver *resolver, + unsigned int num_lines) +{ + int i; + struct resolved_line *line; + bool used = false; + + for (i = 0; i < resolver->num_lines; i++) { + line = &resolver->lines[i]; + if ((line->id_as_offset != -1) && + (line->id_as_offset < (int)num_lines)) { + line->chip_num = 0; + line->offset = line->id_as_offset; + line->resolved = true; + used = true; + } + } + return used; +} + + +bool resolve_done(struct line_resolver *resolver) +{ + return (!resolver->strict && + resolver->num_found >= resolver->num_lines); +} + +struct line_resolver *resolver_init(int num_lines, char **lines, int num_chips, + bool strict, bool by_name) +{ + struct line_resolver *resolver; + struct resolved_line *line; + size_t resolver_size; + int i; + + resolver_size = sizeof(*resolver) + num_lines * sizeof(*line); + resolver = malloc(resolver_size); + if (resolver == NULL) + die("out of memory"); + + memset(resolver, 0, resolver_size); + + resolver->chips = calloc(num_chips, sizeof(struct resolved_chip)); + if (resolver->chips == NULL) + die("out of memory"); + memset(resolver->chips, 0, num_chips * sizeof(struct resolved_chip)); + + resolver->num_lines = num_lines; + resolver->strict = strict; + for (i = 0; i < num_lines; i++) { + line = &resolver->lines[i]; + line->id = lines[i]; + line->id_as_offset = by_name ? -1 : parse_uint(lines[i]); + line->chip_num = -1; + } + return resolver; +} + +struct line_resolver *resolve_lines(int num_lines, char **lines, + const char *chip_id, bool strict, bool by_name) +{ + struct line_resolver *resolver; + struct gpiod_chip *chip; + struct gpiod_chip_info *chip_info; + struct gpiod_line_info *line_info; + char **paths; + int num_chips, i, offset; + bool chip_used; + + if (chip_id == NULL) + by_name = true; + + num_chips = chip_paths(chip_id, &paths); + if (chip_id && (num_chips == 0)) + die("cannot find GPIO chip character device '%s'", chip_id); + + resolver = resolver_init(num_lines, lines, num_chips, strict, by_name); + + for (i = 0; (i < num_chips) && !resolve_done(resolver); i++) { + chip_used = false; + chip = gpiod_chip_open(paths[i]); + if (!chip) { + if ((errno == EACCES) && (chip_id == NULL)) { + free(paths[i]); + continue; + } + + die_perror("unable to open chip '%s'", paths[i]); + } + + chip_info = gpiod_chip_get_info(chip); + if (!chip_info) + die_perror("unable to get info for '%s'", paths[i]); + + num_lines = gpiod_chip_info_get_num_lines(chip_info); + + if (i == 0 && chip_id && !by_name) + chip_used = resolve_lines_by_offset(resolver, num_lines); + + for (offset = 0; + (offset < num_lines) && !resolve_done(resolver); + offset++) { + line_info = gpiod_chip_get_line_info(chip, offset); + if (!line_info) + die_perror("unable to read the info for line %d from %s", + offset, + gpiod_chip_info_get_name(chip_info)); + + if (resolve_line(resolver, line_info, i)) + chip_used = true; + else + gpiod_line_info_free(line_info); + + } + + gpiod_chip_close(chip); + + if (chip_used) { + resolver->chips[resolver->num_chips].info = chip_info; + resolver->chips[resolver->num_chips].path = paths[i]; + resolver->num_chips++; + } else { + gpiod_chip_info_free(chip_info); + free(paths[i]); + } + } + free(paths); + + return resolver; +} + +void validate_resolution(struct line_resolver *resolver, const char *chip_id) +{ + struct resolved_line *line, *prev; + int i, j; + bool valid = true; + + for (i = 0 ; i < resolver->num_lines; i++) { + line = &resolver->lines[i]; + if (line->resolved) { + for (j = 0; j < i; j++) { + prev = &resolver->lines[j]; + if (prev->resolved && + (prev->chip_num == line->chip_num) && + (prev->offset == line->offset)) { + print_error("lines '%s' and '%s' are the same line", + prev->id, line->id); + valid = false; + break; + } + } + continue; + } + valid = false; + if (chip_id && line->id_as_offset != -1) + print_error("offset %s is out of range on chip '%s'", + line->id, chip_id); + else + print_error("cannot find line '%s'", line->id); + } + if (!valid) + exit(EXIT_FAILURE); +} + +void free_line_resolver(struct line_resolver *resolver) +{ + int i; + + if (!resolver) + return; + + for (i = 0; i < resolver->num_lines; i++) + gpiod_line_info_free(resolver->lines[i].info); + + for (i = 0; i < resolver->num_chips; i++) { + gpiod_chip_info_free(resolver->chips[i].info); + free(resolver->chips[i].path); + } + + free(resolver->chips); + free(resolver); +} + +int get_line_offsets_and_values(struct line_resolver *resolver, + int chip_num, unsigned int *offsets, int *values) +{ + struct resolved_line *line; + int i, num_lines = 0; + + for (i = 0; i < resolver->num_lines; i++) { + line = &resolver->lines[i]; + if (line->chip_num == chip_num) { + offsets[num_lines] = line->offset; + if (values) + values[num_lines] = line->value; + + num_lines++; + } + } + return num_lines; +} + +const char *get_chip_name(struct line_resolver *resolver, int chip_num) +{ + return gpiod_chip_info_get_name(resolver->chips[chip_num].info); +} + +const char *get_line_name(struct line_resolver *resolver, + int chip_num, unsigned int offset) +{ + struct resolved_line *line; + int i; + + for (i = 0; i < resolver->num_lines; i++) { + line = &resolver->lines[i]; + if (line->info && (line->offset == offset) && + (line->chip_num == chip_num)) + return gpiod_line_info_get_name(resolver->lines[i].info); + } + + return 0; +} + +void set_line_values(struct line_resolver *resolver, int chip_num, int *values) +{ + int i, j; + + for (i = 0, j = 0; i < resolver->num_lines; i++) { + if (resolver->lines[i].chip_num == chip_num) { + resolver->lines[i].value = values[j]; + j++; + } + } +} diff --git a/tools/tools-common.h b/tools/tools-common.h index cb61d54..77946e5 100644 --- a/tools/tools-common.h +++ b/tools/tools-common.h @@ -1,10 +1,10 @@ /* SPDX-License-Identifier: GPL-2.0-or-later */ /* SPDX-FileCopyrightText: 2017-2021 Bartosz Golaszewski <bartekgola@gmail.com> */ +/* SPDX-FileCopyrightText: 2022 Kent Gibson <warthog618@gmail.com> */ #ifndef __GPIOD_TOOLS_COMMON_H__ #define __GPIOD_TOOLS_COMMON_H__ -#include <dirent.h> #include <gpiod.h> /* @@ -21,16 +21,101 @@ #define GETOPT_NULL_LONGOPT NULL, 0, NULL, 0 +struct resolved_line { + /* from the command line */ + const char *id; + + /* + * id parsed as int, if that is an option, or -1 if line must be + * resolved by name + */ + int id_as_offset; + + /* line has been located on a chip */ + bool resolved; + + /* remaining fields only valid once resolved... */ + + /* info for the line */ + struct gpiod_line_info *info; + + /* num of relevant chip in line_resolver */ + int chip_num; + + /* offset of line on chip */ + uint offset; + + /* line value for gpioget/set */ + int value; +}; + +struct resolved_chip { + /* info of the relevant chips */ + struct gpiod_chip_info *info; + + /* path to the chip */ + char *path; +}; + +/* a resolver from requested line names/offsets to lines on the system */ +struct line_resolver { + /* + * number of chips the lines span, and number of entries in chips + */ + int num_chips; + + /* number of lines in lines */ + int num_lines; + + /* number of lines found */ + int num_found; + + /* perform exhaustive search to check line names are unique */ + bool strict; + + /* details of the relevant chips */ + struct resolved_chip *chips; + + /* descriptors for the requested lines */ + struct resolved_line lines[]; +}; + const char *get_progname(void); +void print_error(const char *fmt, ...) PRINTF(1, 2); +void print_perror(const char *fmt, ...) PRINTF(1, 2); void die(const char *fmt, ...) NORETURN PRINTF(1, 2); void die_perror(const char *fmt, ...) NORETURN PRINTF(1, 2); void print_version(void); -int parse_bias(const char *option); +int parse_bias_or_die(const char *option); +int parse_period(const char *option); +unsigned int parse_period_or_die(const char *option); +int parse_periods_or_die(char *option, unsigned int **periods); +int parse_uint(const char *option); +unsigned int parse_uint_or_die(const char *option); void print_bias_help(void); -int make_signalfd(void); -int chip_dir_filter(const struct dirent *entry); -struct gpiod_chip *chip_open_by_name(const char *name); -struct gpiod_chip *chip_open_lookup(const char *device); -bool has_duplicate_offsets(size_t num_offsets, unsigned int *offsets); +void print_chip_help(void); +void print_period_help(void); +void print_event_time(uint64_t evtime, int format); +void print_line_attributes(struct gpiod_line_info *info); +void print_line_id(struct line_resolver *resolver, int chip_num, + unsigned int offset, const char *chip_id); +bool chip_path_lookup(const char *id, char **path_ptr); +int chip_paths(const char *id, char ***paths_ptr); +int all_chip_paths(char ***paths_ptr); +struct line_resolver *resolve_lines(int num_lines, char **lines, + const char *chip_id, bool strict, bool by_name); +struct line_resolver *resolver_init(int num_lines, char **lines, int num_chips, + bool strict, bool by_name); +bool resolve_lines_by_offset(struct line_resolver *resolver, + unsigned int num_lines); +bool resolve_done(struct line_resolver *resolver); +void validate_resolution(struct line_resolver *resolver, const char *chip_id); +void free_line_resolver(struct line_resolver *resolver); +int get_line_offsets_and_values(struct line_resolver *resolver, + int chip_num, unsigned int *offsets, int *values); +const char *get_chip_name(struct line_resolver *resolver, int chip_num); +const char *get_line_name(struct line_resolver *resolver, int chip_num, + unsigned int offset); +void set_line_values(struct line_resolver *resolver, int chip_num, int *values); #endif /* __GPIOD_TOOLS_COMMON_H__ */
Rework the tool suite to support identifying lines by name and to support operating on the GPIO lines available to the user at once, rather than on one particular GPIO chip. All tools, other than gpiodetect, now provide the name to (chip,offset) mapping that was previously only performed by gpiofind. As names are not guaranteed to be unique, a --strict option is provided for all tools to either abort the operation or report all lines with the matching name, as appropriate. By default the tools operate on the first line found with a matching name. Selection of line by (chip,offset) is still supported with a --chip option, though it restricts the scope of the operation to an individual chip. When the --chip option is specified, the lines are assumed to be identified by offset where they parse as an integer, else by name. To cater for the unusual case where a line name parses as an integer, but is different from the offset, the --by-name option forces the lines to be identified by name. The updated tools are intentionally NOT backwardly compatible with the previous tools. Using old command lines with the updated tools will almost certainly fail, though migrating old command lines is generally as simple as adding a '-c' before the chip. In addition the individual tools are modified as follows: gpiodetect: Add the option to select individual chips. gpioinfo: Change the focus from chips to lines, so the scope can be an individual line, a subset of lines, all lines on a particular chip, or all the lines available to the user. For line scope a single line summary is output for each line. For chip scope the existing format displaying a summary of the chip and each of its lines is retained. Line attributes are consolidated into a list format, and are extended to cover all attributes supported by uAPI v2. gpioget: The default output format is becomes line=value, as per the input for gpioset, and the value is reported as active or inactive, rather than 0 or 1. The previous format is available using the --numeric option. Add an optional hold period between requesting a line and reading the value to allow the line to settle once the requested configuration has been applied (e.g. bias). gpiomon: Consolidate the edge options into a single option. Add a debounce period option. Add options to report event times as UTC or localtime. Add format specifiers for GPIO chip path, line name, stringified event type, and event time as a datetime. Rearrange default output format to place fields with more predicable widths to the left, and to separate major field groups with tabs. Lines are identified consistent with the command line. gpioset: Add a hold period option that specifies the minimum period the line value must be held for. This applies to all set options. Support line values specified as active/inactive, on/off and true/false, as well as 1/0. Add a toggle option that specifies a time sequence over which the requested lines should be toggled. If the sequence is 0 terminated then gpioset exits when the sequence completes, else it repeats the sequence. This allows for anything from simple blinkers to bit bashing from the command line. e.g. gpioset -t 500ms LED=on Add an interactive option to provide a shell-like interface to allow manual or scripted manipulation of requested lines. A basic command set allows lines to be get, set, or toggled, and to insert sleeps between operations. Remove the --mode, --sec, and --usec options. The combination of hold period and interactive mode provide functionality equivalent to the old --mode options. Signed-off-by: Kent Gibson <warthog618@gmail.com> --- configure.ac | 8 +- tools/Makefile.am | 2 +- tools/gpiodetect.c | 113 +++++- tools/gpioget.c | 204 ++++++++++- tools/gpioinfo.c | 223 +++++++++++- tools/gpiomon.c | 450 +++++++++++++++++++++++- tools/gpioset.c | 815 ++++++++++++++++++++++++++++++++++++++++++- tools/tools-common.c | 713 ++++++++++++++++++++++++++++++++++++- tools/tools-common.h | 99 +++++- 9 files changed, 2585 insertions(+), 42 deletions(-)