aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPrashanth Mundkur <prashanth.mundkur@gmail.com>2019-01-16 10:24:17 -0800
committerPrashanth Mundkur <prashanth.mundkur@gmail.com>2019-01-16 10:24:17 -0800
commit254ed382c60fae295985fe7b83775adf116e49ba (patch)
treecd0e174f34b6332dab2aeca622e1f05b181d80cd /README.md
parent9d0282a0a52f0fa37e1d07827a4c0189dd01301c (diff)
downloadsail-riscv-254ed382c60fae295985fe7b83775adf116e49ba.zip
sail-riscv-254ed382c60fae295985fe7b83775adf116e49ba.tar.gz
sail-riscv-254ed382c60fae295985fe7b83775adf116e49ba.tar.bz2
Make it clearer that the outer c,ocaml sub-dirs contain supporting files for the emulators.
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/README.md b/README.md
index 6089a28..4210543 100644
--- a/README.md
+++ b/README.md
@@ -77,8 +77,8 @@ your environment pointing to its top-level directory.
```
$ make
```
-will build the OCaml simulator in `ocaml/riscv_ocaml_sim`, the C simulator in
-`c/riscv_sim`, the Isabelle model in `generated_models/isabelle/Riscv.thy`, and the Coq
+will build the OCaml simulator in `ocaml_emulator/riscv_ocaml_sim`, the C simulator in
+`c_emulator/riscv_sim`, the Isabelle model in `generated_models/isabelle/Riscv.thy`, and the Coq
model in `generated_models/coq/riscv.v`.
Executing test binaries
@@ -87,11 +87,11 @@ Executing test binaries
The C and OCaml simulators can be used to execute small test RV64 binaries.
```
-$ ./ocaml/riscv_ocaml_sim <elf-file>
-$ ./c/riscv_sim <elf-file>
+$ ./ocaml_emulator/riscv_ocaml_sim <elf-file>
+$ ./c_emulator/riscv_sim <elf-file>
```
Some information on additional configuration options for each simulator is available
-from `./ocaml/riscv_ocaml_sim -h` and `./c/riscv_sim -h`.
+from `./ocaml_emulator/riscv_ocaml_sim -h` and `./c_emulator/riscv_sim -h`.
Booting Linux with the C backend
--------------------------------
@@ -103,7 +103,7 @@ a DTB (device-tree blob) file describing the platform (say in the file
the model should be run as:
```
-$ ./c/riscv_sim -t console.log -b spike.dtb bbl > execution-trace.log 2>&1 &
+$ ./c_emulator/riscv_sim -t console.log -b spike.dtb bbl > execution-trace.log 2>&1 &
$ tail -f console.log
```
The `console.log` file contains the console boot messages.
@@ -114,7 +114,7 @@ Booting Linux with the OCaml backend
The OCaml model only needs the ELF-version of the BBL, since it can generate its
own DTB.
```
-$ ./ocaml/riscv_ocaml_sim bbl > execution-trace.log 2> console.log
+$ ./ocaml_emulator/riscv_ocaml_sim bbl > execution-trace.log 2> console.log
```
Generating input files for Linux boot