SNIP_CLASSIC_FRTRCV_SECTION_8_3_6_FrTrcv_ClearTransceiverWakeup

8.3.6 FrTrcv_ClearTransceiverWakeup [SWS_FrTrcv_00329] Definition of API function FrTrcv_ClearTransceiverWakeup ⌈ Service Name FrTrcv_ClearTransceiverWakeup Syntax Std_ReturnType FrTrcv_ClearTransceiverWakeup ( uint8 FrTrcv_TrcvIdx ) Service ID [hex] 0x0c Sync/Async Synchronous Reentrancy Non Reentrant Parameters (in) FrTrcv_TrcvIdx This zero based index identifies the transceiver within the context of the transceiver driver to which the API call has to be applied. Parameters (inout) None Parameters (out) None Return value Std_ReturnType E_OK: will be returned if the transceiver wake up source has been cleared E_NOT_OK: will be returned if the parameter FrTrcv_TrcvIdx is out of range. Wake up state remains unchanged. Description This function clears a pending wake up event. Available via FrTrcv.h ⌋ [SWS_FrTrcv_00247] Upstream requirements: SRS_Fr_05161 ⌈The function FrTrcv_ClearTransceiverWakeup shall clear a pending wake up event on the transceiver identified by FrTrcv_TrcvIdx.⌋ [SWS_FrTrcv_00371] ⌈The API shall clear all pending wake up events under control of the higher layer. It may even be used if the wake up notification is disabled.⌋ In order to keep the transceiver driver simple, this API refers to all kinds of wake up. Further differentiation of wakeup sources requires knowledge available only to higher software layers and is out of scope of the transceiver driver. [SWS_FrTrcv_00306] Upstream requirements: SRS_Fr_05151 ⌈In case of a fault during transceiver access, the function FrTrcv_ClearTransceiverWakeup shall raise the runtime error FRTRCV_E_FR_NO_CONTROL_TRCV (see also [SWS_FrTrcv_00237]).⌋ [SWS_FrTrcv_00304] ⌈If development error detection is enabled for the module FrTrcv: if the parameter FrTrcv_TrcvIdx is out of range, the function FrTrcv_ClearTransceiverWakeup shall raise the development error code FRTRCV_E_FR_INVALID_TRCVIDX.⌋ [SWS_FrTrcv_00305] ⌈If development error detection is enabled for the module FrTrcv: if the transceiver has not been initialized, the function FrTrcv_ClearTransceiverWakeup shall raise the development error code FRTRCV_E_UNINIT.⌋