SNIP_CLASSIC_ETHIF_SECTION_8_3_4_EthIf_CheckWakeup

8.3.4 EthIf_CheckWakeup [SWS_EthIf_00244] Definition of API function EthIf_CheckWakeup ⌈ Service Name EthIf_CheckWakeup Syntax Std_ReturnType EthIf_CheckWakeup ( EcuM_WakeupSourceType WakeupSource ) Service ID [hex] 0x30 Sync/Async Asynchronous Reentrancy Reentrant Parameters (in) WakeupSource Source device which initiated the wake up event. The source device could either be a Ethernet switch or a Ethernet transceiver Parameters (inout) None Parameters (out) None ▽ △ Return value Std_ReturnType E_OK when the request to check for a wake-up of the affected Ethernet hardware (e.g. PHY) has been accepted. E_NOT_OK when the request to check for a wake-up of the affected Ethernet hardware is rejected. Description This API request the affected Ethernet hardware to check for a signaled wake-up. The used Ethernet hardware could be an Ethernet switch or Ethernet transceiver (PHY). This is used e.g. for Ethernet hardware which is compliant to the specification of Open Alliance TC10. This API is called by the integration code. The function could be called in context of the interrupt or on task level. Available via EthIf.h ⌋() [SWS_EthIf_00245] ⌈For all affected Ethernet transceivers (either referenced by EthIfTransceiver or by EthIfSwitchPortGroups) the function EthIf_CheckWakeup shall forward the call to function <EthTrcv>_CheckWakeup of the respective Ethernet Transceiver Driver. The call shall be forwarded to each Ethernet transceiver only once⌋ (SRS_Eth_00106) Note:[SWS_EthIf_00245] avoids multiple calls if multiple EthIfSwitchPortGroups and/or multiple EthIfControllers reference the same EthIfTransceiver. [SWS_EthIf_00500] ⌈For all affected Ethernet switches (referenced by EthIfSwitch) the function EthIf_CheckWakeup shall forward the call to function EthSwt_SwitchCheckWakeup of the respective Ethernet Switch Driver. The call shall be forwarded to each Ethernet switch only once.⌋(SRS_Eth_00106) Note:[SWS_EthIf_00500] avoids multiple calls if multiple EthIfControllers reference the same EthIfSwitch. [SWS_EthIf_00246] ⌈If development error detection is enabled: the function shall check that the service EthIf_Init was previously called. If the check fails, the function shall raise the development error ETHIF_E_UNINIT.⌋() [SWS_EthIf_00247] ⌈If development error detection is enabled: the function shall check the parameter WakeupSource for being valid. If the check fails, the function shall raise the development error ETHIF_E_INV_PARAM.⌋()