hsi::create_comp_param - 2020.2 English

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)

Document ID
UG1400
Release Date
2020-12-15
Version
2020.2 English

Description

Add parameter.

Syntax

create_comp_param [-quiet] [-verbose] <name> <value> <objects> 

Returns

Parameter object. Returns nothing if the command fails.

Usage

Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
<name> Parameter name
<value> Parameter value
<objects> List of nodes

Categories

Software

Description

Create a new param to list of nodes (driver/os/proc/node).

If successful, this command returns the name of the param created. Otherwise it returns an error.

Arguments

-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.
Note: Any errors encountered on the command line while launching the command are returned. Only errors occurring inside the command are trapped.
-verbose – (optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

<name> - The name of the param to create.

<value> - The value of the param to create. Default type of param is string.

<objects> - List of nodes to which new param is created.

Examples

The following example creates a new param called p1 to specified driver:

hsi::create_comp_param p1 [get_drivers ps7_uart_1]

The following example creates a new param called p2 to all drivers.

hsi::create_comp_param p2 [get_drivers]