HP Sim EE User Manual

Start Here for
Model
EE Installation - 6 Installation - UNIX platforms - 7 Installation - Windows platforms - 10 Locating Documentation - 21 Tech Support, Updates & Licensing - 25
Sim
EE
Online References - 32
Model produced by Model Technology Incorporated. Unauthorized copying, duplication, or other reproduction is prohibited without the written consent of Model Technology.
The information in this manual is subject to change without notice and does not represent a commitment on the part of Model Technology. The program described in this manual is furnished under a license agreement and may not be used or copied except in accordance with the terms of the agreement. The online documentation provided with this product may be printed by the end-user. The number or copies that may be printed is limited to the number of licenses purchased.
/VHDL, Model
Sim
/VLOG, Model
Sim
/LNL, and Model
Sim
/PLUS are
Sim
Model trademark of Adobe Systems Incorporated. UNIX is a registered trademark of AT&T in the USA and other countries. FLEXlm is a trademark of Globetrotter Software, Inc. IBM, AT, and PC are registered trademarks, AIX and RISC System/6000 are trademarks of International Business Machines Corporation. Windows, Microsoft, and MS-DOS are registered trademarks of Microsof t Corporation. OSF/Motif is a trademark of the Open Software Foundation, Inc. in the USA and other countries. SPARC is a registered trademark and SPARCstation is a trademark of SPARC International, Inc. Sun Microsystems is a registered trademark, and Sun, SunOS and OpenWindows are trademarks of Sun Microsystems, I nc. All other trademarks and re gistered trademarks are the properties of their respective holders.
Copyright (c) 1990-1998, Model Technology Incorporated. All rights reserved. Confidential. Online documentation may be printed by licensed customers of Model Technology Incorporated for internal business purposes only.
Published: November 1998
EE Start Here - Part # M16500 US$50
is a trademark of Model Technology Incorporated. PostScript is a register ed
Sim

Thank you

Thank you for purch asing from Model Technology’s family of sim ulation products! If we can help you with any addi tional product information, please email our sales department at sales@model.com page at www.model.com
Sim
Model
Elite Edition Simulators for UNIX and Windows
.
, or visit our home
EE/VHDL
EE/VLOG
• EE/LNL
(Language-Neutral Li censing)
EE/PLUS
Questions?
If you have questions a bout the produc t yo u have purcha sed he re are a few sources of information:
"Locating Docume ntation" (p21)
"Tech Support, Upda tes & Licensing" (p25)
"Online References" (p32)
This document
In this document you will find information on Model documentation for our Elite Edition (EE) simulators. You will also find sections on tech support, lic ensing, and EDA industry refer ences. If you are using this document online (the best way to use it), links for cross-references, email and the web are available - just click on the blue text.
Help preserve the Silicon Forest
- for VHDL simulation only
- for Verilog simulation only
- for
- for single-language, or mix ed VHDL/ Verilog simulation
VHDL, or Verilog simulation
either
installation and
Sim
Oregon is famous for its forests as well as its rain and slug chowder. Help us keep our for ests alive and green by using our online docu menta tion.
3

Table of Contents

EE Installation - 6
System requirements for ModelSim EE - 6 Installation - UNIX platforms - 7 Installation - Windows platforms - 10
Windows platform installation details - 12
Regenerating your design libraries - 13 Installed dir ectori es and files - 13 Platform-specific directories - 19
Locating Documentation - 21
Online documentation - 21
Getting the most current PDF manuals - 22
Getti ng paper ma nuals - 22 EE documentation - 22 Using ModelSim’s PDF docum entation - 23
Getting the Acrobat Reader - 23
Searching PDF files - 23
Requirements for Acrobat Search - 24
Installing th e FLEXid security k ey - 10 Installatio n and setup f or a PC server - 10 Troubleshooting PC server setup - 12 Setup for a UNIX server - 12
Licensing - 12 How to find the security key ID - 13
Doc files for ModelSim EE - 24 Copy and Paste fr om PDF files - 24
Tech Support, Updates & Licensing - 25
ModelSim contact matrix - 25 Technical support - by telephone - 25
Mentor Graphics customers In North America - 25
Mentor Graphics customers outside North America - 26
Model Technology customers worldwide - 26 Techn ical support - electronic support ser vices - 26
Mentor G r ap hi cs cus t o m ers - 26
Model Technology customers - 27 Technical support - other channels - 28 Updates - 28
Mentor customers: getting the latest version via FTP - 28
Model Technology customers: getting the latest version via FTP - 29
4
Licenses - ModelSim EE - 29
Where to obtain your license - 29 If you have trou ble with licensing - 29 All customers: Mod elSim EE licensing - 29
A All customers: maintenance renewals and EE licenses - 32 All customers: license t ransfers and server changes - 32
license.dat
Online References - 32
Books an d pu blicati on s - 32 Partners - 32 Training partners - 32 Resources - 32
Model Tech nology License Agreement - 33
Softwa re Lic ense Agre ement - 33 Model Technology Software Licens e - 33 Important Notice - 34 Limited Warranty - 34
file example - 29
Table of Contents
5

EE Installation

System requir ements for Mode l
Platform Operating system &
interface
SPARCstation SunOS 4.1 &
OpenWindows
Solaris 2.4, 2.5, 2.6 & OSF/ Motif , OpenWindows, or CDE
IBM RISC/ 6000
HP 700 HP-UX 9x through 11.0 &
X86 network-ready (see note)
Platfo rm- s pe c if ic in s truc tions
Select your platf orm for installation ins tructions.
Installation - UNIX platforms (p7)
AIX 4.1, 4.2 & OSF/Motif
HP VUE , OSF/Motif, or CDE
Windows NT 4.0 or 95/98
Sim
EE
Memory Storage
32 Mb minimum (memory need scales with size of circui t ­med to large gate design may need 256 Mb)
hard disk with at least 35 Mb spare capacit y
Installation - Windows platforms (p10)
Note:
TCP/IP or IPX/SPX. If you are installing on an NT machine, make sure you are logged in as "admi nistrator" when runn ing the installation program.
6
Any PC client or server must be conne cte d to a network with
Start Here for ModelSim EE

Installation - UNIX platforms

