interface ti.sysbios.interfaces.ITimestamp

Timestamp Interface

This interface defines the methods used by client applications to get timestamp values. It is implemented by the Timestamp module.
XDCspec summary sourced in ti/sysbios/interfaces/ITimestamp.xdc
interface ITimestamp {  ...
    // inherits xdc.runtime.ITimestampClient
        // inherits xdc.runtime.IModule
XDCspec declarations sourced in ti/sysbios/interfaces/ITimestamp.xdc
 
interface ITimestamp inherits ITimestampProvider {
module-wide config parameters
module-wide functions
    override Bits32 get32// Return a 32-bit timestamp();
    override Void get64// Return a 64-bit timestamp(Types.Timestamp64 *result);
}
 
metaonly config ITimestamp.common$  // module-wide

Common module configuration parameters

XDCspec declarations sourced in ti/sysbios/interfaces/ITimestamp.xdc
metaonly config Types.Common$ common$;
 
DETAILS
All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.
 
ITimestamp.get32()  // module-wide

Return a 32-bit timestamp

XDCspec declarations sourced in ti/sysbios/interfaces/ITimestamp.xdc
override Bits32 get32();
 
RETURNS
Returns a 32-bit timestamp value. Use getFreq to convert this value into units of real time.
Returns a 32-bit timestamp value. Use getFreq to convert this value into units of real time.
SEE
 
ITimestamp.get64()  // module-wide

Return a 64-bit timestamp

XDCspec declarations sourced in ti/sysbios/interfaces/ITimestamp.xdc
override Void get64(Types.Timestamp64 *result);
 
ARGUMENTS
result — pointer to 64-bit result
This parameter is a pointer to a structure representing a 64-bit wide timestamp value where the current timestamp is written.
If the underlying hardware does not support 64-bit resolution, the hi field of result is always set to 0; see xdc.runtime.Types.Timestamp64. So, it is possible for the lo field to wrap around without any change to the hi field. Use getFreq to convert this value into units of real time.
pointer to 64-bit result
This parameter is a pointer to a structure representing a 64-bit wide timestamp value where the current timestamp is written.
If the underlying hardware does not support 64-bit resolution, the hi field of result is always set to 0; see xdc.runtime.Types.Timestamp64. So, it is possible for the lo field to wrap around without any change to the hi field. Use getFreq to convert this value into units of real time.
SEE
 
ITimestamp.getFreq()  // module-wide

Get the timestamp timer's frequency (in Hz)

XDCspec declarations sourced in ti/sysbios/interfaces/ITimestamp.xdc
override Void getFreq(Types.FreqHz *freq);
 
ARGUMENTS
freq — pointer to a 64-bit result
This parameter is a pointer to a structure representing a 64-bit wide frequency value where the timer's frequency (in Hz) is written; see xdc.runtime.Types.FreqHz. This function provides a way of converting timestamp values into units of real time.
pointer to a 64-bit result
This parameter is a pointer to a structure representing a 64-bit wide frequency value where the timer's frequency (in Hz) is written; see xdc.runtime.Types.FreqHz. This function provides a way of converting timestamp values into units of real time.
SEE
generated on Thu, 23 May 2019 00:23:08 GMT