xref: /netbsd-src/usr.sbin/gpioctl/gpioctl.c (revision f89f6560d453f5e37386cc7938c072d2f528b9fa)
1 /* $NetBSD: gpioctl.c,v 1.21 2015/01/29 03:30:06 christos Exp $ */
2 
3 /*
4  * Copyright (c) 2008, 2010, 2011, 2013 Marc Balmer <mbalmer@NetBSD.org>
5  * Copyright (c) 2004 Alexander Yurchenko <grange@openbsd.org>
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 /*
21  * Program to control GPIO devices.
22  */
23 
24 #include <sys/types.h>
25 #include <sys/gpio.h>
26 #include <sys/ioctl.h>
27 
28 #include <err.h>
29 #include <errno.h>
30 #include <fcntl.h>
31 #include <limits.h>
32 #include <paths.h>
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <time.h>
36 #include <string.h>
37 #include <unistd.h>
38 
39 static char *dev;
40 static int devfd = -1;
41 static int quiet = 0;
42 static int state = 0;
43 
44 static void getinfo(void);
45 static void gpioread(int, char *);
46 static void gpiowrite(int, char *, int);
47 static void gpioset(int pin, char *name, int flags, char *alias);
48 static void gpiounset(int pin, char *name);
49 static void devattach(char *, int, uint32_t, uint32_t);
50 __dead static void usage(void);
51 
52 static const struct bitstr {
53 	unsigned int mask;
54 	const char *string;
55 } pinflags[] = {
56 	{ GPIO_PIN_INPUT, "in" },
57 	{ GPIO_PIN_OUTPUT, "out" },
58 	{ GPIO_PIN_INOUT, "inout" },
59 	{ GPIO_PIN_OPENDRAIN, "od" },
60 	{ GPIO_PIN_PUSHPULL, "pp" },
61 	{ GPIO_PIN_TRISTATE, "tri" },
62 	{ GPIO_PIN_PULLUP, "pu" },
63 	{ GPIO_PIN_PULLDOWN, "pd" },
64 	{ GPIO_PIN_INVIN, "iin" },
65 	{ GPIO_PIN_INVOUT, "iout" },
66 	{ GPIO_PIN_PULSATE, "pulsate" },
67 	{ 0, NULL },
68 };
69 
70 int
71 main(int argc, char *argv[])
72 {
73 	const struct bitstr *bs;
74 	int pin, ch, n, fl = 0, value = 0;
75 	const char *errstr;
76 	char *ep;
77 	int ga_offset = -1;
78 	uint32_t ga_mask = 0;
79 	uint32_t ga_flags = 0;
80 	long lval;
81 	char *nam = NULL;
82 	char *flags;
83 	char devn[32];
84 
85 	while ((ch = getopt(argc, argv, "qs")) != -1)
86 		switch (ch) {
87 		case 'q':
88 			quiet = 1;
89 			break;
90 		case 's':
91 			quiet = state = 1;
92 			break;
93 		default:
94 			usage();
95 			/* NOTREACHED */
96 		}
97 	argc -= optind;
98 	argv += optind;
99 
100 	if (argc < 1)
101 		usage();
102 	dev = argv[0];
103 
104 	if (strncmp(_PATH_DEV, dev, sizeof(_PATH_DEV) - 1)) {
105 		(void)snprintf(devn, sizeof(devn), "%s%s", _PATH_DEV, dev);
106 		dev = devn;
107 	}
108 
109 	if ((devfd = open(dev, O_RDWR)) == -1)
110 		err(EXIT_FAILURE, "%s", dev);
111 
112 	if (argc == 1) {
113 		getinfo();
114 		return EXIT_SUCCESS;
115 	}
116 
117 	if (!strcmp(argv[1], "attach")) {
118 		char *driver, *offset, *mask;
119 
120 		if (argc != 5 && argc != 6)
121 			usage();
122 
123 		driver = argv[2];
124 		offset = argv[3];
125 		mask = argv[4];
126 		flags = argc == 6 ? argv[5] : NULL;
127 
128 		ga_offset = strtonum(offset, 0, INT_MAX, &errstr);
129 		if (errstr)
130 			errx(EXIT_FAILURE, "offset is %s: %s", errstr, offset);
131 		lval = strtol(mask, &ep, 0);
132 		if (*mask == '\0' || *ep != '\0')
133 			errx(EXIT_FAILURE, "invalid mask (not a number)");
134 		if ((errno == ERANGE && (lval == LONG_MAX
135 		    || lval == LONG_MIN)) || (unsigned long)lval > UINT_MAX)
136 			errx(EXIT_FAILURE, "mask out of range");
137 		ga_mask = lval;
138 		if (flags != NULL) {
139 			lval = strtol(flags, &ep, 0);
140 			if (*flags == '\0' || *ep != '\0')
141 				errx(EXIT_FAILURE,
142 				    "invalid flag locator (not a number)");
143 			if ((errno == ERANGE && (lval == LONG_MAX
144 			    || lval == LONG_MIN))
145 			    || (unsigned long)lval > UINT_MAX)
146 				errx(EXIT_FAILURE, "flag locator out of range");
147 
148 			ga_flags = lval;
149 		}
150 		devattach(driver, ga_offset, ga_mask, ga_flags);
151 		return EXIT_SUCCESS;
152 	} else {
153 		char *nm = NULL;
154 
155 		/* expecting a pin number or name */
156 		pin = strtonum(argv[1], 0, INT_MAX, &errstr);
157 		if (errstr)
158 			nm = argv[1];	/* try named pin */
159 		if (argc > 2) {
160 			if (!strcmp(argv[2], "set")) {
161 				for (n = 3; n < argc; n++) {
162 					for (bs = pinflags; bs->string != NULL;
163 					     bs++) {
164 						if (!strcmp(argv[n],
165 						    bs->string)) {
166 							fl |= bs->mask;
167 							break;
168 						}
169 					}
170 					if (bs->string == NULL)
171 						nam = argv[n];
172 				}
173 				gpioset(pin, nm, fl, nam);
174 			} else if (!strcmp(argv[2], "unset"))
175 				gpiounset(pin, nm);
176 			else {
177 				value = strtonum(argv[2], INT_MIN, INT_MAX,
178 				   &errstr);
179 				if (errstr) {
180 					if (!strcmp(argv[2], "on"))
181 						value = GPIO_PIN_HIGH;
182 					else if (!strcmp(argv[2], "off"))
183 						value = GPIO_PIN_LOW;
184 					else if (!strcmp(argv[2], "toggle"))
185 						value = 2;
186 					else
187 						errx(EXIT_FAILURE,
188 						    "%s: invalid value",
189 						    argv[2]);
190 				}
191 				gpiowrite(pin, nm, value);
192 			}
193 		} else
194 			gpioread(pin, nm);
195 	}
196 	return EXIT_SUCCESS;
197 }
198 
199 static void
200 getinfo(void)
201 {
202 	struct gpio_info info;
203 
204 	if (ioctl(devfd, GPIOINFO, &info) == -1)
205 		err(EXIT_FAILURE, "GPIOINFO");
206 
207 	if (state)
208 		printf("%d\n", info.gpio_npins);
209 
210 	if (quiet)
211 		return;
212 
213 	printf("%s: %d pins\n", dev, info.gpio_npins);
214 }
215 
216 static void
217 gpioread(int pin, char *gp_name)
218 {
219 	struct gpio_req req;
220 
221 	memset(&req, 0, sizeof(req));
222 	if (gp_name != NULL)
223 		strlcpy(req.gp_name, gp_name, sizeof(req.gp_name));
224 	else
225 		req.gp_pin = pin;
226 
227 	if (ioctl(devfd, GPIOREAD, &req) == -1)
228 		err(EXIT_FAILURE, "GPIOREAD");
229 
230 	if (state)
231 		printf("%d\n", req.gp_value);
232 
233 	if (quiet)
234 		return;
235 
236 	if (gp_name)
237 		printf("pin %s: state %d\n", gp_name, req.gp_value);
238 	else
239 		printf("pin %d: state %d\n", pin, req.gp_value);
240 }
241 
242 static void
243 gpiowrite(int pin, char *gp_name, int value)
244 {
245 	struct gpio_req req;
246 
247 	if (value < 0 || value > 2)
248 		errx(EXIT_FAILURE, "%d: invalid value", value);
249 
250 	memset(&req, 0, sizeof(req));
251 	if (gp_name != NULL)
252 		strlcpy(req.gp_name, gp_name, sizeof(req.gp_name));
253 	else
254 		req.gp_pin = pin;
255 
256 	if (value == GPIO_PIN_HIGH || value == GPIO_PIN_LOW) {
257 		req.gp_value = value;
258 		if (ioctl(devfd, GPIOWRITE, &req) == -1)
259 			err(EXIT_FAILURE, "GPIOWRITE");
260 	} else {
261 		if (ioctl(devfd, GPIOTOGGLE, &req) == -1)
262 			err(EXIT_FAILURE, "GPIOTOGGLE");
263 	}
264 
265 	if (state)
266 		printf("%d\n", value < 2 ? value : 1 - req.gp_value);
267 
268 	if (quiet)
269 		return;
270 
271 	if (gp_name)
272 		printf("pin %s: state %d -> %d\n", gp_name, req.gp_value,
273 		    (value < 2 ? value : 1 - req.gp_value));
274 	else
275 		printf("pin %d: state %d -> %d\n", pin, req.gp_value,
276 		    (value < 2 ? value : 1 - req.gp_value));
277 }
278 
279 static void
280 gpioset(int pin, char *name, int fl, char *alias)
281 {
282 	struct gpio_set set;
283 	const struct bitstr *bs;
284 
285 	memset(&set, 0, sizeof(set));
286 	if (name != NULL)
287 		strlcpy(set.gp_name, name, sizeof(set.gp_name));
288 	else
289 		set.gp_pin = pin;
290 	set.gp_flags = fl;
291 
292 	if (alias != NULL)
293 		strlcpy(set.gp_name2, alias, sizeof(set.gp_name2));
294 
295 	if (ioctl(devfd, GPIOSET, &set) == -1)
296 		err(EXIT_FAILURE, "GPIOSET");
297 
298 	if (quiet)
299 		return;
300 
301 	if (name != NULL)
302 		printf("pin %s: caps:", name);
303 	else
304 		printf("pin %d: caps:", pin);
305 	for (bs = pinflags; bs->string != NULL; bs++)
306 		if (set.gp_caps & bs->mask)
307 			printf(" %s", bs->string);
308 	printf(", flags:");
309 	for (bs = pinflags; bs->string != NULL; bs++)
310 		if (set.gp_flags & bs->mask)
311 			printf(" %s", bs->string);
312 	if (fl > 0) {
313 		printf(" ->");
314 		for (bs = pinflags; bs->string != NULL; bs++)
315 			if (fl & bs->mask)
316 				printf(" %s", bs->string);
317 	}
318 	printf("\n");
319 }
320 
321 static void
322 gpiounset(int pin, char *name)
323 {
324 	struct gpio_set set;
325 
326 	memset(&set, 0, sizeof(set));
327 	if (name != NULL)
328 		strlcpy(set.gp_name, name, sizeof(set.gp_name));
329 	else
330 		set.gp_pin = pin;
331 
332 	if (ioctl(devfd, GPIOUNSET, &set) == -1)
333 		err(EXIT_FAILURE, "GPIOUNSET");
334 }
335 
336 static void
337 devattach(char *dvname, int offset, uint32_t mask, uint32_t flags)
338 {
339 	struct gpio_attach attach;
340 
341 	memset(&attach, 0, sizeof(attach));
342 	strlcpy(attach.ga_dvname, dvname, sizeof(attach.ga_dvname));
343 	attach.ga_offset = offset;
344 	attach.ga_mask = mask;
345 	attach.ga_flags = flags;
346 	if (ioctl(devfd, GPIOATTACH, &attach) == -1)
347 		err(EXIT_FAILURE, "GPIOATTACH");
348 }
349 
350 static void
351 usage(void)
352 {
353 	const char *progname;
354 
355 	progname = getprogname();
356 	fprintf(stderr, "usage: %s [-qs] device [pin] [0 | 1 | 2 | "
357 	    "on | off | toggle]\n", progname);
358 	fprintf(stderr, "       %s [-q] device pin set [flags] [name]\n",
359 	    progname);
360 	fprintf(stderr, "       %s [-q] device pin unset\n", progname);
361 	fprintf(stderr, "       %s [-q] device attach device offset mask "
362 	    "[flag]\n",
363 	    progname);
364 
365 	exit(EXIT_FAILURE);
366 }
367