Before you begin a new Model make sure you have a Globetrotte r license dat a file ( need the file to run Model
Sim
EE installation on a UNIX machine,
Sim
license.dat
file); you ’ll
. If you don’t have a license file see
"Licenses - ModelSim EE" (p29).
Your workstation’s ide ntification is required for a license; here are the commands that return the ID:
Syntax Platform
hostid SPARC /etc/lans can HP 700 uname -m RISC/6000
The commands used to install Model
are case - sen s i ti v e, so they m u st
Sim
be entered exactly as shown in the following steps. (Note that neither the prompt nor the <Return> at the end of a line is shown in the examples.)
Model
1
you are installing it in the
can be installed in any directory. These instructions assume that
Sim
directory. You can change to the desired
/usr
installation directory by entering one of the following commands:
cd /usr
or
cd <pathname>
From a mounted Model
2
following syntax (this creates the top-level directory
tar xf /<CD-ROM>/WORKSTATION/install/<filename.tar>
CD, extract the file for your platform with the
Sim
modeltech
where the <fil ename.tar > is :
Platform <filename.tar>
All platforms base.tar (extract for all platforms) Sun OS-4/Solaris 1. x sun4.tar Sun OS-5/Solaris 2. x sunos5.tar
EE Installation
):
7
Platform <filename.tar>
HP hp700.tar IBM rs6000.tar All platforms docs.tar ( Model
In addition to the platform-specific file you need to extract (common Model
Add the pathname of the Model
3
files) and
Sim
docs.tar
Sim
(documentation).
executable directory to your search
manuals in pdf format)
Sim
base.tar
path (use one of the following):
/usr/modeltech/sun4 /usr/modeltech/sunos5 /usr/modeltech/hp700 /usr/modeltech/rs6000
If are using shell scripts that require platform inde pendence, you can use the
command within th e path of your she ll sc ript to retu rn th e plat form
vco
directory to your search path.
returns a path appropriate for the
Vco
hardware from which you are inv oking the simulator. The shell you are running determines how you add vco to your path:
• for csh:
set path = ( $path /usr/modeltech/‘/usr/modeltech/vco‘ )
• for sh (Bourne or Korn)
PATH=$PATH:/usr/modeltech/‘/usr/modeltech/vco‘ export PATH
If you are using SunOS 4, a nd are planning to load shared libraries, yo u’ll
4
need this path included in the LD_LIBRARY_PATH environment variable:
/usr/openwin/lib
Enter or edit the
5
license.dat
file in th e
modeltech
directory. Typically the
file looks like this (also see "Lic ense s - Mode lSi m EE " (p29)):
SERVER hostname nnnnnnnn 1650 DAEMON modeltech ./modeltech ./options FEATURE vsim modeltech 1997.090 dd-mmm-yyyy 2 \ 6C92577EC335F4C9568D ck=61 FEATURE vcom modeltech 1997.090 dd-mmm-yyyy 2 \ 6C92577EC335F4C9568D ck=61
Start Here for ModelSim EE
8
Note:
To enable starting the license daemon from any directory,
change the DAEMON line to use the full path. For example:
DAEMON modeltech /usr/modeltech/hp700/modeltech \ /usr/modeltech/hp700/options
For HP installation usi ng HP-UX version 9.x only: either the de vice /dev/
6
lan0 must be writable by the userID that starts the server, or the lmgrd daemon and the lmhostid utility must be made “setuid root”. The commands to do this are:
chmod a+w /dev/lan0
or
chown root lmgrd lmhostid chmod u+s lmgrd lmhostid
Start the license manager daemon by entering the following commands:
7
cd /usr/modeltech/<platform> START_SERVER
where <platform> can be sun4, suno s5, hp700, rs6000. If your system runs other applic ations that use Globetrotter Software’s
FLEXlm, a complete user ’s manual fo r FLEXlm is available at Globetrotter Software’s home page:
http://www.globetrotter.com/manual.htm
You may delete the executables you don’t want. Fo r example, if you don’t
8
need Model
cd /usr/modeltech/ rm -rf hp700
for HP machines:
Sim
EE Installation
9

Installation - Windows platforms

Note:
IP or IPX/SPX. If you are installing on an NT machine, make sure you are logged in as "administrator" when running the installation program.
Model one of the following:

Installing the FLEXid security key

Attach the FLEXid security key (FLEXid is printed on the key) to the parallel port of the PC server or stand-alone PC (key drivers are loa ded during installation). If a printer or other device is using the parallel port, install the security key on th e port first, the n attach that de vice to the key. The security key will not interfere with normal device operations.
Please remember to protect your security key; Model Technology will replace a defective key, but not one that is lost or stolen.

Installation and setup for a PC server

