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

//#include "device.h"

/* Global declarations ==========================================================================*/
#ifndef NULL
#define NULL  0
#endif

/* Global defines ==============================================================================*/

/* 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_INTR_POLARITY,
  M2MB_GPIO_IOCTL_GET_INTR_POLARITY,
  M2MB_GPIO_IOCTL_SET_ISR_COUNTER,          
  M2MB_GPIO_IOCTL_GET_ISR_COUNTER,          
  ENUM_TO_INT( M2MB_GPIO_IOCTL_REQUEST_E )
} M2MB_GPIO_IOCTL_REQUEST_E;

typedef enum
{
  M2MB_GPIO_MODE_INPUT = 0x00,               
  M2MB_GPIO_MODE_OUTPUT = 0x01,              
  ENUM_TO_INT( M2MB_GPIO_DIRECTION_E )
} M2MB_GPIO_DIRECTION_E;

typedef enum
{
  M2MB_GPIO_INTR_LEVEL = 0x0,           
  M2MB_GPIO_INTR_EDGE = 0x1,            
  M2MB_GPIO_INTR_ANYEDGE = 0x2,         
  ENUM_TO_INT( M2MB_GPIO_TRIGGER_E )
} M2MB_GPIO_TRIGGER_E;

typedef enum
{
  M2MB_GPIO_INTR_POL_LOW = 0x0,           
  M2MB_GPIO_INTR_POL_HIGH = 0x1,               
  ENUM_TO_INT( M2MB_GPIO_POLARITY_E )
} M2MB_GPIO_POLARITY_E;

typedef enum
{
  M2MB_GPIO_INT_DEBOUNCE_DISABLE,         
  M2MB_GPIO_INT_DEBOUNCE_ENABLE,          
  ENUM_TO_INT( M2MB_GPIO_DEBOUNCE_E )
} M2MB_GPIO_DEBOUNCE_E;

typedef enum
{
    M2MB_GPIO_NO_PULL = 0x00,                  
    M2MB_GPIO_PULL_DOWN = 0x01,                
    M2MB_GPIO_PULL_UP = 0x02,                  
        M2MB_GPIO_PULL_KEEPER,                     
    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,               
  ENUM_TO_INT( M2M_GPIO_INTR_TYPE_E )
}M2M_GPIO_INTR_TYPE_E;



typedef VOID (*M2MB_GPIOINT_CB_T)(UINT32 id, UINT32 event);

typedef UINT32 M2MB_GPIO_PIN_E;

typedef VOID* M2MB_GPIOINT_CALLBACK_DATA_T;


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

typedef struct
{
  M2MB_GPIO_PIN_E                               GPIO_Pin;                       
  M2MB_GPIO_DIRECTION_E                 GPIO_Mode;                      
  M2MB_GPIO_PULL_MODE_E                 GPIO_PuPd;                      
  M2MB_GPIO_TRIGGER_E                   GPIO_ITTrigger;         
  M2MB_GPIO_POLARITY_E          GPIO_ITPolarity;    
  M2MB_GPIO_DEBOUNCE_E                  GPIO_ITDebounce;    
  M2MB_GPIO_DRIVE_E                             drive;                          
  M2MB_GPIOINT_CB_T                             callback_fn;            
  M2MB_GPIOINT_CALLBACK_DATA_T  callback_ctxt;          
} M2MB_GPIO_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_E cmd, void* 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 );

VOID gpio_toggle_tmr_cb(VOID *ctxt);

INT32 m2mb_gpio_toggle_stop( HANDLE h );
HANDLE m2mb_gpio_toggle_init( UINT8 gpio_number, UINT32 toggle_timeout, UINT8 toggle_number);

INT32 m2mb_gpio_toggle_start( HANDLE h );

INT32 m2mb_gpio_toggle_deinit( HANDLE h );



#endif  /* M2M_M2MB_GPIO_API_H */