chiark / gitweb /
Added a clock mode to enable the GPIo pins to be set with
[wiringPi.git] / gpio / gpio.c
index 1d12aabf8ad782aa549a0b7ab3111840ee2e3907..6c0bf89a59f77af551dda8037f32e96bb0df8152 100644 (file)
@@ -1,6 +1,7 @@
 /*
  * gpio.c:
- *     Set-UID command-line interface to the Raspberry Pi's GPIO
+ *     Swiss-Army-Knife, Set-UID command-line interface to the Raspberry
+ *     Pi's GPIO.
  *     Copyright (c) 2012 Gordon Henderson
  ***********************************************************************
  * This file is part of wiringPi:
@@ -21,7 +22,6 @@
  ***********************************************************************
  */
 
-#include <wiringPi.h>
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <sys/types.h>
 #include <fcntl.h>
 
+#include <wiringPi.h>
+#include <gertboard.h>
+
+extern int wiringPiDebug ;
+
 #ifndef TRUE
 #  define      TRUE    (1==1)
 #  define      FALSE   (1==2)
 #endif
 
-#define        VERSION "1.1"
+#define        VERSION "1.11"
 
 static int wpMode ;
 
 char *usage = "Usage: gpio -v\n"
-              "       gpio [-g] <read/write/pwm/mode> ...\n"
-              "       gpio [-p] <read/write/mode> ...\n"
-             "       gpio export/edge/unexport/unexportall/exports ...\n"
+              "       gpio -h\n"
+              "       gpio [-g] <read/write/wb/pwm/clock/mode> ...\n"
+              "       gpio [-p] <read/write/wb> ...\n"
+             "       gpio readall\n"
+             "       gpio unexportall/exports ...\n"
+             "       gpio export/edge/unexport ...\n"
              "       gpio drive <group> <value>\n"
              "       gpio pwm-bal/pwm-ms \n"
              "       gpio pwmr <range> \n"
-             "       gpio load spi/i2c" ;
-
+             "       gpio pwmc <divider> \n"
+             "       gpio load spi/i2c\n"
+             "       gpio gbr <channel>\n"
+             "       gpio gbw <channel> <value>" ;     // No trailing newline needed here.
 
 
 /*
@@ -119,43 +129,62 @@ static int moduleLoaded (char *modName)
 
 static void _doLoadUsage (char *argv [])
 {
-  fprintf (stderr, "Usage: %s load <spi/i2c>\n", argv [0]) ;
+  fprintf (stderr, "Usage: %s load <spi/i2c> [SPI bufferSize in KB | I2C baudrate in Kb/sec]\n", argv [0]) ;
   exit (1) ;
 }
 
 static void doLoad (int argc, char *argv [])
 {
-  char *module ;
+  char *module1, *module2 ;
   char cmd [80] ;
   char *file1, *file2 ;
+  char args1 [32], args2 [32] ;
 
-  if (argc != 3)
+  if (argc < 3)
     _doLoadUsage (argv) ;
 
+  args1 [0] = args2 [0] = 0 ;
+
   /**/ if (strcasecmp (argv [2], "spi") == 0)
   {
-    module = "spi_bcm2708" ;
+    module1 = "spidev" ;
+    module2 = "spi_bcm2708" ;
     file1  = "/dev/spidev0.0" ;
     file2  = "/dev/spidev0.1" ;
+    if (argc == 4)
+      sprintf (args1, " bufsize=%d", atoi (argv [3]) * 1024) ;
+    else if (argc > 4)
+      _doLoadUsage (argv) ;
   }
   else if (strcasecmp (argv [2], "i2c") == 0)
   {
-    module = "i2c_bcm2708" ;
+    module1 = "i2c_dev" ;
+    module2 = "i2c_bcm2708" ;
     file1  = "/dev/i2c-0" ;
     file2  = "/dev/i2c-1" ;
+    if (argc == 4)
+      sprintf (args2, " baudrate=%d", atoi (argv [3]) * 1000) ;
+    else if (argc > 4)
+      _doLoadUsage (argv) ;
   }
   else
     _doLoadUsage (argv) ;
 
