SNIP_CLASSIC_FR_SECTION_8_4_7_Fr_AbortCommunication

8.4.7 Fr_AbortCommunication [SWS_Fr_00011] Definition of API function Fr_AbortCommunication Upstream requirements: SRS_Fr_05114 ⌈ Service Name Fr_AbortCommunication Syntax Std_ReturnType Fr_AbortCommunication ( uint8 Fr_CtrlIdx ) Service ID [hex] 0x05 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. ▽ 2Invoke the command ’HALT’ for FlexRay Controllers compliant to [2]. △ 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 ’FREEZE’. Available via Fr.h ⌋ [SWS_Fr_00191] ⌈The function Fr_AbortCommunication() shall perform the following tasks on FlexRay CC Fr_CtrIdx: • Invoke the CC CHI command ’FREEZE’, which immediately aborts communication (if active) and changes to the POC:halt state from any previous POCState. • Return E_OK. ⌋ Note: The function Fr_AbortCommunication() leaves the CC Fr_CtrlIdx in POCState POC:halt (vPOC!Freeze is set). [SWS_Fr_00190] ⌈If the function Fr_AbortCommunication() 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_00188] ⌈If development error detection for the Fr module is enabled, and if the function Fr_AbortCommunication() is called before the successful initialization of Fr, then the function Fr_AbortCommunication() shall raise the development error FR_E_INIT_FAILED.⌋ [SWS_Fr_00189] ⌈If development error detection for the Fr module is enabled, then the function Fr_AbortCommunication() shall check the validity of the parameter Fr_CtrlIdx. If Fr_CtrlIdx is invalid, then the function Fr_AbortCommunication() shall raise the development error FR_E_INV_CTRL_IDX.⌋