gpioexport

Macros
#define	APP_EC_OK   0
	success exit code
#define	APP_EC_ARGS   2
	command-line options/arguments error exit code
#define	APP_EC_EXEC   4
	execution exit code
#define	NO_ARG   -1
	no argument
#define	APP_EC_OK   0
	success exit code
#define	APP_EC_ARGS   2
	command-line options/arguments error exit code
#define	APP_EC_EXEC   4
	execution exit code

Functions
static void	badCmdExit ()
	Exit program on bad command-line values.
static int	strToInt (const string &str, int &val)
	Convert string to integer.
static int	strToMode (const string &str, mode_t &mode)
	Convert string to file permissions.
static void	mainInit (int argc, char *argv[])
	Main initialization. More...
int	main (int argc, char *argv[])
	Main. More...

Variables
static char *	Argv0
	the command
static char *	OptsMode = NULL
	permissions
static int	ArgsGpioNum
	gpio number
static int	ArgsGpioDir
	gpio direction
static int	ArgsGpioEdge
	gpio edge trigger type
static mode_t	Permissions
	gpio permissions
static OptsPgmInfo_T	PgmInfo
	Program information. More...
static OptsInfo_T	OptsInfo []
	Command line options information. More...
static char *	Argv0
	the command
static bool_t	OptsMonitor = false
	do [not] keep listening for events
static double	OptsTimeout = 0.0
	event timeout (none)
static int	ArgsGpioNum
	gpio number
static OptsPgmInfo_T	PgmInfo
	Program information. More...
static OptsInfo_T	OptsInfo []
	Command line options information.

Detailed Description

Function Documentation

int main	(	int	argc,
		char *	argv[]
	)

Main.

Parameters

argc	Command-line argument count.
argv	Command-line argument list.

Returns

Returns 0 on succes, non-zero on failure.

Definition at line 295 of file gpioexport.cxx.

References APP_EC_EXEC, APP_EC_OK, ArgsGpioDir, ArgsGpioEdge, ArgsGpioNum, gpioExport(), gpioMakeDirname(), gpioSetDirection(), gpioSetEdge(), mainInit(), NO_ARG, OptsMode, and Permissions.

{
  mainInit(argc, argv);

  if( gpioExport(ArgsGpioNum) < 0 )
  {
    return APP_EC_EXEC;
  }

  if( ArgsGpioDir != NO_ARG )
  {
    if( gpioSetDirection(ArgsGpioNum, ArgsGpioDir) < 0 )
    {
      return APP_EC_EXEC;
    }
  }

  if( ArgsGpioEdge != NO_ARG )
  {
    if( gpioSetEdge(ArgsGpioNum, ArgsGpioEdge) < 0 )
    {
      return APP_EC_EXEC;
    }
  }

  if( OptsMode != NULL )
  {
    char  gpioPath[MAX_PATH]; 
    char  path[MAX_PATH]; 
  
    gpioMakeDirname(ArgsGpioNum, gpioPath, sizeof(gpioPath));

    sprintf(path, "%s/%s", gpioPath, "value");

    if( chmod(path, Permissions) < 0 )
    {
      LOGSYSERROR("chmod(%s, %o)", path, Permissions);
      return APP_EC_EXEC;
    }
  }

  return APP_EC_OK;
}

static void mainInit ( int  argc, char *  argv[]  )

static

Main initialization.

Parameters

argc	Command-line argument count.
argv	Command-line argument list.

Exits:

Program terminates on conversion error.

Returns

Exit code.

Definition at line 201 of file gpioexport.cxx.

References ArgsGpioDir, ArgsGpioEdge, ArgsGpioNum, Argv0, badCmdExit(), GPIO_DIR_IN, GPIO_DIR_IN_STR, GPIO_DIR_OUT, GPIO_DIR_OUT_STR, GPIO_EDGE_BOTH, GPIO_EDGE_BOTH_STR, GPIO_EDGE_FALLING, GPIO_EDGE_FALLING_STR, GPIO_EDGE_NONE, GPIO_EDGE_NONE_STR, GPIO_EDGE_RISING, GPIO_EDGE_RISING_STR, NO_ARG, OptsInfo, OptsMode, Permissions, PgmInfo, PkgInfo, strToInt(), and strToMode().

Referenced by main().

