aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRobert Norton <rmn30@cam.ac.uk>2018-11-30 12:31:50 +0000
committerRobert Norton <rmn30@cam.ac.uk>2018-11-30 12:31:50 +0000
commit00dc8a578d2af1eafbc96c89f9e01a5e1de95b18 (patch)
treeb948c3959a86408b34bb6bfeca12504e910c6f6a /README.md
parentc18905486156fe245ba4edbddf3c41d475382eeb (diff)
downloadsail-riscv-00dc8a578d2af1eafbc96c89f9e01a5e1de95b18.zip
sail-riscv-00dc8a578d2af1eafbc96c89f9e01a5e1de95b18.tar.gz
sail-riscv-00dc8a578d2af1eafbc96c89f9e01a5e1de95b18.tar.bz2
Move readme to .md file
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b925821
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+Booting Linux with the C backend:
+---------------------------------
+
+The C model needs an ELF-version of the BBL (Berkeley-Boot-Loader) that contains
+the Linux kernel as an embedded payload. It also needs a DTB (device-tree blob)
+file describing the platform. Once those are available, the model should be run
+as:
+
+$ ./riscv_sim -b spike.dtb bbl > execution-trace.log 2>&1 &
+$ tail -f term.log
+
+The term.log file contains the console boot messages.
+
+
+Booting Linux with the OCaml backend:
+-------------------------------------
+
+The OCaml model only needs the ELF-version of the BBL, since it can generate its
+own DTB.
+
+$ ./platform bbl > execution-trace.log
+
+The console output is sent to stderr.