## Prerequisites
- [Java](http://jdk.java.net/) 11 or later (or [Oracle Implementation](https://www.oracle.com/technetwork/java/javase/downloads/index.html))
-- [Eclipse](https://www.eclipse.org/downloads/) 2019-03 or later (TODO: do earlier versions work?)
+- [Eclipse](https://www.eclipse.org/downloads/) 2019-03 or later (Open question: do earlier versions work?)
## Install Mograsim
+### Via the Eclipse Marketplace
+1. Start Eclipse.
+2. Go to "Help" -> "Eclipse Marketplace...".
+3. Search for "Mograsim"
+4. Click on "Install" and follow the instructions.
+
+### Manually via an updatesite
1. Start Eclipse.
2. Go to "Help" -> "Install New Software...".
3. Add the Mograsim update site:
1. Click on "Add...".
- 2. Next to "Location:", enter the update site address.
-Note: Currently, there is no online update site for Mograsim. You have to build Mograsim yourself as described in [Building Mograsim](building_mograsim.md).
+ 2. Next to "Location:", enter the update site address. Currently, this is https://mograsim.net/updatesite/. This address could, however, change in the future.
3. Click on "Add".
1. Tick "Mograsim".
2. Click on "Next >" two times, read and accept the license, and click on "Finish".
## Enable the Launch action set
-1. Go to "Window" -> "Perspective" -> "Customize Perspective...".
-2. Go to the tab "Action Set Availability".
-3. Under "Available action sets", enable "Launch" (if it is not already enabled); click on "Apply and Close".
+1. Go to "Window" -> "Perspective" -> "Open Perspective"
+ and select "Mograsim" or click "Other..." and then select Mograsim.<br>
+ This can also be done by the perspective switcher on the right.
## Create a new Mograsim project
-1. Create a new Eclipse project. (Go to "File" -> "New" -> "Project...", select "General" -> "Project".)
-2. Add the Mograsim nature to the new project and set it up:
- 1. Open the properties dialog of the new project. (Right-click on it, select Properties.)
- 2. Go to the "Project Natures" page, click on "Add...". If a confirmation dialog pops up, confirm.
- 3. Select "Mograsim Project Nature"; click on "OK".
- 4. Click on "Apply and Close" and re-open the properties dialog.
- 5. Go to the new "Mograsim" page, select "Am2900Simple", click on "Apply and Close".
+1. Create a new Mograsim project. (Go to "File" -> "New" -> "Project...", select "Mograsim" -> "Mograsim
+ Project".)
+2. Give it a project name and a Mograsim machine and finish.
+
+Alternatively, you can create a general Project and add the Mograsim nature to the new project and set it up:
+
+1. Open the properties dialog of the new project. (Right-click on it, select Properties.)
+2. Go to the "Project Natures" page, click on "Add...". If a confirmation dialog pops up, confirm.
+3. Select "Mograsim Project Nature"; click on "OK".
+4. Click on "Apply and Close" and re-open the properties dialog.
+5. Go to the new "Mograsim" page, select "Am2900Teaching", click on "Apply and Close".
## Write a MPM file (containing the microprogram)
3. Write the memory contents.
Each table row contains one (16 bit wide) memory cell.
-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.
-Don't use the "Set active" button. (TODO: remove it)
+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.
## Open the views "Simulation", "Debug", "Memory" and "Registers"
4. If you don't have a MEM file, leave the according field blank. This causes the memory to be initialized with 0.
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.
-The machine doesn't start running yet since it starts paused. (TODO: make a checkbox for this)
+The machine doesn't start running yet since it starts paused.
## Set up and get used to the views
Using the slider or by directly entering a number in the text field, the machine can be slowed down or sped up.
-Also, a "step by step execution" mode can be enabled. (TODO: use "Step over" instead)
+Also, a "step by step execution" mode can be enabled.
Step by step execution means that the machine is automatically paused on each rising edge of the clock.
At the bottom of the Simulation view, a single instruction table row is displayed. This row contains the instruction currently being executed.
### Memory view
-1. In the Memory view, click on the green +, enter 0 and click on "OK".
+1. Select the preferred numerical representation
2. Right-click on the table -> "Format...".
3. Select 16 units per row and one unit per column. (8 units per row if 16 don't fit on the screen.)
### Register view
-1. Expand the pseudo register group.
+1. Expand the register group you would like to view.
It should contain the registers R0-R15 as well as the Q register.
-All of them should be 0, displayed as a bitstring (TODO: view in hex).
+All of them should be 0, displayed as a bitstring
-It is possible to change the register contents via this view by clicking on the old value and entering a new bitstring (TODO: a hex integer). It is not recommended to use `Z` in these bitstrings.
+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.
### Debug view
- If nothing Mograsim-related seems to be installed after installing Mograsim, make sure Eclipse uses Java 11 or later.
1. Go to "Help" -> "About Eclipse IDE", click on "Installation Details", go to the tab "Configuration".
2. Search the line starting with "java.version=". (This line is in the "System properties" block, which usually occupies the first 200 lines.)
-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.
\ No newline at end of file
+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.
projects / Mograsim.git / blobdiff