docs/getting_started.md

   1 # Getting started with Mograsim
   2
   3 ## Prerequisites
   4
   5 - [Java](http://jdk.java.net/) 11 or later (or [Oracle Implementation](https://www.oracle.com/technetwork/java/javase/downloads/index.html))
   6 - [Eclipse](https://www.eclipse.org/downloads/) 2019-03 or later (Open question: do earlier versions work?)
   7
   8 ## Install Mograsim
   9
  10 1. Start Eclipse.
  11 2. Go to "Help" -> "Install New Software...".
  12 3. Add the Mograsim update site:
  13         1. Click on "Add...".
  14         2. Next to "Location:", enter the update site address. Currently, this is http://vmschulz34.in.tum.de/updatesite/. This address could, however, change in the future.
  15         3. Click on "Add".
  16 1. Tick "Mograsim".
  17 2. Click on "Next >" two times, read and accept the license, and click on "Finish".
  18 3. Confirm that you want to install unsigned content.
  19 4. Wait for the installation to complete (may take a while). When prompted, restart Eclipse.
  20
  21 ## Enable the Launch action set
  22
  23 1. Go to "Window" -> "Perspective" -> "Open Perspective"
  24    and select "Mograsim" or click "Other..." and then select Mograsim.<br>
  25    This can also be done by the perspective switcher on the right.
  26
  27 ## Create a new Mograsim project
  28
  29 1. Create a new Mograsim project. (Go to "File" -> "New" -> "Project...", select "Mograsim" -> "Mograsim
  30    Project".)
  31 2. Give it a project name and a Mograsim machine and finish.
  32
  33 Alternatively, you can create a general Project and add the Mograsim nature to the new project and set it up:
  34
  35 1. Open the properties dialog of the new project. (Right-click on it, select Properties.)
  36 2. Go to the "Project Natures" page, click on "Add...". If a confirmation dialog pops up, confirm.
  37 3. Select "Mograsim Project Nature"; click on "OK".
  38 4. Click on "Apply and Close" and re-open the properties dialog.
  39 5. Go to the new "Mograsim" page, select "Am2900Teaching", click on "Apply and Close".
  40
  41 ## Write a MPM file (containing the microprogram)
  42
  43 1. Create a new file with the extension ".mpm". (Right-click on the project -> "New" -> "File"; enter the filename; click on "Finish".)
  44 2. The Mograsim instruction editor should open. If not, right-click on the MPM file -> "Open With" -> "Other..."; select "Instruction Editor"; click on "OK".
  45 3. Write a microprogram. (Note: The MPROM is hardcoded to be Opcode * 0x10.)
  46
  47 Every cell differing from the default value is highlighted with a cursive font and green background.
  48
  49 ## _(optional)_ Write a MEM file (containing the initial contents of the memory)
  50
  51 1. Create a new file with the extension ".mem" (as described above).
  52 2. The Mograsim memory editor should open. If not, open it as described above.
  53 3. Write the memory contents.
  54
  55 Each table row contains one (16 bit wide) memory cell.
  56 The two text fields labeled "Address" and "Number of cells" only refer to the cells displayed simultaneously in the editor. The editor internally retains all 65536 addressable cells.
  57
  58 ## Open the views "Simulation", "Debug", "Memory" and "Registers"
  59
  60 1. Go to "Window" -> "Show View" -> "Other...", select a view; click on "Open".
  61 The Simulation view is in the category "Mograsim" and the other views in "Debug".
  62
  63 It is recommended to move the Simulation view to the Editor pane.
  64
  65 ## Create a machine launch configuration and run it
  66
  67 1. Click on the little triangle next to the "Launch" symbol in the toolbar; click on "Run configurations...".
  68 2. Right-click on "Mograsim machine" -> "New Configuration".
  69 3. Enter the Mograsim project containing both the MPM and MEM file, as well as these files.
  70 4. If you don't have a MEM file, leave the according field blank. This causes the memory to be initialized with 0.
  71 5. Click "Run". The Simulation view now should contain a rectangle containing either the text "Am2900" in a very small font or a huge mess of smaller rectangles connected by colored lines.
  72
  73 The machine doesn't start running yet since it starts paused.
  74
  75 ## Set up and get used to the views
  76
  77 ### Simulation view (see also the [simulation model explanation](model.md))
  78
  79 Move the view around by dragging with the left mouse button held.
  80 Zoom in and out by either scrolling up or down or by dragging down and up with the middle mouse button held.
  81
  82 Using the slider or by directly entering a number in the text field, the machine can be slowed down or sped up.
  83
  84 Also, a "step by step execution" mode can be enabled.
  85 Step by step execution means that the machine is automatically paused on each rising edge of the clock.
  86
  87 At the bottom of the Simulation view, a single instruction table row is displayed. This row contains the instruction currently being executed.
  88 The MPM can be modified by this line. This is not recommended, however, because changes done here are not reflected in the MPM file, and will be undone if the MPM file is hot-replaced (see below), even if the changed row didn't change in the hot replace. Also, as for a hot replace, these changes doesn't affect the currently active microinstruction.
  89
  90 ### Memory view
  91
  92 1. Select the preferred numerical representation
  93 2. Right-click on the table -> "Format...".
  94 3. Select 16 units per row and one unit per column. (8 units per row if 16 don't fit on the screen.)
  95
  96 The table now displays the contents of the currently running machine. At this moment, this should be equal to the contents of the initial memory specified when creating the launch configuration. This table updates automatically if the machine writes a memory cell. In this case, for a short time, this cell is highlighted using a red font and with a small delta symbol in the cell's corner.
  97
  98 ### Register view
  99
 100 1. Expand the register group you would like to view.
 101 It should contain the registers R0-R15 as well as the Q register.
 102 All of them should be 0, displayed as a bitstring
 103
 104 It is possible to change the register contents via this view by clicking on the old value and entering a new bitstring. It is not recommended to use `Z` in these bitstrings.
 105
 106 ### Debug view
 107
 108 Lists all currently running machines. The Simulation, Memory, and Register view follow the selection done here.
 109 A Mograsim machine launch contains one debug target, which contains one thread labeled "pseudo thread".
 110 The pseudo thread contains one stack frame labeled "pseudo stack frame" as long as the machine is paused. Unfortunately, it is required by Eclipse that threads don't have stack frames as long as they are running.
 111 For the Memory view to work, the pseudo thread or pseudo stack frame of a machine launch needs to be selected; for the Register view, the stack frame needs to be selected.
 112
 113 ### Toolbar
 114
 115 The toolbar also contains some relevant buttons: "Resume", "Suspend", and "Terminate".
 116 Suspend not only causes the clock to stop, but freezes the other components and wires.  Because of this, some components can seem to be in an incorrect state, for example the two inputs of a NAND gate could be 1, while the output also is 1.
 117
 118 ## Start the machine
 119
 120 Set the simulation speed to the lowest setting.
 121 In the toolbar, click the "Resume" button.
 122 Slowly increase the simulation speed until the wires in the Simulation view start flickering. The machine is now running and starts executing the microprogram.
 123
 124 ## Notes
 125
 126 1. If the MPM file used by a machine launch is opened in the Instruction editor, the row corresponding to the microinstruction currently being executed is highlighted there using a bold font and yellow background.
 127 2. If the MPM file changes, after confirmation, the changes are hot-replaced into the machine.
 128         Changes in the MPM file don't affect the currently active microinstruction, however.
 129 3. Some of the behaviour described here can be changed in the Eclipse Preferences (in the pages "Mograsim" and "General" -> "Appearance" -> "Colors and Fonts"). For these cases the default behaviour is described.
 130
 131 ## Troubleshooting
 132
 133 - If nothing Mograsim-related seems to be installed after installing Mograsim, make sure Eclipse uses Java 11 or later.
 134 1. Go to "Help" -> "About Eclipse IDE", click on "Installation Details", go to the tab "Configuration".
 135 2. Search the line starting with "java.version=". (This line is in the "System properties" block, which usually occupies the first 200 lines.)
 136 3. If this line specifies a version less than 11, configure your Eclipse installation to use a Java 11 JRE (or later). See https://wiki.eclipse.org/FAQ_How_do_I_run_Eclipse%3F#Find_the_JVM.