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