metaonly interface ti.catalog.msp430.peripherals.clock.IClock

MSP430 Master Clock

XDCspec summary sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
metaonly interface IClock {  ...
instance:  ...
XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
 
metaonly interface IClock inherits IPeripheral {
module-wide constants & types
    typedef String StringArray// [];
 
        String clockType;
        Bool hasClock;
    };
 
        String register;
        Bool regForceSet;
    };
module-wide functions
 
 
instance:
per-instance config parameters
    readonly config Float ACLKHz// ACLK frequency in Hertz;
    readonly config Float DCOCLKHz// DCO clock frequency in Hertz = 1000000;
    readonly config Float MCLKHz// MCLK frequency in Hertz;
    readonly config Float SMCLKHz// SMCLK frequency in Hertz;
per-instance functions
}
 
typedef IClock.IPeripheralArray
XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
typedef IPeripheral.Instance IPeripheralArray[];
 
 
typedef IClock.StringArray
XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
typedef String StringArray[];
 
 
struct IClock.AvailableClockVariations_t

Available variations of clock in a device

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
metaonly struct AvailableClockVariations_t {
    String clockType;
    Bool hasClock;
};
 
DETAILS
Stores true/false if any of the clock variations are available.
SEE
 
struct IClock.ForceSetDefaultRegister_t

Force Set Default Register

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
metaonly struct ForceSetDefaultRegister_t {
    String register;
    Bool regForceSet;
};
 
DETAILS
Type to store if each register needs to be forced initialized even if the register is in default state.
SEE
 
IClock.getAll()  // module-wide

Find all peripherals of a certain type

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
 
DETAILS
The type of the peripherals returned is defined by the type of the caller.
RETURNS
Returns an array of IPeripheral instances
 
IClock.getRegisters()  // module-wide

Find all registers defined by the peripheral

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
IPeripheral.StringArray getRegisters();
 
RETURNS
Returns an array of register names
 
config IClock.ACLKHz  // instance

ACLK frequency in Hertz

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
readonly config Float ACLKHz;
 
 
config IClock.DCOCLKHz  // instance

DCO clock frequency in Hertz

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
readonly config Float DCOCLKHz = 1000000;
 
 
config IClock.MCLKHz  // instance

MCLK frequency in Hertz

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
readonly config Float MCLKHz;
 
 
config IClock.SMCLKHz  // instance

SMCLK frequency in Hertz

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
readonly config Float SMCLKHz;
 
 
config IClock.baseAddr  // instance

Address of the peripheral's control register

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
config UInt baseAddr;
 
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 IClock.hasAllCal  // instance

Specify if device has all calibration constants

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
config Bool hasAllCal = false;
 
DETAILS
G1 devices do not.
 
config IClock.hasHFXT1  // instance

Specify if HFXT1 is available on the device

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
config Bool hasHFXT1 = false;
 
DETAILS
Not all devices have high frequency clock. This specifies if it is available for a particular device.
 
config IClock.hasRosc  // instance

Specify if Rosc is available on the device

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
config Bool hasRosc = false;
 
DETAILS
Not all devices have Rosc circuitry. This specifies if it is available for a particular device.
 
config IClock.hasVLO  // instance

Specify if VLO is available on the device

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
config Bool hasVLO = false;
 
DETAILS
Not all devices have very low frequency clock VLO. This specifies if it is available for a particular device.
 
config IClock.hasXT2  // instance

Specify if XT2 is available on the device

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
config Bool hasXT2 = false;
 
DETAILS
Not all devices have XT2 clock available. This specifies if it is available for a particular device.
 
config IClock.maxCpuFrequency  // instance

Maximum CPU frequency in Hertz

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
config Float maxCpuFrequency = 0;
 
 
config IClock.name  // instance

Specific peripheral name given by the device

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
config String name;
 
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 IClock.owner  // instance

String specifying the entity that manages the peripheral

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
config String owner;
 
 
IClock.computeDCOCLKHz()  // instance

Initialize to the nearest available DCO clock frequency

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
Void computeDCOCLKHz(Float DCOCLKHz);
 
generated on Thu, 27 Sep 2012 23:23:48 GMT