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// No action;
        const WDTplus.WDTCNTCL// WDTCNT = 0000h;
 
    values of type WDTplus.WDTHOLD_t// 
 
    values of type WDTplus.WDTIS0_t// 
 
    values of type WDTplus.WDTIS1_t// 
 
    values of type WDTplus.WDTNMIES_t// 
 
    values of type WDTplus.WDTNMI_t// 
        const WDTplus.WDTNMI_OFF// Reset function;
        const WDTplus.WDTNMI// NMI function;
 
    values of type WDTplus.WDTPW_t// 
        const WDTplus.WDTPW// Watchdog password;
 
    values of type WDTplus.WDTSSEL_t// 
        const WDTplus.WDTSSEL_OFF// SMCLK;
        const WDTplus.WDTSSEL// ACLK;
 
    values of type WDTplus.WDTTMSEL_t// 
        const WDTplus.WDTTMSEL_OFF// Watchdog mode;
 
        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: true
            }
        ];
        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, params);
 
 
enum WDTplus.WDTCNTCL_t
XDCscript usage meta-domain
values of type WDTplus.WDTCNTCL_t
    const WDTplus.WDTCNTCL_OFF;
    // No action
    const WDTplus.WDTCNTCL;
    // WDTCNT = 0000h
 
 
enum WDTplus.WDTHOLD_t
XDCscript usage meta-domain
values of type WDTplus.WDTHOLD_t
    const WDTplus.WDTHOLD_OFF;
    // Watchdog timer+ is not stopped
    const WDTplus.WDTHOLD;
    // Watchdog timer+ is stopped
 
 
enum WDTplus.WDTIS0_t
XDCscript usage meta-domain
values of type WDTplus.WDTIS0_t
    const WDTplus.WDTIS0_OFF;
    // Watchdog clock source bit0 disabled
    const WDTplus.WDTIS0;
    // Watchdog clock source bit0 enabled
 
 
enum WDTplus.WDTIS1_t
XDCscript usage meta-domain
values of type WDTplus.WDTIS1_t
    const WDTplus.WDTIS1_OFF;
    // Watchdog clock source bit1 disabled
    const WDTplus.WDTIS1;
    // Watchdog clock source bit1 enabled
 
 
enum WDTplus.WDTNMIES_t
XDCscript usage meta-domain
values of type WDTplus.WDTNMIES_t
    const WDTplus.WDTNMIES_OFF;
    // NMI on rising edge
    const WDTplus.WDTNMIES;
    // NMI on falling edge
 
 
enum WDTplus.WDTNMI_t
XDCscript usage meta-domain
values of type WDTplus.WDTNMI_t
    const WDTplus.WDTNMI_OFF;
    // Reset function
    const WDTplus.WDTNMI;
    // NMI function
 
 
enum WDTplus.WDTPW_t
XDCscript usage meta-domain
values of type WDTplus.WDTPW_t
    const WDTplus.WDTPW_OFF;
    // no Watchdog password value
    const WDTplus.WDTPW;
    // Watchdog password
 
 
enum WDTplus.WDTSSEL_t
XDCscript usage meta-domain
values of type WDTplus.WDTSSEL_t
    const WDTplus.WDTSSEL_OFF;
    // SMCLK
    const WDTplus.WDTSSEL;
    // ACLK
 
 
enum WDTplus.WDTTMSEL_t
XDCscript usage meta-domain
values of type WDTplus.WDTTMSEL_t
    const WDTplus.WDTTMSEL_OFF;
    // Watchdog mode
    const WDTplus.WDTTMSEL;
    // Interval timer mode
 
 
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.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: true
        }
    ];
    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: true
    }
];
 
 
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, params);
// Create an instance-object
generated on Fri, 14 Sep 2012 21:31:21 GMT