metaonly module ti.catalog.msp430.peripherals.dma.DMA
index URL

MSP430 DMA controller

XDCscript usage meta-domain sourced in ti/catalog/msp430/peripherals/dma/DMA.xdc
var DMA = xdc.useModule('ti.catalog.msp430.peripherals.dma.DMA');
module-wide constants & types
    var obj = new DMA.ForceSetDefaultRegister_t// Force Set Default Register;
        obj.register = String  ...
        obj.regForceSet = Bool  ...
 
    var obj = new DMA.regIntVect_t// Interrupt vector description;
        obj.registerName = String  ...
        obj.registerDescription = String  ...
        obj.isrToggleString = String  ...
        obj.priorityName = String  ...
        obj.interruptEnable = Bool  ...
        obj.interruptHandler = Bool  ...
        obj.priority = Int  ...
 
    var obj = new DMA.regTriggerVect_t// Trigger vector description;
        obj.channel = Int  ...
        obj.triggerName = String  ...
        obj.value = Int  ...
module-wide functions
    DMA.getAll// Find all peripherals of a certain type() returns IPeripheral.Instance[]
    DMA.getRegisters// Find all registers defined by the peripheral() returns String[]
per-instance config parameters
    var params = new DMA.Params// Instance config-params object;
        params.baseAddr// Address of the peripheral's control register = UInt undefined;
        params.forceSetDefaultRegister// Determine if each Register needs to be forced set or not = DMA.ForceSetDefaultRegister_t[] [ ];
        params.interruptSource// DMA interrupt enables = DMA.regIntVect_t[8] undefined;
        params.name// Specific peripheral name given by the device = String undefined;
        params.numberOfChannels//  = UInt undefined;
        params.owner// String specifying the entity that manages the peripheral = String undefined;
        params.triggerSource//  = DMA.regTriggerVect_t[32][8] undefined;
 
 
struct DMA.ForceSetDefaultRegister_t
index URL

Force Set Default Register

XDCscript usage meta-domain
var obj = new DMA.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
 
struct DMA.regIntVect_t
index URL

Interrupt vector description

XDCscript usage meta-domain
var obj = new DMA.regIntVect_t;
 
    obj.registerName = String  ...
    obj.registerDescription = String  ...
    obj.isrToggleString = String  ...
    obj.priorityName = String  ...
    obj.interruptEnable = Bool  ...
    obj.interruptHandler = Bool  ...
    obj.priority = Int  ...
 
DETAILS
Type to describe a single interrupt vector pin and all its possible configurations.
SEE
regIntVect_t
 
struct DMA.regTriggerVect_t
index URL

Trigger vector description

XDCscript usage meta-domain
var obj = new DMA.regTriggerVect_t;
 
    obj.channel = Int  ...
    obj.triggerName = String  ...
    obj.value = Int  ...
 
 
DMA.getAll()  // module-wide
index URL

Find all peripherals of a certain type

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

Find all registers defined by the peripheral

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

XDCscript usage meta-domain
var params = new DMA.Params;
// Instance config-params object
    params.baseAddr = UInt undefined;
    // Address of the peripheral's control register
    params.forceSetDefaultRegister = DMA.ForceSetDefaultRegister_t[] [ ];
    // Determine if each Register needs to be forced set or not
    params.interruptSource = DMA.regIntVect_t[8] undefined;
    // DMA interrupt enables
    params.name = String undefined;
    // Specific peripheral name given by the device
    params.numberOfChannels = UInt undefined;
    // 
    params.owner = String undefined;
    // String specifying the entity that manages the peripheral
    params.triggerSource = DMA.regTriggerVect_t[32][8] undefined;
    // 
 
config DMA.baseAddr  // instance
index URL

Address of the peripheral's control register

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

Determine if each Register needs to be forced set or not

XDCscript usage meta-domain
var params = new DMA.Params;
  ...
const params.forceSetDefaultRegister = DMA.ForceSetDefaultRegister_t[] [ ];
 
 
config DMA.interruptSource  // instance
index URL

DMA interrupt enables

XDCscript usage meta-domain
var params = new DMA.Params;
  ...
params.interruptSource = DMA.regIntVect_t[8] undefined;
 
 
config DMA.name  // instance
index URL

Specific peripheral name given by the device

XDCscript usage meta-domain
var params = new DMA.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 DMA.numberOfChannels  // instance
index URL
XDCscript usage meta-domain
var params = new DMA.Params;
  ...
params.numberOfChannels = UInt undefined;
 
 
config DMA.owner  // instance
index URL

String specifying the entity that manages the peripheral

XDCscript usage meta-domain
var params = new DMA.Params;
  ...
params.owner = String undefined;
 
 
config DMA.triggerSource  // instance
index URL
XDCscript usage meta-domain
var params = new DMA.Params;
  ...
params.triggerSource = DMA.regTriggerVect_t[32][8] undefined;
 
generated on Thu, 27 Sep 2012 23:24:00 GMT