SNIP_CLASSIC_FR_SECTION_8_4_6_Fr_HaltCommunication

8.4.6 Fr_HaltCommunication [SWS_Fr_00014] Definition of API function Fr_HaltCommunication Upstream requirements: SRS_BSW_00336, SRS_Fr_05115 ⌈ Service Name Fr_HaltCommunication Syntax Std_ReturnType Fr_HaltCommunication ( uint8 Fr_CtrlIdx ) Service ID [hex] 0x04 Sync/Async Asynchronous 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 Parameters (out) None Return value Std_ReturnType E_OK: API call finished successfully. E_NOT_OK: API call aborted due to errors. Description Invokes the CC CHI command ’DEFERRED_HALT’. Available via Fr.h ⌋ Note: The Fr module’s environment shall only call the function Fr_HaltCommunication() when CC Fr_CtrlIdx is synchronous to the FlexRay global time. [SWS_Fr_00187] ⌈The function Fr_HaltCommunication() shall perform the following tasks on FlexRay CC Fr_CtrIdx: 1. Invoke the CC CHI command ’DEFERRED_HALT’2. 2. Return E_OK. ⌋ Note: The function Fr_HaltCommunication() requests the halt state which shall be reached by the end of the current FlexRay communication cycle but might not be reached immediately. [SWS_Fr_00186] ⌈If the function Fr_HaltCommunication() 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_00183] ⌈If development error detection for the Fr module is enabled, and if the function Fr_HaltCommunication() is called before the successful initialization of Fr, then the function Fr_HaltCommunication() shall raise the development error FR_E_INIT_FAILED.⌋ [SWS_Fr_00184] ⌈If development error detection for the Fr module is enabled, then the function Fr_HaltCommunication() shall check the validity of the parameter Fr_CtrlIdx. If Fr_CtrlIdx is invalid, then the function Fr_HaltCommunication() shall raise the development error FR_E_INV_CTRL_IDX.⌋ [SWS_Fr_00185] ⌈The function Fr_HaltCommunication() shall check whether the CC Fr_CtrlIdx is synchronous to the FlexRay global time. If the CC Fr_CtrlIdx is not synchronous to the FlexRay global time, then the function Fr_HaltCommunication() shall raise the runtime error FR_E_INV_POCSTATE.⌋