xWRL6432 MMWAVE-L-SDK  05.04.00.01
SystemP.h File Reference

Go to the source code of this file.

Macros

#define LLD_PARAM_CHECK_ENABLED
 
#define LLD_PARAMS_CHECK(expression)
 
#define NOT_IN_USE(x)   (void) 0
 NOT_IN_USE macro to highlight unused parameters. More...
 
Return status
#define SystemP_SUCCESS   ((int32_t )0)
 Return status when the API execution was successful. More...
 
#define SystemP_FAILURE   ((int32_t)-1)
 Return status when the API execution was not successful due to a failure. More...
 
#define SystemP_TIMEOUT   ((int32_t)-2)
 Return status when the API execution failed due to a time out. More...
 
#define SystemP_INVALID_PARAM   ((int32_t)-3)
 Return status when the API execution failed due invalid parameters. More...
 
#define SystemP_BUSY   ((int32_t)-4)
 Return status when the API execution failed due to driver busy. More...
 
#define SystemP_INVALID_STATE   ((int32_t)-5)
 Return status when the API execution failed due to invalid LLD state. More...
 
#define SystemP_OUT_OF_RESOURCES   ((int32_t)-6)
 Return status when the API execution failed due to lack of resources (memory / HW) More...
 
Timeout values

#define SystemP_NO_WAIT   ((uint32_t)0)
 Value to use when needing a timeout of zero or NO timeout, return immediately on resource not available. More...
 
#define SystemP_WAIT_FOREVER   ((uint32_t)-1)
 Value to use when needing a timeout of infinity or wait forver until resource is available. More...
 
LLD (Low Level Driver) states

LLD_PARAM_CHECK_DEBUG_ASSERT

LLD_PARAM_CHECK_ENABLED

#define LLD_STATE_RESET   (0U)
 LLD is in Reset State prior to driver init and post driver deinit. More...
 
#define LLD_STATE_READY   (1U)
 LLD accepts runtime APIs only Ready State, otherwise return error. More...
 
#define LLD_STATE_BUSY   (2U)
 LLD is busy performing operation with peripherals, return error when APIs are invoked. More...
 
#define LLD_STATE_ERROR   (3U)
 LLD ran into error, returns error for all APIs other than deinit in this state. More...
 
#define LLD_STATE_RESET   (0U)
 LLD is in Reset State prior to driver init and post driver deinit. More...
 
#define LLD_STATE_READY   (1U)
 LLD accepts runtime APIs only Ready State, otherwise return error. More...
 
#define LLD_STATE_BUSY   (2U)
 LLD is busy performing operation with peripherals, return error when APIs are invoked. More...
 
#define LLD_STATE_ERROR   (3U)
 LLD ran into error, returns error for all APIs other than deinit in this state. More...
 

Macro Definition Documentation

◆ LLD_STATE_RESET [1/2]

#define LLD_STATE_RESET   (0U)

LLD is in Reset State prior to driver init and post driver deinit.

◆ LLD_STATE_READY [1/2]

#define LLD_STATE_READY   (1U)

LLD accepts runtime APIs only Ready State, otherwise return error.

◆ LLD_STATE_BUSY [1/2]

#define LLD_STATE_BUSY   (2U)

LLD is busy performing operation with peripherals, return error when APIs are invoked.

◆ LLD_STATE_ERROR [1/2]

#define LLD_STATE_ERROR   (3U)

LLD ran into error, returns error for all APIs other than deinit in this state.

◆ LLD_PARAM_CHECK_ENABLED

#define LLD_PARAM_CHECK_ENABLED

◆ LLD_PARAMS_CHECK

#define LLD_PARAMS_CHECK (   expression)
Value:
if (status == SystemP_SUCCESS) { \
if(!(expression)) { \
} \
}

◆ LLD_STATE_RESET [2/2]

#define LLD_STATE_RESET   (0U)

LLD is in Reset State prior to driver init and post driver deinit.

◆ LLD_STATE_READY [2/2]

#define LLD_STATE_READY   (1U)

LLD accepts runtime APIs only Ready State, otherwise return error.

◆ LLD_STATE_BUSY [2/2]

#define LLD_STATE_BUSY   (2U)

LLD is busy performing operation with peripherals, return error when APIs are invoked.

◆ LLD_STATE_ERROR [2/2]

#define LLD_STATE_ERROR   (3U)

LLD ran into error, returns error for all APIs other than deinit in this state.

◆ NOT_IN_USE

#define NOT_IN_USE (   x)    (void) 0

NOT_IN_USE macro to highlight unused parameters.

SystemP_SUCCESS
#define SystemP_SUCCESS
Return status when the API execution was successful.
Definition: SystemP.h:56
SystemP_INVALID_PARAM
#define SystemP_INVALID_PARAM
Return status when the API execution failed due invalid parameters.
Definition: SystemP.h:71