metaonly interface ti.catalog.msp430.peripherals.rtc.IRTC
index URL

MSP430 Real-Time Clock interface

XDCspec summary sourced in ti/catalog/msp430/peripherals/rtc/IRTC.xdc
metaonly interface IRTC {  ...
// inherits xdc.platform.IPeripheral
instance:  ...
XDCspec declarations sourced in ti/catalog/msp430/peripherals/rtc/IRTC.xdc
package ti.catalog.msp430.peripherals.rtc;
 
metaonly interface IRTC inherits IPeripheral {
module-wide constants & types
    typedef IPeripheral.Instance IPeripheralArray// [];
    typedef String StringArray// [];
 
    metaonly struct ForceSetDefaultRegister_t// Force Set Default Register {
        String register;
        Bool regForceSet;
    };
 
    metaonly struct regIntVect_t// Interrupt vector description {
        String registerName;
        String registerDescription;
        String isrToggleString;
        String priorityName;
        Bool interruptEnable;
        Bool interruptHandler;
        Int priority;
    };
module-wide functions
    IPeripheral.IPeripheralArray getAll// Find all peripherals of a certain type();
    IPeripheral.StringArray getRegisters// Find all registers defined by the peripheral();
 
 
instance:
per-instance config parameters
    config String name// Specific peripheral name given by the device;
    config String owner// String specifying the entity that manages the peripheral;
}
 
typedef IRTC.IPeripheralArray
index URL
XDCspec declarations sourced in ti/catalog/msp430/peripherals/rtc/IRTC.xdc
typedef IPeripheral.Instance IPeripheralArray[];
 
 
typedef IRTC.StringArray
index URL
XDCspec declarations sourced in ti/catalog/msp430/peripherals/rtc/IRTC.xdc
typedef String StringArray[];
 
 
struct IRTC.ForceSetDefaultRegister_t
index URL

Force Set Default Register

XDCspec declarations sourced in ti/catalog/msp430/peripherals/rtc/IRTC.xdc
metaonly struct ForceSetDefaultRegister_t {
    String register;
    Bool regForceSet;
};
 
DETAILS
Type to store if each register needs to be forced initialized even if the register is in default state.
SEE
ForceSetDefaultRegister_t
 
struct IRTC.regIntVect_t
index URL

Interrupt vector description

XDCspec declarations sourced in ti/catalog/msp430/peripherals/rtc/IRTC.xdc
metaonly struct regIntVect_t {
    String registerName;
    String registerDescription;
    String isrToggleString;
    String priorityName;
    Bool interruptEnable;
    Bool interruptHandler;
    Int priority;
};
 
DETAILS
Type to describe a single interrupt vector pin and all its possible configurations.
SEE
regIntVect_t
 
IRTC.getAll()  // module-wide
index URL

Find all peripherals of a certain type

XDCspec declarations sourced in ti/catalog/msp430/peripherals/rtc/IRTC.xdc
IPeripheral.IPeripheralArray getAll();
 
DETAILS
The type of the peripherals returned is defined by the type of the caller.
RETURNS
Returns an array of IPeripheral instances
 
IRTC.getRegisters()  // module-wide
index URL

Find all registers defined by the peripheral

XDCspec declarations sourced in ti/catalog/msp430/peripherals/rtc/IRTC.xdc
IPeripheral.StringArray getRegisters();
 
RETURNS
Returns an array of register names
 
config IRTC.name  // instance
index URL

Specific peripheral name given by the device

XDCspec declarations sourced in ti/catalog/msp430/peripherals/rtc/IRTC.xdc
config String name;
 
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 IRTC.owner  // instance
index URL

String specifying the entity that manages the peripheral

XDCspec declarations sourced in ti/catalog/msp430/peripherals/rtc/IRTC.xdc
config String owner;
 
generated on Tue, 16 Oct 2012 23:18:53 GMT