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

MSP430 Master Clock

XDCspec summary sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
metaonly interface IClock {  ...
// inherits xdc.platform.IPeripheral
instance:  ...
XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
package ti.catalog.msp430.peripherals.clock;
 
metaonly interface IClock inherits IPeripheral {
module-wide constants & types
    typedef IPeripheral.Instance IPeripheralArray// [];
    typedef String StringArray// [];
    metaonly struct ForceSetDefaultRegister_t// Force Set Default Register {
        String register;
        Bool regForceSet;
    };
module-wide functions
    Void addPeripheralsMap// Create a map of all peripherals available on a device(ICpuDataSheet.Instance cds);
    IPeripheral.IPeripheralArray getAll// Find all peripherals of a certain type();
    IPeripheral.StringArray getRegisters// Find all registers defined by the peripheral();
 
instance:
per-instance config parameters
    readonly config Float ACLKHz// Stores ACLK as frequency in float;
    readonly config Float DCOCLKHz// Stores the DCO clock frequency in float = 1000000;
    readonly config Float MCLKHz// Stores MCLK as frequency in float;
    readonly config Float SMCLKHz// Stores SMCLK as frequency in float;
    config UInt baseAddr// Address of the peripheral's control register;
    config String name// Specific peripheral name given by the device;
    config String owner// String specifying the entity that manages the peripheral;
per-instance functions
    Void computeDCOCLKHz// Initialize to the nearest available DCO clock frequency(Float DCOCLKHz);
}
typedef IClock.IPeripheralArray
index URL
XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
typedef IPeripheral.Instance IPeripheralArray[];
typedef IClock.StringArray
index URL
XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
typedef String StringArray[];
struct IClock.ForceSetDefaultRegister_t
index URL

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
ForceSetDefaultRegister_t
IClock.addPeripheralsMap()  // module-wide
index URL

Create a map of all peripherals available on a device

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
Void addPeripheralsMap(ICpuDataSheet.Instance cds);
ARGUMENTS
cds — an xdc.platform.ICpuDataSheet instance
DETAILS
The config parameter peripherals is by default undefined in an xdc.platform.ICpuDataSheet instance. This function gathers all instance configuration parameters that are of the type xdc.platform.IPeripheral into the map peripherals.
IClock.getAll()  // module-wide
index URL

Find all peripherals of a certain type

XDCspec declarations sourced in ti/catalog/msp430/peripherals/clock/IClock.xdc
IPeripheral.IPeripheralArray getAll();
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
index URL

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
index URL

Stores ACLK as frequency in float

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

Stores the DCO clock frequency in float

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

Stores MCLK as frequency in float

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

Stores SMCLK as frequency in float

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

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.name  // instance
index URL

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
index URL

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
index URL

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 Tue, 24 Aug 2010 15:40:41 GMT