Follow this process to set up a floating license server on a PC. If you are installing Model floating license. If you are using a UNIX server see: "Se tup fo r a UN IX
server" (p12).
Any PC client or server must be conne cte d to a network with TCP/
EE requires a server for proper installation. Your server can be
Sim
• A stand-alone PC with a F LEX lm security key attached. (The PC acts as both server and client.)
• A Windows server (95/98/NT) with a security key attache d. (The client has no security key.)
• A UNIX server. (The client nor server have a security key; the server’s hostID provides the same locking function as the security key.)
on a stand-alone PC, the license is still a considered
Sim
Run the Model
1
Install from the CD -
you can click on the CD icon.
Install from an FTP file
below.
The password-protected Model and documentation file (ee_docs.zip) are available within the version­numbered directories at:
ftp.model.com/ pub/EE/
Place the unzipp ed doc ume ntation files in th e after Model
Start Here for ModelSim EE
10
Sim
is installed.
Sim
installation.
install wil l au to-r un when yo u inse rt the CD, or
- run the installation executable as noted
instal la tion exe cutabl e (mti52ee.ex e )
Sim
modelsim\docs
directory
During installation you will be asked to choos e a Sent inel driver for your
2
specific FLEXid security key. The number on your FLEXid security key (something like 7-xxxxxxxx, or 8-xxxxxxxx) relates to the driver you will select.
Copy
3
license.dat
purchased Model specific Model into th e
license.dat
(the license file you received by email when you
) to
Sim
Sim
C:\modelsim\win32\license.dat
pathname if different. Pasting the text from the email
, or to your
file is the safest way to create a valid license file. See "A licen se.da t fil e ex ample" (p29) for details on the structure of a licens e file.
Verify your hostname (the server’s computer name) via the Windows
4
Control Panel with either FLEXlm > Advanced > Diagnostics, or with Network > Iden tification.
5
Edit th e
license.dat
file and make the following changes:
• Replace "h o stname" with the server computer name.
• Change the "1650" port value only if this port is already us ed. If uncertain, do not change.
• Change the DAEMON path to correspond with the full pathname of the modeltech daemon. For example,
DAEMON modeltech C:\modelsim\win32\modeltech
Set the environment variable for LM_LICENSE_FILE.
6
• For
Windows NT
go to Control Panel > System > Environment and add LM_LICENSE_FILE with an ini tial value of 1650@MYPC, where MYPC is the hostname.
• For
Windows 95/98
set LM_LICENSE_FILE=1650@MYPC
edit the
autoexec.bat
and add the following line:
where MYPC is your hostname.
Note that the chan ges ma de to y our
license.dat
file a re ref lecte d in the port#
(1650) and the hostname (MYPC) that you set for LM_LICENSE_FILE.
Note:
If the LM_LICENSE_FILE variab le is alrea dy defined, you c an add a second value by separating the two values with a semi-colon ( ; ). For example: LM_LICENSE_FILE= 1650@MYPC;c:\renoir\license.da t
For Windows 95/98, reboot your machine; no reboot is needed for NT.
7
EE Installation
11
Go to the FLEXlm Li cense Mana ger located i n your Cont rol Panel. C hoose
8
the Setup tab and add the pathnames for the lmgrd.exe, license.dat, and debug.log. Mak e s ure the pathnames and extensions are cor r ect, then save the setup. Typical entries might look like this:
lmgrd.exe C:\modelsim\win32\lmgrd.exe License file C:\modelsim\win32\license.dat Debug log file C:\modelsim\win32\debug.log
Next choose the FLEXlm Control tab. Press the start button. Wait a
9
moment, then pres s t he stat us but ton. The server s hould be up . If the ser ver does not start, try the following troubleshooting procedures.

Troubleshooting PC server setup

Open a DOS window and go to the appropriate
1
modelsim\win32
For example, C:\modelsim\win32. Enter the command:
lmutil lmdiag
This allows you to verify each fe ature independently.
directory.
From a DOS window, and the same
2
lmutil lmstat -a
directory, enter the following:
win32
This shows you all li censes that are available.
3
Go to the
debug.log
inside the
directory. This may provide other
win32
informat ion about th e source o f the license server problems.

Setup for a UNIX server

Check with your system administrator for the server’s hostname and port# , then follow the installation instructions above (steps 5 through 7) to set the LM_LICENSE_FILE variable for your pl atform.

Windows platform installation details

