ptxLog.h

Go to the documentation of this file.

 
#ifndef PTX_LOG_H
#define PTX_LOG_H
 
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include "ptx_Status.h"
#include "ptxOsal.h"
#include "ptx_Platform.h"
 
#ifdef PTX_PLAT_ANDROID
    #include <log/log.h>
#endif
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES
 * ####################################################################################################################
 */
 
#define PTX_LOG_FILE_NAME_LEN       40  
#define PTX_LOG_FILE_BUF_LEN        258 
#define PTX_LOG_MIN_NUM_ENTRIES     3   
#define PTX_LOG_ASSERT_LOG_ENTRIES  (PTX_LOG_MIN_NUM_ENTRIES * 2) 
typedef struct ptxLogItem* pptxLogItem_t;
 
typedef ptxStatus_t (*pptxLogCallbackFn_t)(void *LogContext, pptxLogItem_t pLogItem);
 
 
/*
 * ####################################################################################################################
 * INTERNALS
 * ####################################################################################################################
 */
 
typedef enum ptxLogClass
{
    ptxLogClass_Trace,              
    ptxLogClass_Message,            
    ptxLogClass_Warning,            
    ptxLogClass_Error,              
    ptxLogClass_Rx,                 
    ptxLogClass_Tx,                 
    ptxLogClass_Sys_Debug,          
    ptxLogClass_Sys_Info,           
    ptxLogClass_Sys_Warn,           
    ptxLogClass_Sys_Error,          
    ptxLogClass_Assert,             
    ptxLogClass_Assert_Status,      
    ptxLogClass_Assert_NotNull,     
    ptxLogClass_Assert_Equals,      
    ptxLogClass_Assert_NotEqual,    
} ptxLogClass_t;
 
typedef enum ptxLogParamType
{
    ptxLogParamType_None,           
    ptxLogParamType_P2,             
    ptxLogParamType_PL,             
    ptxLogParamType_Ptr,            
    ptxLogParamType_Data,           
    ptxLogParamType_String          
} ptxLogParamType_t;
 
typedef struct ptxLogItem_ParamBuffer
{
    size_t                  Length;                     
    uint8_t                 Data[PTX_LOG_FILE_BUF_LEN]; 
} ptxLogItem_ParamBuffer_t;
 
typedef struct ptxLogItem_2U32
{
    uint32_t                Param1;         
    uint32_t                Param2;         
} ptxLogItem_2U32_t;
 
typedef union ptxLogItem_Param
{
    ptxLogItem_2U32_t           Param2U32;      
    uint64_t                    Param64;        
    void                       *Pointer;        
    ptxLogItem_ParamBuffer_t    Buffer;         
} ptxLogItem_Param_t;
 
typedef struct ptxLogItem
{
    ptxLogClass_t           Class;          
    char                    LocationMajor[PTX_LOG_FILE_NAME_LEN+1]; 
    uint32_t                LocationMinor;  
    uint32_t                StatusCode;     
    ptxTimeDiff_t           TimeStamp;      
    ptxLogParamType_t       ParamType;      
    ptxLogItem_Param_t      Param;          
} ptxLogItem_t;
 
typedef struct ptxLogState
{
    uint8_t                 Used;               
    size_t                  LogSize;            
    ptxLogItem_t           *LogItems;           
    size_t                  WriteIndex;         
    size_t                  ReadIndex;          
    uint64_t                EntriesWritten;     
    ptxMutex_t              Mutex;              
} ptxLogState_t;
 
typedef struct ptxLog
{
    struct ptxOsal          *OsAl;              
    ptxLogState_t           Logger;             
    ptxLogState_t           Assert;             
    pptxLogCallbackFn_t     LogCallbackFn;      
    void                    *LogContext;        
} ptxLog_t;
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS / LOG COMPONENT ADMINISTRATION
 * ####################################################################################################################
 */
 
ptxStatus_t ptxLog_Init(ptxLog_t *logCtx, void *osAl, size_t numEntries);
 
ptxStatus_t ptxLog_InitRTLogging(ptxLog_t *logCtx, pptxLogCallbackFn_t LogCallbackFn, void *Handler);
 
ptxStatus_t ptxLog_DeInit(ptxLog_t *logCtx);
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS / STORING LOG ITEM DATA
 * ####################################################################################################################
 */
 
void ptxLog_SP2(ptxLog_t *logCtx, const char *locationMajor, int locationMinor, ptxLogClass_t logClass,
        uint32_t logStatus, uint32_t logP1, uint32_t logP2);
 
void ptxLog_SPL(ptxLog_t *logCtx, const char *locationMajor, int locationMinor, ptxLogClass_t logClass,
        uint32_t logStatus, uint64_t logP);
 
void ptxLog_SD(ptxLog_t *logCtx, const char *locationMajor, int locationMinor, ptxLogClass_t logClass,
        uint32_t logStatus, uint8_t *logData, size_t logLen);
 
void ptxLog_S(ptxLog_t *logCtx, const char *locationMajor, int locationMinor, ptxLogClass_t logClass,
        uint32_t logStatus);
 
void ptxLog_TraceText(ptxLog_t *logCtx, const char *locationMajor, int locationMinor, const char *traceText);
 
void ptxLog_TraceTextStatus(ptxLog_t *logCtx, const char *locationMajor, int locationMinor, const char *traceText, uint32_t logStatus);
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS / ASSERTION-LOG HANDLERS
 * ####################################################################################################################
 */
 
void ptxLog_AssertStatus(ptxLog_t *logCtx, const char *locationMajor, int locationMinor,
        ptxStatus_t actualStatus, const ptxStatus_t requiredStatus);
 
void ptxLog_AssertNotNull(ptxLog_t *logCtx, const char *locationMajor, int locationMinor, void *actualPtr);
 
void ptxLog_AssertEquals(ptxLog_t *logCtx, const char *locationMajor, int locationMinor,
        uint32_t actualValue, uint32_t requiredValue, const char *traceText);
 
void ptxLog_AssertNotEqual(ptxLog_t *logCtx, const char *locationMajor, int locationMinor,
        uint32_t actualValue, uint32_t requiredValue, const char *traceText);
 
 
/*
 * ####################################################################################################################
 * API FUNCTIONS / RETRIEVE LOG ITEMS
 * ####################################################################################################################
 */
 
ptxStatus_t ptxLog_GetFirst(ptxLog_t *logCtx, ptxLogItem_t **logItem);
 
ptxStatus_t ptxLog_GetNext(ptxLog_t *logCtx, ptxLogItem_t **logItem);
 
ptxStatus_t ptxLogAssert_GetFirst(ptxLog_t *logCtx, ptxLogItem_t **logItem);
 
ptxStatus_t ptxLogAssert_GetNext(ptxLog_t *logCtx, ptxLogItem_t **logItem);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */