module ti.catalog.msp430.peripherals.special

metaonly module ti.catalog.msp430.peripherals.special_function.IE1

index URL

MSP430 Interrupt Enable Register 1

XDCscript usage
Individual elements

XDCscript usage meta-domain sourced in ti/catalog/msp430/peripherals/special_function/IE1.xdc

var IE1 = xdc.useModule('ti.catalog.msp430.peripherals.special_function.IE1');

module-wide constants & types

values of type IE1.NMIE_t//

const IE1.NMIE_OFF;

const IE1.NMIE;

values of type IE1.OFIE_t//

const IE1.OFIE_OFF// Interrupt not enabled;

const IE1.OFIE// Interrupt enabled;

values of type IE1.WDTIE_t//

const IE1.WDTIE_OFF;

const IE1.WDTIE;

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

obj.register = String ...

obj.regForceSet = Bool ...

var obj = new IE1.IE1_t// ;

obj.NMIE = IE1.NMIE_t ...

obj.OFIE = IE1.OFIE_t ...

obj.WDTIE = IE1.WDTIE_t ...

module-wide functions

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

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

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

per-instance config parameters

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

params.IE1// IE1, Interrupt Enable Register 1 = IE1.IE1_t {

NMIE: IE1.NMIE_OFF,

OFIE: IE1.OFIE_OFF,

WDTIE: IE1.WDTIE_OFF

};

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

{

regForceSet: false

}

];

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

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

per-instance functions

inst.getNMIE// Gets NMIE bit() returns Bool

inst.getOFIE// Gets OFIE bit() returns Bool

inst.getWDTIE// Gets WDTIE bit() returns Bool

inst.setNMIE// Sets NMIE bit(Bool set) returns Bool

inst.setOFIE// Sets OFIE bit(Bool set) returns Bool

inst.setWDTIE// Sets WDTIE bit(Bool set) returns Bool

enum IE1.NMIE_t

index URL

XDCscript usage meta-domain

values of type IE1.NMIE_t

const IE1.NMIE_OFF;

const IE1.NMIE;

enum IE1.OFIE_t

index URL

XDCscript usage meta-domain

values of type IE1.OFIE_t

const IE1.OFIE_OFF;

// Interrupt not enabled

const IE1.OFIE;

// Interrupt enabled

enum IE1.WDTIE_t

index URL

XDCscript usage meta-domain

values of type IE1.WDTIE_t

const IE1.WDTIE_OFF;

const IE1.WDTIE;

struct IE1.ForceSetDefaultRegister_t

index URL

Force Set Default Register

XDCscript usage meta-domain

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

struct IE1.IE1_t

index URL

XDCscript usage meta-domain

var obj = new IE1.IE1_t;

obj.NMIE = IE1.NMIE_t ...

obj.OFIE = IE1.OFIE_t ...

obj.WDTIE = IE1.WDTIE_t ...

IE1.addPeripheralsMap() // module-wide

index URL

Create a map of all peripherals available on a device

XDCscript usage meta-domain

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

IE1.getAll() // module-wide

index URL

Find all peripherals of a certain type

XDCscript usage meta-domain

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

IE1.getRegisters() // module-wide

index URL

Find all registers defined by the peripheral

XDCscript usage meta-domain

IE1.getRegisters() returns String[]

RETURNS

Returns an array of register names

Instance Config Parameters

index URL

XDCscript usage meta-domain

var params = new IE1.Params;

// Instance config-params object

params.IE1 = IE1.IE1_t {

// IE1, Interrupt Enable Register 1

NMIE: IE1.NMIE_OFF,

OFIE: IE1.OFIE_OFF,

WDTIE: IE1.WDTIE_OFF

};

params.forceSetDefaultRegister = IE1.ForceSetDefaultRegister_t[] [

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

{

regForceSet: false

}

];

params.name = String undefined;

// Specific peripheral name given by the device

params.owner = String undefined;

// String specifying the entity that manages the peripheral

config IE1.IE1 // instance

index URL

IE1, Interrupt Enable Register 1

XDCscript usage meta-domain

var params = new IE1.Params;

...

params.IE1 = IE1.IE1_t {

NMIE: IE1.NMIE_OFF,

OFIE: IE1.OFIE_OFF,

WDTIE: IE1.WDTIE_OFF

};

config IE1.forceSetDefaultRegister // instance

index URL

Determine if each Register needs to be forced set or not

XDCscript usage meta-domain

var params = new IE1.Params;

...

const params.forceSetDefaultRegister = IE1.ForceSetDefaultRegister_t[] [

{

regForceSet: false

}

];

config IE1.name // instance

index URL

Specific peripheral name given by the device

XDCscript usage meta-domain

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

index URL

String specifying the entity that manages the peripheral

XDCscript usage meta-domain

var params = new IE1.Params;

...

params.owner = String undefined;

IE1.getNMIE() // instance

index URL

Gets NMIE bit

XDCscript usage meta-domain

inst.getNMIE() returns Bool