B

---

Environment Variables

---

This appendix describes the environment variables of Virtuoso Text Editor and HDL Package Setup form that you can use to customize the default settings. You can set the values of these environment variables in the .cdsenv or .cdsinit file. The following example illustrates how an environment variable is set in the .cdsenv file.

textedit   useExternalEditor boolean nil

For details on the .cdsenv file, see Specifying Environment Settings in Virtuoso Design Environment User Guide.

This appendix describes the following Virtuoso Text Editor and HDL Package Setup form environment variables:

• CDS5X_NOLINK
• enableAhdllintStaticCheck
• hdlPkgAdvancedMode
• hdlPkgEnableHdlSetup
• hdlPkgEnableUPF
• hdlPkgEnableUVM
• hdlPkgHdlvarFile
• hdlPkgMakeLibTree
• hdlPkgProjDir
• hdlPkgUseHdlvar
• hdlPkgUseXmlibdirname
• hdlPkgUVMVersion
• hdlPkgXmlibdirname
• hdlPkgXrunArgsFileTableList
• inScopeReadBGColor
• inScopeWriteBGColor
• showLineNumbersInSideBar
• syntaxLineLength
• useExternalEditor
• ignoreDesignValCheckXcelium
• messageSeverityXcelium
• designCheckLogFileXcelium
• messageSeverityExtractionFramework

CDS5X_NOLINK

If set to t, the netlist file is copied in the cellview. Else, a symbolic link of the netlist file is created in the cellview. This variable is useful in creating a symbolic link when the size of the netlist file is large.

Variable Type	Boolean
Default Value	t
Acceptable Values	t, nil

enableAhdllintStaticCheck

If set to t, enables AHDL Linter static check in Virtuoso Text Editor.

Variable Type	Boolean
Default Value	nil
Acceptable Values	t, nil

Related Topics

Understanding the Graphical User Interface

hdlPkgAdvancedMode

Displays the options used to specify additional package text files and name of the xcelium.d directory for xrun compilation in the Virtuoso HDL Package Setup form. By default, these options are not displayed.

Variable Type	toggle
Default Value	nil
Acceptable Values	t, nil

GUI Equivalent

Command	Tools – AMS – HDL Package Setup
Field	Advanced mode

Examples

envSetVal("hdlPkg" "hdlPkgAdvancedMode" 'toggle '(nil))

Related Topics

Virtuoso HDL Package Setup Form

hdlPkgEnableHdlSetup

Enables the flow where xrun is called with the options specified on the Virtuoso HDL Package Setup form to compile HDL files. A *.pak file is created in the default scratch directory instead of the existing Virtuoso library directory. By default, the flow is not enabled.

Variable Type	Toggle
Default Value	nil
Acceptable Values	t, nil

GUI Equivalent

Command	Tools – AMS – HDL Package Setup
Field	Enable HDL package setup

Examples

envSetVal("hdlPkg" "hdlPkgEnableHdlSetup" 'toggle '(nil))

Related Topics

Virtuoso HDL Package Setup Form

hdlPkgEnableUPF

Enables the SystemVerilog UPF package. By default, the SystemVerilog UPF package is not enabled.

Variable Type	toggle
Default Value	nil
Acceptable Values	t, nil

GUI Equivalent

Command	Tools – AMS – HDL Package Setup
Field	Enable SystemVerilog UPF

Examples

envSetVal("hdlPkg" "hdlPkgEnableUPF" 'toggle '(nil))

Related Topics

Virtuoso HDL Package Setup Form

hdlPkgEnableUVM

Enables the UVM compilation built-in package. By default, the UVM compilation package is not enabled.

Variable Type	toggle
Default Value	nil
Acceptable Values	t, nil

GUI Equivalent

Command	Tools – AMS – HDL Package Setup
Field	Enable UVM Compilation

Examples

envSetVal("hdlPkg" "hdlPkgEnableUVM" 'toggle '(nil))

Related Topics

• Virtuoso HDL Package Setup Form
• hdlPkgUVMVersion

hdlPkgHdlvarFile

Specifies the name and absolute path of an hdl.var file. The is recommended only when the project uses hdl.var legacy file. By default, no hdl.var file is specified.

Variable Type	string
Default Value	""
Acceptable Values	string specifying the name and path of a valid hdl.var file enclosed in double quotes

GUI Equivalent

