SNIP_CLASSIC_CANTRCV_SECTION_8_3_17_CanIf_SetTrcvWakeupMode

8.3.17 CanIf_SetTrcvWakeupMode [SWS_CANIF_00290] Definition of API function CanIf_SetTrcvWakeupMode ⌈ Service Name CanIf_SetTrcvWakeupMode Syntax Std_ReturnType CanIf_SetTrcvWakeupMode ( uint8 TransceiverId, CanTrcv_TrcvWakeupModeType TrcvWakeupMode ) Service ID [hex] 0x10 Sync/Async Synchronous Reentrancy Non Reentrant ▽ △ TransceiverId Abstracted CanIf TransceiverId, which is assigned to a CAN transceiver, which is requested for wake up notification mode transition. Parameters (in) TrcvWakeupMode Requested transceiver wake up notification mode Parameters (inout) None Parameters (out) None Return value Std_ReturnType E_OK: Will be returned, if the wake up notifications state has been changed to the requested mode. E_NOT_OK: Will be returned, if the wake up notifications state change has failed or the parameter is out of the allowed range. The previous state has not been changed. Description This function shall call CanTrcv_SetTrcvWakeupMode. Available via CanIf.h ⌋ Note: For more details, please refer to [2, Specification of CAN Transceiver Driver]. [SWS_CANIF_00372] ⌈The function CanIf_SetTrcvWakeupMode() shall call CanTrcv_SetWakeupMode(Transceiver, TrcvWakeupMode) on the corresponding requested CanTrcv.⌋ Info: The parameters of the function CanTrcv_SetWakeupMode() are of type: • TrcvWakeupMode: CanTrcv_TrcvWakeupModeType (see [2, Specification of CAN Transceiver Driver]) • Transceiver: uint8 (Transceiver to which API call has to be applied) (see [2, Specification of CAN Transceiver Driver]) Note: The following three paragraphs are already described in the Specification of CanTrcv (see [2]). They describe the behavior of a CanTrcv in the respective transceiver wake-up mode, which is requested in parameter TrcvWakeupMode. CANIF_TRCV_WU_ENABLE: If the CanTrcv has a stored wake-up event pending for the addressed CanNetwork, the notification is executed within or immediately after the function CanTrcv_SetTrcvWakeupMode() (depending on the implementation). CANIF_TRCV_WU_DISABLE: No notifications for wake-up events for the addressed CanNetwork are passed through the CanTrcv. The transceiver device and the underlying communication driver has to buffer detected wake-up events and raise the event(s), when the wake-up notification is enabled again. CANIF_TRCV_WU_CLEAR: If notification of wake-up events is disabled (see description of mode CANIF_TRCV_ WU_DISABLE), detected wake-up events are buffered. Calling CanIf_SetTrcvWakeupMode() with parameter CANIF_TRCV_WU_CLEAR clears these bufferd events. Clearing of wake-up events has to be used, when the wake-up notification is disabled to clear all stored wake-up events under control of the higher layers of the CanTrcv. [SWS_CANIF_00535] Upstream requirements: SRS_BSW_00323 ⌈If parameter TransceiverId of CanIf_SetTrcvWakeupMode() has an invalid value, the CanIf shall report development error code CANIF_E_PARAM_TRCV to the Det_ReportError service of the DET module, when CanIf_SetTrcvWakeupMode () is called.⌋ [SWS_CANIF_00536] Upstream requirements: SRS_BSW_00323 ⌈If parameter TrcvWakeupMode of CanIf_SetTrcvWakeupMode() has an invalid value, the CanIf shall report development error code CANIF_E_PARAM_TRCVWAKEUPMODE to the Det_ReportError service of the DET module, when CanIf_SetTrcvWakeupMode() is called.⌋ [SWS_CANIF_00373] ⌈Configuration of CanIf_SetTrcvWakeupMode(): The number of supported transceiver types for each network is set up in the configuration phase (see CanIfTrcvCfg and CanIfTrcvDrvCfg). If no transceiver is used, this function may be omitted. Therefore, if no transceiver is configured in LT or PB class the API shall return with E_NOT_OK.⌋