-  if (!moduleLoaded (module))
+  if (!moduleLoaded (module1))
+  {
+    sprintf (cmd, "modprobe %s%s", module1, args1) ;
+    system (cmd) ;
+  }
+
+  if (!moduleLoaded (module2))
   {
-    sprintf (cmd, "modprobe %s", module) ;
+    sprintf (cmd, "modprobe %s%s", module2, args2) ;
     system (cmd) ;
   }
 
-  if (!moduleLoaded (module))
+  if (!moduleLoaded (module2))
   {
-    fprintf (stderr, "%s: Unable to load %s\n", argv [0], module) ;
+    fprintf (stderr, "%s: Unable to load %s\n", argv [0], module2) ;
     exit (1) ;
   }
 
@@ -166,6 +195,49 @@ static void doLoad (int argc, char *argv [])
 }
 
 
+/*
+ * doReadall:
+ *     Read all the GPIO pins
+ *********************************************************************************
+ */
+
+static char *pinNames [] =
+{
+  "GPIO 0", "GPIO 1", "GPIO 2", "GPIO 3", "GPIO 4", "GPIO 5", "GPIO 6", "GPIO 7",
+  "SDA   ", "SCL   ",
+  "CE0   ", "CE1   ", "MOSI  ", "MISO  ", "SCLK  ",
+  "TxD   ", "RxD   ",
+  "GPIO 8", "GPIO 9", "GPIO10", "GPIO11",
+} ;
+
+static char *alts [] =
+{
+  "IN  ", "OUT ", "ALT0", "ALT1", "ALT2", "ALT3", "ALT4", "ALT5", "XXXX"
+} ;
+
+static void doReadall (void)
+{
+  int pin ;
+
+  printf ("+----------+------+--------+------+-------+\n") ;
+  printf ("| wiringPi | GPIO | Name   | Mode | Value |\n") ;
+  printf ("+----------+------+--------+------+-------+\n") ;
+
+  for (pin = 0 ; pin < 64 ; ++pin)
+  {
+    if (wpiPinToGpio (pin) == -1)
+      continue ;
+
+    printf ("| %6d   | %3d  | %s | %s | %s  |\n",
+       pin, wpiPinToGpio (pin),
+       pinNames [pin], 
+       alts [getAlt (pin)], 
+       digitalRead (pin) == HIGH ? "High" : "Low ") ;
+  }
+
+  printf ("+----------+------+--------+------+-------+\n") ;
+}
+
 
 /*
  * doExports:
@@ -173,7 +245,7 @@ static void doLoad (int argc, char *argv [])
  *********************************************************************************
  */
 
-void doExports (void)
+static void doExports (int argc, char *argv [])
 {
   int fd ;
   int i, l, first ;
@@ -328,8 +400,6 @@ void doEdge (int argc, char *argv [])
   int pin ;
   char *mode ;
   char fName [128] ;
-  uid_t uid ;
-  gid_t gid ;
 
   if (argc != 4)
   {
@@ -337,8 +407,7 @@ void doEdge (int argc, char *argv [])
     exit (1) ;
   }
 
-  pin = atoi (argv [2]) ;
-
+  pin  = atoi (argv [2]) ;
   mode = argv [3] ;
 
 // Export the pin and set direction to input
@@ -369,40 +438,23 @@ void doEdge (int argc, char *argv [])
     exit (1) ;
   }
 
-  /**/ if (strcasecmp (mode, "none")    == 0)
-    fprintf (fd, "none\n") ;
-  else if (strcasecmp (mode, "rising")  == 0)
-    fprintf (fd, "rising\n") ;
-  else if (strcasecmp (mode, "falling") == 0)
-    fprintf (fd, "falling\n") ;
-  else if (strcasecmp (mode, "both")    == 0)
-    fprintf (fd, "both\n") ;
+  /**/ if (strcasecmp (mode, "none")    == 0) fprintf (fd, "none\n") ;
+  else if (strcasecmp (mode, "rising")  == 0) fprintf (fd, "rising\n") ;
+  else if (strcasecmp (mode, "falling") == 0) fprintf (fd, "falling\n") ;
+  else if (strcasecmp (mode, "both")    == 0) fprintf (fd, "both\n") ;
   else
   {
     fprintf (stderr, "%s: Invalid mode: %s. Should be none, rising, falling or both\n", argv [1], mode) ;
     exit (1) ;
   }
 
