Appendix B: Tcl-Based Debugging

This appendix describes the Tcl-based simulator commands you can use to debug your design. Tcl is an object-oriented language, which means that you supply the action to be performed on the object as a modifier to the command.

The command format is

xcelium> Tcl_command [ -modifiers ] [-options] [arguments]

For information on the Tcl commands you can use with the Spectre ^® AMS Designer simulator, see the following table. Some commands are detailed here and have links to the respective topics. For commands that do not have a link, and for other commands you can use only with purely digital designs, see "Using the Tcl Command-Line Interface" in the Xcelium Simulator Tcl Command Reference.

Tcl Command	Description
`alias`	Defines aliases that you can use as command short-cuts.
`analog`	Controls the analog solver during mixed-signal simulation using AMS simulator with Spectre/APS solver.
`attribute`	Enables VHDL function-valued attributes for specified signals so that they can be accessed from the Tcl interface with the `value` command. The `attribute` command is enabled only for purely digital designs.
`call`	Lets you call a user-defined C-interface function or a Verilog user-defined PLI system task or function from the command line.
`coverage`	For purely digital designs, controls the dumping of code coverage data.
`database`	Lets you control an SHM or VCD database. An SHM database can hold both analog and digital databases. VCD databases do not support both analog and digital databases in a single database.
`deposit`	Lets you set the value of an object.
`describe`	Displays information about the specified simulation object, including its declaration.
`drivers`	Displays a list of all contributors to the value of the specified objects. When the simulator is stopped in a resolution function (`at_resfunc`), the TCL `drivers` command can be invoked without arguments. See at_resfunc.
`exit`	Terminates simulation and returns control to the operating system.
`finish`	Causes the simulator to exit and returns control to the operating system.
`fmibkpt`	Performs operations on breakpoints that are coded into C models using the `fmiBreakpoint` call.
`force`	Sets a specified object to a given value and forces it to retain that value until it is released with a release command or until another force is placed on it.
`help`	Displays information about simulator (`xmsim`) commands and options and predefined variable names and values.
`history`	Lets you re-execute commands without having to retype them.
`input`	Queues the commands in a file so that the simulator executes them when it issues its first prompt. This command is enabled only for purely digital designs.
`memory`	Loads VHDL memory from a memory file or dumps VHDL memory to a memory file. This command is disabled while the analog solver is active.
`omi`	Lets you display information about model managers and instances controlled by model managers. Also lets you pass OMI model manager run-time commands to model managers that support this capability.
`probe`	Lets you control the values being saved to a database.
`process`	Displays information about the processes that are currently executing or that are scheduled to execute at the current time. This command is disabled while the analog solver is active.
`release`	Releases any force set on the specified objects.
`reset`	Resets the currently loaded model to its original state at time zero. This command is enabled only for purely digital designs.
`restart`	Replaces the currently simulating snapshot with another snapshot of the same elaborated design. You cannot use `restart` after the current AMS simulation is started.
`run`	Starts simulation or resumes a previously halted simulation.
`save`	Creates a snapshot of the current simulation state.
`scope`	Lets you set the current debug scope, describe items declared within a scope, display the drivers of objects declared within a scope, list instances of auto-inserted connect modules within a scope, list resolved disciplines of all nets within a scope, print the source code, or part of the source code, for a scope, and display scope information.
`source`	Lets you execute a file containing simulator commands.
`stack`	Lets you view or set the current stack frame. This command is enabled only for purely digital designs.
`status`	Displays memory and CPU usage statistics and shows the current simulation time.
`stop`	Creates or operates on a breakpoint.
`strobe`	Writes out the values of objects under the control of specified conditions, changes in signal values, or at specified time intervals. This command can be used only for digital objects.
`task`	Lets you schedule Verilog-AMS tasks for execution. This command is disabled while the analog solver is active.
`time`	Displays the current simulation time scaled to the specified unit.
`value`	Prints the current value of the specified objects using the last format specifier preceding the object name argument. When the simulator is stopped in a resolution function (`at_resfunc`), the TCL `value` command can be invoked without arguments. See at_resfunc.
`version`	Displays the version number of `xmsim.`
`where`	Displays the current location of the simulation. When the simulator is stopped in a resolution function (`at_resfunc`), the TCL `where` command can be invoked without arguments. See at_resfunc.

Appendix B: Tcl-Based Debugging

Related Topics