SNIP_CLASSIC_FRIF_SECTION_8_3_3_FrIf_SetAbsoluteTimer

8.3.3 FrIf_SetAbsoluteTimer [SWS_FrIf_05021] Definition of API function FrIf_SetAbsoluteTimer ⌈ Service Name FrIf_SetAbsoluteTimer Syntax Std_ReturnType FrIf_SetAbsoluteTimer ( uint8 FrIf_CtrlIdx, uint8 FrIf_AbsTimerIdx, uint8 FrIf_Cycle, uint16 FrIf_Offset ) Service ID [hex] 0x19 Sync/Async Synchronous Reentrancy non reentrant for the same FlexRay CC, reentrant for different FlexRay CCs FrIf_CtrlIdx Index of the FlexRay CC to address. FrIf_AbsTimerIdx Index of the absolute timer to address. FrIf_Cycle FlexRay Cycle number to be set. Parameters (in) FrIf_Offset Number of Macroticks to be set. Parameters (inout) None Parameters (out) None Return value Std_ReturnType E_OK: The call of the FlexRay Driver’s API service has returned E_OK. E_NOT_OK: The call of the FlexRay Driver’s API service has returned E_NOT_OK, or an error has been detected in development mode. Description Wraps the FlexRay Driver API function Fr_SetAbsoluteTimer(). Available via FrIf.h ⌋ [SWS_FrIf_05234] ⌈If parameter FrIf_CtrlIdx of FrIf_SetAbsoluteTimer has an invalid value and if development error detection is enabled (i.e. FrIfDevErrorDetect equals ON), the function FrIf_SetAbsoluteTimer shall report development error code FRIF_E_ INV_CTRL_IDX to the Det_ReportError service of the DET module.⌋ [SWS_FrIf_05235] ⌈The function FrIf_SetAbsoluteTimer shall wrap This API service of the FlexRay Interface wraps the FlexRay Driver API function Fr_SetAbsoluteTimer() by: 1. Translating (based on static FrIf module configuration) the FlexRay CC index Fr If_CtrlIdx into a tuple (FlexRay Driver | Driver-specific CC index Fr_CtrlIdx). 2. Setting parameters 3. Fr_AbsTimerIdx to FrIf_AbsTimerIdx 4. Fr_Cycle to FrIf_Cycle 5. Fr_Offset to FrIf_Offset 6. Calling Fr_SetAbsoluteTimer() of the determined FlexRay Driver module with the parameters determined as described above. ⌋ [SWS_FrIf_05236] ⌈Caveats of FrIf_SetAbsoluteTimer: The FlexRay Interface module has to be initialized with a call of FrIf_Init() before this API service may be called, see [SWS_FrIf_05003].⌋