{
  // name of this process
  Argv0 = basename(argv[0]);

  // parse input options
  argv = OptsGet(Argv0, &PkgInfo, &PgmInfo, OptsInfo, true, &argc, argv);

  if( OptsMode != NULL )
  {
    if( strToMode(OptsMode, Permissions) < 0 )
    {
      fprintf(stderr, "%s: '%s': Bad permissions mode.\n", Argv0, OptsMode);
      badCmdExit();
    }
  }

  if( argc == 0 )
  {
    fprintf(stderr, "%s: No GPIO pin number <gpio> specified.\n", Argv0);
    badCmdExit();
  }

  else if( strToInt(argv[0], ArgsGpioNum) < 0 )
  {
    fprintf(stderr, "%s: '%s': Bad GPIO number.\n", Argv0, argv[0]);
    badCmdExit();
  }

  if( argc >= 2 )
  {
    if( !strcasecmp(argv[1], GPIO_DIR_IN_STR) )
    {
      ArgsGpioDir = GPIO_DIR_IN;
    }
    else if( !strcasecmp(argv[1], GPIO_DIR_OUT_STR) )
    {
      ArgsGpioDir = GPIO_DIR_OUT;
    }
    else
    {
      fprintf(stderr, "%s: '%s': Bad GPIO direction.\n", Argv0, argv[1]);
      badCmdExit();
    }
  }
  else
  {
    ArgsGpioDir = NO_ARG;
  }

  if( argc >= 3 )
  {
    if( !strcasecmp(argv[2], GPIO_EDGE_NONE_STR) )
    {
      ArgsGpioEdge = GPIO_EDGE_NONE;
    }
    else if( !strcasecmp(argv[2], GPIO_EDGE_RISING_STR) )
    {
      ArgsGpioEdge = GPIO_EDGE_RISING;
    }
    else if( !strcasecmp(argv[2], GPIO_EDGE_FALLING_STR) )
    {
      ArgsGpioEdge = GPIO_EDGE_FALLING;
    }
    else if( !strcasecmp(argv[2], GPIO_EDGE_BOTH_STR) )
    {
      ArgsGpioEdge = GPIO_EDGE_BOTH;
    }
    else
    {
      fprintf(stderr, "%s: '%s': Bad GPIO edge.\n", Argv0, argv[2]);
      badCmdExit();
    }
  }
  else
  {
    ArgsGpioEdge = NO_ARG;
  }

  if( argc >= 4 )
  {
    fprintf(stderr, "%s: '%s...': What is this?.\n", Argv0, argv[3]);
    badCmdExit();
  }
}

Variable Documentation

OptsInfo_T OptsInfo[]

static

Initial value:

=
{
  
  {
    "mode",               
    'm',                  
    required_argument,    
    false,                
    &OptsMode,            
    OptsCvtArgStr,        
    OptsFmtStr,           
    "<MODE>",             
                          
    "Change GPIO exported interface permissions. "
    "Format: 0[0-7]+ for user,group,other."
  },

  {NULL, }
}

Command line options information.

Definition at line 100 of file gpioexport.cxx.

Referenced by mainInit().

OptsPgmInfo_T PgmInfo

static

Initial value:

=
{
  
  "<gpio>",

  
  "Block wait for GPIO value to change.",

  
  "The %P command block waits for the value of the inoput GPIO associated with "
  "the <gpio> exported number to change. "
  "When the GPIO value changes or a timeout "
  "occurs, the value of \"0\" or \"1\" is printed to stdout. On error, the "
  "value \"-1\" is printed to stdout, and the program terminates.\n"
  "Note:\n"
  "  The exported GPIO interface must be configured to trigger on an "
  "edge transition.\n"
  "Examples:\n"
  "  gpionotify 19\n"
  "  gpionotify --timeout=1.5 --monitor 172"
  "",

  
  NULL
}

Program information.

Definition at line 68 of file gpionotify.cxx.

Referenced by mainInit().

OptsPgmInfo_T PgmInfo

static

Initial value:

=
{
  
  "<gpio> [{in|out} [{none|rising|falling|both}]]",

  
  "Create GPIO exported interface.",

  
  "The %P command creates a GPIO exported interface for the specified GPIO "
  "number. Optionally, the direction and edge of the GPIO can also be "
  "specified.\n\n"
  "Arguments:\n"
  "  <gpio>         Exported GPIO number.\n"
  "  <direction>    GPIO direction. One of: in out.\n"
  "                   Default: System defined.\n"
  "  <edge>         Input GPIO trigger. One of: none rising falling both.\n"
  "                   Default: System defined. N/A for output GPIO."
  "\n\n"
  "NOTE: This command requires root privileges.",

  
  NULL
}

Program information.

Definition at line 72 of file gpioexport.cxx.

Referenced by mainInit().