SNIP_CLASSIC_ETH_SECTION_8_3_14_Eth_GetCurrentTime

8.3.14 Eth_GetCurrentTime (OBSOLETE, replaced by Eth_GetCurrentTimeTuple (SWS_Eth_91017)) [SWS_Eth_00181]{OBSOLETE} Definition of API function Eth_GetCurrentTime ⌈ Service Name Eth_GetCurrentTime (obsolete) Syntax Std_ReturnType Eth_GetCurrentTime ( uint8 CtrlIdx, TimeStampQualType* timeQualPtr, TimeStampType* timeStampPtr ) Service ID [hex] 0x16 Sync/Async Synchronous Reentrancy Non Reentrant Parameters (in) CtrlIdx Index of the addresses controller. Parameters (inout) None timeQualPtr quality of HW time stamp, e.g. based on current drift Parameters (out) timeStampPtr current time stamp Return value Std_ReturnType E_OK: successful E_NOT_OK: failed Description Returns a time value out of the HW registers according to the capability of the HW. Is the HW resolution is lower than the Eth_TimeStampType resolution resp. range, than an the remaining bits will be filled with 0. Important Note: Eth_GetCurrentTime may be called within an exclusive area. Tags: atp.Status=obsolete Available via Eth.h ⌋() [SWS_Eth_00182]{OBSOLETE} ⌈If development error detection is enabled: the function shall check that the service Eth_Init was previously called. If the check fails, the function shall raise the development error ETH_E_UNINIT.⌋() [SWS_Eth_00183]{OBSOLETE} ⌈If development error detection is enabled: the function shall check the parameter CtrlIdx for being valid. If the check fails, the function shall raise the development error ETH_E_INV_CTRL_IDX.⌋() [SWS_Eth_00184]{OBSOLETE} ⌈If development error detection is enabled: the function shall check the parameter timeQualPtr and timeStampPtr for being valid. If the check fails, the function shall raise the development error ETH_E_PARAM_POINTER.⌋ () [SWS_Eth_00210]{OBSOLETE} ⌈The function shall be pre compile time configurable On/Off by the configuration parameter: EthGlobalTimeSupport.⌋() [SWS_Eth_00185]{OBSOLETE} ⌈Eth_Init() shall be called before Eth_GetCurrentTime().⌋() In case the Com-Stack is distributed across several partitions, the Ethernet stack could reside in a different partition than the StbM module calling Eth_GetCurrentTime (via EthIf_GetCurrentTime) API, means the call of Eth_GetCurrentTime could happen in another partition. [SWS_Eth_00262]{OBSOLETE} ⌈The Eth module shall apply appropriate mechanisms to allow calls of Eth_GetCurrentTime API from other partitions than its main function, e.g. by providing an Eth satellite.⌋()