ntxGetRtTimestampInfo

Returns information about the INtime timestamp counter source.

NTXSTATUS ntxGetRtTimestampInfo(
    LPTIMESTAMPINFO tsInfo
);

Parameters

tsInfo: A pointer to a buffer containing a TIMESTAMPINFO structure which will be filled in on successful completion of the call.

Remarks

The INtime timestamp counter has different sources depending on the hardware configuration of the platform. If the HPET facility is available that source is used by default since it is a single counter source of known frequency and accessible from every node on the platform. If the HPET facility is not available then the CPU timestamp counter is used. In the case of the CPU timestamp counter the values may be co-ordinated between nodes (in other words they will count at the same rate) but they will not be synchronized (they will not have exactly the same starting value).

This call returns the period of the configured timestamp counter, in femtoseconds, and flags to indicate the features of the selected source. If the flags TS_COORDINATED and TS_SYNCHRONIZED are both set then the source is guaranteed to return the same value at a given time from every node on the host.

Return Values

Returns the status value.

Status

E_OK 0x0000: No exceptional conditions occurred.
E_NOT_CONFIGURED 0x0008: No suitable timestamp source is available

Requirements

Versions	Defined in	Include	Link to
INtime 4.2	intime/rt/include/rtbase.h	rt.h	rt.lib