m2mb_uart.h

Go to the documentation of this file.

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

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

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


/* Global declarations ==========================================================================*/
#define M2MB_CONSOLE_PORT                                M2MB_UART_HS_PORT_E

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

typedef VOID* M2MB_UART_HANDLE_T;   

typedef VOID(*M2MB_UART_CB_T)(UINT32 num_bytes, VOID *p_cb_data);

typedef enum
{
        M2MB_UART_HS_PORT_E              = 0,   
   M2MB_UART_DEBUG_PORT_E       = 1,   
   M2MB_UART_MAX_PORTS_E,              
}M2MB_UART_PORT_ID_E;

typedef enum
{
  M2MB_UART_NO_PARITY_E         = 0,   
  M2MB_UART_ODD_PARITY_E        = 1,   
  M2MB_UART_EVEN_PARITY_E       = 2,   
  M2MB_UART_SPACE_PARITY_E      = 3,   
} M2MB_UART_PARITY_MODE_E;

typedef enum
{
  M2MB_UART_5_BITS_PER_CHAR_E   = 0,   
  M2MB_UART_6_BITS_PER_CHAR_E   = 1,   
  M2MB_UART_7_BITS_PER_CHAR_E   = 2,   
  M2MB_UART_8_BITS_PER_CHAR_E   = 3,   
} M2MB_UART_BITS_PER_CHAR_E;

typedef enum
{
  M2MB_UART_0_5_STOP_BITS_E     = 0,   
  M2MB_UART_1_0_STOP_BITS_E     = 1,   
  M2MB_UART_1_5_STOP_BITS_E     = 2,   
  M2MB_UART_2_0_STOP_BITS_E     = 3,   
} M2MB_UART_NUM_STOP_BITS_E;

typedef struct M2MB_UART_CONFIG
{
   UINT32                       baud_rate;        
   M2MB_UART_PARITY_MODE_E      parity_mode;      
   M2MB_UART_NUM_STOP_BITS_E    num_stop_bits;    
   M2MB_UART_BITS_PER_CHAR_E    bits_per_char;    
   UINT32                       enable_loopback;  
   UINT32                       enable_flow_ctrl; 
   M2MB_UART_CB_T               tx_cb;            
   M2MB_UART_CB_T               rx_cb;            
}M2MB_UART_CONFIG_T;

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

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_uart_open( M2MB_UART_HANDLE_T *p_handle,     M2MB_UART_PORT_ID_E id, 
        M2MB_UART_CONFIG_T *p_config );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_uart_close(M2MB_UART_HANDLE_T p_handle);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_uart_write( M2MB_UART_HANDLE_T p_handle, CHAR *p_buf, 
        UINT32 bytes_to_tx, VOID *p_cb_data );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
UINT8* m2mb_uart_read( HANDLE h, UINT32* size, UINT32 timeout, UINT8* buff, VOID *p_cb_data );



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

#endif  /* M2MB_UART_API_H */