XDK API  3.6.0
Documentation
BCDS_HAL_Delay.h File Reference

Provide functions for different delay times. More...

#include "BCDS_Retcode.h"
+ Include dependency graph for BCDS_HAL_Delay.h:
typedef Retcode_T(* HAL_Delay_MsHook_T )(uint32_t timeInMs)
 
Retcode_T HAL_Delay_SetMsHook (HAL_Delay_MsHook_T hook)
 Set Delay ms Mode for use in NoOS or RTOS Context. More...
 
Retcode_T HAL_Delay_WaitUs (uint32_t timeInUs)
 Delay/wait in us. More...
 
Retcode_T HAL_Delay_WaitMs (uint32_t timeInMs)
 Delay/wait in ms. More...
 

Detailed Description

By default the Delay Functions is implemented with a active blocking delay .

The us Delay is always a active waiting function, who needs a BSP_Board_DelayUs function who must implemented in the BSP. The implemented function for Delay ms will use this Function so

Using the function HAL_Delay_SetMsHook(), an RTOS Delay for ms implementation can be hooked in if needed to replace the HAL implementation.

Typedef Documentation

typedef Retcode_T(* HAL_Delay_MsHook_T)(uint32_t timeInMs)

Function data type for to handle different OS Functions by setting a new Function

Function Documentation

Retcode_T HAL_Delay_SetMsHook ( HAL_Delay_MsHook_T  hook)
Parameters
[in]hook: Pointer to new Delay ms Function
Return values
RETCODE_OKwhen successful
RETCODE_NULL_POINTERwhen any one of the param has been NULL
Retcode_T HAL_Delay_WaitMs ( uint32_t  timeInMs)

By default this function is wrapper for the BSP_Board_Delay() function. It is implements a busy wait. Using the function HAL_Delay_SetMsHook(), an RTOS delay function can be hooked in if needed to replace the busy wait with a proper RTOS delay mechanism.

Parameters
[in]timeInMs: value in ms to wait (active wait in noOS and task delay in RTOS Mode )
Return values
RETCODE_OKwhen successful
RETCODE_NULL_POINTERwhen HAL_Delay_SetMsHook() is not initialized.
Retcode_T HAL_Delay_WaitUs ( uint32_t  timeInUs)

This is just a wrapper for the BSP_Board_DelayUs() function.

Parameters
[in]timeInUs: value in us to active wait (in noOS and in RTOS Mode )
Return values
RETCODE_OKwhen successful

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