metaonly module ti.catalog.arm.cortexm3.F28M35x
index URL

The F28M35x 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.
XDCscript usage meta-domain sourced in ti/catalog/arm/cortexm3/F28M35x.xdc
var F28M35x = xdc.useModule('ti.catalog.arm.cortexm3.F28M35x');
per-instance config parameters
    var params = new F28M35x.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.deviceHeader// The optional header file that define device specific constants and structures = String undefined;
        params.memMap// The memory map returned by getMemoryMap() = IPlatform.Memory[string] [
            [
                "BOOTROM",
                {
                    comment: "On-Chip Boot ROM",
                    name: "BOOTROM",
                    base: 0x0,
                    len: 0x10000,
                    space: "code",
                    access: "RX"
                }
            ],
            [
                "FLASH_BOOT",
                {
                    comment: "Branch for boot from Flash",
                    name: "FLASH_BOOT",
                    base: 0x200030,
                    len: 0x4,
                    space: "code/data",
                    access: "RWX"
                }
            ],
            [
                "FLASH",
                {
                    comment: "512KB Flash memory",
                    name: "FLASH",
                    base: 0x200034,
                    len: 0x7FFC8,
                    space: "code/data",
                    access: "RWX"
                }
            ],
            [
                "OTP",
                {
                    comment: "4KB OTP memory",
                    name: "OTP",
                    base: 0x680000,
                    len: 0x1000,
                    space: "code",
                    access: "RWX"
                }
            ],
            [
                "C03SRAM",
                {
                    comment: "32KB On-Chip RAM Memory",
                    name: "C03SRAM",
                    base: 0x20000000,
                    len: 0x8000,
                    space: "code/data",
                    access: "RWX"
                }
            ],
            [
                "S07SHRAM",
                {
                    comment: "64KB On-Chip Shared RAM Memory",
                    name: "S07SHRAM",
                    base: 0x20008000,
                    len: 0x10000,
                    space: "code/data",
                    access: "RWX"
                }
            ],
            [
                "CTOMMSGRAM",
                {
                    comment: "C28 to M3 MSG RAM Memory",
                    name: "CTOMMSGRAM",
                    base: 0x2007F000,
                    len: 0x800,
                    space: "data",
                    access: "R"
                }
            ],
            [
                "MTOCMSGRAM",
                {
                    comment: "M3 to C28 MSG RAM Memory",
                    name: "MTOCMSGRAM",
                    base: 0x2007F800,
                    len: 0x800,
                    space: "data",
                    access: "RW"
                }
            ]
        ];
        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.peripherals// A map of peripherals available on the device = IPeripheral.Instance[string] undefined;
        params.timer0//  = Timer.Instance undefined;
        params.timer1//  = Timer.Instance undefined;
        params.timer2//  = Timer.Instance undefined;
        params.timer3//  = Timer.Instance undefined;
per-instance creation
    var inst = F28M35x.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
 
Instance Config Parameters
index URL

XDCscript usage meta-domain
var params = new F28M35x.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.deviceHeader = String undefined;
    // The optional header file that define device specific constants and structures
    params.memMap = IPlatform.Memory[string] [
    // The memory map returned by getMemoryMap()
        [
            "BOOTROM",
            {
                comment: "On-Chip Boot ROM",
                name: "BOOTROM",
                base: 0x0,
                len: 0x10000,
                space: "code",
                access: "RX"
            }
        ],
        [
            "FLASH_BOOT",
            {
                comment: "Branch for boot from Flash",
                name: "FLASH_BOOT",
                base: 0x200030,
                len: 0x4,
                space: "code/data",
                access: "RWX"
            }
        ],
        [
            "FLASH",
            {
                comment: "512KB Flash memory",
                name: "FLASH",
                base: 0x200034,
                len: 0x7FFC8,
                space: "code/data",
                access: "RWX"
            }
        ],
        [
            "OTP",
            {
                comment: "4KB OTP memory",
                name: "OTP",
                base: 0x680000,
                len: 0x1000,
                space: "code",
                access: "RWX"
            }
        ],
        [
            "C03SRAM",
            {
                comment: "32KB On-Chip RAM Memory",
                name: "C03SRAM",
                base: 0x20000000,
                len: 0x8000,
                space: "code/data",
                access: "RWX"
            }
        ],
        [
            "S07SHRAM",
            {
                comment: "64KB On-Chip Shared RAM Memory",
                name: "S07SHRAM",
                base: 0x20008000,
                len: 0x10000,
                space: "code/data",
                access: "RWX"
            }
        ],
        [
            "CTOMMSGRAM",
            {
                comment: "C28 to M3 MSG RAM Memory",
                name: "CTOMMSGRAM",
                base: 0x2007F000,
                len: 0x800,
                space: "data",
                access: "R"
            }
        ],
        [
            "MTOCMSGRAM",
            {
                comment: "M3 to C28 MSG RAM Memory",
                name: "MTOCMSGRAM",
                base: 0x2007F800,
                len: 0x800,
                space: "data",
                access: "RW"
            }
        ]
    ];
    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.peripherals = IPeripheral.Instance[string] undefined;
    // A map of peripherals available on the device
    params.timer0 = Timer.Instance undefined;
    // 
    params.timer1 = Timer.Instance undefined;
    // 
    params.timer2 = Timer.Instance undefined;
    // 
    params.timer3 = Timer.Instance undefined;
    // 
 
