m2mb_i2c.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef M2M_M2MB_I2C_API_H
#define M2M_M2MB_I2C_API_H
 
 
 
/* Global declarations ==========================================================================*/
#ifndef NULL
#define NULL  0
#endif
 
#define I2C_M_WR              0x0000  /* write data, from master to slave */
#define I2C_M_RD              0x0001  /* read data, from slave to master */
 
/* Global enums ==============================================================================*/
 
enum M2MB_I2C_IOCTL_REQUEST
{
  M2MB_I2C_IOCTL_SET_CFG, /* set i2c device configuration */
  M2MB_I2C_IOCTL_GET_CFG, /* get i2c device configuration */
  M2MB_I2C_IOCTL_RDWR     /* i2c combined format */
};
 
/* Global typedefs ==============================================================================*/
 
typedef struct
{
  UINT16 flags;     /* I2C_M_WR or I2C_M_RD*/
  UINT16 len;       /* msg length */
  UINT8 *buf;       /* msg data */
} M2MB_I2C_MSG;
 
/* This is the structure as used in the I2C_RDWR ioctl call */
typedef struct
{
  M2MB_I2C_MSG *msgs;    /* pointers to i2c_msgs */
  UINT32 nmsgs;          /* number of i2c_msgs: 1 if only a write or a read operation is performed; 2 if both operations are performed */
} M2MB_I2C_RDWR_IOCTL_DATA;
 
/* I2C device configuration struct */
typedef struct
{
  UINT8 sdaPin;
  UINT8 sclPin;
  UINT8 registerId;
  M2MB_I2C_RDWR_IOCTL_DATA *rw_param;
} M2MB_I2C_CFG_T;
 
/* Global functions =============================================================================*/
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
 
INT32 m2mb_i2c_open( const CHAR *path, INT32 flags, ... );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_i2c_close( INT32 fd );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_i2c_ioctl( INT32 fd, INT32 request, ... );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
SSIZE_T m2mb_i2c_read( INT32 fd, void *buf, SIZE_T nbyte );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
SSIZE_T m2mb_i2c_write( INT32 fd, const void *buf, SIZE_T nbyte );
 
 
#endif  /* M2M_M2MB_I2C_API_H */