metaonly module ti.catalog.msp430.peripherals.comparator.Comparator_E

MSP430FR5xx Family Comparator_E Module

XDCscript usage meta-domain sourced in ti/catalog/msp430/peripherals/comparator/Comparator_E.xdc
var Comparator_E = xdc.useModule('ti.catalog.msp430.peripherals.comparator.Comparator_E');
module-wide constants & types
    values of type Comparator_E.CAEX_t// CAEX Bit
        const Comparator_E.CAEX// Enable CAEX bit;
 
    values of type Comparator_E.CAF_t// CAF Bit
        const Comparator_E.CAF// Enable CAF bit;
 
    values of type Comparator_E.CAIES_t// CAIES Bit
        const Comparator_E.CAIES_OFF// Rising Edge;
        const Comparator_E.CAIES// Falling Edge;
 
    values of type Comparator_E.CAIE_t// CAIE Bit
        const Comparator_E.CAIE// Enable CAIE bit;
 
    values of type Comparator_E.CAIFG_t// CAIFG Bit
 
    values of type Comparator_E.CAON_t// CAON Bit
        const Comparator_E.CAON// Enable CAON bit;
 
    values of type Comparator_E.CAPD0_t// CAPD0 Bit
 
    values of type Comparator_E.CAPD1_t// CAPD1 Bit
 
    values of type Comparator_E.CAPD2_t// CAPD2 Bit
 
    values of type Comparator_E.CAPD3_t// CAPD3 Bit
 
    values of type Comparator_E.CAPD4_t// CAPD4 Bit
 
    values of type Comparator_E.CAPD5_t// CAPD5 Bit
 
    values of type Comparator_E.CAPD6_t// CAPD6 Bit
 
    values of type Comparator_E.CAPD7_t// CAPD7 Bit
 
    values of type Comparator_E.CAREF_t// CAREF Bit
        const Comparator_E.CAREF_0// Reference Off;
        const Comparator_E.CAREF_1// 0.25 * VCC;
        const Comparator_E.CAREF_2// 0.50 * VCC;
 
    values of type Comparator_E.CARSEL_t// CARSEL Bit
 
    values of type Comparator_E.CASHORT_t// CASHORT Bit
 
    values of type Comparator_E.P2CA0_t// P2CA0 Bit
 
    values of type Comparator_E.P2CA1_t// P2CA1 Bit
 
    values of type Comparator_E.P2CA2_t// P2CA2 Bit
 
    values of type Comparator_E.P2CA3_t// P2CA3 Bit
 
    values of type Comparator_E.P2CA4_t// P2CA4 Bit
 
        obj.register = String  ...
        obj.regForceSet = Bool  ...
 
        obj.registerName = String  ...
        obj.registerDescription = String  ...
        obj.isrToggleString = String  ...
        obj.priorityName = String  ...
        obj.interruptEnable = Bool  ...
        obj.interruptHandler = Bool  ...
        obj.priority = Int  ...
module-wide functions
per-instance config parameters
    var params = new Comparator_E.Params// Instance config-params object;
        params.baseAddr// Address of the peripheral's control register = UInt undefined;
        params.interruptSource// Interrupt enables = Comparator_E.regIntVect_t[2] undefined;
        params.name// Specific peripheral name given by the device = String undefined;
        params.owner// String specifying the entity that manages the peripheral = String undefined;
 
 
enum Comparator_E.CAEX_t

CAEX Bit

XDCscript usage meta-domain
values of type Comparator_E.CAEX_t
    const Comparator_E.CAEX_OFF;
    // Disable CAEX bit
    const Comparator_E.CAEX;
    // Enable CAEX bit
 
 
enum Comparator_E.CAF_t

CAF Bit

XDCscript usage meta-domain
values of type Comparator_E.CAF_t
    const Comparator_E.CAF_OFF;
    // Disable CAF bit
    const Comparator_E.CAF;
    // Enable CAF bit
 
 
enum Comparator_E.CAIES_t

CAIES Bit

XDCscript usage meta-domain
values of type Comparator_E.CAIES_t
    const Comparator_E.CAIES_OFF;
    // Rising Edge
    const Comparator_E.CAIES;
    // Falling Edge
 
 
enum Comparator_E.CAIE_t

CAIE Bit

