metaonly module ti.catalog.msp430.peripherals.frctl.FRCTL |
![](../../../../../Arrow_left.png) |
![](../../../../../Arrow_up.png) |
MSP430 FRAM controller (FRCTL)
var FRCTL = xdc.useModule('ti.catalog.msp430.peripherals.frctl.FRCTL');
module-wide constants & types
module-wide functions
per-instance config parameters
per-instance creation
struct FRCTL.ForceSetDefaultRegister_t |
![](../../../../../Arrow_up.png) |
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
FRCTL.getAll() // module-wide |
![](../../../../../Arrow_up.png) |
Find all peripherals of a certain type
XDCscript usage |
meta-domain |
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 |
![](../../../../../Arrow_up.png) |
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 |
![](../../../../../Arrow_up.png) |
XDCscript usage |
meta-domain |
var params = new FRCTL.Params;
// Instance config-params object
params.baseAddr = UInt undefined;
// Address of the peripheral's control register
// 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 |
![](../../../../../Arrow_up.png) |
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 |
![](../../../../../Arrow_up.png) |
Determine if each Register needs to be forced set or not
XDCscript usage |
meta-domain |
var params = new FRCTL.Params;
...
config FRCTL.name // instance |
![](../../../../../Arrow_up.png) |
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 |
![](../../../../../Arrow_up.png) |
String specifying the entity that manages the peripheral
XDCscript usage |
meta-domain |
var params = new FRCTL.Params;
...
params.owner = String undefined;
Instance Creation |
![](../../../../../Arrow_up.png) |
XDCscript usage |
meta-domain |
var params =
new FRCTL.
Params;
// Allocate instance config-params
params.config = ...
// Assign individual configs
// Create an instance-object
generated on Tue, 16 Oct 2012 23:18:02 GMT