config F28M35x.cpuCore  // instance
index URL

A string identifying the CPU Core

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

A string that uniquely identifies a revision of the core

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

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

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

The optional header file that define device specific constants and structures

XDCscript usage meta-domain
var params = new F28M35x.Params;
  ...
params.deviceHeader = String undefined;
 
 
config F28M35x.memMap  // instance
index URL

The memory map returned by getMemoryMap()

XDCscript usage meta-domain
var params = new F28M35x.Params;
  ...
params.memMap = IPlatform.Memory[string] [
    [
        "BOOTROM",
        {
            comment: "On-Chip Boot ROM",
            name: "BOOTROM",
            base: 0x0,
            len: 0x10000,
            space: "code",
            access: "RX"
        }
    ],
    [
        "FLASH_BOOT",
        {
            comment: "Branch for boot from Flash",
            name: "FLASH_BOOT",
            base: 0x200030,
            len: 0x4,
            space: "code/data",
            access: "RWX"
        }
    ],
    [
        "FLASH",
        {
            comment: "512KB Flash memory",
            name: "FLASH",
            base: 0x200034,
            len: 0x7FFC8,
            space: "code/data",
            access: "RWX"
        }
    ],
    [
        "OTP",
        {
            comment: "4KB OTP memory",
            name: "OTP",
            base: 0x680000,
            len: 0x1000,
            space: "code",
            access: "RWX"
        }
    ],
    [
        "C03SRAM",
        {
            comment: "32KB On-Chip RAM Memory",
            name: "C03SRAM",
            base: 0x20000000,
            len: 0x8000,
            space: "code/data",
            access: "RWX"
        }
    ],
    [
        "S07SHRAM",
        {
            comment: "64KB On-Chip Shared RAM Memory",
            name: "S07SHRAM",
            base: 0x20008000,
            len: 0x10000,
            space: "code/data",
            access: "RWX"
        }
    ],
    [
        "CTOMMSGRAM",
        {
            comment: "C28 to M3 MSG RAM Memory",
            name: "CTOMMSGRAM",
            base: 0x2007F000,
            len: 0x800,
            space: "data",
            access: "R"
        }
    ],
    [
        "MTOCMSGRAM",
        {
            comment: "M3 to C28 MSG RAM Memory",
            name: "MTOCMSGRAM",
            base: 0x2007F800,
            len: 0x800,
            space: "data",
            access: "RW"
        }
    ]
];
 
 
config F28M35x.minDataUnitSize  // instance
index URL

The minimum addressable data unit size in 8-bit bytes

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

The minimum addressable program unit size in 8-bit bytes

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

A map of peripherals available on the device

XDCscript usage meta-domain
var params = new F28M35x.Params;
  ...
params.peripherals = IPeripheral.Instance[string] undefined;
 
 
config F28M35x.timer0  // instance
index URL
XDCscript usage meta-domain
var params = new F28M35x.Params;
  ...
params.timer0 = Timer.Instance undefined;
 
 
config F28M35x.timer1  // instance
index URL
XDCscript usage meta-domain
var params = new F28M35x.Params;
  ...
params.timer1 = Timer.Instance undefined;
 
 
config F28M35x.timer2  // instance
index URL
XDCscript usage meta-domain
var params = new F28M35x.Params;
  ...
params.timer2 = Timer.Instance undefined;
 
 
config F28M35x.timer3  // instance
index URL
XDCscript usage meta-domain
var params = new F28M35x.Params;
  ...
params.timer3 = Timer.Instance undefined;
 
Instance Creation
index URL

XDCscript usage meta-domain
var params = new F28M35x.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = F28M35x.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.
 
F28M35x.getMemoryMap()  // 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.
 
F28M35x.getRegisterSet()  // 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 Fri, 16 Sep 2011 21:20:42 GMT