SNIP_CLASSIC_LINIF_SECTION_8_2_9_LinIf_GetTrcvWakeupReason

8.2.9 LinIf_GetTrcvWakeupReason [SWS_LinIf_00547] Definition of API function LinIf_GetTrcvWakeupReason Upstream requirements: SRS_Lin_01588 ⌈ Service Name LinIf_GetTrcvWakeupReason Syntax Std_ReturnType LinIf_GetTrcvWakeupReason ( NetworkHandleType Channel, LinTrcv_TrcvWakeupReasonType* TrcvWuReasonPtr ) Service ID [hex] 0x0a Sync/Async Synchronous Reentrancy Reentrant Parameters (in) Channel Identification of the LIN channel Parameters (inout) None Parameters (out) TrcvWuReasonPtr Pointer to a memory location where output value will be stored. Return value Std_ReturnType E_OK: The call of the LIN Transceiver Driver’s API service has returned E_OK. E_NOT_OK: The call of the LIN Transceiver Driver’s API service has returned E_NOT_OK or channel parameter is invalid or pointer is NULL. Description Returns the reason for the wake up that has been detected by the LIN Transceiver Driver. Available via LinIf.h ⌋ [SWS_LinIf_00548] ⌈This API shall return the reason for the wake up that the LIN Transceiver Driver has detected by invoking the underlying function LinTrcv_GetBusWuReason(LinNetwork, Reason) for the corresponding requested LIN transceiver.⌋ [SWS_LinIf_00549] ⌈If development error detection is enabled and an invalid value for Channel is given, the function LinIf_GetTrcvWakeupReason shall report LINIF_E_NONEXISTENT_CHANNEL to the default error tracer.⌋ [SWS_LinIf_00573] ⌈If development error detection is enabled and the parameter TrcvWuReasonPtr has an invalid value, the function LinIf_GetTrcvWakeupReason shall raise the development error code LINIF_E_PARAM_POINTER.⌋ [SWS_LinIf_00572] ⌈If development error detection is enabled and the current mode is not LINTRCV_TRCV_MODE_NORMAL, the function LinIf_GetTrcvWakeupReason shall report LINIF_E_TRCV_NOT_NORMAL to the default error tracer.⌋ [SWS_LinIf_00636] ⌈The function LinIf_GetTrcvWakeupReason is required only if at least one LIN channel uses the LIN transceiver driver. This function shall be pre-compile time configurable On/Off by the configuration parameter LinIfTrcvDriverSupported.⌋ 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]. • Please be aware, that if more than one network is available, each network may report a different wake up reason. This API has a“per network” view and does not vote the more important reason or sequence internally. The same may be true if e.g. one transceiver controls the power supply and the other is just powered or un-powered. Then one may be able to return LINTRCV_WU_POWER_ON, whereas the other may state e.g. LINTRCV_WU_RESET. It is up to the EcuM to decide how to handle that wake up information.