m2mb_gpio.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef M2M_M2MB_GPIO_API_H
#define M2M_M2MB_GPIO_API_H


#ifdef __cplusplus
extern "C" {
#endif

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/

/* Global declarations ==========================================================================*/

/* Global enums ==============================================================================*/

typedef enum M2MB_GPIO_IOCTL_REQUEST
{
  M2MB_GPIO_IOCTL_SET_CFG, 
  M2MB_GPIO_IOCTL_GET_CFG  
}M2MB_GPIO_IOCTL_REQUEST_T;

typedef enum M2MB_GPIOINT_IOCTL_REQUEST
{
  M2MB_GPIOINT_IOCTL_SET_CFG,                           
  M2MB_GPIOINT_IOCTL_GET_CFG,                           
  M2MB_GPIOINT_IOCTL_SET_TRIGGER_TYPE,          
  M2MB_GPIOINT_IOCTL_GET_TRIGGER_TYPE,          
  M2MB_GPIOINT_IOCTL_GET_INT_PRIO,                      
  M2MB_GPIOINT_IOCTL_GET_INT_MASK,                      
  M2MB_GPIOINT_IOCTL_GET_GPIO_NUM,                      
  M2MB_GPIOINT_IOCTL_SET_INT_EN,                        
  M2MB_GPIOINT_IOCTL_SET_INT_DIS,                       
  M2MB_GPIOINT_IOCTL_SET_TRIGGER_INT,           
  M2MB_GPIOINT_IOCTL_GET_INT_PENDING,           
  M2MB_GPIOINT_IOCTL_SET_CALLBACK_FN,       
  M2MB_GPIOINT_IOCTL_GET_CALLBACK_FN,       
  M2MB_GPIOINT_IOCTL_SET_CALLBACK_CTXT,     
  M2MB_GPIOINT_IOCTL_GET_CALLBACK_CTXT,     
}M2MB_GPIOINT_IOCTL_REQUEST_T;



typedef uint32_t M2MB_GPIO_ID_T;

typedef uint32_t M2MB_GPIO_PIN_T;

typedef void* M2MB_GPIOINT_ID_T;
typedef uint32_t M2MB_GPIOINT_PIN_T;

typedef enum
{ 
  M2MB_GPIO_INPUT_E  = 0, 
  M2MB_GPIO_OUTPUT_E = 1, 
  M2MB_GPIO_INVALID_DIR_E = 0x7fffffff /* Placeholder - Do not use */

}M2MB_GPIO_DIRECTION_T;

typedef enum
{
  M2MB_GPIO_NO_PULL_E    = 0x0, 
  M2MB_GPIO_PULL_DOWN_E  = 0x1, 
  M2MB_GPIO_PULL_UP_E    = 0x2, 
  M2MB_GPIO_INVALID_PULL_E = 0x7fffffff /* Placeholder - Do not use */

}M2MB_GPIO_PULL_T;

typedef enum
{
  M2MB_GPIO_1P6MA_E = 0,   
  M2MB_GPIO_2P7MA_E = 1,   
  M2MB_GPIO_4P0MA_E = 2,   
  M2MB_GPIO_INVALID_STRENGTH_E = 0x7fffffff 
}M2MB_GPIO_DRIVE_T;

typedef enum
{
  M2MB_GPIO_LOW_VALUE_E,     
  M2MB_GPIO_HIGH_VALUE_E,    
  M2MB_GPIO_INVALID_VALUE_E = 0x7fffffff /* Placeholder - Do not use */

}M2MB_GPIO_VALUE_T;


typedef enum
{ 
  M2MB_GPIOINT_TRIGGER_HIGH_LEVEL_E = 0,        
  M2MB_GPIOINT_TRIGGER_LOW_LEVEL_E = 1,         
  M2MB_GPIOINT_TRIGGER_RISING_EDGE_E  = 2,      
  M2MB_GPIOINT_TRIGGER_FALLING_EDGE_E = 3,      
  M2MB_GPIOINT_TRIGGER_DUAL_EDGE_E = 4,         
  M2MB_GPIOINT_TRIGGER_INVALID_E = 0x7fffffff /* Placeholder - Do not use */

}M2MB_GPIOINT_TRIGGER_TYPE_T;

typedef enum
{ 
  M2MB_GPIOINT_INTERRUPT_PRIORITY_HIGHEST_E  = 0,       
  M2MB_GPIOINT_INTERRUPT_PRIORITY_HIGH_E  = 1,          
  M2MB_GPIOINT_INTERRUPT_PRIORITY_MEDIUM_E  = 2,        
  M2MB_GPIOINT_INTERRUPT_PRIORITY_LOW_E  = 3,           
  M2MB_GPIOINT_INTERRUPT_PRIORITY_LOWEST_E  = 4,        
  M2MB_GPIOINT_INTERRUPT_PRIORITY_INVALID_E = 0x7fffffff /* Placeholder - Do not use */

}M2MB_GPIOINT_INTERRUPT_PRIORITY_T;

typedef enum
{ 
  M2MB_GPIOINT_INTERRUPT_MASKABLE_E  = 0,                       
  M2MB_GPIOINT_INTERRUPT_NONMASKABLE_E  = 1,            
  M2MB_GPIOINT_INTERRUPT_MASK_INVALID_E = 0x7fffffff 
}M2MB_GPIOINT_INTERRUPT_MASK_T;

/* Global typedefs ==============================================================================*/
typedef uint32_t M2MB_GPIOINT_CALLBACK_DATA_T;

typedef void (*M2MB_GPIOINT_CB_T) (M2MB_GPIOINT_CALLBACK_DATA_T);


/* Global typedefs ==============================================================================*/

typedef struct
{
  M2MB_GPIO_ID_T                        accessId;               
  M2MB_GPIO_PIN_T                       pin;                    
  M2MB_GPIO_DIRECTION_T         direction;              
  M2MB_GPIO_PULL_T                      pull;                   
  M2MB_GPIO_DRIVE_T                     drive;                  
} M2MB_GPIO_CFG_T;

typedef struct
{
  M2MB_GPIOINT_ID_T                                             handle;                         
  M2MB_GPIOINT_PIN_T                                    pin;                            
  M2MB_GPIOINT_TRIGGER_TYPE_T                   triggertype;            
  M2MB_GPIOINT_INTERRUPT_PRIORITY_T             priority;                       
  M2MB_GPIOINT_INTERRUPT_MASK_T                 mask;                           
  M2MB_GPIOINT_CB_T                                             callback_fn;            
  M2MB_GPIOINT_CALLBACK_DATA_T                  callback_ctxt;          
  M2MB_GPIO_CFG_T                                               gpio_cfg;                       
} M2MB_GPIOINT_CFG_T;


/* Global functions =============================================================================*/

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_gpio_open( const CHAR *path, INT32 flags, ... );



/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_gpio_close( INT32 fd );



/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_gpio_ioctl( INT32 fd,  M2MB_GPIO_IOCTL_REQUEST_T request, ... );



/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
SSIZE_T m2mb_gpio_read( INT32 fd, void *buf, SIZE_T nbyte );



/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
SSIZE_T m2mb_gpio_write( INT32 fd, const void *buf, SIZE_T nbyte );


/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_gpioint_open( const CHAR *path, INT32 cfg, ... );



/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_gpioint_close( INT32 fd );



/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_gpioint_ioctl( INT32 fd, M2MB_GPIOINT_IOCTL_REQUEST_T request, ... );

/*-----------------------------------------------------------------------------------------------*/


#ifdef __cplusplus
}
#endif

#endif  /* M2M_M2MB_GPIO_API_H */