-// Change ownership so the current user can actually use it!
-
-  uid = getuid () ;
-  gid = getgid () ;
+// Change ownership of the value and edge files, so the current user can actually use it!
 
   sprintf (fName, "/sys/class/gpio/gpio%d/value", pin) ;
-  if (chown (fName, uid, gid) != 0)
-  {
-    fprintf (stderr, "%s: Unable to change ownership of the value file: %s\n", argv [1], strerror (errno)) ;
-    exit (1) ;
-  }
-
-// Also change ownership of the edge file
+  changeOwner (argv [0], fName) ;
 
   sprintf (fName, "/sys/class/gpio/gpio%d/edge", pin) ;
-  if (chown (fName, uid, gid) != 0)
-  {
-    fprintf (stderr, "%s: Unable to change ownership of the value file: %s\n", argv [1], strerror (errno)) ;
-    exit (1) ;
-  }
+  changeOwner (argv [0], fName) ;
 
   fclose (fd) ;
 }
@@ -489,15 +541,16 @@ void doMode (int argc, char *argv [])
 
   mode = argv [3] ;
 
-  /**/ if (strcasecmp (mode, "in")   == 0) pinMode         (pin, INPUT) ;
-  else if (strcasecmp (mode, "out")  == 0) pinMode         (pin, OUTPUT) ;
-  else if (strcasecmp (mode, "pwm")  == 0) pinMode         (pin, PWM_OUTPUT) ;
-  else if (strcasecmp (mode, "up")   == 0) pullUpDnControl (pin, PUD_UP) ;
-  else if (strcasecmp (mode, "down") == 0) pullUpDnControl (pin, PUD_DOWN) ;
-  else if (strcasecmp (mode, "tri")  == 0) pullUpDnControl (pin, PUD_OFF) ;
+  /**/ if (strcasecmp (mode, "in")     == 0) pinMode         (pin, INPUT) ;
+  else if (strcasecmp (mode, "out")    == 0) pinMode         (pin, OUTPUT) ;
+  else if (strcasecmp (mode, "pwm")    == 0) pinMode         (pin, PWM_OUTPUT) ;
+  else if (strcasecmp (mode, "clock")  == 0) pinMode         (pin, GPIO_CLOCK) ;
+  else if (strcasecmp (mode, "up")     == 0) pullUpDnControl (pin, PUD_UP) ;
+  else if (strcasecmp (mode, "down")   == 0) pullUpDnControl (pin, PUD_DOWN) ;
+  else if (strcasecmp (mode, "tri")    == 0) pullUpDnControl (pin, PUD_OFF) ;
   else
   {
-    fprintf (stderr, "%s: Invalid mode: %s. Should be in/out/pwm/up/down/tri\n", argv [1], mode) ;
+    fprintf (stderr, "%s: Invalid mode: %s. Should be in/out/pwm/clock/up/down/tri\n", argv [1], mode) ;
     exit (1) ;
   }
 }
@@ -509,7 +562,7 @@ void doMode (int argc, char *argv [])
  *********************************************************************************
  */
 
-void doPadDrive (int argc, char *argv [])
+static void doPadDrive (int argc, char *argv [])
 {
   int group, val ;
 
@@ -538,13 +591,91 @@ void doPadDrive (int argc, char *argv [])
 }
 
 
