interface ti.catalog.msp430.peripherals.timer.ITimer

metaonly interface ti.catalog.msp430.peripherals.timer.ITimer

MSP430 ITimer interface

XDCspec summary sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

metaonly interface ITimer { ...

// inherits xdc.platform.IPeripheral

instance: ...

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

package ti.catalog.msp430.peripherals.timer;

metaonly interface ITimer inherits IPeripheral {

module-wide constants & types

typedef IPeripheral.Instance IPeripheralArray// [];

typedef String StringArray// [];

metaonly struct ForceSetDefaultRegister_t// Force Set Default Register {

String register;

Bool regForceSet;

};

metaonly struct regIntVect_t// Interrupt vector description {

String registerName;

String registerDescription;

String isrToggleString;

String priorityName;

Bool interruptEnable;

Bool interruptHandler;

Int priority;

};

module-wide functions

IPeripheral.IPeripheralArray getAll// Find all peripherals of a certain type();

IPeripheral.StringArray getRegisters// Find all registers defined by the peripheral();

instance:

per-instance config parameters

config UInt baseAddr// Address of the peripheral's control register;

config UInt intNum// Interrupt source number;

config Bool isInternal// Boolean that is true if a Timer is internal, meaning it has no external inputs or outputs = false;

config String name// Specific peripheral name given by the device;

config UChar numberOfTimers// Stores the number of available timer capture compare blocks;

config String owner// String specifying the entity that manages the peripheral;

per-instance creation

create// Create an instance-object(IClock.Instance clock);

per-instance functions

Bits16 getTxxCCRx// Returns TxxCCRx register value based on which CCR register(UChar ccrNumber);

Void setTxxCCRx// Sets TxxCCRx register value based on which CCR register(UChar ccrNumber, Bits16 value);

}

typedef ITimer.IPeripheralArray

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

typedef IPeripheral.Instance IPeripheralArray[];

typedef ITimer.StringArray

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

typedef String StringArray[];

struct ITimer.ForceSetDefaultRegister_t

Force Set Default Register

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

metaonly struct ForceSetDefaultRegister_t {

String register;

Bool regForceSet;

};

DETAILS

Type to store if each register needs to be forced initialized even if the register is in default state.

SEE

ForceSetDefaultRegister_t

struct ITimer.regIntVect_t

Interrupt vector description

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

metaonly struct regIntVect_t {

String registerName;

String registerDescription;

String isrToggleString;

String priorityName;

Bool interruptEnable;

Bool interruptHandler;

Int priority;

};

DETAILS

Type to describe a single interrupt vector pin and all its possible configurations.

SEE

ITimer.getAll() // module-wide

Find all peripherals of a certain type

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

IPeripheral.IPeripheralArray getAll();

DETAILS

The type of the peripherals returned is defined by the type of the caller.

RETURNS

Returns an array of IPeripheral instances

ITimer.getRegisters() // module-wide

Find all registers defined by the peripheral

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

IPeripheral.StringArray getRegisters();

RETURNS

Returns an array of register names

config ITimer.baseAddr // instance

Address of the peripheral's control register

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

config UInt baseAddr;

DETAILS

A peripheral's registers are commonly accessed through a structure that defines the offsets of a particular register from the lowest address mapped to a peripheral. That lowest address is specified by this parameter.

config ITimer.intNum // instance

Interrupt source number

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

config UInt intNum;

config ITimer.isInternal // instance

Boolean that is true if a Timer is internal, meaning it has no external inputs or outputs

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

config Bool isInternal = false;

config ITimer.name // instance

Specific peripheral name given by the device

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

config String name;

DETAILS

Devices can have more than one peripheral of the same type. In such cases, device data sheets give different names to the instances of a same peripheral. For example, the name for a timer module could be TimerA3, and a device that has two such timers can name them TA0 and TA1.

config ITimer.numberOfTimers // instance

Stores the number of available timer capture compare blocks

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

config UChar numberOfTimers;

config ITimer.owner // instance

String specifying the entity that manages the peripheral

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

config String owner;

Instance Creation

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

create(IClock.Instance clock);

// Create an instance-object

ITimer.getTxxCCRx() // instance

Returns TxxCCRx register value based on which CCR register

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

Bits16 getTxxCCRx(UChar ccrNumber);

SEE

ITimer.setTxxCCRx() // instance

Sets TxxCCRx register value based on which CCR register

XDCspec declarations sourced in ti/catalog/msp430/peripherals/timer/ITimer.xdc

Void setTxxCCRx(UChar ccrNumber, Bits16 value);

SEE

generated on Thu, 27 Sep 2012 23:24:47 GMT