1 /* $NetBSD: gpioctl.c,v 1.28 2022/12/13 21:47:36 jakllsch 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 #include <sys/cdefs.h> 20 __RCSID("$NetBSD: gpioctl.c,v 1.28 2022/12/13 21:47:36 jakllsch Exp $"); 21 22 /* 23 * Program to control GPIO devices. 24 */ 25 26 #include <sys/types.h> 27 #include <sys/gpio.h> 28 #include <sys/ioctl.h> 29 30 #include <err.h> 31 #include <errno.h> 32 #include <fcntl.h> 33 #include <limits.h> 34 #include <paths.h> 35 #include <stdio.h> 36 #include <stdlib.h> 37 #include <time.h> 38 #include <string.h> 39 #include <unistd.h> 40 41 static char *dev; 42 static int devfd = -1; 43 static int quiet = 0; 44 static int state = 0; 45 46 static void getinfo(void); 47 static void gpioread(int, char *); 48 static void gpiowrite(int, char *, int); 49 static void gpioset(int pin, char *name, int flags, char *alias); 50 static void gpiounset(int pin, char *name); 51 static void gpiolist(void); 52 static void devattach(char *, int, uint32_t, uint32_t); 53 __dead static void usage(void); 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 { GPIO_PIN_ALT0, "alt0" }, 71 { GPIO_PIN_ALT1, "alt1" }, 72 { GPIO_PIN_ALT2, "alt2" }, 73 { GPIO_PIN_ALT3, "alt3" }, 74 { GPIO_PIN_ALT4, "alt4" }, 75 { GPIO_PIN_ALT5, "alt5" }, 76 { GPIO_PIN_ALT6, "alt6" }, 77 { GPIO_PIN_ALT7, "alt7" }, 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 if (!strcmp(argv[1], "list")) { 165 gpiolist(); 166 return EXIT_SUCCESS; 167 } else { 168 char *nm = NULL; 169 170 /* expecting a pin number or name */ 171 pin = strtonum(argv[1], 0, INT_MAX, &errstr); 172 if (errstr) 173 nm = argv[1]; /* try named pin */ 174 if (argc > 2) { 175 if (!strcmp(argv[2], "set")) { 176 for (n = 3; n < argc; n++) { 177 for (bs = pinflags; bs->string != NULL; 178 bs++) { 179 if (!strcmp(argv[n], 180 bs->string)) { 181 fl |= bs->mask; 182 break; 183 } 184 } 185 if (bs->string == NULL) 186 nam = argv[n]; 187 } 188 gpioset(pin, nm, fl, nam); 189 } else if (!strcmp(argv[2], "unset")) 190 gpiounset(pin, nm); 191 else { 192 value = strtonum(argv[2], INT_MIN, INT_MAX, 193 &errstr); 194 if (errstr) { 195 if (!strcmp(argv[2], "on")) 196 value = GPIO_PIN_HIGH; 197 else if (!strcmp(argv[2], "off")) 198 value = GPIO_PIN_LOW; 199 else if (!strcmp(argv[2], "toggle")) 200 value = 2; 201 else 202 errx(EXIT_FAILURE, 203 "%s: invalid value", 204 argv[2]); 205 } 206 gpiowrite(pin, nm, value); 207 } 208 } else 209 gpioread(pin, nm); 210 } 211 return EXIT_SUCCESS; 212 } 213 214 static void 215 getinfo(void) 216 { 217 struct gpio_info info; 218 219 if (ioctl(devfd, GPIOINFO, &info) == -1) 220 err(EXIT_FAILURE, "GPIOINFO"); 221 222 if (state) 223 printf("%d\n", info.gpio_npins); 224 225 if (quiet) 226 return; 227 228 printf("%s: %d pins\n", dev, info.gpio_npins); 229 } 230 231 static void 232 gpioread(int pin, char *gp_name) 233 { 234 struct gpio_req req; 235 236 memset(&req, 0, sizeof(req)); 237 if (gp_name != NULL) 238 strlcpy(req.gp_name, gp_name, sizeof(req.gp_name)); 239 else 240 req.gp_pin = pin; 241 242 if (ioctl(devfd, GPIOREAD, &req) == -1) 243 err(EXIT_FAILURE, "GPIOREAD"); 244 245 if (state) 246 printf("%d\n", req.gp_value); 247 248 if (quiet) 249 return; 250 251 if (gp_name) 252 printf("pin %s: state %d\n", gp_name, req.gp_value); 253 else 254 printf("pin %d: state %d\n", pin, req.gp_value); 255 } 256 257 static void 258 gpiowrite(int pin, char *gp_name, int value) 259 { 260 struct gpio_req req; 261 262 if (value < 0 || value > 2) 263 errx(EXIT_FAILURE, "%d: invalid value", value); 264 265 memset(&req, 0, sizeof(req)); 266 if (gp_name != NULL) 267 strlcpy(req.gp_name, gp_name, sizeof(req.gp_name)); 268 else 269 req.gp_pin = pin; 270 271 if (value == GPIO_PIN_HIGH || value == GPIO_PIN_LOW) { 272 req.gp_value = value; 273 if (ioctl(devfd, GPIOWRITE, &req) == -1) 274 err(EXIT_FAILURE, "GPIOWRITE"); 275 } else { 276 if (ioctl(devfd, GPIOTOGGLE, &req) == -1) 277 err(EXIT_FAILURE, "GPIOTOGGLE"); 278 } 279 280 if (state) 281 printf("%d\n", value < 2 ? value : 1 - req.gp_value); 282 283 if (quiet) 284 return; 285 286 if (gp_name) 287 printf("pin %s: state %d -> %d\n", gp_name, req.gp_value, 288 (value < 2 ? value : 1 - req.gp_value)); 289 else 290 printf("pin %d: state %d -> %d\n", pin, req.gp_value, 291 (value < 2 ? value : 1 - req.gp_value)); 292 } 293 294 static void 295 gpioset(int pin, char *name, int fl, char *alias) 296 { 297 struct gpio_set set; 298 const struct bitstr *bs; 299 300 memset(&set, 0, sizeof(set)); 301 if (name != NULL) 302 strlcpy(set.gp_name, name, sizeof(set.gp_name)); 303 else 304 set.gp_pin = pin; 305 set.gp_flags = fl; 306 307 if (alias != NULL) 308 strlcpy(set.gp_name2, alias, sizeof(set.gp_name2)); 309 310 if (ioctl(devfd, GPIOSET, &set) == -1) 311 err(EXIT_FAILURE, "GPIOSET"); 312 313 if (quiet) 314 return; 315 316 if (name != NULL) 317 printf("pin %s: caps:", name); 318 else 319 printf("pin %d: caps:", pin); 320 for (bs = pinflags; bs->string != NULL; bs++) 321 if (set.gp_caps & bs->mask) 322 printf(" %s", bs->string); 323 printf(", flags:"); 324 for (bs = pinflags; bs->string != NULL; bs++) 325 if (set.gp_flags & bs->mask) 326 printf(" %s", bs->string); 327 if (fl > 0) { 328 printf(" ->"); 329 for (bs = pinflags; bs->string != NULL; bs++) 330 if (fl & bs->mask) 331 printf(" %s", bs->string); 332 } 333 printf("\n"); 334 } 335 336 static void 337 gpiounset(int pin, char *name) 338 { 339 struct gpio_set set; 340 341 memset(&set, 0, sizeof(set)); 342 if (name != NULL) 343 strlcpy(set.gp_name, name, sizeof(set.gp_name)); 344 else 345 set.gp_pin = pin; 346 347 if (ioctl(devfd, GPIOUNSET, &set) == -1) 348 err(EXIT_FAILURE, "GPIOUNSET"); 349 } 350 351 static void 352 gpiolist() 353 { 354 struct gpio_info info; 355 struct gpio_req req; 356 int i; 357 358 if (ioctl(devfd, GPIOINFO, &info) == -1) 359 err(EXIT_FAILURE, "GPIOINFO"); 360 361 for (i = 0; i < info.gpio_npins; i++) { 362 memset(&req, 0, sizeof(req)); 363 req.gp_pin = i; 364 if (ioctl(devfd, GPIOREAD, &req) == -1) 365 continue; 366 if (!quiet) 367 printf("%d: %s\n", i, req.gp_name); 368 } 369 } 370 371 static void 372 devattach(char *dvname, int offset, uint32_t mask, uint32_t flags) 373 { 374 struct gpio_attach attach; 375 376 memset(&attach, 0, sizeof(attach)); 377 strlcpy(attach.ga_dvname, dvname, sizeof(attach.ga_dvname)); 378 attach.ga_offset = offset; 379 attach.ga_mask = mask; 380 attach.ga_flags = flags; 381 if (ioctl(devfd, GPIOATTACH, &attach) == -1) 382 err(EXIT_FAILURE, "GPIOATTACH"); 383 } 384 385 static void 386 usage(void) 387 { 388 const char *progname; 389 390 progname = getprogname(); 391 fprintf(stderr, "usage: %s [-qs] device [pin] [0 | 1 | 2 | " 392 "on | off | toggle]\n", progname); 393 fprintf(stderr, " %s [-q] device pin set [flags] [name]\n", 394 progname); 395 fprintf(stderr, " %s [-q] device pin unset\n", progname); 396 fprintf(stderr, " %s [-q] device attach device offset mask " 397 "[flag]\n", 398 progname); 399 fprintf(stderr, " %s [-q] device list\n", progname); 400 401 exit(EXIT_FAILURE); 402 } 403