module ti.sysbios.family.c28.TimestampProvider

Calling Context

Function Hwi Swi Task Main Startup
get32 Y Y Y Y N
get64 Y Y Y Y N
getFreq Y Y Y Y N
Definitions:
  • Hwi: API is callable from a Hwi thread.
  • Swi: API is callable from a Swi thread.
  • Task: API is callable from a Task thread.
  • Main: API is callable during any of these phases:
    • In your module startup after this module is started (e.g. TimestampProvider_Module_startupDone() returns TRUE).
    • During xdc.runtime.Startup.lastFxns.
    • During main().
    • During BIOS.startupFxns.
  • Startup: API is callable during any of these phases:
    • During xdc.runtime.Startup.firstFxns.
    • In your module startup before this module is started (e.g. TimestampProvider_Module_startupDone() returns FALSE).
C synopsis target-domain sourced in ti/sysbios/family/c28/TimestampProvider.xdc
 
config TimestampProvider_timerId  // module-wide

TimestampProvider timer id: 0, 1, or 2

C synopsis target-domain
extern const UInt TimestampProvider_timerId;
 
DETAILS
This parameter is ignored if useClockTimer is true.
 
config TimestampProvider_useClockTimer  // module-wide

Whether the TimestampProvider should share the Clock's timer

C synopsis target-domain
extern const Bool TimestampProvider_useClockTimer;
 
DETAILS
This parameter overrides the timeId setting.
Sharing the Clock timer leaves more timers available for other uses, but makes the Timestamp APIs less efficient. If the Clock timer is used, the timestamp is calculated as: (Clock ticks) x (tick period) + (current timer count) This also limits the maximum value of the timestamp: max timestamp = 2^32 x (Clock tick period)
Using a dedicated timer allows for a full 64-bit timestamp and does not require any multiplication to retrieve the value.
 
TimestampProvider_get32()  // module-wide

Return a 32-bit timestamp

C synopsis target-domain
Bits32 TimestampProvider_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
 
TimestampProvider_get64()  // module-wide

Return a 64-bit timestamp

C synopsis target-domain
Void TimestampProvider_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
 
TimestampProvider_getFreq()  // module-wide

Get the timestamp timer's frequency (in Hz)

C synopsis target-domain
Void TimestampProvider_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
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId TimestampProvider_Module_id();
// Get this module's unique id
 
Bool TimestampProvider_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle TimestampProvider_Module_heap();
// The heap from which this module allocates memory
 
Bool TimestampProvider_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 TimestampProvider_Module_getMask();
// Returns the diagnostics mask for this module
 
Void TimestampProvider_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
Configuration settings sourced in ti/sysbios/family/c28/TimestampProvider.xdc
var TimestampProvider = xdc.useModule('ti.sysbios.family.c28.TimestampProvider');
module-wide config parameters
 
 
 
config TimestampProvider.timerId  // module-wide

TimestampProvider timer id: 0, 1, or 2

Configuration settings
TimestampProvider.timerId = UInt ITimer.ANY;
 
DETAILS
This parameter is ignored if useClockTimer is true.
C SYNOPSIS
 
config TimestampProvider.useClockTimer  // module-wide

Whether the TimestampProvider should share the Clock's timer

Configuration settings
TimestampProvider.useClockTimer = Bool false;
 
DETAILS
This parameter overrides the timeId setting.
Sharing the Clock timer leaves more timers available for other uses, but makes the Timestamp APIs less efficient. If the Clock timer is used, the timestamp is calculated as: (Clock ticks) x (tick period) + (current timer count) This also limits the maximum value of the timestamp: max timestamp = 2^32 x (Clock tick period)
Using a dedicated timer allows for a full 64-bit timestamp and does not require any multiplication to retrieve the value.
C SYNOPSIS
 
metaonly config TimestampProvider.common$  // module-wide

Common module configuration parameters

Configuration settings
TimestampProvider.common$ = Types.Common$ undefined;
 
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.
generated on Fri, 10 Jun 2016 23:29:04 GMT