SNIP_CLASSIC_CANTRCV_SECTION_8_3_8_CanTrcv_ClearTrcvWufFlag

8.3.8 CanTrcv_ClearTrcvWufFlag [SWS_CanTrcv_00214] Definition of API function CanTrcv_ClearTrcvWufFlag Upstream requirements: SRS_Can_01157 ⌈ Service Name CanTrcv_ClearTrcvWufFlag Syntax Std_ReturnType CanTrcv_ClearTrcvWufFlag ( uint8 Transceiver ) Service ID [hex] 0x0a Sync/Async Synchronous Reentrancy Reentrant for different transceivers Parameters (in) Transceiver CAN Transceiver ID. Parameters (inout) None Parameters (out) None Return value Std_ReturnType E_OK: will be returned if the WUF flag has been cleared. E_NOT_OK: will be returned if the WUF flag has not been cleared or a development error occurs. Description Clears the WUF flag in the transceiver hardware. This API shall exist only if CanTrcvHwPn Support = TRUE. Available via CanTrcv.h ⌋ [SWS_CanTrcv_00194] ⌈The function CanTrcv_ClearTrcvWufFlag shall clear the wakeup flag in the CAN transceiver. If successful, E_OK shall be returned. Implementation Hints: This API shall be used by the CanSM module for ensuring that no frame wakeup event is lost, during entering a low-power mode. This API clears the WUF flag. The CAN transceiver shall be shall be put into Standby mode (CANTRCV_STANDBY) after clearing of the WUF flag. If a system error (SYSERR, e.g. configuration error) occurs while selective wakeup functionality is being enabled, transceiver will disable the functionality. Transceiver will wake up on the next CAN wake pattern (WUP). In case of any other hardware error (e.g. frame detection error), transceiver will wake up if the error counter inside the transceiver overflows.⌋ [SWS_CanTrcv_00195] ⌈CanTrcv shall inform CanIf that the wakeup flag has been cleared for the requested Transceiver, through the callback notification CanIf_ClearTrcvWufFlagIndication referring to the corresponding CAN transceiver with the abstract CanIf TransceiverId.⌋ [SWS_CanTrcv_00196] ⌈If there is no/incorrect communication to the transceiver, the function CanTrcv_ClearTrcvWufFlag shall report the runtime error CANTRCV_E_ NO_TRCV_CONTROL to the Default Error Tracer and return E_NOT_OK.⌋ [SWS_CanTrcv_00197] ⌈If development error detection is enabled for the CanTrcv module: if called before the CanTrcv has been initialized, the function CanTrcv_ClearTrcvWufFlag shall raise development error CANTRCV_E_UNINIT otherwise (if DET is disabled) return E_NOT_OK.⌋ [SWS_CanTrcv_00198] ⌈If development error detection is enabled for the CanTrcv module: if called with an invalid transceiver ID for parameter Transceiver, function CanTrcv_ClearTrcvWufFlag shall raise the development error CANTRCV_E_ INVALID_TRANSCEIVER otherwise (if DET is disabled) return E_NOT_OK.⌋