xref: /netbsd-src/usr.sbin/gpioctl/gpioctl.c (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1 /* $NetBSD: gpioctl.c,v 1.20 2013/05/19 15:31:23 mbalmer 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 extern long long strtonum(const char *numstr, long long minval,
53     long long maxval, const char **errstrp);
54 
55 static const struct bitstr {
56 	unsigned int mask;
57 	const char *string;
58 } pinflags[] = {
59 	{ GPIO_PIN_INPUT, "in" },
60 	{ GPIO_PIN_OUTPUT, "out" },
61 	{ GPIO_PIN_INOUT, "inout" },
62 	{ GPIO_PIN_OPENDRAIN, "od" },
63 	{ GPIO_PIN_PUSHPULL, "pp" },
64 	{ GPIO_PIN_TRISTATE, "tri" },
65 	{ GPIO_PIN_PULLUP, "pu" },
66 	{ GPIO_PIN_PULLDOWN, "pd" },
67 	{ GPIO_PIN_INVIN, "iin" },
68 	{ GPIO_PIN_INVOUT, "iout" },
69 	{ GPIO_PIN_PULSATE, "pulsate" },
70 	{ 0, NULL },
71 };
72 
73 int
74 main(int argc, char *argv[])
75 {
76 	const struct bitstr *bs;
77 	int pin, ch, n, fl = 0, value = 0;
78 	const char *errstr;
79 	char *ep;
80 	int ga_offset = -1;
81 	uint32_t ga_mask = 0;
82 	uint32_t ga_flags = 0;
83 	long lval;
84 	char *nam = NULL;
85 	char *flags;
86 	char devn[32];
87 
88 	while ((ch = getopt(argc, argv, "qs")) != -1)
89 		switch (ch) {
90 		case 'q':
91 			quiet = 1;
92 			break;
93 		case 's':
94 			quiet = state = 1;
95 			break;
96 		default:
97 			usage();
98 			/* NOTREACHED */
99 		}
100 	argc -= optind;
101 	argv += optind;
102 
103 	if (argc < 1)
104 		usage();
105 	dev = argv[0];
106 
107 	if (strncmp(_PATH_DEV, dev, sizeof(_PATH_DEV) - 1)) {
108 		(void)snprintf(devn, sizeof(devn), "%s%s", _PATH_DEV, dev);
109 		dev = devn;
110 	}
111 
112 	if ((devfd = open(dev, O_RDWR)) == -1)
113 		err(EXIT_FAILURE, "%s", dev);
114 
115 	if (argc == 1) {
116 		getinfo();
117 		return EXIT_SUCCESS;
118 	}
119 
120 	if (!strcmp(argv[1], "attach")) {
121 		char *driver, *offset, *mask;
122 
123 		if (argc != 5 && argc != 6)
124 			usage();
125 
126 		driver = argv[2];
127 		offset = argv[3];
128 		mask = argv[4];
129 		flags = argc == 6 ? argv[5] : NULL;
130 
131 		ga_offset = strtonum(offset, 0, INT_MAX, &errstr);
132 		if (errstr)
133 			errx(EXIT_FAILURE, "offset is %s: %s", errstr, offset);
134 		lval = strtol(mask, &ep, 0);
135 		if (*mask == '\0' || *ep != '\0')
136 			errx(EXIT_FAILURE, "invalid mask (not a number)");
137 		if ((errno == ERANGE && (lval == LONG_MAX
138 		    || lval == LONG_MIN)) || (unsigned long)lval > UINT_MAX)
139 			errx(EXIT_FAILURE, "mask out of range");
140 		ga_mask = lval;
141 		if (flags != NULL) {
142 			lval = strtol(flags, &ep, 0);
143 			if (*flags == '\0' || *ep != '\0')
144 				errx(EXIT_FAILURE,
145 				    "invalid flag locator (not a number)");
146 			if ((errno == ERANGE && (lval == LONG_MAX
147 			    || lval == LONG_MIN))
148 			    || (unsigned long)lval > UINT_MAX)
149 				errx(EXIT_FAILURE, "flag locator out of range");
150 
151 			ga_flags = lval;
152 		}
153 		devattach(driver, ga_offset, ga_mask, ga_flags);
154 		return EXIT_SUCCESS;
155 	} else {
156 		char *nm = NULL;
157 
158 		/* expecting a pin number or name */
159 		pin = strtonum(argv[1], 0, INT_MAX, &errstr);
160 		if (errstr)
161 			nm = argv[1];	/* try named pin */
162 		if (argc > 2) {
163 			if (!strcmp(argv[2], "set")) {
164 				for (n = 3; n < argc; n++) {
165 					for (bs = pinflags; bs->string != NULL;
166 					     bs++) {
167 						if (!strcmp(argv[n],
168 						    bs->string)) {
169 							fl |= bs->mask;
170 							break;
171 						}
172 					}
173 					if (bs->string == NULL)
174 						nam = argv[n];
175 				}
176 				gpioset(pin, nm, fl, nam);
177 			} else if (!strcmp(argv[2], "unset"))
178 				gpiounset(pin, nm);
179 			else {
180 				value = strtonum(argv[2], INT_MIN, INT_MAX,
181 				   &errstr);
182 				if (errstr) {
183 					if (!strcmp(argv[2], "on"))
184 						value = GPIO_PIN_HIGH;
185 					else if (!strcmp(argv[2], "off"))
186 						value = GPIO_PIN_LOW;
187 					else if (!strcmp(argv[2], "toggle"))
188 						value = 2;
189 					else
190 						errx(EXIT_FAILURE,
191 						    "%s: invalid value",
192 						    argv[2]);
193 				}
194 				gpiowrite(pin, nm, value);
195 			}
196 		} else
197 			gpioread(pin, nm);
198 	}
199 	return EXIT_SUCCESS;
200 }
201 
202 static void
203 getinfo(void)
204 {
205 	struct gpio_info info;
206 
207 	if (ioctl(devfd, GPIOINFO, &info) == -1)
208 		err(EXIT_FAILURE, "GPIOINFO");
209 
210 	if (state)
211 		printf("%d\n", info.gpio_npins);
212 
213 	if (quiet)
214 		return;
215 
216 	printf("%s: %d pins\n", dev, info.gpio_npins);
217 }
218 
219 static void
220 gpioread(int pin, char *gp_name)
221 {
222 	struct gpio_req req;
223 
224 	memset(&req, 0, sizeof(req));
225 	if (gp_name != NULL)
226 		strlcpy(req.gp_name, gp_name, sizeof(req.gp_name));
227 	else
228 		req.gp_pin = pin;
229 
230 	if (ioctl(devfd, GPIOREAD, &req) == -1)
231 		err(EXIT_FAILURE, "GPIOREAD");
232 
233 	if (state)
234 		printf("%d\n", req.gp_value);
235 
236 	if (quiet)
237 		return;
238 
239 	if (gp_name)
240 		printf("pin %s: state %d\n", gp_name, req.gp_value);
241 	else
242 		printf("pin %d: state %d\n", pin, req.gp_value);
243 }
244 
245 static void
246 gpiowrite(int pin, char *gp_name, int value)
247 {
248 	struct gpio_req req;
249 
250 	if (value < 0 || value > 2)
251 		errx(EXIT_FAILURE, "%d: invalid value", value);
252 
253 	memset(&req, 0, sizeof(req));
254 	if (gp_name != NULL)
255 		strlcpy(req.gp_name, gp_name, sizeof(req.gp_name));
256 	else
257 		req.gp_pin = pin;
258 
259 	if (value == GPIO_PIN_HIGH || value == GPIO_PIN_LOW) {
260 		req.gp_value = value;
261 		if (ioctl(devfd, GPIOWRITE, &req) == -1)
262 			err(EXIT_FAILURE, "GPIOWRITE");
263 	} else {
264 		if (ioctl(devfd, GPIOTOGGLE, &req) == -1)
265 			err(EXIT_FAILURE, "GPIOTOGGLE");
266 	}
267 
268 	if (state)
269 		printf("%d\n", value < 2 ? value : 1 - req.gp_value);
270 
271 	if (quiet)
272 		return;
273 
274 	if (gp_name)
275 		printf("pin %s: state %d -> %d\n", gp_name, req.gp_value,
276 		    (value < 2 ? value : 1 - req.gp_value));
277 	else
278 		printf("pin %d: state %d -> %d\n", pin, req.gp_value,
279 		    (value < 2 ? value : 1 - req.gp_value));
280 }
281 
282 static void
283 gpioset(int pin, char *name, int fl, char *alias)
284 {
285 	struct gpio_set set;
286 	const struct bitstr *bs;
287 
288 	memset(&set, 0, sizeof(set));
289 	if (name != NULL)
290 		strlcpy(set.gp_name, name, sizeof(set.gp_name));
291 	else
292 		set.gp_pin = pin;
293 	set.gp_flags = fl;
294 
295 	if (alias != NULL)
296 		strlcpy(set.gp_name2, alias, sizeof(set.gp_name2));
297 
298 	if (ioctl(devfd, GPIOSET, &set) == -1)
299 		err(EXIT_FAILURE, "GPIOSET");
300 
301 	if (quiet)
302 		return;
303 
304 	if (name != NULL)
305 		printf("pin %s: caps:", name);
306 	else
307 		printf("pin %d: caps:", pin);
308 	for (bs = pinflags; bs->string != NULL; bs++)
309 		if (set.gp_caps & bs->mask)
310 			printf(" %s", bs->string);
311 	printf(", flags:");
312 	for (bs = pinflags; bs->string != NULL; bs++)
313 		if (set.gp_flags & bs->mask)
314 			printf(" %s", bs->string);
315 	if (fl > 0) {
316 		printf(" ->");
317 		for (bs = pinflags; bs->string != NULL; bs++)
318 			if (fl & bs->mask)
319 				printf(" %s", bs->string);
320 	}
321 	printf("\n");
322 }
323 
324 static void
325 gpiounset(int pin, char *name)
326 {
327 	struct gpio_set set;
328 
329 	memset(&set, 0, sizeof(set));
330 	if (name != NULL)
331 		strlcpy(set.gp_name, name, sizeof(set.gp_name));
332 	else
333 		set.gp_pin = pin;
334 
335 	if (ioctl(devfd, GPIOUNSET, &set) == -1)
336 		err(EXIT_FAILURE, "GPIOUNSET");
337 }
338 
339 static void
340 devattach(char *dvname, int offset, uint32_t mask, uint32_t flags)
341 {
342 	struct gpio_attach attach;
343 
344 	memset(&attach, 0, sizeof(attach));
345 	strlcpy(attach.ga_dvname, dvname, sizeof(attach.ga_dvname));
346 	attach.ga_offset = offset;
347 	attach.ga_mask = mask;
348 	attach.ga_flags = flags;
349 	if (ioctl(devfd, GPIOATTACH, &attach) == -1)
350 		err(EXIT_FAILURE, "GPIOATTACH");
351 }
352 
353 static void
354 usage(void)
355 {
356 	const char *progname;
357 
358 	progname = getprogname();
359 	fprintf(stderr, "usage: %s [-qs] device [pin] [0 | 1 | 2 | "
360 	    "on | off | toggle]\n", progname);
361 	fprintf(stderr, "       %s [-q] device pin set [flags] [name]\n",
362 	    progname);
363 	fprintf(stderr, "       %s [-q] device pin unset\n", progname);
364 	fprintf(stderr, "       %s [-q] device attach device offset mask "
365 	    "[flag]\n",
366 	    progname);
367 
368 	exit(EXIT_FAILURE);
369 }
370