m2mb_gpio.h

Go to the documentation of this file.

/* $version: 372317T2_R1  */ 
/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef M2M_M2MB_GPIO_API_H
#define M2M_M2MB_GPIO_API_H
 
 
/* Global declarations ==========================================================================*/
#ifndef NULL
#define NULL  0
#endif
 
/* Global defines ==============================================================================*/
 
 
/*************************************************************************************************************/
/* use of gpio old interface is DEPRECATED for new project: enable it only for old already deployed project  */
/* If an application from APPZONE is used, a good solution for using old GPIO is to create a                 */
/*  makefile.in file and write in it the define: CPPFLAGS=-DENABLE_GPIO_OLD_INTERFACE                        */
/* instead of using the #define ENABLE_GPIO_OLD_INTERFACE below                                              */
/*************************************************************************************************************/
/* #define ENABLE_GPIO_OLD_INTERFACE */
 
 
#define M2MB_GPIO_ISR_IS_ENABLED  1
#define M2MB_GPIO_ISR_IS_DISABLED 0
 
#ifndef ATP_TEST_DEFINE
#define m2mb_gpio_multi_ioctl_( fd, args... ) m2mb_gpio_multi_ioctl( fd, CMDS_ARGS( args ) )
#endif
/* Global enums ==============================================================================*/
 
typedef enum
{
  M2MB_GPIO_IOCTL_SET_DIR,          
  M2MB_GPIO_IOCTL_GET_DIR,          
  M2MB_GPIO_IOCTL_SET_PULL,         
  M2MB_GPIO_IOCTL_GET_PULL,         
  M2MB_GPIO_IOCTL_SET_DRIVE,        
  M2MB_GPIO_IOCTL_GET_DRIVE,        
  M2MB_GPIO_IOCTL_INIT_INTR,        
  M2MB_GPIO_IOCTL_DEINIT_INTR,      
  M2MB_GPIO_IOCTL_SET_INTR_TYPE,    
  M2MB_GPIO_IOCTL_GET_INTR_TYPE,    
  M2MB_GPIO_IOCTL_SET_INTR_CB,      
  M2MB_GPIO_IOCTL_GET_INTR_CB,      
  M2MB_GPIO_IOCTL_SET_INTR_ARG,     
  M2MB_GPIO_IOCTL_GET_INTR_ARG,     
  M2MB_GPIO_IOCTL_SET_INTR_TRIGGER, 
  M2MB_GPIO_IOCTL_GET_INTR_TRIGGER, 
  M2MB_GPIO_IOCTL_SET_ISR_COUNTER,  
  M2MB_GPIO_IOCTL_GET_ISR_COUNTER,  
  M2MB_GPIO_IOCTL_GET_GPIO_N,       
  M2MB_GPIO_IOCTL_GET_INTR,         
  ENUM_TO_INT( M2MB_GPIO_IOCTL_REQUEST_E )
} M2MB_GPIO_IOCTL_REQUEST_E;
 
typedef enum
{
  M2MB_GPIO_MODE_INPUT = 0,               
  M2MB_GPIO_MODE_OUTPUT = 1,              
  ENUM_TO_INT( M2MB_GPIO_DIRECTION_E )
} M2MB_GPIO_DIRECTION_E;
 
typedef enum
{
  M2MB_GPIO_INTR_POSEDGE,         
  M2MB_GPIO_INTR_NEGEDGE,         
  M2MB_GPIO_INTR_ANYEDGE,         
  ENUM_TO_INT( M2MB_GPIO_TRIGGER_E )
} M2MB_GPIO_TRIGGER_E;
 
typedef enum
{
    M2MB_GPIO_NO_PULL,                  
    M2MB_GPIO_PULL_DOWN,                
    M2MB_GPIO_PULL_KEEPER,              
    M2MB_GPIO_PULL_UP,                  
    ENUM_TO_INT( M2MB_GPIO_PULL_MODE_E )
} M2MB_GPIO_PULL_MODE_E;
 
typedef enum
{
  M2MB_GPIO_LOW_DRIVE      = 0,    
  M2MB_GPIO_MEDIUM_DRIVE   = 0x1, 
  M2MB_GPIO_HIGH_DRIVE     = 0x2, 
  ENUM_TO_INT( M2MB_GPIO_DRIVE_E )
 
}M2MB_GPIO_DRIVE_E;
 
typedef enum
{
  M2MB_GPIO_LOW_VALUE = 0,     
  M2MB_GPIO_HIGH_VALUE = 1,    
  ENUM_TO_INT( M2MB_GPIO_VALUE_E )
 
}M2MB_GPIO_VALUE_E;
 
typedef enum
{
  INTR_CB_SET = 0,                
  INTR_COUNTER_SET,               
  INTR_COUNTER_SET_HP,            
  ENUM_TO_INT( M2M_GPIO_INTR_TYPE_E )
}M2M_GPIO_INTR_TYPE_E;
 
 
 
typedef void ( *m2mb_gpio_intr_callback )( UINT32 fd,  void *userdata );
 
/* Global functions =============================================================================*/
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
 
INT32 m2mb_gpio_open( const CHAR *path, INT32 flags, ... );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
 
 
INT32 m2mb_gpio_close( INT32 fd );
 
 
/*-----------------------------------------------------------------------------------------------*/
 
 
/*-----------------------------------------------------------------------------------------------*/
 
 
INT32 m2mb_gpio_ioctl( INT32 fd, INT32 cmd, UINT32 arg );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
 
 
INT32 m2mb_gpio_multi_ioctl( INT32 fd, UINT8 nCmds, ... );
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
 
INT32 m2mb_gpio_read( INT32 fd, M2MB_GPIO_VALUE_E *value );
 
 
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
 
INT32 m2mb_gpio_write( INT32 fd, M2MB_GPIO_VALUE_E value );
 
 
#ifdef ENABLE_GPIO_OLD_INTERFACE
 
/*************************************************************/
/* OLD GPIO INTERFACE                                        */
/*************************************************************/
#warning "**** WARNING!  ENABLE_GPIO_OLD_INTERFACE defined! "
 
/* Global enums ==============================================================================*/
 
enum M2MB_GPIO_IOCTL_REQUEST
{
  M2MB_GPIO_IOCTL_SET_CFG, /* set gpio device configuration */
  M2MB_GPIO_IOCTL_GET_CFG  /* get gpio device configuration */
};
 
/* Global typedefs ==============================================================================*/
 
/* GPIO device configuration struct */
typedef struct
{
  UINT8 direction;
  UINT8 save_cfg;
} M2MB_GPIO_CNFG_T;
 
INT32 m2mb_gpio_ioctl_wrp( INT32 fd, INT32 request, ... );
 
SSIZE_T m2mb_gpio_read_wrp( INT32 fd, void *buf, SIZE_T nbyte );
 
SSIZE_T m2mb_gpio_write_wrp( INT32 fd, const void *buf, SIZE_T nbyte );
 
#define m2mb_gpio_read( fd, value, nbyte )     m2mb_gpio_read_wrp( fd, ( void * )value, nbyte )
#define m2mb_gpio_write( fd, value, nbyte )    m2mb_gpio_write_wrp( fd, ( void * )value, nbyte )
#define m2mb_gpio_ioctl( a... )                m2mb_gpio_ioctl_wrp( a )
#define M2MB_GPIO_CFG_T     M2MB_GPIO_CNFG_T
 
#endif  /* ENABLE_GPIO_OLD_INTERFACE */
 
 
#endif  /* M2M_M2MB_GPIO_API_H */