+/*
+ * doGbw:
+ *     gpio gbw channel value
+ *     Gertboard Write - To the Analog output
+ *********************************************************************************
+ */
+
+static void doGbw (int argc, char *argv [])
+{
+  int channel, value ;
+
+  if (argc != 4)
+  {
+    fprintf (stderr, "Usage: %s gbr <channel> <value>\n", argv [0]) ;
+    exit (1) ;
+  }
+
+  channel = atoi (argv [2]) ;
+  value   = atoi (argv [3]) ;
+
+  if ((channel < 0) || (channel > 1))
+  {
+    fprintf (stderr, "%s: channel must be 0 or 1\n", argv [0]) ;
+    exit (1) ;
+  }
+
+  if ((value < 0) || (value > 1023))
+  {
+    fprintf (stderr, "%s: value must be from 0 to 255\n", argv [0]) ;
+    exit (1) ;
+  }
+
+  if (gertboardSPISetup () == -1)
+  {
+    fprintf (stderr, "Unable to initialise the Gertboard SPI interface: %s\n", strerror (errno)) ;
+    exit (1) ;
+  }
+
+  gertboardAnalogWrite (channel, value) ;
+}
+
+
+/*
+ * doGbr:
+ *     gpio gbr channel
+ *     From the analog input
+ *********************************************************************************
+ */
+
+static void doGbr (int argc, char *argv [])
+{
+  int channel ;
+
+  if (argc != 3)
+  {
+    fprintf (stderr, "Usage: %s gbr <channel>\n", argv [0]) ;
+    exit (1) ;
+  }
+
+  channel = atoi (argv [2]) ;
+
+  if ((channel < 0) || (channel > 1))
+  {
+    fprintf (stderr, "%s: channel must be 0 or 1\n", argv [0]) ;
+    exit (1) ;
+  }
+
+  if (gertboardSPISetup () == -1)
+  {
+    fprintf (stderr, "Unable to initialise the Gertboard SPI interface: %s\n", strerror (errno)) ;
+    exit (1) ;
+  }
+
+  printf ("%d\n",gertboardAnalogRead (channel)) ;
+}
+
+
+
 /*
  * doWrite:
  *     gpio write pin value
  *********************************************************************************
  */
 
-void doWrite (int argc, char *argv [])
+static void doWrite (int argc, char *argv [])
 {
   int pin, val ;
 
@@ -559,7 +690,12 @@ void doWrite (int argc, char *argv [])
   if ((wpMode == WPI_MODE_PINS) && ((pin < 0) || (pin >= NUM_PINS)))
     return ;
 
-  val = atoi (argv [3]) ;
+  /**/ if ((strcasecmp (argv [3], "up") == 0) || (strcasecmp (argv [3], "on") == 0))
+    val = 1 ;
+  else if ((strcasecmp (argv [3], "down") == 0) || (strcasecmp (argv [3], "off") == 0))
+    val = 0 ;
+  else
+    val = atoi (argv [3]) ;
 
   /**/ if (val == 0)
     digitalWrite (pin, LOW) ;
@@ -567,6 +703,27 @@ void doWrite (int argc, char *argv [])
     digitalWrite (pin, HIGH) ;
 }
 
+/*
+ * doWriteByte:
+ *     gpio write value
+ *********************************************************************************
+ */
+
+static void doWriteByte (int argc, char *argv [])
+{
+  int val ;
+
+  if (argc != 3)
+  {
+    fprintf (stderr, "Usage: %s wb value\n", argv [0]) ;
+    exit (1) ;
+  }
+
+  val = (int)strtol (argv [2], NULL, 0) ;
+
+  digitalWriteByte (val) ;
+}
+
 
 /*
  * doRead:
@@ -598,6 +755,33 @@ void doRead (int argc, char *argv [])
 }
 
 
+/*
+ * doClock:
+ *     Output a clock on a pin
+ *********************************************************************************
+ */
+
+void doClock (int argc, char *argv [])
+{
+  int pin, freq ;
+
+  if (argc != 4)
+  {
+    fprintf (stderr, "Usage: %s clock <pin> <freq>\n", argv [0]) ;
+    exit (1) ;
+  }
+
+  pin = atoi (argv [2]) ;
+
+  if ((wpMode == WPI_MODE_PINS) && ((pin < 0) || (pin >= NUM_PINS)))
+    return ;
+
+  freq = atoi (argv [3]) ;
+
+  gpioClockSet (pin, freq) ;
+}
+
+
 /*
  * doPwm:
  *     Output a PWM value on a pin
@@ -626,8 +810,8 @@ void doPwm (int argc, char *argv [])
 
 
 /*
- * doPwmMode: doPwmRange:
- *     Change the PWM mode and Range values
+ * doPwmMode: doPwmRange: doPwmClock:
+ *     Change the PWM mode, range and clock divider values
  *********************************************************************************
  */
 
