metaonly interface ti.catalog.msp430.peripherals.adc.IADC
index URL

MSP430 Analog to Digital Converter Interface

XDCspec summary sourced in ti/catalog/msp430/peripherals/adc/IADC.xdc
metaonly interface IADC {  ...
// inherits xdc.platform.IPeripheral
instance:  ...
XDCspec declarations sourced in ti/catalog/msp430/peripherals/adc/IADC.xdc
package ti.catalog.msp430.peripherals.adc;
 
metaonly interface IADC 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;
    };
module-wide functions
    Void addPeripheralsMap// Create a map of all peripherals available on a device(ICpuDataSheet.Instance cds);
    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;
per-instance creation
    create// Create an instance-object(IClock.Instance clock, ITimer_A.Instance timerA);
}
typedef IADC.IPeripheralArray
index URL
XDCspec declarations sourced in ti/catalog/msp430/peripherals/adc/IADC.xdc
typedef IPeripheral.Instance IPeripheralArray[];
typedef IADC.StringArray
index URL
XDCspec declarations sourced in ti/catalog/msp430/peripherals/adc/IADC.xdc
typedef String StringArray[];
struct IADC.ForceSetDefaultRegister_t
index URL

Force Set Default Register

XDCspec declarations sourced in ti/catalog/msp430/peripherals/adc/IADC.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
IADC.addPeripheralsMap()  // module-wide
index URL

Create a map of all peripherals available on a device

XDCspec declarations sourced in ti/catalog/msp430/peripherals/adc/IADC.xdc
Void addPeripheralsMap(ICpuDataSheet.Instance cds);
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.
IADC.getAll()  // module-wide
index URL

Find all peripherals of a certain type

XDCspec declarations sourced in ti/catalog/msp430/peripherals/adc/IADC.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
IADC.getRegisters()  // module-wide
index URL

Find all registers defined by the peripheral

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

Specific peripheral name given by the device

XDCspec declarations sourced in ti/catalog/msp430/peripherals/adc/IADC.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 IADC.owner  // instance
index URL

String specifying the entity that manages the peripheral

XDCspec declarations sourced in ti/catalog/msp430/peripherals/adc/IADC.xdc
config String owner;
Instance Creation
index URL

XDCspec declarations sourced in ti/catalog/msp430/peripherals/adc/IADC.xdc
create(IClock.Instance clock, ITimer_A.Instance timerA);
// Create an instance-object
generated on Tue, 24 Aug 2010 15:40:40 GMT