21.4.34 sd_instantiate_hdl_module

Description

This Tcl command instantiates a HDL module in a SmartDesign component. The HDL file in which the HDL module is defined must be imported/linked before running this command.

sd_instantiate_hdl_module -sd_name {smartdesign component name} \
                          -hdl_module_name {hdl module name} \
                          -hdl_file {hdl file} \
                          [-instance_name {instance name}]

Arguments


Parameter	Type	Description
sd_name	string	Specifies the name of the SmartDesign component. It is mandatory.
hdl_module_name	string	Specifies the name of the HDL module being instantiated in the SmartDesign component. It is mandatory.
hdl_file	string	Specifies the path of the HDL file in which the HDL module is defined. The HDL file path can be relative to project folder for imported files but the path has to be complete for linked files. It is mandatory.
instance_name	string	Specifies the instance name of the HDL module. It is optional. By default, the instance name is <hdl_module_name>_<index> (index is an automatically generated integer starting at 0 such that the instance name is unique in the SmartDesign).


Return Type	Description
None	None

Error Codes


Error Code	Description
None	Required parameter 'sd_name' is missing.
None	Required parameter 'hdl_file' is missing.
None	You cannot instantiate a sub-module 'module_name' of HDL module.
None	Parameter 'param_name' is not defined. Valid command formatting is 'sd_instantiate_hdl_module -sd_name "sd_name" [-hdl_module_name "hdl_module_name"] -hdl_file "hdl_file" [-instance_name "instance_name"]'.

Supported Families


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

Example

The following example instantiates a 'top' module in a SmartDesign 'mydesign' component "top_0" instance name (by default):

sd_instantiate_hdl_module -sd_name {mydesign} \
                          -hdl_module_name {top} \
                          -hdl_file {hdl/top.v} \
                          -instance_name {}

v2024.2