@@ -657,6 +841,27 @@ static void doPwmRange (int argc, char *argv [])
   pwmSetRange (range) ;
 }
 
+static void doPwmClock (int argc, char *argv [])
+{
+  unsigned int clock ;
+
+  if (argc != 3)
+  {
+    fprintf (stderr, "Usage: %s pwmc <clock>\n", argv [0]) ;
+    exit (1) ;
+  }
+
+  clock = (unsigned int)strtoul (argv [2], NULL, 10) ;
+
+  if ((clock < 1) || (clock > 4095))
+  {
+    fprintf (stderr, "%s: clock must be between 0 and 4096\n", argv [0]) ;
+    exit (1) ;
+  }
+
+  pwmSetClock (clock) ;
+}
+
 
 /*
  * main:
@@ -668,18 +873,32 @@ int main (int argc, char *argv [])
 {
   int i ;
 
+  if (getenv ("WIRINGPI_DEBUG") != NULL)
+  {
+    printf ("gpio: wiringPi debug mode enabled\n") ;
+    wiringPiDebug = TRUE ;
+  }
+
   if (argc == 1)
   {
-    fprintf (stderr, "%s: %s\n", argv [0], usage) ;
+    fprintf (stderr, "%s\n", usage) ;
     return 1 ;
   }
 
+  if (strcasecmp (argv [1], "-h") == 0)
+  {
+    printf ("%s: %s\n", argv [0], usage) ;
+    return 0 ;
+  }
+
   if (strcasecmp (argv [1], "-v") == 0)
   {
     printf ("gpio version: %s\n", VERSION) ;
     printf ("Copyright (c) 2012 Gordon Henderson\n") ;
     printf ("This is free software with ABSOLUTELY NO WARRANTY.\n") ;
     printf ("For details type: %s -warranty\n", argv [0]) ;
+    printf ("\n") ;
+    printf ("This Raspberry Pi is a revision %d board.\n", piBoardRev ()) ;
     return 0 ;
   }
 
@@ -712,12 +931,20 @@ int main (int argc, char *argv [])
 
 // Initial test for /sys/class/gpio operations:
 
-  /**/ if (strcasecmp (argv [1], "exports"    ) == 0)  { doExports () ;                return 0 ; }
-  else if (strcasecmp (argv [1], "export"     ) == 0)  { doExport (argc, argv) ;       return 0 ; }
-  else if (strcasecmp (argv [1], "edge"       ) == 0)  { doEdge (argc, argv) ;         return 0 ; }
+  /**/ if (strcasecmp (argv [1], "exports"    ) == 0)  { doExports     (argc, argv) ;  return 0 ; }
+  else if (strcasecmp (argv [1], "export"     ) == 0)  { doExport      (argc, argv) ;  return 0 ; }
+  else if (strcasecmp (argv [1], "edge"       ) == 0)  { doEdge        (argc, argv) ;  return 0 ; }
   else if (strcasecmp (argv [1], "unexportall") == 0)  { doUnexportall (argc, argv) ;  return 0 ; }
-  else if (strcasecmp (argv [1], "unexport"   ) == 0)  { doUnexport (argc, argv) ;     return 0 ; }
-  else if (strcasecmp (argv [1], "load"       ) == 0)  { doLoad (argc, argv) ;         return 0 ; }
+  else if (strcasecmp (argv [1], "unexport"   ) == 0)  { doUnexport    (argc, argv) ;  return 0 ; }
+
+// Check for load command:
+
+  if (strcasecmp (argv [1], "load" ) == 0)     { doLoad     (argc, argv) ; return 0 ; }
+
+// Gertboard commands
+
+  if (strcasecmp (argv [1], "gbr" ) == 0)      { doGbr (argc, argv) ; return 0 ; }
+  if (strcasecmp (argv [1], "gbw" ) == 0)      { doGbw (argc, argv) ; return 0 ; }
 
 // Check for -g argument
 
