Description
Get a list of parmas.
Syntax
get_comp_params [-regexp] [-filter <arg>] [-of_objects <args>] [-quiet] [-verbose] [<patterns>...]
Returns
Property objects. Returns nothing if the command fails.
Usage
Name | Description |
---|---|
[-regexp ] |
Patterns are full regular expressions |
[-filter ] |
Filter list with expression |
[-of_objects ] |
Get 'param' objects of these types: 'driver sw_proc os node'. |
[-quiet ] |
Ignore command errors |
[-verbose ] |
Suspend message limits during command execution |
[<patterns>] | Match names against patterns Default: * |
Categories
Software
Description
Get a list of params in drivers/os/nodes in the current software design.
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
||
).
get_comp_params -filter {NAME == clock-names && VALUE == "ref_clk aper_clk"}
-of_objects
<arg> - (optional)
Get 'node' objects of these types: 'sw_driver', 'sw_os', 'sw_proc', 'sw_node'. -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 sotfware design cells against the specified patterns. The default pattern is the wildcard `*` which gets a list of all cells in the current IP subsystem design. More than one pattern can be specified to find multiple cells based on different search criteria.
Examples
The following example gets a list of params that include the specified driver in the software design:
hsi::get_comp_params -of_objects [get_drivers ps7_uart_0]
The following example gets a list of all params of OS:
hsi::get_comp_params -of_objects [get_os]