m2mb_uart.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef M2M_M2MB_UART_API_H
#define M2M_M2MB_UART_API_H
 
/* Global declarations ==========================================================================*/
#ifndef NULL
#define NULL  0
#endif
 
/* Global enums ==============================================================================*/
 
enum M2MB_UART_IOCTL_REQUEST
{
  M2MB_UART_IOCTL_SET_CFG = 0,                 
  M2MB_UART_IOCTL_GET_CFG,                     
  M2MB_UART_IOCTL_SET_BR,                      
  M2MB_UART_IOCTL_GET_BR,                      
  M2MB_UART_IOCTL_SET_FCTL,                    
  M2MB_UART_IOCTL_GET_FCTL,                    
  M2MB_UART_IOCTL_SET_PARITY_MODE,             
  M2MB_UART_IOCTL_GET_PARITY_MODE,             
  M2MB_UART_IOCTL_SET_STOP_BITS,               
  M2MB_UART_IOCTL_GET_STOP_BITS,               
  M2MB_UART_IOCTL_SET_BITS_PER_CHAR,           
  M2MB_UART_IOCTL_GET_BITS_PER_CHAR,           
  M2MB_UART_IOCTL_SET_TX_TIMEOUT = 14,         
  M2MB_UART_IOCTL_GET_TX_TIMEOUT,              
  M2MB_UART_IOCTL_SET_RX_TIMEOUT,              
  M2MB_UART_IOCTL_GET_RX_TIMEOUT,              
  M2MB_UART_IOCTL_SET_CB_FN,                   
  M2MB_UART_IOCTL_GET_CB_FN,                   
  M2MB_UART_IOCTL_SET_CB_USERDATA,             
  M2MB_UART_IOCTL_GET_CB_USERDATA,             
  M2MB_UART_IOCTL_SET_POWER_STATE,             
  M2MB_UART_IOCTL_GET_POWER_STATE,             
  M2MB_UART_IOCTL_GET_OP_MODE,                 
  M2MB_UART_IOCTL_GET_RTS_STATE,               
  M2MB_UART_IOCTL_GET_DTR_STATE,               
  M2MB_UART_IOCTL_SET_CTS,                     
  M2MB_UART_IOCTL_SET_DSR,                     
  M2MB_UART_IOCTL_SET_DCD,                     
  M2MB_UART_IOCTL_SET_RING,                    
  M2MB_UART_IOCTL_SET_DTR_FCTL,                
  M2MB_UART_IOCTL_GET_DTR_FCTL,                
  M2MB_UART_IOCTL_NOF_REQ
};
 
/* Global typedefs ==============================================================================*/
 
typedef enum
{
  M2MB_UART_FCTL_OFF = 0,       
  M2MB_UART_CTSRFR_AUTO_FCTL,   
  M2MB_UART_FCTL_MAX
} M2MB_UART_FCTL_E;
 
typedef enum
{
  M2MB_UART_NO_PARITY = 0,            
  M2MB_UART_ODD_PARITY,               
  M2MB_UART_EVEN_PARITY,              
  M2MB_UART_SPACE_PARITY,             
  M2MB_UART_PARITY_MAX
} M2MB_UART_PARITY_E;
 
typedef enum
{
  M2MB_UART_0_5_STOP_BITS = 0,       
  M2MB_UART_1_0_STOP_BITS,           
  M2MB_UART_1_5_STOP_BITS,           
  M2MB_UART_2_0_STOP_BITS,           
  M2MB_UART_STOP_BITS_MAX
} M2MB_UART_STOP_BITS_E;
 
typedef enum
{
  M2MB_UART_5_BITS_PER_CHAR = 0,     
  M2MB_UART_6_BITS_PER_CHAR,         
  M2MB_UART_7_BITS_PER_CHAR,         
  M2MB_UART_8_BITS_PER_CHAR,         
  M2MB_UART_BITS_PER_CHAR_MAX
} M2MB_UART_BITS_PER_CHAR_E;
 
typedef enum
{
  M2MB_UART_TX_EV,                   
  M2MB_UART_RX_EV,                   
  M2MB_UART_DTR_EV                   
} M2MB_UART_IND_E;
 
typedef enum
{
  M2MB_UART_LOW_VALUE,                   
  M2MB_UART_HIGH_VALUE,                  
  ENUM_TO_INT( M2MB_UART_PIN_VALUE_E )
} M2MB_UART_PIN_VALUE_E;
 
 
 
typedef void ( *m2mb_uart_ind_callback )( INT32 fd, M2MB_UART_IND_E uart_event, UINT16 resp_size, void *resp_struct, void *userdata );
 
typedef struct
{
  UINT32 baud_rate;                             
  M2MB_UART_FCTL_E flow_control;                
  M2MB_UART_PARITY_E parity_mode;               
  M2MB_UART_STOP_BITS_E stop_bits;              
  M2MB_UART_BITS_PER_CHAR_E bits_per_char;      
  BOOLEAN loopback_mode;                        
  UINT16 tx_timeout_ms;                         
  UINT16 rx_timeout_ms;                         
  m2mb_uart_ind_callback cb_fn;                 
  void *cb_data;                                
} M2MB_UART_CFG_T;
 
/* Global functions =============================================================================*/
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_uart_open( const CHAR *path, INT32 flags, ... );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_uart_close( INT32 fd );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_uart_ioctl( INT32 fd, INT32 request, ... );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
SSIZE_T m2mb_uart_read( INT32 fd, void *buf, SIZE_T nbyte );
 
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
SSIZE_T m2mb_uart_write( INT32 fd, const void *buf, SIZE_T nbyte );
 
#endif  /* M2M_M2MB_UART_API_H */