Skip to content

Commit 11957b6

Browse files
committedOct 28, 2012
Add informations about how to use dmp in README.md
1 parent 64bf35c commit 11957b6

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed
 

‎README.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ It is being developped in parallel with this project <a href="https://github.com
88
LatticeMico32 softcore CPU.
99

1010
<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.
1213

1314
<b>Draw Me a Pipeline</b> represents interesting wire/register values conditioning the pipeline state changes
1415
as well as stage inputs and outputs.
@@ -19,4 +20,27 @@ On a Debian Squeeze machine:
1920

2021
$ sudo apt-get install python2.6 python-pydot python-argparse
2122

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+
2246
[1] -- https://github.com/fallen/milkymist-mmu-simulation

0 commit comments

Comments
 (0)
Please sign in to comment.