package_xo Command

Description

Kernels written in RTL are compiled using the package_xo command line utility. This utility, similar to xocc -c, generates an .xo file which can subsequently used in the xocc linking stage.

Arguments

Table 1. Arguments
Argument Description
-kernel_name <arg> Required. Specifies the name of the RTL kernel.
-force (Optional) Overwrite an existing XO file if one exists.
-kernel_xml <arg>

(Optional) Specify the path to an existing kernel XML file.

-design_xml <arg> (Optional) Specify the path to an existing design XML file
-ip_directory <arg> (Optional) Specify the path to the kernel IP directory.
-parent_ip_directory (Optional) If the kernel IP directory specified contains multiple IPs, specify a directory path to the parent IP where its component.xml is located directly below.
-kernel_files (Optional) Kernel file name(s).
-kernel_xml_args <args> (Optional) Generate the kernel.xml with the specified function arguments. Each argument value should use the following format: 
{name:addressQualifier:id:port:size:offset:type:memSize}
Note: memSize is optional.
-kernel_xml_pipes <args> (Optional) Generate the kernel.xml with the specified pipe(s). Each pipe value use the following format: 
{name:width:depth}
-kernel_xml_connections <args> (Optional) Generate the kernel.xml file with the specified connections. Each connection value should use the following format:
{srcInst:srcPort:dstInst:dstPort}
-xo_path <arg> (Required) Specifies the path and file name of the compiled object (XO) container file.
-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, will be returned. Only errors occurring inside the command will be 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.

Examples

The following example creates the specified XO file containing an RTL kernel of the specified name: 
package_xo -xo_path /temp/data/rtl_kernel/Vadd_A_B.xo -kernel_name Vadd_A_B