module ti.sysbios.family.msp430.TimestampProvider

MSP430 Timestamp Provider

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
C synopsis target-domain sourced in ti/sysbios/family/msp430/TimestampProvider.xdc
 
enum TimestampProvider_Source

Input clock sources for dedicated Timestamp timer

C synopsis target-domain
typedef enum TimestampProvider_Source {
    TimestampProvider_Source_ACLK,
    // ACLK
    TimestampProvider_Source_SMCLK
    // SMCLK
} TimestampProvider_Source;
 
 
config TimestampProvider_clockSource  // module-wide

Input clock source for dedicated timer

C synopsis target-domain
extern const TimestampProvider_Source TimestampProvider_clockSource;
 
DETAILS
If the TimestampProvider is to use a different timer than the one used by the Clock module, this parameter specifies the input clock source for that dedicated timer.
For example, to use a dedicated timer for Timestamps, and to have it run off of SMCLK, add the following to the application config script:
  var Timestamp = xdc.useModule('ti.sysbios.family.msp430.TimestampProvider');
  Timestamp.useClockTimer = false;
  Timestamp.clockSource = Timestamp.Source_SMCLK;
 
config TimestampProvider_timerId  // module-wide

Id of the timer to use for creating timestamps

C synopsis target-domain
extern const UInt TimestampProvider_timerId;
 
DETAILS
A value of Timer.ANY (-1) indicates any timer supported by Timer is ok.
 
config TimestampProvider_useClockTimer  // module-wide

Use the same timer as Clock

C synopsis target-domain
extern const Bool TimestampProvider_useClockTimer;
 
DETAILS
Set this parameter when you want TimestampProvider to use the same timer as the BIOS Clock module.
This parameter overrides the timeId setting.
 
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.
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.
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.
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
 
XDCscript usage meta-domain sourced in ti/sysbios/family/msp430/TimestampProvider.xdc
 
enum TimestampProvider.Source

Input clock sources for dedicated Timestamp timer

XDCscript usage meta-domain
values of type TimestampProvider.Source
    const TimestampProvider.Source_ACLK;
    // ACLK
    const TimestampProvider.Source_SMCLK;
    // SMCLK
 
C SYNOPSIS
 
config TimestampProvider.clockSource  // module-wide

Input clock source for dedicated timer

XDCscript usage meta-domain
TimestampProvider.clockSource = TimestampProvider.Source TimestampProvider.Source_ACLK;
 
DETAILS
If the TimestampProvider is to use a different timer than the one used by the Clock module, this parameter specifies the input clock source for that dedicated timer.
For example, to use a dedicated timer for Timestamps, and to have it run off of SMCLK, add the following to the application config script:
  var Timestamp = xdc.useModule('ti.sysbios.family.msp430.TimestampProvider');
  Timestamp.useClockTimer = false;
  Timestamp.clockSource = Timestamp.Source_SMCLK;
C SYNOPSIS
 
config TimestampProvider.timerId  // module-wide

Id of the timer to use for creating timestamps

XDCscript usage meta-domain
TimestampProvider.timerId = UInt ITimer.ANY;
 
DETAILS
A value of Timer.ANY (-1) indicates any timer supported by Timer is ok.
C SYNOPSIS
 
config TimestampProvider.useClockTimer  // module-wide

Use the same timer as Clock

XDCscript usage meta-domain
TimestampProvider.useClockTimer = Bool undefined;
 
DETAILS
Set this parameter when you want TimestampProvider to use the same timer as the BIOS Clock module.
This parameter overrides the timeId setting.
C SYNOPSIS
 
metaonly config TimestampProvider.common$  // module-wide

Common module configuration parameters

XDCscript usage meta-domain
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 Thu, 01 Mar 2012 16:57:24 GMT