EE 3060 - Procedures

Independent Study Account Setup (Updated Spring 2002)

To Setup Account for use with Verilog and Other Software

ModelSim Simulator (Updated Spring 2001)

Compile, simulate (and view waveforms) a Verilog description on the ECE Suns

Simulating, Editing, and Re-Simulating.

X-Window Software (Spring 2000)

Running Graphical Software on an X-Server-Equipped PC

Emacs Text Editor (Spring 2001)

Setting up Emacs for the First Time

Starting Info, Emacs' Help

Independent Study Account Setup (Updated Spring 2002)

The instructions below are for students that need a Sun account for the independent study course. If you already have an account you don't need to get another one but you'll still need to follow the account setup instructions that follow.

Get a Sun Account Application from Saied Andalib's office in room 150.
Fill out the form, use "Verilog Independent Study" for the purpose of the account.
Bring the form to me (Dr. Koppelman) for my signature.
Return the form to Saied and ask him when you can log in.
When you are able to log in follow the account setup instructions below.

To Setup Account for use with Verilog and Other Software

The instructions below setup your account so that it can use the Verilog Simulation and Synthesis software and the Emacs initialization file for working with Verilog. The steps are not necessary for a regular EE 3755 class account (or a future regular Verilog course).

Beware, these steps have not been checked. Please report any problems immediately.

Copy files /home/classes/ee3755/com/etc/.cshrc and /home/classes/ee3755/com/etc/.login to your home directory.
```
cp /home/classes/ee3755/com/etc/.cshrc ~
cp /home/classes/ee3755/com/etc/.login ~
```
If you don't want to replace your .cshrc or .login file then add the following to .cshrc:
setenv MODELSIM /home/classes/ee3755/com/tcl/modelsim.ini setenv DOPATH /home/classes/ee3755/com/tcl setenv PATH /home/classes/ee3755/com/bin:${PATH}
and make sure the .login sets vt100 as the default terminal.
Copy file /home/classes/ee3755/com/lisp/.emacs to your home directory.
```
cp /home/classes/ee3755/com/lisp/.emacs ~
```
If you already have an initialization file for The One True Editor just copy the lines up to
(mouse-wheel-mode 1)
to your .emacs.
Copy the files in /home/classes/ee3755/com/etc/.dt/icons /home/classes/ee3755/com/etc/.dt/types to your corresponding directories.
```
cp /home/classes/ee3755/com/etc/.dt/icons/* ~/.dt/icons
cp /home/classes/ee3755/com/etc/.dt/types/* ~/.dt/types
```
You may be prompted whether you want to overwrite a file. Answer yes, unless you've made changes to the command panel on the bottom of the screen.
Test if everything works by logging out and back in (or source the .cshrc file and restart the window manager).
There should be an Emacs overflowing sink icon on the command panel.
Start Emacs by clicking the icon.
The overflowing sink should start dripping and Emacs should start. Emacs should have an "EE 3755" menu.
Start the simulator by clicking the small arrow above the Emacs icon and then clocking the Modelsim entry in the slide-up menu
Modelsim should start.
If you're done with them, Exit Emacs and Modelsim (use the file menus) and proceed with the Modelsim and Emacs procedures linked to the EE 3755 Web page. (The ones here are not up to date.)

ModelSim Simulator (Updated Spring 2001)

Compile, simulate (and view waveforms) a Verilog description on the ECE Suns

The procedure below is for setting up and running the software for the first time on a sample Verilog description, "bo.v". Alternate instructions can be found in lesson 7 of the ModelSim tutorial. (See the references page.)

Log in to your account.
Either use a specially prepared class account or follow the independent study setup instructions above.
Create a new directory and make it current.
```
mkdir proj1
cd proj1
```
Copy the Verilog file to the directory.
```
cp /home/classes/ee4702/files/v/bo.v .
```
Create a "library" named work.
```
vlib work
```
In the Unix tradition, this command generates no output if it works.
The library is where the HDL (Verilog and VHDL) compilers put the compiled designs.
This step is usually done just once per directory.
Start the ModelSim GUI (Graphical User Interface)
```
vsim -gui
```
You will be greeted by a rhinoceros-emblazoned dialog box. Select Done. The dialog box should disappear, leaving a window with the title "ModelSim EE/Plus".
There are buttons to create and open projects. Projects won't be used in these instructions though they can be used to complete assignments.
Compile the Verilog description in one of the following ways:
- Enter
```
vlog bo.v
```
  in the Unix shell or in the ModelSim window (at what will initially be a "ModelSim>" prompt).
