Description
Get a list of software arrays.
Syntax
get_arrays [-regexp] [-filter <arg>] [-of_objects <args>] [-quiet] [-verbose] [<patterns>...]
Returns
Array objects. Returns nothing if the command fails.
Usage
Name | Description |
---|---|
[-regexp ] |
Patterns are full regular expressions |
[-filter ] |
Filter list with expression |
[-of_objects ] |
Get 'array' objects of these types: 'sw_proc os driver lib sw_core'. |
[-quiet ] |
Ignore command errors |
[-verbose ] |
Suspend message limits during command execution |
[<patterns>] | Match cell names against patterns Default: * |
Categories
Software
Description
Arrays are defined in MDD/MLDs. It contains any number of PARAMs and PROPERTYs which describes size, description of array and default values of elements in array.Arguments
-regexp
– (optional) Specifies that the
search <patterns> are written as regular expressions. Both search
<patterns> and -filter
expressions must be written as
regular expressions when this argument is used. Xilinx regular expression
Tcl commands are always anchored to the start of the search string. You can
add .*
to the beginning or end of a search string to widen
the search to include a substring. See this web page for help with regular expression
syntax.regexp
is not anchored, and works as a standard Tcl
command. For more information, refer to this web page.
-filter
<args> – (optional) Filter the
results list with the specified expression. The -filter
argument filters the list of objects returned based on property values on
the objects. You can find the properties on an object with the
report_property
or list_property
commands.
*
character can be used at the beginning or at the end of a search string to
widen the search to include a substring of the property value. *
wildcard character, this matches a
property with a defined value of "".For string comparison, the specific operators that can be
used in filter expressions are equal
(==
),
not-equal
(!=
),
match
(=~
), and
not-match
(!~
). Numeric comparison
operators <
, >
,
<=
, and >=
can also be used.
Multiple filter expressions can be joined by AND
and
OR
(&&
and
||
).
For array objects, "NAME", and "other config parameters" are some of the properties that can be used to filter results.
-of_objects
<arg> - (optional)
Get the arrays that are available in OS, Drivers, Libraries, Processor, Core, as
returned by the get_os, get_drivers, get_libs, get_sw_processor, get_sw_cores
commands.
-of_objects
option requires objects to be specified using the
get_*
commands, such as get_os
or
get_libs
, rather than specifying objects by name. In addition,
-of_objects
cannot be used with a search
<pattern>.-quiet
– (optional) Execute
the command quietly, returning no messages from the command. The command
also returns TCL_OK
regardless of any
errors encountered during execution. -verbose
– (optional) Temporarily override
any message limits and return all messages from this command.set_msg_config
command.<patterns> - (optional) Match arrays against the specified patterns. The default pattern is the wildcard `*` which gets a list of all arrays. More than one pattern can be specified to find multiple arrays based on different search criteria.
Examples
The following example gets a list of arrays present in all software cores(drivers/libs/os):
hsi::get_arrays
The following example gets a list of all arrays matching the name "mem_table":
hsi::get_arrays mem_table
The following example gets a list of arrays present in OS of current software design:
hsi::get_arrays -of_objects [get_os]