Command	Tools – AMS – HDL Package Setup
Field	hdl.var file

Examples

envSetVal("hdlPkg" "hdlPkgHdlvarFile" 'string "$Usr/hdl.var")

Related Topics

• Virtuoso HDL Package Setup Form
• hdlPkgUseHdlvar

hdlPkgMakeLibTree

Creates the makelib table.

Variable Type	String
Default Value	""
Acceptable Values	string specifying the values of all the columns in the table enclosed in double quotes

GUI Equivalent

Command	Tools – AMS – HDL Package Setup
Field	makelib (table)

Examples

envSetVal("hdlPkg"  "hdlPkgMakeLibTree"   'string "((t \"pkgLib\" \"$PROJ/package_1.sv\"\"-incdir$PROJ/pkg_source\")(t\"pkgLib\"\"$PROJ/package_2.sv\"\"\"))")

Related Topics

Virtuoso HDL Package Setup Form

hdlPkgProjDir

Specifies the directory to save the xcelium.d and xcelium compilation results.

Variable Type	string
Default Value	"./compileScratch"
Acceptable Values	string specifying the path to any valid, accessible file system location

GUI Equivalent

Command	Tools – AMS – HDL Package Setup
Field	Default scratch directory (text field)

Examples

envSetVal("hdlPkg"  "hdlPkgProjDir"   'string "./compileScratch_test")

Related Topics

Virtuoso HDL Package Setup Form

hdlPkgUseHdlvar

Enables the option to specify an hdl.var file. By default, the option is disabled.

Variable Type	toggle
Default Value	nil
Acceptable Values	t, nil

GUI Equivalent

Command	Tools – AMS – HDL Package Setup
Field	hdl.var file t

Examples

envSetVal("hdlPkg" "hdlPkgUseHdlvar" 'toggle '(nil))

Related Topics

• Virtuoso HDL Package Setup Form
• hdlPkgHdlvarFile

hdlPkgUseXmlibdirname

Enables the option to specify name of the xcelium.d directory. By default, the directory is not specified.

Variable Type	toggle
Default Value	nil
Acceptable Values	t, nil

GUI Equivalent

Command	Tools – AMS – HDL Package Setup
Field	-xmlibdirname

Examples

envSetVal("hdlPkg"  "hdlPkgUseXmlibdirname"   'toggle '(nil))

Related Topics

Virtuoso HDL Package Setup Form

hdlPkgUVMVersion

Specifies the UVM version if UVM compilation is enabled.

Variable Type	string
Default Value	"1.2"
Acceptable Values	String specifying any valid UVM version

GUI Equivalent

Command	Tools – AMS – HDL Package Setup
Field	UVM version

Examples

envSetVal("hdlPkg" "hdlPkgUVMVersion" 'string "1.2")

Related Topics

• Virtuoso HDL Package Setup Form
• hdlPkgEnableUVM

hdlPkgXmlibdirname

Specifies the name of the xcelium.d directory.

The specified name is used together with the value of the-xmlibdirpath argument, therefore, must not contain any path information.

Variable Type	string
Default Value	""
Acceptable Values	String specifying a valid directory on the file system

GUI Equivalent

Command	Tools – AMS – HDL Package Setup
Field	-xmlibdirname

Examples

envSetVal("hdlPkg" "hdlPkgXmlibdirname" 'string "myXmLibDir")

Related Topics

Virtuoso HDL Package Setup Form

hdlPkgXrunArgsFileTableList

Creates the Options files table.

Variable Type	String
Default Value	""
Acceptable Values	string specifying the values of all the columns in the table enclosed in double quotes

GUI Equivalent

Command	Tools – AMS – HDL Package Setup
Field	Options files (table)

Examples

envSetVal("hdlPkg" "hdlPkgXrunArgsFileTableList" 'string "((t \"$PROJ/test_compile.f\")(t \"$PROJ/pkgs.f\"))")

Related Topics

Virtuoso HDL Package Setup Form

inScopeReadBGColor

Sets the background color of the content when a text cellview is opened in read-only mode.

Variable Type	String
Default Value	"#E8E8E8"
Acceptable Values	String, nil

Related Topics

Switching Between Edit Mode and Read-Only Mode

inScopeWriteBGColor

Sets the background color of the content when a text cellview is opened in edit mode.

Variable Type	String
Default Value	"white"
Acceptable Values	String, nil

Related Topics

Switching Between Edit Mode and Read-Only Mode

showLineNumbersInSideBar

If set to t, Virtuoso Text Editor displays the line number of each line in the text cellview file.

Variable Type	Boolean
Default Value	t
Acceptable Values	t, nil

Related Topics

Showing Line Numbers and Going to a Line Number

syntaxLineLength

Specifies the number of characters that will be processed by the syntax highlighter on every line.

Variable Type	Integer
Default Value	1000
Acceptable Values	0-1000

useExternalEditor

If set to t, Virtuoso uses an external editor as the default editor instead of using Virtuoso Text Editor.

Variable Type	Boolean
Default Value	nil
Acceptable Values	t, nil

Related Topics

Editing a Text Cellview File in an External Editor

ignoreDesignValCheckXcelium

textif ignoreDesignValCheckXcelium boolean nil nil  

Description

Ignores the Xcelium design validation checks. The default value is nil, which indicates that the Xcelium design validation checks are done.

GUI Equivalent

None

Examples

envGetVal("textif" "ignoreDesignValCheckXcelium")

envSetVal("textif" "ignoreDesignValCheckXcelium" 'boolean t)

messageSeverityXcelium

textif messageSeverityXcelium cyclic {"AllCurrentVersion" | "Notice" | "Warning" | "Error" | "System" | "Internal" | "None" | "AllAnyVersion"} 

Description

Controls the severity of the Xcelium design validation checks. The default value is None, which indicates that no errors or warnings for Xcelium design validation checks are reported. Possible values are:

• AllCurrentVersion: All messages for the current version of Xcelium are reported.
• Notice: Only messages of type Notice are reported.
• Warning: Only messages of type Warning are reported.
• Error: Only messages of type Error are reported.
• System: Only messages of type System are reported.
• Internal: Only messages of type Internal are reported.
• None: No messages are reported.
• AllAnyVersion: All messages for all versions are reported.

GUI Equivalent

None

Examples

envGetVal("textif" "messageSeverityXcelium")

envSetVal("textif" "messageSeverityXcelium" 'cyclic "AllCurrentVersion")

envSetVal("textif" "messageSeverityXcelium" 'cyclic "Notice")

envSetVal("textif" "messageSeverityXcelium" 'cyclic "Warning")

envSetVal("textif" "messageSeverityXcelium" 'cyclic "Error")

envSetVal("textif" "messageSeverityXcelium" 'cyclic "System")

envSetVal("textif" "messageSeverityXcelium" 'cyclic "Internal")

envSetVal("textif" "messageSeverityXcelium" 'cyclic "AllAnyVersion")

designCheckLogFileXcelium

textif designCheckLogFileXcelium string "./vamsXceliumDesignValidationLogs" 

Description

Specifies the path of the log file in which the messages are printed.

The default value is "./vamsXceliumDesignValidationLogs".

GUI Equivalent

None

Examples

textif designCheckLogFileXcelium string "/user1/myValidationLogs" 

messageSeverityExtractionFramework

textif messageSeverityExtractionFramework cyclic { "All" | "Warning" | "Error" | "System" | "Failure" | "AllExceptWarning" | "None" } 

Description

Controls the severity of the messages reported by the Xcelium extraction framework. The default value is All, which indicates that all errors or warnings for Xcelium design validation checks are reported. Possible values are:

• All: Default. All messages are reported.
• Warning: Only messages of type Warning are reported.
• Error: Only messages of type Error are reported.
• System: Only messages of type System are reported.
• Failure: Only messages of type Failure are reported.
• AllExceptWarning: All messages except those of type Warning are reported.
• None: No messages are reported.

GUI Equivalent

None

Examples

envGetVal("textif" "messageSeverityExtractionFramework")

envSetVal("textif" "messageSeverityExtractionFramework" 'cyclic "Warning")

envSetVal("textif" "messageSeverityExtractionFramework" 'cyclic "Error")

envSetVal("textif" "messageSeverityExtractionFramework" 'cyclic "System")

envSetVal("textif" "messageSeverityExtractionFramework" 'cyclic "Failure")

envSetVal("textif" "messageSeverityExtractionFramework" 'cyclic "AllExceptWarning")

envSetVal("textif" "messageSeverityExtractionFramework" 'cyclic "None")

Return to top