| metaonly module ti.catalog.msp430.peripherals.svs.SVS |
 |
 |
MSP430F2xx Family SVS Module
| usage | meta-domain | sourced in ti/catalog/msp430/peripherals/svs/SVS.xdc |
var SVS = xdc.useModule('ti.catalog.msp430.peripherals.svs.SVS');
module-wide constants & types
values of type SVS.PORON_t// PORON Bit
values of type SVS.SVSFG_t// SVSFG Bit
const SVS.SVSFG_OFF;
const SVS.SVSFG;
values of type SVS.SVSON_t// SVSON Bit
const SVS.SVSON_OFF;
const SVS.SVSON;
values of type SVS.SVSOP_t// SVSOP Bit
const SVS.SVSOP_OFF;
const SVS.SVSOP;
values of type SVS.VLD0_t// VLD0 Bit
const SVS.VLD0_OFF;
const SVS.VLD0;
values of type SVS.VLD1_t// VLD1 Bit
const SVS.VLD1_OFF;
const SVS.VLD1;
values of type SVS.VLD2_t// VLD2 Bit
const SVS.VLD2_OFF;
const SVS.VLD2;
values of type SVS.VLD3_t// VLD3 Bit
const SVS.VLD3_OFF;
const SVS.VLD3;
obj.register = String ...
obj.regForceSet = Bool ...
obj.VLD3// Voltage level detect. These bits turn on the SVS and select
the nominal SVS threshold voltage level. See the device specific
data sheet for parameters.
0000 SVS is off
0001 1.9 V
0010 2.1 V
0011 2.2 V
0100 2.3 V
0101 2.4 V
0110 2.5 V
0111 2.65 V
1000 2.8 V
1001 2.9 V
1010 3.05
1011 3.2 V
1100 3.35 V
1101 3.5 V
1110 3.7 V
1111 Compares external input voltage SVSIN to 1.25 V = SVS.VLD3_t ...
obj.VLD2// Voltage level detect. These bits turn on the SVS and select
the nominal SVS threshold voltage level. See the device specific
data sheet for parameters.
0000 SVS is off
0001 1.9 V
0010 2.1 V
0011 2.2 V
0100 2.3 V
0101 2.4 V
0110 2.5 V
0111 2.65 V
1000 2.8 V
1001 2.9 V
1010 3.05
1011 3.2 V
1100 3.35 V
1101 3.5 V
1110 3.7 V
1111 Compares external input voltage SVSIN to 1.25 V = SVS.VLD2_t ...
obj.VLD1// Voltage level detect. These bits turn on the SVS and select
the nominal SVS threshold voltage level. See the device specific
data sheet for parameters.
0000 SVS is off
0001 1.9 V
0010 2.1 V
0011 2.2 V
0100 2.3 V
0101 2.4 V
0110 2.5 V
0111 2.65 V
1000 2.8 V
1001 2.9 V
1010 3.05
1011 3.2 V
1100 3.35 V
1101 3.5 V
1110 3.7 V
1111 Compares external input voltage SVSIN to 1.25 V = SVS.VLD1_t ...
obj.VLD0// Voltage level detect. These bits turn on the SVS and select
the nominal SVS threshold voltage level. See the device specific
data sheet for parameters.
0000 SVS is off
0001 1.9 V
0010 2.1 V
0011 2.2 V
0100 2.3 V
0101 2.4 V
0110 2.5 V
0111 2.65 V
1000 2.8 V
1001 2.9 V
1010 3.05
1011 3.2 V
1100 3.35 V
1101 3.5 V
1110 3.7 V
1111 Compares external input voltage SVSIN to 1.25 V = SVS.VLD0_t ...
obj.PORON// POR on. This bit enables the SVSFG flag to
cause a POR device reset.
0 SVSFG does not cause a POR
1 SVSFG causes a POR = SVS.PORON_t ...
obj.SVSON// SVS on. This bit reflects the status of SVS operation. This bit DOES NOT turn
on the SVS. The SVS is turned on by setting VLDx > 0.
0 SVS is Off
1 SVS is On = SVS.SVSON_t ...
obj.SVSOP// SVS output. This bit reflects the output value of the SVS comparator.
0 SVS comparator output is low
1 SVS comparator output is high = SVS.SVSOP_t ...
obj.SVSFG// SVS flag. This bit indicates a low voltage condition. SVSFG remains set after
a low voltage condition until reset by software.
0 No low voltage condition occurred
1 A low condition is present or has occurred = SVS.SVSFG_t ...
module-wide functions
SVS.getRegisters// Find all registers defined by the peripheral() returns String[]
per-instance config parameters
params.SVSCTL// SVSCTL Register = SVS.SVSCTL_t {
VLD3: ISVS.VLD3_OFF,
VLD2: ISVS.VLD2_OFF,
VLD1: ISVS.VLD1_OFF,
VLD0: ISVS.VLD0_OFF,
PORON: ISVS.PORON_OFF,
SVSON: ISVS.SVSON_OFF,
SVSOP: ISVS.SVSOP_OFF,
SVSFG: ISVS.SVSFG_OFF
};
params.forceSetDefaultRegister// Determine if each Register needs to be forced set or not = SVS.ForceSetDefaultRegister_t[] [
{
register: "SVSCTL",
regForceSet: false
}
];
per-instance creation
var inst = SVS.create// Create an instance-object(params);
| enum SVS.PORON_t |
|
PORON Bit
| usage | meta-domain |
values of type SVS.PORON_t
const SVS.PORON_OFF;
// SVSFG does not cause a POR
const SVS.PORON;
// SVSFG causes a POR
| enum SVS.SVSFG_t |
|
SVSFG Bit
| usage | meta-domain |
values of type SVS.SVSFG_t
const SVS.SVSFG_OFF;
const SVS.SVSFG;
| enum SVS.SVSON_t |
|
SVSON Bit
| usage | meta-domain |
values of type SVS.SVSON_t
const SVS.SVSON_OFF;
const SVS.SVSON;
| enum SVS.SVSOP_t |
|
SVSOP Bit
| usage | meta-domain |
values of type SVS.SVSOP_t
const SVS.SVSOP_OFF;
const SVS.SVSOP;
| enum SVS.VLD0_t |
|
VLD0 Bit
| usage | meta-domain |
values of type SVS.VLD0_t
const SVS.VLD0_OFF;
const SVS.VLD0;
| enum SVS.VLD1_t |
|
VLD1 Bit
| usage | meta-domain |
values of type SVS.VLD1_t
const SVS.VLD1_OFF;
const SVS.VLD1;
| enum SVS.VLD2_t |
|
VLD2 Bit
| usage | meta-domain |
values of type SVS.VLD2_t
const SVS.VLD2_OFF;
const SVS.VLD2;
| enum SVS.VLD3_t |
|
VLD3 Bit
| usage | meta-domain |
values of type SVS.VLD3_t
const SVS.VLD3_OFF;
const SVS.VLD3;
| struct SVS.ForceSetDefaultRegister_t |
|
Force Set Default Register
| usage | meta-domain |
var obj = new SVS.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 SVS.SVSCTL_t |
|
SVSCTL Register
| usage | meta-domain |
var obj = new SVS.SVSCTL_t;
obj.VLD3 = SVS.VLD3_t ...
// Voltage level detect. These bits turn on the SVS and select
the nominal SVS threshold voltage level. See the device specific
data sheet for parameters.
0000 SVS is off
0001 1.9 V
0010 2.1 V
0011 2.2 V
0100 2.3 V
0101 2.4 V
0110 2.5 V
0111 2.65 V
1000 2.8 V
1001 2.9 V
1010 3.05
1011 3.2 V
1100 3.35 V
1101 3.5 V
1110 3.7 V
1111 Compares external input voltage SVSIN to 1.25 V
obj.VLD2 = SVS.VLD2_t ...
// Voltage level detect. These bits turn on the SVS and select
the nominal SVS threshold voltage level. See the device specific
data sheet for parameters.
0000 SVS is off
0001 1.9 V
0010 2.1 V
0011 2.2 V
0100 2.3 V
0101 2.4 V
0110 2.5 V
0111 2.65 V
1000 2.8 V
1001 2.9 V
1010 3.05
1011 3.2 V
1100 3.35 V
1101 3.5 V
1110 3.7 V
1111 Compares external input voltage SVSIN to 1.25 V
obj.VLD1 = SVS.VLD1_t ...
// Voltage level detect. These bits turn on the SVS and select
the nominal SVS threshold voltage level. See the device specific
data sheet for parameters.
0000 SVS is off
0001 1.9 V
0010 2.1 V
0011 2.2 V
0100 2.3 V
0101 2.4 V
0110 2.5 V
0111 2.65 V
1000 2.8 V
1001 2.9 V
1010 3.05
1011 3.2 V
1100 3.35 V
1101 3.5 V
1110 3.7 V
1111 Compares external input voltage SVSIN to 1.25 V
obj.VLD0 = SVS.VLD0_t ...
// Voltage level detect. These bits turn on the SVS and select
the nominal SVS threshold voltage level. See the device specific
data sheet for parameters.
0000 SVS is off
0001 1.9 V
0010 2.1 V
0011 2.2 V
0100 2.3 V
0101 2.4 V
0110 2.5 V
0111 2.65 V
1000 2.8 V
1001 2.9 V
1010 3.05
1011 3.2 V
1100 3.35 V
1101 3.5 V
1110 3.7 V
1111 Compares external input voltage SVSIN to 1.25 V
obj.PORON = SVS.PORON_t ...
// POR on. This bit enables the SVSFG flag to
cause a POR device reset.
0 SVSFG does not cause a POR
1 SVSFG causes a POR
obj.SVSON = SVS.SVSON_t ...
// SVS on. This bit reflects the status of SVS operation. This bit DOES NOT turn
on the SVS. The SVS is turned on by setting VLDx > 0.
0 SVS is Off
1 SVS is On
obj.SVSOP = SVS.SVSOP_t ...
// SVS output. This bit reflects the output value of the SVS comparator.
0 SVS comparator output is low
1 SVS comparator output is high
obj.SVSFG = SVS.SVSFG_t ...
// SVS flag. This bit indicates a low voltage condition. SVSFG remains set after
a low voltage condition until reset by software.
0 No low voltage condition occurred
1 A low condition is present or has occurred
| SVS.getAll() // module-wide |
|
Find all peripherals of a certain type
| usage | meta-domain |
SVS.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
| SVS.getRegisters() // module-wide |
|
Find all registers defined by the peripheral
| usage | meta-domain |
SVS.getRegisters() returns String[]
RETURNS
Returns an array of register names
| Instance Config Parameters |
|
| usage | meta-domain |
var params = new SVS.Params;
// Instance config-params object
params.SVSCTL = SVS.SVSCTL_t {
// SVSCTL Register
VLD3: ISVS.VLD3_OFF,
VLD2: ISVS.VLD2_OFF,
VLD1: ISVS.VLD1_OFF,
VLD0: ISVS.VLD0_OFF,
PORON: ISVS.PORON_OFF,
SVSON: ISVS.SVSON_OFF,
SVSOP: ISVS.SVSOP_OFF,
SVSFG: ISVS.SVSFG_OFF
};
params.forceSetDefaultRegister = SVS.ForceSetDefaultRegister_t[] [
// Determine if each Register needs to be forced set or not
{
register: "SVSCTL",
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 SVS.SVSCTL // instance |
|
SVSCTL Register
| usage | meta-domain |
var params = new SVS.Params;
...
params.SVSCTL = SVS.SVSCTL_t {
VLD3: ISVS.VLD3_OFF,
VLD2: ISVS.VLD2_OFF,
VLD1: ISVS.VLD1_OFF,
VLD0: ISVS.VLD0_OFF,
PORON: ISVS.PORON_OFF,
SVSON: ISVS.SVSON_OFF,
SVSOP: ISVS.SVSOP_OFF,
SVSFG: ISVS.SVSFG_OFF
};
| config SVS.forceSetDefaultRegister // instance |
|
Determine if each Register needs to be forced set or not
| usage | meta-domain |
var params = new SVS.Params;
...
{
register: "SVSCTL",
regForceSet: false
}
];
| config SVS.name // instance |
|
Specific peripheral name given by the device
| usage | meta-domain |
var params = new SVS.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 SVS.owner // instance |
|
String specifying the entity that manages the peripheral
| usage | meta-domain |
var params = new SVS.Params;
...
params.owner = String undefined;
| Instance Creation |
|
| usage | meta-domain |
// Allocate instance config-params
params.config = ...
// Assign individual configs
var inst = SVS.create(params);
// Create an instance-object
generated on Thu, 17 Nov 2011 02:05:45 GMT