XDK API  3.6.0
Documentation
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
BCDS_ErrorLogger.h File Reference
#include "BCDS_Utils.h"
#include "BCDS_Basics.h"
#include "BCDS_Retcode.h"
+ Include dependency graph for BCDS_ErrorLogger.h:

Data Structures

struct  ErrorLogger_LogEntry_S
 Struct for storing the details of Logs. More...
 
struct  ErrorLoggerConfig_S
 

Macros

#define ERRORLOGGER_SIZE   (UINT8_C(120))
 
#define MAXENTRIES   (ERRORLOGGER_SIZE/SIZEOF_LOGENTRY)
 
#define SIZEOF_LOGENTRY   (UINT8_C(12))
 

Typedefs

typedef Retcode_T(* ErrorLogger_EraseFunc_T )(ErrorLogger_StorageMedium_T storageSelect, void *value, uint32_t StartAddr, uint32_t numOfBytes)
 This function writes the data from the specified partition of the storage medium. More...
 
typedef uint32_t(* ErrorLogger_GetTime )(void)
 This function is used to provide the time stamp and unit will be based on application perspective. More...
 
typedef struct
ErrorLogger_LogEntry_S 
ErrorLogger_LogEntry_T
 
typedef Retcode_T(* ErrorLogger_ReadFunc_T )(ErrorLogger_StorageMedium_T storageSelect, void *value, uint32_t StartAddr, uint32_t numOfBytes)
 This function reads the data from the specified partition of the storage medium. More...
 
typedef enum
ErrorLogger_StorageMedium_E 
ErrorLogger_StorageMedium_T
 
typedef Retcode_T(* ErrorLogger_WriteFunc_T )(ErrorLogger_StorageMedium_T storageSelect, void *value, uint32_t StartAddr, uint32_t numOfBytes)
 This function writes the data from the specified partition of the storage medium. More...
 
typedef struct ErrorLoggerConfig_S ErrorLoggerConfig_T
 

Enumerations

enum  ErrorLogger_StorageMedium_E
 Enum for different storage medium. More...
 

Functions

struct ErrorLogger_LogEntry_S __attribute__ ((packed))
 
Retcode_T ErrorLogger_ClearAllErrorLogs (void)
 API to clear all the error in the user page. More...
 
uint8_t ErrorLogger_GetCurrentErrors (void)
 API to query numbers of errors available in the storage medium. More...
 
Retcode_T ErrorLogger_GetErrorAt (uint8_t index, ErrorLogger_LogEntry_T *LogEntry)
 API to get the error at particular index. More...
 
Retcode_T ErrorLogger_GetLastErrorLog (ErrorLogger_LogEntry_T *LogEntry)
 API to get the most recent error happened in the system. More...
 
uint16_t ErrorLogger_GetTotalErrors (void)
 API to query total number of errors occurred in the system. More...
 
Retcode_T ErrorLogger_HasError (Retcode_T Error)
 API to query if particular error has happened in the system. More...
 
Retcode_T ErrorLogger_Init (ErrorLoggerConfig_T storageAgentHandle)
 API for initialize the ErrorLogger module. More...
 
Retcode_T ErrorLogger_LogError (Retcode_T Error)
 API for logging error to the storage medium. More...
 

Variables

enum ErrorLogger_StorageMedium_E __attribute__
 
uint32_t ErrorCode
 
uint16_t Reserved
 
uint16_t SeqNo
 
uint32_t TimeStamp
 

Variable Documentation

uint32_t ErrorCode

It records the timestamp (uptime) of error occurance

uint16_t Reserved

It holds error occurance number

uint16_t SeqNo

It holds the Retcode_T which says from where the error comes

uint32_t TimeStamp

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:49 by doxygen 1.8.8