module ti.catalog.msp430.peripherals.clock.Clock2xx

metaonly module ti.catalog.msp430.peripherals.clock.Clock2xx

index URL

MSP430 Master Clock

XDCscript usage
Individual elements

XDCscript usage meta-domain sourced in ti/catalog/msp430/peripherals/clock/Clock2xx.xdc

var Clock2xx = xdc.useModule('ti.catalog.msp430.peripherals.clock.Clock2xx');

module-wide constants & types

values of type Clock2xx.DCO0_t// DCO0 Bit

const Clock2xx.DCO0_OFF// Disable DCO0 bit;

const Clock2xx.DCO0// Enable DCO0 bit;

values of type Clock2xx.DCO1_t// DCO1 Bit

const Clock2xx.DCO1_OFF// Disable DCO1 bit;

const Clock2xx.DCO1// Enable DCO1 bit;

values of type Clock2xx.DCO2_t// DCO2 Bit

const Clock2xx.DCO2_OFF// Disable DCO2 bit;

const Clock2xx.DCO2// Enable DCO2 bit;

values of type Clock2xx.DCOR_t//

const Clock2xx.DCOR_OFF// DCO uses internal resistor;

const Clock2xx.DCOR// DCO uses external resistor;

values of type Clock2xx.DIVA_t// ACLK Divider values

const Clock2xx.DIVA_0// Divide by 1;

const Clock2xx.DIVA_1// Divide by 2;

const Clock2xx.DIVA_2// Divide by 4;

const Clock2xx.DIVA_3// Divide by 8;

values of type Clock2xx.DIVM_t// MCLK Divider values

const Clock2xx.DIVM_0// Divide by 1;

const Clock2xx.DIVM_1// Divide by 2;

const Clock2xx.DIVM_2// Divide by 4;

const Clock2xx.DIVM_3// Divide by 8;

values of type Clock2xx.DIVS_t// SMCLK Divider values

const Clock2xx.DIVS_0// Divide by 1;

const Clock2xx.DIVS_1// Divide by 2;

const Clock2xx.DIVS_2// Divide by 4;

const Clock2xx.DIVS_3// Divide by 8;

values of type Clock2xx.LFXT1OF_t//

const Clock2xx.LFXT1OF_OFF// No fault condition present;

const Clock2xx.LFXT1OF// LFXT1 fault condition present;

values of type Clock2xx.LFXT1S_t//

const Clock2xx.LFXT1S_0// XTS = 0, 32768kHz Crystal ; XTS = 1, 0.4 - 1-MHz crystal or resonator;

const Clock2xx.LFXT1S_1// XTS = 0, Reserved ; XTS = 1, 1 - 3-MHz crystal or resonator;

const Clock2xx.LFXT1S_2// XTS = 0, VLOCLK ; XTS = 1, 3 - 16-MHz crystal or resonator;

const Clock2xx.LFXT1S_3// XTS = 0, Digital External ; XTS = 1, 0.4 - 16-MHz Digital External;

values of type Clock2xx.MOD0_t// MOD0 Bit

const Clock2xx.MOD0_OFF// Disable MOD0 bit;

const Clock2xx.MOD0// Enable MOD0 bit;

values of type Clock2xx.MOD1_t// MOD1 Bit

const Clock2xx.MOD1_OFF// Disable MOD1 bit;

const Clock2xx.MOD1// Enable MOD1 bit;

values of type Clock2xx.MOD2_t// MOD2 Bit

const Clock2xx.MOD2_OFF// Disable MOD2 bit;

const Clock2xx.MOD2// Enable MOD2 bit;

values of type Clock2xx.MOD3_t// MOD3 Bit

const Clock2xx.MOD3_OFF// Disable MOD3 bit;

const Clock2xx.MOD3// Enable MOD3 bit;

values of type Clock2xx.MOD4_t// MOD4 Bit

const Clock2xx.MOD4_OFF// Disable MOD4 bit;

const Clock2xx.MOD4// Enable MOD4 bit;

values of type Clock2xx.PreCalibratedValues_t//

const Clock2xx.PreCal_0// 1 MHz;

const Clock2xx.PreCal_1// 8 MHz;