- With Emacs set up as described elsewhere, load the Verilog file bo.v into a buffer and press [f9] or select "Compile" from the "Verilog" pull-down menu in Emacs.
- Select "Compile" from the "Design" pull down menu from the ModelSim window. A "Compile HDL Source Files" dialog box should pop up. Select file "bo.v" and click "Edit Source". A "source_edit" window should pop up. Next clock "Compile" in the "Compile HDL Source Files" dialog.
- Click the compile button (the leftmost botton one) on the ModelSim window toolbar.
In all cases the compiler will generate output that looks something like:
```
vlog -reportprogress 300 -work work {/home/faculty1/koppel/teach/v00/ex/proj/bo.v}
# Model Technology ModelSim EE vlog 5.3a Compiler 1999.09 Sep 20 1999
# -- Compiling module byte_order
# -- Compiling module test_bo
# Top level modules:
# 	test_bo
```
If there had been compile errors then you could jump to offending source lines by double clicking the corresponding error message in the ModelSim window or single-clicking with the center mouse button in the Emacs *compilation* window.
By default the source window is read only. Select "read only" from the Edit menu to toggle out of read only mode.
Load a design into the simulator by selecting "Load New Design" from the ModelSim "Design" menu. A "Load Design" dialog should pop up. Select "test_bo", the testbench for the design, then clock "Load". The dialog box should disappear and the ModelSim window should show an impressive legal notice followed by:
```
# Loading work.test_bo
# Loading work.byte_order
VSIM 5>
```
Learn how to move windows to the front of the display. On a Sun workstation this can be done using the "Front" button on the left-hand key cluster.
Bring up all the simulator information windows by typing
```
view *
```
in the ModelSim window. Windows should cover the whole display.
Windows can be opened individually using the ModelSim "View" menu.
In the "structure" window make sure "test_bo" is highlighted.
Drag the blue dot next to "in" in the "signals" window to the "wave" window.
Repeat the process for "middle" and "out".
This must be done before running the simulation (otherwise you can't view those signals).
Run the simulation by pressing the "Run All" icon (a text page with a double down arrow) or by selecting "Run -All" from the "Run" ModelSim menu.
The ModelSim window should show "# Finished", in addition to other changes.
View the waveforms by pressing the "Zoom All" icon (the rightmost magnifying glass) on the wave window toolbar or by using the "Zoom" menu. The waveforms should fill the waveform display area.
To change the signal values to hexadecimal or some other radix, double click the signal name in the "wave" window.
To exit, select "Quit" from the ModelSim "File" menu. This will get rid of all the windows. If there are unsaved changes in the source window you'll be prompted to save but you won't be warned to save formating information you might have specified in the "wave" window and elsewhere.
Read the Editing and Re-Simulating procedure. There are some non-obvious things you need to know.
See Chapter 10 of the ModelSim EE/SE User's Manual for more information.

Simulating, Editing, and Re-Simulating.

The procedure below is to be used after you set up a directory and initially compiled a Verilog description, perhaps using the procedure above. The steps for starting the ModelSim software are slightly different after a description is compiled.

Make the directory containing the Verilog description current.
```
cd ~/proj1
```
Start the GUI specifying the top-level module (usually the testbench) you want to simulate:
```
vsim test_bo
```
If you rather not type the name of the top-level module start the simulator without arguments:
vsim
You will be greeted by the rhinoceros. Click "Done", a "Load Design" dialog should pop up. Select the top level module then click "Load".
Open the "structure", "signals", "wave", and other windows using the "View" menu or by issuing "view" commands in the ModelSim window. Drag the signals you want to see into the "wave" window and make any other changes.
Run time simulation by typing "Run" into the ModelSim window, clicking one of the run toolbar icons, or selecting one of the "Run" pull-down menu entries. The status bar at the bottom of the ModelSim window should show simulation time and the wave, signal, and perhaps other windows should be updated with simulated signal values.
You are not satisfied. (Pretend, if necessary.) Edit the Verilog program using the source window or your favorite text editor.
Re-compile by pressing [f9] in Emacs or by selecting "Compile" from the "Design" pull-down menu in the ModelSim window, by pressing the toolbar, or by entering vlog bo.v in the ModelSim window. If necessary, fix bugs and recompile.
Beware, if you select "Compile" while a compile dialog box is already open an error dialog (with the title "Error in Tcl Script") will pop up. If this happens click "OK" in the error dialog and find the already-opened compile dialog.
If you want to simulate the same top-level module skip this step. Suppose "bar" is the name of the new top-level module you want to simulate. Enter vsim bar in the ModelSim window or select "Load New Design..." from the "Design" pull-down menu.
Click the restart toolbar botton (to the right of the clipboard) or select "Restart..." from the "Run" menu in the ModelSim window. Click "Restart" on the dialog that should have popped up.
Run the simulation again.

X-Window Software (Spring 2000)

Setting up the MI/X X-Server

On a computer running an X-server you can use graphical X-Windows programs that are actually running on another computer. For example, if you had an X-server on your PC at home your could use the ModelSim software, which would actually be running in the EE building. Speed varies from sluggish to unbearably slow, though text editing is not so bad. The MicroImages MI/X 2.0 X-Server is currently offered with a 15-day trial period, after which you'll have to pay $25 to continue using it. To use it with ModelSim and many other X-windows program additional fonts have to be installed. These instructions are for installing the server and the additional fonts.

Download the MicroImages X-server distribution (MIX) (3.7 MB) and the fonts (651 kB).
Unpack the MIX distribution into an empty, temporary directory. Run the setup program, following its directions.
Start the X-server using the entry inserted into the Start Menu. Test the installation by following the instructions below for logging in. Note: when a new window is opened you sometimes have to position the window yourself. In such a situation the new window will look like a frame, move it to the desired location and click. If you are able to start an xterm and nothing seems wrong, remove the install directory.
The only documentation for the MIX software is the MicroImages FAQ.
Copy the font distribution into directory c:/Program Files/MicroImages/MIX/bdf/misc/ and unpack it. Two files, fonts.dir and fonts.ali should be overwritten. If your unpacking program asks for overwrite permission, say yes.
If the X-server is still running, exit it. (By default, by closing all X-windows or by closing the main (root) X-window.) Re-start the MIX X-server and try to start ModelSim. Text labeling the menus and buttons should be clearly readable. If the additional fonts weren't installed they would be difficult to read at best.

Running Graphical Software on an X-Server-Equipped PC

Follow these instructions after installing MI/X (see instructions above) or some other X-server on your Internet-connected PC.

Log into one of the Sun workstations using telnet or some other program. You can telnet into one of the following hosts: babble.ece.lsu.edu, batch.ece.lsu.edu, buz.ece.lsu.edu, chip.ece.lsu.edu, delta.ece.lsu.edu, fuzzy.ece.lsu.edu, image.ece.lsu.edu, isa.ece.lsu.edu, mars.ece.lsu.edu, oberon.ece.lsu.edu, optimal.ece.lsu.edu, pop.ece.lsu.edu, serial.ece.lsu.edu, uranus.ece.lsu.edu.
Start the X-server.
From the Unix shell enter the command setdisp. An "xterm" window should appear, which should be running your default shell (command interpreter). Graphical programs can be started from the xterminal, for example, xeyes, and vsim, and emacs. (Emacs also works on non-graphical connections.)
The setdisp command guesses where your logging in from, sets the DISPLAY environment variable, and starts xterm. Command setdisp foo bar foobar... starts foo with arguments bar foobar.. instead.
You may still be able to log in using xdm, but its use is discouraged and it may be discontinued.

Emacs Text Editor (Spring 2001)

Setting up Emacs for the First Time

Use of the Emacs text editor is optional.

The first time you run Emacs make sure there is not a file named .emacs in your home directory. (It will automatically be copied from ../files/lisp/.emacs.)
This file contains settings for Emacs. You can edit it to add, remove, or change the settings. The settings are specified using Emacs extension language, lisp.
Start emacs by typing emacs &. The Emacs window should pop up. There should be an "EE4702" pull-down menu in the upper left hand corner.

Using Emacs to Edit a File

Type emacs &. A window should pop up, the frame will be labeled Emacs. If the .emacs file was copied correctly there will be an "EE4702" pull-down menu.
Load a file by selecting "Open File..." from the Files menu.
Enter a file name. Note that text appears in the bottom of the main window in an area called the minibuffer, not in a dialog box. (Once loaded, the file name will appear in the mode line near the bottom of the window.)
Enter text in the buffer to try out the editor.
Select "Save Buffer" from the Files menu to save.
Select "Exit Emacs" from Files to exit.

Using Emacs to Edit Verilog

Special features for editing Verilog code. (Some work with other languages.)

Load a Verilog description into a buffer. Enter Verilog code (nothing special). Code should be syntax highlighted, alerting you to some syntax errors and giving you something pretty to look at.
Pressing tab will automatically indent the line the cursor is over. This is useful for catching syntax errors and keeping the description properly indented.
Pressing F9 will invoke the compiler. A window will open showing the compiler output. Clicking on an error message with the center mouse button will move the cursor to the line with the error.
Pressing return at the end of a line containing endmodule or some other ending keyword will automatically place a comment identifying the start.

Running the Emacs Tutorial

(The tutorial is an introduction for first-time users.)

Start emacs.
Select "Emacs Tutorial" from the "Help" menu. Do not attempt to learn everything the first day.

Starting Info, Emacs' Help

(Info provides detailed documentation for Emacs and other programs.)

Start Emacs
Select "Browse Manuals" from "Help" menu.
Following instructions, select the Emacs manual.

David M. Koppelman - koppel@ece.lsu.edu

Modified 1 Feb 2002 17:27 (2327 UTC)

EE 3060 - Procedures

To Obtain an Account

To Setup Account for use with Verilog and Other Software

Compile, simulate (and view waveforms) a Verilog description on the ECE Suns

Simulating, Editing, and Re-Simulating.

Setting up the MI/X X-Server

Running Graphical Software on an X-Server-Equipped PC

Setting up Emacs for the First Time

Using Emacs to Edit a File

Using Emacs to Edit Verilog

Running the Emacs Tutorial

Starting Info, Emacs' Help

To Obtain an Account

To Setup Account for use with Verilog and Other Software

Compile, simulate (and view waveforms) a Verilog description on the ECE Suns

Simulating, Editing, and Re-Simulating.

Setting up the MI/X X-Server

Running Graphical Software on an X-Server-Equipped PC

Setting up Emacs for the First Time

Using Emacs to Edit a File

Using Emacs to Edit Verilog

Running the Emacs Tutorial

Starting Info, Emacs' Help