metaonly interface xdc.platform.IExeContext
index URL

Execution environment interface between a platform and an executable

This interface describes the execution environment provided by a platform as seen by an executable on a particular CPU at the time it is loaded. [ more ... ]
XDCspec summary sourced in xdc/platform/IExeContext.xdc
metaonly interface IExeContext {  ...
instance:  ...
XDCspec declarations sourced in xdc/platform/IExeContext.xdc
package xdc.platform;
 
metaonly interface IExeContext {
module-wide constants & types
    metaonly struct Cpu// CPU attributes necessary to create an execution context {
        String id// unique id within the platform;
        String catalogName// name of catalog package;
        String deviceName// module name within catalog package;
        String revision// revision of specified device;
        Float clockRate// clock rate in MHz of CPU on board;
    };
 
instance:
per-instance config parameters
    config ICpuDataSheet.Instance attrs// The CPU "data-sheet" attributes;
    readonly config IPlatform.Board board// The board-level attributes;
    config String catalogName// The name of the package containing the module named by deviceName;
    config Float clockRate// The clock rate in MHz of the CPU;
    config String deviceName// The name of a CPU device within the catalog package catalogName;
    config String id// The CPU's unique id within the platform;
    config IPlatform.Memory memoryMap// The memory map seen by executables at the time they are loaded[string];
    config String revision// The revision of the CPU = "";
}
DETAILS
This interface describes the execution environment provided by a platform as seen by an executable on a particular CPU at the time it is loaded.
Execution contexts are created by platforms via xdc.platform.IPlatform.getExeContext(). Execution contexts are created implicitly just prior to executing a program's configuration script. This execution context is made available to the configuration script as the global read-only Program.cpu configuration parameter; see xdc.cfg.Program.
struct IExeContext.Cpu
index URL

CPU attributes necessary to create an execution context

XDCspec declarations sourced in xdc/platform/IExeContext.xdc
metaonly struct Cpu {
    String id;
    // unique id within the platform
    String catalogName;
    // name of catalog package
    String deviceName;
    // module name within catalog package
    String revision;
    // revision of specified device
    Float clockRate;
    // clock rate in MHz of CPU on board
};
DETAILS
Attributes that uniquely identify the CPU responsible for executing an executable image.
config IExeContext.attrs  // instance
index URL

The CPU "data-sheet" attributes

XDCspec declarations sourced in xdc/platform/IExeContext.xdc
config ICpuDataSheet.Instance attrs;
DETAILS
This "data sheet" allows one to get information about the CPU that runs the run the executable associated with this execution context.
Multi-CPU platforms provide multiple execution contexts; each context is associated with a single CPU on the platform.
READONLY
This parameter is set by the platform and is readonly for configuration scripts.
config IExeContext.board  // instance
index URL

The board-level attributes

XDCspec declarations sourced in xdc/platform/IExeContext.xdc
readonly config IPlatform.Board board;
DETAILS
This parameter defines the static attributes of the board containing the CPU that runs the executable.
READONLY
This parameter is set by the platform and is readonly for configuration scripts.
config IExeContext.catalogName  // instance
index URL

The name of the package containing the module named by deviceName

XDCspec declarations sourced in xdc/platform/IExeContext.xdc
config String catalogName;
DETAILS
This string names a package containing one or more modules that implements the xdc.platform.ICpuDataSheet interface.
READONLY
This parameter is set by the platform and is readonly for configuration scripts.
config IExeContext.clockRate  // instance
index URL

The clock rate in MHz of the CPU

XDCspec declarations sourced in xdc/platform/IExeContext.xdc
config Float clockRate;
READONLY
This parameter is set by the platform and is readonly for configuration scripts.
config IExeContext.deviceName  // instance
index URL

The name of a CPU device within the catalog package catalogName

XDCspec declarations sourced in xdc/platform/IExeContext.xdc
config String deviceName;
DETAILS
This string names a module in the catalog package, specified by catalogName, that represents the CPU that runs the executable; i.e., it implements the xdc.platform.ICpuDataSheet interface.
config IExeContext.id  // instance
index URL

The CPU's unique id within the platform

XDCspec declarations sourced in xdc/platform/IExeContext.xdc
config String id;
DETAILS
This id is the string used to identify a specific CPU within the platform that provides this execution context.
READONLY
This parameter is set by the platform and is readonly for configuration scripts.
config IExeContext.memoryMap  // instance
index URL

The memory map seen by executables at the time they are loaded

XDCspec declarations sourced in xdc/platform/IExeContext.xdc
config IPlatform.Memory memoryMap[string];
READONLY
This parameter is set by the platform and is readonly for configuration scripts.
config IExeContext.revision  // instance
index URL

The revision of the CPU

XDCspec declarations sourced in xdc/platform/IExeContext.xdc
config String revision = "";
READONLY
This parameter is set by the platform and is readonly for configuration scripts.
generated on Tue, 24 Aug 2010 15:39:19 GMT