const Clock2xx.PreCal_2// 12 MHz;

const Clock2xx.PreCal_3// 16 MHz;

const Clock2xx.PreCal_4// Custom;

values of type Clock2xx.RSEL0_t//

const Clock2xx.RSEL0_OFF// Disable RSEL0 bit;

const Clock2xx.RSEL0// Enable RSEL0 bit;

values of type Clock2xx.RSEL1_t//

const Clock2xx.RSEL1_OFF// Disable RSEL1 bit;

const Clock2xx.RSEL1// Enable RSEL1 bit;

values of type Clock2xx.RSEL2_t//

const Clock2xx.RSEL2_OFF// Disable RSEL2 bit;

const Clock2xx.RSEL2// Enable RSEL2 bit;

values of type Clock2xx.RSEL3_t//

const Clock2xx.RSEL3_OFF// Disable RSEL3 bit;

const Clock2xx.RSEL3// Enable RSEL3 bit;

values of type Clock2xx.SELM_t// MCLK Source Select

const Clock2xx.SELM_0// DCOCLK;

const Clock2xx.SELM_2// XT2CLK/LFXTCLK;

const Clock2xx.SELM_3// LFXTCLK;

values of type Clock2xx.SELS_t//

const Clock2xx.SELS_OFF// DCOCLK;

const Clock2xx.SELS// XT2CLK;

values of type Clock2xx.XCAP_t//

const Clock2xx.XCAP_0// ~1 pF;

const Clock2xx.XCAP_1// ~6 pF;

const Clock2xx.XCAP_2// ~10 pF;

const Clock2xx.XCAP_3// ~12.5 pF;

values of type Clock2xx.XT2OFF_t//

const Clock2xx.XT2OFF_OFF// Enable XT2CLK;

const Clock2xx.XT2OFF// Disable XT2CLK;

values of type Clock2xx.XT2OF_t//

const Clock2xx.XT2OF_OFF// No fault condition present;

const Clock2xx.XT2OF// XT2 fault condition present;

values of type Clock2xx.XT2S_t// XT2 frequency range select

const Clock2xx.XT2S_0// 0.4 - 1 MHz;

const Clock2xx.XT2S_1// 1 - 3 MHz;

const Clock2xx.XT2S_2// 3 - 16 MHz;

const Clock2xx.XT2S_3// Digital input signal;

values of type Clock2xx.XTS_t//

const Clock2xx.XTS_OFF// Low Frequency;

const Clock2xx.XTS// High Frequency;

var obj = new Clock2xx.BCSCTL1_t// BCS Control Register 1;

obj.XT2OFF// 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 = Clock2xx.XT2OFF_t ...

obj.XTS// LFXT1 mode select. 0 Low frequency mode 1 High frequency mode = Clock2xx.XTS_t ...

obj.DIVA// Divider for ACLK 00 /1 01 /2 10 /4 11 /8 = Clock2xx.DIVA_t ...

obj.RSEL0// Range select bit 0 = Clock2xx.RSEL0_t ...

obj.RSEL1// Range select bit 1 = Clock2xx.RSEL1_t ...

obj.RSEL2// Range select bit 2 = Clock2xx.RSEL2_t ...

obj.RSEL3// Range select bit 3 = Clock2xx.RSEL3_t ...

var obj = new Clock2xx.BCSCTL2_t// BCS Control Register 2;

obj.SELM// 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 = Clock2xx.SELM_t ...

obj.DIVM// Divider for MCLK 00 /1 01 /2 10 /4 11 /8 = Clock2xx.DIVM_t ...

obj.SELS// Select SMCLK. This bit selects the SMCLK source. 0 DCOCLK 1 XT2CLK when XT2 oscillator present. LFXT1CLK or VLOCLK when XT2 oscillator not present = Clock2xx.SELS_t ...

obj.DIVS// Divider for SMCLK 00 /1 01 /2 10 /4 11 /8 = Clock2xx.DIVS_t ...

obj.DCOR// DCO resistor select 0 Internal resistor 1 External resistor = Clock2xx.DCOR_t ...

var obj = new Clock2xx.BCSCTL3_t// BCS Control register 3;

