SNIP_CLASSIC_CAN_SECTION_8_3_2_13_Can_GetIngressTimeStamp

8.3.2.13 Can_GetIngressTimeStamp [SWS_CAN_91028] Definition of API function Can_GetIngressTimeStamp Status: DRAFT Upstream requirements: SRS_Can_01181 ⌈ Service Name Can_GetIngressTimeStamp (draft) Syntax Std_ReturnType Can_GetIngressTimeStamp ( Can_HwHandleType Hrh, Can_TimeStampType* timeStampPtr ) Service ID [hex] 0x35 Sync/Async Synchronous Reentrancy Non Reentrant for the same Hrh, Reentrant for different Hrh Parameters (in) Hrh HW-receive handle for which the ingress 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 ingress time stamp on a dedicated message object. It needs to be called within the RxIndication() function. Tags: atp.Status=draft Available via Can.h ⌋ [SWS_Can_00535] 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_00536] Status: DRAFT ⌈If development error detection for the Can module is enabled: The function Can_GetIngressTimeStamp shall raise the error CAN_E_PARAM_HANDLE and shall return E_NOT_OK if the parameter Hrh is not a configured Hardware Receive Handle.⌋ [SWS_Can_00537] 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_00538] Status: DRAFT ⌈The function shall be pre-compile time configurable On/Off by the configuration parameter: CanGlobalTimeSupport.⌋ [SWS_Can_00539] Status: DRAFT ⌈Caveat: The function requires previous controller initialization (Can_Init).⌋