@@ -725,7 +952,7 @@ int main (int argc, char *argv [])
   {
     if (wiringPiSetupGpio () == -1)
     {
-      fprintf (stderr, "%s: Unable to initialise GPIO in GPIO mode.\n", argv [0]) ;
+      fprintf (stderr, "%s: Unable to initialise GPIO mode.\n", argv [0]) ;
       exit (1) ;
     }
 
@@ -757,31 +984,35 @@ int main (int argc, char *argv [])
   {
     if (wiringPiSetup () == -1)
     {
-      fprintf (stderr, "%s: Unable to initialise GPIO in wiringPi mode\n", argv [0]) ;
+      fprintf (stderr, "%s: Unable to initialise wiringPi mode\n", argv [0]) ;
       exit (1) ;
     }
     wpMode = WPI_MODE_PINS ;
   }
 
-// Check for PWM operations
+// Check for PWM or Pad Drive operations
 
   if (wpMode != WPI_MODE_PIFACE)
   {
-    if (strcasecmp (argv [1], "pwm-bal") == 0) { doPwmMode  (PWM_MODE_BAL) ; return 0 ; }
-    if (strcasecmp (argv [1], "pwm-ms")  == 0) { doPwmMode  (PWM_MODE_MS) ;  return 0 ; }
-    if (strcasecmp (argv [1], "pwmr")    == 0) { doPwmRange (argc, argv) ;   return 0 ; }
+    if (strcasecmp (argv [1], "pwm-bal") == 0) { doPwmMode  (PWM_MODE_BAL) ;   return 0 ; }
+    if (strcasecmp (argv [1], "pwm-ms")  == 0) { doPwmMode  (PWM_MODE_MS) ;    return 0 ; }
+    if (strcasecmp (argv [1], "pwmr")    == 0) { doPwmRange (argc, argv) ;     return 0 ; }
+    if (strcasecmp (argv [1], "pwmc")    == 0) { doPwmClock (argc, argv) ;     return 0 ; }
+    if (strcasecmp (argv [1], "drive")   == 0) { doPadDrive (argc, argv) ;     return 0 ; }
   }
 
 // Check for wiring commands
 
-  /**/ if (strcasecmp (argv [1], "write"   ) == 0) doWrite    (argc, argv) ;
-  else if (strcasecmp (argv [1], "read"    ) == 0) doRead     (argc, argv) ;
-  else if (strcasecmp (argv [1], "mode"    ) == 0) doMode     (argc, argv) ;
-  else if (strcasecmp (argv [1], "pwm"     ) == 0) doPwm      (argc, argv) ;
-  else if (strcasecmp (argv [1], "drive"   ) == 0) doPadDrive (argc, argv) ;
+  /**/ if (strcasecmp (argv [1], "readall" ) == 0) doReadall   () ;
+  else if (strcasecmp (argv [1], "read" )    == 0) doRead      (argc, argv) ;
+  else if (strcasecmp (argv [1], "write")    == 0) doWrite     (argc, argv) ;
+  else if (strcasecmp (argv [1], "wb")       == 0) doWriteByte (argc, argv) ;
+  else if (strcasecmp (argv [1], "pwm"  )    == 0) doPwm       (argc, argv) ;
+  else if (strcasecmp (argv [1], "clock")    == 0) doClock     (argc, argv) ;
+  else if (strcasecmp (argv [1], "mode" )    == 0) doMode      (argc, argv) ;
   else
   {
-    fprintf (stderr, "%s: Unknown command: %s. (read/write/pwm/mode/drive expected)\n", argv [0], argv [1]) ;
+    fprintf (stderr, "%s: Unknown command: %s.\n", argv [0], argv [1]) ;
     exit (1) ;
   }
   return 0 ;