Skip to content
This repository
Browse code

Add informations about how to use dmp in README.md

  • Loading branch information...
commit 11957b637eef2b193c5bdd9fa703f5951891bef7 1 parent 64bf35c
Yann Sionneau authored October 28, 2012

Showing 1 changed file with 25 additions and 1 deletion. Show diff stats Hide diff stats

  1. 26  README.md
26  README.md
Source Rendered
@@ -8,7 +8,8 @@ It is being developped in parallel with this project <a href="https://github.com
8 8
 LatticeMico32 softcore CPU.
9 9
 
10 10
 <b>Draw Me a Pipeline</b> uses the pydot library to generate a diagram representing the changes in each of the CPU pipeline
11  
-stages during the simulation of the execution of a given binary file.
  11
+stages during the simulation of the execution of a given binary file. Early releases of <b>Draw Me a Pipeline</b> will only
  12
+support HTML rendering.
12 13
 
13 14
 <b>Draw Me a Pipeline</b> represents interesting wire/register values conditioning the pipeline state changes
14 15
 as well as stage inputs and outputs.
@@ -19,4 +20,27 @@ On a Debian Squeeze machine:
19 20
 
20 21
     $ sudo apt-get install python2.6 python-pydot python-argparse
21 22
 
  23
+How to use it:
  24
+
  25
+    $ git clone https://github.com/fallen/milkymist-mmu-simulation.git # Clone the simulation repository
  26
+    $ git clone https://github.com/fallen/dmp.git # Clone the dmp tool to analyse simulation output
  27
+    $ cd milkymist-mmu-simulation
  28
+    $ source /opt/Xilinx/14.3/ISE_DS/settings32.sh # Sets environment up to use Xilinx tools 
  29
+    $ export PATH=$PWD/tools/h2a/:$PATH # Adds h2a tool in PATH to convert binary files to ASCII hex files
  30
+    $ make tools # Builds h2a tool
  31
+    
  32
+Uncomment "`define CFG_DRAW_ME_A_PIPELINE" in lm32_include.v
  33
+
  34
+Comment other defines which could lead to text being written to the console during simulation (e.g. CFG_PIPELINE_TRACES, CFG_UART_ENABLED, CFG_VERBOSE_DISPLAY_ENABLED)
  35
+    
  36
+    $ make dmp # Runs the actual simulation and saves pipeline informations to dmp.data file
  37
+    $ cd ../dmp
  38
+    $ ./dmp --starttime 2700 --endtime 3000 ../milkymist-mmu-simulation/dmp.data
  39
+
  40
+And there you are, <b>Draw Me a Pipeline</b> has generated an HTML visualization of the pipeline states during your simulation
  41
+and saved it under "output.html".
  42
+
  43
+You can now open it with your favorite web browser!
  44
+
  45
+
22 46
 [1] -- https://github.com/fallen/milkymist-mmu-simulation

0 notes on commit 11957b6

Please sign in to comment.
Something went wrong with that request. Please try again.