struct CS.AvailableClockVariations_t |
![](../../../../../Arrow_up.png) |
Available variations of clock in a device
XDCscript usage |
meta-domain |
var obj = new CS.AvailableClockVariations_t;
obj.clockType = String ...
obj.hasClock = Bool ...
DETAILS
Stores true/false if any of the clock variations are
available.
SEE
struct CS.ForceSetDefaultRegister_t |
![](../../../../../Arrow_up.png) |
Force Set Default Register
XDCscript usage |
meta-domain |
var obj = new CS.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
CS.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
CS.getRegisters() // module-wide |
![](../../../../../Arrow_up.png) |
Find all registers defined by the peripheral
XDCscript usage |
meta-domain |
CS.getRegisters() returns String[]
RETURNS
Returns an array of register names
Instance Config Parameters |
![](../../../../../Arrow_up.png) |
XDCscript usage |
meta-domain |
var params = new CS.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.VLOCLKHz = Float 8300;
//
params.WATCHCRYSTALCLKHz = Float 32768;
//
params.XT1CLKHz = Float 0;
//
params.XT2CLKHz = Float 0;
//
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 CS.ACLKHz // instance |
![](../../../../../Arrow_up.png) |
ACLK frequency in Hertz
XDCscript usage |
meta-domain |
var params = new CS.Params;
...
const params.ACLKHz = Float computed value;
config CS.DCOCLKHz // instance |
![](../../../../../Arrow_up.png) |
DCO clock frequency in Hertz
XDCscript usage |
meta-domain |
var params = new CS.Params;
...
const params.DCOCLKHz = Float 1000000;
config CS.MCLKHz // instance |
![](../../../../../Arrow_up.png) |
MCLK frequency in Hertz
XDCscript usage |
meta-domain |
var params = new CS.Params;
...
const params.MCLKHz = Float computed value;
config CS.SMCLKHz // instance |
![](../../../../../Arrow_up.png) |
SMCLK frequency in Hertz
XDCscript usage |
meta-domain |
var params = new CS.Params;
...
const params.SMCLKHz = Float computed value;
config CS.VLOCLKHz // instance |
![](../../../../../Arrow_up.png) |
XDCscript usage |
meta-domain |
var params = new CS.Params;
...
params.VLOCLKHz = Float 8300;
config CS.WATCHCRYSTALCLKHz // instance |
![](../../../../../Arrow_up.png) |
XDCscript usage |
meta-domain |
var params = new CS.Params;
...
params.WATCHCRYSTALCLKHz = Float 32768;
config CS.XT1CLKHz // instance |
![](../../../../../Arrow_up.png) |
XDCscript usage |
meta-domain |
var params = new CS.Params;
...
params.XT1CLKHz = Float 0;
config CS.XT2CLKHz // instance |
![](../../../../../Arrow_up.png) |
XDCscript usage |
meta-domain |
var params = new CS.Params;
...
params.XT2CLKHz = Float 0;
config CS.baseAddr // instance |
![](../../../../../Arrow_up.png) |
Address of the peripheral's control register
XDCscript usage |
meta-domain |
var params = new CS.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 CS.hasAllCal // instance |
![](../../../../../Arrow_up.png) |
Specify if device has all calibration constants
XDCscript usage |
meta-domain |
var params = new CS.Params;
...
params.hasAllCal = Bool false;
DETAILS
G1 devices do not.
config CS.hasHFXT1 // instance |
![](../../../../../Arrow_up.png) |
Specify if HFXT1 is available on the device
XDCscript usage |
meta-domain |
var params = new CS.Params;
...
params.hasHFXT1 = Bool false;
DETAILS
Not all devices have high frequency clock. This specifies if
it is available for a particular device.
config CS.hasRosc // instance |
![](../../../../../Arrow_up.png) |
Specify if Rosc is available on the device
XDCscript usage |
meta-domain |
var params = new CS.Params;
...
params.hasRosc = Bool false;
DETAILS
Not all devices have Rosc circuitry. This specifies if
it is available for a particular device.
config CS.hasVLO // instance |
![](../../../../../Arrow_up.png) |
Specify if VLO is available on the device
XDCscript usage |
meta-domain |
var params = new CS.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 CS.hasXT2 // instance |
![](../../../../../Arrow_up.png) |
Specify if XT2 is available on the device
XDCscript usage |
meta-domain |
var params = new CS.Params;
...
params.hasXT2 = Bool false;
DETAILS
Not all devices have XT2 clock available. This specifies if
it is available for a particular device.
config CS.maxCpuFrequency // instance |
![](../../../../../Arrow_up.png) |
Maximum CPU frequency in Hertz
XDCscript usage |
meta-domain |
var params = new CS.Params;
...
params.maxCpuFrequency = Float 0;
config CS.name // instance |
![](../../../../../Arrow_up.png) |
Specific peripheral name given by the device
XDCscript usage |
meta-domain |
var params = new CS.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 CS.owner // instance |
![](../../../../../Arrow_up.png) |
String specifying the entity that manages the peripheral
XDCscript usage |
meta-domain |
var params = new CS.Params;
...
params.owner = String undefined;
CS.computeDCOCLKHz() // instance |
![](../../../../../Arrow_up.png) |
Initialize to the nearest available DCO clock frequency
XDCscript usage |
meta-domain |
inst.computeDCOCLKHz(Float DCOCLKHz) returns Void