metaonly module ti.catalog.peripherals.hdvicp2.HDVICP2
index URL
XDCscript usage meta-domain sourced in ti/catalog/peripherals/hdvicp2/HDVICP2.xdc
var HDVICP2 = xdc.useModule('ti.catalog.peripherals.hdvicp2.HDVICP2');
module-wide functions
    HDVICP2.addPeripheralsMap// Create a map of all peripherals available on a device(ICpuDataSheet.Instance cds) returns Void
    HDVICP2.getAll// Find all peripherals of a certain type() returns IPeripheral.Instance[]
    HDVICP2.getRegisters// Find all registers defined by the peripheral() returns String[]
per-instance config parameters
    var params = new HDVICP2.Params// Instance config-params object;
        params.baseAddr// Address of the peripheral's control register = UInt undefined;
        params.intNum// Transfer completion Interrupt source number = UInt undefined;
        params.name// Specific peripheral name given by the device = String undefined;
        params.owner// String specifying the entity that manages the peripheral = String undefined;
 
HDVICP2.addPeripheralsMap()  // module-wide
index URL

Create a map of all peripherals available on a device

XDCscript usage meta-domain
HDVICP2.addPeripheralsMap(ICpuDataSheet.Instance cds) returns Void
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.
HDVICP2.getAll()  // module-wide
index URL

Find all peripherals of a certain type

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

Find all registers defined by the peripheral

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

XDCscript usage meta-domain
var params = new HDVICP2.Params;
// Instance config-params object
    params.baseAddr = UInt undefined;
    // Address of the peripheral's control register
    params.intNum = UInt undefined;
    // Transfer completion Interrupt source number
    params.name = String undefined;
    // Specific peripheral name given by the device
    params.owner = String undefined;
    // String specifying the entity that manages the peripheral
config HDVICP2.baseAddr  // instance
index URL

Address of the peripheral's control register

XDCscript usage meta-domain
var params = new HDVICP2.Params;
  ...
params.baseAddr = UInt undefined;
DETAILS
A peripheral's registers are commonly accessed through a structure that defines the offsets of a particular register from the lowest address mapped to a peripheral. That lowest address is specified by this parameter.
config HDVICP2.intNum  // instance
index URL

Transfer completion Interrupt source number

XDCscript usage meta-domain
var params = new HDVICP2.Params;
  ...
params.intNum = UInt undefined;
config HDVICP2.name  // instance
index URL

Specific peripheral name given by the device

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

String specifying the entity that manages the peripheral

XDCscript usage meta-domain
var params = new HDVICP2.Params;
  ...
params.owner = String undefined;
generated on Tue, 24 Aug 2010 15:40:01 GMT