resources: Make riscv-fs README file clearer
Signed-off-by: Hoa Nguyen <hoanguyen@ucdavis.edu>
Change-Id: I1335726017f022d5625a5232d55d863926326110
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5-resources/+/48261
Reviewed-by: Bobby R. Bruce <bbruce@ucdavis.edu>
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Maintainer: Bobby R. Bruce <bbruce@ucdavis.edu>
Tested-by: Bobby R. Bruce <bbruce@ucdavis.edu>
Tested-by: Jason Lowe-Power <power.jg@gmail.com>
diff --git a/src/riscv-fs/README.md b/src/riscv-fs/README.md
index 5865a68..6d62cf4 100644
--- a/src/riscv-fs/README.md
+++ b/src/riscv-fs/README.md
@@ -72,7 +72,7 @@
export PATH=$PATH:/opt/riscv/bin/
```
-***Note:** The above step is necessary and might cause errors while cross compiling different components for riscv if other methods are used to point to the toolchain.
+**Note:** The above step is necessary and might cause errors while cross compiling different components for riscv if other methods are used to point to the toolchain.
## UCanLinux Source
@@ -243,24 +243,31 @@
gem5 scripts which can configure a riscv full system and run simulation are available in configs/.
The main script `run_riscv.py` expects following arguments:
-**bbl:** path to the bbl (berkeley bootloader) binary with kernel payload.
+**bbl:** path to the bbl (berkeley bootloader) binary with kernel payload (located at `riscv64-sample/riscv-pk/build/bbl`).
-**disk:** path to the disk image to use.
+**disk:** path to the disk image to use (located at `riscv64-sample/riscv_disk`).
-**cpu_type:** cpu model (`atomic`, `simple`).
+**cpu_type:** cpu model (`atomic` for AtomicSimpleCPU, `simple` for TimingSimpleCPU).
**num_cpus:** number of cpu cores.
An example use of this script is the following:
```sh
-[gem5 binary] -re configs/run_riscv.py [path to bbl] [path to the disk image] atomic 1
+[gem5 binary] configs/run_riscv.py [path to bbl] [path to the disk image] atomic 1
```
-To interact with the simulated system's console:
+To interact with the simulated system's console, you can use `telnet`,
```sh
-telnet localhost 3457 (this port number comes from `simerr` file)
+telnet localhost <port>
+```
+
+Another option is to use `m5term` provided by gem5. To compile and launch `m5term`,
+```sh
+cd gem5/util/term
+make # compiling
+./m5term localhost <port> # launching the terminal
```
The default linux system based on this README, has both `login` and `password` set as `root`.
