metaonly module ti.catalog.msp430.peripherals.clock.UCS
index URL

MSP430 Unified Clock System

XDCscript usage meta-domain sourced in ti/catalog/msp430/peripherals/clock/UCS.xdc
var UCS = xdc.useModule('ti.catalog.msp430.peripherals.clock.UCS');
module-wide constants & types
    var obj = new UCS.AvailableClockVariations_t// Available variations of clock in a device;
        obj.clockType = String  ...
        obj.hasClock = Bool  ...
 
    var obj = new UCS.ForceSetDefaultRegister_t// Force Set Default Register;
        obj.register = String  ...
        obj.regForceSet = Bool  ...
module-wide functions
    UCS.getAll// Find all peripherals of a certain type() returns IPeripheral.Instance[]
    UCS.getRegisters// Find all registers defined by the peripheral() returns String[]
per-instance config parameters
    var params = new UCS.Params// Instance config-params object;
        params.ACLKHz// ACLK frequency in Hertz = Float undefined;
        params.DCOCLKHz// DCO clock frequency in Hertz = Float 1000000;
        params.MCLKHz// MCLK frequency in Hertz = Float undefined;
        params.SMCLKHz// SMCLK frequency in Hertz = Float undefined;
        params.baseAddr// Address of the peripheral's control register = UInt undefined;
        params.hasAllCal// Specify if device has all calibration constants = Bool false;
        params.hasHFXT1// Specify if HFXT1 is available on the device = Bool false;
        params.hasRosc// Specify if Rosc is available on the device = Bool false;
        params.hasVLO// Specify if VLO is available on the device = Bool false;
        params.hasXT2// Specify if XT2 is available on the device = Bool false;
        params.maxCpuFrequency// Maximum CPU frequency in Hertz = Float 0;
        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 functions
    inst.computeDCOCLKHz// Initialize to the nearest available DCO clock frequency(Float DCOCLKHz) returns Void
 
 
struct UCS.AvailableClockVariations_t
index URL

Available variations of clock in a device

XDCscript usage meta-domain
var obj = new UCS.AvailableClockVariations_t;
 
    obj.clockType = String  ...
    obj.hasClock = Bool  ...
 
DETAILS
Stores true/false if any of the clock variations are available.
SEE
AvailableClockVariations_t
 
struct UCS.ForceSetDefaultRegister_t
index URL

Force Set Default Register

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

Find all peripherals of a certain type

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

Find all registers defined by the peripheral

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

XDCscript usage meta-domain
var params = new UCS.Params;
// Instance config-params object
    params.ACLKHz = Float undefined;
    // ACLK frequency in Hertz
    params.DCOCLKHz = Float 1000000;
    // DCO clock frequency in Hertz
    params.MCLKHz = Float undefined;
    // MCLK frequency in Hertz
    params.SMCLKHz = Float undefined;
    // SMCLK frequency in Hertz
    params.baseAddr = UInt undefined;
    // Address of the peripheral's control register
    params.hasAllCal = Bool false;
    // Specify if device has all calibration constants
    params.hasHFXT1 = Bool false;
    // Specify if HFXT1 is available on the device
    params.hasRosc = Bool false;
    // Specify if Rosc is available on the device
    params.hasVLO = Bool false;
    // Specify if VLO is available on the device
    params.hasXT2 = Bool false;
    // Specify if XT2 is available on the device
    params.maxCpuFrequency = Float 0;
    // Maximum CPU frequency in Hertz
    params.name = String undefined;
    // Specific peripheral name given by the device
    params.owner = String undefined;
    // String specifying the entity that manages the peripheral
 
config UCS.ACLKHz  // instance
index URL

ACLK frequency in Hertz

XDCscript usage meta-domain
var params = new UCS.Params;
  ...
const params.ACLKHz = Float computed value;
 
 
config UCS.DCOCLKHz  // instance
index URL

DCO clock frequency in Hertz

XDCscript usage meta-domain
var params = new UCS.Params;
  ...
const params.DCOCLKHz = Float 1000000;
 
 
config UCS.MCLKHz  // instance
index URL

MCLK frequency in Hertz

XDCscript usage meta-domain
var params = new UCS.Params;
  ...
const params.MCLKHz = Float computed value;
 
 
config UCS.SMCLKHz  // instance
index URL

SMCLK frequency in Hertz

XDCscript usage meta-domain
var params = new UCS.Params;
  ...
const params.SMCLKHz = Float computed value;
 
 
config UCS.baseAddr  // instance
index URL

Address of the peripheral's control register

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

Specify if device has all calibration constants

XDCscript usage meta-domain
var params = new UCS.Params;
  ...
params.hasAllCal = Bool false;
 
DETAILS
G1 devices do not.
 
config UCS.hasHFXT1  // instance
index URL

Specify if HFXT1 is available on the device

XDCscript usage meta-domain
var params = new UCS.Params;
  ...
params.hasHFXT1 = Bool false;
 
DETAILS
Not all devices have high frequency clock. This specifies if it is available for a particular device.
 
config UCS.hasRosc  // instance
index URL

Specify if Rosc is available on the device

XDCscript usage meta-domain
var params = new UCS.Params;
  ...
params.hasRosc = Bool false;
 
DETAILS
Not all devices have Rosc circuitry. This specifies if it is available for a particular device.
 
config UCS.hasVLO  // instance
index URL

Specify if VLO is available on the device

XDCscript usage meta-domain
var params = new UCS.Params;
  ...
params.hasVLO = Bool false;
 
DETAILS
Not all devices have very low frequency clock VLO. This specifies if it is available for a particular device.
 
config UCS.hasXT2  // instance
index URL

Specify if XT2 is available on the device

XDCscript usage meta-domain
var params = new UCS.Params;
  ...
params.hasXT2 = Bool false;
 
DETAILS
Not all devices have XT2 clock available. This specifies if it is available for a particular device.
 
config UCS.maxCpuFrequency  // instance
index URL

Maximum CPU frequency in Hertz

XDCscript usage meta-domain
var params = new UCS.Params;
  ...
params.maxCpuFrequency = Float 0;
 
 
config UCS.name  // instance
index URL

Specific peripheral name given by the device

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

String specifying the entity that manages the peripheral

XDCscript usage meta-domain
var params = new UCS.Params;
  ...
params.owner = String undefined;
 
 
UCS.computeDCOCLKHz()  // instance
index URL

Initialize to the nearest available DCO clock frequency

XDCscript usage meta-domain
inst.computeDCOCLKHz(Float DCOCLKHz) returns Void
 
generated on Mon, 10 Oct 2011 16:55:04 GMT