SNIP_CLASSIC_LINTRCV_SECTION_8_3_7_LinTrcv_SetWakeupMode

8.3.7 LinTrcv_SetWakeupMode [SWS_LinTrcv_00009] Definition of API function LinTrcv_SetWakeupMode ⌈ Service Name LinTrcv_SetWakeupMode Syntax Std_ReturnType LinTrcv_SetWakeupMode ( uint8 LINNetwork, LinTrcv_TrcvWakeupModeType TrcvWakupMode ) Service ID [hex] 0x05 Sync/Async Synchronous Reentrancy non Reentrant LINNetwork LIN network to which API call has to be applied Parameters (in) TrcvWakupMode Requested transceiver wakup reason. Parameters (inout) None Parameters (out) None Return value Std_ReturnType E_OK will be returned if the transceiver state has been changed to the requested mode. E_NOT_OK will be returned, if service request is failed due to wakeup mode is not set. Description This API enables, disables and clears the notification for wakeup events on the addressed network. Available via LinTrcv.h ⌋ [SWS_LinTrcv_00135] ⌈Enabled: If the function LinTrcv_SetWakeupMode is called with TrcvWakupMode == LINTRCV_WUMODE_ENABLE and if the LinTrcv module has a stored wakeup event pending for the addressed bus, the LinTrcv module shall execute the notification within the API call or immediately after (depending on the implementation).⌋ [SWS_LinTrcv_00136] ⌈Disabled: If the function LinTrcv_SetWakeupMode is called with TrcvWakupMode == LINTRCV_WUMODE_DISABLE, then the notifications for wakeup events are disabled on the addressed network. It is required by the transceiver device and the underlying communication driver to detect the wakeup events and store it internally in order to raise the event when the wakeup notification is enabled again.⌋ [SWS_LinTrcv_00137] ⌈Clear: If the function LinTrcv_SetWakeupMode is called with TrcvWakupMode == LINTRCV_WUMODE_CLEAR, then a stored wakeup event is cleared on the addressed network. Clearing of wakeup events have to be used when the wake up notification is disabled to clear all stored wake up events under control of the higher layer.⌋ [SWS_LinTrcv_00138] ⌈If there is no / incorrect communication to the transceiver, the function LinTrcv_SetWakeupMode shall return E_NOT_OK.⌋ [SWS_LinTrcv_00139] ⌈If development error detection for the module LinTrcv is enabled: If called before the LinTrcv has been initialized, the function LinTrcv_SetWakeupMode shall report development error LINTRCV_E_UNINIT.⌋ [SWS_LinTrcv_00140] ⌈If development error detection for the module LinTrcv is enabled: If called with an invalid network number LINNetwork, the function LinTrcv_SetWakeupMode shall report development error LINTRCV_E_INVALID_LIN_NETWORK.⌋