metaonly module ti.catalog.arm.LM3S9B95
index URL
XDCspec summary sourced in ti/catalog/arm/LM3S9B95.xdc
metaonly module LM3S9B95 {  ...
// inherits ti.catalog.arm.ILM3SxBxx
    // inherits ti.catalog.ICpuDataSheet
        // inherits xdc.platform.ICpuDataSheet
instance:  ...
XDCscript usage meta-domain
var LM3S9B95 = xdc.useModule('ti.catalog.arm.LM3S9B95');
module-wide constants & types
    var obj = new LM3S9B95.Timer// ;
        obj.name = String  ...
        obj.baseAddr = UInt  ...
        obj.intNum = UInt  ...
per-instance config parameters
    var params = new LM3S9B95.Params// Instance config-params object;
        params.cpuCore// A string identifying the CPU Core = String "CM3";
        params.cpuCoreRevision// A string that uniquely identifies a revision of the core = String "1.0";
        params.dataWordSize// The size of an int on the target in 8-bit bytes = Int 4;
        params.isa//  = String "v7M";
        params.memMap// The memory map returned by getMemoryMap() = IPlatform.Memory[string] [
        [
            "FRAM",
            {
                comment: "256KB FRAM",
                name: "FRAM",
                base: 0x00000000,
                len: 0x00040000
            }
        ],
        [
            "IRAM",
            {
                comment: "96KB IRAM",
                name: "IRAM",
                base: 0x20000000,
                len: 0x00018000
            }
        ]
    ];
        params.minDataUnitSize// The minimum addressable data unit size in 8-bit bytes = Int 1;
        params.minProgUnitSize// The minimum addressable program unit size in 8-bit bytes = Int 1;
        params.timers//  = ILM3SxBxx.Timer[4] [
        {
            name: "Timer 0",
            baseAddr: 0x40030000,
            intNum: 35
        },
        {
            name: "Timer 1",
            baseAddr: 0x40031000,
            intNum: 37
        },
        {
            name: "Timer 2",
            baseAddr: 0x40032000,
            intNum: 39
        },
        {
            name: "Timer 3",
            baseAddr: 0x40033000,
            intNum: 51
        }
    ];
per-instance creation
    var inst = LM3S9B95.create// Create an instance-object( String revision, params );
per-instance functions
    inst.getMemoryMap// Get the memory map that corresponds to the values of the specified registers( Any registers ) returns Any
    inst.getRegisterSet// The set of valid register names for this CPU( ) returns Any
 
XDCspec declarations sourced in ti/catalog/arm/LM3S9B95.xdc
package ti.catalog.arm;
 
metaonly module LM3S9B95 inherits ILM3SxBxx {
module-wide constants & types
    metaonly struct Timer//  {
        String name;
        UInt baseAddr;
        UInt intNum;
    };
 
 
instance:
per-instance config parameters
    override config String cpuCore// A string identifying the CPU Core = "CM3";
    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 IPlatform.Memory memMap// The memory map returned by getMemoryMap()[string] = [
        [
            "FRAM",
            {
                comment: "256KB FRAM",
                name: "FRAM",
                base: 0x00000000,
                len: 0x00040000
            }
        ],
        [
            "IRAM",
            {
                comment: "96KB IRAM",
                name: "IRAM",
                base: 0x20000000,
                len: 0x00018000
            }
        ]
    ];
    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 ILM3SxBxx.Timer timers// [4] = [
        {
            name: "Timer 0",
            baseAddr: 0x40030000,
            intNum: 35
        },
        {
            name: "Timer 1",
            baseAddr: 0x40031000,
            intNum: 37
        },
        {
            name: "Timer 2",
            baseAddr: 0x40032000,
            intNum: 39
        },
        {
            name: "Timer 3",
            baseAddr: 0x40033000,
            intNum: 51
        }
    ];
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( );
}
 
struct LM3S9B95.Timer
index URL
XDCscript usage meta-domain
var obj = new LM3S9B95.Timer;
 
    obj.name = String  ...
    obj.baseAddr = UInt  ...
    obj.intNum = UInt  ...
 
 
per-instance config parameters
index URL

