metaonly module ti.catalog.msp430.peripherals.special_function.SR
index URL

MSP430 Status Register

XDCscript usage meta-domain sourced in ti/catalog/msp430/peripherals/special_function/SR.xdc
var SR = xdc.useModule('ti.catalog.msp430.peripherals.special_function.SR');
module-wide constants & types
    values of type SR.CPUOFF_t// 
        const SR.CPUOFF_OFF// CPU On;
        const SR.CPUOFF// CPU Off;
 
    values of type SR.GIE_t// 
        const SR.GIE_OFF// General interrupt disable;
        const SR.GIE// General interrupt enable;
 
    values of type SR.OSCOFF_t// 
        const SR.OSCOFF_OFF// Oscillator On;
        const SR.OSCOFF// Oscillator Off;
 
    values of type SR.SCG0_t// 
        const SR.SCG0_OFF// Disable System clock generator 0;
        const SR.SCG0// Enable System clock generator 0;
 
    values of type SR.SCG1_t// 
        const SR.SCG1_OFF// Disable System clock generator 1;
        const SR.SCG1// Enable System clock generator 1;
 
    var obj = new SR.ForceSetDefaultRegister_t// Force Set Default Register;
        obj.register = String  ...
        obj.regForceSet = Bool  ...
 
    var obj = new SR.SR_t// ;
        obj.SCG1// System clock generator 1 This bit, when set, turns off the SMCLK = SR.SCG1_t  ...
        obj.SCG0// System clock generator 0 This bit, when set, turns off the DCO dc generator, if DCOCLK is not used for MCLK or SMCLK = SR.SCG0_t  ...
        obj.OSCOFF// Oscillator Off This bit, when set, turns off the LFXT1 crystal oscillator, when LFXT1CLK is not use for MCLK or SMCLK = SR.OSCOFF_t  ...
        obj.CPUOFF// CPU off This bit, when set, turns off the CPU = SR.CPUOFF_t  ...
        obj.GIE// General interrupt enable This bit, when set, enables maskable interrupts. When reset, all maskable interrupts are disabled = SR.GIE_t  ...
module-wide functions
    SR.getAll// Find all peripherals of a certain type() returns IPeripheral.Instance[]
    SR.getRegisters// Find all registers defined by the peripheral() returns String[]
