3 * Set-UID command-line interface to the Raspberry Pi's GPIO
4 * Copyright (c) 2012 Gordon Henderson
5 ***********************************************************************
6 * This file is part of wiringPi:
7 * https://projects.drogon.net/raspberry-pi/wiringpi/
9 * wiringPi is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * wiringPi is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with wiringPi. If not, see <http://www.gnu.org/licenses/>.
21 ***********************************************************************
32 #include <sys/types.h>
44 char *usage = "Usage: gpio -v\n"
46 " gpio [-g] <read/write/pwm/mode> ...\n"
47 " gpio [-p] <read/write/mode> ...\n"
48 " gpio export/edge/unexport/unexportall/exports ...\n"
49 " gpio drive <group> <value>\n"
50 " gpio load spi/i2c" ;
55 * Change the ownership of the file to the real userId of the calling
56 * program so we can access it.
57 *********************************************************************************
60 static void changeOwner (char *cmd, char *file)
62 uid_t uid = getuid () ;
63 uid_t gid = getgid () ;
65 if (chown (file, uid, gid) != 0)
67 if (errno == ENOENT) // Warn that it's not there
68 fprintf (stderr, "%s: Warning: File not present: %s\n", cmd, file) ;
71 fprintf (stderr, "%s: Unable to change ownership of %s: %s\n", cmd, file, strerror (errno)) ;
80 * Return true/false if the supplied module is loaded
81 *********************************************************************************
84 static int moduleLoaded (char *modName)
86 int len = strlen (modName) ;
88 FILE *fd = fopen ("/proc/modules", "r") ;
93 fprintf (stderr, "gpio: Unable to check modules: %s\n", strerror (errno)) ;
97 while (fgets (line, 80, fd) != NULL)
99 if (strncmp (line, modName, len) != 0)
114 * Load either the spi or i2c modules and change device ownerships, etc.
115 *********************************************************************************
118 static void _doLoadUsage (char *argv [])
120 fprintf (stderr, "Usage: %s load <spi/i2c>\n", argv [0]) ;
124 static void doLoad (int argc, char *argv [])
128 char *file1, *file2 ;
131 _doLoadUsage (argv) ;
133 /**/ if (strcasecmp (argv [2], "spi") == 0)
135 module = "spi_bcm2708" ;
136 file1 = "/dev/spidev0.0" ;
137 file2 = "/dev/spidev0.1" ;
139 else if (strcasecmp (argv [2], "i2c") == 0)
141 module = "i2c_bcm2708" ;
142 file1 = "/dev/i2c-0" ;
143 file2 = "/dev/i2c-1" ;
146 _doLoadUsage (argv) ;
148 if (!moduleLoaded (module))
150 sprintf (cmd, "modprobe %s", module) ;
154 if (!moduleLoaded (module))
156 fprintf (stderr, "%s: Unable to load %s\n", argv [0], module) ;
160 sleep (1) ; // To let things get settled
162 changeOwner (argv [0], file1) ;
163 changeOwner (argv [0], file2) ;
170 * List all GPIO exports
171 *********************************************************************************
174 static void doExports (int argc, char *argv [])
181 // Rather crude, but who knows what others are up to...
183 for (first = 0, i = 0 ; i < 64 ; ++i)
186 // Try to read the direction
188 sprintf (fName, "/sys/class/gpio/gpio%d/direction", i) ;
189 if ((fd = open (fName, O_RDONLY)) == -1)
195 printf ("GPIO Pins exported:\n") ;
198 printf ("%4d: ", i) ;
200 if ((l = read (fd, buf, 16)) == 0)
201 sprintf (buf, "%s", "?") ;
204 if ((buf [strlen (buf) - 1]) == '\n')
205 buf [strlen (buf) - 1] = 0 ;
207 printf ("%-3s", buf) ;
211 // Try to Read the value
213 sprintf (fName, "/sys/class/gpio/gpio%d/value", i) ;
214 if ((fd = open (fName, O_RDONLY)) == -1)
216 printf ("No Value file (huh?)\n") ;
220 if ((l = read (fd, buf, 16)) == 0)
221 sprintf (buf, "%s", "?") ;
224 if ((buf [strlen (buf) - 1]) == '\n')
225 buf [strlen (buf) - 1] = 0 ;
227 printf (" %s", buf) ;
229 // Read any edge trigger file
231 sprintf (fName, "/sys/class/gpio/gpio%d/edge", i) ;
232 if ((fd = open (fName, O_RDONLY)) == -1)
238 if ((l = read (fd, buf, 16)) == 0)
239 sprintf (buf, "%s", "?") ;
242 if ((buf [strlen (buf) - 1]) == '\n')
243 buf [strlen (buf) - 1] = 0 ;
245 printf (" %-8s\n", buf) ;
254 * gpio export pin mode
255 * This uses the /sys/class/gpio device interface.
256 *********************************************************************************
259 void doExport (int argc, char *argv [])
268 fprintf (stderr, "Usage: %s export pin mode\n", argv [0]) ;
272 pin = atoi (argv [2]) ;
276 if ((fd = fopen ("/sys/class/gpio/export", "w")) == NULL)
278 fprintf (stderr, "%s: Unable to open GPIO export interface: %s\n", argv [0], strerror (errno)) ;
282 fprintf (fd, "%d\n", pin) ;
285 sprintf (fName, "/sys/class/gpio/gpio%d/direction", pin) ;
286 if ((fd = fopen (fName, "w")) == NULL)
288 fprintf (stderr, "%s: Unable to open GPIO direction interface for pin %d: %s\n", argv [0], pin, strerror (errno)) ;
292 /**/ if ((strcasecmp (mode, "in") == 0) || (strcasecmp (mode, "input") == 0))
293 fprintf (fd, "in\n") ;
294 else if ((strcasecmp (mode, "out") == 0) || (strcasecmp (mode, "output") == 0))
295 fprintf (fd, "out\n") ;
298 fprintf (stderr, "%s: Invalid mode: %s. Should be in or out\n", argv [1], mode) ;
304 // Change ownership so the current user can actually use it!
306 sprintf (fName, "/sys/class/gpio/gpio%d/value", pin) ;
307 changeOwner (argv [0], fName) ;
309 sprintf (fName, "/sys/class/gpio/gpio%d/edge", pin) ;
310 changeOwner (argv [0], fName) ;
318 * Easy access to changing the edge trigger on a GPIO pin
319 * This uses the /sys/class/gpio device interface.
320 *********************************************************************************
323 void doEdge (int argc, char *argv [])
332 fprintf (stderr, "Usage: %s edge pin mode\n", argv [0]) ;
336 pin = atoi (argv [2]) ;
339 // Export the pin and set direction to input
341 if ((fd = fopen ("/sys/class/gpio/export", "w")) == NULL)
343 fprintf (stderr, "%s: Unable to open GPIO export interface: %s\n", argv [0], strerror (errno)) ;
347 fprintf (fd, "%d\n", pin) ;
350 sprintf (fName, "/sys/class/gpio/gpio%d/direction", pin) ;
351 if ((fd = fopen (fName, "w")) == NULL)
353 fprintf (stderr, "%s: Unable to open GPIO direction interface for pin %d: %s\n", argv [0], pin, strerror (errno)) ;
357 fprintf (fd, "in\n") ;
360 sprintf (fName, "/sys/class/gpio/gpio%d/edge", pin) ;
361 if ((fd = fopen (fName, "w")) == NULL)
363 fprintf (stderr, "%s: Unable to open GPIO edge interface for pin %d: %s\n", argv [0], pin, strerror (errno)) ;
367 /**/ if (strcasecmp (mode, "none") == 0) fprintf (fd, "none\n") ;
368 else if (strcasecmp (mode, "rising") == 0) fprintf (fd, "rising\n") ;
369 else if (strcasecmp (mode, "falling") == 0) fprintf (fd, "falling\n") ;
370 else if (strcasecmp (mode, "both") == 0) fprintf (fd, "both\n") ;
373 fprintf (stderr, "%s: Invalid mode: %s. Should be none, rising, falling or both\n", argv [1], mode) ;
377 // Change ownership of the value and edge files, so the current user can actually use it!
379 sprintf (fName, "/sys/class/gpio/gpio%d/value", pin) ;
380 changeOwner (argv [0], fName) ;
382 sprintf (fName, "/sys/class/gpio/gpio%d/edge", pin) ;
383 changeOwner (argv [0], fName) ;
392 * This uses the /sys/class/gpio device interface.
393 *********************************************************************************
396 void doUnexport (int argc, char *argv [])
403 fprintf (stderr, "Usage: %s unexport pin\n", argv [0]) ;
407 pin = atoi (argv [2]) ;
409 if ((fd = fopen ("/sys/class/gpio/unexport", "w")) == NULL)
411 fprintf (stderr, "%s: Unable to open GPIO export interface\n", argv [0]) ;
415 fprintf (fd, "%d\n", pin) ;
423 * Un-Export all the GPIO pins.
424 * This uses the /sys/class/gpio device interface.
425 *********************************************************************************
428 void doUnexportall (int argc, char *argv [])
433 for (pin = 0 ; pin < 63 ; ++pin)
435 if ((fd = fopen ("/sys/class/gpio/unexport", "w")) == NULL)
437 fprintf (stderr, "%s: Unable to open GPIO export interface\n", argv [0]) ;
440 fprintf (fd, "%d\n", pin) ;
448 * gpio mode pin mode ...
449 *********************************************************************************
452 void doMode (int argc, char *argv [])
459 fprintf (stderr, "Usage: %s mode pin mode\n", argv [0]) ;
463 pin = atoi (argv [2]) ;
465 if ((wpMode == WPI_MODE_PINS) && ((pin < 0) || (pin >= NUM_PINS)))
470 /**/ if (strcasecmp (mode, "in") == 0) pinMode (pin, INPUT) ;
471 else if (strcasecmp (mode, "out") == 0) pinMode (pin, OUTPUT) ;
472 else if (strcasecmp (mode, "pwm") == 0) pinMode (pin, PWM_OUTPUT) ;
473 else if (strcasecmp (mode, "up") == 0) pullUpDnControl (pin, PUD_UP) ;
474 else if (strcasecmp (mode, "down") == 0) pullUpDnControl (pin, PUD_DOWN) ;
475 else if (strcasecmp (mode, "tri") == 0) pullUpDnControl (pin, PUD_OFF) ;
478 fprintf (stderr, "%s: Invalid mode: %s. Should be in/out/pwm/up/down/tri\n", argv [1], mode) ;
486 * gpio drive group value
487 *********************************************************************************
490 void doPadDrive (int argc, char *argv [])
496 fprintf (stderr, "Usage: %s drive group value\n", argv [0]) ;
500 group = atoi (argv [2]) ;
501 val = atoi (argv [3]) ;
503 if ((group < 0) || (group > 2))
505 fprintf (stderr, "%s: drive group not 0, 1 or 2: %d\n", argv [0], group) ;
509 if ((val < 0) || (val > 7))
511 fprintf (stderr, "%s: drive value not 0-7: %d\n", argv [0], val) ;
515 setPadDrive (group, val) ;
521 * gpio write pin value
522 *********************************************************************************
525 void doWrite (int argc, char *argv [])
531 fprintf (stderr, "Usage: %s write pin value\n", argv [0]) ;
535 pin = atoi (argv [2]) ;
537 if ((wpMode == WPI_MODE_PINS) && ((pin < 0) || (pin >= NUM_PINS)))
540 val = atoi (argv [3]) ;
543 digitalWrite (pin, LOW) ;
545 digitalWrite (pin, HIGH) ;
551 * Read a pin and return the value
552 *********************************************************************************
555 void doRead (int argc, char *argv [])
561 fprintf (stderr, "Usage: %s read pin\n", argv [0]) ;
565 pin = atoi (argv [2]) ;
567 if ((wpMode == WPI_MODE_PINS) && ((pin < 0) || (pin >= NUM_PINS)))
573 val = digitalRead (pin) ;
575 printf ("%s\n", val == 0 ? "0" : "1") ;
581 * Output a PWM value on a pin
582 *********************************************************************************
585 void doPwm (int argc, char *argv [])
591 fprintf (stderr, "Usage: %s pwm <pin> <value>\n", argv [0]) ;
595 pin = atoi (argv [2]) ;
597 if ((wpMode == WPI_MODE_PINS) && ((pin < 0) || (pin >= NUM_PINS)))
600 val = atoi (argv [3]) ;
602 pwmWrite (pin, val) ;
609 *********************************************************************************
612 int main (int argc, char *argv [])
618 fprintf (stderr, "%s: %s\n", argv [0], usage) ;
622 if (strcasecmp (argv [1], "-h") == 0)
624 printf ("%s: %s\n", argv [0], usage) ;
628 if (strcasecmp (argv [1], "-v") == 0)
630 printf ("gpio version: %s\n", VERSION) ;
631 printf ("Copyright (c) 2012 Gordon Henderson\n") ;
632 printf ("This is free software with ABSOLUTELY NO WARRANTY.\n") ;
633 printf ("For details type: %s -warranty\n", argv [0]) ;
637 if (strcasecmp (argv [1], "-warranty") == 0)
639 printf ("gpio version: %s\n", VERSION) ;
640 printf ("Copyright (c) 2012 Gordon Henderson\n") ;
642 printf (" This program is free software; you can redistribute it and/or modify\n") ;
643 printf (" it under the terms of the GNU Leser General Public License as published\n") ;
644 printf (" by the Free Software Foundation, either version 3 of the License, or\n") ;
645 printf (" (at your option) any later version.\n") ;
647 printf (" This program is distributed in the hope that it will be useful,\n") ;
648 printf (" but WITHOUT ANY WARRANTY; without even the implied warranty of\n") ;
649 printf (" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n") ;
650 printf (" GNU Lesser General Public License for more details.\n") ;
652 printf (" You should have received a copy of the GNU Lesser General Public License\n") ;
653 printf (" along with this program. If not, see <http://www.gnu.org/licenses/>.\n") ;
660 fprintf (stderr, "%s: Must be root to run. Program should be suid root. This is an error.\n", argv [0]) ;
664 // Initial test for /sys/class/gpio operations:
666 /**/ if (strcasecmp (argv [1], "exports" ) == 0) { doExports (argc, argv) ; return 0 ; }
667 else if (strcasecmp (argv [1], "export" ) == 0) { doExport (argc, argv) ; return 0 ; }
668 else if (strcasecmp (argv [1], "edge" ) == 0) { doEdge (argc, argv) ; return 0 ; }
669 else if (strcasecmp (argv [1], "unexportall") == 0) { doUnexportall (argc, argv) ; return 0 ; }
670 else if (strcasecmp (argv [1], "unexport" ) == 0) { doUnexport (argc, argv) ; return 0 ; }
672 // Check for drive or load commands:
674 if (strcasecmp (argv [1], "drive") == 0) { doPadDrive (argc, argv) ; return 0 ; }
675 if (strcasecmp (argv [1], "load" ) == 0) { doLoad (argc, argv) ; return 0 ; }
677 // Check for -g argument
679 if (strcasecmp (argv [1], "-g") == 0)
681 if (wiringPiSetupGpio () == -1)
683 fprintf (stderr, "%s: Unable to initialise GPIO mode.\n", argv [0]) ;
687 for (i = 2 ; i < argc ; ++i)
688 argv [i - 1] = argv [i] ;
690 wpMode = WPI_MODE_GPIO ;
693 // Check for -p argument for PiFace
695 else if (strcasecmp (argv [1], "-p") == 0)
697 if (wiringPiSetupPiFaceForGpioProg () == -1)
699 fprintf (stderr, "%s: Unable to initialise PiFace.\n", argv [0]) ;
703 for (i = 2 ; i < argc ; ++i)
704 argv [i - 1] = argv [i] ;
706 wpMode = WPI_MODE_PIFACE ;
709 // Default to wiringPi mode
713 if (wiringPiSetup () == -1)
715 fprintf (stderr, "%s: Unable to initialise wiringPi mode\n", argv [0]) ;
718 wpMode = WPI_MODE_PINS ;
721 // Check for wiring commands
723 /**/ if (strcasecmp (argv [1], "read" ) == 0) doRead (argc, argv) ;
724 else if (strcasecmp (argv [1], "write") == 0) doWrite (argc, argv) ;
725 else if (strcasecmp (argv [1], "pwm" ) == 0) doPwm (argc, argv) ;
726 else if (strcasecmp (argv [1], "mode" ) == 0) doMode (argc, argv) ;
729 fprintf (stderr, "%s: Unknown command: %s.\n", argv [0], argv [1]) ;