SNIP_CLASSIC_LINTRCV_SECTION_8_3_4_LinTrcv_GetBusWuReason

8.3.4 LinTrcv_GetBusWuReason [SWS_LinTrcv_00007] Definition of API function LinTrcv_GetBusWuReason Upstream requirements: SRS_BSW_00310, SRS_BSW_00369, SRS_BSW_00377, SRS_BSW_ 00406 ⌈ Service Name LinTrcv_GetBusWuReason Syntax Std_ReturnType LinTrcv_GetBusWuReason ( uint8 LinNetwork, LinTrcv_TrcvWakeupReasonType* Reason ) Service ID [hex] 0x03 Sync/Async Synchronous Reentrancy Reentrant Parameters (in) LinNetwork LIN network to which API call has to be applied Parameters (inout) None Parameters (out) Reason Pointer to wakeup reason of the bus the API is applied to. Return value Std_ReturnType E_OK: will be returned if the wake up reason is detected E_NOT_OK: will be returned, if service request is failed due to wakeup reason is not detected. Description This API provides the reason for the wakeup that the LIN transceiver has detected in the parameter "Reason". The ability to detect and differentiate the possible wakeup reasons depends strongly on the LIN transceiver hardware. Available via LinTrcv.h ⌋ [SWS_LinTrcv_00126] ⌈The function LinTrcv_GetBusWuReason shall return the reason for the wake up that the LIN transceiver has detected in the parameter Reason.⌋ [SWS_LinTrcv_00127] ⌈If there is no / incorrect communication to the transceiver, the function LinTrcv_GetBusWuReason shall return E_NOT_OK.⌋ [SWS_LinTrcv_00128] ⌈If development error detection for the module LinTrcv is enabled: If called before the LinTrcv module has been initialized, the function LinTrcv_GetBusWuReason shall report development error LINTRCV_E_UNINIT.⌋ [SWS_LinTrcv_00129] ⌈If development error detection for the module LinTrcv is enabled: If called with an invalid network number LinNetwork, the function LinTrcv_GetBusWuReason shall report development error LINTRCV_E_INVALID_LIN_NETWORK.⌋ [SWS_LinTrcv_00130] ⌈If development error detection for the module LinTrcv is enabled: If called with Reason == NULL, the function LinTrcv_GetBusWuReason shall report the development error LINTRCV_E_PARAM_POINTER.⌋ Configuration: The number of supported busses is statically set in the configuration phase. Caveats: Be aware that if more than one bus is available each bus may report a different wakeup reason. E.g. if an ECU has LIN, a wakeup by LIN may occur and the incoming data may cause an internal wakeup for another LIN bus. The LIN transceiver driver has a "per bus" 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.