1*fa616ef4Sjakllsch /* $NetBSD: gpioctl.c,v 1.28 2022/12/13 21:47:36 jakllsch Exp $ */
232eeaba5Smbalmer
3825ff184Sjmcneill /*
41bdc60c3Smbalmer * Copyright (c) 2008, 2010, 2011, 2013 Marc Balmer <mbalmer@NetBSD.org>
5825ff184Sjmcneill * Copyright (c) 2004 Alexander Yurchenko <grange@openbsd.org>
6825ff184Sjmcneill *
7825ff184Sjmcneill * Permission to use, copy, modify, and distribute this software for any
8825ff184Sjmcneill * purpose with or without fee is hereby granted, provided that the above
9825ff184Sjmcneill * copyright notice and this permission notice appear in all copies.
10825ff184Sjmcneill *
11825ff184Sjmcneill * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12825ff184Sjmcneill * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13825ff184Sjmcneill * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14825ff184Sjmcneill * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15825ff184Sjmcneill * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16825ff184Sjmcneill * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17825ff184Sjmcneill * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18825ff184Sjmcneill */
1973e87e7aSchristos #include <sys/cdefs.h>
20*fa616ef4Sjakllsch __RCSID("$NetBSD: gpioctl.c,v 1.28 2022/12/13 21:47:36 jakllsch Exp $");
21825ff184Sjmcneill
22825ff184Sjmcneill /*
23825ff184Sjmcneill * Program to control GPIO devices.
24825ff184Sjmcneill */
25825ff184Sjmcneill
26825ff184Sjmcneill #include <sys/types.h>
27825ff184Sjmcneill #include <sys/gpio.h>
28825ff184Sjmcneill #include <sys/ioctl.h>
29825ff184Sjmcneill
30825ff184Sjmcneill #include <err.h>
3132eeaba5Smbalmer #include <errno.h>
32825ff184Sjmcneill #include <fcntl.h>
3332eeaba5Smbalmer #include <limits.h>
3432eeaba5Smbalmer #include <paths.h>
35825ff184Sjmcneill #include <stdio.h>
36825ff184Sjmcneill #include <stdlib.h>
37da668cdfSmbalmer #include <time.h>
38825ff184Sjmcneill #include <string.h>
39825ff184Sjmcneill #include <unistd.h>
40825ff184Sjmcneill
41c45de77dSjoerg static char *dev;
42c45de77dSjoerg static int devfd = -1;
43c45de77dSjoerg static int quiet = 0;
441bdc60c3Smbalmer static int state = 0;
45825ff184Sjmcneill
4657ef84d0Smbalmer static void getinfo(void);
4757ef84d0Smbalmer static void gpioread(int, char *);
4857ef84d0Smbalmer static void gpiowrite(int, char *, int);
4957ef84d0Smbalmer static void gpioset(int pin, char *name, int flags, char *alias);
5057ef84d0Smbalmer static void gpiounset(int pin, char *name);
51d564a57eStnn static void gpiolist(void);
52be149ed8Smbalmer static void devattach(char *, int, uint32_t, uint32_t);
53c45de77dSjoerg __dead static void usage(void);
5432eeaba5Smbalmer
55c45de77dSjoerg static const struct bitstr {
56825ff184Sjmcneill unsigned int mask;
57825ff184Sjmcneill const char *string;
58825ff184Sjmcneill } pinflags[] = {
59825ff184Sjmcneill { GPIO_PIN_INPUT, "in" },
60825ff184Sjmcneill { GPIO_PIN_OUTPUT, "out" },
61825ff184Sjmcneill { GPIO_PIN_INOUT, "inout" },
62825ff184Sjmcneill { GPIO_PIN_OPENDRAIN, "od" },
63825ff184Sjmcneill { GPIO_PIN_PUSHPULL, "pp" },
64825ff184Sjmcneill { GPIO_PIN_TRISTATE, "tri" },
65825ff184Sjmcneill { GPIO_PIN_PULLUP, "pu" },
66cfebb94aSxtraeme { GPIO_PIN_PULLDOWN, "pd" },
67cfebb94aSxtraeme { GPIO_PIN_INVIN, "iin" },
6832eeaba5Smbalmer { GPIO_PIN_INVOUT, "iout" },
6998c90767Smbalmer { GPIO_PIN_PULSATE, "pulsate" },
70e27bab72Smlelstv { GPIO_PIN_ALT0, "alt0" },
71e27bab72Smlelstv { GPIO_PIN_ALT1, "alt1" },
72e27bab72Smlelstv { GPIO_PIN_ALT2, "alt2" },
73e27bab72Smlelstv { GPIO_PIN_ALT3, "alt3" },
74e27bab72Smlelstv { GPIO_PIN_ALT4, "alt4" },
75e27bab72Smlelstv { GPIO_PIN_ALT5, "alt5" },
76e27bab72Smlelstv { GPIO_PIN_ALT6, "alt6" },
77e27bab72Smlelstv { GPIO_PIN_ALT7, "alt7" },
78e27bab72Smlelstv { GPIO_PIN_USER, "user" },
79825ff184Sjmcneill { 0, NULL },
80825ff184Sjmcneill };
81825ff184Sjmcneill
82825ff184Sjmcneill int
main(int argc,char * argv[])83825ff184Sjmcneill main(int argc, char *argv[])
84825ff184Sjmcneill {
8532eeaba5Smbalmer const struct bitstr *bs;
8632eeaba5Smbalmer int pin, ch, n, fl = 0, value = 0;
8732eeaba5Smbalmer const char *errstr;
88825ff184Sjmcneill char *ep;
8932eeaba5Smbalmer int ga_offset = -1;
90da668cdfSmbalmer uint32_t ga_mask = 0;
91be149ed8Smbalmer uint32_t ga_flags = 0;
9232eeaba5Smbalmer long lval;
9332eeaba5Smbalmer char *nam = NULL;
94be149ed8Smbalmer char *flags;
9532eeaba5Smbalmer char devn[32];
96825ff184Sjmcneill
971bdc60c3Smbalmer while ((ch = getopt(argc, argv, "qs")) != -1)
98825ff184Sjmcneill switch (ch) {
99825ff184Sjmcneill case 'q':
100825ff184Sjmcneill quiet = 1;
101825ff184Sjmcneill break;
1021bdc60c3Smbalmer case 's':
1031bdc60c3Smbalmer quiet = state = 1;
1041bdc60c3Smbalmer break;
105825ff184Sjmcneill default:
106825ff184Sjmcneill usage();
107825ff184Sjmcneill /* NOTREACHED */
108825ff184Sjmcneill }
109825ff184Sjmcneill argc -= optind;
110825ff184Sjmcneill argv += optind;
111825ff184Sjmcneill
11232eeaba5Smbalmer if (argc < 1)
113825ff184Sjmcneill usage();
11432eeaba5Smbalmer dev = argv[0];
11532eeaba5Smbalmer
11632eeaba5Smbalmer if (strncmp(_PATH_DEV, dev, sizeof(_PATH_DEV) - 1)) {
11732eeaba5Smbalmer (void)snprintf(devn, sizeof(devn), "%s%s", _PATH_DEV, dev);
11832eeaba5Smbalmer dev = devn;
11932eeaba5Smbalmer }
12032eeaba5Smbalmer
12132eeaba5Smbalmer if ((devfd = open(dev, O_RDWR)) == -1)
12232eeaba5Smbalmer err(EXIT_FAILURE, "%s", dev);
12332eeaba5Smbalmer
12432eeaba5Smbalmer if (argc == 1) {
12532eeaba5Smbalmer getinfo();
12632eeaba5Smbalmer return EXIT_SUCCESS;
12732eeaba5Smbalmer }
12832eeaba5Smbalmer
12932eeaba5Smbalmer if (!strcmp(argv[1], "attach")) {
13032eeaba5Smbalmer char *driver, *offset, *mask;
13132eeaba5Smbalmer
132be149ed8Smbalmer if (argc != 5 && argc != 6)
13332eeaba5Smbalmer usage();
13432eeaba5Smbalmer
13532eeaba5Smbalmer driver = argv[2];
13632eeaba5Smbalmer offset = argv[3];
13732eeaba5Smbalmer mask = argv[4];
138be149ed8Smbalmer flags = argc == 6 ? argv[5] : NULL;
13932eeaba5Smbalmer
14032eeaba5Smbalmer ga_offset = strtonum(offset, 0, INT_MAX, &errstr);
14132eeaba5Smbalmer if (errstr)
14232eeaba5Smbalmer errx(EXIT_FAILURE, "offset is %s: %s", errstr, offset);
14332eeaba5Smbalmer lval = strtol(mask, &ep, 0);
14432eeaba5Smbalmer if (*mask == '\0' || *ep != '\0')
14532eeaba5Smbalmer errx(EXIT_FAILURE, "invalid mask (not a number)");
14632eeaba5Smbalmer if ((errno == ERANGE && (lval == LONG_MAX
14732eeaba5Smbalmer || lval == LONG_MIN)) || (unsigned long)lval > UINT_MAX)
14832eeaba5Smbalmer errx(EXIT_FAILURE, "mask out of range");
14932eeaba5Smbalmer ga_mask = lval;
150be149ed8Smbalmer if (flags != NULL) {
151be149ed8Smbalmer lval = strtol(flags, &ep, 0);
152be149ed8Smbalmer if (*flags == '\0' || *ep != '\0')
153be149ed8Smbalmer errx(EXIT_FAILURE,
1543b72c2b3Smbalmer "invalid flag locator (not a number)");
155be149ed8Smbalmer if ((errno == ERANGE && (lval == LONG_MAX
156be149ed8Smbalmer || lval == LONG_MIN))
157be149ed8Smbalmer || (unsigned long)lval > UINT_MAX)
1583b72c2b3Smbalmer errx(EXIT_FAILURE, "flag locator out of range");
1593b72c2b3Smbalmer
160be149ed8Smbalmer ga_flags = lval;
161be149ed8Smbalmer }
162be149ed8Smbalmer devattach(driver, ga_offset, ga_mask, ga_flags);
16332eeaba5Smbalmer return EXIT_SUCCESS;
164d564a57eStnn } else if (!strcmp(argv[1], "list")) {
165d564a57eStnn gpiolist();
166d564a57eStnn return EXIT_SUCCESS;
16732eeaba5Smbalmer } else {
16832eeaba5Smbalmer char *nm = NULL;
16932eeaba5Smbalmer
17032eeaba5Smbalmer /* expecting a pin number or name */
17132eeaba5Smbalmer pin = strtonum(argv[1], 0, INT_MAX, &errstr);
17232eeaba5Smbalmer if (errstr)
17332eeaba5Smbalmer nm = argv[1]; /* try named pin */
17432eeaba5Smbalmer if (argc > 2) {
17532eeaba5Smbalmer if (!strcmp(argv[2], "set")) {
17632eeaba5Smbalmer for (n = 3; n < argc; n++) {
17732eeaba5Smbalmer for (bs = pinflags; bs->string != NULL;
17832eeaba5Smbalmer bs++) {
17932eeaba5Smbalmer if (!strcmp(argv[n],
18032eeaba5Smbalmer bs->string)) {
18132eeaba5Smbalmer fl |= bs->mask;
18232eeaba5Smbalmer break;
18332eeaba5Smbalmer }
18432eeaba5Smbalmer }
18532eeaba5Smbalmer if (bs->string == NULL)
18632eeaba5Smbalmer nam = argv[n];
18732eeaba5Smbalmer }
18832eeaba5Smbalmer gpioset(pin, nm, fl, nam);
189e680da6bSmbalmer } else if (!strcmp(argv[2], "unset"))
19032eeaba5Smbalmer gpiounset(pin, nm);
191e680da6bSmbalmer else {
19232eeaba5Smbalmer value = strtonum(argv[2], INT_MIN, INT_MAX,
19332eeaba5Smbalmer &errstr);
19432eeaba5Smbalmer if (errstr) {
19532eeaba5Smbalmer if (!strcmp(argv[2], "on"))
196da668cdfSmbalmer value = GPIO_PIN_HIGH;
19732eeaba5Smbalmer else if (!strcmp(argv[2], "off"))
198da668cdfSmbalmer value = GPIO_PIN_LOW;
19932eeaba5Smbalmer else if (!strcmp(argv[2], "toggle"))
20032eeaba5Smbalmer value = 2;
20132eeaba5Smbalmer else
20232eeaba5Smbalmer errx(EXIT_FAILURE,
20332eeaba5Smbalmer "%s: invalid value",
20432eeaba5Smbalmer argv[2]);
20532eeaba5Smbalmer }
20632eeaba5Smbalmer gpiowrite(pin, nm, value);
20732eeaba5Smbalmer }
20832eeaba5Smbalmer } else
20932eeaba5Smbalmer gpioread(pin, nm);
210825ff184Sjmcneill }
2119b5c4f42Sxtraeme return EXIT_SUCCESS;
212825ff184Sjmcneill }
213825ff184Sjmcneill
21457ef84d0Smbalmer static void
getinfo(void)215825ff184Sjmcneill getinfo(void)
216825ff184Sjmcneill {
217825ff184Sjmcneill struct gpio_info info;
218825ff184Sjmcneill
219825ff184Sjmcneill if (ioctl(devfd, GPIOINFO, &info) == -1)
2209b5c4f42Sxtraeme err(EXIT_FAILURE, "GPIOINFO");
221825ff184Sjmcneill
2221bdc60c3Smbalmer if (state)
2231bdc60c3Smbalmer printf("%d\n", info.gpio_npins);
2241bdc60c3Smbalmer
225825ff184Sjmcneill if (quiet)
226825ff184Sjmcneill return;
227825ff184Sjmcneill
22832eeaba5Smbalmer printf("%s: %d pins\n", dev, info.gpio_npins);
229825ff184Sjmcneill }
230825ff184Sjmcneill
23157ef84d0Smbalmer static void
gpioread(int pin,char * gp_name)23232eeaba5Smbalmer gpioread(int pin, char *gp_name)
233825ff184Sjmcneill {
23432eeaba5Smbalmer struct gpio_req req;
235825ff184Sjmcneill
23632eeaba5Smbalmer memset(&req, 0, sizeof(req));
23732eeaba5Smbalmer if (gp_name != NULL)
23832eeaba5Smbalmer strlcpy(req.gp_name, gp_name, sizeof(req.gp_name));
23932eeaba5Smbalmer else
24032eeaba5Smbalmer req.gp_pin = pin;
24132eeaba5Smbalmer
24232eeaba5Smbalmer if (ioctl(devfd, GPIOREAD, &req) == -1)
24332eeaba5Smbalmer err(EXIT_FAILURE, "GPIOREAD");
244825ff184Sjmcneill
2451bdc60c3Smbalmer if (state)
2461bdc60c3Smbalmer printf("%d\n", req.gp_value);
2471bdc60c3Smbalmer
248825ff184Sjmcneill if (quiet)
249825ff184Sjmcneill return;
250825ff184Sjmcneill
25132eeaba5Smbalmer if (gp_name)
25232eeaba5Smbalmer printf("pin %s: state %d\n", gp_name, req.gp_value);
25332eeaba5Smbalmer else
25432eeaba5Smbalmer printf("pin %d: state %d\n", pin, req.gp_value);
255825ff184Sjmcneill }
256825ff184Sjmcneill
25757ef84d0Smbalmer static void
gpiowrite(int pin,char * gp_name,int value)25832eeaba5Smbalmer gpiowrite(int pin, char *gp_name, int value)
259825ff184Sjmcneill {
26032eeaba5Smbalmer struct gpio_req req;
261825ff184Sjmcneill
262825ff184Sjmcneill if (value < 0 || value > 2)
2639b5c4f42Sxtraeme errx(EXIT_FAILURE, "%d: invalid value", value);
264825ff184Sjmcneill
26532eeaba5Smbalmer memset(&req, 0, sizeof(req));
26632eeaba5Smbalmer if (gp_name != NULL)
26732eeaba5Smbalmer strlcpy(req.gp_name, gp_name, sizeof(req.gp_name));
26832eeaba5Smbalmer else
26932eeaba5Smbalmer req.gp_pin = pin;
270da668cdfSmbalmer
271da668cdfSmbalmer if (value == GPIO_PIN_HIGH || value == GPIO_PIN_LOW) {
272da668cdfSmbalmer req.gp_value = value;
27332eeaba5Smbalmer if (ioctl(devfd, GPIOWRITE, &req) == -1)
27432eeaba5Smbalmer err(EXIT_FAILURE, "GPIOWRITE");
275825ff184Sjmcneill } else {
27632eeaba5Smbalmer if (ioctl(devfd, GPIOTOGGLE, &req) == -1)
27732eeaba5Smbalmer err(EXIT_FAILURE, "GPIOTOGGLE");
278825ff184Sjmcneill }
279825ff184Sjmcneill
2801bdc60c3Smbalmer if (state)
2811bdc60c3Smbalmer printf("%d\n", value < 2 ? value : 1 - req.gp_value);
2821bdc60c3Smbalmer
283825ff184Sjmcneill if (quiet)
284825ff184Sjmcneill return;
285825ff184Sjmcneill
28632eeaba5Smbalmer if (gp_name)
28732eeaba5Smbalmer printf("pin %s: state %d -> %d\n", gp_name, req.gp_value,
28832eeaba5Smbalmer (value < 2 ? value : 1 - req.gp_value));
28932eeaba5Smbalmer else
29032eeaba5Smbalmer printf("pin %d: state %d -> %d\n", pin, req.gp_value,
29132eeaba5Smbalmer (value < 2 ? value : 1 - req.gp_value));
292825ff184Sjmcneill }
293825ff184Sjmcneill
29457ef84d0Smbalmer static void
gpioset(int pin,char * name,int fl,char * alias)29532eeaba5Smbalmer gpioset(int pin, char *name, int fl, char *alias)
296825ff184Sjmcneill {
29732eeaba5Smbalmer struct gpio_set set;
298825ff184Sjmcneill const struct bitstr *bs;
299825ff184Sjmcneill
30032eeaba5Smbalmer memset(&set, 0, sizeof(set));
30132eeaba5Smbalmer if (name != NULL)
30232eeaba5Smbalmer strlcpy(set.gp_name, name, sizeof(set.gp_name));
30332eeaba5Smbalmer else
30432eeaba5Smbalmer set.gp_pin = pin;
30532eeaba5Smbalmer set.gp_flags = fl;
30632eeaba5Smbalmer
30732eeaba5Smbalmer if (alias != NULL)
30832eeaba5Smbalmer strlcpy(set.gp_name2, alias, sizeof(set.gp_name2));
30932eeaba5Smbalmer
31032eeaba5Smbalmer if (ioctl(devfd, GPIOSET, &set) == -1)
31132eeaba5Smbalmer err(EXIT_FAILURE, "GPIOSET");
312825ff184Sjmcneill
313825ff184Sjmcneill if (quiet)
314825ff184Sjmcneill return;
315825ff184Sjmcneill
31632eeaba5Smbalmer if (name != NULL)
31732eeaba5Smbalmer printf("pin %s: caps:", name);
31832eeaba5Smbalmer else
319825ff184Sjmcneill printf("pin %d: caps:", pin);
320825ff184Sjmcneill for (bs = pinflags; bs->string != NULL; bs++)
32132eeaba5Smbalmer if (set.gp_caps & bs->mask)
322825ff184Sjmcneill printf(" %s", bs->string);
323825ff184Sjmcneill printf(", flags:");
324825ff184Sjmcneill for (bs = pinflags; bs->string != NULL; bs++)
32532eeaba5Smbalmer if (set.gp_flags & bs->mask)
326825ff184Sjmcneill printf(" %s", bs->string);
327825ff184Sjmcneill if (fl > 0) {
328825ff184Sjmcneill printf(" ->");
329825ff184Sjmcneill for (bs = pinflags; bs->string != NULL; bs++)
330825ff184Sjmcneill if (fl & bs->mask)
331825ff184Sjmcneill printf(" %s", bs->string);
332825ff184Sjmcneill }
333825ff184Sjmcneill printf("\n");
334825ff184Sjmcneill }
335825ff184Sjmcneill
33657ef84d0Smbalmer static void
gpiounset(int pin,char * name)33732eeaba5Smbalmer gpiounset(int pin, char *name)
33832eeaba5Smbalmer {
33932eeaba5Smbalmer struct gpio_set set;
34032eeaba5Smbalmer
34132eeaba5Smbalmer memset(&set, 0, sizeof(set));
34232eeaba5Smbalmer if (name != NULL)
34332eeaba5Smbalmer strlcpy(set.gp_name, name, sizeof(set.gp_name));
34432eeaba5Smbalmer else
34532eeaba5Smbalmer set.gp_pin = pin;
34632eeaba5Smbalmer
34732eeaba5Smbalmer if (ioctl(devfd, GPIOUNSET, &set) == -1)
34832eeaba5Smbalmer err(EXIT_FAILURE, "GPIOUNSET");
34932eeaba5Smbalmer }
35032eeaba5Smbalmer
35157ef84d0Smbalmer static void
gpiolist()352d564a57eStnn gpiolist()
353d564a57eStnn {
354d564a57eStnn struct gpio_info info;
355d564a57eStnn struct gpio_req req;
356d564a57eStnn int i;
357d564a57eStnn
358d564a57eStnn if (ioctl(devfd, GPIOINFO, &info) == -1)
359d564a57eStnn err(EXIT_FAILURE, "GPIOINFO");
360d564a57eStnn
361d564a57eStnn for (i = 0; i < info.gpio_npins; i++) {
362d564a57eStnn memset(&req, 0, sizeof(req));
363d564a57eStnn req.gp_pin = i;
364d564a57eStnn if (ioctl(devfd, GPIOREAD, &req) == -1)
365*fa616ef4Sjakllsch continue;
366d564a57eStnn if (!quiet)
367d564a57eStnn printf("%d: %s\n", i, req.gp_name);
368d564a57eStnn }
369d564a57eStnn }
370d564a57eStnn
371d564a57eStnn static void
devattach(char * dvname,int offset,uint32_t mask,uint32_t flags)372be149ed8Smbalmer devattach(char *dvname, int offset, uint32_t mask, uint32_t flags)
37332eeaba5Smbalmer {
37432eeaba5Smbalmer struct gpio_attach attach;
37532eeaba5Smbalmer
37632eeaba5Smbalmer memset(&attach, 0, sizeof(attach));
37732eeaba5Smbalmer strlcpy(attach.ga_dvname, dvname, sizeof(attach.ga_dvname));
37832eeaba5Smbalmer attach.ga_offset = offset;
37932eeaba5Smbalmer attach.ga_mask = mask;
380be149ed8Smbalmer attach.ga_flags = flags;
38132eeaba5Smbalmer if (ioctl(devfd, GPIOATTACH, &attach) == -1)
38232eeaba5Smbalmer err(EXIT_FAILURE, "GPIOATTACH");
38332eeaba5Smbalmer }
38432eeaba5Smbalmer
38557ef84d0Smbalmer static void
usage(void)386825ff184Sjmcneill usage(void)
387825ff184Sjmcneill {
38857ef84d0Smbalmer const char *progname;
38932eeaba5Smbalmer
39057ef84d0Smbalmer progname = getprogname();
3911bdc60c3Smbalmer fprintf(stderr, "usage: %s [-qs] device [pin] [0 | 1 | 2 | "
39257ef84d0Smbalmer "on | off | toggle]\n", progname);
39332eeaba5Smbalmer fprintf(stderr, " %s [-q] device pin set [flags] [name]\n",
39457ef84d0Smbalmer progname);
39557ef84d0Smbalmer fprintf(stderr, " %s [-q] device pin unset\n", progname);
396be149ed8Smbalmer fprintf(stderr, " %s [-q] device attach device offset mask "
3973b72c2b3Smbalmer "[flag]\n",
39857ef84d0Smbalmer progname);
399d564a57eStnn fprintf(stderr, " %s [-q] device list\n", progname);
400825ff184Sjmcneill
4019b5c4f42Sxtraeme exit(EXIT_FAILURE);
402825ff184Sjmcneill }
403