XDCscript usage meta-domain
values of type Comparator_E.CAIE_t
    const Comparator_E.CAIE_OFF;
    // Disable CAIE bit
    const Comparator_E.CAIE;
    // Enable CAIE bit
 
 
enum Comparator_E.CAIFG_t

CAIFG Bit

XDCscript usage meta-domain
values of type Comparator_E.CAIFG_t
    const Comparator_E.CAIFG_OFF;
    // Disable CAIFG bit
    const Comparator_E.CAIFG;
    // Enable CAIFG bit
 
 
enum Comparator_E.CAON_t

CAON Bit

XDCscript usage meta-domain
values of type Comparator_E.CAON_t
    const Comparator_E.CAON_OFF;
    // Disable CAON bit
    const Comparator_E.CAON;
    // Enable CAON bit
 
 
enum Comparator_E.CAPD0_t

CAPD0 Bit

XDCscript usage meta-domain
values of type Comparator_E.CAPD0_t
    const Comparator_E.CAPD0_OFF;
    // Disable CAPD0 bit
    const Comparator_E.CAPD0;
    // Enable CAPD0 bit
 
 
enum Comparator_E.CAPD1_t

CAPD1 Bit

XDCscript usage meta-domain
values of type Comparator_E.CAPD1_t
    const Comparator_E.CAPD1_OFF;
    // Disable CAPD1 bit
    const Comparator_E.CAPD1;
    // Enable CAPD1 bit
 
 
enum Comparator_E.CAPD2_t

CAPD2 Bit

XDCscript usage meta-domain
values of type Comparator_E.CAPD2_t
    const Comparator_E.CAPD2_OFF;
    // Disable CAPD2 bit
    const Comparator_E.CAPD2;
    // Enable CAPD2 bit
 
 
enum Comparator_E.CAPD3_t

CAPD3 Bit

XDCscript usage meta-domain
values of type Comparator_E.CAPD3_t
    const Comparator_E.CAPD3_OFF;
    // Disable CAPD3 bit
    const Comparator_E.CAPD3;
    // Enable CAPD3 bit
 
 
enum Comparator_E.CAPD4_t

CAPD4 Bit

XDCscript usage meta-domain
values of type Comparator_E.CAPD4_t
    const Comparator_E.CAPD4_OFF;
    // Disable CAPD4 bit
    const Comparator_E.CAPD4;
    // Enable CAPD4 bit
 
 
enum Comparator_E.CAPD5_t

CAPD5 Bit

XDCscript usage meta-domain
values of type Comparator_E.CAPD5_t
    const Comparator_E.CAPD5_OFF;
    // Disable CAPD5 bit
    const Comparator_E.CAPD5;
    // Enable CAPD5 bit
 
 
enum Comparator_E.CAPD6_t

CAPD6 Bit

XDCscript usage meta-domain
values of type Comparator_E.CAPD6_t
    const Comparator_E.CAPD6_OFF;
    // Disable CAPD6 bit
    const Comparator_E.CAPD6;
    // Enable CAPD6 bit
 
 
enum Comparator_E.CAPD7_t

CAPD7 Bit

XDCscript usage meta-domain
values of type Comparator_E.CAPD7_t
    const Comparator_E.CAPD7_OFF;
    // Disable CAPD7 bit
    const Comparator_E.CAPD7;
    // Enable CAPD7 bit
 
 
enum Comparator_E.CAREF_t

CAREF Bit

XDCscript usage meta-domain
values of type Comparator_E.CAREF_t
    const Comparator_E.CAREF_0;
    // Reference Off
    const Comparator_E.CAREF_1;
    // 0.25 * VCC
    const Comparator_E.CAREF_2;
    // 0.50 * VCC
    const Comparator_E.CAREF_3;
    // Diode Reference
 
 
enum Comparator_E.CARSEL_t

CARSEL Bit

XDCscript usage meta-domain
values of type Comparator_E.CARSEL_t
    const Comparator_E.CARSEL_OFF;
    // Disable CARSEL bit
    const Comparator_E.CARSEL;
    // Enable CARSEL bit
 
 
enum Comparator_E.CASHORT_t

CASHORT Bit

XDCscript usage meta-domain
values of type Comparator_E.CASHORT_t
    const Comparator_E.CASHORT_OFF;
    // Disable CASHORT bit
    const Comparator_E.CASHORT;
    // Enable CASHORT bit
 
 
