module ti.mcu.msp430.runtime.utils.Clock

index URL

Basic "wall clock" functions

C synopsis
Individual elements
XDCscript usage
Individual elements

C synopsis target-domain sourced in ti/mcu/msp430/runtime/utils/Clock.xdc

#include <ti/mcu/msp430/runtime/utils/Clock.h>

Functions
Void	Clock_delay// Spin for specified number of micro seconds(UInt16 usec);
Clock_TimeValue	Clock_getTime// Get the current time in Auxiliary clock ticks();
Void	Clock_sleep// Idle the CPU for specified number of micro seconds(UInt16 usec, UInt lpm);
Functions common to all target modules
	Clock_Module_getMask// Returns the diagnostics mask for this module, Clock_Module_hasMask// Test whether this module has a diagnostics mask, Clock_Module_heap// The heap from which this module allocates memory, Clock_Module_id// Get this module's unique id, Clock_Module_setMask// Set the diagnostics mask for this module, Clock_Module_startupDone// Test if this module has completed startup
Defines
#define	Clock_T0A3// (Clock_TimerRegs*)0x340
#define	Clock_T0A5// (Clock_TimerRegs*)0x340
#define	Clock_T0B7// (Clock_TimerRegs*)0x3d0
#define	Clock_T1A2// (Clock_TimerRegs*)0x180
#define	Clock_T1A3// (Clock_TimerRegs*)0x380
#define	Clock_T1A5// (Clock_TimerRegs*)0x380
#define	Clock_T2A3// (Clock_TimerRegs*)0x400
#define	Clock_TA2// (Clock_TimerRegs*)0x160
#define	Clock_TA3// (Clock_TimerRegs*)0x160
#define	Clock_TA5// (Clock_TimerRegs*)0x160
#define	Clock_TB3// (Clock_TimerRegs*)0x180
#define	Clock_TB7// (Clock_TimerRegs*)0x180
Typedefs
typedef struct	Clock_TimerRegs// Timer peripheral register definition ...
typedef UInt16	Clock_TimeValue// Time value type;
Constants
extern const Int	Clock_fastClockKHz// Main System clock frequency (KHz);
extern const Int	Clock_slowClockHz// Auxiliary clock frequency (Hz);
extern const Clock_TimerRegs *	Clock_TIMER// Base address of timer peripheral to use;

const Clock_T0A3

index URL

C synopsis target-domain

#define Clock_T0A3 (Clock_TimerRegs*)0x340

const Clock_T0A5

index URL

C synopsis target-domain

#define Clock_T0A5 (Clock_TimerRegs*)0x340

const Clock_T0B7

index URL

C synopsis target-domain

#define Clock_T0B7 (Clock_TimerRegs*)0x3d0

const Clock_T1A2

index URL

C synopsis target-domain

#define Clock_T1A2 (Clock_TimerRegs*)0x180

const Clock_T1A3

index URL

C synopsis target-domain

#define Clock_T1A3 (Clock_TimerRegs*)0x380

const Clock_T1A5

index URL

C synopsis target-domain

#define Clock_T1A5 (Clock_TimerRegs*)0x380

const Clock_T2A3

index URL

C synopsis target-domain

#define Clock_T2A3 (Clock_TimerRegs*)0x400

const Clock_TA2

index URL

C synopsis target-domain

#define Clock_TA2 (Clock_TimerRegs*)0x160

const Clock_TA3

index URL

C synopsis target-domain

#define Clock_TA3 (Clock_TimerRegs*)0x160

const Clock_TA5

index URL

C synopsis target-domain

#define Clock_TA5 (Clock_TimerRegs*)0x160

const Clock_TB3

index URL

C synopsis target-domain

#define Clock_TB3 (Clock_TimerRegs*)0x180

const Clock_TB7

index URL

C synopsis target-domain

#define Clock_TB7 (Clock_TimerRegs*)0x180

typedef Clock_TimeValue

index URL

Time value type

C synopsis target-domain

typedef UInt16 Clock_TimeValue;

struct Clock_TimerRegs

index URL

Timer peripheral register definition

C synopsis target-domain

typedef struct Clock_TimerRegs {

Bits16 CTL;

Bits16 CCTL[7];

Bits16 R;

Bits16 CCR[7];

Bits16 EX0;

Bits16 IV;

} Clock_TimerRegs;

config Clock_TIMER // module-wide

index URL

Base address of timer peripheral to use

C synopsis target-domain

extern const Clock_TimerRegs *Clock_TIMER;

DETAILS

Timer B on 2274

config Clock_fastClockKHz // module-wide

index URL

Main System clock frequency (KHz)

C synopsis target-domain

extern const Int Clock_fastClockKHz;

config Clock_slowClockHz // module-wide

index URL

Auxiliary clock frequency (Hz)

C synopsis target-domain

extern const Int Clock_slowClockHz;

Clock_delay() // module-wide

index URL

Spin for specified number of micro seconds

C synopsis target-domain

Void Clock_delay(UInt16 usec);

Clock_getTime() // module-wide

index URL

Get the current time in Auxiliary clock ticks

C synopsis target-domain

Clock_TimeValue Clock_getTime();

Clock_sleep() // module-wide

index URL

Idle the CPU for specified number of micro seconds