obj.XT2S// 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 = Clock2xx.XT2S_t ...

obj.LFXT1S// 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 = Clock2xx.LFXT1S_t ...

obj.XCAP// 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 = Clock2xx.XCAP_t ...

obj.XT2OF// XT2 oscillator fault 0 No fault condition present 1 Fault condition present = Clock2xx.XT2OF_t ...

obj.LFXT1OF// LFXT1 oscillator fault 0 No fault condition present 1 Fault condition present = Clock2xx.LFXT1OF_t ...

var obj = new Clock2xx.DCOCTL_t// ;

obj.MOD0// Modulation Bit 0 = Clock2xx.MOD0_t ...

obj.MOD1// Modulation Bit 1 = Clock2xx.MOD1_t ...

obj.MOD2// Modulation Bit 2 = Clock2xx.MOD2_t ...

obj.MOD3// Modulation Bit 3 = Clock2xx.MOD3_t ...

obj.MOD4// Modulation Bit 4 = Clock2xx.MOD4_t ...

obj.DCO0// DCO Select Bit 0 = Clock2xx.DCO0_t ...

obj.DCO1// DCO Select Bit 1 = Clock2xx.DCO1_t ...

obj.DCO2// DCO Select Bit 2 = Clock2xx.DCO2_t ...

var obj = new Clock2xx.ForceSetDefaultRegister_t// Force Set Default Register;

obj.register = String ...

obj.regForceSet = Bool ...

module-wide functions

Clock2xx.addPeripheralsMap// Create a map of all peripherals available on a device(ICpuDataSheet.Instance cds) returns Void

Clock2xx.getAll// Find all peripherals of a certain type() returns IPeripheral.Instance[]

Clock2xx.getRegisters// Find all registers defined by the peripheral() returns String[]

per-instance config parameters

var params = new Clock2xx.Params// Instance config-params object;

params.ACLKHz// Stores ACLK as frequency in float = Float undefined;

params.BCSCTL1// Basic Clock System Control 1 = Clock2xx.BCSCTL1_t {

XT2OFF: Clock2xx.XT2OFF,

XTS: Clock2xx.XTS_OFF,

DIVA: Clock2xx.DIVA_0,

RSEL0: Clock2xx.RSEL0,

RSEL1: Clock2xx.RSEL1,

RSEL2: Clock2xx.RSEL2,

RSEL3: Clock2xx.RSEL3_OFF

};

params.BCSCTL2// Basic Clock System Control 2 = Clock2xx.BCSCTL2_t {

SELM: Clock2xx.SELM_0,

DIVM: Clock2xx.DIVM_0,

SELS: Clock2xx.SELS_OFF,

DIVS: Clock2xx.DIVS_0,

DCOR: Clock2xx.DCOR_OFF

};

params.BCSCTL3// Basic Clock System Control 3 = Clock2xx.BCSCTL3_t {

XT2S: Clock2xx.XT2S_0,

LFXT1S: Clock2xx.LFXT1S_0,

XCAP: Clock2xx.XCAP_1

};

params.DCOCLKHz// Stores the DCO clock frequency in float = Float 1000000;

params.DCOCTL// DCO Clock Frequency Control = Clock2xx.DCOCTL_t {

MOD0: Clock2xx.MOD0_OFF,

MOD1: Clock2xx.MOD1_OFF,

MOD2: Clock2xx.MOD2_OFF,

MOD3: Clock2xx.MOD3_OFF,

MOD4: Clock2xx.MOD4_OFF,

DCO0: Clock2xx.DCO0,

DCO1: Clock2xx.DCO1,

DCO2: Clock2xx.DCO2_OFF

};

params.LFXT1CLKHz// = Float 0;

params.MCLKHz// Stores MCLK as frequency in float = Float undefined;

params.SMCLKHz// Stores SMCLK as frequency in float = Float undefined;

params.VLOCLKHz// = Float 12000;

params.WATCHCRYSTALCLKHz// = Float 32768;

params.XT2CLKHz// = Float 0;

params.baseAddr// Address of the peripheral's control register = UInt undefined;

