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