SNIP_CLASSIC_FR_SECTION_8_4_8_Fr_SendWUP

8.4.8 Fr_SendWUP [SWS_Fr_00009] Definition of API function Fr_SendWUP Upstream requirements: SRS_Fr_05117 ⌈ Service Name Fr_SendWUP Syntax Std_ReturnType Fr_SendWUP ( uint8 Fr_CtrlIdx ) Service ID [hex] 0x06 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 ’WAKEUP’. Available via Fr.h ⌋ Note: The Fr module’s environment shall only call Fr_SendWUP() when CC Fr_CtrlIdx is in POCState ’POC:ready’. [SWS_Fr_00196] ⌈The function Fr_SendWUP() shall perform the following tasks on FlexRay CC Fr_CtrIdx: 1. Invoke the CC CHI command ’WAKEUP’, which initiates the wakeup transmission procedure on the configured FlexRay channel. 2. Return E_OK. ⌋ Note: The function Fr_SendWUP() changes the CC Fr_CtrlIdx POCState to POC:wakeup, which is a transitional state. After wakeup procedure completion, the CC will reach POC:ready again. Note: Sending a wakeup pattern does not necessarily cause all cluster nodes to be awoken afterwards. The function Fr_SendWUP() just invokes the wakeup symbol transmission procedure on a certain FlexRay CC. [SWS_Fr_00195] ⌈If the function Fr_SendWUP() 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_00192] ⌈If development error detection for the Fr module is enabled, and if the function Fr_SendWUP() is called before the successful initialization of Fr, then the function Fr_SendWUP() shall raise the development error FR_E_INIT_FAILED.⌋ [SWS_Fr_00193] ⌈If development error detection for the Fr module is enabled, then the function Fr_SendWUP() shall check the validity of the parameter Fr_CtrlIdx. If Fr_CtrlIdx is invalid, then the function Fr_SendWUP() shall raise the development error FR_E_INV_CTRL_IDX.⌋ [SWS_Fr_00194] ⌈The function Fr_SendWUP() shall check whether the CC Fr_CtrlIdx’s POCState is POC:ready. If the POCState is not POC:ready, then the function Fr_SendWUP() shall raise the runtime error FR_E_INV_POCSTATE.⌋