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

Macros

#define BCDS_MODULE_ID   0
 
#define BCDS_PACKAGE_ID   0
 
#define RETCODE(Severity, Code)   (RETCODE_COMPOSE((uint32_t)BCDS_PACKAGE_ID, (uint32_t)BCDS_MODULE_ID, (uint32_t)Severity, (uint32_t)Code))
 This macro should be used to compose a Retcode_T value. More...
 
#define RETCODE_COMPOSE(PackageID, ModuleID, Severity, Code)   ( (Retcode_T) ( RETCODE_MK_PACKAGE(PackageID) | RETCODE_MK_MODULEID(ModuleID) | RETCODE_MK_SEVERITY(Severity) | RETOCDE_MK_CODE(Code) ) )
 This Macro composes a return code based on input parameters. More...
 
#define RETCODE_DOPPLE_INITIALIZATION   RETCODE_DOUBLE_INITIALIZATION
 
#define RETCODE_INCONSITENT_STATE   RETCODE_INCONSISTENT_STATE
 
#define RETCODE_INVALID_SEMAPHORE_IN_ISR   RETCODE_INVALID_SIGNAL_IN_ISR
 
#define RETCODE_MK_MODULEID(ModuleID)   ( (ModuleID & 0x000000FFUL) << 16UL )
 A helper macro to make Module Id. More...
 
#define RETCODE_MK_PACKAGE(Package)   ( (Package & 0x000000FFUL) << 24UL )
 A helper macro to make to create the package. More...
 
#define RETCODE_MK_SEVERITY(Severity)   ( (Severity & 0x0000000FUL) << 12UL )
 A helper macro to make severity. More...
 
#define RETCODE_OK   ((Retcode_T) RETCODE_SUCCESS)
 A helper macro to return success. More...
 
#define RETCODE_RTOS_QUEUE_ERROR   RETCODE_QUEUE_ERROR
 
#define RETOCDE_MK_CODE(Code)   (Code & 0x00000FFFUL)
 A helper macro to make code. More...
 

Typedefs

typedef void(* Retcode_ErrorHandlingFunc_T )(Retcode_T error, bool isFromIsr)
 Typedef to represent the Callback function to be called for handling the Error. More...
 
typedef enum Retcode_Severity_E Retcode_Severity_T
 Typedef to represent the Severity of error. More...
 
typedef uint32_t Retcode_T
 This is the return code data type of the BCDS platform. Each retcode is composed of four parts: package, module, severity and code. More...
 

Enumerations

enum  Retcode_General_E
 Enumeration to represent the General return codes. The first codes from 0 to RETCODE_FIRST_CUSTOM_CODE are reserved as general error codes. Packages and projects may define their own codes starting from RETCODE_FIRST_CUSTOM_CODE up to the code 4095. More...
 
enum  Retcode_Severity_E
 Enumeration to represent the Severity of errors. More...
 

Functions

 BCDS_DEPRECATED (Retcode_T Retcode_initialize(Retcode_ErrorHandlingFunc_T func))
 This function initializes the Retcode module. More...
 
 BCDS_DEPRECATED (void Retcode_raiseError(Retcode_T error))
 Raises the error passed as parameter to the error handling function. More...
 
 BCDS_DEPRECATED (static BCDS_INLINE Retcode_Severity_T Retcode_getSeverity(Retcode_T retcode))
 This function provides the Severity of a return code. More...
 
 BCDS_DEPRECATED (static BCDS_INLINE uint32_t Retcode_getCode(Retcode_T retcode))
 This function provides the Error code of a return code. More...
 
static BCDS_INLINE uint32_t Retcode_GetCode (Retcode_T retcode)
 This function provides the Error code of a return code. More...
 
static BCDS_INLINE uint32_t Retcode_getCode (Retcode_T retcode)
 
static BCDS_INLINE uint32_t Retcode_GetModuleId (Retcode_T retcode)
 This function provides the Package of a return code. More...
 
static BCDS_INLINE uint32_t Retcode_GetPackage (Retcode_T retcode)
 This function provides the Package of a return code. More...
 
static BCDS_INLINE uint32_t Retcode_getPackage (Retcode_T retcode)
 
static BCDS_INLINE
Retcode_Severity_T 
Retcode_GetSeverity (Retcode_T retcode)
 This function provides the Severity of a return code. More...
 
static BCDS_INLINE
Retcode_Severity_T 
Retcode_getSeverity (Retcode_T retcode)
 
Retcode_T Retcode_Initialize (Retcode_ErrorHandlingFunc_T func)
 This function initializes the Retcode module. More...
 
void Retcode_RaiseError (Retcode_T error)
 Raises the error passed as parameter to the error handling function. More...
 
void Retcode_RaiseErrorFromIsr (Retcode_T error)
 Raises the error passed as parameter to the error handling function, use from ISR (Interrupt) context only. More...
 

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:48 by doxygen 1.8.8