enum BCSplus.DCO0_t |
|
DCO0 Bit
XDCscript usage |
meta-domain |
values of type BCSplus.DCO0_t
const BCSplus.DCO0_OFF;
// Disable DCO0 bit
const BCSplus.DCO0;
// Enable DCO0 bit
enum BCSplus.DCO1_t |
|
DCO1 Bit
XDCscript usage |
meta-domain |
values of type BCSplus.DCO1_t
const BCSplus.DCO1_OFF;
// Disable DCO1 bit
const BCSplus.DCO1;
// Enable DCO1 bit
enum BCSplus.DCO2_t |
|
DCO2 Bit
XDCscript usage |
meta-domain |
values of type BCSplus.DCO2_t
const BCSplus.DCO2_OFF;
// Disable DCO2 bit
const BCSplus.DCO2;
// Enable DCO2 bit
enum BCSplus.DCOR_t |
|
XDCscript usage |
meta-domain |
values of type BCSplus.DCOR_t
const BCSplus.DCOR_OFF;
// DCO uses internal resistor
const BCSplus.DCOR;
// DCO uses external resistor
enum BCSplus.DIVA_t |
|
ACLK Divider values
XDCscript usage |
meta-domain |
values of type BCSplus.DIVA_t
const BCSplus.DIVA_0;
// Divide by 1
const BCSplus.DIVA_1;
// Divide by 2
const BCSplus.DIVA_2;
// Divide by 4
const BCSplus.DIVA_3;
// Divide by 8
enum BCSplus.DIVM_t |
|
MCLK Divider values
XDCscript usage |
meta-domain |
values of type BCSplus.DIVM_t
const BCSplus.DIVM_0;
// Divide by 1
const BCSplus.DIVM_1;
// Divide by 2
const BCSplus.DIVM_2;
// Divide by 4
const BCSplus.DIVM_3;
// Divide by 8
enum BCSplus.DIVS_t |
|
SMCLK Divider values
XDCscript usage |
meta-domain |
values of type BCSplus.DIVS_t
const BCSplus.DIVS_0;
// Divide by 1
const BCSplus.DIVS_1;
// Divide by 2
const BCSplus.DIVS_2;
// Divide by 4
const BCSplus.DIVS_3;
// Divide by 8
enum BCSplus.LFXT1OF_t |
|
XDCscript usage |
meta-domain |
values of type BCSplus.LFXT1OF_t
const BCSplus.LFXT1OF_OFF;
// No fault condition present
const BCSplus.LFXT1OF;
// LFXT1 fault condition present
enum BCSplus.LFXT1S_t |
|
XDCscript usage |
meta-domain |
values of type BCSplus.LFXT1S_t
const BCSplus.LFXT1S_0;
// If XTS = 0, XT1 = 32768kHz Crystal ; If XTS = 1, XT1 = 0.4 - 1-MHz crystal or resonator
const BCSplus.LFXT1S_1;
// If XTS = 0, XT1 = Reserved ; If XTS = 1, XT1 = 1 - 3-MHz crystal or resonator
const BCSplus.LFXT1S_2;
// If XTS = 0, XT1 = VLOCLK ; If XTS = 1, XT1 = 3 - 16-MHz crystal or resonator
const BCSplus.LFXT1S_3;
// If XTS = 0, XT1 = Digital External ; If XTS = 1, XT1 = 0.4 - 16-MHz Digital External
enum BCSplus.MOD0_t |
|
MOD0 Bit
XDCscript usage |
meta-domain |
values of type BCSplus.MOD0_t
const BCSplus.MOD0_OFF;
// Disable MOD0 bit
const BCSplus.MOD0;
// Enable MOD0 bit
enum BCSplus.MOD1_t |
|
MOD1 Bit
XDCscript usage |
meta-domain |
values of type BCSplus.MOD1_t
const BCSplus.MOD1_OFF;
// Disable MOD1 bit
const BCSplus.MOD1;
// Enable MOD1 bit
enum BCSplus.MOD2_t |
|
MOD2 Bit
XDCscript usage |
meta-domain |
values of type BCSplus.MOD2_t
const BCSplus.MOD2_OFF;
// Disable MOD2 bit
const BCSplus.MOD2;
// Enable MOD2 bit
enum BCSplus.MOD3_t |
|
MOD3 Bit
XDCscript usage |
meta-domain |
values of type BCSplus.MOD3_t
const BCSplus.MOD3_OFF;
// Disable MOD3 bit
const BCSplus.MOD3;
// Enable MOD3 bit
enum BCSplus.MOD4_t |
|
MOD4 Bit
XDCscript usage |
meta-domain |
values of type BCSplus.MOD4_t
const BCSplus.MOD4_OFF;
// Disable MOD4 bit
const BCSplus.MOD4;
// Enable MOD4 bit
enum BCSplus.RSEL0_t |
|
XDCscript usage |
meta-domain |
values of type BCSplus.RSEL0_t
const BCSplus.RSEL0_OFF;
// Disable RSEL0 bit
const BCSplus.RSEL0;
// Enable RSEL0 bit
enum BCSplus.RSEL1_t |
|
XDCscript usage |
meta-domain |
values of type BCSplus.RSEL1_t
const BCSplus.RSEL1_OFF;
// Disable RSEL1 bit
const BCSplus.RSEL1;
// Enable RSEL1 bit
enum BCSplus.RSEL2_t |
|
XDCscript usage |
meta-domain |
values of type BCSplus.RSEL2_t
const BCSplus.RSEL2_OFF;
// Disable RSEL2 bit
const BCSplus.RSEL2;
// Enable RSEL2 bit
enum BCSplus.RSEL3_t |
|
XDCscript usage |
meta-domain |
values of type BCSplus.RSEL3_t
const BCSplus.RSEL3_OFF;
// Disable RSEL3 bit
const BCSplus.RSEL3;
// Enable RSEL3 bit
enum BCSplus.SELM_t |
|
MCLK Source Select
XDCscript usage |
meta-domain |
values of type BCSplus.SELM_t
const BCSplus.SELM_0;
// DCOCLK
const BCSplus.SELM_2;
// XT2CLK/LFXTCLK
const BCSplus.SELM_3;
// LFXTCLK
enum BCSplus.SELS_t |
|
XDCscript usage |
meta-domain |
values of type BCSplus.SELS_t
const BCSplus.SELS_OFF;
// DCOCLK
const BCSplus.SELS;
// XT2CLK when XT2 oscillator present. LFXT1CLK or VLOCLK when XT2 oscillator not present
enum BCSplus.XCAP_t |
|
XDCscript usage |
meta-domain |
values of type BCSplus.XCAP_t
const BCSplus.XCAP_0;
// ~1 pF
const BCSplus.XCAP_1;
// ~6 pF
const BCSplus.XCAP_2;
// ~10 pF
const BCSplus.XCAP_3;
// ~12.5 pF
enum BCSplus.XT2OFF_t |
|
XDCscript usage |
meta-domain |
values of type BCSplus.XT2OFF_t
const BCSplus.XT2OFF_OFF;
// Enable XT2CLK
const BCSplus.XT2OFF;
// Disable XT2CLK
enum BCSplus.XT2OF_t |
|
XDCscript usage |
meta-domain |
values of type BCSplus.XT2OF_t
const BCSplus.XT2OF_OFF;
// No fault condition present
const BCSplus.XT2OF;
// XT2 fault condition present
enum BCSplus.XT2S_t |
|
XT2 frequency range select
XDCscript usage |
meta-domain |
values of type BCSplus.XT2S_t
const BCSplus.XT2S_0;
// 0.4 - 1 MHz
const BCSplus.XT2S_1;
// 1 - 3 MHz
const BCSplus.XT2S_2;
// 3 - 16 MHz
const BCSplus.XT2S_3;
// Digital input signal
enum BCSplus.XTS_t |
|
XDCscript usage |
meta-domain |
values of type BCSplus.XTS_t
const BCSplus.XTS_OFF;
// Low Frequency
const BCSplus.XTS;
// High Frequency
struct BCSplus.AvailableClockVariations_t |
|
Available variations of clock in a device
XDCscript usage |
meta-domain |
var obj = new BCSplus.AvailableClockVariations_t;
obj.clockType = String ...
obj.hasClock = Bool ...
DETAILS
Stores true/false if any of the clock variations are
available.
SEE
struct BCSplus.BCSCTL1_t |
|
BCS Control Register 1
XDCscript usage |
meta-domain |
var obj = new BCSplus.BCSCTL1_t;
// XT2 off. This bit turns off the XT2 oscillator
0 XT2 is on
1 XT2 is off if it is not used for MCLK or SMCLK
// LFXT1 mode select.
0 Low frequency mode
1 High frequency mode
// Divider for ACLK
00 /1
01 /2
10 /4
11 /8
// Range select bit 0
// Range select bit 1
// Range select bit 2
// Range select bit 3
FIELDS
XT2OFF
This bit turns off the XT2 oscillator: 0 - XT2 is on,
1 - XT2 is off if it is not used for MCLK or SMCLK
XTS
0 - Low frequency mode; 1 - High frequency mode
struct BCSplus.BCSCTL2_t |
|
BCS Control Register 2
XDCscript usage |
meta-domain |
var obj = new BCSplus.BCSCTL2_t;
// Select MCLK. These bits select the MCLK source.
00 DCOCLK
01 DCOCLK
10 XT2CLK when XT2 oscillator present on-chip. LFXT1CLK or VLOCLK
when XT2 oscillator not present on-chip.
11 LFXT1CLK or VLOCLK
// Divider for MCLK
00 /1
01 /2
10 /4
11 /8
// Select SMCLK. This bit selects the SMCLK source.
0 DCOCLK
1 XT2CLK when XT2 oscillator present. LFXT1CLK or VLOCLK when
XT2 oscillator not present
// Divider for SMCLK
00 /1
01 /2
10 /4
11 /8
// DCO resistor select
0 Internal resistor
1 External resistor
FIELDS
SELM
These bits select the MCLK source.
SELS
These bits select the SMCLK source. When
XT2 oscillator present, 0 selects DCOCLK and
1 selects XT2CLK; otherwise 0 selects LFXT1CLK and
1 selects VLOCLK.
DCOR
0 - Internal resistor, 1 - external resistor
struct BCSplus.BCSCTL3_t |
|
BCS Control register 3
XDCscript usage |
meta-domain |
var obj = new BCSplus.BCSCTL3_t;
// XT2 range select. These bits select the frequency range for XT2.
00 0.4 - 1-MHz crystal or resonator
01 1 - 3-MHz crystal or resonator
10 3 - 16-MHz crystal or resonator
11 Digital external 0.4 - 16-MHz clock source
// Low-frequency clock select and LFXT1 range select. These bits select
between LFXT1 and VLO when XTS = 0, and select the frequency range
for LFXT1 when XTS = 1
// Oscillator capacitor selection. These bits select the effective capacitance
seen by the LFXT1 crystal when XTS = 0. If XTS = 1 or if LFCT1Sx = 11
XCAPx should be 00.
00 ~1 pF
01 ~6 pF
10 ~10 pF
11 ~12.5 pF
// XT2 oscillator fault
0 No fault condition present
1 Fault condition present
// LFXT1 oscillator fault
0 No fault condition present
1 Fault condition present
FIELDS
LFXT1S
These bits select between LFXT1 and VLO and XTS = 0,
and select the frequency range for LFXT1 when XTS = 1
XCAP
These bits select the effective capacitance seen by
the LFXT1 crystal when XTS = 0. If XTS = 1 or if
LFCT1Sx = 11, then XCAPx should be 00.
struct BCSplus.DCOCTL_t |
|
XDCscript usage |
meta-domain |
var obj = new BCSplus.DCOCTL_t;
// Modulation Bit 0
// Modulation Bit 1
// Modulation Bit 2
// Modulation Bit 3
// Modulation Bit 4
// DCO Select Bit 0
// DCO Select Bit 1
// DCO Select Bit 2
struct BCSplus.ForceSetDefaultRegister_t |
|
Force Set Default Register
XDCscript usage |
meta-domain |
var obj = new BCSplus.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
BCSplus.getAll() // module-wide |
|
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
BCSplus.getRegisters() // module-wide |
|
Find all registers defined by the peripheral
XDCscript usage |
meta-domain |
BCSplus.getRegisters() returns String[]
RETURNS
Returns an array of register names
Instance Config Parameters |
|
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
// Instance config-params object
params.ACLKHz = Float undefined;
// ACLK frequency in Hertz
// Basic Clock System Control 1
};
// Basic Clock System Control 2
};
// Basic Clock System Control 3
};
params.DCOCLKHz = Float 1000000;
// DCO clock frequency in Hertz
// DCO Clock Frequency Control
};
params.LFXT1CLKHz = Float 0;
//
params.MCLKHz = Float undefined;
// MCLK frequency in Hertz
params.SMCLKHz = Float undefined;
// SMCLK frequency in Hertz
params.VLOCLKHz = Float 12000;
//
params.WATCHCRYSTALCLKHz = Float 32768;
//
params.XT2CLKHz = Float 0;
//
params.baseAddr = UInt undefined;
// Address of the peripheral's control register
params.enableXT2 = Bool false;
// Set whether XT2 is used on the device. This is different than hasXT2
variable
// Determine if each Register needs to be forced set or not
{
register: "DCOCTL",
regForceSet: false
},
{
register: "BCSCTL1",
regForceSet: false
},
{
register: "BCSCTL2",
regForceSet: false
},
{
register: "BCSCTL3",
regForceSet: false
}
];
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
params.preCalibratedValues = UInt 0;
// Basic Clock System + pre-calibrated system frequency
params.preCalibratedValuesItems = String[length] undefined;
// hasAllCal = false
UInt - Description
0 - 1 MHz
1 - Custom
config BCSplus.ACLKHz // instance |
|
ACLK frequency in Hertz
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
const params.ACLKHz = Float computed value;
config BCSplus.BCSCTL1 // instance |
|
Basic Clock System Control 1
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
};
config BCSplus.BCSCTL2 // instance |
|
Basic Clock System Control 2
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
};
config BCSplus.BCSCTL3 // instance |
|
Basic Clock System Control 3
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
};
config BCSplus.DCOCLKHz // instance |
|
DCO clock frequency in Hertz
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
const params.DCOCLKHz = Float 1000000;
config BCSplus.DCOCTL // instance |
|
DCO Clock Frequency Control
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
};
config BCSplus.LFXT1CLKHz // instance |
|
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
params.LFXT1CLKHz = Float 0;
config BCSplus.MCLKHz // instance |
|
MCLK frequency in Hertz
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
const params.MCLKHz = Float computed value;
config BCSplus.SMCLKHz // instance |
|
SMCLK frequency in Hertz
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
const params.SMCLKHz = Float computed value;
config BCSplus.VLOCLKHz // instance |
|
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
params.VLOCLKHz = Float 12000;
config BCSplus.WATCHCRYSTALCLKHz // instance |
|
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
params.WATCHCRYSTALCLKHz = Float 32768;
config BCSplus.XT2CLKHz // instance |
|
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
params.XT2CLKHz = Float 0;
config BCSplus.baseAddr // instance |
|
Address of the peripheral's control register
XDCscript usage |
meta-domain |
var params = new BCSplus.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 BCSplus.enableXT2 // instance |
|
Set whether XT2 is used on the device. This is different than hasXT2
variable
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
params.enableXT2 = Bool false;
config BCSplus.forceSetDefaultRegister // instance |
|
Determine if each Register needs to be forced set or not
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
{
register: "DCOCTL",
regForceSet: false
},
{
register: "BCSCTL1",
regForceSet: false
},
{
register: "BCSCTL2",
regForceSet: false
},
{
register: "BCSCTL3",
regForceSet: false
}
];
config BCSplus.hasAllCal // instance |
|
Specify if device has all calibration constants
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
params.hasAllCal = Bool false;
DETAILS
G1 devices do not.
config BCSplus.hasHFXT1 // instance |
|
Specify if HFXT1 is available on the device
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
params.hasHFXT1 = Bool false;
DETAILS
Not all devices have high frequency clock. This specifies if
it is available for a particular device.
config BCSplus.hasRosc // instance |
|
Specify if Rosc is available on the device
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
params.hasRosc = Bool false;
DETAILS
Not all devices have Rosc circuitry. This specifies if
it is available for a particular device.
config BCSplus.hasVLO // instance |
|
Specify if VLO is available on the device
XDCscript usage |
meta-domain |
var params = new BCSplus.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 BCSplus.hasXT2 // instance |
|
Specify if XT2 is available on the device
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
params.hasXT2 = Bool false;
DETAILS
Not all devices have XT2 clock available. This specifies if
it is available for a particular device.
config BCSplus.maxCpuFrequency // instance |
|
Maximum CPU frequency in Hertz
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
params.maxCpuFrequency = Float 0;
config BCSplus.name // instance |
|
Specific peripheral name given by the device
XDCscript usage |
meta-domain |
var params = new BCSplus.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 BCSplus.owner // instance |
|
String specifying the entity that manages the peripheral
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
params.owner = String undefined;
config BCSplus.preCalibratedValues // instance |
|
Basic Clock System + pre-calibrated system frequency
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
params.preCalibratedValues = UInt 0;
config BCSplus.preCalibratedValuesItems // instance |
|
hasAllCal = false
UInt - Description
0 - 1 MHz
1 - Custom
XDCscript usage |
meta-domain |
var params = new BCSplus.Params;
...
params.preCalibratedValuesItems = String[length] undefined;
DETAILS
hasAllCal = true
UInt - Description
0 - 1 MHz
1 - 8 MHz
2 - 12 MHz
3 - 16 MHz
4 - Custom
BCSplus.computeDCOCLKHz() // instance |
|
Initialize to the nearest available DCO clock frequency
XDCscript usage |
meta-domain |
inst.computeDCOCLKHz(Float DCOCLKHz) returns Void