21.4.42 sd_rename_port

Description

This Tcl command renames a SmartDesign port name.

Important: This command is not required to build a SmartDesign component. It maps to an interactive user action in the SmartDesign Canvas and will not be present in the exported SmartDesign component Tcl description.
sd_rename_port -sd_name {smartdesign component name} \
               -current_port_name {port name} \
               -new_port_name {new port name}

Arguments

ParameterTypeDescription
sd_namestringSpecifies the name of the SmartDesign component. It is mandatory.
current_port_namestringSpecifies the name of the port to be renamed in the SmartDesign component. It is mandatory.
Note: Only port names can be renamed, and not port types (scalar ports cannot be renamed as bus ports and vice versa).
new_port_namestringSpecifies the new name of the specified port. It is mandatory.
Return TypeDescription
NoneNone

Error Codes

Error CodeDescription
None'P*' is containing the invalid character '*'.
NoneParameter 'new_port_name' has illegal value.
NoneRequired parameter 'sd_name' is missing.
NoneParameter 'current_port_name' has illegal value.
NonePort 'port_name' doesn't exist.
NoneRequired parameter 'current_port_name' is missing.
NoneRequired parameter 'new_port_name' is missing.
NoneParameter 'param_name' is not defined. Valid command formatting is 'sd_rename_port -sd_name "sd_name" -current_port_name "current_port_name" -new_port_name "new_port_name"'.
SDCTRL02Port name already exists.

Supported Families

Supported Families
PolarFire®
PolarFire SoC
RTG4
SmartFusion® 2
IGLOO® 2

Example

The following command renames c1 port name with c2 in "top" design:

sd_rename_port -sd_name {top} -current_port_name {c1} -new_port_name {c2}

See Also

  • sd_create_scalar_port