per-instance config parameters
    var params = new SR.Params// Instance config-params object;
        params.SR// SR, Status Register = SR.SR_t {
            SCG1: SR.SCG1_OFF,
            SCG0: SR.SCG0_OFF,
            OSCOFF: SR.OSCOFF_OFF,
            CPUOFF: SR.CPUOFF_OFF,
            GIE: SR.GIE_OFF
        };
        params.forceSetDefaultRegister// Determine if each Register needs to be forced set or not = SR.ForceSetDefaultRegister_t[] [
            {
                register: "SR",
                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.getCPUOFF// Gets CPUOFF bit() returns Bool
    inst.getGIE// Gets GIE bit() returns Bool
    inst.getOSCOFF// Gets OSCOFF bit() returns Bool
    inst.getSCG0// Gets SCG0 bit() returns Bool
    inst.getSCG1// Gets SCG1 bit() returns Bool
    inst.setCPUOFF// Sets CPUOFF bit(Bool set) returns Bool
    inst.setGIE// Sets GIE bit(Bool set) returns Bool
    inst.setOSCOFF// Sets OSCOFF bit(Bool set) returns Bool
    inst.setSCG0// Sets SCG0 bit(Bool set) returns Bool
    inst.setSCG1// Sets SCG1 bit(Bool set) returns Bool
 
 
enum SR.CPUOFF_t
index URL
XDCscript usage meta-domain
values of type SR.CPUOFF_t
    const SR.CPUOFF_OFF;
    // CPU On
    const SR.CPUOFF;
    // CPU Off
 
 
enum SR.GIE_t
index URL
XDCscript usage meta-domain
values of type SR.GIE_t
    const SR.GIE_OFF;
    // General interrupt disable
    const SR.GIE;
    // General interrupt enable
 
 
enum SR.OSCOFF_t
index URL
XDCscript usage meta-domain
values of type SR.OSCOFF_t
    const SR.OSCOFF_OFF;
    // Oscillator On
    const SR.OSCOFF;
    // Oscillator Off
 
 
enum SR.SCG0_t
index URL
XDCscript usage meta-domain
values of type SR.SCG0_t
    const SR.SCG0_OFF;
    // Disable System clock generator 0
    const SR.SCG0;
    // Enable System clock generator 0
 
 
enum SR.SCG1_t
index URL
XDCscript usage meta-domain
values of type SR.SCG1_t
    const SR.SCG1_OFF;
    // Disable System clock generator 1
    const SR.SCG1;
    // Enable System clock generator 1
 
 
struct SR.ForceSetDefaultRegister_t
index URL

Force Set Default Register

XDCscript usage meta-domain
var obj = new SR.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 SR.SR_t
index URL
XDCscript usage meta-domain
var obj = new SR.SR_t;
 
    obj.SCG1 = SR.SCG1_t  ...
    // System clock generator 1 This bit, when set, turns off the SMCLK
    obj.SCG0 = SR.SCG0_t  ...
    // System clock generator 0 This bit, when set, turns off the DCO dc generator, if DCOCLK is not used for MCLK or SMCLK
    obj.OSCOFF = SR.OSCOFF_t  ...
    // Oscillator Off This bit, when set, turns off the LFXT1 crystal oscillator, when LFXT1CLK is not use for MCLK or SMCLK
    obj.CPUOFF = SR.CPUOFF_t  ...
    // CPU off This bit, when set, turns off the CPU
    obj.GIE = SR.GIE_t  ...
    // General interrupt enable This bit, when set, enables maskable interrupts. When reset, all maskable interrupts are disabled
 
 
SR.getAll()  // module-wide
index URL

Find all peripherals of a certain type

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

Find all registers defined by the peripheral

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

XDCscript usage meta-domain
var params = new SR.Params;
// Instance config-params object
    params.SR = SR.SR_t {
    // SR, Status Register
        SCG1: SR.SCG1_OFF,
        SCG0: SR.SCG0_OFF,
        OSCOFF: SR.OSCOFF_OFF,
        CPUOFF: SR.CPUOFF_OFF,
        GIE: SR.GIE_OFF
    };
    params.forceSetDefaultRegister = SR.ForceSetDefaultRegister_t[] [
    // Determine if each Register needs to be forced set or not
        {
            register: "SR",
            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 SR.SR  // instance
index URL

SR, Status Register

XDCscript usage meta-domain
var params = new SR.Params;
  ...
params.SR = SR.SR_t {
    SCG1: SR.SCG1_OFF,
    SCG0: SR.SCG0_OFF,
    OSCOFF: SR.OSCOFF_OFF,
    CPUOFF: SR.CPUOFF_OFF,
    GIE: SR.GIE_OFF
};
 
 
config SR.forceSetDefaultRegister  // instance
index URL

Determine if each Register needs to be forced set or not

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

Specific peripheral name given by the device

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

String specifying the entity that manages the peripheral

XDCscript usage meta-domain
var params = new SR.Params;
  ...
params.owner = String undefined;
 
 
SR.getCPUOFF()  // instance
index URL

Gets CPUOFF bit

XDCscript usage meta-domain
inst.getCPUOFF() returns Bool
 
SEE
getCPUOFF
 
SR.getGIE()  // instance
index URL

Gets GIE bit

XDCscript usage meta-domain
inst.getGIE() returns Bool
 
SEE
getGIE
 
SR.getOSCOFF()  // instance
index URL

Gets OSCOFF bit

XDCscript usage meta-domain
inst.getOSCOFF() returns Bool
 
SEE
getOSCOFF
 
SR.getSCG0()  // instance
index URL

Gets SCG0 bit

XDCscript usage meta-domain
inst.getSCG0() returns Bool
 
SEE
getSCG0
 
SR.getSCG1()  // instance
index URL

Gets SCG1 bit

XDCscript usage meta-domain
inst.getSCG1() returns Bool
 
SEE
getSCG1
 
SR.setCPUOFF()  // instance
index URL

Sets CPUOFF bit

XDCscript usage meta-domain
inst.setCPUOFF(Bool set) returns Bool
 
SEE
setCPUOFF
 
SR.setGIE()  // instance
index URL

Sets GIE bit

XDCscript usage meta-domain
inst.setGIE(Bool set) returns Bool
 
SEE
setGIE
 
SR.setOSCOFF()  // instance
index URL

Sets OSCOFF bit

XDCscript usage meta-domain
inst.setOSCOFF(Bool set) returns Bool
 
SEE
setOSCOFF
 
SR.setSCG0()  // instance
index URL

Sets SCG0 bit

XDCscript usage meta-domain
inst.setSCG0(Bool set) returns Bool
 
SEE
setSCG0
 
SR.setSCG1()  // instance
index URL

Sets SCG1 bit

XDCscript usage meta-domain
inst.setSCG1(Bool set) returns Bool
 
SEE
setSCG1
generated on Thu, 27 Sep 2012 23:24:43 GMT