metaonly module ti.catalog.msp430.peripherals.pmm.PMM
index URL

MSP430 Power Management Module

XDCscript usage meta-domain sourced in ti/catalog/msp430/peripherals/pmm/PMM.xdc
var PMM = xdc.useModule('ti.catalog.msp430.peripherals.pmm.PMM');
module-wide constants & types
    var obj = new PMM.ForceSetDefaultRegister_t// Force Set Default Register;
        obj.register = String  ...
        obj.regForceSet = Bool  ...
module-wide functions
    PMM.getAll// Find all peripherals of a certain type() returns IPeripheral.Instance[]
    PMM.getRegisters// Find all registers defined by the peripheral() returns String[]
per-instance config parameters
    var params = new PMM.Params// Instance config-params object;
        params.baseAddr// Address of the peripheral's control register = 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;
 
 
struct PMM.ForceSetDefaultRegister_t
index URL

Force Set Default Register

XDCscript usage meta-domain
var obj = new PMM.ForceSetDefaultRegister_t;
 
    obj.register = String  ...
    obj.regForceSet = Bool  ...
 
DETAILS
Type to store if each register needs to be forced initialized even if the register is in default state.
SEE
ForceSetDefaultRegister_t
 
PMM.getAll()  // module-wide
index URL

Find all peripherals of a certain type

XDCscript usage meta-domain
PMM.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
 
PMM.getRegisters()  // module-wide
index URL

Find all registers defined by the peripheral

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

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

Address of the peripheral's control register

XDCscript usage meta-domain
var params = new PMM.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 PMM.name  // instance
index URL

Specific peripheral name given by the device

XDCscript usage meta-domain
var params = new PMM.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 PMM.owner  // instance
index URL

String specifying the entity that manages the peripheral

XDCscript usage meta-domain
var params = new PMM.Params;
  ...
params.owner = String undefined;
 
generated on Thu, 27 Sep 2012 23:24:41 GMT