m2mb_dbg.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
#ifndef  M2MB_DBG_API_H
#define  M2MB_DBG_API_H
#ifdef __cplusplus
extern "C" {
#endif

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

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


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

/* Macro to be called by an application to log debug message at EMERGENCY log level */
#define M2MB_DBG_EMERG(...) \
    m2mb_dbg_msg_log(M2MB_DBG_LOG_SEVERITY_EMERG, __func__, __LINE__, __VA_ARGS__)

/* Macro to be called by an application to log debug message at ALERT log level */
#define M2MB_DBG_ALERT(...) \
    m2mb_dbg_msg_log(M2MB_DBG_LOG_SEVERITY_ALERT, __func__, __LINE__, __VA_ARGS__)

/* Macro to be called by an application to log debug message at CRITICAL log level */
#define M2MB_DBG_CRIT(...) \
    m2mb_dbg_msg_log(M2MB_DBG_LOG_SEVERITY_CRIT, __func__, __LINE__, __VA_ARGS__)

/* Macro to be called by an application to log debug message at ERROR log level */
#define M2MB_DBG_ERROR(...) \
    m2mb_dbg_msg_log(M2MB_DBG_LOG_SEVERITY_ERROR, __func__, __LINE__, __VA_ARGS__)

/* Macro to be called by an application to log debug message at WARNING log level */
#define M2MB_DBG_WARN(...) \
    m2mb_dbg_msg_log(M2MB_DBG_LOG_SEVERITY_WARN, __func__, __LINE__, __VA_ARGS__)

/* Macro to be called by an application to log debug message at NOTICE log level */
#define M2MB_DBG_NOTICE(...) \
    m2mb_dbg_msg_log(M2MB_DBG_LOG_SEVERITY_NOTICE, __func__, __LINE__, __VA_ARGS__)

/* Macro to be called by an application to log debug message at INFORMATION log level */
#define M2MB_DBG_INFO(...) \
    m2mb_dbg_msg_log(M2MB_DBG_LOG_SEVERITY_INFO, __func__, __LINE__, __VA_ARGS__)

/* Macro to be called by an application to log debug message at DEBUG log level */
#define M2MB_DBG_DEBUG(...) \
    m2mb_dbg_msg_log(M2MB_DBG_LOG_SEVERITY_DEBUG, __func__, __LINE__, __VA_ARGS__)

#define M2MB_FUNC_ENTRY \
{\
    M2MB_DBG_INFO(" FUNC_ENTRY \n"); \
}
#define M2MB_FUNC_EXIT \
{\
    M2MB_DBG_INFO(" FUNC_EXIT \n"); \
}
#define M2MB_FUNC_EXIT_RC(x) \
{\
    M2MB_DBG_INFO(" FUNC_EXIT : Return Code : %d \n", x); \
    return x; \
}
/* Global typedefs ==============================================================================*/
typedef enum M2MB_DBG_LOG_SEVERITY
{
    M2MB_DBG_LOG_SEVERITY_INVALID = -1,   
    M2MB_DBG_LOG_SEVERITY_LOGING_OFF = 0, 
    M2MB_DBG_LOG_SEVERITY_EMERG,          
    M2MB_DBG_LOG_SEVERITY_ALERT,          
    M2MB_DBG_LOG_SEVERITY_CRIT,           
    M2MB_DBG_LOG_SEVERITY_ERROR,          
    M2MB_DBG_LOG_SEVERITY_WARN,           
    M2MB_DBG_LOG_SEVERITY_NOTICE,         
    M2MB_DBG_LOG_SEVERITY_INFO,           
    M2MB_DBG_LOG_SEVERITY_DEBUG,          
}M2MB_DBG_LOG_SEVERITY_T;

typedef INT32 (* M2MB_DBG_CMD_CB_T )( VOID *userCtx, UINT32 len, UINT8* cmd );

typedef VOID (*M2MB_DBG_SEND_T)( VOID *userCtx, UINT32 len, UINT8* data );

typedef VOID (*M2MB_DBG_RECV_PROC_DONE_T)( VOID *userCtx );

typedef struct M2MB_DBG_CFG
{
    M2MB_UART_PORT_ID_E port;
    UINT16 bufferSize;                  
    M2MB_DBG_LOG_SEVERITY_T logLevel;   
        UINT8 enableCI;                     
        M2MB_DBG_CMD_CB_T cb;               
        VOID *cbCtx;                        
    M2MB_DBG_SEND_T sendData;           
    M2MB_DBG_RECV_PROC_DONE_T recvDone; 
    VOID *userCtx;                      
}M2MB_DBG_CFG_T;

/* Global functions =========================================================*/
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_dbg_init( M2MB_DBG_CFG_T *pCfg, M2MB_UART_CONFIG_T *uart_cfg );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_dbg_is_init( VOID );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_dbg_prepare_for_deepsleep( VOID );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_dbg_reinit( VOID );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_dbg_msg_log( M2MB_DBG_LOG_SEVERITY_T severity, 
    char const *sourceFilePath, UINT32 lineNumber, char *format, ...);

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
INT32 m2mb_dbg_consol_print( char *format, ...);

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_dbg_set_severity( M2MB_DBG_LOG_SEVERITY_T severityLevel );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_DBG_LOG_SEVERITY_T m2mb_dbg_get_severity(  VOID );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
void m2mb_data_tx_done_cb( UINT32 num_bytes, void* cb_data );

/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
void m2mb_data_rx_cb( UINT32 num_bytes, void* cb_data );

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

#ifdef __cplusplus
}
#endif
#endif