metaonly interface ti.catalog.c6000.IAntara
index URL

The Antara device data sheet module

This module implements the xdc.platform.ICpuDataSheet interface and is used by platforms to obtain "data sheet" information about this device.
XDCspec summary sourced in ti/catalog/c6000/IAntara.xdc
metaonly interface IAntara {  ...
// inherits ti.catalog.ICpuDataSheet
    // inherits xdc.platform.ICpuDataSheet
instance:  ...
XDCspec declarations sourced in ti/catalog/c6000/IAntara.xdc
package ti.catalog.c6000;
 
metaonly interface IAntara inherits ICpuDataSheet {
 
 
instance:
per-instance config parameters
    override config String cpuCore// A string identifying the CPU Core = "67x+";
    override config String cpuCoreRevision// A string that uniquely identifies a revision of the core = "1.0";
    override config Int dataWordSize// The size of an int on the target in 8-bit bytes = 4;
    config String deviceHeader// The optional header file that define device specific constants and structures;
    config IPlatform.Memory memMap// [string] = [
        [
            "IRAM",
            {
                name: "IRAM",
                comment: "Internal memory",
                base: 0x10000000,
                len: 0x00040000,
                space: "code/data",
                access: "RWX"
            }
        ]
    ];
    override config Int minDataUnitSize// The minimum addressable data unit size in 8-bit bytes = 1;
    override config Int minProgUnitSize// The minimum addressable program unit size in 8-bit bytes = 1;
    config IPeripheral.Instance peripherals// A map of peripherals available on the device[string];
per-instance creation
    create// Create an instance-object(String revision);
per-instance functions
    function getMemoryMap// Get the memory map that corresponds to the values of the specified registers(registers);
    function getRegisterSet// The set of valid register names for this CPU();
}
 
config IAntara.Params.cpuCore  // instance
index URL

A string identifying the CPU Core

XDCspec declarations sourced in ti/catalog/c6000/IAntara.xdc
override config String cpuCore = "67x+";
 
DETAILS
This uniquely identifies the instruction set that the CPU can decode and execute.
 
config IAntara.Params.cpuCoreRevision  // instance
index URL

A string that uniquely identifies a revision of the core

XDCspec declarations sourced in ti/catalog/c6000/IAntara.xdc
override config String cpuCoreRevision = "1.0";
 
 
config IAntara.Params.dataWordSize  // instance
index URL

The size of an int on the target in 8-bit bytes

XDCspec declarations sourced in ti/catalog/c6000/IAntara.xdc
override config Int dataWordSize = 4;
 
 
config IAntara.Params.deviceHeader  // instance
index URL

The optional header file that define device specific constants and structures

XDCspec declarations sourced in ti/catalog/c6000/IAntara.xdc
config String deviceHeader;
 
 
config IAntara.Params.memMap  // instance
index URL
XDCspec declarations sourced in ti/catalog/c6000/IAntara.xdc
config IPlatform.Memory memMap[string] = [
    [
        "IRAM",
        {
            name: "IRAM",
            comment: "Internal memory",
            base: 0x10000000,
            len: 0x00040000,
            space: "code/data",
            access: "RWX"
        }
    ]
];
 
 
config IAntara.Params.minDataUnitSize  // instance
index URL

The minimum addressable data unit size in 8-bit bytes

XDCspec declarations sourced in ti/catalog/c6000/IAntara.xdc
override config Int minDataUnitSize = 1;
 
 
config IAntara.Params.minProgUnitSize  // instance
index URL

The minimum addressable program unit size in 8-bit bytes

XDCspec declarations sourced in ti/catalog/c6000/IAntara.xdc
override config Int minProgUnitSize = 1;
 
 
config IAntara.Params.peripherals  // instance
index URL

A map of peripherals available on the device

XDCspec declarations sourced in ti/catalog/c6000/IAntara.xdc
config IPeripheral.Instance peripherals[string];
 
Static Instance Creation
index URL

XDCspec declarations sourced in ti/catalog/c6000/IAntara.xdc
create(String revision);
// Create an instance-object
ARGUMENTS
revision — a string that identifies revision of the CPU to be created.
DETAILS
A "data sheet" for a CPU allows one to get specific attributes for a CPU programatically; e.g., the memory map of the CPU.
Notice that we don't specify CPU registers when we create a a data-sheet; registers are provided as necessary to the other functions defined in this interface. This allows one to more easily get memory maps for several different setting of the registers, for example.
 
IAntara.getMemoryMap()  // instance
index URL

Get the memory map that corresponds to the values of the specified registers

XDCspec declarations sourced in ti/catalog/c6000/IAntara.xdc
function getMemoryMap(registers);
 
ARGUMENTS
registers — a hash of named registers to values at the time an executable is to be loaded (for example)
DETAILS
If a register is not specified and this register can affect the memory map, the register is assumed to be set to its reset value (the value of the register immediately after a CPU reset).
RETURNS
Returns an array of xdc.platform.IPlatform.Memory objects that represent the memory visible to an executable running on the CPU.
 
IAntara.getRegisterSet()  // instance
index URL

The set of valid register names for this CPU

XDCspec declarations sourced in ti/catalog/c6000/IAntara.xdc
function getRegisterSet();
 
DETAILS
This function returns the complete set of register names that may be passed to the getMemoryMap() function. This function is only used to enable one to write a "requires contract" for the getMemoryMap() function.
RETURNS
Returns an array of valid register names (strings) for this device; only names from this array are valid keys for the registers argument to getMemoryMap().
generated on Thu, 23 May 2019 00:23:45 GMT