SNIP_CLASSIC_LINIF_SECTION_8_2_6_LinIf_Wakeup

8.2.6 LinIf_Wakeup [SWS_LinIf_00205] Definition of API function LinIf_Wakeup Upstream requirements: SRS_Lin_01515 ⌈ Service Name LinIf_Wakeup Syntax Std_ReturnType LinIf_Wakeup ( NetworkHandleType Channel ) Service ID [hex] 0x07 Sync/Async Asynchronous Reentrancy Reentrant Parameters (in) Channel Identification of the LIN channel. Parameters (inout) None Parameters (out) None Return value Std_ReturnType E_OK: Request to wake up has been accepted or the controller is not in sleep state. E_NOT_OK: Request to wake up has not been accepted due to one or more of the following reasons: - LIN Interface has not been initialized - referenced channel does not exist (identification is out of range) - Lin_Wakeup has returned E_NOT_OK - Lin_WakeupInternal has returned E_NOT_OK Description Initiates the wake up process. Available via LinIf.h ⌋ [SWS_LinIf_00432] ⌈When the referenced Channel is not in the sleep state, the function LinIf_Wakeup will not forward the call to the LIN driver. In this case, it will simulate a successful wakeup by returning E_OK.⌋ [SWS_LinIf_00296] ⌈The function LinIf_Wakeup shall call the function Lin_Wakeup of the LIN Driver module to transmit a wake-up request on the selected Channel, if the Channel is in the channel state LINIF_CHANNEL_SLEEP and the wakeup flag of the selected Channel is not set. (see [SWS_LinIf_00716])⌋ [SWS_LinIf_00713] ⌈The function LinIf_Wakeup shall call the function Lin_WakeupInternal of the LIN Driver module to set selected Channel to the wakeup state, if the Channel is in the channel state LINIF_CHANNEL_SLEEP and the wakeup flag of the selected Channel is set. (see [SWS_LinIf_00716])⌋ [SWS_LinIf_00714] ⌈The function LinIf_Wakeup shall clear the wakeup flag of the selected Channel.⌋ [SWS_LinIf_00720] ⌈If the function Lin_Wakeup returns E_NOT_OK, the function LinIf_Wakeup shall return E_NOT_OK and not change the status of the wakeup flag.⌋ [SWS_LinIf_00721] ⌈If the function Lin_WakeupInternal returns E_NOT_OK, the function LinIf_Wakeup shall return E_NOT_OK and not change the status of the wakeup flag.⌋ [SWS_LinIf_00565] ⌈If development error detection is enabled and an invalid Channel is given, the function LinIf_Wakeup shall raise the development error code LINIF_E_NONEXISTENT_CHANNEL.⌋ Caveats: The LIN Interface has to be initialized with a call of LinIf_Init before this API service may be called, see [SRS_BSW_00487].