diff options
Diffstat (limited to 'usr.sbin/gpioctl')
| -rw-r--r-- | usr.sbin/gpioctl/Makefile | 10 | ||||
| -rw-r--r-- | usr.sbin/gpioctl/Makefile.depend | 19 | ||||
| -rw-r--r-- | usr.sbin/gpioctl/gpioctl.8 | 132 | ||||
| -rw-r--r-- | usr.sbin/gpioctl/gpioctl.c | 327 |
4 files changed, 488 insertions, 0 deletions
diff --git a/usr.sbin/gpioctl/Makefile b/usr.sbin/gpioctl/Makefile new file mode 100644 index 0000000..c0a907b --- /dev/null +++ b/usr.sbin/gpioctl/Makefile @@ -0,0 +1,10 @@ +# $FreeBSD$ + +PROG= gpioctl +MAN= gpioctl.8 + +CFLAGS+= -I${.CURDIR}/../../lib/libgpio + +LIBADD= gpio + +.include <bsd.prog.mk> diff --git a/usr.sbin/gpioctl/Makefile.depend b/usr.sbin/gpioctl/Makefile.depend new file mode 100644 index 0000000..712b56e --- /dev/null +++ b/usr.sbin/gpioctl/Makefile.depend @@ -0,0 +1,19 @@ +# $FreeBSD$ +# Autogenerated - do NOT edit! + +DIRDEPS = \ + gnu/lib/csu \ + gnu/lib/libgcc \ + include \ + include/xlocale \ + lib/${CSU_DIR} \ + lib/libc \ + lib/libcompiler_rt \ + lib/libgpio \ + + +.include <dirdeps.mk> + +.if ${DEP_RELDIR} == ${_DEP_RELDIR} +# local dependencies - needed for -jN in clean tree +.endif diff --git a/usr.sbin/gpioctl/gpioctl.8 b/usr.sbin/gpioctl/gpioctl.8 new file mode 100644 index 0000000..dc2a554 --- /dev/null +++ b/usr.sbin/gpioctl/gpioctl.8 @@ -0,0 +1,132 @@ +.\" Copyright (c) 1980, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 4. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd March 8, 2015 +.Dt GPIOCTL 1 +.Os +.Sh NAME +.Nm gpioctl +.Nd GPIO control utility +.Sh SYNOPSIS +.Nm +.Op Fl f Ar ctldev +.Cm -l +.Op Fl v +.Nm +.Op Fl f Ar ctldev +.Cm -t +.Ar pin +.Nm +.Op Fl f Ar ctldev +.Cm -c +.Ar pin +.Ar flag +.Op flag ... +.Nm +.Op Fl f Ar ctldev +.Cm -n +.Ar pin +.Ar pin-name +.Nm +.Op Cm -f Ar ctldev +.Ar pin +.Ar [0|1] +.Sh DESCRIPTION +The +.Nm +utility could be used to manage GPIO pins from userland and list available pins. +.Pp +The options are as follows: +.Bl -tag -width ".Fl f Ar ctldev" +.It Fl c Ar pin Ar flag Op flag ... +Configure pin by setting provided flags. +The following flags are currently defined: +.Bl -tag -offset indent -width ".Cm PULSE" +.It Cm IN +Input pin +.It Cm OUT +Output pin +.It Cm OD +Open drain pin +.It Cm PP +Push pull pin +.It Cm TS +Tristate pin +.It Cm PU +Pull-up pin +.It Cm PD +Pull-down pin +.It Cm II +Inverted input pin +.It Cm IO +Inverted output pin +.El +.It Fl f Ar ctldev +GPIO controller device to use +If not specified, defaults to +.Pa /dev/gpioc0 +.It Fl l +list available pins +.It Fl n Ar pin Ar pin-name +set the name used to describe the pin +.It Fl t Ar pin +toggle value of provided pin number +.It Fl v +be verbose: for each listed pin print current configuration +.El +.Sh EXAMPLES +.Bl -bullet +.It +List pins available on GPIO controller defined by device /dev/gpioc0 +.Pp +gpioctl -f /dev/gpioc0 -l +.It +Set the value of pin 12 to 1 +.Pp +gpioctl -f /dev/gpioc0 12 1 +.It +Configure pin 12 to be input pin +.Pp +gpioctl -f /dev/gpioc0 -c 12 IN +.El +.Sh SEE ALSO +.Xr gpio 4 , +.Xr gpioiic 4 , +.Xr gpioled 4 +.Sh HISTORY +The +.Nm +utility appeared in +.Fx 9.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +utility and this manual page were written by +.An Oleksandr Tymoshenko Aq Mt gonzo@freebsd.org . diff --git a/usr.sbin/gpioctl/gpioctl.c b/usr.sbin/gpioctl/gpioctl.c new file mode 100644 index 0000000..38e53e7 --- /dev/null +++ b/usr.sbin/gpioctl/gpioctl.c @@ -0,0 +1,327 @@ +/*- + * Copyright (c) 2009, Oleksandr Tymoshenko <gonzo@FreeBSD.org> + * Copyright (c) 2014, Rui Paulo <rpaulo@FreeBSD.org> + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice unmodified, this list of conditions, and the following + * disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + +#include <sys/cdefs.h> +__FBSDID("$FreeBSD$"); + +#include <fcntl.h> +#include <getopt.h> +#include <paths.h> +#include <stdio.h> +#include <stdarg.h> +#include <stdlib.h> +#include <string.h> +#include <unistd.h> + +#include <libgpio.h> + +struct flag_desc { + const char *name; + uint32_t flag; +}; + +static struct flag_desc gpio_flags[] = { + { "IN", GPIO_PIN_INPUT }, + { "OUT", GPIO_PIN_OUTPUT }, + { "OD", GPIO_PIN_OPENDRAIN }, + { "PP", GPIO_PIN_PUSHPULL }, + { "TS", GPIO_PIN_TRISTATE }, + { "PU", GPIO_PIN_PULLUP }, + { "PD", GPIO_PIN_PULLDOWN }, + { "II", GPIO_PIN_INVIN }, + { "IO", GPIO_PIN_INVOUT }, + { "PULSE", GPIO_PIN_PULSATE }, + { NULL, 0 }, +}; + +int str2cap(const char *str); + +static void +usage(void) +{ + fprintf(stderr, "Usage:\n"); + fprintf(stderr, "\tgpioctl [-f ctldev] -l [-v]\n"); + fprintf(stderr, "\tgpioctl [-f ctldev] -t pin\n"); + fprintf(stderr, "\tgpioctl [-f ctldev] -c pin flag ...\n"); + fprintf(stderr, "\tgpioctl [-f ctldev] -n pin pin-name\n"); + fprintf(stderr, "\tgpioctl [-f ctldev] pin [0|1]\n"); + exit(1); +} + +static const char * +cap2str(uint32_t cap) +{ + struct flag_desc * pdesc = gpio_flags; + while (pdesc->name) { + if (pdesc->flag == cap) + return pdesc->name; + pdesc++; + } + + return "UNKNOWN"; +} + +int +str2cap(const char *str) +{ + struct flag_desc * pdesc = gpio_flags; + while (pdesc->name) { + if (strcasecmp(str, pdesc->name) == 0) + return pdesc->flag; + pdesc++; + } + + return (-1); +} + +/* + * Our handmade function for converting string to number + */ +static int +str2int(const char *s, int *ok) +{ + char *endptr; + int res = strtod(s, &endptr); + if (endptr != s + strlen(s) ) + *ok = 0; + else + *ok = 1; + + return res; +} + +static void +print_caps(int caps) +{ + int i, need_coma; + + need_coma = 0; + printf("<"); + for (i = 0; i < 32; i++) { + if (caps & (1 << i)) { + if (need_coma) + printf(","); + printf("%s", cap2str(1 << i)); + need_coma = 1; + } + } + printf(">"); +} + +static void +dump_pins(gpio_handle_t handle, int verbose) +{ + int i, maxpin, pinv; + gpio_config_t *cfgs; + gpio_config_t *pin; + + maxpin = gpio_pin_list(handle, &cfgs); + if (maxpin < 0) { + perror("gpio_pin_list"); + exit(1); + } + + for (i = 0; i <= maxpin; i++) { + pin = cfgs + i; + pinv = gpio_pin_get(handle, pin->g_pin); + printf("pin %02d:\t%d\t%s", pin->g_pin, pinv, + pin->g_name); + + print_caps(pin->g_flags); + + if (verbose) { + printf(", caps:"); + print_caps(pin->g_caps); + } + printf("\n"); + } + free(cfgs); +} + +static void +fail(const char *fmt, ...) +{ + va_list ap; + + va_start(ap, fmt); + vfprintf(stderr, fmt, ap); + va_end(ap); + exit(1); +} + +int +main(int argc, char **argv) +{ + int i; + gpio_config_t pin; + gpio_handle_t handle; + char *ctlfile = NULL; + int pinn, pinv, ch; + int flags, flag, ok; + int config, list, name, toggle, verbose; + + config = toggle = verbose = list = name = pinn = 0; + + while ((ch = getopt(argc, argv, "c:f:ln:t:v")) != -1) { + switch (ch) { + case 'c': + config = 1; + pinn = str2int(optarg, &ok); + if (!ok) + fail("Invalid pin number: %s\n", optarg); + break; + case 'f': + ctlfile = optarg; + break; + case 'l': + list = 1; + break; + case 'n': + name = 1; + pinn = str2int(optarg, &ok); + if (!ok) + fail("Invalid pin number: %s\n", optarg); + break; + case 't': + toggle = 1; + pinn = str2int(optarg, &ok); + if (!ok) + fail("Invalid pin number: %s\n", optarg); + break; + case 'v': + verbose = 1; + break; + default: + usage(); + break; + } + } + argv += optind; + argc -= optind; + if (ctlfile == NULL) + handle = gpio_open(0); + else + handle = gpio_open_device(ctlfile); + if (handle == GPIO_INVALID_HANDLE) { + perror("gpio_open"); + exit(1); + } + + /* Set the pin name. */ + if (name) { + if (argc == 0) { + usage(); + exit(1); + } + if (gpio_pin_set_name(handle, pinn, argv[0]) < 0) { + perror("gpio_pin_set_name"); + exit(1); + } + exit(0); + } + + if (list) { + dump_pins(handle, verbose); + gpio_close(handle); + exit(0); + } + + if (toggle) { + /* + * -t pin assumes no additional arguments + */ + if (argc > 0) { + usage(); + exit(1); + } + if (gpio_pin_toggle(handle, pinn) < 0) { + perror("gpio_pin_toggle"); + exit(1); + } + gpio_close(handle); + exit(0); + } + + if (config) { + flags = 0; + for (i = 0; i < argc; i++) { + flag = str2cap(argv[i]); + if (flag < 0) + fail("Invalid flag: %s\n", argv[i]); + flags |= flag; + } + pin.g_pin = pinn; + pin.g_flags = flags; + if (gpio_pin_set_flags(handle, &pin) < 0) { + perror("gpio_pin_set_flags"); + exit(1); + } + exit(0); + } + + /* + * Last two cases - set value or print value + */ + if ((argc == 0) || (argc > 2)) { + usage(); + exit(1); + } + + pinn = str2int(argv[0], &ok); + if (!ok) + fail("Invalid pin number: %s\n", argv[0]); + + /* + * Read pin value + */ + if (argc == 1) { + pinv = gpio_pin_get(handle, pinn); + if (pinv < 0) { + perror("gpio_pin_get"); + exit(1); + } + printf("%d\n", pinv); + exit(0); + } + + /* Is it valid number (0 or 1) ? */ + pinv = str2int(argv[1], &ok); + if (!ok || ((pinv != 0) && (pinv != 1))) + fail("Invalid pin value: %s\n", argv[1]); + + /* + * Set pin value + */ + if (gpio_pin_set(handle, pinn, pinv) < 0) { + perror("gpio_pin_set"); + exit(1); + } + + gpio_close(handle); + exit(0); +} |
