Modelsim Se Ref

ModelSim SE Reference Manual
Software Version 6.4a
1991-2008 Mentor Graphics Corporation All rights reserved.

This document contains information that is proprietary to Mentor Graphics Corporation. The original recipient of this document may duplicate this document in whole or in part for internal business purposes only, provided that this entire notice appears in all copies. In duplicating any part of this document, the recipient agrees to make every reasonable effort to prevent the unauthorized use and distribution of the proprietary information.
This document is for information and instruction purposes. Mentor Graphics reserves the right to make changes in specifications and other information contained in this publication without prior notice, and the reader should, in all cases, consult Mentor Graphics to determine whether any changes have been made. The terms and conditions governing the sale and licensing of Mentor Graphics products are set forth in written agreements between Mentor Graphics and its customers. No representation or other affirmation of fact contained in this publication shall be deemed to be a warranty or give rise to any liability of Mentor Graphics whatsoever. MENTOR GRAPHICS MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS MATERIAL INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. MENTOR GRAPHICS SHALL NOT BE LIABLE FOR ANY INCIDENTAL, INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING BUT NOT LIMITED TO LOST PROFITS) ARISING OUT OF OR RELATED TO THIS PUBLICATION OR THE INFORMATION CONTAINED IN IT, EVEN IF MENTOR GRAPHICS CORPORATION HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. RESTRICTED RIGHTS LEGEND 03/97 U.S. Government Restricted Rights. The SOFTWARE and documentation have been developed entirely at private expense and are commercial computer software provided with restricted rights. Use, duplication or disclosure by the U.S. Government or a U.S. Government subcontractor is subject to the restrictions set forth in the license agreement provided with the software pursuant to DFARS 227.72023(a) or as set forth in subparagraph (c)(1) and (2) of the Commercial Computer Software - Restricted Rights clause at FAR 52.227-19, as applicable. Contractor/manufacturer is: Mentor Graphics Corporation 8005 S.W. Boeckman Road, Wilsonville, Oregon 97070-7777. Telephone: 503.685.7000 Toll-Free Telephone: 800.592.2210 Website: www.mentor.com SupportNet: supportnet.mentor.com/ Send Feedback on Documentation: supportnet.mentor.com/user/feedback_form.cfm
TRADEMARKS: The trademarks, logos and service marks ("Marks") used herein are the property of Mentor Graphics Corporation or other third parties. No one is permitted to use these Marks without the prior written consent of Mentor Graphics or the respective third-party owner. The use herein of a thirdparty Mark is not an attempt to indicate Mentor Graphics as a source of a product, but is intended to indicate a product from, or associated with, a particular third party. A current list of Mentor Graphics trademarks may be viewed at: www.mentor.com/terms_conditions/trademarks.cfm.
Table of Contents
Chapter 1 Syntax and Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Documentation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . File and Directory Pathnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Design Object Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Object Name Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SystemC Class, Structure, and Union Member Specification . . . . . . . . . . . . . . . . . . . . . . SystemVerilog Scope Resolution Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Escaping Brackets and Spaces in Array Slices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Environment Variables and Pathnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Name Case Sensitivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Extended Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Wildcard Characters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Filtering Wildcard Matching for Certain Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . Simulator Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Simulation Time Units. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Argument Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Shortcuts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command History Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Numbering Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VHDL Numbering Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Verilog Numbering Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . GUI_expression_format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Expression Typing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Expression Syntax. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Signal and Subelement Naming Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Grouping and Precedence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Concatenation of Signals or Subelements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Record Field Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Searching for Binary Signal Values in the GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 2 Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .main clear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . add button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . add dataflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . add list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . add memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . add testbrowser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . add watch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 15 16 16 16 17 18 19 21 21 22 22 22 22 24 24 25 26 26 27 27 28 29 29 30 35 35 35 37 37 41 54 55 56 58 60 65 67 68
ModelSim SE Reference Manual, v6.4a
Table of Contents
add wave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . add_cmdhelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . add_menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . add_menucb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . add_menuitem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . add_separator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . add_submenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . batch_mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . bd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . bookmark add wave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . bookmark delete wave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . bookmark goto wave. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . bookmark list wave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . bp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cd. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . cdbg. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . change_menu_cmd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . check contention add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . check contention config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . check contention off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . check float add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . check float config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . check float off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . check stable off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . check stable on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . checkpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare annotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare continue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare end . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare reload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare savediffs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare saverules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare see. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare start. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . compare update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . context. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4
70 77 78 80 82 84 85 86 87 88 89 91 92 93 94 100 101 104 107 108 110 111 112 113 114 115 116 117 119 124 125 127 129 130 131 132 134 135 139 140 141 142 143 144 146 148 149 150 155
Table of Contents
coverage attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . coverage clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . coverage exclude. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . coverage goal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . coverage open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . coverage report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . coverage save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . coverage testnames . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . coverage weight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dataset alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dataset clear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dataset close . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dataset config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dataset current . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dataset info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dataset list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dataset open. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dataset rename. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dataset restart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dataset save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dataset snapshot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . describe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . disablebp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . disable_menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . disable_menuitem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . do. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . down . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . dumplog64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . echo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . enablebp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . enable_menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . enable_menuitem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . examine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . exit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . find infiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . find insource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . formatTime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . force . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . gdb dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . getactivecursortime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . getactivemarkertime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . jobspy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
157 160 162 168 170 171 178 180 181 183 184 185 186 187 188 189 190 191 192 193 194 196 197 198 199 200 201 202 204 205 206 207 208 209 210 211 213 218 219 224 225 226 227 231 232 233 234 235 236
5
Table of Contents
layout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . lecho . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . left . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . lshift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . lsublist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mem compare . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mem display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mem list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mem load. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mem save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . mem search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . messages clearfilter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . messages setfilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . modelsim. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . noforce . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . nolog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . notepad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . noview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . nowhen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . onbreak . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . onElabError. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . onerror. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pop. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . power add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . power off. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . power on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . power report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . power reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . precision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . printenv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . process report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . profile clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . profile interval. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . profile off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . profile on. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . profile option. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . profile reload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . profile report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . property list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . property wave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . push . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . pwd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . quietly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . qverilog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6
237 238 239 241 244 245 246 247 249 250 253 255 258 259 260 261 262 263 265 266 267 268 270 271 272 273 274 276 278 280 283 284 285 286 287 288 289 290 291 292 293 296 298 300 302 303 304 305 306
Table of Contents
radix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . radix define . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . radix names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . radix list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . radix delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . readers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . restart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . resume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . right . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . runStatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sccom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . scgenmod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . sdfcom. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . searchlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . see . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . seetime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . setenv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . shift . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . simstats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . stop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . suppress. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tcheck_set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tcheck_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . toggle add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . toggle disable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . toggle enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . toggle report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . toggle reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tr color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tr order. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tr uid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . transcribe. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . transcript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . transcript file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tssi2mti . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . typespec. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ui_VVMode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . unsetenv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . up. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd add . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
308 310 312 313 314 315 316 318 320 321 322 324 326 328 334 337 338 341 343 344 345 346 347 348 350 351 352 353 354 355 358 360 363 366 367 368 370 371 374 376 378 379 380 381 382 383 384 385 387
7
Table of Contents
vcd checkpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd comment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd dumpports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd dumpportsall. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd dumpportsflush. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd dumpportslimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd dumpportsoff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd dumpportson. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd flush . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd on . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcd2wlf . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcover attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcover merge. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcover ranktest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcover report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcover stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vcover testnames. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vdel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vencrypt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . verror. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vgencomp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . view. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual define . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual delete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual describe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual expand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual hide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual nohide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual nolog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual region. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual show. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual signal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . virtual type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vlib . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vlog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vmake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vopt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vsim. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
8
389 390 391 393 394 395 396 397 398 400 402 403 404 405 406 407 422 424 428 431 438 440 441 443 446 448 450 452 455 456 457 458 459 460 463 464 466 467 469 470 471 472 475 477 479 500 502 503 522
Table of Contents
vsim<info> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vsim_break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vsource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . wave . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . wave create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . wave edit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . wave export. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . wave import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . wave modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . when . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . where. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . wlf2log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . wlf2vcd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . wlfman . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . wlfrecover . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . write cell_report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . write format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . write list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . write preferences. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . write report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . write timing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . write transcript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . write tssi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . write wave. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xml2ucdb. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 3 AVM Encyclopedia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Class Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Classes for Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_env . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_named_component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_random_stimulus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_stimulus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_threaded_component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_verification_component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Classes for Comparators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_algorithmic_comparator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_in_order_built_in_comparator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_in_order_class_comparator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_in_order_comparator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Classes for Connectors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_*_export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_*_imp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_*_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_analysis_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_blocking_master_imp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
551 552 553 554 558 561 564 565 566 569 576 577 580 581 585 586 587 589 590 591 593 594 595 597 599 603 603 608 609 611 616 618 619 620 621 621 623 625 626 627 629 630 632 634 636 637
Table of Contents
avm_blocking_slave_imp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_connector_base. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_master_imp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_nonblocking_master_imp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_nonblocking_slave_imp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_port_base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_slave_imp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_transport_imp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . analysis_imp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . analysis_port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . global_analysis_ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_*_imp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Classes for Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . analysis_fifo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_fifo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_req_rsp_channel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_transport_channel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TLM Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . analysis_if #(type T=int) . . . . . . . . . . . . . . . . . . . . . . . . tlm_blocking_get_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_blocking_get_peek_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_blocking_peek_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_blocking_put_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_blocking_master_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_blocking_slave_if. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_get_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_get_peek_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_master_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_nonblocking_get_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_nonblocking_get_peek_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_nonblocking_master_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_nonblocking_peek_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_nonblocking_put_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_nonblocking_slave_if. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_peek_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_put_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_slave_if. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . tlm_transport_if. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_built_in_clone. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_built_in_comp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_built_in_converter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_built_in_pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_class_clone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_class_comp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_class_converter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_class_pair . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10
639 641 645 647 649 651 653 655 656 657 658 659 659 661 662 665 668 668
669
670 671 672 673 674 675 676 677 679 681 682 683 685 686 687 689 690 691 693 693 694 695 696 697 698 699 700 701 702 703
Table of Contents
avm_report_client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_report_handler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_report_server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . avm_reporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index End-User License Agreement
704 709 712 714
11
List of Examples
Example 1-1. Base- and Descendant-Class Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . Example 1-2. SystemVerilog Scope Resolution Operator Example . . . . . . . . . . . . . . . . . . . 17 19
12
List of Figures
Figure 2-1. find infiles Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Figure 2-2. find insource Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Figure 3-1. UML Diagram for Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Figure 3-2. UML Diagram for Comparator Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Figure 3-3. UML Diagram for Connectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Figure 3-4. UML Diagram for Channels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Figure 3-5. UML Diagram for Reporting Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224 225 608 622 629 660 703
13
List of Tables
Table 1-1. Conventions for Command Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 1-2. Examples of Object Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 1-3. Wildcard Characters in HDL Object Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 1-4. Arguments for the WildcardFilter Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 1-5. Keyboard Shortcuts for Command History . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 1-6. VHDL Number Conventions: Style 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 1-7. VHDL Number Conventions: Style 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 1-8. Verilog Number Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 1-9. Constants Supported for GUI Expresssions . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 1-10. Array Constants Supported for GUI Expresssions . . . . . . . . . . . . . . . . . . . . . . Table 1-11. Variables Supported for GUI Expresssions . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 1-12. Array Variables Supported for GUI Expresssions . . . . . . . . . . . . . . . . . . . . . . Table 1-13. Operators Supported for GUI Expresssions . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 1-14. Casting Conversions Supported for GUI Expresssions . . . . . . . . . . . . . . . . . . . Table 1-15. VHDL Logic Values Used in GUI Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 1-16. Verilog Logic Values Used in GUI Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 2-1. Supported Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 2-2. Comparing Reference Objects to Test Objects . . . . . . . . . . . . . . . . . . . . . . . . . . Table 2-3. runStatus Command States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 2-4. runStatus -full Command Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 2-5. Field Arguments for Window Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 2-6. Output Fields for tcheck_status Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 2-7. Warning Message Categories for vcom -nowarn . . . . . . . . . . . . . . . . . . . . . . . . Table 2-8. Order and Type of Ranked Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 2-9. Design Unit Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 2-10. Warning Message Categories for vlog -nowarn . . . . . . . . . . . . . . . . . . . . . . . . Table 2-11. Warning Message Categories for vopt -nowarn . . . . . . . . . . . . . . . . . . . . . . . . Table 2-12. Wave Window Commands for Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 2-13. Wave Window Commands for Zooming . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 2-14. Wave Window Commands for Controlling Display . . . . . . . . . . . . . . . . . . . . . Table 2-15. Wave Window Commands for Expanded Time Display . . . . . . . . . . . . . . . . . Table 3-1. Class Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 3-2. Exports and Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 3-3. Interface Implementations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 3-4. Ports and Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table 3-5. Deprecated Implementations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 20 22 23 26 27 28 28 30 31 31 32 33 34 38 38 41 119 326 326 338 359 417 428 443 493 517 554 554 554 555 603 630 633 634 659
14
Chapter 1 Syntax and Conventions

Documentation Conventions
This manual uses the following conventions to define ModelSim command syntax. Table 1-1. Conventions for Command Syntax Syntax notation < > Description angled brackets surrounding a syntax item indicate a user-defined argument; do not enter the brackets in commands square brackets generally indicate an optional item; if the brackets surround several words, all must be entered as a group; the brackets are not entered1 braces indicate that the enclosed expression contains one or more spaces yet should be treated as a single argument, or that the expression contains square brackets for an index; for either situation, the braces are entered an ellipsis indicates items that may appear more than once; the ellipsis itself does not appear in commands the vertical bar indicates a choice between items on either side of it; do not include the bar in the command monospaced type is used in command examples comments included with commands are preceded by the number sign (#); useful for adding comments to DO files (macros)
1. One exception to this rule is when you are using Verilog syntax to designate an array slice. For example, add wave {vector1[4:0]} The square brackets in this case denote an index. The braces prevent the Tcl interpreter from treating the text within the square brackets as a Tcl command.
| monospaced type #
Note Neither the prompt at the beginning of a line nor the <Enter> key that ends a line is shown in the command examples.
15
Syntax and Conventions File and Directory Pathnames
File and Directory Pathnames

Several ModelSim commands have arguments that point to files or directories. For example, the -y argument to vlog specifies the Verilog source library directory to search for undefined modules. Spaces in file pathnames must be escaped or the entire path must be enclosed in quotes. For example:
vlog top.v -y C:/Documents\ and\ Settings/projects/dut
or
vlog top.v -y "C:/Documents and Settings/projects/dut"
Design Object Names

Design objects are organized hierarchically. Each of the following objects creates a new level in the hierarchy: VHDL component instantiation statement, block statement, and package Verilog module instantiation, named fork, named begin, task and function SystemVerilog class, package, program, and interface SystemC module instantiation
Object Name Syntax

The syntax for specifying object names in ModelSim is as follows:
[<datasetName><datasetSeparator>][<pathSeparator>][<hierarchicalPath>] <objectName>[<elementSelection>]
where datasetName is the logical name of the WLF file in which the object exists. The currently active simulation is the sim dataset. Any loaded WLF file is referred to by the logical name specified when the WLF file was loaded. Refer to the chapter Recording Simulation Results With Datasets in the Users Manual for more information. datasetSeparator is the character used to terminate the dataset name. The default is :, though a different character (other than \) may be specified as the dataset separator via the DatasetSeparator variable in the modelsim.ini file. The default is ':'. This character must be different than the pathSeparator character. pathSeparator is the character used to separate hierarchical object names. Normally, '/' is used for VHDL and '.' is used for Verilog, although other characters (except '\') may be specified via the PathSeparator variable in the modelsim.ini file. This character must
16
be different than the datasetSeparator. Both '.' and '/' can be used for SystemC. Neither '.' or '/' can be used when referring to the contents of a SystemVerilog package or class. hierarchicalPath is a set of hierarchical instance names separated by a path separator and ending in a path separator prior to the objectName. For example, /top/proc/clk. objectName is the name of an object in a design. elementSelection indicates some combination of the following:
o
Array indexing Single array elements are specified using either parentheses "()" or square brackets "[]" around a single number. Array slicing Slices (or part-selects) of arrays are specified using either parentheses "()" or square brackets "[]" around a range specification. A range is two numbers separated by one of the following: " to ", " downto ", ":". See Escaping Brackets and Spaces in Array Slices for important information about using square brackets in ModelSim commands. Record field selection A record field is specified using a period "." followed by the name of the field. C++ class, structure, and union member selection A class, structure, or union member is specified using the record field specification syntax, described just above.
SystemC Class, Structure, and Union Member Specification

You can specify members of SystemC structures and classes using HDL record syntax. The syntax for specifying members of a base class using ModelSim is different than C++. In C++, it is not necessary to specify the base class:
<instance>.<base_member>
Whereas, in ModelSim you must include the name of the base class:
<instance>.<base>.<base_member>
Example 1-1. Base- and Descendant-Class Specification Lets say you have a base class and a descendant class:
class dog { private: int value; };
17
Syntax and Conventions File and Directory Pathnames class beagle : public dog { private: int value; dog d; };
You have an sc_signal<> of type beagle somewhere in your code:

sc_signal<beagle> spot;
Legal names for viewing this signal are:

spot spot.* spot.value spot.dog spot.dog.* spot.dog.value
Now, to examine the member value of the base class dog, you would type:
exa spot.dog.value
To examine the member value of member d, you would type:

exa spot.d.value
To examine the member value, you would type:

exa spot.value
SystemVerilog Scope Resolution Operator

SystemVerilog offers the scope resolution operator :: for accessing classes within a package and static data within a class. The example below shows various methods of using this operator as well as alternatives using standard hierarchical references.
18
Example 1-2. SystemVerilog Scope Resolution Operator Example

package myPackage; class packet; static int a[0:1] = {1, 2}; int b[0:1]; int c; function new; b[0] = 3; b[1] = 4; c = a[0]; endfunction endclass endpackage : myPackage module top; myPackage::packet my = new; int myint = my.a[1]; endmodule
The following examine examples access data from the class packet.
examine myPackage::packet::a examine /top/my.a
Both of the above commands return the contents of the static array a within class packet.
examine myPackage::packet::a(0) examine /top/my.a(0)
Both of the above commands return the contents of the first element of the static array a within class packet.
examine /top/my.b
Return the contents of the instance-specific array b.

examine /top/my.b(0)
Return the contents of the first element of the instance-specific array b. When referring to the contents of a package or class, you cannot use the standard path separators . or /.
Specifying Names
We distinguish between four "types" of object names: simple, relative, fully-rooted, and absolute. A simple name does not contain any hierarchy. It is simply the name of an object (e.g., clk or data[3:0]) in the current context.
19
A relative name does not start with a path separator and may or may not include a dataset name or a hierarchical path (e.g., u1/data or view:clk). A relative name is relative to the current context in the current or specified dataset. A fully-rooted name starts with a path separator and includes a hierarchical path to an object (e.g., /top/u1/clk).There is a special case of a fully-rooted name where the top-level design unit name can be unspecified (e.g., /u1/clk). In this case, the first top-level instance in the design is assumed. An absolute name is an exactly specified hierarchical name containing a dataset name and a fully rooted name (e.g., sim:/top/u1/clk). The current dataset is used when accessing objects where a dataset name is not specified as part of the name. The current dataset is determined by the dataset currently selected in the Structure window or by the last dataset specified in an environment. The current context in the current or specified dataset is used when accessing objects with relative or simple names. The current context is either the current process, if any, or the current instance if there is no current process or the current process is not in the current instance. The situation of the current process not being in the current instance can occur, for example, by selecting a different instance in the Structure tab or by using the environment to set the current context to a different instance. Table 1-2 contains examples of various ways of specifying object names. Table 1-2. Examples of Object Names Object Name clk /top/clk /top/block1/u2/clk block1/u2/clk array_sig[4] Description specifies the object clk in the current context specifies the object clk in the top-level design unit. specifies the object clk, two levels down from the top-level design unit specifies the object clk, two levels down from the current context specifies an index of an array object
{array_sig(1 to 10)} specifies a slice of an array object in VHDL or SystemC; see Escaping Brackets and Spaces in Array Slices for more information {mysignal[31:0]} specifies a slice of an array object in Verilog or SystemC; see Escaping Brackets and Spaces in Array Slices for more information specifies a field of a record, a C++ class or structure member, or a C++ base class
record_sig.field
20
Escaping Brackets and Spaces in Array Slices

Because ModelSim is a Tcl-based tool, you must use curly braces ({}) to "escape" square brackets and spaces when specifying array slices. For example:
toggle add {data[3:0]} toggle add {data(3 to 0)}
For complete details on Tcl syntax, refer to Tcl Command Syntax.
Further Details
As a Tcl-based tool, ModelSim commands follow Tcl syntax. One problem people encounter with ModelSim commands is the use of square brackets ([]) or spaces when specifying array slices. As shown on the previous page, square brackets are used to specify slices of arrays (e.g., data[3:0]). However, in Tcl, square brackets signify command substitution. Consider the following example:
set aluinputs [find -in alu/*]
ModelSim evaluates the find command first and then sets variable aluinputs to the result of the find command. Obviously you dont want this type of behavior when specifying an array slice, so you would use curly brace escape characters:
add wave {/s/abc/data_in[10:1]}
You must also use the escape characters if using VHDL syntax with spaces:
add wave {/s/abc/data_in(10 downto 1)}
Environment Variables and Pathnames

You can substitute environment variables for pathnames in any argument that requires a pathname. For example:
vlog -v $lib_path/und1
Assuming you have defined $lib_path on your system, vlog will locate the source library file und1 and search it for undefined modules. Refer to Environment Variables for more information. Note Environment variable expansion does not occur in files that are referenced via the -f argument to vcom, vlog, or vsim.
21
Syntax and Conventions Wildcard Characters
Name Case Sensitivity

Name case sensitivity is different for VHDL and Verilog. VHDL names are not case sensitive except for extended identifiers in VHDL 1076-1993 or later. In contrast, all Verilog names are case sensitive. Names in ModelSim commands are case sensitive when matched against case sensitive identifiers, otherwise they are not case sensitive. SystemC names are case sensitive.
Extended Identifiers
The following are supported formats for extended identifiers for any command that takes an identifier.
{\ext ident!\ } # Note that trailing space before closing brace is required \\ext\ ident\!\\ # All non-alpha characters escaped
Wildcard Characters
Wildcard characters can be used in HDL object names in some simulator commands. Table 1-3 shows the conventions for allowable wildcard characters. Table 1-3. Wildcard Characters in HDL Object Names Character Syntax * ? [] Description matches any sequence of characters matches any single character matches any one of the enclosed characters; a hyphen can be used to specify a range (for example, a-z, A-Z, 0-9); can be used only with the find command
Filtering Wildcard Matching for Certain Commands

By default certain commands do not add all objects that match a wildcard pattern. For example, the add wave command does not add VHDL variables or Verilog memories by default because this can use a lot of resources. For example, "add log -r *" will not log process variables, even if you change the WildcardFilter preference variable, because the filter only applies to variables in packages and design units. To use wildcards for other variables, you must specify an explicit path to the process in the log command, such as "add log /proc_test/p1/*".
22
Syntax and Conventions Wildcard Characters
Note A wildcard character does not match a path separator. For example, /dut/* will match /dut/siga and /dut/clk. However, /dut* will not match either of those.
WildcardFilter Preference Variable

The WildcardFilter preference variable allows you to specify the object types to exclude when performing wildcard matches. The settings will be applied only to variables in packages and design units. See Filtering Wildcard Matching for Certain Commands for more information. The WildcardFilter variable applies to the commands add dataflow, add list, add memory, add watch, add wave, find, and log. You can view the current settings by entering the following at the command prompt:
> set WildcardFilter
This returns a space-separated list of the current values. The default setting returns the following:
> set WildcardFilter # Variable Constant Generic Parameter SpecParam Memory CellInternal
You can change the settings by specifying a space-separated list of values enclosed in quotation marks ("). For example:
set WildcardFilter "signal constant net reg"
Table 1-4 lists all the legal argument values for the WildcardFilter variable. Table 1-4. Arguments for the WildcardFilter Variable Argument Value Alias CellInternal Excluded Object Types VHDL alias Signals in cells, where a cell is defined as: a module within a celldefine a Verilog module found with a library search (using either vlog -v or vlog -y) and compiled with vlog +libcell a module containing a specify block SystemVerilog Class Reference VHDL constant VHDL generic Yes Yes Yes By default?
ClassReference Constant Generic
23
Syntax and Conventions Simulator Variables
Table 1-4. Arguments for the WildcardFilter Variable Argument Value ImmediateAssert Integer Memory NamedEvent Net None Parameter Real Reg Signal SpecParam Time Variable Excluded Object Types VHDL immediate assertions VHDL integer Verilog memories Verilog named event Verilog net No items are filtered out Verilog parameter Verilog real registers Verilog Register VHDL signal Verilog specparam Verilog time registers VHDL shared variables in packages and design units. Yes Yes Yes By default? Yes
Simulator Variables
ModelSim variables can be referenced in simulator commands by preceding the name of the variable with the dollar sign ($) character. ModelSim uses global variables for simulator state variables, simulator control variables, simulator preference variables, and user-defined variables. Refer to Simulator State Variables in the Users Manual for more information on variables. The report command returns a list of current settings for either the simulator state or simulator control variables.
Simulation Time Units

You can specify the time unit for delays in all simulator commands that have time arguments. For example:
force clk 1 50 ns, 1 100 ns -repeat 1 us run 2 ms
Note that all the time units in a ModelSim command need not be the same.
24
Syntax and Conventions Argument Files
Unless you specify otherwise as in the examples above, simulation time is always expressed using the resolution units that are specified by the UserTimeUnit variable. By default, the specified time units are assumed to be relative to the current time unless the value is preceded by the character @, which signifies an absolute time specification.
Argument Files
You can load additional arguments into some commands by using argument files, which are specified with the -f argument. The following commands support the -f argument:
vlog vcom sccom vopt vsim
The -f <filename> argument specifies a file that contains additional command line arguments. The following sections outline some syntax rules for argument files. Single Quotes allows you to group arbitrary characters so that no character substitution occurs within the quotes, such as environment variable expansion or escaped characters.
+acc=rn+'\mymodule //does not treat the \ as an escape character
Double Quotes allows you to group arbitrary characters so that Tcl-style backslash substitution and environment variable expansion is performed.
+acc=rn+"\\mymodule\\$VAR" // escapes the path separators (\) and substitues // your value of $VAR
Unquoted the following are notes on what occurs when some information is not quoted:
o
Tcl backslash substitution any unquoted backslash (\) will be treated as an escape character.
+acc=rn\\mymodule // the leading '\' is considered an escape character
Environment variable expansion any unquoted environment variable, such as $envname, will be expanded. You can also use curly braces in your environment variable, such as ${envname}.
+acc=rn\\$MODULE // the leading '\' is considered an escape character and the // variable $MODULE is expanded
Newline Character you can specify arguments on separate lines in the argument file, with the newline characters treated as space characters. There is no need to put '\' at the end of each line.
25
Syntax and Conventions Command Shortcuts
Comments Comments within the argument files follow these rules:

o o
All text in a line beginning with // to its end is treated as a comment. All text bracketed by /* */ is treated as a comment.
Command Shortcuts
You may abbreviate command syntax, but theres a catch the minimum number of characters required to execute a command are those that make it unique. Remember, as we add new commands some of the old shortcuts may not work. For this reason ModelSim does not allow command name abbreviations in macro files. This minimizes your need to update macro files as new commands are added. Multiple commands may be entered on one line if they are separated by semi-colons (;). For example:
ModelSim> vlog -nodebug=ports level3.v level2.v ; vlog -nodebug top.v
The return value of the last function executed is the only one printed to the transcript. This may cause some unexpected behavior in certain circumstances. Consider this example:
vsim -c -do "run 20 ; simstats ; quit -f" top
You probably expect the simstats results to display in the Transcript window, but they will not, because the last command is quit -f. To see the return values of intermediate commands, you must explicitly print the results. For example:
vsim -do "run 20 ; echo [simstats]; quit -f" -c top
Command History Shortcuts

You can review simulator command history or rerun previous commands by using keyboard shortcuts at the ModelSim/VSIM prompt. Table 1-5 contains a list of these shortcuts. Table 1-5. Keyboard Shortcuts for Command History Shortcut !! !n !abc ^xyzâb^ Description repeats the last command repeats command number n; n is the VSIM prompt number (e.g., for this prompt: VSIM 12>, n =12) repeats the most recent command starting with "abc" replaces "xyz" in the last command with "ab"
up and down arrows scrolls through the command history with the keyboard arrows
26
Syntax and Conventions Numbering Conventions
Table 1-5. Keyboard Shortcuts for Command History Shortcut click on prompt Description left-click once on a previous ModelSim or VSIM prompt in the transcript to copy the command typed at that prompt to the active cursor shows the last few commands (up to 50 are kept)
his or history
Numbering Conventions
Numbers in ModelSim can be expressed in either VHDL or Verilog style. You can use two styles for VHDL numbers and one for Verilog.
VHDL Numbering Conventions

There are two types of VHDL number styles:
VHDL Style 1
[ - ] [ radix # ] value [ # ]
Table 1-6. VHDL Number Conventions: Style 1 Element radix value # Description indicates a negative number; optional can be any base in the range 2 through 16 (2, 8, 10, or 16); by default, numbers are assumed to be decimal; optional specifies the numeric value, expressed in the specified radix; required is a delimiter between the radix and the value; the first # sign is required if a radix is used, the second is always optional
A - can also be used to designate a "dont care" element when you search for a signal value or expression in the List or Wave window. If you want the - to be read as a "dont care" element, rather than a negative sign, be sure to enclose the number in double quotes. For instance, you would type "-0110--" as opposed to -0110--. If you dont include the double quotes, ModelSim will read the - as a negative sign. For example:
16#FFca23# 2#11111110 -23749
27
Syntax and Conventions Numbering Conventions
VHDL Style 2
base "value"
Table 1-7. VHDL Number Conventions: Style 2 Element base "value" For example:
B"11111110" X"FFca23"
Description specifies the base; binary: B, octal: O, hex: X; required specifies digits in the appropriate base with optional underscore separators; default is decimal; required
Searching for VHDL Arrays in the Wave and List Windows

Searching for signal values in the Wave or List window may not work correctly for VHDL arrays if the target value is in decimal notation. You may get an error that the value is of incompatible type. Since VHDL does not have a radix indicator for decimal, the target value may get misinterpreted as a scalar value. Prefixing the value with the Verilog notation 'd should eliminate the problem, even if the signal is VHDL.
Verilog Numbering Conventions

Verilog numbers are expressed in the style:
[ - ] [ size ] [ base ] value
Table 1-8. Verilog Number Conventions Element size base value Description indicates a negative number; optional the number of bits in the number; optional specifies the base; binary: b or B, octal: o or O, decimal: d or D, hex: h or H; optional specifies digits in the appropriate base with optional underscore separators; default is decimal; required
A - can also be used to designate a "dont care" element when you search for a signal value or expression in the List or Wave windows. If you want the - to be read as a "dont care" element, rather than a negative sign, be sure to enclose the number in double quotes. For instance, you would type "-0110--" as opposed to 7'b-0110--. If you dont include the double quotes, ModelSim will read the - as a negative sign. For example:
28
Syntax and Conventions GUI_expression_format b11111110 Hffca23 -23749 8b11111110 21H1fca23
GUI_expression_format
The GUI_expression_format is an option of several simulator commands that operate within the ModelSim GUI environment. The expressions help you locate and examine objects within the List and Wave windows (expressions may also be used through the Edit > Search menu in both windows). The commands that use the expression format are: compare add, compare clock, compare configure, configure, examine, searchlog, virtual function, virtual signal down, left, right, up
Expression Typing
GUI expressions are typed. The supported types consist of the following scalar and array types.
Scalar Types
The scalar types are as follows: boolean, integer, real, time (64-bit integer), enumeration, and signal state. Signal states are represented by the nine VHDL std_logic states: U X 0 1 Z W L H and -. Verilog states 0, 1, x, and z are mapped into these states and the Verilog strengths are ignored. Conversion is done automatically when referencing Verilog nets or registers. SystemC scalar types supported are: all the C/C++ types except class, structure, union, and array, as well as SystemC types sc_logic and sc_bit.
Array Types
The supported array types are signed and unsigned arrays of signal states. This would correspond to the VHDL std_logic_array type. Verilog registers are automatically converted to these array types. The array type can be treated as either UNSIGNED or SIGNED, as in the IEEE std_logic_arith package. Normally, referencing a signal array causes it to be treated as UNSIGNED by the expression evaluator; to cause it to be treated as SIGNED, use casting as described below. Numeric operations supported on arrays are performed by the expression evaluator via ModelSims built-in numeric_standard (and similar) package routines. The expression evaluator selects the appropriate numeric routine based on SIGNED or UNSIGNED properties of the array arguments and the result. The enumeration types supported are any VHDL enumerated type. Enumeration literals may be used in the expression as long as some variable of that enumeration type is referenced in the expression. This is useful for sub-expressions of the form:
29
Syntax and Conventions GUI_expression_format (/memory/state == reading)
The supported SystemC aggregate types are the C/C++ array types: union, class, structure, and array. Also supported are the SystemC array types: sc_bv<w>, sc_lv<w>, sc_int<w>, etc.
Expression Syntax
GUI expressions generally follow C-language syntax, with both VHDL-specific and Verilogspecific conventions supported. These expressions are not parsed by the Tcl parser, and so do not support general Tcl; parentheses should be used rather than braces. Procedure calls are not supported. A GUI expression can include the following elements: Tcl macros, constants, array constants, variables, array variables, signal attributes, operators, and casting.
Tcl Macros
Macros are useful for pre-defined constants or for entire expressions that have been previously saved. The substitution is done only once, when the expression is first parsed. Macro syntax is:
$<name>
Substitutes the string value of the Tcl global variable <name>.
Constants
Table 1-9. Constants Supported for GUI Expresssions Type boolean value integer real number time enumeration single bit constants Values true false TRUE FALSE [0-9]+ <int>|([<int>].<int>[exp]) where the optional [exp] is: (e|E)[+|-][09]+ integer or real optionally followed by time unit VHDL user-defined enumeration literal expressed as any of the following: 0 1 x X z Z U H L W U X 0 1 Z W L H - 1b0 1b1
30
Syntax and Conventions GUI_expression_format
Array Constants, Expressed in Any of the Following Formats

Table 1-10. Array Constants Supported for GUI Expresssions Type VHDL # notation VHDL bitstring Verilog notation Values <int>#<alphanum>[#] Example: 16#abc123# "(U|X|0|1|Z|W|L|H|-)*" Example: "11010X11" [-][<int>](b|B|o|O|d|D|h|H) <alphanum> (where <alphanum> includes 0-9, a-f, A-F, and -) Example: 12hc91 (This is the preferred notation because it removes the ambiguity about the number of bits.) 0x, 0X, 0o, 0O, 0b, OB ModelSim automatically zero fills unspecified upper bits.
Based notation
Variables
Table 1-11. Variables Supported for GUI Expresssions Variable Name of a signal Type The name may be a simple name, a VHDL or Verilog style extended identifier, or a VHDL or Verilog style path. The signal must be one of the following types: -- VHDL signal of type INTEGER, REAL, or TIME -- VHDL signal of type std_logic or bit -- VHDL signal of type user-defined enumeration -- Verilog net, Verilog register, Verilog integer, or Verilog real -- SystemC primitive channels of type scalar (e.g. bool, int, etc.) Returns the value of time at the current location in the WLF file as the WLF file is being scanned (not the most recent simulation time).
NOW
31
Array variables
Table 1-12. Array Variables Supported for GUI Expresssions Variable Name of a signal Type -- VHDL signals of type bit_vector or std_logic_vector -- Verilog register -- Verilog net array -- SystemC primitive channels of type vector (e.g. sc_bv, sc_int, etc.) A subrange or index may be specified in either VHDL or Verilog syntax. Examples: mysignal(1 to 5), mysignal[1:5], mysignal (4), mysignal [4]
Signal attributes
<name>event <name>rising <name>falling <name>delayed() <name>hasX
The delayed attribute lets you assign a delay to a VHDL signal. To assign a delay to a signal in Verilog, use # notation in a sub-expression (e.g., #-10 /top/signalA). The hasX attribute lets you search for signals, nets, or registers that contains an X (unknown) value. See Examples of Expression Syntax below for further details on delayed and hasX.
32
Operators
Table 1-13. Operators Supported for GUI Expresssions Operator && || ! == != === !== < <= > >= not/NOT/~ and/AND/& nand/NAND or/OR/| nor/NOR xor/XOR xnor/XNOR Description boolean and boolean or boolean not equal not equal exact equal1 exact not equal1 less than less than or equal greater than greater than or equal unary bitwise inversion bitwise and bitwise nand bitwise or bitwise nor bitwise xor bitwise xnor Operator sll/SLL sla/SLA srl/SRL sra/SRA ror/ROR rol/ROL + * / mod/MOD rem/REM Description shift left logical shift left arithmetic shift right logical shift right arithmetic rotate right rotate left arithmetic add arithmetic subtract arithmetic multiply arithmetic divide arithmetic modulus arithmetic remainder
|<vector_expr> OR reduction ^<vector_expr> XOR reduction
1. This operator is allowed to be compatible with other simulators.
Note Arithmetic operators use the std_logic_arith package.
33
Casting
Table 1-14. Casting Conversions Supported for GUI Expresssions Casting (bool) (boolean) (int) (integer) (real) (time) (std_logic) (signed) (unsigned) (std_logic_vector) Description convert to boolean convert to boolean convert to integer convert to integer convert to real convert to 64-bit integer convert to 9-state signal value convert to signed vector convert to unsigned vector convert to unsigned vector
Examples of Expression Syntax

/top/bus & $bit_mask
This expression takes the bitwise AND function of signal /top/bus and the array constant contained in the global Tcl variable bit_mask.
clkevent && (/top/xyz == 16hffae)
This expression evaluates to a boolean true when signal clk changes and signal /top/xyz is equal to hex ffae; otherwise is false.
clkrising && (mystate == reading) && (/top/u3/addr == 32habcd1234)
Evaluates to a boolean true when signal clk just changed from low to high and signal mystate is the enumeration reading and signal /top/u3/addr is equal to the specified 32-bit hex constant; otherwise is false.
(/top/u3/addr and 32hff000000) == 32hac000000
Evaluates to a boolean true when the upper 8 bits of the 32-bit signal /top/u3/addr equals hex ac.
/top/signalA'delayed(10ns)
This expression returns /top/signalA delayed by 10 ns.

/top/signalA'delayed(10 ns) && /top/signalB
This expression takes the logical AND of a delayed /top/signalA with /top/signalB.
34
Syntax and Conventions GUI_expression_format virtual function { (#-10 /top/signalA) && /top/signalB} mySignalB_AND_DelayedSignalA
This evaluates /top/signalA at 10 simulation time steps before the current time, and takes the logical AND of the result with the current value of /top/signalB. The '#' notation uses positive numbers for looking into the future, and negative numbers for delay. This notation does not support the use of time units.
((NOW > 23 us) && (NOW < 54 us)) && clkrising && (mode == writing)
Evaluates to a boolean true when WLF file time is between 23 and 54 microseconds, clk just changed from low to high, and signal mode is enumeration writing.
searchlog -expr {dbus'hasX} {0 ns} dbus
Searches for an X in dbus. This is equivalent to the expression: {dbus(0) == 'x' || dbus(1) == 'x'} . . .. This makes it possible to search for X values without having to write a type specific literal.
Signal and Subelement Naming Conventions

ModelSim supports naming conventions for VHDL and Verilog signal pathnames, VHDL array indexing, Verilog bit selection, VHDL subrange specification, and Verilog part selection. All supported naming conventions for VHDL and Verilog are valid for SystemC designs. Examples in Verilog and VHDL syntax:
top.chip.vlogsig /top/chip/vhdlsig vlogsig[3] vhdlsig(9) vlogsig[5:2] vhdlsig(5 downto 2)
Grouping and Precedence

Operator precedence generally follows that of the C language, but we recommend liberal use of parentheses.
Concatenation of Signals or Subelements

Elements in the concatenation that are arrays are expanded so that each element in the array becomes a top-level element of the concatenation. But for elements in the concatenation that are records, the entire record becomes one top-level element in the result. To specify that the records be broken down so that their subelements become top-level elements in the concatenation, use the concat_flatten directive. Currently we do not support leaving full arrays as elements in the result. (Please let us know if you need that option.)
35
If the elements being concatenated are of incompatible base types, a VHDL-style record will be created. The record object can be expanded in the Objects and Wave windows just like an array of compatible type elements.
Concatenation Syntax for VHDL

<signalOrSliceName1> & <signalOrSliceName2> & ...
Concatenation Syntax for Verilog

&{<signalOrSliceName1>, <signalOrSliceName2>, ... } &{<count>{<signalOrSliceName1>}, <signalOrSliceName2>, ... }
Note that the concatenation syntax begins with "&{" rather than just "{". Repetition multipliers are supported, as illustrated in the second line. The repetition element itself may be an arbitrary concatenation subexpression.
Concatenation Directives
A concatenation directive (as illustrated below) can be used to constrain the resulting array range of a concatenation or influence how compound objects are treated. By default, the concatenation will be created with a descending index range from (n-1) downto 0, where n is the number of elements in the array.
(concat_range 31:0)<concatenationExpr> # Verilog syntax (concat_range (31:0))<concatenationExpr> # Also Verilog syntax (concat_range (31 downto 0))<concatenationExpr> # VHDL syntax
The concat_range directive completely specifies the index range.

(concat_ascending) <concatenationExpr>
The concat_ascending directive specifies that the index start at zero and increment upwards.
(concat_flatten) <concatenationExpr>
The concat_flatten directive flattens the signal structure hierarchy.

(concat_noflatten) <concatenationExpr>
The concat_noflatten directive groups signals together without merging them into one big array. The signals become elements of a record and retain their original names. When expanded, the new signal looks just like a group of signals. The directive can be used hierarchically with no limits on depth.
(concat_sort_wild_ascending) <concatenationExpr>
The concat_sort_wild_ascending directive gathers signals by name in ascending order (the default is descending).
36
Syntax and Conventions GUI_expression_format (concat_reverse) <concatenationExpr>
The concat_reverse directive reverses the bits of the concatenated signals.
Examples of Concatenation
&{ "mybusbasename*" }
Gathers all signals in the current context whose names begin with "mybusbasename", sorts those names in descending order, and creates a bus with index range (n-1) downto 0, where n is the number of matching signals found. (Note that it currently does not derive the index name from the tail of the one-bit signal name.)
(concat_range 13:4)&{ "mybusbasename*" }
Specifies the index range to be 13 downto 4, with the signals gathered by name in descending order.
(concat_ascending)&{ "mybusbasename*" }
Specifies an ascending range of 0 to n-1, with the signals gathered by name in descending order.
(concat_ascending)((concat_sort_wild_ascending)&{"mybusbasename*" })
Specifies an ascending range of 0 to n-1, with the signals gathered by name in ascending order.
(concat_reverse)(bus1 & bus2)
Specifies that the bits of bus1 and bus2 be reversed in the output virtual signal.
Record Field Members

Arbitrarily-nested arrays and records are supported, but operators will only operate on one field at a time. That is, the expression {a == b} where a and b are records with multiple fields, is not supported. This would have to be expressed as:
{(a.f1 == b.f1) && (a.f2 == b.f2) ...}
Examples:
vhdlsig.field1 vhdlsig.field1.subfield1 vhdlsig.(5).field3 vhdlsig.field4(3 downto 0)
Searching for Binary Signal Values in the GUI

When you use the GUI to search for signal values displayed in 4-state binary radix, you should be aware of how ModelSim maps between binary radix and std_logic. The issue arises because
37
there is no un-initialized value in binary, while there is in std_logic. So, ModelSim relies on mapping tables to determine whether a match occurs between the displayed binary signal value and the underlying std_logic value. This matching algorithm applies only to searching using the GUI. It does not apply to VHDL or Verilog testbenches. For comparing VHDL std_logic/std_ulogic objects, ModelSim uses the table shown below. An entry of 0 in the table is no match; an entry of 1 is a match; an entry of 2 is a match only if you set the Tcl variable STDLOGIC_X_MatchesAnything to 1. Note that X will match a U, and - will match anything. Table 1-15. VHDL Logic Values Used in GUI Search Search Entry U X 0 1 Z W L H Matches as follows: U 1 1 0 0 0 0 0 0 1 X 1 1 2 2 2 2 2 2 1 0 0 2 1 0 0 0 1 0 1 1 0 2 0 1 0 0 0 1 1 Z 0 2 0 0 1 0 0 0 1 W 0 2 0 0 0 1 0 0 1 L 0 2 1 0 0 0 1 0 1 H 0 2 0 1 0 0 0 1 1 1 1 1 1 1 1 1 1 1
For comparing Verilog net values, ModelSim uses the table shown below. An entry of 2 is a match only if you set the Tcl variable VLOG_X_MatchesAnything to 1. Table 1-16. Verilog Logic Values Used in GUI Search Search Entry 0 1 Z X Matches as follows: 0 1 0 0 2 1 0 1 0 2 Z 0 0 1 2 X 2 2 2 1
This table also applies to SystemC types: sc_bit, sc_bv, sc_logic, sc_int, sc_uint, sc_bigint, sc_biguint.
38
39
40
Chapter 2 Commands
You enter the commands in this chapter either on the command line of the Main window or in macro files. Some commands are automatically entered on the command line when you use the ModelSim graphical user interface. Note that in addition to the simulation commands listed in this chapter, you can also use the Tcl commands described in the Tcl man pages (use the Main window menu selection: Help > Tcl Man Pages). Table 2-1 provides a brief description of each ModelSim command. For more information on command details, arguments, and examples, click the link in the Command name column. Table 2-1. Supported Commands Command name .main clear abort add button add dataflow add list add log add memory add testbrowser add watch add wave add_cmdhelp add_menu add_menucb Action clears the Main window transcript halts the execution of a macro file interrupted by a breakpoint or error adds a user-defined button to the Main window button bar adds the specified object to the Dataflow window lists VHDL signals and variables, and Verilog nets and registers, and their values in the List window also known as the log command; see log opens the specified memory in the MDI frame of the Main window adds .ucdb files to the Test Management Browser adds signals or variables to the Watch window adds VHDL signals and variables, and Verilog nets and registers to the Wave window adds an entry to the command-line help; use the help command to display the help text adds a menu to the menu bar of the specified window, using the specified menu name creates a checkbox within the specified menu of the specified window
41
Commands
Table 2-1. Supported Commands (cont.) Command name add_menuitem add_separator add_submenu alias batch_mode bd bookmark add wave bookmark delete wave bookmark goto wave bookmark list wave bp cd cdbg change change_menu_cmd check contention add check contention config check contention off check float add check float config check float off check stable off check stable on checkpoint Action creates a menu item within the specified menu of the specified window adds a separator as the next item in the specified menu path in the specified window creates a cascading submenu within the specified menu path of the specified window creates a new Tcl procedure that evaluates the specified commands returns a 1 if ModelSim is operating in batch mode, otherwise returns a 0 deletes a breakpoint adds a bookmark to the specified Wave window deletes bookmarks from the specified Wave window zooms and scrolls a Wave window using the specified bookmark displays a list of available bookmarks sets a breakpoint changes the ModelSim local directory to the specified directory provides command-line equivalents of the menu options that are available for C Debug. modifies the value of a VHDL variable or Verilog register variable changes the command to be executed for a specified menu item label, in the specified menu, in the specified window enables contention checking for the specified nodes writes checking messages to a file disables contention checking for the specified nodes enables float checking for the specified nodes writes checking messages to a file disables float checking for the specified nodes disables stability checking enables stability checking on the entire design saves the state of your simulation
42
Commands
Table 2-1. Supported Commands (cont.) Command name compare add compare annotate compare clock compare configure compare continue compare delete compare end compare info compare list compare options compare reload compare reset compare run compare savediffs compare saverules compare see compare start compare stop compare update configure context coverage attribute coverage clear coverage exclude coverage goal Action compares signals in a reference design against signals in a test design marks a compare difference as "ignore" or tags it with a text message defines a clock to be used with clocked-mode comparisons modifies options for compare signals or regions continues difference computation that had been suspended deletes a signal or region from the current comparison closes the currently open comparison lists the results of the comparison lists all the compare add commands currently in effect sets defaults for options used in other compare commands reloads a comparison previously saved with the compare savediffs command clears the current compare differences runs the comparison on selected signals saves comparison differences to a file that can be reloaded later saves comparison setup information to a file that can be reloaded later displays a comparison difference in the Wave window starts a new dataset comparison halts active difference computation updates the comparison differences invokes the List or Wave widget configure command for the current default List or Wave window provides several operations on a contexts name displays attributes in the currently loaded database clears all coverage data obtained during previous run commands. Undocumented for 6.4 loads an exclusion filter file; or, allows you to exclude specific lines in a source file or rows within a table. Sets the value of UCDB-wide goals
43
Commands
Table 2-1. Supported Commands (cont.) Command name coverage report coverage save coverage testnames coverage weight dataset alias dataset clear dataset close dataset config dataset info dataset list dataset open dataset rename dataset restart dataset save dataset snapshot delete describe disablebp disable_menu disable_menuitem do down drivers Action produces a textual output of the coverage statistics that have been gathered up to this point saves current coverage statistics to a file that can be reloaded later, preserving instance-specific information displays test names in the current UCDB file loaded sets a global per-type weight for total coverage calculations assigns an additional name to a dataset clears the current simulation WLF file closes a dataset configures WLF file settings after dataset is open reports information about the specified dataset lists the open dataset(s) opens a dataset and references it by a logical name changes the logical name of an opened dataset unloads specified or current dataset saves data from the current WLF file to a specified file saves data from the current WLF file at a specified interval removes objects from either the List or Wave window displays information about the specified HDL object turns off breakpoints and when commands disables the specified menu within the specified window disables the specified menu item within the specified menu path of the specified window executes commands contained in a macro file searches for signal transitions or values in the specified List window displays in the Main window the current value and scheduled future values for all the drivers of a specified VHDL signal or Verilog net dumps the contents of the vsim.wlf file in a readable format displays a specified message in the Main window invokes the editor specified by the EDITOR environment variable
dumplog64 echo edit
44
Commands
Table 2-1. Supported Commands (cont.) Command name enablebp enable_menu enable_menuitem environment examine exit find find infiles find insource Action turns on breakpoints and when commands turned off by the disablebp command enables a previously-disabled menu enables a previously-disabled menu item displays or changes the current dataset and region environment examines one or more objects, and displays current values (or the values at a specified previous time) in the Main window exits the simulator and the ModelSim application displays the full pathnames of all objects in the design whose names match the name specification you provide searches the specified files and prints to the Transcript pane those lines from the files that match the specified pattern. searches all source files related to the current design and prints to the Transcript pane those lines from the files that match the specified pattern. global format control for all time values displayed in the GUI applies stimulus to VHDL signals and Verilog nets sets the source directory for FLI/PLI/VPI C source code when using C Debug gets the time of the active cursor in the Wave window gets the time of the active marker in the List window displays in the Main window a brief description and syntax for the specified command lists the commands executed during the current session controls and monitors batch jobs save or load custom GUI layouts takes one or more Tcl lists as arguments and pretty-prints them to the Main window searches left (previous) for signal transitions or values in the specified Wave window creates a wave log format (WLF) file containing simulation data for all objects whose names match the provided specifications takes a Tcl list as an argument and shifts it in-place one place to the left, eliminating the left-most element
formatTime force gdb dir getactivecursortime getactivemarkertime help history jobspy layout lecho left log lshift
45
Commands
Table 2-1. Supported Commands (cont.) Command name lsublist mem compare mem display mem list mem load mem save Action returns a sublist of the specified Tcl list that matches the specified Tcl glob pattern compares the selected memory to a reference memory or file displays the memory contents of a selected instance to the screen displays a flattened list of all memory instances in the current or specified context after a design has been elaborated updates the simulation memory contents of a specified instance saves the contents of a memory instance to a file in any of the supported formats: Verilog binary, Verilog hex, and MTI memory pattern data finds and prints to the screen the first occurring match of a specified memory pattern in the specified memory instance starts the ModelSim GUI without prompting you to load a design; valid only for Windows platforms continues a search; see the search command removes the effect of any active force commands on the selected object suspends writing of data to the WLF file for the specified signals opens a simple text editor closes a window or set of windows in the ModelSim GUI deactivates selected when commands specifies command(s) to be executed when running a macro that encounters a breakpoint in the source code; in effect only during a run command specifies one or more commands to be executed when an error is encountered during elaboration; in effect only during a vsim command specifies one or more commands to be executed when a Tcl command in a dofile encounters an error; not dependent on a run command interrupts the execution of a macro moves one level up the C callstack specifies the signals or nets to track for power information works in conjunction with the power add command to make vsim stop updating toggle activity data for the specified signal or net
mem search modelsim next noforce nolog notepad noview nowhen onbreak
onElabError
onerror
pause pop power add power off
46
Commands
Table 2-1. Supported Commands (cont.) Command name power on Action works in conjunction with the power add command to make vsim begin or resume updating toggle activity data for the specified signal or net writes out the power information for the specified signals or nets resets power information to zero for the signals or nets specified with the power add command determines how real numbers display in the GUI echoes to the Main window the current names and values of all environment variables creates textual report of all processes displayed in the Process window clears any statistical performance or memory allocation data that has been gathered during previous run commands selects the frequency with which the profiler collects samples during a run command disables runtime statistical performance and memory allocation profiling enables runtime profiling of where your simulation is spending its time and where memory is allocated allows various profiling options to be changed reads in raw profile data from an external file created during memory allocation profiling produces a textual output of the profiling statistics that have been gathered up to this point performs common operations on new projects changes one or more properties of the specified signal, net, or register in the List Window changes one or more properties of the specified signal, net, or register in the Wave Window moves one level down the C callstack displays the current directory path in the Main window turns off transcript echoing for the specified command exits the simulator compiles, optimizes, and simulates a Verilog or SystemVerilog design in one step
47
power report power reset precision printenv process report profile clear profile interval profile off profile on profile option profile reload profile report project property list property wave push pwd quietly quit qverilog
Commands
Table 2-1. Supported Commands (cont.) Command name radix radix define radix names radix list radix delete readers report restart Action specifies the default radix to be used creates or modifies a user-defined radix returns a list of currently defined radix names returns the complete definition of a radix removes the radix definition from the named radix displays the names of all readers of the specified object displays the value of all simulator control variables, or the value of any simulator state variables relevant to the current simulation reloads the current dataset if the current dataset is not the active simulation ("sim") and resets the simulation time to zero, in effect acting just like a restart of a simulation restores the state of a simulation that was saved with a checkpoint command during the current invocation of vsim resumes execution of a macro file after a pause command or a breakpoint searches right (next) for signal transitions or values in the specified Wave window advances the simulation by the specified number of timesteps compiles SystemC design units creates a VHDL entitys or Verilog modules equivalent SystemC foreign module declaration, writing it to standard output compiles SDF files searches the specified window for one or more objects matching the specified pattern(s) searches one or more of the currently open logfiles for a specified condition scrolls the List or Wave window to make the specified time visible sets an environment variable shifts macro parameter values down one place lists objects and subregions visible from the current environment reports performance-related statistics about active simulations lists all currently interrupted macros
restore resume right run sccom scgenmod sdfcom search searchlog seetime setenv shift show simstats status
48
Commands
Table 2-1. Supported Commands (cont.) Command name step stop suppress tb tcheck_set tcheck_status toggle add toggle disable toggle enable toggle report toggle reset tr color tr uid tr order transcribe transcript transcript file tssi2mti typespec unsetenv up vcd add vcd checkpoint Action steps to the next HDL statement stops simulation in batch files; used with the when command prevents the specified message(s) from displaying displays a stack trace for the current process in the Transcript pane modifies a timing checks reporting or X generation status prints the current status of timing checks to the Transcript pane enables collection of toggle statistics for the specified nodes disables collection of toggle statistics for the specified nodes re-enables collection of toggle statistics for the specified nodes displays to the Transcript pane a list of all nodes that have not transitioned to both 0 and 1 at least once resets the toggle counts to zero for the specified nodes modifies the color of a specific transaction or stream of transactions in a wave window, or all wave windows displays to the Transcript pane a list of all active transactions and their IDs controls which attributes are visible in a transaction and the order in which they appear displays a command in the Transcript pane, then executes the command controls echoing of commands executed in a macro file; also works at top level in batch mode sets or queries the pathname for the transcript file converts a vector file in Technology Standard Events Format (TSSI) into a sequence of force and run commands queries class names and class relationships of SystemVerilog classes deletes an environment variable searches for signal transitions or values in the specified List window adds the specified objects to the VCD file dumps the current values of all VCD variables to the VCD file
49
Commands
Table 2-1. Supported Commands (cont.) Command name vcd comment vcd dumpports vcd dumpportsall vcd dumpportsflush vcd dumpportslimit vcd dumpportsoff vcd dumpportson vcd file vcd files vcd flush vcd limit vcd off vcd on vcd2wlf vcom vcover attribute vcover merge vcover ranktest vcover report vcover stats vcover testnames vdel vdir vencrypt verror Action inserts the specified comment in the VCD file creates a VCD file that captures port driver data creates a checkpoint in the VCD file that shows the current values of all selected ports flushes the VCD buffer to the VCD file specifies the maximum size of the VCD file turns off VCD dumping and records all dumped port values as x turns on VCD dumping and records the current values of all selected ports specifies the filename and state mapping for the VCD file created by a vcd add command specifies filenames and state mapping for the VCD files created by the vcd add command; supports multiple VCD files flushes the contents of the VCD file buffer to the VCD file specifies the maximum size of the VCD file turns off VCD dumping and records all VCD variable values as x turns on VCD dumping and records the current values of all VCD variables translates VCD files into WLF files compiles VHDL design units displays attributes in the currently loaded database merges multiple code coverage data files offline ranks the specified input files according to their contribution to cumulative coverage reports on multiple code coverage data files offline produces summary statistics from multiple coverage data files displays test names in the current UCDB file loaded deletes a design unit from a specified library lists the contents of a design library encrypts Verilog code contained within encryption envelopes prints a detailed description of a message number
50
Commands
Table 2-1. Supported Commands (cont.) Command name vgencomp view virtual count virtual define virtual delete virtual describe virtual expand virtual function virtual hide virtual log virtual nohide virtual nolog virtual region virtual save virtual show virtual signal virtual type vlib vlog vmake vmap vopt vsim Action writes a Verilog modules equivalent VHDL component declaration to standard output opens a ModelSim window and brings it to the front of the display counts the number of currently defined virtuals that were not read in using a macro file prints the definition of a virtual signal or function in the form of a command that can be used to re-create the object removes the matching virtuals prints a complete description of the data type of one or more virtual signals produces a list of all the non-virtual objects contained in the virtual signal(s) creates a new signal that consists of logical operations on existing signals and simulation time causes the specified real or virtual signals to not be displayed in the Objects window causes the sim-mode dependent signals of the specified virtual signals to be logged by the simulator redisplays a virtual previously hidden with virtual hide stops the logging of the specified virtual signals creates a new user-defined design hierarchy region saves the definitions of virtuals to a file lists the full path names of all the virtuals explicitly defined creates a new signal that consists of concatenations of signals and subelements creates a new enumerated type creates a design library compiles Verilog design units and SystemVerilog extensions creates a makefile that can be used to reconstruct the specified library defines a mapping between a logical library name and a directory produces an optimized version of your design loads a new design into the simulator
51
Commands
Table 2-1. Supported Commands (cont.) Command name vsim<info> vsim_break vsource wave wave create wave edit wave export wave import wave modify when where wlf2log wlf2vcd wlfman wlfrecover write cell_report write format write list write preferences write report write timing write transcript write tssi Action returns information about the current vsim executable stop the current simulation before completion specifies an alternative file to use for the current source file commands for manipulating cursors, for zooming, and for adjusting the wave display view in the Wave window creates an editable waveform that can be used to create stimulus and drive simulation edits a created waveform exports created waveforms to a stimulus file imports an EVCD file previously created with a wave export command modifies the parameters of a created waveform instructs ModelSim to perform actions when the specified conditions are met displays information about the system environment translates a ModelSim WLF file to a QuickSim II logfile translates a ModelSim WLF file to a VCD file outputs information about or a new WLF file from an existing WLF file attempts to repair an incomplete WLF file creates a report of cell instances in the design that are optimized records the names and display options in a file of the objects currently being displayed in the List or Wave window records the contents of the most recently opened or specified List window in a list output file saves the current GUI preference settings to a Tcl preference file prints a summary of the design being simulated prints timing information about the specified instance writes the contents of the Main window transcript to the specified file records the contents of the default or specified List window in a TSSI format file
52
Commands
Table 2-1. Supported Commands (cont.) Command name write wave xml2ucdb Action records the contents of the most currently opened or specified Wave window in PostScript format converts an XML file into a .ucdb file
53
Commands .main clear
.main clear
The .main clear command clears the Main window Transcript pane. The behavior is the same as selecting Edit > Clear when the Transcript pane is active. Syntax .main clear Arguments None See also Main Window, Transcript Window, transcript, transcript file
54
Commands abort
abort
This command halts the execution of a macro file interrupted by a breakpoint or error. When macros are nested, you may choose to abort the last macro only, abort a specified number of nesting levels, or abort all macros. You can specify this command within a macro to return early. Syntax abort [<n> | all] Arguments <n> (optional) An integer, greater than 0, that specifies the number of nested macro levels to abort, where the default value of is 1. all (optional) A literal that instructs the tool to abort all levels of nested macros. See also onbreak onElabError onerror
55
Commands add button
add button
This command adds a user-defined button to the Main window button bar. New buttons are added to the right end of the bar. Returns the path name of the button widget created. You may want to remember this path name, which is similar to:
# .dockbar.tbf0.standard.tb.button_49
in case you ever want to remove the button. To remove a button you have previously added you can use the destroy Tcl command with the buttons path name as an argument, for example:
destroy .dockbar.tbf0.standard.tb.button_49
Syntax add button <text> <cmd> [Disable | NoDisable] [{<option> <value> ...}] Arguments <text> (required) A string that specifies the label to appear on the face of the button. <cmd> (required) A string that defines the command to be executed when the button is clicked. If your command contains any whitespace or non-alphanumeric characters you must enclose the command in braces ( {} ). You can specify multiple commands by separating them with a semicolon. You can echo the command and display the return value in the Transcript window by prefixing the command with the transcribe command. Transcribe will also echo the results to the Transcript pane. Disable | NoDisable (optional) A choice of literals that specify the appearance of the button. Disable the button is inactive and grayed-out during a run. NoDisable the button is active and available during a run. {<option> <value>} ... (optional) A pair of strings, which are repeatable, that specify Tk button widgets you want to apply to the button. You must enclose your option/value pairs in braces ( {} ). Note To specify any option/value pairs, you must specify either Disable or NoDisable.
56
Commands add button
You can use any properties belonging to Tk button widgets. Useful options are foreground color (-fg), background color (-bg), width (-width), and relief (-relief). For a complete list of available options, use the configure command addressed to the newlycreated widget. For example:
.dockbar.tbf0.standard.tb.button_51 config
or you can access the Tk documentation for button widgets by selecting Help > Tcl Man Pages, which displays HTML help. You then can select the links: Tk commands then buttons. Examples Create a button labeled pwd that invokes the transcribe command with the pwd Tcl command, and echoes the command and its results to the Transcript pane. The button remains active during a run.
add button pwd {transcribe pwd} NoDisable
Create a button labeled date that echoes the system date to the Transcript pane. The button is disabled during a run; its colors are: blue foreground, yellow background, and red active background.
add button date {transcribe exec date} Disable \ {-fg blue -bg yellow -activebackground red}
Create a doit button and underline the second character of the label, the "o" of "doit".
add button doit {run 1000 ns; echo did it} Disable {-underline 1}
Change the command that the button executes to "run 10000" and the buttons background color to red; you must know the buttons path name that was returned after the initial creation of the button.
.dockbar.tbf0.standard.tb.button_13 config -command {run 10000} -bg red
See also transcribe
57
Commands add dataflow
add dataflow
The add dataflow command adds the specified process, signal, net, or register to the Dataflow window. Wildcards are allowed. Syntax add dataflow <object> ... { [-in] [-out] [-inout] | [-ports] } [-internal] [-nofilter] [-recursive] [-window <wname>] <object> ... (required) A string, which is repeatable in a space separated list, that specifies a process, signal, net, or register that you want to add to the Dataflow window, where wildcards are allowed. Refer to the section Filtering Wildcard Matching for Certain Commands for wildcard usage as it pertains to the add commands. -in (optional) A literal that specifies to add ports of mode IN. -inout (optional) A literal that specifies to add ports of mode INOUT. -internal (optional) A literal that specifies to add internal (non-port) objects. -nofilter (optional) A literal that specifies that the WildcardFilter Tcl preference variable be ignored when finding signals or nets. The WildcardFilter Tcl preference variable identifies types to ignore when matching objects with wildcard patterns. -out (optional) A literal that specifies to add ports of mode OUT. -ports (optional) A literal that specifies to add all ports. This switch has the same effect as specifying -in, -out, and -inout together. -recursive (optional) A literal that specifies that the scope of the search is to descend recursively into subregions. If omitted, the search is limited to the selected region. You can specify -r as an alias to this switch. -window <wname> (optional) A switch and argument pair that adds the object(s) to the specified Dataflow window. <window> the name of the dataflow window, as shown in the windows tab.
58
Commands add dataflow
This switch is useful for when you have multiple dataflow windows open. You can open a new dataflow window by entering:
view dataflow -new
See also Dataflow Window Examples Add all objects in the design to the dataflow window.
add dataflow -r /*
WildcardFilter Preference Variable
Add all objects in the region to the dataflow window.

add dataflow *
59
Commands add list
add list
The add list command adds the following objects and their values to the List window: VHDL signals and variables Verilog nets and registers User-defined buses SystemC primitive channels (signals)
If you do not specify a port mode, such as -in or -out, add list displays all objects in the selected region with names matching the object name specification. See Filtering Wildcard Matching for Certain Commands for wildcard usage as it pertains to the add commands. Syntax add list [-width <integer>] [-allowconstants] [-depth <level>] {[-in] [-inout] [-out] | [-ports]} [-internal] [-label <name>] [-nodelta] [-trigger | -notrigger] [-radix <type> | -<radix_type>] [-radixenumnumeric | -radixenumsymbolic] [-recursive] [-optcells] [-window <wname>] {<object> ... | <object_name> {sig ...}} Arguments <object> ... (required) A string, which is repeatable in a space-separated list, that specifies the name(s) of the object to be listed, where wildcards are allowed. Refer to the section Filtering Wildcard Matching for Certain Commands for wildcard usage as it pertains to the add commands. Note that the WildcardFilter Tcl preference variable identifies types to ignore when matching objects with wildcard patterns. You can add variables as long as they are preceded by the process name. For example:
add list myproc/int1
<object_name> {sig ...} (required) A group of arguments, enclosed in braces ({ }), that creates a user-defined bus with the specified object name containing the specified signals (sig) concatenated within the user-defined bus. sig A space-separated list of signals, enclosed in braces ({ }), that are included in the user-defined bus. The signals may be either scalars or various sized arrays as long as they have the same element enumeration type. For example:
add list {mybus {a b y}}
60
Commands add list
-allowconstants For use with wildcard searches. (optional) A switch that specifies that constants matching the wildcard search should be added to the List window. This command does not add constants by default because they do not change.
-depth <level> (optional) A switch and argument pair that restricts a recursive search, as specified with -recursive, to a certain level of hierarchy. <level> an integer greater than or equal to zero. For example, if you specify -depth 1, the command descends only one level in the hierarchy.
-in For use with wildcard searches. (optional) A switch that specifies that the scope of the search is to include ports of mode IN if they match the object specification.
-inout For use with wildcard searches. (optional) A switch that specifies that the scope of the search is to include ports of mode INOUT if they match the object specification.
-internal For use with wildcard searches. (optional) A switch that specifies that the scope of the search is to include internal objects (non-port objects) if they match the object specification. VHDL variables are not selected.
-label <name> (optional) A switch and argument pair that specifies an alternative signal name to be displayed as a column heading in the listing. <name> specifies the label to be used at the top of the column. You must enclose <name> in braces ({ }) if it includes any whitespace. This alternative name is not valid in a force or examine command. However, you can use it in a search with the list option.
-nodelta (optional) A switch that specifies that the delta column not be displayed when adding signals to the List window. Identical to configure list -delta none.
-optcells For use with wildcard searches. (optional) A switch that allows Verilog optimized cell ports to be visible when using wildcards. By default Verilog optimized cell ports are not selected even if they match the specified wildcard pattern.
-out For use with wildcard searches. (optional) A switch that specifies that the scope of the search is to include ports of mode OUT if they match the object specification.
61
Commands add list
-ports For use with wildcard searches. (optional) A switch that specifies that the scope of the search is to include all ports. This switch has the same effect as specifying -in, -out, and -inout together.
-radix <type> | -<radix_type> (optional) A choice between switches that specify the radix for the objects that follow in the command. Valid entries (or any unique abbreviations) are: -radix binary -radix ascii -radix unsigned -radix decimal -radix octal -radix hex -radix symbolic -radix time -radix default -binary -ascii -unsigned -decimal -octal -hex -symbolic -time -default
If no radix is specified for an enumerated type, the default representation is used. If you specify a radix for an array of a VHDL enumerated type, ModelSim converts each signal value to 1, 0, Z, or X. You can change the default radix for the current simulation using the radix command. You can change the default radix permanently by editing the DefaultRadix variable in the modelsim.ini file. -radixenumnumeric (optional) Displays SystemVerilog and SystemC enums as numbers rather than strings. The current radix setting controls the actual enum value displayed, except when the radix setting is ASCII. If the current radix setting is ASCII, the value of SystemVerilog and SystemC enums are displayed as a string. This option overrides the global setting of the default radix (the DefaultRadix variable in the modelsim.ini file). -radixenumsymbolic (optional) Reverses the action of the -radixenumnumeric option and sets the global setting of the default radix (the DefaultRadix variable in the modelsim.ini file) to symbolic. -recursive For use with wildcard searches. (optional) A switch that specifies that the scope of the search is to descend recursively into subregions. If omitted, the search is limited to the selected region. You can use the -depth argument to specify how far down the hierarchy to descend. You can use "-r" as an alias to this switch.
62
Commands add list
-trigger | -notrigger (optional) A choice of switches that specify whether objects should be updated in the List window when the objects change value.
-width <integer> (optional) A switch and argument pair that specifies the column width in characters. -window <wname> (optional) A switch and argument pair that adds objects to the specified List window <wname> (e.g., list2). You should use this switch to specify a particular window when multiple instances of that window type exist. This option selects an existing window, but does not create a new window. Use the view command with the -new option to create a new window.
Examples List all objects in the design.

add list -r /*
List all objects in the region.

add list *
List all input ports in the region.

add list -in *
Display a List window containing three columns headed a, sig, and array_sig(9 to 23).
add list a -label sig /top/lower/sig {array_sig(9 to 23)}
List clk, a, b, c, and d only when clk changes.

add list clk -notrigger a b c d
Lists clk, a, b, c, and d every 100 ns.

config list -strobeperiod {100 ns} -strobestart {0 ns} -usestrobe 1 add list -notrigger clk a b c d
Creates a user-defined bus named "mybus" consisting of three signals; the bus is displayed in hex.
add list -hex {mybus {msb {opcode(8 downto 1)} data}}
Lists the object vec1 using symbolic values, lists vec2 in hexadecimal, and lists vec3 and vec4 in decimal.
add list vec1 -hex vec2 -dec vec3 vec4
63
Commands add list
See also add wave log Extended Identifiers WildcardFilter Preference Variable
64
Commands add memory
add memory
The add memory command displays the contents and sets the address and data radix of the specified memory in the MDI frame of the Main window. See Filtering Wildcard Matching for Certain Commands for wildcard usage as it pertains to the add commands. Syntax add memory [-addressradix {decimal | hex}] [-dataradix <radix_type>] [-radixenumnumeric | -radixenumsymbolic] [-wordsperline <num>] <object_name> ... Arguments -addressradix {decimal | hex} (optional) A switch and argument pair that specifies the address radix for the memory display. decimal (default) sets the radix to decimal. You can abbreviate this argument to "d". hex sets the radix to hexidecimal. You can abbreviate this to "h". -dataradix <radix_type> (optional) A switch and argument pair that specifies the data radix for the memory display. If you do not specify this switch, the command uses the global default radix. <type> Valid entries (or any unique abbreviations) are: -binary -unsigned -decimal -octal -hex -symbolic -default If you do not specify a radix is specified for an enumerated type, the command uses the symbolic representation. You can change the default radix for the current simulation using the radix command. You can change the default radix permanently by editing the DefaultRadix variable in the modelsim.ini file. Changing the default radix does not change the radix of the currentlydisplayed memory. Use the add memory command to re-add the memory with the desired radix, or change the display radix from the Memory window Properties dialog.
65
Commands add memory
-radixenumnumeric (optional) Displays SystemVerilog and SystemC enums as numbers rather than strings. The current radix setting controls the actual enum value displayed, except when the radix setting is ASCII. If the current radix setting is ASCII, the value of SystemVerilog and SystemC enums are displayed as a string. This option overrides the global setting of the default radix (the DefaultRadix variable in the modelsim.ini file).
-radixenumsymbolic (optional) Reverses the action of the -radixenumnumeric option and sets the global setting of the default radix (the DefaultRadix variable in the modelsim.ini file) to symbolic.
-wordsperline <num> (optional) A switch and argument pair that specifies how many words are displayed on each line in the memory window. By default, the information displayed will wrap based on the width of the window.
<object_name> ... (required) A string, which is repeatable in a space-separated list, that specifies the hierarchical path of the memory to be displayed. Wildcard characters are allowed. (Note that the WildcardFilter Tcl preference variable identifies types to ignore when matching objects with wildcard patterns.)
See also Memory Panes WildcardFilter Preference Variable
66
Commands add testbrowser
add testbrowser
The add testbrowser command adds .ucdb file(s) to the test management browser. Syntax add testbrowser <ucdb_filename> [<ucdb_filename>...] Arguments <ucdb_filename> [<ucdb_filename>...] (required: at least one .ucdb) A string that specifies the name of the .ucdb file(s) to be added. Wildcard characters are allowed. (Note that the WildcardFilter Tcl preference variable identifies types to ignore when matching objects with wildcard patterns.) See also Browser Tab WildcardFilter Preference Variable
67
Commands add watch
add watch
The add watch command adds signals and variables to the Watch window in the Main window. SystemC objects and user-defined buses may also be added. See Filtering Wildcard Matching for Certain Commands for wildcard usage as it pertains to the add commands. Syntax add watch <object_name> ... [-radix <type>] [-radixenumnumeric | -radixenumsymbolic] Arguments <object_name> ... (required) A string, which is repeatable in a space-separated list, that specifies the name of the object to be added. Wildcard characters are allowed. (Note that the WildcardFilter Tcl preference variable identifies types to ignore when matching objects with wildcard patterns.) Variables must be preceded by the process name. For example,
add watch myproc/int1
-radix <type> (optional) A switch and argument pair that specifies a user-defined radix. If you do not specify this switch, the command uses the global default radix. <type> Valid entries (or any unique abbreviations) are: -binary -ascii -unsigned -decimal -octal -hex -symbolic -time -default
-radixenumnumeric (optional) Displays SystemVerilog and SystemC enums as numbers rather than strings. The current radix setting controls the actual enum value displayed, except when the radix setting is ASCII. If the current radix setting is ASCII, the value of SystemVerilog and SystemC
68
Commands add watch
enums are displayed as a string. This option overrides the global setting of the default radix (the DefaultRadix variable in the modelsim.ini file). -radixenumsymbolic (optional) Reverses the action of the -radixenumnumeric option and sets the global setting of the default radix (the DefaultRadix variable in the modelsim.ini file) to symbolic. See also Watch Pane WildcardFilter Preference Variable
69
Commands add wave
add wave
The add wave command adds the following objects to the Wave window: VHDL signals and variables Verilog nets and registers SystemVerilog class objects SystemC primitive channels (signals) Dividers and user-defined buses.
If no port mode is specified, add wave will display all objects in the selected region with names matching the object name specification. See Filtering Wildcard Matching for Certain Commands for wildcard usage as it pertains to the add commands. Syntax add wave [-allowconstants] [-clampanalog {0 | 1}] [-color <standard_color_name>] [-depth <level>] [-expand <signal_name>] [-<format>] [-group <group_name> [<sig_name1> ...]] [-height <pixels>] { [-in] [-inout] [-out] | [-ports]} [-internal] [-max <real_num>] [-min <real_num>] [-noupdate] [-position <location>] [-radix <type> | -<radix_type>] [-radixenumnumeric | -radixenumsymbolic] [-recursive] [-time] [[-divider [<divider_name> ...]] | [-label <name> | {<object_name> {sig ...}}] ] [-window <wname>] [-optcells] Arguments -allowconstants For use with wildcard searches. (optional) A switch that specifies that constants matching the wildcard search should be added to the Wave window. By default, constants are ignored because they do not change. -clampanalog {0 | 1} (optional) A switch and argument pair that clamps the display of an analog waveform to the values specified by -max and -min. Specifying a value of 1 prevents the waveform from extending above the value specified for -max or below the value specified for -min. 0 not clamped 1 (default) clamped -color <standard_color_name> (optional) A switch and argument pair that specifies the color used to display a waveform. <standard_color_name> You can use either of the following:
70
Commands add wave
standard X Window color name enclose 2-word names in quotes ("), for example:
-color "light blue"
rgb value for example:

-color #357f77
-depth <level> (optional) A switch and argument pair that restricts a recursive search, as specified with -recursive to a specified level of hierarchy. <level> an integer greater than or equal to zero. For example, if you specify -depth 1, the command descends only one level in the hierarchy.
-divider [<divider_name> ...] (optional) A switch and argument pair that adds a divider to the Wave window. <divider_name> ... A string, which is repeatable in a space separated list, that specifies the name of the divider, which appears in the pathnames column. When you specify more than one <divider_name>, the command creates a divider for each name. You cannot begin a name with a hyphen (-). You can begin a name with a space, but you must enclose the name within quotes (") or braces ({ }) If you do not specify this argument, the command inserts an unnamed divider.
-expand <signal_name> (optional) A switch and argument pair that instructs the command to expand a compound signal immediately, but only one level down. <signal_name> a string that specifies the name of the signal. This string can include wildcards.
-<format> (optional) A switch that specifies the display format of the objects. The switches are: -literal Literal waveforms are displayed as a box containing the object value. -logic Logic signals may be U, X, 0, 1, Z, W, L, H, or -. -analog-step Analog-step changes to the new time before plotting the new Y. -analog-interpolated Analog-interpolated draws a diagonal line. -analog-backstep Analog-backstep plots the new Y before moving to the new time. The way each state is displayed is specified by the logic type display preference (refer to Simulator Control Variables). The Y-axis range of analog signals is bounded by -max and -min switches. Refer to Waveform Pane for more information on analog formats of waveform signals.
71
Commands add wave
-group <group_name> [<sig_name1> ...] (optional) A switch and argument group that creates a wave group with the specified group_name. <group_name> a string that specifies the name of the group. You must enclose this argument in quotes (") or braces ({ }) if it contains any white space. <sig_name> ... a string, which is repeatable in a space separated list, that specifies the signals to add to the group. This command creates an empty group if you do not specify any signal names.
-height <pixels> (optional) A switch and argument pair that specifies the height, in pixels, of the waveform. -in For use with wildcard searches. (optional) A switch that specifies that the scope of the search is to include ports of mode IN if they match the object_name specification.
-inout For use with wildcard searches. (optional) A switch that specifies that the scope of the search is to include ports of mode INOUT if they match the object_name specification.
-internal For use with wildcard searches. (optional) A switch that specifies that the scope of the search is to include internal objects (non-port objects) if they match the object_name specification.
-label <name> (optional) A switch and argument pair that specifies an alternative name for the signal being added. For example,
add wave -label c clock
adds the clock signal, labeled as "c". This alternative name is not valid in a force or examine command; however, it can be used in a search command with the wave option. -max <real_num> (optional) A switch and argument pair that specifies the maximum Y-axis data value to be displayed for an analog waveform. Used in conjunction with the -min switch; the value you specify for -max must be greater than the value you specify for -min. -min <real_num> (optional) A switch and argument pair that specifies the minimum Y-axis data value to be displayed for an analog waveform. Used in conjunction with the -max switch; the value you specify for -min must be less than the value you specify for -max.
72
Commands add wave
For example, if you know the Y-axis data for a waveform varies between 0.0 and 5.0, you could add the waveform with the following command:
add wave -analog -min 0 -max 5 -height 100 my_signal
Note Although -offset and -scale are still supported, the -max and -min arguments provide an easier way to define upper and lower limits of an analog waveform. -noupdate (optional) A switch that prevents the Wave window from updating when a series of add wave commands are executed in series. <object_name> ... (required) A string, which is repeatable in a space separated list, that specifies the names of objects to be included in the Wave window. Wildcard characters are allowed. Note that the WildcardFilter Tcl preference variable identifies types to ignore when matching objects with wildcard patterns. Variables may be added if preceded by the process name. For example,
add wave myproc/int1
{<object_name> {sig ...}} (required) A group of arguments, enclosed in braces ({ }), that creates a user-defined bus with the specified object name containing the specified signals (sig) concatenated within the user-defined bus. sig A space-separated list of signals, enclosed in braces ({ }), that are included in the user-defined bus. The signals may be either scalars or various sized arrays as long as they have the same element enumeration type. Note You can also select Wave > Combine Signals (when the Wave window is selected) to create a user-defined bus.
-optcells (optional) A switch that specifies that optimized cell ports are visible when using wildcards. By default optimized cell ports are not selected even if they match the specified wildcard pattern.
-out For use with wildcard searches. (optional) A switch that specifies that the scope of the search is to include ports of mode OUT if they match the object_name specification.
73
Commands add wave
-ports For use with wildcard searches. (optional) A switch that specifies that the scope of the listing is to include ports of modes IN, OUT, or INOUT.
-position <location> (optional) A switch and argument pair that specifies where the command adds the signals. <location> can be any of the following: top adds the signals to the beginning of the list of signals. bottom | end adds the signals the end of the list of signals. before | above adds the signals to the location before the first selected signal in the wave window. after | below adds the signals to the location after the first selected signal in the wave window. <integer> adds the signals beginning at the specified point in the list of signals.
-radix <type> | -<radix_type> (optional) A choice between switches that specify the radix for the objects that follow in the command. Valid entries (or any unique abbreviations) are: -radix binary -radix ascii -radix unsigned -radix decimal -radix octal -radix hex -radix symbolic -radix time -radix default -binary -ascii -unsigned -decimal -octal -hex -symbolic -time -default
If no radix is specified for an enumerated type, the default representation is used. If you specify a radix for an array of a VHDL enumerated type, ModelSim converts each signal value to 1, 0, Z, or X. You can change the default radix for the current simulation using the radix command. You can change the default radix permanently by editing the DefaultRadix variable in the modelsim.ini file. -radixenumnumeric (optional) Displays SystemVerilog and SystemC enums as numbers rather than strings. The current radix setting controls the actual enum value displayed, except when the radix setting is ASCII. If the current radix setting is ASCII, the value of SystemVerilog and SystemC
74
Commands add wave
enums are displayed as a string. This option overrides the global setting of the default radix (the DefaultRadix variable in the modelsim.ini file). -radixenumsymbolic (optional) Reverses the action of the -radixenumnumeric option and sets the global setting of the default radix (the DefaultRadix variable in the modelsim.ini file) to symbolic. -recursive For use with wildcard searches. (optional) A switch that specifies that the scope of the search is to descend recursively into subregions. If you do not specify this switch, the search is limited to the selected region. You can use the -depth argument to specify how far down the hierarchy to descend. -time Use time as the radix for Verilog objects that are register-based types (register vectors, time, int, and integer types). -window <wname> (optional) A switch and argument pair that adds objects to the specified window <wname> (e.g., wave2). Used to specify a particular window when multiple instances of that window type exist. Selects an existing window; does not create a new window. Use the view command with the -new option to create a new window. Examples Display an object named out2. The object is specified as being a logic object presented in gold.
add wave -logic -color gold out2
Display a user-defined, hex formatted bus named address.

add wave -hex {address {a_7 a_6 a_5 a_4 a_3 a_2 a_1 a_0}}
Wave all objects in the region.

add wave *
Wave all input ports in the region.

add wave -in *
Create a user-defined bus named "mybus" consisting of three signals. Scalar1 and scalar2 are of type std_logic and vector1 is of type std_logic_vector (7 downto 1). The bus is displayed in hex.
add wave -hex {mybus {scalar1 vector1 scalar2}}
Slices and arrays may be added to the bus using either VHDL or Verilog syntax. For example:
75
Commands add wave add add add add wave wave wave wave {vector3(1)} {vector3[1]} {vector3(4 downto 0)} {vector3[4:0]}
Add the object vec1 to the Wave window using symbolic values, adds vec2 in hexadecimal, and adds vec3 and vec4 in decimal.
add wave vec1 -hex vec2 -dec vec3 vec4
Add a divider with the name "-Example-". Note that for this to work, the first hyphen of the name must be preceded by a space.
add wave -divider " -Example- "
Add an unnamed divider.

add wave -divider add wave -divider "" add wave -divider {}
See also add list WildcardFilter Preference Variable log Concatenation Directives Extended Identifiers
76
Commands add_cmdhelp
add_cmdhelp
The add_cmdhelp command adds the specified command name, description, and command arguments to the command-line help. You can then access the information using the help command. To delete an entry, invoke the command with an empty command description and arguments. See examples. Syntax add_cmdhelp {<command_name>} {<command_description>} {<command_arguments>} Arguments {<command_name>} (required) A string, enclosed in braces ({ }), that specifies the command name that will be entered as an argument to the help command. The command_name must not interfere with an already existing command_name. {<command_description>} (required) A string, enclosed in braces ({ }), that specifies a description of the command. {<command_arguments>} (required) A space-separated list of arguments, enclosed in braces ({ }), for the command. If the command doesnt have any arguments, enter {}. Examples Add a command named "date" with no arguments.
add_cmdhelp date {Displays date and time.} {} VSIM> help date Displays date and time. Usage: date
Add the change date command.

add_cmdhelp {change date} {Modify date or time.} {-time|-date <arg>} VSIM> help change date Modify data or time. Usage: change date -time|-date <arg>
Deletes the change date command from the command-line help.

add_cmdhelp {change date} {} {}
77
Commands add_menu
add_menu
The add_menu command adds a menu to the menu bar of the specified window, using the specified menu name. Use the add_menuitem, add_separator, add_menucb, and add_submenu commands to complete the menu. Returns the full Tk pathname of the new menu. Color and other Tk properties of the menu may be changed, after creating the menu, using the Tk menu widget configure command. Syntax add_menu <window_name> <menu_name> [<shortcut> [-hide_menubutton]] Arguments <window_name> (required) A string that specifies the Tk path of the window to contain the menu. To add a menu to the Main window you must express this value as: "". For example,
add_menu "" mymenu
To add a menu to any other window, you must determine the window_name by executing the view command, for example:
view workspace # .main_pane.workspace
Note that all window panes, other than the Main window, begin with a period (.). <menu_name> (required) A string that specifies the name to be given to the Tk menu widget. <shortcut> (optional) An integer that specifies the number of the letter in the menu name that is to be used as the shortcut. Numbering starts with 0 (first letter = 0, second letter = 1, third letter = 2, and so on). Optional unless you specify -hide_menubutton, in which case <shortcut> is required. Default is "-1", which indicates no shortcut is to be used. -hide_menubutton (optional) A switch that specifies that the new menu is not to be displayed. You can add the menu later by calling tk_popup on the menu path widget. Note that you must specify <shortcut> if you specify -hide_menubutton. Examples The following Tcl code is an example of creating user-customized menus. It adds a menu containing a top-level item labeled "Do My Own Thing...", which prints "my_own_thing.signals", and adds a cascading submenu labeled "changeCase" with two
78
Commands add_menu
entries, "To Upper" and "To Lower", which echo "my_to_upper" and "my_to_lower" respectively. A checkbox that controls the value of myglobalvar (.signals:one) is also added.
set myglobalvar 0 set wname [view wave]; #Gets path to Wave window proc AddMyMenus {wname} { global myglobalvar set cmd1 "echo my_own_thing $wname" set cmd2 "echo my_to_upper $wname" set cmd3 "echo my_to_lower $wname" # # add_menu add_menuitem add_separator add_submenu add_menuitem add_menuitem add_submenu add_menucb WindowName ---------$wname $wname $wname $wname $wname $wname $wname $wname Menu ---mine mine mine mine mine.changeCase mine.changeCase mine mine.vars MenuItem label -------------------"Do My Own Thing..." ;#-----------------changeCase "To Upper" "To Lower" vars "Feature One" Command ------$cmd1 ------$cmd2 $cmd3 -variable myglobalvar -onvalue 1 -offvalue 0 -indicatoron 1
} AddMyMenus $wname
This example is available in the following DO file:

<install_dir>/examples/misc/addmenu.do.
You can run the DO file to add the "Mine" menu shown in the illustration, or modify the file for different results. To execute the DO file, select Tools > Execute Macro (Main window), or use the do command. See also add_menucb change_menu_cmd add_menuitem add_separator add_submenu
79
Commands add_menucb
add_menucb
The add_menucb command creates a checkbox within the specified menu of the specified window. A checkbox is a small box with a label. Clicking on the box will toggle the state, from on to off or the reverse. When the box is "on", the Tcl global variable <var> is set to <onval>. When the box is "off", the global variable is set to <offval>. Also, if something else changes the global variable, its current state is reflected in the state of the checkbox. Returns nothing. Syntax add_menucb <window_name> <menu_name> <Text> -variable <var> -onvalue <onval> -offvalue <offval> [-indicatoron {0 | 1}] Arguments <window_name> (required) A string that specifies the Tk path of the window to contain the menu. To add a menu to the Main window you must express this value as: "". For example,
add_menucb "" mymenu
Note that all window panes, other than the Main window, begin with a period (.). <menu_name> (required) A string that specifies the name of the Tk menu widget. Required. <Text> (required) A string that specifies the text to be displayed next to the checkbox. -variable <var> (required) A switch and argument pair that specifies the global Tcl variable to be reflected and changed. -onvalue <onval> (required) A switch and argument pair that specifies the value to set the global Tcl variable to when the box is "on". -offvalue <offval> (required) A switch and argument pair that specifies the value to set the global Tcl variable to when the box is "off".
80
Commands add_menucb
-indicatoron {0 | 1} (required) A switch and argument pair that specifies whether or not the status indicator is displayed. 0 off 1 (default) on
Examples
add_menucb $wname mine.vars "Feature One" \ -variable myglobalvar($wname:one) -onvalue 1 -offvalue 0 -indicatoron 1
The add_menucb command is also used as part of the add_menu example. See also add_menu change_menu_cmd add_menuitem add_separator add_submenu
81
Commands add_menuitem
add_menuitem
The add_menuitem command creates a menu item within the specified menu of the specified window. May be used within a submenu. Returns nothing. Syntax add_menuitem <window_name> <menu_path> <Text> <Cmd> [<shortcut>] Arguments <window_name> (required) A string that specifies the Tk path of the window to contain the menu. To add a menu to the Main window you must express this value as: "". For example,
add_menu "" mymenu
Note that all window panes, other than the Main window, begin with a period (.). <menu_path> (required) A string that specifies the name of the Tk menu widget plus submenu path. <Text> (required) A string that specifies the text to be displayed. <Cmd> (required) A string that specifies the command to be executed when the menu item is selected with the left mouse button. To echo the command and display the return value in the Main window, prefix the command with the transcribe command. Transcribe will also echo the results to the Transcript pane. <shortcut> (optional) An integer that specifies the number of the letter in the menu name that is to be used as the shortcut. Numbering starts with 0 (first letter = 0, second letter = 1, third letter = 2, and so on). Default is "-1", which indicates no shortcut is to be used. Examples
add_menuitem $wname user "Save Results As..." $my_save_cmd
The add_menuitem command is also used as part of the add_menu example.
82
Commands add_menuitem
See also add_menu change_menu_cmd add_menucb add_separator add_submenu
83
Commands add_separator
add_separator
The add_separator command adds a separator as the next item in the specified menu path in the specified window. Returns nothing. Syntax add_separator <window_name> <menu_path> Arguments <window_name> (required) A string that specifies the Tk path of the window to contain the menu. To add a menu to the Main window you must express this value as: "". For example,
add_menu "" mymenu
Note that all window panes, other than the Main window, begin with a period (.). <menu_path> (required) A string that specifies the name of the Tk menu widget plus submenu path. Examples
add_separator $wname user
The add_separator command is also used as part of the add_menu example. See also add_menu change_menu_cmd add_menucb add_menuitem add_submenu
84
Commands add_submenu
add_submenu
The add_submenu command creates a cascading submenu within the specified menu path of the specified window. May be used within a submenu. Returns the full Tk path to the new submenu widget. Syntax add_submenu <window_name> <menu_path> <name> [<shortcut>] Arguments <window_name> (required) A string that specifies the Tk path of the window to contain the menu. To add a menu to the Main window you must express this value as: "". For example,
add_menu "" mymenu
Note that all window panes, other than the Main window, begin with a period (.). <menu_path> (required) A string that specifies the name of the Tk menu widget plus submenu path. <name> (required) A string that specifies the name to be displayed on the submenu. <shortcut> (optional) An integer that specifies the number of the letter in the menu name that is to be used as the shortcut. Numbering starts with 0 (first letter = 0, second letter = 1, third letter = 2, and so on). Default is "-1", which indicates no shortcut is to be used. Examples The add_submenu command is used as part of the add_menu example. See also add_menu change_menu_cmd add_menucb add_menuitem add_separator
85
Commands alias
alias
The alias command displays or creates user-defined aliases. Any arguments passed on invocation of the alias will be passed through to the specified commands. Returns nothing. Existing commands (e.g., run, env, etc.) cannot be aliased. Syntax alias [<name> ["<cmds>"]] Arguments <name> (optional) A string that specifies the new procedure name to be used when invoking the commands. "<cmds>" (optional) A string, enclosed in quotes ("), that specifies the command or commands to be evaluated when the alias is invoked. You must separate multiple commands with a semicolon (;). Examples List all aliases currently defined.
alias
List the alias definition for the specified name if one exists.
alias <name>
Create a Tcl procedure, "myquit", that when executed, writes the contents of the List window to the file mylist.save by invoking write list, and quits ModelSim by invoking quit.
alias myquit "write list ./mylist.save; quit -f"
86
Commands batch_mode
batch_mode
The batch_mode command returns a 1 if ModelSim is operating in batch mode, otherwise it returns a 0. It is typically used as a condition in an if statement. Syntax batch_mode Arguments None Examples Some GUI commands do not exist in batch mode. If you want to write a script that will work in or out of batch mode, you can use the batch_mode command to determine which command to use. For example:
if [batch_mode] { log /* } else { add wave /* }
See also Modes of Operation
87
Commands bd
bd
The bd command deletes a breakpoint. You can delete multiple breakpoints by specifying separate information groupings on the same command line. Syntax bd {{<filename> <line_number>} | {<id_number> | <label>} ... Arguments <filename> (required) A string that specifies the name of the source file in which the breakpoint is to be deleted. The filename must match the one used previously to set the breakpoint, including whether you used a full pathname or a relative name. <line_number> (required) A string that specifies the line number of the breakpoint to be deleted. <id_number> (required) A string that specifies the identification number of the breakpoint to be deleted. If you are deleting a C breakpoint, the identification number will have a "c" prefix. <label> (required) A string that specifies the label of the breakpoint to be deleted. The label is specified with the -label switch to the bp command. Examples Delete the breakpoint at line 127 in the source file named alu.vhd.
bd alu.vhd 127
Delete the breakpoint with id# 5.

bd 5
Delete the breakpoint with the label top_bp

bd top_bp
Delete the breakpoint with id# 6 and the breakpoint at line 234 in the source file named alu.vhd.
bd 6 alu.vhd 234
Delete the C breakpoint with id# c.4.

bd c.4
See also bp
88
onbreak
C Debug
Commands bookmark add wave
bookmark add wave

The bookmark add wave command creates a named reference to a specific zoom range and scroll position in the specified Wave window. Bookmarks are saved in the wave format file and are restored when the format file is read. You can also interactively add a bookmark through the GUI by selecting the Wave > Bookmarks > Bookmarks menu item. Syntax bookmark add wave <label> [[<range_start> [<unit>]] <range_end> [<unit>] [<topindex>]] [-window <window_name>] Arguments <label> (required) A string that specifies the name for the bookmark. [<range_start> [<unit>]] <range_end> [<unit>] (optional) A group of strings that specify the beginning and end points of the zoom range. You must enclose these arguments within braces ({}) or quotation marks (""). If you do not specify the <range_start> argument the bookmark will begin with zero. The tool uses your current time unit if you do not specify <unit>. The complete grouping of <range_start> and <range_end> must also be enclosed in braces ({ }) or quotes (" "), for example:
{{100 ns} {10000 ns}} {10000}
<topindex> (optional) An integer that specifies the vertical scroll position of the window. You must specify a zoom range to specify topindex. The number identifies which object the window should be scrolled to. For example, specifying 20 means the Wave window will be scrolled down to show the 20th object.
-window <window_name> (optional) A switch and argument pair that specifies the window to which the bookmark will be added. If this argument is omitted, the bookmark is added in the current default Wave window.
Examples Add a bookmark named "foo" to the current default Wave window. The bookmark marks a zoom range from 10ns to 1000ns and a scroll position of the 20th object in the window.
bookmark add wave foo {{10 ns} {1000 ns}} 20
89
Commands bookmark add wave
See also bookmark delete wave bookmark goto wave bookmark list wave write format
90
Commands bookmark delete wave
bookmark delete wave

The bookmark delete wave command deletes bookmarks from the specified Wave window. You can also interactively delete a bookmark through the GUI by selecting the Wave > Bookmarks > Bookmarks menu item. Syntax bookmark delete wave {<label> | -all ] [-window <window_name>] Arguments <label> (required) A string that specifies the name of the bookmark to delete. You must specify this argument unless you specify -all. -all (optional) A switch that specifies that all bookmarks in the window be deleted. -window <window_name> (optional) A switch and argument pair that specifies the window from which bookmark(s) will be deleted. Optional. If this argument is omitted, bookmark(s) in the current default Wave window are deleted. Examples Delete the bookmark named "foo" from the current default Wave window.
bookmark delete wave foo
Delete all bookmarks from the Wave window named "wave1".

bookmark delete wave -all -window wave1
See also bookmark add wave bookmark goto wave bookmark list wave write format
91
Commands bookmark goto wave
bookmark goto wave

The bookmark goto wave command zooms and scrolls a Wave window using the specified bookmark. You can also interactively navigate between bookmarks through the GUI by selecting the Wave > Bookmarks > Bookmarks menu item. Syntax bookmark goto wave <label> [-window <window_name>] Arguments <label> (required) A string that specifies the bookmark to go to. -window <window_name> (optional) A switch and argument pair that specifies the Wave window to which the bookmark applies. Optional. Bookmarks can be used only in the windows in which they were originally created. See also bookmark add wave bookmark delete wave bookmark list wave write format
92
Commands bookmark list wave
bookmark list wave

The bookmark list wave command displays a list of available bookmarks in the Transcript pane. Syntax bookmark list wave [-window <window_name>] Arguments -window <window_name> (optional) A switch and argument pair that specifies the Wave window to which the bookmark applies. Optional. Bookmarks can be used only in the windows in which they were originally created. See also bookmark add wave bookmark delete wave bookmark goto wave write format
93
Commands bp
bp
The bp or breakpoint command either sets a file-line breakpoint or returns a list of currently set breakpoints. A set breakpoint affects every SystemC instance in the design unless the -inst <region> argument is used. Note When running in full optimization mode, breakpoints can not be set. Increase the visibility of the design by setting the +acc argument to vopt. Refer to the chapter Optimizing Designs with vopt in the Users Manual for more information. Syntax
Setting an HDL breakpoint
bp <filename> <line_number> [-id <id_number> | -label <label> ] [-inst <region>] [-disable] [-cond <condition_expression>] [<command>]
Setting a C breakpoint
bp -c {<location> | -inst <region>} [-id <id_number> | -label <label>] [-disable] [-cond <condition_expression>] [<command>]
Querying a breakpoint
bp [-query <filename> [<line_number> ...]]

Reporting all breakpoints
bp Arguments <filename> (required for an HDL breakpoint) A string that specifies the name of the source file in which to set the breakpoint. <line_number> (required for an HDL breakpoint) A string that specifies the line number at which the breakpoint is to be set. <location> (required for a C breakpoint) A string that specifies the location of the breakpoint in a SystemC design, or when you are using C Debug. <location> one of the following: <function_name> sets the C breakpoint at the entry to the specified function. [<file_name>:]<line_number> sets the C breakpoint at the specified line number of the file. If you do not specify a file name, the breakpoint is set at the line number of the current C or SystemC file.
94
Commands bp
*0x<hex_address> sets the C breakpoint at the specified hex address. -id <id_number> (optional) A switch and argument pair that attempts to assign this id number to the breakpoint. The command returns an error if the id number you specify is already used. Note Ids for breakpoints are assigned from the same pool as those used for the when command. So, even if you havent used an id number for a breakpoint, its possible it is used for a when command. -inst <region> (optional) A switch and argument pair that sets a SystemC or HDL breakpoint so it applies only to the specified instance, where <region> is the full path to the instance. NOTE: You can also specify this instance by choosing Tools > Breakpoints... from the main menu and using the Modify Breakpoints dialog box. Refer to Modifying File-Line Breakpoints in the Users Manual for more information. -disable (optional) A switch that sets the breakpoint to a disabled state. You can enable the breakpoint later using the enablebp command. This command enables breakpoints by default. -cond <condition_expression> (optional) A switch and argument pair that specifies condition(s) that determine whether the breakpoint is hit. You must enclose the condition expression within quotation marks ("). If the condition is true, the simulation stops at the breakpoint. If false, the simulation bypasses the breakpoint. A condition cannot refer to a VHDL variable (only a signal). NOTE: You can also specify this expression by choosing Tools > Breakpoints... from the main menu and using the Modify Breakpoints dialog box. Refer to Modifying File-Line Breakpoints in the Users Manual for more information. The condition can be an expression with these operators: Operator equals not equal AND OR ==, = !=, /= &&, AND ||, OR
The operands may be object names, signameevent, or constants. Subexpressions in parentheses are permitted. The command will be executed when the expression is evaluated as TRUE or 1. The formal BNF syntax is:
95
Commands bp condition ::= Name | { expression } expression ::= expression AND relation | expression OR relation | relation relation ::= Name = Literal | Name /= Literal | Name ' EVENT | ( expression ) Literal ::= '<char>' | "<bitstring>" | <bitstring>
The "=" operator can occur only between a Name and a Literal. This means that you cannot compare the value of two signals; i.e., Name = Name is not possible. You can construct a breakpoint such that the simulation breaks when a SystemVerilog Class is associated with a specific handle, or address:
bp <filename> <line_number> -cond "this==<class_handle>" bp <filename> <line_number> -cond "this!=<class_handle>"
where you can obtain the class handle with the examine -handle command. The string "this" is a literal that refers to the specific line_number. You can construct a breakpoint such that the simulation breaks when a line number is of a specific class type or extends the specified class type:
bp <filename> <line_number> -cond "this ISA <class_type_name>"
where class_type_name is the actual class name, not a variable. <command> (optional) A string, enclosed in braces ({ }) that specifies one or more commands that are to be executed at the breakpoint. You must separate multiple commands by semicolons (;) or placed on multiple lines. NOTE: You can also specify this command string by choosing Tools > Breakpoints... from the main menu and using the Modify Breakpoints dialog box. Refer to Modifying File-Line Breakpoints in the Users Manual for more information. Any commands that follow a run or step command are ignored. A run or step command terminates the breakpoint sequence. This rule also applies if you use a macros within the command string. You cannot use a restore command. If many commands are needed after the breakpoint, you could place them in a macro file. -label <label> (optional) a string, enclosed in quotes (") or braces ({ }), that adds a level of identification to the break point. The quotes or braces are only required if <label> does not contain spaces or special characters.
96
Commands bp
-query <filename> [<line_number> ...] (optional) A switch and argument group that returns information about the breakpoints set in the specified file. The information returned varies depending on which arguments you specify. The output contains six pieces of information, for example:
bp -query top.vhd 70 # 1 1 top.vhd 70 2 1 o o o o o o
{1 | 0} Indicates whether a breakpoint exists at the location. 1 always reports a 1 <file_name> <line_number> <id_number> {1 | 0} Indicates whether the breakpoint is enabled
If you specify this command with no arguments, it returns a list of all breakpoints in the design containing the following information, for example:
bp # bp top.vhd 70;# 2 o o o o
bp an echo of the command <file_name> <line_number> # <id_number>
Examples List all existing breakpoints in the design, including the source file names, line numbers, breakpoint id#s, and any commands that have been assigned to breakpoints.
bp
Set a breakpoint in the source file alu.vhd at line 147.

bp alu.vhd 147
Execute the macro.do macro file when the breakpoint is hit.

bp alu.vhd 147 {do macro.do}
Set a breakpoint on line 22 of test.vhd. When the breakpoint is hit, the values of variables var1 and var2 are examined. This breakpoint is initially disabled; it can be enabled with the enablebp command.
bp -disable test.vhd 22 {echo [exa var1]; echo [exa var2]}
97
Commands bp
Set a breakpoint in every instantiation of the file test.vhd at line 14. When that breakpoint is executed, the Tcl command is run. This Tcl command causes the simulator to continue if the current simulation time is not 100.
bp test.vhd 14 {if {$now /= 100} then {cont}}
Set a breakpoint so that the simulation pauses whenever clk=1 and prdy=0:
bp test.vhd 14 -cond "clk=1 AND prdy=0"
Set a breakpoint with the label top_bp

bp top.vhd 14 -label top_bp
Set a breakpoint for line 15 of a.vhd, but only for the instance a2:
bp a.vhd 15 -inst "/top/a2"
Set a breakpoint for a specific variable of a particular class type:

set x [examine -handle my_class_var] bp top.sv 15 -cond "this == $x"
List the line number and enabled/disabled status (1 = enabled, 0 = disabled) of all breakpoints in testadd.vhd.
bp -query testadd.vhd

98
List details about the breakpoint on line 48.

bp -query testadd.vhd 48
List all executable lines in testadd.vhd between lines 2 and 59.

bp -query testadd.vhd 2 59
Sets a C breakpoint at the entry to C function and_gate_init.

bp -c and_gate_init
Sets a C breakpoint at line 46 in the file and_gate.c.

bp -c and_gate.c:46
Sets a C breakpoint at line 44 in the current C or SystemC file.

bp -c 44
Sets a C breakpoint at hexadecimal address 0xff130504.

bp -c *0xff130504
Sets a C breakpoint for instances sctop.a.b and sttop.a.d.

bp -c -inst "sctop.a.b sctopa.d"
Sets a C breakpoint for all instances whose name begins with sctop.a.c.
Commands bp bp -c -inst "sctop.a.c*"
Note Any breakpoints set in VHDL code and called by either resolution functions or functions that appear in a port map are ignored. See also add button onbreak bd when disablebp SystemC Simulation enablebp C Debug
99
Commands cd
cd
The cd command changes the ModelSim local directory to the specified directory. This command cannot be executed while a simulation is in progress. Also, executing a cd command will close the current project. Syntax cd [<dir>] Arguments <dir> (optional) A string that specifies a full or relative directory path to which to change. If you do not specify a directory, the command changes to your home directory.
100
Commands cdbg
cdbg
The cdbg command provides command-line equivalents of the menu options that are available for C Debug. For some of the commands there is a required argument "on | off". The value can be either on or off. For example:
cdbg enable_auto_step on cdbg stop_on_quit off
Syntax cdbg {allow_lib_step {on | off} | auto_find_bp | debug_on | enable_auto_step {on | off} | init_mode_complete | init_mode_setup | interrupt | keep_user_init_bps {on | off} | quit | refresh_source_window | set_debugger <path> | show_source_balloon {on | off} | stop_on_quit {on | off} | trace_entry_point {on | off} [<function_name>]} Arguments allow_lib_step {on | off} An argument that enables (off) or disables (on) stepping out from OSCI library functions (off). When you try to step inside OSCI library functions, C Debug automatically steps out to the last user function that was called. Note that setting this argument to on disables the stepping out action. auto_find_bp An argument that sets breakpoints on all currently known function entry points. Refer to Finding Function Entry Points with Auto Find bp". Equivalent to selecting Tools > C Debug > Auto find bp. debug_on An argument that enables the C Debugger. Equivalent to selecting Tools > C Debug > Start C Debug. enable_auto_step {on | off} An argument that enables (on) or disables (off) auto-step mode. Refer to Identifying All Registered Function Calls. Equivalent to selecting Tools > C Debug > Enable auto step. init_mode_complete An argument that instructs C Debug to continue loading the design without stopping at functions calls. Refer to Debugging Functions During Elaboration. Equivalent to selecting Tools > C Debug > Complete load. Not supported on Windows platform.
101
Commands cdbg
init_mode_setup An argument that enables initialization mode. Refer to Debugging Functions During Elaboration. Equivalent to selecting Tools > C Debug > Init mode. Not supported on Windows platform.
interrupt An argument that reactivates the C debugger when stopped in HDL code. Equivalent to selecting Tools > C Debug > C Interrupt or clicking the 'C Interrupt' toolbar button.
keep_user_init_bps {on | off} An argument that specifies whether breakpoints set during initialization mode are retained after the design finishes loading. Refer to Debugging Functions During Elaboration. Equivalent to toggling the 'Keep user init bps' button in the C Debug setup dialog.
quit An argument that quits the C Debugger. Equivalent to selecting Tools > C Debug > Quit C Debug.
refresh_source_window An argument that re-opens a C source file if you close the Source window inadvertently while stopped in the C debugger. Equivalent to selecting Tools > C Debug > Refresh.
set_debugger <path> An argument that sets the path to your gdb installation. Equivalent to selecting Tools > C Debug > C Debug Setup and entering a custom path. The argument path is required and is the complete pathname to the gdb executable. For example: cdbg set_debugger_path /usr/bin/gdb
show_source_balloon {on | off} An argument that enables (on) or disables (off) the source balloon popup. Equivalent to toggling the 'Show balloon' button on the C Debug setup dialog.
stop_on_quit {on | off} An argument that enables (on) or disables (off) debugging capability when the simulator is exiting. Refer to Debugging Functions when Quitting Simulation. Equivalent to toggling the 'Stop on quit' button on the C Debug setup dialog.
102
Commands cdbg
trace_entry_point {on | off} [<function_name>] An argument that helps debug an FLI/PLI application when a design is loaded with vsim trace_foreign. ModelSim stops at a C breakpoint each time a named FLI or PLI function is called from your application. Once at the breakpoint, use the tb and pop commands to investigate the C code at the place the function was called.
103
Commands change
change
The change command modifies the value of a: Syntax change <variable> <value> Arguments <variable> (required) A string that specifies the name of an object. The name can be a full hierarchical name or a relative name, where a relative name is relative to the current environment. You cannot use Wildcards. The following sections list supported objects: VHDL
o
VHDL constant, generic, or variable Verilog register or variable C variable if running C Debug
Scalar variable, constant, or generics of all types except FILE. The tool generates a warning when changing a VHDL constant or generic. You can suppress this warning by setting the TCL variable WarnConstantChange to 0 or in the [vsim] section of the modelsim.ini file.
Scalar subelement of composite variable, constant, and generic of all types except FILE. One-dimensional array of enumerated character types, including slices. Access type. An access type pointer can be set to "null"; the value that an access type points to can be changed as specified above.
o o
Verilog
o o o o
Parameter. Register or memory. Integer, real, realtime, time, and local variables in tasks and functions. Subelements of register, integer, real, realtime, and time multi-dimensional arrays (all dimensions must be specified). Bit-selects and part-selects of the above except for objects whose basic type is real.
C
o
Scalar C variables of type int, char, double, or float.

104
Commands change o o
Individual fields of a C structure. SystemC primitive channels are not supported.
The name can be a full hierarchical name or a relative name. A relative name is relative to the current environment. Wildcards cannot be used. Required. <value> (required) A string that defines a value for the <variable>. The specified value must be appropriate for the type of the variable. You must enclose any <value> that contain spaces within quotation marks or curly braces. Note that the initial type of a parameter determines the type of value that it can be given. For example, if a parameter is initially equal to 3.14 then only real values can be set on it. Also note that changing the value of a parameter or generic will not modify any design elements that depended on the parameter or generic during elaboration (for example, sizes of arrays). Examples Change the value of the variable count to the hexadecimal value FFFF.
change count 16#FFFF
Change the value of the element of rega that is specified by the index (i.e., 16).
change {rega[16]} 0
Change the value of the set of elements of foo that is specified by the slice (i.e., 20:22).
change {foo[20:22]} 011
Set the value of x (type double) to 1.5.

change x 1.5
Set the value of structure member a1.c1 (type int) to 0.

change a1.c1 0
Set val_b (type char *) to point to the string my_string.

change val_b my_string
Set val_b (type char *) to point to the string my string. Since there is a space in the value, it must be enclosed by quotation marks or curly braces.
change val_b "my string"
Set the Verilog register file_name to "test2.txt". Note that the quote marks are escaped with \.
change file_name \"test2.txt\"
105
Commands change
Set the time value of the mytimegeneric variable to 500 ps. The time value is enclosed by curly braces (or quotation marks) because of the space between the value and the units.
change mytimegeneric {500 ps}
See also force
106
Commands change_menu_cmd
change_menu_cmd
The change_menu_cmd command changes the command to be executed for a specified menu item label, in the specified menu, in the specified window. The menu path and label must already exist for this command to function. Returns nothing. Syntax change_menu_cmd <window_name> <menu_path> <label> <Cmd> Arguments <window_name> (required) A string that specifies the Tk path of the window containing the menu. The path for the Main window must be expressed as "". All other window pathnames begin with a period (.). <menu_path> (required) A string that specifies the name of an existing Tk menu widget plus any submenu path. <label> (required) A string that specifies the current label on the menu item. <Cmd> (required) A string that specifies the new Tcl command to be executed when selected. See also add_menu, add_menucb, add_menuitem, add_separator, add_submenu
107
Commands check contention add
check contention add

The check contention add command enables contention checking for the specified nodes. The allowed nodes are Verilog nets and VHDL signals of types std_logic and std_logic_vector. This command ignores any other node types or nodes that do not have multiple drivers. Syntax check contention add {[-in] [-out] [-inout] | [-ports]} [-internal] [-r] <node_name>... Arguments -in (optional) A switch that enables checking on nodes of mode IN. -inout (optional) A switch that enables checking on nodes of mode INOUT. -internal (optional) A switch that enables checking on internal (non-port) objects. -out (optional) A switch that enables checking on nodes of mode OUT. -ports (optional) A switch that enables checking on nodes of modes IN, OUT, or INOUT. -r (optional) A switch that specifies that contention checking is enabled recursively into subregions. If omitted, contention check enabling is limited to the current region. <node_name>... (required) A string that specifies the name of a node. Description Bus contention checking detects bus fights on nodes that have multiple drivers. A bus fight occurs when two or more drivers drive a node with the same strength and that strength is the strongest of all drivers currently driving the node. The following table provides some examples for two drivers driving a std_logic signal: driver 1 Z 0 1 0 L driver 2 Z 0 Z 1 1 fight no yes no yes no
108
Commands check contention add
driver 1 L
driver 2 H
fight yes
Detection of a bus fight results in an error message specifying the node and its drivers current driving values. If a node's drivers later change value and the node is still in contention, a message is issued giving the new values of the drivers. A message is also issued when the contention ends. The bus contention checking commands can be used on VHDL and Verilog designs. See also check contention config, check contention off
109
Commands check contention config
check contention config

The check contention config command allows you to write checking messages to a file. By default, any messages display on your screen. You may also configure the contention time limit. Syntax check contention config [-file <filename>] [-time <limit>] Arguments -file <filename> (optional) A switch and argument pair that specifies a file to which to write contention messages. When you specify this switch, check contention messages will not be displayed to the screen. -time <limit> (optional) A switch and argument pair that specifies a time limit that a node may be in contention. Contention is detected if a node is in contention for as long as or longer than the limit. The default limit is 0. See also check contention add, check contention off
110
Commands check contention off
check contention off

The check contention off command disables contention checking for the specified nodes. Syntax check contention off [-all] {[-in] [-out] [-inout] | [-ports]} [-internal] [-r] <node_name> ... Arguments -all (optional) A switch that disables contention checking for all nodes that have checking enabled. -r (optional) A switch that specifies that contention checking is disabled recursively into subregions. If omitted, contention check disabling is limited to the current region. -in (optional) A switch that disables checking on nodes of mode IN. -out (optional) A switch that disables checking on nodes of mode OUT. -inout (optional) A switch that disables checking on nodes of mode INOUT. -internal (optional) A switch that disables checking on internal (non-port) objects. -ports (optional) A switch that disables checking on nodes of modes IN, OUT, or INOUT. <node_name> ... (required) A string that specifies the named node(s). See also check contention add, check contention config
111
Commands check float add
check float add

The check float add command enables float checking for the specified nodes. The allowed nodes are Verilog nets and VHDL signals of type std_logic and std_logic_vector (other types are silently ignored). You can set a time limit (the default is zero) for float checking using the -time <limit> argument to the check float config command. If you choose to modify the limit, you should do so prior to invoking any check float add commands. Syntax check float add {[-in] [-out] [-inout] | [-ports] } [-internal] [-r] <node_name> ... Arguments -r (optional) A switch that specifies that float checking is enabled recursively into subregions. If omitted, float check enabling is limited to the current region. -in (optional) A switch that enables checking on nodes of mode IN. -out (optional) A switch that enables checking on nodes of mode OUT. -inout (optional) A switch that enables checking on nodes of mode INOUT. -internal (optional) A switch that enables checking on internal (non-port) objects. -ports (optional) A switch that enables checking on nodes of modes IN, OUT, or INOUT. <node_name> ... (required) A string that enables checking for the named node(s). Description Bus float checking detects nodes that are in the high impedance state for a time equal to or exceeding a user-defined limit. This is an error in some technologies. Detection of a float violation results in an error message identifying the node. A message is also issued when the float violation ends. The bus float checking commands can be used on VHDL and Verilog designs. See also check float config, check float off
112
Commands check float config
check float config

The check float config command allows you to write checking messages to a file (messages display on your screen by default). You may also configure the float time limit. Syntax check float config [-file <filename>] [-time <limit>] Arguments -file <filename> (optional) A switch and argument pair that specifies a file to which to write float messages. If this option is selected, the messages are not displayed to the screen. -time <limit> (optional) A switch and argument pair that specifies a time limit that a node may be floating. An error is detected if a node is floating for as long as or longer than the limit. The default limit is 0. Note that you should configure the time limit prior to invoking any check float add commands. See also check float add, check float off
113
Commands check float off
check float off

The check float off command disables float checking for the specified nodes. Syntax check float off [-all] {[-in] [-out] [-inout] | [-ports]} [-internal] [-r] <node_name> ... Arguments -all (optional) A switch that disables float checking for all nodes that have checking enabled. -r (optional) A switch that specifies that float checking is disabled recursively into subregions. If omitted, float check disabling is limited to the current region. -in (optional) A switch that disables checking on nodes of mode IN. -out (optional) A switch that disables checking on nodes of mode OUT. -inout (optional) A switch that disables checking on nodes of mode INOUT. -internal (optional) A switch that disables checking on internal (non-port) objects. -ports (optional) A switch that disables checking on nodes of modes IN, OUT, or INOUT. <node_name> ... (required) A string that disables checking for the named node(s). See also check float add, check float config
114
Commands check stable off
check stable off

The check stable off command disables stability checking. You may later enable it with check stable on, and meanwhile, the clock cycle numbers and boundaries are still tracked. Syntax check stable off Arguments None
See also check stable on
115
Commands check stable on
check stable on
The check stable on command enables stability checking on the entire design. Syntax check stable on [-file <filename>] [-period <time>] [-strobe <time>] Arguments -file <filename> (optional) A switch and argument pair that specifies a file to which to write the error messages. If this option is selected, the messages are not displayed to the screen. -period <time> (optional) A switch and argument pair that specifies the clock period (which is assumed to begin at the time the check stable on command is issued). This option is required the first time you invoke the check stable on command. It is not required if you later enable checking after it was disabled with the check stable off command. -strobe <time> (optional) A switch and argument pair that specifies the elapsed time within each clock cycle that the stability check is performed. The default strobe time is the period time. If the strobe time falls on a period boundary, then the check is actually performed one timestep earlier. Normally the strobe time is specified as less than or equal to the period, but if it is greater than the period, then the check will skip cycles. Description Design stability checking detects when circuit activity has not settled within a period you define for synchronous designs. You specify the clock period for the design and the strobe time within the period during which the circuit must be stable. A violation is detected and an error message is issued if there are pending driver events at the strobe time. The message identifies the driver that has a pending event, the node that it drives, and the cycle number. The design stability checking commands can be used on VHDL and Verilog designs. Examples Performs a stability check 99 ps into each even numbered clock cycle (cycle numbers start at 1).
check stable on -period "100 ps" -strobe "199 ps"
See also check stable off
116
Commands checkpoint
checkpoint
The checkpoint command saves the state of your simulation, including: the simulation kernel state the vsim.wlf file the list of the design objects shown in the List and Wave windows the file pointer positions for files opened under VHDL and the Verilog $fopen system task the states of foreign architectures VCD output Toggle statistics are saved (see the toggle report command)
However, it does not save the following: Changes you made interactively while running vsim are not saved; for example, macros, virtual objects, command-line interface additions like user-defined commands, and states of graphical user interface Transactions
Once saved, a checkpoint file may be used with the restore command during the same simulation to restore the simulation to a previous state. A VSIM session may also be started with a checkpoint file by using the vsim -restore command. Compression of the checkpoint file is controlled by the CheckpointCompressMode variable in the modelsim.ini file. If a checkpoint occurs while ModelSim is writing a VCD file, the entire VCD file is copied into the checkpoint file. Since VCD files can be very large, it is possible that disk space problems could occur. Consequently, ModelSim issues a warning in this situation. Checkpoint files are platform dependent, therefore you cannot checkpoint on one platform and restore on another. If checkpointing DPI code that works with heap memory, use mti_Malloc() rather than raw malloc() or new. Any memory allocated with mti_Malloc() is guaranteed to be restored correctly. Any memory allocated with raw malloc() will not be restored correctly, and simulator crashes can result. Syntax checkpoint <filename> Arguments <filename> (required) An argument that specifies the name of the checkpoint file.
117
Commands checkpoint
See also restore, restart, vsim, Checkpointing and Restoring Simulations
118
Commands compare add
compare add
The compare add command creates an object that is a comparison between signals in a reference design against signals in a test design. You can specify whether to compare two signals, all signals in the region, or just ports or a subset of ports. Constant signals such as parameters and generics are ignored. Refer to Waveform Compare for a general overview of waveform comparisons. The names of the added comparison objects take the form:
<path>/\refSignalName<>testSignalName\
If you compare two signals from different regions, the signal names include the uncommon part of the path. Table 2-2 shows how comparisons work between specified reference objects and test objects. Table 2-2. Comparing Reference Objects to Test Objects Reference object signal signal Test object signal region Result compare the two signals compare a signal with a name matching the reference signal in the specified test region compare all matching signals in both regions legal only if the glob expression selects only one signal compare all signals matching the glob expression that match signals in the test region
region glob expression glob expression
region signal region
The compare add command supports arguments that specify how each signal state matches std_logic or Verilog values (e.g., -vhdlmatches, see below). Since state matching can also be set on a global basis with the compare options command or PrefCompare() Tcl variables, ModelSim follows state match settings in this order: 1. Use local matching values specified when the compare was created using compare add or subsequently configured using compare configure. 2. If no local values were set, use global matching values set with the compare options command. 3. If no compare options were set, use default matching values specified by PrefCompare Tcl variables.
119
Syntax compare add -clock <name> [-help] [-label <label>] [-list] [-<mode>] [-nowin] [-rebuild] [-recursive] [-separator <string>] [-tol <delay>] [-tolLead <delay>] [-tolTrail <delay>] [-verbose] [-vhdlmatches {<ref-logic-value>=<test-logic-value>:}] [-vlogmatches {<ref-logic-value>=<test-logic-value>:}] [-wavepane <n>] [-when {<expression>}] <referencePath> [<testPath>] [-wave] [-win <wname>] Arguments -clock <name> Specifies the clock definition to use when sampling the specified regions. Required for a clocked comparison; not used for asynchronous comparisons. -help Lists the description and syntax for the compare add command in the Transcript pane. Optional. -label <label> Specifies a name for the comparison when it is displayed in the Wave window. Optional. -list Causes specified comparisons to be displayed in the default List window. Optional. -<mode> Specifies the mode of signal types that are compared. Optional. The actual values the option may take are -in, -out, -inout, -internal, -ports, and -all. You can use more than one mode option in the same command. -nowin Specifies that compare signals shouldnt be added to any window. Optional. By default, compare signals are added to the default Wave window. See -wave below. -rebuild Rebuilds a fragmented bus in the test design region and compares it with the corresponding bus in the reference design region. Optional. If a signal is found having the same name as the reference signal, the -rebuild option is ignored. When rebuilding the test signal, the name of the reference signal is used as the wildcard prefix. -recursive Specifies that signals should also be selected in all nested subregions, and subregions of those, etc. Optional. -separator <string> Used with the -rebuild option. When a bus has been broken into bits (bit blasted) by a synthesis tool, ModelSim expects a separator between the base bus name and the bit
120
indication. This option identifies that separator. The default is "_". For example, the signal "mybus" might be broken down into "mybus_0", "mybus_1", etc. -tol <delay> Specifies the maximum time a test signal edge is allowed to lead or trail a reference edge in an asynchronous comparison. Optional. The default is 0. If a unit (e.g., ps) is used with the time value, the time must be placed in curly braces. -tolLead <delay> Specifies the maximum time a test signal edge is allowed to lead a reference edge in an asynchronous comparison. Optional. The default is 0. If a unit (e.g., ps) is used with the time value, the time must be placed in curly braces. -tolTrail <delay> Specifies the maximum time a test signal edge is allowed to trail a reference edge in an asynchronous comparison. Optional. The default is 0. If a unit is used (e.g., ps) with the time value, the time must be placed in curly braces. Graphical representation of tolLead and tolTrail
Reference Signal
Test Signal
tolLead tolTrail
-verbose Prints information in the Transcript pane confirming the signals selected for comparison and any type conversions employed. Optional.
-vhdlmatches {<ref-logic-value>=<test-logic-value>:} Specifies how VHDL signal states in the reference dataset should match values in the test dataset. Optional. Values are specified in a colon-separated list of match values. For example:
-vhdlmatches {X=XUD:Z=ZD:1=1HD}
Default is:
{U=UWXD:X=UWXD:0=0LD:1=1HD:Z=ZD:W=UWXD:L=0LD:H=1HD:D=UX01ZWLHD}
The 'D' character represents the '-' "don't care" std_logic value.
121
-vlogmatches {<ref-logic-value>=<test-logic-value>:} Specifies how Verilog signal states in the reference dataset should match values in the test dataset. Optional. Values are specified in a colon-separated list of match values. For example:
-vlogmatches {0=0:1=1:Z=Z}
Default is:
{0=0:1=1:Z=Z:X=X}.
-wavepane <n> Specifies the pane of the Wave window in which the differences will be viewed. Optional. -wave Specifies that compare signals be added automatically to the default Wave window. Optional. Default.
-when {<expression>} Specifies a conditional expression that must evaluate to "true" or "1" for differences to be reported. Optional. The expression is evaluated at the start of an observed difference. See GUI_expression_format for legal expression syntax.
-win <wname> Specifies a particular window to which to add objects. Optional. Used to specify a particular window when multiple instances of that window type exist.
<referencePath> Specifies either an absolute or relative path to the reference signal or region, or a glob expression. Required. Relative paths are relative to the current context of the reference dataset. If you specify a glob expression, it will match signals only in the containing context.
<testPath> Specifies an absolute or relative path to the test signal or region. Cannot be a glob expression. Optional. If omitted, the test path defaults to the same path as <referencePath> except for the dataset name.
Examples Select signals in the reference and test dataset top region according to the default mode. Uses asynchronous comparison with the default tolerances. Assumes that the top regions of the reference and test datasets have the same name and contain the same signals with the same names.
compare add /*
Select port signals of instance .test_ringbuf.ring_inst in both datasets to be compared and sampled on strobe myclock10.
122
Commands compare add compare add -port -clock myclock10 gold:.test_ringbuf.ring_inst
Select all signals in the cpu region to be compared asynchronously using the default tolerances. Requires that the reference and test relative hierarchies and signal names within the cpu region be identical, but they need not be the same above the cpu region.
compare add -r gold:/top/cpu test:/testbench/cpu
Specify that signal gold:.top.s1 should be sampled at clock12 and compared with test:.top.s1, also sampled at clock12.
compare add -clock clock12 gold:.top.s1
Specify that signal gold:/asynch/abc/s1 should be compared asynchronously with signal sim:/flat/sigabc using a leading tolerance of 3 ns and a trailing tolerance of 5 ns.
compare add -tolLead {3 ns} -tolTrail {5 ns} gold:/asynch/abc/s1 sim:/flat/sigabc
Cause signals test:.counter2.cnt_dd to be rebuilt into bus test:.counter2.cnt[] and compared against gold:.counter1.count.
compare add -rebuild gold:.counter1.count test:.counter2.cnt
See also compare add, compare annotate, compare clock, compare configure, compare continue, compare delete, compare end, compare info, compare list, compare options, compare reload, compare reset, compare run, compare savediffs, compare saverules, compare see, compare start, compare stop, compare update, and Waveform Compare
123
Commands compare annotate
compare annotate
The compare annotate command either flags a comparison difference as "ignore" or adds a text string annotation to the difference. The text string appears when the difference is viewed in info popups or in the output of a compare open command. Syntax compare annotate [-ignore] [-noignore] [-text <message>] <idNum1> [<idNum2>] Arguments -ignore Flags the specified difference as "ignore." Optional. -noignore Undoes a previous -ignore command. Optional. -text <message> Adds a text string annotation to the difference that is shown wherever the difference is viewed. Optional. <idNum1> Identifies the difference number to annotate. Required. You can obtain a differences number using the compare start command or a popup dialog. Difference numbers are ordered by time of the difference start, but there may be more than one difference starting at a given time. <idNum2> Identifies a second, third, etc. difference number to be annotated in the same way as idNum1. Optional. These are individual references; ranges of numbers cannot be specified. Examples Flag difference numbers 1, 2, and 10 as "ignore."
compare annotate -ignore 1 2 10
Annotate difference number 12 with the message "THIS IS A CRITICAL PROBLEM."

compare annotate -text "THIS IS A CRITICAL PROBLEM" 12
See also compare add, compare info, and Waveform Compare
124
Commands compare clock
compare clock
The compare clock command defines a clock that can then be used for clocked-mode comparisons. In clocked-mode comparisons, signals are sampled and compared only at or just after an edge on some signal. Syntax compare clock [-delete] [-offset <delay>] [-rising | -falling | -both] [-when {<expression>}] <clock_name> <signal_path> Arguments -delete Deletes an existing compare clock. Optional. -offset <delay> Specifies a time value for delaying the sample time beyond the specified signal edge. Optional. The default is 0. If a unit (e.g., ps) is used with the time value, the time must be placed in curly braces. -rising Specifies that the rising edge of the specified signal should be used. Optional. This is the default. -falling Specifies that the falling edge of the specified signal should be used. Optional. The default is rising. -both Specifies that both the rising and the falling edge of the specified signal should be used. Optional. The default is rising. -when {<expression>} Specifies a conditional expression that must evaluate to "true" or "1" for that clock edge to be used as a strobe. Optional. The expression is evaluated at the time of the clock edge, rather than after the delay has been applied. See GUI_expression_format for legal expression syntax. <clock_name> A name for this clock definition. Required. This name will be used with the compare add command when doing a clocked-mode comparison. <signal_path> A full path to the signal whose edges are to be used as the strobe trigger. Required.
125
Commands compare clock
Examples Define a clocked compare strobe named "strobe" that samples signals on the rising edge of signal gold:.top.clock.
compare clock -rising strobe gold:.top.clock
Define a clocked compare strobe named "clock12" that samples signals 12 ns after the rising edge of signal gold:/mydesign/clka.
compare clock -rising -delay {12 ns} clock12 gold:/mydesign/clka
See also compare add, Waveform Compare
126
Commands compare configure
compare configure
The compare configure command modifies options for compare signals and regions. The modified options are applied to all objects in the specified compare path. Syntax compare configure [-clock <name>] [-recursive] [-tol <delay>] [-tolLead <delay>] [-tolTrail <delay>] [-vhdlmatches {<ref-logic-value>=<test-logic-value>:}] [-vlogmatches {<ref-logic-value>=<test-logic-value>:}] [-when {<expression>}] <comparePath> Arguments -clock <name> Changes the strobe signal for the comparison. Optional. If the comparison is currently asynchronous, it will be changed to clocked. This switch may not be used with the -tol, -tolLead, and -tolTrail options. -recursive Specifies that signals should also be selected in all nested subregions, and subregions of those, etc. Optional. -tol <delay> Specifies the default maximum time the test signal edge is allowed to trail or lead the reference edge in an asynchronous comparison. Optional. The default is 0. If a unit is used (e.g., ps) with the time value, the time must be in curly braces. -tolLead <delay> Specifies the maximum time a test signal edge is allowed to lead a reference edge in an asynchronous comparison. Optional. The default is 0. If a unit (e.g., ps) is used with the time value, the time must be placed in curly braces. -tolTrail <delay> Specifies the maximum time a test signal edge is allowed to trail a reference edge in an asynchronous comparison. Optional. The default is 0. If a unit is used (e.g., ps) with the time value, the time must be placed in curly braces. -vhdlmatches {<ref-logic-value>=<test-logic-value>:} Specifies how VHDL signal states in the reference dataset should match values in the test dataset. Optional. Values are specified in a colon-separated list of match values. For example:
Default is:
{U=UWXD:X=UWXD:0=0LD:1=1HD:Z=ZD:W=UWXD:L=0LD:H=1HD:-=UX01ZWLHD}
127
Commands compare configure
-vlogmatches {<ref-logic-value>=<test-logic-value>:} Specifies how Verilog signal states in the reference dataset should match values in the test dataset. Optional. Values are specified in a colon-separated list of match values. For example:
Default is:
{0=0:1=1:Z=Z:X=X}
-when {<expression>} Specifies a conditional expression that must evaluate to "true" or "1" for differences to be reported. Optional. The expression is evaluated at the start of an observed difference. See GUI_expression_format for legal expression syntax.
<comparePath> Identifies the path of a compare signal, region, or glob expression. Required.
128
Commands compare continue
compare continue
This command is used to continue with comparison difference computations that were suspended using the compare stop button or Control-C. If the comparison was not suspended, compare continue has no effect. Syntax compare continue Arguments None
See also compare stop, Waveform Compare
129
Commands compare delete
compare delete
The compare delete command deletes a comparison object from the currently open comparison. Syntax compare delete [-recursive] {<objectPath> } Arguments -recursive Deletes a region recursively. Optional. {<objectPath> } Path to the comparison object to be deleted (e.g., {compare:/top/\clk<>clk\ }). Required. The comparison object must be "escaped" correctly so the braces {} and trailing space are required. See also compare add, Waveform Compare
130
Commands compare end
compare end
The compare end command closes the active comparison without saving any information. Syntax compare end Arguments None
131
Commands compare info
compare info
The compare info command lists the results of the comparison in the Main window transcript. To save the information to a file, use the -write argument. Syntax compare info [-all] [-count] [-primaryonly] [-signals] [-secondaryonly] [<startNum> [<endNum>]] [-summary] [-write <filename>] Arguments -all Lists all differences (even those marked as "ignore") in the output. Optional. By default, ignored differences are not listed in the output of a compare info command. -count Returns the total number of primary differences found. -primaryonly Lists only differences on individual bits, ignoring aggregate values such as a bus. Optional. -signals Returns a Tcl list of compare signal names that have at least one difference. -secondaryonly Lists only aggregate value differences such as a bus, ignoring the individual bits. <startNum> [<endNum>] Specifies the difference numbers to start and end the list with. Optional. If omitted, ModelSim starts the listing with the first difference and ends it with the last. If just endNum is omitted, ModelSim ends the listing with the last difference. -summary Lists only summary information. Optional. -write <filename> Saves the summary information to <filename> rather than the Main window transcript. Optional. Examples List all errors in the Main window transcript.
compare info
List only an error summary in the Main window transcript.

compare info -summary
Write errors 20 through 50 to the file myerrorfile.
132
Commands compare info compare info -write myerrorfile 20 50
See also compare add, compare annotate, Waveform Compare
133
Commands compare list
compare list
Displays in the Transcript pane a list of all the compare add commands currently in effect. Syntax compare list [-expand] Arguments -expand Expands groups specified by the compare add command to individual signals. Optional. See also compare add, Waveform Compare
134
Commands compare options
compare options
The compare options command sets defaults for various waveform comparison commands. Those defaults are used when other compare commands are invoked during the current session. To set defaults permanently, edit the appropriate PrefCompare() Tcl variable. Refer to Simulator GUI Preferences for details. If no arguments are used, compare options returns the current setting for all options. If one option is given that requires a value, and if that value is not given, compare options returns the current value of that option. Syntax compare options [-addwave][-noaddwave] [-ignoreVlogStrengths] [-noignoreVlogStrengths] [-maxsignal <n>] [-maxtotal <n>] [-listwin <name>] [-<mode>] [-separator <string>] [-tol <delay>] [-tolLead <delay>] [-tolTrail <delay>] [-track] [-notrack] [-vhdlmatches {<ref-logic-value>=<test-logic-value>:}] [-vlogmatches {<ref-logic-value>=<test-logic-value>:}] [-wavepane <n>] [-wavewin <name>] Arguments -addwave Specifies that new comparison objects are added automatically to the Wave window. Optional. Default. You can specify that objects arent added automatically using the -noaddwave argument. Related Tcl variable is PrefCompare(defaultAddToWave). -noaddwave Specifies that new comparison objects are not added automatically to the Wave window. Optional. The default is to add comparison objects automatically. Related Tcl variable is PrefCompare(defaultAddToWave). -ignoreVlogStrengths Specifies that Verilog net strengths should be ignored when comparing two Verilog nets. Optional. Default. Related Tcl variable is PrefCompare(defaultIgnoreVerilogStrengths). -noignoreVlogStrengths Specifies that Verilog net strengths should not be ignored when comparing two Verilog nets. Optional. Related Tcl variable is PrefCompare(defaultIgnoreVerilogStrengths). -listwin <name> Causes specified comparisons to be displayed in the specified List window. Optional. Related Tcl variable is PrefCompare(defaultListWindow). -maxsignal <n> Specifies an upper limit for the total differences encountered on any one signal. When that limit is reached, ModelSim stops computing differences on that signal. Optional. The default is 100. Related Tcl variable is PrefCompare(defaultMaxSignalErrors).
135
-maxtotal <n> Specifies an upper limit for the total differences encountered. When that limit is reached, ModelSim stops computing differences. Optional. The default is 1000. Related Tcl variable is PrefCompare(defaultMaxTotalErrors).
-<mode> Specifies the default mode of signal types that are compared with the compare add command. Optional. The actual values the option may take are -in, -out, -inout, -internal, ports, and -all. More than one mode option may be used in the same compare options command.
-separator <string> Used with the -rebuild option of the compare add command. When a bus has been broken into bits (bit blasted) by a synthesis tool, ModelSim expects a separator between the base bus name and the bit indication. This option identifies that separator. The default is "_". For example, the signal "mybus" might be broken down into "mybus_0", "mybus_1", etc. Optional. Related Tcl variable is PrefCompare(defaultRebuildSeparator).
-tol <delay> Specifies the default maximum time the test signal edge is allowed to trail or lead the reference edge in an asynchronous comparison. Optional. The default is 0. If a unit is used (e.g., ps) with the time value, the time must be in curly braces. You can specify different values for the leading and trailing tolerances using -tolLead and tolTrail.
-tolLead <delay> Specifies the default maximum time the test signal edge is allowed to lead the reference edge in an asynchronous comparison. Optional. The default is 0. If a unit (e.g., ps) is used with the time value, the time must be in curly braces. Related Tcl variables are PrefCompare(defaultLeadTolerance) and PrefCompare(defaultLeadUnits).
-tolTrail <delay> Specifies the default maximum time the test signal edge is allowed to trail the reference edge in an asynchronous comparison. Optional. The default is 0. If a unit is used (e.g., ps) with the time value, the time must be in curly braces. Related Tcl variables are PrefCompare(defaultTrailTolerance) and PrefCompare(defaultTrailUnits).
136
Graphical representation of tolLead and tolTrail

Reference Signal
Test Signal
tolLead tolTrail
-track Specifies that the waveform comparison should track the current simulation. Optional. Default. The differences will be updated at the end of each run command, so if you want to see differences soon after they occur, use many relatively short run commands. Related Tcl variable is PrefCompare(defaultTrackLiveSim).
-notrack Specifies that the waveform comparison should not track the current simulation. Optional. Related Tcl variable is PrefCompare(defaultTrackLiveSim).
-vhdlmatches {<ref-logic-value>=<test-logic-value>:} Specifies how VHDL signal states in the reference dataset should match values in the test dataset. Optional. Values are specified in a colon-separated list of match values. For example:
Default is:
{U=UWX-:X=UWXD:0=0LD:1=1HD:Z=ZD:W=UWXD:L=0LD:H=1HD:-=UX01ZWLHD}
Related Tcl variable is PrefCompare(defaultVHDLMatches). -vlogmatches {<ref-logic-value>=<test-logic-value>:} Specifies how Verilog signal states in the reference dataset should match values in the test dataset. Optional. Values are specified in a colon-separated list of match values. For example:
Default is:
{0=0:1=1:Z=Z:X=X}
Related Tcl variable is PrefCompare(defaultVLOGMatches). -wavepane <n> Specifies the default pane of the Wave window in which compare differences will be viewed. Optional. Related Tcl variable is PrefCompare(defaultWavePane).
137
-wavewin <name> Specifies the default name of the Wave window in which compare differences will be viewed. Optional. Related Tcl variable is PrefCompare(defaultWaveWindow).
Examples Return the current value of all options.

compare options
Set the maxtotal option to 2000 differences.

compare options -maxtotal 2000
Return the current value of the maxtotal option.

compare options -maxtotal
Set the option to ignore Verilog net strengths.

compare options -ignoreVlogStrengths
Verilog X will now match X, Z, or 0.

compare options -vlogxmatches {0=0:1=1:Z=Z:X=XZ0}
VHDL std_logic X will now match 'U', 'X', 'W', or 'D'.

compare options -vhdlmatches {X=UXWD}
Set the leading tolerance for asynchronous comparisons to 300 picoseconds.

compare options -tolLead {300 ps}
Set the trailing tolerance for asynchronous comparisons to 250 picoseconds.

compare options -tolTrail {250 ps}
See also compare add, compare clock, Waveform Compare
138
Commands compare reload
compare reload
The compare reload command reloads comparison differences to allow their viewing without recomputation. Prior to invoking compare reload, you must open the relevant datasets with the same names that were used during the original comparison. Syntax compare reload <rulesFilename> <diffsFilename> Arguments <rulesFilename> Specifies the name of the file that was previously saved using the compare saverules command. Required. Must be the first argument. <diffsFilename> Specifies the name of the file that was previously saved using the compare savediffs command. Required. See also compare add, compare savediffs, compare saverules, compare run, compare start, Waveform Compare
139
Commands compare reset
compare reset
Clears the current compare differences, allowing another compare run command to be executed. Does not modify any of the compare options or any of the signals selected for comparison. This allows you to re-run the comparison with different options or with a modified signal list. Syntax compare reset Arguments None
See also compare add, compare run, and Waveform Compare
140
Commands compare run
compare run
The compare run command runs the difference computation on the signals selected via a compare add command. Reports in the Transcript pane the total number of errors found. Syntax compare run [<startTime>] [<endTime>] Arguments <startTime> Specifies when to start computing differences. Optional. Default is zero. If a unit (e.g., ps) is used with the time value, the time must be in curly braces. The default units are determined by the simulation resolution. (Default simulation resolution is nanoseconds. Simulation resolution can be changed with the -t argument of the vsim command). <endTime> Specifies when to end computing differences. Optional. Default is the end of the dataset simulation run that ends earliest. If a unit (e.g., ps) is used with the time value, the time must be placed in curly braces. Examples Compute differences over the entire time range.
compare run
Compute differences from 5.3 nanoseconds to 57 milliseconds.

compare run {5.3 ns} {57 ms}
See also compare add, compare end, compare start, Waveform Compare
141
Commands compare savediffs
compare savediffs
The compare savediffs command saves the comparison results to a file that can be reloaded later. To be able to reload the file later, you must also save the comparison setup using the compare saverules command. Syntax compare savediffs <diffsFilename> Arguments <diffsFilename> Specifies the name of the file to create. Required. To load the file at a later time, use the compare reload command. See also compare add, compare reload, compare saverules, Waveform Compare
142
Commands compare saverules
compare saverules
The compare saverules command saves the comparison setup information (or "rules") to a file that can be re-executed later. The command saves compare options, clock definitions, and region and signal selections. Syntax compare saverules [-expand] <rulesFilename> Arguments -expand Expands groups specified by the compare add command to individual signals. Optional. If you added a region with the compare add command and then deleted signals from that region, you must use the -expand argument or the rules will not reflect the signal deletions. <rulesFilename> Specifies the name of the file to which you want to save the rules. Required. To load the file at a later time, use the compare reload command. See also compare add, compare reload, compare savediffs, Waveform Compare
143
Commands compare see
compare see
The compare see command displays the specified comparison difference in the Wave window using whatever horizontal and vertical scrolling are necessary. The signal containing the specified difference will be highlighted, and the active cursor will be positioned at the starting time of the difference. Syntax compare see [-first] [-last] [-next] [-nextanno] [-previous] [-prevanno] [-wavepane <n>] [-wavewin <name>] Arguments -first Shows the first difference, ordered by time. Optional. Performs the same action as the Find First Difference button in the Wave window. -last Shows the last difference, ordered by time. Optional. Performs the same action as the Find Last Difference button in the Wave window. -next Shows the next difference (in time) after the currently selected difference. Optional. Performs the same action as the Find Next Difference button in the Wave window. -nextanno Shows the next annotated difference (in time) after the currently selected difference. Optional. Performs the same action as the Next Annotated Difference button in the Wave window. -previous Shows the previous difference (in time) before the currently selected difference. Optional. Performs the same action as the Previous Difference button in the Wave window. -prevanno Shows the previous annotated difference (in time) before the currently selected difference. Optional. Performs the same action as the Previous Annotated Difference button in the Wave window. -wavepane <n> Specifies the pane of the Wave window in which the difference should be shown. Optional. -wavewin <name> Specifies the name of the Wave window in which the difference should be shown. Optional. Examples Show the earliest difference (in time) in the default Wave window.
144
Commands compare see compare see -first
Show the next difference (in time) in the default Wave window.
compare see -next
See also compare add, compare run, Waveform Compare
145
Commands compare start
compare start
The compare start command begins a new dataset comparison. The datasets that youll be comparing must already be open. Syntax compare start [-batch] [-maxsignal <n>] [-maxtotal <n>] [-refDelay <delay>] [-testDelay <delay>] <reference_dataset> [<test_dataset>] Arguments -batch Specifies that comparisons will not be automatically inserted into the Wave window. Optional. -maxsignal <n> Specifies an upper limit for the total differences encountered on any one signal. When that limit is reached, ModelSim stops computing differences on that signal. Optional. The default limit is 100. You can change the default using the compare options command or by editing the PrefCompare(defaultMaxSignalErrors) variable in the pref.tcl file. -maxtotal <n> Specifies an upper limit for the total differences encountered. When that limit is reached, ModelSim stops computing differences. Optional. The default limit is 1000. You can change the default using the compare options command or by editing the PrefCompare(defaultMaxTotalErrors) variable in the pref.tcl file. -refDelay <delay> Delays the reference dataset relative to the test dataset. Optional. If <delay> contains a unit, it must be enclosed in curly braces. Delays are applied to signals specified with the compare add command. For each signal compared, a delayed virtual signal is created with "_d" appended to the signal name, and these are the signals viewed in the Wave window comparison objects. The delay is not applied to signals specified in compare "when" expressions. -testDelay <delay> Delays the test dataset relative to the reference dataset. Optional. If <delay> contains a unit, it must be enclosed in curly braces. Delays are applied to signals specified with the compare add command. For each signal compared, a delayed virtual signal is created with "_d" appended to the signal name, and these are the signals viewed in the Wave window comparison objects. The delay is not applied to signals specified in compare "when" expressions. <reference_dataset> The dataset to be used as the comparison reference. Required.
146
Commands compare start
<test_dataset> The dataset to be tested against the reference. Optional. If not specified, ModelSim uses the current simulation. The reference and test datasets may be the same.
Examples Begin a waveform comparison between a dataset named "gold" and the current simulation. Assumes the gold dataset was already opened.
compare start gold
This command sequence opens two datasets and starts a comparison between the two using greater than default limits for total differences encountered.
dataset open gold_typ.wlf gold dataset open bad_typ.wlf test compare start -maxtotal 5000 -maxsignal 1000 gold test
See also compare add, compare options, compare stop, Waveform Compare
147
Commands compare stop
compare stop
This command is used internally by the compare stop button to suspend comparison computations in progress. If a compare run execution has returned to the VSIM prompt, compare stop has no effect. Under Unix, entering a Control-C character in the window that invoked ModelSim has the same effect as compare stop. Syntax compare stop Arguments None
See also compare run, compare start, Waveform Compare
148
Commands compare update
compare update
This command is primarily used internally to update the comparison differences when comparing a live simulation against a .wlf file. The compare update command is called automatically at the completion of each simulation run if the "-track" compare option is in effect. The user can also call compare update periodically during a long simulation run to cause difference computations to catch up with the simulation. This command does nothing if the track compare option was not in effect when the compare run command was executed. Syntax compare update Arguments None
See also compare run, Waveform Compare
149
Commands configure
configure
The configure command invokes the List or Wave widget configure command for the current default List or Wave window. To change the default window, use the view command. Syntax configure list | wave [-window <wname>] [<option> <value>] ---- List Window Arguments [-delta [all | collapse | events | none]] [-gateduration [<duration_open>]] [-gateexpr [<expression>]] [-usegating [<value>]] [-strobeperiod [<period>]] [-strobestart [<start_time>]] [-usesignaltriggers [<value>]] [-usestrobe [<value>]] ---- Wave Window Arguments [-childrowmargin [<pixels>]] [-cursorlockcolor [<color>]] [-gridauto [off | on]] [-gridcolor [<color>]][-griddelta [<pixels>]] [-gridoffset [<time>]] [-gridperiod [<time>]] [-namecolwidth [<width>]] [-rowmargin [<pixels>]] [-signalnamewidth [<value>]] [-timecolor [<color>]] [-timeline [<value>]] [-timelineunits [fs | ps | ns | us | ms | sec | min | hr]] [-valuecolwidth [<width>]] [-vectorcolor [<color>]] [-waveselectcolor [<color>]] [-waveselectenable [<value>]] Description The command works in three modes: without options or values it returns a list of all attributes and their current values with just an option argument (without a value) it returns the current value of that attribute with one or more option-value pairs it changes the values of the specified attributes to the new values
The returned information has five fields for each attribute: the command-line switch, the Tk widget resource name, the Tk class name, the default value, and the current value. Arguments list | wave Specifies either the List or Wave widget to configure. Required. -window <wname> Specifies the name of the List or Wave window to target for the configure command. (The view command allows you to create more than one List or Wave window). Optional. If no window is specified the default window is used; the default window is determined by the most recent invocation of the view command.
150
Commands configure
<option> <value> -bg <color> Specifies the window background color. Optional. -fg <color> Specifies the window foreground color. Optional. -selectbackground <color> Specifies the window background color when selected. Optional. -selectforeground <color> Specifies the window foreground color when selected. Optional. -font <font> Specifies the font used in the widget. Optional. -height <pixels> Specifies the height in pixels of each row. Optional.
Arguments, List window only -delta [all | collapse | events | none] The all option displays a new line for each time step on which objects change; collapse displays the final value for each time step; events displays an "event" column rather than a "delta" column and sorts List window data by event; and none turns off the display of the delta column. To use -delta, -usesignaltriggers must be set to 1 (on). Optional. -gateduration [<duration_open>] The duration for gating to remain open beyond when -gateexpr (below) becomes false, expressed in x number of timescale units. Extends gating beyond the back edge (the last list row in which the expression evaluates to true). Optional. The default value for normal synchronous gating is zero. If -gateduration is set to a non-zero value, a simulation value will be displayed after the gate expression becomes false (if you dont want the values displayed, set -gateduration to zero). -gateexpr [<expression>] Specifies the expression for trigger gating. Optional. (Use the -usegating argument to enable trigger gating.) The expression is evaluated when the List window would normally have displayed a row of data. See the GUI_expression_format for information on expression syntax. -usegating [<value>] Enables triggers to be gated on (a value of 1) or off (a value of 0) by an overriding expression. Default is off. Optional. (Use the -gatexpr argument to specify the expression.) Refer to Using Gating Expressions to Control Triggering for additional information on using gating with triggers. -strobeperiod [<period>] Specifies the period of the list strobe. When using a time unit, the time value and unit must be placed in curly braces. Optional. -strobestart [<start_time>] Specifies the start time of the list strobe. When using a time unit, the time value and unit must be placed in curly braces. Optional.
151
Commands configure
-usesignaltriggers [<value>] If 1, uses signals as triggers; if 0, not. Optional. -usestrobe [<value>] If 1, uses the strobe to trigger; if 0, not. Optional.
Arguments, Wave window only -childrowmargin [<pixels>] Specifies the distance in pixels between child signals. Optional. Default is 2. Related Tcl variable is PrefWave(childRowMargin). -cursorlockcolor [<color>] Specifies the color of a locked cursor. Default is red. Related Tcl variable is PrefWave(cursorLockColor). -gridauto [off | on] Controls the grid period when in simulation time mode. off (default) user-specified grid period is used. on grid period is determined by the major tick marks in the time line. -gridcolor [<color>] Specifies the background grid color; the default is grey50. Optional. Related Tcl variable is PrefWave(gridColor). -griddelta [<pixels>] Specifies the closest (in pixels) two grid lines can be drawn before intermediate lines will be removed. Optional. Default is 40. Related Tcl variable is PrefWave(gridDelta). -gridoffset [<time>] Specifies the time (in user time units) of the first grid line. Optional. Default is 0. Related Tcl variable is PrefWave(gridOffset). -gridperiod [<time>] Specifies the time (in user time units) between subsequent grid lines. Optional. Default is 1. Related Tcl variable is PrefWave(gridPeriod). -namecolwidth [<width>] Specifies in pixels the width of the name column. Optional. Default is 150. Related Tcl variable is PrefWave(nameColWidth). -rowmargin [<pixels>] Specifies the distance in pixels between top-level signals. Default is 4. Related Tcl variable is PrefWave(rowMargin).
152
Commands configure
-signalnamewidth [<value>] Controls the number of hierarchical regions displayed as part of a signal name shown in the pathname pane. Optional. Default of 0 displays the full path. 1 displays only the leaf path element, 2 displays the last two path elements, and so on. Related Tcl variable is PrefWave(SignalNameWidth). Can also be set with the WaveSignalNameWidth variable in the modelsim.ini file.
-timecolor [<color>] Specifies the time axis color. Default is green. Optional. Related Tcl variable is PrefWave(timeColor).
-timeline [<value>] Specifies whether the horizontal axis displays simulation time (default) or grid period count. Default is zero. When set to 1, the grid period count is displayed. Related Tcl variable is PrefWave(timeline).
-timelineunits [fs | ps | ns | us | ms | sec | min | hr] Specifies units for timeline display (does not affect the currently-defined simulation time). Default is ns.
-valuecolwidth [<width>] Specifies in pixels the width of the value column. Default is 100. Related Tcl variable is PrefWave(valueColWidth).
-vectorcolor [<color>] Specifies the vector waveform color. Default is #b3ffb3. Optional. Related Tcl variable is PrefWave(vectorColor).
-waveselectcolor [<color>] Specifies the background highlight color of a selected waveform. Default is grey30. Related Tcl variable is PrefWave(waveSelectColor).
-waveselectenable [<value>] Specifies whether the waveform background highlights when an object is selected. 1 enables highlighting; 0 disables highlighting. Default is 0. Related Tcl variable is PrefWave(waveSelectEnabled).
To get a more readable listing of all attributes and current values, use the lecho command, which pretty-prints a Tcl list. There are more options than are listed here. See the output of a configure list or configure wave command for all options. Examples Display the current value of the strobeperiod attribute.
config list -strobeperiod
153
Commands configure
Set the period of the list strobe and turns it on.

config list -strobeperiod {50 ns} -strobestart 0 -usestrobe 1
Set the wave vector color to blue.

config wave -vectorcolor blue
Set the display in the current Wave window to show only the leaf path of each signal.
config wave -signalnamewidth 1
See also view, Simulator GUI Preferences
154
Commands context
context
The context command provides several operations on a context's name. The option you specify determines the operation. Syntax context dataset | exists | fullpath | isInst | isNet | isProc | isVar | join | parent | path | split | tail | type <name> Arguments context dataset <name> Return the dataset name from the name. context exists <name> Returns 1 if the name is valid, 0 otherwise. context fullpath <name> Returns the full path (including the dataset prefix) of the specified name. context isInst <name> Returns 1 if the name is an instance pathname, 0 otherwise. context isNet <name> Returns 1 if the name is a Signal or Net pathname, 0 otherwise. context isProc <name> Returns 1 if the name is a Process pathname, 0 otherwise. context join <name> <name> ... Takes one or more names and combines them, using the correct path separator. context parent <name> Returns the parent path of the name by removing the tail (see context tail). context path <name> Returns the pathname portion of the name, removing the dataset name. context split <name> Returns a list whose elements are the path components in the name. The first element of the list will be the dataset name if one is present in the name, including the dataset separator. For example, context split /foo/bar/baz returns / foo bar baz. context tail <name> Returns all of the characters in the name after the last path separator. If the name contains no separators then returns the name. Any trailing path separator is discarded.
155
Commands context
context type <name> Returns a string giving the acc type of the name. <name> Name of a context object or region. Required. Does not have to be a valid object name unless the specified option requires this (i.e., exists or isInst).
156
Commands coverage attribute
coverage attribute
The coverage attribute command is used to display or set attributes in the currently loaded database on the following types of attributes: Test Attributes attributes for each test attribute record (one record is created for each simulation that is saved). These attributes are name value pairs that represent testcase information. The following list of attributes are accessible from predefined key strings: "SIMTIME": Simulation time "TIMEUNIT": Unit (Unit for simtime: ns, us, etc.) "CPUTIME": Cputime used by the simulator "DATE": Date "VSIMARGS": vsim arguments "USERNAME": user name "TESTSTATUS": test status (OK, Warning, Error, or Fatal)
For more information of attributes and test attribute records, see Test Attribute Records in UCDB. Object Attributes attached to particular objects stored in the UCDB (ex. design units, design instance scopes, a particular covergroup, or a particular cover directive). Some attributes for different kinds of objects are created by ModelSim, but you can create or read any attribute in the CLI or the UCDB API. UCDB Attributes attached globally to the UCDB file, read or written with "coverage attribute -ucdb". Unlike test attributes, these are merged together during a vcover merge. In the current system, the only attributes created by ModelSim are those related to the test-associated merge. However, you can create attributes for your own use, accessible through this CLI or the UCDB API.
This command can be used both during simulation and with "vsim -viewcov", though in simulation it can only be used for test attributes (the single test attribute record that exists in simulation). Syntax
For test attributes
coverage attribute [-test <testname>] [-seed <str>] [-command <str>] [-comment <str>] [-compulsory [0|1]] <attr_options>
For UCDB attributes
coverage attribute [-ucdb] <attr_options>
157
Commands coverage attribute For object attributes
coverage attribute [-match <str> | -path <obj> | -plansection <obj>] [-du <duname>] [-select instance] [-code {b | c | e | f | s | t}...] [-codeAll] [-sc] [-user] <attr_options>
where
<attr_options> = [-delete] [-tcl] [-concise] [-name <str>]+ [-value <str>]+ Arguments -code {b | c | e | f | s | t}... Specifies this command apply to corresponding code coverage types: branch, condition, expression, statement, toggle, FSM. Optional. -codeAll Specifies the command apply to all coverage types. Optional. Equivalent to -code bcestf. -command <str> Command to run the test: script command line, "knob settings", etc. Optional. -comment <str> Comment on the testcase. Optional. -compulsory [0|1] Indicates test is compulsory. Optional. By default, it is not compulsory (0). -concise Print attribute values only, do not print other information. Optional. -delete Delete specified name attributes. Optional -du <duname> Apply to a design unit, e.g., "lib.primary(secondary)" secondary for VHDL only. Optional. -match <str> Match the given pattern against the given coverage type(s) against some design unit(s) specified by -du. Mutually exclusive with the -path argument. Optional. -name <str> Attribute name. Used to add your own attributes to the test. Multiple -name arguments are allowed. Optional. -path <obj> Apply to a path in the UCDB. Optional. Wildcards are acceptable. Relative path can be used in conjunction with -du.
158
Commands coverage attribute
-plansection <obj> Apply to a testplan section in the UCDB, as specified by <obj>. Optional. Wildcards are acceptable. Relative path can be used in conjunction with -du.
-sc Specifies the command apply to SystemC coverage. Optional. -seed <str> Random seed of the test run. Optional. -select instance Specifies the command applies to HDL instance scopes (VHDL architectures, interface instances, etc.). Optional.
-tcl Prints attribute information in a Tcl format. Optional. -test <testname> Specifies a test object for attributes. Required when used with vsim -viewcov. Optional otherwise.
-ucdb Specifies global UCDB object for attributes. Optional. -user Specifies the command apply to user-defined coverage. Optional. -value <str> Value of attribute associated with -name. Multiple -value arguments are allowed. Optional.
Example Show all test records in a UCDB that has been loaded into coverage view mode:
coverage attribute -test *
See also Verification Management, Verification Management Window, Test Attribute Records in UCDB, coverage exclude, coverage goal, coverage report, coverage save, coverage testnames, coverage weight, vcover attribute, vcover merge, vcover ranktest, vcover stats
159
Commands coverage clear
coverage clear
The coverage clear command clears specified types of coverage data from the coverage database. When entered at the simulation prompt (simulation mode), performing coverage clear on an instance affects the code coverage data of the associated design unit. The reverse is also true, that if you perform "coverage clear" on a design unit, the associated instances of that design unit are also cleared. However, when issued at the vsim prompt with the vsim -viewcov command (batch or postprocessing modes), coverage clear does not synchronize code coverage data between instances and associated design units. So, clearing an instance has no effect on code coverage data for associated design units. Conversely, clearing a design unit has no affect on related instances. Syntax coverage clear [-code {b | c | e | f | s | t |}...] [-du <du_name> | -instance <pathname>] [-path <obj>+] [-match <string>] [-recursive] Arguments -code {b | c | e | f | s | t |}... Clears code coverage data for coverage type: b=branch coverage; c=condition coverage; e=expression coverage; s=statement coverage; t=toggle; f=Finite State Machine coverage. More than one of the coverage types may be specified with a single argument. Optional. -du <du_name> Specifies design unit to clear of specified types of coverage data. To specify all design units in the current dataset, specify <du_name> as "*". -instance <pathname> Clears the specified coverage data for the selected instance. Optional. -match <string> Clears coverage data for instances or design units which match the specified <string>. Valid only for use on UCDB files, in the Coverage View mode. Optional. -path <obj>+ Specifies that the subtrees being cleared are rooted at the specified design node. Multiple objects may be specified. Optional. This argument applies to a sub-hierarchy. -recursive Specifies that the command is applied recursively. Optional. The default is for the query to be restricted to the single object or objects specified in the command. Example coverage clear Clears all coverage data from the current simulation database (UCDB).
160
Commands coverage clear
coverage clear -cvg -directive Clears data for all covergroups and covergroup directives. coverage clear -path /top/a/* Clears coverage data from all /top/a.
See also Code Coverage, coverage attribute, coverage exclude, coverage report, coverage save
161
Commands coverage exclude
coverage exclude
The coverage exclude command allows you to exclude the following from coverage statistics: specific code coverage types all code in specified source file(s) lines within a source file rows within a condition or expression truth table code inside specific design units or instances transitions or states within a Finite State Machine toggle nodes
This command and its arguments can be issued during simulation or in Coverage View (postprocess) mode. Refer to Excluding Objects from Coverage for more details. Syntax For file-based, line-based, or wholesale exclusions: coverage exclude { -srcfile <source_file> [-pragma] | -du <du_name> [-srcfile <source_file>] [-pragma]| -scope <scope_path> [-srcfile <source_file>] [-r] } [-linerange [<ln>] ... [<ln>-<ln>] ...] [-dataset <name>] [-code {b | c | e | f | s | t}...] [-else] [-if] [-clear] To exclude expression or condition rows: coverage exclude { -srcfile <source_file> [-pragma] | -du <du_name> [-srcfile <source_file>] [-pragma] | -scope <scope_path> [-srcfile <source_file>] } -condrow <ln> [<rn>] ... [<rn>-<rn>] ... -exprrow <ln> [<rn>] ... [<rn>-<rn>] ... -feccondrow <stmt_num row_num> -fecexprrow <stmt_num row_num> [-dataset <name>] [-clear] To exclude FSM states or transitions: coverage exclude { -du <du_name> [-pragma] | -scope <scope_path> } { -ftrans <state_var_name> [<transition_name>] ... | -fstate <state_var_name> [<state_name>] ... } [-dataset <name>] [-clear]
162
To exclude an entire state machine from coverage: if auto exclusions are enabled: coverage exclude -fstate <state_var_name> if auto exclusions are not enabled: coverage exclude -fstate <state_var_name> -ftrans <state_var_name> To exclude toggle coverage: coverage exclude -togglenode <node_path> ... [-du <du_name> | -scope <scope_path> [-r]] [-dataset <name>] [-in] [-out] [-inout] [-internal] [-ports] [-clear] [-pragma] Arguments -code {b | c | e | f | s | t}... Excludes coverage objects of the specified type from the specified dataset. b=branch coverage; c=condition coverage; e=expression coverage; f=Finite State Machine coverage; s=statement coverage; t=toggle coverage (either regular or extended). If -code is not specified, all possible coverage types are excluded. More than one coverage can be specified with each -code argument. -clear Removes exclusions from dataset. Add exclusions if -clear is not specified. -condrow <ln> [<rn>] ... [<rn>-<rn>] ... Specifies condition truth table row(s) <rn> in the specified line <ln> to be excluded from coverage. Multiple rows, or ranges of rows, separated by spaces, are allowed. If no row number is specified, all rows are excluded. -dataset <name> Specifies dataset into which exclusions are to be applied. If not specified, the current dataset is assumed ("sim" is the default when running interactively). All specified objects, such as scopes, design units, or variable names, must be present in the named dataset. -du <du_name> Specifies design unit to be excluded. Multiple -du specifications are allowed. Mutually exclusive with -scope. To specify all design units in the current dataset, specify <du_name> as "*" (e.g. coverage exclude -du *). You cannot use -du with -srcfile or -linerange when <du_name> is "*". -else Modifies branch exclusion algorithm by applying exclusions only to the "else" section of every if-else branch.. This argument applies to branch coverage only. Branch coverage (on by default) must be turned on for this argument to take effect. The line number(s) specified with the -linerange argument, if used, must include the line on which the if-branch appears.
163
-exprrow <ln> [<rn>] ... [<rn>-<rn>] ... Specifies expression truth table row(s) <rn> in the specified line <ln> to be excluded from coverage. Multiple rows, or ranges of rows, separated by spaces, are allowed. If no row number is specified, all rows are excluded.
-feccondrow <stmt_num row_num> Excludes specified row in focused expression coverage (FEC) condition coverage with a specified line number from the report. Optional argument to -srcfile argument.
-fecexprrow <stmt_num row_num> Excludes specified row in focused expression coverage (FEC) expression coverage with a specified line number from the report. Optional argument to -srcfile argument.
-fstate <state_var_name> [<state_name>] ... Specifies the Finite State Machine state or states to be excluded from coverage for the specified FSM, specified with <state_var_name>. Multiple states, separated by white space, are allowed. If no state name is specified, all states are excluded. By default, when a state is excluded, all transitions to and from the state are excluded. This behavior is called "auto exclusion". To explicitly control auto exclusion, set the vsim argument -autoexclusionsdisable to fsm or none. To change the default behavior of the tool, set the variable AutoExclusionsDisable in the modelsim.ini file.
-ftrans <state_var_name> [<transition_name>] ... Specifies the transition states to be excluded for the specified FSM (state_var_name). <transition_name> is "<state_name>-><state_name>". Multiple transitions, separated by white space, are allowed. If no transition is specified, all transitions are excluded. If whitespace is present within the transition, it must be surrounded by curly braces.
-if Modifies the branch exclusion by applying exclusions onlly to the if section of if-else branches. Branch coverage (on by default) must be turned on for this option to take effect. The line number(s) specified with the -linerange argument, if used, must include the line on which the if-branch appears.
-in Excludes the specified toggle nodes of mode IN. This argument is valid only when -togglenode is specified.
-inout Excludes the specified toggle nodes of mode INOUT. This argument is valid only when -togglenode is specified.
-internal Excludes the specified toggle nodes of internal (non-port) objects. This argument is valid only when -togglenode is specified.
164
-linerange [<ln>] ... [<ln>-<ln>] ... Specifies the line number(s) and/or range of line numbers to be excluded from code coverage in the design source file -srcfile <source_file>. Multiple lines and line ranges are permitted, separated by whitespace. When -linerange is not specified, all objects on all lines of the specified design unit, scope, or source file are excluded. This is referred to as a "wholesale exclusion". -srcfile is required for -linerange unless -du or -scope is used, and only one source file is used to implement the du or scope. If -srcfile is used together with -du/-scope, and -linerange is in effect, it is possible for -linerange to specify lines other than lines used to implement the -du or -scope. Such lines are ignored. General FSM (i.e. -code f) and toggle (i.e. -code t) coverage exclusions are not applied when -linerange is used.
-out Excludes the specified toggle nodes of mode OUT. This argument is valid only when -togglenode is specified.
-ports Excludes the specified toggle nodes of mode IN, OUT, or INOUT. This argument is valid only when -togglenode is specified.
-pragma Adds or clears pragma and user exclusions. Optional. Operates with file-based exclusions (du and/or -srcfile) for all coverage types, including toggle exclusions (-togglenode). If the pragma argument is specified, both user and pragma exclusions are applied. If the option is not specified, only user exclusions are applied.
-r Used with -scope only. Specifies that exclusions apply recursively into subscopes. If omitted, the exclusions are limited to the current scope.
-scope <scope_path> Specifies the scope to be excluded. Multiple -scope specifications are allowed. Mutually exclusive with the -du argument. To recursively exclude scopes, use with -r.
-srcfile <source_file> Specifies source file to be excluded. Required, unless -du or -scope is specified. Multiple srcfile specifications are allowed.General FSM (i.e. -code f) and toggle (i.e. -code t) coverage exclusions do not apply if -srcfile is specified.
-togglenode <node_path> ... Specifies the named nodes for toggle exclusion. Multiple nodes separated by spaces are allowed. Wildcards are accepted only in the final hierarchical component of <node_path>:
165
for example, a/b/c* is supported, whereas a/b*/c is not. If used with -scope or -du, specified toggle nodes are relative to the scope or design unit. Part select toggle exclusions are supported during active simulation only, not in Coverage View mode. Examples Recursively exclude branch coverage from instance /top/dut.
coverage exclude -scope /top/dut -r -code b
Exclude statement, else branch, expression and condition coverage from line 10 to 20 in file project1.vhd.
coverage exclude -srcfile project1.vhd -linerange 10-20 -else
Exclude statement, branch, expression, and condition coverage from instance /top/dut in dataset tt from line 102 through 110 and line 200 through 250 in the source file project1.vhd.
coverage exclude -scope /top/dut -dataset tt -srcfile project1.vhd -linerange 102-110 200-250
Remove statement, branch, expression, condition, and fsm exclusions from the source file project1.vhd.
coverage exclude -clear -srcfile project1.vhd
Add rows 2 through 4 from the condition truth table on line 115 to the code coverage exclusions for source file project1.vhd.
coverage exclude -srcfile project1.vhd -condrow 115 2-4
Add all rows from the expression truth table on line 220 to the code coverage exclusions for source file project1.vhd.
coverage exclude -srcfile project1.vhd -exprrow 220
or
coverage exclude -srcfile project1.vhd -linerange 220 -code e
Exclude transitions S1->S2 and S2->S0 for FSM state in instance /top/dut/fsm1.
coverage exclude -scope /top/dut/fsm1 -ftrans state S1->S2 S2->S0
Exclude state S1 for FSM state in the design unit "fsm". If auto exclusions are on, all transitions to and from S1 will also be excluded.
coverage exclude -du fsm -fstate state S1
Remove user and pragma exclusions for all toggle coverage. This is equivalent to 'toggle enable -all'.
coverage exclude -du * -code t -clear -pragma
166
Exclude all toggle coverage (equivalent to 'toggle disable -all')

coverage exclude -du * -code t -pragma
Exclude toggle nodes a, b, and c in instance /top/dut.

coverage exclude -togglenode a b c -scope /top/dut
Recursively exclude all input toggle nodes in instance /top/dut.

coverage exclude -togglenode * -scope /top/dut -in -r
What NOT to do: Illegal Examples

coverage exclude -srcfile project1.vhd -code s -else
-else has no effect because branch coverage is not specified.
coverage exclude -srcfile project1.vhd -linerange 10-20 -code ft coverage exclude -srcfile project1.vhd -ftrans state S1->S2
There is no file name and line number associated with FSM and toggle coverage.
coverage exclude -scope /top/dut -srcfile project1.vhd -linerange 10-20 -r
-r does not work with -srcfile or -linerange
coverage exclude -du * -srcfile project1.vhd -linerange 10-20
'-du *' does not work with -srcfile or -linerange
coverage exclude -scope /top/dut -srcfile project1.vhd -line 10-20 -pragma
-pragma does not work with -scope
See also Code Coverage, Managing Exclusions, Verification Management, Verification Management Window, coverage report, coverage save, Toggle Coverage, toggle add, toggle enable, toggle disable
167
Commands coverage goal
coverage goal
The coverage goal command sets the value of UCDB-wide goals for different coverage types, or goals for specific objects in the database. Syntax coverage goal [-cvp] [-bydu] [-byinstance] [-type] [-fstate] [-ftrans] [-active] [-precision <int>] [<float percentage>] [-du <du_name> | -path <path> | -plansection <section_name>] <coverage_types>= [-code {b | c | e | f | s | t}...] [-codeAll] [-sc] Arguments -active Assertion directive active, per instance. Optional. -bydu Modifier used to set per-du (code coverage only) -byinstance Modifier used to set a per-instance goal (code coverage and covergroup). Optional. -code {b | c | e | f | s | t}... Sets goal for code coverage data for coverage type: b=branch coverage; c=condition coverage; e=expression coverage; s=statement coverage; t=toggle; f=Finite State Machine coverage. More than one coverage type can be specified with each -code argument. Optional. -codeAll Specifies the command for all coverage types. Optional. Equivalent to -code bcestf. -cvp Select coverpoint per-instance coverage. Optional. -du <du_name> Sets the goal for a given design unit. Optional. Mutually exclusive with -path and -plansection. Cannot be combined with any other arguments besides -precision or <float percentage>. -fstate Selects FSM state coverage. Optional. -ftrans Selects FSM transition coverage. Optional.
168
Commands coverage goal
<float percentage> Value for goal or goal(s) between 0 and 100. Required in order to set goals: prints goal(s) if left unspecified.
-path <path> Sets the goal for a given test plan item (-plan), design unit (-du) coverage/design object (path). Optional. Cannot be combined with any other arguments besides -precision or <float percentage>.
-plansection <section_name> Sets the goal for a given test plan item. Optional. Mutually exclusive with -path and -plansection. Cannot be combined with any other arguments besides -precision or <float percentage>.
-precision <int> Precision for goal percentage. Default is 1 decimal place. Optional. -sc Specifies command for SystemC coverage only. Optional. -type Modifier used to set covergroup type coverage. Optional.
See also Code Coverage, "Verification Management", Verification Management Window, coverage attribute, coverage exclude, coverage report, coverage save, coverage weight
169
Commands coverage open
coverage open
The coverage open command opens UCDB datasets for viewing in the GUI in Coverage View mode. Datasets can be closed once open using dataset close. This command is equivalent to the command vsim -viewcov. Syntax coverage open <filename> [<logicalname>] Arguments <filename> Specifies the <filename>.ucdb to open in Coverage View mode. At least one UCDB is required. <logicalname> Specifies the logical name for the UCDB dataset. Optional. This is a prefix that will identify the dataset in the current session. By default the dataset prefix will be the name of the specified UCDB file. Examples Open the dataset file last.ucdb and assigns it the logical name test.
coverage open last.ucdb test
See also Coverage View Mode and the UCDB, "Verification Management", Verification Management Window, coverage attribute, coverage exclude, coverage report, coverage save, coverage weight, dataset close, vsim -viewcov option
170
Commands coverage report
coverage report
The coverage report command produces textual output of coverage statistics or exclusions. By default, the command prints results to the Transcript pane, and returns an empty string. You can use the -file argument to save the output to a file. You can choose from a number of report output options using the arguments listed below. You can access the coverage report functionality from the GUI through right-clicking in the Sim or Files tab of the Workspace pane and select Code Coverage > Coverage Reports from the popup context menu; or, Tools > Code Coverage > Report. By default, the command returns results from the current scope. To specify a certain path for the report, you can use the -instance argument, such as: coverage report -instance <path> Tip: A report response of "No match" indicates that the report was empty. For example, "coverage report -du foo" where there is no design unit "foo" will result in "No match." The command orders output on a by file basis unless you specify the -byinstance or -bydu argument. To produce reports offline (i.e., without a simulation loaded), use the vcover report command. Syntax coverage report [<coverage_arguments>]
Global Arguments - Usable with any other arguments
coverage report [-details [-dumptables] [-fecanalysis] [-metricanalysis]] [-memory] [-zeros] [-precision <int>] [-recursive [-depth <n>]] [-file <filename> [-append]] [-xml]
Create HTML output from a UCDB
coverage report [-html [-verbose] [-nosource] [-noframes] [-nodetails] [-htmldir <outdir>] [threshL <val>] [-threshH <val>] <input_ucdb>]
Filtering Arguments - Selects one or more coverage types to appear in the report
coverage report [-code {b | c | e | f | s | t}...] [-codeAll] [-testattr]

Code Coverage
coverage report [-bydu] [-byfile] [-byinstance] [-totals] [-noannotate] [-library <libname>] [-du <du_name>] [-package <pkgname>] [-setdefault [byfile | byinstance | bydu]] [-source <filename>] [-instance <path>] [-recursive [-depth <n>]] [-subscopes]
171
Commands coverage report Exclusion-specific Coverage Arguments
coverage report -excluded [[-pragma] | [-user]] [-code {b | c | e | f | s | t}...] [-instance <path>] [-file <filename> [-append]]
Toggle-specific Coverage Arguments
coverage report [-verbose] [-all] Toggle coverage statistics are relevant only when reporting on instances or design units and are not produced on a per file basis. Toggle data is summed for all instances, and is reported by port or local name in the design unit, rather than by the connected signal. If you want toggle coverage statistics, you must specify either the -byinstance, -bydu, -instance <path>, or -du <du_name> arguments. If you do not use those arguments, or you use the -source <filename> argument, toggle coverage statistics are excluded even if you specify -code t. To get an itemized list of the signals, the -details argument is also required. Arguments -all When reporting toggles, creates a report that lists both toggled and untoggled signals. Counts of all enumeration values are reported. Not a valid option when reporting on a functional coverage database. Optional. -append Appends the current coverage statistics to the named output file (-file <filename>). -bydu Reports coverage statistics by design unit/module. Optional. The simulator will iterate through all design units in the design and report coverage data for each. Each design unit report will be the sum of all instances of that design unit and will be sorted by design unit name. Can be used with the -recursive [-depth <n>] argument to report on all design units contained within the specified design unit. Can be made the default with the -setdefault bydu argument. You can also report coverage data for a specific design unit by using the du <du_name> argument. -byfile Writes out a coverage summary for each source file in the design. Optional. This is the default report generated. A report generated with -byfile does not contain toggle information. -byinstance Writes out a coverage summary for all instances and packages. Can be replace the default (-byfile) with the -setdefault byinstance argument. Optional. -code {b | c | e | f | s | t}... Specifies which code coverage statistics to include in the report. Optional. By default, the report includes statistics for all categories you enabled at compile time. More than one coverage type can be specified with the -code argument.
172
The coverage types allowed are as follows: b Include branch statistics. c Include condition statistics. e Include expression statistics. f Include finite state machine statistics. s Include statement statistics. t Include toggle statistics. To report extended toggle coverage, ensure that you have compiled (vlog/vcom) with the -code x argument, then use coverage report with -code t. -codeAll Specifies the command apply to all coverage types. Equivalent to -code bcestf. Optional. -config Specifies that the current configuration of each cover directive be included in the report. Optional. -details [-dumptables] [-fecanalysis] [-metricanalysis] Includes details associated with each coverage item in the output (both UDP and FEC). By default, details are not provided. Optional. -dumptables forces printing of condition and expression truth tables even though fully covered. Optional. -fecanalysis reports which input patterns can be applied to the inputs to increment the expression/condition hit counts. Optional. -metricanalysis prints sum-of-product and basic sub-condition heuristic metrics from UDP expression/condition view. It reports hit counts for all rows in UPD table. To improve coverage numbers, find rows with 0 hits and exercise the inputs accordingly. See Expression and Condition Coverage Statistics for more information on metrics. Optional. -du <du_name> Reports coverage statistics for the specified design unit. Optional. <du_name> is <library name>.<primary>(<secondary>), where the library name is optional, and secondary name is required only for VHDL. If there are parameterized instances, all are considered to match the specified design unit. -excluded [[-pragma] | [-user]] Includes details on the exclusions in the specified coverage database input file. Optional. The output is structured in Tcl command format (DO file). By default, this option includes both user exclusions and source code pragma exclusions, unless you specify -user or -pragma.
173
-pragma When used with the -excluded argument, writes out only lines currently being excluded by pragmas. Optional. -user When used with the -excluded argument, writes out files and lines currently being excluded by the coverage exclude command. Optional. -file <filename> Specifies a file name for the report. Optional. Default is to write the report to the Transcript pane. Environment variables may be used in the pathname. -html [-verbose] [-nosource] [-noframes] [-nodetails] [-htmldir <outdir>] [-threshL <val>] [-threshH <val>] <input_ucdb> Tip: The -html argument is only supported in Coverage View mode, not during live simulation. Generates an HTML coverage report on coverage data from a given UCDB file. Optional. You can use the -verbose option with -html to enable logging output for each file generated. The -html arguments listed below are not compatible with any other vcover report arguments. <input_ucdb> Specifies input UCDB file. Required, and only one is allowed. -verbose Prints out the files that are generated by the HTML report generator. Optional. -nosource Avoids generation of the annotated source. Optional. This argument is used if you have no source code, or if you dont want the annotated source to be generated. Note that this prevents you from accessing source code related data from inside the generated HTML report. -noframes Avoids generation of JavaScript-based tree for designs with a large number of design scopes. The report comes up as a single frame containing the top-level summary page and an HTML-only design scope index page is available as a link from the top-level page. -nodetails Omits coverage detail pages, saving time and disk space during report generation for very large designs. -htmldir <outdir> Specifies the name of output directory for resulting UCDB (default: "covhtmlreport"). Optional. Whether you specify an output directory or the default is used, any file or directory of that name is completely removed prior to report generation to prevent possible stale data. -threshL <%> -threshH <val> Specifies % of coverage at which colored cells change from red to yellow. Optional. -threshH <%> Specifies % of coverage at which colored cells change from yellow to green. Optional. The default output filename is index.html in the default directory, covhtmlreport.
174
-instance <path> Writes out the source file summary coverage data for the specified instance. Optional. -library <libname> Only needs to be used when you have packages of the same name in different libraries. Optional.
-memory Reports a coarse-grain analysis of capacity data for the following SystemVerilog constructs:
o o o o o
Classes Queues, dynamic arrays, and associative arrays (QDAS) Assertion and cover directives Covergroups Solver (calls to randomize())
Optional. When combined with -cvg and -details, this command reports the detailed memory usage of covergroup. These include the current persistent memory, current transient memory, peak transient memory, and peak time of the following:
o o o o
Per covergroup type Per coverpoint and cross in the type Per covergroup instance (if applicable) Per coverpoint and cross in the instance (if applicable).
-noannotate Removes source code from the output report. Valid for code coverage only. Not applicable with -xml argument. Optional.
-package <pkgname> Prints a report on the specified VHDL package body. Needs to be of the form <lib>.<pkg>. Optional. This argument is equivalent to -du.
-precision <int> Sets the decimal precision for printing functional coverage information. Valid values are from 0 to 6 and default value is 1 (one). Optional.
-recursive [-depth <n>] Reports on the instance specified with -instance and every included instance, recursively. Can also be used with -details and -totals but cannot be used with -zeros. Optional. -depth <n> Used with the -recursive argument, it specifies the maximum recursive depth. A depth of 1 is the same as no recursion at all. Optional.
175
-setdefault [byfile | byinstance | bydu] Sets the coverage report default mode for the current invocation of ModelSim. Report modes are by file (default), by instance, and by design unit. Optional.
-source <filename> Writes a summary of statement coverage data for a specific source file. Optional. Environment variables may be used in the pathname.
-subscopes Reports code coverage data in unrolled generate blocks. They are reported in byinstance mode. Optional.
-testattr Display test attributes in the report. Optional. -totals Writes out a total summary of the specified instance, recursively. Optional. Useful for tracking changes. Without this argument, the report writes out an instance summary for each of the instances. The report prints only one summary if -totals option is used. Also, when the -totals argument is specified, the alias nodes are not counted.
-verbose Prints a report listing all the integer values and their counts an integer toggle encounters during the run. Optional. List will include the number of active assertion threads (Active Count) and number of active root threads (Peak Active Count) that have occurred up to the current time.
-xml Outputs report in XML format. A report created with -xml does not contain source file lines (calls -noannotate implicitly). Optional. This implicitly sets the -details argument. Refer to Reporting Coverage Data for more information.
-zeros Writes out a file-based summary of lines, including file names and line numbers, that have not been executed (zero hits), annotates the source code, and supports the -source and -instance options. Optional. Cannot be used in tandem with the -recursive argument. For a detailed report that includes line numbers, use: coverage report -zeros -details.
Examples Write a top-level summary of the number of files, statements, branches, hits, and signal toggles to myreport.txt.
coverage report -totals -file myreport.txt
Write detailed branch, condition, and statement statistics, without associated source code, to the transcript pane.
176
Commands coverage report coverage report -details -noannotate -code bcs
Write a summary of code coverage for all instances to the Transcript pane.
coverage report -byinstance
Write code coverage details of all instances in the design to myreport.txt. The -details argument reports coverage statistics for each statement, branch, condition and expression.
coverage report -details -byinstance -file myreport.txt
Write code coverage details of one specific instance to the Transcript pane.
coverage report -details -instance /top/p
Write both pragma and user-based exclusions to the transcript window as follows:
coverage report -excluded # coverage report -excluded # src/delta/delta.vhd # 693-696 # 711-806 # src/delta/micro.v # 110-124 # src/delta/pre.v # 216-217 # src/delta/testdel.vhd # 1178-1274 # src/delta/tx.vhd # 148-149
Write both pragma and user-based exclusions to the transcript window in TCL format as follows:
# # # # # # coverage coverage coverage coverage coverage coverage report -excluded exclude -add src/delta/delta.vhd 693-696 711-806 exclude -add src/delta/micro.v 110-124 exclude -add src/delta/pre.v 216-217 exclude -add src/delta/testdel.vhd 1178-1274 exclude -add src/delta/tx.vhd 148-149
Write a summary of coverage by source file for coverage less than or equal to 90%.
coverage report -below 90 -file myreport.txt
Write a list of statements with zero coverage to myzerocov.txt.

coverage report -zeros -byinstance -file myzerocov.txt
See also Code Coverage, Generating HTML Coverage Reports, coverage save, vcover report, coverage attribute, coverage goal, coverage weight, vcover merge, vcover ranktest
177
Commands coverage save
coverage save
The coverage save command is used to save current coverage results of the specified type to the unified coverage database (UCDB). If no type is specified then all types will be saved into the database. While code coverage data can also be saved with the $coverage_save system task (see System Tasks and Functions Specific to the Tool in the Users Manual), the coverage save command is the preferred method of saving coverage data. Syntax coverage save [-instance <path>][-code {b | c | e | f | s | t}...] [-codeAll] [-du <du_name>] [-instance <path>] [-norecursive] [-onexit] <dbname>] Arguments -code {b | c | e | f | s | t}... Save only the designated coverage type: b=branch coverage; c=condition coverage; e=expression coverage; f=Finite State Machine coverage; s=statement coverage; t=toggle. Optional. More than one coverage type can be specified with a single -code argument (example: -code bces). -codeAll Specifies the command apply to all coverage types. Equivalent to -code bcestf. Optional. -du <du_name> Saves coverage statistics for the specified design unit. Optional. Only supported during live simulation, not in Coverage View mode. <du_name> is <library name>.<primary>(<secondary>), where the library name is optional, and secondary name is required only for VHDL. If there are parameterized instances, all are considered to match the specified design unit. -instance <path> Saves coverage data for only a specified instance and any of its children, recursively. Use the -norecursive argument to exclude data from the instances children. <path> is a path to the instance. You can specify more than one instance during live simulation; only one instance can be specified in Coverage View mode. Optional. -norecursive When saving coverage by instance, excludes data from children of the specified instance. Optional. -onexit Causes ModelSim to save coverage data automatically when the simulator exits. Optional.
178
Commands coverage save
<dbname> Designates the name of the database to save. Required.
Examples Save data from the current simulation into myfile1.ucdb:

coverage save myfile1
Save data from current simulation (into somefile.ucdb) when the simulator exits:
coverage save -onexit somefile
Save results for a specific design unit or instance in the design and all its children:
coverage save -instance ./path/inst1 mycov
See also Code Coverage, Verification Management, coverage attribute, coverage report, coverage save, vcover merge, vcover ranktest
179
Commands coverage testnames
coverage testnames
The coverage testnames command displays the testnames in the UCDB file currently loaded into memory. If a merged file, it gives you a list of tests in the merged file. This command is most useful if you use the -testextract for coverage analyze, because it requires the test name. By default, the testname is the name of the UCDB file, though you can set it to whatever you would like. Set the test name, before saving the UCDB file, using the command "coverage attribute -test mytestname". This command is only available during post-simulation processing, when a UCDB file is opened with vsim -viewcov. Syntax coverage testnames [-tcl] Arguments -tcl Print attribute information in a tcl format. Optional. See also Code Coverage, Verification Management Window, coverage attribute, coverage exclude, coverage goal, coverage report, coverage save, coverage weight, vcover merge, vcover ranktest, vcover stats, vcover testnames
180
Commands coverage weight
coverage weight
The coverage weight command sets a global per-type weight for total coverage calculations. Use the -plansection, -path, and -du arguments to set the weights for individual coverage items, design instances, design units,or test plan items. For more information regarding the use of the arguments and the type coverage statistics gathered, see Weight Option. Syntax coverage weight [-bydu] [-byinstance] [-type] [-fstate] [-ftrans] [-fail] [-pass] [-vpass] [-disabled] [-attempted] [-active] [-du <du_name> | -path <path> | -plansection <section_name>] [<integer_weight>] <coverage_types>= [-code {b | c | e | f | s | t}...] [-codeAll] [-sc] Arguments -active Assertion directive active, per instance. Optional. -bydu Modifier used to set per-du (code coverage only) -byinstance Modifier used to set a per-instance goal (code coverage and covergroup). Optional. -code {b | c | e | f | s | t}... Sets weight for code coverage data for coverage type: b=branch coverage; c=condition coverage; e=expression coverage; s=statement coverage; t=toggle; f=Finite State Machine coverage. More than one coverage type can be specified in a single -code argument (example: -code bces). Optional. -codeAll Specifies the command for all coverage types. Optional. Equivalent to -code bcestf. -du <du_name> Sets the weight for a given design unit. Optional. Mutually exclusive with -path and plansection. Cannot be combined with any other arguments besides <integer_weight>. -fstate Selects FSM state coverage. Optional. -ftrans Selects FSM transition coverage. Optional.
181
Commands coverage weight
<integer_weight> Specifies the value for the weight: must be a natural integer, greater than or equal to 0. Required in order to set weight: prints weight(s) if left unspecified.
-path <path> Sets the weight for a given coverage/design object. Optional. Mutually exclusive with -du and -plansection. Cannot be combined with any other arguments besides <integer_weight>.
-plansection <section_name> Sets the weight for a given test plan section. Optional. Mutually exclusive with -du and -path. Cannot be combined with any other arguments besides <integer_weight>.
-sc Specifies the command for SystemC coverage only. Optional. -type Specifies the command for covergroup type coverage. Optional.
See also Code Coverage, Verification Management, Verification Management Window, coverage attribute, coverage exclude, coverage goal,coverage report, coverage save, coverage testnames
182
Commands dataset alias
dataset alias
The dataset alias command assigns an additional name (alias) to a dataset. The dataset can then be referenced by that alias. A dataset can have any number of aliases, but all dataset names and aliases must be unique. Syntax dataset alias <dataset_name> [<alias_name>] Arguments <dataset_name> Specifies the name of the dataset to which to assign the alias. Required. <alias_name> Specifies the alias name to assign to the dataset. Optional. If you dont specify an alias_name, ModelSim lists current aliases for the specified dataset_name. See also dataset clear, dataset close, dataset config, dataset config, dataset info, dataset list, dataset open, dataset rename, dataset restart, dataset save, dataset snapshot
183
Commands dataset clear
dataset clear
The dataset clear command only applies to WLF based simulation datasets. This command applies to simulation datasets only. It has no effect on coverage (UCDB) datasets. This command removes all event data from the current simulation WLF file, while keeping all currently logged signals logged. Subsequent run commands will continue to accumulate data in the WLF file. If no design is loaded then it reports an error: Dataset not found:sim. If a design is loaded, then it clears the sim: dataset irrespective of which dataset is curently set. Clearing the dataset implies that any open wave window based on the sim: dataset is cleared. Syntax dataset clear Example Clear data in the WLF file from time 0ns to 100000ns, then log data into the WLF file from time 100000ns to 200000ns.
add wave * run 100000ns dataset clear run 100000ns
See also dataset alias, dataset close, dataset config, dataset config, dataset info, dataset list, dataset open, dataset rename, dataset restart, dataset save, dataset snapshot, Recording Simulation Results With Datasets, log
184
Commands dataset close
dataset close
The dataset close command closes an active dataset. To open a dataset, use the dataset open command. Syntax dataset close <logicalname> | [-all] Arguments <logicalname> Specifies the logical name of the dataset or alias you wish to close. Required if -all isnt used. -all Closes all open datasets including the simulation. Optional. See also dataset alias, dataset clear, dataset config, dataset config, dataset info, dataset list, dataset open, dataset rename, dataset restart, dataset save, dataset snapshot
185
Commands dataset config
dataset config
The dataset config command configures WLF file parameters after a WLF file has already been opened. This command has no effect on coverage datasets (UCDB). Syntax dataset config <dataset_name> [-wlfcachesize <n>] [-wlfdeleteonquit [0 | 1]] [-wlfopt [0 | 1]] Arguments <dataset_name> Specifies the logical name of the dataset or alias you wish to configure. Required. -wlfcachesize <n> Sets the size in megabytes of the WLF reader cache. Optional. Does not affect the WLF write cache. -wlfdeleteonquit When set to 1 (enabled), deletes the WLF file automatically when the simulation exits. Optional. Valid for the current simulation dataset only. -wlfopt When set to 1 (enabled), optimizes the display of waveforms in the Wave window. Default. Optional. See also dataset alias, dataset clear, dataset close, dataset config, dataset info, dataset list, dataset open, dataset rename, dataset restart, dataset save, dataset snapshot, WLF File Parameter Overview, vsim
186
Commands dataset current
dataset current
The dataset current command opens the specified dataset and sets the GUI context to the last selected context of the specified dataset. All context depenedent GUI data is updated and all context dependent CLI commands start working with respect to the new context. Syntax dataset current [<dataset_name> ] Arguments [<dataset_name>] Specifies the logical name of the dataset or alias you wish to display. Optional. If no dataset name is specified, the command returns the name of the currently displayed dataset. See also dataset alias, dataset clear, dataset close, dataset info, dataset list, dataset open, dataset rename, dataset restart, dataset save, dataset snapshot, WLF File Parameter Overview, vsim
187
Commands dataset info
dataset info
The dataset info command reports a variety of information about a dataset. Syntax dataset info <option> <dataset_name> Arguments <option> Identifies what information you want reported. Required. Only one option per command is allowed. The current options include: name Returns the actual name of the dataset. Useful for identifying the real dataset name of an alias. file Returns the name of the WLF file or UCDB file associated with the dataset. exists Returns "1" if the dataset exists; "0" if it doesnt. <dataset_name> Specifies the name of the dataset or alias for which you want information. Optional. If you do not specify a dataset name, ModelSim uses the dataset of the current environment (see the environment command). See also dataset alias, dataset clear, dataset close, dataset config, dataset config, dataset list, dataset open, dataset rename, dataset restart, dataset save, dataset snapshot
188
Commands dataset list
dataset list
The dataset list command lists all active datasets. Syntax dataset list [-long] Arguments -long Lists the filename corresponding to each datasets logical name. Optional. See also dataset alias, dataset clear, dataset close, dataset config, dataset config, dataset info, dataset open, dataset rename, dataset restart, dataset save, dataset snapshot
189
Commands dataset open
dataset open
The dataset open command opens a WLF file (representing a prior simulation) and/or UCDB file (representing coverage data) and assigns it the logical name that you specify. To close a dataset, use dataset close. Syntax dataset open <filename> [<logicalname>] Arguments <filename> Specifies the WLF file or UCDB file to open as a view-mode dataset. Required. <logicalname> Specifies the logical name for the dataset. Optional. This is a prefix that will identify the dataset in the current session. By default the dataset prefix will be the name of the specified WLF or UCDB file. Examples Open the dataset file last.wlf and assigns it the logical name test.
dataset open last.wlf test
See also dataset alias, dataset clear, dataset close, dataset config, dataset config, dataset info, dataset list, dataset rename, dataset restart, dataset save, dataset snapshot, vsim -view option
190
Commands dataset rename
dataset rename
The dataset rename command changes the logical name of a dataset to the new name you specify. Syntax dataset rename <logicalname> <newlogicalname> Arguments <logicalname> Specifies the existing logical name of the dataset. Required. <newlogicalname> Specifies the new logical name for the dataset. Required. Examples Rename the dataset file "test" to "test2".
dataset rename test test2
See also dataset alias, dataset clear, dataset close, dataset config, dataset config, dataset info, dataset list, dataset open, dataset restart, dataset save, dataset snapshot
191
Commands dataset restart
dataset restart
The dataset restart command unloads the specified dataset or current dataset and reloads the file using the same pathname. The contents of Wave and other coverage windows are restored for UCDB datasets after a reload. Syntax dataset restart [<filename>] Arguments <filename> Specifies the WLF or UCDB file to open as a view-mode or coverage mode dataset. Optional. If <filename> is not specified, the current dataset is restarted. See also dataset alias, dataset clear, dataset close, dataset config, dataset config, dataset info, dataset list, dataset open, dataset rename, dataset save, dataset snapshot
192
Commands dataset save
dataset save
The dataset save command writes data from the current simulation to the specified file. This lets you save simulation data while the simulation is still in progress. This command is equivalent to the coverage save command for coverage datasets. Syntax dataset save <datasetname> <filename> Arguments <datasetname> Specifies the name of the dataset you want to save. Required. <filename> Specifies the name of the file to save. Required. Examples Save all current log data in the sim dataset to the file "gold.wlf".
dataset save sim gold.wlf
See also dataset alias, dataset clear, dataset close, dataset config, dataset config, dataset info, dataset list, dataset open, dataset rename, dataset restart, dataset snapshot
193
Commands dataset snapshot
dataset snapshot
The dataset snapshot command saves data from the current WLF file (vsim.wlf by default) at a specified interval. This lets you take sequential or cumulative "snapshots" of your simulation data. This command does not apply to coverage datasets (UCDB). Syntax dataset snapshot [-dir <directory>] [-disable] [-enable] [-file <filename>] [-filemode overwrite | increment] [-mode cumulative | sequential] [-report] [-reset] [-size <file size> | -time <simulation time>] Arguments -dir <directory> Specifies a directory into which the files should be saved. Optional. Default is to save into the directory where ModelSim is writing the current WLF file. -disable Turns snapshotting off. Optional. All other options are ignored if you specify -disable. -enable Turns snapshotting on. Optional. Default. -file <filename> Specifies the name of the file to save. Optional. Default is "vsim_snapshot". ".wlf" will be appended to the file and possibly an incrementing suffix if -filemode is set to "increment". -filemode overwrite | increment Specifies whether to overwrite the snapshot file each time a snapshot occurs. Optional. Default is "overwrite". If you specify "increment", a new file is created for each snapshot. An incrementing suffix (1 to n) is added to each new file (e.g., vsim_snapshot_1.wlf). -mode cumulative | sequential Specifies whether to keep all data from the time signals are first logged. Optional. Default is "cumulative". If you specify "sequential", the current WLF file is cleared every time a snapshot is taken. See the examples for further details. -report Lists current snapshot settings in the Transcript pane. Optional. All other options are ignored if you specify -report. -reset Resets values back to defaults. Optional. The behavior is to reset to the default, then apply the remainder of the arguments on the command line. See examples below. If specified by itself without any other arguments, -reset disables dataset snapshot.
194
Commands dataset snapshot
-size <file size> Specifies that a snapshot occurs based on WLF file size. You must specify either -size or -time. See examples below.
-time <simulation time> Specifies that a snapshot occurs based on simulation time. You must specify either -time or -size. See examples below.
Examples Create the file vsim_snapshot.wlf that is written to every time the current WLF file reaches a multiple of 10 MB (i.e., at 10 MB, 20 MB, 30 MB, etc.).
dataset snapshot -size 10
Similar to the previous example, but in this case the current WLF file is cleared every time it reaches 10 MB.
dataset snapshot -size 10 -mode sequential
Assuming simulator time units are ps, this command saves a file called gold_n.wlf every 1000000 ps. If you ran for 3000000 ps, youd have three files: gold_1.wlf with data from 0 to 1000000 ps, gold_2.wlf with data from 1000001 to 2000000, and gold_3.wlf with data from 2000001 to 3000000.
dataset snapshot -time 1000000 -file gold.wlf -mode sequential -filemode increment
Note Because this example uses "sequential" mode, if you ran the simulation for 3500000 ps, the resulting vsim.wlf (the default log file) file will contain data only from 3000001 to 3500000 ps. Enable snapshotting with time=10000 and default mode (cumulative) and default filemode (overwrite).
dataset snapshot -reset -time 10000
See also dataset alias, dataset clear, dataset close, dataset config, dataset config, dataset info, dataset list, dataset open, dataset rename, dataset restart, dataset save
195
Commands delete
delete
The delete command removes objects from either the List or Wave window. Syntax delete list | wave [-window <wname>] <object_name> Arguments list | wave Specifies the target window for the delete command. Required. -window <wname> Specifies the name of the List or Wave window to target for the delete command (the view command allows you to create more than one List or Wave window). Optional. If no window is specified the default window is used; the default window is determined by the most recent invocation of the view command. <object_name> Specifies the name of an object. Required. Must match an object name used in an add list or add wave command. Multiple object names may be specified. Wildcard characters are allowed. Examples Remove the object vec2 from the list2 window.
delete list -window list2 vec2
See also add list, add wave, and Wildcard Characters
196
Commands describe
describe
The describe command displays information about the specified HDL object, C variable, or design region. The description is displayed in the Transcript pane. The following kinds of objects can be described: Design region VHDL signals, variables, and constants Verilog nets and registers C variables SystemC signals, ports, FIFOs, and member variables of modules
VHDL signals, Verilog nets and registers, and SystemC signals and ports may be specified as hierarchical names. C variables can be described if you are running C Debug, and the variables are local to the active call frame for the line in the function in the C source file where you are stopped. For specific information related to viewing SystemC objects refer to SystemC Object and Type Display. Syntax describe <name> Arguments <name> The name of an HDL object, SystemC signal, or C variable for which you want a description. HDL object names can be full hierarchical names or relative names. Examples Print the type of C variable x.
describe x
Print the type of what p points to.

describe *p
Print the types of the three specified signals.

describe clk prw prdy
197
Commands disablebp
disablebp
The disablebp command turns off breakpoints and when commands. To turn the breakpoints or when statements back on again, use the enablebp command. Syntax disablebp [<id#> | <label>] Arguments <id#> Specifies the ID number of a breakpoint or when command to disable. Optional. Note that C breakpoint id#s are prefixed with "c." (refer to C Debug). <label> Specifies the label name of a breakpoint or when command to disable. Optional. If you do not specify either of these arguments, all breakpoints are disabled. See also bd, bp, enablebp, onbreak, resume, when
198
Commands disable_menu
disable_menu
The disable_menu command disables the specified menu within the specified window. The disabled menu will become grayed-out and nonresponsive. Returns nothing. Syntax disable_menu <window_name> <menu_path> Arguments <window_name> Tk path of the window containing the menu. Required. The path for the Main window must be expressed as "". All other window pathnames begin with a period (.) as shown in the example below. <menu_path> Name of the Tk menu-widget path. Required. Examples Disable the file menu of the Main window.
disable_menu "" File
Disable the file menu of the mywindow window.

disable_menu .mywindow File
See also add_menu, enable_menu
199
Commands disable_menuitem
disable_menuitem
The disable_menuitem command disables a specified menu item within the specified menu path of the specified window. The menu item will become grayed-out and nonresponsive. Returns nothing. Syntax disable_menuitem <window_name> <menu_path> <label> Arguments <window_name> Tk path of the window containing the menu. Required. Note that the path for the Main window must be expressed as "". All other window pathnames begin with a period (.) as shown in the example below. <menu_path> Name of the Tk menu-widget path. The path may include a submenu as shown in the example below. Required. <label> Menu item text. Required. Examples This command locates the mywindow window, and disables the Save Results As... menu item in the save submenu of the file menu.
disable_menuitem .mywindow file.save "Save Results As..."
See also add_menuitem, enable_menuitem
200
Commands do
do
The do command executes commands contained in a macro file. A macro file can have any name and extension. An error encountered during the execution of a macro file causes its execution to be interrupted, unless an onerror command, onbreak command, or the OnErrorDefaultAction Tcl variable has specified with the resume command. Syntax do <filename> [<parameter_value>] Arguments <filename> Specifies the name of the macro file to be executed. Required. The name can be a pathname or a relative file name. Pathnames are relative to the current working directory if the do command is executed from the command line. If the do command is executed from another macro file, pathnames are relative to the directory of the calling macro file. This allows groups of macro files to be moved to another directory and still work. <parameter_value> Specifies values that are to be passed to the corresponding parameters $1 through $9 in the macro file. Optional. Multiple parameter values must be separated by spaces. If you want to make the parameters optional (i.e., specify fewer parameter values than the number of parameters actually used in the macro), you must use the argc simulator state variable in the macro. Refer to Making Macro Parameters Optional. Note that there is no limit on the number of parameters that can be passed to macros, but only nine values are visible at one time. You can use the shift command to see the other parameters. Examples This command executes the file macros/stimulus, passing the parameter value 100 to $1 in the macro file.
do macros/stimulus 100
If the macro file testfile contains the line bp $1 $2, this command would place a breakpoint in the source file named design.vhd at line 127.
do testfile design.vhd 127
See also Tcl and Macros (DO Files), Modes of Operation, Using a Startup File, DOPATH variable
201
Commands down
down
The down command searches for object transitions or values in the specified List window. It executes the search on objects currently selected in the window, starting at the time of the active cursor. The active cursor moves to the found location. Use this command to move to consecutive transitions or to find the time at which an object takes on a particular value, or an expression of multiple objects evaluates to true. See the up command for related functionality. The procedure for using down includes three steps: click on the desired object; click on the desired starting location; issue the down command. (The seetime command can initially position the cursor from the command line, if desired.) Returns: <number_found> <new_time> <new_delta> Syntax down [-expr {<expression>}] [-falling] [-noglitch] [-rising] [-value <sig_value>] [-window <wname>] [<n>] Arguments -expr {<expression>} The List window will be searched until the expression evaluates to a boolean true condition. Optional. The expression may involve more than one object, but is limited to objects that have been logged in the referenced List window. An object may be specified either by its full path or by the shortcut label displayed in the List window. See GUI_expression_format for the format of the expression. The expression must be placed within curly braces. -falling Searches for a falling edge on the specified object if that object is a scalar object. If it is not a scalar object, the option will be ignored. Optional. -noglitch Specifies that delta-width glitches are to be ignored. Optional. -rising Searches for a rising edge on the specified object if that object is a scalar object. If it is not a scalar object, the option will be ignored. Optional. -value <sig_value> Specifies a value of the object to match. Optional. Must be specified in the same radix that the selected object is displayed. Case is ignored, but otherwise the value must be an exact string match don't-care bits are not yet implemented.
202
Commands down
-window <wname> Specifies an instance of the List window that is not the default. Optional. Otherwise, the default List window is used. Use the view command to change the default window.
<n> Specifies to find the nth match. Optional. If less than n are found, the number found is returned with a warning message, and the marker is positioned at the last match.
Examples Find the next time at which the selected vector transitions to FF23, ignoring glitches.
down -noglitch -value FF23
Go to the next transition on the selected object.

down
The following examples illustrate search expressions that use a variety of object attributes, paths, array constants, and time variables. Such expressions follow the GUI_expression_format. Search down for an expression that evaluates to a boolean 1 when object clk just changed from low to high and object mystate is the enumeration reading and object /top/u3/addr is equal to the specified 32-bit hex constant.
down -expr {clkrising && (mystate == reading) && (/top/u3/addr == 32habcd1234)}
Search down for an expression that evaluates to a boolean 1 when the upper 8 bits of the 32-bit object /top/u3/addr equals hex ac.
down -expr {(/top/u3/addr and 32hff000000) == 32hac000000}
Search down for an expression that evaluates to a boolean 1 when logfile time is between 23 and 54 microseconds, clock just changed from low to high, and object mode is enumeration writing.
down -expr {((NOW > 23 us) && (NOW < 54 us)) && clkrising && (mode == writing)}
See also GUI_expression_format, view, seetime, up
203
Commands drivers
drivers
The drivers command displays the names and strength of all drivers of the specified object. The driver list is expressed relative to the top-most design signal/net connected to the specified object. If the object is a record or array, each subelement is displayed individually. Syntax drivers <object_name> Arguments <object_name> Specifies the name of the signal or net whose drivers are to be shown. Required. All signal or net types are valid. Multiple names and wildcards are accepted. Example
drivers /top/dut/pkt_cnt(4) # Drivers for /top/dut/pkt_cnt(4): # St0 : Net /top/dut/pkt_cnt[4] # St0 : Driver /top/dut/pkt_counter/#IMPLICIT-WIRE(cnt_out)#6
In some cases, the output may supply a strength value similar to 630 or 52x, which indicates an ambiguous verilog strength. For more information, please refer to the Verilog LRM Std 13652005 section 7.10.2 "Ambiguous strengths: sources and combinations". See also readers
204
Commands dumplog64
dumplog64
The dumplog64 command dumps the contents of the specified WLF file in a readable format to stdout. The WLF file cannot be opened for writing in a simulation when you use this command. The dumplog64 command cannot be used in a DO file. Syntax dumplog64 <filename> Arguments <filename> The name of the WLF file to be read. Required.
205
Commands echo
echo
The echo command displays a specified message in the Transcript pane. Syntax echo [<text_string>] Arguments <text_string> Specifies the message text to be displayed. Optional. If the text string is surrounded by quotes, blank spaces are displayed as entered. If quotes are omitted, two or more adjacent blank spaces are compressed into one space. Examples If the current time is 1000 ns, this command:
echo The time is $now ns.
produces the message:

The time is 1000 ns.
If the quotes are omitted:

echo The time is $now ns.
all blank spaces of two or more are compressed into one space.
The time is $now ns.
echo can also use command substitution, such as:

echo The hex value of counter is [examine -hex counter].
If the current value of counter is 21 (15 hex), this command produces:

The hex value of counter is 15.
206
Commands edit
edit
The edit command invokes the editor specified by the EDITOR environment variable. By default, the specified filename will open in ModelSim Source editor. Syntax edit [<filename>] Arguments <filename> Specifies the name of the file to edit. Optional. If the <filename> is omitted, the editor opens the current source file. If you specify a non-existent filename, it will open a new file. See also notepad, EDITOR environment variable
207
Commands enablebp
enablebp
The enablebp command turns on breakpoints and when commands that were previously disabled. Syntax enablebp [<id#> | <label>] Arguments <id#> Specifies a ID number of breakpoint or when statement to enable. Optional. Note that C breakpoint id#s are prefixed with "c.". <label> Specifies the label name of a breakpoint or when statement to enable. Optional. If you dont specify either of these arguments, all breakpoints are enabled. See also bd, bp, disablebp, onbreak, resume, when, C Debug
208
Commands enable_menu
enable_menu
The enable_menu command enables a previously-disabled menu. The menu will be changed from grayed-out to normal and will become responsive. Returns nothing. Syntax enable_menu <window_name> <menu_path> Arguments <window_name> Tk path of the window containing the menu. Required. Note that the path for the Main window must be expressed as "". All other window pathnames begin with a period (.) as shown in the example below. <menu_path> Name of the Tk menu-widget path. Required. Examples Enable the previously-disabled File menu of the Main window.
enable_menu "" File
Enable the previously-disabled File menu of the mywindow window.

enable_menu .mywindow File
See also add_menu, disable_menu
209
Commands enable_menuitem
enable_menuitem
The enable_menuitem command enables a previously-disabled menu item. The menu item will be changed from grayed-out to normal, and will become responsive. Returns nothing. Syntax enable_menuitem <window_name> <menu_path> <label> Arguments <window_name> Tk path of the window containing the menu. Required. Note that the path for the Main window must be expressed as "". All other window pathnames begin with a period (.) as shown in the example below. <menu_path> Name of the Tk menu-widget path. The path may include a submenu as shown in the example below. Required. <label> Menu item text. Required. Examples This command locates the mywindow window and enables the previously-disabled Save Results As... menu item in the save submenu of the file menu.
enable_menuitem .mywindow file.save "Save Results As..."
See also add_menuitem, disable_menuitem
210
Commands environment
environment
The environment, or env command, allows you to display or change the current dataset and region/signal environment. Syntax environment [-dataset] [-nodataset] [<pathname> | -forward | -back] Arguments -dataset Displays the specified environment pathname with a dataset prefix. Optional. Dataset prefixes are displayed by default if more than one dataset is open during a simulation session. -nodataset Displays the specified environment pathname without a dataset prefix. Optional. <pathname> Specifies the pathname to which the current region/signal environment is to be changed. See Object Name Syntax for information on specifying pathnames. Optional. If omitted the command causes the pathname of the current region/signal environment to be displayed. -forward Displays the next environment in your history of visited environments. Optional. -back Displays the previous environment in your history of visited environments. Optional. Refer to the section "Setting your Context by Navigating Source Files" in the Users Manual for more information about -forward and -back. Examples Display the pathname of the current region/signal environment.
env
Change to another dataset but leave it at the currently selected context.

env test:
Change all unlocked windows to the context "test: /top/foo".

env test:/top/foo
Move down two levels in the design hierarchy.

env blk1/u2
211
Commands environment
Move to the top level of the design hierarchy.

env /
212
Commands examine
examine
The examine command examines one or more objects and displays current values (or the values at a specified previous time) in the Transcript pane. It optionally can compute the value of an expression of one or more objects. If you are using C Debug, examine can display the value of a C variable as well. If the design is being optimized with vopt, some of the objects listed below may not be available for viewing. See "Preserving Object Visibility for Debugging Purposes" in the Users Manual for more information. The following objects can be examined: VHDL signals, shared variables, process variables, constants, and generics Verilog nets, registers, parameters, and variables C variables SystemC signals, FIFOs, ports, and member variables of modules
When stopped in C code, examine (with no arguments) displays the values of the local variables and arguments of the current C function. For specific information related to viewing SystemC objects refer to SystemC Object and Type Display. To display a previous value, specify the desired time using the -time option. To compute an expression, use the -expr option. The -expr and the -time options may be used together. Virtual signals and functions may also be examined within the GUI (actual signals are examined in the kernel). The following rules are used by the examine command to locate an HDL object: If the name does not include a dataset name, then the current dataset is used. If the name does not start with a path separator, then the current context is used. If the name is a path separator followed by a name that is not the name of a top-level design unit, then the first top-level design unit in the design is used. For a relative name containing a hierarchical path, if the first object name cannot be found in the current context, then an upward search is done up to the top of the design hierarchy to look for a matching object name. If no objects of the specified name can be found in the specified context, then an upward search is done to look for a matching object in any visible enclosing scope up to an instance boundary. If at least one match is found within a given context, no (more) upward searching is done; therefore, some objects that may be visible from a given context will not be found when wildcards are used if they are within a higher enclosing scope.
213
Commands examine
The wildcards '*' and '?' can be used at any level of a name except in the dataset name and inside of a slice specification. A wildcard character will never match a path separator. For example, /dut/* will match /dut/siga and /dut/clk. However, /dut* wont match either of those.
See Design Object Names for more information on specifying names. Syntax examine [-delta <delta>] [-env <path>] [-handle] [-in] [-out] [-inout] [-internal] [-maxlen [0 | <integer>]] [-ports] [-expr <expression>] [-name] [-<radix_type>] [-radix <type>] [-radixenumnumeric | -radixenumsymbolic] [-time <time>] [-value] <name> Arguments -delta <delta> (optional) Specifies a simulation cycle at the specified time from which to fetch the value. The default is to use the last delta of the time step. The objects to be examined must be logged via the add list, add wave, or log command in order for the examine command to be able to return a value for a requested delta. This option can be used only with objects that have been logged via the add list, add wave, or log command. -env <path> (optional) Specifies a path in which to look for an object name. -expr <expression> (optional) Specifies an expression to be evaluated. The objects to be examined must be logged via the add list, add wave, or log command in order for the examine command to be able to evaluate the specified expression. If the -time argument is present, the expression will be evaluated at the specified time, otherwise it will be evaluated at the current simulation time. See GUI_expression_format for the format of the expression. The expression must be placed within curly braces. -handle (optional) Returns the memory address of the specified <name>. This value can be useful, as a semi-unique tag, for advanced HDL designers when analyzing the simulation of their design. This value is also used as the title of a box in the Watch window. This option will not return any value if you are in -view mode. -in (optional) Specifies that <name> include ports of mode IN. -out (optional) Specifies that <name> include ports of mode OUT. -inout (optional) Specifies that <name> include ports of mode INOUT.
214
Commands examine
-internal (optional) Specifies that <name> include internal (non-port) signals. -maxlen [0 | <integer>] (optional) Specifies the maximum number of characters in the output of the command. The default setting is the value of the MaxValueLen simulator variable, which, itself, defaults to 30,000 characters. A value of zero (0) indicates an unlimited number of characters.
-ports (optional) Specifies that <name> include all ports. Has the same effect as specifying -in, -inout, and -out together.
-name (optional) Displays object name(s) along with the value(s). Default is -value behavior (see below). The lecho command will return the output of an examine command in "pretty-print" format. For example, lecho [examine -name clk prw pstrb]
-<radix_type> (optional) Specifies the radix type for the objects that follow in the command. Valid entries (or any unique abbreviations) are: binary, ascii, unsigned, decimal, octal, hex, symbolic, time, and default. If no radix is specified for an enumerated type, the default representation is used. You can change the default radix for the current simulation using the radix command. You can change the default radix permanently by editing the DefaultRadix variable in the modelsim.ini file.
-radix <type> (optional) Specifies a user-defined radix. Valid entries for <radix_type> are: binary, ascii, unsigned, decimal, octal, hex, symbolic, time, and default. The -radix <radix_type> argument can be used in place of the -<radix> entries. For example, -radix hexadecimal is the same as -hex.
-radixenumnumeric (optional) Displays SystemVerilog and SystemC enums as numbers rather than strings. The current radix setting controls the actual enum value displayed, except when the radix setting is ASCII. If the current radix setting is ASCII, the value of SystemVerilog and SystemC enums are displayed as a string. This option overrides the global setting of the default radix (the DefaultRadix variable in the modelsim.ini file).
-radixenumsymbolic (optional) Reverses the action of the -radixenumnumeric option and sets the global setting of the default radix (the DefaultRadix variable in the modelsim.ini file) to symbolic.
215
Commands examine
-time <time> (optional) Specifies the time value between 0 and $now for which to examine the objects. If an expression is specified it will be evaluated at that time. The objects to be examined must be logged via the add list, add wave, or log command in order for the examine command to be able to return a value for a requested time. If the <time> field uses a unit, the value and unit must be placed in curly braces. For example, the following are equivalent for ps resolution:
exa -time {3.6 ns} signal_a exa -time 3600 signal_a
-value Returns value(s) as a curly-braces separated Tcl list. Default. Use to toggle off a previous use of -name.
<name> Specifies the name of any HDL or SystemC object. Required (except when the -expr option is used). All object types are allowed, except those of the type file. Multiple names and wildcards are accepted. Spaces, square brackets, and extended identifiers require curly braces; see examples below for more details. To examine a VHDL variable you can add a process label to the name. For example, (make certain to use two underscore characters):
exa line__36/i
Examples Return the value of /top/bus1.

examine /top/bus1
Return the value of the subelement of rega that is specified by the index (i.e., 16). Note that you must use curly braces when examining subelements.examine
{rega[16]}
Return the value of the contiguous subelements of foo specified by the slice (i.e., 20:22). Note the curly braces.
examine {foo[20:22]}
Note that when specifying an object that contains an extended identifier as the last part of the name, there must be a space after the closing '\' and before the closing '}'.
examine {/top/\My extended id\ }
In this example, the -expr option specifies a signal path and user-defined Tcl variable. The expression will be evaluated at 3450us.
examine -time {3450 us} -expr {/top/bus and $bit_mask}
216
Commands examine
Using the ${fifo} syntax limits the variable to the simple name fifo, instead of interpreting the parenthesis as part of the variable. Quotes are needed when spaces are involved; and by using quotes (") instead of braces, the Tcl interpreter will expand variables before calling the command.
examine -time $t -name $fifo "${fifo}(1 to 3)" ${fifo}(1)
Because -time is not specified, this expression will be evaluated at the current simulation time. Note the signal attribute and array constant specified in the expression.
examine -expr {clkevent && (/top/xyz == 16hffae)}
Commands like find and examine return their results as a Tcl list (just a blank-separated list of strings). You can do things like:
foreach sig [find sig ABC*] {echo "Signal $sig is [exa $sig]" } if {[examine -bin signal_12] == 11101111XXXZ} {} examine -hex [find *]
The Tcl variable array, $examine (), can also be used to return values. For example, $examine (/clk). You can also examine an object in the Source Window by selecting it with the right mouse button. Print the value of C variable x.
examine x
Print the value *p (de-references p).

examine *p
Print the structure member in1 pointed to by ip.

examine ip->in1
See also Design Object Names, Wildcard Characters, GUI_expression_format, C Debug
217
Commands exit
exit
The exit command exits the simulator and the ModelSim application. If you want to stop the simulation using a when command, you must use a stop command within your when statement. DO NOT use an exit command or a quit command. The stop command acts like a breakpoint at the time it is evaluated. Syntax exit [-force] [-code] Argument -force Quits without asking for confirmation. Optional; if this argument is omitted, ModelSim asks you for confirmation before exiting. -code <integer> Quits the simulation and issues an exit code. <integer> This is the value of the exit code. You should not specify an exit code that already exists in the tool. Refer to the section "Exit Codes" in the Users Manual for a list of existing exit codes. You can also specify a variable in place of the <integer>. You should always print a message before executing the exit -code command to explicitly state the reason for exiting. Examples You can use the exit -code syntax to instruct a vmake run to exit when encountering an assertion error. The onbreak command can specify commands to be executed upon an assert failure of sufficient severity, upon which the simulator can be made to return an exit status, as shown in the following example
set broken 0 onbreak { set broken 88 resume } run -all if { $broken } { puts "failure -- exit status $broken" exit -code $broken } else { puts "success" } quit -f
The resume command gives control back to the commands following the run -all to handle the condition appropriately.
218
Commands find
find
The find command locates objects in the design whose names match the name specification you provide. You must specify the type of object you want to find. When searching for nets and signals, the find command returns the full pathname of all nets, signals, registers, variables, and named events that match the name specification. When searching for instances, the find command returns the primary design unit name. When searching for nets and signals, the order in which arguments are specified is unimportant. When searching for virtuals, however, all optional arguments must be specified before any object names. The following rules are used by the find command to locate an object: If the name does not include a dataset name, then the current dataset is used. If the name does not start with a path separator, then the current context is used. If the name is a path separator followed by a name that is not the name of a top-level design unit, then the first top-level design unit in the design is used. For a relative name containing a hierarchical path, if the first object name cannot be found in the current context, then an upward search is done up to the top of the design hierarchy to look for a matching object name. If no objects of the specified name can be found in the specified context, then an upward search is done to look for a matching object in any visible enclosing scope up to an instance boundary. If at least one match is found within a given context, no (more) upward searching is done; therefore, some objects that may be visible from a given context will not be found when wildcards are used if they are within a higher enclosing scope. The wildcards '*' and '?' can be used at any level of a name except in the dataset name and inside of a slice specification. Square bracket [] wildcards can also be used. A wildcard character will never match a path separator. For example, /dut/* will match /dut/siga and /dut/clk. However, /dut* wont match either of those. Because square brackets are wildcards in the find command, only parentheses () can be used to index or slice arrays. The WildcardFilter Tcl preference variable is used by the find command to exclude the specified types of objects when performing the search.
See Design Object Names for more information on specifying names. Syntax find nets | signals [-in] [-inout] [-internal] <object_name> [-nofilter] [-out] [-ports] [-recursive] find instances | blocks [-recursive] <object_name>
219
Commands find
find virtuals [-kind <kind>] [-unsaved] <object_name> find classes [<class_name>] find objects [-class <class_name>] [-isa <class_name>] [<object_name>] Arguments for nets and signals -in Specifies that the scope of the search is to include ports of mode IN. Optional. -inout Specifies that the scope of the search is to include ports of mode INOUT. Optional. -internal Specifies that the scope of the search is to include internal (non-port) objects. Optional. <object_name> Specifies the net or signal for which you want to search. Required. Multiple nets and signals and wildcard characters are allowed. Wildcards cannot be used inside of a slice specification. Spaces, square brackets, and extended identifiers require special syntax; see the examples below for more details. -nofilter Specifies that the WildcardFilter Tcl preference variable be ignored when finding signals or nets. Optional. -out Specifies that the scope of the search is to include ports of mode OUT. Optional. -ports Specifies that the scope of the search is to include all ports. Optional. Has the same effect as specifying -in, -out, and -inout together. -recursive Specifies that the scope of the search is to descend recursively into subregions. Optional. If omitted, the search is limited to the selected region. Arguments for instances and blocks -recursive Specifies that the scope of the search is to descend recursively into subregions. Optional. If omitted, the search is limited to the selected region. <object_name> Specifies the instance or block for which you want to search. Required. Multiple instances and wildcard characters are allowed.
220
Commands find
Arguments for virtuals -kind <kind> Specifies the kind of virtual object for which you want to search. Optional. <kind> can be one of designs, explicits, functions, implicits, or signals. -unsaved Specifies that ModelSim find only virtuals that have not been saved to a format file. <object_name> Specifies the virtual object for which you want to search. Required. Multiple virtuals and wildcard characters are allowed. Arguments for classes <class_name> Specifies the incrTcl class for which you want to search. Optional. Wildcard characters are allowed. The options for class_name include nets, objects, signals, and virtuals. If you do not specify a class name, the command returns all classes in the current namespace context. See "incrTcl commands" in the Tcl Man Pages for more information. Arguments for objects -class <class_name> Restricts the search to objects whose most-specific class is class_name. Optional. -isa <class_name> Restricts the search to those objects that have class_name anywhere in their heritage. Optional. <object_name> Specifies the incrTcl object for which you want to search. Optional. Wildcard characters are allowed. If you do not specify an object name, the command returns all objects in the current namespace context. See "incrTcl commands" in the Tcl Man Pages for more information. Examples Find all signals in the entire design.
find signals -r /*
Find all input signals in region /top that begin with the letters "xy".
find nets -in /top/xy*
Find all signals in the design hierarchy at or below the region <current_context>/u1/u2 whose names begin with "cl".
find signals -r u1/u2/cl*
221
Commands find
Find a signal named s1. Note that you must enclose the object in curly braces because of the square bracket wildcard characters.
find signals {s[1]}
Find signals s1, s2, or s3.

find signals {s[123]}
Find the element of signal s that is indexed by the value 1. Note that the find command uses parentheses, not square brackets, to specify a subelement index.
find signals s(1)
Find a 4-bit array named data. Note that you must use curly braces due to the spaces in the array slice specification.
find signals {/top/data(3 downto 0)}
Note that when specifying an object that contains an extended identifier as the last part of the name, there must be a space after the closing '\' and before the closing '}'.
find signals {/top/\My extended id\ }
If /dut/core/pclk exists, prints the message "pclk does exist" in the transcript. This would typically be run in a Tcl script.
if {[find signals /dut/core/pclk] != ""} { echo "pclk does exist" }
Find instances based on their names using wildcards. Send search results to a text file that lists instance names, including the hierarchy path, on separate lines.
# Search for all instances with u1 in path set pattern_match "*u1*" ; # Get the list of instance paths set inst_list [find instances -r *]
# Initialize an empty list to strip off the architecture names set ilist [list] ; foreach inst $inst_list { set ipath [lindex $inst 0] if {[string match $pattern_match $ipath]} { lappend ilist $ipath } } # At this point, ilist contains the list of instances only-# no architecture names # # Begin sorting list set ilist [lsort -dictionary $ilist] # Open a file to write out the list
222
Commands find set fhandle [open "instancelist.txt" w] foreach inst $ilist { # Print instance path, one per line puts $fhandle $inst } # Close the file, done. close $fhandle ;
Additional search options To search for HDL objects within a specific display window, use the search command or select Edit > Find. See also Design Object Names, Wildcard Characters
223
Commands find infiles
find infiles
The find infiles command searches the specified files and prints to the Transcript pane those lines from the files that match the specified pattern. You can double-click on the results in the Transcript pane to open the specific file and display the referenced line. When you use this command in command-line mode, outside of the GUI, the results are sent to stdout and you do not have the capability to view the file by double-clicking the result. Syntax find infiles <string_pattern> {<file_pattern> [<file_pattern> ...]} Arguments <string_pattern> The string you are searching for. You can use regular expression wildcards to further restrict the search capability. <file_pattern> [<file_pattern> ...] The file(s) you are searching. You can use regular expression wildcards to further restrict the search capability. Example Figure 2-2 shows a screen capture containing a couple examples of the find infiles command and its results. Figure 2-1. find infiles Example
224
Commands find insource
find insource
The find insource command searches all source files related to the current design and prints to the Transcript pane those lines from the files that match the specified pattern. You can double-click on the results in the Transcript pane to open the specific file and display the referenced line. When you use this command in command-line mode, outside of the GUI, the results are sent to stdout and you do not have the capability to view the file by double-clicking the result. Syntax find insource <pattern> Arguments <pattern> The string you are searching for. You can use regular expression wildcards to further restrict the search. You must enclose <pattern> in quotes (") if it includes spaces. Example Figure 2-2 shows a couple of examples of the find insource command and its results in the Transcript window. Figure 2-2. find insource Example
225
Commands formatTime
formatTime
The formatTime command provides global format control for all time values displayed in the GUI. This command always returns the current state of its three arguments. Syntax formatTime +|-commas | +|-nodefunits | +|-bestunits Arguments +|-commas Insert commas into the time value to make it easier to read. Optional. A leading + turns the argument on; a leading - turns the argument off. Default is off. +|-nodefunits Do not include default unit in the time. Optional. A leading + turns the argument on; a leading - turns the argument off. Default is off. +|-bestunits Use the largest unit value possible. Optional. A leading + turns the argument on; a leading - turns the argument off. Default is off. Examples Display commas in time values.
formatTime +commas
Instead of displaying 6458131 ps, the GUI will display 6,458,131 ps. Use largest unit value possible.
formatTime +bestunits
Displays 8 us instead of 8,000 ns.
226
Commands force
force
The force command allows you to apply stimulus interactively to VHDL signals and Verilog nets. Since force commands (like all commands) can be included in a macro file, it is possible to create complex sequences of stimuli. When you do not specify any arguments, this command returns a list of the most recently applied force commands. There are a number of constraints on what you can and cannot force: You cannot force VHDL variables; these must be changed. See the change command. In VHDL and mixed models, you cannot force an input port that is mapped at a higher level. In other words, you can force the signal at the top of the hierarchy connected to the input port but you cannot force the input port directly. You cannot force slices of a register; you can force only bit-selects or the entire register. You cannot force a VHDL alias of a VHDL signal. You cannot force an input port that has a conversion function on the input. You can force Virtual Signals if the number of bits corresponds to the signal value. You cannot force virtual functions. You can force signals within SystemC modules, with the following limitations: Syntax force [-freeze | -drive | -deposit] [-cancel <time>] [-repeat <time>] <object_name> <value> [<time>] [, <value> <time> ] Arguments -freeze Freezes the object at the specified value until it is forced again or until it is unforced with a noforce command. Optional. -drive Attaches a driver to the object and drives the specified value until the object is forced again or until it is unforced with a noforce command. Optional. This option is illegal for unresolved signals or SystemC signals. Only mixed language boundaries types are supported. The -drive option to force is not supported. Individual bits and slices may not be forced or unforced.
227
Commands force
-deposit Sets the object to the specified value. The value remains until there is a subsequent driver transaction, or until the object is forced again, or until it is unforced with a noforce command. Optional. If one of the -freeze, -drive, or -deposit options is not used, then -freeze is the default for unresolved objects and -drive is the default for resolved objects. If you prefer -freeze as the default for resolved and unresolved VHDL signals, change the default force kind in the DefaultForceKind preference variable.
-cancel <time> Cancels the force command at the specified <time>. The time is relative to the current time unless an absolute time is specified by preceding the value with the character @. Cancellation occurs at the last simulation delta cycle of a time unit. A value of zero cancels the force at the end of the current time period. Optional.
-cancel 520 ns -cancel @520 ns \\ Relative Time \\ Absolute Time
-repeat <time> Repeats the force command, where <time> is the time at which to start repeating the cycle. The time is relative to the current time. A repeating force command will force a value before other non-repeating force commands that occur in the same time step. Optional.
<object_name> Specifies the name of the HDL object to be forced. Required. A wildcard is permitted only if it matches one object. See Design Object Names for the full syntax of an object name. The object name must specify a scalar type or a one-dimensional array of character enumeration. You may also specify a record subelement, an indexed array, or a sliced array, as long as the type is one of the above. Required.
<value> Specifies the value to which the object is to be forced. The specified value must be appropriate for the type. Required. A VHDL one-dimensional array of character enumeration can be forced as a sequence of character literals or as a based number with a radix of 2, 8, 10 or 16. For example, the following values are equivalent for a signal of type bit_vector (0 to 3): Value 1111 2#1111 10#15 16#F Description character literal sequence binary radix decimal radix hexadecimal radix
228
Commands force
Note For based numbers in VHDL, ModelSim translates each 1 or 0 to the appropriate value for the numbers enumerated type. The translation is controlled by the translation table in the pref.tcl file. If ModelSim cannot find a translation for 0 or 1, it uses the left bound of the signal type (typeleft) for that value. <time> Specifies the time to which the value is to be applied. The time is relative to the current time unless an absolute time is specified by preceding the value with the character @. If the time units are not specified, then the default is the resolution units selected at simulation start-up. Optional. A zero-delay force command causes the change to occur in the current (rather than the next) simulation delta cycle. Examples Force input1 to 0 at the current simulator time.
force input1 0
Force bus1 to 01XZ at 100 nanoseconds after the current simulator time.
force bus1 01XZ 100 ns
Force bus1 to 16#F at the absolute time 200 measured in the resolution units selected at simulation start-up.
force bus1 16#f @200
Force input1 to 1 at 10 time units after the current simulation time and to 0 at 20 time units after the current simulation time. This cycle repeats starting at 100 time units after the current simulation time, so the next transition is to 1 at 100 time units after the current simulation time.
force input1 1 10, 0 20 -r 100
Similar to the previous example, but also specifies the time units. Time unit expressions preceding the "-r" must be placed in curly braces.
force input1 1 10 ns, 0 {20 ns} -r 100ns
Force signal s to alternate between values 1 and 0 every 100 time units until time 1000. Cancellation occurs at the last simulation delta cycle of a time unit.
force s 1 0, 0 100 -repeat 200 -cancel 1000
So,
force s 1 0 -cancel 0
will force signal s to 1 for the duration of the current time period.
229
Commands force
Force siga to decimal value 85 whenever the value on the signal is 1.

when {/mydut/siga = 10#1} { force -deposit /mydut/siga 10#85 }
See also noforce, change Note You can configure defaults for the force command by setting the DefaultForceKind variable in the modelsim.ini file. Refer to Force Command Defaults.
230
Commands gdb dir
gdb dir
The gdb dir command sets the source directory search path for the C debugger. Refer to Setting Up C Debug for more information. Invoking this command starts the C debugger if it is not already running. Syntax gdb dir [<src_directory_path_1>[:<src_directory_path_2>[:<...>]]] Argument <src_directory_path_1>[:<src_directory_path_2>[:<...>]] Specifies one or more directories for C source code. Optional. If no directory is specified, the source directory search path is set to the gdb default$cdir:$cwd. Examples Set the source directory search path to /a/b/c:~/foo:$cdir:$cwd
gdb dir /a/b/c:~/foo
See also C Debug
231
Commands getactivecursortime
getactivecursortime
The getactivecursortime command gets the time of the active cursor in the Wave window. Returns the time value. Syntax getactivecursortime [-window <wname>] Arguments -window <wname> Specifies an instance of the Wave window that is not the default. Otherwise, the default Wave window is used. Optional. Use the view command to change the default window. Examples
getactivecursortime
Returns:
980 ns
See also left, right
232
Commands getactivemarkertime
getactivemarkertime
The getactivemarkertime command gets the time of the active marker in the List window. Returns the time value. If -delta is specified, returns time and delta. Syntax getactivemarkertime [-window <wname>] [-delta] Arguments -window <wname> Specifies an instance of the List window that is not the default. Otherwise, the default List window is used. Optional. Use the view command to change the default window. -delta Returns the delta value. Optional. Default is to return only the time. Examples
getactivemarkertime -delta
Returns:
980 ns, delta 0
See also down, up
233
Commands help
help
The help command displays in the Transcript pane a brief description and syntax for the specified command. Syntax help [<command> | <topic>] Arguments <command> Specifies the command for which you want help. The entry is case and space sensitive. Optional. <topic> Specifies a topic for which you want help. The entry is case and space sensitive. Optional. Specify one of the following six topics: Topic commands debugging execution Tcl Tk incrTCL Description Lists all available commands and topics Lists debugging commands Lists commands that control execution of your simulation. Lists all available Tcl commands. Lists all available Tk commands Lists all available incrTCL commands
234
Commands history
history
The history command lists the commands you have executed during the current session. History is a Tcl command. For more information, consult the Tcl Man Pages. Syntax history [clear] [keep <value>] Arguments clear Clears the history buffer. Optional. keep <value> Specifies the number of executed commands to keep in the history buffer. Optional. The default is 50.
235
Commands jobspy
jobspy
The jobspy command controls JobSpy, a tool for monitoring and controlling batch simulations and simulation farms. Refer to Monitoring Simulations with JobSpy for more information. Syntax jobspy -gui | -startd | -killd | jobs | status | <jobid> <command> Arguments -gui Launches the JobSpy Job Manager GUI. Optional. Refer to Running the JobSpy GUI. -startd Starts the jobspy daemon which enables job tracking. Optional. You must first set the JOBSPY_DAEMON environment variable before starting the daemon. Refer to Starting the JobSpy Daemon for further details. -killd Terminates the JobSpy daemon. Optional. jobs Returns a list of current jobs with a variety of status information (e.g., job ID, current simulation time, start time, etc.). Optional. status Returns the status of the JobSpy daemon. Optional. <jobid> <command> Invokes the specified command on the specified job ID. Optional. Use jobspy jobs to get a list of job IDs. Refer to Simulations Commands Available to JobSpy for a list of valid commands.
236
Commands layout
layout
The layout command loads, saves, lists, or deletes custom GUI layouts. The command options include: layout load opens the specified layout layout save saves the current layout to the specified name layout names lists all known layouts layout current lists the current layout layout delete removes the current layout from the .modelsim file (UNIX/Linux) or Registry (Windows)
See Layouts and Modes of Operation for more information. Syntax layout load <name> layout save <name> layout names layout current layout delete <name> Arguments <name> Specifies the name of the layout. Required.
237
Commands lecho
lecho
The lecho command takes one or more Tcl lists as arguments and pretty-prints them to the Transcript pane. Returns nothing. Syntax lecho <args> ... Arguments <args> ... Any Tcl list created by a command or user procedure. Examples Print the Wave window configuration list to the Transcript pane.
lecho [configure wave]
238
Commands left
left
The left command searches left (previous) for signal transitions or values in the specified Wave window. It executes the search on signals currently selected in the window, starting at the time of the active cursor. The active cursor moves to the found location. Use this command to move to consecutive transitions or to find the time at which a waveform takes on a particular value, or an expression of multiple signals evaluates to true. See the right command for related functionality. The procedure for using left entails three steps: click on the desired waveform; click on the desired starting location; issue the left command. (The seetime command can initially position the cursor from the command line, if desired.) Returns: <number_found> <new_time> <new_delta> Syntax left [-expr {<expression>}] [-falling] [-noglitch] [-rising] [-value <sig_value>] [-window <wname>] [<n>] Arguments -expr {<expression>} The waveform display will be searched until the expression evaluates to a boolean true condition. Optional. The expression may involve more than one signal, but is limited to signals that have been logged in the referenced Wave window. A signal may be specified either by its full path or by the shortcut label displayed in the Wave window. See GUI_expression_format for the format of the expression. The expression must be placed within curly braces. -falling Searches for a falling edge on the specified signal if that signal is a scalar signal. If it is not a scalar signal, the option will be ignored. Optional. -noglitch Looks at signal values only on the last delta of a time step. For use with the -value option only. Optional. -rising Searches for a rising edge on the specified signal if that signal is a scalar signal. If it is not a scalar signal, the option will be ignored. Optional. -value <sig_value> Specifies a value of the signal to match. Must be specified in the same radix in which the selected waveform is displayed. Case is ignored, but otherwise the value must be an exact string match don't-care bits are not yet implemented. Only one signal may be selected, but that signal may be an array. Optional.
239
Commands left
-window <wname> Specifies an instance of the Wave window that is not the default. Optional. Otherwise, the default Wave window is used. Use the view command to change the default window.
<n> Specifies to find the nth match. If less than n are found, the number found is returned with a warning message, and the cursor is positioned at the last match. Optional. The default is 1.
Examples Find the second time to the left at which the selected vector transitions to FF23, ignoring glitches.
left -noglitch -value FF23 2
Go to the previous transition on the selected signal.

left
The following examples illustrate search expressions that use a variety of signal attributes, paths, array constants, and time variables. Such expressions follow the GUI_expression_format. Search left for an expression that evaluates to a boolean 1 when signal clk just changed from low to high and signal mystate is the enumeration reading and signal /top/u3/addr is equal to the specified 32-bit hex constant; otherwise is 0.
left -expr {clkrising && (mystate == reading) && (/top/u3/addr == 32habcd1234)}
Search left for an expression that evaluates to a boolean 1 when the upper 8 bits of the 32-bit signal /top/u3/addr equals hex ac.
left -expr {(/top/u3/addr and 32hff000000) == 32hac000000}
Search left for an expression that evaluates to a boolean 1 when logfile time is between 23 and 54 microseconds, clock just changed from low to high, and signal mode is enumeration writing.
left -expr {((NOW > 23 us) && (NOW < 54 us)) && clkrising && (mode == writing)}
Note Wave Window Mouse and Keyboard Shortcuts are also available for next and previous edge searches. Tab searches right (next) and shift-tab searches left (previous). See also GUI_expression_format, right, seetime, view
240
Commands log
log
The log command creates a wave log format (WLF) file containing simulation data for all HDL objects whose names match the provided specifications. Objects that are displayed using the add list and add wave commands are automatically recorded in the WLF file. The log is stored in a WLF file in the working directory. By default the file is named vsim.wlf. You can change the default name using the -wlf option of the vsim command. If no port mode is specified, the WLF file contains data for all objects in the selected region whose names match the object name specification. The WLF file is the source of data for the List and Wave windows. An object that has been logged and is subsequently added to the List or Wave window will have its complete history back to the start of logging available for listing and waving. For all transaction streams created through the SCV or Verilog APIs, logging is enabled by default. The rule for whether a transaction is logged into the .wlf file: A transaction is logged if logging is enabled at the simulation time when the design calls ::begin_transaction() or $begin_transaction. The effective start time of the transaction (the time passed by the design as a parameter to ::begin_transaction) is irrelevant. For example, a stream could have logging disabled between T1 and T2 and still record a transaction in that period, through retroactive logging after time T2. A transaction is always entirely logged or entirely ignored. Syntax log [-depth <level>] [-flush] [-howmany] [-in] [-inout] [-internal] [-out] [-ports] [-recursive] <object_name> [-optcells] Arguments -depth <level> Restricts a recursive search (specified with the -recursive argument) to a certain level of hierarchy. <level> is an integer greater than or equal to zero. For example, if you specify depth 1, the command descends only one level in the hierarchy. Optional. -flush Adds region data to the WLF file after each individual log command. Optional. Default is to add region data to the log file only when a command that advances simulation time is executed (e.g., run, step, etc.) or when you quit the simulation. -howmany Returns an integer indicating the number of signals found. Optional. -in Specifies that the WLF file is to include data for ports of mode IN whose names match the specification. Optional.
241
Commands log
-inout Specifies that the WLF file is to include data for ports of mode INOUT whose names match the specification. Optional.
-internal Specifies that the WLF file is to include data for internal (non-port) objects whose names match the specification. Optional.
-optcells Makes Verilog optimized cell ports visible when using wildcards. Optional. By default Verilog optimized cell ports are not selected even if they match the specified wildcard pattern.
-out Specifies that the WLF file is to include data for ports of mode OUT whose names match the specification. Optional.
-ports Specifies that the scope of the search is to include all ports. Optional. -recursive Specifies that the scope of the search is to descend recursively into subregions. Optional. If omitted, the search is limited to the selected region. You can use the -depth argument to specify how far down the hierarchy to descend.
<object_name> Specifies the object name which you want to log. Required. Multiple object names may be specified. Wildcard characters are allowed. Note that the WildcardFilter Tcl preference variable identifies types to ignore when matching objects with wildcard patterns. By default, wildcard card logging does not log the internals of cells. Refer to the +libcell argument of the vlog command for more information.
Examples Log all objects in the design.

log -r /*
Log all output ports in the current design unit.

log -out *
See also add list, add wave, nolog, Recording Simulation Results With Datasets, and Wildcard Characters
242
Commands log
Note The log command is also known as the "add log" command.
243
Commands lshift
lshift
The lshift command takes a Tcl list as an argument and shifts it in-place, one place to the left, eliminating the left-most element. The number of shift places may also be specified. Returns nothing. Syntax lshift <list> [<amount>] Arguments <list> Specifies the Tcl list to target with lshift. Required. <amount> Specifies the number of places to shift. Optional. Default is 1. Examples
proc myfunc args { # throws away the first two arguments lshift args 2 ... }
See also See the Tcl man pages (Help > Tcl Man Pages) for details.
244
Commands lsublist
lsublist
The lsublist command returns a sublist of the specified Tcl list that matches the specified Tcl glob pattern. Syntax lsublist <list> <pattern> Arguments <list> Specifies the Tcl list to target with lsublist. Required. <pattern> Specifies the pattern to match within the <list> using Tcl glob-style matching. Required. Examples In the example below, variable t returns "structure signals source".
set window_names "structure signals variables process source wave list dataflow" set t [lsublist $window_names s*]
See also The set command is a Tcl command. See the Tcl man pages (Help > Tcl Man Pages) for details.
245
Commands mem compare
mem compare
The mem compare command compare selected memory to reference memory or file. Must have the "diff" utility installed and visible in your search path in order to run the mem compare command. Syntax mem compare [[-mem <ref_mem>] | [-file <ref_file>]] [actual_mem] Arguments -mem <ref_mem> Specifies a reference memory to be compared. -file <ref_file> Specifies a reference file to be compared. actual_mem Specifies the name of the memory to be compared against the reference data.
246
Commands mem display
mem display
The mem display command prints to the Transcript pane the memory contents of the specified instance. As a shorthand, if the given instance path contains only a single array signal or variable, the signal or variable name need not be specified. Address radix, data radix, and address range for the output can also be specified, as well as special output formats. You can redirect the output of the mem display command into a file for later use with the mem load command. The output file can also be read by the Verilog $readmem system tasks if the memory module is a Verilog module and Verilog memory format (hex or binary) is specified. The format settings are stored at the top of this file as a pseudo comment so that subsequent mem load commands can correctly interpret the data. Do not edit this data when manipulating a saved file. By default, identical data lines are printed. To replace identical lines with a single line containing the asterisk character, you can enable compression with the -compress argument. Syntax mem display [-format [bin | hex | mti]] [-addressradix <radix_type>] [-dataradix <radix_type>] [-wordsperline <Nwords>] [-startaddress <st>] [-endaddress <end>] [-noaddress] [-compress] [<path>] Arguments -format [bin | hex | mti] Specifies the output format of the contents. Optional. The default format is mti. For details on mti format, see the description contained in mem load. -addressradix <radix_type> Specifies the address radix for the default (mti) formatted files. The <radix_type> can be specified as: d (decimal) or h (hex). Optional. If the output format is mti, the default is d. -dataradix <radix_type> Specifies the data radix for the default (mti) formatted files. Optional. If unspecified, the global default radix is used. Valid entries (or any unique abbreviations) are: binary, decimal, unsigned, octal, hex, symbolic, and default. If no radix is specified for an enumerated type, the symbolic representation is used. You can change the default radix type for the current simulation using the radix command. You can change the default radix permanently by editing the DefaultRadix variable in the modelsim.ini file. -wordsperline <Nwords> Specifies how many words are to be printed on each line, with the default assuming an 80 column display width. <Nwords> is an unsigned integer. Optional.
247
Commands mem display
-startaddress <st> Specifies the start address for a range of addresses to be displayed. The <st> can be specified as any valid address in the memory. Optional. If unspecified, the default is the start of the memory.
-endaddress <end> Specifies the end address for a range of addresses to be displayed. The <end> can be specified as any valid address in the memory. Optional. If unspecified, the default is the end of the memory.
-noaddress Specifies that addresses not be printed. Optional. -compress Specifies that identical lines not be printed. Optional. Reduces the file size by replacing exact matches with a single line containing an asterisk. These compressed files are automatically expanded during a mem load operation.
<path> Specifies the full path to the memory instance. Optional. The default is the current context, as shown in the Structure tab of the Workspace. Indexes can be specified.
Examples This command displays the memory contents of instance /top/m/mru_mem, addresses 5 to 10 to the screen as follows:
mem display -startaddress 5 -endaddress 10/top/c/mru_mem # 5: 110 110 110 110 110 000
Display the memory contents of the same instance to the screen in hex format, as follows:
mem display -format hex -startaddress 5 -endaddress 10 /top/c/mru_mem # 5: 6 6 6 6 6 0
See Also mem load
248
Commands mem list
mem list
The mem list command displays a flattened list of all memory instances in the current or specified context after a design has been elaborated. Each instance line is prefixed by "VHDL:" or "Verilog:", depending on the type of model. Returns the signal/variable name, address range, and depth and width of the memory. Syntax mem list [-r] [<path>] Arguments -r Recursively descends into sub-modules when listing memories. Optional. <path> The hierarchical path to the location the search should start. Optional. The default is the current context, as shown in the Structure tab of the Workspace pane. Examples Recursively lists all memories at the top level of the design.
mem list -r /
Returns:
# Verilog: /top/m/mem[0:255](256d x 16w) #
Recursively lists all memories in /top2/uut.

mem list /top2/uut -r
Returns:
# Verilog: /top2/uut/mem[0:255] x 16w
249
Commands mem load
mem load
The mem load command updates the simulation memory contents of a specified instance. You can upload contents either from a memory data file, a memory pattern, or both. If both are specified, the pattern is applied only to memory locations not contained in the file. A relocatable memory file is one that has been saved without address information. You can load a relocatable memory file into the instance of a memory core by specifying an address range on the mem load command line. If no address range (starting and ending address) is specified, the memory is loaded starting at the first location. The order in which the data is placed into the memory depends on the format specified by the format option. If you choose bin or hex format, the memory is filled low to high, to be compatible with $readmem commands. This is in contrast to the default mti format, which fills the memory according to the memory declaration, from left index to right index. For Verilog objects and VHDL integers and std_logic types: if the word width in a file is wider than the word width of the memory, the leftmost bits (msbs) in the data words are ignored. To allow wide words use the -truncate option which will ignore the msb bits that exceed the memory word size. If the word width in the file is less than the width of the memory, and the left-most digit of the file data is not X, then the left-most bits are zero filled. Otherwise, they are X-filled. The type of data required for the -filldata argument is dependent on the -filltype specified: a fixed value, or one that governs an incrementing, decrementing, or random sequence. For fixed pattern values, the fill pattern is repeatedly tiled to initialize the memory block specified. The pattern can contain multiple word values for this option. For incrementing or decrementing patterns, each memory word is treated as an unsigned quantity, and each successive memory location is filled in with a value one higher or lower than the previous value. The initial value must be specified. For a random pattern, a random data sequence will be generated to fill in the memory values. The data type in the sequence will match the type stored in the memory. For std_logic and associated types, unsigned integer sequences are generated. A seed value may be specified on the command line. For any given seed, the generated sequence is identical.
The interpretation of the pattern data is performed according to the default system radix setting. However, this can be overridden with a standard Verilog-style <radix_char><data> specification. Syntax mem load [-infile <infile> -format [bin | hex | mti]] [-filltype <filltype>] [-filldata <patterndata>] [-fillradix <radix_type>] [-skip <Nwords>] [-truncate] [-startaddress <st>] [-endaddress <end>] [<path>]
250
Commands mem load
Arguments -infile <infile> Updates memory data from the specified file. Required unless the -filltype argument is used. -endaddress <end> Specifies the end address for a range of addresses to be loaded. The <end> can be specified as any valid address in the memory. Optional. -format [bin | hex | mti] Specifies the format of the file to be loaded. The <formtype> can be specified as: bin, hex, or mti. bin and hex are the standard Verilog hex and binary memory pattern file formats. These can be used with Verilog memories, and with VHDL memories composed of std_logic types. In the MTI memory data file format, internal file address and data radix settings are stored within the file itself. Thus, there is no need to specify these settings on the mem load command line. If a format specified on the command line and the format signature stored internally within the file do not agree, the file cannot be loaded. -filltype <filltype> Fills in memory data patterns algorithmically. The <filltype> can be specified as: value, inc, dec, or rand. Required unless the -infile argument is used, in which case it is optional. Default is value. -filldata <patterndata> Specifies the pattern parameters, value for fixed-value fill operations, and seed or starting point for random, increment, or decrement fill operations. Required if -filltype is used. A fill pattern covers any of the selected address range that is not populated from file values. If a fill pattern is used without a file option, the entire memory or specified address range is initialized with the fill pattern. -fillradix <radix_type> Specifies radix of the data specified by "-filldata" option. Valid entries (or any unique abbreviations) are: binary, decimal, unsigned, octal, hex, symbolic, and default. -skip <Nwords> Specifies the number of words to be skipped between each fill pattern value. <Nwords> is specified as an unsigned integer. Optional. Used with -filltype and -filldata. -truncate Ignores any most significant bits (msb) in a memory word which exceed the memory word size. By default, when memory word size is exceeded, an error results. Optional.
251
Commands mem load
-startaddress <st> Specifies the start address for a range of addresses to be loaded. The <st> can be specified as any valid address in the memory. Optional.
<path> The hierarchical path to the memory instance. If the memory instance name is unique, shorthand instance names can be used. Optional. The default is the current context, as shown in the Structure tab of the Workspace pane. Memory address indexes can be specified in the instance name also. If addresses are specified both in the instance name and the file, only the intersection of the two address ranges is populated with memory data.
Examples Load the memory pattern from the file vals.mem to the memory instance /top/m/mem, filling the rest of the memory with the fixed-value 1b0.
mem load -infile vals.mem -format bin -filltype value -filldata 1b0 /top/m/mem
When you enter the mem display command on memory addresses 0 through 12, you see the following:
mem display -startaddress 0 -endaddress # 0: 0000000000000000 0000000000000001 # 4: 0000000000000100 0000000000000101 # 8: 0000000000001000 0000000000001001 # 12: 0000000000000000 12 /top/m/mem 0000000000000010 0000000000000011 0000000000000110 0000000000000111 0000000000000000 0000000000000000
Load the memory pattern from the file vals.mem to the memory instance /top/m/mru_mem, filling the rest of the memory with the fixed-value 16Hbeef.
mem load -infile vals.mem -format hex -st 0 -end 12 -filltype value -filldata 16Hbeef /top/m/mru_mem
Load memory instance /top/mem2 with two words of memory data using the Verilog Hex format, skipping 3 words after each fill pattern sequence.
mem load -filltype value -filldata "16hab 16hcd" /top/mem2 -skip 3
Truncate the msb bits that exceed the maximum word size (specified in HDL code).
mem load -format h -truncate -infile data_files/data.out /top/m_reg_inc/mem
See also mem save
252
Commands mem save
mem save
The mem save command saves the contents of a memory instance to a file in any of the supported formats: Verilog binary, Verilog hex, and MTI memory pattern data. This command works identically to the mem display command, except that its output is written to a file rather than a display. The order in which the data is placed into the saved file depends on the format specified by the format argument. If you choose bin or hex format, the file is populated from low to high, to be compatible with $readmem commands. This is in contrast to the default mti format, which populates the file according to the memory declaration, from left index to right index. You can use the mem save command to generate relocatable memory data files. The -noaddress option omits the address information from the memory data file. You can later load the generated memory data file using the memory load command. Syntax mem save [-format bin | hex | mti] [-addressradix <radix_type>] [-dataradix <radix_type>] [-wordsperline <Nwords>] [-startaddress <st> -endaddress <end>] [-noaddress] [-compress] [<path>] -outfile <filename> Arguments -format bin | hex | mti Specifies the output format. The <format_spec> can be specified as bin, hex, or mti. Optional. The default format is mti. The MTI memory pattern data format is described in mem load. -addressradix <radix_type> Specifies the address radix for the default mti formatted files. Optional. The <radix_type> can be specified as: dec or hex. The default is the decimal representation. -dataradix <radix_type> Specifies the data radix for the default mti formatted files. Optional. The <radix_type> can be specified as symbolic, binary, octal, decimal, unsigned, or hex. You can change the default radix for the current simulation using the radix command. You can change the default radix permanently by editing the DefaultRadix variable in the modelsim.ini file. -wordsperline <Nwords> Specifies how many memory values are to be printed on each line. Optional. The default assumes an 80 character display width. The <Nwords> is specified as an unsigned integer. -startaddress <st> Specifies the start address for a range of addresses to be saved. The <st> can be specified as any valid address in the memory. Optional.
253
Commands mem save
-endaddress <end> Specifies the end address for a range of addresses to be saved. The <end> can be specified as any valid address in the memory. Optional.
-noaddress Prevents addresses from being printed. Optional. Mutually exclusive with the -compress option.
-compress Specifies that only unique lines are printed, identical lines are not printed. Optional. Mutually exclusive with the -noaddress option.
-outfile <filename> Specifies that the memory contents be stored in <filename>. Required. <path> The hierarchical path to the location of the memory instance. Optional. The default is the current context, as shown in the Structure tab of the Workspace pane.
Examples Save the memory contents of the instance /top/m/mem(0:10) to memfile, written in the mti radix.
mem save -format mti -outfile memfile -start 0 -end 10 /top/m/mem
The contents of memfile are as follows:

// memory data file (do not edit the following line - required for mem load use) // format=mti addressradix=d dataradix=s version = 1.0 0: 0000000000000000 0000000000000001 0000000000000010 0000000000000011 4: 0000000000000100 0000000000000101 0000000000000110 0000000000000111 8: 0000000000001000 0000000000001001 xxxxxxxxxxxxxxxx
See also mem display, mem load
254
Commands mem search
mem search
The mem search command finds and prints to the screen the first occurring match of a specified memory pattern in the specified memory instance. Shorthand instance names are accepted. Optionally, you can instruct the command to print all occurrences. The search pattern can be one word or a sequence of words. Syntax mem search [-addressradix <radix_type>] [-dataradix <radix_type>] [-all] [-replace <word>[ <word>]] [-startaddress <address>] [-endaddress <address>] [<path>] [-glob <word>[ <word>]] | [-regexp <word>[ <word>]] Arguments -addressradix <radix_type> Specifies the radix for the address being displayed. The <radix_type> can be specified as decimal or hexadecimal. Default is decimal. Optional. -dataradix <radix_type> Specifies the radix for the memory data being displayed. The <radix_type> can be specified as symbolic, binary, octal, decimal, unsigned, or hex. Optional. By default the radix displayed is the system default. -all Searches the specified memory range and prints out all matching occurrences to the screen. Optional. By default only the first matching occurrence is printed. -replace <word>[ <word>] Replaces the found patterns with a designated pattern. Optional. If this option is used, each pattern specified by the -pattern argument must have a corresponding pattern specified by the -replace argument. Multiple word patterns are accepted, separated by a single white space. No wildcards are allowed in the replaced pattern. -startaddress <address> Specifies the start address for a range of addresses to search. The <address> can be specified as any valid address in the memory. Optional. -endaddress <address> Specifies the end address for a range of addresses to search. The <address> can be specified as any valid address in the memory. Optional. <path> Specifies the hierarchical path to the location of the memory instance. Optional. The default is the current context value, as shown in the Structure tab of the Workspace pane.
255
Commands mem search
-glob <word>[ <word>] Specifies the value of the pattern, accepting glob pattern syntax for the search. This argument and -regexp and -pattern are mutually exclusive arguments. This argument is functionally identical to the -pattern argument. Required: either -glob or -regexp. Multiple word patterns are accepted, separated by a single white space. Wildcards are accepted in the pattern.
-regexp <word>[ <word>] Specifies the value of the pattern, accepting regular expression syntax, for the search. This argument and -glob and -pattern are mutually exclusive arguments. Required: either -glob or -regexp. Multiple word patterns are accepted, separated by a single white space. Wildcards are accepted in the pattern.
Examples Search for and print to the screen all occurrences of the pattern 16Hbeef in /uut/u0/mem3:
mem search -glob 16Hbeef -dataradix hex /uut/u0/mem3
Returns:
#7845: beef #7846: beef #100223: beef
Search for and print only the first occurrence of 16Hbeef in the address range 7845:150000, replacing it with 16Hcafe in /uut/u1/mem3:
mem search -glob 16Hbeef -d hex -replace 16Hcafe -st 7846 -end 150000 /uut/u1/mem3
Returns:
#7846: cafe
Replace all occurrences of 16Hbeef with 16Habe in /uut/u1/mem3:

mem search -glob 16Hbeef -r 16Habe -addressadix hex -all /uut/u1/mem3
Returns:
#1ea5: 2750 #1ea6: 2750 #1877f: 2750
Search for and print the first occurrence any pattern ending in f:
mem search -glob "*f"
256
Commands mem search
Search for and print the first occurrence of this multiple word pattern:
mem search -glob "abe cafe" /uut/u1/mem3
Search for patterns "0000 0000" or "0001 0000" in m/mem:

mem search -data hex -regexp {000[0|1] 0{4}} m/mem -all
Search for a pattern that has any number of 0s followed by any number of 1s as a memory location, and which has a memory location containing digits as the value:
mem search -regexp {^0+1+$ \d+} m/mem -all
Search for any initialized location in a VHDL memory:

mem search -regexp {[Û]} -all <vhdl_memory>
257
Commands messages clearfilter
messages clearfilter
This command removes any filter you have set in the Message Viewer. Refer to the section Message Viewer Filter Dialog Box for additional information about filtering in the Message Viewer. Syntax messages clearfilter Arguments No arguments
258
Commands messages setfilter
messages setfilter
This command performs the same action as the Message Viewer Filter Dialog Box, which controls which messages are shown in the Message Viewer. The ideal workflow for using this command is through the GUI: 1. View > Message Viewer. 2. Right-click in the Message Viewer and select Filter. The Message Viewer Filter dialog box is displayed 3. Create your filter. 4. OK or Apply. The Message Viewer updates based on your filter and a messages setfilter command, which is equivalent to your settings, is output to the transcript. 5. Retain the messages setfilter command from the transcript for future use. Syntax messages setfilter <tcl_list> Arguments <tcl_list> The tcl_list argument is a complex string of tcl code that controls the filter settings.
Examples Severity is error and time is greater than or equal to 100 ns

messages setfilter {{} \ ( Severity Contains {Case Insensitive} error )} \ {AND ( Time >= 100 ns )}
The objects field contains neither clock or reset

messages setfilter {{} \ ( Object Contains {Case Sensitive} clock )} \ {NOR ( Object Contains {Case Sensitive} data )}
The message string either contains reg_str2 or reg_str1

messages setfilter {{} \ ( Message Contains {Case Insensitive} reg_str2 )} \ {OR ( Message Contains {Case Insensitive} reg_str1 )}
259
Commands modelsim
modelsim
The modelsim command starts the ModelSim GUI without prompting you to load a design. This command is valid only for Windows platforms and may be invoked in one of three ways: from the DOS prompt from a ModelSim shortcut from the Windows Start > Run menu
To use modelsim arguments with a shortcut, add them to the target line of the shortcuts properties. (Arguments work on the DOS command line too, of course.) The simulator may be invoked from either the ModelSim> prompt after the GUI starts or from a DO file called by modelsim. Syntax modelsim [-do <macrofile>] [-nosplash] Arguments -do <macrofile> Specifies the DO file to execute when modelsim is invoked. Optional. Note In addition to the macro called by this argument, if a DO file is specified by the STARTUP variable in modelsim.ini, it will be called when the vsim command is invoked. -nosplash Disables the splash screen. Optional. See also vsim, do, Using a Startup File
260
Commands next
next
The next command continues a search after you have invoked the search command. See the search command for more information. Syntax next <window_name> [-window <wname>] Arguments <window_name> Specifies the window in which to continue searching. Can be one of Signals, Objects, Variables, Locals, Source, List, Wave, Process, Structure, or a unique abbreviation thereof. Required. -window <wname> Specifies an instance of the window that is not the default. Optional. Otherwise, the default window is used. Use the view command to change the default window.
261
Commands noforce
noforce
The noforce command removes the effect of any active force commands on the selected HDL objects. The noforce command also causes the objects value to be re-evaluated. You can use noforce on signals within SystemC modules, with the following limitations: Syntax noforce <object_name> Arguments <object_name> Specifies the name of an object. Required. Must match an object name used in a previous force command. Multiple object names may be specified. Wildcard characters are allowed. See also force and Wildcard Characters Only mixed language boundaries types are supported. Individual bits and slices may not be forced or unforced.
262
Commands nolog
nolog
The nolog command suspends writing of data to the wave log format (WLF) file for the specified signals. A flag is written into the WLF file for each signal turned off, and the GUI displays "-No Data-" for the signal(s) until logging (for the signal(s)) is turned back on. Logging can be turned back on by issuing another log command or by doing a nolog -reset. Because use of the nolog command adds new information to the WLF file, WLF files created when using the nolog command cannot be read by older versions of the simulator. If you are using dumplog64.c, you will need to get an updated version. Transactions written in SCV or Verilog are logged automatically, and can be removed with the nolog command. A transaction is logged into the .wlf file if logging is enabled (in other words, if no nolog command has disabled it) for that stream at the time when the transaction was begun. A entire span of a transaction is either logged or not logged, period, regardless of the begin and end times specified for that transaction. Syntax nolog [-all] [-depth <level>] [-howmany] [-in] [-inout] [-internal] [-out] [-ports] [-recursive] [-reset] [<object_name>] Arguments -all Turns off logging for all signals currently logged. Optional. -depth <level> Restricts a recursive search (specified with the -recursive argument) to a certain level of hierarchy. <level> is an integer greater than or equal to zero. For example, if you specify depth 1, the command descends only one level in the hierarchy. Optional. -howmany Returns an integer indicating the number of signals found. Optional. -in Turns off logging only for ports of mode IN whose names match the specification. Optional. -inout Turns off logging only for ports of mode INOUT whose names match the specification. Optional. -internal Turns off logging only for internal (non-port) objects whose names match the specification. Optional.
263
Commands nolog
-out Turns off logging only for ports of mode OUT whose names match the specification. Optional.
-ports Specifies that the scope of the search is to include all ports. Optional. -recursive Specifies that the scope of the search is to descend recursively into subregions. Optional. If omitted, the search is limited to the selected region. You can use the -depth argument to specify how far down the hierarchy to descend.
-reset Turns logging back on for all unlogged signals. Optional. <object_name> Specifies the object name which you want to unlog. Optional. Multiple object names may be specified. Wildcard characters are allowed.
Examples Unlog all objects in the design.

nolog -r /*
Turn logging back on for all unlogged signals.

nolog -reset
See also add list, add wave, log
264
Commands notepad
notepad
The notepad command opens a simple text editor. It may be used to view and edit ASCII files or create new files. This mode can be changed from the Notepad Edit menu. Returns nothing. Syntax notepad [<filename>] [-r | -edit] Arguments <filename> Name of the file to be displayed. Optional. -r | -edit Selects the notepad editing mode: -r for read-only, and -edit for edit mode. Optional. Edit mode is the default.
265
Commands noview
noview
The noview command closes a window/pane in the ModelSim GUI. To open a window/pane, use the view command. Syntax noview [<class>] [<window_name>] Arguments <class> Specifies a class of windows in the MDI frame to close. All windows in that class will close. Valid values include: Source, List, Wave, and Memory. Optional. <window_name> Specifies the window/pane to close. Wildcards and multiple window/pane types may be used. At least one type (or wildcard) is required. Available window types are:
dataflow, details, exclusions, instances, list, locals, memory, missed, objects, process, profilemain, profiledetails, signals, structure, variables, wave, watch, and workspace
You can also close Source windows using the tab or file name. Examples Close the Wave window named "wave1".
noview wave1
Close all List windows.

noview List
See also view
266
Commands nowhen
nowhen
The nowhen command deactivates selected when commands. Syntax nowhen [<label>] Arguments <label> Specifies an individual when command. Optional. Wildcards may be used to select more than one when command. Examples This nowhen command deactivates the when command labeled 99.
when -label 99 b {echo b changed} nowhen 99
This nowhen command deactivates all when commands.

nowhen *
267
Commands onbreak
onbreak
The onbreak command is used within a macro, which must be followed by a run command to take effect. It specifies one or more commands to be executed when running a macro that encounters a breakpoint in the source code. Using the onbreak command without arguments will return the current onbreak command string. An onbreak command can contain macro calls. The default behavior for the onbreak command is the resume command. Use an empty string to change the onbreak command back to its default behavior:
onbreak ""
In this case, the macro will be interrupted after a breakpoint occurs (after any associated bp command string is executed).
Syntax onbreak {[<command> [; <command>] ]} Arguments <command> Any command can be used as an argument to onbreak. If you want to use more than one command, use a semicolon to separate the commands, or place them on multiple lines. The entire command string must be placed in curly braces. You must use the onbreak command before a run, run -continue, or step command. It is an error to execute any commands within an onbreak command string following any of the run commands. This restriction applies to any macros or Tcl procedures used in the onbreak command string. Optional. Examples Examine the value of the HDL object data when a breakpoint is encountered. Then continue the run command.
onbreak {exa data ; cont}
Resume execution of the macro file on encountering a breakpoint.

onbreak {resume}
This set of commands test for assertions. Assertions are treated as breakpoints if the severity level is greater than or equal to the current BreakOnAssertion variable setting (refer to Simulator Control Variables). By default a severity level of failure or above causes a breakpoint; a severity level of error or below does not.
268
Commands onbreak set broken 0 onbreak { set broken 1 resume } run -all if { $broken } { puts "failure" } else { puts "success" }
See also abort, bd, bp, do, onerror, resume, status
269
Commands onElabError
onElabError
The onElabError command specifies one or more commands to be executed when an error is encountered during the elaboration portion of a vsim command. The command is used by placing it within a macro. Use the onElabError command without arguments to return to a prompt. Syntax onElabError {[<command> [; <command>] ]} Arguments <command> Any command can be used as an argument to onElabError. If you want to use more than one command, use a semicolon to separate the commands, or place them on multiple lines. The entire command string must be placed in curly braces. Optional. See also do
270
Commands onerror
onerror
The onerror command is used within a macro, placed before a run command; it specifies one or more commands to be executed when a running macro encounters an error. Using the onerror command without arguments will return the current onerror command string. Use an empty string to change the onerror command back to its default behavior (i.e., onerror ""). Use onerror with a resume command to allow an error message to be printed without halting the execution of the macro file. You can also set the global OnErrorDefaultAction Tcl variable to dictate what action ModelSim takes when an error occurs. To set the variable on a permanent basis, you must define the variable in a modelsim.tcl file (Refer to The modelsim.tcl File for details). When your onerror command is successful, the macro will continue normally, unless your command instructs the tool to quit (onerror {quit -f}) or break (onerror {break}). However, if your onerror command is not successful, the simulator will be halted, for example onerrror {add wave b} when you dont have a signal named b. The onerror command is executed when a Tcl command encounters an error in the macro file that contains the onerror command (note that a run command does not necessarily need to be in process). Conversely, OnErrorDefaultAction will run even if the macro does not contain a local onerror command. This can be useful when you run a series of macros from one script, and you want the same behavior across all macros. Syntax onerror {[<command> [; <command>] ]} Arguments <command> Any command can be used as an argument to onerror. If you want to use more than one command, use a semicolon to separate the commands, or place them on multiple lines. The entire command string must be placed in curly braces. Optional. Example Force the simulator to quit if an error is encountered while the macro is running.
onerror {quit -f}
See also abort, do, onbreak, resume, status
271
Commands pause
pause
The pause command placed within a macro interrupts the execution of that macro, allowing you to perform interactive debugging of the macro file. Syntax pause Arguments None.
Description When you execute a macro and that macro gets interrupted, the prompt will change to:
VSIM(paused)>
This pause prompt reminds you that a macro has been interrupted. When a macro is paused, you may invoke another macro, and if that one gets interrupted, you may even invoke another up to a nesting level of 50 macros. If the status of nested macros gets confusing, use the status command. It will show you which macros are interrupted, at what line number, and show you the interrupted command. To resume the execution of the macro, use the resume command. To abort the execution of a macro use the abort command. See also abort, do, resume, run, status
272
Commands pop
pop
The pop command moves the specified number of call frames up the C callstack. This command is used with C Debug. See C Debug for more information. Syntax pop <#_of_levels> Arguments <#_of_levels> Specifies the number of call frames to move up the C callstack. Optional. If unspecified, 1 level is assumed. Examples Move up 1 call frame.
pop
Move up 4 call frames.

pop 4
See also push, C Debug
273
Commands power add
power add
The power add command specifies the signals or nets to monitor for power information. When power add is called on a signal or net, vsim keeps account of any toggling activity of that signal. The information is sent a file when you run the power report command. This data produced can be translated and used by third-party power analysis tools. The basic steps for using this command are: 1. Add the signals or nets of interest with the power add command. 2. Run the simulation with the run command. 3. Produce a report with the power report command. Note You can use the power off command to disable monitoring between runs and then use the power on command to resume monitoring. Syntax power add [-in] [-inout] [-internal] [-nocellnet] [-out] [-ports] [-r] <signals_nets> ... Arguments -in Specifies only inputs. Optional. -inout Specifies only inouts. Optional. -internal Specifies only design internal signals or nets. Optional. -nocellnet Prevents vsim command from monitoring cell-net for toggling or any power-related activity. Optional. -out Specifies only outputs. Optional. -ports Specifies only design ports. Optional. -r Searches recursively on a wildcard specified for the signal or net. Optional. <signals_nets> ... Specifies the signal or net to monitor. Required.
274
Commands power add
You can specify multiple names and also use wildcards. The signals and nets must refer to:
o o
VHDL signals of type bit, std_logic, or std_logic_vector Verilog nets
When using wildcards, the -in, -inout, -internal, -out, and -ports arguments filter the qualifying signals. If you specify more than one of the arguments (-in, -inout, -internal, -out, or -ports), the logical OR of the arguments is performed.
275
Commands power off
power off
The power off command works in conjunction with the power add command to make vsim stop updating toggle activity data for the specified signal or net. After this command is executed, every subsequent run command ignores the power add command. Syntax power off [-all] [-in] [-inout] [-internal] [-off] [-on] [-out] [-ports] [-r] <signals_nets> ... Arguments -all Specifies inputs, inouts, and outputs. Optional. -in Specifies only inputs. Optional. -inout Specifies only inouts. Optional. -internal Specifies only design internal signals or nets. Optional. -out Specifies only outputs. Optional. -ports Specifies only design ports. Optional. -r Searches recursively on a wildcard specified for the signal or net. Optional. <signals_nets> ... Specifies the signal or net to monitor. Required. You can specify multiple names and also use wildcards. The signals and nets must refer to:
o o
276
Commands power off
Example Assume that signal /top/a toggles every 5ns. Without running the power off command:
power add /top/a run 400ns power report
Node Tc Ti Time At 1 Time At 0 Time At X ---------------------------------------------------------/top/a 80 0 200 200 0 ----------------------------------------------------------
Running the power off command (and resuming with power on):
power add /top/a run 100ns power off run 100ns power on run 200ns power report
277
Commands power on
power on
The power on command works in conjunction with the power add command to make vsim begin or resume updating toggle activity data for the specified signal or net. After this command is executed, every subsequent run command implements the power add command. Syntax power on [-all] [-in] [-inout] [-internal] [-off] [-on] [-out] [-ports] [-r] <signals_nets> ... Arguments -all Specifies inputs, inouts, and outputs. Optional. -in Specifies only inputs. Optional. -inout Specifies only inouts. Optional. -internal Specifies only design internal signals or nets. Optional. -out Specifies only outputs. Optional. -ports Specifies only design ports. Optional. -r Searches recursively on a wildcard specified for the signal or net. Optional. <signals_nets> ... Specifies the signal or net to monitor. Required. You can specify multiple names and also use wildcards. The signals and nets must refer to:
o o
278
Commands power on
Example Assume that signal /top/a toggles every 5ns. Without running the power off command:
power add /top/a run 400ns power report
Running the power off command (and resuming with power on):
power add /top/a run 100ns power off run 100ns power on run 200ns power report
279
Commands power report
power report
The power report command reports power information for the objects specified with power add. The report can be in either a tabular ASCII format (-file) or a Switching Activity Interchange Format (SAIF) format (-bsaif). Data produced by these commands can be translated and used by third-party tools used for power analysis. The power report command is intended to be used as follows: 1. Add the objects of interest with the power add command. 2. Run the simulation with the run command. 3. Produce the report with the power report command. Syntax power report [-all] [-noheader] [-file <filename>] [-bsaif <filename>] Arguments -all Writes information on all objects logged with power add. Optional. If you do not specify this argument, the report lists only those signals or nets that have a toggle count that is non-zero. -noheader Suppresses the header to aid in post processing. Optional. This argument has no affect on the output from the -bsaif switch. -file <filename> Specifies a filename for the ASCII-format power report. Optional. If you do not specify this argument or the -bsaif argument, the tabular ASCII-format power report is written to the transcript. You can specify both -file and -bsaif on the same command line, resulting in both reports being generated. -bsaif <filename> Specifies the filename for backward-SAIF format power report. Optional. If you do not specify this argument or the -file argument, the tabular ASCII-format power report is written to the transcript. You can specify both -file and -bsaif on the same command line, resulting in both reports being generated. Description The report format for each line is:
Node, Tc, Ti, Time at 1, Time at 0, Time at X
280
Node The hierarchical path of the signal, net or port Tc (toggle count) the number of 0->1 and 1->0 transitions Ti (hazard count) the number of 0/1->X, and X->0/1 transitions Note that if a signal is initialized at X, and later transitions to 0 or 1, it is not counted as a hazard.
Time at ... the length of time spent at each of the three respective states
Example Reports The following example is from the -file output of the tabular ASCII-format power report.
# # # # # # # # # # # # Power Report Interval 1100000 ps Power Report Node Tc Ti Time At 1 Time At 0 Time At X ------------------------------------------------------------------------/test_sm/out_wire(7) 1 0 669000 ps 420000 ps 11000 ps /test_sm/out_wire(6) 2 0 520000 ps 569000 ps 11000 ps /test_sm/out_wire(5) 3 0 149000 ps 940000 ps 11000 ps /test_sm/out_wire(4) 2 0 60000 ps 1029000 ps 11000 ps /test_sm/out_wire(3) 1 0 669000 ps 420000 ps 11000 ps ...
The following example is from the -bsaif output of the backward SAIF format power report. This file contains Header information (between SAIFILE and DURATION entries) and specific instance information (INSTANCE entries)
(SAIFILE (SAIFVERSION "2.0") (DIRECTION "backward") (DESIGN ) (VENDOR "Mentor Graphics") (PROGRAM_NAME "vsim") (VERSION "2.3b") (TIMESCALE 100ps) (DIVIDER /) (DURATION 1200000 ps) (INSTANCE (INSTANCE test_sm (NET out_wire(7) (T0 420000 ps) (T1 769000 ps) (TX 11000 ps) (TC 1) (IG 0) ) ) ) (INSTANCE (INSTANCE test_sm (NET out_wire(6) (T0 660000 ps) (T1 529000 ps) (TX 11000 ps) (TC 3) (IG 0) ) ) )
281
...
282
Commands power reset
power reset
The power reset command selectively resets power information to zero for the signals or nets specified with the power add command. Syntax power reset [-all] [-in] [-inout] [-out] [-internal] [-ports] [-r] <signalsOrNets> ... Arguments -all Resets all signals/nets. Optional. -in Resets only inputs. Optional. -inout Resets only inouts. Optional. -out Resets only outputs. Optional. -internal Resets only design internal signals or nets. Optional. -ports Resets only design ports. Optional. -r Searches recursively on a wildcard specified for the signal or net. Optional. <signalsOrNets> ... Specifies the signal or net to reset. Required. You can specify multiple names and also may use wildcards. The signals and nets must refer to:
o o
When using wildcards, the -in, -inout, -internal, -out, and -ports arguments filter the qualifying signals.
283
Commands precision
precision
The precision command determines how real numbers display in the graphic interface (e.g., Objects, Wave, Locals, and List windows). It does not affect the internal representation of a real number and therefore precision values over 17 are not allowed. Using the precision command without any arguments displays the current precision setting. Syntax precision [<digits>[#]] Arguments <digits>[#] Specifies the number of digits to display. Optional. Default is 6. Trailing zeros are not displayed unless you append the # sign. See examples for more details. Examples Results in 4 digits of precision.
precision 4
For example:
1.234 or 6543
Results in 8 digits of precision including trailing zeros.

precision 8#
For example:
1.2345600 or 6543.2100
Results in 8 digits of precision but doesnt print trailing zeros.

precision 8
For example:
1.23456 or 6543.21
284
Commands printenv
printenv
The printenv command prints to the Transcript pane the current names and values of all environment variables. If variable names are given as arguments, prints only the names and values of the specified variables. Syntax printenv [<var>] Arguments <var> Specifies the name(s) of the environment variable(s) to print. Optional. Examples Print all environment variable names and their current values.
printenv
For example,
# CC = gcc # DISPLAY = srl:0.0
Print the specified environment variables:

printenv USER HOME # USER = vince # HOME = /scratch/srl/vince
285
Commands process report
process report
The process report command creates a textual report of all processes displayed in the Process Window. Syntax process report [-file <filename>] [-append] Arguments -file <filename> Designates the name of the external file where raw process data will be saved. Optional. If <filename> is not given, then the output is redirected to stdout. -append Specifies that process data is to be appended to the current process report file. Optional. If this option is not used, the process data will overwrite the existing process report file.
286
Commands profile clear
profile clear
The profile clear command clears any performance data that has been gathered during previous run commands. After this command is executed, all profiling data will be reset. This command has no effect on the current profiling session. The last profile on or profile off command will still be in effect. Syntax profile clear Arguments None
See also Profiling Performance and Memory Use, profile interval, profile off, profile on, profile option, profile reload, profile report Note Profiling must be active when this command is invoked. Use the profile on command to begin profiling.
287
Commands profile interval
profile interval
The profile interval command selects the frequency with which the profiler collects samples during a run command. To use this command, first enable profiling with the profile on command. Syntax profile interval [<sample_frequency>] Arguments <sample_frequency> An integer value from 1 to 999 that represents how many milliseconds to wait between each sample collected during a profiled simulation run. Default is 10 ms. If the sample-frequency is not supplied, the profile interval command returns the current sample frequency. See also Profiling Performance and Memory Use, profile clear, profile off, profile on, profile option, profile reload, profile report
288
Commands profile off
profile off
The profile off command disables runtime memory allocation and statistical performance profiling. Syntax profile off [{-solver | -qdas | -classes | -cvg | -assertions}] [-m] [-p] Arguments {-solver | -qdas | -classes | -cvg | -assertions} Disables fine-grain analysis of memory capacity data being collected for the specified SystemVerilog construct. solver calls to randomize () qdas queues, dynamic arrays, associative arrays classes class objects cvg covergroups assertions assertions and cover directives -m Disables memory allocation profiling only. Optional. -p Disables statistical performance profiling only. Optional. See also Profiling Performance and Memory Use, profile clear, profile interval, profile on, profile option, profile reload, profile report
289
Commands profile on
profile on
The profile on command enables runtime memory allocation and statistical performance profiling. After this command is executed, every subsequent run command will be profiled. Syntax profile on [{-solver | -qdas | -classes | -cvg | -assertions}] [-m] [-p] [-file <filename> | -fileonly <filename>]] Arguments {-solver | -qdas | -classes | -cvg | -assertions} Enables fine-grain analysis of memory capacity data collected for the specified SystemVerilog construct. solver calls to randomize () qdas queues, dynamic arrays, associative arrays classes class objects cvg covergroups assertions assertions and cover directives -m Enables memory allocation profiling only. Optional. -p Enables statistical performance profiling only. Optional. -file <filename> Allows creation of a raw profile data file that can be post-processed later. Saves memory profile data into both an external file and internal data structures. Optional -fileonly <filename> Allows creation of a raw profile data file that can be post-processed later. Saves memory profile data into an external file only, not to internal data structures. Optional See also Profiling Performance and Memory Use, profile clear, profile interval, profile off, profile option, profile reload, profile report Example This set of commands enables the profiler, runs the simulation for 1000 nanoseconds, and outputs the profiling data to perf.rpt.
profile on run 1000 ns profile report -file perf.rpt
290
Commands profile option
profile option
The profile option command changes how profiling data are reported. The command acts like a toggle: invoking it once turns on the option; invoking it a second time turns the option back off. To use this command, first enable profiling with the profile on command. Syntax profile option collapse_sections [on | off | status] collect_calltrees [on | off] Arguments collapse_sections Groups profiling data by section. A section consists of regions of code such as VHDL processes, functions, or Verilog always blocks. By default all profiling data are reported on a per line basis. on | off | status Specifies whether to enable, disable, or report the status of the profile options. Optional. If omitted, the profile option command acts as a toggle. collect_calltrees [on | off] Collects data for call trees, showing which functions or routines call which others. By default this information is not collected. Simulation time and resource usage will increase if you turn on the collection of this data. See also Profiling Performance and Memory Use, profile clear, profile interval, profile off, profile on, profile reload, profile report
291
Commands profile reload
profile reload
The profile reload command reads in raw profile data from an external file created during memory allocation profiling. The profile report command and the Profile and Profile Details panes of the user interface can be used to view the data. The intent of the raw profile files is to allow analysis of memory profile data in cases where the memory required for the design plus the memory required for internal profiling data exceeds the memory capacity of the machine. To use this command, you must first use the -m -file <filename> or the -m -fileonly <filename> arguments with the profile on command. The profile reload command will clear all performance and memory profiling data collected to that point (implicit profile clear). Any currently loaded design will be unloaded (implicit quit -sim), and run-time profiling will be turned off (implicit profile off -m -p). If a new design is loaded after you have read the raw profile data, then all internal profile data is cleared (implicit profile clear), but run-time profiling is not turned back on. Syntax profile reload <filename> Arguments <filename> Designates the name of the external file where raw profile data will be saved. Required. See also Profiling Performance and Memory Use, profile clear, profile interval, profile off, profile on, profile option, profile report
292
Commands profile report
profile report
The profile report command outputs profiling data that have been gathered up to the point that you execute the command. To use this command, you must first enable profiling using the profile on command or the -memprof argument to the vsim command. Syntax profile report [-ranked | -calltree | -structural [-level <positive_integer>] [<rootname>] [-showcalls] | -callercallee <func> | -functioinst <func> | -instofdef <inst> [-inclusiveDuMatch 0|1]] -cutoff <percentage>] [-file <filename>] [-m] [-p] [-onexit] Arguments -calltree Reports a hierarchical callstack list of statistical performance and memory allocation data. Optional. This is the default report type. -callercallee <func> Creates a ranked report of all callers and callees of the specified function, where <func> indicates a function name (for Systemc, PLI, FLI) or a <.v/.vhd-filename>:<line#>. Optional. -cutoff <percentage> Filters out entries in the report that had less than <percentage> of time spent in them. Optional. Default is to report all entries (i.e., 0%). -file <filename> Specifies a file name for the report. Optional. Default is to write the report to the Transcript pane. -functioinst <func> Creates a ranked profile report of all instances of the specified function, where <func> indicates a function name (for Systemc, PLI, FLI) or a <.v/.vhd-filename>:<line#>. Optional. -instofdef <inst> [-inclusiveDuMatch 0|1] Creates a ranked report of all instances with the same definition as the specified instance, showing profile results for each. <inst> is the hierarchical pathname of the specified instance. Optional.
293
Commands profile report
The optional argument -inclusiveDuMatch 0|1 determines how strict the instance definition is. An inclusiveDuMatch of 1 (the default) includes in the report all instances that reference design units with the same primary name. For example if your design has multiple architectures for a VHDL entity, a value of 1 will cause matching for all instances that use the same entity. An inclusiveDuMatch of 0 includes in the report only instances that reference the exact design unit (e.g., a specific entity/architecture pair). -m Displays memory allocation data in the report. Optional. If -m is not specified, the profile report will include memory allocation data if the memory profiler was previously enabled and memory information was collected during a run. -onexit Causes the command to be executed when the simulator exits. Optional. Allows you to queue multiple profile report commands. -p Displays statistical performance samples in the report. Optional. If -p is not specified, the profile report will include performance statistics if the performance profiler was previously enabled and profile samples were collected during a run. -ranked Reports a ranked list of statistical performance and memory allocation data. Optional. -structural [-level <positive_integer>] [<rootname>] [-showcalls] Reports a structural list of statistical performance and memory allocation data. Optional. -level <positive_integer> determines how far to expand instance hierarchy. If omitted, the report includes all levels. Optional. <rootname> causes the report to be rooted at the specified instance. If not specified, the report contains all roots and any orphan samples. Optional. -showcalls lists function callstacks beneath each instance. If omitted, functional callstacks are not shown in the report. Optional. See also Profiling Performance and Memory Use, profile clear, profile interval, profile off, profile on, profile option, profile reload Examples This set of commands enables the statistical sampling profiler, runs the simulation for 1000 nanoseconds, and outputs the calltree profiling data to a file named perf.rpt.
profile on run 1000 ns profile report -file perf.rpt
Output ranked profile data for instances accounting for greater than 2% of the simulation time.
294
Commands profile report profile report -ranked -cutoff 2
Output to file perf.rpt ranked profile data for all instances that use the same entity as does instance /top/c/s0.
profile report -file perf.rpt -instofdef /top/c/s0
295
Commands project
project
The project command is used to perform common operations on projects. Some of the project commands must be used outside of a simulation session. Syntax project [addfile <filename> [<file_type>] [<folder_name>]] | [addfolder <foldername> [<folder_parent>]] | [calculateorder] | [close] | [compileall [-n]] | [compileorder] | [compileoutofdate [-n]] | [delete <filename>] | [env] | [history] | [new <home_dir> <proj_name> [<defaultlibrary>] [<intialini>] [<reference>]] | [open <project>] | [removefile <filename>] Arguments addfile <filename> [<file_type>] [<folder_name>] Adds the specified file to the current open project. Optional. You may also specifiy the HDL file type and folder name in which the file will be placed. If no folder name is specified the file will be placed in the top level folder. addfolder <foldername> [<folder_parent>] Creates a folder to contain the project. Optional. You may also specify a parent folder for the project folder. If unspecified, the project folder is placed at the top level. calculateorder Determines the compile order for the project by compiling each file, then moving any compiles that fail to the end of the list. This is repeated until there are no more compile errors. Optional. close Closes the current project. Optional. compileall [-n] Compiles all files in the project using the defined compile order. Optional. The -n option will return a list of the compile commands this command would execute, without actually executing the compiles. compileorder Returns the current compile order list. Optional. compileoutofdate [-n] Compiles all files that have a newer date/time stamp than the last time the file was compiled. Optional. The -n option will return a list of the compile commands this command would execute, without actually executing the compiles. delete <filename> Deletes the specified project (.mpf) file. Optional.
296
Commands project
env Returns the current project file. Optional. history Lists a history of manipulated projects. Optional. Must be used outside of a simulation session.
new <home_dir> <proj_name> [<defaultlibrary>] [<intialini>] [<reference>] Creates a new project under a specified home directory with a specified name and optionally a default library. Optional. The name of the work library will default to "work" unless specified. An optional modelsim.ini file can be specified as a seed for the project file by using the initialini option. If initialini is an empty string, then ModelSim uses the current modelsim.ini file when creating the project. You must specify a default library if you want to specify initialini. A new project cannot be created while a project is currently open or a simulation is in progress. The boolean "reference" option indicates if library mappings will include an "others" clause back to the initial .ini file (1) or copy all the mappings into the new file (0).
open <project> Closes any currently opened project and opens a specified project file (must be a valid .mpf file), making it the current project. Changes the current working directory to the project's directory. Optional. Must be used outside of a simulation session.
removefile <filename> Removes the specified file from the current project. Optional.
Examples Make /user/george/design/test3/test3.mpf the current project and changes the current working directory to /user/george/design/test3.
project open /user/george/design/test3/test3.mpf
Execute current project library build scripts.

project compileall
297
Commands property list
property list
The property list command changes one or more properties of the specified signal, net, or register in the List window. The properties correspond to those you can set by selecting View > Signal Properties (List window). At least one argument must be used. Syntax property list [-window <wname>] [-label <label>] [-radix <type>] [-radixenumnumeric | -radixenumsymbolic ] [-trigger <setting>] [-width <number>] <pattern> Arguments -window <wname> (optional) Specifies a particular List window when multiple instances of the window exist (e.g., list2). If no window is specified the default window is used; the default window is determined by the most recent invocation of the view command. -label <label> (optional) Specifies the label to appear at the top of the List window column. -radix <type> (optional) Specifies the radix for List window objects. Valid entries (or any unique abbreviations) are: binary, ascii, unsigned, decimal, octal, hex, symbolic, time, and default. If no radix is specified for an enumerated type, the default representation is used. You can change the default radix for the current simulation using the radix command. You can change the default radix permanently by editing the DefaultRadix variable in the modelsim.ini file. If you specify a radix for an array of a VHDL enumerated type, ModelSim converts each signal value to 1, 0, Z, or X. -radixenumnumeric (optional) Displays SystemVerilog and SystemC enums as numbers rather than strings. The current radix setting controls the actual enum value displayed, except when the radix setting is ASCII. If the current radix setting is ASCII, the value of SystemVerilog and SystemC enums are displayed as a string. This option overrides the global setting of the default radix (the DefaultRadix variable in the modelsim.ini file). -radixenumsymbolic (optional) Reverses the action of the -radixenumnumeric option and sets the global setting of the default radix (the DefaultRadix variable in the modelsim.ini file) to symbolic. -trigger <setting> (optional) Valid settings are 0 or 1. Setting trigger to 1 will enable the List window to be triggered by changes in the objects matching the specified pattern.
298
Commands property list
-width <number> (optional) Valid numbers are 1 through 256. Specifies the desired column width for the objects matching the specified pattern.
<pattern> (required) Specifies a name or wildcard pattern to match the full pathnames of the signals, nets, or registers for which you are defining the property change.
299
Commands property wave
property wave
The property wave command changes one or more properties of the specified signal, net, or register in the Wave window. The properties correspond to those you can set by selecting View > Signal Properties (Wave window). At least one argument must be used. Syntax property wave [-window <wname>] [-color <color>] [-format <format>] [-height <number>] [-offset <number>] [-radix <type>] [-radixenumnumeric | -radixenumsymbolic] [-scale <float>] <pattern> Arguments -window <wname> Specifies a particular Wave window when multiple instances of the window exist (e.g., wave2). Optional. If no window is specified the default window is used; the default window is determined by the most recent invocation of the view command. -color <color> Specifies the color to be used for the waveform. Optional. -format <format> The waveform <format> can be expressed as: analog Displays a waveform whose height and position is determined by the -scale and -offset values (shown below). Optional. literal Displays the waveform as a box containing the object value (if the value fits the space available). Optional. logic Displays values as 0, 1, X, or Z. Optional. -height <number> Specifies the height (in pixels) of the waveform. Optional. -offset <number> Specifies the waveform position offset in pixels. Valid only when -format is specified as analog. Optional. -radix <type> Specifies the radix for Wave window objects. Optional. Valid entries (or any unique abbreviations) are: binary, ascii, unsigned, decimal, octal, hex, symbolic, time, and default. If no radix is specified for an enumerated type, the default representation is used. You can change the default radix for the current simulation using the radix command. You can change the default radix permanently by editing the DefaultRadix variable in the modelsim.ini file.
300
Commands property wave
If you specify a radix for an array of a VHDL enumerated type, ModelSim converts each signal value to 1, 0, Z, or X. -radixenumnumeric (optional) Displays SystemVerilog and SystemC enums as numbers rather than strings. The current radix setting controls the actual enum value displayed, except when the radix setting is ASCII. If the current radix setting is ASCII, the value of SystemVerilog and SystemC enums are displayed as a string. This option overrides the global setting of the default radix (the DefaultRadix variable in the modelsim.ini file). -radixenumsymbolic (optional) Reverses the action of the -radixenumnumeric option and sets the global setting of the default radix (the DefaultRadix variable in the modelsim.ini file) to symbolic. -scale <float> Specifies the waveform scale relative to the unscaled size value of 1. Valid only when -format is specified as analog. Optional. <pattern> Specifies a name or wildcard pattern to match the full path names of the signals, nets, or registers for which you are defining the property change. Required.
301
Commands push
push
The push command moves the specified number of call frames down the C callstack. This command is used with C Debug. Refer to C Debug for more information. Syntax push <#_of_levels> Arguments <#_of_levels> Specifies the number of call frames to move down the C callstack. Optional. If unspecified, 1 level is assumed. Examples Move down 1 call frame.
push
Move down 4 call frames.

push 4
See also pop, C Debug
302
Commands pwd
pwd
The Tcl pwd command displays the current directory path in the Transcript pane. Syntax pwd Arguments None
303
Commands quietly
quietly
The quietly command turns off transcript echoing for the specified command. Syntax quietly <command> Arguments <command> Specifies the command for which to disable transcript echoing. Required. Any results normally echoed by the specified command will not be written to the Transcript pane. To disable echoing for all commands use the transcript command with the -quietly option. See also transcript
304
Commands quit
quit
The quit command exits the simulator. If you want to stop the simulation using a when command, you must use a stop command within your when statement, you must not use an exit or a quit command. The stop command acts like a breakpoint at the time it is evaluated. Syntax quit [-f | -force] [-sim] [-code <integer>] Arguments -f | -force Quits without asking for confirmation. Optional. If omitted, ModelSim asks you for confirmation before exiting. (The -f and -force arguments are equivalent.) -sim Unloads the current design in the simulator without exiting ModelSim. All files opened by the simulation will be closed including the WLF file (vsim.wlf). -code <integer> Quits the simulation and issues an exit code. <integer> This is the value of the exit code. You should not specify an exit code that already exists in the tool. Refer to the section "Exit Codes" in the Users Manual for a list of existing exit codes. You can also specify a variable in place of the <integer>. You should always print a message before executing the quit -code command to explicitly state the reason for exiting. Examples Refer to the Examples section of the exit command for an example of using the -code argument. The quit and exit commands behave similarly in this regard.
305
Commands qverilog
qverilog
The qverilog command compiles (vlog), optimizes (vopt), and simulates (vsim) Verilog and SystemVerilog designs in a single step. It combines the compile, elaborate, and simulate phases together, as some users may be accustomed to doing with NC-Sim. This command is provided to ease these users transition to ModelSim. The qverilog command invokes vlog, vopt, and then vsim. All standard vlog (and vopt) arguments are supported and are applied directly to the qverilog command line. All vsim options are supported and are applied through the qverilog -R argument. You can directly enter either C or C++ file onto the qverilog command line. ModelSim automatically processes them using the SystemVerilog Direct Programming Interface (DPI). Refer to DPI and the qverilog Command for details. If your design contains DPI export tasks or functions, it is recommended that you use the vlog/vsim flow. You can invoke the GUI by specifying the -gui argument through the qverilog -R argument. By default, qverilog runs the simulation and quits automatically by invoking an implicit "run all; quit -f". However, if you invoke qverilog with -do, -gui, or -i, qverilog invokes the simulator and keeps it open until you explicitly quit ModelSim. The qverilog command creates a work library named work in the current directory, if not present already. The command arguments listed below are only those unique to the qverilog command. This command also supports all vlog command arguments. Syntax qverilog [[<vlog_and_vopt_options>]] [-ccflags "opts"] [-gui] [-l <logfile>] <filename> [-ldflags "opts"] [-R <vsim_options>] [-work <library_name>] Arguments [<vlog_and_vopt_options>] All vlog and vopt options are supported. For example, if you are running qverilog on a SystemVerilog design, you need to add the -sv argument to the command line. -ccflags "opts" Specifies all C/C++ compiler options. Options are in quotes. Optional. For -ccflags and -ldflags, qverilog does not check the validity of the option(s) you specify. The options are directly passed on to the compiler and linker, and if they are not valid, an error message is generated by the compiler/linker. -gui Simulates the design using the ModelSim GUI.
306
Commands qverilog
-l <logfile> Creates a logfile/transcript compatible with vlogs -l logfile argument. Optional. If omitted, a default transcript called qverilog.log is created that collects the output from vlog, vopt, and vsim.
<filename> Specifies the name of the Verilog or C/C++ source code file to compile. One filename is required. Multiple filenames separated by spaces may be entered. Wildcards may be used. In the case of C files, they are automatically processed as DPI code.
-ldflags "opts" Specifies all linker options in quotes. Optional. For -ccflags and -ldflags, qverilog does not check the validity of the option(s) you specify. The options are directly passed on to the compiler and linker, and if they are not valid, an error message is generated by the compiler/linker.
-R <vsim_options> Specifies valid vsim arguments to be applied to the simulation. All vlog and vopt arguments must come before -R is specified, as all arguments specified after -R are interpreted as vsim arguments.
-work <library_name> Specifies a logical name or pathname of a library that is to be mapped to the logical library work. Optional. By default, the compiled design units are added to the work library. The specified pathname overrides the pathname specified for work in the project file.
Examples Compile, optimize, and simulate the specified files. The C/C++ code contained in the d.c file is processed as DPI code, creating a shared object, and loading it into vsim at runtime. Creates a logfile named "logfile" and opens the ModelSim GUI with the simulation loaded and ready to run.
qverilog -l logfile a.v b.v c.v d.c -R -gui
307
Commands radix
radix
The radix command specifies the default radix to be used for the current simulation. The command can be used at any time. The specified radix is used for all commands (force, examine, change, etc.) as well as for displayed values in the Objects, Locals, Dataflow, List, and Wave windows. Alternate methods for changing the default radix: Syntax radix [-symbolic | -binary | -octal | -decimal | -hexadecimal | -unsigned | -ascii | -time] [-enumnumeric | -enumsymbolic] Arguments You can abbreviate the following arguments to any length. For example, -dec is equivalent to -decimal. -symbolic Displays values in a form closest to their natural form. Optional. -binary Displays values in binary format. Optional. -octal Displays values in octal format. Optional. -decimal Displays values in decimal format. You can specify -signed as an alias for this argument. Optional. -hexadecimal Displays values in hexadecimal format. Optional. -unsigned Displays values in unsigned decimal format. Optional. -ascii Display a Verilog object as a string equivalent using 8-bit character encoding. Optional. -time Displays values of time for register-based types in Verilog. Optional. In the modelsim.ini file, edit the DefaultRadix variable. Choose Simulate > Runtime Options from the main menu, click the Defaults tab, make your selection in the Default Radix box.
308
Commands radix
-enumnumeric Displays SystemVerilog and SystemC enums as numbers rather than strings. Optional. The current radix setting controls the actual enum value displayed, except when the radix setting is ASCII. If the current radix setting is ASCII, the value of SystemVerilog and SystemC enums are displayed as a string.
-enumsymbolic Displays SystemVerilog and SystemC enums as strings rather than numbers. Optional. This option reverses the action of the -enumnumeric option.
<no argument> Returns the current radix setting.
See also User-Defined Radices, radix define, radix names, radix list, radix delete
309
Commands radix define
radix define
The radix define command is used to create or modify a user-defined radix. A user definable radix is used to map bit patterns to a set of enumeration labels. User-defined radices are available for use in the Wave and List windows or with the examine command. Syntax radix define <name> <definition_body> Arguments <name> User-specified name for the radix. Required. <definition_body> A list of number pattern, label pairs. Required. The definition body has the form:
{ <numeric-value> <enum-label>, <numeric-value> <enum-label> -default <radix_type> }
A <numeric-value> is any legitimate HDL integer numeric literal. To be more specific:

<base>#<base-integer># <base>"bit-value" <integer> <size>'<base><number> --- <base> is 2, 8, 10, or 16 --- <base> is B, O, or X --- <size> is an integer, <base> is b, d, o, or h.
Check the Verilog and VHDL LRM's for exact definitions of these numeric literals. The comma (,) in the definition body is optional. The <enum-label> is any arbitrary string. It should be quoted ("") especially if it contains spaces. The -default entry is optional. If present, it defines the radix to use if a match is not found for a given value. The -default entry can appear anywhere in the list, it does not have to be at the end. -color <value> Designates a color for the waveform and text in the Wave window. Optional. The color value may be a color name or its hex value (see example below). Example The radix define command used to create a radix called States, which will display state values in the List, Watch, and Wave windows instead of numeric values.
radix define States 11'b00000000001 11'b00000000010 11'b00000000100 11'b00000001000 11'b00000010000 { "IDLE", "CTRL", "WT_WD_1", "WT_WD_2", "WT_BLK_1",
310
Commands radix define 11'b00000100000 11'b00001000000 11'b00010000000 11'b00100000000 11'b01000000000 11'b10000000000 -default hex } "WT_BLK_2", "WT_BLK_3", "WT_BLK_4", "WT_BLK_5", "RD_WD_1", "RD_WD_2",
The following example illustrates how to specify the radix color:

radix define States { 11'b00000000001 "IDLE" -color yellow, 11'b00000000010 "CTRL" -color #ffee00, 11'b00000000100 "WT_WD_1" -color orange, 11'b00000001000 "WT_WD_2" -color orange, 11'b00000010000 "WT_BLK_1", 11'b00000100000 "WT_BLK_2", 11'b00001000000 "WT_BLK_3", 11'b00010000000 "WT_BLK_4", 11'b00100000000 "WT_BLK_5", 11'b01000000000 "RD_WD_1" -color green, 11'b10000000000 "RD_WD_2" -color green, -default hex -defaultcolor white }
If a pattern/label pair does not specify a color, the normal wave window colors will be used. If the value of the waveform does not match any pattern, then the -default radix and -defaultcolor will be used. To specify a range of values, wildcards may be specified for bits or characters of the value. The wildcard character is '?', similar to the iteration character in a Verilog UDP, for example:
radix define { 6'b01??00 "Write" -color orange, 6'b10??00 "Read" -color green }
In this example, the first pattern will match "010000", "010100", "011000", and "011100". In case of overlaps, the first matching pattern is used, going from top to bottom. See also User-Defined Radices, radix, radix names, radix list, radix delete
311
Commands radix names
radix names
The radix names command returns a list of currently defined radix names. Syntax radix name Arguments None See also User-Defined Radices, radix, radix define, radix list, radix delete
312
Commands radix list
radix list
The radix list command will return the complete definition of a radix, if a name is given. If no name is given, it will list all the defined radices. Syntax radix list [<name>] Arguments <name> Returns the complete definition of the named radix. Optional. See also User-Defined Radices, radix, radix define, radix names, radix delete
313
Commands radix delete
radix delete
The radix delete command will remove the radix definition from the named radix. Syntax radix delete <name> Arguments <name> Removes the radix definition from the named radix. Required. See also User-Defined Radices, radix, radix define, radix names, radix list
314
Commands readers
readers
The readers command displays the names of all readers of the specified object. The reader list is expressed relative to the top-most design signal/net connected to the specified object. Syntax readers <object_name> Arguments <object_name> Specifies the name of the signal or net whose readers are to be shown. Required. All signal or net types are valid. Multiple names and wildcards are accepted. See also drivers
315
Commands report
report
The report command displays the value of all simulator control variables, or the value of any simulator state variables relevant to the current simulation. Syntax report simulator control | simulator state Arguments simulator control Displays the current values for all simulator control variables. simulator state Displays the simulator state variables relevant to the current simulation. Examples Display all simulator control variables.
report simulator control # # # # # # # # # # # # # # # # # # # # # # UserTimeUnit = ns RunLength = IterationLimit = 5000 BreakOnAssertion = 3 DefaultForceKind = default IgnoreNote = 0 IgnoreWarning = 0 IgnoreError = 0 IgnoreFailure = 0 IgnoreSVAInfo= 0 IgnoreSVAWarning = 0 IgnoreSVAError = 0 IgnoreSVAFatal = 0 CheckpointCompressMode = 1 NumericStdNoWarnings = 0 StdArithNoWarnings = 0 PathSeparator = / DefaultRadix = symbolic DelayFileOpen = 1 WLFFilename = vsim.wlf WLFTimeLimit = 0 WLFSizeLimit = 0
You can set these simulator control variables to a new value by using the Tcl set Command Syntax. Display all simulator state variables. Only the variables that relate to the design being simulated are displayed:
report simulator state
316
Commands report # # # # # # now = 0.0 delta = 0 library = work entity = type_clocks architecture = full resolution = 1ns
Viewing preference variables Preference variables have more to do with the way things look (but not entirely) rather than controlling the simulator. You can view preference variables from the Preferences dialog box. Select Tools > Edit Preferences (Main window). See also Simulator Control Variables, Simulator GUI Preferences
317
Commands restart
restart
The restart command reloads the design elements and resets the simulation time to zero. Only design elements that have changed are reloaded. (Note that SDF files are always reread during a restart.) Note The restart command is equivalent to the dataset restart command when the current environment is set to a non-simulation dataset. Shared libraries are handled as follows during a restart: Shared libraries that implement VHDL foreign architectures only are reloaded at each restart when the architecture is elaborated (unless the -keeploaded option to the vsim command is used). Shared libraries loaded from the command line (-foreign and -pli options) and from the Veriuser entry in the modelsim.ini file are reloaded (unless you specify the -keeploaded argument to vsim). Shared libraries that implement VHDL foreign subprograms remain loaded (they are not reloaded) even if they also contain code for a foreign architecture.
You can configure defaults for the restart command by setting the DefaultRestartOptions variable in the modelsim.ini file. Refer to Restart Command Defaults. To handle restarts with Verilog PLI applications, you need to define a Verilog user-defined task or function, and register a misctf class of callback. To handle restarts with Verilog VPI applications, you need to register reset callbacks. To handle restarts with VHDL FLI applications, you need to register restart callbacks. Refer to Verilog Interfaces to C for more information on the Verilog PLI/VPI/DPI and the ModelSim FLI Reference for more information on the FLI. Syntax restart [-force] [-nobreakpoint] [-nolist] [-nolog] [-nowave] Arguments -force Specifies that the simulation will be restarted without requiring confirmation in a popup window. Optional. -nobreakpoint Specifies that all breakpoints will be removed when the simulation is restarted. Optional. The default is for all breakpoints to be reinstalled after the simulation is restarted.
318
Commands restart
-nolist Specifies that the current List window environment will not be maintained after the simulation is restarted. Optional. The default is for all currently listed HDL objects and their formats to be maintained.
-nolog Specifies that the current logging environment will not be maintained after the simulation is restarted. Optional. The default is for all currently logged objects to continue to be logged.
-nowave Specifies that the current Wave window environment will not be maintained after the simulation is restarted. Optional. The default is for all objects displayed in the Wave window to remain in the window with the same format.
See also checkpoint, restore, vsim, Checkpointing and Restoring Simulations
319
Commands restore
restore
The restore command restores the state of a simulation that was saved with a checkpoint command during the current invocation of VSIM (called a "warm restore"). The items restored are: simulation kernel state, vsim.wlf file, HDL objects listed in the List and Wave windows, file pointer positions for files opened under VHDL and under Verilog $fopen, and the saved state of foreign architectures. If you want to restore while running VSIM, use this command. If you want to start up VSIM and restore a previously-saved checkpoint, use the -restore switch with the vsim (called a "cold restore"). Checkpoint/restore allows a cold restore, followed by simulation activity, followed by a warm restore back to the original cold-restore checkpoint file. Warm restores to checkpoint files that were not created in the current run are not allowed except for this special case of an original cold restore file. Checkpoint files are platform dependentyou cannot checkpoint on one platform and restore on another. Syntax restore <filename> Arguments <filename> Specifies the name of the checkpoint file. Required. See also checkpoint, vsim, Checkpointing and Restoring Simulations
320
Commands resume
resume
The resume command is used to resume execution of a macro file after a pause command or a breakpoint. It may be input manually or placed in an onbreak command string. (Placing a resume command in a bp command string does not have this effect.) The resume command can also be used in an onerror command string to allow an error message to be printed without halting the execution of the macro file. Syntax resume Arguments None
See also abort, do, onbreak, onerror, pause
321
Commands right
right
The right command searches right (next) for signal transitions or values in the specified Wave window. It executes the search on signals currently selected in the window, starting at the time of the active cursor. The active cursor moves to the found location. Use this command to move to consecutive transitions or to find the time at which a waveform takes on a particular value, or an expression of multiple signals evaluates to true. See the left command for related functionality. The procedure for using right entails three steps: click on the desired waveform; click on the desired starting location; issue the right command. (The seetime command can initially position the cursor from the command line, if desired.) Returns: <number_found> <new_time> <new_delta> Syntax right [-expr {<expression>}] [-falling] [-noglitch] [-rising] [-value <sig_value>] [-window <wname>] [<n>] Arguments -expr {<expression>} The waveform display will be searched until the expression evaluates to a boolean true condition. Optional. The expression may involve more than one signal, but is limited to signals that have been logged in the referenced Wave window. A signal may be specified either by its full path or by the shortcut label displayed in the Wave window. See GUI_expression_format for the format of the expression. The expression must be placed within curly braces. -falling Searches for a falling edge on the specified signal if that signal is a scalar signal. If it is not a scalar signal, the option will be ignored. Optional. -noglitch Looks at signal values only on the last delta of a time step. For use with the -value option only. Optional. -rising Searches for a rising edge on the specified signal if that signal is a scalar signal. If it is not a scalar signal, the option will be ignored. Optional. -value <sig_value> Species a value of the signal to match. Must be specified in the same radix that the selected waveform is displayed. Case is ignored, but otherwise the value must be an exact string match -- don't-care bits are not yet implemented. Only one signal may be selected, but that signal may be an array. Optional.
322
Commands right
-window <wname> Specifies an instance of the Wave window that is not the default. Optional. Otherwise, the default Wave window is used. Use the view command to change the default window.
<n> Specifies to find the nth match. If less than n are found, the number found is returned with a warning message, and the cursor is positioned at the last match. Optional. The default is 1.
Examples Find the second time to the right at which the selected vector transitions to FF23, ignoring glitches.
right -noglitch -value FF23 2
Go to the next transition on the selected signal.

right
The following examples illustrate search expressions that use a variety of signal attributes, paths, array constants, and time variables. Such expressions follow the GUI_expression_format. Search right for an expression that evaluates to a boolean 1 when signal clk just changed from low to high and signal mystate is the enumeration reading and signal /top/u3/addr is equal to the specified 32-bit hex constant; otherwise is 0.
right -expr {clkrising && (mystate == reading) && (/top/u3/addr == 32habcd1234)}
Search right for an expression that evaluates to a boolean 1 when the upper 8 bits of the 32-bit signal /top/u3/addr equals hex ac.
right -expr {(/top/u3/addr and 32hff000000) == 32hac000000}
Search right for an expression that evaluates to a boolean 1 when logfile time is between 23 and 54 microseconds, and clock just changed from low to high and signal mode is enumeration writing.
right -expr {((NOW > 23 us) && (NOW < 54 us)) && clkrising && (mode == writing)}
Note Wave Window Mouse and Keyboard Shortcuts are also available for next and previous edge searches. Tab searches right (next) and shift-tab searches left (previous). See also GUI_expression_format, left, seetime, view
323
Commands run
run
The run command advances the simulation by the specified number of timesteps. Syntax run [<timesteps>[<time_units>]] | [-all] | [-continue] | [-finish] | [-next] | [-step] | [-over [<n>>] Arguments <timesteps>[<time_units>] Specifies the number of timesteps for the simulation to run. The number may be fractional, or may be specified absolute by preceding the value with the character @. Optional. In addition, optional <time_units> may be specified as:
fs, ps, ns, us, ms, or sec
The default <timesteps> and <time_units> specifications can be changed during a ModelSim session by selecting Simulate > Simulation Options (Main window). Time steps and time units may also be set with the RunLength and UserTimeUnit variables in the modelsim.ini file. -all Causes the simulator to run the current simulation forever, or until it hits a breakpoint or specified break event. Optional. -continue Continues the last simulation run after a step command, step -over command or a breakpoint. A run -continue command may be input manually or used as the last command in a bp command string. Optional. -finish In C Debug only, continues the simulation run and returns control to the calling function. Optional. -next Causes the simulator to run to the next event time. Optional. -step Steps the simulator to the next HDL statement. Optional. -over [<n>] Directs ModelSim to run VHDL procedures and functions, Verilog tasks and functions, and C functions but to treat them as simple statements instead of entering and tracing them line by line. If you are using C Debug, specifying a positive integer value for <n> moves the debugger n lines ahead. Optional. Examples Advance the simulator 1000 timesteps.
324
Commands run run 1000
Advance the simulator the appropriate number of timesteps corresponding to 10.4 milliseconds.
run 10.4 ms
Advance the simulator to timestep 8000.

run @8000
See also step
325
Commands runStatus
runStatus
The runStatus command returns the current state of your simulation after issuing a run or step command. Syntax runStatus [-full] Arguments -full appends additional information to the output of the runStatus command. Results The output of the runStatus command is described in Table 2-3 (runStatus results) and Table 2-4 (runStatus -full results). Table 2-3. runStatus Command States State ready break error loading nodesign checkpoint cready initializing Description The design is loaded and is ready to run. The simulation stopped before completing the requested run. The simulation stopped due to an error condition. The simulation is currently elaborating. There is no design loaded. A checkpoint is being created, do not interrupt this process. The design is loaded and is ready to run in C debug mode. The user interface initialization is in progress.
Table 2-4. runStatus -full Command Information -full Information bkpt bkpt_builtin end fatal_error iteration_limit silent_halt step step_builtin Description stopped at breakpoint stopped at breakpoint on builtin process reached end of requested run encountered fatal error (such as, divide by 0) iteration limit reached, possible feedback loop mti_BreakSilent() called, run -step completed run -step completed on builtin process
326
Commands runStatus
Table 2-4. runStatus -full Command Information -full Information step_wait_suspend user_break user_halt user_stop gate_oscillation simulation_stop Description run -step completed, time advanced. run interrupted do to break-key or ^C (SIGINT) mti_Break() called. stop or finish requested from vpi, stop command, etc. Verilog gate iteration limit reached. pli stop_simulation() called.
327
Commands sccom
sccom
The sccom command is actually two commands in one: sccom interacts with a C/C++ compiler to compile SystemC source code into the work library, and sccom -link takes the compiled source code and links the design. This command may be invoked from within ModelSim or from the operating system command prompt. This command may also be invoked during simulation. To enable source debugging of SystemC code, you must compile for debugging by specifying the CPP compilers -g argument. Compiled libraries are platform dependent. If you move between platforms, you need to run vdel -allsystemc on the working library and then recompile your SystemC source. Compiled libraries are version dependent. For example, you cannot use a library compiled with 5.8 in a simulation using 5.8a vsim. You have to re-compile your design with the updated version of sccom. During the linking of the design (with sccom -link) the order in which you specify archives (.a) and object files is very important. Any dependent .a or .o must be specified before the .a or .o on which it depends. Compile syntax sccom [-93] [<CPP compiler options>] [<CPP linker options>] [-dumpscvtest <filename>] [-dpilib <libname>] [-error <msg_number> [,<msg_number>,...]] [-f <filename>] [-fatal <msg_number>[,<msg_number>,]] [-help] [-incr] [-lib <compiled library>] [-link] [-log <logfile>] [-nodbgsym] [-nodebug] [-nologo] [-note <msg_number> [,<msg_number>,...]] [-scms] [-scv] [-scversion] [-suppress <msg_number> [,<msg_number>,...]] [-vv] [-verbose] [-version] [-warning <msg_number> [,<msg_number>,...]] <filename> Link syntax sccom -link [<CPP linker options>] [-dpilib <libname>] [-f <filename>] [-help] [-lib <compiled library>] [-log <logfile>] [-nologo] [-scv] [-vv] [-verbose] [-version] [-work <library_name>] Arguments -93 Makes the design unit strictly case-sensitive, enforcing case-sensitivity across the SystemC-HDL mixed language boundary. Optional. <CPP compiler options> Any normal C++ compiler option can be used, with the exception of the -o and -c options. You must specify the -g argument to compile for debugging. By default, sccom compiles without debugging information. You can specify arguments for all sccom compiles by editing the CppOptions variable in the modelsim.ini file.
328
Commands sccom
-DSC_ Specifies SystemVerilog libraries for SystemC DPI (Direct Programming Interface). Optional. Only one library can be specified per each -dpilib argument. See section SystemC Procedural Interface to SystemVerilog.
-DSC_INCLUDE_MTI_AC Enable native debug support of Algorithmic-C datatypes. Optional. -DSC_INCLUDE_DYNAMIC_PROCESSES Enable dynamic processes. Optional. -DSC_INCLUDE_FX Enable fixed-point datatypes. Optional. -DSC_USE_STD_STRING Replace sc_string with std::string. Optional. -DSC_USE_STD_STRING_OLD Use deprecated sc_string. Optional. -DMTI_BIND_SC_MEMBER_FUNCTION Enable registration of module member functions as DPI-SC imports. Optional. -DUSE_MTI_CIN Enables support of C++ standard input cin. Optional.
<CPP linker options> Any normal C++ compiler option can be used, with the exception of the -o option. You can specify arguments for all sccom compiles by editing the CppOptions variable in the modelsim.ini file.
-dumpscvtest <filename> Generates SystemC verification (SCV) extensions for any given object type. For this argument, <filename> is a C++ (.cpp) file that contains global variable definition for each type and includes the header file containing definitions for these types. Optional.
-dpilib <libname> Specifies SystemVerilog libraries for SystemC DPI (Direct Programming Interface). Optional. Only one library can be specified per each -dpilib argument. See section SystemC Procedural Interface to SystemVerilog.
329
Commands sccom
-error <msg_number> [,<msg_number>,...] Changes the severity level of the specified message(s) to "error." Optional. Edit the error variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information.
-f <filename> Specifies an argument file with more command-line arguments. Optional. Allows complex argument strings to be reused without retyping. Nesting of -f options is allowed. Refer to the section "Argument Files" for more information.
-fatal <msg_number>[,<msg_number>,] Changes the severity level of the specified message(s) to "fatal." Optional. Edit the fatal variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information.
-help Displays options and arguments for this command. Optional. -incr Enables automatic incremental compilation so that only changed files are compiled. Optional. A changed file is re-compiled in the following cases:
o
Its pre-processor output is different from the last time it was successfully compiled. This includes changes in included header files and to the source code itself.
Note Pre-processor output is used because it prevents compilation on a file with the following types of changes: Access or modification time (touch) Changes to commentsexcept changes to the source code that affect line numbers (such as adding a comment line) will cause all affected files to be recompiled. This occurs to keep debug information current so that ModelSim can trace back to the correct areas of the source code.
You invoke sccom with a different set of command-line options that have an impact on the gcc command line. Preserving all settings for the gcc command ensures that ModelSim re-compiles source files when a different version of gcc is used or when a platform changes.
-lib <compiled library> Only used for sccom -link invocations. Specifies the default working library where the SystemC linker can find the object files for compiled SystemC modules.
330
Commands sccom
-link sccoms -link argument performs the final link of all previously compiled SystemC source code. Required before running simulation. Any dependent .a or .o must be specified before the .a or .o on which it depends. Two types of dependencies are possible, and where you place the -link argument is different based on which type of dependency the files have. If your archive or object is dependent on the .o files created by sccom (i.e. your code references symbols in the generated SystemC .o files), then you must specify the -link argument after the list of files, as shown below:
sccom a.o b.o libtemp.a -linkz
Under the covers, the C++ linkers command and argument order looks like this:
ld a.o b.o libtemp.a <internal list of SC .o files> libsystemc.a
However, if the .o files created by sccom are dependent on the object or archive you provided, then the -link argument must be placed before the object files or archive:
sccom -link a.o b.o libtemp.a
In this case, the "undercover" command and argument order look like this:
ld <internal list of SC .o files> libsystemc.a a.o b.o libtemp.a
-log <logfile> Specifies the logfile in which to collect output. Optional. Related modelsim.ini variable is SccomLogfile.
-nodbgsym Disables the generation of symbols for the debugging database in the library, which allows source annotation.
-nodebug Disables the creation of a debug database for modules defined in those source files. Optional. Must not be used with any files containing the SC_MODULE_EXPORT() macro. Using this option can significantly reduce the compile time for a design, which is useful when running designs in regression mode. Refer to "Custom Debugging of SystemC Channels and Variables" for more information.
-nologo Disables the startup banner. Optional. -note <msg_number> [,<msg_number>,...] Changes the severity level of the specified message(s) to "note." Optional. Edit the note variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information.
331
Commands sccom
-scms Includes the SystemC master slave library. Optional. If you specify this argument when compiling your C code with sccom, you must also specify it when linking the object files with sccom -link.
-scv Includes the SystemC verification library. Optional. If you specify this argument when compiling your C code with sccom, you must also specify it when linking the object files with sccom -link. Related modelsim.ini variable is UseScv.
-scversion Prints out the version of the SystemC verification library used. Optional. -suppress <msg_number> [,<msg_number>,...] Prevents the specified message(s) from displaying. Optional. You cannot suppress Fatal or Internal messages. Edit the suppress variable in the modelsim.ini file to set a permanent default.
-vv Prints all subprocess invocation information. Optional. An example is the call to gcc along with the command-line arguments.
-verbose Prints the name of each sc_module encountered during compilation. Optional. Related modelsim.ini variable SccomVerbose.
-version Displays the version of sccom used to compile the design. Optional. -warning <msg_number> [,<msg_number>,...] Changes the severity level of the specified message(s) to "warning." Optional. Edit the warning variable in the modelsim.ini file to set a permanent default.
-work <library_name> For the compiler Specifies a logical name or pathname of a library that is to be mapped to the logical library work. Optional; by default, the compiled object files (.so) are added to the work library. The specified pathname overrides the pathname specified for work in the project file. For the linker Specifies a logical name or pathname of a library where the final linked object file (.so) is to be stored. Optional; by default, the linked object files are added to the work library.
<filename> Specifies the name of a file containing the SystemC/C++ source to be compiled. Required. Multiple filenames separated by spaces can be entered, or wildcards can be used (e.g., *.cpp).
332
Commands sccom
Examples Compile example.cpp with debugging information.

sccom -g example.cpp
Link example.o.
sccom -link
Use two sccom commands to compile a.cpp into a first library lib1, and b.cpp into a second library called lib2. Run sccom again to link and compile the compiled object files created in those two libraries into a third shared library, lib3. Run vsim using -sclib, which is required in order to point to the location of the shared library. The -lib arguments are also required to specify the locations of the SystemC design units.
sccom -work sccom -work sccom -link vsim -sclib lib1 lib2 -lib lib3 a.cpp b.cpp lib1 -lib lib2 -work lib3 -lib lib1 -lib lib2
Compile the SystemC code with an include directory and the compile time macro (SC_INCLUDE_FX) to compile the source with support for fixed point types. For more information, refer to Fixed-Point Types.
sccom -I/home/systemc/include -DSC_INCLUDE_FX -g a.cpp b.cpp
Compile with the g++ -02 optimization argument.

sccom -02 a.cpp
Link in the library libmylib.a when creating the .so file. The -L, a gcc argument, specifies the search path for the libraries.
sccom -L home/libs/ -l mylib -link
See also SystemC Simulation, scgenmod, vdel -allsystemc
333
Commands scgenmod
scgenmod
Once a Verilog or VHDL module is compiled into a library, you can use the scgenmod command to write its equivalent SystemC foreign module declaration to standard output. Optional -map argument allow you to appropriately generate sc_bit, sc_bv, or resolved port types; sc_logic and sc_lv port types are generated by default. Syntax scgenmod [-help] [-lib <library_name>] [-map "<hdl_type>=<sc_type>"] [-createtemplate] <module_name> Arguments -createtemplate Creates a class template declaration of a foreign module with integer template arguments corresponding to the integer parameter/generic defined in the VHDL or Verilog module. Ports in VHDL and Verilog modules instantiated from SystemC can now have their range specified in terms of integer parameters/generics. Such port ranges will be specified in terms of the template arguments of the foreign module. -help Displays the commands options and arguments. Optional. -lib <library_name> Specifies the pathname of the working library. If not specified, the default library work is used. Optional. -map "<hdl_type>=<sc_type>" Specifies the user defined type mappings between either SystemVerilog or VHDL and SystemC types. <hdl_type> is the supported SystemVerilog or VHDL types . <sc_type> is the supported SystemC types. No spaces are allowed. Optional. SystemVerilog supported types: scalar (Verilog scalar), vector (Verilog vector), bit, logic, reg, bitvector (signed/unsigned, packed/unpacked bit vector), logicvector (signed/unsigned, packed/unpacked logic vector), regvector (signed/unsigned, packed/unpacked logic vector), integer, integer unsigned, int, int unsigned, shortint, shortint unsigned, longint, longint unsigned, byte, byte unsigned, struct (including fields with multidimensional arrays) VHDL supported types: bit, bit_vector, enum, record (including nested records and fields with multidimensional arrays), std_logic, std_logic_vector, vl_logic, vl_logic_vector SystemC supported types: bool, sc_bit, sc_logic, sc_bv, sc_lv, short, unsigned short, int, unsigned int, long, unsigned long, long long, unsigned long long, sc_int, sc_signed, sc_unsigned, sc_bigint, sc_biguint, char, unsigned char
334
Commands scgenmod
Note VHDL/SystemVerilog ports of type multi-dimensional array get converted to SystemC signal arrays in the generated foreign module declaration. <module_name> Specifies the name of the Verilog/VHDL module to be accessed. Required.
Obsolete for the Current Release
The following options have become obsolete. As of the 6.3 release, the types are mapped automatically according to the specifications given to the -map argument. -sc_bit Causes scgenmod to generate sc_bit scalar port types. Obsolete. See the -map argument. -bool Causes scgenmod to generate boolean scalar port types. Obsolete. See the -map argument. -sc_logic Causes scgenmod to generate sc_logic scalar port types. Obsolete. See the -map argument. -sc_resolved Causes scgenmod to generate resolved scalar port types. Obsolete. See the -map argument. -sc_bv Causes scgenmod to generate sc_bv<N> vector port types. Obsolete. See the -map argument. -sc_int Causes scgenmod to generate sc_int<N> vector port types. Obsolete. See the -map argument. -sc_lv Causes scgenmod to generate sc_lv<N> vector port types. Obsolete. See the -map argument. -sc_rv Causes scgenmod to generate resolved vector port types. Obsolete. See the -map argument. -sc_uint Causes scgenmod to generate sc_uint<N> port types. Obsolete. See the -map argument. Examples This example uses a Verilog module that is compiled into the work library. The module begins as Verilog source code:
335
Commands scgenmod module vcounter (clock, topcount, count); input clock; input topcount; output count; reg count; ... endmodule
After compiling using vlog, you invoke scgenmod on the compiled module with the following command:
scgenmod vcounter
The SystemC foreign module declaration for the above Verilog module is:
class vcounter : public sc_foreign_module { public: sc_in<sc_logic> clock; sc_in<sc_logic> topcount; sc_out<sc_logic> count; vcounter(sc_module_name nm), : sc_foreign_module(nm, hdl_name), clock("clock"), topcount("topcount"), count("count") {elaborate_foreign_module(hdl_hame);} ~vcounter() {} };
See also SystemC Simulation, sccom
336
Commands sdfcom
sdfcom
The sdfcom command compiles the specified SDF file. Compiled SDF files can dramatically improve performance in cases where the same SDF file is used for multiple simulation runs. This command compiles SDF files such that the annotation is compatible with the vsim -v2k_int_delays command. Refer to Compiling SDF Files for more information. SDF compilation works only with pure Verilog regions. Syntax sdfcom [-delayscale <value>] [-maxdelays] [-mindelays] [-nocompress] [-typdelays] <source_file> <output_file> Arguments -delayscale <value> Scales delays by the specified value. Optional. If you use this argument during SDF compilation, do not use the scaling option when reading in the SDF file with vsim. If you do so, the delays will be scaled twice. -maxdelays Selects maximum delays from SDF delay values of the form (min:typ:max). Optional. -mindelays Selects minimum delays from SDF delay values of the form (min:typ:max). Optional. -nocompress Produces a compiled file that is not compressed with gzip. Optional. By default the compiled file is compressed with gzip (even though the resulting file does not have the usual ".gz" extension). -typdelays Selects typical delays from SDF delay values of the form (min:typ:max). Optional. Default. <source_file> Specifies the SDF file to compile. Required. <output_file> Specifies the name for the compiled SDF file. Required. See also vsim -sdftyp
337
Commands search
search
The search command searches the specified window for one or more objects matching the specified pattern(s). The search can be continued using the next command. The search starts at the object currently selected, if any; otherwise it starts at the window top. The default action is to search downward until the first match, then move the selection to the object found, and return the index of the object found. Returns the index of a single match, or a list of matching indices. Returns nothing if no matches are found. Syntax search <window_name> [-window <wname>] [-all] [-field <n>] [-toggle] [-forward | -backward] [-wrap | -nowrap] [-exact] [-regexp] [-nocase] [-count <n>] <pattern> Arguments for all windows <window_name> Specifies the window in which to search. Can be one of Signals, Objects, Variables, Locals, Source, List, Wave, Process, Structure, or a unique abbreviation thereof. Required. -window <wname> Specifies an instance of the window that is not the default. Optional. Otherwise, the default window is used. Use the view command to change the default window. -forward Search in the forward direction. Optional. This is the default. -backward Search in the reverse direction. Optional. Default is forward. <pattern> String or glob-style wildcard pattern. Required. Must be the last argument specified. Arguments, for all EXCEPT the Source window -all Finds all matches and returns a list of the indices of all objects that match. Optional. -field <n> Selects different fields to test, depending on the window type: Table 2-5. Field Arguments for Window Searches Window structure signals
338
n=1 instance name
n=2 entity/module -
n=3 architecture cur. value
default instance name
Commands search
Table 2-5. Field Arguments for Window Searches (cont.) Window process variables wave list n=1 status name name label n=2 process label fullname n=3 fullpath cur. value cur. value default fullpath name name label
Default behavior for the List window is to attempt to match the label and if that fails, try to match the full signal name. -toggle Adds objects found to the selection. Does not do an initial clear selection. Optional. Otherwise deselects all and selects only one object. -wrap Specifies that the search continue from the top of the window after reaching the bottom. Optional. This is the default. -nowrap Specifies that the search stop at the bottom of the window and not continue searching at the top. Optional. The default is to wrap. Arguments, Source window only -exact Search for an exact match. Optional. -regexp Use the pattern as a Tcl regular expression. Optional. -nocase Ignore case. Optional. Default is to use case. -count <n> Search for the nth match. Optional. Default is to search for the first match. Description With the -all option, the entire window is searched, the last object matching the pattern is selected, and a Tcl list of all corresponding indices is returned. With the -toggle option, objects found are selected in addition to the current selection. For the List window, the search is done on the names of the objects listed, that is, across the header. To search for values of objects in the List window, use the down and up commands. Likewise, in the Wave window, the search is done on object names and values in the values
339
Commands search
column. To search for object values in the waveform pane of the Wave window, use the right and the left commands. You can also select Edit > Search in both windows. See also find, next, view
340
Commands searchlog
searchlog
The searchlog command searches one or more of the currently open logfiles for a specified condition. It can be used to search for rising or falling edges, for signals equal to a specified value, or for when a generalized expression becomes true. Syntax searchlog [-count <n>] [-deltas] [-env <path>] [-expr {<expr>}] [-reverse] [-rising | -falling | -anyedge] [-startDelta <num>] [-value <string>] <startTime> <pattern> Description If at least one match is found, it returns the time (and optionally delta) at which the last match occurred and the number of matches found, in a Tcl list:
{{<time>} <matchCount>}
where <time> is in the format <number> <unit>. If the -deltas option is specified, the delta of the last match is also returned:
{{<time>} <delta> <matchCount>}
If no matches are found, a TCL_ERROR is returned. If one or more matches are found, but less than the number requested, it is not considered an error condition, and the time of the farthest match is returned, with the count of the matches found. Arguments -count <n> Specifies to search for the nth occurrence of the match condition, where <n> is a positive integer. Optional. -deltas Indicates to test for a match on simulation delta cycles. Otherwise, matches are only tested for at the end of each simulation time step. Optional. -env <path> Provides a design region in which to look for the signal names. Optional. -expr {<expr>} Specifies a general expression of signal values and simulation time. Optional. searchlog will search until the expression evaluates to true. The expression must have a boolean result type. See GUI_expression_format for the format of the expression. -reverse Specifies to search backwards in time from <startTime>. Optional.
341
Commands searchlog
-rising | -falling | -anyedge Specifies an edge to look for on a scalar signal. Optional. This option is ignored for compound signals. If no options are specified, the default is -anyedge.
-startDelta <num> Indicates a simulation delta cycle on which to start. Optional. -value <string> Specifies to search until a single scalar or compound signal takes on this value. Optional. <startTime> Specifies the simulation time at which to start the search. Required. The time may be specified as an integer number of simulation units, or as {<num> <timeUnit>}, where <num> can be integer or with a decimal point, and <timeUnit> is one of the standard VHDL time units (fs, ps, ns, us, ms, sec).
<pattern> Specifies one or more signal names or wildcard patterns of signal names to search on. Required unless the -expr argument is used.
See also virtual signal, virtual log, virtual nolog
342
Commands see
see
The see command displays the specified number of source file lines around the current execution line. By default, five lines will be displayed before and four lines after. Syntax see [<n> | <pre> <post>] Arguments <n> Designates the number of lines to display before and after the current execution line. Optional. <pre> Designates the number of lines to display before the current execution line. Optional. <post> Designates the number of lines to display after the current execution line. Optional. Example Display 8 lines before and 6 lines after the current execution line.
see 8 6
343
Commands seetime
seetime
The seetime command scrolls the List or Wave window to make the specified time visible. For the List window, a delta can be optionally specified as well. Returns nothing Syntax seetime list | wave [-window <wname>] [-select] [-delta <num>] <time> Arguments list | wave Specifies the target window type. Required. -window <wname> Specifies an instance of the Wave or List window that is not the default. Optional. Otherwise, the default Wave or List window is used. Use the view command to change the default window. -select Also moves the active cursor or marker to the specified time (and optionally, delta). Optional. Otherwise, the window is only scrolled. -delta <num> For the List window when deltas are not collapsed, this option specifies a delta. Optional. Otherwise, delta 0 is selected. <time> Specifies the time to be made visible. Required.
344
Commands setenv
setenv
The setenv command changes or reports the current value of an environment variable. The setting is not persistentit is valid only for the current ModelSim session. Syntax setenv <varname> [<value>] Arguments <varname> The name of the environment variable you wish to set or check. Required. <value> The value for the environment variable. Optional. If you dont specify a value, ModelSim reports the variables current value. See also unsetenv, printenv
345
Commands shift
shift
The shift command shifts macro parameter values left one place, so that the value of parameter \$2 is assigned to parameter \$1, the value of parameter \$3 is assigned to \$2, etc. The previous value of \$1 is discarded. The shift command and macro parameters are used in macro files. If a macro file requires more than nine parameters, they can be accessed using the shift command. To determine the current number of macro parameters, use the argc variable. Syntax shift Arguments None
Description For a macro file containing nine macro parameters defined as $1 to $9, one shift command shifts all parameter values one place to the left. If more than nine parameters are named, the value of the tenth parameter becomes the value of $9 and can be accessed from within the macro file. See also do
346
Commands show
show
The show command lists HDL objects and subregions visible from the current environment. The objects listed include: VHDL signals, processes, constants, variables, and instances Verilog nets, registers, tasks, functions, instances, variables, and memories
If using C Debug, show displays the names and types of the local variables and arguments of the current C function. The show command returns formatted results to stdout. To eliminate formatting (to use the output in a Tcl script), use the Show command instead. Syntax show [-all] [<pathname>] Arguments -all Displays all names at and below the specified path recursively. Optional. <pathname> Specifies the pathname of the environment for which you want the objects and subregions to be listed. Optional; if omitted, the current environment is assumed. Examples List the names of all the objects and subregion environments visible in the current environment.
show
List the names of all the objects and subregions visible in the environment named /uut.
show /uut
List the names of all the objects and subregions visible in the environment named sub_region which is directly visible in the current environment.
show sub_region
See also environment, find
347
Commands simstats
simstats
The simstats command returns performance-related statistics about elaboration and simulation. The statistics measure the simulation kernal process (vsimk) for a single invocation of vsim. If you invoke vsim a second time, or restart the simulation, the current statistics are discarded and new values are collected. If executed without arguments, the command returns a list of pairs like the following:
{{elab memory} 0} {{elab working set} 7245824} {{elab time} 0.942645} {{elab cpu time} 0.190274} {{elab context} 0} {{elab page faults} 1549} {memory 0} {{working set} 0} {time 0} {{cpu time} 0} {context 0} {{page faults} 0}
The elaboration statistics are measured one time at the end of elaboration. The simulation memory statistics are measured at the time you invoke simstats. The simulation time statistics are updated at the end of each run command. See the arguments below for descriptions of each statistic. Units for time values are in seconds. Units for memory values vary by platform: For SunOS and Linux, the memory size is reported in Kbytes For Windows, the memory size is reported in bytes.
Some of the values may not be available on all platforms and other values may be approximates. Different operating systems report these numbers differently. Syntax simstats [memory | working | time | cpu | context | faults] Arguments memory Returns the amount of virtual memory that the OS has allocated for vsimk. Optional. working Returns the portion of allocated virtual memory that is currently being used by vsimk. Optional. If this number exceeds the actual memory size, you will encounter performance degradation. time Returns the cumulative "wall clock time" of all run commands. Optional. cpu Returns the cumulative processor time of all run commands. Optional. Processor time differs from wall clock time in that processor time is only counted when the cpu is actually running vsimk. If vsimk is swapped out for another process, cpu time does not increase.
348
Commands simstats
context Returns the number of context swaps (vsimk being swapped out for another process) that occurred during all run commands. Optional.
faults Returns the number of page faults that occurred during all run commands. Optional.
349
Commands status
status
The status command lists summary information about currently interrupted macros. If invoked without arguments, the command lists the filename of each interrupted macro, the line number at which it was interrupted, and prints the command itself. It also displays any onbreak or onerror commands that have been defined for each interrupted macro. Syntax status [file | line] Arguments file Reports the file pathname of the current macro. line Reports the line number of the current macro. Examples The transcript below contains examples of resume, and status commands.
VSIM(paused)> status # Macro resume_test.do at line 3 (Current macro) # command executing: "pause" # is Interrupted # ONBREAK commands: "resume" # Macro startup.do at line 34 # command executing: "run 1000" # processing BREAKPOINT # is Interrupted # ONBREAK commands: "resume" VSIM(paused)> resume # Resuming execution of macro resume_test.do at line 4
See also abort, do, pause, resume
350
Commands step
step
The step command steps to the next HDL or C statement. Current values of local HDL variables may be observed at this time using the Locals window. You can use the -over argument to skip over a VHDL procedures or functions, Verilog task or functions, or a C functions. When a wait statement or end of process is encountered, time advances to the next scheduled activity. ModelSim then updates the Process and Source windows to reflect the next activity. Syntax step [<n>] [-inst <full_path_name>] [-out] [-over [<n>] [<n>]] [-this "this==<class_handle>"] Arguments <n> (optional) Instructs the simulation to execute n steps before returning, where <n> is any positive integer. -inst <full_path_name> (optional) Instructs the simulation to step into a specific instance, process, or thread, as identified by <full_path_name>. -out (optional) Instructs the simulation to step out of the current function or procedure and return to the caller. -over [<n>] (optional) Directs ModelSim to run VHDL procedures and functions, Verilog tasks and functions, and C functions but to treat them as simple statements instead of entering and tracing them line by line. If you are using C Debug, specifying a positive integer value for <n> moves the debugger n lines ahead. -this "this==<class_handle>" (optional) Instructs the simulation to step into a System Verilog class, as identified by <class_handle>. To obtain the handle of the class, use the examine -handle command. Note that you must use quotation marks (") with this argument. See also run
351
Commands stop
stop
The stop command is used with the when command to stop simulation in batch files. The stop command has the same effect as hitting a breakpoint. The stop command may be placed anywhere within the body of the when command. Syntax stop Arguments None.
Description Use the run command with the -continue option to continue the simulation run, or the resume command to continue macro execution. If you want macro execution to resume automatically, put the resume command at the top of your macro file:
onbreak {resume}
Note If you want to stop the simulation using a when command, you must use a stop command within your when statement. DO NOT use an exit command or a quit command. The stop command acts like a breakpoint at the time it is evaluated. See also bp, resume, run, when
352
Commands suppress
suppress
The suppress command prevents the specified message(s) from displaying. You cannot suppress Fatal or Internal messages. The suppress command used without arguments will return the message numbers of all suppressed messages. Edit the suppress variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information. Syntax suppress [-clear <msg_number>[,<msg_number>,...]] [<msg_number>[,<msg_number>,]] Arguments -clear <msg_number>[,<msg_number>,...] Clears message suppression of the message (or messages) designated by the message number (or numbers). Optional. <msg_number>[,<msg_number>,...] The number (or numbers) preceding the message (or messages) you wish to suppress. At least one message number is required. Optional. Examples Return the message numbers of all suppressed messages:
suppress
Suppress designated messages:

suppress 8241,8242,8243,8446,8447
Clear message suppression for the designated messages:

suppress -clear 8241,8242
Return the message numbers of all suppressed messages and clear suppression for all:
suppress -clear [suppress]
353
Commands tb
tb
The tb (traceback) command displays a stack trace for the current process in the Transcript pane. This lists the sequence of HDL function calls that have been entered to arrive at the current state for the active process. If you are using C Debug, tb displays a stack trace of the C call stack. Syntax tb [<#_of_levels>] Arguments <#_of_levels> Specifies the number of call frames in the C stack to display. Optional. If you dont specify a level, the entire C stack is displayed. This argument is available only for C Debug.
354
Commands tcheck_set
tcheck_set
The tcheck_set command works in tandem with tcheck_status to report on and enable/disable individual timing checks. tcheck_set modifies either a check's reporting or X-generation status and reports the new setting in the Transcript pane. Disabling a timing check's reporting prevents generation of associated violation messages. For Verilog modules this means ModelSim disables message reporting. For VHDL design units this means ModelSim sets the MsgOn parameter in a VITAL timing check procedure (TCP) to FALSE. Disabling a timing check's X generation removes a timing checks ability to affect the outputs of the simulation. For Verilog modules this means ModelSim toggles the timing check's notifier. For VHDL design units this means ModelSim sets the Xon parameter in a VITAL TCP to FALSE. tcheck_set does not override the effects of invoking vlog or vsim with the +nospecify, +notimingchecks, or +no_neg_tchk arguments. tcheck_set can override the effects of invoking vsim with the +no_notifier, +no_tchk_msg, -g, or -G arguments. These latter arguments establish initial values for the simulation, and those values can be modified by tcheck_set. If a design has been compiled by vlog with the -nodebug argument, no timing checks placed in the design using tcheck_set are visible with the tcheck_status command. Keep in mind the following if you are using VHDL VITAL: VITAL does not provide the granularity to set individual period or width checks. These checks are part of a single VITAL TCP, and tcheck_set toggles MsgOn and Xon for all checks in the TCP. See "Examples" below for further information. If an instance is not Level-1 optimized, you cannot set values for individual TCPs. You can set values only for the entire instance. tcheck_status reports "ALL" for instances that arent Level-1 optimized. See "Examples" below for further information.
Syntax tcheck_set <instance> [-quiet] [-r | <tcheck>] [<Stat> | <MsgStat> <XStat>] Arguments <instance> Specifies the instance for which you want to change the reporting or X-generation status. Required. -quiet Suppresses printing the new setting to the Transcript pane. Optional. -r Attempts to change all checks on this instance and instances below this instance. Optional.
355
Commands tcheck_set
<tcheck> Specifies a specific timing check to change. Optional. If you dont specify <tcheck> or -r, or you specify ALL for <tcheck>, ModelSim attempts to apply the change to all timing checks in the instance. You can specify either the integer that is assigned to each timing check (and reported via tcheck_status) or the actual timing check name enclosed in double quotes (see "Examples" below). Note that the integer number may change between library compiles.
<Stat> Enables/disables both X generation and violation message reporting for the specified timing check(s). Optional. Specify either ON (enable) or OFF (disable).
<MsgStat> Enables/disables violation message reporting for the specified timing check(s). Optional. Specify either ON (enable) or OFF (disable).
<XStat> Enables/disables X generation for the specified timing check(s). Optional. Specify either ON (enable) or OFF (disable).
Examples Turn off message reporting and X generation for the "(WIDTH (negedge CLK))" check in instance top.y1.u2. These examples assume that your PathSeparator variable is set to "." rather than the default "/".
tcheck_set top.y1.u2 "( WIDTH (negedge CLK) )" OFF
Create the following output in the Transcript pane:

#0 ( WIDTH (negedge CLK) ) MsgOff XOff
Turn off message reporting for timing check number 1 in instance top.y1.u2.
tcheck_set top.y1.u2 1 OFF ON
Create the following output in the Transcript pane:

#1 ( WIDTH (posedge CLK) ) MsgOff XOn VSIM 2> tcheck_status dff1 # 1 ( PERIOD CLK ) MsgOn, XOn # ( WIDTH (posedge CLK) ) MsgOn, XOn # ( WIDTH (negedge CLK) ) MsgOn, XOn VSIM 3> tcheck_set dff1 "( WIDTH (posedge CLK) )" off on # 1 ( PERIOD CLK ) MsgOff, XOn # ( WIDTH (posedge CLK) ) MsgOff, XOn # ( WIDTH (negedge CLK) ) MsgOff, XOn
Show how period and hold checks work with VHDL VITAL. In this case, specifying "off on" for (WIDTH (posedge CLK)) also sets (PERIOD CLK) and (WIDTH (negedge CLK)) to the same values.
356
Commands tcheck_set VSIM 3> tcheck_status dff5 # ALL MsgOn XOn VSIM 4> tcheck_set dff5 on off # ALL MsgOn XOff
Instance dff5 is from an unaccelerated model so tcheck_set can only toggle message reporting and X generation for all checks on the instance. See also tcheck_status, Compiling and Simulating with Accelerated VITAL Packages, SDF Timing Annotation, Disabling Timing Checks, -g, -G, no_notifier, +no_tchk_msg, +nospecify, +no_neg_tchk, and +notimingchecks arguments to the vsim
357
Commands tcheck_status
tcheck_status
The tcheck_status command works in tandem with tcheck_set to report on and enable/disable individual timing checks. tcheck_status prints in the Transcript pane the current status of all timing checks in the instance or a specific timing check specified with the optional <tcheck> argument. Disabling a timing check's reporting prevents generation of associated violation messages. For Verilog modules this means ModelSim disables message reporting. For VHDL design units this means ModelSim sets the MsgOn parameter in a VITAL timing check procedure (TCP) to FALSE. Disabling a timing check's X generation removes a timing checks ability to affect the outputs of the simulation. For Verilog modules this means ModelSim toggles the timing check's notifier. For VHDL design units this means ModelSim sets the Xon parameter in a VITAL TCP to FALSE. Syntax tcheck_status [-lines] <instance> [<tcheck>] Arguments -lines Specifies that the HDL source file and line numbers of the check(s) be displayed. Optional. Has no effect on VHDL instances. Note that line information may not always be available. <instance> Specifies the instance for which you want timing check status reported. Required. <tcheck> Specifies a specific timing check within the instance on which to report status. Optional. By default ModelSim reports all timing checks within the specified instance. You can specify either the integer that is assigned to each timing check (and reported via tcheck_status) or the actual timing check name enclosed in double quotes (see "Examples" below). Note that the integer number may change between library compiles. Output The output of tcheck_status is displayed in the following form:
#<Number> <SDF_Description> [<src_line>] <MsgStat> <XStat>
358
Commands tcheck_status
Table 2-6 contains a short description of each field in the output. Table 2-6. Output Fields for tcheck_status Command Field <Number> Description an integer that can be used as shorthand to specify the check in the tcheck_status or tcheck_set commands (as the <tcheck> argument); this number can change with compiler optimizations, and you cant assume it will stay the same between library compiles an SDF specification of the timing check including enclosing parentheses ( )' the source file and line number for the timing check specification; output if you specify the -lines argument; the format of the object is <source_file_name>:<line_number>. violation message reporting status indicator MsgON/MsgOFF - violation reporting is enabled/disabled and unchangeable MsgOn/MsgOff - violation reporting is enabled/disabled and modifiable violation X generation status indicator XON/XOFF - X generation is enabled/disabled and unchangeable XOn/XOff - X generation is enabled/disabled and modifiable
<SDF_Description> <src_line>
<MsgStat>
<XStat>
Examples Create the following output:

tcheck_status top.y1.u2 #0 #1 #2 #3 ( ( ( ( WIDTH (negedge CLK) ) MsgOn XOn WIDTH (posedge CLK) ) MsgOn XOn SETUP (negedge D) (posedge CLK) ) MsgOFF XOFF HOLD (posedge CLK) (negedge D) ) MsgOn XOff
Create the following output:

tcheck_status -lines top.y1.u2 1 #1 ( WIDTH (posedge CLK) ) 'cell.v:224' MsgOn XOn
See also tcheck_set, SDF Timing Annotation
359
Commands Time
Time
There are several Time commands that allow you to perform comparisons between, operations on, and conversions of time values. Syntax eqTime <time1> <time2> Returns a 1 (true) or 0 (false) if <time1> and <time2> are equal. neqTime <time1> <time2> Returns a 1 (true) or 0 (false) if <time1> and <time2> are not equal. ltTime <time1> <time2> Returns a 1 (true) or 0 (false) if <time1> is less than <time2>. gtTime <time1> <time2> Returns a 1 (true) or 0 (false) if <time1> is greater than <time2>. lteTime <time1> <time2> Returns a 1 (true) or 0 (false) if <time1> is less than or equal to <time2>. gteTime <time1> <time2> Returns a 1 (true) or 0 (false) if <time1> is greater than or equal to <time2>. addTime <time1> <time2> Returns the value of adding <time1> to <time2> subTime <time1> <time2> Returns the value of subtracting <time2> from <time1> mulTime <time1> <integer> Returns the value of multiplying <time1> by an <integer> divTime <time1> <time2> Returns an integer, which is the value of dividing <time1> by <time2>. Specifying 0 for <time2> results in an error. intToTime <high_32bit_int> <low_32bit_int> Returns a 64-bit time value based on two 32-bit parts of a 64-bit integer. This command is useful when youve performed an integer calculation that results in a 64-bit value and need to convert it to a time unit. scaleTime <time1> <scale_factor> Returns a time value scaled by a real number and truncated to the current time resolution. RealToTime <real>
360
Commands Time
Returns a time value equivalent to the specified real number and truncated to the current time resolution. validTime <time> Returns a 1 (true) or 0 (false) if the given string is a valid time for use with any of these Time calculations. formatTime {+ | -} commas | {+ | -}nodefunit | {+ | -}bestunits Sets display properties for time values. Arguments <time> <number> the command assumes that the <time_unit> is the current simulation time unit, as defined by the Resolution variable in the modelsim.ini file or the -t switch to the vsim command. <number><time_unit> note that there is no space is between the values. <number> <time_unit> note that if you put a space between the values, you must enclose the argument in braces ({ }) or double-quotes ( " " ). <time_unit> fs femtosecond (10-15 seconds) ps picosecond (10-12 seconds) ns nanosecond (10-9 seconds) us microsecond (10-6 seconds) ms millisecond (10-3 seconds) sec second min minute (60 seconds) hr hour (3600 seconds) <high_32bit_int> | <low_32bit_int> <high_32bit_int> The "high" part of the 64-bit integer. <low_32bit_int> The "low" part of the 64-bit integer. <scale_factor> a real number to be used as scaling factor. Common values can include:
0.25, 0.5, 1.5, 2, 10, 100
{+ | -} commas controls whether commas are displayed in time values. +commas time values include commas -commas time values do not include commas
{+ | -}nodefunit controls whether time values display time units +nodefunit time values do not include time units and will be in current time resolution
361
Commands Time
-nodefunit time values may include time units {+ | -}bestunits controls whether time values display the largest possible time unit, for example 8 us instead of 8,000 ns. +bestunits time values display the largest possible time unit -bestunits time values display the default time unit Examples The following transcript shows examples of the Time commands and their output:
>ltTime 100ns 1ms # 1 >addTime {1545 ns} {455 ns} # 2 us >gteTime "1000 ns" "1 us" # 1 >divTime 1us 10ns # 100 >formatTime +bestunit >scaleTime 3ms 1000 # 3 sec >RealToTime 1.345e04 # 13450 ns
362
Commands toggle add
toggle add
The toggle add command enables collection of toggle statistics for the specified nodes. The allowed nodes are Verilog nets and registers and VHDL signals of type bit, bit_vector, std_ulogic, std_logic, and std_logic_vector (other types are silently ignored). You can also collect and view toggle statistics in the ModelSim GUI. Refer to Coverage for details. Note The toggle coverage feature is available as an add-on to ModelSim PE, LE, and Designer.
Syntax toggle add [-exclude {<list>}] [-countlimit] [-full] [-in] [-inout] [-internal] [-out] [-ports] [-r] [-unique] [-widthlimit] <node_name> Returns
Command result no signals are added and no signals are found to be already in the toggle set no signals are added and some signals are found to be already in the toggle set some signals are added Arguments -exclude {<list>}
Return value Nothing added. 0 the number of bits added
Excludes specified bits of a bus from toggle computations and reports. Can also be used to exclude specific VHDL or SystemVerilog enums or ranges of enums from toggle coverage and reporting. Optional. <list> is a space-separated list of integers or ranges, where a range is two integers separated by either ":" or "-". The range must be in the same ascending or descending order as the signal declaration. If a second toggle add -exclude command is issued on the same signal, the latest command will override the earlier one. -countlimit Limits the toggle coverage count for a toggle node. Optional. Overrides the global default value set by the ToggleCountLimit modelsim.ini variable. -full Enables extended mode toggle coverage, which tracks the following six transitions:
363
Commands toggle add o o o o o o
1 or H --> 0 or L 0 or L --> 1 or H Z --> 1 or H Z --> 0 or L 1 or H --> Z 0 or L --> Z
Optional. By default only the first two transitions to and from 0 and to and from1 are counted. If you do a toggle add command on a group of signals and then try to convert to extended toggle coverage mode (all six transitions) by doing toggle add -full on the same signals, nothing will change. The only way to change the internal toggle triggers from default to extended toggle coverage is to restart vsim and start with the correct command. -in Enables toggle statistics collection on nodes of mode IN. Optional. -inout Enables toggle statistics collection on nodes of mode INOUT. Optional. -internal Enables toggle statistics collection on internal (non-port) objects. Optional. -out Enables toggle statistics collection on nodes of mode OUT. Optional. -ports Enables toggle statistics collection on nodes of modes IN, OUT, or INOUT. Optional. -r Specifies that toggle statistics collection is enabled recursively into subregions. Optional. If omitted, toggle statistic collection is limited to the current region. -unique Reports an attempt to add a signal that is an alias to a signal already added. The alias will not be added. Optional. -widthlimit Limits the maximum width of signals included in toggle coverage for the specified node. Optional. Overrides the global default limit (128) set by the ToggleCountLimit modelsim.ini variable. <node_name> Enables toggle statistics collection for the named node(s). Required. Multiple names and wildcards are accepted.
364
Commands toggle add
Examples Enable toggle statistics collection for signal /dut/data/a.

toggle add /dut/data/a
Enable toggle statistics collection for bit 6 of bus /dut/data_in. The curly braces must be added in order to escape the square brackets ([])
toggle add {/dut/data_in[5]}
See also Toggle Coverage, toggle disable, toggle enable, toggle report, toggle reset
365
Commands toggle disable
toggle disable
The toggle disable command disables toggle coverage statistics collection on the specified nodes. The command provides a method of implementing coverage exclusions for toggle coverage. An equivalent command for excluding toggles from coverage is coverage exclude togglenode. For information on disabling individual bits, see Excluding Bus Bits from Toggle Coverage in the Users Manual. Syntax toggle disable [-all] | [-in] [-out] [-inout] [-internal] [-ports] [-r] <node_name> Arguments -all Disables toggle statistics collection for all nodes that have toggle checking enabled. Optional. Must be used alone without other arguments. -in Disables toggle statistics collection on nodes of mode IN. Optional. -out Disables toggle statistics collection on nodes of mode OUT. Optional. -inout Disables toggle statistics collection on nodes of mode INOUT. Optional. -internal Disables toggle statistics collection on internal (non-port) objects. Optional. -ports Disables toggle statistics collection on nodes of modes IN, OUT, or INOUT. Optional. -r Specifies that toggle statistics collection is disabled recursively into subregions. Optional. If omitted, the disable is limited to the current region. <node_name> Disables toggle statistics collection for the named node(s). Required. Multiple names and wildcards are accepted. See also Toggle Coverage, toggle add, toggle enable, toggle report, toggle reset, coverage exclude
366
Commands toggle enable
toggle enable
The toggle enable command re-enables toggle statistics collection on nodes whose toggle coverage had previously been disabled. Syntax toggle enable [-all] | [-in] [-out] [-inout] [-internal] [-ports] [-r] <node_name> Arguments -all Enables toggle statistics collection for all nodes that have toggle checking disabled. Optional. Must be used alone without other arguments. -in Enables toggle statistics collection on disabled nodes of mode IN. Optional. -out Enables toggle statistics collection on disabled nodes of mode OUT. Optional. -inout Enables toggle statistics collection on disabled nodes of mode INOUT. Optional. -internal Enables toggle statistics collection on disabled internal (non-port) objects. Optional. -ports Enables toggle statistics collection on disabled nodes of modes IN, OUT, or INOUT. Optional. -r Specifies that toggle statistics collection is enabled recursively into subregions. Optional. If omitted, the enable is limited to the current region. <node_name> Enables toggle statistics collection for the named node(s). Required. Multiple names and wildcards are accepted. See also Toggle Coverage, Managing Toggle Exclusions, toggle add, toggle disable, toggle report, toggle reset, coverage exclude
367
Commands toggle report
toggle report
The toggle report command displays a list of all unique nodes that have not transitioned to both 0 and 1 at least once, and the counts for how many times each node toggled for each state transition type. Also displayed is a summary of the number of nodes checked, the number that toggled, the number that didn't toggle, and a percentage that toggled. You can also collect and view toggle statistics in the ModelSim GUI. Refer to Coverage for details. The toggle report command is intended to be used as follows: 1. Enable statistics collection with the toggle add command. 2. Run the simulation with the run command. 3. Produce the report with the toggle report command. Note If you want to ensure that you are reporting all signals in the design, use the -nocollapse argument to vsim when you load your design. Without this argument, the simulator collapses certain ports that are connected to the same signal in order to improve performance, and those collapsed signals will not appear in the report. The -nocollapse argument degrades simulator performance, so it should be used only when it is absolutely necessary to see all signals in a toggle report. Ordering of toggle nodes The ordering of nodes in the report may vary depending on how you specify the signal list. If you use a wildcard in the signal argument (e.g., toggle report -all -r /*), the nodes are listed in the order signals are found when searching down the context tree using the wildcard. Multiple elements of the same net will be listed multiple times. If you do not use a wildcard (e.g., toggle report -all -r /*), the nodes are listed in the order in which they were originally added to toggle coverage, and elements are not duplicated. Syntax toggle report [-all] [-file <filename>] [-select { inputs | outputs | inout | ports | internals }] [-instance <path> [-recursive]] [-onexit] [<signal>] [-summary] [-top] [-verbose] Arguments -all Lists all nodes, both toggled and untoggled. Optional. -file <filename> Specifies a file to which to write the report. By default the report is displayed in the Transcript pane. Optional.
368
Commands toggle report
-select { inputs | outputs | inout | ports | internals } Reports on input, output, inout, all ports, or internal signals. Optional. -instance <path> [-recursive] Reports on toggles for a specified instance, and optionally on toggles under the specified instance path. Optional. The optional -recursive argument specifies that toggle statistics reporting is enabled recursively into subregions. If omitted, toggle statistic reporting is limited to the current region.
-onexit Causes ModelSim to report toggle data automatically when the simulator exits. Optional. <signal> Specifies the name of a signal whose toggle statistics are to be displayed. Multiple signal names, separated by spaces, may be specified. Wildcards may be used.
-summary Selects only the summary portion of the report. Optional. -top For signals that were added to toggle coverage using vcom or vlog -cover t, -top uses the name of the top-most element of multiple-segment (collapsed) nets. Optional. By default the name of the wildcard-matching segment will be used.
-unique This option is obsolete with version 6.3. By default, toggles are always unique. -verbose Specifies that the toggle report includes all values taken on by integer variables. Optional.
See also Toggle Coverage, toggle add, toggle disable, toggle enable, toggle reset
369
Commands toggle reset
toggle reset
The toggle reset command resets the toggle counts to zero for the specified nodes. Syntax toggle reset [-all] | [-in] [-out] [-inout] [-internal] [-ports] [-r] <node_name> Arguments -all Resets toggle statistics collection for all nodes that have toggle checking enabled. Optional. Must be used alone without other arguments. -in Resets toggle statistics collection on nodes of mode IN. Optional. -out Resets toggle statistics collection on nodes of mode OUT. Optional. -inout Resets toggle statistics collection on nodes of mode INOUT. Optional. -internal Resets toggle statistics collection on internal (non-port) objects. Optional. -ports Resets toggle statistics collection on nodes of modes IN, OUT, or INOUT. Optional. -r Specifies that toggle statistics collection is reset recursively into subregions. Optional. If omitted, the reset is limited to the current region. <node_name> Resets toggle statistics collection for the named node(s). Required. Multiple names and wildcards are accepted. See also Toggle Coverage, toggle add, toggle disable, toggle enable, toggle report
370
Commands tr color
tr color
The tr color command changes the color scheme of individual transactions and entire streams, either in a specific wave window or for all wave windows. It is the command equivalent of the Colors tab in the Transaction-Stream Properties dialog. <color> in the arguments specifies the color to use. Either a standard X Window color name or an RGB value (e.g., #357f77) is accepted; multi-word names (light blue) in quotes. If no arguments are specified, this command returns the value of each configuration item in a Tcl list. Unique abbreviations are accepted for all arguments. Syntax tr color -stream <stream> [<stream>] ... [-attrbg <color>] [-attrtext <color>] [-border <color>] [-color <color>] [-default] [-get] [-inactive <color>] [-namebg <color>] [-nametext <color>] [-win <wave>] tr color -transaction <uid> [<uid>] ... [-attrbg <color>] [-attrtext <color>] [-border <color>] [-color <color>] [-default] [-get] [-inactive <color>] [-namebg <color>] [-nametext <color>] [-win <wave>] Arguments -attrbg <color> Select the color to use as the background for all attributes. Optional. See <color>. -attrtext <color> Select the color to use for attribute text. Optional. -border <color> Select the border color. Optional. -color <color> Select the background color for the transaction. All other colors are chosen automatically. Optional. <color> Specifies the color to use. Either a standard X Window color name or an RGB value (e.g., #357f77) is accepted; multi-word names (light blue) in quotes. -default Removes any color overrides on the specified streams or transactions. Optional. If present, this option takes precedence over any other option that sets color.
371
Commands tr color
-get Indicates that the command should return a list of the color schemes for each transaction or stream. Optional. If colors are changed by the command, this argument returns the resulting color scheme. Each scheme is itself a Tcl list with the colors listed in the following order: inactive line, border line, name background, name text, attribute background, attribute text.
-inactive <color> Select the inactive-line color. Optional. -namebg <color> Select the color to use as the background for the transactions name. Optional. -nametext <color> Select the color for the transaction name. Optional. -stream <stream> [<stream>] ... If present, all objects specified in the tr color command are transaction streams. Either this argument or -transaction is required. <stream> is the path to a transaction stream. Multiple streams are allowed, and the <stream> need not immediately follow the -stream argument. No wildcards are allowed.
-transaction <uid> [<uid>] ... Specifies the Unique IDs (UID) of the transactions to configure. The UID consists of dataset name and the 64-bit serial number assigned during simulation, which can be determined using the tr uid command. <uid> can be specified either with full UID or just the serial number. If only the serial number is present, the current dataset as returned by the env command is assumed. If the full UID is used, it must be surrounded by curly braces ({}). Multiple ID specifications are allowed, and the <uid> need not immediately follow the transactionn argument. No wildcards are allowed. Either -transaction or -stream is required.
-win <wave> If present, this option specifies the wave window for which the changes should apply. <wave> is the Tk name (not the title) for the wave window pane. Any color changes to specific transactions take precedence over color changes to the streams carrying those transactions. You can change the scheme for the associated streams and not change those transactions. To remove color changes on specific transactions, use the default option. The selected transactions would then reflect the color scheme of the stream.
Examples
372
Set colors for the name and background for a specified transaction stream:
tr color -stream -namebg light blue -nametext black /path/tr03
Set the color of the border for a specified transaction:

Commands tr color tr color -transaction -border #357f77 {sim 10023}
See also Recording and Viewing Transactions, tr uid, tr order
373
Commands tr order
tr order
The tr order command controls which attributes are visible and the order in which they appear. It applies to entire streams only, either in a specific wave window or for all wave windows. It is the command equivalent of the Order tab in the Transaction-Stream Properties dialog. This command functions to either: specify which attributes are visible and the order of those attributes (using -attributes and -default) display the attribute order and visibility settings (using -hidden and -visible).
Because two streams may have different attributes or the same attributes in different order, this command resolves the differences when setting the attribute order and visibility. When you set the order with -attributes, only attributes applying to a specific stream are visible. All other attributes for that stream are hidden. Names not matching actual attributes are ignored for that stream. When restoring the original order with -default, each stream returns to its original order and visibility which may be different from that of another stream in the command line. Unique abbreviations are accepted for all arguments. Syntax tr order [-attributes <attrs>] [-default] [-win <wave>] <stream> [<stream>] ... tr order [-hidden] [-visible] [-win <wave>] {<stream> [<stream>] ...} Arguments -attributes <attrs> Specifies that the attributes for the specified stream(s) should be visible. All other attributes are hidden. Optional. The order of the list determines the order of the attributes listed. <attrs> is a Tcl list of attribute names. Use {} to specify that there should be no visible attributes. -default Removes any visibility and order overrides on the specified streams or transactions. Optional. If present, this option takes precedence over the attributes option. -hidden Return a list of the hidden attributes for each stream or transaction specified. Optional. If -visible is set, the hidden attributes are in a list following the visible attributes. -visible Return a list of the visible attributes for each stream or transaction specified. Optional. If -hidden is set, the visible attributes are in a list preceding the hidden attributes.
374
Commands tr order
-win <wave> If present, this option specifies the wave window for which the changes should apply. <wave> is the Tk name (not the title) for the wave window pane for which the changes apply.
<stream> [<stream>] ... The path to a transaction stream. Multiple streams are allowed. No wildcards are allowed. The tr order command requires either a stream or unique ID.
Examples Set the order in which attributes appear in the wave window for a specified transaction stream:
tr order -attr attr1 attr2 attr3 /path/tr03
Returns the attribute order for the top/stream stream to the default order:
tr order -default /top/stream
Sets the visibility for attributes of the transaction stream /top/stream2:

tr order -visible attr1 -hidden attr2 top/stream2
Displays a Tcl list of visible attributes, followed by the hidden attributes. See also Recording and Viewing Transactions, tr uid, tr color
375
Commands tr uid
tr uid
The tr uid command returns a list of unique transaction IDs for the specified time span on the specified streams. A transactions UID is the logical name of its dataset and its a 64-bit serial number created during simulation. Usage: the returned UIDs can be passed to the tr color command to specify a particular transaction. The returned UIDs represent transactions that are ACTIVE during the time span. If a transaction starts anywhere in the time span, at the start of the span or even at the end of the span, it is considered active. A transaction that ends at the start time is not active. The optional arguments in this command apply either to a: listing of transactions occurring over a large range of time (using -end and -start) listing of transactions that are active at one specific time (using -time)
Unique abbreviations are accepted for all arguments. Syntax tr uid -start <time> -end <time> <stream> [<stream>] ... tr uid -time <time> <stream> [<stream>] ... Arguments -end <time> Specifies the end of the time range for the command. Required unless -time is specified. Must be used in conjunction with the -start argument. <time> Indicates time, or time and delta. -start <time> Specifies the start of the time range for the command. Required in conjunction with the -end option, unless -time is specified. -time <time> Specifies both the start and end of the time range for the command. Required unless -end and -start are specified. <stream> [<stream>] ... The path to a transaction stream. Required. May specify more than one stream. No wildcards are allowed. Examples List all transaction UIDs for a specified transaction stream:
376
Commands tr uid tr uid /path/tr03
List the transaction UID for a specified transaction stream at a particular time:
tr uid -time 20ns {sim 209456}
See also Recording and Viewing Transactions, tr color, tr order
377
Commands transcribe
transcribe
The transcribe command displays a command in the Transcript pane, and then executes the command. The transcribe command is normally used to direct commands to the Transcript pane from an external event such as a menu pick or button selection. The add button and add_menuitem commands can utilize transcribe. Returns nothing. Syntax transcribe <command> Arguments <command> Specifies the command to execute. Required. Examples Create a button labeled "pwd" that invokes transcribe with the pwd Tcl command, and echoes the command and its results to the Transcript pane. The button remains active during a run.
add button pwd {transcribe pwd} NoDisable
See also add button, add_menuitem
378
Commands transcript
transcript
The transcript command controls echoing of commands executed in a macro file. If no option is specified, the current setting is reported. Syntax transcript [on | off | -q | quietly] Arguments on Specifies that commands in a macro file will be echoed to the Transcript pane as they are executed. Optional. off Specifies that commands in a macro file will not be echoed to the Transcript pane as they are executed. Optional. The transcribe command can be used to force a command to be echoed. -q Returns "0" if transcripting is turned off or "1" if transcripting is turned on. Useful in a Tcl conditional expression. Optional. quietly Turns off the transcript echo for all commands. To turn off echoing for individual commands see the quietly command. Optional. Examples Commands within a macro file will be echoed to the Transcript pane as they are executed.
transcript on
If issued immediately after the previous example, the message:

transcript Macro transcripting is turned ON.
appears in the Transcript pane. See also Transcript Window, echo, transcribe, .main clear
379
Commands transcript file
transcript file
The transcript file command sets or queries the pathname for the transcript file. You can use this command to clear a transcript in batch mode or to limit the size of a transcript file. It offers an alternative to setting the PrefMain(file) Tcl preference variable. Syntax transcript file [<filename>] Arguments <filename> Specifies the full path and filename for the transcript file. Optional. If you specify a new file, the existing transcript file is closed and a new transcript file opened. If you specify an empty string (""), the existing file is closed and no new file is opened. If you dont specify this argument, the current setting is returned. Examples Close the current transcript file and stops writing data to the file. This is a method for reducing the size of your transcript.
transcript file ""
This series of commands results in the transcript containing only data from the second millisecond of the simulation. The first transcript file command closes the transcript so no data is being written to it. The second transcript file command opens a new transcript and records data from 1 ms to 2 ms.
transcript file "" run 1 ms transcript file transcript run 1 ms
See also Transcript Window, .main clear
380
Commands tssi2mti
tssi2mti
The tssi2mti command is used to convert a vector file in TSSI Format into a sequence of force and run commands. The stimulus is written to the standard output. The source code for tssi2mti is provided in the file tssi2mti.c in the examples directory. Syntax tssi2mti <signal_definition_file> [<sef_vector_file>] Arguments <signal_definition_file> Specifies the name of the TSSI signal definition file describing the format and content of the vectors. Required. <sef_vector_file> Specifies the name of the file containing vectors to be converted. If none is specified, standard input is used. Optional. Examples The command will produce a do file named trigger.do from the signal definition file trigger.def and the vector file trigger.sef.
tssi2mti trigger.def trigger.sef > trigger.do
This example is the same as the previous one, but uses the standard input instead.
tssi2mti trigger.def < trigger.sef > trigger.do
See also force, run, write tssi
381
Commands typespec
typespec
The typespec command queries class names and class relationships of SystemVerilog classes. Syntax typespec [-isa <value>] [-class <value>] [-exact] [-regexp] [-ancestry] [-indent <value>] <pattern> Arguments -isa <value> Returns classes derived from the given <value> -class <value> Returns specialized classes of the given <value> -exact Returns results that match the given <pattern> exactly. -regexp Specifies that all <value> arguments should be treated as regular expressions. -ancestry Returns the ancestry for the classes matching the criteria. -indent <value> Prefixes the results with the given <value>. <pattern> The pattern you are querying for.
382
Commands ui_VVMode
ui_VVMode
The ui_VVMode command specifies the products behavior when encountering UI registration calls used by verification packages such as AVM or OVM. Syntax ui_VVMode {off | nolog | full} Arguments off Disables context registration and automatic logging when encountering UI registration calls. nolog Enables the context registration of the UI registration call, but does not automatically log the registration to the WLF file. full Enables the context registration of the UI registration call and automatically logs the registration to the WLF file. Description UI registration calls, Verilog system tasks specific to this product, are typically included in verification packages such as AVM and OVM so that key information about the packages is available when debugging the simulation. The UI registration calls include: $ui_VVInstallInst() Defines a region in the context tree, which will appear in the Structure window. $ui_VVInstallObj() Adds an object to the defined parent, which will appear in the Objects window when the parent instance is selected in the Structure window. $ui_VVInstallPort() Adds a port that is an object that connects to another component, which will appear in the Objects window when the parent instance is selected in the Structure window. $ui_VVSetFilter() Specifies which class properties should not be shown in the GUI. $ui_VVSetAllow() Specifies which class properties should be retained that were filtered out with $ui_VVSetFilter.
383
Commands unsetenv
unsetenv
The unsetenv command deletes an environment variable. The deletion is not permanentit is valid only for the current ModelSim session. Syntax unsetenv <varname> Arguments <varname> The name of the environment variable you wish to delete. Required. See also setenv, printenv
384
Commands up
up
The up command searches for object transitions or values in the specified List window. It executes the search on objects currently selected in the window, starting at the time of the active cursor. The active cursor moves to the found location. Use this command to move to consecutive transitions or to find the time at which an object takes on a particular value, or an expression of multiple objects evaluates to true. See the down command for related functionality. The procedure for using up includes three steps: click on the desired object; click on the desired starting location; issue the up command. (The seetime command can initially position the cursor from the command line, if desired.) Returns: <number_found> <new_time> <new_delta> Syntax up [-expr {<expression>}] [-falling] [-noglitch] [-rising] [-value <sig_value>] [-window <wname>] [<n>] Arguments -expr {<expression>} The List window will be searched until the expression evaluates to a boolean true condition. Optional. The expression may involve more than one object, but is limited to objects that have been logged in the referenced List window. An object may be specified either by its full path or by the shortcut label displayed in the List window. See GUI_expression_format for the format of the expression. The expression must be placed within curly braces. -falling Searches for a falling edge on the specified object if that object is a scalar. If it is not a scalar, the option will be ignored. Optional. -noglitch Specifies that delta-width glitches are to be ignored. Optional. -rising Searches for a rising edge on the specified object if that object is a scalar. If it is not a scalar, the option will be ignored. Optional. -value <sig_value> Specifies a value of the object to match. Optional. Must be specified in the same radix in which the selected object is displayed. Case is ignored, but otherwise must be an exact string match don't-care bits are not yet implemented.
385
Commands up
-window <wname> Specifies an instance of the List window that is not the default. Optional. Otherwise, the default List window is used. Use the view command to change the default window.
<n> Specifies to find the nth match. Optional. If less than n are found, the number found is returned with a warning message, and the marker is positioned at the last match.
Examples Find the last time at which the selected vector transitions to FF23, ignoring glitches.up
-noglitch -value FF23
Go to the previous transition on the selected object.

up
The following examples illustrate search expressions that use a variety of signal attributes, paths, array constants, and time variables. Such expressions follow the GUI_expression_format. Search up for an expression that evaluates to a boolean 1 when signal clk just changed from low to high and signal mystate is the enumeration reading and signal /top/u3/addr is equal to the specified 32-bit hex constant.
up -expr {clkrising && (mystate == reading) && (/top/u3/addr == 32habcd1234)}
Search up for an expression that evaluates to a boolean 1 when the upper 8 bits of the 32-bit signal /top/u3/addr equals hex ac.
up -expr {(/top/u3/addr and 32hff000000) == 32hac000000}
Search up for an expression that evaluates to a boolean 1 when logfile time is between 23 and 54 microseconds, clock just changed from low to high, and signal mode is enumeration writing.
up -expr {((NOW > 23 us) && (NOW < 54 us)) && clkrising && (mode == writing)}
See also GUI_expression_format, view, seetime, down
386
Commands vcd add
vcd add
The vcd add command adds the specified objects to a VCD file. The allowed objects are Verilog nets and variables and VHDL signals of type bit, bit_vector, std_logic, and std_logic_vector (other types are silently ignored). The command works with mixed HDL designs. All vcd add commands must be executed at the same simulation time. The specified objects are added to the VCD header and their subsequent value changes are recorded in the specified VCD file. By default all port driver changes and internal variable changes are captured in the file. You can filter the output using arguments detailed below. Related Verilog tasks: $dumpvars, $fdumpvars Syntax vcd add [-r] [-in] [-out] [-inout] [-internal] [-ports] [-file <filename>] [-dumpports] <object_name> ... Arguments -r Specifies that signal and port selection occurs recursively into subregions. Optional. If omitted, included signals and ports are limited to the current region. -in Includes only port driver changes from ports of mode IN. Optional. -out Includes only port driver changes from ports of mode OUT. Optional. -inout Includes only port driver changes from ports of mode INOUT. Optional. -internal Includes only internal variable or signal changes. Excludes port driver changes. Optional. -ports Includes only port driver changes. Excludes internal variable or signal changes. Optional. -file <filename> Specifies the name of the VCD file. This option should be used only when you have created multiple VCD files using the vcd files command. -dumpports Specifies port driver changes to be added to an extended VCD file. Optional. When the vcd dumpports command cannot specify all port driver changes that will appear within the VCD file, multiple vcd add -dumpports commands can be used to specify additional port driver changes.
387
Commands vcd add
<object_name> ... Specifies the Verilog or VHDL object or objects to add to the VCD file. Required. Multiple objects may be specified by separating names with spaces. Wildcards are accepted.
See also Value Change Dump (VCD) Files. Verilog tasks are documented in the IEEE 1364 standard.
388
Commands vcd checkpoint
vcd checkpoint
The vcd checkpoint command dumps the current values of all VCD variables to the specified VCD file. While simulating, only value changes are dumped. Related Verilog tasks: $dumpall, $fdumpall Syntax vcd checkpoint [<filename>] Arguments <filename> Specifies the name of the VCD file. Optional. If omitted the command is executed on the file designated by the vcd file command or "dump.vcd" if vcd file was not invoked. See also Value Change Dump (VCD) Files, DumpportsCollapse Verilog tasks are documented in the IEEE 1364 standard.
389
Commands vcd comment
vcd comment
The vcd comment command inserts the specified comment in the specified VCD file. Syntax vcd comment <comment string> [<filename>] Arguments <comment string> Comment to be included in the VCD file. Required. Must be quoted by double quotation marks or curly braces. <filename> Specifies the name of the VCD file. Optional. If omitted the command is executed on the file designated by the vcd file command or "dump.vcd" if vcd file was not invoked. See also Value Change Dump (VCD) Files, DumpportsCollapse Verilog tasks are documented in the IEEE 1364 standard.
390
Commands vcd dumpports
vcd dumpports
The vcd dumpports command creates a VCD file that includes port driver data. By default all port driver changes are captured in the file. You can filter the output using arguments detailed below. Related Verilog task: $dumpports Syntax vcd dumpports [-compress] [-direction] [-file <filename>] [-in] [-inout] [-out] [-no_strength_range] [-unique] [-vcdstim] <object_name> ... Arguments -compress Produces a compressed VCD file. Optional. ModelSim uses the gzip compression algorithm. If you specify a .gz extension on the -file <filename> argument, ModelSim compresses the file even if you dont use the -compress argument. -direction Includes driver direction data in the VCD file. Optional. -file <filename> Specifies the path and name of a VCD file to create. Optional. Defaults to the current working directory and the filename dumpports.vcd. Multiple filenames can be opened during a single simulation. -in Includes ports of mode IN. Optional. -inout Includes ports of mode INOUT. Optional. -out Includes ports of mode OUT. Optional. -no_strength_range Ignores strength ranges when resolving driver values. Optional. This argument is an extension to the IEEE 1364 specification. Refer to Resolving Values for additional information. -unique Generates unique VCD variable names for ports even if those ports are connected to the same collapsed net. Optional. -vcdstim Ensures that port name order in the VCD file matches the declaration order in the instances module or entity declaration. Optional. Refer to Port Order Issues for further information.
391
Commands vcd dumpports
<object_name> ... Specifies the Verilog or VHDL object or objects to add to the VCD file. Required. Multiple objects may be specified by separating names with spaces. Wildcards are accepted.
Examples Create a VCD file named counter.vcd of all IN ports in the region /test_design/dut/.
vcd dumpports -in -file counter.vcd /test_design/dut/*
These two commands resimulate a design from a VCD file. Refer to Simulating with Input Values from a VCD File for further details.
vcd dumpports -file addern.vcd /testbench/uut/* vsim -vcdstim addern.vcd addern -gn=8 -do "add wave /*; run 1000"
This series of commands creates VCD files for the instances proc and cache and then resimulates the design using the VCD files in place of the instance source files. Refer to Replacing Instances with Output Values from a VCD File for more information.
vcd dumpports -vcdstim -file proc.vcd /top/p/* vcd dumpports -vcdstim -file cache.vcd /top/c/* run 1000 vsim top -vcdstim /top/p=proc.vcd -vcdstim /top/c=cache.vcd
See also Value Change Dump (VCD) Files, DumpportsCollapse Verilog tasks are documented in the IEEE 1364 standard.
392
Commands vcd dumpportsall
vcd dumpportsall
The vcd dumpportsall command creates a checkpoint in the VCD file which shows the value of all selected ports at that time in the simulation, regardless of whether the port values have changed since the last timestep. Related Verilog task: $dumpportsall Syntax vcd dumpportsall [<filename>] Arguments <filename> Specifies the name of the VCD file. Optional. If omitted the command is executed on all open VCD files. See also Value Change Dump (VCD) Files, DumpportsCollapse Verilog tasks are documented in the IEEE 1364 standard.
393
Commands vcd dumpportsflush
vcd dumpportsflush
The vcd dumpportsflush command flushes the contents of the VCD file buffer to the specified VCD file. Related Verilog task: $dumpportsflush Syntax vcd dumpportsflush [<filename>] Arguments <filename> Specifies the name of the VCD file. Optional. If omitted the command is executed on all open VCD files. See also Value Change Dump (VCD) Files, DumpportsCollapse
394
Commands vcd dumpportslimit
vcd dumpportslimit
The vcd dumpportslimit command specifies the maximum size of the VCD file (by default, limited to available disk space). When the size of the file exceeds the limit, a comment is appended to the file and VCD dumping is disabled. Related Verilog task: $dumpportslimit Syntax vcd dumpportslimit <dumplimit> [<filename>] Arguments <dumplimit> Specifies the maximum VCD file size in bytes. Required. <filename> Specifies the name of the VCD file. Optional. If omitted the command is executed on all open VCD files. See also Value Change Dump (VCD) Files, DumpportsCollapse Verilog tasks are documented in the IEEE 1364 standard.
395
Commands vcd dumpportsoff
vcd dumpportsoff
The vcd dumpportsoff command turns off VCD dumping and records all dumped port values as x. Related Verilog task: $dumpportsoff Syntax vcd dumpportsoff [<filename>] Arguments <filename> Specifies the name of the VCD file. Optional. If omitted the command is executed on all open VCD files. See also Value Change Dump (VCD) Files, DumpportsCollapse Verilog tasks are documented in the IEEE 1364 standard.
396
Commands vcd dumpportson
vcd dumpportson
The vcd dumpportson command turns on VCD dumping and records the current values of all selected ports. This command is typically used to resume dumping after invoking vcd dumpportsoff. Related Verilog task: $dumpportson Syntax vcd dumpportson [<filename>] Arguments <filename> Specifies the name of the VCD file. Optional. If omitted the command is executed on all open VCD files. See also Value Change Dump (VCD) Files, DumpportsCollapse Verilog tasks are documented in the IEEE 1364 standard.
397
Commands vcd file
vcd file
The vcd file command specifies the filename and state mapping for the VCD file created by a vcd add command. The vcd file command is optional. If used, it must be issued before any vcd add commands. Related Verilog task: $dumpfile Syntax vcd file [-dumpports] [-direction] [<filename>] [-map <mapping pairs>] [-no_strength_range] [-nomap] [-unique] Arguments -dumpports Capture detailed port driver data for Verilog ports and VHDL std_logic ports. Optional. This option works only on ports, and any subsequent vcd add command will accept only qualifying ports (silently ignoring all other specified objects). -direction Includes driver direction data in the VCD file. Optional. <filename> Specifies the name of the VCD file that is created (the default is dump.vcd). Optional. -map <mapping pairs> Affects only VHDL signals of type std_logic. Optional. It allows you to override the default mappings. The mapping is specified as a list of character pairs. The first character in a pair must be one of the std_logic characters UX01ZWLH- and the second character is the character you wish to be recorded in the VCD file. For example, to map L and H to z:
vcd file -map "L z H z"
Note that the quotes in the example above are a Tcl convention for command strings that include spaces. -no_strength_range Ignores strength ranges when resolving driver values. Optional. This argument is an extension to the IEEE 1364 specification. Refer to Resolving Values for additional information. -nomap Affects only VHDL signals of type std_logic. Optional. It specifies that the values recorded in the VCD file shall use the std_logic enumeration characters of UX01ZWLH-. This option results in a non-standard VCD file because VCD values are limited to the four state character set of x01z. By default, the std_logic characters are mapped as follows.
398
Commands vcd file
VHDL U X 0 1 Z -unique
VCD x x 0 1 z
VHDL W L H -
VCD x 0 1 x
Generates unique VCD variable names for ports even if those ports are connected to the same collapsed net. Optional. See also Value Change Dump (VCD) Files, vcd files, DumpportsCollapse Verilog tasks are documented in the IEEE 1364 standard.
399
Commands vcd files
vcd files
The vcd files command specifies filenames and state mapping for VCD files created by the vcd add command. The vcd files command is optional. If used, it must be issued before any vcd add commands. Related Verilog task: $fdumpfile Syntax vcd files [-compress] [-direction] <filename> [-map <mapping pairs>] [-no_strength_range] [-nomap] [-unique] Arguments -compress Produces a compressed VCD file. Optional. ModelSim uses the gzip compression algorithm. If you specify a .gz extension on the -file <filename> argument, ModelSim compresses the file even if you dont use the -compress argument. -direction Includes driver direction data in the VCD file. Optional. <filename> Specifies the name of a VCD file to create. Required. Multiple files can be opened during a single simulation; however, you can create only one file at a time. If you want to create multiple files, invoke vcd files multiple times. -map <mapping pairs> Affects only VHDL signals of type std_logic. Optional. It allows you to override the default mappings. The mapping is specified as a list of character pairs. The first character in a pair must be one of the std_logic characters UX01ZWLH- and the second character is the character you wish to be recorded in the VCD file. For example, to map L and H to z:
vcd files -map "L z H z"
Note that the quotes in the example above are a Tcl convention for command strings that include spaces. -no_strength_range Ignores strength ranges when resolving driver values. Optional. This argument is an extension to the IEEE 1364 specification. Refer to Resolving Values for additional information. -nomap Affects only VHDL signals of type std_logic. Optional. It specifies that the values recorded in the VCD file shall use the std_logic enumeration characters of UX01ZWLH-. This option
400
Commands vcd files
results in a non-standard VCD file because VCD values are limited to the four state character set of x01z. By default, the std_logic characters are mapped as follows. VHDL U X 0 1 Z -unique Generates unique VCD variable names for ports even if those ports are connected to the same collapsed net. Optional. Examples The following example shows how to "mask" outputs from a VCD file until a certain time after the start of the simulation. The example uses two vcd files commands and the vcd on and vcd off commands to accomplish this task.
vcd vcd vcd vcd vcd run vcd run files in_inout.vcd files output.vcd add -in -inout -file in_inout.vcd /* add -out -file output.vcd /* off output.vcd 1us on output.vcd -all
VCD x x 0 1 z
VHDL W L H -
VCD x 0 1 x
See also Value Change Dump (VCD) Files, vcd file, DumpportsCollapse Verilog tasks are documented in the IEEE 1364 standard.
401
Commands vcd flush
vcd flush
The vcd flush command flushes the contents of the VCD file buffer to the specified VCD file. This command is useful if you want to create a complete VCD file without ending your current simulation. Related Verilog tasks: $dumpflush, $fdumpflush Syntax vcd flush [<filename>] Arguments <filename> Specifies the name of the VCD file. Optional. If omitted the command is executed on the file designated by the vcd file command or dump.vcd if vcd file was not invoked. See also Value Change Dump (VCD) Files, DumpportsCollapse Verilog tasks are documented in the IEEE 1364 standard.
402
Commands vcd limit
vcd limit
The vcd limit command specifies the maximum size of a VCD file (by default, limited to available disk space). When the size of the file exceeds the limit, a comment is appended to the file and VCD dumping is disabled. Related Verilog tasks: $dumplimit, $fdumplimit Syntax vcd limit <filesize> [<filename>] Arguments <filesize> (Required) Specifies the maximum VCD file size, in bytes. The numerical value of <filesize> can only be a whole number. You can use a unit multiplier of either Kb, Mb, or Gb with the numerical value (multipliers are case insensitive). Do not insert a space between the numerical value and the multiplier (for example, 400Mb, not 400 Mb). <filename> (Optional) Specifies the name of the VCD file. If omitted, the command is executed on the file designated by the vcd file command or dump.vcd if vcd file was not invoked. Example Specify a maximum VCD file size of 6 gigabytes and a VCD file named my_vcd_file.vcd.
vcd limit 6gb my_vcd_file.vcd
See also Value Change Dump (VCD) Files, DumpportsCollapse Verilog tasks are documented in the IEEE 1364 standard.
403
Commands vcd off
vcd off
The vcd off command turns off VCD dumping to the specified file and records all VCD variable values as x. Related Verilog tasks: $dumpoff, $fdumpoff Syntax vcd off [<filename>] Arguments <filename> Specifies the name of the VCD file. Optional. If omitted the command is executed on the file designated by the vcd file command or dump.vcd if vcd file was not invoked. See also Value Change Dump (VCD) Files., DumpportsCollapse Verilog tasks are documented in the IEEE 1364 standard.
404
Commands vcd on
vcd on
The vcd on command turns on VCD dumping to the specified file and records the current values of all VCD variables. By default, vcd on is automatically performed at the end of the simulation time that the vcd add commands are performed. Related Verilog tasks: $dumpon, $fdumpon Syntax vcd on [<filename>] Arguments <filename> Specifies the name of the VCD file. Optional. If omitted the command is executed on the file designated by the vcd file command or dump.vcd if vcd file was not invoked. See also Value Change Dump (VCD) Files, DumpportsCollapse Verilog system tasks are documented in the IEEE 1364 standard.
405
Commands vcd2wlf
vcd2wlf
vcd2wlf is a utility that translates a VCD (Value Change Dump) file into a WLF file that you can display in ModelSim using the vsim -view argument. This command only works on VCD files containing positive time values. Description The vcd2wlf command functions as simple one-pass converter. If you are defining a bus in a VCD file, you must specify all bus bits before the next $scope or $upscope statement appears in the file. The best way to ensure that bits get converted together as a bus is to declare them on consecutive lines. For example:
Line 21 : $var wire 1 $ in [2] $end Line 22 : $var wire 1 $u in [1] $end Line 23 : $var wire 1 # in [0] $end
Syntax vcd2wlf [-splitio] [-splitio_in_ext <extension>] [-splitio_out_ext <extension>] [-nocase] <vcd filename> <wlf filename> Arguments -splitio Specifies that extended VCD port values are to be split into their corresponding input and output components by creating 2 signals instead of just 1 in the resulting .wlf file. Optional. By default the new input-component signal keeps the same name as the original port name while the output-component name is the original name with "__o" appended to it. -splitio_in_ext <extension> Specifies an extension to add to input-component signal names created by using -splitio. Optional. -splitio_out_ext <extension> Specifies an extension to add to output-component signal names created by using -splitio. Optional. -nocase Converts all alphabetic identifiers to lowercase. Optional. <vcd filename> Specifies the name of the VCD file you want to translate into a WLF file. Required. <wlf filename> Specifies the name of the output WLF file. Required. See also Value Change Dump (VCD) Files
406
Commands vcom
vcom
The vcom command compiles VHDL source code into a specified working library (or to the work library by default). You can invoke vcom either from within ModelSim or from the command prompt of your operating system. You can invoke this command during simulation. Compiled libraries are dependent on the major version of ModelSim. When moving between major versions, you must refresh compiled libraries using the -refresh argument to vcom. This is not required for minor versions (letter releases). All arguments to the vcom command are case-sensitive. For example, -WORK and -work are not equivalent. Syntax vcom [-87] [-93] [-2002] [-allowProtectedBeforeBody] [-amsstd | -noamsstd] [-bindAtCompile] [-bindAtLoad] [-check_synthesis] [-debugVA] [-deferSubpgmCheck] [-explicit] [-f <filename>] [-fsmdebug] [-fsmimplicittrans] [-fsmresettrans] [-fsmsingle] [-fsmverbose] [-force_refresh <design_unit>] [-gen_xml <design_unit> <filename>] [-help] [-ignoredefaultbinding] [-ignorevitalerrors] [-just abcep] [-line <number>] [-lint] [-maxfecrows] [-maxudprows] [-mixedsvvh [b | l | r | i]] [-no1164] [-noaccel <package_name>] [-nocasestaticerror] [-nocheck] [-nocoverrespecthandl] [-nodbgsym] [-noDeferSubpgmCheck] [-noindexcheck] [-nofsmresettrans] [-nofsmsingle] [-nofsmxassign] [-nologo] [-nonstddriverinit] [-noothersstaticerror] [-norangecheck] [-note <msg_number> [,<msg_number>, ]] [-novital] [-novitalcheck] [-nowarn <category_number>] [-O0 | -O1 | -O4 | -O5] [-pedanticerrors] [-performdefaultbinding] [-quiet] [-rangecheck] [-refresh] [-s] [-skip abcep] [-source] [-time] [-togglecountlimit] [-togglewidthlimit] [-version] [-suppress <msg_number>[,<msg_number>,]] [-error <msg_number>[,<msg_number>,]] [-warning <msg_number>[,<msg_number>,]] [-fatal <msg_number>[,<msg_number>,]] [-work <library_name>] <filename> [+acc[=<spec>][+<entity>[(architecture)]]] [-novopt] [-vopt] [+cover <stat>] [-cover <stat>] [-coveropt] [-coverexcludedefault] [-coversub] [-nocoversub] [-nocovershort] [-nocovergenerate] [-nodebug[=ports]] [-nocoverfec] Arguments -87 Disables support for VHDL-1993 and 2002. Optional. Default is -2002. See additional discussion in the examples. You can modify the VHDL93 variable in the modelsim.ini file to set this permanently (Refer to Simulator Control Variables).
407
Commands vcom
-93 Disables support for VHDL-1987 and 2002. Optional. Default is -2002. See additional discussion in the examples. You can modify the VHDL93 variable in the modelsim.ini file to set this permanently.
-2002 Specifies that the compiler is to support VHDL-2002. Optional. This is the default. +acc[=<spec>][+<entity>[(architecture)]] Enable debug command access to objects indicated by <spec> when optimizing a design. Optional. Note Using this option may reduce simulation speed.
<spec> can be: f Enable access to finite state machines. q Enable access to VHDL variables and generics. v Enable access to variables, constants, and aliases in processes that would otherwise be merged due to optimizations. Disables an optimization that automatically converts variables to constants. If <spec> is omitted, access is enabled for all objects. <entity> and (<architecture>) specify the VHDL design regions in which to allow the access. If (<architecture>) is not specified, then all architectures of a given <entity> are enabled for access. May be optionally followed by "." to indicate all children of the module. -allowProtectedBeforeBody Allows a variable of a protected type to be created prior to declaring the body. Optional. -amsstd | -noamsstd Specifies whether vcom adds the declaration of REAL_VECTOR to the STANDARD package. This is useful for designers using VHDL-AMS to test digital parts of their model. -amsstd REAL_VECTOR is included in STANDARD. -noamsstd REAL_VECTOR is not included in STANDARD (default). You can also control this with the AmsStandard variable or the MGC_AMS_HOME environment variable.
408
Commands vcom
-bindAtCompile Forces ModelSim to perform default binding at compile time rather than at load time. Optional. Refer to Default Binding for more information. You can change the permanent default by editing the BindAtCompile variable in the modelsim.ini.
-bindAtLoad Forces ModelSim to perform default binding at load time rather than at compile time. Optional. Default.
-check_synthesis Turns on limited synthesis rule compliance checking. Specifically, it checks to see that signals read by a process are in the sensitivity list. Optional. The checks understand only combinational logic, not clocked logic. Edit the CheckSynthesis variable in the modelsim.ini file to set a permanent default.
+cover <stat> Enables various coverage statistics collection. The use of +cover is recommended over -cover, as it is more powerful and flexible, and often yields better performance. To obtain the behavior of the obsolete -coverAll argument, use the +cover argument without any <stat> characters. Optional. <stat> one or more of the following characters: b Collect branch statistics. c Collect condition statistics. Collects both FEC and UDP statistics, unless -nocoverfec is specified. e Collect expression statistics, Collects both FEC and UDP statistics, unless -nocoverfec is specified. s Collect statement statistics. t Collect toggle statistics. Overridden if x is specified elsewhere. x Collect extended toggle statistics (Refer to Toggle Coverage for details). This takes precedence, if t is specified elsewhere. f Collect Finite State Machine statistics. See -coveropt argument to override the default level of optimization for coverage for a particular compilation run.
-cover <stat> Recommendation: Use +cover instead of this option, as it is more powerful and flexible, and often yields better performance as a result. Enables various coverage statistics collection. Optional. <stat> one or more of the following characters: b Collect branch statistics.
409
Commands vcom
c Collect condition statistics. Collects both FEC and UDP statistics, unless -nocoverfec is specified. e Collect expression statistics, Collects both FEC and UDP statistics, unless -nocoverfec is specified. s Collect statement statistics. t Collect toggle statistics. Cannot be used if x is specified. x Collect extended toggle statistics (Refer to Toggle Coverage for details). Cannot be used if t is specified. f Collect Finite State Machine statistics. <i> Override the default level of optimization for current run only, where i is an integer between 1 and 4. To change default level for all subsequent runs, change value of CoverOpt variable in modelsim.ini file. See CoverOpt for a description of optimization levels. -coverexcludedefault Excludes code coverage data collection from the default branch of case statements. Optional. -coveropt Overrides the default level of optimization for the current run only. Optional. Edit the CoverOpt variable in the modelsim.ini file to set a permanent default. See CoverOpt for a description of optimization levels. -coversub Re-enables code coverage data collection in VHDL subprograms previously disabled with -nocoversub. Optional. By default code coverage data is collected for VHDL subprograms. Edit the CoverSub variable in the modelsim.ini file to set a permanent default. -nocoversub Disables code coverage data collection in VHDL subprograms. Optional. By default code coverage data is collected for VHDL subprograms. Edit the CoverSub variable in the modelsim.ini file to set a permanent default. -debugVA Prints a confirmation if a VITAL cell was optimized, or an explanation of why it was not, during VITAL level-1 acceleration. Optional. -deferSubpgmCheck Forces the compiler to report array indexing and length errors as warnings (instead of as errors) when encountered within subprograms. Subprograms with indexing and length errors that are invoked during simulation cause the simulator to report errors, which can potentially slow down simulation because of additional checking.
410
Commands vcom
-error <msg_number>[,<msg_number>,] Changes the severity level of the specified message(s) to "error." Optional. Edit the error variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information.
-explicit Directs the compiler to resolve ambiguous function overloading by favoring the explicit function definition over the implicit function definition. Optional. Strictly speaking, this behavior does not match the VHDL standard. However, the majority of EDA tools choose explicit operators over implicit operators. Using this switch makes ModelSim compatible with common industry practice.
-f <filename> Specifies a file with more command-line arguments. Optional. Allows complex argument strings to be reused without retyping. Allows gzipped input files. Nesting of -f options is allowed. Refer to the section "Argument Files" for more information.
-fsmdebug Enables recognition of finite state machines and display of state and transition data in the FSM Viewer. Optional.
-fsmimplicittrans Enables recognition of implied same state transitions. Optional. -fsmresettrans Enables recognition of implicit asynchronous reset transitions. Optional. This includes asynchronous reset transitions in coverage results.
-fsmsingle Enables recognition FSMs having single bit current state variable. Optional. -fsmverbose Provides information about FSMs detected, including state reachability analysis. Optional. -force_refresh <design_unit> Forces the refresh of all specified design units. Optional. By default, the work library is updated; use -work <library_name>, in conjunction with -force_refresh, to update a different library (for example, vcom -work <your_lib_name> -force_refresh). When the compiler refreshes a design unit, it checks each dependency to ensure its source has not been changed and recompiled. Sometimes the tools dependency checking algorithm
411
Commands vcom
changes from release to release. This can lead to false errors during the integrity checks performed by the -refresh argument. An example of such a message follows:
** Error: (vsim-13) Recompile /u/test/dware/dware_61e_beta.dwpackages because /home/users/questasim/linux/../synopsys.attributes has changed.
The -force_refresh argument forces the refresh of the design unit, overriding any dependency checking errors encountered by the -refresh argument. A more conservative approach to working around -refresh dependency checks is to recompile the source code, if it is available. -gen_xml <design_unit> <filename> Produces an XML-tagged file containing the interface definition of the specified entity. Optional. This option requires a two-step process where you must 1) compile <filename> into a library with vcom (without -gen_xml) then 2) execute vcom with the -gen_xml switch, for example:
vlib work vcom counter.vhd vcom -gen_xml counter counter.xml
-help Displays the commands options and arguments. Optional. -ignoredefaultbinding Instructs the compiler not to generate a default binding during compilation. Optional. You must explicitly bind all components in the design to use this switch.
-ignorevitalerrors Directs the compiler to ignore VITAL compliance errors. Optional. The compiler still reports that VITAL errors exist, but it will not stop the compilation. You should exercise caution in using this switch; as part of accelerating VITAL packages, we assume that compliance checking has passed.
-just abcep Directs the compiler to include only the following: a architectures b bodies c configurations e entities p packages Any combination in any order can be used, but you must specify at least one choice if you use this optional switch.
412
Commands vcom
-line <number> Starts the compiler on the specified line in the VHDL source file. Optional. By default, the compiler starts at the beginning of the file.
-lint Optional. Enables better checking on case statement rules. Also enables warning messages for the following situations: 1) the result of the built-in concatenation operator ("&") is the actual for a subprogram formal parameter of an unconstrained array type; 2) the entity to which a component instantiation is bound has a port that is not on the component, and for which there is no error otherwise; 3) a direct recursive subprogram call; and 4) in cases involving class SIGNAL formal parameters, as described in IEEE Standard VHDL Language Reference Manual 1076-1993, section 2.1.1.2 entitled "Signal parameters", line 115. This last check only applies to designs compiled using 87. If you were to compile in 93, it would be flagged as a warning or error, even without the -lint argument. Can also be enabled using the Show_Lint variable in the modelsim.ini file.
-maxfecrows Sets the maximum number of rows allowed in an FEC truth table for a code coverage condition or expression. The default maximum is 192 rows. Increasing the number of rows includes more expressions for coverage, but also increases the compile time, sometimes dramatically. You can also configure this option using the CoverMaxFECRows variable in the modelsim.ini file.
-maxudprows Sets the maximum number of rows allowed in an UDP truth table for a code coverage condition or expression. The default maximum is 192 rows. Increasing the number of rows includes more expressions for coverage, but also increases the compile time, sometimes dramatically. You can also configure this option using the CoverMaxUDPRows variable in the modelsim.ini file.
-mixedsvvh [b | l | r | i] Facilitates using VHDL packages at the SystemVerilog-VHDL boundary of a mixedlanguage design. When you compile a VHDL package with -mixedsvvh, the package can be included in a SystemVerilog design as if it were defined in SystemVerilog itself. Optional. b treats all scalars and vectors in the package as SystemVerilog bit type l treats all scalars and vectors in the package as SystemVerilog logic type r treats all scalars and vectors in the package as SystemVerilog reg type i ignores the range specified with VHDL integer types
-no1164 Causes the source files to be compiled without taking advantage of the built-in version of the IEEE std_logic_1164 package. Optional. This will typically result in longer simulation times for VHDL programs that use variables and signals of type std_logic.
413
Commands vcom
-noaccel <package_name> Turns off acceleration of the specified package in the source code using that package. -nocasestaticerror Suppresses case statement static warnings. Optional. VHDL standards require that case statement alternative choices be static at compile time. However, some expressions which are globally static are allowed. This switch prevents the compiler from warning on such expressions. If the -pedanticerrors switch is specified, this switch is ignored.
-nocheck Disables index and range checks. Optional. You can disable these individually using the -noindexcheck and -norangecheck arguments, respectively.
-nocoverfec Prevents focused expression coverage (FEC) from being enabled for coverage collection. By default, both UDP and FEC coverage statistics are enabled for collection. You can customize the default behavior with the CoverFEC variable in the modelsim.ini file. Optional.
-nocovergenerate Disables code coverage inside the top level of generate blocks. Optional. By default, code coverage is automatically enabled for the top level of all generate blocks which are elaborated. You can customize the default behavior with the CoverGenerate variable in the modelsim.ini file.
-nocoverrespecthandl Specifies that you want the VHDL 'H' and 'L' input values on conditions and expressions to be automatically converted to 1 and 0, respectively. By default in the current release, they are not automatically converted. As an alternative to using this argument if you are not using 'H' and 'L' values and dont want the additional UDP rows that are difficult to cover you can either: change your VHDL expressions of the form (a = '1') to (to_x01(a) = '1') or to std_match(a,'1'). These functions are recognized and serve to simplify the UDP tables set the CoverRespectHandL .ini file variable to 0
-nocovershort Disables short circuiting of expressions when coverage is enabled. Short circuiting is enabled by default. You can customize the default behavior with the CoverShortCircuit variable in the modelsim.ini file.
-nodebug[=ports] Hides, within the GUI and other parts of the tool, the internal data of all compiled design units. Optional.
414
Commands vcom
-nodebug The switch, specified in this form, does not hide ports, due to the fact that the port information may be required for instantiation in a parent scope. The design units source code, internal structure, registers, nets, etc. will not display in the GUI. In addition, none of the hidden objects may be accessed through the Dataflow window or with commands. This also means that you cannot set breakpoints or single step within this code. It is advised that you not compile with this switch until you are done debugging. Note that this is not a speed switch like the nodebug option on many other products. Use the vopt command to increase simulation speed. -nodebug=ports additionally hides the ports for the lower levels of your design; it should be used only to compile the lower levels of the design. If you hide the ports of the top level you will not be able to simulate the design. You should not use the switch in this form when working in mixed language designs or when the parent is part of a vopt -bbox flow. This functionality encrypts entire files. The `protect compiler directive allows you to encrypt regions within a file. Design units or modules compiled with -nodebug can only instantiate design units or modules that are also compiled -nodebug. -nodbgsym Disables the generation of the symbols debugging database in the compiled library. The symbols debugging database is the .dbs file in the compiled library that provides information to the GUI allowing you to view detailed information about design objects at the source level. Two major GUI features that use this database include source window annotation and textual dataflow. You should only specify this switch if you know that anyone using the library will not require this information for design analysis purposes. -noDeferSubpgmCheck Causes range and length violations detected within subprograms to be reported as errors (instead of as warnings). As an alternative to using this argument, you can set the NoDeferSubpgmCheck property in the modelsim.ini file to a value of 1. -noindexcheck Disables checking on indexing expressions to determine whether indices are within declared array bounds. Optional. -nofsmresettrans Disables recognition of implicit asynchronous reset transitions. Optional. This has the effect of excluding asynchronous reset transitions from any coverage results. -nofsmsingle Disables recognition of FSMs having single bit current state variable. Optional.
415
Commands vcom
-nofsmxassign Disable recognition of FSMs containing x assignment. Optional. -noFunctionInline Turns off VHDL subprogram inlining for design units using a local copy of a VHDL package. This may be needed in case the local package has the same name as an MTI supplied package.
-nologo Disables display of the startup banner. Optional. -nonstddriverinit Forces ModelSim to match pre-5.7c behavior in initializing drivers in a particular case. Optional. Prior to 5.7c, VHDL ports of mode out or inout could have incorrectly initialized drivers if the port did not have an explicit initialization value and the actual signal connected to the port had explicit initial values. Depending on a number of factors, ModelSim could incorrectly use the actual signal's initial value when initializing lower level drivers. Note that the argument does not cause all lower-level drivers to use the actual signal's initial value. It does this only in the specific cases where older versions used the actual signal's initial value.
-noothersstaticerror Disables warnings that result from array aggregates with multiple choices having "others" clauses that are not locally static. Optional. If the -pedanticerrors switch is specified, this switch is ignored.
-norangecheck Disables run time range checking. In some designs, this results in a 2X speed increase. Range checking is enabled by default or, once disabled, can be enabled using -rangecheck. Refer to Range and Index Checking for additional information.
-note <msg_number> [,<msg_number>, ] Changes the severity level of the specified message(s) to "note." Optional. Edit the note variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information.
-novital Causes vcom to use VHDL code for VITAL procedures rather than the accelerated and optimized timing and primitive packages built into the simulator kernel. Optional. Allows breakpoints to be set in the VITAL behavior process and permits single stepping through the VITAL procedures to debug your model. Also all of the VITAL data can be viewed in the Locals or Objects windows.
-novitalcheck Disables Vital level 1 checks and also Vital level 0 checks defined in section 4 of the Vital95 Spec (IEEE Std 1076.4-1995). Optional.
416
Commands vcom
-novopt Forces vcom to produce code if the VoptFlow variable is set to 1 (optimizations turned on) in the modelsim.ini. (VoptFlow = 1 is the default behavior.) You can use this argument in tandem with vsim -novopt to run the simulator in debug / full visibility mode when the default behavior is optimized.
-nowarn <category_number> Selectively disables a category of warning messages. Optional. Multiple -nowarn switches are allowed. Warnings may be disabled for all compiles via the Main window Compile > Compile Options menu command or the modelsim.ini file (Refer to VHDL Compiler Control Variables). The warning message categories are described in Table 2-7: Table 2-7. Warning Message Categories for vcom -nowarn Category number 1 2 3 4 5 6 7 8 9 10 13 14 Description unbound component process without a wait statement null range no space in time literal multiple drivers on unresolved signal VITAL compliance checks (VitalChecks also works) VITAL optimization messages lint checks signal value dependency at elaboration VHDL-1993 constructs in VHDL-1987 code constructs that coverage can't handle locally static error deferred until simulation run
-O0 | -O1 | -O4 | -O5 Lower the optimization to a minimum with -O0 (capital oh zero). Optional. Use this to work around bugs, increase your debugging visibility on a specific cell, or when you want to place breakpoints on source lines that have been optimized out. Add the DisableOpt variable to the [vcom] section of the modelsim.ini file to set a permanent default. Please refer to the section "Optimizing Designs with vopt" in the Users Manual for detailed information on using vopt to perform optimization. Enable PE-level optimization with -O1. Optional. Note that changing from the default -O4 to -O1 may cause event order differences in your simulation.
417
Commands vcom
Enable standard SE optimizations with -O4. Default. The main differences between -O4 and -O1 are that ModelSim attempts to improve memory management for vectors and accelerate VITAL Level 1 modules with -O4. Enable maximum optimization with -O5. Optional. We recommend use of this switch with large sequential blocks only; other uses may significantly increase compile times. -O5 attempts to optimize loops and prevents variable assignments in situations where a variable is assigned but is not actually used. Using the +acc argument to vcom will cancel this latter optimization.
-pedanticerrors Forces display of an error message (rather than a warning) on a variety of conditions. Refer to Enforcing Strict 1076 Compliance for a complete list of these conditions. Optional. This argument overrides -nocasestaticerror and -noothersstaticerror (see above).
-performdefaultbinding Enables default binding when it has been disabled via the RequireConfigForAllDefaultBinding option in the modelsim.ini file. Optional.
-quiet Disables Loading messages. Optional. -rangecheck Enables run time range checking. Default. Range checking can be disabled using the -norangecheck argument. Refer to Range and Index Checking for additional information.
-refresh Regenerates a library image. Optional. By default, the work library is updated. To update a different library, use -work <library_name> with -refresh (for example, vcom -work <your_lib_name> -refresh). If a dependency checking error occurs which prevents the refresh, use the vcom -force_refresh argument. See the vcom Examples for more information. You may use a specific design name with -refresh to regenerate a library image for that design, but you may not use a file name.
-s Instructs the compiler not to load the standard package. Optional. This argument should only be used if you are compiling the standard package itself.
-skip abcep Directs the compiler to skip all: a architectures b bodies c configurations e entities p packages
418
Commands vcom
Any combination in any order can be used, but one choice is required if you use this optional switch. -source Displays the associated line of source code before each error message that is generated during compilation. Optional. By default, only the error message is displayed. -suppress <msg_number>[,<msg_number>,] Prevents the specified message(s) from displaying. The <msg_number> is the number preceding the message you wish to suppress. Optional. You cannot suppress Fatal or Internal messages. Edit the suppress variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information. -time Reports the "wall clock time" vcom takes to compile the design. Optional. Note that if many processes are running on the same system, wall clock time may differ greatly from the actual "cpu time" spent on vcom. -togglecountlimit Limits the toggle coverage count for a toggle node. Optional. After the limit is reached, further activity on the node will be ignored for toggle coverage. All possible transition edges must reach this count for the limit to take effect. For example, if you are collecting toggle data on 0->1 and 1->0 transitions, both transition counts must reach the limit. If you are collecting "full" data on 6 edge transitions, all 6 must reach the limit. Overrides the global value set by the ToggleCountLimit modelsim.ini variable. -togglewidthlimit Sets the maximum width of signals that are automatically added to toggle coverage with the -cover t argument. Optional. Can be set on design unit basis. Overrides the global value set by the ToggleWidthLimit modelsim.ini variable. -version Returns the version of the compiler as used by the licensing tools. Optional. -vopt Notifies vcom that the vopt command will be run. As a result, vcom does not produce code. This saves an unnecessary code generation step. Only needed if VoptFlow is set to 0 in the modelsim.ini. If VoptFlow is set to 1, the vcom code generation step is skipped automatically. Optional. -warning <msg_number>[,<msg_number>,] Changes the severity level of the specified message(s) to "warning." Optional. Edit the warning variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information.
419
Commands vcom
-work <library_name> Specifies a logical name or pathname of a library that is to be mapped to the logical library work. Optional; by default, the compiled design units are added to the work library. The specified pathname overrides the pathname specified for work in the project file.
<filename> Specifies the name of a file containing the VHDL source to be compiled. One filename is required; multiple filenames can be entered separated by spaces or wildcards may be used (e.g., *.vhd). If you dont specify a filename, and you are using the GUI, a dialog box pops up allowing you to select the options and enter a filename.
Examples Compile the VHDL source code contained in the file example.vhd.
vcom example.vhd
ModelSim supports designs that use elements conforming to the 1987, 1993, and 2002 standards. Compile the design units separately using the appropriate switches.
vcom -87 o_units1.vhd o_units2.vhd vcom -93 n_unit91.vhd n_unit92.vhd
Hide the internal data of example.vhd. Models compiled with -nodebug cannot use any of the ModelSim debugging features; any subsequent user will not be able to see into the model.
vcom -nodebug example.vhd
The first line compiles and hides the internal data, plus the ports, of the lower-level design units, level3.vhd and level2.vhd. The second line compiles the top-level unit, top.vhd, without hiding the ports. It is important to compile the top level without =ports because top-level ports must be visible for simulation.
vcom -nodebug=ports level3.vhd level2.vhd vcom -nodebug top.vhd
When compiling source that uses the numeric_std package, this command turns off acceleration of the numeric_std package, located in the ieee library.
vcom -noaccel numeric_std example.vhd
Although it is not obvious, the = operator is overloaded in the std_logic_1164 package. All enumeration data types in VHDL get an implicit definition for the = operator. So while there is no explicit = operator, there is an implicit one. This implicit declaration can be hidden by an explicit declaration of = in the same package (LRM Section 10.3). However, if another version of the = operator is declared in a different package than that containing the enumeration declaration, and both operators become visible through use clauses, neither can be used without explicit naming.
420
Commands vcom vcom -explicit example.vhd
To eliminate that inconvenience, the VCOM command has the -explicit option that allows the explicit = operator to hide the implicit one. Allowing the explicit declaration to hide the implicit declaration is what most VHDL users expect.
ARITHMETIC."="(left, right)
The -work option specifies mylib as the library to regenerate. -refresh rebuilds the library image without using source code, allowing models delivered as compiled libraries without source code to be rebuilt for a specific release of ModelSim (4.6 and later only).
vcom -work mylib -refresh
421
Commands vcover attribute
vcover attribute
The vcover attribute command is used to display or set attributes in the currently loaded database, during batch mode simulation, on the following types of attributes: Test Attributes sets the value of attributes for testcase information. The following list of attributes are accessible from predefined key strings: Syntax
For test attributes
"SIMTIME": Simulation time "TIMEUNIT": Unit (Unit for simtime: ns, us, etc.) "CPUTIME": Cputime used by the simulator "DATE": Date "VSIMARGS": vsim arguments "USERNAME": user name "TESTSTATUS": test status (OK, Warning, Error, or Fatal)
vcover attribute [-test <testname>] [-seed <str>] [-command <str>] [-comment <str>] [-compulsory [0|1]] [-tcl] [-concise] [-name <str>]+ [-value <str>]+ Arguments -command <str> Command to run the test: script command line, "knob settings", etc. Optional. -comment <str> Comment on the testcase. Optional. -compulsory [0|1] Indicates test is compulsory. Optional. By default, it is no compulsory. -concise Print attribute values only, do not print other information. Optional. -name <str> Attribute name. Used to add your own attributes to the test. Multiple specifications of -name are allowed. Optional. -seed <str> Random seed of the test run. Optional. -tcl Prints attribute information in a tcl format. Optional.
422
Commands vcover attribute
-test <testname> Specifies a test object for attributes. Required when used with vsim -viewcov. Optional otherwise.
-value <str> Value of attribute associated with -name. Multiple specifications of -value are allowed. Optional.
See also Verification Management, Verification Management Window, coverage attribute, coverage exclude, coverage goal, coverage report, coverage save, coverage testnames, coverage weight, vcover merge, vcover ranktest, vcover stats
423
Commands vcover merge
vcover merge
The vcover merge command merges multiple code coverage data files that were created with the coverage save command. All files being merged must have been created from the same design. By default, vcover merge creates a test-associated merge, which associates coverage items with the test(s) that covered them. To obtain a more basic level of information use the -totals argument without -test. There are cases in which it may be advisable not to merge, and instead preserve the individual UCDBs for analysis and ranking. In the following cases, the tool issues a warning message indicating that the resulting merged file cannot completely represent the merged information: if "at_least" is greater than 1 weights are different for the same object in different files different objects in different files
For these, you can run with the -verbose argument set to obtain further details about potential issues with the merge. If a code coverage instance in the unified coverage database (UCDB) has been changed, a warning will be generated. Warnings can be disabled with the -quiet option. The command can be invoked within the ModelSim GUI or at the system prompt. Syntax vcover merge <merge_options> [-out <outfile>] <file1> [<file2> ...<filen>] <merge_options> = [-and] [-append] [-backup] [-inputs <file>] [-install <path>] [[-instance <path> [-recursive]] | [-du <du_name> [-recursive]] [-log <filename>] [-notagging] [-strip <n>] [-quiet] [-verbose] [-version] [-totals |-testassociated] [-timeout <seconds>] <file1> [<file2> ...<filen>] Arguments -and Excludes statements in the output file only if they are excluded in all input files. Optional. By default a statement is excluded in the output merge file if the statement is excluded in any of the input files. -append Specifies that progress messages are to be appended to the current log file. Optional. By default a new log file is created each time you invoke the command.
424
-backup Creates a backup UCDB output file named "< ucdb filename >._backup" during the lockprotected execution of vcover merge.
-du <du_name> [-recursive] Instructs the tool to merge all instances of the specified design unit in all the input files. It then creates an output file consisting of one instance of the design unit, containing all the merged data. <du_name> is [<library name>.]<primary>[(<secondary>)], where the library name is optional, and secondary name is required only for VHDL. Instance names in the output file are generated in the following format, replacing any '/' with '_' from the library names: <library>_<primary>[_<secondary>] The -recursive argument instructs the tool to merge the complete design subtree, from the designated design unit down. Optional. If not specified, just the level specified is merged.
-inputs <file> Specifies a text file containing input filenames that you want to merge. Optional. -instance <path> [-recursive] Instructs the tool to merge all occurrences of the specified instances in all the input files. It then creates an output file consisting of a single instance, containing all the merged data. You can change the resulting path using the -install <path> option. The -recursive argument instructs the tool to merge the complete design subtree, from the designated instance down. Optional. If not specified, just the level specified is merged.
-install <path> Adds <path> as additional hierarchy on the front end of instance and object names in the data files. Optional. This argument allows you to merge coverage results from simulations that have different hierarchies. See "Merge Usage Scenarios" for more information.
-log <filename> Specifies the file for outputting progress messages. Optional. By default these messages are output to vcover.log.
-notagging Prevents the automatic implicit test plan tagging from being performed. -out <outfile> Specifies the name of the file that will contain the merged output. Optional. When -out is not specified, the filename used for the output is the base name of the first UCDB file listed in the command, whereas when -out is specified, the output file can be specified anywhere in the command.
425
-quiet Disable warnings when merging databases and a changed instance is encountered. -strip <n> Removes <n> levels of hierarchy from instance and object names in the data files. Optional. This argument allows you to merge coverage results from simulations that have different hierarchies. See "Merge Usage Scenarios" for more information.
-testassociated Merges the selected databases, including all the basic information (created with -totals) as well as the associated tests and bins. This is the default merge. This argument is mutually exclusive with -totals. When tests and bins are associated, each coverage count is marked with the test that caused it to be covered. For functional coverage, this means the bin count should be greater than or equal to the at_least parameter. For code coverage and assertion data, any non-zero count for a test causes the bin to be marked with the test. While it cannot be known which test incremented a bin by exactly how much, it can be known which test caused a bin to be covered.
-totals Merges the databases with a basic level of information, including: coverage scopes, design scopes, and test plan scopes. The counts are incremented together. In the case of vector bin counts, counts are ORed. The final output database is a union of objects from the input files. Information about which test contributed what coverage into the merge is lost. Information about tests themselves are not lost test data records are added together from all merge inputs. While the list of tests can be known, it cannot be known what tests might have incremented particular bins.
-timeout <seconds> Sets the timeout period after which the lock can be removed. During the timeout period the lock holder is protected. After the timeout expires, it is open hunting season. Supports cumulative merges and multiple merge commands, issued one after another. Such merge commands can be issued simultaneously from various platforms in a networking environment. In order to avoid corrupting cumulative coverage results, merges of UCDB files are serialized.
-verbose Enables summary code coverage statistics to be computed and directed to the log file each time a file is merged into the base. The statistics are instance-based. Optional.
-version Returns the version number of each input UCDB file, and the version number of the output UCDB file, which is always created with the most recent version of the UCDB creation software. Optional.
426
<file1> [<file2> ...<filen>] Specifies the file(s) you want to merge, with <file1> required to contain the superset of the objects to be merged. Subsequent files listed must be subsets of the first file listed. Required. Multiple pathnames and wildcards are allowed. See Examples.
Examples Merge coverage statistics for myfile1 and myfile2 and writes them to myresult.
vcover merge myfile1 myfile2 -out myresult
Use wildcards to merge all files with a .cov extension in a particular directory.
vcover merge myresult2 /dut/*.cov
Change the default time-out for the lock file to 600 seconds.
vcover merge -timeout 600 out1.ucdb out2.ucdb in.ucdb
Strip the top two levels of hierarchy from an instance or objects in myfile.ucdb and place into another file myfile_stripped.ucdb.
vcover merge -strip 2 myfile_stripped.ucdb myfie.ucdb
See also Code Coverage, "Merge Usage Scenarios", "Verification Management", coverage attribute, coverage save, coverage testnames, vcover attribute, vcover merge, vcover ranktest, vcover stats
427
Commands vcover ranktest
vcover ranktest
The vcover ranktest command ranks the specified input tests according to their contribution to cumulative coverage. The output of this command is a list of ranked tests (saved by default to ranktest.rank) consisting of the following types of tests. listed in the order presented: Table 2-8. Order and Type of Ranked Tests Contributing, compulsory Mandatory tests, providing some coverage not provided by any previous test. Sorted by total coverage % Sorted by total coverage % Not sorted
Contributing, noncompulsory Tests providing coverage not provided by any previous test. Non-contributing Redundant tests, providing no incremental coverage.
Syntax vcover ranktest <rankest_options> {<UCDB_inputfile1> [... <UCDB_inputfileN>]} <ranktest_options> = [-rankfile <filename>] [-inputs <file_list>] [-log <filename>] [<coverage_type>] [-goal {<coverage_type> <RealNum>] | <RealNum>}] [-maxcpu <real_num_in_seconds>] [-maxtests <int>] [-metric {aggregate | total}] [-fewest | -cputime | -simtime [-path <path> | -du <du_name> | -plansection <path>] [-keepmergefile <filepath>] [-totals | -testassociated] [-precision] [-quiet | -concise | -verbose] <coverage_type> = [-code {b | c | e | f | s | t}...] [-codeAll] Arguments -code {b | c | e | f | s | t}... Specifies ranktest for corresponding code coverage type only: branch, condition, expression, statement, toggle, FSM. More than one coverage type can be specified with each -code argument (example: -code bcesf). Optional. -codeAll Specifies ranktest for all coverage types. Equivalent to -code bcestf. Optional.
428
-concise Specifies the output files are created with minimum additional I/O. Optional. Default creates ranktest with full I/O (-verbose). Mutually exclusive with -quiet and -verbose.
-cputime Specifies that the files be ranked by minimum CPU time. Optional. Mutually exclusive to the -fewest and -simtime arguments.
-du <du_name> Specifies the subtrees be rooted at the specified design unit. Optional. This argument applies to a particular module type, by name, in all UCDB files. This option is mutually exclusive with -path and -plansection.
-fewest Specifies that the files be ranked by fewest number of tests. Optional. Mutually exclusive to the -cputime and -simtime arguments. Default.
-inputs <file_list> Specifies a file containing ranktest arguments. Optional. -goal {<coverage_type> <RealNum>] | <RealNum>} -keepmergefile <filepath> Specifies the merge file corresponding to the ranking be preserved. By default, the merge file is deleted.
-log <filename> Specifies the file for outputting ranked results. Optional. -maxcpu <real_num_in_seconds> Monitors the accumulated CPU time of the ranked tests. Specifies the maximum CPU time to be allowed. If the specified number of seconds is exceeded, the ranking process is stopped. The default value is -1.0 (no limit). Optional.
-maxtests <int> Specifies threshold for the maximum number of tests to be ranked. When this threshold is exceeded, the ranking operation is terminated. Optional.
-metric {aggregate | total} Important: When the -metric aggregate argument is used, the resulting metric number will not match any other total coverage number produced by other verification tools (i.e. coverage analyze). This is important because when you use any of the arguments (-totals, -goal, with ranktest command, the aggregate metric is the default.
429
-path <path> Specifies the subtrees be rooted at the specified design node. Optional. This argument applies to a sub-hierarchy in all UCDB files. This option is mutually exclusive with -du and -plansection.
-plansection <path> Specifies the subtrees be rooted at the testplan node. Optional. This argument applies to a particular module type, by name, in all UCDB files. This argument can not be applied if the -totals argument is in use. This option is mutually exclusive with -du and -path.
-precision Specifies the precision for output. <int_num> is an integer value. The default value is -4. -quiet Creates the output ranktest file without any additional I/O. Optional. Default creates ranktest with full I/O (-verbose). Mutually exclusive with -concise and -verbose.
-rankfile <filename> Specifies the name of the ranktest file being created. Optional. Default if not specified is ranktest.rank. Can be specified with the vcover stats command to redisplay the results of this ranking.
-simtime Specifies that the files be ranked by minimum simulation time. Optional. Mutually exclusive to the -cputime and -fewest arguments.
-testassociated Ranks the coverage items in the selected database(s) including all the basic information (as created with -totals) as well as the associated tests and bins. Optional. This is the default ranktest. This argument is mutually exclusive with -totals.
-totals Ranks the coverage items in the specified database(s) with a basic level of information, including: coverage scopes, design scopes, and test plan scopes. Optional. Mutually exclusive with -testassociated.
-verbose Specifies the output files are created with full I/O. Optional. Mutually exclusive with -quiet and -concise. This is the default.
<UCDB_inputfile1> [... <UCDB_inputfileN>] Specifies the name of two or more non-merged UCDB file(s) to rank. Required, unless -input is specified one or more UCDB files to be ranked.
See also vcover merge, Code Coverage, coverage goal. coverage weight
430
Commands vcover report
vcover report
The vcover report command prints textual output of coverage statistics or exclusions from a previously saved code coverage run to a specified file. This allows you to produce reports "offline" (i.e., without having to load a simulation.) You can choose from a number of report output options using the arguments listed below. By default, the command prints out results from the current scope. To specify a certain path for the report, you can use the -instance argument, such as: vcover report -instance <path>
The command orders the output on a by-file basis unless you specify the -byinstance or -bydu argument. Syntax vcover report [<coverage_arguments>] -file <filename> vcover report [-version]
Global Arguments - Usable with any other arguments
vcover report [-append] [-details [-dumptables] [-fecanalysis] [-metricanalysis]] [-memory] [-zeros] [-precision <int>] [-recursive [-depth <n>]] [-file <filename>] [-xml]
Create HTML output from a UCDB
vcover report [-html [-verbose] [-nosource] [-noframes] [-nodetails] [-htmldir <outdir>] [threshL <val>] [-threshH <val>] <input_ucdb>]
Filtering Arguments - Used to filter one or more coverage types in the report
vcover report [-code {b | c | e | f | s | t}...]] [-testattr]

Code Coverage Arguments
vcover report [-bydu] [-byfile] [-byinstance] [-totals] [-noannotate] [-library <libname>] [-du <du_name>] [-package <pkgname>] [-source <filename>] [-instance <path> [-recursive [-depth <n>]] [-subscopes]
Exclusion-specific Coverage Arguments
vcover report [-excluded [-pragma | -user]]

Toggle-specific Coverage Arguments
vcover report [-toggles] [-verbose] [-all] [-top] [-select { inputs | outputs | inout | ports | internals }] Toggle coverage statistics are relevant only when reporting on instances or design units and are not produced on a per file basis. Toggle data is summed for all instances, and is reported by port or local name in the design unit, rather than by the connected signal. If you want toggle coverage statistics, you must specify either the -byinstance, -bydu, -instance <path>, or -du
431
<du_name> arguments. If you do not use those arguments, or you use the -source <filename> argument, toggle coverage statistics are excluded even if you specify -code t. To get an itemized list of the signals, the -details argument is also required. To report extended toggle coverage, ensure that you have compiled (vlog/vcom) with the -code x argument, then use vcover report with -code t. Arguments -all When reporting toggles, creates a report that lists both toggled and untoggled signals. Counts of all enumeration values are reported. Not a valid option when reporting on a functional coverage database. Optional. -append Appends the report data to the named output file. Optional. -bydu Reports coverage statistics by design unit (du). Optional. The simulator will iterate through all design units/modules in the design and report coverage data for each. Each design unit report will be the sum of all instances of that module and will be sorted by design unit name. Can be used with the -recursive [-depth <n>] argument to report on all design units contained within the specified design unit. You can also report coverage data for a specific design unit by using the -du <name> argument. -byfile Writes out a coverage summary for each source file in the design. Optional. This is the default report generated. A report generated with -byfile does not contain toggle information. -byinstance Writes out a coverage summary for all instances and packages. The default setting, if not used, is -byfile. Optional. -code {b | c | e | f | s | t}... Specifies which code coverage statistics to include in the report. Optional. If this argument is not specified, the report includes statistics for all categories you enabled at compile time. The characters are as follows: b Include branch statistics. c Include condition statistics. e Include expression statistics. f Include finite state machine statistics. s Include statement statistics. t Include toggle statistics.
432
For example, to includes statistics associated with each coverage item except toggles in the report, you would enter -code bcefs. -details [-dumptables] [-fecanalysis] [-metricanalysis] Includes details associated with each coverage item in the output (both UDP and FEC). By default, details are not provided. Optional. -dumptables forces printing of condition and expression truth tables even though fully covered. Optional. -fecanalysis reports which input patterns can be applied to the inputs to increment the expression/condition hit counts. Optional. -metricanalysis prints sum-of-product and basic sub-condition heuristic metrics from UDP expression/condition view. It reports hit counts for all rows in UPD table. To improve coverage numbers, find rows with 0 hits and exercise the inputs accordingly. See Expression and Condition Coverage Statistics for more information on metrics. Optional. -du <du_name> Reports coverage statistics for the specified design unit. Optional. <du_name> is <library name>.<primary>(<secondary>), where the library name is optional, and secondary name is required only for VHDL. If there are parameterized instances, all are considered to match the specified design unit. -excluded [-pragma | -user] Includes details on the exclusions in the specified coverage database input file. Optional. By default, this option includes both user exclusions and source code pragma exclusions, unless you specify -user or -pragma. The output is structured in DO file command format. -pragma When used with the -excluded argument, writes out only lines currently being excluded by pragmas. Optional. -user When used with the -excluded argument, writes out files and lines currently being excluded by the coverage exclude command. Optional. -file <filename> Specifies a file name for the report. Optional. Default is to write the report to the Transcript pane. Environment variables may be used in the pathname. -html [-verbose] [-nosource] [-noframes] [-nodetails] [-htmldir <outdir>] [-threshL <val>] [-threshH <val>] <input_ucdb> Generate an HTML coverage report on coverage data from a given UCDB file. Optional. You can use the -verbose option with -html to enable logging output for each file generated. The -html arguments listed below are not compatible with any other vcover report arguments. <input_ucdb> Specifies input UCDB file. Required, and only one is allowed. -verbose Prints out the files that are generated by the HTML report generator. Optional.
433
-nosource Used to avoid generation of the annotated source. Optional. This argument used if you have no source code, or if you dont want the annotated source to be generated. Note that this prevents you from accessing source code related data from inside the generated HTML report. -noframes Avoids generation of JavaScript-based tree for designs with a large number of design scopes. The report comes up as a single frame containing the top-level summary page and an HTML-only design scope index page is available as a link from the top-level page. -nodetails Omits coverage detail pages, saving time and disk space during report generation for very large designs. -htmldir <outdir> Specifies the name of output directory for resulting UCDB (default: "covhtmlreport"). Optional. Whether you specify an output directory or the default is used, any file or directory of that name is completely removed prior to report generation to prevent possible stale data. -threshL <%> -threshH <val> Specifies % of coverage at which colored cells change from red to yellow. Optional. -threshH <%> Specifies % of coverage at which colored cells change from yellow to green. Optional. The default output filename is index.html in the default directory, covhtmlreport. -instance <path> Writes out the source file summary coverage data for the selected instance. Optional. -library <libname> Only needs to be used when you have packages of the same name in different libraries. Optional. -memory Reports a coarse-grain analysis of capacity data for the following SystemVerilog constructs:
o o o o o
Classes Queues, dynamic arrays, and associative arrays (QDAS) Assertion and cover directives Covergroups Solver (calls to randomize())
Optional. When combined with -cvg and -details, this command reports the detailed memory usage of covergroup. These include the current persistent memory, current transient memory, peak transient memory, and peak time of the following:
o o
Per covergroup type Per coverpoint and cross in the type
434
Commands vcover report o o
Per covergroup instance (if applicable) Per coverpoint and cross in the instance (if applicable).
-noannotate Removes source code from the output report. Valid for code coverage only. Not applicable with -xml argument. Optional.
-nodetails Excludes details associated with each coverage item from the output. Details are included by default. Optional.
-package <pkgname> Prints a report on the specified VHDL package body. Needs to be of the form <lib>.<pkg>. Optional. This argument is equivalent to -du.
-precision <int> Sets the decimal precision for printing functional coverage information. Valid values for <int> are from 0 to 6 and default value is 1 (one). Optional.
-recursive [-depth <n>] Reports on the instance specified with -instance and every included instance, recursively. Can also be used with -details and -totals. Optional. -depth <n> Used with the -recursive argument, it specifies the maximum recursive depth. A depth of 1 is the same as no recursion at all. Optional.
-select { inputs | outputs | inout | ports | internals } Reports on input, output, inout, all ports, or internal signals. Can be used with the -toggles argument. Optional.
-source <filename> Writes a summary of statement coverage data for a specific source file. Optional. Environment variables may be used in the pathname.
-subscopes Reports code coverage data in unrolled generate blocks. They are reported in byinstance mode. Optional.
-testattr Display test attributes in the report. Optional. -totals Writes out a total summary of the specified instance, recursively. Optional. Useful for tracking changes. Without this argument, the report writes out an instance summary for each of the instances. The report prints only one summary if -totals option is used. Also, when the -totals argument is specified, the alias nodes are not counted.
435
-toggles Writes out all (and only) the toggles in the entire design (not including alias nodes), or under the instance specified by -instance <path>. Optional. Valid during simulation, postprocessing, and in vcover. The toggle report generated with this argument is written in the style of reports generated by toggle report.
-top For signals that were added to toggle coverage using vcom or vlog -cover t, -top uses the name of the top-most element of multiple-segment (collapsed) nets. Optional. By default the name of the wildcard-matching segment will be used.
-verbose Prints a report listing all the integer values and their counts an integer toggle encounters during the run. Optional. List will include the number of active assertion threads (Active Count) and number of active root threads (Peak Active Count) that have occurred up to the current time.
-version Returns the version number of UCDB file used to create the report. This argument can not be combined with any other arguments; when present, it invalidates all other arguments. Optional.
-xml Outputs report in XML format. A report created with -xml does not contain source file lines (calls -noannotate implicitly). Optional. This implicitly sets the -details argument. Refer to Reporting Coverage Data for more information.
-zeros Writes out a file-based summary of lines, including file names and line numbers, that have not been executed (zero hits), annotates the source code, and supports the -source and -instance options. Optional. Optional. Cannot be used in tandem with the -recursive argument. For a detailed report that includes line numbers, use: vcover report -zeros -details.
<file> Specifies the previously saved code coverage file on which you want to report. Required.
Examples Write a top-level summary of the number of instances, statements, branches, hits, and signal toggles to myreport.txt.
vcover report -totals -file myreport.txt input.ucdb
Write detailed branch, condition, and statement statistics from save.ucdb, without associated source code, to stdout.
436
Commands vcover report vcover report -details -code bcs save.ucdb
Write a summary of code coverage for all instances in save.cov to stdout.

vcover report save.ucdb
Write code coverage details of all instances in input.ucdb to save.cov. The -details option reports coverage statistics for each statement and branch. Branch coverage statistics will following statement statistics and will be presented in four columns: line, column, true branch count, false branch count.
vcover report -details -file save.cov input.ucdb
Write code coverage details of one specific instance to save.cov.

vcover report -details -instance /top/p -file save.cov input.ucdb
Write a summary of coverage by source file for coverage less than or equal to 90%.
vcover report -details -below 90 -file myreport.txt input.ucdb
Write a list of statements with zero coverage to myzerocov.txt.

vcover report -zeros -file myzerocov.txt input.ucdb
See also Code Coverage, coverage save, coverage report,
437
Commands vcover stats
vcover stats
The vcover stats command computes and prints to stdout summary statistics for previously saved code coverage databases. It can be invoked within the ModelSim GUI or at the command line. vcover stats creates coverage statistics output that is equivalent to the output from this command:
vcover report -totals -byinstance
Syntax vcover stats [-assert] [-code {b | c | e | f | s | t}...] [-memory] [-precision <int>][-precision <int>] <file1> [<file2> <filen>] Arguments -assert Reports only assertion coverage data. Optional. -code {b | c | e | f | s | t}... Specifies which code coverage statistics to include in the report. Optional. By default the report includes statistics for all categories you enabled at compile time. The characters are as follows: b Include branch statistics. c Include condition statistics. e Include expression statistics. f Include finite state machine statistics. s Include statement statistics. t Include toggle statistics. -inputs <pathname> Specifies a text file containing input filenames for which you want to produce statistics. Optional. -memory Reports a coarse-grain analysis of capacity data for the following SystemVerilog constructs (Optional):
o o o o
Classes Queues, dynamic arrays, and associative arrays (QDAS) Assertion and cover directives Covergroups
438
Commands vcover stats o
Solver (calls to randomize())
-precision <int> Sets the decimal precision for printing functional coverage information. Valid values for <int> are from 0 to 6 and default value is 1 (one). Optional.
<file1> [<file2> <filen>] Specifies the file(s) for which you want summary statistics, including .rank file created by vcover ranktest. Required. Multiple pathnames and wildcards are allowed.
See also coverage save, vcover merge, Code Coverage, coverage report, vcover ranktest
439
Commands vcover testnames
vcover testnames
The vcover testnames command displays the testnames in the currently loaded UCDB file. If a merged file, it gives you a list of tests in the merged file. By default, the testname is the name of the UCDB file, though you can set it to whatever you want. Syntax coverage testnames [-tcl] Arguments -tcl Print attribute information in a tcl format. Optional. See also Code Coverage, Verification Management Window, coverage attribute, coverage exclude, coverage goal, coverage report, coverage save, coverage testnames, coverage weight, vcover merge, vcover ranktest, vcover stats
440
Commands vdel
vdel
The vdel command deletes a design unit from a specified library. Syntax vdel [-help] [-lib <library_name>] [-verbose] [-all | <design_unit> [<arch_name>] | -allsystemc] Arguments -all Deletes an entire library. Optional. BE CAREFUL! Libraries cannot be recovered once deleted, and you are not prompted for confirmation. -allsystemc Deletes all SystemC modules in a design from the working directory. Optional. <arch_name> Specifies the name of an architecture to be deleted. Optional. If omitted, all of the architectures for the specified entity are deleted. Invalid for a configuration or a package. <design_unit> Specifies the entity, package, configuration, or module to be deleted. Required unless -all is used. This option is not supported for SystemC modules. -help Displays the commands options and arguments. Optional. -lib <library_name> Specifies the logical name or pathname of the library that holds the design unit to be deleted. Optional. By default, the design unit is deleted from the work library. -verbose Displays progress messages. Optional. Examples Delete the work library.
vdel -all
Delete the synopsys library.

vdel -lib synopsys -all
Delete the entity named xor and all its architectures from the work library.
vdel xor
Delete the architecture named behavior of the entity xor from the work library.
441
Commands vdel vdel xor behavior
Delete the package named base from the work library.

vdel base
442
Commands vdir
vdir
The vdir command lists the contents of a design library. This command can also be used to check compatibility of a vendor library. If vdir cannot read a vendor-supplied library, the library may not be ModelSim compatible. SystemC modules are listed with this command. Syntax vdir [-help] [-l | [-prop <prop>]] [-r] [-all | [-lib <library_name>]] [<design_unit>] Arguments -help Displays options and arguments for this command. Optional. -l Prints the version of vcom, vlog, or sccom with which each design unit was compiled, plus any compilation options used. Also prints the object-code version number that indicates which versions of vcom/vlog/sccom and ModelSim are compatible. -prop <prop> Reports on the specified design unit property, as listed in Table 2-9. If you do not specify a value for <prop>, an error message is displayed. Table 2-9. Design Unit Properties Value of <prop> archcfg bbox body default dir dpnd entcfg extern inline lrm mtime name opcode Description configuration for arch blackbox for optimized design needs a body default options source directory depends on configuration for entity package reference number module inlined language standard source modified time short name opcode format
443
Commands vdir
Table 2-9. Design Unit Properties Value of <prop> options root src top ver vlogv voptv -r Prints architecture information for each entity in the output. -all Lists the contents of all libraries listed in the Library section of the active modelsim.ini file. Optional. Refer to Library Path Variables for more information. -lib <library_name> Specifies the logical name or the pathname of a library to be listed. Optional. By default, the contents of the work library are listed. <design_unit> Indicates the design unit to search for within the specified library. If the design unit is a VHDL entity, its architectures are listed. Optional. By default all entities, configurations, modules, packages, and optimized design units in the specified library are listed. Examples List the architectures associated with the entity named my_asic that reside in the HDL design library called design.
vdir -lib design my_asic
Description compile options optimized Verilog design root source file top level model version number Verilog version Verilog optimized version
Show the output of vdir -l, including any compilation options used to compile the library:
> > > > > > > > > > > # MODULE ram_tb # Verilog Version: RV9i]?9FGhibjG<jXXV_`1 # Version number: CRW2<UhheaW;LIL2_B5o31 # Source modified time: 1132284874 # Source file: ram_tb.v # Version number: CRW2<UhheaW;LIL2_B5o31 # Opcode format: 6.1c; VLOG SE Object version 31 # Optimized Verilog design root: 1 # Language standard: 1 # Compile options: -cover bcst # Compile defaults: GenerateLoopIterationMax=100000
444
Commands vdir > # Source directory: C:\Verif\QuestaSim_6.1c \examples\tutorials\verilog\memory
445
Commands vencrypt
vencrypt
The vencrypt command encrypts Verilog and SystemVerilog code contained within encryption envelopes. The code is not pre-processed before encryption, so macros and other `directives are unchanged. This allows IP vendors to deliver encrypted IP with undefined macros and `directives. Upon execution of this command, the filename extension will be changed to .vp for Verilog files (.v files) and .svp for SystemVerilog files (.sv files). As the vencrypt utility processes the file (or files), if it does not find any encryption directives it reprocesses the file using the following default encryption:
`pragma `pragma pragma pragma `pragma `pragma protect protect protect protect protect protect data_method = "aes128-cbc" key_keyowner = "MTI" key_keyname = "MGC-DVT-MTI" key_method = "rsa" key_block encoding = (enctype = "base64") begin
The vencrypt command must be followed by a compile command such as vlog for the design to be compiled. Syntax vencrypt <filename> [-d <dirname>] [-e <extension>] [-f <filename>] [-h <filename>] [-help] [-l <filename>] [-o <filename>] [-p <prefix>] [-quiet] <filename> Specifies the name of the Verilog source code file to encrypt. One filename is required. Multiple filenames can be entered separated by spaces. Wildcards can be used. Default encryption pragmas will be used, as described above, if no encryption directives are found during processing. -d <dirname> Specifies directory that will contain encrypted Verilog files. Optional. If no directory is specified, current working directory will be used. The original file extension (.v for Verilog and .sv for SystemVerilog) will be preserved. -e <extension> Specifies a filename extension. Optional. -f <filename> Specifies a file with more command line arguments. Optional. Allows complex arguments to be reused without retyping. Nesting of -f options is allowed. Refer to the section "Argument Files" for more information. -h <filename> Concatenates header information, specified by <file>, into all design files listed with <filename>. Optional. Allows the user to pass a large number of files to the vencrypt utility that do not contain the `pragma protect or `protect information about how to encrypt the
446
Commands vencrypt
file. Saves the user from editing hundreds of files to add in the same `pragma protect to every file. -help Displays vencrypt command arguments. Optional. -l <filename> Redirects output to the file designated by <filename>. Optional. -o <filename> Combines all encrypted output into a single file. Optional. -p <prefix> Prepends file names with a prefix. Optional. -quiet Disables encryption messages. Optional. See also "Protecting Your Source Code" in the Users Manual Example Insert header information into all design files listed.
vencrypt -h encrypt_head top.v cache.v gates.v memory.v
The encrypt_head file may look like the following:

`pragma `pragma `pragma `pragma `pragma protect protect protect protect protect data_method = "aes128-cbc" author = "IP Provider" key_keyowner = "MTI", key_method = "rsa" key_keyname = "MGC-DVT-MTI" begin
There is no `pragma protect end expression in the header file, just the header block that starts the encryption. The `pragma protect end expression is implied by the end of the file. For more detailed examples, see "Protecting Your Source Code" in the Users Manual.
447
Commands verror
verror
The verror command prints a detailed description about a message number. It may also point to additional documentation related to the error. Syntax verror [-fmt | -tag | -fmt -tag | -full] <msgNum> ... verror [-fmt | -tag | -fmt -tag | -full] [-tool <tool>] -all verror -ranges verror -help Arguments -fmt | -tag | -full Specifies the type and amount of information to return. -fmt returns the format string used in the error message. -tag returns a tag associated with the error message. -full returns the format string, tag, and complete text associated with the error message. [-tool <tool>] -all Allows you to return information about all error messages. -all returns all error messages. -tool <tool> -all returns all error messages associated with the specified tool, where <tool> can be one of the following: common vlog wlf vsim-systemc pseudo_synth <msgNum> Specifies the message number(s) you would like more information about. You can find the message number in messages of the format: ** <Level>: ([<Tool>-[<Group>-]]<MsgNum>) <FormattedMsg> You can specify <msgNum> any number of times for one verror command. It is suggested that you use a space-separated list. -ranges Prints the numeric ranges of error message numbers, organized by tool. vcom vsim vsim-sccom ucdb vcom-vlog vsim-vish sccom vsim-vlog
448
Commands verror
Example If you receive the following message in the transcript:

** Error (vsim-3061) foo.v(22): Too many Verilog port connections.
and you would like more information about this message, you would type:
verror 3061
and receive the following output:

Message # 3061: Too many Verilog ports were specified in a mixed VHDL/Verilog instantiation. Verify that the correct VHDL/Verilog connection is being made and that the number of ports matches. [DOC: ModelSim User's Manual - Mixed VHDL and Verilog Designs Chapter]
449
Commands vgencomp
vgencomp
Once a Verilog module is compiled into a library, you can use the vgencomp command to write its equivalent VHDL component declaration to standard output. Optional switches allow you to generate bit or vl_logic port types; std_logic port types are generated by default. Syntax vgencomp [-help] [-lib <library_name>] [-b] [-s] [-v] <module_name> Arguments -help Displays the commands options and arguments. Optional. -lib <library_name> Specifies the pathname of the working library. If not specified, the default library work is used. Optional. -b Causes vgencomp to generate bit port types. Optional. -s Used for the explicit declaration of default std_logic port types. Optional. -v Causes vgencomp to generate vl_logic port types. Optional. <module_name> Specifies the name of the Verilog module to be accessed. Required. Examples This example uses a Verilog module that is compiled into the work library. The module begins as Verilog source code:
module top(i1, o1, o2, io1); parameter width = 8; parameter delay = 4.5; parameter filename = "file.in"; input i1; output [7:0] o1; output [4:7] o2; inout [width-1:0] io1; endmodule
After compiling, vgencomp is invoked on the compiled module:

vgencomp top
450
Commands vgencomp
and writes the following to stdout:

component top generic( width delay filename ); port( i1 o1 o2 io1 ); end component;
: integer := 8; : real := 4.500000; : string := "file.in"
: : : :
in out out inout
std_logic; std_logic_vector(7 downto 0); std_logic_vector(4 to 7); std_logic_vector
451
Commands view
view
The view command displays a stand-alone window or Main window pane. If multiple instances of a stand-alone window exist, view will change the default window of that type to the specified window. Using the -new option, view will create an additional instance of the specified stand-alone window type and set it to be the default window for that type. Names for windows are generated as follows: The first window name (automatically created without using -new) has the same name as the window type. Additional window names created by -new append an integer to the window type, starting with 1.
To remove a window, use the noview command. The view command without arguments returns a list of window class names of all the windows currently open. The view command with one or more options and no window classes or window names specified applies the options to the currently open windows. See examples for additional details. Syntax view [*] [-height <n>] [-icon] [-new] [-title {New Window Title}] [-undock | -dock] [-width <n>] [-x <n>] [-y <n>] <window_type> Arguments * Specifies that all windows be opened. Optional. -height <n> Specifies the window height in pixels. Valid only for stand-alone windows, not panes in the Main window. Optional. -icon Toggles the view between window and icon. Valid only for stand-alone windows, not panes in the Main window. Optional. -new Creates a new instance of the window type specified with the <window_type> argument. Valid only for stand-alone windows, not panes in the Main window. Optional. New window names are created by appending an integer to the window type, starting with 1, then incrementing the integer. -title {New Window Title} Specifies the window title of the designated window. Curly braces are only needed for titles that include spaces. Double quotes can be used in place of braces, for example "New Window Title". If the new window title does not include spaces, no braces or quotes are
452
Commands view
needed. For example: -title new_wave wave assigns the title new_wave to the Wave window. -undock Opens the specified pane as a standalone window, undocked from the Main window. Optional. -dock Docks the specified standalone window into the Main window. -width <n> Specifies the window width in pixels. Valid only for stand-alone windows, not panes in the Main window. Optional. <window_type> Specifies the window/pane type to view. Required. You do not need to type the full type name (see examples below); implicit wildcards are accepted; multiple window types are accepted. Available window/pane types are: capacity,dataflow, details, exclusions, instances, list, locals, memory, missed, objects, process, profiledetails, profilemain, signals, structure, variables, wave, watch, workspace When you specify a window type and also use the -new argument, you create a new instance of that stand-alone window type. You may also specify the window(s) to view when multiple instances of that window type exist (such as wave2). This works only with window names generated by ModelSim, not with window titles specified with the -title argument. -x <n> Specifies the window upper-left-hand x-coordinate in pixels. Valid only for stand-alone windows, not panes in the Main window. Optional. -y <n> Specifies the window upper-left-hand y-coordinate in pixels. Valid only for stand-alone windows, not panes in the Main window. Optional. Examples Undock the Wave pane from the Main window and makes it a standalone window.
view -undock wave
Undock all currently open panes in the Main window.

view -undock
Display the Watch and Wave panes.

view w
453
Commands view
Display the Objects and Active Process panes.

view ob pr
Open a new Wave window with My Wave Window as its title.

view -title {My Wave Window} wave
The first command creates a window named wave. The second command creates a window named wave1. Its full Tk path is .wave1. Wave1 is now the default Wave window. Any add wave command would add objects to wave1.
view wave view -new wave
Change the default Wave window back to wave.

view wave
Will override the default Wave window and add mysig to wave1.
add wave -win .wave1 mysig
See also noview
454
Commands virtual count
virtual count
The virtual count command counts the number of currently defined virtuals that were not read in using a macro file. Syntax virtual count [-kind <kind>] [-unsaved] Arguments -kind <kind> Specifies a subset of virtuals to look at. Optional. <kind> can be implicits and explicits. Unique abbreviations are accepted. -unsaved Specifies that the count include only those virtuals that have not been saved to a macro file. Optional. See also virtual define, virtual save, virtual show, Virtual Objects
455
Commands virtual define
virtual define
The virtual define command prints to the Transcript pane the definition of the virtual signal or function in the form of a command that can be used to re-create the object. Syntax virtual define [-kind <kind>] <pathname> Arguments -kind <kind> Specifies a subset of virtuals to look at. Optional. <kind> can be implicits and explicits. Unique abbreviations are accepted. <pathname> Specifies the path to the virtual(s) for which you want definitions. Required. Wildcards can be used. Examples Show the definitions of all the virtuals you have explicitly created.
virtual define -kind explicits *
See also virtual describe, virtual show, Virtual Objects
456
Commands virtual delete
virtual delete
The virtual delete command removes the matching virtuals. Syntax virtual delete [-kind <kind>] <pathname> Arguments -kind <kind> Specifies a subset of virtuals to look at. Optional. <kind> can be implicits and explicits. Unique abbreviations are accepted. <pathname> Specifies the path to the virtual(s) you want to delete. Required. Wildcards can be used. Examples Delete all of the virtuals you have explicitly created.
virtual delete -kind explicits *
See also virtual signal, virtual function, Virtual Objects
457
Commands virtual describe
virtual describe
The virtual describe command prints to the Transcript pane a complete description of the data type of one or more virtual signals. Similar to the existing describe command. Syntax virtual describe [-kind <kind>] <pathname> Arguments -kind <kind> Specifies a subset of virtuals to look at. Optional. <kind> can be implicits and explicits. Unique abbreviations are accepted. <pathname> Specifies the path to the virtual(s) for which you want descriptions. Required. Wildcards can be used. Examples Describe the data type of all virtuals you have explicitly created.
virtual describe -kind explicits *
See also virtual define, virtual show, Virtual Objects
458
Commands virtual expand
virtual expand
The virtual expand command produces a list of all the non-virtual objects contained in the specified virtual signal(s). This can be used to create a list of arguments for a command that does not accept or understand virtual signals. Syntax virtual expand [-base] <pathname> Arguments -base Causes the root signal parent to be output in place of a subelement. Optional. For example:
vcd add [virtual expand -base myVirtualSignal]
the resulting command after substitution would be:

vcd add signala signalb signalc
<pathname> Specifies the path to the signals and virtual signals to expand. Required. Wildcards can be used. Any number of paths can be specified.
Examples Add the elements of a virtual signal to the VCD file. In the Tcl language, the square brackets specify that the enclosed command should be executed first ("virtual expand "), then the result substituted into the surrounding command.
vcd add [virtual expand myVirtualSignal]
So if myVirtualSignal is a concatenation of signala, signalb.rec1 and signalc(5 downto 3), the resulting command after substitution would be:
vcd add signala signalb.rec1 {signalc(5 downto 3)}
The slice of signalc is quoted in curly braces, because it contains spaces. See also virtual signal, Virtual Objects
459
Commands virtual function
virtual function
The virtual function command creates a new signal, known only by the GUI (not the kernel), that consists of logical operations on existing signals and simulation time, as described in <expressionString>. It cannot handle bit selects and slices of Verilog registers. Please see Syntax and Conventions for more details on syntax. If the virtual function references more than a single scalar signal, it will display as an expandable object in the Wave and Objects windows. The children correspond to the inputs of the virtual function. This allows the function to be "expanded" in the Wave window to see the values of each of the input waveforms, which could be useful when using virtual functions to compare two signal values. Virtual functions can also be used to gate the List window display. Syntax virtual function [-env <path>] [-install <path>] [-delay <time>] {<expressionString>} <name> Arguments Arguments for virtual function are the same as those for virtual signal, except for the contents of the expression string. -env <path> Specifies a hierarchical context for the signal names in <expressionString> so they don't all have to be full paths. Optional. -install <path> Causes the newly-created signal to become a child of the specified region. If -install is not specified, the newly-created signal becomes a child of the nearest common ancestor of all objects appearing in <expressionString>. If the expression references more than one WLF file (dataset), the virtual signal will automatically be placed in region virtuals:/Functions. Optional. -delay <time> Specifies a value by which the virtual function will be delayed. Optional. You can use negative values to look forward in time. If units are specified, the <time> option must be enclosed in curly braces. See the examples below for more details. {<expressionString>} A text string expression in the MTI GUI expression format. Required. See GUI_expression_format for more information. <name> The name you define for the virtual signal. Required. Case is ignored unless installed in a Verilog region. Use alpha, numeric, and underscore characters only, unless you are using
460
VHDL extended identifier notation. If using VHDL extended identifier notation, <name> needs to be quoted with double quotes or with curly braces. Examples Create a signal /chip/section1/clk_n that is the inverse of /chip/section1/clk.
virtual function { not /chip/section1/clk } clk_n
Create a std_logic_vector equivalent of a Verilog register rega and installs it as /chip/rega_slv.

virtual function -install /chip { (std_logic_vector) chip.vlog.rega } rega_slv
Create a boolean signal /chip/addr_eq_fab that is true when /chip/addr[11:0] is equal to hex "fab", and false otherwise. It is acceptable to mix VHDL signal path notation with Verilog part-select notation.
virtual function { /chip/addr[11:0] == 0xfab } addr_eq_fab
Create a signal that is high only during times when signal /chip/siga of the gate-level version of the design does not match /chip/siga of the rtl version of the design. Because there is no common design region for the inputs to the expression, siga_diff is installed in region virtuals:/Functions. The virtual function siga_diff can be added to the Wave window, and when expanded will show the two original signals that are being compared.
virtual function { gate:/chip/siga XOR rtl:/chip/siga } siga_diff
Create a virtual signal consisting of the logical "AND" function of /top/signalA with /top/signalB, and delays it by 10 ns.
virtual function -delay {10 ns} {/top/signalA AND /top/signalB} myDelayAandB
Create a one-bit signal outbus_diff which is non-zero during times when any bit of /chip/outbus in the gate-level version doesnt match the corresponding bit in the rtl version. This expression uses the "OR-reduction" operator, which takes the logical OR of all the bits of the vector argument.
virtual function { | (gate:/chip/outbus XOR rtl:/chip/outbus) } outbus_diff
Commands fully compatible with virtual functions
add list
add log, log
add wave
461
checkpoint restore down up restart searchlog
delete examine left right show
describe ("virtual describe" is a little faster) find search
Commands not currently compatible with virtual functions
check contention add check float add check stable on force power report toggle reset when See also
check contention config check float config check stable off noforce power reset toggle report
check contention off check float off drivers power add toggle add vcd add
virtual count virtual describe virtual log virtual region virtual signal
virtual define virtual expand virtual nohide virtual save virtual type
virtual delete virtual hide virtual nolog virtual show Virtual Objects
462
Commands virtual hide
virtual hide
The virtual hide command causes the specified real or virtual signals to not be displayed in the Objects window. This is used when you want to replace an expanded bus with a user-defined bus. You make the signals reappear using the virtual nohide command. Syntax virtual hide [-kind <kind>]|[-region <path>] <pattern> Arguments -kind <kind> Specifies a subset of virtuals to look at. Optional. <kind> can be implicits and explicits. Unique abbreviations are accepted. -region <path> Used in place of -kind to specify a region of design space in which to look for the signal names. Optional. <pattern> Indicates which signal names or wildcard patterns should be used in finding the signals to hide. Required. Any number of names or wildcard patterns may be used. See also virtual nohide, Virtual Objects
463
Commands virtual log
virtual log
The virtual log command causes the simulation-mode dependent signals of the specified virtual signals to be logged by the kernel. If wildcard patterns are used, it will also log any normal signals found, unless the -only option is used. You unlog the signals using the virtual nolog command. Syntax virtual log [-kind <kind>] | [-region <path>] [-recursive] [-only] [-in] [-out] [-inout] [-internal] [-ports] <pattern> Arguments -kind <kind> Specifies a subset of virtuals to look at. Optional. <kind> can be implicits and explicits. Unique abbreviations are accepted. -region <path> Used in place of -kind to specify a region of design space in which to look for signals to log. Optional. -recursive Specifies that the scope of the search is to descend recursively into subregions. Optional. If omitted, the search is limited to the selected region. -only Can be used with a wildcard to specify that only virtual signals (as opposed to all signals) found by the wildcard should be logged. Optional. -in Specifies that the kernel log data for ports of mode IN whose names match the specification. Optional. -out Specifies that the kernel log data for ports of mode OUT whose names match the specification. Optional. -inout Specifies that the kernel log data for ports of mode INOUT whose names match the specification. Optional. -internal Specifies that the kernel log data for internal (non-port) objects whose names match the specification. Optional. -ports Specifies that the kernel log data for all ports. Optional.
464
Commands virtual log
<pattern> Indicates which signal names or wildcard patterns should be used in finding the signals to log. Required. Any number of names or wildcard patterns may be used.
See also virtual nolog, Virtual Objects
465
Commands virtual nohide
virtual nohide
The virtual nohide command reverses the effect of a virtual hide command, causing the specified real or virtual signals to reappear the Objects window. Syntax virtual nohide [-kind <kind>]|[-region <path>] <pattern> Arguments -kind <kind> Specifies a subset of virtuals to look at. Optional. <kind> can be implicits and explicits. Unique abbreviations are accepted. -region <path> Used in place of -kind to specify a region of design space in which to look for the signal names. Optional. <pattern> Indicates which signal names or wildcard patterns should be used in finding the signals to expose. Required. Any number of names or wildcard patterns may be used. See also virtual hide, Virtual Objects
466
Commands virtual nolog
virtual nolog
The virtual nolog command reverses the effect of a virtual log command. It causes the simulation-dependent signals of the specified virtual signals to be excluded ("unlogged") by the kernel. If wildcard patterns are used, it will also unlog any normal signals found, unless the -only option is used. Syntax virtual nolog [-kind <kind>] | [-region <path>] [-recursive] [-only] [-in] [-out] [-inout] [-internal] [-ports] <pattern> Arguments -kind <kind> Specifies a subset of virtuals to look at. Optional. <kind> can be implicits and explicits. Unique abbreviations are accepted. -region <path> Used in place of -kind to specify a region of design space in which to look for signals to unlog. Optional. -recursive Specifies that the scope of the search is to descend recursively into subregions. Optional. If omitted, the search is limited to the selected region. -only Can be used with a wildcard to specify that only virtual signals (as opposed to all signals) found by the wildcard should be unlogged. Optional. -in Specifies that the kernel exclude data for ports of mode IN whose names match the specification. Optional. -out Specifies that the kernel exclude data for ports of mode OUT whose names match the specification. Optional. -inout Specifies that the kernel exclude data for ports of mode INOUT whose names match the specification. Optional. -internal Specifies that the kernel exclude data for internal (non-port) objects whose names match the specification. Optional.
467
Commands virtual nolog
-ports Specifies that the kernel exclude data for all ports. Optional. <pattern> Indicates which signal names or wildcard pattern should be used in finding the signals to unlog. Required. Any number of names or wildcard patterns may be used.
See also virtual log, Virtual Objects
468
Commands virtual region
virtual region
The virtual region command creates a new user-defined design hierarchy region. Syntax virtual region <parentPath> <regionName> Arguments <parentPath> The full path to the region that will become the parent of the new region. Required. <regionName> The name you want for the new region. Required. See also virtual function, virtual signal, Virtual Objects Note Virtual regions cannot be used in the when command.
469
Commands virtual save
virtual save
The virtual save command saves the definitions of virtuals to a file. Syntax virtual save [-kind <kind>] [-append] [<filename>] Arguments -kind <kind> Specifies a subset of virtuals to look at. Optional. <kind> can be implicits and explicits. Unique abbreviations are accepted. -append Specifies to save only virtuals that are not already saved or werent read in from a macro file. These unsaved virtuals are then appended to the specified or default file. Optional. <filename> Used for writing the virtual definitions. Optional. If you dont specify <filename>, the default virtual filename (virtuals.do) will be used. You can specify a different default in the pref.tcl file. See also virtual count, Virtual Objects
470
Commands virtual show
virtual show
The virtual show command lists the full path names of all explicitly defined virtuals. Syntax virtual show [-kind <kind>] Arguments -kind <kind> Specifies a subset of virtuals to look at. Optional. <kind> can be implicits and explicits. Unique abbreviations are accepted. See also virtual define, virtual describe, Virtual Objects
471
Commands virtual signal
virtual signal
The virtual signal command creates a new signal, known only by the GUI (not the kernel), that consists of concatenations of signals and subelements as specified in <expressionString>. It cannot handle bit selects and slices of Verilog registers. Please see Concatenation of Signals or Subelements for more details on syntax. Syntax virtual signal [-env <path>] [-install <path>] [-delay <time>] {<expressionString>} <name> Arguments -env <path> Specifies a hierarchical context for the signal names in <expressionString>, so they don't all have to be full paths. Optional. -install <path> Causes the newly-created signal to become a child of the specified region. If -install is not specified, the newly-created signal becomes a child of the nearest common ancestor of all objects appearing in <expressionString>. If the expression references more than one WLF file (dataset), the virtual signal will automatically be placed in region virtuals:/Signals. Optional. -delay <time> Specifies a value by which the virtual signal will be delayed. Optional. You can use negative values to look forward in time. If units are specified, the <time> option must be enclosed in curly braces. See the examples below for more details. {<expressionString>} A text string expression in the MTI GUI expression format that defines the signal and subelement concatenation. Can also be a literal constant or computed subexpression. Required. For details on syntax, please see Syntax and Conventions. <name> The name you define for the virtual signal. Required. Case is ignored unless installed in a Verilog region. Use alpha, numeric, and underscore characters only, unless you are using VHDL extended identifier notation. If using VHDL extended identifier notation, <name> needs to be quoted with double quotes or with curly braces. Examples Reconstruct a bus sim:/chip/alu/a(4 downto 0), using VHDL notation, assuming that a_ii are all scalars of the same type.
virtual signal -env sim:/chip/alu { (concat_range (4 downto 0))(a_04 & a_03 & a_02 & a_01 & a_00) } a
472
Commands virtual signal
Reconstruct a bus sim:chip.alu.a[4:0], using Verilog notation. Note that the concatenation notation starts with "&{" rather than "{".
virtual signal -env sim:chip.alu { (concat_range [4:0])&{a_04, a_03, a_02, a_01, a_00} } a
Create a signal sim:/testbench/stuff which is a record type with three fields corresponding to the three specified signals. The example assumes /chipa/mode is of type integer, /chipa/alu/a is of type std_logic_vector, and /chipa/decode/inst is a userdefined enumeration.
virtual signal -install sim:/testbench { /chipa/alu/a(19 downto 13) & /chipa/decode/inst & /chipa/mode } stuff
Create a virtual signal that is the same as /top/signalA except it is delayed by 10 ps.
virtual signal -delay {10 ps} {/top/signalA} myDelayedSignalA
Create a three-bit signal, chip.address_mode, as an alias to the specified bits.

virtual signal { chip.instruction[23:21] } address_mode
Concatenate signals a, b, and c with the literal constant 000.

virtual signal {a & b & c & 3'b000} myextendedbus
Add three missing bits to the bus num, creates a virtual signal fullbus, and then adds that signal to the Wave window.
virtual signal {num & "000"} fullbus add wave -unsigned fullbus
Reconstruct a bus that was fragmented by synthesis and is missing the lower three bits. Note that you would have to type in the actual bit names (i.e. num28, num27, etc.) represented by the in the syntax above.
virtual signal { num31 & num30 & num29 & ... & num4 & num3 & "000" } fullbus add wave -unsigned fullbus
Create a two-bit signal (with an enumerated type) based on the results of the subexpressions. For example, if aold equals anew, then the first bit is true (1). Alternatively, if bold does not equal bnew, the second bit is false (0). Each subexpression is evaluated independently.
virtual signal {(aold == anew) & (bold == bnew)} myequalityvector
Create signal newbus that is a concatenation of bus1 (bit-reversed) and bus2[7:4] (bitreversed). Assuming bus1 has indices running 7 downto 0, the result will be newbus[11:0] with the upper 8 bits being bus1[0:7] and the lower 4 bits being bus2[4:7]. See Concatenation Directives for further details.
473
Commands virtual signal virtual signal {(concat_reverse)(bus1 & bus2[7:4])} newbus
Commands fully compatible with virtual signals
add list checkpoint restore down up force noforce search
add log log delete examine restart searchlog
add wave describe ("virtual describe" is a little faster) find left right show
Commands compatible with virtual signals using [virtual expand <signal>]
check contention add check float add check stable on power add toggle add vcd add
check contention config check float config check stable off power report toggle reset
check contention off check float off drivers power reset toggle report
Commands not currently compatible with virtual signals when See also
virtual count virtual describe virtual log virtual region virtual function
virtual define virtual expand virtual nohide virtual save virtual type
virtual delete virtual hide virtual nolog virtual show Virtual Objects
474
Commands virtual type
virtual type
The virtual type command creates a new enumerated type, known only by the GUI, not the kernel. Virtual types are used to convert signal values to character strings. The command works with signed integer values up to 64 bits. Virtual types cannot be used in the when command. Syntax virtual type -delete <name> | {<list_of_strings>} <name> Arguments -delete <name> Deletes a previously defined virtual type. <name> is the name you gave the virtual type when you originally defined it. Required if not defining a type. {<list_of_strings>} A list of values and their associated character strings. Required if -delete is not used. Values can be expressed in decimal or based notation and can include "dont-cares" (see examples below). Three kinds of based notation are supported: Verilog, VHDL, and C-language styles. The values are interpreted without regard to the size of the bus to be mapped. Bus widths up to 64 bits are supported. There is currently no restriction on the contents of each string, but if strings contain spaces they would need to be quoted, and if they contain characters treated specially by Tcl (square brackets, curly braces, backslashes), they would need to be quoted with curly braces. See the examples below for further syntax. <name> The user-defined name of the virtual type. Required if -delete is not used. Case is not ignored. Use alpha, numeric, and underscore characters only, unless you are using VHDL extended identifier notation. If using VHDL extended identifier notation, <name> needs to be quoted with double quotes or with curly braces. Examples Using positional notation, associates each string with an enumeration index, starting at zero and increasing by one in the positive direction.When myConvertedSignal is displayed in the Wave, List, or Objects window, the string "state0" will appear when mysignal == 0, "state1" when mysignal == 1, "state2" when mysignal == 2, etc.
virtual type {state0 state1 state2 state3} mystateType virtual function {(mystateType)mysignal} myConvertedSignal add wave myConvertedSignal
Use sparse mapping of bus values to alphanumeric strings for an 8-bit, one-hot encoding. It shows the variety of syntax that can be used for values. The value "default" has special meaning and corresponds to any value not explicitly specified.
475
Commands virtual type virtual type {{0 NULL_STATE} {1 st1} {2 st2} {0x04 st3} {16'h08 st4} \ {'h10 st5} {16#20 st6} {0b01000000 st7} {0x80 st8} \ {default BAD_STATE}} myMappedType virtual function {(myMappedType)mybus} myConvertedBus add wave myConvertedBus
Delete the virtual type "mystateType".

virtual type -delete mystateType
Create a virtual type that includes "dont-cares" (the - character).

virtual type {{0x01-- add}{0x02-- sub}{default bad}} mydecodetype
Create a virtual type using a mask for "dont-cares." The middle field is the mask, and the mask should have bits set to 1 for the bits that are don't care.
virtual type {{0x0100 0xff add}{0x0200 0xff sub}{default bad}} mydecodetype
See also virtual function, Virtual Objects
476
Commands vlib
vlib
The vlib command creates a design library. You must use vlib rather than operating system commands to create a library directory or index file. If the specified library already exists as a valid ModelSim library, the vlib command will exit with a warning message without touching the library. Syntax vlib [-archive [-compact <percent>]] [-format { 1 | 3 }] [-help] [-dos | -short | -unix | -long] [-lock | -unlock] [-locklib | -unlocklib <] [-unnamed_designs <value>] <name> Arguments -archive [-compact <percent>] Causes design units that are compiled into the created library to be stored in archives rather than in subdirectories. Optional. Refer to Archives for more details. You may optionally specify a decimal number between 0 and 1 that denotes the allowed percentage of wasted space before archives are compacted. By default archives are compacted when 50% (.5) of their space is wasted. See an example below. -format { 1 | 3 } Allows you to convert a library compiled with the current to be compatible with a previous release. 1 allows you to convert a library to be compatible with the 6.2 series and earlier. 3 allows you to convert a library to be compatible with the 6.3 series and newer. -help Displays the commands options and arguments. Optional. -dos Specifies that subdirectories in a library have names that are compatible with DOS. Not recommended if you use the vmake utility. Optional. -short Interchangeable with the -dos argument. Optional. -unix Specifies that subdirectories in a library may have long file names that are NOT compatible with DOS. Optional. Default for SE. -long Interchangeable with the -unix argument. Optional. -lock | -unlock Locks an existing design unit so it cannot be recompiled or refreshed. The -unlock switch reverses this action. Optional. File permissions are not affected by these switches.
477
Commands vlib
-locklib | -unlocklib < Locks a complete library so that compilation cannot target the library and the library cannot be refreshed. The -unlocklib switch reverses this action. Optional. File permissions are not affected by these switches.
-unnamed_designs <value> Specifies how many unnamed, optimized versions of a design the vopt command will save within the library. Once <value> is reached, vopt deletes the oldest unnamed, optimized version. By default, the maximum number of unnamed designs (_opt[number]") is set to 3. Optional.
<name> Specifies the pathname or archive name of the library to be created. Required.
Examples Create the design library design. You can define a logical name for the library using the vmap command or by adding a line to the library section of the modelsim.ini file that is located in the same directory.
vlib design
Create the design library uut and specifies that any design units compiled into the library are created as archives. Also specifies that each archive be compacted when 30% of its space is wasted.
vlib -archive -compact .3 uut
478
Commands vlog
vlog
The vlog command compiles Verilog source code and SystemVerilog extensions into a specified working library (or to the work library by default). The vlog command may be invoked from within ModelSim or from the operating system command prompt. It may also be invoked during simulation. Compiled libraries are major-version dependent. When moving between major versions, you have to refresh compiled libraries using the -refresh argument to vlog. This is not true for minor versions (letter releases). All arguments to the vlog command are case sensitive: -WORK and -work are not equivalent. The IEEE P1800 Draft Standard for SystemVerilog requires that the default behavior of the vlog command is to treat each Verilog design file listed on the command line as a separate compilation unit. This behavior is a change in vlog from versions prior to 6.2, wherein all files in a single command line were concatenated into a single compilation unit. To treat multiple files listed within a single command line as a single compilation unit, use either the vlog -mfcu argument or the MultiFileCompilationUnit modelsim.ini file variable. Syntax vlog [-93] [-compat] [-compile_uselibs[=<directory_name>]] [-convertallparams] [-cuname] [+define+<macro_name>[=<macro_text>]] [+delay_mode_distributed] [+delay_mode_path] [+delay_mode_unit] [+delay_mode_zero] [-dpiheader <filename>] [-E <filename>] [-Epretty <filename>] [-error <msg_number>[,<msg_number>,]] [-f <filename>] [-force_refresh <design_unit>] [-fsmdebug] [-fsmimplicittrans] [-fsmresettrans] [-fsmsingle] [-fsmverbose] [-fsmxassign] [-gen_xml <design_unit> <filename>] [-hazards] [-help] [+incdir+<directory>] [-incr] [-isymfile] [+libcell] [+libext+<suffix>] [-libmap <pathname>] [-libmap_verbose] [+librescan] [-line <number>] [-lint] [+maxdelays] [+mindelays] [-maxfecrows] [-maxudprows] [-mixedansiports] [-mixedsvvh [b | s | v]] [-mfcu | -sfcu] [-nocovercells] [-nodbgsym] [-noincr] [-nofsmresettrans] [-nofsmsingle] [-nofsmxassign] [+nolibcell] [-nologo] [+nospecify] [-note <msg_number>[,<msg_number>,]] [+notimingchecks] [+nowarn<CODE>] [-nowarn <category_number>] [-O0 | -O1 | -O4 | -O5] [-pedanticerrors] [-quiet] [-R [<simargs>]] [-refresh] [-source] [-s] [-sv] [-suppress <msg_number>[,<msg_number>,]] [-time] [-timescale <time_units>/<time_precision>] [-togglecountlimit] [-togglewidthlimit] [+typdelays] [-u] [-v <library_file>] [-version] [-vlog01compat] [-vlog95compat] [-warning <msg_number>[,<msg_number>,]] [-work <library_name>] [-y <library_directory>] <filename> [+acc[=<spec>] [+<selection> [.]] [+floatparameters[+<selection>[.]]] [-novopt] [-vopt] [-L <libname>] [-Lf <libname>] [+initmem[=<spec>][+{0 | 1 | X | Z}]] [+initreg[=<spec>][+{0 | 1 | X | Z}]] [+cover <stat>] [-coveropt] [-covercells] [-coverExcludeDefault] [-nocovergenerate] [-nocovershort] [-nocoverfec] [-mti_trace_vlog_calls] [-nodebug[=ports | =pli | =ports+pli]] [+nosparse[+<selection> [.]]]
479
Commands vlog
[+num_opt_cell_conds+<value>] [+protect[=<filename>]] [-scdpiheader <filename>] Arguments -93 Specifies that the VHDL interface to Verilog modules use VHDL 1076-1993 extended identifiers to preserve case in Verilog identifiers that contain uppercase letters. Optional. +acc[=<spec>] [+<selection> [.] Enables PLI and debug command access to design objects that would otherwise become unavailable due to optimizations. Optional. Note Using this option may reduce optimizations.
<spec> is one or more of the following characters. If <spec> is omitted, the entire set of access specifiers is enabled. b Enable access to bits of vector nets. This is necessary for PLI applications that require handles to individual bits of vector nets. Also, some user interface commands require this access if you need to operate on net bits. c Enable access to library cells. By default any Verilog module containing a non-empty specify block may be optimized, and debug and PLI access may be limited. This option keeps module cell visibility. f Enable access to finite state machines. l Enable access to line number directives and process names. m Preserve the visibility of primitive gates. n Enable access to nets. p Enable access to ports. This disables the module inlining optimization, and is necessary only if you have PLI applications that require access to port handles. r Enable access to registers (including memories, integer, time, and real types). s Enable access to system tasks.
480
Commands vlog
t Enable access to tasks and functions. u Enable access to primitive instances. The tool determines whether you have supplied a module name or a object pathname by the existence of the PathSeparator character (set in the modelsim.ini file) in the path. By default, the separator is a /. An example object pathname specification is:
+acc=n+/u1/u2/n2
-compat Disables optimizations that result in different event ordering than Verilog-XL. Optional. ModelSim Verilog generally duplicates Verilog-XL event ordering, but there are cases where it is inefficient to do so. Using this option does not help you find event order dependencies, but it allows you to ignore them. Keep in mind that this option does not account for all event order discrepancies, and that using this option may degrade performance. Refer to Event Ordering in Verilog Designs for additional information.
-compile_uselibs[=<directory_name>] Locates source files specified in a ùselib directive (Refer to Verilog-XL uselib Compiler Directive), compiles those files into automatically created libraries, and updates the modelsim.ini file with the logical mappings to the new libraries. Optional. If a directory_name is not specified, ModelSim uses the name specified in the MTI_USELIB_DIR environment variable. If that variable is not set, ModelSim creates the directory mti_uselibs in the current working directory.
-convertallparams Enables converting parameters not defined in ANSI style to VHDL generics of type std_logic_vector, bit_vector, std_logic, vl_logic, vl_logic_vector, and bit. Optional.
+cover <stat> Enables various coverage statistics collection. The use of +cover is recommended over -cover, as it is more powerful and flexible, and often yields better performance. To obtain the behavior of the obsolete -coverAll argument, use the +cover argument without any <stat> characters. Optional. <stat> one or more of the following characters: b Collect branch statistics. c Collect condition statistics. Collects both FEC and UDP statistics, unless -nocoverfec is specified. e Collect expression statistics, Collects both FEC and UDP statistics, unless -nocoverfec is specified. s Collect statement statistics. t Collect toggle statistics. Overridden if x is specified elsewhere.
481
Commands vlog
x Collect extended toggle statistics (Refer to Toggle Coverage for details). This takes precedence, if t is specified elsewhere. f Collect Finite State Machine statistics. See -coveropt argument to override the default level of optimization for coverage for a particular compilation run. -cover <stat> Recommendation: Use +cover argument instead of -cover, asi it is often can yield better performance. Specifies type(s) of coverage statistics to collect. Optional. <stat> is one or more of the following characters: b Collect branch statistics. c Collect condition statistics. Collects both FEC and UDP statistics, unless -nocoverfec is specified. e Collect expression statistics, Collects both FEC and UDP statistics, unless -nocoverfec is specified. s Collect statement statistics. t Collect toggle statistics. Cannot be used if x is specified. x Collect extended toggle statistics (Refer to Toggle Coverage for details). Cannot be used if t is specified. f Collect Finite State Machine statistics. <i> Override the default level of optimization for current run only, where i is an integer between 1 and 4. To change default level for all subsequent runs, change value of CoverOpt variable in modelsim.ini file. See CoverOpt for a description of optimization levels. -covercells Enables code coverage of modules defined by celldefine and endcelldefine compiler directives, or compiled with the -v or -y arguments. Optional. Can be used to override the CoverCells compiler control variable in the modelsim.ini file. -coverExcludeDefault Excludes code coverage data collection from the default branch of case statements. Optional. -coverGenerate Obsolete in current release. For 6.2x releases, this argument enabled code coverage inside the top level of generate blocks, and was optional. For the current release, code coverage is automatically enabled for the top level of all generate blocks which are elaborated.
482
Commands vlog
-coveropt Overrides the default level of optimization for the current run only. Optional. Edit the CoverOpt variable in the modelsim.ini file to set a permanent default. See CoverOpt for a description of optimization levels.
-cuname Used only in conjunction with -mfcu. Optional. The -cuname names the compilation unit being created by vlog. The named compilation unit can then be specified on the vsim command line, along with the <top> design unit. The purpose of doing so is to force elaboration of specified compilation unit package, thereby forcing elaboration of a necessary bind statement within that compilation unit that would otherwise not be elaborated. An example of the necessary commands is:
vlog -cuname pkg_name -mfcu file1.sv file2.sv vsim top pkg_name
You need to do this only in cases where you have a bind statement in a module that might otherwise not be elaborated, because no module in the design depends on that compilation unit. In other words, if a module that depends on that compilation unit exists, you dont need to force the elaboration, for it occurs automatically. Also, if you are using qverilog to compile and simulate the design, this binding issue is handled properly automatically. +define+<macro_name>[=<macro_text>] Allows you to define a macro from the command line that is equivalent to the following compiler directive:
`define <macro_name> <macro_text>
Optional. You can specify more than one macro with a single +define. For example:
vlog +define+one=r1+two=r2+three=r3 test.v
A command line macro overrides a macro of the same name defined with the `define compiler directive. +delay_mode_distributed Disables path delays in favor of distributed delays. Optional. Refer to Delay Modes for details. +delay_mode_path Sets distributed delays to zero in favor of using path delays. Optional. +delay_mode_unit Sets path delays to zero and non-zero distributed delays to one time unit. Optional. +delay_mode_zero Sets path delays and distributed delays to zero. Optional.
483
Commands vlog
-dpiheader <filename> Generates a header file that may then be included in C source code for DPI import functions. Optional. Refer to DPI Use Flow for additional information.
-E <filename> Captures text processed by the Verilog parser after preprocessing has occurred and copies that text to an output file, <filename>. Optional. Generally, preprocessing consists of the following compiler directives: ìfdef, èlse, èlsif, èndif, ìfndef, `define, ùndef, ìnclude. The `line directive attempts to preserve line numbers and file names in the output file. White space is usually preserved, but sometimes it may be deleted or added to the output file.
-Epretty <filename> Captures text processed by the Verilog parser after preprocessing has occurred, performs some formatting for better readability, and copies that text to an output file, <filename>. Optional.
-f <filename> Specifies a file with more command line arguments. Optional. Allows complex arguments to be reused without retyping. Allows gzipped input files. Nesting of -f options is allowed. Refer to the section "Argument Files" for more information.
+floatparameters[+<selection>[.]] Instructs the tool to not lock down parameter values during optimization, which enables successful use of the vsim -g/G options. +<selection> localizes the effect of this option to specific parameters in the design hierarchy. +<selection> can be a hierarchical path to a parameter or a design unit instance. It can also be the name of a design unit declaration. . If a period (.) is present after an instance or design unit name, all parameters under that scope are recursively selected.
-force_refresh <design_unit> Forces the refresh of all specified design units. Optional. By default, the work library is updated; use -work <library_name>, in conjunction with -force_refresh, to update a different library (for example, vlog -work <your_lib_name> -force_refresh). When the compiler refreshes a design unit, it checks each dependency to ensure its source has not been changed and recompiled. Sometimes the tools dependency checking algorithm changes from release to release. This can lead to false errors during the integrity checks performed by the -refresh argument. An example of such a message follows:
484
Commands vlog ** Error: (vsim-13) Recompile /u/test/dware/dware_61e_beta.dwpackages because /home/users/questasim/linux/../synopsys.attributes has changed.
The -force_refresh argument forces the refresh of the design unit, overriding any dependency checking errors encountered by the -refresh argument. A more conservative approach to working around -refresh dependency checks is to recompile the source code, if it is available. -fsmdebug Enables recognition of state machines and display of state and transition data in the FSM Viewer. Optional. -fsmimplicittrans Enables recognition of implied same state transitions. Optional -fsmresettrans Enables recognition of implicit asynchronous reset transitions. Optional. This includes asynchronous reset transitions in coverage results. -fsmsingle Enables recognition of FSMs having single bit current state variable. Optional. -fsmverbose Provides information about FSMs detected, including state reachability analysis. Optional. -fsmxassign Enables recognition of finite state machines (FSMs) containing X assignment. Optional. This option is used to detect FSMs if current state variable or next state variable has been assigned "X" value in a "case" statement. FSMs containing X-assign are otherwise not detectable. -gen_xml <design_unit> <filename> Produces an XML-tagged file containing the interface definition of the specified module. Optional. This option requires a two-step process where you must 1) compile <filename> into a library with vlog (without -gen_xml) then 2) execute vlog with the -gen_xml switch, for example:
vlib work vlog counter.v vlog -gen_xml counter counter.xml
-hazards Detects event order hazards involving simultaneous reading and writing of the same register in concurrently executing processes. Optional. You must also specify this argument when you simulate the design with vsim. Refer to Hazard Detection for more details.
485
Commands vlog
Note Enabling -hazards implicitly enables the -compat argument. As a result, using this argument may affect your simulation results. -help Displays the commands options and arguments. Optional. +incdir+<directory> Specifies directories to search for files included with ìnclude compiler directives. Optional. By default, the current directory is searched first and then the directories specified by the +incdir options in the order they appear on the command line. You may specify multiple +incdir options as well as multiple directories separated by "+" in a single +incdir option. -incr Performs an incremental compile. Optional. Default. Compiles only code that has changed. For example, if you change only one module in a file containing several modules, only the changed module will be recompiled. Note however that if the compile options change, all modules are recompiled regardless if you use -incr or not. +initmem[=<spec>][+{0 | 1 | X | Z}] Enables the initialization of memories. Optional. =<spec> (optional) identifies the types to be initialized. If you do not specify this option, vlog initializes fixed-size arrays of all these types, where fixed-size arrays may have any number of packed or unpacked dimensions. <spec> can be one or more of the following: r register/logic, integer, or time types (four-state integral types). b bit, int, shortint, longint, or byte types (two-state integral types). e enum types. You must also add the enum's base type to the initialization specification. If you choose static initialization for an enum type variable with value 0, 1, X, or Z, the simulator assigns that value to the variable, whether it is a valid value or not. If you choose random initialization for an enum type variable, the simulator generates a random number and uses the (random_number % num_valid_enum_values)th entry of the enum literals to initialize it. u sequential UDPs. +{0 | 1 | X | Z} (optional) specifies the value to use in initialization for all bits of a memory. For two-state datatypes, X and Z will map to 0. If you do not specify this option you are preparing the design unit for randomization with vsim +initmem +<seed>. This argument initializes static variables in any scope (package, $unit, module, interface, generate, program, task, function). However, it does not affect:
486
Commands vlog
automatic variables dynamic variables members of dynamic variables artificially generated variables, such as #randstate#
Because you can specify +initmem on the vlog and vopt command line, the priority of the specifications are as follows:
1) vopt ... +initmem+1+top.foo 2) vlog ... +initmem+0 3) vopt ... +initmem+Z
This argument will not override any variable declaration assignment, such as:
reg r = 1b0
+initreg[=<spec>][+{0 | 1 | X | Z}] Enables you to initialize registers. Optional. =<spec> (optional) identifies the types to be initialized. If you do not specify this option, vlog initializes variables of all these types. <spec> can be one or more of the following: r register/logic, integer, or time types (four-state integral types). Notifier registers are not initialized by the +initreg option. b bit, int, shortint, longint, or byte types (two-state integral types). e enum types. You must also add the enum's base type to the initialization specification. If you choose static initialization for an enum type variable with value 0, 1, X, or Z, the simulator assigns that value to the variable, whether it is a valid value or not. If you choose random initialization for an enum type variable, the simulator generates a random number and uses the (random_number % num_valid_enum_values)th entry of the enum literals to initialize it. u sequential UDPs. If a sequential UDP contains an "initial" statement, that initial value overrides all +initreg-related functionality. For other sequential UDPs, the +initreg option takes effect as described for regular variables. In case a sequential UDP does not contain an "initial" statement, and it wasn't compiled with +initreg in effect, the UDPs initial value will be taken from its instantiating parent scope (provided that scope has +initreg options in effect). +{0 | 1 | X | Z} (optional) specifies the value to use in initialization. For two-state datatypes, X and Z will map to 0. If you do not specify this option you are preparing the design unit for randomization with vsim +initreg +<seed>
487
Commands vlog
This argument initializes static variables in any scope (package, $unit, module, interface, generate, program, task, function). However, it does not affect: automatic variables dynamic variables members of dynamic variables artificially generated variables, such as #randstate#
Because you can specify +initreg on the vlog and vopt command line, the priority of the specifications are as follows:
1) vopt ... +initreg+1+top.foo 2) vlog ... +initreg+0 3) vopt ... +initreg+Z
reg r = 1b0
-isymfile Generates a complete list of all imported tasks and functions (TFs). Used with DPI to determine all imported TFs that are expected by ModelSim.
-L <libname> Searches the specified resource library for precompiled modules. The library search options you specify here must also be specified when you run the vsim command. Optional. See also the LibrarySearchPath variable and Specifying the Resource Libraries in the Users Manual. Note The -L argument is required when you are importing a UPF package in a Power Aware RTL (PA-RTL) flow. You must specify mtiUPF as the value of <libname>.
-Lf <libname> Same as -L, but the specified library is searched before any uselib directives. (Refer to Library Usage and Verilog-XL Compatible Compiler Arguments for more information.) Optional.
+libcell Treats all modules found and compiled by source library search as though they contained a celldefine compiler directive, thus marking them as cells (refer to the -v and -y arguments of vlog, which enable source library search). Using the +libcell argument matches historical behavior of Verilog-XL with respect to source library search. Optional.
488
Commands vlog
Note By default, wildcard logging and code coverage exclude cells. For more information, refer to the -nocovercells and -covercells arguments of vlog and to the description of wildcard logging performed by the log command. +libext+<suffix> Works in conjunction with the -y option. Specifies file extensions for the files in a source library directory. Optional. By default, the compiler searches for files without extensions. If you specify the +libext argument, then the compiler will search for a file with the suffix appended to an unresolved name. You may specify only one +libext option, but it may contain multiple suffixes separated by the plus character (+). The extensions are tried in the order you specify them with the +libext argument. -libmap <pathname> Specifies a Verilog 2001 library map file. Optional. You can omit this argument by placing the library map file as the first option on the vlog invocation (e.g., vlog top.map top.v top_cfg.v). -libmap_verbose Displays library map pattern matching information during compilation. Optional. Use to troubleshoot problems with matching filename patterns in a library file. +librescan Scans libraries in command-line order for all unresolved modules. Optional. -line <number> Starts the compiler on the specified line in the Verilog source file. Optional. By default, the compiler starts at the beginning of the file. -lint Instructs ModelSim to perform the following lint-style checks: 1) warn when Module ports are NULL; 2) warn when assigning to an input port; 3) warn when referencing undeclared variables/nets in an instantiation; 4) warn when an index for a Verilog unpacked variable array reference is out of bounds. The warnings are reported as WARNING[8]. You can also enable this option using the Show_Lint variable in the modelsim.ini file. This argument generates additional array bounds-checking code by inserting checks for outof-bound indexing into arrays. This functionality can slow down simulation. +maxdelays Selects maximum delays from the "min:typ:max" expressions. Optional. If preferred, you can defer delay selection until simulation time by specifying the same option to the simulator.
489
Commands vlog
+mindelays Selects minimum delays from the "min:typ:max" expressions. Optional. If preferred, you can defer delay selection until simulation time by specifying the same option to the simulator.
-maxfecrows Sets the maximum number of rows allowed in an FEC truth table for a code coverage condition or expression. The default maximum is 192 rows. Increasing the number of rows includes more expressions for coverage, but also increases the compile time, sometimes dramatically. You can also configure this option using the CoverMaxFECRows variable in the modelsim.ini file.
-maxudprows Sets the maximum number of rows allowed in an UDP truth table for a code coverage condition or expression. The default maximum is 192 rows. Increasing the number of rows includes more expressions for coverage, but also increases the compile time, sometimes dramatically. You can also configure this option using the CoverMaxUDPRows variable in the modelsim.ini file.
-mixedansiports Permits partial port redeclarations. -mixedsvvh [b | s | v] Facilitates using SystemVerilog packages at the SystemVerilog-VHDL boundary of a mixed-language design. When you compile a SystemVerilog package with -mixedsvvh, the package can be included in a VHDL design as if it were defined in VHDL itself. Optional. b treats all scalars/vectors in the package as VHDL bit/bit_vector s treats all scalars/vectors in the package as VHDL std_logic/std_logic_vector v treats all scalars/vectors in the package as VHDL vl_logic/vl_logic_vector
-mfcu Instructs the compiler to treat all files within a compilation command line as a single compilation unit. Optional. The default behavior is to treat each file listed in a command as a separate compilation unit, per the SystemVerilog standard. Prior versions concatenated the contents of the multiple files into a single compilation unit by default. You can also enable this option using the MultiFileCompilationUnit variable in the modelsim.ini file.
-mti_trace_vlog_calls Enables viewing of SystemVerilog class contents in the Wave window. Optional. -nocovercells Disables code coverage of modules defined by celldefine and endcelldefine compiler directives, or compiled with the -v or -y arguments. Optional. Can be used to override the CoverCells compiler control variable in the modelsim.ini file.
490
Commands vlog
-nodebug[=ports | =pli | =ports+pli] Hides, within the GUI and other parts of the tool, the internal data of all compiled design units. Optional. -nodebug The switch, specified in this form, does not hide ports, due to the fact that the port information may be required for instantiation in a parent scope. The design units source code, internal structure, registers, nets, etc. will not display in the GUI. In addition, none of the hidden objects may be accessed through the Dataflow window or with commands. This also means that you cannot set breakpoints or single step within this code. It is advised that you not compile with this switch until you are done debugging. Note that this is not a speed switch like the nodebug option on many other products. Use the vopt command to increase simulation speed. -nodebug=ports additionally hides the ports for the lower levels of your design; it should be used only to compile the lower levels of the design. If you hide the ports of the top level you will not be able to simulate the design. You should not use the switch in this form when working in mixed language designs or when the parent is part of a vopt -bbox flow. -nodebug=pli additionally prevents the use of pli functions to interrogate individual modules for information. You should be aware that this form will leave a "nodebug" module untraversable by PLI. -nodebug=ports+pli you can combine the behavior of =ports and =pli in this manner. This functionality encrypts entire files. The `protect compiler directive allows you to encrypt regions within a file.
-nodbgsym Disables the generation of the symbols debugging database in the compiled library. The symbols debugging database is the .dbs file in the compiled library that provides information to the GUI allowing you to view detailed information about design objects at the source level. Two major GUI features that use this database include source window annotation and textual dataflow. You should only specify this switch if you know that anyone using the library will not require this information for design analysis purposes.
491
Commands vlog
-nocovershort Disables short circuiting of expressions when coverage is enabled. Short circuiting is enabled by default. You can customize the default behavior with the CoverShortCircuit variable in the modelsim.ini file. Optional.
-noincr Disables incremental compile previously turned on with -incr. Optional. -nofsmresettrans Disables recognition of implicit asynchronous reset transitions. Optional. This has the effect of excluding asynchronous reset transitions from any coverage results.
-nofsmsingle Disables recognition of FSMs having single bit current state variable. Optional. -nofsmxassign Disables recognition of FSMs containing x assignment. Optional. +nolibcell Disables treating all modules found and compiled by source library search as though they contained a celldefine compiler directive. That is, this argument restores the default library search behavior if you have changed it using the +libcell argument. Optional.
-nologo Disables the startup banner. Optional. +nosparse[+<selection> [.]] Identifies which memories are considered not sparse, which causes ModelSim to override the rules for allocating storage for memory elements only when necessary. Optional. If you use +nosparse on a given memory, the tool will simulate the memory normally. Refer to Sparse Memory Modeling for more information. +<selection> enables access for specific Verilog design units, scopes, or design objects (vars, mem). Multiple selections are allowed, with each separated by a "+" (+nosparse=+top1+top2). If no selection is specified, then all modules are affected. You can use a path delimiter to select unique instances or objects (+nosparse=+/top/ul.). If you specify a module name (+nosparse=+Demux), pertinent objects inside the module are selected. . indicates the selection occurs recursively downward from the specified module or instance.
492
Commands vlog
+nospecify Disables specify path delays and timing checks. Optional. -note <msg_number>[,<msg_number>,] Changes the severity level of the specified message(s) to "note." Optional. Edit the note variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information.
+notimingchecks Removes all timing check entries from the design as it is parsed. Optional. To disable checks on individual instances, use the tcheck_set command.
-novopt Forces vlog to produce code if the VoptFlow variable is set to 1 (optimizations turned on) in the modelsim.ini. (VoptFlow = 1 is the default behavior.) You can use this argument in tandem with vsim -novopt to run ModelSim in debug mode when the default behavior is optimized.
+nowarn<CODE> Disables warning messages in the category specified by <CODE>. Optional. Warnings that can be disabled include the <CODE> name in square brackets in the warning message. For example,
** Warning: test.v(15): [RDGN] - Redundant digits in numeric literal.
This warning message can be disabled by specifying +nowarnRDGN. -nowarn <category_number> Prevents the specified message(s) from displaying. The <msg_number> is the number preceding the message you wish to suppress. Optional. Multiple -nowarn switches are allowed. Warnings may be disabled for all compiles via the Main window Compile > Compile Options menu command or the modelsim.ini file (refer to VHDL Compiler Control Variables). The warning message categories are described in Table 2-10: Table 2-10. Warning Message Categories for vlog -nowarn Category number 12 13 Description non-LRM compliance in order to match Cadence behavior constructs that code coverage can't handle
+num_opt_cell_conds+<value> Restricts gate level optimization capacity for accepting cells with I/O path and timing check conditions. Optional. The <value> is any integer less than 254.
493
Commands vlog
-O0 | -O1 | -O4 | -O5 Lower the optimization to a minimum with -O0 (capital oh zero). Optional. Use this to work around bugs, increase your debugging visibility on a specific cell, or when you want to place breakpoints on source lines that have been optimized out. Add the DisableOpt variable to [vlog] section of the modelsim.ini file to set a permanent default. Please refer to the section "Optimizing Designs with vopt" in the Users Manual for detailed information on using vopt to perform optimization. Enable PE-level optimization with -O1. Optional. Enable standard SE optimizations with -O4. Default. Enable maximum optimization with -O5. Optional. -O5 attempts to optimize loops and prevents variable assignments in situations where a variable is assigned but is not actually used. Using the +acc argument to vlog will cancel this latter optimization. Use caution with the -O5 argument. We recommend use of this argument with large sequential blocks only; other uses may significantly increase compile times.
-pedanticerrors Enforces strict compliance of the IEEE Std 1800-2005 in the following case: Using "new for queues is not legal. When strict compliance is not enforced, use of "new" creates a queue of the specified size where all elements are initialized to the default value of the queue element type.
This argument also produces a report of mismatched else directives. Optional. +protect[=<filename>] Enables `pragma protect, `protect, and èndprotect directives for encrypting selected regions of your code. Optional. Produces an encrypted output file with a .vp extension in the default work directory. You can create an encrypted output file to the current directory by using the optional [=<filename>] part of the argument. If the filename is specified in this manner, all source files on the command line will be concatenated together into a single output file. Any ìnclude files will also be inserted into the output file when [=<filename>] is used. If the [=<filename>] part of the argument is not used, all ìnclude files will be encrypted into the work directory as individual files, not merged together into one file. -quiet Disables 'Loading' messages. Optional. -R [<simargs>] Instructs the compiler to invoke vsim after compiling the design. The compiler automatically determines which top-level modules are to be simulated. The command line arguments following -R are passed to the simulator, not the compiler. Place the -R option at the end of the command line or terminate the simulator command line arguments with a single "-" character to differentiate them from compiler command line arguments.
494
Commands vlog
The -R option is not a Verilog-XL option, but it is used by ModelSim to combine the compile and simulate phases together as you may be used to doing with Verilog-XL. It is not recommended that you regularly use this option because you will incur the unnecessary overhead of compiling your design for each simulation run. Mainly, it is provided to ease the transition to ModelSim. -refresh Regenerates a library image. Optional. By default, the work library is updated. To update a different library, use -work <library_name> with -refresh (for example, vlog -work <your_lib_name> -refresh). If a dependency checking error occurs which prevents the refresh, use the vlog -force_refresh argument. See vlog examples for more information. You may use a specific design name with -refresh to regenerate a library image for that design, but you may not use a file name. -scdpiheader <filename> Specifies the name of SystemC DPI function prototype header file automatically generated from the current compilation. Optional. The default filename is sc_dpiheader.h when no such switch is provided. Refer to section SystemC Procedural Interface to SystemVerilog for more detailed description. -sfcu Instructs the compiler to treat all files within a compilation command line as a separate compilation units. This is the default behavior and is the inverse of the behavior of -mfcu. This switch will override the MultiFileCompilationUnit variable if it is set to "1" in the modelsim.ini file. -source Displays the associated line of source code before each error message that is generated during compilation. Optional; by default, only the error message is displayed. -s Instructs the compiler not to load the standard package. Optional. This argument should only be used when you are compiling the sv_std package. -sv Enables SystemVerilog features and keywords. Optional. By default ModelSim follows the rules of IEEE Std 1364-2001 and ignores SystemVerilog keywords. If a source file has a ".sv" extension, ModelSim will automatically parse SystemVerilog keywords. -suppress <msg_number>[,<msg_number>,] Prevents the specified message(s) from displaying. The <msg_number> is the number preceding the message you wish to suppress. Optional. You cannot suppress Fatal or Internal messages. Edit the suppress variable in the modelsim.ini file to set a permanent default. Refer to Changing message Severity Level for more information.
495
Commands vlog
-time Reports the "wall clock time" vlog takes to compile the design. Optional. Note that if many processes are running on the same system, wall clock time may differ greatly from the actual "cpu time" spent on vlog.
-timescale <time_units>/<time_precision> Specifies the default timescale for modules not having an explicit timescale directive in effect during compilation. Optional. The format of the -timescale argument is the same as that of the `timescale directive. The format for <time_units> and <time_precision> is <n><units>. The value of <n> must be 1, 10, or 100. The value of <units> must be fs, ps, ns, us, ms, or s. In addition, the <time_units> must be greater than or equal to the <time_precision>.
-togglecountlimit Limits the toggle coverage count for a toggle node. Optional. After the limit is reached, further activity on the node is ignored for toggle coverage. All possible transition edges must reach this count for the limit to take effect. For example, if you are collecting toggle data on 0->1 and 1->0 transitions, both transition counts must reach the limit. If you are collecting "full" data on 6 edge transitions, all 6 must reach the limit. Overrides the global value set by the ToggleCountLimit modelsim.ini variable.
-togglewidthlimit Sets the maximum width of signals that are automatically added to toggle coverage with the -cover t argument. Optional. Can be set on design unit basis. Overrides the default value (128) of the ToggleWidthLimit modelsim.ini variable.
+typdelays Selects typical delays from the "min:typ:max" expressions. Default. If preferred, you can defer delay selection until simulation time by specifying the same option to the simulator.
-u Converts regular Verilog identifiers to uppercase. Allows case insensitivity for module names. Optional.
-v <library_file> Specifies a source library file containing module and UDP definitions. Optional. Refer to Verilog-XL Compatible Compiler Arguments for more information. After all explicit filenames on the vlog command line have been processed, the compiler uses the -v option to find and compile any modules that were referenced but not yet defined. Modules and UDPs within the file are compiled only if they match previously unresolved references. Multiple -v options are allowed. See additional discussion in the examples.
-version Returns the version of the compiler as used by the licensing tools. Optional.
496
Commands vlog
-vlog01compat Ensures compatibility with rules of IEEE Std 1364-2001. Default. -vlog95compat Disables Verilog 2001 keywords, which ensures that code that was valid according to the 1364-1995 spec can still be compiled. By default ModelSim follows the rules of IEEE Std 1364-2001. Some requirements in 1364-2001 conflict with requirements in 1364-1995. Optional. Edit the vlog95compat variable in the modelsim.ini file to set a permanent default.
-vopt Notifies vlog that the vopt command will be run. As a result, vlog does not produce code. This saves an unnecessary code generation step. Optional. This argument is needed only if you have set the VoptFlow variable to 0 in the modelsim.ini file. If it is set to 1 (default operation) vlog skips the code generation step automatically.
-warning <msg_number>[,<msg_number>,] Changes the severity level of the specified message(s) to "warning." Optional. Edit the warning variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information.
-work <library_name> Specifies a logical name or pathname of a library that is to be mapped to the logical library work. Optional; by default, the compiled design units are added to the work library. The specified pathname overrides the pathname specified for work in the project file.
-y <library_directory> Specifies a source library directory containing definitions for modules, packages, interfaces, and user-defined primitives (UDPs). Usually, this is a directory of source files that you want to scan if the compiled versions do not already exist in a library. Optional. Refer to Verilog-XL Compatible Compiler Arguments for more information. After all explicit filenames on the vlog command line have been processed, the compiler uses the -y option to find and compile any modules that were referenced but not yet defined. Files within this directory are compiled only if the file names match the names of previously unresolved references. Multiple -y options are allowed. You will need to specify a file suffix by using -y in conjunction with the +libext+<suffix> option if your filenames differ from your module names. See additional discussion in the examples. Note Any -y arguments that follow a -refresh argument on a vlog command line are ignored. Any -y arguments that come before the -refresh argument on a vlog command line are processed.
<filename> Specifies the name of the Verilog source code file to compile. One filename is required. Multiple filenames can be entered separated by spaces. Wildcards can be used.
497
Commands vlog
Examples Compile the Verilog source code contained in the file example.vlg.
vlog example.vlg
Hide the internal data of example.v. Models compiled with -nodebug cannot use any of the ModelSim debugging features; any subsequent user will not be able to see into the model.
vlog -nodebug example.v
The first line compiles and hides the internal data, plus the ports, of the lower-level design units, level3.v and level2.v. The second line compiles the top-level unit, top.v, without hiding the ports. It is important to compile the top level without =ports because top-level ports must be visible for simulation.
vlog -nodebug=ports level3.v level2.v vlog -nodebug top.v
The first command hides the internal data, and ports of the design units, level3.v and level2.v. In addition it prevents the use of PLI functions to interrogate the compiled modules for information (either =ports+pli or =pli+ports works fine for this command). The second line compiles the top-level unit without hiding the ports but restricts the use of PLI functions as well. Note that the =pli switch may be used at any level of the design but =ports should only be used on lower levels since you cant simulate without visible top-level ports.
vlog -nodebug=ports+pli level3.v level2.v vlog -nodebug=pli top.v
After compiling top.v, vlog will scan the file und1 for modules or primitives referenced but undefined in top.v. Only referenced definitions will be compiled.
vlog top.v -v und1
After compiling top.v, vlog will scan the vlog_lib library for files with modules with the same name as primitives referenced, but undefined in top.v. The use of +libext+.v+.u implies filenames with a .v or .u suffix (any combination of suffixes may be used). Only referenced definitions will be compiled.
vlog top.v +libext+.v+.u -y vlog_lib
The -work option specifies mylib as the library to regenerate. -refresh rebuilds the library image without using source code, allowing models delivered as compiled libraries without source code to be rebuilt for a specific release of ModelSim. If your library contains VHDL design units, be sure to regenerate the library with the vcom command using the -refresh option as well. Refer to Regenerating Your Design Libraries for more information.
498
Commands vlog vlog -work mylib -refresh
The -incr option determines whether or not the module source or compile options have changed as module1.v is parsed. If no change is found, the code generation phase is skipped. Differences in compile options are determined by comparing the compiler options stored in the _info file with the compiler options given. They must match exactly
.vlog module1.v -u -O0 -incr
The -timescale option specifies the default timescale for module1.v, which did not have an explicit timescale directive in effect during compilation. Quotes are necessary because the argument contains white spaces.vlog module1.
v -timescale "1 ns / 1 ps"
499
Commands vmake
vmake
The vmake utility allows you to use a UNIX or Windows MAKE program to maintain individual libraries. You run vmake on a compiled design library. This utility operates on multiple source files per design unit; it supports Verilog include files as well as Verilog and VHDL PSL vunit files. Note If a design is spread across multiple libraries, then each library must have its own makefile and you must build each one separately. By default, the output of vmake is sent to stdouthowever, you can send the output to a makefile by using the shell redirect operator (>) along with the name of the file. You can then run the makefile with a version of MAKE (not supplied with ModelSim) to reconstruct the library. This command must be invoked from either the UNIX or the Windows/DOS prompt. A MAKE program is included with Microsoft Visual C/C++, as well as many other program development environments. After running the vmake utility, MAKE recompiles only the design units (and their dependencies) that have changed. You run vmake only once; then you can simply run MAKE to rebuild your design. If you add new design units or delete old ones, you should re-run vmake to generate a new makefile. The vmake utility ignores library objects compiled with -nodebug. Also, the vmake utility is not supported for use with SystemC. Syntax vmake [-du <design_unit_name>] [-f <filename>] [-fullsrcpath] [-help] [-ignore] [<library_name>] Arguments -du <design_unit_name> Specifies that a vmake file will be generated only for the specified design unit. Optional. You can specify this argument any number of times for a single vmake command. -f <filename> Specifies a file to read command line arguments from. Optional. -fullsrcpath Produces complete source file paths within generated makefiles. Optional. By default source file paths are relative to the directory in which compiles originally occurred. This argument makes it possible to copy and evaluate generated makefiles within directories that are different from where compiles originally occurred. -help Displays the commands options and arguments. Optional.
500
Commands vmake
-ignore Omits a make rule for the named primary design unit and its secondary design units. Optional.
<library_name> Specifies the library name; if none is specified, then work is assumed. Optional.
Examples To produce a makefile for the work library:

vmake >mylib.mak
To run vmake on libraries other than work:

vmake mylib >mylib.mak
To rebuild mylib, specify its makefile when you run MAKE:

make -f mylib.mak
501
Commands vmap
vmap
The vmap command defines a mapping between a logical library name and a directory by modifying the modelsim.ini file. With no arguments, vmap reads the appropriate modelsim.ini file(s) and prints the current logical library to physical directory mappings. Returns nothing. Syntax vmap [-help] [-c] [-del] [<logical_name>] [<path>] Arguments -help Displays the commands options and arguments. Optional. -c Copies the default modelsim.ini file from the ModelSim installation directory to the current directory. Optional. This argument is intended only for making a copy of the default modelsim.ini file to the current directory. Do not use it while making your library mappings or the mappings may end up in the incorrect copy of the modelsim.ini. -del Deletes the mapping specified by <logical_name> from the current project file. Optional. <logical_name> Specifies the logical name of the library to be mapped. Optional. <path> Specifies the pathname of the directory to which the library is to be mapped. Optional. If omitted, the command displays the mapping of the specified logical name.
502
Commands vopt
vopt
The vopt command performs global optimizations on designs after they have been compiled with vcom or vlog. For detailed usage information on optimization, refer to the chapter entitled Optimizing Designs with vopt in the Users Manual. Note The default optimization behavior of vopt may differ from what is documented in this section if you are using any modelsim.ini file other than the one shipped with the tool. See Optimizing Designs with vopt and "VoptFlow" in the Users Manual for information on possible optimization settings. The vopt command produces an optimized version of your design in the working directory. You provide a name for this optimized version using the -o argument. You can then invoke vsim directly on that new design unit name. The vopt command makes use of the PathSeparator variable from the modelsim.ini file, which allows you to specify which character the tool recognizes as a path separator. By default, vopt expects you to use the forward-slash (/), but you could change this to a period (.) for ease of use with Verilog designs, for example:
vopt top -o opttop +acc=rn+.top.middle.bottom -G.top.myparam=4
The default operation of vopt -o <name> is incremental compilation that is, ModelSim reuses elements of the design that have not changed. This results in a boost of vopt performance when a design has been minimally modified. In the course of optimizing a design, vopt will remove objects that are deemed unnecessary for simulation. For example, line numbers are removed, processes are merged, nets and registers may be removed, etc. If you need visibility into your design for debugging purposes, use the +acc argument to conditionally enable visibility for parts of your design. Note, however, that using +acc may reduce simulation speed. All arguments to the vopt command are case sensitive: -WORK and -work are not equivalent. Note Many of the arguments below may also be specified at compile time (e.g., -O5). These "in-common" arguments are processed by vopt automatically (i.e., if you specify them at compile time, vopt will use them automatically during optimization). The first instance of an in-common argument takes priority. For example, if you specify -O5 to vlog or vcom, and then specify -O1 to vopt, -O5 takes precedence. There is one exception to this rule: vopt will "OR" any -cover arguments to vlog or vcom (vlog -cover bc) with any -cover arguments to vopt (vopt -cover est) Syntax vopt <design_unit> -o <name>
503
Commands vopt
[+acc[=<spec>][+<selection>[.] | +<entity>[(<architecture>)] [.]]] [-bbox] [-compat] [-cover <stat>] [-nocovershort] [-covercells] [-enablescstdout] [-debugCellOpt] [-deferSubpgmCheck] [+delay_mode_distributed] [+delay_mode_path] [+delay_mode_unit] [+delay_mode_zero] [-dpiheader <filename>] [-error <msg_number>[,<msg_number>,...]] [-f <filename>] [-fatal <msg_number>[,<msg_number>,]] [+floatgenerics[+<selection>[.]]] [+floatparameters[+<selection>[.]]] [-fsmdebug] [-fsmimplicittrans] [-fsmresettrans] [-fsmsingle] [-fsmverbose] [-g<Name>=<Value> ] [-G<Name>=<Value> ] [-hazards] [-help] [-incr | -noincr] [+initmem[=<spec>][+{0 | 1 | X | Z}][+<selection>[.]]] [+initreg[=<spec>][+{0 | 1 | X | Z}][+<selection>[.]]] [-ka] [-keep_delta] [-L <libname>] [-Lf <libname>] [+maxdelays] [+mindelays] [-mti_trace_vlog_calls] [-mixedansiports] [+nocheck<CODE>] [-nocover] [-nocovercells] [-nocoverfec] [-nocovergenerate] [-nodebug[=ports | =pli | =ports+pli]] [-nofsmresettrans] [-nofsmsingle] [-nofsmxassign] [+nolibcell] [-nologo] [+nosparse[+<selection> [.]]] [+nospecify] [-note <msg_number>[,<msg_number>,...]] [+notimingchecks] [+nowarn<CODE>] [-nowarn <category_number>] [-O0 | -O1 | -O4 | -O5] [-quiet] [-sclib <library>] [-sdfmin | -sdftyp | -sdfmax[@<delayScale>] [<instance>=]<sdf_filename>] [-sdfmaxerrors <n>] [-source] [-suppress <msg_number>[,<msg_number>,...]] [-tab <tabfile>] [-time] [-timescale <time_units>/<time_precision>] [+typdelays] [-version] [-warning <msg_number>[,<msg_number>,...]] [-work <library_name>] Arguments +acc[=<spec>][+<selection>[.] | +<entity>[(<architecture>)] [.]] Enable PLI and debug command access to objects indicated by <spec> when optimizing a design. Optional.
504
Commands vopt
Note Using this option may reduce simulation speed.
=<spec> optionally, one or more of the following characters. If <spec> is omitted, the entire set of access specifiers is enabled. b Enable access to bits of vector nets. This is necessary for PLI applications that require handles to individual bits of vector nets. Also, some user interface commands require this access if you need to operate on net bits. c Enable access to library cells. By default any Verilog module containing a non-empty specify block may be optimized, and debug and PLI access may be limited. This option keeps module cell visibility. f Enable access to finite state machines. l Enable access to line number directives and process names. m Preserve the visibility of module, program, and interface instances. n Enable access to nets. p Enable access to ports. This disables the module inlining optimization, and is necessary only if you have PLI applications that require access to port handles. q Enable access to VHDL variables and generics. r Enable access to registers (including memories, integer, time, and real types). s Enable access to system tasks. t Enable access to tasks and functions. u Enable access to primitive instances. v Enable access to variables, constants, and aliases in processes (VHDL design units only) that would otherwise be merged due to optimizations. Disables an optimization that automatically converts variables to constants. +<selection> enables access for specific Verilog design objects and/or regions, optionally followed by ".", selection occurs recursively downward from the specified module or instance. Multiple selections are allowed, with each separated by a "+" (+acc=rn+top1+top2). If no selection is specified, then all modules are affected. Ensure that you do not put a space between any <spec> arguments and the +<selection> argument. You can use a path delimiter to select unique instances or objects (+acc=mrp+/top/ul. or +acc=r+/top/myreg). If you specify a module name (+acc=rn+Demux), pertinent objects in side the module are selected. +<entity>[(architecture)] enables access for all instances of the specified VHDL entity, optionally followed by "." to indicate all children of the module.
505
Commands vopt
-bbox Instructs vopt to optimize a portion of the design, allowing you to reuse the optimized portion and speed up future simulation and optimization runs. Refer to the section "Optimizing Portions of your Design" for further information.
-compat Disables optimizations that result in different event ordering than Verilog-XL. Optional. ModelSim Verilog generally duplicates Verilog-XL event ordering, but there are cases where it is inefficient to do so. Using this option does not help you find event order dependencies, but it allows you to ignore them. Keep in mind that this option does not account for all event order discrepancies, and that using this option may degrade performance. Refer to Event Ordering in Verilog Designs for additional information.
+cover <stat> Enables various coverage statistics collection. The use of +cover is recommended over -cover, as it is more powerful and flexible, and often yields better performance. To obtain the behavior of the obsolete -coverAll argument, use the +cover argument without any <stat> characters. Optional. <stat> one or more of the following characters: b Collect branch statistics. c Collect condition statistics. Collects both FEC and UDP statistics, unless -nocoverfec is specified. e Collect expression statistics, Collects both FEC and UDP statistics, unless -nocoverfec is specified. s Collect statement statistics. t Collect toggle statistics. Overridden if x is specified elsewhere. x Collect extended toggle statistics (Refer to Toggle Coverage for details). This takes precedence, if t is specified elsewhere. f Collect Finite State Machine statistics. See -coveropt argument to override the default level of optimization for coverage for a particular compilation run.
-cover <stat> Recommendation: Use the +cover argument, as its power and flexibility often yields better performance. Instructs ModelSim to recompile the design for specified types of coverage statistics collection. Optional. <stat> one or more of the following characters: b Collect branch statistics. c Collect condition statistics.
506
Commands vopt
e Collect expression statistics. s Collect statement statistics. t Collect toggle statistics. Cannot be used if x is specified. x Collect extended toggle statistics (Refer to Toggle Coverage for details). Cannot be used if t is specified. f Collect Finite State Machine statistics. <i> Override the default level of optimization for current run only, where i is an integer between 1 and 4. To change default level for all subsequent runs, change value of CoverOpt variable in modelsim.ini file. See CoverOpt for a description of optimization levels. When you specify -cover to vopt, it will logically OR the -cover arguments to vlog/vcom with the -cover arguments to vopt. You can force coverage to be off and the time of running vopt by specifying -nocover. -nocovershort Disables short circuiting of expressions when coverage is enabled. Short circuiting is enabled by default. -covercells Enables code coverage of modules defined by celldefine and endcelldefine compiler directives, or compiled with the -v or -y arguments. Optional. Can be used to override the CoverCells compiler control variable in the modelsim.ini file. -coveropt Overrides the default level of optimization for the current run only. Optional. Edit the CoverOpt variable in the modelsim.ini file to set a permanent default. See CoverOpt for a description of optimization levels. -debugCellOpt Produces Transcript pane output that identifies why certain cells within the design were not optimized. Optional. -deferSubpgmCheck Forces the compiler to report array indexing and length errors as warnings (instead of as errors) when encountered within subprograms. Subprograms with indexing and length errors that are invoked during simulation cause the simulator to report errors, which can potentially slow down simulation because of additional checking. +delay_mode_distributed Disables path delays in favor of distributed delays. Optional. Refer to Delay Modes for details. +delay_mode_path Sets distributed delays to zero in favor of using path delays. Optional.
507
Commands vopt
+delay_mode_unit Sets path delays to zero and non-zero distributed delays to one time unit. Optional. +delay_mode_zero Sets path delays and distributed delays to zero. Optional. -dpiheader <filename> Generates a header file that may then be included in C source code for DPI import functions. Optional. Refer to DPI Use Flow for additional information.
-enablescstdout Enables the reporting of messages from the SystemC tasks cout, printf and fprintf to stdout during the execution of vopt. This behavior is suppressed by default. However, information printed to stderr will always be displayed.
-error <msg_number>[,<msg_number>,...] Changes the severity level of the specified message(s) to "error." Optional. Edit the error variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information.
-f <filename> Specifies a file with more command line arguments. Optional. Allows complex arguments to be reused without retyping. Allows gzipped input files. Nesting of -f options is allowed. Refer to the section "Argument Files" for more information.
+floatgenerics[+<selection>[.]] Instructs the tool to not lock down generics values during optimization, which enables successful use of the vsim -g/G options. +<selection> localizes the effect of this option to specific generics in the design hierarchy. +<selection> can be a hierarchical path to a generic or a design unit instance. It can also be the name of a design unit declaration. . If a period (.) is present after an instance or design unit name, all generics under that scope are recursively selected. Refer to the section "Optimizing Parameters and Generics" for more information. This command is fully equivalent to +floatparameters, therefore you can use them interchangeably.
+floatparameters[+<selection>[.]] Instructs the tool to not lock down parameter values during optimization, which enables successful use of the vsim -g/G options.
508
Commands vopt
+<selection> localizes the effect of this option to specific parameters in the design hierarchy. +<selection> can be a hierarchical path to a parameter or a design unit instance. It can also be the name of a design unit declaration. . If a period (.) is present after an instance or design unit name, all parameters under that scope are recursively selected. Refer to the section "Optimizing Parameters and Generics" for more information. This command is fully equivalent to +floatgenerics, therefore you can use them interchangeably. -fsmdebug Enables recognition of state machines and display of state and transition data in the FSM Viewer. Optional. -fsmimplicittrans Enables recognition of implied same state transitions. Optional -fsmresettrans Enables recognition of implicit asynchronous reset transitions. Optional. This includes asynchronous reset transitions in coverage results. -fsmsingle Enables recognition of FSMs having single bit current state variable. Optional. -fsmverbose Provides information about FSMs detected, including state reachability analysis. Optional. -g<Name>=<Value> Assigns a value to all specified VHDL generics and Verilog parameters that have not received explicit values in generic maps, instantiations, or via defparams (such as top-level generics/parameters and generics/parameters that would otherwise receive their default values). Optional. Note there is no space between -g and <Name>=<Value>. For more information on this switch, refer to the longer description under vsim -g<Name>=<Value> Refer to the section "Optimizing Parameters and Generics" for more information. Limitation: In general, generics/parameters of composite type (arrays and records) cannot be set from the command line. However, you can set string arrays, std_logic vectors, and bit vectors if they can be set using a quoted string. For example,
-gstrgen="This is a string" -gslv="01001110"
The quotation marks must make it into vsim as part of the string because the type of the value must be determinable outside of any context. Therefore, when entering this command from a shell, put single quotes ( ' ) around the string. For example:
-gstrgen='"This is a string"'
509
Commands vopt
If working within the ModelSim GUI, you would enter the command as follows:
{-gstrgen="This is a string"}
You can also enclose the value escaped quotes (\"), for example:
-gstrgen=\"This is a string\"
-G<Name>=<Value> Same as -g (see above) except that it will also override generics/parameters that received explicit values in generic maps, instantiations, or via defparams. Optional. Note there is no space between -G and <Name>=<Value>. This argument is the only way for you to alter the generic/parameter, such as its length, (other than its value) after the design has been loaded. If <value> is a string, you must enclose it in escaped quotes (\"), for example:
-Gfilename=\"a.in\"
Refer to the section "Optimizing Parameters and Generics" for more information. -hazards Detects event order hazards involving simultaneous reading and writing of the same register in concurrently executing processes. Optional. You must also specify this argument when you simulate the design with vsim. Refer to Hazard Detection for more details. Note Enabling -hazards implicitly enables the -compat argument. As a result, using this argument may affect your simulation results. -help Displays the commands options and arguments. Optional. -incr | -noincr Defines whether vopt reuses design elements or not. -incr Instructs vopt to only optimize design elements that have changed since a previous optimization. Default -noincr Instructs vopt to optimize all design elements, even if they have not changed since a previous optimization. +initmem[=<spec>][+{0 | 1 | X | Z}][+<selection>[.]] Enables the initialization of memories. Optional. =<spec> (optional) identifies the types to be initialized. If you do not specify this option, vlog initializes fixed-size arrays of all these types, where fixed-size arrays may have any number of packed or unpacked dimensions. <spec> can be one or more of the following: r register/logic, integer, or time types (four-state integral types).
510
Commands vopt
b bit, int, shortint, longint, or byte types (two-state integral types). e enum types. You must also add the enum's base type to the initialization specification. If you choose static initialization for an enum type variable with value 0, 1, X, or Z, the simulator assigns that value to the variable, whether it is a valid value or not. If you choose random initialization for an enum type variable, the simulator generates a random number and uses the (random_number % num_valid_enum_values)th entry of the enum literals to initialize it. u sequential UDPs. +{0 | 1 | X | Z} (optional) specifies the value to use in initialization for all bits of a memory. For two-state datatypes, X and Z will map to 0. If you do not specify this option you are preparing the design unit for randomization with vsim +initmem +<seed>. +<selection>[.] specifies a design unit name (module, package, interface, or program), or an instance name. An optional trailing '.' after the "selection" means that the initialization recursively descends into the hierarchy. If you do not specify this argument, the initialization is provided to the entire design. If initialization is recursively extended to descendants of a given design unit, and a descendant has an explicit initialization specification applied to it, the child's initialization specification overrides the parent's initialization specification. The initialization specifications of the parent and child are not merged together (as is done with +acc options). The default initialization state for top modules is "no_init", provided a top module does not have an explicit initialization specification applied to it. This argument initializes static variables in any scope (package, $unit, module, interface, generate, program, task, function). However, it does not affect: automatic variables dynamic variables members of dynamic variables artificially generated variables, such as #randstate#
Because you can specify +initmem on the vlog and vopt command line, the priority of the specifications are as follows:
1) vopt ... +initmem+1+top.foo 2) vlog ... +initmem+0 3) vopt ... +initmem+Z
reg r = 1b0
511
Commands vopt
+initreg[=<spec>][+{0 | 1 | X | Z}][+<selection>[.]] Enables you to initialize registers. Optional. =<spec> (optional) identifies the types to be initialized. If you do not specify this option, vlog initializes variables of all these types. <spec> can be one or more of the following: r register/logic, integer, or time types (four-state integral types). Notifier registers are not initialized by the +initreg option. b bit, int, shortint, longint, or byte types (two-state integral types). e enum types. You must also add the enum's base type to the initialization specification. If you choose static initialization for an enum type variable with value 0, 1, X, or Z, the simulator assigns that value to the variable, whether it is a valid value or not. If you choose random initialization for an enum type variable, the simulator generates a random number and uses the (random_number % num_valid_enum_values)th entry of the enum literals to initialize it. u sequential UDPs. If a sequential UDP contains an "initial" statement, that initial value overrides all +initreg-related functionality. For other sequential UDPs, the +initreg option takes effect as described for regular variables. In case a sequential UDP does not contain an "initial" statement, and it wasn't compiled with +initreg in effect, the UDPs initial value will be taken from its instantiating parent scope (provided that scope has +initreg options in effect). +{0 | 1 | X | Z} (optional) specifies the value to use in initialization. For two-state datatypes, X and Z will map to 0. If you do not specify this option you are preparing the design unit for randomization with vsim +initreg +<seed> +<selection>[.] specifies a design unit name (module, package, interface, or program), or an instance name. An optional trailing '.' after the "selection" means that the initialization recursively descends into the hierarchy. If you do not specify this argument, the initialization is provided to the entire design. If initialization is recursively extended to descendants of a given design unit, and a descendant has an explicit initialization specification applied to it, the child's initialization specification overrides the parent's initialization specification. The initialization specifications of the parent and child are not merged together (as is done with +acc options). The default initialization state for top modules is "no_init", provided a top module does not have an explicit initialization specification applied to it. This argument initializes static variables in any scope (package, $unit, module, interface, generate, program, task, function). However, it does not affect: automatic variables
512
Commands vopt
dynamic variables members of dynamic variables artificially generated variables, such as #randstate#
Because you can specify +initreg on the vlog and vopt command line, the priority of the specifications are as follows:
1) vopt ... +initreg+1+top.foo 2) vlog ... +initreg+0 3) vopt ... +initreg+Z
reg r = 1b0
-ka (optional) This switch, which is short for keep alternate, informs vopt that it should attempt to preserve a 32-bit version of an optimized design, if it exists, if compiling with a 64-bit version of vopt (and vice versa). When you specify -ka, vopt attempts to retain the 32- or 64-bit version of the design unit, thus overlaying both into the same optimized design. This allows you to maintain a single optimized design unit that can be simulated by both 32- and 64-bit versions of the simulator. This switch requires you to follow these compatibility rules:
o
All designs that go into the optimized design must be the same, specifically nothing can be changed or recompiled. You must use the same version of the simulator for both compilations. All command line and modelsim.ini options that affect compilation must be the same, including library mapping.
o o
For example, if you are using a 32-bit version of vopt and enter:
vopt -o mydesign top1 top2 +acc
then at another point use a 64-bit version of vopt:

vopt -o mydesign top1 top2 +acc -ka
mydesign will result in having both 32- and 64-bit versions, assuming you did not change any modelsim.ini settings or recompile any design units. This command is most useful for users who distribute black-boxed design units, specifically if the recipient switches between 32- and 64-bit execution. -keep_delta Disables optimizations that remove delta delays. Optional.
513
Commands vopt
Delta delays result from zero delay events. Those events are normally processed in the next iteration or "delta" of the current timestep. Vopt implements optimizations that can remove delta delays and process an event earlier. -L <libname> Searches the specified resource library for precompiled modules. The library search options you specify here must also be specified when you run the vsim command. Optional. -Lf <libname> Same as -L, but the specified library is searched before any uselib directives. (Refer to Library Usage and Verilog-XL Compatible Compiler Arguments for more information.) Optional. +maxdelays Selects maximum delays from the "min:typ:max" expressions. Optional. If preferred, you can defer delay selection until simulation time by using vsim -sdfmax. +mindelays Selects minimum delays from the "min:typ:max" expressions. Optional. If preferred, you can defer delay selection until simulation time by using vsim -sdfmin. -mti_trace_vlog_calls Enables viewing of SystemVerilog class contents in the Wave window. Optional. +nocheck<CODE> Disables the specified optimization check. Optional. <CODE> may be one of the following: ALL Enables all +nocheck arguments described below except INBUF. CLUP Allows connectivity loops in a cell to be optimized. DELAY When used in conjunction with +delay_mode_path (see above), allows inlined Verilog modules with distributed delays and no path delays to be optimized. DNET Allows both the port and the delayed port (created for negative setup/hold) to be used in the functional section of the cell. INBUF Enables optimizations where buffers are used between input ports and timing checks. Disables optimized gate-level compiler checks for multiple drivers due to input buffering. It should be used with old models that are coded with input buffers to approximate the behavior that is now available in the Verilog 2000 standard (v2k_int_delay). INTRI Allows inputs of type tri1 or tri0 in cell optimizations. OPRD Allows an output port to be read internally by the cell. Note that if the value read is the only value contributed to the output by the cell, and if there's a driver on the net outside the cell, the value read will not reflect the resolved value. SUDP Allows a sequential UDP to drive another sequential UDP.
514
Commands vopt
-nocover Disables code coverage on all source files, regardless of any -cover arguments specified to vlog or vopt. Optional.
-nocovercells Disables code coverage of modules defined by celldefine and endcelldefine compiler directives, or compiled with the -v or -y arguments. Optional. Can be used to override the CoverCells compiler control variable in the modelsim.ini file.
-nodebug[=ports | =pli | =ports+pli] Hides, within the GUI and other parts of the tool, the internal data of all compiled design units. Optional. -nodebug The switch, specified in this form, does not hide ports, due to the fact that the port information may be required for instantiation in a parent scope. The design units source code, internal structure, registers, nets, etc. will not display in the GUI. In addition, none of the hidden objects may be accessed through the Dataflow window or with commands. This also means that you cannot set breakpoints or single step within this code. It is advised that you not compile with this switch until you are done debugging. Note that this is not a speed switch like the nodebug option on many other products. Use the vopt command to increase simulation speed. -nodebug=ports additionally hides the ports for the lower levels of your design; it should be used only to compile the lower levels of the design. If you hide the ports of the top level you will not be able to simulate the design. You should not use the switch in this form when working in mixed language designs or when the parent is part of a vopt -bbox flow. -nodebug=pli additionally prevents the use of pli functions to interrogate individual modules for information. You should be aware that this form will leave a "nodebug" module untraversable by PLI. -nodebug=ports+pli you can combine the behavior of =ports and =pli in this manner.
515
Commands vopt
This functionality encrypts entire files. The `protect compiler directive allows you to encrypt regions within a file. -nofsmresettrans Disables recognition of implicit asynchronous reset transitions. Optional. This has the effect of excluding asynchronous reset transitions from any coverage results. -nofsmsingle Disables recognition of FSMs having single bit current state variable. Optional. -nofsmxassign Disables recognition of FSMs containing x assignment. Optional. +nolibcell By default all modules compiled from a source library are treated as though they contain a `celldefine compiler directive. This option disables this default. The `celldefine directive only affects the PLI access routines acc_next_cell and acc_next_cell_load. Optional. -nologo Disables the startup banner. Optional. +nosparse[+<selection> [.]] Identifies which memories are considered "not sparse", which instructs the tool to override the rules for allocating storage for memory elements only when necessary. If you use +nosparse on a given memory, the tool will simulate the memory normally. Refer to Sparse Memory Modeling for more information. +<selection> enables access for specific Verilog design units, scopes, or design objects (vars, mem). Multiple selections are allowed, with each separated by a "+" (+nosparse=+top1+top2). If no selection is specified, then all modules are affected. You can use a path delimiter to select unique instances or objects (+nosparse=+/top/ul.). If you specify a module name (+nosparse=+Demux), pertinent objects inside the module are selected. . indicates the selection occurs recursively downward from the specified module or instance +nospecify Disables specify path delays and timing checks. Optional. -note <msg_number>[,<msg_number>,...] Changes the severity level of the specified message(s) to "note." Optional. Edit the note variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information. +notimingchecks Removes all timing check entries from the design as it is parsed. Optional. To disable checks on individual instances, use the tcheck_set command.
516
Commands vopt
Specifying vopt +notimingchecks or -GTimingChecks=<FALSE/TRUE> will fix the TimingChecksOn generic value in VITAL models to FALSE for simulation. As a consequence, using vsim +notimingchecks at simulation may not have any effect on the simulation depending on the optimization of the model. +nowarn<CODE> Disables warning messages in the category specified by <CODE>. Optional. Warnings that can be disabled include the <CODE> name in square brackets in the warning message. For example,
** Warning: test.v(15): [RDGN] - Redundant digits in numeric literal.
This warning message can be disabled by specifying +nowarnRDGN. -nowarn <category_number> Selectively disables a category of warning message. Optional. Multiple -nowarn switches are allowed. Warnings may be disabled for all compiles via the Main window Compile > Compile Options menu command or the modelsim.ini file (refer to VHDL Compiler Control Variables). The warning message categories are described in Table 2-11: Table 2-11. Warning Message Categories for vopt -nowarn Category Description number 1 2 3 4 5 6 7 8 9 10 12 13 14 unbound component process without a wait statement null range no space in time literal multiple drivers on unresolved signal VITAL compliance checks VITAL optimization messages lint checks signal value dependency at elaboration VHDL-1993 constructs in VHDL-1987 code non-LRM compliance in order to match Cadence behavior constructs that coverage can't handle locally static error deferred until simulation run
517
Commands vopt
-O0 | -O1 | -O4 | -O5 Lower the optimization to a minimum with -O0 (capital oh zero). Optional. Use this to work around bugs, increase your debugging visibility on a specific cell, or when you want to place breakpoints on source lines that have been optimized out. Please refer to the section "Optimizing Designs with vopt" in the Users Manual for detailed information on using vopt to perform optimization. Enable some optimization with -O1. Optional. Enable most optimizations with -O4. Default. Enable maximum optimization with -O5. Optional. -O5 attempts to optimize loops and prevents variable assignments in situations where a variable is assigned but is not actually used.
-quiet Disables 'Loading' messages. Optional. -source Displays the associated line of source code before each error message that is generated during compilation. Optional; by default, only the error message is displayed.
-sc_arg <string> ... Specifies a string representing a startup argument which is subsequently accessible from within SystemC via the sc_argc() and sc_argv() functions (refer to Accessing CommandLine Arguments. If multiple SystemC startup arguments are specified, each must have a separate -sc_arg argument. SystemC startup arguments returned via sc_argv() are in the order in which they appear on the command line. White space within the <string> will not be treated specially, and the string, white space and all, will be accessible as a single string among the strings returned by sc_argv().
-sclib <library> Specifies the design library where the SystemC shared library is created. By default, the SystemC shared library is created in the logical work library. This argument is only necessary when the shared library is compiled in a design library other than the logical work directory. See the sccom command for more information.
-sdfmin | -sdftyp | -sdfmax[@<delayScale>] [<instance>=]<sdf_filename> Annotates VITAL or Verilog cells in the specified SDF file (a Standard Delay Format file) with minimum, typical, or maximum timing. Optional. The optional argument @<delayScale> scales all values by the specified value. For example, if you specify [email protected], all maximum values in the SDF file will be scaled to 150% of their original value. Do not use this option if you scaled the SDF file while using the sdfcom command.
518
Commands vopt
The use of [<instance>=] with <sdf_filename> is also optional; it is used when the backannotation is not being done at the top level. Refer to Specifying SDF Files for Simulation. Note The tool will issue an error if you specify this switch and your SDF is being annotated to VHDL because the tool does not support compiled SDF for VHDL. -sdfmaxerrors <n> Controls the number of Verilog SDF missing instance messages that will be emitted before terminating vsim. Optional. <n> is the maximum number of missing instance error messages to be emitted. The default number is 5. Note The tool will issue an error if you specify this switch and your SDF is being annotated to VHDL because the tool does not support compiled SDF for VHDL. -suppress <msg_number>[,<msg_number>,...] Prevents the specified message(s) from displaying. Optional. You cannot suppress Fatal or Internal messages. Edit the suppress variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information. -tab <tabfile> Specifies the location of a Synopsys VCS table file (.tab), which vopt uses to improve the visibility of PLI functions in the design. <tabfile> The location of a .tab file containing information about PLI functions. The tool expects the .tab file to be based on Synopsys VCS version 7.2 syntax. Because the format for this file is non-standard, changes to the format are outside of the control of Mentor Graphics. When you use the Three-step optimization flow, you must specify this switch on both the vopt and vsim command lines. This is because vopt uses this file to improve the visibility of PLI functions and vsim uses it to register the PLI functions. -time Reports the "wall clock time" vopt takes to optimize the design. Optional. Note that if many processes are running on the same system, wall clock time may differ greatly from the actual "cpu time" spent on vopt. -timescale <time_units>/<time_precision> Specifies the default timescale for modules not having an explicit timescale directive in effect during compilation. Optional. The format of the -timescale argument is the same as that of the `timescale directive. The format for <time_units> and <time_precision> is <n><units>. The value of <n> must be 1, 10, or 100. The value of <units> must be fs, ps,
519
Commands vopt
ns, us, ms, or s. In addition, the <time_units> must be greater than or equal to the <time_precision>. +typdelays Selects typical delays from the "min:typ:max" expressions. Default. If preferred, you can defer delay selection until simulation time by using vsim -sdfmin. -version Returns the version of the optimizer as used by the licensing tools. Optional. -warning <msg_number>[,<msg_number>,...] Changes the severity level of the specified message(s) to "warning." Optional. Edit the warning variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information. -work <library_name> Specifies a logical name or pathname of a library that is to be mapped to the logical library work. Optional. By default, the optimized output for the design is added to the work library. The specified pathname overrides the pathname specified for work in the project file. <design_unit> One or more top-level design units that you want to optimize. Required. -o <name> Specifies a name for the optimized version of the design. Required. The name can contain only lower-case alpha and numeric characters and underscores. Examples Run optimizations on top-level design unit top and produce an optimized design unit named "mydesign". The simulator vsim is then invoked on design unit mydesign.
vopt top -o mydesign vsim mydesign
Run optimizations both top-level design units top and testtop and produce a global optimized design unit named mydesign.
vopt top testtop -o mydesign
Run optimizations on top-level design unit top but preserve all visibility. Names the optimized design "mydesign."
vopt top +acc -o mydesign
Run optimizations on top-level design unit top but preserve visibility on sub-module foo. Names the optimized design "mydesign."
vopt top +acc+foo -o mydesign
520
Commands vopt
Run optimizations on top-level design unit top but preserve visibility on sub-module foo and all its children.
vopt top +acc+foo. -o mydesign
Run optimizations on top-level design unit top but enable net and register access in all modules in the design. Names the optimized design "mydesign."
vopt top +acc=rn -o mydesign
See also Optimizing Designs with vopt
521
Commands vsim
vsim
The vsim command is used to invoke the VSIM simulator, to view the results of a previous simulation run (when invoked with the -view switch), or to view coverage data stored in the UCDB from a previous simulation run (when invoked with the -viewcov switch). You can simulate a VHDL configuration or an entity/architecture pair; a Verilog module or configuration; a SystemC module; or an optimized design. If you specify a VHDL configuration, it is invalid to specify an architecture. During elaboration vsim determines if the source has been modified since the last compile. To manually interrupt design loading use the Break key or <Ctrl-c> from a shell. You can invoke vsim from a command prompt or in the Transcript pane of the Main window. You can also invoke it from the GUI by selecting Simulate > Start Simulation. All arguments to the vsim command are case sensitive; for example, -g and -G are not equivalent. Syntax Note This Syntax section presents all of the vsim switches in alphabetical order, while the Arguments section groups the arguments into the following sections: Arguments, all languages Arguments, VHDL Arguments, Verilog Arguments, SystemC Arguments, object vsim [-absentisempty] [+alt_path_delays] [-assertfile <filename>] [-autoexclusionsdisable=[assertions | fsm | none]] [-c] [-capacity] [-colormap new] [-compress_elab] [-coverage] [-coverCountNone] [-debugDB=<db_pathname>] [+delayed_timing_checks] [-display <display_spec>] [-do <command_string> | <macro_file_name>] [-dpiexportobj <objfile>] [-dpioutoftheblue 1 | 0] [+dumpports+collapse | +dumpports+nocollapse] [+dumpports+direction] [+dumpports+no_strength_range] [+dumpports+unique] [-error <msg_number>[,<msg_number>,]] [-elab <filename>] [-elab_cont <filename>] [-elab_defer_fli] [-errorfile <filename>] [-f <filename>] [-fatal <msg_number>[,<msg_number>,]] [-filemap_elab <HDLfilename>=<NEWfilename>] [-foreign <attribute>] [-fsmdebug] [-g<Name>=<Value> ] [-G<Name>=<Value> ] [-gblso <filename>] [-geometry <geometry_spec>] [-gui]
522
Commands vsim
[-hazards] [-help] [-i] [+initmem+<seed>] [+initreg+<seed>] [-installcolormap] [-keeploaded] [-keeploadedrestart] [-keepstdout] [-l <filename>] [-lib <libname>] [<license_option>] [-L <library_name> ] [-Lf <library_name> ] [<library_name>.<design_unit>] [-load_elab <filename>] [+maxdelays] [+mindelays] [-memprof] [-memprof+call] [-memprof+file=<filename>] [-memprof+fileonly=<filename>] [-msgmode both | tran | wlf] [-multisource_delay min | max | latest] [+multisource_int_delays] [-name <name>] [+no_autdtc] [-noautoldlibpath] [-nodpiexports] [-no_autoacc] [+no_cancelled_e_msg] [+no_glitch_msg] [+no_neg_tchk] [+no_notifier] [+no_path_edge] [+no_pulse_msg] [-no_risefall_delaynets] [+no_show_cancelled_e] [+no_tchk_msg] [-nocollapse] [-nocapacity] [-nocompress] [-noexcludehiz] [-nofileshare] [-noglitch] [+nosdferror] [+nosdfwarn] [+nospecify] [-note <msg_number>[,<msg_number>,]] [+notimingchecks] [+nowarn<CODE>] [+ntc_warn] [-onfinish ask | stop | exit] [-pli "<object list>"] [+<plusarg>] [-printsimstats] [+pulse_e/<percent>] [+pulse_e_style_ondetect] [+pulse_e_style_onevent] [+pulse_r/<percent>] [-quiet] [-restore <filename>] [-sc_arg <string> ...] [-scdpidebug] [-sclib <library>] [+sdf_iopath_to_prim_ok] [+sdf_nocheck_celltype] [-sdfmin | -sdftyp | -sdfmax[@<delayScale>] [<instance>=]<sdf_filename>] [-sdfmaxerrors <n>] [-sdfnoerror] [-sdfnowarn] [+sdf_verbose] [-std_input <filename>] [-std_output <filename>] [+show_cancelled_e] [-strictvital] [-suppress <msg_number>[,<msg_number>,]] [-sv_lib <shared_obj>] [-sv_liblist <filename>] [-sv_root <dirname>] [-sync] [-t [<multiplier>]<time_unit>] [-tab <tabfile>] [-tag <string>] [-title <title>] [-togglecountlimit] [-toggleMaxIntValues <int>] [-toggleNoIntegers] [-togglenosubs] [-togglenovlogints] [-togglevlogints] [-togglewidthlimit] [-trace_foreign <int>] [+transport_int_delays] [+transport_path_delays] [+typdelays] [-v2k_int_delays] [-vcdread <filename>] [-vcdstim [<instance>=]<filename>] [-version] [-view [<dataset_name>=]<WLF_filename>] [-viewcov [<dataset_name>=]<UCDB_filename>] [-visual <visual>] [-vital2.2b] [+vlog_retain_on] [-vopt | -novopt] [-voptargs="<args>"] [-vopt_verbose] [-warning <msg_number>[,<msg_number>,]] [-wlf <filename>] [-wlfcachesize <n>] [-wlfcollapsedelta] [-wlfcollapsetime] [-wlfcompress] [-wlfdeleteonquit] [-wlflock] [-wlfnocollapse] [-wlfnocompress] [-wlfnodeleteonquit] [-wlfnolock] [-wlfnoopt] [-wlfopt]
523
Commands vsim
[-wlfsimcachesize <n>] [-wlfslim <size>] [-wlftlim <duration>] [-wlfthreads | -wlfnothreads] Arguments, all languages -assertfile <filename> Designates an alternative file for recording VHDL assertion messages. Optional. An alternate file may also be specified by the AssertFile modelsim.ini variable. By default, assertion messages are output to the file specified by the TranscriptFile variable in the modelsim.ini file (refer to Creating a Transcript File). -autoexclusionsdisable=[assertions | fsm | none] Disables automatic code coverage exclusions for FSMs and VHDL/SVA immediate and concurrent assertions and their action blocks. Optional. By default, FSMs and VHDL/SVA immediate and concurrent assertions (and their action blocks) are excluded from code coverage. To change this default behavior, use the AutoExclusionsDisable variable in the modelsim.ini file. If an FSM state is excluded, then all transitions from and to this state are also excluded. -c Specifies that the simulator is to be run in command-line mode. Optional. Refer to Modes of Operation for more information. -capacity Enables the fine-grain analysis display of memory capacity (coarse-grain analysis is enabled by default). Optional. -colormap new Specifies that the window should have a new private colormap instead of using the default colormap for the screen. Optional. -compress_elab Compresses an elaboration file when it is created. Optional. Refer to Simulating with an Elaboration File for more information. -coverage Turns off optimizations that interfere with code coverage and enables code coverage statistics collection during simulation. Optional. By default, the following optimizations (CoverOpt variable set to 2) are allowed Allows optimizations that provide large performance improvements by invoking sequential processes only when the data changes. Allows VHDL flip-flop recognition. This setting may result in major reductions in coverage counts.
524
Commands vsim
Change the default level of optimizations by editing the CoverOpt variable in the modelsim.ini file. Refer to Notes on Coverage and Optimization and CoverOpt in the Users Manual for more information. -coverCountNone Disables the default behavior of the simulator to increment the count of all matching rows in condition and expression coverage UDP tables. Optional. Change the default behavior by editing the CoverCountAll variable in the modelsim.ini file. Please refer to the Code Coverage chapter in the Users Manual for more information. -display <display_spec> Specifies the name of the display to use. Optional. Does not apply to Windows platforms. For example:
-display :0
-displaymsgmode both | tran | wlf Controls the transcription of $display system task messages to the transcript and/or the Message Viewer. Refer to the section "Message Viewer Tab" in the Users Manual for more information and the displaymsgmode .ini file variable. both outputs messages to both the transcript and the WLF file. tran outputs messages only to the transcript, therefore they are not available in the Message Viewer. Default behavior wlf outputs messages only to the WLF file/Message Viewer, therefore they are not available in the transcript. The display system tasks displayed with this functionality include: $display, $strobe, $monitor, $write as well as the analogous file I/O tasks that write to STDOUT, such as $fwrite or $fdisplay.
-debugDB=<db_pathname> Instructs ModelSim to generate database of dataflow connectivity information to be used for post-sim debug in the Dataflow window. Optional. The database pathname should have a .dbg extension. If a database pathname is not specified, ModelSim creates a database file named vsim.dbg in the current directory. See Post-Simulation Debug Flow Details.
-do <command_string> | <macro_file_name> Instructs vsim to use the command(s) specified by <command_string> or the macro file named by <macro_file_name> rather than the startup file specified in the .ini file, if any. Optional. Multiple commands should be separated by semi-colons (;).
-dpioutoftheblue 1 | 0 Setting this variable to 1 instructs vsim to allow DPI out of the blue calls from C functions The C functions must not be declared as import tasks or functions.
525
Commands vsim
+dumpports+collapse | +dumpports+nocollapse Determines whether vectors (VCD id entries) in dumpports output or collapsed or not. Optional. The default behavior is collapsed, and can be changed by setting the DumpportsCollapse variable in the modelsim.ini file.
+dumpports+direction Modifies the format of extended VCD files to contain direction information. Optional. +dumpports+no_strength_range Ignores strength ranges when resolving driver values for an extended VCD file. Optional. This argument is an extension to the IEEE 1364 specification. Refer to Resolving Values for additional information.
+dumpports+unique Generates unique VCD variable names for ports in a VCD file even if those ports are connected to the same collapsed net. Optional.
-elab <filename> Creates an elaboration file for use with -load_elab. Optional. Refer to Simulating with an Elaboration File for more information.
-elab_cont <filename> Creates an elaboration file for use with -load_elab and then continues the simulation. Optional.
-elab_defer_fli Defers the initialization of FLI models until the load of the elaboration file. Use this argument along with -elab to create elaboration files for designs with FLI models that don't support checkpoint/restore. Note that FLI models sensitive to design load ordering may still not work correctly even if you use this argument.
-errorfile <filename> Designates an alternative file for recording error messages. Optional. An alternate file may also be specified by the ErrorFile modelsim.ini variable. By default, error messages are output to the file specified by the TranscriptFile variable in the modelsim.ini file (refer to Creating a Transcript File).
-f <filename> Specifies a file with more vsim command arguments. Optional. Allows complex argument strings to be reused without retyping. Refer to the section "Argument Files" for more information.
526
Commands vsim
-filemap_elab <HDLfilename>=<NEWfilename> Defines a file mapping during -load_elab that lets you change the stimulus. Optional. Refer to Simulating with an Elaboration File for more information.
-fsmdebug Enables recognition of state machines and display of state and transition data in the FSM Viewer. Optional.
-g<Name>=<Value> Assigns a value to all specified VHDL generics and Verilog parameters that have not received explicit values in generic maps, instantiations, or via defparams (such as top-level generics/parameters and generics/parameters that would otherwise receive their default values). Optional. Note there is no space between -g and <Name>=<Value>. "Name" is the name of the generic/parameter, exactly as it appears in the VHDL source (case is ignored) or Verilog source. "Value" is an appropriate value for the declared data type of a VHDL generic or any legal value for a Verilog parameter. Make sure the Value you specify for a VHDL generic is appropriate for VHDL declared data types. No spaces are allowed anywhere in the specification, except within quotes when specifying a string value. Multiple -g options are allowed, one for each generic/parameter. Name may be prefixed with a relative or absolute hierarchical path to select generics in an instance-specific manner. For example, specifying -g/top/u1/tpd=20ns on the command line would affect only the tpd generic on the /top/u1 instance, assigning it a value of 20ns. Specifying -gu1/tpd=20ns affects the tpd generic on all instances named u1. Specifying gtpd=20ns affects all generics named tpd. If more than one -g option selects a given generic the most explicit specification takes precedence. For example,
vsim -g/top/ram/u1/tpd_hl=10ns -gtpd_hl=15ns top
This command sets tpd_hl to 10ns for the /top/ram/u1 instance. However, all other tpd_hl generics on other instances will be set to 15ns. Limitation: In general, generics/parameters of composite type (arrays and records) cannot be set from the command line. However, you can set string arrays, std_logic vectors, and bit vectors if they can be set using a quoted string. For example,
-gstrgen="This is a string" -gslv="01001110"
The quotation marks must make it into vsim as part of the string because the type of the value must be determinable outside of any context. Therefore, when entering this command from a shell, put single quotes ( ' ) around the string. For example:
527
Commands vsim -gstrgen='"This is a string"'
{-gstrgen="This is a string"}
You can also enclose the value escaped quotes (\"), for example:
-gstrgen=\"This is a string\"
-G<Name>=<Value> Same as -g (see above) except that it will also override generics/parameters that received explicit values in generic maps, instantiations, or via defparams. Optional. Note there is no space between -G and <Name>=<Value>. This argument is the only way for you to alter the generic/parameter, such as its length, (other than its value) after the design has been loaded.
-gblso <filename> On UNIX platforms, loads PLI/FLI shared objects with global symbol visibility. Essentially all data and functions are exported from the specified shared object and are available to be referenced and used by other shared objects. This option may also be specified with the GlobalSharedObjectsList variable in the modelsim.ini file. Optional.
-geometry <geometry_spec> Specifies the size and location of the main window. Optional. Where <geometry_spec> is of the form:
WxH+X+Y
-gui Starts the ModelSim GUI without loading a design and redirects the standard output (stdout) to the GUI Transcript window. Optional.
-help Displays the commands options and arguments. Optional. -i Specifies that the simulator is to be run in interactive mode. Optional. -installcolormap For UNIX only. Causes vsim to use its own colormap so as not to hog all the colors on the display. This is similar to the -install switch on Netscape. Optional.
-keeploaded Prevents the simulator from unloading/reloading any FLI/PLI/VPI shared libraries when it restarts or loads a new design. Optional. The shared libraries will remain loaded at their current positions. User application code in the shared libraries must reset its internal state during a restart in order for this to work effectively.
528
Commands vsim
-keeploadedrestart Prevents the simulator from unloading/reloading any FLI/PLI/VPI shared libraries during a restart. Optional. The shared libraries will remain loaded at their current positions. User application code in the shared libraries must reset its internal state during a restart in order for this to work effectively. We recommend using this option if youll be doing warm restores after a restart and the user application code has set callbacks in the simulator. Otherwise, the callback function pointers might not be valid if the shared library is loaded into a new position.
-keepstdout For use with foreign programs. Instructs the simulator to not redirect the stdout stream to the Main window. Optional.
-l <filename> Saves the contents of the Transcript pane to <filename>. Optional. Default is taken from the TranscriptFile variable (initially set to transcript) in the modelsim.ini.
-L <library_name> Specifies the library to search for design units instantiated from Verilog and for VHDL default component binding. Refer to Library Usage for more information. If multiple libraries are specified, each must be preceded by the -L option. Libraries are searched in the order in which they appear on the command line.
-learn <root_file_name> (Must be specified with -novopt) Specifies that you want the simulator to generate control files for retaining the proper level of visibility when performing an optimized simulation. The files generated are:
top_pli_learn.acc top_pli_learn.ocf top_pli_learn.ocm
Refer to the section Preserving Design Visibility with the Learn Flow in the Users Manual for more information. -Lf <library_name> Same as -L but libraries are searched before uselib directives. Refer to Library Usage for more information. Optional. -lib <libname> Specifies the default working library where vsim will look for the design unit(s). Optional. Default is "work".
529
Commands vsim
<license_option> Restricts the search of the license manager. Optional. Use one of the following options. <license_option> -lic_lnl_only -lic_mixed_only -lic_no_lnl -lic_no_mix -lic_no_slvhdl -lic_no_slvlog -lic_nomgc -lic_nomti -lic_noqueue -lic_plus -lic_vhdl -lic_vlog Description check out msimhdlsim and hdlsim licenses only check out msimhdlsim/msimhdlmix and hdlsim/hdlmix licenses only exclude msimhdlsim and hdlsim licenses exclude msimhdlmix and hdlmix licenses exclude qhsimvh and vsim licenses exclude qhsimvl and vsimvlog licenses exclude any MGC licenses from the search exclude any MTI licenses from the search do not wait in queue when license is unavailable check out PLUS (VHDL and Verilog) license immediately after invocation check out VHDL license immediately after invocation check out VLOG license immediately after invocation
The options may also be specified with the License variable in the modelsim.ini file. Note that settings made from the command line are additive to options set in the License variable. For a complete list of license features and descriptions, see the ModelSim Installation & Licensing Guide, available from the Help menu within ModelSim. -load_elab <filename> Loads an elaboration file that was created with -elab. Optional. Refer to Simulating with an Elaboration File for more information. You can not use this switch with any form of the -memprof switch. To analyze memory usage when simulating an elaboration file, you will need to use the profile on command. For example:
vsim -load_elab top.elab -do "profile on -m -fileonly top_mem_run.rpt; run -all"
-memprof Causes memory allocation data to be collected during elaboration and simulation. Shows what part of the design is using memory. Optional.
530
Commands vsim
-memprof+call Unwinds the call stack and collects the call tree information. Optional. At the VSIM prompt, call stack collection can also be turned on with profile option collect_calltrees on and off with profile option collect_calltrees off.
-memprof+file=<filename> Saves memory profile data to the named file and makes the data available for viewing and reporting during the current simulation. The file can be used for archival or comparison purposes. Optional.
-memprof+fileonly=<filename> Saves memory profile data to the named file only. The file can be read in later with the profile reload command for analysis. This mode is useful for large designs, when the design plus internal profiling data would use up too much memory. Optional.
-msgmode both | tran | wlf Specifies the location(s) for the simulator to output elaboration and runtime messages. Refer to the section "Message Viewer Tab" in the Users Manual for more information. both outputs messages to both the transcript and the WLF file. Default behavior tran outputs messages only to the transcript, therefore they are not available in the Message Viewer. wlf outputs messages only to the WLF file/Message Viewer, therefore they are not available in the transcript.
-multisource_delay min | max | latest Controls the handling of multiple PORT or INTERCONNECT constructs that terminate at the same port. Optional. By default, the Module Input Port Delay (MIPD) is set to the max value encountered in the SDF file. Alternatively, you may choose the min or latest of the values. If you have a Verilog design and want to model multiple interconnect paths independently, use the +multisource_int_delays argument.
+multisource_int_delays Enables multisource interconnect delay with pulse handling and transport delay behavior. Works for both Verilog and VITAL cells. Optional. Use this argument when you have interconnect data in your SDF file and you want the delay on each interconnect path modeled independently. Pulse handling is configured using the +pulse_int_e and +pulse_int_r switches (described below). The +multisource_int_delays argument cannot be used if you compiled using the -novital argument to vcom. The -novital argument instructs vcom to implement VITAL functionality using VHDL code instead of accelerated code, and multisource interconnect delays cannot be implemented purely within VHDL.
531
Commands vsim
-name <name> Specifies the application name used by the interpreter for send commands. This does not affect the title of the window. Optional.
-no_autoacc Prevents vsim from automatically passing the +acc switch to vopt. Optional. By specifying this argument you can prevent vopt from opening any Verilog PLI modules for accessibility. You can pass specific +acc options to vopt by using the -voptargs argument.
-noautoldlibpath Disables the default internal setting of LD_LIBRARY_PATH, enabling you to set it yourself. Optional. This argument only valid for batch mode use (vsim invoked from a shell prompt, rather than inside the GUI).
-nocapacity Disables the display of both coarse-grain and fine-grain analysis of memory capacity. Optional.
-nocompress Causes VSIM to create uncompressed checkpoint files. Optional. This option may also be specified with the CheckpointCompressMode variable in the modelsim.ini file.
+no_notifier Disables the toggling of the notifier register argument of all timing check system tasks. Optional. By default, the notifier is toggled when there is a timing check violation, and the notifier usually causes a UDP to propagate an X. This argument suppresses X propagation in both Verilog and VITAL for the entire design. You can suppress X propagation on individual instances using the tcheck_set command.
+no_tchk_msg Disables error messages generated when timing checks are violated. Optional. For Verilog, it disables messages issued by timing check system tasks. For VITAL, it overrides the MsgOn arguments and generics. Notifier registers are still toggled and may result in the propagation of Xs for timing check violations. You can disable individual messages using the tcheck_set command.
-note <msg_number>[,<msg_number>,] Changes the severity level of the specified message(s) to "note." Optional. Edit the note variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information.
+notimingchecks Disables Verilog timing checks. (It does NOT set the generic TimingChecksOn to FALSE for all VHDL Vital models with the Vital_level0 or Vital_level1 attribute. Generics with the
532
Commands vsim
name TimingChecksOn on non-Vital models are unaffected.) Optional. By default, Verilog timing check system tasks ($setup, $hold,) in specify blocks are enabled. For VITAL, the timing check default is controlled by the ASIC or FPGA vendor, but most default to enabled. You can disable individual checks using the tcheck_set command. -novopt Prevents ModelSim from running the vopt command automatically. If you have the VoptFlow variable set to 1 (optimizations turned on) in the modelsim.ini file, vsim automatically runs vopt if you didnt invoke it manually. If you specify this argument, you should be sure to specify it with your compilation command (vcom or vlog) -plicompatdefault { latest | 2005 | 2001 } Specifies the VPI object model behavior within vsim. This switch applies globally, not to individual libraries. latest This is equivalent to the "2005" argument. This is the default behavior if you do not specify this switch or if you specify the switch without an argument. 2005 Instructs vsim to use the object models as defined in IEEE Std 1800-2005 and IEEE Std 1364-2005. You can also use "05" as an alias. 2001 Instructs vsim to use the object models as defined in IEEE Std 1364-2001. When you specify this argument, SystemVerilog objects will not be accessible. You can also use "01" as an alias. You can also control this behavior with the PliCompatDefault variable in the modelsim.ini file, where the -plicompatdefault argument will override the PliCompatDefault variable. You should note that there are a few cases where the 2005 VPI object model is incompatible with the 2001 model, which is inherent in the specifications. Refer to the appendix "Verilog Interfaces to C" in the Users Manual for more information. -printsimstats Prints the output of the simstats command to the screen at the end of simulation before exiting. Edit the PrintSimStats variable in the modelsim.ini file to set the simulation to print the simstats data by default. +pulse_int_e/<percent> Controls how pulses are propagated through interconnect delays, where <percent> is a number between 0 and 100 that specifies the error limit as a percentage of the interconnect delay. Optional. Used in conjunction with +multisource_int_delays (see above). This option works for both Verilog and VITAL cells, though the destination of the interconnect must be a Verilog cell. The source may be VITAL or Verilog. A pulse greater than or equal to the error limit propagates to the output in transport mode (transport mode allows multiple pending transitions on an output). A pulse less than the error limit and greater than or equal to the rejection limit (see +pulse_int_r/<percent> below) propagates to the output as an X. If the rejection limit is not specified, then it
533
Commands vsim
defaults to the error limit. For example, consider an interconnect delay of 10 along with a +pulse_int_e/80 option. The error limit is 80% of 10 and the rejection limit defaults to 80% of 10. This results in the propagation of pulses greater than or equal to 8, while all other pulses are filtered. +pulse_int_r/<percent> Controls how pulses are propagated through interconnect delays, where <percent> is a number between 0 and 100 that specifies the rejection limit as a percentage of the interconnect delay. Optional. This option works for both Verilog and VITAL cells, though the destination of the interconnect must be a Verilog cell. The source may be VITAL or Verilog. A pulse less than the rejection limit is filtered. If the error limit is not specified by +pulse_int_e then it defaults to the rejection limit. -quiet Disable 'Loading' messages during batch-mode simulation. Optional. -restore <filename> Specifies that vsim is to restore a simulation saved with the checkpoint command. Optional. You must restore vsim under the same environment in which you did the checkpoint. This means not only the same type of machine and OS and at least the same memory size, but also the same vsim environment such as GUI vs. command line mode. +sdf_iopath_to_prim_ok Prevents vsim from issuing an error when it cannot locate specify path delays to annotate. If you specify this argument, IOPATH statements are annotated to the primitive driving the destination port if a corresponding specify path is not found. Optional. Refer to SDF to Verilog Construct Matching for additional information. -sdfmin | -sdftyp | -sdfmax[@<delayScale>] [<instance>=]<sdf_filename> Annotates VITAL or Verilog cells in the specified SDF file (a Standard Delay Format file) with minimum, typical, or maximum timing. Optional. The optional argument @<delayScale> scales all values by the specified value. For example, if you specify [email protected], all maximum values in the SDF file are scaled to 150% of their original value. Do not use this option if you scaled the SDF file while using the sdfcom command. The use of [<instance>=] with <sdf_filename> is also optional; use it when the backannotation is not being done at the top level. Refer to Specifying SDF Files for Simulation. -sdfmaxerrors <n> Controls the number of Verilog SDF missing instance messages to be generated before terminating vsim. Optional. <n> is the maximum number of missing instance error messages to be emitted. The default number is 5.
534
Commands vsim
-sdfnoerror Errors issued by the SDF annotator while loading the design prevent the simulation from continuing, whereas warnings do not. Changes SDF errors to warnings so that the simulation can continue. Optional.
-sdfnowarn Disables warnings from the SDF reader. Optional. Refer to VHDL Simulation for an additional discussion of SDF.
+sdf_verbose Turns on the verbose mode during SDF annotation. The Transcript pane provides detailed warnings and summaries of the current annotation as well as information including the module name, source file name and line number. Optional.
-suppress <msg_number>[,<msg_number>,] Prevents the specified message(s) from displaying. Optional. You cannot suppress Fatal or Internal messages. Edit the suppress variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information.
-sync Executes all X server commands synchronously, so that errors are reported immediately. Does not apply to Windows platforms.
-t [<multiplier>]<time_unit> Specifies the simulator time resolution. Optional. <time_unit> must be one of the following:
fs, ps, ns, us, ms, sec
The default is 1ns; the optional <multiplier> may be 1, 10 or 100. Note that there is no space between the multiplier and the unit (for example, 10fs, not 10 fs). If you omit the -t argument, the default simulator time resolution depends on design type:
o
In a VHDL designthe value specified for the Resolution variable in modelsim.ini is used. In a Verilog design with timescale directivesthe minimum specified time precision of all directives is used. In a Verilog design with no timescale directivesthe value specified for the Resolution variable in the modelsim.ini file is used. In a mixed design with VHDL on topthe value specified for the Resolution variable in the modelsim.ini file is used. In a mixed design with Verilog on top for Verilog modules not under a VHDL instance: the minimum value specified for their timescale directives is used.
535
Commands vsim
for Verilog modules under a VHDL instance: all their timescale directives are ignored (the minimum value for timescale directives in all modules not under a VHDL instance is used).
If there are no timescale directives in the design, the value specified for the Resolution variable in modelsim.ini is used. Tip: After you have started a simulation, you can view the current simulator resolution by using the report command as follows:
report simulator state
-tab <tabfile> Specifies the location of a Synopsys VCS table file (.tab), which the simulator uses to automate the registration of PLI functions in the design. <tabfile> The location of a .tab file contains information about PLI functions. The tool expects the .tab file to be based on Synopsys VCS version 7.2 syntax. Because the format for this file is non-standard, changes to the format are outside of the control of Mentor Graphics. By specifying the location of a .tab file, you do not need to use the -no_autoacc switch, which prevents vopt from opening PLI modules for accessibility. If you are using the Two-step optimization flow, the tool passes this information automatically to vopt, which uses the file to improve accessibility rules. If you are using the Three-step optimization flow, you must specify this switch on both the vopt and vsim command lines. You can use this switch when you disable optimization with the -novopt switch.
-tag <string> Specifies a string tag to append to foreign trace filenames. Optional. Used with the -trace_foreign <int> option. Used when running multiple traces in the same directory. See the ModelSim FLI Reference for more information.
-title <title> Specifies the title to appear for the ModelSim Main window. Optional. If omitted the current ModelSim version is the window title. Useful when running multiple simultaneous simulations. Text strings with spaces must be in quotes (e.g., "my title").
-togglecountlimit Overrides the global toggle coverage count limit for toggle nodes in an entire simulation. Optional. After the limit is reached, further activity on the node will be ignored for toggle coverage. All possible transition edges must reach this count for the limit to take effect. For example, if you are collecting toggle data on 0->1 and 1->0 transitions, both transition counts must reach the limit. If you are collecting "full" data on 6 edge transitions, all 6 must
536
Commands vsim
reach the limit. Overrides the global value set by the ToggleCountLimit modelsim.ini variable. -togglewidthlimit Sets the maximum width of signals that are automatically added to toggle coverage with the -cover t argument for vcom or vlog. Optional. Can be set on design unit basis. Overrides the global value set by the ToggleWidthLimit modelsim.ini variable. -trace_foreign <int> Creates two kinds of foreign interface traces: a log of what functions were called, with the value of the arguments, and the results returned; and a set of C-language files to replay what the foreign interface side did. The purpose of the logfile is to aid the debugging of your FLI/PLI/VPI code. The primary purpose of the replay facility is to send the replay file to MTI support for debugging cosimulation problems, or debugging problems for which it is impractical to send the FLI/PLI/VPI code. See the ModelSim FLI Reference for more information. +transport_int_delays Selects transport mode with pulse control for single-source nets (one interconnect path). Optional. By default interconnect delays operate in inertial mode (pulses smaller than the delay are filtered). In transport mode, narrow pulses are propagated through interconnect delays. This option works for both Verilog and VITAL cells, though the destination of the interconnect must be a Verilog cell. The source may be VITAL or Verilog. This option works independently from +multisource_int_delays. -vcdstim [<instance>=]<filename> Specifies a VCD file from which to re-simulate the design. Optional. The VCD file must have been created in a previous ModelSim simulation using the vcd dumpports command. Refer to Using Extended VCD as Stimulus for more information. -version Returns the version of the simulator as used by the licensing tools. Optional. -view [<dataset_name>=]<WLF_filename> Specifies a wave log format (WLF) file for vsim to read. Allows you to use vsim to view the results from an earlier simulation. The Structure, Objects, Wave, and List windows can be opened to look at the results stored in the WLF file (other ModelSim windows will not show any information when you are viewing a dataset). See additional discussion in the Examples. -viewcov [<dataset_name>=]<UCDB_filename> Invokes vsim in the coverage view mode to display UCDB data.
537
Commands vsim
-visual <visual> Specifies the visual to use for the window. Optional. Does not apply to Windows platforms. Where <visual> may be: <class> <depth> One of the following: {directcolor | grayscale | greyscale | pseudocolor | staticcolor | staticgray | staticgrey | truecolor} followed by: <depth> Specifies how many bits per pixel are needed for the visual. default Instructs the tool to use the default visual for the screen <number> Specifies a visual X identifier. best <depth> Instructs the tool to choose the best possible visual for the specified <depth>, where: <depth> Specifies how many bits per pixel are needed for the visual.
+vlog_retain_on Instructs vsim to process RETAIN delays. Optional. -vopt Instructs vsim to run the vopt command automatically if vopt was not manually invoked. Not needed unless the VoptFlow variable has been set to 0 in the modelsim.ini. Optional. Refer to the chapter entitled Optimizing Designs with vopt for more information.
-voptargs="<args>" Specifies arguments that vsim should pass to vopt when running vopt automatically. The primary purpose of this argument is to pass +acc arguments. Optional.
-vopt_verbose Outputs vopt messages to the Transcript pane. Optional. By default these messages are not displayed or saved when vopt is run via vsim.
-warning <msg_number>[,<msg_number>,] Changes the severity level of the specified message(s) to "warning." Optional. Edit the warning variable in the modelsim.ini file to set a permanent default. Refer to Changing Message Severity Level for more information.
-wlf <filename> Specifies the name of the wave log format (WLF) file to create. The default is vsim.wlf. Optional. This option may also be specified with the WLFFilename variable in the modelsim.ini file.
-wlfcachesize <n> Specifies the size in megabytes of the WLF reader cache. Optional. By default the cache size is set to zero. WLF reader caching caches blocks of the WLF file to reduce redundant
538
Commands vsim
file I/O. This should have significant benefit in slow network environments. This option may also be specified with the WLFCacheSize variable in the modelsim.ini file. -wlfcollapsedelta Instructs ModelSim to record values in the WLF file only at the end of each simulator delta step. Any sub-delta values are ignored. May dramatically reduce WLF file size. This option may also be specified with the WLFCollapseMode variable in the modelsim.ini file. Default. -wlfcollapsetime Instructs ModelSim to record values in the WLF file only at the end of each simulator time step. Any delta or sub-delta values are ignored. May dramatically reduce WLF file size. This option may also be specified with the WLFCollapseMode variable in the modelsim.ini file. Optional. -wlfcompress Creates compressed WLF files. Default. Use -wlfnocompress to turn off compression. This option may also be specified with the WLFCompress variable in the modelsim.ini file. -wlfdeleteonquit Deletes the current simulation WLF file (vsim.wlf) automatically when the simulator exits. Optional. This option may also be specified with the WLFDeleteOnQuit variable in the modelsim.ini file. -wlflock Locks a WLF file. Optional. An invocation of ModelSim will not overwrite a WLF file that is being written by a different invocation. -wlfnocollapse Instructs ModelSim to preserve all events for each logged signal and their event order to the WLF file. May result in relatively larger WLF files. This option may also be specified with the WLFCollapseMode variable in the modelsim.ini file. Optional. -wlfnocompress Causes vsim to create uncompressed WLF files. Optional. WLF files are compressed by default in order to reduce file size. This may slow simulation speed by one to two percent. You may want to disable compression to speed up simulation or if you are experiencing problems with faulty data in the resulting WLF file. This option may also be specified with the WLFCompress variable in the modelsim.ini file. -wlfnodeleteonquit Preserves the current simulation WLF file (vsim.wlf) when the simulator exits. Default. This option may also be specified with the WLFDeleteOnQuit variable in the modelsim.ini file.
539
Commands vsim
-wlfnolock Disables WLF file locking. Optional. This will prevent vsim from checking whether a WLF file is locked prior to opening it as well as preventing vsim from attempting to lock a WLF once it has been opened.
-wlfnoopt Disables optimization of waveform display in the Wave window. Optional. This option may also be specified with the WLFOptimize variable in the modelsim.ini file.
-wlfopt Optimizes the display of waveforms in the Wave window. Default. Optional. This option may also be specified with the WLFOptimize variable in the modelsim.ini file.
-wlfsimcachesize <n> Specifies the size in megabytes of the WLF reader cache for the current simulation dataset only. Optional. By default the cache size is set to zero. This makes it easier to set different sizes for the WLF reader cache used during simulation and those used during postsimulation debug. WLF reader caching caches blocks of the WLF file to reduce redundant file I/O. If neither -wlfsimcachesize nor WLFSimCacheSize modelsim.ini variable are specified, the -wlfcachesize or WLFCacheSize settings will be used.
-wlfslim <size> Specifies a size restriction in megabytes for the event portion of the WLF file. Optional. The default is infinite size (0). The <size> must be an integer. Note that a WLF file contains event, header, and symbol portions. The size restriction is placed on the event portion only. When ModelSim exits, the entire header and symbol portion of the WLF file is written. Consequently, the resulting file will be larger than the size specified with -wlfslim. If used in conjunction with -wlftlim, the more restrictive of the limits takes precedence. This option may also be specified with the WLFSizeLimit variable in the modelsim.ini file. (See Limiting the WLF File Size.)
-wlfthreads | -wlfnothreads Specifies whether the logging of information to the WLF file is performed using multithreading. This behavior is on (-wlfthreads) by default on Solaris and Linux platforms where there are more than one processor on the system. If there is only one processor available, or you are running on a Windows system, this behavior is off by default (-wlfnothreads). When this behavior is enabled, the logging of information is performed on the secondary processor while the simulation and other tasks are performed on the primary processor. You can turn this option off with the -wlfnothreads option, which you may want to do if you are performing several simulations with logging at the same time.
540
Commands vsim
You can also control this behavior with the WLFUseThreads variable in the modelsim.ini file. -wlftlim <duration> Specifies the duration of simulation time for WLF file recording. Optional. The default is infinite time (0). The <duration> is an integer of simulation time at the current resolution; you can optionally specify the resolution if you place curly braces around the specification. For example,
{5000 ns}
sets the duration at 5000 nanoseconds regardless of the current simulator resolution. The time range begins at the current simulation time and moves back in simulation time for the specified duration. For example,
vsim -wlftlim 5000
writes at most the last 5000ns of the current simulation to the WLF file (the current simulation resolution in this case is ns). If used in conjunction with -wlfslim, the more restrictive of the limits will take effect. This option may also be specified with the WLFTimeLimit variable in the modelsim.ini file. The -wlfslim and -wlftlim switches were designed to help users limit WLF file sizes for long or heavily logged simulations. When small values are used for these switches, the values may be overridden by the internal granularity limits of the WLF file format. (See Limiting the WLF File Size.)
Arguments, VHDL
-absentisempty Causes VHDL files opened for read that target non-existent files to be treated as empty, rather than ModelSim issuing fatal error messages. Optional.
-foreign <attribute> Specifies the foreign module to load. Optional. <attribute> is a quoted string consisting of the name of a C function and a path to a shared library. For example,
vsim -foreign "c_init for.sl"
You can load up to ten foreign modules. Syntax for the attribute is further described in the Introduction chapter of the ModelSim FLI Reference. -nocollapse Disables the optimization of internal port map connections. Optional. -nofileshare Turns off file descriptor sharing. Optional. By default ModelSim shares a file descriptor for all VHDL files opened for write or append that have identical names.
541
Commands vsim
-noglitch Disables VITAL glitch generation. Optional. Refer to VHDL Simulation for additional discussion of VITAL.
+no_glitch_msg Disable VITAL glitch error messages. Optional. -std_input <filename> Specifies the file to use for the VHDL TextIO STD_INPUT file. Optional. -std_output <filename> Specifies the file to use for the VHDL TextIO STD_OUTPUT file. Optional. -strictvital Specifies to exactly match the VITAL package ordering for messages and delta cycles. Optional. Useful for eliminating delta cycle differences caused by optimizations not addressed in the VITAL LRM. Using this argument negatively impacts simulator performance.
-toggleMaxIntValues <int> Specifies the maximum number of VHDL integer values to record for toggle coverage. Optional. This limit variable may be changed on a per-signal basis. The default value of <int> is 100 values.
-toggleNoIntegers Turns off toggle coverage recording of VHDL integer values. Optional. -vcdread <filename> Simulates the VHDL top-level design from the specified VCD file. Optional. This argument is included for backwards compatibility. Consider using the -vcdstim argument instead. Refer to Simulating with Input Values from a VCD File for more details.
-vital2.2b Selects SDF mapping for VITAL 2.2b (default is VITAL 2000). Optional.
Arguments, Verilog
+alt_path_delays Configures path delays to operate in inertial mode by default. Optional. In inertial mode, a pending output transition is cancelled when a new output transition is scheduled. The result is that an output may have no more than one pending transition at a time, and that pulses narrower than the delay are filtered. The delay is selected based on the transition from the cancelled pending value of the net to the new pending value. The +alt_path_delays option modifies the inertial mode such that a delay is based on a transition from the current output value rather than the cancelled pending value of the net. This option has no effect in transport mode (see +pulse_e/<percent> and +pulse_r/<percent>).
542
Commands vsim
+delayed_timing_checks Causes timing checks to be performed on the delayed versions of input ports (used when there are negative timing check limits). Optional. ModelSim automatically detects and applies +delayed_timing_checks to optimized cells with negative timing checks. To turn off this feature, specify +no_autodtc with vsim.
-dpiexportobj <objfile> Generates the C export wrappers and associated compiled object code for your design. The C wrapper code is written to your <work>/_dpi/ directory, so it must have the proper permissions. The object file(s) are written to whatever location you specify with the <objfile> argument. For Windows platforms, this is a required switch when using DPI that generates a .obj file suitable for linking into a .dll. Refer to DPI Use Flow for additional information. For Linux and UNIX platforms, this switch generates both a .o and a so file. The .o file is suitable for linking into a larger .so file, which may contain import code. The .so file can be used directly, for example as an argument to the vsim -gblso switch or as a dependent library in the link command for an import shared object. Once you compile the export wrapper code into a shared object or .dll, you can manually load it into the simulation using -sv_lib, or perhaps -gblso. When you do manually load the export wrapper code, you should use the -nodpiexports switch so that the simulation does not automatically generate and load the <work>/_dpi/exportwrapper.so file, which would cause symbol collisions.
-hazards Enables event order hazard checking in Verilog modules. Optional. You must also specify this argument when you compile your design with vlog. Refer to Hazard Detection for more details. Note Enabling -hazards implicitly enables the -compat argument. As a result, using this argument may affect your simulation results.
+initmem+<seed> Specifies the seed value to be used by random initialization for Verilog designs. Random initialization (of only 0 or 1) occurs at runtime for memories compiled by vlog with the +initmem option without specifying a modifier (+{0 | 1 | X | Z}). If no +initmem is present on the vsim command line, a random seed of 0 is used during initialization. +<seed> any signed 32-bit integer (-2147483648 to +2147483647).
543
Commands vsim
+initreg+<seed> Specifies the seed value to be used by random initialization for Verilog designs. Random initialization (of only 0 or 1) occurs at runtime for registers compiled by vlog with the +initreg optionwithout specifying a modifier (+{0 | 1 | X | Z}). If no +initreg is present on the vsim command line, a random seed of 0 is used during initialization. +<seed> any signed 32-bit integer (-2147483648 to +2147483647).
+maxdelays Selects the maximum value in min:typ:max expressions. Optional. The default is the typical value. Has no effect if you specified the min:typ:max selection at compile time.
+mindelays Selects the minimum value in min:typ:max expressions. Optional. The default is the typical value. Has no effect if you specified the min:typ:max selection at compile time.
+no_autdtc Turns off auto-detection of optimized cells with negative timing checks and autoapplication of +delayed_timing_checks to those cells. Optional.
+no_cancelled_e_msg Disables negative pulse warning messages. Optional. By default vsim issues a warning and then filters negative pulses on specify path delays. You can drive an X for a negative pulse using +show_cancelled_e.
+no_neg_tchk Disables negative timing check limits by setting them to zero. Optional. By default negative timing check limits are enabled. This is just the opposite of Verilog-XL, where negative timing check limits are disabled by default, and they are enabled with the +neg_tchk option.
+no_notifier Disables the toggling of the notifier register argument of all timing check system tasks. Optional. By default, the notifier is toggled when there is a timing check violation, and the notifier usually causes a UDP to propagate an X. This argument suppresses X propagation on timing violations for the entire design. You can suppress X propagation on individual instances using the tcheck_set command.
+no_path_edge Causes ModelSim to ignore the input edge specified in a path delay. Optional. The result of this argument is that all edges on the input are considered when selecting the output delay. Verilog-XL always ignores the input edges on path delays.
+no_pulse_msg Disables the warning message for specify path pulse errors. Optional. A path pulse error occurs when a pulse propagated through a path delay falls between the pulse rejection limit and pulse error limit set with the +pulse_r and +pulse_e options. A path pulse error results
544
Commands vsim
in a warning message, and the pulse is propagated as an X. The +no_pulse_msg option disables the warning message, but the X is still propagated. -no_risefall_delaynets Disables the rise/fall delay net delay negative timing check algorithm. Optional. This argument is provided to return ModelSim to its pre-6.0 behavior where violation regions must overlap in order to find a delay net solution. In 6.0 versions and later, ModelSim uses separate rise/fall delays, so violation regions need not overlap for a delay solution to be found. +no_show_cancelled_e Filters negative pulses on specify path delays so they dont show on the output. Default. Use +show_cancelled_e to drive a pulse error state. +no_tchk_msg Disables error messages issued by timing check system tasks when timing check violations occur. Optional. Notifier registers are still toggled and may result in the propagation of Xs for timing check violations. You can disable individual messages using the tcheck_set command. -nodpiexports Instructs the command to not generate C wrapper code for DPI export task and function routines found at elaboration time. More specifically, the command does not generate the exportwrapper.so shared object file in <work>/_dpi/. For a description on when you should use this switch, refer to the section Integrating Export Wrappers into an Import Shared Object in the Users Manual. -noexcludehiz Instructs ModelSim to include truth table rows that contain Hi-Z states in the coverage count. Without this argument, these rows are automatically excluded. Optional. +nosdferror Errors issued by the SDF annotator while loading the design prevent the simulation from continuing, whereas warnings do not. Changes SDF errors to warnings so that the simulation can continue. Optional. +nosdfwarn Disables warnings from the SDF annotator. Optional. +nospecify Disables specify path delays and timing checks. Optional. +nowarn<CODE> Disables warning messages in the category specified by <CODE>. Optional. Warnings that can be disabled include the <CODE> name in square brackets in the warning message. For example:
545
Commands vsim ** Warning: (vsim-3017) test.v(2): [TFMPC] - Too few port connections. Expected <m>, found <n>.
This warning message can be disabled with +nowarnTFMPC. +ntc_warn Enables warning messages from the negative timing constraint algorithm. Optional. By default, these warnings are disabled. This algorithm attempts to find a set of delays for the timing check delayed net arguments such that all negative limits can be converted to non-negative limits with respect to the delayed nets. If there is no solution for this set of limits, then the algorithm sets one of the negative limits to zero and recalculates the delays. This process is repeated until a solution is found. A warning message is issued for each negative limit set to zero. -onfinish ask | stop | exit Customizes the simulator shutdown behavior when it encounters $finish or sc_stop() in the design: ask
o o
In batch mode, the simulation exits. In GUI mode, a dialog box pops up and asks for user confirmation on whether to quit the simulation.
stop stops simulation and leave the simulation kernal running exit exits out of the simulation without a prompt
By default, the simulator exits in batch mode; prompts you in GUI mode. Edit the OnFinish variable in the modelsim.ini file to set the default operation of $finish. -pli "<object list>" Loads a space-separated list of PLI shared objects. Optional. The list must be quoted if it contains more than one object. This is an alternative to specifying PLI objects in the Veriuser entry in the modelsim.ini file, refer to Simulator Control Variables. You can use environment variables as part of the path. +<plusarg> Arguments preceded with "+" are accessible by the Verilog PLI routine mc_scan_plusargs(). Optional. +pulse_e/<percent> Controls how pulses are propagated through specify path delays, where <percent> is a number between 0 and 100 that specifies the error limit as a percentage of the path delay. Optional. A pulse greater than or equal to the error limit propagates to the output in transport mode (transport mode allows multiple pending transitions on an output). A pulse less than the error limit and greater than or equal to the rejection limit (see +pulse_r/<percent>)
546
Commands vsim
propagates to the output as an X. If the rejection limit is not specified, then it defaults to the error limit. For example, consider a path delay of 10 along with a +pulse_e/80 option. The error limit is 80% of 10 and the rejection limit defaults to 80% of 10. This results in the propagation of pulses greater than or equal to 8, while all other pulses are filtered. Note that you can force specify path delays to operate in transport mode by using the +pulse_e/0 option. +pulse_e_style_ondetect Selects the "on detect" style of propagating pulse errors (see +pulse_e). Optional. A pulse error propagates to the output as an X, and the "on detect" style is to schedule the X immediately, as soon as it has been detected that a pulse error has occurred. "on event" style is the default for propagating pulse errors (see +pulse_e_style_onevent). +pulse_e_style_onevent Selects the "on event" style of propagating pulse errors (see +pulse_e). Default. A pulse error propagates to the output as an X, and the "on event" style is to schedule the X to occur at the same time and for the same duration that the pulse would have occurred if it had propagated through normally. +pulse_r/<percent> Controls how pulses are propagated through specify path delays, where <percent> is a number between 0 and 100 that specifies the rejection limit as a percentage of the path delay. Optional. A pulse less than the rejection limit is suppressed from propagating to the output. If the error limit is not specified by +pulse_e then it defaults to the rejection limit. +sdf_nocheck_celltype Disables the error check a for mismatch between the CELLTYPE name in the SDF file and the module or primitive name for the CELL instance. It is an error if the names do not match. Optional. +show_cancelled_e Drives a pulse error state (X) for the duration of a negative pulse on a specify path delay. Optional. By default ModelSim filters negative pulses. -sv_lib <shared_obj> Specifies the name of the DPI shared object with no extension. Required for use with DPI import libraries. Refer to DPI Use Flow for additional information. -sv_liblist <filename> Specifies the name of a bootstrap file containing names of DPI shared objects to load. Optional. -sv_root <dirname> Specifies the directory name to be used as the prefix for DPI shared object lookups. Optional.
547
Commands vsim
-togglenosubs Disables toggle coverage for objects declared within functions and tasks. Optional. -togglenovlogints Disables toggle coverage of Verilog integer types (except SystemVerilog enumeration types). Optional. Not needed unless the ToggleVlogIntegers modelsim.ini variable is set to 1 (on).
-togglevlogints Enables toggle coverage of Verilog integer types. Optional. Disables the ToggleVlogIntegers modelsim.ini variables default setting of off(0).
+transport_path_delays Selects transport mode for path delays. Optional. By default, path delays operate in inertial mode (pulses smaller than the delay are filtered). In transport mode, narrow pulses are propagated through path delays. Note that this option affects path delays only, and not primitives. Primitives always operate in inertial delay mode.
+typdelays Selects the typical value in min:typ:max expressions. Default. Has no effect if you specified the min:typ:max selection at compile time.
-v2k_int_delays Causes interconnect delays to be visible at the load module port per the IEEE 1364-2001 spec. Optional. By default ModelSim annotates INTERCONNECT delays in a manner compatible with Verilog-XL. If you have $sdf_annotate() calls in your design that are not getting executed, add the Verilog task $sdf_done() after your last $sdf_annotate() to remove any zero-delay MIPDs that may have been created. May be used in tandem with the +multisource_int_delays argument (see above). Refer to sdfcom for SDF compilation information.
Arguments, SystemC
-scdpidebug Enables DPI debug single-stepping across SystemC-SystemVerilog call boundaries for SystemVerilog breakpoints place inside an export function call that was initiated form an SC_METHOD. Refer to the sections "Setting Breakpoints" and "Stepping in C Debug" for more information.
-sclib <library> Specifies the design library where the SystemC shared library is created. By default, the SystemC shared library is created in the logical work library. This option is only necessary when the shared library is compiled in a design library other than the logical work directory (via sccom -link -work <lib>). For more information on the sccom -link and -work arguments, see sccom.
548
Commands vsim
-sc_arg <string> ... Specifies a string representing a startup argument which is subsequently accessible from within SystemC via the sc_argc() and sc_argv() functions (refer to Accessing CommandLine Arguments. If multiple SystemC startup arguments are specified, each must have a separate -sc_arg argument. SystemC startup arguments returned via sc_argv() are in the order in which they appear on the command line. White space within the <string> will not be treated specially, and the string, white space and all, will be accessible as a single string among the strings returned by sc_argv().
Arguments, object
The object arguments may be a [<library_name>].<design_unit>, a .mpf file, a .wlf file, or a text file. Multiple design units may be specified for Verilog modules and mixed VHDL/Verilog configurations. <library_name>.<design_unit> Specifies a library and associated design unit; multiple library/design unit specifications can be made. Optional. If no library is specified, the work library is used. You cannot use the wildcard * for this argument. Environment variables can be used. <design_unit> may be one of the following: <configuration> <module> <entity> [(<architecture>)] Specifies the VHDL configuration to simulate. Specifies the name of one or more top-level Verilog modules to be simulated. Optional. Specifies the name of the top-level VHDL entity to be simulated. Optional. The entity may have an architecture optionally specified; if omitted the last architecture compiled for the specified entity is simulated. An entity is not valid if a configuration is specified.1 Specifies the name of an optimized design. See the vopt command. Optional.
<optimized_design_name>
1. Most UNIX shells require arguments containing () to be single-quoted to prevent special parsing by the shell. See the examples below.
<MPF_file_name> Opens the specified project. Optional. <WLF_file_name> Opens the specified dataset. Optional. <text_file_name> Opens the specified text file in a Source window. Optional.
549
Commands vsim
Examples Invoke vsim on the entity cpu and assigns values to the generic parameters edge and VCC.
vsim -gedge="low high" -gVCC=4.75 cpu
vsim {-gedge="low high"} -gVCC=4.75 cpu
Instruct ModelSim to view the results of a previous simulation run stored in the WLF file sim2.wlf. The simulation is displayed as a dataset named test. Use the -wlf option to specify the name of the WLF file to create if you plan to create many files for later viewing.
vsim -view test=sim2.wlf
For example:
vsim -wlf my_design.i01 my_asic structure vsim -wlf my_design.i02 my_asic structure
Annotate instance /top/u1 using the minimum timing from the SDF file myasic.sdf.
vsim -sdfmin /top/u1=myasic.sdf
Use multiple switches to annotate multiple instances:

vsim -sdfmin /top/u1=sdf1 -sdfmin /top/u2=sdf2 top
This example searches the libraries mylib for top(only) and gatelib for cache_set. If the design units are not found, the search continues to the work library. Specification of the architecture (only) is optional.
vsim mylib.top(only) gatelib.cache_set
Invoke vsim on test_counter and run the simulation until a break event, then quit when it encounters a $finish task.
vsim -do "set PrefMain(forceQuit) 1; run -all" work.test_counter
550
Commands vsim<info>
vsim<info>
The vsim<info> commands return information about the current vsim executable. vsimAuth Returns the authorization level (PE/SE, VHDL/Verilog/PLUS). vsimDate Returns the date the executable was built, such as "Apr 10 2000". vsimId Returns the identifying string, such as "ModelSim 6.1". vsimVersion Returns the version as used by the licensing tools, such as "1999.04". vsimVersionString Returns the full vsim version string. This same information can be obtained using the -version argument of the vsim command.
551
Commands vsim_break
vsim_break
Stop (interrupt) the current simulation before it runs to completion. To stop a simulation and then resume it, use this command in conjunction with run -continue. Syntax vsim_break Arguments None. Example Interrupt a simulation, then restart it from the point of interruption.
vsim_break run -continue
552
Commands vsource
vsource
The vsource command specifies an alternative file to use for the current source file. This command is used when the current source file has been moved. The alternative source mapping exists for the current simulation only. Syntax vsource [<filename>] Arguments <filename> Specifies a relative or full pathname. Optional. If filename is omitted, the source file for the current design context is displayed. Examples
vsource design.vhd vsource /old/design.vhd
553
Commands wave
wave
A number of wave commands are available to manipulate the Wave window. The following tables summarize the available options for manipulating cursors, for zooming, and for adjusting the wave display view in the Wave window: Table 2-12. Wave Window Commands for Cursor Cursor Commands wave activecursor wave addcursor wave cursortime wave deletecursor wave seecursor Description Sets the active cursor to the specified cursor or, if no cursor is specified, reports the active cursor Adds a new cursor at specified time and returns the number of the newly added cursor Moves or reports the time of the specified cursor or, if no cursor is specified, the time of the active cursor Deletes the specified cursor or, if no cursor is specified, the active cursor Positions the wave display such that the specified or active cursor appears at the specified percent from the left edge of the display 0% is the left edge, 100% is the right edge.
Table 2-13. Wave Window Commands for Zooming Zooming Commands wave zoomin wave zoomout wave zoomfull wave zoomlast wave zoomrange Description Zoom in the wave display by the specified factor. The default factor is 2.0. Zoom out the wave display by the specified factor. The default factor is 2.0. Zoom the wave display to show the full simulation time. Return to last zoom range. Sets left and right edge of wave display to the specified start time and end time. If times are not specified, reports left and right edge times.
Table 2-14. Wave Window Commands for Controlling Display Display view Commands wave interrupt wave refresh Description Immediately stops wave window drawing Cleans wave display and redraws waves
554
Commands wave
Table 2-14. Wave Window Commands for Controlling Display (cont.) Display view Commands wave seecursor Description Positions the wave display such that the specified or active cursor appears at the specified percent from the left edge of the display 0% is the left edge, 100% is the right edge. Positions the wave display such that the specified time appears at the specified percent from the left edge of the display 0% is the left edge, 100% is the right edge.
wave seetime
Table 2-15. Wave Window Commands for Expanded Time Display Display view Commands wave expand mode wave expand all Description Selects the expanded time display mode: Delta Time, Event Time, or off. Expands simulation time into delta time steps if Delta Time mode is currently selected (WLFCollapseMode = 1) or into event time steps if Event Time mode is currently selected (WLFCollapseMode = 0) over the full range of the simulation from time 0 to the current time. Expands simulation time into delta time steps if Delta Time mode is currently selected (WLFCollapseMode = 1) or into event time steps if Event Time mode is currently selected (WLFCollapseMode = 0) at the simulation time of the active cursor. Expands simulation time into delta time steps if Delta Time mode is currently selected (WLFCollapseMode = 1) or into event time steps if Event Time mode is currently selected (WLFCollapseMode = 0) over a time range specified by a start time and an end time. Collapses simulation time over the full range of the simulation from time 0 to the current time. Collapses simulation time at the time of the active cursor. Collapses simulation time over a specific simulation time range.
wave expand cursor
wave expand range
wave collapse all wave collapse cursor wave collapse range
Syntax wave activecursor [-window <win>] [<cursor-num>] wave addcursor [-window <win>] [-time <time>] [-name <name>] [-lock <0|1>] wave collapse all [-window <win>] wave collapse cursor [-window <win>] [<cursor-num>]
555
Commands wave
wave collapse range [-window <win>] <start-time> <end time> wave configcursor [<cursor-num>] [-window <win>] [<option> [<value>]] wave cursortime [-window <win>] [-time <time>] [<cursor-num>] wave deletecursor [-window <win>] [<cursor-num>] wave expand all [-window <win>] wave expand cursor [-window <win>] [<cursor-num>] wave expand mode [-window <win>] [off | deltas | events] wave expand range [-window <win>] <start-time> <end-time> wave interrupt [-window <win>] wave refresh [-window <win>] wave seecursor [-window <win>] [-at <percent>] [<cursor-num>] wave seetime [-window <win>] [-at <percent>] <time> wave zoomin [-window <win>] [<factor>] wave zoomout [-window <win>] [<factor>] wave zoomfull [-window <win>] wave zoomlast [-window <win>] wave zoomrange [-window <win>] [<start-time>] [<end-time>] Arguments [-at <percent>] Positions the display such that the time or cursor is the specified <percent> from the left edge of the wave display. 0% is the left edge; 100% is the right edge. Optional. Default is 50%. [<cursor-num>] Specifies a cursor number. Optional. If not specified, the active cursor is used. [<factor>] A number that specifies how much you want to zoom into or out of the wave display. Optional. Default value is 2.0. [-lock <0|1>] Specify the lock state of the cursor. Optional. Default is 0, unlocked. [-name <name>] Specify the name of the cursor. Optional. Default is "Cursor <n>" where <n> is the cursor number.
556
Commands wave
off | deltas | events Specifies the expanded time display mode for the Wave window. Optional. Default is off. <option> [<value>] Specify a value for the designated option. Currently supported options are -name, -time, and -lock. Optional. If no option is specified, current value of all options are reported.
[<start-time>] [<end-time>] start-time and end-time are times that specify a expand, collapse, or zoom range. If neither number is specified, the command returns the current range. If only one time is specified, then the range is set to start at 0 and end at specified time.
[-time <time>] Specifies a cursor time. Optional. [-window <win>] All commands default to the active Wave window unless this argument is used to specify a different Wave window. Optional.
Examples Either of these commands creates a zoom range with a start time of 20 ns and an end time of 100 ns.
wave zoomrange 20ns 100ns wave zoomrange 20 100
Return the name of cursor 2:

wave configcursor 2 -name
Name cursor 2, "reference cursor" and return that name with:

wave configcursor 2 -name {reference cursor}
Return the values of all wave configcursor options for cursor 2:

wave configcursor 2
557
Commands wave create
wave create
The wave create command generates a waveform known only to the GUI. You can then modify the waveform interactively and use the results to drive simulation. Refer to Generating Stimulus with Waveform Editor for more information. Syntax wave create [-driver freeze | deposit | driver | expectedoutput] [-endtime <time>] [-initialvalue <value>] [-language VHDL | Verilog] -pattern clock | constant | random | repeater | counter | none [-portmode in | out | inout | input | output | internal] [-range <MSB LSB>] [-starttime <time>] <object_name> wave create -period <value> -dutycycle <value> wave create -value <value> wave create -period <value> -random_type <value> [-seed <value>] wave create -sequence val1 val2 val3 } -period <value> -repeat forever | never | <#_of_times> wave create -direction <value> -type Binary | Range | Johnson | OneHot | ZeroHot | Gray -endvalue <value> -period <value> -repeat forever | never | <#_of_times> -startvalue <value> -step <value> The arguments below are grouped according to waveform pattern. The first set applies to all waveforms regardless of pattern. Arguments for all waveforms -driver freeze | deposit | driver | expectedoutput Specifies that the signal is a driver of the specified type. Applies to signals of type inout or internal. Optional. -endtime <time> The simulation time that the waveform should stop. If omitted, the waveform stops at 1000 simulation time units. Optional. -initialvalue <value> The initial value for the waveform. Value must be appropriate for the type of waveform you are creating. Not applicable to counter patterns. Optional. -language VHDL | Verilog The language for the created wave. By default ModelSim uses VHDL to create the waveform. Optional. -pattern clock | constant | random | repeater | counter | none The pattern for the created waveform. Refer to Creating Waveforms from Patterns for a description of the pattern types. Required.
558
-portmode in | out | inout | input | output | internal The port type for the created waveform. ModelSim uses internal by default. Useful for creating signals prior to loading a design. Optional.
-range <MSB LSB> Specifies a vector of the designated bit width. Optional. -starttime <time> The simulation time at which the waveform should start. If omitted, the waveform starts at 0 simulation time units. Optional.
<object_name> The name of the created waveform. Required.
Arguments, clock patterns only -dutycycle <value> The duty cycle of the clock, which is the percentage of the period that the clock is high or low. Acceptable values range from 0 to 100. Required. -period <value> The period of the signal. Required. Arguments, constant patterns only -value <value> The value for the constant. Required. Arguments, random patterns only -period <value> The period after which the value should change. Required. -random_type <value> The type of random pattern to generate. Required. Choices for <value> include Normal, Uniform, Poisson, or Exponential. Default is Uniform. -seed <value> A seed value for the random generator. If omitted, ModelSim uses the value 5. Optional. Arguments, repeater patterns only -period <value> The period after which the value should change. Required. -repeat forever | never | <#_of_times> The number of times to repeat. Required.
559
-sequence val1 val2 val3 } The set of values that you want repeated. Required.
Arguments, counter patterns only -direction <value> The direction which the counter should increment or decrement. Optional. The default is Up. Choices for <value> include Up, Down, UpThenDown, and DownThenUp. -type Binary | Range | Johnson | OneHot | ZeroHot | Gray The type of counter to create. Default is Range. Optional. -endvalue <value> The ending value of the counter. This option applies to Range counter patterns only. All other counter patterns start from 0 and go to the max value for that particular signal (e.g., for a 3-bit signal, the start value will be 000 and end value will be 111). -period <value> The period after which the value should change. Required. -repeat forever | never | <#_of_times> The number of times to repeat. Required. -startvalue <value> The starting value of the counter. This option applies to Range counter patterns only. All other counter patterns start from 0 and go to the max value for that particular signal (e.g., for a 3-bit signal, the start value will be 000 and end value will be 111). -step <value> The step by which the counter is incremented/decremented. Required. Examples Create a clock signal with the following default values:
wave create -pattern /counter/clk -period 100 -dutycycle 50 -starttime 0 -endtime 1000 -initialvalue 0
Create a constant 8-bit signal vector from 0 to 1000 ns with a value of 1111 and a drive type of freeze.
wave create -driver freeze -pattern constant -value 1111 -range 7 0 -starttime 0ns -endtime 1000ns sim:/andm/v_cont2
See also wave edit, wave modify, Generating Stimulus with Waveform Editor
560
Commands wave edit
wave edit
The wave edit command modifies waveforms created with the wave create command. The following table summarizes the available editing options: Command wave edit cut wave edit copy wave edit paste wave edit invert wave edit mirror wave edit insert_pulse wave edit delete wave edit stretch wave edit move wave edit change_value wave edit extend wave edit driveType wave edit undo wave edit redo Syntax wave edit {cut | copy | paste | invert | mirror} [-end <time>] -start <time> <object_name> wave edit insert_pulse [-duration <time>] -start <time> <object_name> wave edit delete -time <time> <object_name> wave edit stretch | move -backward <time> | -forward <time> -time <time> <object_name> wave edit change_value -end <time> -start <time> <value> <object_name> wave edit extend -extend to | by -time <time> wave edit driveType -driver freeze | deposit | driver | expectedoutput -end <time> -start <time> The arguments below are grouped by editing operation. Many operations share similar arguments.
Arguments for cut, copy, paste, invert, and mirror
Description Cut part of a waveform to the clipboard Copy part of a waveform to the clipboard Paste the waveform from the clipboard Vertically flip part of a waveform Mirror part of a waveform Insert a new edge on a waveform; doesnt affect waveform duration Delete an edge from a waveform; doesnt affect waveform duration Move an edge by stretching the waveform Move an edge without moving other edges Change the value of part of a waveform Extend all waves Change the driver type Undo an edit Redo a previously undone edit
-end <time> The end of the section of waveform to perform the editing operation upon, denoted by a simulation time. Optional for paste.
561
Commands wave edit
-start <time> The beginning of the section of waveform to perform the editing operation upon, denoted by a simulation time. Required.
<object_name> The pathname of the waveform to edit. Required.
Arguments for insert_pulse
-duration <time> The length of the pulse. Default is 10 time units. Optional. -start <time> The time at which the new pulse should be inserted. Required. <object_name> The pathname of the waveform on which you are inserting a pulse. Required.
Arguments for delete
-time <time> The time at which the edge to delete occurs. Required. <object_name> The pathname of the waveform for which you are deleting an edge. Required.
Arguments for stretch and move
-backward <time> The amount to stretch or move the edge backwards in simulation time. Required if -forward <time> isnt specified.
-forward <time> The amount to stretch or move the edge forwards in simulation time. Required if -backward <time> isnt specified.
-time <time> The time at which the edge to stretch or move occurs. Required. <object_name> The pathname of the waveform on which you are stretching or moving an edge. Required.
Arguments for change_value
-end <time> The end of the section of waveform of which you are changing the value. Required. -start <time> The beginning of the section of waveform of which you are changing the value. Required.
562
Commands wave edit
<value> The new value. Must match the type of the <object_name>. Required. <object_name> The pathname of the waveform on which you are changing a value. Required.
Arguments for extend
-extend to | by Specify whether you are extending waves to a specific time or by a certain amount of time. Required.
-time <time> The time to extend waves to or the amount by which to extend the waves. Required.
Arguments for driveType
-driver freeze | deposit | driver | expectedoutput The type of driver to which you want the specified section of the waveform changed. Required.
-end <time> The end of the section of waveform of which you are changing the drive type. Required. -start <time> The beginning of the section of waveform of which you are changing the drive type. Required.
Arguments for undo and redo
<number> The number of editing operations to undo or redo. If omitted, only one editing operation is undone or redone. Optional.
See also wave create, Generating Stimulus with Waveform Editor
563
Commands wave export
wave export
The wave export command creates a stimulus file from waveforms created with the wave create command. Syntax wave export [-designunit <name>] [-endtime <time>] -file <name> -format force | vcd | vhdl | verilog [-starttime <time>] Arguments -designunit <name> The name of the design unit for which you want to export created waves. If omitted, the command exports waves from the active design unit. Optional. -endtime <time> The simulation time at which you want to stop exporting. Required. -file <name> The filename for the saved stimulus file. Required. -format force | vcd | vhdl | verilog The format of the saved stimulus file. Required. The format options include: force A Tcl script that recreates the waveforms. The file should be sourced when reloading the simulation. vcd An extended VCD file. Load using the -vcdstim argument to vsim. vhdl A VHDL testbench. Compile and load the file as your top-level design unit. verilog A Verilog testbench. Compile and load the file as your top-level design unit. -starttime <time> The simulation time at which you want to start exporting. Required. See also wave create, wave import, Generating Stimulus with Waveform Editor
564
Commands wave import
wave import
The wave import command imports an extended VCD file that was created with the wave export command. It cannot read extended VCD file created by software other than ModelSim. Use this command to apply a VCD file as stimulus to the current simulation. Syntax wave import <VCD_file> Arguments <VCD_file> The name of the extended VCD file to import. Required. See also wave create, wave export, Generating Stimulus with Waveform Editor
565
Commands wave modify
wave modify
The wave modify command modifies waveform parameters set by a previous wave create command. See the ModelSim Command Reference for syntax. Syntax wave modify <wave_name> [-driver freeze | deposit | driver | expectedoutput] [-endtime <time>] [-initialvalue <value>] -pattern clock | random | repeater | counter | none [-range <MSB LSB>] [-starttime <time>] wave modify -period <value> -dutycycle <value> wave modify -period <value> -random_type Normal|Uniform [-seed <value>] wave modify -period <value> -repeat forever | never | <#_of_times> -sequence {val1 val2 val3 } wave modify -direction down | up -type Binary | Range | Johnson | OneHot | ZeroHot | Gray -endvalue <value> -period <value> -repeat forever | never | <#_of_times> -startvalue <value> -step <value>
Arguments for all waveforms
<wave_name> The name of an existing waveform created with the wave create command. Required. -driver freeze | deposit | driver | expectedoutput Specifies that the signal is a driver of the specified type. Applies to signals of type inout or internal. Optional.
-endtime <time> The simulation time that the waveform should stop. If omitted, the waveform stops at 1000 simulation time units. Optional.
-initialvalue <value> The initial value for the waveform. Value must be appropriate for the type of waveform you are creating. Not applicable to counter patterns. Optional.
-pattern clock | random | repeater | counter | none The pattern for the created waveform. Refer to Creating Waveforms from Patterns for a description of the pattern types. Required.
-range <MSB LSB> Specifies a vector of the designated bit width. Optional. -starttime <time> The simulation time that the waveform should start. If omitted, the waveform starts at 0 simulation time units. Optional.
566
Commands wave modify Arguments, clock patterns only
-period <value> The period of the signal. Required. -dutycycle <value> The duty cycle of the clock, which is the percentage of the period that the clock is high or low. Acceptable values range from 0 to 100. Required.
Arguments, random patterns only
-period <value> The period after which the value should change. Required. -random_type Normal|Uniform The type of random pattern to generate. Required. Default is uniform. -seed <value> A seed value for the random generator. If omitted, ModelSim uses the value 5. Optional.
Arguments, repeater patterns only
-period <value> The period after which the value should change. Required. -repeat forever | never | <#_of_times> The number of times to repeat. Required. -sequence {val1 val2 val3 } The set of values that you want repeated. Required.
Arguments, counter patterns only
-direction down | up The direction which the counter should increment or decrement. Optional. The default is up. -type Binary | Range | Johnson | OneHot | ZeroHot | Gray The type of counter to create. Default is Range. Optional. -endvalue <value> The ending value of the counter. This option applies to Range counter patterns only. All other counter patterns start from 0 and go to the max value for that particular signal (e.g., for a 3-bit signal, the start value will be 000 and end value will be 111).
-period <value> The period after which the value should change. Required. -repeat forever | never | <#_of_times> The number of times to repeat. Required.
567
Commands wave modify
-startvalue <value> The starting value of the counter. This option applies to Range counter patterns only. All other counter patterns start from 0 and go to the max value for that particular signal (e.g., for a 3-bit signal, the start value will be 000 and end value will be 111).
-step <value> The step by which the counter is incremented/decremented. Required.
See also wave create, Generating Stimulus with Waveform Editor
568
Commands when
when
The when command instructs ModelSim to perform actions when the specified conditions are met. For example, you can use the when command to break on a signal value or at a specific simulator time. Use the nowhen command to deactivate when commands. Note When running in full optimization mode, breakpoints can not be set. Run the design in non-optimized mode (or set +acc arguments) to enable you to set breakpoints in the design. See Preserving Object Visibility for Debugging Purposes. Syntax when [[-fast] [-id <id#>] [-label <label>] {<when_condition_expression>} {<command>}] Description The when command uses a when_condition_expression to determine whether or not to perform the action. Conditions can include VHDL signals and Verilog nets and registers. The when_condition_expression uses a simple restricted language (that is not related to Tcl), which permits only four operators and operands that may be either HDL object names, signameevent, or constants. ModelSim evaluates the condition every time any object in the condition changes, hence the restrictions. Here are some additional points to keep in mind about the when command: The when command creates the equivalent of a VHDL process or a Verilog always block. It does not work like a looping construct you might find in other languages such as C. Virtual signals, functions, regions, types, etc. cannot be used in the when command. Neither can simulator state variables other than $now. With no arguments, when will list the currently active when statements and their labels (explicit or implicit).
Syntax
when [[-fast] [-id <id#>] [-label <label>] {<when_condition_expression>} {<command>}]

Embedded Commands Allowed with the -fast Argument
You can use any Tcl command as a <command>, along with any of the following vsim commands: bp, bd change disablebp, enablebp
569
Commands when
echo examine force, noforce log, nolog stop when, nowhen Any do commands Any Tk commands or widgets References to U/I state variables or tcl variables Virtual signals, functions, or types
Embedded Commands Not Allowed with the -fast Argument
Using Global Tcl Variables with the -fast Argument
Embedded commands that use global Tcl variables for passing a state between the when command and the user interface need to declare the state using the Tcl uivar command. For example, the variable i below is visible in the GUI. From the command prompt, you can display it (by entering echo $i) or modify it (for example, by entering set i 25).
set i 10 when -fast {clk == '0'} { uivar i set i [expr {$i - 1}] if {$i <= 0} { force reset 1 0, 0 250 } } when -fast {reset == '0'} { uivar i set i 10 } Additional Restrictions on the -fast Argument
Accessing channels (such as files, pipes, sockets) that were opened outside of the embedded command will not work. For example:
set fp [open mylog.txt w] when -fast {bus} { puts $fp "bus change: [examine bus]" }
The channel that $fp refers to is not available in the simulator, only in the user interface. Even using the uivar command does not work here because the value of $fp has no meaning in the context of the -fast argument. The following method of rewriting this example opens the channel, writes to it, then closes it within the when command:
570
Commands when
when -fast {bus} { set fp [open mylog.txt a] puts $fp "bus change: [examine bus]" close $fp }
The following example is a little more sophisticated method of doing the same thing:
when -fast {$now == 0ns} { set fp [open mylog.txt w] } when -fast {bus} { puts $fp "bus change: [examine bus]" } when -fast {$now == 1000ns} { close $fp }
The general principle is that any embedded command done using the -fast argument is global to all other commands used with the -fast argument. Here, {$now == 0ns} is a way to define Tcl processes that the -fast commands can use. These processes have the same restrictions that when bodies have, but the advantage is again speed as a proc will tend to execute faster than code in the when body itself. It is recommended not to use virtual signals and expressions. Arguments -fast Causes the embedded <command> to execute within the simulation kernel, which provides faster execution and reduces impact on simulation runtime performance. Optional. Limitations on using the -fast argument are described above (in Embedded Commands Not Allowed with the -fast Argument). Disallowed commands still work, but they slow down the simulation. -label <label> Used to identify individual when commands. Optional. -id <id#> Attempts to assign this id number to the when command. Optional. If the id number you specify is already used, ModelSim will return an error. Note Ids for when commands are assigned from the same pool as those used for the bp command. So, even if you havent used an id number for a when command, its possible it is used for a breakpoint. {<when_condition_expression>} Specifies the conditions to be met for the specified <command> to be executed. Required if a command is specified. The condition is evaluated in the simulator kernel and can be an
571
Commands when
object name, in which case the curly braces can be omitted. The command will be executed when the object changes value. The condition can be an expression with these operators: Name equals not equal greater than less than greater than or equal less than or equal AND OR Operator ==, = !=, /= > < >= <= &&, AND ||, OR
The operands may be object names, signameevent, or constants. Subexpressions in parentheses are permitted. The command will be executed when the expression is evaluated as TRUE or 1. The formal BNF syntax is:
condition ::= Name | { expression } expression ::= expression AND relation | expression OR relation | relation relation ::= Name = Literal | Name /= Literal | Name ' EVENT | ( expression ) Literal ::= '<char>' | "<bitstring>" | <bitstring>
The "=" operator can occur only between a Name and a Literal. This means that you cannot compare the value of two signals, i.e., Name = Name is not possible. Tcl variables can be used in the condition expression but you must replace the curly braces ({}) with double quotes (""). This works like a macro substitution where the Tcl variables are evaluated once and the result is then evaluated as the when condition. Condition expressions are evaluated in the vsim kernel, which knows nothing about Tcl variables. That's why the condition expression must be evaluated in the GUI before it is sent to the vsim kernel. See below for an example of using a Tcl variable. The ">", "<", ">=", and "<=" operators are the standard ones for vector types, not the overloaded operators in the std_logic_1164 package. This may cause unexpected results when comparing objects that contain values other than 1 and 0. ModelSim does a lexical comparison (position number) for values other than 1 and 0. For example:
572
Commands when 0000 < 1111 ## This evaluates to true H000 < 1111 ## This evaluates to false 001X >= 0010 ## This also evaluates to false
{<command>} The command(s) for this argument are evaluated by the Tcl interpreter within the ModelSim GUI. Any ModelSim or Tcl command or series of commands are valid with one exceptionthe run command cannot be used with the when command. Required if a when expression is specified. The command sequence usually contains a stop command that sets a flag to break the simulation run after the command sequence is completed. Multiple-line commands can be used. Note If you want to stop the simulation using a when command, you must use a stop command within your when statement. DO NOT use an exit command or a quit command. The stop command acts like a breakpoint at the time it is evaluated.
Examples The when command below instructs the simulator to display the value of object c in binary format when there is a clock event, the clock is 1, and the value of b is 01100111. Finally, the command tells ModelSim to stop.
when -label when1 {clkevent and clk=1 and b = "01100111"} { echo "Signal c is [exa -bin c]" stop }
The commands below show an example of using a Tcl variable within a when command. Note that the curly braces ({}) have been replaced with double quotes ("").
set clkb_path /tb/ps/dprb_0/udprb/ucar_reg/uint_ram/clkb; when -label when1 "$clkb_path'event and $clkb_path ='1'" { echo "Detected Clk edge at path $clkb_path" }
The when command below is labeled a and will cause ModelSim to echo the message b changed whenever the value of the object b changes.
when -label a b {echo "b changed"}
The multi-line when command below does not use a label and has two conditions. When the conditions are met, an echo and a stop command will be executed.
when {b = 1 and c /= 0 } { echo "b is 1 and c is not 0" stop }
In the example below, for the declaration "wire [15:0] a;", the when command will activate when the selected bits match a 7:
573
Commands when when {a(3:1) = 3'h7} {echo "matched at time " $now}
If you encounter a vectored net caused by optimizing with vopt, use the event qualifier to prevent the command from falsely evaluating when unrelated bits of a change:
when {a(3:1) = 3'h7 and a(3:1)'event} {echo "matched at time " $now}
In the example below, we want to sample the values of the address and data bus on the first falling edge of clk after sstrb has gone high.
# ::strobe is our state variable set ::strobe Zero # This signal breakpoint only fires when sstrb changes to a '1' when -label checkStrobe {/top/sstrb == '1'} { # Our state Zero condition has been met, move to state One set ::strobe One } # This signal breakpoint fires each time clk goes to '0' when {/top/clk == '0'} { if {$::strobe eq "One"} { # Our state One condition has been met # Sample the busses echo Sample paddr=[examine -hex /top/paddr] :: sdata=[examine -hex /top/sdata] # reset our state variable until next rising edge of sstrb (back to state Zero) set ::strobe Zero } }
Ending the simulation with the stop command
Batch mode simulations are often structured as "run until condition X is true," rather than "run for X time" simulations. The multi-line when command below sets a done condition and executes an echo and a stop command when the condition is reached. The simulation will not stop (even if a quit -f command is used) unless a stop command is executed. To exit the simulation and quit ModelSim, use an approach like the following:
onbreak {resume} when {/done_condition == 1} { echo "End condition reached" if [batch_mode] { set DoneConditionReached 1 stop } } run 1000 us if {$DoneConditionReached == 1} { quit -f }
Heres another example that stops 100ns after a signal transition:
574
Commands when when {a = 1} { # If the 100ns delay is already set then let it go. if {[when -label a_100] == ""} { when -label a_100 { $now = 100 } { # delete this breakpoint then stop nowhen a_100 stop } } } Time-based breakpoints
You can build time-based breakpoints into a when statement with the following syntax. For absolute time (indicated by @) use:
when {$now = @1750 ns} {stop}
You can also use:

when {errorFlag = '1' OR $now = 2 ms} {stop}
This example adds 2 ms to the simulation time at which the when statement is first evaluated, then stops. The white space between the value and time unit is required for the time unit to be understood by the simulator. You can also use variables, as shown in the following example:
set time 1000 when "\$now = $time" {stop}
The quotes instruct Tcl to expand the variables before calling the command. So, the when command sees:
when "$now = 1000" stop
Note that "$now" has the $ escaped. This prevents Tcl from expanding the variable, because if it did, you would get:
when "0 = 1000" stop
See also bp, disablebp, enablebp, nowhen
575
Commands where
where
The where command displays information about the system environment. This command is useful for debugging problems where ModelSim cannot find the required libraries or support files. mg67000 The command displays two results on consecutive lines: current directory This is the current directory that ModelSim was invoked from, or that was specified on the ModelSim command line. current project file This is the .mpf file ModelSim is using. All library mappings are taken from here when a project is open. If the design is not loaded through a project, this line displays the modelsim.ini file in the current directory. Syntax where Arguments None.
Examples Design is loaded through a project:

VSIM> where # Current directory is: D:\Client # Project is: D:/Client/monproj.mpf
Design is loaded with no project (indicates the modelsim.ini file is under the mydesign directory):
VSIM> where # Current directory is: C:\Client\testcase\mydesign # Project is: modelsim.ini
576
Commands wlf2log
wlf2log
The wlf2log command translates a ModelSim WLF file (vsim.wlf) to a QuickSim II logfile. The command reads the vsim.wlf WLF file generated by the add list, add wave, or log commands in the simulator and converts it to the QuickSim II logfile format. Note This command should be invoked only after you have stopped the simulation using quit sim or dataset close sim. Syntax wlf2log [-bits] [-fullname] [-help] [-inout] [-input] [-internal] [-l <instance_path>] [-lower] [-o <outfile>] [-output] [-quiet] <wlffile> Arguments -bits Forces vector nets to be split into 1-bit wide nets in the log file. Optional. -fullname Shows the full hierarchical pathname when displaying signal names. Optional. -help Displays a list of command options with a brief description for each. Optional. -inout Lists only the inout ports. Optional. This may be combined with the -input, -output, or -internal switches. -input Lists only the input ports. Optional. This may be combined with the -output, -inout, or -internal switches. -internal Lists only the internal signals. Optional. This may be combined with the -input, -output, or inout switches. -l <instance_path> Lists the signals at or below the specified HDL instance path within the design hierarchy. Optional. -lower Shows all logged signals in the hierarchy. Optional. When invoked without the -lower switch, only the top-level signals are displayed.
577
Commands wlf2log
-o <outfile> Directs the output to be written to the file specified by <outfile>. Optional. The default destination for the logfile is standard out.
-output Lists only the output ports. Optional. This may be combined with the -input, -inout, or -internal switches.
-quiet Disables error message reporting. Optional. <wlffile> Specifies the ModelSim WLF file that you are converting. Required.
Additional information for QuickSim II users
In some cases your original QuickHDL/ModelSim simulation results (in your vsim.wlf file) may contain signal values that do not directly correspond to qsim_12state values. The resulting QuickSim II logfile generated by wlf2log may contain state values that are surrounded by single quotes, e.g. '0' and '1'. To make this logfile compatible with QuickSim models (that expect qsim_12state) you need to use a QuickSim II function named $convert_wdb(). This function was created to convert logfiles resulting from VHDL simulation that used std_logic and std_ulogic since these data types do not correlate to QuickSim's 12 simulation states. Other VHDL data types such as qsim_state or bit (2 state) do not require conversion as they are directly compatible with qsim_12state QuickSim II Waveform Databases (WDB). The following procedure can be used to convert a wlf2log-generated logfile into a compatible QuickSim WDB. The procedure below shows how to convert the logfile while loaded into memory in QuickSim II. 1. Load the logfile (the output from wlf2log) into a WDB other than "forces". "Forces" is the default WDB, so you need to choose a unique name for the WDB when loading the logfile (for example, "fred"). 2. Enter the following at the command prompt from within QuickSim:
$convert_wdb("fred",0)
The first argument, which is "fred", is the name of the new WDB to be created. The second argument, which is 0, specifies the type of conversion. At this time only one type of conversion is supported. The value 0 specifies to convert std_logic or std_ulogic into qsim_12state. 3. Do a connect_wdb (either through the pulldown menus, the "Connect WDB" palette icon under "Stimulus", or a function invocation). You specify the name of the WDB that you originally loaded the logfile into (in this case, "fred"). At this point you can issue the "run" command and the stimulus in the converted logfile will be applied. Before exiting the simulation you should save the new WDB ("fred") as a WDB or
578
Commands wlf2log
logfile so that it can be loaded again in the future. The new WDB or logfile will contain the correct qsim_12state values eliminating the need to re-use $convert_wdb().
579
Commands wlf2vcd
wlf2vcd
The wlf2vcd command translates a ModelSim WLF file to a standard VCD file. Complex data types that are unsupported in the VCD standard (records, memories, etc.) are not converted. Note This command should be invoked only after you have stopped the simulation using quit sim or dataset close sim. Syntax wlf2vcd [-help] [-o <outfile>] [-quiet] <wlffile> Arguments -help Displays a list of command options with a brief description for each. Optional. -o <outfile> Specifies a filename for the output. By default, the VCD output goes to stdout. Optional. -quiet Disables warning messages that are produced when an unsupported type (e.g., records) is encountered in the WLF file. Optional. <wlffile> Specifies the ModelSim WLF file that you are converting. Required.
580
Commands wlfman
wlfman
The wlfman command allows you to get information about and manipulate WLF files. The command performs four functions depending on which mode you use: wlfman info generates file information, resolution, versions, etc. wlfman items generates a list of HDL objects (i.e., signals) from the source WLF file and outputs it to stdout. When redirected to a file, the output is called an object_list_file, and it can be read in by wlfman filter. The object_list_file is a list of objects, one per line. Comments start with a '#' and continue to the end of the line. Wildcards are legal in the leaf portion of the name. Here is an example:
/top/foo /top/u1/* /top/u1 -r /top/u2 # # # # signal foo all signals under u1 same as line above recursively, all signals under u2
Note that you can produce these files from scratch but be careful with syntax. wlfman items always creates a legal object_list_file. wlfman filter reads in a WLF file and optionally an object_list_file and writes out another WLF file containing filtered information from those sources. You determine the filtered information with the arguments you specify. wlfman profile generates a report of the estimated percentage of file space that each signal is taking in the specified WLF file. This command can identify signals that account for a large percentage of the WLF file size (e.g., a logged memory that uses a zero-delay integer loop to initialize the memory). You may be able to drastically reduce WLF file size by not logging those signals. wlfman merge combines two WLF files with different signals into one WLF file. It does not combine wlf files containing the same signals at different runtime ranges (i.e., mixedhdl_0ns_100ns.wlf & mixedhdl_100ns_200ns.wlf).
The different modes are intended to be used together. For example, you might run wlfman profile and identify a signal that accounts for 50% of the WLF file size. If you dont actually need that signal, you can then run wlfman filter to remove it from the WLF file. Syntax wlfman info <wlffile> wlfman items [-n] [-v] <wlffile> wlfman filter [-begin <time>] [-end <time>] [-f <object_list_file>] [-r <object>] [-s <symbol>] [-t <resolution>] -o <outwlffile> <sourcewlffile> wlfman profile [-rank] [-top <number>] <wlffile> wlfman merge [-noopt] [-opt] -o <outwlffile> [<wlffile1> <wlffile2>]
581
Commands wlfman Arguments for wlfman info
<wlffile> Specifies the WLF file from which you want information. Required.
Arguments for wlfman items
-n Lists regions only (no signals). Optional. -v Produces verbose output that lists the object type next to each object. Optional. <wlffile> Specifies the WLF file for which you want a profile report. Required.
Arguments for wlfman filter
-begin <time> Specifies the simulation time at which you want to begin reading information from the source WLF file. Optional. By default the output includes the entire time that is recorded in the source WLF file.
-end <time> Specifies the simulation time at which you want to end reading information from the source WLF file. Optional.
-f <object_list_file> Specifies an object_list_file created by wlfman items to include in the output WLF file. Optional.
-r <object> Specifies an object (region) to recursively include in the output. If <object> is a signal, the output would be the same as using -s. Optional.
-s <symbol> Specifies an object to include in the output. Optional. By default all objects are output. -t <resolution> Specifies the time resolution of the new WLF file. Optional. By default the resolution is the same as the source WLF file.
-o <outwlffile> Specifies the name of the output WLF file. Required. The output WLF file will contain all objects specified by -f <object_list_file>, -r <object>, and -s <symbol>. Output WLF files are always written in the latest WLF version regardless of the source WLF file version.
<sourcewlffile> Specifies the source WLF file from which you want objects. Required.
582
Commands wlfman Arguments for wlfman profile
-rank Sorts the report by percentage. Optional. -top <number> Filters the report so that only the top <number> signals in terms of file space percentage are displayed. Optional.
<wlffile> Specifies the WLF file from which you want object information. Required.
Arguments for wlfman merge
-noopt Disables WLF file optimizations when writing output WLF file. Optional. -opt Forces WLF file optimizations when writing output WLF file. Optional. Default. -o <outwlffile> Specifies the name of the output WLF file. Required. The output WLF file will contain all objects from <wlffile1> and <wlffile2>. Output WLF files are always written in the latest WLF version regardless of the source WLF file version.
<wlffile1> <wlffile2> Specifies the WLF files whose objects you want to copy into one WLF file. Optional.
Examples The output from this command would look something like this:
wlfman profile -rank top_vh.wlf
583
Commands wlfman #Repeated ID #'s mean those signals share the same #space in the wlf file. # # ID Transitions File % Name #------------------------------------------------------1 2192 33 % /top_vh/pdata 1 /top_vh/processor/data 1 /top_vh/cache/pdata 1 /top_vh/cache/gen__0/s/data 1 /top_vh/cache/gen__1/s/data 1 /top_vh/cache/gen__2/s/data 1 /top_vh/cache/gen__3/s/data 2 1224 18 % /top_vh/ptrans 3 1216 18 % /top_vh/sdata 3 /top_vh/cache/sdata 3 /top_vh/memory/data 4 675 10 % /top_vh/strans 5 423 6 % /top_vh/cache/gen__3/s/data_out 6 135 3 % /top_vh/paddr. . . .
wlfman profile -top 3 top_vh.wlf
The output from this command would look something like this:
# ID #----1 1 1 1 1 1 1 2 3 3 3 Transitions ----------2192 File % -----33 % Name -----------------------------------/top_vh/pdata /top_vh/processor/data /top_vh/cache/pdata /top_vh/cache/gen__0/s/data /top_vh/cache/gen__1/s/data /top_vh/cache/gen__2/s/data /top_vh/cache/gen__3/s/data /top_vh/ptrans /top_vh/sdata /top_vh/cache/sdata /top_vh/memory/data
1224 1216
18 % 18 %
See also Recording Simulation Results With Datasets
584
Commands wlfrecover
wlfrecover
The wlfrecover tool attempts to "repair" WLF files that are incomplete due to a crash or the file being copied prior to completion of the simulation. You can run the tool from the VSIM> or ModelSim> prompt or from a shell. Syntax wlfrecover <filename> [-force] [-q] Arguments <filename> Specifies the WLF file to repair. Required. -force Disregards file locking and attempts to repair the file. Optional. -q Hides all messages unless there is an error while repairing the file. Optional.
585
Commands write cell_report
write cell_report
The write cell_report command writes to the Transcript pane or to a file a list of Verilog modules which qualified for and received gate-level cell optimizations. Gate-level cell optimizations are applied at the module level, in addition to normal Verilog optimizations, to improve performance of gate-level simulations. Syntax write cell_report [-filter <number>] [-infile <filename>] [-nonopt] [[-outfile] <filename>] Arguments -filter <number> Excludes cells with instance counts fewer than <number>. Optional. -infile <filename> Specifies a previously generated write report file to use as input. Optional. If not specified then the write report command will be run. -nonopt Reports only non-optimized instances. Optional. [-outfile] <filename> Writes the report to the specified output file rather than the Transcript pane. Optional.
586
Commands write format
write format
The write format command records the names and display options of the HDL objects currently being displayed in the Analysis, List, Memory, Message Viewer, Test Browser, and Wave windows. The write format restart command creates a single .do file that will recreate all debug windows, all file/line breakpoints, and all signal breakpoints created using the when command. If the ShutdownFile modelsim.ini variable is set to this .do filename, it will call the write format restart command upon exit. The file created is primarily a list of add list, add wave, and configure commands, though a few other commands are included (see "Output" below). This file may be invoked with the do command to recreate the window format on a subsequent simulation run. When you load a format file, ModelSim verifies the existence of the datasets required by that file. ModelSim displays an error message if the requisite datasets do not all exist. To force the execution of the format file even if all datasets are not present, use the -force switch with your do command. For example:
VSIM> do format.do -force
Note that this will result in error messages for signals referencing nonexistent datasets. Also, -force is recognized by the format file not the do command. Syntax write format analysis | list | memory | msgviewer | testbrowser | wave | restart [-window <window_name>] <filename> Arguments analysis | list | memory | msgviewer | testbrowser | wave | restart Specifies that the contents of the designated window are recorded in a .do file, <filename>. If restart is designated, all windows and breakpoints are recorded in the .do file. Required. -window <window_name> Specifies the List or Wave window for which you want contents recorded. Optional. Use when you have more than one instance of the List or Wave window. <filename> Specifies the name of the output file where the data is to be written. Required. Examples Save the current data in the List window in a file named alu_list.do.
write format list alu_list.do
Save the current data in the Wave window in a file named alu_wave.do.
write format wave alu_wave.do
587
Commands write format
Output Below is an example of a saved Wave window format file.

onerror {resume} quietly WaveActivateNextPane {} 0 add wave -noupdate -format Logic /cntr_struct/ld add wave -noupdate -format Logic /cntr_struct/rst add wave -noupdate -format Logic /cntr_struct/clk add wave -noupdate -format Literal /cntr_struct/d add wave -noupdate -format Literal /cntr_struct/q TreeUpdate [SetDefaultTree] quietly WaveActivateNextPane add wave -noupdate -format Logic /cntr_struct/p1 add wave -noupdate -format Logic /cntr_struct/p2 add wave -noupdate -format Logic /cntr_struct/p3 TreeUpdate [SetDefaultTree] WaveRestoreCursors {0 ns} WaveRestoreZoom {0 ns} {1 us} configure wave -namecolwidth 150 configure wave -valuecolwidth 100 configure wave -signalnamewidth 0 configure wave -justifyvalue left
In the example above, five signals are added with the -noupdate argument to the default window pane. The TreeUpdate command then refreshes all five waveforms. The second WaveActivateNextPane command creates a second pane which contains three signals.The WaveRestoreCursors command restores any cursors you set during the original simulation, and the WaveRestoreZoom command restores the Zoom range you set. These four commands are used only in saved Wave format files; therefore, they are not documented elsewhere. See also add list, add wave, configure
588
Commands write list
write list
The write list command records the contents of the most recently opened or specified List window in a list output file. This file contains simulation data for all HDL objects displayed in the List window: VHDL signals and variables and Verilog nets and registers. Syntax write list [-events] [-window <wname>] <filename> Arguments -events Specifies to write print-on-change format. Optional. Default is tabular format. -window <wname> Specifies an instance of the List window that is not the default. Optional. Otherwise, the default List window is used. Use the view command to change the default window. <filename> Specifies the name of the output file where the data is to be written. Required. Examples Save the current data in the default List window in a file named alu.lst.
write list alu.lst
Save the current data in window list1 in a file named group1.list.

write list -win list1 group1.list
See also write tssi
589
Commands write preferences
write preferences
The write preferences command saves the current GUI preference settings to a Tcl preference file. Settings saved include Wave, Objects, and Locals window column widths; Wave, Objects, and Locals window value justification; and Wave window signal name width. Syntax write preferences <preference file name> Arguments <preference file name> Specifies the name for the preference file. Optional. If the file is named modelsim.tcl, ModelSim will read the file each time vsim is invoked. To use a preference file other than modelsim.tcl you must specify the alternative file name with the MODELSIM_TCL environment variable. See also You can modify variables by editing the preference file with the ModelSim notepad:
notepad <preference file name>
590
Commands write report
write report
The write report command prints a summary of the design being simulated including a list of all design units (VHDL configurations, entities, and packages, and Verilog modules) with the names of their source files. The summary includes a list of all source files used to compile the given design. Syntax write report [-capacity [-l | -s] [-assertions | -classes | -cvg | -qdas | -solver]] | [-l | -s] [-tcl] [<filename>] Arguments <filename> Specifies the name of the output file where the data is to be written. Optional. If the <filename> is omitted, the report is written to the Transcript pane. -capacity Reports data on memory usage of various types of SystemVerilog constructs in the design. Optional. ModelSim collects memory usage data for assertions, classes, covergroups, dynamic objects, and the solver. Each of these design object types has a switch that you can specify along with -capacity in order to display its memory data. To display memory data for all object types, specify -capacity -l. -assertions Reports memory usage data for SystemVerilog assertions and cover directives. -classes Reports memory usage data for the current number of objects allocated, the current memory allocated for class object, the peak memory allocated and peak time. -cvg Reports memory usage data for the number of covergroups, cross, bins and memory allocated. -qdas Reports memory usage data for queues, dynamic arrays, and associative arrays. -solver Reports memory usage data for calls to randomize() and memory usage. -l Generates more detailed information about the design, including a list of sparse memories or the memory capacity for all object types. Default. -s Generates a short list of design information. Optional.
591
Commands write report
-tcl Generates a Tcl list of design unit information. Optional. This argument cannot be used with a filename.
Examples Save information about the current design in a file named alu_rpt.txt.
write report alu_rpt.txt
Display a short list of information regarding the memory capacity for covergroups in the design during the simulation so far.
write report -capacity -s cvg
Display information on all of the calls to randomize() made during simulation so far, along with the memory usage of those calls, number of calls, and callsite information.
write report -capacity -solver
592
Commands write timing
write timing
The write timing command displays path delays and timing check limits, unadjusted for delay net delays, for the specified instance. Syntax write timing [-recursive] [-file <filename>] [<instance_name1><instance_nameN>] [-simvalues] Arguments -recursive Generates timing information for the specified instance and all instances underneath it in the design hierarchy. Optional. -file <filename> Specifies the name of the output file where the data is to be written. Optional. If the -file argument is omitted, timing information is written to the Transcript pane. <instance_name1><instance_nameN> The name(s) of the instance(s) for which timing information will be written. Required. -simvalues Displays optimization-adjusted values for delay net delays. Optional. Examples Write timing about /top/u1 and all instances underneath it in the hierarchy to the file timing.txt.
write timing -r -f timing.txt /top/u1
Write timing information about the designated instances to the Transcript pane.
write timing /top/u1 /top/u2 /top/u3 /top/u8
593
Commands write transcript
write transcript
The write transcript command writes the contents of the Transcript pane to the specified file. The resulting file can be used to replay the transcribed commands as a DO file (macro). The command cannot be used in batch mode. In batch mode use the standard Transcript file or redirect stdout. Syntax write transcript [<filename>] Arguments <filename> Specifies the name of the output file where the data is to be written. Optional. If the <filename> is omitted, the transcript is written to a file named transcript. See also do
594
Commands write tssi
write tssi
The write tssi command records the contents of the default or specified List window in a "TSSI format" file. The file contains simulation data for all HDL objects displayed in the List window that can be converted to TSSI format (VHDL signals and Verilog nets). A signal definition file is also generated. The List window needs to be using symbolic radix in order for write tssi to produce useful output. Syntax write tssi [-window <wname>] <filename> Arguments -window <wname> Specifies an instance of the List window that is not the default. Optional. Otherwise, the default List window is used. Use the view command to change the default window. <filename> Specifies the name of the output file where the data is to be written. Required. Description If the <filename> has a file extension (e.g., listfile.lst), then the definition file is given the same file name with the extension .def (e.g., listfile.def). The values in the listfile are produced in the same order that they appear in the List window. The directionality is determined from the port type if the object is a port, otherwise it is assumed to be bidirectional (mode INOUT). Objects that can be converted to SEF are VHDL enumerations with 255 or fewer elements and Verilog nets. The enumeration values U, X, 0, 1, Z, W, L, H and - (the enumeration values defined in the IEEE Standard 1164 std_ulogic enumeration) are converted to SEF values according to the table below. Other values are converted to a question mark (?) and cause an error message. Though the write tssi command was developed for use with std_ulogic, any signal which uses only the values defined for std_ulogic (including the VHDL standard type bit) will be converted. std_ulogic State Characters U X 0 1 Z SEF State Characters Input N N D U Z Output X X L H T Bidirectional ? ? 0 1 F
595
Commands write tssi
std_ulogic State Characters W L H -
SEF State Characters Input N D U N Output X L H X Bidirectional ? 0 1 ?
Bidirectional logic values are not converted because only the resolved value is available. The TSSI TDS ASCII In Converter and ASCII Out Converter can be used to resolve the directionality of the signal and to determine the proper forcing or expected value on the port. Lowercase values x, z, w, l, and h are converted to the same values as the corresponding capitalized values. Any other values will cause an error message to be generated the first time an invalid value is detected on a signal, and the value will be converted to a question mark (?). Note The TDS ASCII In Converter and ASCII Out Converter are part of the TDS software. ModelSim outputs a vector file, and TSSI tools determine whether the bidirectional signals are driving or not. See also tssi2mti
596
Commands write wave
write wave
The write wave command records the contents of the most currently opened or specified Wave window in PostScript format. The output file can then be printed on a PostScript printer. Syntax write wave [-window <wname>] [-width <real_num>] [-height <real_num>] [-margin <real_num>] [-start <time>] [-end <time>] [-perpage <time>] [-landscape] [-portrait] <filename> Arguments -window <wname> Specifies an instance of the Wave window that is not the default. Optional. Otherwise, the default Wave window is used. Use the view command to change the default window. -width <real_num> Specifies the paper width in inches. Optional. Default is 8.5. -height <real_num> Specifies the paper height in inches. Optional. Default is 11.0. -margin <real_num> Specifies the margin in inches. Optional. Default is 0.5. -start <time> Specifies the start time (on the waveform timescale) to be written. Optional. -end <time> Specifies the end time (on the waveform timescale) to be written. Optional. -perpage <time> Specifies the time width per page of output. Optional. -landscape Use landscape (horizontal) orientation. Optional. This is the default orientation. -portrait Use portrait (vertical) orientation. Optional. The default is landscape (horizontal). <filename> Specifies the name of the PostScript output file. Required. Examples Save the current data in the Wave window in a file named alu.ps.
597
Commands write wave write wave alu.ps
Save the current data in window wave2 in a file named group2.ps.

write wave -win wave2 group2.ps
Write two separate pages to top.ps. The first page contains data from 600ns to 700ns, and the second page contains data from 701ns to 800ns.
write wave -start 600ns -end 800ns -perpage 100ns top.ps
To make the job of creating a PostScript waveform output file easier, use the File > Print Postscript menu selection in the Wave window.
598
Commands xml2ucdb
xml2ucdb
The xml2ucdb is a utility used to convert an XML test plan file to a .ucdb file. The configuration settings for this utiility are read automatically from the xml2ucdb.ini file, located in INSTALL_DIR/vm_src/ directory. For information about the XML language, see the XML 1.0 Specification available on the web. Syntax xml2ucdb [<options>] <XML_filename> [<ucdb_filename>] Where <options> are: [-help] [-debug] [-verbose] [-version] [-viewtags] [-viewall] [-formatlist] [-format <format>] [-excelsheet <sheet_name>] [-dofilename <file>] [-ucdbfilename <file>] [-inherit] [-stylesheet <file>] [-tagseparators <str>] [-starttags <tags>] [-stoptags <tags>] [-excludetags <tags>] [-sectiontags <tag>] [-datatags <tag>] [-titletag <tag>] [-descriptiontag <tag>][-goaltag <tags>] [-weighttag <tags>] [-linktag <tag>] [-typeattr <name>] [-linkattr <tag>] [-datafields <str>] [-datalabels <str>] [-autonumber | -noautonumber] [-startsection <num>] [-startstoring <num>] [-root <str>] [-title <str>] [-tagprefix <str>] [-sectionprefix <str>] Arguments -autonumber | -noautonumber Enables (-autonumber) or disables (-noautonumber) the automatic generation of testitem numbers from section tags. Optional. By default, the autonumbering is disabled. Use -autonumber to enable it. If you override the default off setting by enabling autonumbering in a custom configuration (xml2ucdb.ini) file, use -noautonumber to subsequently turn if off. -datafields <str> Specifies data fields, in the order that the columns appear in the testplan UCDB being imported (for example: "Section:Title:Tags:Description"). Use to add data fields to the testplan. Optional. -datalabels <str> Specifies labels for datafields. Optional. -datatags <tag> Specifies XML tag for item data fields. Optional.
599
Commands xml2ucdb
-debug Prints out internal debug information. Optional. -descriptiontag <tag> Specifies XML tag or tag list for description fields. Optional. -dofilename <file> Specifies the name of test plan mapping file. The test plan mapping file contains the Optional. The default: no mapping file.
-excludetags <tags> Specifies XML tag or tag list for tags to exclude from the processing. Optional. -excelsheet <sheet_name> Imports data from one specific sheet in an Excel spreadsheet. <sheet_name> is the exact string as it appears in the tab (Sheet1, Sheet2, etc.) at the bottom of an Excel spreadsheet. Optional.
-format <format> Specifies the format to be used for the command, from a list of formats (pre-defined XML semantic definitions) listed in the xml2ucdb.ini file, located at the root of the install directory. Optional.
-formatlist Lists the currently defined formats (pre-defined XML semantic definitions in Tcl) listed in the xml2ucdb.ini file located at the root of the install directory. Optional.
-goaltag <tags> Specifies the XML tag or tag list for a goal field. Optional. -help Prints Help Message. Optional. -inherit Used with a nested testplan. Causes storing state (resulting from start/stop tags or startstoring tag) to be inherited by the nested testplan.
-linkattr <tag> Specifies XML tag attribute for cover items. Optional. -linktag <tag> Specifies XML tag or tag list for cover items. Optional. -root <str> Specifies the root name to be prepended to each section number (in non-autonumbered testplans, i.e. spreadsheets) of the test plan. Allows you to specify a root testplan, in which you wish to next the current testplan. Optional.
600
Commands xml2ucdb
-stylesheet <file> Specifies the name of XSL pre-processing stylesheet to be used. Optional. -sectiontags <tag> Specifies XML tag or tag list for a test item section number (i.e.: "tag1:tag2:tag3"). Optional.
-sectionprefix <str> Specifies the prefix for section numbering (i.e. "tag1prefix:tag2prefix:tag3prefix"). Optional.
-startsection <num> Sets starting item number : defaults "0". Optional. -startstoring <num> Specifies the Storing to begin at an item number: defaults "0". Optional. -starttags <tags> Specifies XML tag or tag list for a tag to start the processing. Optional. -stoptags <tags> Specifies XML tag or tag list for a tag to stop the processing. Optional. -tagprefix <str> Specifies a string to be prefixed to UCDB tag names. For a top-level testplan, if the tagprefix is not set, the value specified with -title is used. If any whitespace is contained in the title, it is replaced with underscore characters for use as the tagprefix. For nested testplans, there is no default tagprefix: if you do not specify a tagprefix, none is used for the nested testplan. Optional.
-tagseparators <str> Specifies a list of characters used as tag separators for tag arguments accepting multiple tags. Applies only to the taglist parameters (-starttags, -stoptags, excludetags, etc.) specified on the command line. Optional.
-title <str> Specifies a string to be used as the title for the test plan. For a top-level testplan, if the title is not set, the basename of the input XML file is used. For nested testplans, there is no default title: if you do not specify a title, none is used for the nested testplan. Optional.
-titletag <tag> Specifies XML tag or tag list for a test item name, or start tag for Data fields. Optional. -typeattr <name> Specifies an attribute containing the "type" of each coverage item. Optional.
601
Commands xml2ucdb
<ucdb_filename> Specifies the name for the .ucdb output file. Required, unless -ucdbfilename is specified. -ucdbfilename <file> Specifies the name for the .ucdb output file. Required, unless <ucdb_filename> is specified. -verbose Prints the testplan hierarchy and design mapping. Optional. -version Prints the utilitys version number. Optional. -viewall Prints both tags & text contents of XML File. Optional. -viewtags Prints tag contents of XML File. Optional. -weighttag <tags> Specifies the XML tag or tag list for a weight field. Optional. <XML_filename> Specifies the input XML file to be converted. Required. The path can be a full or relative path to the file location. On Windows systems the path separator should be a slash (/), rather than a backslash (\), for example:
C:/design/vplan/verification.xml
Examples Convert the an Excel formatted XML file called input.xml to a UCDB format file, output.ucdb:
xml2ucdb -format Excel input.xml output.ucdb
Convert only a specified sheet, Sheet1, of an Excel formatted XML file called input.xml to a UCDB format file, output.ucdb:
xml2ucdb -format Excel -excelsheet Sheet1 input.xml output.ucdb
See also coverage goal, coverage weight, vcover attribute, vcover merge, vcover testnames
602
AVM Encyclopedia Class Index
Chapter 3 AVM Encyclopedia

The AVM Encyclopedia documents all of the classes in the AVM library. The classes are organized in related groups. For each class there is a description of the class and what it is used for along with a listing of all the members and methods. The methods and members are described as well. To use the Encyclopedia, look up a class name in the class index to find the page that has the complete description and the file name in the library where the class is defined. You can also peruse the class groups to understand how the classes work together.
Class Index
Table 3-1 is a complete list of all the class definitions in alphabetic order, the file in which each definition resides, and a reference to a page number for the complete description of the class.
Table 3-1. Class Index Class Name analysis_imp analysis_port avm_algorithmic_comparator avm_analysis_export avm_analysis_imp avm_analysis_port avm_blocking_get_export avm_blocking_get_imp avm_blocking_get_peek_export avm_blocking_get_peek_imp avm_blocking_get_peek_port avm_blocking_get_port avm_blocking_master_export avm_blocking_master_imp Definition File deprecated/tlm_imps.svh deprecated/analysis_port.svh utils/avm_algorithmic_comparator.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh tlm/avm_ports.svh tlm/avm_exports.svh tlm/avm_imps.svh Page 656 657 623 630 632 636 630 632 630 632 634 634 630 637
603
Table 3-1. Class Index Class Name avm_blocking_master_port avm_blocking_peek_export avm_blocking_peek_imp avm_blocking_peek_port avm_blocking_put_export avm_blocking_put_imp avm_blocking_put_port avm_blocking_slave_export avm_blocking_slave_imp avm_blocking_slave_port avm_built_in_clone avm_built_in_comp avm_built_in_converter avm_built_in_pair avm_class_clone avm_class_comp avm_class_converter avm_class_pair avm_connector_base avm_env avm_get_export avm_get_imp avm_get_peek_export avm_get_peek_imp avm_get_peek_port avm_get_port avm_in_order_built_in_ comparator avm_in_order_class_comparator avm_in_order_comparator Definition File tlm/avm_ports.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh vbase/avm_policies.svh vbase/avm_policies.svh vbase/avm_policies.svh utils/avm_pair.svh vbase/avm_policies.svh vbase/avm_policies.svh vbase/avm_policies.svh utils/avm_pair.svh vbase/avm_connector_base.svh utils/avm_env.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh tlm/avm_ports.svh utils/avm_in_order_comparator.svh utils/avm_in_order_comparator.svh utils/avm_in_order_comparator.svh Page 634 630 632 634 630 632 634 630 639 634 694 695 696 697 698 699 700 701 641 609 630 632 630 632 634 634 625 626 627
604
Table 3-1. Class Index Class Name avm_master_export avm_master_imp avm_master_port avm_named_component avm_nonblocking_get_export avm_nonblocking_get_imp avm_nonblocking_get_peek_ export avm_nonblocking_get_peek_imp avm_nonblocking_get_peek_port avm_nonblocking_get_port avm_nonblocking_master_export avm_nonblocking_master_imp avm_nonblocking_master_port avm_nonblocking_peek_export avm_nonblocking_peek_imp avm_nonblocking_peek_port avm_nonblocking_put_export avm_nonblocking_put_imp avm_nonblocking_put_port avm_nonblocking_slave_export avm_nonblocking_slave_imp avm_nonblocking_slave_port avm_peek_export avm_peek_imp avm_peek_port avm_port_base avm_put_export avm_put_imp analysis_fifo Definition File tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh vbase/avm_named_component.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh tlm/avm_ports.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh vbase/avm_port_base.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/tlm_fifos.svh Page 630 645 634 611 630 632 630 632 634 634 630 647 634 630 632 634 630 632 634 630 649 634 630 632 634 651 630 632 661
605
Table 3-1. Class Index Class Name analysis_if avm_put_port avm_random_stimulus avm_report_client avm_report_handler avm_report_server avm_reporter avm_slave_export avm_slave_imp avm_slave_port avm_stimulus avm_subscriber avm_threaded_component avm_transaction avm_transport_export avm_transport_imp avm_transport_port avm_verification_component global_analysis_ports tlm_blocking_get_if tlm_blocking_get_imp tlm_blocking_get_peek_if tlm_blocking_get_peek_imp tlm_blocking_master_if tlm_blocking_master_imp tlm_blocking_peek_if tlm_blocking_peek_imp tlm_blocking_put_if tlm_blocking_put_imp tlm_blocking_slave_if
606
Definition File tlm/tlm_ifs.svh tlm/avm_ports.svh utils/avm_random_stimulus.svh reporting/avm_report_client.svh reporting/avm_report_handler.svh reporting/avm_report_server.svh reporting/avm_report_client.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh deprecated/avm_stimulus.svh utils/avm_subscriber.svh utils/avm_threaded_component.svh vbase/avm_transaction.svh tlm/avm_exports.svh tlm/avm_imps.svh tlm/avm_ports.svh deprecated/avm_verification_component.svh deprecated/avm_global_analysis_ports.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh
Page 669 634 616 704 709 712 714 630 653 634 618 619 620 702 630 655 634 621 658 630 659 630 659 630 659 630 659 630 659 630
Table 3-1. Class Index Class Name tlm_blocking_slave_imp tlm_fifo tlm_get_if tlm_get_imp tlm_get_peek_if tlm_get_peek_imp tlm_master_if tlm_master_imp tlm_nonblocking_get_if tlm_nonblocking_get_imp tlm_nonblocking_get_peek_if tlm_nonblocking_get_peek_imp tlm_nonblocking_master_if tlm_nonblocking_master_imp tlm_nonblocking_peek_if tlm_nonblocking_peek_imp tlm_nonblocking_put_if tlm_nonblocking_put_imp tlm_nonblocking_slave_if tlm_nonblocking_slave_imp tlm_peek_if tlm_peek_imp tlm_put_if tlm_put_imp tlm_req_rsp_channel tlm_slave_if tlm_slave_imp tlm_transport_channel tlm_transport_if tlm_transport_imp
Definition File deprecated/tlm_imps.svh tlm/tlm_fifos.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_req_rsp.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh tlm/tlm_req_rsp.svh tlm/tlm_ifs.svh deprecated/tlm_imps.svh
Page 659 662 676 659 677 659 679 659 681 659 682 659 683 659 685 659 686 659 687 659 689 659 690 659 665 691 659 668 693 659
607
AVM Encyclopedia Classes for Components
Classes for Components

Components form the foundation of the AVM. Components encapsulate behavior of transactors, scoreboards, and other objects in a testbench. avm_named_component is the base class from which all component classes are derived.
Figure 3-1. UML Diagram for Components
608
AVM Encyclopedia avm_env
avm_env
extends avm_named_component
A subclass of avm_env is the top-level class in any class-based AVM verification environment. All the components of the testbench are children of this top-level class. There are two key methods in any such subclass: the constructor that specifies the connectivity between the environment class and the rest of the testbench and do_test(), which is inherited from the avm_env base class. avm_env::do_test() runs through the AVM phases. These are connect() (further broken down into export_connections(), connect() and import_connections()), configure(), run(), and report(). file
utils/avm_env.svh
virtual
yes
members
avm_connection_phase_e m_connection_phase = AVM_CONSTRUCTION_PHASE
Used to determine which phase of elaboration is currently being executed. This enum is used by avm_connector_base (see page 641) to check that the correct connections are being done in the correct subphase of the connect phase. internal members
local process m_run_process
The run process is the process id of the run() task. methods

function new(string name="env") This is the constructor. name is the first argument of the normal avm_named_component constructor. It is not necessary to specify argument, since avm_env does not have a parent. virtual function void configure()
the parent
Allows configuration of verification components before the simulation starts, although it may be that back door memory accesses are also done here. It is virtual so that it can be overloaded in subclasses of avm_env. It is a function, so it cannot consume time. If there is some time-consuming initialization that needed before the test starts, then this needs to be done in the run phase. configure() is executed after elaborate() and before run().
virtual function void connect()
A virtual method that gets overridden in the user-defined subclass to specify the connections between top-level components in the environment.
609
AVM Encyclopedia avm_env function void do_kill_all() Kills all run() tasks, whether these were created by avm_env or avm_threaded_component. It is called by do_test() between the
run phase and the report phase. It can also be called manually to stop all processes.
virtual task do_test()
The main user-visible method in avm_env. It runs through the AVM phases as described above.
virtual task execute()
This method is deprecated. It exists to support backward compatibility with AVM 2.0.
virtual function void kill() Kills the run() task and any
of its children. It can be overloaded to do additional work before or after killing these processes. However, it is necessary that the overloaded method call super.kill(). It provides a summary of all AVM message reporting calls, so if it is overridden in a subclass, it is recommended that super.report() be called as the last thing in the user-defined report() method. It is a function and cannot consume time. If some time-consuming post processing is needed, then it must be done at the end of the run() task. task and any of its children. It can be overloaded to do additional work before or after resuming these processes. However, it is necessary that the overloaded method call super.resume(). The main process at the top level of the testbench. Typically, it is used to start stimulus generation, examine the state of scoreboards and/or coverage objects, and then stop stimulus generation.
virtual function void report() Called when the run() task finishes.
virtual task resume() Suspends the run()
virtual task run()
virtual task suspend() Suspends the run()
task and any of its children. It can be overloaded to do additional work before or after suspending these processes. However, it is necessary that the overloaded method call super.suspend().
internal methods
task do_run_all()
A virtual method in avm_named_component. The implementation in avm_env adds a delta delay to ensure that all subcomponents start before the run() task in the avm_env.
local function void elaborate()
A local method that runs through the connect subphases. It is the first phase executed after the environment constructor completes.
610
AVM Encyclopedia avm_named_component
avm_named_component
extends avm_report_client
This is the fundamental building block of the AVM. All structural classes (e.g., avm_env, avm_threaded_component, avm_random_stimulus, etc.) inherit from avm_named_component. Broadly speaking, the methods of this class are divided into three kinds: the basic hierarchy handling methods, including the constructor and remove; the methods called by avm_env to do configuration, connections, and reporting; and the hierarchical reporting methods. file
vbase/avm_named_component.svh
virtual
Yes
members
protected avm_named_component m_children[string]
An associative array of those named components that are children of this component. The children are indexed by their leaf name.
protected avm_named_component m_components[string]
An array used purely for debugging purposes. It is only valid after the end of elaboration. It consists of those children of this component that are not ports, exports, or implementations.
avm_env m_env
A handle to the avm_env within which this component is defined. It is null if the component is defined outside of an avm_env.
protected avm_named_component m_exports[string]
An array used purely for debugging purposes. It is only valid after the end of elaboration. It consists of those children of this component that are exports.
protected avm_named_component m_implementations[string]
An array used purely for debugging purposes, it is only valid after the end of elaboration. It consists of those children of this component that are implementations.
string m_leaf_name
The local name of the component, e.g., data_phase_monitor.

string m_name
The full hierarchical name of the component, e.g., top.monitor.data_phase_monitor.

protected avm_named_component m_parent A handle to the parent. For avm_envs and
components defined outside of avm_envs (e.g., in modules, interfaces, or program blocks) this will be null. For any component defined within an avm_env, the parent will be the avm_env.
protected avm_named_component m_ports[string]
611
AVM Encyclopedia avm_named_component
An array used purely for debugging purposes. It is only valid after the end of elaboration. It consists of those children of this component that are ports. internal members
local bit m_is_removed
Set to true when a component is removed.

static protected avm_env s_current_env
Only used for printing AVM 2.0 backward compatibility messages. It should not under any circumstances be relied on to contain a useful handle by subclasses of this component. methods
function new(string name, avm_named_component parent=null, bit check_parent=1) We must always provide a local name. For most components, a parent is supplied and checked. The only exceptions to this are avm_env, which must not have a parent, and components such as tlm_fifo (see page 662), which might not have a parent if they are being used outside of an avm_env, such as in a module. If a component instantiation does not have a parent, then check_parent should be set to
0.
function avm_named_component absolute_lookup(string name)
Returns a handle to the component with the full hierarchical name specified by name, if there is such a component, and will return null otherwise.
virtual function void configure() An empty implementation in avm_named_component. It should be overloaded required in a subclass. It is called by the avm_env using do_configure().
if
protected virtual function void connect() Called by avm_env after export_connections and before import_connections. It should be overloaded in subclasses of avm_named_component so that a child port
that requires an interface can obtain it from an export of another sibling child. Connections in connect() should be of the form child1.port.connect( child2.export ).
virtual function void do_display(int max_level=-1, int level=0, bit display_connectors=0)
A debugging method that is used to recursively display the hierarchical names of this component and its children. max_level is used to control the depth of the recursionthe default value of -1 means that the recursion will always carry on to the lowest level in the hierarchy of the testbench. It is not expected that the normal testbench code will supply a value other than zero to the second argument. The third argument is used to control whether ports, exports, and implementations are displayed. The default value of zero indicates that they are not displayed; a value of 1 ensures that connectors are displayed.
612
AVM Encyclopedia avm_named_component virtual function void do_kill_all() Kills all the run() tasks in the current
instance of avm_named_component and any tasks spawned by this instance and any child component instances. It is called by avm_env after its run() task has finished executing. method for this component and all its children using a bottom-up ordering. It is not called automatically by avm_env, so it needs to be called explicitly when required. A virtual function whose default implementation is empty. It is called by avm_env at the end of elaboration and before configure(). It can be overloaded in a subclass, and is a useful place to put debugging code that can display interesting aspects of the testbench hierarchy or connectivity.
function void do_flush() Calls the virtual flush()
virtual function void end_of_elaboration()
protected virtual function void export_connections() Called by avm_env at the beginning of the connect() phase. It should be overloaded in subclasses of avm_named_component to make avm_*_exports and avm_*_imps
defined in children of this component externally visible. Connections in export_connections should be of the form export.connect(child.export).
virtual function void flush()
An empty implementation in avm_named_component. It should be overloaded if required in a subclass. It is called from normal testbench code by do_flush().
protected virtual function void import_connections() Called by avm_env at the end of the connect() phase. It should be overloaded in subclasses of avm_named_component so that a child port that requires an external
interface can obtain it from a port of this component. Connections in import_connections should be of the form child.port.connect( port ).
function bit is_removed()
Returns 1 if this component has been removed, otherwise returns 0.

function avm_named_component relative_lookup(string name)
Looks up the child of this component whose name relative to this component is name. For example, if this components name is i1.i2 and name is i3.i4, then this method will return the handle to the component with name i1.i2.i3.i4 if there is such a component, and will return null otherwise.
virtual function void remove()
Removes all trace of a component from the various AVM data structures. It is virtual to allow subclasses to delete this component from their data structures if that is necessary. remove() can only be called during the avm_env construction phase.
virtual function void report() An empty implementation in avm_named_component. It should be overloaded required in a subclass. It is called by the avm_env using do_report(). function void set_report_default_file_hier(FILE f) Calls set_report_default_file() on this component
if
and all its children.

613
AVM Encyclopedia avm_named_component function void set_report_id_action_hier (string id, action a) Calls set_report_id_action() on this component and
all its children.
function void set_report_severity_action_hier(severity s, action a) Calls set_report_severity_action() on this component and function void set_report_id_file_hier (string id, FILE f) Calls set_report_id_file() on this component and
all its children.
all its children.
function void set_report_severity_file_hier (severity s, FILE f) Calls set_report_severity_file() on this component and all
its children.
function void set_report_severity_id_action_hier(severity s, string id, action a) Calls set_report_severity_id_action() on this component and function void set_report_severity_id_file_hier (severity s, string id, FILE f) Calls set_report_severity_id_file() on this component and all function void set_report_verbosity_level_hier(int v) This method calls set_report_verbosity_level() on this
all its children.
its children.
component and all its
children. internal methods

protected virtual function void add_to_debug_list()
Adds this component to the relevant debug list in its parent. By default, this is the m_components array. This protected method is overridden in avm_connector_base.
local function void build_debug_lists() Calls add_to_debug_list() for each child
of this component.
virtual function void check_connection_size() Called by amv_env at the end of elaboration to check
that the minimum number of interfaces have been supplied to each connector as defined by the min_size argument in the constructor of avm_connector_base.
function void do_configure() Called by avm_env after the elaboration phase but before the run() phase. It calls configure() on this component and all its children using a top-down ordering. function void do_connect() Called by avm_env after do_export_connections() and before do_import_connections(). Calls connect() in this component and all its children
using an undefined ordering.

function void do_end_of_elaboration() Used by avm_env to ensure top-down ordering of end_of_elaboration() methods. 614
AVM Encyclopedia avm_named_component function void do_export_connections() Called by avm_env at the beginning of the connect() phase. Calls export_connections() in this component and all its children using
a bottom-up
ordering.
function void do_import_connections() Called by avm_env after do_connect().
Calls import_connections() in this component and all its children using a top-down ordering. the run() method terminates. Calls report on this component and its children using a bottom-up ordering.
function void do_report() Called by avm_env after
virtual task do_run_all() Spawns all the run() tasks in this component and all its children. Called by avm_env after the configure() phase and immediately before it spawns its own run()
method.
function void do_set_env(avm_env e) Called by avm_env after construction and before the connection phase. It sets m_env in all the children of the avm_env. local function void extract_name()
A utility used by the absolute and relative look-up methods.

local function void no_parent_message()
An internal method that prints out some AVM 2.0 to AVM 3.0 migration messages.
615
AVM Encyclopedia avm_random_stimulus
avm_random_stimulus
#(type trans_type=avm_transaction) extends avm_named_component
This is a general purpose unidirectional random stimulus generator. It is a very useful component in its own right, but can also either be used as a template to define other stimulus generators, or it can be extended to add additional stimulus generation methods to simplify test writing. The avm_random_stimulus class generates streams of trans_type transactions. These streams may be generated by the randomize() method of trans_type, or the randomize() method of one of its subclasses, depending on the type of the argument passed into the generate_stimulus() method. The stream may go indefinitely, until terminated by a call to stop_stimulus_generation(), or you may specify the maximum number of transactions to be generated. By using inheritance, we can add directed initialization or tidy up sequences to the random stimulus generation. file
utils/avm_random_stimulus.svh
virtual
no
parameters
type trans_type=avm_transaction
Specifies the type of transaction to be generated. members

avm_blocking_put_port #(trans_type) blocking_put_port
The port through which transactions come out of the stimulus generator.
local bit m_stop=0
Indicates whether the stimulus generator should stop before issuing the next transaction. methods
function new(string name, avm_named_component parent)
This is the standard AVM 3.0 constructor. The constructor displays the string obtained from get_randstate() during construction. set_randstate() can then be used to regenerate precisely the same sequence of transactions for debugging purposes.
virtual task generate_stimulus(trans_type t=null, int max_count=0)
616
AVM Encyclopedia avm_random_stimulus
The main user-visible method. If t is not specified, we will generate random transactions of type trans_type. If t is specified, we will use the randomize() method in t to generate transactionsso t must be a subclass of trans_type. max_count is the maximum number of transactions to be generated. A value of zero indicates no maximumin this case, generate_stimulus() will go on indefinitely unless stopped by some other process. The transactions are cloned before they are sent out over the blocking_put_port.
virtual function void stop_stimulus_generation()
Stops the generation of stimulus.
617
AVM Encyclopedia avm_stimulus
avm_stimulus
#(type trans_type=avm_transaction) extends avm_named_component This is deprecated in AVM 3.0 in favor of avm_random_stimulus.
It is in the library to ensure
backward compatibility with AVM 2.0. file

deprecated/avm_stimulus.svh
virtual
no
parameters
type trans_type = avm_transaction
members
tlm_blocking_put_if #(trans_type) blocking_put_port local bit m_stop=0
methods
function new(string name, avm_named_component parent=null) virtual task generate_stimulus(trans_type t=null, int max_count=0) virtual function void stop_stimulus_generation()
618
AVM Encyclopedia avm_subscriber
avm_subscriber
#(type T=int) extends avm_named_component
A subclass of avm_subscriber can be used to connect to an avm_analysis_port that writes transactions of type T. It has a single pure virtual method, write(), which is made available to the outside via an analysis_export. It is particularly useful when writing a coverage object that needs to be attached to a monitor. file
utils/avm_subscriber.svh
virtual
yes
parameters
type T = int
Specifies the type of transaction to be received. members

typedef avm_subscriber #(T) this_type avm_analysis_imp #(T, this_type) analysis_export The export through which the write method is made
available.
methods
function new(string name, avm_named_component p)
This is the standard AVM 3.0 constructor.

pure virtual function void write(T t)
A pure virtual method that needs to be defined in a subclass.
619
AVM Encyclopedia avm_threaded_component
avm_threaded_component
extends avm_named_component
A threaded component inherits from avm_named_component and adds the ability to spawn a run() task at the beginning of the simulation. file
utils/avm_threaded_component.svh
virtual
yes
members
protected process m_main_process The process id of the run() task.
methods
This is the standard AVM 3.0 constructor.

function void do_kill_all() A virtual method in avm_named_component that is called by avm_env run() tasks and any other processes spawned by any run() task. virtual function void kill() A virtual in avm_named_component that
to kill all the
is called by do_kill_all(). If additional tidying up is required before or after killing the run() task and its children, then this method can be overloaded. If this is done, super.kill() must be called. phase.
virtual function void report() Called by avm_env after the run virtual task resume() Resumes the run()
task and any other processes spawned by the run() task.
pure virtual task run()
A pure virtual method that must be defined in any subclass.

virtual task suspend() Suspends the run()
task and any other processes spawned by the run() task.
internal methods
task do_run_all() Used by the avm_env
to spawn the run() method.
620
AVM Encyclopedia avm_verification_component
avm_verification_component
extends avm_threaded_component
This is deprecated in AVM 3.0 in favor of avm_threaded_component. It is in the library to ensure backward compatibility with AVM 2.0. file
deprecated/avm_verification_component
virtual
yes
members
<none>
methods
Classes for Comparators

A common function of testbenches is to compare streams of transactions for equivalence. For example, a testbench may compare a stream of transactions from a DUT with expected results. The AVM library provides a base class called avm_in_order_comparator and two derived classes, which are avm_in_order_built_in_comparator for comparing streams of built-in types and avm_in_order_class_comparator for comparing streams of class objects. avm_algorithmic_comparator also compares two streams of transactions; however, the transaction streams might be of different type objects. This device will use a user-written transformation function to convert one type to another before performing a comparison.
621
AVM Encyclopedia Classes for Comparators
Figure 3-2. UML Diagram for Comparator Classes
622
AVM Encyclopedia avm_algorithmic_comparator
avm_algorithmic_comparator
#(type BEFORE=int, type AFTER=int, type TRANSFORMER=int_transform) extends avm_named_component The algorithmic comparator is a wrapper around avm_in_order_class_comparator.
Like the in-order comparator, the algorithmic comparator compares two streams of transactions, the before stream and the after stream. It is often the case when two streams of transactions need to be compared that the two streams are in different forms. That is, the type of the before transaction stream is different than the type of the after transaction stream. The avm_algorithmic_comparator provides a transformer that transforms before transactions into after transactions. The transformer is supplied to the algorithmic comparator as a policy class via the class parameter TRANSFORMER. The transformer policy must provide a transform() method with the following prototype:
AFTER transform (BEFORE b);
file
utils/avm_algorithmic_comparator.svh
virtual
no
parameters
type AFTER = int
The type of the transaction against which the transformed BEFORE transactions will be compared.
type BEFORE = int
The type of incoming transaction to be transformed prior to comparing against the AFTER transactions.
type TRANSFORMER = int_transform
The type of the class that contains the transform() method. members
typedef avm_algorithmic_comparator #(BEFORE, AFTER, TRANSFORMER) this_type avm_analysis_export #(AFTER) after_export Provides a write(AFTER t) method so that publishers (e.g., monitors) can send in an ordered stream of transactions against which the transformed BEFORE transactions will be compared. avm_analysis_imp #(BEFORE, this_type) before_export Provides a write(BEFORE t) method so that publishers (e.g., monitors) can send in an ordered stream of transactions to be transformed and compared to the AFTER
transactions.
623
AVM Encyclopedia avm_algorithmic_comparator
internal members
local avm_in_order_class_comparator #(AFTER) comp comp is the comparator used to compare the transformed BEFORE AFTER stream. local TRANSFORMER m_transformer m_transformer encapsulates the
stream with the
algorithm that transforms BEFOREs into AFTERs.
methods
function new(TRANSFORMER transformer, string name, avm_named_component parent)
The constructor takes a handle to an externally constructed transformer, a name, and a parent. The last two arguments are the normal arguments for an AVM 3.0 named component constructor. We create an instance of the transformer (rather than making it a genuine policy class with a static transform method) because we might need to do reset and configuration on the transformer itself.
function void export_connections()
This is the standard AVM method for making exports and implementations of subcomponents visible externally.
function void write(BEFORE b)
This method handles incoming BEFORE transactions. It is usually accessed via the before_export, and it transforms the BEFORE transaction into an AFTER transaction before passing it to the in_order_class_comparator.
624
AVM Encyclopedia avm_in_order_built_in_comparator
avm_in_order_built_in_comparator
#(type T=int) extends avm_in_order_comparator #(T) A subclass of avm_in_order_comparator that is used to compare two streams of built-in types.
file
utils/avm_in_order_comparator.svh
virtual
no
parameters
type T = int
Specifies the type of transactions to be compared. members

<none>
methods
function new(string name,avm_named_component parent)
This is the normal AVM 3.0 constructor
625
AVM Encyclopedia avm_in_order_class_comparator
avm_in_order_class_comparator
#(type T=int) extends avm_in_order_comparator #(T, avm_class_comp #(T), avm_class_converter #(T), avm_class_pair #(T)) A subclass of avm_in_order_comparator that is used to compare two streams assumed that the classes have comp() and convert2string() methods.
of classes. It is
file
virtual
no
parameters
type T = int
Specifies the type of transactions to be compared. members

<none>
methods
This is the normal AMV 3.0 constructor
626
AVM Encyclopedia avm_in_order_comparator
avm_in_order_comparator
#(type T=int, type comp=avm_built_in_comp #(T), type convert=avm_built_in_converter #(T), type pair_type=avm_built_in_pair #(T)) extends avm_threaded_component
Compares two streams of transactions. These transactions may either be classes or built-in types. To be successfully compared, the two streams of data must be in the same order. Apart from that, there are no assumptions made about the relative timing of the two streams of data. file
virtual
no
parameters
type T = int
Specifies the type of transactions to be compared.

type comp = avm_built_in_comp #(T)
The type of the comparator to be used to compare the two transaction streams.
type convert = avm_built_in_converter #(T) A policy class to allow convert2string() to be called on the transactions being compared. If T is an extension of avm_transaction, it uses T::convert2string(). If T is a built-in type, the policy provides a convert2string() method for the
comparator to call.
type pair_type = avm_built_in_pair #(T)
A policy class to allow pairs of transactions to be handled as a single avm_transaction type. members
avm_analysis_export #(T) before_export
The export to which one stream of data is written.

avm_analysis_export #(T) after_export
The export to which the other stream of data is written.

avm_analysis_port #(pair_type) pair_ap
The comparator sends out pairs of transactions across this analysis port. Both matched and unmatched pairs are published.
int m_matches
The number of successfully paired transactions.

int m_mismatches
The number of unsuccessfully paired transactions.
627
AVM Encyclopedia avm_in_order_comparator
members
local analysis_fifo #(T) before_fifo
The local storage for the stream of data coming in through before_export.
local analysis_fifo #( T ) after_fifo
The local storage for the stream of data coming in through after_export. methods
The normal AVM 3.0 constructor.

function void export_connections() Connects the before_export and after_export function void flush() This method sets m_matches
to their respective FIFOs.
and m_mismatches back to zero. tlm_fifo::flush takes care of flushing the FIFOs.
task run()
Takes pairs of before and after transactions and compares them. Status information is updated according to the results of the comparison and pairs are published using the analysis port.
628
AVM Encyclopedia Classes for Connectors
Classes for Connectors

Connectors are the ports and exports used to form transaction-level connections between components or between components and channels.
Figure 3-3. UML Diagram for Connectors
629
AVM Encyclopedia avm_*_export
avm_*_export
#(type T=int) extends avm_port_base #(tlm_*_if #(T))
An avm_*_export is a connector that provides interfaces to other components. It gets these interfaces by connecting to an avm_*_export or avm_*_imp in a child component.
avm_*_export inherits all the connectivity methods (e.g., the connect() method) from its base class avm_port_base.
It also implements all the methods of tlm_*_if, as described in the documentation of avm_*_port (see page 634). However, this is mainly for backwards compatibility with AVM 2.0. These methods are not usually called directly from normal testbench code. file
tlm/avm_exports.svh
parameters
type T = int
The type of transaction to be communicated across the export. members

<none>
methods
function new(string name, avm_named_component parent, int min_size=1, int max_size=1) name and parent are the standard AVM 3.0 constructor arguments. min_size and max_size specify the minimum and maximum number of interfaces that must have
been supplied to this port by the end of elaboration. The AVM library contains one export for each tlm_*_if interface class as shown in Table 3-2.
Table 3-2. Exports and Interfaces Interface analysis_if tlm_blocking_get_if tlm_blocking_get_peek_if tlm_blocking_master_if tlm_blocking_peek_if tlm_blocking_put_if tlm_blocking_slave_if Export avm_analysis_export avm_blocking_get_export avm_blocking_get_peek_export avm_blocking_master_export avm_blocking_peek_export avm_blocking_put_export avm_blocking_slave_export
630
AVM Encyclopedia avm_*_export
Table 3-2. Exports and Interfaces Interface tlm_get_if tlm_get_peek_if tlm_master_if tlm_nonblocking_get_if tlm_nonblocking_get_peek_if tlm_nonblocking_master_if tlm_nonblocking_peek_if tlm_nonblocking_put_if tlm_nonblocking_slave_if tlm_peek_if tlm_put_if tlm_slave_if tlm_transport_if Export avm_get_export avm_get_peek_export avm_master_export avm_nonblocking_get_export avm_nonblocking_get_peek_export avm_nonblocking_master_export avm_nonblocking_peek_export avm_nonblocking_put_export avm_nonblocking_slave_export avm_peek_export avm_put_export avm_slave_export avm_transport_export
631
AVM Encyclopedia avm_*_imp
avm_*_imp
#(type T=int, type IMP=int) extends avm_port_base #(tlm_*_if #(T)) avm_*_imp provides a tlm_*_if to ports and exports that require it. The actual implementation of the methods that comprise tlm_*_if are defined in an object of type IMP (e.g., tlm_fifo #(T)) which is passed in to the constructor.
file
tlm/avm_imps.svh
virtual
no
parameters
type T = int
Type of transactions to be communicated across the underlying interface.

type IMP = int
Type of the parent of this implementation. internal members

local tlm_*_if #(T) m_if Handle back to avm_*_imp. local IMP m_imp
Handle to the component that implements the methods conveyed in the tlm_*_if description. methods
function new(string name, IMP imp) name is the normal first argument to
an AVM 3.0 constructor. imp is a slightly different form for the second argument to the AVM 3.0 constructor, which is of type IMP and defines the type of the parent. Since it is the purpose of an imp class to provide an implementation of a set of interface tasks and functions, the particular set of tasks and functions available for each avm_*_imp class is dependent on the type of the interface it implements, i.e., the particular TLM interface it extends. Table 3-3 lists all the avm_*_imp classes and the interfaces each implements. The set of tasks and functions implemented is listed in the description of the interface classes.
632
AVM Encyclopedia avm_*_imp
Table 3-3. Interface Implementations Implementation avm_analysis_imp avm_blocking_get_imp avm_blocking_get_peek_imp avm_blocking_master_imp avm_blocking_peek_imp avm_blocking_put_imp avm_blocking_slave_imp avm_get_imp avm_get_peek_imp avm_master_imp avm_nonblocking_get_imp avm_nonblocking_get_peek_imp avm_nonblocking_master_imp avm_nonblocking_peek_imp avm_nonblocking_put_imp avm_nonblocking_slave_imp avm_peek_imp avm_put_imp avm_slave_imp avm_transport_imp Interface analysis_if tlm_blocking_get_if tlm_blocking_get_peek_if tlm_blocking_master_if tlm_blocking_peek_if tlm_blocking_put_if tlm_blocking_slave_if tlm_get_if tlm_get_peek_if tlm_master_if tlm_nonblocking_get_if tlm_nonblocking_get_peek_if tlm_nonblocking_master_if tlm_nonblocking_peek_if tlm_nonblocking_put_if tlm_nonblocking_slave_if tlm_peek_if tlm_put_if tlm_slave_if tlm_transport_if
633
AVM Encyclopedia avm_*_port
avm_*_port
#(type T=int) extends avm_port_base #(tlm_*_if #(T))
An avm_*_port is a connector that requires interfaces to be supplied to it. It may get these interfaces by connecting to a parents avm_*_port, or an avm_*_export, or avm_*_imp in a sibling.
avm_*_port inherits all the connectivity methods (e.g., the connect() method) from its base class, avm_port_base. It is effectively a proxy for the interface that originally supplied the implementation of this interface (e.g., a tlm_fifo). avm_*_port implements all the methods in tlm_*_if, and a call to any of these methods has the same effect as the equivalent call to the
resolved implementation. file

tlm/avm_ports.svh
virtual
no
parameters
type T = int
The type of transaction to be communicated across the port. members

<none>
methods
function new(string name, avm_named_component parent, int min_size=1, int max_size=1) name and parent are the standard AVM 3.0 constructor arguments. min_size and max_size specify the minimum and maximum number of interfaces that must have
been supplied to this port by the end of elaboration. The set of functions and tasks available in each port object is dependent on the kind of port it is. Table 3-4 lists, for each port type, the interface it implements. The tasks and functions for each interface can be found in the descriptions for the interface classes as shown below.
Table 3-4. Ports and Interfaces Port avm_analysis_port avm_blocking_get_port avm_blocking_get_peek_port Interface analysis_if tlm_blocking_get_if tlm_blocking_get_peek_if
634
AVM Encyclopedia avm_*_port
Table 3-4. Ports and Interfaces Port avm_blocking_master_port avm_blocking_peek_port avm_blocking_put_port avm_blocking_slave_port avm_get_port avm_get_peek_port avm_master_port avm_nonblocking_get_port avm_nonblocking_get_peek_port avm_nonblocking_master_port avm_nonblocking_peek_port avm_nonblocking_put_port avm_nonblocking_slave_port avm_peek_port avm_put_port avm_slave_port avm_transport_port Interface tlm_blocking_master_if tlm_blocking_peek_if tlm_blocking_put_if tlm_blocking_slave_if tlm_get_if tlm_get_peek_if tlm_master_if tlm_nonblocking_get_if tlm_nonblocking_get_peek_if tlm_nonblocking_master_if tlm_nonblocking_peek_if tlm_nonblocking_put_if tlm_nonblocking_slave_if tlm_peek_if tlm_put_if tlm_slave_if tlm_transport_if
635
AVM Encyclopedia avm_analysis_port
avm_analysis_port
#(type T=int) extends avm_port_base #(analysis_if #(T)) avm_analysis_port is used by a component such as a monitor to publish a transaction to zero,
one, or more subscribers. Typically, it will be used inside a monitor to publish a transaction observed on a bus to scoreboards and coverage objects. file
tlm/avm_ports.svh
parameters
type T = int
The type of transaction to be written by the analysis port. members

typedef avm_port_base #(analysis_if #(T)) port_type
methods
function new(string name, avm_named_component parent) This is the standard AVM 3.0 constructor. parent should be null for analysis ports
defined in a static scope, e.g., in a module-based monitor.

virtual function void connect(port_type provider)
Used to connect an analysis port to another analysis port, an analysis export, or an analysis implementation; e.g., in a flat hierarchy, we will typically use monitor.ap.connect(coverage_object.analysis_export) to connect a monitor to a coverage object observing the transactions being emitted by the monitor.
function void register(analysis_if #(T) _if)
Provides backwards compatibility with AVM 2.0.

function void write(T t) Publishes transaction t
to all subscribers.
636
AVM Encyclopedia avm_blocking_master_imp
avm_blocking_master_imp
#(type REQ=int, type RSP=int, type IMP=int, type REQ_IMP=IMP, type RSP_IMP=IMP) extends avm_port_base #(tlm_blocking_master_if #(REQ, RSP))
A blocking master implementation allows a single or a pair of components that implement put(request), get(response), and peek(response) to export a single interface that allows a master to put requests and get or peek responses. file tlm/avm_imps.svh virtual no parameters
type REQ = int
Type of transactions to be sent out by this master.

type RSP = int
Type of transactions to be received by this master.

type IMP = int
Type of the parent of this implementation.

type REQ_IMP = IMP
Type of the object that implements the request side of the interface.
type RSP_IMP = IMP
Type of the object that implements the response side of the interface. internal members
local tlm_blocking_master_if #(REQ, RSP) m_if
Handle back to the blocking master implementation itself.

local REQ_IMP m_req_imp
Handle to the object that implements put(request), try_put(request) and can_put. By default, it is the parent of the nonblocking master implementation.
local RSP_IMP m_rsp_imp
Handle to the object that implements get(response), try_get(request), can_get, peek(response), try_peek(response), and can_peek. By default, it is the parent of the nonblocking master implementation. methods
637
AVM Encyclopedia avm_blocking_master_imp function new(string name, IMP imp, REQ_IMP req_imp=imp, RSP_IMP rsp_imp=imp) name is the normal first argument to an AVM 3.0 constructor. imp
is a slightly different form for the second argument to the AVM 3.0 constructor, which is of type IMP and defines the type of the parent. req_imp and rsp_imp are optional. If they are specified, then they must point to the underlying implementation of the request and response methods; e.g., in tlm_req_rsp_channel (see page 665), req_imp and rsp_imp are the request and response FIFOs.
task put(input REQ req) task get(output RSP rsp) task peek(output RSP rsp)
See the documentation for tlm_blocking_master_if (see page 674) for a description of these methods.
638
AVM Encyclopedia avm_blocking_slave_imp
avm_blocking_slave_imp
#(type REQ=int, type RSP=int, type IMP=int, type REQ_IMP=IMP, type RSP_IMP=IMP) extends avm_port_base #(tlm_blocking_slave_if #(REQ, RSP))
A blocking slave implementation allows a single or a pair of components that implement put(response), get(request), and peek(request) to export a single interface that allows a slave to get or peek requests and put responses. file tlm/avm_imps.svh virtual no parameters
type REQ = int
Type of transactions to be received by this slave.

type RSP = int

type IMP = int

type REQ_IMP = IMP
type RSP_IMP = IMP
local tlm_blocking_slave_if #(REQ, RSP) m_if
Handle back to the nonblocking slave implementation itself.

Handle to the object that implements get(request), can_get, peek(response), and can_peek. By default, it is the parent of the blocking master implementation.
Handle to the object that implements put(response) and can_put. By default, it is the parent of the blocking master implementation. methods
function new(string name, IMP imp, REQ_IMP req_imp=imp, RSP_IMP rsp_imp=imp)
639
AVM Encyclopedia avm_blocking_slave_imp
is the normal first argument to an AVM 3.0 constructor. imp is a slightly different form for the second argument to the AVM 3.0 constructor, which is of type IMP and defines the type of the parent. req_imp and rsp_imp are optional. If they are specified, then they must point to the underlying implementation of the request and response methods; e.g., in tlm_req_rsp_channel (see page 665), req_imp and rsp_imp are the request and response FIFOs.
name task put(input RSP rsp) task get(output REQ req) task peek(output REQ req)
See the documentation for tlm_blocking_slave_if (see page 675) for a description of these methods.
640
AVM Encyclopedia avm_connector_base
avm_connector_base
#(type IF=int) extends avm_named_component avm_connector_base does all the work for ports, exports and implementations. A port, export, or implementation has a handle to a corresponding avm_connector_base and delegates most of the hard work to it. avm_connector_base actually does the connection between one connector
and another (including all the checking), and it provides the implementation of the debugging methods. Because it is an avm_named_component (unlike the port, export, and imp classes that delegate to it) it appears in the AVM data structures and implements various utility methods that are virtual in avm_named_component. file
vbase/avm_connector_base.svh
enums
typedef enum {AVM_PORT, AVM_EXPORT, AVM_IMPLEMENTATION} avm_port_type_e
Lists the types of connectors allowed in the AVM.

typedef enum {AVM_CONSTRUCTION_PHASE, AVM_EXPORT_CONNECTIONS_PHASE, AVM_CONNECT_PHASE, AVM_IMPORT_CONNECTIONS_PHASE, AVM_DONE_CONNECTIONS_PHASE} avm_connection_phase_e Lists the phases executed during the elaboration of an avm_env.
virtual
no
parameters
type IF = int
A placeholder for the type of interface being required or provided by this connector. internal members
typedef avm_connector_base #(IF) connector_type local IF m_if_list[$]
Holds the interfaces that (should) satisfy the connectivity requirements of this connector. At the end of elaboration, an error will be reported if the size of this list is not between m_min_size and m_max_size (inclusive).
local int m_max_size
The maximum number of interfaces that this connector can have at the end of elaboration. This value is checked during elaboration.
local int m_min_size
641
The minimum number of interfaces that this connector can have at the end of elaboration. This value is checked at the end of elaboration.
local avm_port_type_e m_port_type
Indicates whether this connector is a port, export, or implementation.

local avm_connector_base #(IF) m_provided_by[string]
An associative array of connector bases that have supplied their interfaces to satisfy the connectivity requirements of this avm_connector_base. It is indexed by the name of the connector to make debugging easier. All the interfaces of the avm_connector_bases in this.m_provided_by are copied into this.m_if_list.
local avm_connector_base #(IF) m_provided_to[string] An associative array of avm_connector_bases to which this
connector base has supplied its interfaces. It is indexed by the name of the connector to make debugging easier. All the interfaces of the avm_connector_bases in this.m_if_list are copied into this.m_provided_to.
methods
function new(string name, avm_named_component parent, avm_port_type_e port_type, int min_size, int max_size, bit check_parent)
This is the constructor. The first two arguments are the standard AVM 3.0 constructor arguments. The port_type tells us whether this connector_base is a port, an export, or an implementation. min_size and max_size are the minimum and maximum number of interfaces that must be present at the end of elaboration. check_parent is also a standard AVM 3.0 constructor argument, which is used to indicate whether hierarchy checking should happen. For connectors, it is typically only used for analysis_ports in modules, which have no parent.
function bit add_if(IF _if)
Used to connect AVM 3.0 connectors to AVM 2.0 exports and implementations. It simply copies in _if to this connectors interface list without updating the provided_by and provided_to lists.
function void check_connection_size()
Checks the minimum connection size. The maximum connection size is checked as interfaces are added.
local virtual function void add_to_debug_list() Puts this avm_connector_bases handle into the relevant
associative array in its
parent. This method is purely for debugging purposes.

function void check_min_connection_size()
Checks that the minimum size for this connector has not been violated. It is called when an export or implementation supplies its interfaces to a port or export, and it is also called on every connector at the end of elaboration.
function bit check_phase(connector_type provider)
642
Checks that legal connections are being made in the correct phase. Port->port connections must be done in import_connections(), port->export and port->imp must be done in connect(), and export->export and export->imp must be done in export_connections(). Anything else is an error.
function bit check_relationship(connector_type provider)
Checks that legal connections in the correct phase do not violate the required parentchild relationships. Connections made in import_connections must be of the type child.port.connect(port); those made in connect must be of the form child.port.connect(child.export); and those done in export_connections must be of the form export.connect(child.export);
function bit check_types(connector_type provider)
Checks that only legal types are being connected. These are port -> port, port->export, export->export, and export->imp. Exports cannot connect to ports, and imps cannot connect to anything.
function bit connect_to(input connector_type c) Copies the interfaces provided by c into this connector base. It also checks the minimum connection size of c and updates this connectors provided_by list and cs provided_to list. function void debug_connected_to(int level=0, int max_level=-1)
A debugging method that looks forward at the connections made that satisfy this connectors requirements. It is recursive to the depth specified by max_level. The default value of -1 means that the recursion continues until it hits an implementation, at which point it can follow the provided_by connections no further. It can be useful to call this method in avm_named_component::end_of_elaboration.
function void debug_provided_to(int level=0, int max_level=-1)
A debugging method that looks backwards at the connectors whose requirements are satisfied by this connector. It is recursive to the depth specified by max_level. The default value of -1 means that the recursion continues until it hits a leaf level port, at which point it can follow the provided_to connections no further. It can be useful to call this method in avm_named_component::end_of_elaboration.
function void do_display(int max_level=-1, int level=0, bit display_connectors=0) A recursive virtual method originally defined in avm_named_component. It prints a high verbosity message if display_connectors is true. Otherwise, it does nothing. function IF lookup_indexed_if(int i=0) Looks up the ith interface supplied to this connector. It is typically used to access the
various interfaces bound to a multiport.

function int max_size()
Returns the maximum number of connected interfaces.

function int min_size()
Returns the minimum number of connected interfaces.

function int size()
643
Returns the number of connected interfaces (i.e., the number of elements in the m_if_list).
function void update_connection_lists(input connector_type c) Updates this connectors provided_by list and cs provided_to list.
internal methods
local function avm_connection_phase_e get_required_phase(avm_port_type_e provider_port_type) Gets the current phase of the elaborator in the avm_env within which
this connector
is defined.
644
AVM Encyclopedia avm_master_imp
avm_master_imp
#(type REQ=int, type RSP=int, type IMP=int, type REQ_IMP=IMP, type RSP_IMP=IMP) extends avm_port_base #(tlm_master_if #(REQ, RSP))
A master implementation allows a single or pair of components that implement put(request), try_put(request), can_put, get(response), try_get(response), can_get, peek(response), try_peek(request), and can_peek to export a single interface that allows a master to put requests and get or peek responses in both blocking and nonblocking flavors. file tlm/avm_imps.svh virtual no parameters
type REQ = int

type RSP = int

type IMP = int

type REQ_IMP = IMP
type RSP_IMP = IMP
local tlm_master_if #(REQ, RSP) m_if
Handle back to the master implementation itself.

Handle to the object that implements put(request), try_put(request), and can_put. By default, it is the parent of the master implementation.
Handle to the object that implements get(response), try_get(request), can_get, peek(response), try_peek(response), and can_peek. By default, it is the parent of the master implementation. methods
645
AVM Encyclopedia avm_master_imp
is the normal first argument to an AVM 3.0 constructor. imp is a slightly different form for a second argument to the AVM 3.0 constructor, which is of type IMP and defines the type of the parent. req_imp and rsp_imp are optional. If they are specified, then they must point to the underlying implementation of the request and response methods; e.g., in tlm_req_rsp_channel (see page 665), req_imp and rsp_imp are the request and response FIFOs.
name task put(input REQ req) function bit try_put(input REQ req) function bit can_put() task get(output RSP rsp) function bit try_get(output RSP rsp) function bit can_get() task peek(output RSP rsp) function bit try_peek(output RSP rsp) function bit can_peek() See the documentation of tlm_master_if
(see page 679) for a description of these
methods.
646
AVM Encyclopedia avm_nonblocking_master_imp
avm_nonblocking_master_imp
#(type REQ=int, type RSP=int, type IMP=int, type REQ_IMP=IMP, type RSP_IMP=IMP) extends avm_port_base #(tlm_nonblocking_master_if #(REQ, RSP))
A nonblocking master implementation allows a single or pair of components that implement try_put(request), can_put, try_get(response), can_get, try_peek(response), and can_peek to export a single interface that allows a master to put requests and get or peek responses. file tlm/avm_imps.svh virtual no parameters
type REQ = int

type RSP = int

type IMP = int

type REQ_IMP = IMP
type RSP_IMP = IMP
local tlm_nonblocking_master_if #(REQ, RSP) m_if
Handle back to the nonblocking master implementation itself.

Handle to the object that implements try_put(request) and can_put. By default, it is the parent of the nonblocking master implementation.
Handle to the object that implements try_get(response), can_get, try_peek(response), and can_peek. By default, it is the parent of the nonblocking master implementation. methods
function new(string name, IMP imp,
647
AVM Encyclopedia avm_nonblocking_master_imp REQ_IMP req_imp=imp, RSP_IMP rsp_imp=imp)
name function function function function function function bit bit bit bit bit bit try_put(input REQ req) can_put() try_get(output RSP rsp) can_get() try_peek(output RSP rsp) can_peek() documentation for tlm_nonblocking_master_if
See the description of these methods.
(see page 683) for a
648
AVM Encyclopedia avm_nonblocking_slave_imp
avm_nonblocking_slave_imp
#(type REQ=int, type RSP=int, type IMP=int, type REQ_IMP=IMP, type RSP_IMP=IMP) extends avm_port_base #(tlm_nonblocking_slave_if #(REQ, RSP))
A nonblocking slave implementation allows a single or pair of components that implement try_put(response), can_put, try_get(request), can_get, try_peek(request), and can_peek to export a single interface that allows a slave to get or peek requests and put responses. file tlm/avm_imps.svh virtual no parameters
type REQ = int

type RSP = int

type IMP = int

type REQ_IMP = IMP
type RSP_IMP = IMP
local tlm_nonblocking_slave_if #(REQ, RSP) m_if
Handle back to the nonblocking slave implementation itself.

Handle to the object that implements try_get(request), can_get, try_peek(request), and can_peek. By default, it is the parent of the nonblocking slave implementation.
Handle to the object that implements try_put(response) and can_put. By default, it is the parent of the nonblocking slave implementation. methods
function new(string name, IMP imp,
649
AVM Encyclopedia avm_nonblocking_slave_imp REQ_IMP req_imp=imp, RSP_IMP rsp_imp=imp)
name function function function function function function bit bit bit bit bit bit try_put(input RSP rsp) can_put() try_get(output REQ req) can_get() try_peek(output REQ req) can_peek() documentation for tlm_nonblocking_slave_if
See the description of these methods.
(see page 687) for a
650
AVM Encyclopedia avm_port_base
avm_port_base
#(type IF=avm_virtual_class) extends IF avm_port_base is the base class for all ports, exports, and implementations (avm_*_port, avm_*_export, and avm_*_imp). avm_port_base extends IF, which is the type of the interface
required and/or provided by the port, export, or implementation. In many senses, avm_port_base is a facade class. It has a handle to an avm_connector_base and delegates much of the functionality to it. file
vbase/avm_port_base.svh
virtual
yes
parameters
type IF = avm_virtual_class
A placeholder for the type of interface supported by this connector. The default value, avm_virtual_class, is a virtual class defined in vbase/avm_vbase.svh. Because it is virtual, a specific interface class (see TLM Interfaces on page 668) must be provided when extending the avm_port_base. members
typedef avm_connector_base #(IF) connector_type typedef avm_port_base #(IF) this_type avm_connector_base #(IF) m_connector
The place where most of the hard work related to checking the validity of the connection, making the connection, and providing debugging information is done. Many of the methods below are delegated to m_connector.
protected IF m_if
A handle to the 0th interface that has been connected to this port, export, or implementation. methods
function new(string name, avm_named_component parent, avm_port_type_e port_type, int min_size=1, int max_size=1, bit check_parent=1)
The first two arguments are the normal AVM 3.0 constructor arguments. The port_type is port, export, or implementation. min_size and max_size specify the minimum and maximum number of interfaces that must be supplied to this port base by the end of elaboration. parent is usually non null, in which case, check_parent should take its default value of 1. The rare exception to this (usually, analysis ports
651
AVM Encyclopedia avm_port_base
defined outside of an avm_env) should set the value of parent to null and check_parent to 0.
function void connect(this_type provider)
Connects a port or export that requires interfaces of type IF to a port, export, or implementation that provides interfaces of type IF.
function void connect_to_if(IF _if)
Connects directly to an interface by delegating the call to m_connector. The main use for this method is to enable backward compatibility with AVM 2.0.
function void debug_connected_to(int level=0, int max_level=-1)
Prints out information on the connectors that have supplied interfaces to this connector, by delegating the call to m_connector.
function void debug_provided_to(int level=0, int max_level=-1)
Prints out information on the connectors that this connector has supplied interfaces to, by delegating the call to m_connector.
function IF lookup_indexed_if(int i=0) Gets the ith interface that has been provided
to this port base, by delegating the call
to m_connector.
function void remove()
Delegates the method call to m_connector.

function int size()
Gets the number of interfaces that have been provided to this port base by delegating the call to m_connector.
652
AVM Encyclopedia avm_slave_imp
avm_slave_imp
#(type REQ=int, type RSP=int, type IMP=int, type REQ_IMP=IMP, type RSP_IMP=IMP) extends avm_port_base #(tlm_slave_if #(REQ, RSP))
A slave implementation allows a single or pair of components that implement put(response), try_put(response), can_put, get(request), try_get(request), can_get, peek(request), try_peek(request), and can_peek to export a single interface that allows a slave to get or peek requests and put responses. file tlm/avm_imps.svh virtual no parameters
type REQ = int

type RSP = int

type IMP = int

type REQ_IMP = IMP
type RSP_IMP = IMP
local tlm_slave_if #(REQ, RSP) m_if
Handle back to the slave implementation itself.

Handle to the object that implements get(request), try_get(request), can_get, peek(request), try_peek(request), and can_peek. By default, it is the parent of the slave implementation.
Handle to the object that implements put(response), try_put(response), and can_put. By default, it is the parent of the slave implementation. methods
653
AVM Encyclopedia avm_slave_imp
is the normal first argument to an AVM 3.0 constructor. imp is a slightly different form for the second argument to the AVM 3.0 constructor, which is of type IMP and defines the type of the parent. req_imp and rsp_imp are optional. If they are specified, then they must point to the underlying implementation of the request and response methods; e.g., in tlm_req_rsp_channel (see page 665). req_imp and rsp_imp are the request and response FIFOs.
name task put(input RSP rsp) function bit try_put(input RSP rsp) function bit can_put() task get(output REQ req) function bit try_get(output REQ req) function bit can_get() task peek(output REQ req) function bit try_peek(output REQ req) function bit can_peek() See the documentation for tlm_slave_if
(see page 691) for a description of these
methods.
654
AVM Encyclopedia avm_transport_imp
avm_transport_imp
#(type REQ=int, type RSP=int, type IMP=int) extends avm_port_base #(tlm_transport_if #(REQ, RSP))
A transport implementation allows a component that implements the transport task to export a tlm_transport_if. file
tlm/avm_imps.svh
virtual
no
parameters
type REQ = int

type RSP = int

type IMP = int
Type of the parent of this implementation. internal members

local tlm_transport_if #(REQ, RSP) m_if Handle back to the avm_transport_imp itself. local IMP m_imp
Handle to the component that implements the transport task. methods

function new(string name, IMP imp) name is the normal first argument to
an AVM 3.0 constructor. imp is a slightly different form for the second argument to the AVM 3.0 constructor, which is of type IMP and defines the type of the parent.
task transport(input REQ request, output RSP response) Delegates the call to m_imp.transport().
655
AVM Encyclopedia analysis_imp
analysis_imp
#(type IMP=virtual_class, type T=int) extends analysis_if #(T)
[Deprecated in AVM-3.0. Use avm_analysis_imp instead.] file

deprecated/tlm_imps.svh
virtual
no
members
local IMP m_imp function new(IMP i)
methods
function void write(input T t)
656
AVM Encyclopedia analysis_port
analysis_port
#(type T=int) extends analysis_if #(T)
[Deprecated in AVM-3.0. Use avm_analysis_port instead.] file

deprecated/analysis_port.svh
virtual
no
parameters
type T = int
members
local analysis_if #(T) if_list[$] local avm_reporter r
methods
function new() function void register(input analysis_if #(T) i) function void write(input T t)
657
AVM Encyclopedia global_analysis_ports
global_analysis_ports
#(type T=int)
This is deprecated in AVM 3.0. Instead, use a normal avm_analysis_port and the absolute and relative look-up methods in avm_named_component. file
deprecated/avm_global_analysis_ports.svh
virtual
no
members
static analysis_port #(T) s_analysis_ports[string]
methods
static function analysis_port #(T) get_analysis_port(string name)
658
AVM Encyclopedia tlm_*_imp
tlm_*_imp
Table 3-5 lists the tlm_*_imp deprecated in AVM 3.0
Table 3-5. Deprecated Implementations Implementation tlm_blocking_get_imp tlm_blocking_get_peek_imp tlm_blocking_master_imp tlm_blocking_peek_imp tlm_blocking_put_imp tlm_blocking_slave_imp tlm_get_imp tlm_get_peek_imp tlm_master_imp tlm_nonblocking_get_imp tlm_nonblocking_get_peek_imp tlm_nonblocking_master_imp tlm_nonblocking_peek_imp tlm_nonblocking_put_imp tlm_nonblocking_slave_imp tlm_peek_imp tlm_put_imp tlm_slave_imp tlm_transport_imp Interface tlm_blocking_get_if tlm_blocking_get_peek_if tlm_blocking_master_if tlm_blocking_peek_if tlm_blocking_put_if tlm_blocking_slave_if tlm_get_if tlm_get_peek_if tlm_master_if tlm_nonblocking_get_if tlm_nonblocking_get_peek_if tlm_nonblocking_master_if tlm_nonblocking_peek_if tlm_nonblocking_put_if tlm_nonblocking_slave_if tlm_peek_if tlm_put_if tlm_slave_if tlm_transport_if
Classes for Channels

The AVM supplies a FIFO channel and a variety of interfaces to access it. The interfaces have both blocking and nonblocking forms. Because SystemVerilog does not support multiple inheritance, the FIFO has a collection of imps implementations of abstract interfaces that are
659
AVM Encyclopedia Classes for Channels
used to access the FIFO. The FIFO is a named component and thus has a name and a location in the component hierarchy.
Figure 3-4. UML Diagram for Channels
660
AVM Encyclopedia analysis_fifo
analysis_fifo
#(type T=int) extends tlm_fifo #(T)
An analysis_fifo is a tlm_fifo with an unbounded size and a write() interface. It can be used any place an avm_subscriber is used. Typical usage is as a buffer between an analysis_port in a monitor and an analysis component (i.e., a component derived from avm_subscriber). file:
tlm/tlm_fifos.svh
virtual
no
parameters
type T = int
Type of transactions to be stored in the FIFO. members

avm_analysis_imp #(T, analysis_fifo #(T)) analysis_export analysis_export provides the write method to other components. Calling ap.write(t) on a port bound to this export is the normal mechanism for writing
to
an analysis FIFO. methods

function new(string name, avm_named_component parent=null) This is the standard AVM 3.0 avm_named_component constructor. name is the local name of this component. parent should be left unspecified when this component is
instantiated in statically elaborated constructs and must be specified when this component is a child of another AVM component.
function void write(input T t) Transfers transaction t into the
unbounded FIFO, which is guaranteed to succeed.
661
AVM Encyclopedia tlm_fifo
tlm_fifo
#(type T=int) extends avm_named_component tlm_fifo is a FIFO that implements all the unidirectional
TLM interfaces.
file
tlm/tlm_fifos.svh
virtual
no
parameters
type T = int
Type of transactions to be stored in the FIFO. members

typedef tlm_fifo #(T) this_type avm_blocking_get_imp #(T, this_type) blocking_get_export avm_blocking_get_peek_imp #(T, this_type) blocking_get_peek_export avm_blocking_peek_imp #(T, this_type) blocking_peek_export avm_blocking_put_imp #(T, this_type) blocking_put_export avm_get_imp #(T, this_type) get_export avm_get_peek_imp #(T, this_type) get_peek_export avm_nonblocking_get_imp #(T, this_type) nonblocking_get_export avm_nonblocking_get_peek_imp #(T, this_type) nonblocking_get_peek_export avm_nonblocking_peek_imp #(T, this_type) nonblocking_peek_export avm_nonblocking_put_imp #(T, this_type) nonblocking_put_export avm_peek_imp #(T, this_type) peek_export avm_put_imp #(T, this_type) put_export
The implementations above export the relevant TLM interface. Every unidirectional TLM interface is implemented in tlm_fifo and exported using an appropriately named export.
avm_analysis_port #(T) put_ap
Analysis port to which the transaction is published whenever put() or try_put() succeeds.
analysis_port #(T) get_ap
Analysis port to which the transaction is published whenever get(), try_get(), peek(), or try_peek() succeeds.
local mailbox #(T) m
The internal mailbox used to implement the basic FIFO functionality.

local int m_size m_size is the
maximum size of the FIFO. A value of zero indicates no upper bound.
662
internal members
local int m_pending_blocked_gets Used to calculate the result of can_get().
It should not be accessed by normal user
code. methods
function new(string name, avm_named_component parent=null, int size=1) name and parent are the normal AVM 3.0 constructor arguments. parent should be null if the tlm_fifo is going to be used in a statically elaborated construct. If it is defined within an avm_env, parent must be specified. size indicates the maximum
size of the FIFO; a value of zero indicates no upper bound.

function bit can_get() can_get() returns 1
if try_get() will be successful, and it returns 0 otherwise. if try_peek() will be successful, and it returns 0 otherwise.
function bit can_peek() can_peek() returns 1 function bit can_put() can_put() returns 1 function void flush() flush() flushes the task get(output T t) Does a blocking get
if try_put() will be successful, and it returns 0 otherwise. FIFO.
and then publishes the gotten transaction using get_ap. Succeeds when there is something in the FIFO available to be gotten. get() is consuming. When it succeeds, t is no longer in the FIFO. and then publishes the peeked transaction using get_ap. Succeeds when there is something in the FIFO available to be peeked. peek() is not consuming. When it succeeds, t is still in the FIFO. Inserts transaction t to the internal mailbox and publishes the transaction to the put_ap when it is successful. Succeeds when there is room in the FIFO.
task peek(output T t) Does a blocking peek()
task put(input T t)
function int size() This returns m_size. function bit try_get(output T t)
Will get a transaction from the FIFO. If the FIFO contains a transaction, then it publishes the transaction across get_ap and returns 1. Otherwise, it returns 0. try_get() is consuming. When it succeeds, t is no longer in the FIFO.
function bit try_peek(output T t)
663
Will get a transaction from the FIFO if it contains a transaction, then it publishes the transaction across get_ap and returns 1. Otherwise, it returns 0. peek() is not consuming. When it succeeds, t is still in the FIFO.
function bit try_put(input T t) Will put t into the FIFO if there is room, then publish the transaction across put_ap
and return 1. Otherwise, it returns 0.
664
AVM Encyclopedia tlm_req_rsp_channel
tlm_req_rsp_channel
#(type REQ=int, type RSP=int) extends avm_named_component tlm_req_rsp_channel contains a request
FIFO of type REQ and a response FIFO of type RSP. These FIFOs can be of any size. This channel is particularly useful for dealing with pipelined protocols where the request and response are not tightly coupled.
file
tlm/tlm_req_rsp.svh
virtual
no
parameters
type REQ = int
Type of transactions to be passed to/from the request FIFO.

type RSP = int
Type of transactions to be passed to/from the response FIFO. members

typedef tlm_req_rsp_channel #(REQ, RSP) this_type protected tlm_fifo #(REQ) m_request_fifo
The internal FIFO that stores the REQs.

protected tlm_fifo #(RSP) m_response_fifo
The internal FIFO that stores the RSPs.

avm_blocking_put_export #(REQ) blocking_put_request_export avm_nonblocking_put_export #(REQ) nonblocking_put_request_export avm_put_export #(REQ) put_request_export
The exports make the put, blocking put, and nonblocking put interfaces of the request FIFO externally visible. Through these interfaces, a master can put requests into the request FIFO.
avm_blocking_get_peek_export #(REQ) blocking_get_peek_request_export avm_blocking_get_export #(REQ) blocking_get_request_export avm_blocking_peek_export #(REQ) blocking_peek_request_export avm_get_peek_export #(REQ) get_peek_request_export avm_get_export #(REQ) get_request_export avm_nonblocking_get_peek_export #(REQ) nonblocking_get_peek_request_export avm_nonblocking_get_export #(REQ) nonblocking_get_request_export avm_nonblocking_peek_export #(REQ) nonblocking_peek_request_export avm_peek_export #(REQ) peek_request_export
665
These nine request get exports export the blocking, nonblocking, and combined get, peek, and get_peek interfaces of the request FIFO. These allow slaves to get or peek requests from the request FIFO.
avm_blocking_put_export #(RSP) blocking_put_response_export avm_nonblocking_put_export #(RSP) nonblocking_put_response_export avm_put_export #(RSP) put_response_export
These three response put exports export the put, blocking put, and nonblocking put interfaces of the response FIFO. These allow a slave to put responses into the response FIFO.
avm_blocking_get_peek_export #(RSP) blocking_get_peek_response_export avm_blocking_get_export #(RSP) blocking_get_response_export avm_blocking_peek_export #(RSP) blocking_peek_response_export avm_get_peek_export #(RSP) get_peek_response_export avm_get_export #(RSP) get_response_export avm_nonblocking_get_peek_export #(RSP) nonblocking_get_peek_response_export avm_nonblocking_get_export #(RSP) nonblocking_get_response_export avm_nonblocking_peek_export #(RSP) nonblocking_peek_response_export avm_peek_export #(RSP) peek_response_export
These nine response get exports export the blocking, nonblocking, and combined get, peek and get_peek interfaces of the request FIFO. These allow masters to get or peek responses from the response FIFO.
avm_analysis_port #(RSP) response_ap response_ap publishes an RSP whenever
a put() or try_put() to the response
FIFO succeeds.
avm_analysis_port #(REQ) request_ap Publishes a REQ whenever a put() or try_put()
to the request FIFO succeeds.
avm_master_imp #(REQ, RSP, this_type, tlm_fifo #(REQ), tlm_fifo #(RSP)) master_export
Exports a single interface that allows a master to put requests and get or peek responses.
avm_slave_imp #(REQ, RSP, this_type tlm_fifo #(REQ), tlm_fifo #(RSP)) slave_export
Exports a single interface that allows a slave to get or peek requests and put responses.
avm_blocking_master_imp #(REQ, RSP, this_type, tlm_fifo #(REQ), tlm_fifo #(RSP)) blocking_master_export
Exports a single blocking interface that allows a master to put requests and get or peek responses.
avm_blocking_slave_imp #(REQ, RSP, this_type, tlm_fifo #(REQ), tlm_fifo #(RSP)) blocking_slave_export
666
Exports a single blocking interface that allows a slave to get or peek requests and put responses.
avm_nonblocking_master_imp #(REQ, RSP, this_type, tlm_fifo #(REQ), tlm_fifo #(RSP)) nonblocking_master_export
Exports a single nonblocking interface that allows a master to put requests and get or peek responses.
avm_nonblocking_slave_imp #(REQ, RSP, this_type, tlm_fifo #(REQ), tlm_fifo #(RSP)) nonblocking_slave_export
Exports a single nonblocking interface that allows a slave to get or peek requests and put responses. methods
function new(string name, avm_named_component parent=null, int request_fifo_size=1, int response_fifo_size = 1) name and parent are the standard AVM 3.0 constructor arguments. parent must be null if this component is defined within a static component such as a module,
program block, or interface, and it must take a non value if it is defined inside an avm_env. The last two arguments specify the request and response FIFO sizes, which have default values of one. internal methods:
function void create_master_slave_exports()
Creates the bidirectional exports for both master and slave.

function void create_response_exports()
Creates the unidirectional request exports for both master and slave.
function void export_response_connections()
Connects the response FIFO to the appropriate exports.

function void export_request_connections()
Connects the request FIFO to the appropriate exports.
667
AVM Encyclopedia tlm_transport_channel
tlm_transport_channel
#(type REQ=int, type RSP=int) extends tlm_req_rsp_channel #(REQ, RSP) A tlm_transport_channel is a tlm_req_rsp_channel
that implements the transport interface. It is useful when modeling a nonpipelined bus at the transaction level. Because the requests and responses have a tightly coupled one-to-one relationship, the request and response FIFO sizes must be one. file
tlm/tlm_req_rsp.svh
virtual
no
parameters
type REQ = int
Type of transactions to be passed to/from the request FIFO.

type RSP = int
Type of transactions to be passed to/from the response FIFO. members

typedef tlm_transport_channel #(REQ, RSP) this_type avm_transport_imp #(REQ, RSP, this_type) transport_export
The mechanism by which external components gain access to the transport() task. methods
function new(string name, avm_named_component parent=null) name and parent are the standard AVM 3.0 constructor arguments. parent must be null if this component is defined within a statically elaborated construct such as a
module, program block, or interface, and it must take a non-null value if it is defined inside an avm_env.
task transport(input REQ request, output RSP response) Calls put(request) followed by get(response).
TLM Interfaces
The TLM interfaces are a collection of pure virtual classes that define the way transaction objects move between components. Each interface class supplies a set of one or more tasks and function prototypes. Interface implementations (imps), ports, exports, and channels use the TLM interfaces to define the set of functions and tasks that each needs to implement.
668
AVM Encyclopedia analysis_if #(type T=int)
analysis_if #(type
file tlm/tlm_ifs.svh
T=int)
The analysis interface is a nonblocking, non-negotiable, unidirectional interface. It is typically used to transfer a transaction from a monitor, which cannot block, to a scoreboard or coverage object. virtual
yes
parameters
type T = int
Type of transactions to be handled by this interface. members

<none>
methods Pure virtual methods must have an implementation specified in a subclass.

pure virtual function void write(input T t) Takes transaction t, operates on it (e.g., copies
it, records values for functional coverage, etc.) in some nonblocking way and returns immediately.
669
AVM Encyclopedia tlm_blocking_get_if
tlm_blocking_get_if
#(type T=int)
The blocking get interface file

tlm/tlm_ifs.svh
virtual
yes
parameters
type T = int

<none>

pure virtual task get( output T t )
Blocks until the callee is able to supply a transaction t. This is a consuming method, so subsequent calls to get() return a different transaction (or a new copy of the same transaction).
670
AVM Encyclopedia tlm_blocking_get_peek_if
tlm_blocking_get_peek_if
#(type T=int)
The blocking get interface file

tlm/tlm_ifs.svh
virtual
yes
parameters
type T = int

<none>

pure virtual task get( output T t )
pure virtual task peek( output T t )
Blocks until the callee is able to supply a transaction. This is a nonconsuming method, so subsequent calls to peek() or the next call to get() return the same transaction.
671
AVM Encyclopedia tlm_blocking_peek_if
tlm_blocking_peek_if
#(type T=int)
The blocking peek interface file

tlm/tlm_ifs.svh
virtual
yes
parameters
type T = int

<none>

pure virtual task peek( output T t )
672
AVM Encyclopedia tlm_blocking_put_if
tlm_blocking_put_if
#(type T=int)
The blocking put interface file

tlm/tlm_ifs.svh
virtual
yes
parameters
type T = int

<none>

pure virtual task put( input T t );
Blocks until the callee is able to accept a transaction.
673
AVM Encyclopedia tlm_blocking_master_if
tlm_blocking_master_if
#(type REQ = int, type RSP = int)
The blocking master interface file

tlm/tlm_ifs.svh
virtual
yes
parameters
type T = int

<none>

pure virtual task put( input REQ req )
Blocks until the callee is able to accept a request transaction.

pure virtual task get( output RSP rsp )
Blocks until the callee is able to supply a response transaction t. This is a consuming method, so subsequent calls to get() return a different transaction (or a new copy of the same transaction).
pure virtual task peek( output RSP rsp )
Blocks until the callee is able to supply a response transaction. This is a nonconsuming method, so subsequent calls to peek() or the next call to get() return the same transaction.
674
AVM Encyclopedia tlm_blocking_slave_if
tlm_blocking_slave_if
#(type T=int)
The blocking slave interface file

tlm/tlm_ifs.svh
virtual
yes
parameters
type T = int

<none>

pure virtual task put( RSP rsp )
Blocks until the callee is able to accept a response transaction.

pure virtual task get( output REQ req )
Blocks until the callee is able to supply a request transaction t. This is a consuming method, so subsequent calls to get() return a different transaction (or a new copy of the same transaction).
pure virtual task peek( output REQ req );
Blocks until the callee is able to supply a request transaction. This is a nonconsuming method, so subsequent calls to peek() or the next call to get() return the same transaction.
675
AVM Encyclopedia tlm_get_if
tlm_get_if
#(type T=int)
The get interface is a unidirectional consuming interface. It has both functions, which cannot block, and tasks, which may block. file
tlm/tlm_ifs.svh
virtual
yes
parameters
type T = int

<none>

pure virtual function bit can_get()
Returns 1 if a callee can supply a transaction and 0 otherwise. If no time elapses and nothing else happens to modify the state of the underlying component, then a subsequent call to get() or try_get() is guaranteed to succeed.
pure virtual task get(output T t)
pure virtual function bit try_get(output T t) Returns immediately and supplies a transaction t, if one is available. will return 1, otherwise will return 0 (and t will be undefined).
If successful,
676
AVM Encyclopedia tlm_get_peek_if
tlm_get_peek_if
#(type T=int)
The get peek interface is a unidirectional interface. It has both blocking tasks and nonblocking functions, and it has both consuming and nonconsuming methods. file
tlm/tlm_ifs.svh
virtual
yes
parameters
type T = int

<none>

Returns 1 if a callee can supply a transaction and 0 otherwise. If no time elapses and nothing else happens to modify the state of the underlying component, then a subsequent call to get(), try_get(), peek(), or try_peek() is guaranteed to succeed.
pure virtual function bit can_peek()
pure virtual task get(output T t)
pure virtual task peek(output T t)
pure virtual function bit try_get(output T t)
677
AVM Encyclopedia tlm_get_peek_if
Returns immediately and supplies a transaction t, if one is available. If successful, it returns 1 (and t will no longer be available). Otherwise, it returns 0 (and t will be undefined).
pure virtual function bit try_peek(output T t) Returns immediately and supplies a transaction t, if one is available. If successful, returns 1 (and t will still be available). Otherwise, it returns 0 (and t is undefined).
678
AVM Encyclopedia tlm_master_if
tlm_master_if
#(type REQ=int, type RSP=int)
The master interface is a bidirectional interface. It enables a master to put requests and get or peek responses. It contains both blocking and nonblocking methods. file
tlm/tlm_ifs.svh
virtual
yes
parameters
type REQ = int
Type of transactions to be handled on the put side.

type RSP = int
Type of transactions to be handled on the get/peek side. members

<none>

Returns 1 if a callee can supply a response transaction and 0 otherwise. If no time elapses and nothing else happens to modify the state of the underlying component, then a subsequent call to get(), try_get(), peek(), or try_peek() is guaranteed to succeed.
pure virtual function bit can_put()
Returns 1 if the callee can accept a request and 0 otherwise. If no time elapses and nothing else happens to modify the state of the underlying component, then a subsequent call to put() is guaranteed to succeed.
pure virtual task get(output RSP rsp)
Blocks until the callee is able to supply a response transaction, rsp. This is a consuming method, so subsequent calls to get() return a different transaction (or a new copy of the same transaction).
679
AVM Encyclopedia tlm_master_if pure virtual task peek(output RSP rsp)
Blocks until the callee is able to supply a response transaction. This is a nonconsuming method, so subsequent calls to peek() or the next call to get() returns the same transaction.
pure virtual task put(REQ req)
Blocks until the callee is able to accept a request transaction, req.

pure virtual function bit try_get(output RSP rsp)
Returns immediately and supplies a response transaction rsp, if one is available. If successful, it returns 1 (and rsp will no longer be available). Otherwise, it returns 0 (and rsp will be undefined).
pure virtual function bit try_peek(output RSP rsp)
Returns immediately and supplies a response transaction rsp, if one is available. If successful, it returns 1 (and rsp will still be available). Otherwise, it returns 0 (and rsp will be undefined).
pure virtual function bit try_put(REQ req)
Returns immediately. If the callee can accept a request, it returns 1, otherwise, it returns 0.
680
AVM Encyclopedia tlm_nonblocking_get_if
tlm_nonblocking_get_if
#(type T=int)
The nonblocking get interface is a nonblocking, unidirectional, consuming interface. file

tlm/tlm_ifs.svh
virtual
yes
parameters
type T = int

<none>

pure virtual function bit try_get(output T t) Returns immediately and supplies a transaction t, if one is available. If successful, it returns 1. Otherwise, it returns 0 (and t will be undefined).
681
AVM Encyclopedia tlm_nonblocking_get_peek_if
tlm_nonblocking_get_peek_if
#(type T=int)
The nonblocking get peek interface is a nonblocking, unidirectional, interface. file

tlm/tlm_ifs.svh
virtual
yes
parameters
type T = int

<none>

Returns 1 if a callee can supply a transaction and 0 otherwise. If no time elapses and nothing else happens to modify the state of the underlying component, then a subsequent call to try_get() or try_peek() is guaranteed to succeed.
pure virtual function bit try_get(output T t) Returns immediately and supplies a transaction t, if one is available. If successful, it returns 1. Otherwise, it returns 0 (and t will be undefined). pure virtual function bit try_peek(output T t) Returns immediately and supplies a transaction t, if one is available. If successful, it returns 1 (and t will still be available). Otherwise, it returns 0 (and t will be
undefined).
682
AVM Encyclopedia tlm_nonblocking_master_if
tlm_nonblocking_master_if
The nonblocking master interface is a bidirectional interface. It enables a master to put requests and get or peek responses. file
tlm/tlm_ifs.svh
virtual
yes
parameters
type REQ = int
Type of transactions to be handled on the put side.

type RSP = int
Type of transactions to be handled on the get/peek side. members

<none>

Returns 1 if the callee can accept a request and 0 otherwise. If no time elapses and nothing else happens to modify the state of the underlying component, then a subsequent call to put() is guaranteed to succeed.
pure virtual function bit try_get(output RSP rsp)
Returns immediately and supplies a response transaction rsp, if one is available. If successful, it returns 1 (and rsp will no longer be available). Otherwise, it returns 0 (and rsp will be undefined).
683
AVM Encyclopedia tlm_nonblocking_master_if pure virtual function bit try_peek(output RSP rsp)
Returns immediately and supplies a response transaction rsp, if one is available. If successful, it returns 1 (and rsp will still be available). Otherwise, it returns 0 (and rsp will be undefined).
pure virtual function bit try_put(REQ req)
Returns immediately. If the callee can accept a request, it returns 1. Otherwise, it returns 0.
684
AVM Encyclopedia tlm_nonblocking_peek_if
tlm_nonblocking_peek_if
#(type T=int)
The nonblocking peek interface is a unidirectional, nonblocking, nonconsuming interface. file

tlm/tlm_ifs.svh
virtual
yes
parameters
type T = int

<none>

Returns 1 if a callee can supply a transaction and 0 otherwise. If no time elapses and nothing else happens to modify the state of the underlying component, then a subsequent call to try_get() or try_peek() is guaranteed to succeed.
pure virtual function bit try_peek(output T t) Returns immediately and supplies a transaction t, if one is available. If successful, it returns 1 (and t will still be available). Otherwise, it returns 0 (and t will be
undefined).
685
AVM Encyclopedia tlm_nonblocking_put_if
tlm_nonblocking_put_if
#(type T=int)
The nonblocking put interface is a unidirectional, nonblocking interface. file

tlm/tlm_ifs.svh
virtual
yes
parameters
type T = int

<none>

Returns 1 if the callee can accept a transaction and 0 otherwise. If no time elapses and nothing else happens to modify the state of the underlying component, then a subsequent call to try_put() is guaranteed to succeed.
pure virtual function bit try_put(T t)
Returns immediately. If the callee can accept a transaction, it returns 1. Otherwise, it returns 0.
686
AVM Encyclopedia tlm_nonblocking_slave_if
tlm_nonblocking_slave_if
The nonblocking slave interface is a bidirectional nonblocking interface. It allows a slave to get or peek requests and put responses. file
tlm/tlm_ifs.svh
virtual
yes
parameters
type REQ = int
Type of transactions to be handled on the get/peek side.

type RSP = int
Type of transactions to be handled on the put side. members

<none>

Returns 1 if a callee can supply a request transaction and 0 otherwise. If no time elapses and nothing else happens to modify the state of the underlying component, then a subsequent call to get(), try_get(), peek(), or try_peek() is guaranteed to succeed.
Returns 1 if the callee can accept a response and 0 otherwise. If no time elapses and nothing else happens to modify the state of the underlying component, then a subsequent call to put() is guaranteed to succeed.
pure virtual function bit try_get(output REQ req)
Returns immediately and supplies a request transaction req, if one is available. If successful, it returns 1 (and req will no longer be available). Otherwise, it returns 0 (and req is undefined).
687
AVM Encyclopedia tlm_nonblocking_slave_if pure virtual function bit try_peek(output REQ req)
Returns immediately and supplies a request transaction req, if one is available. If successful, it returns 1 (and req will still be available). Otherwise, it returns 0 (and req is undefined).
pure virtual function bit try_put(RSP rsp)
Returns immediately. If the callee can accept a response, it returns 1. Otherwise, it returns 0.
688
AVM Encyclopedia tlm_peek_if
tlm_peek_if
#(type T=int)
The peek interface is a unidirectional, nonconsuming interface. file

tlm/tlm_ifs.svh
virtual
yes
parameters
type T = int

<none>

pure virtual task peek(output T t)
pure virtual function bit try_peek(output T t) Returns immediately and supplies a transaction t, if one is available. If successful, it returns 1 (and t will still be available). Otherwise, it returns 0 (and t is undefined).
689
AVM Encyclopedia tlm_put_if
tlm_put_if
#(type T=int)
The put interface is a unidirectional interface. It contains both blocking tasks and nonblocking functions. file
tlm/tlm_ifs.svh
virtual
yes
parameters
type T = int

<none>

pure virtual task put(input T t) The put() task blocks until the callee pure virtual function bit can_put()
is able to accept a T.
Returns 1 if the callee can accept a transaction and 0 otherwise. If no time elapses and nothing else happens to modify the state of the underlying component, then a subsequent call to try_put() is guaranteed to succeed.
pure virtual function bit try_put(T t)
Returns immediately. If the callee can accept a transaction, it returns 1, otherwise, it returns 0.
pure virtual task put(T t)
Blocks until the callee is able to accept a transaction.
690
AVM Encyclopedia tlm_slave_if
tlm_slave_if
The slave interface is a bidirectional interface. It allows a slave to get or peek requests and put responses in either blocking or nonblocking forms. file
tlm/tlm_ifs.svh
virtual
yes
parameters
type REQ = int
Type of transactions to be handled on the get/peek side.

type RSP = int
Type of transactions to be handled on the put side. members

<none>

Returns 1 if the callee can accept a response and 0 otherwise. If no time elapses and nothing else happens to modify the state of the underlying component, then a subsequent call to put() is guaranteed to succeed.
pure virtual task get(output REQ req)
Blocks until the callee is able to supply a request transaction, req. This is a consuming method, so subsequent calls to get() return a different transaction (or a new copy of the same transaction).
691
AVM Encyclopedia tlm_slave_if pure virtual task peek(output REQ req)
Blocks until the callee is able to supply a request transaction. This is a nonconsuming method, so subsequent calls to peek() or the next call to get() return the same transaction.
pure virtual task put(RSP rsp)
Blocks until the callee is able to accept a response transaction, rsp.

pure virtual function bit try_get(output REQ req)
Returns immediately and supplies a request transaction req, if one is available. If successful, it returns 1 (and req will no longer be available). Otherwise, it returns 0 (and req will be undefined).
pure virtual function bit try_peek(output REQ req)
Returns immediately and supplies a request transaction req, if one is available. If successful, it returns 1 (and req will still be available). Otherwise, it returns 0 (and req will be undefined).
pure virtual function bit try_put(RSP rsp)
Returns immediately. If the callee can accept a response, it returns 1. Otherwise, it returns 0.
692
AVM Encyclopedia tlm_transport_if
tlm_transport_if
The transport interface is a bidirectional blocking interface. It is used when there is a tight oneto-one coupling between request and response, typically in the context of nonpipelined buses. file
tlm/tlm_ifs.svh
virtual
yes
parameters
type REQ = int
Type of transactions to be sent.

type RSP = int
Type of transactions to be received. members

<none>

pure virtual task transport(input REQ request, output RSP response)
Sends a request transaction to the callee and blocks until it obtains a response transaction back from the callee.
Transactions
693
AVM Encyclopedia avm_built_in_clone
avm_built_in_clone
#(type T=int)
This policy class is used to clone built-in types. It is used to build generic components that will work with either classes or built-in types. file
vbase/avm_policies.svh
virtual
no
parameters
type T = int
The return type of the clone() method. members

<none>
methods
static function T clone(input T from) Returns the value of from.
694
AVM Encyclopedia avm_built_in_comp
avm_built_in_comp
#(type T=int)
This policy class is used to compare built-in types. It is used to build generic components that work with either classes or built-in types. file
vbase/avm_policies.svh.
virtual
no
parameters
type T = int
The type of the items to be compared. members

<none>
methods
static function bit comp(input T a, input T b) Returns the value of a==b.
695
AVM Encyclopedia avm_built_in_converter
avm_built_in_converter
#(type T=int)
This policy class is used to convert built-in types to strings. It is used to build generic components that will work with either classes or built-in types. file vbase/avm_policies.svh virtual
no
parameters
type T = int
The type of the item to be converted. members

<none>
methods
static function string convert2string(input T t); Returns the value of t as a string.
696
AVM Encyclopedia avm_built_in_pair
avm_built_in_pair
#(type T1=int, type T2=T1) extends avm_transaction
This class represents a pair of built in types. file

utils/avm_pair.svh
virtual
no
parameters
type T1 = int
The type of the first element of the pair.

type T2 = T1
The type of the second element of the pair. By default, the two types are the same. members
typedef avm_built_in_pair #(T1, T2) this_type T1 first
The first element of the pair.

T2 second
The second element of the pair. methods

virtual function string convert2string() function bit comp(this_type t) function void copy(input this_type t) function avm_transaction clone() Since avm_built_in_pair is a transaction
class, it provides the four compulsory
methods as defined by AVM 3.0.
697
AVM Encyclopedia avm_class_clone
avm_class_clone
#(type T=int)
This policy class is used to clone classes. It is used to build generic components that work with either classes or built-in types. file
virtual
no
members
<none>
methods
static function avm_transaction clone(input T from) This method returns from.clone().
698
AVM Encyclopedia avm_class_comp
avm_class_comp
#(type T=int)
This policy class is used to compare classes. It is used to build generic components that work with either built-in types or classes. file
virtual
no
members
<none>
methods
static function bit comp(input T a, input T b) This method returns a.comp( b ).
699
AVM Encyclopedia avm_class_converter
avm_class_converter
#(type T=int)
This policy class is used to convert classes to strings. It is used to build generic components that work with either built-in types or classes. file
virtual
no
members
<none>
methods
static function string convert2string(input T t) This method returns t.convert2string().
700
AVM Encyclopedia avm_class_pair
avm_class_pair
#(type T1=int, type T2=T1) extends avm_transaction
This class represents a pair of classes. file

utils/avm_pairs.svh
virtual
no
members
typedef avm_class_pair #(T1, T2) this_type T1 first
This is the first element in the pair.

T2 second
This is the second element in the pair. methods

function new(input T1 f=null, input T2 s=null)
A constructor, with optional arguments for first and second. No cloning is performed for nondefault values.
function function function function string convert2string bit comp(this_type t) void copy(input this_type t) avm_transaction clone Since avm_built_in_pair is a transaction
class, it provides the four compulsory
methods as defined by AVM 3.0.
701
AVM Encyclopedia avm_transaction
avm_transaction
This is the base class for all AVM transactions. file
vbase/avm_transaction.svh
virtual
yes
members
<none>
methods
pure virtual function avm_transaction clone
This virtual method returns a handle to a clone of this transaction. Since it is virtual, the clone is deep in relation to the inheritance hierarchy, although it may be shallow or deep in relation to members of subclasses that are themselves handles.
pure virtual function string convert2string
This method converts the transaction into a string. Since it is virtual, it is also deep, in relation to the inheritance hierarchy. In addition to the two methods described above, any transaction T that is a subtype of avm_transaction must also define the following two methods.
function bit comp( input T t );
This function compares this transaction with t. It returns 1 if it is the same and 0 if they are different.
function void copy( input T t );
This function copies the contents of t into this transaction. It may be shallow or deep in relation to handles. It usually calls super.copy( t ) if T is not a direct base class of avm_transaction.
702
AVM Encyclopedia Reporting
Reporting
The reporting classes provide a facility for issuing reports with different severities and ids, and to different files. The primary interface to the reporting facility is avm_report_client.
Figure 3-5. UML Diagram for Reporting Classes
703
AVM Encyclopedia avm_report_client
avm_report_client
is a base class from which all components that want to use the AVM reporting facility must inherit. It provides methods to issue messages, change the action associated with these messages, associate files with messages, and execute hook methods as a result of these messages.
avm_report_client
All of the state information relating to actions and files associated with different types of messages is held in an avm_report_handler. Most of the methods in this class are delegated to a report handler, which in turn delegates the actual formatting and production of messages to a central avm_report_server. file
reporting/avm_report_client.svh
virtual
yes
members
protected avm_report_handler m_rh
Handle to a report handler, which stores all the state information about actions and files. It may be unique to this report client or shared with other clients.
local string m_report_name
The name of the report handler. This name is printed out at the beginning of each message. methods
function new(string name="")
The constructor requires a name, and creates a new report handler that is unique to this client.
function void avm_report_error(string id, string message, int verbosity_level=100, string filename=, int line=0)
One of the four core reporting methods, it issues a report of severity ERROR. If the verbosity level of this report is higher than the maximum verbosity level of the report handler, this report is simply ignored. By default, a warning is displayed on the command line, logged in a file if one has been set, and counted. If the error count in any report handler exceeds its maximum quit count, then the die()method is called. The default verbosity level for an error is 100.
function void avm_report_fatal(string id, string message, int verbosity_level=0, string filename=, int line=0)
One of the four core reporting methods, it issues a report of severity FATAL. If the verbosity level of this report is higher than the maximum verbosity level of the
704
report handler, this report is simply ignored. By default, a fatal error is displayed on the command line, and then it calls the die() method. The default verbosity level for a fatal report is 0.
function void avm_report_message(string id, string message, int verbosity_level=300, string filename=, int line=0)
One of the four core reporting methods, it issues a report of severity MESSAGE. If the verbosity level of this report is higher than the maximum verbosity level of the report handler, this report is simply ignored. By default, a message is displayed on the command line and logged in a file, if one has been set. The default verbosity level for a message is 300.
function void avm_report_warning(string id, string message, int verbosity_level=200, string filenamee=, int line=0)
One of the four core reporting methods, it issues a report of severity WARNING. If the verbosity level of this report is higher than the maximum verbosity level of the report handler, this report is simply ignored. By default a warning is displayed on the command line and logged in a file, if one has been set. The default verbosity level for a warning is 200.
function avm_report_handler get_report_handler()
Provides public access to the report handler, which stores all the state information.
function string get_report_name()
Provides public access to the report name.

virtual function void report_header(FILE f=0)
Prints version and copyright information. This information will be sent to the command line if f is 0, or to the file descriptor f if it is not 0. This method is called by avm_env immediately after the construction phase and before the connect phase.
virtual function bit report_hook(string id, string message, int verbosity, string filename, int line) Called only if the CALL_HOOK bit is specified in the action associated with the report.
By default, it does nothing other than return 1, but it can be overloaded in a subclass. If this method returns 0, the report will not be processed by the report server.
virtual function bit report_error_hook(string id, string message, int verbosity, string filename, int line) Called only if the CALL_HOOK bit is specified in the action
associated with an error report. By default, it does nothing other than return 1, but it can be overloaded in a subclass. If this method returns 0, the error will not be processed by the report server.
virtual function bit report_fatal_hook(string id, string message, int verbosity,
705
AVM Encyclopedia avm_report_client string filename, int line)
Called only if the CALL_HOOK bit is specified in the action associated with a fatal report. By default, it does nothing other than return 1, but it can be overloaded in a subclass. If this method returns 0, the fatal will not be processed by the report server.
virtual function bit report_message_hook(string id, string message, int verbosity, string filename, int line) Called only if the CALL_HOOK bit is specified in the action associated with a message.
By default, it does nothing other than return 1, but can be overloaded in a subclass. If this method returns 0, the message will not be processed by the report server.
function void report_summarize(FILE f=0)
Produces statistical information on the reports issued by the central report server. This information will be sent to the command line if f is 0, or to the file descriptor f if it is not 0.
virtual function bit report_warning_hook(string id, string message, int verbosity, string filename, int line) Called only if the CALL_HOOK bit is specified in the action associated with a warning.
By default, it does nothing other than return 1, but can be overloaded in a subclass. If this method returns 0, the warning will not be processed by the report server.
function void reset_report_handler()
Reinitializes the clients report handler to the default settings.

function void set_report_handler(avm_report_handler hndlr)
Sets the report handler, thus allowing more than one client to share the same report handler.
function void set_report_max_quit_count(int m) Sets the value of the max_quit_count in the report handler to m. When the number of COUNT actions reaches m, the die() method is called. The default value of 0
indicates that there is no upper limit to the number of COUNTed reports.

function void set_report_name(string s)
Sets the report name.

function void set_report_severity_action (severity s, action a)
Sets the action associated with a severity. An action can take the value NO_ACTION ( 5'b00000 ) or can be composed of the bitwise OR of any combination of DISPLAY, LOG, COUNT, EXIT, or CALL_HOOK.
function void set_report_verbosity_level(int verbosity_level)
Sets the maximum verbosity level for the clients report handler. If the verbosity of any report exceeds this maximum value, then the report is ignored.
function void set_report_id_action (string id, action a)
706
This method sets the action associated with an id. An action associated with an id takes priority over an action associated with a severity. An action can take the value NO_ACTION ( 5'b00000 ) or can be composed of the bitwise OR of any combination of DISPLAY, LOG, COUNT, EXIT, or CALL_HOOK.
function void set_report_severity_id_action (severity s, string id, action a)
This method sets the action associated with a (severity,id) pair. An action associated with a (severity,id) pair takes priority over an action associated with either the severity or the id alone. An action can take the value NO_ACTION ( 5'b00000 ) or can be composed of the bitwise OR of any combination of DISPLAY, LOG, COUNT, EXIT, or CALL_HOOK.
function void set_report_default_file (input FILE f)
This method sets the file descriptor associated by default with any report issued by this clients report handler. The default value is 0, which means that even if the action includes a LOG attribute, the report is not sent to a file.
function void set_report_severity_file (severity s, FILE f)
This method sets the file descriptor associated with a severity. A file descriptor associated with a severity takes priority over the default file descriptor.
function void set_report_id_file (input string id, input FILE f)
This method sets the file descriptor associated with an id. A file descriptor associated with an id takes priority over the default file descriptor and a file descriptor associated with a severity.
function void set_report_severity_id_file (severity s, string id, FILE f)
This method sets the file descriptor associated with a (severity,id) pair. A file descriptor associated with a (severity,id) pair takes priority over the default file descriptor, a file descriptor associated with a severity, or a file descriptor associated with an id.
function void dump_report_state()
This method dumps the internal state of the report handler. This includes information about the maximum quit count, the maximum verbosity, and the action and files associated with severities, ids, and (severity,id) pairs.
virtual function void die()
This method is called by the report server if a report reaches the maximum quit count or has an EXIT action associated with it (this is part of the default action for a fatal error). If this method is called in a client that is actually a named component defined in an avm_env, then all the avm_envs run() tasks are killed and the avm_env goes through the report phase, which by default, calls report_summarize(). In this case, any other avm_envs in the simulation will not be affected.
707
If die() is called in a report client that is not an avm_named_component, or in an avm_named_component defined outside of an avm_env, then report_summarize() is called and the simulation terminates with $finish.
708
AVM Encyclopedia avm_report_handler
avm_report_handler
is the class to which many of the methods in avm_report_client are delegated. None of its methods are intended to be called directly from normal testbench code.
avm_report_handler
It stores the maximum verbosity, actions, and files that affect the way reports are handled. The relationship between report clients and report handlers is usually one to one, but it can, in theory, be many to one. If a report needs processing, it passes it on to the central report server. The relationship between report handlers and report servers is many to one. file
reporting/avm_report_handler.svh
virtual
no
members
avm_report_server m_srvr
This is the central report server that actually processes the reports.
int m_max_verbosity_level
This is the maximum verbosity of reports that this report handler forwards to the report server. The default value is 10000.
action severity_actions[severity]
This is the array that contains the actions associated with each severity. The default values are given by the table below.
Severity MESSAGE WARNING ERROR FATAL
Actions DISPLAY DISPLAY DISPLAY | COUNT DISPLAY | EXIT
id_actions_array id_actions
This is the array of actions associated with each string id. By default, there are no entries in this array.
id_actions_array severity_id_actions[severity]
This is an associative array of associative arrays. If it exists, then severity_id_actions[s][i] contains the actions associated with the (severity,id) pair (s,i). By default, there are no entries in this array.
709
AVM Encyclopedia avm_report_handler FILE default_file_handle
This is the default file handle for this report handler. By default, it is set to 0, which means that reports are not sent to a file even if a LOG attribute is set in the action associated with the report.
FILE severity_file_handles[severity]
This array contains the file handle associated with each severity.
id_file_array id_file_handles
This array contains the file handle associated with each string id.
id_file_array severity_id_file_handles[severity]
This associative array of associative arrays contains the file descriptor associated with each (severity,id) pair, if there are any. methods
function new()
The constructor.
function void set_max_quit_count(int m) See avm_report_client::set_report_max_quit_count (see function void summarize(FILE f=0) See avm_report_client::report_summarize (see function void report_header(FILE f=0) See avm_report_client::report_header (see function void initialize()
page 706).
page 706).
page 705).
This method is called by the constructor to initialize the arrays and other variables described above to their default values.
virtual function bit run_hooks(avm_report_client client, severity s, string id, string message, int verbosity, string filename, int line) run_hooks is called if the CALL_HOOK attribute is set for this report. It calls the clients report_hook and severity specific hook method. If either returns 0, then the
report is not processed.

local function FILE get_severity_id_file(severity s, string id)
This method looks up the file descriptor associated with reports with this severity and id.
function void set_verbosity_level(int verbosity_level) See avm_report_client::set_report_verbosity_level function action get_action(severity s, string id)
(see page 706).
This method looks up the action associated with this severity and id.
function FILE get_file_handle(severity s, string id)
This method looks up the file descriptor associated with reports with this severity and id.
710
AVM Encyclopedia avm_report_handler function void report(severity s, string name, string id, string mess, int verbosity_level=0, avm_report_client client=null)
This is the basic reporting method, which is called by the four core reporting methods avm_report_client::avm_report_message (see page 705), avm_report_client::avm_report_warning (see page 705), avm_report_client::avm_report_error (see page 704), and avm_report_client::avm_report_fatal (see page 704). See the descriptions of these methods for their detailed behavior.
function string format_action(action a)
This method returns a string that describes the action.

function void set_severity_action(severity s, action a) See avm_report_client::set_report_severity_action (see function void set_id_action(string id, action a) See avm_report_client::set_report_id_action (see
page 706).
page 706).
function void set_severity_id_action(severity s, string id, action a) See avm_report_client::set_report_severity_id_action (see function void set_default_file(FILE f) See avm_report_client::set_report_default_file (see
page 707).
page 707). 707).
function void set_severity_file(severity s, FILE f) See avm_report_client::set_report_severity_file (see function void set_id_file(string id, FILE f) See avm_report_client::set_report_id_file (see
page 707).
function void set_severity_id_file(severity s, string id, FILE f) See avm_report_client::set_report_severity_id_file (see function void dump_state() See avm_report_client::dump_report_state (see
page 707).
page 707).
711
AVM Encyclopedia avm_report_server
avm_report_server
avm_report_server is a global server that processes all the reports generated by an avm_report_handler. None of its methods are intended to be called by normal testbench code, although in some circumstances the virtual methods process_report and/or compose_message may be overloaded in a subclass.
file
reporting/avm_report_server.svh
virtual
no
members
static avm_report_server global_report_server=null This is an internal avm_report_server singleton. local int max_quit_count
This specifies the maximum number of COUNT actions that can be tolerated before a COUNT action is treated as an EXIT action. The default value is 0, which is treated as specifying no upper bound.
local int quit_count
This is the actual number of COUNT actions sent to the server.

local int severity_count[severity]
This counts the number of messages for each severity.

local int id_count[string]
This counts the number of messages for each string id. methods
function new()
The constructor is protected to enforce a singleton.

static function avm_report_server get_server()
This method returns a handle to the singleton.

function int get_max_quit_count() This method gets the value of max_quit_count(). function void set_max_quit_count(int m) This method sets the value of max_quit_count(). function void reset_quit_count() This method resets the value of quit_count function void incr_quit_count()
to 0.
This method increments the value of quit_count.
712
AVM Encyclopedia avm_report_server function int get_quit_count()
This method gets the value of quit_count.

function bit is_quit_count_reached() This method returns 1 if the value of quit_count
has reached its upper bound, if
there is one, and returns 0 otherwise.

function void reset_severity_counts() This method resets the values in the severity_count function int get_severity_count(severity s)
array.
This method gets the number of reports with severity s since the last reset.
function void incr_severity_count(severity s)
This method increments the severity count for this severity.

function void set_id_count(string id, int n)
This method resets the value in the id_count array for an id to n.

function int get_id_count(string id)
This method gets the number of reports with this id.

function void incr_id_count(string id)
This method increments the number of reports with this id.

function void summarize(FILE f=0) See avm_report_client::report_summarize (see function void f_display(FILE f, string s) This method sends string s to the command line by f if it is not 0.
706).
if f is 0 and to the file(s) specified
function void dump_server_state() See avm_report_client::dump_report_state() (see
page 707).
virtual function void process_report( severity s, string name , string id, string message, action a, FILE f, string filename , int line, avm_report_client client ) This method calls compose_message to construct the actual message to be output. It
then takes the appropriate action according to the value of action a and file f. This method can be overloaded by expert users so that the report system processes the actions different from the way described in avm_report_client and avm_report_handler.
virtual function string compose_message(severity s, string name, string id, string message)
This method constructs the actual string sent to the file or command line from the severity, component name, report id, and the message itself. Expert users can overload this method to change the formatting of the reports generated by avm_report_client.
713
AVM Encyclopedia avm_reporter
avm_reporter
extends avm_report_client
avm_reporter is a reporter that can be used by objects that are not avm_named_components to
issue reports. file

reporting/avm_report_client.svh
virtual
no
members
<none>
methods
function new(string name="reporter")
The constructor has a default name of "reporter."
714
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
Index
Symbols
$finish behavior, customizing, 546 +typdelays, 496, 520 {}, 21 hasX, hasX, 32 assertions testing for with onbreak command, 268 assume directives -noassume argument, 532 attributes, of signals, using in expressions, 32 avm_*_export class definition of, 630 avm_*_imp class, 632 avm_*_port class definition of, 634 avm_algorithmic_comparator class, 623 avm_analysis_port class, 636 avm_blocking_master_imp class, 637 avm_blocking_slave_imp class, 639 avm_built_in_clone class, 694 avm_built_in_comp class, 695 avm_built_in_converter class, 696 avm_built_in_pair class, 697 avm_class_clone class, 698 avm_class_comp class, 699 avm_class_converter class, 700 avm_class_pair class, 701 avm_connector_base class, 641 avm_in_order_built_in_ comparator class, 625 avm_in_order_class_comparator class, 626 avm_in_order_comparator class, 627 avm_master_imp class, 645 avm_named_component class definition of, 611 avm_nonblocking_master_imp class, 647 avm_nonblocking_slave_imp class, 649 avm_port_base class, 651 avm_random_stimulus class, 616 avm_report_client class definition of, 704 avm_report_handler class definition of, 709 avm_report_server class, 712 avm_reporter class, 714 avm_slave_imp class, 653
715
Numerics
2001, keywords, disabling, 497
A
abort command, 55 absolute time, using @, 25 add button command, 56 add list command, 60 add log command, 241 add memory command, 65 add watch command, 68 add wave command, 70 add_cmdhelp command, 77 add_menu command, 78 add_menucb command, 80 add_menuitem simulator command, 82 add_separator command, 84 add_submenu command, 85 addTime command, 360 alias command, 86 analog signal formatting, 71 analysis_fifo class, 661 analysis_if class, 669 analysis_imp class, 656 analysis_port class, 657 annotating interconnect delays, v2k_int_delays, 548 archives, library, 477 argument, 490 arrays indexes, 17 slices, 17, 21 arrays, VHDL, searching for, 28
avm_stimulus class, 618 avm_subscriber class, 619 avm_threaded_component class definition of, 620 avm_transaction class, 702 avm_transport_imp class, 655 avm_verification_component class, 621 escape characters in, 21 user-defined, 73 buttons, adding to the Main window toolbar, 56
C
C callstack moving down, 302 moving up, 273 C debugging, 101 case choice, must be locally static, 414 case sensitivity VHDL vs. Verilog, 22 cd (change directory) command, 100 cdbg command, 101 change command, 104 change_menu_cmd command, 107 channel class, 661 definitions of, 659 tlm_fifo, 662 tlm_req_rsp_channel, 665 tlm_transport_channel, 668 check contention add command, 108 check contention config command, 110 check contention off command, 111 check float add command, 112 check float config command, 113 check float off command, 114 check stable off command, 115 check stable on command, 116 -check_synthesis argument, 409 checkpoint command, 117 class member selection, syntax, 17 classes cloning, 698 comparing, 699 converting to strings, 700 Code Coverage coverage clear command, 160 coverage exclude command, 162 coverage goal command, 168 coverage report command, 171 coverage save command, 178 coverage testnames command, 180 coverage weight command, 181 merging reports, 424 toggle coverage
B
batch simulations, 236 batch_mode command, 87 batch-mode simulations halting, 574 bd (breakpoint delete) command, 88 binary radix, mapping to std_logic values, 37 blocking interfaces tlm_transport_if, 693 bookmark add wave command, 89 bookmark delete wave command, 91 bookmark goto wave command, 92 bookmark list wave command, 93 bp (breakpoint) command, 94 brackets, escaping, 21 break on signal value, 569 breakpoints conditional, 569 continuing simulation after, 324 deleting, 88 listing, 94 setting, 94 signal breakpoints (when statements), 569 time-based in when statements, 575 built-in types cloning, 694 comparing, 695 converting to strings, 696 bus contention checking, 108 configuring, 110 disabling, 111 bus float checking configuring, 113 disabling, 114 enabling, 112 busses
716
excluding signals, 366 vcover report command, 431 Color radix, 310 example, 311 combining signals, busses, 73 command line args, accessing vopt sc_arg command, 518 vsim sc_arg command, 549 commands .main clear, 54 abort, 55 add button, 56 add list, 60 add memory, 65 add testbrowser, 67 add watch, 68 add wave, 70 add_menu, 78 add_menucb, 80 add_menuitem, 82 add_separator, 84 add_submenu, 85 alias, 86 batch_mode, 87 bd (breakpoint delete), 88 bookmark add wave, 89 bookmark delete wave, 91 bookmark goto wave, 92 bookmark list wave, 93 bp (breakpoint), 94 cd (change directory), 100 cdbg, 101 change, 104 change_menu_cmd, 107 check contention add, 108 check contention config, 110 check contention off, 111 check float add, 112 check float config, 113 check float off, 114 check stable off, 115 check stable on, 116 checkpoint, 117 compare add, 119 compare annotate, 124, 127 compare clock, 125 compare close, 131 compare delete, 130 compare info, 132 compare list, 134 compare open, 146 compare options, 135 compare reload, 139 compare savediffs, 142 compare saverules, 143 compare see, 144 compare start, 141 configure, 150 coverage attribute, 157 coverage clear, 160 coverage exclude, 162 coverage goal, 168 coverage open, 170 coverage report, 171 coverage save, 178 coverage testnames, 180 coverage weight, 181 dataset alias, 183 dataset clear, 184 dataset close, 185 dataset config, 186, 187 dataset info, 188 dataset list, 189 dataset open, 190 dataset rename, 191, 193 dataset restart, 192 dataset snapshot, 194 delete, 196 describe, 197 disable_menu, 199 disable_menuitem, 200 disablebp, 198 do, 201 down, 202 drivers, 204 dumplog64, 205 echo, 206 edit, 207 enable_menu, 209
717
enable_menuitem, 210 enablebp, 208 environment, 211 examine, 213 exit, 218 find, 219 force, 227 gdb dir, 231 getactivecursortime, 232 getactivemarkertime, 233 help, 234 history, 235 jobspy, 236 layout, 237 lecho, 238 left, 239 log, 241 lshift, 244 lsublist, 245 mem compare, 246 mem display, 247 mem list, 249 mem load, 250 mem save, 253 mem search, 255 messages clearfilter, 258, 259 next, 261 noforce, 262 nolog, 263 notation conventions, 15 notepad, 265 noview, 266 nowhen, 267 onbreak, 268 onElabError, 270 onerror, 271 pause, 272 pop, 273 power add, 274 power report, 280 power reset, 283 printenv, 284, 285 profile clear, 287 profile interval, 288 profile off, 289 profile on, 290 profile option, 291 profile reload, 292 profile report, 293 property list, 298 property wave, 300 push, 302 pwd, 303 quietly, 304 quit, 305 qverilog, 306 radix, 308 radix define, 310 radix list, 313 radix name, 312 readers, 315 report, 316 restart, 318 restore, 320 resume, 321 right, 322 run, 324 sccom, 328 scgenmod, 334 sdfcom, 337 search, 338 searchlog, 341 seetime, 344 setenv, 345 shift, 346 show, 347 status, 350 step, 351 stop, 352 suppress, 353 tb (traceback), 354 tcheck_set, 355 tcheck_status, 358 toggle add, 363 toggle disable, 366 toggle enable, 367 toggle report, 368 toggle reset, 370 tr color, 371 tr id, 376
718
tr order, 374 transcribe, 378 transcript, 379 transcript file, 380 TreeUpdate, 588 tssi2mti, 381 typespec, 382 unsetenv, 384 up, 385 variables referenced in, 24 vcd add, 387 vcd checkpoint, 389 vcd comment, 390 vcd dumpports, 391 vcd dumpportsall, 393 vcd dumpportsflush, 394 vcd dumpportslimit, 395 vcd dumpportsoff, 396 vcd dumpportson, 397 vcd file, 398 vcd files, 400 vcd flush, 402 vcd limit, 403 vcd off, 404 vcd on, 405 vcom, 407 vcover attribute, 422 vcover merge, 424 vcover ranktest, 428 vcover report, 431 vcover testnames, 440 vdel, 441 vdir, 443 vencrypt, 446 verror, 448 vgencomp, 450 view, 452 virtual count, 455 virtual define, 456 virtual delete, 457 virtual describe, 458 virtual expand, 459 virtual function, 460 virtual hide, 463 virtual log, 464 virtual nohide, 466 virtual nolog, 467 virtual region, 469 virtual save, 470 virtual show, 471 virtual signal, 472 virtual type, 475 vlib, 477 vlog, 479 vmake, 500 vmap, 502 vopt, 503 vsim, 522 vsimDate, 551 vsimId, 551 vsimVersion, 551 wave, 554 wave create, 558 wave edit, 561 wave export, 564 wave import, 565 wave modify, 566 WaveActivateNextPane, 588 WaveRestoreCursors, 588 WaveRestoreZoom, 588 when, 569 where, 576 wlf2log, 577 wlf2vcd, 580 wlfman, 581 wlfrecover, 585 write cell_report, 586 write format, 587 write list, 589 write preferences, 590 write report, 591 write timing, 593 write transcript, 594 write tssi, 595 write wave, 597 xml2ucdb, 599 comment characters in VSIM commands, 15 comparator class avm_in_order_built_in_ comparator, 625 avm_in_order_class_ comparator, 626
719
avm_in_order_comparator, 627 definitions for, 621 tlm_algorithmic_comparator, 623 compare add command, 119 compare annotate command, 124, 127 compare clock command, 125 compare close command, 131 compare delete command, 130 compare info command, 132 compare list command, 134 compare open command, 146 compare options command, 135 compare reload command, 139 compare savediffs command, 142 compare saverules command, 143 compare see command, 144 compare start command, 141 compatibility, of vendor libraries, 443 compiling range checking in VHDL, 418 SystemC, 328, 334 Verilog, 479 VHDL, 407 at a specified line number, 413 selected design units (-just eapbc), 412 standard package (-s), 418, 495 component classes avm_named_component, 611 avm_random_stimulus, 616 avm_stimulus, 618 avm_subscriber, 619 avm_threaded_component, 620 avm_verification_component, 621 general description of, 608 compressing files checkpoint files, 117 elaboration files, 524 VCD files, 391, 400 concatenation directives, 36 of signals, 35, 472 conditional breakpoints, 569 configurations, simulating, 522 configure command, 150 connector classes analysis_imp, 656 analysis_port, 657 avm_*_export, 630 avm_*_imp, 632 avm_*_port, 634 avm_analysis_port, 636 avm_blocking_master_imp, 637 avm_blocking_slave_imp, 639 avm_connector_base, 641 avm_master_imp, 645 avm_nonblocking_master_imp, 647 avm_nonblocking_slave_imp, 649 avm_port_base, 651 avm_slave_imp, 653 avm_transport_imp, 655 deprecated implementations, list of, 659 general description of, 629 global_analysis_ports, 658 constants in case statements, 414 values of, displaying, 197, 213 contention checking, 108 conversion radix, 308 coverage vcover testnames command, 440 coverage attribute command, 157 coverage clear command, 160 coverage exclude command, 162 coverage goal command, 168 coverage open command, 170 coverage report command, 171 coverage save command, 178 coverage testnames command, 180 Coverage View mode coverage open command, 170 coverage weight command, 181 customizing adding buttons, 56
D
dataset alias command, 183 dataset clear command, 184 dataset close command, 185 dataset config command, 186, 187 dataset info command, 188
720
dataset list command, 189 dataset open command, 190 dataset rename command, 191, 193 dataset restart command, 192 dataset snapshot command, 194 datasets environment command, specifying with, 211 declarations, hiding implicit with explicit, 421 default VOPT behavior, and .ini file, 503 +define+, 483 delay interconnect, 531 +delay_mode_distributed, 483, 507 +delay_mode_path, 483, 507 +delay_mode_unit, 483, 508 +delay_mode_zero, 483, 508 delayed, 32 delete command, 196 deltas collapsing in WLF files, 539 hiding in the List window, 151 dependencies, checking, 443 dependency errors, 411, 484 describe command, 197 design loading, interrupting, 522 design units report of units simulated, 591 Verilog adding to a library, 479 directories mapping libraries, 502 disable_menu command, 199 disable_menuitem command, 200 disablebp command, 198 dividers adding from command line, 71 divTime ccommand, 360 do command, 201 DO files (macros), 201 down command, 202 drivers command, 204 dump files, viewing in the simulator, 406 dumplog64 command, 205
E
echo command, 206 edges, finding, 239, 322 edit command, 207 enable_menu command, 209 enable_menuitem command, 210 enablebp command, 208 encryption +protect argument, 494 -nodebug argument (vcom), 414 -nodebug argument (vlog), 491 entities, specifying for simulation, 549 enumerated types user defined, 475 environment command, 211 environment variables reading into Verilog code, 483 specifying UNIX editor, 207 state of, 285 using in pathnames, 21 environment, displaying or changing pathname, 211 eqTime command, 360 errors getting details about messages, 448 onerror command, 271 SDF, disabling, 535 escape character, 21 event order changing in Verilog, 481, 483, 506 examine command, 213 exit command, 218 exiting the simulator, customizing behavior, 546 extended identifier, 31 extended identifiers, 22 extended toggle coverage, reporting, 173, 432
F
-f, 484, 508 FIFO channel AVM class for, 659 file compression checkpoint files, 117 elaboration files, 524
721
VCD files, 391, 400 find command, 219 force command, 227 foreign module declaration Verilog example, 336 format file List window, 587 Wave window, 587 formatTime command, 361 Functional coverage merging databases offline, 424 generating from .ucdb, 174, 433
I
implementation class, related interfaces, 632 implicit operator, hiding with vcom -explicit, 421 +incdir+, 486 indexed arrays, escaping square brackets, 21 interconnect delays, 531 annotating per Verilog 2001, 548 interfaces related implementation, 632 internal signals, adding to a VCD file, 387 interrupting design loading, 522 intToTime command, 360
G
gdb setting source directory, 231 gdb dir command, 231 generics assigning or overriding values with -g and G, 527 examining generic values, 213 limitation on assigning composite types, 509, 527 getactivecursortime command, 232 getactivemarkertime command, 233 glitches disabling generation from command line, 542 global visibility PLI/FLI shared objects, 528 global_analysis_ports class, 658 gteTime command, 360 gtTime command, 360 GUI_expression_format, 29 syntax, 30
J
JobSpy command syntax, 236 jobspy, 236 jobspy command, 236
K
keywords disabling 2001 keywords, 497 enabling SystemVerilog keywords, 495
L
layout command, 237 LD_LIBRARY_PATH, disabling default internal setting of, 532 lecho command, 238 left command, 239 +libcell, 488 libraries archives, 477 dependencies, checking, 443 design libraries, creating, 477 listing contents, 443 refreshing library images, 418, 495 vendor supplied, compatibility of, 443 Verilog, 529 lint-style checks, 489 List window adding items to, 60 lm, 682 loading designs, interrupting, 522
H
hasX, 32 hazards -hazards argument to vlog, 485, 510 -hazards argument to vsim, 543 help command, 234 history of commands shortcuts for reuse, 26 history command, 235 HTML report
722
log command, 241 log file log command, 241 nolog command, 263 QuickSim II format, 577 redirecting with -l, 529 virtual log command, 464 virtual nolog command, 467 lshift command, 244 lsublist command, 245 lteTime command, 360 ltTime command, 360 loading, disabling with -quiet, 494, 518 loading, disbling with -quiet, 418 messages clearfilter command, 258, 259 -mfcu, 490 +mindelays, 490, 514 mnemonics, assigning to signal values, 475 modelsim.ini default VOPT behavior, 503 mulTime command, 360 multi-source interconnect delays, 531
N
name case sensitivity, VHDL vs. Verilog, 22 ncsim, one step simulation, 306 negative pulses driving an error state, 547 neqTime command, 360 nets drivers of, displaying, 204 readers of, displaying, 315 stimulus, 227 values of examining, 213 next command, 261 -no_risefall_delaynets, 545 -nodebug argument (vcom), 414 -nodebug argument (vlog), 491 noforce command, 262 +nolibcell, 492, 516 nolog command, 263 nonblocking interfaces tlm_nonblocking_put_if, 686 tlm_nonblocking_slave_if, 687 notepad command, 265 noview command, 266 +nowarn<CODE>, 493, 517 nowhen command, 267
M
macros (DO files) breakpoints, executing at, 96 executing, 201 forcing signals, nets, or registers, 227 parameters passing, 201 relative directories, 201 shifting parameter values, 346 .main clear command, 54 master slave library (SystemC), including, 332 +maxdelays, 489, 514 mc_scan_plusargs, PLI routine, 546 mem compare command, 246 mem display command, 247 mem list command, 249 mem load command, 250 mem save command, 253 mem search command, 255 memory window add memory command, 65 adding items to, 65 memory, comparing contents, 246 memory, displaying contents, 247 memory, listing, 249 memory, loading contents, 250 memory, saving contents, 253 memory, searching for patterns, 255 merging coverage reports, 424 messages base class for, 704 echoing, 206 getting more information, 448
O
object_list_file, WLF files, 581 onbreak command, 268 onElabError command, 270 onerror command, 271 optimizations disabling for Verilog designs, 494, 518 disabling for VHDL designs, 417
723
vopt command, 503 optimizations (vlog) disabling process merging, 480 order of events changing in Verilog, 481, 483, 506
Q
QuickSim II logfile format, 577 quietly command, 304 quit command, 305 qverilog command, 306
P
parameters using with macros, 201 pathnames in VSIM commands, 16 spaces in, 16 pause command, 272 performance vopt command, 503 PLI loading shared objects with global symbol visibility, 528 policy class, transactions, 694 pop command, 273 power add command, 274 Power Aware verification, 488 power report command, 280 power reset command, 283 printenv command, 284, 285 processes (vlog) optimizations, disabling the merging of, 480 profile clear command, 287 profile interval command, 288 profile off command, 289 profile on command, 290 profile option command, 291 profile reload command, 292 profile report command, 293 projects override mapping for work directory with vcom, 332, 420 override mapping for work directory with vlog, 307, 497 propagation, preventing X propagation, 532 property list command, 298 property wave command, 300 pulse error state, 547 push command, 302 pwd command, 303
724
R
Radix color, 310 example, 311 user defined, 310 radix character strings, displaying, 475 display values in debug windows, 308 of signals being examined, 215 radix command, 308 Radix define command, 310 setting radix color, 310, 311 radix list command, 313 radix name command, 312 range checking disabling, 416 enabling, 418 readers command, 315 RealToTime command, 360 record field selection, syntax, 17 refresh, dependency check errors, 411, 484 refreshing library images, 418, 495 report command, 316 report handling, class for, 709 report processing, global server for, 712 reporting issuing reports, class for, 714 variable settings, 24 reporting classes avm_report_client, 704 avm_report_handler, 709 avm_report_server, 712 avm_reporter, 714 general description of, 703 resolution specifying with -t argument, 535 restart command, 318 restore command, 320 resume command, 321
right command, 322 run command, 324 signals alternative names in the List window (label), 61 alternative names in the Wave window (label), 72 attributes of, using in expressions, 32 breakpoints, 569 combining into a user-defined bus, 73 drivers of, displaying, 204 environment of, displaying, 211 finding, 219 force time, specifying, 229 log file, creating, 241 pathnames in VSIM commands, 16 radix specifying for examine, 215 specifying in List window, 62, 74 readers of, displaying, 315 states of, displaying as mnemonics, 475 stimulus, 227 values of examining, 213 replacing with text, 475 simulating delays, specifying time units for, 24 design unit, specifying, 522 ncsim style, 306 one step, 306 saving simulations, 241, 538 stepping through a simulation, 351 stopping simulation in batch mode, 574 simulation farms jobspy, 236 simulations saving results, 193, 194 Simulator commands, 55 simulator resolution vsim -t argument, 535 simulator version, 537, 551 simultaneous events in Verilog changing order, 481, 483, 506 sml2ucdb command, 599 source annotation, 331 spaces in pathnames, 16 sparse memories
S
sc_stop() customizing simulator behavior, 546 scaleTime command, 360 sccom command, 328 -scdpidebug command, 548 scgenmod command, 334 -sclib command, 518, 548 scope resolution operator, 18 scope, setting region environment, 211 SCV library, including, 332 SDF annotation verbose mode, 535 compiled SDF, 337 controlling missing instance messages, 519, 534 disabling individual checks, 355 errors on loading, disabling, 535 warning messages, disabling, 535 sdfcom command, 337 search command, 338 search libraries, 529 searching binary signal values in the GUI, 37 List window signal values, transitions, and names, 29, 202, 385 next and previous edge in Wave window, 239, 322 VHDL arrays, 28 Wave window signal values, edges and names, 239, 322 searchlog command, 341 seetime command, 344 setenv command, 345 shared objects loading with global symbol visibility, 528 shift command, 346 shortcuts command history, 26 command line caveat, 26 show command, 347
725
listing with write report, 591 specify path delays, 547 square brackets, escaping, 21 stability checking disabling, 115 enabling, 116 startup alternate to startup.do (vsim -do), 525 status command, 350 Std_logic mapping to binary radix, 37 step command, 351 stop command, 352 subTime command, 360 suppress command, 353 symbolic constants, displaying, 475 symbolic names, assigning to signal values, 475 synthesis rule compliance checking, 409 SystemC class and structure member naming syntax, 17 DPI, command for single-stepping across call boundaries, 548 master slave library, including, 332 specifying shared library path, command, 518, 548 verification library, including, 332 SystemVerilog enabling with -sv argument, 495 multiple files in a compilation unit, 490 scope resolution, 18 time absolute, using @, 25 simulation time units, 24 time collapsing, 539 time resolution setting with vsim command, 535 time, time units, simulation time, 24 timescale directive warning disabling, 545 timing disabling checks, 493, 516 disabling checks for entire design, 532 disabling individual checks, 355 status of individual checks, 358 title, Main window, changing, 536 TLM interface classes analysis_if, 669 general description of, 668 tlm_blocking_get_if, 670 tlm_blocking_get_peek_if, 671 tlm_blocking_master_if, 674 tlm_blocking_put_if, 673 tlm_blocking_slave_if, 675 tlm_get_if, 676 tlm_get_peek_if, 677 tlm_master_if, 679 tlm_nonblocking_get_ peek_if, 682 tlm_nonblocking_get_if, 681 tlm_nonblocking_master_if, 683 tlm_nonblocking_peek_if, 685 tlm_nonblocking_put_if, 686 tlm_nonblocking_slave_if, 687 tlm_peek_if, 689 tlm_put_if, 690 tlm_slave_if, 691 tlm_transport_if, 693 tlm_*_imp, deprecated implementations, 659 tlm_blocking_get_if class, 670 tlm_blocking_get_peek_if class, 671 tlm_blocking_master_if class, 674 tlm_blocking_put_if class, 673 tlm_blocking_slave_if class, 675 tlm_fifo class, 662 tlm_get_if class, 676, 677
T
tb command, 354 tcheck_set command, 355 tcheck_status command, 358 Tcl history shortcuts, 26 variable in when commands, 572 test management window adding UCDB files to, 67 TFMPC disabling warning, 545
726
tlm_master_if class, 679 tlm_nonblocking_get_if class, 681 tlm_nonblocking_get_peek_if class, 682 tlm_nonblocking_master_if class, 683 tlm_nonblocking_peek_if class, 685 tlm_nonblocking_put_if class, 686 tlm_nonblocking_slave_if class, 687 tlm_peek_if class, 689 tlm_put_if class, 690 tlm_req_rsp_channel class, 665 tlm_slave_if class, 691 tlm_transport_channel class, 668 tlm_transport_if class, 693 toggle reporting extended, 173, 432 toggle add command, 363 toggle coverage excluding signals, 366 reporting, duplication of elements, 368 reporting, ordering of nodes, 368 toggle disable command, 366 toggle enable command, 367 toggle report command, 368 toggle reset command, 370 toggle statistics enabling, 363 reporting, 368 resetting, 370 tr color command, 371 tr id command, 376 tr order command, 374 transactions policy classes AVM transactions, base class for, 702 avm_built_in_clone, 694 avm_built_in_comp, 695 avm_built_in_converter, 696 avm_built_in_pair, 697 avm_class_clone, 698 avm_class_comp, 699 avm_class_converter, 700 avm_class_pair, 701 general description of, 693 transcribe command, 378 transcript clearing, 54 redirecting with -l, 529 reducing file size, 380 transcript command, 379 transcript file command, 380 transitions, signal, finding, 239, 322 TreeUpdate command, 588 TSCALE, disabling warning, 545 TSSI, 595 tssi2mti command, 381 typespec command, 382
U
-u, 496 UCDB coverage coverage attribute command, 157 vcover attribute command, 422 undeclared nets, reporting an error, 489 unsetenv command, 384 up command, 385 UPF, 488 user-defined bus, 73 User-defined radix, 310
V
-v, 496 v2k_int_delays, 548 validTime command, 361 values describe HDL items, 197 examine HDL item values, 213 replacing signal values with strings, 475 variable settings report, 24 variables describing, 197 referencing in commands, 24 value of changing from command line, 104 examining, 213 vcd add command, 387 vcd checkpoint command, 389 vcd comment command, 390 vcd dumpports command, 391 vcd dumpportsall command, 393 vcd dumpportsflush command, 394 vcd dumpportslimit command, 395 vcd dumpportsoff command, 396
727
vcd dumpportson command, 397 vcd file command, 398 VCD files adding items to the file, 387 capturing port driver data, 391 converting to WLF files, 406 creating, 387 dumping variable values, 389 flushing the buffer contents, 402 generating from WLF files, 580 inserting comments, 390 internal signals, adding, 387 specifying maximum file size, 403 specifying name of, 400 specifying the file name, 398 state mapping, 398, 400 turn off VCD dumping, 404 turn on VCD dumping, 405 viewing files from another tool, 406 vcd files command, 400 vcd flush command, 402 vcd limit command, 403 vcd off command, 404 vcd on command, 405 vcd2wlf command, 406 vcom command, 407 vcom Examples, 420 vcover attribute command, 422 vcover merge command, 424 vcover ranktest command, 428 vcover report command, 431 vcover testnames command, 440 vdel command, 441 vdir command, 443 vector elements, initializing, 104 vencrypt command, 446 vendor libraries, compatibility of, 443 Verilog $finish behavior, customizing, 546 capturing port driver data with -dumpports, 398 Verilog 2001 disabling support, 497 verror command, 448 version obtaining with vsim command, 537 obtaining with vsim<info> commands, 551 vgencomp command, 450 VHDL arrays searching for, 28 conditions and expressions, automatic conversion of H and L., 414 field naming syntax, 17 VHDL-1993, enabling support for, 408 VHDL-2002, enabling support for, 408 view command, 452 viewing waveforms, 538 virtual count commands, 455 virtual define command, 456 virtual delete command, 457 virtual describe command, 458 virtual expand commands, 459 virtual function command, 460 virtual hide command, 463 virtual log command, 464 virtual nohide command, 466 virtual nolog command, 467 virtual region command, 469 virtual save command, 470 virtual show command, 471 virtual signal command, 472 virtual type command, 475 vlib command, 477 vlog multiple file compilation, 490 vlog command, 479 vmake command, 500 vmap command, 502 vopt path separator, 503 vopt command, 503 vsim disabling internal setting of LD_LIBRARY_PATH, 532 vsim build date and version, 551 vsim command, 522 vsim Examples, 550
728
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z W
WARNING[8], -lint argument to vlog, 489 warnings SDF, disabling, 535 suppressing VCOM warning messages, 417, 493, 517 suppressing VLOG warning messages, 493, 517 suppressing VSIM warning messages, 545 watch window add watch command, 68 adding items to, 68 watching signal values, 68 wave commands, 554 wave create command, 558 wave edit command, 561 wave export command, 564 wave import command, 565 wave log format (WLF) file, 538 of binary signal values, 241 wave modify command, 566 Wave window adding items to, 70 WaveActivateNextPane command, 588 Waveform Comparison, 119 waveform editor creating waves, 558 editing commands, 561 importing vcd stimulus file, 565 modifying existing waves, 566 saving waves, 564 waveform logfile log command, 241 waveforms optimizing viewing of, 540 saving and viewing, 241 WaveRestoreCursors command, 588 WaveRestoreZoom command, 588 when command, 569 when statement time-based breakpoints, 575 where command, 576 wildcard characters for pattern matching in simulator commands, 22 windows List window output file, 589 saving the format of, 587 Main window adding user-defined buttons, 56 opening from command line, 452 Wave window path elements, changing, 153 WLF files collapsing deltas, 539 collapsing time steps, 539 converting to VCD, 580 creating from VCD, 406 filtering, combining, 581 limiting size, 540 log command, 241 optimizing waveform viewing, 540 repairing, 585 saving, 193, 194 specifying name, 538 wlf2log command, 577 wlf2vcd command, 580 wlfman command, 581 wlfrecover command, 585 write cell_report command, 586 write format command, 587 write list command, 589 write preferences command, 590 write report command, 591 write timing command, 593 write transcript command, 594 write tssi command, 595 write wave command, 597
X
X propagation disabling for entire design, 532 disabling X generation on specific instances, 355
Y
-y, 497
729
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Z
zoom wave window returning current range, 554
730
End-User License Agreement

The latest version of the End-User License Agreement is available on-line at: www.mentor.com/terms_conditions/enduser.cfm IMPORTANT INFORMATION USE OF THIS SOFTWARE IS SUBJECT TO LICENSE RESTRICTIONS. CAREFULLY READ THIS LICENSE AGREEMENT BEFORE USING THE SOFTWARE. USE OF SOFTWARE INDICATES YOUR COMPLETE AND UNCONDITIONAL ACCEPTANCE OF THE TERMS AND CONDITIONS SET FORTH IN THIS AGREEMENT. ANY ADDITIONAL OR DIFFERENT PURCHASE ORDER TERMS AND CONDITIONS SHALL NOT APPLY.
END-USER LICENSE AGREEMENT (Agreement) This is a legal agreement concerning the use of Software between you, the end user, as an authorized representative of the company acquiring the license, and Mentor Graphics Corporation and Mentor Graphics (Ireland) Limited acting directly or through their subsidiaries (collectively Mentor Graphics). Except for license agreements related to the subject matter of this license agreement which are physically signed by you and an authorized representative of Mentor Graphics, this Agreement and the applicable quotation contain the parties' entire understanding relating to the subject matter and supersede all prior or contemporaneous agreements. If you do not agree to these terms and conditions, promptly return or, if received electronically, certify destruction of Software and all accompanying items within five days after receipt of Software and receive a full refund of any license fee paid. 1. GRANT OF LICENSE. The software programs, including any updates, modifications, revisions, copies, documentation and design data (Software), are copyrighted, trade secret and confidential information of Mentor Graphics or its licensors who maintain exclusive title to all Software and retain all rights not expressly granted by this Agreement. Mentor Graphics grants to you, subject to payment of appropriate license fees, a nontransferable, nonexclusive license to use Software solely: (a) in machine-readable, object-code form; (b) for your internal business purposes; (c) for the license term; and (d) on the computer hardware and at the site authorized by Mentor Graphics. A site is restricted to a one-half mile (800 meter) radius. Mentor Graphics standard policies and programs, which vary depending on Software, license fees paid or services purchased, apply to the following: (a) relocation of Software; (b) use of Software, which may be limited, for example, to execution of a single session by a single user on the authorized hardware or for a restricted period of time (such limitations may be technically implemented through the use of authorization codes or similar devices); and (c) support services provided, including eligibility to receive telephone support, updates, modifications, and revisions. EMBEDDED SOFTWARE. If you purchased a license to use embedded software development (ESD) Software, if applicable, Mentor Graphics grants to you a nontransferable, nonexclusive license to reproduce and distribute executable files created using ESD compilers, including the ESD run-time libraries distributed with ESD C and C++ compiler Software that are linked into a composite program as an integral part of your compiled computer program, provided that you distribute these files only in conjunction with your compiled computer program. Mentor Graphics does NOT grant you any right to duplicate, incorporate or embed copies of Mentor Graphics' real-time operating systems or other embedded software products into your products or applications without first signing or otherwise agreeing to a separate agreement with Mentor Graphics for such purpose. BETA CODE. Software may contain code for experimental testing and evaluation (Beta Code), which may not be used without Mentor Graphics explicit authorization. Upon Mentor Graphics authorization, Mentor Graphics grants to you a temporary, nontransferable, nonexclusive license for experimental use to test and evaluate the Beta Code without charge for a limited period of time specified by Mentor Graphics. This grant and your use of the Beta Code shall not be construed as marketing or offering to sell a license to the Beta Code, which Mentor Graphics may choose not to release commercially in any form. If Mentor Graphics authorizes you to use the Beta Code, you agree to evaluate and test the Beta Code under normal conditions as directed by Mentor Graphics. You will contact Mentor Graphics periodically during your use of the Beta Code to discuss any malfunctions or suggested improvements. Upon completion of your evaluation and testing, you will send to Mentor Graphics a written evaluation of the Beta Code, including its strengths, weaknesses and recommended improvements. You agree that any written evaluations and all inventions, product improvements, modifications or developments that Mentor Graphics conceived or made during or subsequent to this Agreement, including those based partly or wholly on your feedback, will be the exclusive property of Mentor Graphics. Mentor Graphics will have exclusive rights, title and interest in all such property. The provisions of this section 3 shall survive the termination or expiration of this Agreement.
2.
3.
4.
RESTRICTIONS ON USE. You may copy Software only as reasonably necessary to support the authorized use. Each copy must include all notices and legends embedded in Software and affixed to its medium and container as received from Mentor Graphics. All copies shall remain the property of Mentor Graphics or its licensors. You shall maintain a record of the number and primary location of all copies of Software, including copies merged with other software, and shall make those records available to Mentor Graphics upon request. You shall not make Software available in any form to any person other than employees and on-site contractors, excluding Mentor Graphics' competitors, whose job performance requires access and who are under obligations of confidentiality. You shall take appropriate action to protect the confidentiality of Software and ensure that any person permitted access to Software does not disclose it or use it except as permitted by this Agreement. Except as otherwise permitted for purposes of interoperability as specified by applicable and mandatory local law, you shall not reverse-assemble, reverse-compile, reverse-engineer or in any way derive from Software any source code. You may not sublicense, assign or otherwise transfer Software, this Agreement or the rights under it, whether by operation of law or otherwise (attempted transfer), without Mentor Graphics prior written consent and payment of Mentor Graphics then-current applicable transfer charges. Any attempted transfer without Mentor Graphics' prior written consent shall be a material breach of this Agreement and may, at Mentor Graphics' option, result in the immediate termination of the Agreement and licenses granted under this Agreement. The terms of this Agreement, including without limitation, the licensing and assignment provisions shall be binding upon your successors in interest and assigns. The provisions of this section 4 shall survive the termination or expiration of this Agreement. LIMITED WARRANTY. 5.1. Mentor Graphics warrants that during the warranty period Software, when properly installed, will substantially conform to the functional specifications set forth in the applicable user manual. Mentor Graphics does not warrant that Software will meet your requirements or that operation of Software will be uninterrupted or error free. The warranty period is 90 days starting on the 15th day after delivery or upon installation, whichever first occurs. You must notify Mentor Graphics in writing of any nonconformity within the warranty period. This warranty shall not be valid if Software has been subject to misuse, unauthorized modification or improper installation. MENTOR GRAPHICS' ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL BE, AT MENTOR GRAPHICS' OPTION, EITHER (A) REFUND OF THE PRICE PAID UPON RETURN OF SOFTWARE TO MENTOR GRAPHICS OR (B) MODIFICATION OR REPLACEMENT OF SOFTWARE THAT DOES NOT MEET THIS LIMITED WARRANTY, PROVIDED YOU HAVE OTHERWISE COMPLIED WITH THIS AGREEMENT. MENTOR GRAPHICS MAKES NO WARRANTIES WITH RESPECT TO: (A) SERVICES; (B) SOFTWARE WHICH IS LICENSED TO YOU FOR A LIMITED TERM OR LICENSED AT NO COST; OR (C) EXPERIMENTAL BETA CODE; ALL OF WHICH ARE PROVIDED AS IS. 5.2. THE WARRANTIES SET FORTH IN THIS SECTION 5 ARE EXCLUSIVE. NEITHER MENTOR GRAPHICS NOR ITS LICENSORS MAKE ANY OTHER WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, WITH RESPECT TO SOFTWARE OR OTHER MATERIAL PROVIDED UNDER THIS AGREEMENT. MENTOR GRAPHICS AND ITS LICENSORS SPECIFICALLY DISCLAIM ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT OF INTELLECTUAL PROPERTY.
5.
6.
LIMITATION OF LIABILITY. EXCEPT WHERE THIS EXCLUSION OR RESTRICTION OF LIABILITY WOULD BE VOID OR INEFFECTIVE UNDER APPLICABLE LAW, IN NO EVENT SHALL MENTOR GRAPHICS OR ITS LICENSORS BE LIABLE FOR INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES (INCLUDING LOST PROFITS OR SAVINGS) WHETHER BASED ON CONTRACT, TORT OR ANY OTHER LEGAL THEORY, EVEN IF MENTOR GRAPHICS OR ITS LICENSORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. IN NO EVENT SHALL MENTOR GRAPHICS' OR ITS LICENSORS' LIABILITY UNDER THIS AGREEMENT EXCEED THE AMOUNT PAID BY YOU FOR THE SOFTWARE OR SERVICE GIVING RISE TO THE CLAIM. IN THE CASE WHERE NO AMOUNT WAS PAID, MENTOR GRAPHICS AND ITS LICENSORS SHALL HAVE NO LIABILITY FOR ANY DAMAGES WHATSOEVER. THE PROVISIONS OF THIS SECTION 6 SHALL SURVIVE THE EXPIRATION OR TERMINATION OF THIS AGREEMENT. LIFE ENDANGERING ACTIVITIES. NEITHER MENTOR GRAPHICS NOR ITS LICENSORS SHALL BE LIABLE FOR ANY DAMAGES RESULTING FROM OR IN CONNECTION WITH THE USE OF SOFTWARE IN ANY APPLICATION WHERE THE FAILURE OR INACCURACY OF THE SOFTWARE MIGHT RESULT IN DEATH OR PERSONAL INJURY. THE PROVISIONS OF THIS SECTION 7 SHALL SURVIVE THE EXPIRATION OR TERMINATION OF THIS AGREEMENT. INDEMNIFICATION. YOU AGREE TO INDEMNIFY AND HOLD HARMLESS MENTOR GRAPHICS AND ITS LICENSORS FROM ANY CLAIMS, LOSS, COST, DAMAGE, EXPENSE, OR LIABILITY, INCLUDING ATTORNEYS' FEES, ARISING OUT OF OR IN CONNECTION WITH YOUR USE OF SOFTWARE AS
7.
8.
DESCRIBED IN SECTION 7. THE PROVISIONS OF THIS SECTION 8 SHALL SURVIVE THE EXPIRATION OR TERMINATION OF THIS AGREEMENT. 9. INFRINGEMENT. 9.1. Mentor Graphics will defend or settle, at its option and expense, any action brought against you alleging that Software infringes a patent or copyright or misappropriates a trade secret in the United States, Canada, Japan, or member state of the European Patent Office. Mentor Graphics will pay any costs and damages finally awarded against you that are attributable to the infringement action. You understand and agree that as conditions to Mentor Graphics' obligations under this section you must: (a) notify Mentor Graphics promptly in writing of the action; (b) provide Mentor Graphics all reasonable information and assistance to defend or settle the action; and (c) grant Mentor Graphics sole authority and control of the defense or settlement of the action. 9.2. If an infringement claim is made, Mentor Graphics may, at its option and expense: (a) replace or modify Software so that it becomes noninfringing; (b) procure for you the right to continue using Software; or (c) require the return of Software and refund to you any license fee paid, less a reasonable allowance for use. 9.3. Mentor Graphics has no liability to you if infringement is based upon: (a) the combination of Software with any product not furnished by Mentor Graphics; (b) the modification of Software other than by Mentor Graphics; (c) the use of other than a current unaltered release of Software; (d) the use of Software as part of an infringing process; (e) a product that you make, use or sell; (f) any Beta Code contained in Software; (g) any Software provided by Mentor Graphics licensors who do not provide such indemnification to Mentor Graphics customers; or (h) infringement by you that is deemed willful. In the case of (h) you shall reimburse Mentor Graphics for its attorney fees and other costs related to the action upon a final judgment. 9.4. THIS SECTION IS SUBJECT TO SECTION 6 ABOVE AND STATES THE ENTIRE LIABILITY OF MENTOR GRAPHICS AND ITS LICENSORS AND YOUR SOLE AND EXCLUSIVE REMEDY WITH RESPECT TO ANY ALLEGED PATENT OR COPYRIGHT INFRINGEMENT OR TRADE SECRET MISAPPROPRIATION BY ANY SOFTWARE LICENSED UNDER THIS AGREEMENT. 10. TERM. This Agreement remains effective until expiration or termination. This Agreement will immediately terminate upon notice if you exceed the scope of license granted or otherwise fail to comply with the provisions of Sections 1, 2, or 4. For any other material breach under this Agreement, Mentor Graphics may terminate this Agreement upon 30 days written notice if you are in material breach and fail to cure such breach within the 30 day notice period. If Software was provided for limited term use, this Agreement will automatically expire at the end of the authorized term. Upon any termination or expiration, you agree to cease all use of Software and return it to Mentor Graphics or certify deletion and destruction of Software, including all copies, to Mentor Graphics reasonable satisfaction. 11. EXPORT. Software is subject to regulation by local laws and United States government agencies, which prohibit export or diversion of certain products, information about the products, and direct products of the products to certain countries and certain persons. You agree that you will not export any Software or direct product of Software in any manner without first obtaining all necessary approval from appropriate local and United States government agencies. 12. RESTRICTED RIGHTS NOTICE. Software was developed entirely at private expense and is commercial computer software provided with RESTRICTED RIGHTS. Use, duplication or disclosure by the U.S. Government or a U.S. Government subcontractor is subject to the restrictions set forth in the license agreement under which Software was obtained pursuant to DFARS 227.7202-3(a) or as set forth in subparagraphs (c)(1) and (2) of the Commercial Computer Software - Restricted Rights clause at FAR 52.227-19, as applicable. Contractor/manufacturer is Mentor Graphics Corporation, 8005 SW Boeckman Road, Wilsonville, Oregon 97070-7777 USA. 13. THIRD PARTY BENEFICIARY. For any Software under this Agreement licensed by Mentor Graphics from Microsoft or other licensors, Microsoft or the applicable licensor is a third party beneficiary of this Agreement with the right to enforce the obligations set forth herein. 14. AUDIT RIGHTS. You will monitor access to, location and use of Software. With reasonable prior notice and during your normal business hours, Mentor Graphics shall have the right to review your software monitoring system and reasonably relevant records to confirm your compliance with the terms of this Agreement, an addendum to this Agreement or U.S. or other local export laws. Such review may include FLEXlm or FLEXnet report log files that you shall capture and provide at Mentor Graphics request. Mentor Graphics shall treat as confidential information all of your information gained as a result of any request or review and shall only use or disclose such information as required by law or to enforce its rights under this Agreement or addendum to this Agreement. The provisions of this section 14 shall survive the expiration or termination of this Agreement.
15. CONTROLLING LAW, JURISDICTION AND DISPUTE RESOLUTION. THIS AGREEMENT SHALL BE GOVERNED BY AND CONSTRUED UNDER THE LAWS OF THE STATE OF OREGON, USA, IF YOU ARE LOCATED IN NORTH OR SOUTH AMERICA, AND THE LAWS OF IRELAND IF YOU ARE LOCATED OUTSIDE OF NORTH OR SOUTH AMERICA. All disputes arising out of or in relation to this Agreement shall be submitted to the exclusive jurisdiction of Portland, Oregon when the laws of Oregon apply, or Dublin, Ireland when the laws of Ireland apply. Notwithstanding the foregoing, all disputes in Asia (except for Japan) arising out of or in relation to this Agreement shall be resolved by arbitration in Singapore before a single arbitrator to be appointed by the Chairman of the Singapore International Arbitration Centre (SIAC) to be conducted in the English language, in accordance with the Arbitration Rules of the SIAC in effect at the time of the dispute, which rules are deemed to be incorporated by reference in this section 15. This section shall not restrict Mentor Graphics right to bring an action against you in the jurisdiction where your place of business is located. The United Nations Convention on Contracts for the International Sale of Goods does not apply to this Agreement. 16. SEVERABILITY. If any provision of this Agreement is held by a court of competent jurisdiction to be void, invalid, unenforceable or illegal, such provision shall be severed from this Agreement and the remaining provisions will remain in full force and effect. 17. PAYMENT TERMS AND MISCELLANEOUS. You will pay amounts invoiced, in the currency specified on the applicable invoice, within 30 days from the date of such invoice. Any past due invoices will be subject to the imposition of interest charges in the amount of one and one-half percent per month or the applicable legal rate currently in effect, whichever is lower. Some Software may contain code distributed under a third party license agreement that may provide additional rights to you. Please see the applicable Software documentation for details. This Agreement may only be modified in writing by authorized representatives of the parties. Waiver of terms or excuse of breach must be in writing and shall not constitute subsequent consent, waiver or excuse. Rev. 060210, Part No. 227900

Modelsim Se Ref

Uploaded by

Copyright:

Available Formats

Modelsim Se Ref

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Modelsim Se Ref

Uploaded by

Copyright:

Available Formats

ModelSim SE Reference Manual

Software Version 6.4a

1991-2008 Mentor Graphics Corporation All rights reserved.

ModelSim SE Reference Manual, v6.4a

ModelSim SE Reference Manual, v6.4a

ModelSim SE Reference Manual, v6.4a

ModelSim SE Reference Manual, v6.4a

ModelSim SE Reference Manual, v6.4a

ModelSim SE Reference Manual, v6.4a

704 709 712 714

ModelSim SE Reference Manual, v6.4a

ModelSim SE Reference Manual, v6.4a

ModelSim SE Reference Manual, v6.4a

ModelSim SE Reference Manual, v6.4a

Chapter 1 Syntax and Conventions

ModelSim SE Reference Manual, v6.4a

Syntax and Conventions File and Directory Pathnames

File and Directory Pathnames

Design Object Names

Object Name Syntax

ModelSim SE Reference Manual, v6.4a

Syntax and Conventions File and Directory Pathnames

SystemC Class, Structure, and Union Member Specification

ModelSim SE Reference Manual, v6.4a

You have an sc_signal<> of type beagle somewhere in your code:

Legal names for viewing this signal are:

To examine the member value of member d, you would type:

To examine the member value, you would type:

SystemVerilog Scope Resolution Operator

ModelSim SE Reference Manual, v6.4a

Syntax and Conventions File and Directory Pathnames

Example 1-2. SystemVerilog Scope Resolution Operator Example

Return the contents of the instance-specific array b.

ModelSim SE Reference Manual, v6.4a

Syntax and Conventions File and Directory Pathnames

ModelSim SE Reference Manual, v6.4a

Syntax and Conventions File and Directory Pathnames

Escaping Brackets and Spaces in Array Slices

For complete details on Tcl syntax, refer to Tcl Command Syntax.

Environment Variables and Pathnames

ModelSim SE Reference Manual, v6.4a

Syntax and Conventions Wildcard Characters

Name Case Sensitivity

Filtering Wildcard Matching for Certain Commands

Syntax and Conventions Wildcard Characters

WildcardFilter Preference Variable

ClassReference Constant Generic

ModelSim SE Reference Manual, v6.4a

Syntax and Conventions Simulator Variables

Simulation Time Units

ModelSim SE Reference Manual, v6.4a

Syntax and Conventions Argument Files

ModelSim SE Reference Manual, v6.4a

Syntax and Conventions Command Shortcuts

Comments Comments within the argument files follow these rules:

Command History Shortcuts

ModelSim SE Reference Manual, v6.4a

Syntax and Conventions Numbering Conventions

VHDL Numbering Conventions

ModelSim SE Reference Manual, v6.4a