| metaonly module xdc.platform.Utils |
 |
 |
Misc platform utilities
| usage | meta-domain | sourced in xdc/platform/Utils.xdc |
var Utils = xdc.useModule('xdc.platform.Utils');
module-wide functions
Utils.addPeripheralsMap// Create a map of all peripherals available on a device(ICpuDataSheet.Instance cds ) returns Void
Utils.assembleMemoryMap// Combine the device and the external memory map into a platform map(Any cpu , Any plat , Any noCheck ) returns Any
Utils.assemblePeripheralsMap// Create a map of all peripherals available on a platform(ICpuDataSheet.Instance cds , IPlatform.Instance inst , String[] names ) returns Void
Utils.checkDefaults// Check if dataMemory, codeMemory and stackMemory are set correctly(Any inst , Any memMap ) returns Any
Utils.checkFit// Check if a memory map fits into available physical memory(Any realMemMap , Any customMemMap ) returns Any
Utils.checkOverlap// Check if there is an overlap among memory objects in a memory map(Any memMap ) returns Any
| Utils.addPeripheralsMap() // module-wide |
|
Create a map of all peripherals available on a device
| usage | meta-domain |
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.
| Utils.assembleMemoryMap() // module-wide |
|
Combine the device and the external memory map into a platform map
| usage | meta-domain |
Utils.assembleMemoryMap(Any cpu, Any plat, Any noCheck) returns Any
ARGUMENTS
cpu
— an xdc.platform.IExeContext object
plat
— a platform instance
noCheck
— if true, and a custom memory map is defined, the
function does not check if the custom memory map fits
into the available physical memory
DETAILS
This function combines memory maps and also applies memory map name
changes requested through renameMap.
RETURNS
platform memory map
| Utils.assemblePeripheralsMap() // module-wide |
|
Create a map of all peripherals available on a platform
| usage | meta-domain |
Utils.assemblePeripheralsMap(ICpuDataSheet.Instance cds, IPlatform.Instance inst, String[] names) returns Void
ARGUMENTS
inst
— an xdc.platform.IPlatform instance
cds
— an xdc.platform.ICpuDataSheet instance
names
— an optional list of names of IPeripheral parameters
DETAILS
The config parameter peripherals is by default undefined in an
xdc.platform.IPlatform instance. This function gathers
all peripherals defined in an xdc.platform.ICpuDataSheet
instance available as xdc.cfg.Program.cpu.attrs, and adds
peripherals defined in this platform instance. By providing a list
of config parameter names, the instance can add only listed
peripherals instead of adding all available ones.
| Utils.checkDefaults() // module-wide |
|
Check if dataMemory, codeMemory and stackMemory are set correctly
| usage | meta-domain |
Utils.checkDefaults(Any inst, Any memMap) returns Any
ARGUMENTS
inst
— an xdc.platform.IPlatform instance
memMap
— a map of xdc.platform.IPlatform.Memory objects
DETAILS
The xdc.platform.IPlatform instance parameters 'dataMemory',
'codeMemory', and 'stackMemory' are strings. This function verifies
that those strings correspond to names of the memory objects in the
supplied memory map.
RETURNS
'true' if checked parameters are valid, 'false'
otherwise
| Utils.checkFit() // module-wide |
|
Check if a memory map fits into available physical memory
| usage | meta-domain |
Utils.checkFit(Any realMemMap, Any customMemMap) returns Any
ARGUMENTS
realMemMap
— a map of xdc.platform.IPlatform.Memory
objects containing physical memory map as
defined in datasheets for the device and the
platform
customMemMap
— a map of xdc.platform.IPlatform.Memory
objects containing user defined memory map,
which must fit within boundaries of 'realMemMap'
DETAILS
A custom memory map segment can be spread over multiple physical
memories or multiple custom memory map segments can be located in
one physical memory. However, code/data restrictions must be followed.
A custom memory segment with the parameter 'space' set to "code/data",
which is the default value if the parameter was not specified, can fit
only into "code/data" physical memories. Custom memory segments with
'space' set to "code" can fit into "code" and "code/data" memories, and
custom memory segments with 'space' set to "data" can fit into "data"
and "code/data" physical memories.
RETURNS
'true', if customMemMap fits within realMemMap,
and 'false' otherwise
| Utils.checkOverlap() // module-wide |
|
Check if there is an overlap among memory objects in a memory map
| usage | meta-domain |
Utils.checkOverlap(Any memMap) returns Any
ARGUMENTS
memMap
— a map of xdc.platform.IPlatform.Memory objects
RETURNS
a string with names of Memory objects that overlap
| Utils.getCpuDataSheet() // module-wide |
|
Get the specified cpu data sheet object
| usage | meta-domain |
Utils.getCpuDataSheet(Any cpuDesc) returns Any
ARGUMENTS
cpuDesc
— an xdc.platform.IExeContext.Cpu object identifying
the CPU device
RETURNS
an xdc.platform.ICpuDataSheet.Instance object that
corresponds to the specified cpuDesc
THROWS
Error exceptions are thrown for fatal errors
generated on Wed, 20 Jul 2011 20:33:33 GMT