enum Comparator_E.P2CA0_t

P2CA0 Bit

XDCscript usage meta-domain
values of type Comparator_E.P2CA0_t
    const Comparator_E.P2CA0_OFF;
    // Disable P2CA0 bit
    const Comparator_E.P2CA0;
    // Enable P2CA0 bit
 
 
enum Comparator_E.P2CA1_t

P2CA1 Bit

XDCscript usage meta-domain
values of type Comparator_E.P2CA1_t
    const Comparator_E.P2CA1_OFF;
    // Disable P2CA1 bit
    const Comparator_E.P2CA1;
    // Enable P2CA1 bit
 
 
enum Comparator_E.P2CA2_t

P2CA2 Bit

XDCscript usage meta-domain
values of type Comparator_E.P2CA2_t
    const Comparator_E.P2CA2_OFF;
    // Disable P2CA2 bit
    const Comparator_E.P2CA2;
    // Enable P2CA2 bit
 
 
enum Comparator_E.P2CA3_t

P2CA3 Bit

XDCscript usage meta-domain
values of type Comparator_E.P2CA3_t
    const Comparator_E.P2CA3_OFF;
    // Disable P2CA3 bit
    const Comparator_E.P2CA3;
    // Enable P2CA3 bit
 
 
enum Comparator_E.P2CA4_t

P2CA4 Bit

XDCscript usage meta-domain
values of type Comparator_E.P2CA4_t
    const Comparator_E.P2CA4_OFF;
    // Disable P2CA4 bit
    const Comparator_E.P2CA4;
    // Enable P2CA4 bit
 
 
struct Comparator_E.ForceSetDefaultRegister_t

Force Set Default Register

XDCscript usage meta-domain
var obj = new Comparator_E.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
 
struct Comparator_E.regIntVect_t

Interrupt vector description

XDCscript usage meta-domain
var obj = new Comparator_E.regIntVect_t;
 
    obj.registerName = String  ...
    obj.registerDescription = String  ...
    obj.isrToggleString = String  ...
    obj.priorityName = String  ...
    obj.interruptEnable = Bool  ...
    obj.interruptHandler = Bool  ...
    obj.priority = Int  ...
 
DETAILS
Type to describe a single interrupt vector pin and all its possible configurations.
SEE
 
Comparator_E.getAll()  // module-wide

Find all peripherals of a certain type

XDCscript usage meta-domain
Comparator_E.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
 
Comparator_E.getRegisters()  // module-wide

Find all registers defined by the peripheral

XDCscript usage meta-domain
Comparator_E.getRegisters() returns String[]
 
RETURNS
Returns an array of register names
Instance Config Parameters

XDCscript usage meta-domain
var params = new Comparator_E.Params;
// Instance config-params object
    params.baseAddr = UInt undefined;
    // Address of the peripheral's control register
    params.forceSetDefaultRegister = Comparator_E.ForceSetDefaultRegister_t[] [ ];
    // Determine if each Register needs to be forced set or not
    params.interruptSource = Comparator_E.regIntVect_t[2] undefined;
    // Interrupt enables
    params.name = String undefined;
    // Specific peripheral name given by the device
    params.owner = String undefined;
    // String specifying the entity that manages the peripheral
 
config Comparator_E.baseAddr  // instance

Address of the peripheral's control register

XDCscript usage meta-domain
var params = new Comparator_E.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 Comparator_E.forceSetDefaultRegister  // instance

Determine if each Register needs to be forced set or not

XDCscript usage meta-domain
var params = new Comparator_E.Params;
  ...
const params.forceSetDefaultRegister = Comparator_E.ForceSetDefaultRegister_t[] [ ];
 
 
config Comparator_E.interruptSource  // instance

Interrupt enables

XDCscript usage meta-domain
var params = new Comparator_E.Params;
  ...
params.interruptSource = Comparator_E.regIntVect_t[2] undefined;
 
 
config Comparator_E.name  // instance

Specific peripheral name given by the device

XDCscript usage meta-domain
var params = new Comparator_E.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 Comparator_E.owner  // instance

String specifying the entity that manages the peripheral

XDCscript usage meta-domain
var params = new Comparator_E.Params;
  ...
params.owner = String undefined;
 
generated on Tue, 16 Oct 2012 23:18:01 GMT