XDCscript usage meta-domain
var params = new LM3S9B95.Params;
// Instance config-params object
    params.cpuCore = String "CM3";
    // A string identifying the CPU Core
    params.cpuCoreRevision = String "1.0";
    // A string that uniquely identifies a revision of the core
    params.dataWordSize = Int 4;
    // The size of an int on the target in 8-bit bytes
    params.isa = String "v7M";
    // 
    params.memMap = IPlatform.Memory[string] [
    // The memory map returned by getMemoryMap()
    [
        "FRAM",
        {
            comment: "256KB FRAM",
            name: "FRAM",
            base: 0x00000000,
            len: 0x00040000
        }
    ],
    [
        "IRAM",
        {
            comment: "96KB IRAM",
            name: "IRAM",
            base: 0x20000000,
            len: 0x00018000
        }
    ]
];
    params.minDataUnitSize = Int 1;
    // The minimum addressable data unit size in 8-bit bytes
    params.minProgUnitSize = Int 1;
    // The minimum addressable program unit size in 8-bit bytes
    params.timers = ILM3SxBxx.Timer[4] [
    // 
    {
        name: "Timer 0",
        baseAddr: 0x40030000,
        intNum: 35
    },
    {
        name: "Timer 1",
        baseAddr: 0x40031000,
        intNum: 37
    },
    {
        name: "Timer 2",
        baseAddr: 0x40032000,
        intNum: 39
    },
    {
        name: "Timer 3",
        baseAddr: 0x40033000,
        intNum: 51
    }
];
 
config LM3S9B95.cpuCore  // per-instance
index URL

A string identifying the CPU Core

XDCscript usage meta-domain
var params = new LM3S9B95.Params;
  ...
params.cpuCore = String "CM3";
 
DETAILS
This uniquely identifies the instruction set that the CPU can decode and execute.
 
config LM3S9B95.cpuCoreRevision  // per-instance
index URL

A string that uniquely identifies a revision of the core

XDCscript usage meta-domain
var params = new LM3S9B95.Params;
  ...
params.cpuCoreRevision = String "1.0";
 
 
config LM3S9B95.dataWordSize  // per-instance
index URL

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

XDCscript usage meta-domain
var params = new LM3S9B95.Params;
  ...
params.dataWordSize = Int 4;
 
 
config LM3S9B95.memMap  // per-instance
index URL

The memory map returned by getMemoryMap()

XDCscript usage meta-domain
var params = new LM3S9B95.Params;
  ...
params.memMap = IPlatform.Memory[string] [
    [
        "FRAM",
        {
            comment: "256KB FRAM",
            name: "FRAM",
            base: 0x00000000,
            len: 0x00040000
        }
    ],
    [
        "IRAM",
        {
            comment: "96KB IRAM",
            name: "IRAM",
            base: 0x20000000,
            len: 0x00018000
        }
    ]
];
 
 
config LM3S9B95.minDataUnitSize  // per-instance
index URL

The minimum addressable data unit size in 8-bit bytes

XDCscript usage meta-domain
var params = new LM3S9B95.Params;
  ...
params.minDataUnitSize = Int 1;
 
 
config LM3S9B95.minProgUnitSize  // per-instance
index URL

The minimum addressable program unit size in 8-bit bytes

XDCscript usage meta-domain
var params = new LM3S9B95.Params;
  ...
params.minProgUnitSize = Int 1;
 
 
config LM3S9B95.timers  // per-instance
index URL
XDCscript usage meta-domain
var params = new LM3S9B95.Params;
  ...
params.timers = ILM3SxBxx.Timer[4] [
    {
        name: "Timer 0",
        baseAddr: 0x40030000,
        intNum: 35
    },
    {
        name: "Timer 1",
        baseAddr: 0x40031000,
        intNum: 37
    },
    {
        name: "Timer 2",
        baseAddr: 0x40032000,
        intNum: 39
    },
    {
        name: "Timer 3",
        baseAddr: 0x40033000,
        intNum: 51
    }
];
 
 
per-instance creation
index URL

XDCscript usage meta-domain
var params = new LM3S9B95.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = LM3S9B95.create( String revision, params );
// 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.
 
LM3S9B95.getMemoryMap( )  // per-instance
index URL

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

XDCscript usage meta-domain
inst.getMemoryMap( Any registers ) returns Any
 
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.
 
LM3S9B95.getRegisterSet( )  // per-instance
index URL

The set of valid register names for this CPU

XDCscript usage meta-domain
inst.getRegisterSet( ) returns Any
 
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 Wed, 02 Dec 2009 21:34:19 GMT