SNIP_CLASSIC_CAN_SECTION_8_3_2_12_Can_GetEgressTimeStamp

8.3.2.12 Can_GetEgressTimeStamp [SWS_CAN_91027] Definition of API function Can_GetEgressTimeStamp Status: DRAFT Upstream requirements: SRS_Can_01181 ⌈ Service Name Can_GetEgressTimeStamp (draft) Syntax Std_ReturnType Can_GetEgressTimeStamp ( PduIdType TxPduId, Can_HwHandleType Hth, Can_TimeStampType* timeStampPtr ) Service ID [hex] 0x34 Sync/Async Synchronous Reentrancy Non Reentrant for the same TxPduId. TxPduId L-PDU handle of CAN L-PDU for which the time stamp shall be returned. Parameters (in) Hth HW-transmit handle for which the egress timestamp shall be retrieved Parameters (inout) None Parameters (out) timeStampPtr current time stamp ▽ △ Return value Std_ReturnType E_OK: success E_NOT_OK: failed to read time stamp. Description Reads back the egress time stamp on a dedicated message object. It needs to be called within the TxConfirmation() function. Tags: atp.Status=draft Available via Can.h ⌋ [SWS_Can_00529] Status: DRAFT ⌈If development error detection is enabled: the function shall check that the service Can_Init was previously called. If the check fails, the function shall raise the development error CAN_E_UNINIT.⌋ [SWS_Can_00530] Status: DRAFT ⌈If development error detection is enabled: the function shall check the parameter TxPduId for being valid. If the check fails, the function shall raise the development error CAN_E_PARAM_LPDU.⌋ [SWS_Can_00531] Status: DRAFT ⌈If development error detection for the Can module is enabled: The function Can_GetEgressTimeStamp shall raise the error CAN_E_PARAM_HANDLE and shall return E_NOT_OK if the parameter Hth is not a configured Hardware Transmit Handle.⌋ [SWS_Can_00532] Status: DRAFT ⌈If development error detection is enabled: the function shall check the parameter timeStampPtr for being valid. If the check fails, the function shall raise the development error CAN_E_PARAM_POINTER.⌋ [SWS_Can_00533] Status: DRAFT ⌈The function shall be pre-compile time configurable On/Off by the configuration parameter: CanGlobalTimeSupport.⌋ [SWS_Can_00534] Status: DRAFT ⌈Caveat: The function requires previous controller initialization (Can_Init).⌋