i2cscan.c File Reference

I2C Bus Scan. More...

#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <errno.h>
#include <ctype.h>
#include <libgen.h>
#include <unistd.h>
#include "rnr/rnrconfig.h"
#include "rnr/log.h"
#include "rnr/opts.h"
#include "rnr/i2c-dev.h"
#include "rnr/i2c.h"
#include "version.h"

Go to the source code of this file.

Functions
static int	scanCallback (i2c_t *pI2C, i2c_addr_t addr, void *context)
	Found scanned device callback. More...
static int	execScan (i2c_t *pI2C)
	Execute I2C slave device scan. More...
static void	MainInit (int argc, char *argv[], i2c_t *pI2C)
	Command initialization. More...
int	main (int argc, char *argv[])
	i2cscan main() More...

Variables
static char *	Argv0
	command name
static int	OptVerbose = 0
	verbose option
static char *	OptDevName = "/dev/i2c/0"
	i2c bus device option
static int	OptDevFd = -1
	opened i2c bus device fd option
static OptsPgmInfo_T	I2CScanPgmInfo
	Program Information. More...
static OptsInfo_T	I2CScanOptsInfo []
	Command Line Options Information.

Detailed Description

I2C Bus Scan.

LastChangedDate

2009-09-09 09:44:12 -0600 (Wed, 09 Sep 2009)

Rev

130

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2007-2017. RoadNarrows LLC.
http://www.roadnarrows.com
All Rights Reserved

Definition in file i2cscan.c.

Function Documentation

static int execScan ( i2c_t *  pI2C )

static

Execute I²C slave device scan.

Parameters

pI2C	Pointer to I2C handle.

Returns

Returns number of devices found ≥ 0 on success, -1 on failure.

Definition at line 160 of file i2cscan.c.

References Argv0, i2c_scan(), OptVerbose, and scanCallback().

Referenced by main().

{
  int n = 0;

  if( OptVerbose )
  {
    printf("%s scanning...\n", Argv0);
    printf(" scanned devices: ");
  }
  n = i2c_scan(pI2C, scanCallback, NULL);

  if(n > 0)
  {
    printf("\n");
  }

  if( OptVerbose )
  {
    printf(" number found:    %d\n", n);
  }

  return n;
}

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

i2cscan main()

Parameters

argc	Count of command-line options and arguments.
argv	Array of command-line options and arguments.

Returns

Exit value.

Definition at line 239 of file i2cscan.c.

References execScan(), and MainInit().

{
  i2c_t i2c;
  int   rc;

  MainInit(argc, argv, &i2c);

  rc = execScan(&i2c);

  return rc > 0? 0: 1;
}

static void MainInit ( int  argc, char *  argv[], i2c_t *  pI2C  )

static

Command initialization.

Parameters

argc	Command-line argument count.
argv	Command-line arguments.
pI2C	Pointer to I2C handle.

Definition at line 191 of file i2cscan.c.

References i2c_struct::addr, Argv0, i2c_struct::fd, i2c_open(), I2CScanOptsInfo, I2CScanPgmInfo, OptDevFd, OptDevName, OptVerbose, and PkgInfo.

Referenced by main().

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

  // Get the environment
  //EnvGet();

  // Parse input arguments
  argv = OptsGet(Argv0, &PkgInfo, &I2CScanPgmInfo, I2CScanOptsInfo, true,
                 &argc, argv);

  // Opened device specified
  if( OptDevFd >= 0 )
  {
    pI2C->fd    = OptDevFd;
    pI2C->addr  = (ushort_t)(-1);
  }

  // I2C Bus device specified
  else
  {
    if( OptDevName == NULL || OptDevName[0] == 0 )
    {
      OptDevName = "/dev/i2c/0";
    }

    if( OptVerbose )
    {
      printf("I2C device: %s\n\n", OptDevName);
    }
  
    if( i2c_open(pI2C, OptDevName) < 0 )
    {
     LOGSYSERROR("%s: Failed to open.", OptDevName);
     exit(EC_ERROR);
    }
  }
}

static int scanCallback ( i2c_t *  pI2C, i2c_addr_t  addr, void *  context  )

static

Found scanned device callback.

Parameters

pI2C	Pointer to I2C handle.
addr	Slave device address.
context	User provided context.

Returns

Returns 1.

Definition at line 147 of file i2cscan.c.

Referenced by execScan().

{
  printf("0x%02x ", addr);
  return 1;
}

Variable Documentation

OptsPgmInfo_T I2CScanPgmInfo

static

Initial value:

=
{
  NULL,

  .synopsis = "I2C Bus Scan",

  .long_desc = 
    "The %P command scans the specified I2C Bus for all attached devices. "
    "The I2C addresses of all found devices are written to stdout in ASCII hex "
    "format.",

  .diagnostics = 
    "Exit status is 0 if devices are found, 1 otherwise. Exit tatus is >= 2 if "
    "error(s) are encountered."
}

Program Information.

Definition at line 78 of file i2cscan.c.

Referenced by MainInit().