Licensing
Model Globetrotter Softwa re. In a Windows-only environ ment, a FLEXid securit y key is installed that identifies the machine as the license server (a stand­alone PC acts as server the license server, and requires no security key because FLEXlm uses the UNIX server’s hostID as the identifier.
The license file ( or host ID), and is obtained from either Model Technology or Ment or Graphic s. (S ee "Lic ens es - Model Sim EE" (p29) if you n ee d a license file.)
licensing is handled by the FLEXlm license manager from
Sim
client). A UNIX machine may al s o be us ed as
and
license.dat
) is based on the serv er identifier (the FLEXid,
Start Here for ModelSim EE
12
If your license server is a UNIX workstation, make sure you are running lmgrd version 5.12b. If you have Model server, you have the current version - ea rlier lmgrd versions will not work for Windows machines accessing the server. If you need a new version of lmgrd, please download it from : http://www.globetrotter.com/lmgrd.htm If you are a Mentor customer using an MGC license, consult MGC documentation for setting up your server.
How to find the security key ID
The key ID is on a stick er att ached to the ke y. If yo u can’t easil y acce ss the key, you can ru n a ut ilit y fro m the DOS p rompt that reads the key ID. Type
lmutil lmhostid -flexid
find
lmutil.exe
Model
Sim
in the
installation.
at the DOS prompt on the Windows server. You’ll
<install_dir >\modelsim\win32
5.2 installed on the UNIX
Sim
directory after

Regenerating your design libraries

Depending on your cur rent Mode l your design librar ies before running a simulation. Check the install ation readme file to see if your libraries require an update . You ca n ea si ly regenerate your de sign librarie s with is updated; u se if you have a library named design units you would use both of these commands:
vcom -work mylib -refresh vlog -work mylib -refresh
-work <library> mylib
version, y ou may nee d to re genera te
Sim
-refresh
to update a diffe rent libra ry. For examp le,
that contains both VHDL and Verilog
. By default, the
work
.
library
Note:
VHDL, and regenerate the std, ieee, vital22b, and verilog libraries .
Important:
varies between Model library in th e P E $MODEL_TECH/../std. To prepare a new it is best to ch ange the na me of your PE then use
As in the example above, you will need to use
to refresh Verilog design units. Also, you
vlog
The library mapping for the provided Model
to copy a new
vmap
PE and Model
Sim
modelsim.ini
says $MODEL_TECH/std, where EE says
modelsim.ini
EE. For example, the std
Sim
modelsim.ini
modelsim.ini
file.
to another name, and
to refresh
vcom
don't
librar i es
Sim
for Model

Installed directories and files

A typical installation for any EE platform would include the bas e file structure illustrated below. For platform-spe cific (hp700, rs6000, sun 4, sunos5, and Win32) directories see "Platform-spec if ic directories" (p19).
EE Installation
need to
EE
Sim
13
Sim
Installed files - Model
Directory Files & subdirectories Description
EE
<install directory> /<modelsim_dir>
* NOTE: the default Model is /modeltech for UNIX, and /modelsim for Windows
./arithmetic std_logic_arith Mentor Graphics
./bin various UNIX platform-
directory
Sim
convert.tc l, modelsim. ini, rebuild_libs.csh, rebuild_ libs.sh, release_notes, release _notes.html, vsim.ps
tran slates 4.6 DO files into 5.1 DO files, modelsim initialization file, recrea tes all lib raries from the source files (for csh and sh shells), modelsim readme fil es in text and HTML formats , Postscript header file
synthesis-speci f ic arithmetic packages
independent executables and QuickHDL mappings to Model executables
Sim
Start Here for ModelSim EE
14
Installed files - Model
Directory Files & subdirectories Description
Sim
EE
./docs technotes, HTML,
winhelp, ee_start_here.pdf, ee_tutorial_<ver>.pdf, ee_manual_<ver>.pdf, ee_doc_index.pdf sdk_um.pdf,
./examples various example sim ulation
./examples/fore ign various example fil e
general Model technotes, HTML versions of the Tc l/ Tk man pages, WinHelp version of the Tcl man pages, Start Here doc ument in PDF format, Model
Sim
in PDF format, EE/ PLUS Reference Manual in PDF format, Model documentation index, MGC standard deve loper’s kit manual in PDF format
models, testbe nches, macros, and utilities
directory f or forei gn interface
Sim
Tutor i al
Sim
./examples/ mixedhdl
./examples/ tcl_getstart
various example file
directory for mixed VHDL/Verilog design
various example files for
Tcl/Tk tut ori al
EE Installation
15
Installed files - Model
Directory Files & subdirectories Description
./ieee various library for
./ieeepure various standard VHDL
./include various include files for use
./mgc_portable various Mentor Graphics
./std various VHDL STD library
./std_developerskit various libraries for MGC
Sim
EE
accelerated IEEE and Synopsys arithmetic packages
IEEE library
with Verilog PLI, VHDL foreign interface, and TCL
Quick compatible logic set
and package TEXTIO
standard developer’s kit
Sim
./synopsys various accelerated
arithmetic packages (also in ieee)
./tcl bitmaps, tcl8.0, tix4.1,
tk8.0, vsim
./verilog vl_types VHDL package for
./vhdl_src/ arithmetic
Start Here for ModelSim EE
16
std_arit.vhd (see note below)
libraries for Tcl, Tix, Tk, and, vsim
mapping to V er ilog states
source for Mentor Graphics synthe s is arithmetic libraries
Installed files - Model
Directory Files & subdirectories Description
Sim
EE
./vhdl_src/ieee mti_numeric_bit.vhd,
mti_numeric_std.vhd, stdlogic.vhd
./vhdl_src/mentor numeric_extra.vhd,
numeric_signed.vhd, numeric_unsigned.vhd, qsim_logic.vhd, qsim_relations.vhd, qsim_tc.vhd, std_logic_1164_ext.vhd
./vhdl_src/std standard.vhd, textio.vhd sources for VHDL
./vhdl_src/ std_developerskit
examples, iopakb.vhd, iopakp.vhd, mempakb.vhd, mempakp.vhd, regpakb.vhd, regpakp.vhd, simflagb.vhd, simflagp.vhd, synthreg.vhd, timingb.vh d, timingp.vhd
sources for rebuilding basic IEEE std_logic_1164 library and accelerated IEEE arithmetic packages
source for Mentor Graphics QuickHDL add-ons
STD library and package TEXTIO
sources and examples for MGC standard deve loper’s kit
EE Installation
17
Installed files - Model
Sim
EE
Directory Files & subdirectories Description
./vhdl_src/s ynopsys mti_std_logic_arith.vhd,
mti_std_logic_misc.vhd, mti_std_logic_signed.vh d mti_std_logic_unsigned. v
sources for rebuilding accelerated
arithmetic packages hd, std_logi c_textio.vhd, syn_ari.vhd, syn_attributes.vhd, syn_type. vhd
./vhdl_src/ve rilog vltypes.vhd source for rebuilding
Verilog library
./vhdl_src/vital2.2b prmtvs_b.vhd,
prmtvs_p.vhd, timing_b. vhd,
sources for
rebuilding VITAL
version 2.2b library timing_p. vhd
./vhdl_src/vital95 prmtvs_b.vhd,
prmtvs_p.vhd, timing_b.vhd,
sources for
rebuilding VITAL
version 95 libra r y timing_p.vhd
Note:
The version of std_logic_arith contained in file
NOT the version tha t is compiled into the Model
This version is compiled into library
arithmetic
std_arit .vhd
Sim ieee
library.
and is available for
is
customers who may have previously used Ment or QuickVhdl, and used the Mentor
arithmetic
package th at contained std_logic_arith modified
for use with the Mentor synthesis tools.
The source for the ieee-prec omp iled version is in:
vhdl_src/synopsys/mti_std_logic_arith.vhd
Start Here for ModelSim EE
18

Platform-specific directories

Platform-specific di rectories wit hin the
rs6000, sun4, sunos5, and win32
Platform-specific directories - UNIX platforms
Files in UNIX platform directory Description
DUMPLOG64 dumps readable content for vsim
START_SERVER license manager script libhm.sl, libsm .s l, libswiftpli.sl SmartModel and hardware
lmborrow, lmcksu m , lm diag, lmdown, lmgrd, lmhostid, lmremove, lmreread, lmstat, lmswitchr, lmutil, lmver, modeltech
options license manager user-specified
sm_entity, hm_entity Model
<modelsim_dir >
) contain files as noted below.
.wav file
modeler support libraries Globetrotter license manager
executables
options
Sim
LMG Smar tmod els and ha rdwa re modeler
directory (
tools for use with
hp700
,
tssi2mti Model
files vcom Model vdel, vdir, vlib, vma ke, vmap Model
tools vlog Model vish Tcl/TK user in t erf ac e vlm simulation license manager
tool for use with SEF
Sim
VHDL compiler
Sim
library management
Sim
Verilog compiler
Sim
EE Installation
19
Platform-specific directories - UNIX platforms
Files in UNIX platform directory Description
vgencomp Model
tool for use with
Sim
Verilog modules in VHDL vsim Model wav2log translates Model
simulator
Sim
log file to
Sim
QuickSim II log file ./rs6000/mti_exports list of foreign interface routines
exported from mti ./sun4/vsim.swift Model
simulator for use with
Sim
LMG models; only required for
Sun4
Platform-specific directories - Windows platforms
Files in the ../win32 directory Description
dumplog64.exe dumps readable content for vsim
.wav file
libsm.dll, libsm.exp, libsm .lib,
SmartModel s upport libraries
libswiftpli.dll flexlm.cpl, lmgr325c.dll,
lmgrd.exe, lmutil.exe,
Globetrotter license manager executables and libraries
modeltech.exe license.dat license manage r data file modelsim.exe invokes Model modelsim.ini Model sm_entity.exe Model
Sim Sim
Sim
project file tool for use with LMG
models
Start Here for ModelSim EE
20
environment
Platform-specific directories - Windows platforms
Files in th e ../w in32 direc tor y Des c ri p ti on
tcl80.dll, tclpip80.dll, tix4180.dll, tk80.dll
tssi2mti.e xe Model
vcom.exe Model vdel.exe, vdir.e xe, vlib.exe,
vmake.exe, vmap.exe vlog.exe Model vish.exe Tcl/TK user interface vlm.exe simulation license manager vgencomp.exe Model
vsim.exe Model wav2log.exe translates Model
Tcl, Tix and Tk dynamic libraries
tool for use with SEF
Sim
files
VHDL compiler
Sim
Model tools
Verilog modules in VHDL
QuickSim II log file
library management
Sim
Verilog compiler
Sim
tool for use with
Sim
simulator
Sim

Locating Documentation

log file to
Sim

Online documentation

Model Technology docum entation, including this booklet, is available in Adobe Acrobat (PDF) format for online viewing.
PDF documentation
You’ll find it easier to follow cross references (click on blue links), and navigate the document with the outline/bookmark feature of the Acrobat Reader. Find and Sea rch capabilitie s allow you to loca te any text string, and since the table of contents and index entries are also links into the document, the Acrobat Reader "turns the pages" for you.
is more than electronic images of paper manuals.
Locating Docume ntation
21
Our documentation requires Acrobat Reader version 3.01 for viewing (free from adobe.com Reader with Search for viewing the files because it facilitates indexed searching, which is much faster than simp le tex t -string searches. See
"Using ModelSim’s PDF documentation" (p25) for more information
about using Search.
, and on the ModelSim CD). We suggest you use the

Getting the most current PDF manuals

Download the current PDF reference manuals from the Model Technology FTP site: ftp://ftp.model.com/pub find the documentation files within the version-numbered directories. The
Reference Manual files are password-protected for registered users. The ModelSim EE Start Here and EE Tutorial are available from
www.model.com
ModelSim software see "Updates" (p30), www.model.com above.
; no password is required. For the latest version of
. Choose either the EE or PE tree; you’ll
, or the ftp site

Getting paper manuals

If you need a printed copy of the ModelSim Reference Manual or the ModelSim Tutorial, use one of the request cards attached to this booklet.
Registered users may request up to two copies of each book for each license purchased. You might save the second form to order new books when versions change. (Additional copies are available at US$50 per book, you might also consider printing only the sections you need from the PDF file.)

EE documentation

ModelSim EE documentation is included on the ModelSim CD in the electronic formats shown below.
Model
Model
Std_DevelopersKit User’s Manual
22 Start Here for ModelSim EE
Sim
EE/PLUS Reference Manual
• PDF format (in print for US$50)
• command and simulation reference for all EE products
• default path: <modelsim_dir>/docs/ee_manual_<version>.pdf
Sim
EE Tutorial
• PDF format (in print for US$50)
• beginning tutorial for all EE products
• default path: <modelsim_dir>/docs/ee_tutorial_<version>.pdf
• PDF format
• Mentor Graphics VHDL design development kit
• default path: /<modelsim_dir>/docs/sdk_um.pdf
Start Here for Model
• PDF format
• installation and support references
• default path: /<modelsim_dir>/docs/ee_start_here.pdf
Sim
(this guide)
Technotes
• text format
• various
• default path: /<modelsim_dir>/docs/technotes/
Tcl man pages
• HTML format, and WinHelp format
• ModelSim menu pick: Help > Tcl Man Pages
Available from our web site:
Model
Using Model

Getting the Acrobat Reader

ModelSim PDF documentation requires Adobe Acrobat Reader version
3.01 (Reader with Search is recommended). Installation files for the Reader with Search are in the Acrobat directory on the ModelSim CD, or available directly from Adobe at: http://www.adobe.com/
Sim
Quick Guide
• PDF format
• quick reference for commands, variables, tools
• from web site: www.model.com/pdf/quickguide.pdf
Sim
’s PDF documen ta ti o n

Searching PDF files

The Acrobat Reader with Search provides two methods for finding text within PDF documents: Search (fast, indexed search), and Find (slower text search). Look for these icons on the Acr o bat Reader toolbar:
Search icons help you quickly search through an
indexed PDF document. The small binocular icon (the Find icon is larger) returns a search criteria dialog box. To use Search you must be viewing an
Locating Documentation 23
indexed document. See "Requirements for Acrobat Search" (p24) below.
The
Find icon
initiates a simple text search of the PDF file. Depending on the speed of your machine and the size of the file, Find can be slow (but effective).

Requirements for Acrobat Search

To use Acrobat Search with Model file /d i r ec tory str ucture. If you in stalle d Mo d el downloaded the docume ntation set from our web site (http://www.model.com
) you will likely have this structure. Search is intended for us e with the complete Search will not work corre ctly with individual files that are not part of the directory structure below.
Doc files for Model
These Mo d el
EE
Sim
documentation files must be in the directory shown for
Sim
Acrobat Search to work. This directory:
<intall_dir>/<modelsim_dir>/docs/
must in cl u d e th ese files :
ee_manual_<version>.pdf (reference manual) ee_tutorial_<version>.pdf (Model ee_start_here.pdf (this document) ee_doc_index.pdf (links to documentation) sdk_um.pdf (Mentor Std_developersKit) ee_index.pdx (PDF index file) /ee_index (directory and subdirectories for PDF index)
PDF docs you need the following
Sim
from the CD-ROM or
Sim
Manual/Tut or ial
documentation set.
Sim
tutorial)
Copy and Paste from PDF files
You can copy text from PDF files and paste it into Model
Sim
transcript.
Select the
select and copy text from the PDF file into Model
button on the Acrobat Reader toolbar. You can then
abc
. This is especially
Sim
helpful if you want to copy and paste examples from the tutorials to the command line.
Start Here for ModelSim EE
24
’s Main

Tech Support, Updates & Licensing

Model
Sim
contact matrix
If you are viewing this document online, select a link for Model and support from the table below, or see the sections that follow for additiona l detail.
Model T echno logy
Americas
Mentor Graphics
North America Outside North America 1-800-547-4303 supportnetweb.mentorg.com
Annapolis Microsystem s Exemplar Logic Hewlett Packard EEsof Synplicity
(www.mo del.com
Europe Asia
(www.mentorg.com
)
)
www.annapmicro. com www.exemplar.com www.hp.com/go/hpeesof www.synplicity.com
Sim
sale s

Technical support - by telephone

Mentor Graphics customers In North America

For customers who purchased produ cts from Mentor Graphics in North America, and are under a current support contract, technical telephone support is availa ble from the central Suppo rtCenter by calling toll-free 1-800-547-4303. The coverage window is from 6:00am to 5:30pm Pacific Time, Monday through Friday, excluding Mentor Graphics holidays.
Tech Support, Update s & Licens ing
25
The more prelimin ar y information custo mers can supply about a p r oblem or issue at the beginning of the reporting process, th e s ooner the Software Support Engineer (SSE) can s uppl y a soluti on or work around. Informat ion of most help to the SSE in cludes accurate operating sys t em and softw ar e version numbers, the steps leading to the problem or crash, the first few lines of a traceback, and problem sections of the Procedural Inte rface code.

Mentor Graphics customers outside North America

For customers who purchased prod ucts from Mentor Graphics outside of North America, should contact their local s upport organization. A list of local Mentor Graphic s SupportCente rs outside North Americ a can be found at supportnetweb.mentorg. com Directory".
under "Connections", then "International

Model Technology customers worldwide

For customers who purchased from Model Technology, please contact Model Technology via the support line at 1-503-641 -1340 from 8:00 AM to 5:00 PM Pacific Time. Be sure to ha ve your server hostID or hardware security key authorization number handy.

Technical support - electronic support services

Mentor Graphics customers

Mentor Graphics Customer S upport offers a SupportNet-Email ser ver for North American and European companies that let s cus tomers find product information or submit service requests (call logs ) to the Sup portCenter 24 hours a day, 3 65 days a year. T he server will re turn a c all log n umber with in minutes. SSEs follow up on the call logs submitted through SupportNet­Email using the same proces s as if a customer had phoned the SupportCente r. For mo re information about using the SupportNet-Email server, send a blank e-mail message to the following address:
support_net@mentorg.com
Additionally, custo mers can open call logs or sea rch the Men tor TechNote database of so lutions t o try to find the answers to t heir ques tions by log ging onto Mentor Graphics’ Customer Support web home page at
http://supportnetweb.mentorg.com
Start Here for ModelSim EE
26
.
.
To establish a Suppor tNet account for your site (both a site-based SupportNet-Web account and a user-based SupportNet Email account), please submit the following information: name, phone number, fax number, email address, company name, site ID. With in one business day, you will be provided with th e account information for new registrations.
While all c ustomers worldwide a re invi ted to o btain a SupportNet -Web site login, the SupportNet-Email services are currently limited to customers who receive support from Mentor support offices in North Americ a or Europe. If you receive support from Mentor offices outside of North America or Europe, please contact your local field office to obtain assistance for a technic al-support issue.

Model Technology customers

Support questions may be s ubmitted through the Mode l Te chnology web site at: www.model.com cases to support@ model.com this format, in the body of your email message:
• Your name: Company: Email address (if different f rom message address): Telephone: FAX (optional):
. Model T echnology customers may als o email t est
; please prov ide the foll owing info rmati on, in
• Model
• Model (Use the Help About dialog box with Windows; type workstations.)
• Host operating system version:
• PC hardware security key authori zation number:
• Host ID of license server for workstations:
• Description of the proble m (please include the exact wording of any error messages):
product (EE or PE, and VHDL, VLOG, or PLUS):
Sim
Version:
Sim
Tech Support, Update s & Licens ing
vcom
for UNIX
27

Technical support - other channels

For customers who purchased Model an OEM, or VAR, support is availa ble at the following:
Annapolis Microsystems
email: wftech@annapmicro.com telephone: 1-410-841-2514 web site: http://www.annapmicro.com
Exemplar Logic
email: support@ exemplar.com telephone: 1-510-789-3333 web site: http://www.exemplar.com
Hewlett Packard EEsof
email: hpeesof_support@hp.com telephone: 1-800-HPEESOF (1-800-473-3763) web site: http://www.hp.com/go/hpees of
Synplicity
email: support @ synplicity.com telephone: 1-408-617-6000 web site: http://www.synplicity. com
as part of a bundle d pr oduct fr om
Sim

Updates

Mentor customers: getting the latest version via FTP

You can ftp th e latest EE or PE version of th e softwar e from the SupportNe t site at ftp://supportnet.me ntorg.com/pub/men tortech/modeltec h/ Instructions are there a s well. A valid license file from Mentor Graphics is needed to uncompress the Model Technology is required to uncompress the Model
license@model.com
Start Here for ModelSim EE
28
if you are a curr ent PE customer and nee d a password.
EE files. A password from Model
Sim
PE files. Contact
Sim
.

Model Technology customers: getting the latest version via FTP

You can ftp the latest version of the software from the web site at
ftp://ftp.m odel.com
Model Technology is needed to uncompress the Model password from Model Technolo gy is neede d to uncompres s the Model PE files. Contact license@model.com need a password.
. Instr uctio ns are t here as well. A vali d lice nse fi le fro m
EE files. A
Sim
if you are a current PE customer and
Sim
Licenses - Model
Sim
EE

Where to obtain your license

Mentor Graphics customers must contact their Mentor Grap hics salesperson for Model Model Tec h nolo gy at license@model.com
EE licenses from Model Technology. Please contact Model
Sim
EE licensing. All other customers may obtain
Sim
.

If you have trouble with licensing

Contact your normal tec hnical support channel:
Technical su pport - by telephone (p25)
Technical su pport - electronic support services (p26)
Technical support - other channels (p28)
All customers: Model
Model Globetrotter FLE Xlm license files contain lines that can be referr ed to by the word th at appears first on t h e line. Each kind of line has a spec if ic purpose and there are many more kinds of lines that MTI does not use.
EE uses Globetrotte r’s FLEXlm license manager and files .
Sim
Sim
EE licensing
A
license.dat
SERVER hostname 11111111 1650 DAEMON modeltech ./modeltech ./options FEATURE vcom modeltech 1998.080 31-aug-98 1 \ 0C944D8F0C79B02EF5CF ck=117
file example
Tech Support, Update s & Licens ing
29
FEATURE vsim modeltech 1998.080 31-aug-98 1 \ FCB4FD0F2A635C20E5CF ck=128 FEATURE vlog modeltech 1998.080 31-aug-98 1 \ 0C944D9F176CA773E889 ck=10 FEATURE vsim-vlog modeltech 1998.080 31-aug-98 1 \ FCB41D9FC43C87567DBC ck=116
FEATURE hdlcom modeltech 1998.080 31-aug-98 1 \ 4C94EDFF6A00858BC8F2 ck=93 FEATURE hdlsim modeltech 1998.080 31-aug-98 1 \ 4CF48DDF6A6EA59BCEF2 ck=89 # NOTE: You can edit the hostname on the SERVER line (1st arg), # the port address on the SERVER line (3rd arg), the paths # to the daemon and options files on the DAEMON line # (2nd and 3rd args), or any right-half of a string (b) # of the form a=b where (a) is all lowercase. (For example, # xxx in vendor_info="xxx" can be changed). # Any other changes will invalidate this license.
A Globetrotter FLE Xlm lic ense fil e conta ins in format ion about the license server, the daemon required to authorize the feature, and a line for each product feature you are a uthorized to execute.
The fi r st li ne is a SER V ER line ; it spells ou t w h ic h comput er o n th e network is the license server. The license server is a network resource that will manage t he fe atures for all u sers of Mode l
products. The SERVER
Sim
line includ es the serve r's hos tname (the s erver’s networ k identifi cation - for Windows, check the Netwo rk pr operties Identifica tion tab), hostID (a unique serial number), and a socket number. The hostname and socket number may be changed i n a lice nse file , bu t any change to th e host ID will invalidate the licens e. If the host is a Windows machine, the hostID is the FLEXid security key number, and will take the alpha-numeric form: 7-xxxxxxxx, or 8-xxxxxxxx.
If you need to fi nd the unique server ID, us e one of th ese UNIX commands: for Sun,
hostid
; for HP,
/etc/lanscan
; for IBM RISC/6000:
uname -m
determine the sec urity key ID on a Windows server, from the DOS prompt, invoke:
lmutil lmhost id -f lexid
(located in the
modelsim\win32
directory).
A DAEMON line specifies the name of the license daemon and the locations of the da emon an d options files it will us e. Th is is the full path t o the modeltec h daemon. In the exa mple file, the UNIX "./" means "look in the current direc tor y". This i s the direct ory i n which t he serve r was sta rted. If the server is to be started from another dire ct ory, the full path to the
modeltech
30
and
Start Here for ModelSim EE
files would need to be adde d to this line.
options
. To
For example,
DAEMON modeltech /usr/mti5.2/sunos5/modeltech \ /usr/mti5.2/sunos5/options
A FEATURE line describe s how many li censes (" token s") ar e availa bl e; it contains the feature name, daemon required, most current build date authorized to run, token expiration date, number of tokens for the feature, license code, and a ch ecksum. The featu res are:
is a VHDL compilation fea ture
vcom
is a VHDL simulation feature
vsim
is a Verilog compilation fea ture
vlog vsim-vlog
is a Verilog simulation feature
When a VHDL design is compiled, a design is compil ed, a simulated, a
vsim-vlog
is used. This is why two people running different single-
token is used. When a Verilog design is simulated,
vsim
token is used. When a VHDL design is
vlog
language designs can work at the same time with one Model
token is used. When a Verilog
vcom
Sim
PLUS product. When a design with both languages is run, one of ea ch token is checked out.
With Model
EE/LNL,
Sim
FEATURE lines ar e ad ded. Wit h LNL
hdl
(language-neutral licensing), either VHDL or Verilog - but not both - can be used. The hdl FEATURE lines are shown in the example:
hdlcom hdlsim
is a compilation feature used with either VHDL or Verilog
is a simulation feature used with either language
Notice the FEATURE lines. If a line is too long for the email program, a backslash ("\") appears at the end of the line. A UNIX system reads that as "whatever you rea d on the next l ine belongs on thi s li ne". So ne ver edi t out the "\" when you are tra nscribing a l icense file. Ne ver put anothe r character afte r it ei th e r.
All the import ant line s end in che cksums. FL EXlm will le t you kno w if you mistyped somethi ng when transcribing the license files because the checksum will not ma tch the line's contents. (GLOBE tr otter has a utility that will report any che cksum errors in a file. Use this command: lmchksum <lice n se.file>) Lin es that star t wi th "#" ar e comment s.
If you want to learn more about the tools that license Model license manager ap pendix in the Model
reference manual, and visit
Sim
GLOBEtrotter at http://www.globetrotter.com/home.ht m
.
, read the
Sim
Tech Support, Update s & Licens ing
31

All customers: maintenance renewals and EE licenses

When main tenanc e is r ene wed, a n ew licen se f ile t hat in cor porate s the n ew maintenance expiration date will be autom atically sent to you. If maintenance is not renewed, the curre nt lic ense file will s till pe rmit the use of any version of the software bui lt before the maintenanc e expired until the stop date is reached .

All customers: license transfers and server changes

Model Technology and Mentor Graphics both charge a fee for server changes or license transfers. Contact sales@model.com information from Model Technology, or contact your local Mentor Graphics sales office for Mentor Graphics purchases.
for more

Online References

The Model Technolo gy web s ite includes links to many EDA information sources. Check the links below for the most current information.

Books and publications

model.com/support/tnbooksvhd.html

Partners

model.com/partners/index.html

Training partners

model.com/support/training.html

Resources

Useful quick guides and other references.
model.com/resources/index.html
Start Here for ModelSim EE
32

Model Technology License Agreement

Software Licens e Agreement This i s a le gal ag re emen t betw ee n you , th e end user, an d Mod el Te chno lo gy In corp ora ted (MTI). By opening the sealed package, or by signing this form, you are agreeing to be bound by the terms of this agreement. If you do not agree to the terms of this agreement, promptly return the un op en ed pa cka ge a nd al l ac com pa nyi ng i t ems to t he p lac e yo u o bt ain ed th em for a full refund.

Model Technology Software License

1. LICENSE. MTI grants to you the the enclosed software program (the "SOFTWARE") for each license you have purchased. The SOFTWARE must be used on the computer hardware server equipment that you ident ified in w riting by make, model, an d works tation or host ide ntifica tion number an d the equipment served, in machine-readable form only, as allowed by the authorization code provided to you by MTI or its agents. All authorized systems must be used within the country for which the systems were sold. Model within a one-kilometer radius identified in writing to MTI. This restriction does not apply to single Model products may be relocated within the country for which sold.
2. COPYRIGHT. The SOFTWARE is owned by MTI (or its licensors) and is protected by United States copyright laws and international treaty provisions. Therefore you must treat the SOFTWARE like any other copyrighted material, except that you may either (a) make one copy of the SOFTWARE solely for backup or archival purposes, or (b) transfer the SOFTWARE to a single hard disk provided you keep the original solely for backup or archival purposes. You may not copy the written materi als accompanying t he SOFTWARE.
3. USE O F SOFTWARE. The SOFTWARE is licensed to you for internal use only. You shall not conduct bench marks or othe r evalua tio ns of the S OFTWARE witho ut the ad vance writte n consent of an authorized representative of MTI. You shall not sub-license, assign or otherw ise transfer the license granted or the rights under it without the prior written co nsent of MTI or its applicable licenso r. You shall keep the SOFTW ARE in a restricted and secured area and shall grant access only to authorized persons. You shall not make software available in any form to any person other than your employees whose job performance requires access and who are specified in writing to MTI. MTI may enter your business premises during normal business hours to inspect the SOFTWARE, subject to your normal security.
PE lice nses lock ed by a hardw are se curity ke y, and suc h Model
Sim
nontransferable, nonexclusive
EE licenses must be loc ated at a single site, i.e.
Sim
right to us e on e cop y of
Sim
PE
4. PERMISSION TO COPY LICENS ED SOFTW ARE. You may co py the SOFTW ARE only as reasonably necessary to support an authorized use. Except as permitted by Section 2, you may not make copies, in whole or in part, of the SOFTWARE or other material provided by MTI without the prior written consent of MTI. For such permitted copies, you will include all notic es an d le gends e mb ed de d in the SO FTWARE a nd affixe d to its me di um and con tai ne r
Model Technology License Agreement
33
as received from MTI. All copies of the SOFTWARE, whet her provided by MTI or made by you, shall remain the property of MTI or its licensors.
You will maintain a record of the number and location of all copies of the SOFTWARE made, including copes that have been merged with other software, and will make those records available to MTI or its applicable licensor upon request.
5. TRADE SECRET. The source code of the SOFTWARE is trade secret or confidential information of MTI or its licensors. You shall take appropriate action to protect the confidentiality of the SOFTWARE and to ensure that any user permitted access to the SOFTWARE does not provide it to others. You shall take appropriate action to protect the confidentiality of the source code of the SOFTWARE. You shall not reverse-assemble, reverse-compile or otherwise reverse-engineer the SOFTWARE in whole or in part. The provisions of this section shall survive the termination of this Agreement.
6. TITLE. Title to the SOF TWARE licensed to you or copies thereof are retained by MTI or third parties from whom MTI has obtained a licensing right.
7. OTHER RESTRICTIONS. You may not rent or lease the SOFTWARE. You shall not mortgage, pledge or encumber the SOFTWARE in any way. You shall ensure that all support service is performed by MTI or its designated agents. You shall notify MTI of any loss of the SOFTWARE.
8. TERMINATION. MTI may terminate this Agreement, or any license granted under it, in the event of breach or default by you. In the event of such termination, all applicable SOFTWARE shall be returned to MTI or destroyed.
9. EXPORT. You agree not to allow the MTI SOFTWARE to be sent or used in any other country except in compliance with this license and applicable U.S. laws and regulations. If you need advice on export laws and regulations, you should contact the U.S. Department of Commerce, Export Division, Washington, DC 20230, USA for clarification.
Important Notice Any provision of Model Technology Incorporated SOFTWARE to the U.S. Government is with "Restricted Rights" as follows: Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraphs (a) through (d) of the Commercial Computer­Restricted Rights clause at F AR 2.227-19 when applicable, or in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clauses in the NASA FAR Supplement. Any provision of Model T echnology documentation to the U.S. Government is with Limited Rights. Contractor/manufacturer is Model Technology Incorporated, 10450 SW Nimbus Avenue / Building R, Portland, Oregon 97223-4347 USA.
Limited Warranty LIMITED WARRANTY. MTI warrants that the SOFTWARE will perform substantially in accordance with the accompanying written materials for a period of 30 days from the date of receipt. Any implied warranties on the SOFTWARE are limited to 30 days. Some states do not allow limitations on duration of an implied warranty, so the above limitation may not apply to you.
Start Here for ModelSim EE
34
CUSTO M E R R E M ED IES. MTI ’s en tire liab ili t y an d yo ur excl us iv e remedy shall b e, a t MT I’s option, either (a) return of the price paid or (b) repair or replacement of the SOFTWARE that does not meet MTI’s Limited Warranty and which is returned to MTI. This Limited Warranty is void if failure of the SOFTWARE has resulted from accident, abuse or misapplication. Any replacement SOFTWARE will be wa rranted for the remainder of the original war ranty pe riod or 30 days, whichever is lon ger.
NO OTHE R WARRAN TIES. MTI disclai ms all other warranti es, either express or implied , including but not limited to implied warranties of merchantability and fitness for a particular purpose, with respect to the SOFTWARE and the accompanying written materials. This limited warranty gives you specific legal rights. You may have others, which vary from state to state.
NO LIABILITY FOR CONSEQUENTIAL DA MAGES. In no event shall MTI or its su pp liers be liable for any damages whatsoever (including, without limitation, damages for loss of busine ss profits, business interrupti on, loss of business information, or other pecuniar y loss) arising out of the use of or inability to use the s e MTI products, even if MTI has been advised of the possibility of such damages. Because some states do not allow th e exclusion o r limitation of liability for consequential or incidental damages, the above limitation may not apply to you.
Model Technology License Agreement
35
Keep these numbers handy for tech support:
UNIX server hostid # :
FLEXid security key # :
Model Technology Inco rporated www. m odel.com
Thank you for purchasing ModelSim!
Model Technology
A MENTOR GRAPHICS COMPANY
www.model.com
Loading...