metaonly module ti.catalog.msp430.peripherals.frctl.FRCTL
index URL

MSP430 FRAM controller (FRCTL)

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

Force Set Default Register

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

Find all peripherals of a certain type

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

Find all registers defined by the peripheral

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

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

Address of the peripheral's control register

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

Determine if each Register needs to be forced set or not

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

Specific peripheral name given by the device

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

String specifying the entity that manages the peripheral

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

XDCscript usage meta-domain
var params = new FRCTL.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = FRCTL.create(IClock.Instance clock, params);
// Create an instance-object
generated on Fri, 14 Sep 2012 21:30:16 GMT