metaonly module ti.catalog.msp430.peripherals.watchdog.WDTPlus

MSP430 Watchdog Timer+

XDCscript usage meta-domain sourced in ti/catalog/msp430/peripherals/watchdog/WDTPlus.xdc
var WDTPlus = xdc.useModule('ti.catalog.msp430.peripherals.watchdog.WDTPlus');
module-wide constants & types
    values of type WDTPlus.WDTCNTCL_t// 
        const WDTPlus.WDTCNTCL_OFF;
        const WDTPlus.WDTCNTCL;
    values of type WDTPlus.WDTHOLD_t// 
        const WDTPlus.WDTHOLD_OFF;
        const WDTPlus.WDTHOLD;
    values of type WDTPlus.WDTIS0_t// 
        const WDTPlus.WDTIS0_OFF;
        const WDTPlus.WDTIS0;
    values of type WDTPlus.WDTIS1_t// 
        const WDTPlus.WDTIS1_OFF;
        const WDTPlus.WDTIS1;
    values of type WDTPlus.WDTNMIES_t// 
        const WDTPlus.WDTNMIES_OFF;
        const WDTPlus.WDTNMIES;
    values of type WDTPlus.WDTNMI_t// 
        const WDTPlus.WDTNMI_OFF;
        const WDTPlus.WDTNMI;
    values of type WDTPlus.WDTPW_t// 
        const WDTPlus.WDTPW_OFF;
        const WDTPlus.WDTPW;
    values of type WDTPlus.WDTSSEL_t// 
        const WDTPlus.WDTSSEL_OFF;
        const WDTPlus.WDTSSEL;
    values of type WDTPlus.WDTTMSEL_t// 
        const WDTPlus.WDTTMSEL_OFF;
        const WDTPlus.WDTTMSEL;
        obj.register = String  ...
        obj.regForceSet = Bool  ...
    var obj = new WDTPlus.WDTCTL_t// ;
        obj.WDTPW// WDT+ password = WDTPlus.WDTPW_t  ...
