::osvvm

analyze

Analyze an HDL source file.

analyze FileName ?args?

Parameters

FileName:: Path to the HDL source file.
args:: Further options.

Description

This procedure executes a tool-specific analyze command depending on what tool was detected. Some of the used analyze option depend on the current context. For example the use VHDL library this source file and its design units are compiled into, depend on the last library call.

Procedures influencing the context for the ``analyze`` command:

library - set the VHDl working library
SetVHDLVersion - tbd
SetExtendedAnalyzeOptions - tbd
SetVhdlAnalyzeOptions - tbd

Supported HDL sourcefile languages:

VHDL *.vhd/*.vhdl
Verilog *.v
SystemVerilog *.sv

build

build ?Path_Or_File? ?args?

Parameters

Path_Or_File:: Not documented. Optional, default ..

BuildName

BuildName ParamBuildName

Parameters

ParamBuildName:: Not documented.

ChangeWorkingDirectory

ChangeWorkingDirectory RelativePath

Parameters

RelativePath:: Not documented.

CoSim

CoSim

CreateAnalyzeOrderCsv

CreateAnalyzeOrderCsv runs a build script in DryRunMode and creates a AnalyzeOrder.csv file.

CreateAnalyzeOrderCsv ProFileToBuild ?FileNameAndPath?

Parameters

ProFileToBuild:: Path to the pro file that build the entire design.
FileNameAndPath:: Name of file to create. Default: ./AnalyzeOrder.csv Optional, default ./AnalyzeOrder.csv.

CreateDirectory

CreateDirectory Directory

Parameters

Directory:: Not documented.

CreateDryRunDict

CreateDryRunDict runs a build script in DryRunMode and creates dictionaries and lists of Analyze and Simulate information. The Analyze dictionary, ::osvvm::AnalyzeDict, has a dictionary for each library used. For each library there is an list of dictionaries that contain the file analyzed as well as language version used. The list, ::osvvm::AnalyzeOrderList, has a list of dictionaries that contain the file name, library, and vhdl version. The Simulation dictionary, ::osvvm::SimulateDict, has a dictionary for each library used. For each library there is an list of dictionaries that contain information passed to simulate.

CreateDryRunDict ProFileToBuild

Parameters

ProFileToBuild:: Path to the pro file that build the entire design.
WhereToCreate:: Directory into which to create vhdl_ls.toml. Default = .

CreateLibraryPath

CreateLibraryPath PathToLib

Parameters

PathToLib:: Not documented.

CreateOsvvmScriptSettingsPkg

CreateOsvvmScriptSettingsPkg SettingsDirectory

Parameters

SettingsDirectory:: Not documented.

CreateTestCaseCommonPkg

set CurrentDir “”

CreateTestCaseCommonPkg ?PackageName? ?ValidatedResults?

Parameters

PackageName:: Not documented. Optional, default TestCaseCommonPkg.
ValidatedResults:: Not documented. Optional, default ../ValidatedResults.

CreateVhdlLsToml

CreateVhdlLsToml runs a build script in DryRunMode and creates a vhdl_ls.toml file.

CreateVhdlLsToml ProFileToBuild ?FileNameAndPath?

Parameters

ProFileToBuild:: Path to the pro file that build the entire design.
FileNameAndPath:: Name of file to create. Default: ./vhdl_ls.toml Optional, default ./vhdl_ls.toml.

DirectoryExists

DirectoryExists DirInQuestion

Parameters

DirInQuestion:: Not documented.

DoWaves

DoWaves ?args?

Parameters

EndSimulation

EndSimulation

FileExists

FileExists FileName

Parameters

FileName:: Not documented.

FileModified

FileModified FileName

Parameters

FileName:: Not documented.

FindExistingLibraryPath

FindExistingLibraryPath PathToLib

Parameters

PathToLib:: Not documented.

FindIncludeFile

FindIncludeFile Path_Or_File

Parameters

Path_Or_File:: Not documented.

FindLibraryPath

FindLibraryPath PathToLib

Parameters

PathToLib:: Not documented.

FindLibraryPathByName

FindLibraryPathByName LibraryName

Parameters

LibraryName:: Not documented.

FindOsvvmSettingsDirectory

When StartUpShared.tcl calls this to determine the value of ::osvvm::OsvvmUserSettingsDirectory, OsvvmSettingsLocal.tcl has not been run yet, as a result,

FindOsvvmSettingsDirectory ?OsvvmSubdirectory?

Parameters

OsvvmSubdirectory:: Not documented. Optional, default osvvm.

Description

OsvvmSettingsSubdirectory will have its default value of “” and
SettingsAreRelativeToSimulationDirectory will have its default value of false.

For OsvvmSettingsSubdirectory, this is ok as it is only needed to differentiate the VHDL code and not the settings. SettingsAreRelativeToSimulationDirectory this is not ok and it usage has been deprecated. This was used to differentiate VHDL sources for different simulators - use OsvvmSettingsSubdirectory instead

generic

generic Name Value

Parameters

Name:: Not documented.
Value:: Not documented.

GetCoverageAnalyzeEnable

GetCoverageAnalyzeEnable

GetCoverageAnalyzeOptions

GetCoverageAnalyzeOptions

GetCoverageEnable

GetCoverageEnable

GetCoverageSimulateEnable

GetCoverageSimulateEnable

GetCoverageSimulateOptions

GetCoverageSimulateOptions

GetDebugMode

GetDebugMode

GetExtendedAnalyzeOptions

GetExtendedAnalyzeOptions

GetExtendedElaborateOptions

GetExtendedElaborateOptions

GetExtendedOptimizeOptions

GetExtendedOptimizeOptions

GetExtendedRunOptions

GetExtendedRunOptions

GetExtendedSimulateOptions

GetExtendedSimulateOptions

GetInteractiveMode

GetInteractiveMode

GetLibraryDirectory

GetLibraryDirectory

GetLogSignals

GetLogSignals

GetSaveWaves

GetSaveWaves

GetSecondSimulationTopLevel

GetSecondSimulationTopLevel

GetSimulatorResolution

GetSimulatorResolution

GetTimeString

GetTimeString

GetTranscriptType

GetTranscriptType

GetVerilogAnalyzeOptions

GetVerilogAnalyzeOptions

GetVhdlAnalyzeOptions

GetVhdlAnalyzeOptions

GetVHDLVersion

GetVHDLVersion

include

include Path_Or_File ?args?

Parameters

Path_Or_File:: Not documented.

IterateFile

puts “$FileWithNames”

IterateFile FileWithNames ActionForName

Parameters

FileWithNames:: Not documented.
ActionForName:: Not documented.

JoinWorkingDirectory

JoinWorkingDirectory RelativePath

Parameters

RelativePath:: Not documented.

library

library LibraryName ?PathToLib?

Parameters

LibraryName:: Not documented.
PathToLib:: Not documented. Optional, default "".

LinkCurrentLibraries

LinkCurrentLibraries

LinkLibrary

LinkLibrary LibraryName ?PathToLib?

Parameters

LibraryName:: Not documented.
PathToLib:: Not documented. Optional, default "".

LinkLibraryDirectory

LinkLibraryDirectory ?LibraryDirectory?

Parameters

LibraryDirectory:: Not documented. Optional, default "".

ListLibraries

ListLibraries

MergeCoverage

MergeCoverage SuiteName MergeName

Parameters

SuiteName:: Not documented.
MergeName:: Not documented.

NoNullRangeWarning

NoNullRangeWarning

OpenBuildHtml

OpenBuildHtml ?ParamBuildName?

Parameters

ParamBuildName:: Not documented. Optional, default "".

OpenIndex

OpenIndex

OsvvmLibraryPath

Make sure $PathToLib ends with VhdlLibraryDirectory/VhdlLibrarySubdirectory If it does not, fix it so it does.

OsvvmLibraryPath PathToLib

Parameters

PathToLib:: Not documented.

RemoveAllLibraries

RemoveAllLibraries

RemoveLibrary

RemoveLibrary LibraryName ?PathToLib?

Parameters

LibraryName:: Not documented.
PathToLib:: Not documented. Optional, default "".

RemoveLibraryDirectory

RemoveLibraryDirectory ?PathToLib?

Parameters

PathToLib:: Not documented. Optional, default "".

RemoveLocalLibraries

RemoveLocalLibraries

RunAllTests

RunAllTests ?TestFilePrefix? ?args?

Parameters

TestFilePrefix:: Not documented. Optional, default "".

RunTest

RunTest FileName ?SimName? ?args?

Parameters

FileName:: Not documented.
SimName:: Not documented. Optional, default "".

SetCoverageAnalyzeEnable

SetCoverageAnalyzeEnable ?Enable?

Parameters

Enable:: Not documented. Optional, default true.

SetCoverageAnalyzeOptions

SetCoverageAnalyzeOptions ?Options?

Parameters

Options:: Not documented. Optional, default "".

SetCoverageEnable

SetCoverageEnable ?Enable?

Parameters

Enable:: Not documented. Optional, default true.

SetCoverageSimulateEnable

SetCoverageSimulateEnable ?Enable?

Parameters

Enable:: Not documented. Optional, default true.

SetCoverageSimulateOptions

SetCoverageSimulateOptions ?Options?

Parameters

Options:: Not documented. Optional, default "".

SetDebugMode

SetDebugMode ?Options?

Parameters

Options:: Not documented. Optional, default true.

SetExtendedAnalyzeOptions

SetExtendedAnalyzeOptions ?Options?

Parameters

Options:: Not documented. Optional, default "".

SetExtendedElaborateOptions

SetExtendedElaborateOptions ?Options?

Parameters

Options:: Not documented. Optional, default "".

SetExtendedOptimizeOptions

SetExtendedOptimizeOptions ?Options?

Parameters

Options:: Not documented. Optional, default "".

SetExtendedRunOptions

SetExtendedRunOptions ?Options?

Parameters

Options:: Not documented. Optional, default "".

SetExtendedSimulateOptions

SetExtendedSimulateOptions ?Options?

Parameters

Options:: Not documented. Optional, default "".

SetInteractiveMode

SetInteractiveMode ?Options?

Parameters

Options:: Not documented. Optional, default true.

SetLibraryDirectory

SetLibraryDirectory ?LibraryDirectory?

Parameters

LibraryDirectory:: Not documented. Optional, default ..

SetLogSignals

SetLogSignals ?Options?

Parameters

Options:: Not documented. Optional, default true.

SetSaveWaves

SetSaveWaves ?Options?

Parameters

Options:: Not documented. Optional, default true.

SetSecondSimulationTopLevel

SetSecondSimulationTopLevel ?LibraryDotDesignUnit?

Parameters

LibraryDotDesignUnit:: Not documented. Optional, default "".

SetSimulatorResolution

SetSimulatorResolution SimulatorResolution

Parameters

SimulatorResolution:: Not documented.

SetTranscriptType

SetTranscriptType ?TranscriptType?

Parameters

TranscriptType:: Not documented. Optional, default html.

SetVerilogAnalyzeOptions

SetVerilogAnalyzeOptions ?Options?

Parameters

Options:: Not documented. Optional, default "".

SetVhdlAnalyzeOptions

SetVhdlAnalyzeOptions ?Options?

Parameters

Options:: Not documented. Optional, default "".

SetVHDLVersion

SetVHDLVersion Version

Parameters

Version:: Not documented.

simulate

simulate LibraryUnit ?args?

Parameters

LibraryUnit:: Not documented.

SkipTest

SkipTest ?FileName? ?Reason?

Parameters

FileName:: Not documented. Optional, default NotProvided.vhd.
Reason:: Not documented. Optional, default Not Provided.

StartTranscript

StartTranscript

StopTranscript

StopTranscript ?FileBaseName?

Parameters

FileBaseName:: Not documented. Optional, default "".

TestCase

TestCase Name

Parameters

Name:: Not documented.

TestName

TestName Name

Parameters

Name:: Not documented.

TestSuite

TestSuite SuiteName

Parameters

SuiteName:: Not documented.

TimeIt

TimeIt ?args?

Parameters

UnsetLibraryVars

UnsetLibraryVars