params.forceSetDefaultRegister// Determine if each Register needs to be forced set or not = Clock2xx.ForceSetDefaultRegister_t[] [

{

regForceSet: false

{

regForceSet: false

{

regForceSet: false

{

regForceSet: false

}

];

params.hasXT2// Set whether XT2 is available on the device = Bool false;

params.name// Specific peripheral name given by the device = String undefined;

params.owner// String specifying the entity that manages the peripheral = String undefined;

params.preCalibratedValues// Basic Clock System 2xx pre-calibrated system frequency = Clock2xx.PreCalibratedValues_t Clock2xx.PreCal_0;

per-instance creation

var inst = Clock2xx.create// Create an instance-object(IE1.Instance interruptEnableRegister1, params);

per-instance functions

inst.computeDCOCLKHz// Initialize to the nearest available DCO clock frequency(Float DCOCLKHz) returns Void

enum Clock2xx.DCO0_t

index URL

DCO0 Bit

XDCscript usage meta-domain

values of type Clock2xx.DCO0_t

const Clock2xx.DCO0_OFF;

// Disable DCO0 bit

const Clock2xx.DCO0;

// Enable DCO0 bit

enum Clock2xx.DCO1_t

index URL

DCO1 Bit

XDCscript usage meta-domain

values of type Clock2xx.DCO1_t

const Clock2xx.DCO1_OFF;

// Disable DCO1 bit

const Clock2xx.DCO1;

// Enable DCO1 bit

enum Clock2xx.DCO2_t

index URL

DCO2 Bit

XDCscript usage meta-domain

values of type Clock2xx.DCO2_t

const Clock2xx.DCO2_OFF;

// Disable DCO2 bit

const Clock2xx.DCO2;

// Enable DCO2 bit

enum Clock2xx.DCOR_t

index URL

XDCscript usage meta-domain

values of type Clock2xx.DCOR_t

const Clock2xx.DCOR_OFF;

// DCO uses internal resistor

const Clock2xx.DCOR;

// DCO uses external resistor

enum Clock2xx.DIVA_t

index URL

ACLK Divider values

XDCscript usage meta-domain

values of type Clock2xx.DIVA_t

const Clock2xx.DIVA_0;

// Divide by 1

const Clock2xx.DIVA_1;

// Divide by 2

const Clock2xx.DIVA_2;

// Divide by 4

const Clock2xx.DIVA_3;

// Divide by 8

enum Clock2xx.DIVM_t

index URL

MCLK Divider values

XDCscript usage meta-domain

values of type Clock2xx.DIVM_t

const Clock2xx.DIVM_0;

// Divide by 1

const Clock2xx.DIVM_1;

// Divide by 2

const Clock2xx.DIVM_2;

// Divide by 4

const Clock2xx.DIVM_3;

// Divide by 8

enum Clock2xx.DIVS_t

index URL

SMCLK Divider values

XDCscript usage meta-domain

values of type Clock2xx.DIVS_t

const Clock2xx.DIVS_0;

// Divide by 1

const Clock2xx.DIVS_1;

// Divide by 2

const Clock2xx.DIVS_2;

// Divide by 4

const Clock2xx.DIVS_3;

// Divide by 8

enum Clock2xx.LFXT1OF_t

index URL

XDCscript usage meta-domain

values of type Clock2xx.LFXT1OF_t

const Clock2xx.LFXT1OF_OFF;

// No fault condition present

const Clock2xx.LFXT1OF;

// LFXT1 fault condition present

enum Clock2xx.LFXT1S_t

index URL

XDCscript usage meta-domain

values of type Clock2xx.LFXT1S_t

const Clock2xx.LFXT1S_0;

// XTS = 0, 32768kHz Crystal ; XTS = 1, 0.4 - 1-MHz crystal or resonator

const Clock2xx.LFXT1S_1;

// XTS = 0, Reserved ; XTS = 1, 1 - 3-MHz crystal or resonator

const Clock2xx.LFXT1S_2;

// XTS = 0, VLOCLK ; XTS = 1, 3 - 16-MHz crystal or resonator

const Clock2xx.LFXT1S_3;

// XTS = 0, Digital External ; XTS = 1, 0.4 - 16-MHz Digital External

enum Clock2xx.MOD0_t

index URL

MOD0 Bit

XDCscript usage meta-domain

values of type Clock2xx.MOD0_t

const Clock2xx.MOD0_OFF;

// Disable MOD0 bit

const Clock2xx.MOD0;

// Enable MOD0 bit

enum Clock2xx.MOD1_t

index URL

MOD1 Bit

XDCscript usage meta-domain

values of type Clock2xx.MOD1_t

const Clock2xx.MOD1_OFF;

// Disable MOD1 bit

const Clock2xx.MOD1;

// Enable MOD1 bit

enum Clock2xx.MOD2_t

index URL

MOD2 Bit

XDCscript usage meta-domain

values of type Clock2xx.MOD2_t

const Clock2xx.MOD2_OFF;

// Disable MOD2 bit

const Clock2xx.MOD2;

// Enable MOD2 bit

enum Clock2xx.MOD3_t

index URL

MOD3 Bit

XDCscript usage meta-domain

values of type Clock2xx.MOD3_t

const Clock2xx.MOD3_OFF;

// Disable MOD3 bit

const Clock2xx.MOD3;

// Enable MOD3 bit

enum Clock2xx.MOD4_t

index URL

MOD4 Bit

XDCscript usage meta-domain

values of type Clock2xx.MOD4_t

const Clock2xx.MOD4_OFF;

// Disable MOD4 bit

const Clock2xx.MOD4;

// Enable MOD4 bit

enum Clock2xx.PreCalibratedValues_t

index URL

XDCscript usage meta-domain

values of type Clock2xx.PreCalibratedValues_t

const Clock2xx.PreCal_0;

// 1 MHz

const Clock2xx.PreCal_1;

// 8 MHz

const Clock2xx.PreCal_2;

// 12 MHz

const Clock2xx.PreCal_3;

// 16 MHz

const Clock2xx.PreCal_4;

// Custom

enum Clock2xx.RSEL0_t

index URL

XDCscript usage meta-domain

values of type Clock2xx.RSEL0_t

const Clock2xx.RSEL0_OFF;

// Disable RSEL0 bit

const Clock2xx.RSEL0;

// Enable RSEL0 bit

enum Clock2xx.RSEL1_t

index URL

XDCscript usage meta-domain

values of type Clock2xx.RSEL1_t

const Clock2xx.RSEL1_OFF;

// Disable RSEL1 bit

const Clock2xx.RSEL1;

// Enable RSEL1 bit

enum Clock2xx.RSEL2_t

index URL

XDCscript usage meta-domain

values of type Clock2xx.RSEL2_t

const Clock2xx.RSEL2_OFF;

// Disable RSEL2 bit

const Clock2xx.RSEL2;

// Enable RSEL2 bit

enum Clock2xx.RSEL3_t

index URL

XDCscript usage meta-domain

values of type Clock2xx.RSEL3_t

const Clock2xx.RSEL3_OFF;

// Disable RSEL3 bit

const Clock2xx.RSEL3;

// Enable RSEL3 bit

enum Clock2xx.SELM_t

index URL

MCLK Source Select

XDCscript usage meta-domain

values of type Clock2xx.SELM_t

const Clock2xx.SELM_0;

// DCOCLK

const Clock2xx.SELM_2;

// XT2CLK/LFXTCLK

const Clock2xx.SELM_3;

// LFXTCLK

enum Clock2xx.SELS_t

index URL

XDCscript usage meta-domain

values of type Clock2xx.SELS_t

const Clock2xx.SELS_OFF;

// DCOCLK

const Clock2xx.SELS;

// XT2CLK

enum Clock2xx.XCAP_t

index URL

XDCscript usage meta-domain

values of type Clock2xx.XCAP_t

const Clock2xx.XCAP_0;

// ~1 pF

const Clock2xx.XCAP_1;

// ~6 pF

const Clock2xx.XCAP_2;

// ~10 pF

const Clock2xx.XCAP_3;

// ~12.5 pF

enum Clock2xx.XT2OFF_t

index URL

XDCscript usage meta-domain

values of type Clock2xx.XT2OFF_t

const Clock2xx.XT2OFF_OFF;

// Enable XT2CLK

const Clock2xx.XT2OFF;

// Disable XT2CLK

enum Clock2xx.XT2OF_t

index URL

XDCscript usage meta-domain

values of type Clock2xx.XT2OF_t

const Clock2xx.XT2OF_OFF;

// No fault condition present

const Clock2xx.XT2OF;

// XT2 fault condition present

enum Clock2xx.XT2S_t

index URL

XT2 frequency range select

XDCscript usage meta-domain

values of type Clock2xx.XT2S_t

const Clock2xx.XT2S_0;

// 0.4 - 1 MHz

const Clock2xx.XT2S_1;

// 1 - 3 MHz

const Clock2xx.XT2S_2;

// 3 - 16 MHz

const Clock2xx.XT2S_3;

// Digital input signal

enum Clock2xx.XTS_t

index URL

XDCscript usage meta-domain

values of type Clock2xx.XTS_t

const Clock2xx.XTS_OFF;

// Low Frequency

const Clock2xx.XTS;

// High Frequency

struct Clock2xx.BCSCTL1_t

index URL

BCS Control Register 1

XDCscript usage meta-domain

var obj = new Clock2xx.BCSCTL1_t;

obj.XT2OFF = Clock2xx.XT2OFF_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

obj.XTS = Clock2xx.XTS_t ...

// LFXT1 mode select. 0 Low frequency mode 1 High frequency mode

obj.DIVA = Clock2xx.DIVA_t ...

// Divider for ACLK 00 /1 01 /2 10 /4 11 /8

obj.RSEL0 = Clock2xx.RSEL0_t ...

// Range select bit 0

obj.RSEL1 = Clock2xx.RSEL1_t ...

// Range select bit 1

obj.RSEL2 = Clock2xx.RSEL2_t ...

// Range select bit 2

obj.RSEL3 = Clock2xx.RSEL3_t ...

// 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 Clock2xx.BCSCTL2_t

index URL

BCS Control Register 2

XDCscript usage meta-domain

var obj = new Clock2xx.BCSCTL2_t;

obj.SELM = Clock2xx.SELM_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

obj.DIVM = Clock2xx.DIVM_t ...

// Divider for MCLK 00 /1 01 /2 10 /4 11 /8

obj.SELS = Clock2xx.SELS_t ...

// Select SMCLK. This bit selects the SMCLK source. 0 DCOCLK 1 XT2CLK when XT2 oscillator present. LFXT1CLK or VLOCLK when XT2 oscillator not present

obj.DIVS = Clock2xx.DIVS_t ...

// Divider for SMCLK 00 /1 01 /2 10 /4 11 /8

obj.DCOR = Clock2xx.DCOR_t ...

// 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 Clock2xx.BCSCTL3_t

index URL

BCS Control register 3

XDCscript usage meta-domain

var obj = new Clock2xx.BCSCTL3_t;

obj.XT2S = Clock2xx.XT2S_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

obj.LFXT1S = Clock2xx.LFXT1S_t ...

// 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

obj.XCAP = Clock2xx.XCAP_t ...

// 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

obj.XT2OF = Clock2xx.XT2OF_t ...

// XT2 oscillator fault 0 No fault condition present 1 Fault condition present

obj.LFXT1OF = Clock2xx.LFXT1OF_t ...

// 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 Clock2xx.DCOCTL_t

index URL

XDCscript usage meta-domain

var obj = new Clock2xx.DCOCTL_t;

obj.MOD0 = Clock2xx.MOD0_t ...

// Modulation Bit 0

obj.MOD1 = Clock2xx.MOD1_t ...

// Modulation Bit 1

obj.MOD2 = Clock2xx.MOD2_t ...

// Modulation Bit 2

obj.MOD3 = Clock2xx.MOD3_t ...

// Modulation Bit 3

obj.MOD4 = Clock2xx.MOD4_t ...

// Modulation Bit 4

obj.DCO0 = Clock2xx.DCO0_t ...

// DCO Select Bit 0

obj.DCO1 = Clock2xx.DCO1_t ...

// DCO Select Bit 1

obj.DCO2 = Clock2xx.DCO2_t ...

// DCO Select Bit 2

struct Clock2xx.ForceSetDefaultRegister_t

index URL

Force Set Default Register

XDCscript usage meta-domain

var obj = new Clock2xx.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

Clock2xx.addPeripheralsMap() // module-wide

index URL

Create a map of all peripherals available on a device

XDCscript usage meta-domain

Clock2xx.addPeripheralsMap(ICpuDataSheet.Instance cds) returns Void

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.

Clock2xx.getAll() // module-wide

index URL

Find all peripherals of a certain type

XDCscript usage meta-domain

Clock2xx.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

Clock2xx.getRegisters() // module-wide

index URL

Find all registers defined by the peripheral

XDCscript usage meta-domain

Clock2xx.getRegisters() returns String[]

RETURNS

Returns an array of register names

Instance Config Parameters

index URL

XDCscript usage meta-domain

var params = new Clock2xx.Params;

// Instance config-params object

params.ACLKHz = Float undefined;

// Stores ACLK as frequency in float

params.BCSCTL1 = Clock2xx.BCSCTL1_t {

// Basic Clock System Control 1

XT2OFF: Clock2xx.XT2OFF,

XTS: Clock2xx.XTS_OFF,

DIVA: Clock2xx.DIVA_0,

RSEL0: Clock2xx.RSEL0,

RSEL1: Clock2xx.RSEL1,

RSEL2: Clock2xx.RSEL2,

RSEL3: Clock2xx.RSEL3_OFF

};

params.BCSCTL2 = Clock2xx.BCSCTL2_t {

// Basic Clock System Control 2

SELM: Clock2xx.SELM_0,

DIVM: Clock2xx.DIVM_0,

SELS: Clock2xx.SELS_OFF,

DIVS: Clock2xx.DIVS_0,

DCOR: Clock2xx.DCOR_OFF

};

params.BCSCTL3 = Clock2xx.BCSCTL3_t {

// Basic Clock System Control 3

XT2S: Clock2xx.XT2S_0,

LFXT1S: Clock2xx.LFXT1S_0,

XCAP: Clock2xx.XCAP_1

};

params.DCOCLKHz = Float 1000000;

// Stores the DCO clock frequency in float

params.DCOCTL = Clock2xx.DCOCTL_t {

// DCO Clock Frequency Control

MOD0: Clock2xx.MOD0_OFF,

MOD1: Clock2xx.MOD1_OFF,

MOD2: Clock2xx.MOD2_OFF,

MOD3: Clock2xx.MOD3_OFF,

MOD4: Clock2xx.MOD4_OFF,

DCO0: Clock2xx.DCO0,

DCO1: Clock2xx.DCO1,

DCO2: Clock2xx.DCO2_OFF

};

params.LFXT1CLKHz = Float 0;

params.MCLKHz = Float undefined;

// Stores MCLK as frequency in float

params.SMCLKHz = Float undefined;

// Stores SMCLK as frequency in float

params.VLOCLKHz = Float 12000;

params.WATCHCRYSTALCLKHz = Float 32768;

params.XT2CLKHz = Float 0;

params.baseAddr = UInt undefined;

// Address of the peripheral's control register

params.forceSetDefaultRegister = Clock2xx.ForceSetDefaultRegister_t[] [

// Determine if each Register needs to be forced set or not

{

regForceSet: false

{

regForceSet: false

{

regForceSet: false

{

regForceSet: false

}

];

params.hasXT2 = Bool false;

// Set whether XT2 is available on the device

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 = Clock2xx.PreCalibratedValues_t Clock2xx.PreCal_0;

// Basic Clock System 2xx pre-calibrated system frequency

config Clock2xx.ACLKHz // instance

index URL

Stores ACLK as frequency in float

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

const params.ACLKHz = Float computed value;

config Clock2xx.BCSCTL1 // instance

index URL

Basic Clock System Control 1

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

params.BCSCTL1 = Clock2xx.BCSCTL1_t {

XT2OFF: Clock2xx.XT2OFF,

XTS: Clock2xx.XTS_OFF,

DIVA: Clock2xx.DIVA_0,

RSEL0: Clock2xx.RSEL0,

RSEL1: Clock2xx.RSEL1,

RSEL2: Clock2xx.RSEL2,

RSEL3: Clock2xx.RSEL3_OFF

};

config Clock2xx.BCSCTL2 // instance

index URL

Basic Clock System Control 2

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

params.BCSCTL2 = Clock2xx.BCSCTL2_t {

SELM: Clock2xx.SELM_0,

DIVM: Clock2xx.DIVM_0,

SELS: Clock2xx.SELS_OFF,

DIVS: Clock2xx.DIVS_0,

DCOR: Clock2xx.DCOR_OFF

};

config Clock2xx.BCSCTL3 // instance

index URL

Basic Clock System Control 3

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

params.BCSCTL3 = Clock2xx.BCSCTL3_t {

XT2S: Clock2xx.XT2S_0,

LFXT1S: Clock2xx.LFXT1S_0,

XCAP: Clock2xx.XCAP_1

};

config Clock2xx.DCOCLKHz // instance

index URL

Stores the DCO clock frequency in float

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

const params.DCOCLKHz = Float 1000000;

config Clock2xx.DCOCTL // instance

index URL

DCO Clock Frequency Control

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

params.DCOCTL = Clock2xx.DCOCTL_t {

MOD0: Clock2xx.MOD0_OFF,

MOD1: Clock2xx.MOD1_OFF,

MOD2: Clock2xx.MOD2_OFF,

MOD3: Clock2xx.MOD3_OFF,

MOD4: Clock2xx.MOD4_OFF,

DCO0: Clock2xx.DCO0,

DCO1: Clock2xx.DCO1,

DCO2: Clock2xx.DCO2_OFF

};

config Clock2xx.LFXT1CLKHz // instance

index URL

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

params.LFXT1CLKHz = Float 0;

config Clock2xx.MCLKHz // instance

index URL

Stores MCLK as frequency in float

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

const params.MCLKHz = Float computed value;

config Clock2xx.SMCLKHz // instance

index URL

Stores SMCLK as frequency in float

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

const params.SMCLKHz = Float computed value;

config Clock2xx.VLOCLKHz // instance

index URL

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

params.VLOCLKHz = Float 12000;

config Clock2xx.WATCHCRYSTALCLKHz // instance

index URL

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

params.WATCHCRYSTALCLKHz = Float 32768;

config Clock2xx.XT2CLKHz // instance

index URL

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

params.XT2CLKHz = Float 0;

config Clock2xx.baseAddr // instance

index URL

Address of the peripheral's control register

XDCscript usage meta-domain

var params = new Clock2xx.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 Clock2xx.forceSetDefaultRegister // instance

index URL

Determine if each Register needs to be forced set or not

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

const params.forceSetDefaultRegister = Clock2xx.ForceSetDefaultRegister_t[] [

{

regForceSet: false

{

regForceSet: false

{

regForceSet: false

{

regForceSet: false

}

];

config Clock2xx.hasXT2 // instance

index URL

Set whether XT2 is available on the device

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

params.hasXT2 = Bool false;

config Clock2xx.name // instance

index URL

Specific peripheral name given by the device

XDCscript usage meta-domain

var params = new Clock2xx.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 Clock2xx.owner // instance

index URL

String specifying the entity that manages the peripheral

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

params.owner = String undefined;

config Clock2xx.preCalibratedValues // instance

index URL

Basic Clock System 2xx pre-calibrated system frequency

XDCscript usage meta-domain

var params = new Clock2xx.Params;

...

params.preCalibratedValues = Clock2xx.PreCalibratedValues_t Clock2xx.PreCal_0;

Instance Creation

index URL

XDCscript usage meta-domain

var params = new Clock2xx.Params;

// Allocate instance config-params

params.config = ...

// Assign individual configs

var inst = Clock2xx.create(IE1.Instance interruptEnableRegister1, params);

// Create an instance-object

Clock2xx.computeDCOCLKHz() // instance

index URL

Initialize to the nearest available DCO clock frequency

XDCscript usage meta-domain

inst.computeDCOCLKHz(Float DCOCLKHz) returns Void

generated on Tue, 24 Aug 2010 15:40:41 GMT