metaonly module ti.catalog.msp430.peripherals.adc.ADC12_B
index URL

MSP430 12-bit Analog to Digital Converter

XDCscript usage meta-domain sourced in ti/catalog/msp430/peripherals/adc/ADC12_B.xdc
var ADC12_B = xdc.useModule('ti.catalog.msp430.peripherals.adc.ADC12_B');
module-wide constants & types
    var obj = new ADC12_B.ForceSetDefaultRegister_t// Force Set Default Register;
        obj.register = String  ...
        obj.regForceSet = Bool  ...
 
    var obj = new ADC12_B.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  ...
module-wide functions
    ADC12_B.getAll// Find all peripherals of a certain type() returns IPeripheral.Instance[]
    ADC12_B.getRegisters// Find all registers defined by the peripheral() returns String[]
per-instance config parameters
    var params = new ADC12_B.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 = ADC12_B.ForceSetDefaultRegister_t[] [ ];
        params.interruptSource// Interrupt enables = ADC12_B.regIntVect_t[35] undefined;
        params.name// Specific peripheral name given by the device = String undefined;
        params.owner// String specifying the entity that manages the peripheral = String undefined;
per-instance creation
    var inst = ADC12_B.create// Create an instance-object(IClock.Instance clock, params);
 
 
struct ADC12_B.ForceSetDefaultRegister_t
index URL

Force Set Default Register

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

Interrupt vector description

XDCscript usage meta-domain
var obj = new ADC12_B.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
 
ADC12_B.getAll()  // module-wide
index URL

Find all peripherals of a certain type

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

Find all registers defined by the peripheral

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

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

Address of the peripheral's control register

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

Determine if each Register needs to be forced set or not

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

Interrupt enables

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

Specific peripheral name given by the device

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

String specifying the entity that manages the peripheral

XDCscript usage meta-domain
var params = new ADC12_B.Params;
  ...
params.owner = String undefined;
 
Instance Creation
index URL

XDCscript usage meta-domain
var params = new ADC12_B.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = ADC12_B.create(IClock.Instance clock, params);
// Create an instance-object
generated on Thu, 06 Sep 2012 00:44:46 GMT