runH2G (hierarchyType library file primary secondary) | |
| Convert specified text declarations to graphics. Uses options set by setupH2G. | |
| Argument: hierarchyType | SINGLE | HIERARCHY. |
| Argument: library | Library name. |
| Argument: file | File path, relative to the library HDL mapping. |
| Argument: primary | Primary HDL declaration (VHDL entity or verilog module). |
| Argument: secondary | Secondary HDL declaration (VHDL architecture). |
runHdlImport (library args) | |
| Import HDL files to a new or existing library. Options set by setupHdlImport are used. See also: setupHdlImport. | |
Example: # import files by pointing to them (without copy)
runHdlImport "mylib" "d:/mydesign/file1.v" "d:/mydesign/file2.v" -point -clean
# import files by copying them to a sub-directory named "rtl" in library "mylib"
runHdlImport "mylib" "d:/mydesign/file1.v" "d:/mydesign/file2.v" -copy -subDirectory {"mylib" "rtl"}
# import files specified in a file-list by copying them to the target libraries (also specified in the file-list)
runHdlImport "" -filelist "d:/mydesign/components/filelist.txt" -copy
# import a set of files specified in a Tcl list by pointing to them (without copy)
set files {{d:/mydesign/file1.v} {d:/mydesign/file2.v}}
eval runHdlImport {""} $files -point -clean
# import a set of files specified in a Tcl list by copying them to a sub-directory named "rtl" in library "mylib"
set files {{d:/mydesign/file1.v} {d:/mydesign/file2.v}}
eval runHdlImport {"mylib"} $files -copy -subDirectory {{"mylib" "rtl"}}
| |
| Argument: library | The default target library name to import the files into. This argument is mandatory. If a default target library is not required (i.e. all libraries are specified in the file-list), and empty string ("" or {}) must be entered. If an empty string provided (and no library specified in filelist), the project's default library is used if -copy option is supplied and a made-up library name is used if -point option is supplied. If the library does not exist, it is automatically created at the libraries root directory preference (see setLibrariesRootDirectory). |
| Argument: args | <path to file 1> <path to file 2> <path to file 3>...: Files to import. File paths can be specified relative to the current working directory. -filelist <path to file-list>: Imports a list of files specified in a filelist (see HDS User Manual for filelist format). Filelist path can be specified relative to the current working directory. -copy: Imports the files by copying them to the target library HDL mapping. This option is the default. -point: Imports the files by pointing the library HDL mapping to them. If the target library is already created, the HDL mapping must by enclosing all the files to import. -clean: Applicable only when -point option is supplied. If the target library already exists, it cleans the HDS mapping specified by the libraries root directory preference (see setLibrariesRootDirectory) if it is not empty. -useSpecifiedLibraries: This option forces the import process to use the library(ies) specified in the file list or the default library (as appropriate) when importing files. If this option is not used, the import process will infer in which libraries the VHDL files belong by parsing “library”, “use” and instance statements. New libraries will be created if necessary. -subDirectory {<library 1> <directory 1>} {<library 2> <directory 2>}...: Applicable only when -copy option is supplied. Specify a sub-directory (relative to library's HDL mapping) to have the files copied to. If nothing specified, files are copied to target libraries' HDL mapping directory. |
runHtmlExport (library unit view file) | |
| Run the HTML export on the given design object. Uses options set by setupHtmlExport. | |
Example:# Run HTML Export for Block Diagram view "struct" of design unit UART.uart_top runHtmlExport UART uart_top struct uart_top/struct.bd # Run HTML Export for Symbol view of design unit UART_V.uart_tb runHtmlExport UART_V uart_tb "" uart_tb/symbol.sb | |
| Argument: library | Library name. |
| Argument: unit | Design unit name. |
| Argument: view | View name for graphics or secondary declaration name for HDL (VHDL architecture). View name can be left empty when exporting primary unit files (e.g: graphical symbol). |
| Argument: file | File path, relative to the library HDS/HDL mapping. |
setupH2G (args) | |
| Setup the options for runH2G. | |
| Argument: args | Option names and values. |
| View Styles Options: | |
| -createAltSmFlowChart ON|OFF (ON) | If a State Diagram view cannot be created, create a FlowChart view instead. |
| -createBlockDiagram ON|OFF (ON) | Create a structural Block Diagram view. |
| -createFlowChart ON|OFF (OFF) | Create a Flow Chart view. |
| -createIBD ON|OFF (OFF) | Create an IBD view. |
| -createLeafBlockDiagram ON|OFF (OFF) | Create a leaf level Block Diagram view. |
| -createStateDiagram ON|OFF (OFF) | Create a State Diagram view. |
| -createSymbolAlways ON|OFF (OFF) | Create a symbol even if no view styles are selected. |
| General Options: | |
| -overwrite ON|OFF (OFF) | If a graphical view already exists, overwrite it. |
| -copyOnOverwrite ON|OFF (OFF) | Copy a view before overwriting it. |
| -searchLibraries <libraries> | Search for black box components in these libraries. |
| -setCreateForGenerate ON|OFF (ON) | Set Create For generation. Create editable graphical views not visualization views. |
| -setDefaultView ON|OFF (ON) | Set graphical views as default. |
| -setLibrary <unit> <library> | Specify a library for a black box component. |
| -verbose ON|OFF (OFF) | Display additional information during conversion. |
| Block Diagram Options: | |
| -assignmentShape RECTANGLE|BUFFER (RECTANGLE) | Specify the shape of concurrent assignments, if extracted. |
| -connectEmbedded ON|OFF (OFF) | Create signals between embedded blocks. |
| -createEmbeddedStateDiagram ON|OFF (OFF) | Create embedded state machines if possible. |
| -defaultInstanceView ON|OFF (OFF) | Apply to instances in preference to a specified view. |
| -diagramTextVisibility NONE|ALL|PREFS (NONE) | Specify the visibility of text associated with the diagram. |
| -extractAssignments ON|OFF (OFF) | Create separate embedded blocks for concurrent assignments. |
| -instanceLimit <positive integer> (1000) | Maximum number of instances allowed in a Block Diagram. |
| -netTextVisibility NONE|PORT_ONLY|ALL|PREFS (PORT_ONLY) | Specify the visibility of text associated with nets. |
| -portTextVisibility NONE|NAME_ONLY|NAME_AND_TYPE|PREFS (PREFS) | Specify the visibility of text associated with PortIO. |
| Placement Options: | |
| -instanceAutoSize WIDTH|HEIGHT|WIDTH_AND_HEIGHT|NONE (WIDTH_AND_HEIGHT) | Size component instances to fit the visible text. |
| -placementLimit <positive integer> (50) | Maximum number of auto-placed instances. |
| -preservePlacement ON|OFF (OFF) | Preserve placement of existing diagrams. |
| Routing Options: | |
| -alignPorts ON|OFF (ON) | Align port I/O with connections. |
| -bundleLimit <positive integer> (5) | Maximum number of signals allowed in a bundle. |
| -bundleSignals DIRECT|INDIRECT|NONE (NONE) | Bundle signals between nodes. |
| -busReconstruct ON|OFF (OFF) | Reconstruct buses for signal slices |
| -connectionLimit <positive integer> | Maximum number of connections allowed for a net. |
| -globalConnectors ON|OFF (ON) | Create global connectors for global signals. |
| -movePorts ON|OFF (ON) | Allow connector end points to move during routing. |
| -routeSignals ON|OFF (ON) | Connect and route signals on the diagram. |
| -useDefaults | Set all options to default values. Default values are shown in brackets, above. |
setupHdlImport (args) | |
| Set the options for HDL import. These options are used by runHdlImport. See also: runHdlImport. | |
Example:# get the current setting for all options setupHdlImport # get the current setting for "-overwrite" option setupHdlImport -overwrite # change HDL import options and run HDL import setupHdlImport -overwrite OFF runHdlImport "mylib" "d:/mydesign/file1.v" | |
| Notes: If no options are specified, all options with their current values are returned. If an option is specified without a value, the current value of that option is returned. | |
| Argument: args | -useDefaults: Restore the defaults for HDL import options. -overwrite (ON | OFF): Default value (ON). Specify if to overwrite files if they already exist in the target location. -importReferencedText (ON | OFF): Default value (OFF). Specify if to create references to imported files instead of copying them. -importDirectoryStructure (ON | OFF): Default value (ON). Specify if to keep the same directory structure for imported files. -defaultLanguage (VHDL | VERILOG | UNKNOWN): Default value (UNKNOWN). Specify the lagnuage of imported files with unrecognized extensions. Must be set to (UNKNOWN) to import non-HDL files. -defaultVhdlDialect (VHDL_87 | VHDL_93 | VHDL_2002 | VHDL_2008): Default value (VHDL_ANY). Specify the VHDL dialect that will be used during import. If set to default, HDS will auto detect the dialect during the import operation. -defaultVerilogDialect (VERILOG_95 | VERILOG_2001 | SYSTEM_VERILOG_2002): Default value (VERILOG_ANY). Specify the verilog dialect that will be used during import. If set to default, HDS will auto detect the dialect during the import operation. if set to SYSTEM_VERILOG_2002, HDS will import the files as SystemVerilog and if set to VERILOG_2001, HDS will import the files as Verilog 2005. |
setupHtmlExport (args) | |
| Setup the options for runHtmlExport. This can be called mutiple times to change various options before calling runHtmlExport. | |
| Argument: args | Option names and values. |
| HTML Settings: | |
| -reset_defaults | Reset all options back to their defaults. |
| -export_directory <path> | Target directory for export. |
| -hierarchy_levels ALL|<number> (ALL) | Levels of hierarchy to decend. |
| -export_visualizations ON|OFF (ON) | Switch for creation of visualization. |
| -include_doc_types ALL|<doc_types> (ALL) | Add a list of document types to include in the export (see Documentation and Visualization options dialog for document type names). |
| -include_only_doc_types | Make these document types the only ones included for export. More types can be added with subsequently include_doc_types calls (see Documentation and Visualization options dialog for document type names). |
| -export_all_ict ON|OFF | Switch to export all ICT views. |
| -export_generated ON|OFF (ON) | Switch to export generated files. |
| -export_sidedata_files ALL|REGISTERED (ALL) | Set the types of sidedata files to export. |
| -export_sidedata_type USER|DESIGN|ALL|NONE (ALL) | Sets the types of sidedata to export. |
| -title_page AUTO|<path> (AUTO) | Sets the path to the title page to use. |
| -index_page AUTO|<page> (AUTO) | Set the index page name. |
| Graphics Settings: | |
| -graphics_format JPEG|PNG|SVG (SVG) | Set the format to use when exporting graphics. |
| -jpeg_quality <1- 100> (100) | Quality to use for JPEG graphics. |
| -graphics_size <1- 100> (100) | Percentage size for graphics. |