module-wide functions
per-instance config parameters
    var params = new WDTPlus.Params// Instance config-params object;
        WDTPW: WDTPlus.WDTPW,
        WDTHOLD: WDTPlus.WDTHOLD_OFF,
        WDTNMIES: WDTPlus.WDTNMIES_OFF,
        WDTNMI: WDTPlus.WDTNMI_OFF,
        WDTTMSEL: WDTPlus.WDTTMSEL_OFF,
        WDTCNTCL: WDTPlus.WDTCNTCL_OFF,
        WDTSSEL: WDTPlus.WDTSSEL_OFF,
        WDTIS0: WDTPlus.WDTIS0_OFF,
        WDTIS1: WDTPlus.WDTIS1_OFF
    };
        params.baseAddr// Address of the peripheral's control register = UInt undefined;
        {
            register: "WDTCTL",
            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 creation
    var inst = WDTPlus.create// Create an instance-object(IClock.Instance clock, IE1.Instance interruptEnableRegister1, params);
 
enum WDTPlus.WDTCNTCL_t
XDCscript usage meta-domain
values of type WDTPlus.WDTCNTCL_t
    const WDTPlus.WDTCNTCL_OFF;
    const WDTPlus.WDTCNTCL;
enum WDTPlus.WDTHOLD_t
XDCscript usage meta-domain
values of type WDTPlus.WDTHOLD_t
    const WDTPlus.WDTHOLD_OFF;
    const WDTPlus.WDTHOLD;
enum WDTPlus.WDTIS0_t
XDCscript usage meta-domain
values of type WDTPlus.WDTIS0_t
    const WDTPlus.WDTIS0_OFF;
    const WDTPlus.WDTIS0;
enum WDTPlus.WDTIS1_t
XDCscript usage meta-domain
values of type WDTPlus.WDTIS1_t
    const WDTPlus.WDTIS1_OFF;
    const WDTPlus.WDTIS1;
enum WDTPlus.WDTNMIES_t
XDCscript usage meta-domain
values of type WDTPlus.WDTNMIES_t
    const WDTPlus.WDTNMIES_OFF;
    const WDTPlus.WDTNMIES;
enum WDTPlus.WDTNMI_t
XDCscript usage meta-domain
values of type WDTPlus.WDTNMI_t
    const WDTPlus.WDTNMI_OFF;
    const WDTPlus.WDTNMI;
enum WDTPlus.WDTPW_t
XDCscript usage meta-domain
values of type WDTPlus.WDTPW_t
    const WDTPlus.WDTPW_OFF;
    const WDTPlus.WDTPW;
enum WDTPlus.WDTSSEL_t
XDCscript usage meta-domain
values of type WDTPlus.WDTSSEL_t
    const WDTPlus.WDTSSEL_OFF;
    const WDTPlus.WDTSSEL;
enum WDTPlus.WDTTMSEL_t
XDCscript usage meta-domain
values of type WDTPlus.WDTTMSEL_t
    const WDTPlus.WDTTMSEL_OFF;
    const WDTPlus.WDTTMSEL;
struct WDTPlus.ForceSetDefaultRegister_t

Force Set Default Register

XDCscript usage meta-domain
var obj = new WDTPlus.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 WDTPlus.WDTCTL_t
XDCscript usage meta-domain
var obj = new WDTPlus.WDTCTL_t;
 
    obj.WDTPW = WDTPlus.WDTPW_t  ...
    // WDT+ password
    obj.WDTHOLD = WDTPlus.WDTHOLD_t  ...
    // Watchdog timer+ hold. This bit stops the watchdog timer+. Setting WDTHOLD = 1 when the WDT+ is not in use conserves power. 0 Watchdog timer+ is not stopped 1 Watchdog timer+ is stopped
    obj.WDTNMIES = WDTPlus.WDTNMIES_t  ...
    // Watchdog timer+ NMI edge select. This bit selects the interrupt edge for the NMI interrupt when WDTNMI = 1. Modifying this bit can trigger an NMI. Modify this bit when WDTIE = 0 to avoid triggering an accidental NMI. 0 NMI on rising edge 1 NMI on falling edge
    obj.WDTNMI = WDTPlus.WDTNMI_t  ...
    // Watchdog timer+ NMI select. This bit selects the function for the RST/NMI pin. 0 Reset function 1 NMI function
    obj.WDTTMSEL = WDTPlus.WDTTMSEL_t  ...
    // Watchdog timer+ mode select 0 Watchdog mode 1 Interval timer mode
    obj.WDTCNTCL = WDTPlus.WDTCNTCL_t  ...
    // Watchdog timer+ counter clear. Setting WDTCNTCL = 1 clears the count value to 0000h. WDTCNTCL is automatically reset. 0 No action 1 WDTCNT = 0000h
    obj.WDTSSEL = WDTPlus.WDTSSEL_t  ...
    // Watchdog timer+ clock source select 0 SMCLK 1 ACLK
    obj.WDTIS0 = WDTPlus.WDTIS0_t  ...
    // Watchdog timer+ interval select. These bits select the watchdog timer+ interval to set the WDTIFG flag and/or generate a PUC. 00 Watchdog clock source /32768 01 Watchdog clock source /8192 10 Watchdog clock source /512 11 Watchdog clock source /64
    obj.WDTIS1 = WDTPlus.WDTIS1_t  ...
    // Watchdog timer+ interval select. These bits select the watchdog timer+ interval to set the WDTIFG flag and/or generate a PUC. 00 Watchdog clock source /32768 01 Watchdog clock source /8192 10 Watchdog clock source /512 11 Watchdog clock source /64
WDTPlus.addPeripheralsMap()  // module-wide

Create a map of all peripherals available on a device

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

Find all peripherals of a certain type

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

Find all registers defined by the peripheral

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

XDCscript usage meta-domain
var params = new WDTPlus.Params;
// Instance config-params object
    params.WDTCTL = WDTPlus.WDTCTL_t {
    // WDTCTL, Watchdog Timer+ Register
    WDTPW: WDTPlus.WDTPW,
    WDTHOLD: WDTPlus.WDTHOLD_OFF,
    WDTNMIES: WDTPlus.WDTNMIES_OFF,
    WDTNMI: WDTPlus.WDTNMI_OFF,
    WDTTMSEL: WDTPlus.WDTTMSEL_OFF,
    WDTCNTCL: WDTPlus.WDTCNTCL_OFF,
    WDTSSEL: WDTPlus.WDTSSEL_OFF,
    WDTIS0: WDTPlus.WDTIS0_OFF,
    WDTIS1: WDTPlus.WDTIS1_OFF
};
    params.baseAddr = UInt undefined;
    // Address of the peripheral's control register
    params.forceSetDefaultRegister = WDTPlus.ForceSetDefaultRegister_t[] [
    // Determine if each Register needs to be forced set or not
    {
        register: "WDTCTL",
        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 WDTPlus.WDTCTL  // instance

WDTCTL, Watchdog Timer+ Register

XDCscript usage meta-domain
var params = new WDTPlus.Params;
  ...
params.WDTCTL = WDTPlus.WDTCTL_t {
    WDTPW: WDTPlus.WDTPW,
    WDTHOLD: WDTPlus.WDTHOLD_OFF,
    WDTNMIES: WDTPlus.WDTNMIES_OFF,
    WDTNMI: WDTPlus.WDTNMI_OFF,
    WDTTMSEL: WDTPlus.WDTTMSEL_OFF,
    WDTCNTCL: WDTPlus.WDTCNTCL_OFF,
    WDTSSEL: WDTPlus.WDTSSEL_OFF,
    WDTIS0: WDTPlus.WDTIS0_OFF,
    WDTIS1: WDTPlus.WDTIS1_OFF
};
config WDTPlus.baseAddr  // instance

Address of the peripheral's control register

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

Determine if each Register needs to be forced set or not

XDCscript usage meta-domain
var params = new WDTPlus.Params;
  ...
const params.forceSetDefaultRegister = WDTPlus.ForceSetDefaultRegister_t[] [
    {
        register: "WDTCTL",
        regForceSet: false
    }
];
config WDTPlus.name  // instance

Specific peripheral name given by the device

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

String specifying the entity that manages the peripheral

XDCscript usage meta-domain
var params = new WDTPlus.Params;
  ...
params.owner = String undefined;
Instance Creation

XDCscript usage meta-domain
var params = new WDTPlus.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = WDTPlus.create(IClock.Instance clock, IE1.Instance interruptEnableRegister1, params);
// Create an instance-object
generated on Tue, 24 Aug 2010 15:40:49 GMT