metaonly interface xdc.platform.IPeripheral
index URL

Configuration-time representation of a peripheral

XDCspec summary sourced in xdc/platform/IPeripheral.xdc
metaonly interface IPeripheral {  ...
instance:  ...
XDCspec declarations sourced in xdc/platform/IPeripheral.xdc
package xdc.platform;
 
metaonly interface IPeripheral {
module-wide constants & types
    typedef IPeripheral.Instance IPeripheralArray// [];
    typedef String StringArray// [];
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 IPeripheral.IPeripheralArray
index URL
XDCspec declarations sourced in xdc/platform/IPeripheral.xdc
typedef IPeripheral.Instance IPeripheralArray[];
 
 
typedef IPeripheral.StringArray
index URL
XDCspec declarations sourced in xdc/platform/IPeripheral.xdc
typedef String StringArray[];
 
 
IPeripheral.getAll()  // module-wide
index URL

Find all peripherals of a certain type

XDCspec declarations sourced in xdc/platform/IPeripheral.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
 
IPeripheral.getRegisters()  // module-wide
index URL

Find all registers defined by the peripheral

XDCspec declarations sourced in xdc/platform/IPeripheral.xdc
IPeripheral.StringArray getRegisters();
 
RETURNS
Returns an array of register names
 
config IPeripheral.name  // instance
index URL

Specific peripheral name given by the device

XDCspec declarations sourced in xdc/platform/IPeripheral.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 IPeripheral.owner  // instance
index URL

String specifying the entity that manages the peripheral

XDCspec declarations sourced in xdc/platform/IPeripheral.xdc
config String owner;
 
generated on Thu, 27 Sep 2012 23:21:11 GMT