C synopsis target-domain

Void Clock_sleep(UInt16 usec, UInt lpm);

Module-Wide Built-Ins

index URL

C synopsis target-domain

Types_ModuleId Clock_Module_id();

// Get this module's unique id

Bool Clock_Module_startupDone();

// Test if this module has completed startup

IHeap_Handle Clock_Module_heap();

// The heap from which this module allocates memory

Bool Clock_Module_hasMask();

// Test whether this module has a diagnostics mask

Bits16 Clock_Module_getMask();

// Returns the diagnostics mask for this module

Void Clock_Module_setMask(Bits16 mask);

// Set the diagnostics mask for this module

XDCscript usage meta-domain sourced in ti/mcu/msp430/runtime/utils/Clock.xdc

var Clock = xdc.useModule('ti.mcu.msp430.runtime.utils.Clock');

module-wide constants & types

const Clock.T0A3// = 0x340;

const Clock.T0A5// = 0x340;

const Clock.T0B7// = 0x3d0;

const Clock.T1A2// = 0x180;

const Clock.T1A3// = 0x380;

const Clock.T1A5// = 0x380;

const Clock.T2A3// = 0x400;

const Clock.TA2// = 0x160;

const Clock.TA3// = 0x160;

const Clock.TA5// = 0x160;

const Clock.TB3// = 0x180;

const Clock.TB7// = 0x180;

var obj = new Clock.TimerRegs// Timer peripheral register definition;

obj.CTL = Bits16 ...

obj.CCTL = Bits16[7] ...

obj.R = Bits16 ...

obj.CCR = Bits16[7] ...

obj.EX0 = Bits16 ...

obj.IV = Bits16 ...

module-wide config parameters

Clock.TIMER// Base address of timer peripheral to use = Clock.TimerRegs* Clock.TB3;

Clock.fastClockKHz// Main System clock frequency (KHz) = Int 8000;

Clock.slowClockHz// Auxiliary clock frequency (Hz) = Int 12000;

Clock.common$// Common module configuration parameters = Types.Common$ undefined;

const Clock.T0A3

index URL

XDCscript usage meta-domain

const Clock.T0A3 = 0x340;

C SYNOPSIS

Clock_T0A3

const Clock.T0A5

index URL

XDCscript usage meta-domain

const Clock.T0A5 = 0x340;

C SYNOPSIS

Clock_T0A5

const Clock.T0B7

index URL

XDCscript usage meta-domain

const Clock.T0B7 = 0x3d0;

C SYNOPSIS

Clock_T0B7

const Clock.T1A2

index URL

XDCscript usage meta-domain

const Clock.T1A2 = 0x180;

C SYNOPSIS

Clock_T1A2

const Clock.T1A3

index URL

XDCscript usage meta-domain

const Clock.T1A3 = 0x380;

C SYNOPSIS

Clock_T1A3

const Clock.T1A5

index URL

XDCscript usage meta-domain

const Clock.T1A5 = 0x380;

C SYNOPSIS

Clock_T1A5

const Clock.T2A3

index URL

XDCscript usage meta-domain

const Clock.T2A3 = 0x400;

C SYNOPSIS

Clock_T2A3

const Clock.TA2

index URL

XDCscript usage meta-domain

const Clock.TA2 = 0x160;

C SYNOPSIS

Clock_TA2

const Clock.TA3

index URL

XDCscript usage meta-domain

const Clock.TA3 = 0x160;

C SYNOPSIS

Clock_TA3

const Clock.TA5

index URL

XDCscript usage meta-domain

const Clock.TA5 = 0x160;

C SYNOPSIS

Clock_TA5

const Clock.TB3

index URL

XDCscript usage meta-domain

const Clock.TB3 = 0x180;

C SYNOPSIS

Clock_TB3

const Clock.TB7

index URL

XDCscript usage meta-domain

const Clock.TB7 = 0x180;

C SYNOPSIS

Clock_TB7

struct Clock.TimerRegs

index URL

Timer peripheral register definition

XDCscript usage meta-domain

var obj = new Clock.TimerRegs;

obj.CTL = Bits16 ...

obj.CCTL = Bits16[7] ...

obj.R = Bits16 ...

obj.CCR = Bits16[7] ...

obj.EX0 = Bits16 ...

obj.IV = Bits16 ...

C SYNOPSIS

Clock_TimerRegs

config Clock.TIMER // module-wide

index URL

Base address of timer peripheral to use

XDCscript usage meta-domain

Clock.TIMER = Clock.TimerRegs* Clock.TB3;

DETAILS

Timer B on 2274

C SYNOPSIS

Clock_TIMER

config Clock.fastClockKHz // module-wide

index URL

Main System clock frequency (KHz)

XDCscript usage meta-domain

Clock.fastClockKHz = Int 8000;

C SYNOPSIS

Clock_fastClockKHz

config Clock.slowClockHz // module-wide

index URL

Auxiliary clock frequency (Hz)

XDCscript usage meta-domain

Clock.slowClockHz = Int 12000;

C SYNOPSIS

Clock_slowClockHz

metaonly config Clock.common$ // module-wide

index URL

Common module configuration parameters

XDCscript usage meta-domain

Clock.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 Tue, 10 Jul 2012 02:24:10 GMT