SNIP_CLASSIC_FR_SECTION_8_4_18_Fr_GetGlobalTime

8.4.18 Fr_GetGlobalTime [SWS_Fr_00042] Definition of API function Fr_GetGlobalTime Upstream requirements: SRS_Fr_05019 ⌈ Service Name Fr_GetGlobalTime Syntax Std_ReturnType Fr_GetGlobalTime ( uint8 Fr_CtrlIdx, uint8* Fr_CyclePtr, uint16* Fr_MacroTickPtr ) Service ID [hex] 0x10 Sync/Async Synchronous Reentrancy Non Reentrant for the same device Parameters (in) Fr_CtrlIdx Index of FlexRay CC within the context of the FlexRay Driver. Parameters (inout) None Fr_CyclePtr Address where the current FlexRay communication cycle value shall be stored. Parameters (out) Fr_MacroTickPtr Address where the current macrotick value shall be stored. Return value Std_ReturnType E_OK: API call finished successfully. E_NOT_OK: API call aborted due to errors. Description Gets the current global FlexRay time. Important Note: Fr_GetGlobalTime may be called within an exclusive area. Available via Fr.h ⌋ Note: The Fr module’s environment shall only call Fr_GetGlobalTime() if the CC Fr_CtrlIdx is synchronous to FlexRay global time. [SWS_Fr_00256] ⌈The function Fr_GetGlobalTime() shall perform the following tasks on FlexRay CC Fr_CtrIdx: 1. Read the current global FlexRay time and write it to the output parameters Fr_CyclePtr and Fr_MacrotickPtr. 2. Return E_OK. ⌋ [SWS_Fr_00257] ⌈The function Fr_GetGlobalTime() shall ensure that the time information is consistent and valid. This means that the values returned of both parameters (Fr_CyclePtr and Fr_MacrotickPtr) must be taken from a single point in time. The resulting global time shall always strictly increase over time (until it wraps around at the time-boundary).⌋ [SWS_Fr_00044] Upstream requirements: SRS_Fr_05072 ⌈The function Fr_GetGlobalTime() shall ensure that the time information is valid and up to date (synchronized CC), - otherwise the output parameters shall not be written and E_NOT_OK returned.⌋ [SWS_Fr_00255] ⌈If the function Fr_GetGlobalTime() is able to and detects a hardware error while performing the requested functionality, then it shall call Dem_SetEventStatus() (FR_E_CTRL_TESTRESULT, DEM_EVENT_STATUS_FAILED) and return E_NOT_OK.⌋ [SWS_Fr_00251] ⌈If development error detection for the Fr module is enabled, and if the function Fr_GetGlobalTime() is called before the successful initialization of Fr, then the function Fr_GetGlobalTime() shall raise the development error FR_E_INIT_FAILED.⌋ [SWS_Fr_00252] ⌈If development error detection for the Fr module is enabled, then the function Fr_GetGlobalTime() shall check the validity of the parameter Fr_CtrlIdx. If Fr_CtrlIdx is invalid, then the function Fr_GetGlobalTime() shall raise the development error FR_E_INV_CTRL_IDX.⌋ [SWS_Fr_00253] ⌈If development error detection for the Fr module is enabled, then the function Fr_GetGlobalTime() shall check whether the parameter Fr_CyclePtr is a NULL pointer (NULL_PTR). If Fr_CyclePtr is a NULL pointer, the function Fr_ GetGlobalTime() shall raise the development error FR_E_PARAM_POINTER.⌋ [SWS_Fr_00254] ⌈If development error detection for the Fr module is enabled, then the function Fr_GetGlobalTime() shall check whether the parameter Fr_MacroTickPtr is a NULL pointer (NULL_PTR). If Fr_MacroTickPtr is a NULL pointer, the function Fr_GetGlobalTime() shall raise the development error FR_E_PARAM_POINTER.⌋