metaonly module ti.catalog.arm.peripherals.timers.Timer
index URL
XDCscript usage meta-domain sourced in ti/catalog/arm/peripherals/timers/Timer.xdc
var Timer = xdc.useModule('ti.catalog.arm.peripherals.timers.Timer');
module-wide functions
    Timer.getAll// Find all peripherals of a certain type() returns IPeripheral.Instance[]
    Timer.getRegisters// Find all registers defined by the peripheral() returns String[]
per-instance config parameters
    var params = new Timer.Params// Instance config-params object;
        params.baseAddr// Address of the peripheral's control register = UInt undefined;
        params.intNum// Interrupt source number = UInt undefined;
        params.name// Specific peripheral name given by the device = String undefined;
        params.owner// String specifying the entity that manages the peripheral = String undefined;
 
 
Timer.getAll()  // module-wide
index URL

Find all peripherals of a certain type

XDCscript usage meta-domain
Timer.getAll() returns IPeripheral.Instance[]
 
DETAILS
The type of the peripherals returned is defined by the type of the caller.
RETURNS
Returns an array of IPeripheral instances
 
Timer.getRegisters()  // module-wide
index URL

Find all registers defined by the peripheral

XDCscript usage meta-domain
Timer.getRegisters() returns String[]
 
RETURNS
Returns an array of register names
Instance Config Parameters
index URL

XDCscript usage meta-domain
var params = new Timer.Params;
// Instance config-params object
    params.baseAddr = UInt undefined;
    // Address of the peripheral's control register
    params.intNum = UInt undefined;
    // Interrupt source number
    params.name = String undefined;
    // Specific peripheral name given by the device
    params.owner = String undefined;
    // String specifying the entity that manages the peripheral
 
config Timer.baseAddr  // instance
index URL

Address of the peripheral's control register

XDCscript usage meta-domain
var params = new Timer.Params;
  ...
params.baseAddr = UInt undefined;
 
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 Timer.intNum  // instance
index URL

Interrupt source number

XDCscript usage meta-domain
var params = new Timer.Params;
  ...
params.intNum = UInt undefined;
 
 
config Timer.name  // instance
index URL

Specific peripheral name given by the device

XDCscript usage meta-domain
var params = new Timer.Params;
  ...
params.name = String undefined;
 
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 Timer.owner  // instance
index URL

String specifying the entity that manages the peripheral

XDCscript usage meta-domain
var params = new Timer.Params;
  ...
params.owner = String undefined;
 
generated on Mon, 02 May 2011 23:04:00 GMT