Standardize the log output

Author: Undefined01

README.md

@@ -141,14 +141,24 @@ Enter the test cycle:
 
 `projects/soc`目录下存放了接入`ysyxSoC`的示例程序。源码中只有一个占位符，能够通过编译但不能正常运行。
 
-使用该脚本，需要先按照 [ysyx SoC 的 readme](https://github.com/osCPU/ysyxsoc) 完成命名规范和 CPU 内部修改两个步骤，得到 `ysyx_21xxxx.v`，随后放入 `projects/soc/vsrc/` 中。脚本会根据 `myinfo.txt` 中的 ID 自动进行 `cpu-check` 和 `soc` 的编译。
-
-`ysyxSoC` 中附带的例程会被自动软连接至 `build` 目录下，仿真时可以如下快速使用。
+要使用该框架，需要先按照 [ysyx SoC 的 readme](https://github.com/osCPU/ysyxsoc) 完成 `命名规范` 和 `CPU 内部修改` 两个步骤，得到 `ysyx_21xxxx.v`，随后放入 `projects/soc/vsrc/` 中。此后，执行下面的命令将会根据 `myinfo.txt` 中的 ID 自动 对代码进行规范检查、集成到 `soc` 并运行指定的程序。`ysyxSoC` 中附带的例程会被自动软连接至 `build` 目录下，仿真时可以快速使用。
 
 ```bash
 ./build.sh -e soc -b -s -y -v '--timescale "1ns/1ns" -Wno-fatal --trace' -a "-i ysyxSoC/flash/hello-flash.bin --dump-wave"
 ```
 
+由于无法直接使用 `difftest` 框架，暂时只支持少量参数。
+```bash
+$ ./emu -h
+Usage: ./emu [OPTION...]
+
+  -i, --image=FILE           run with this image file
+      --dump-wave            dump waveform when log is enabled
+  -b, --log-begin=NUM        display log from NUM th cycle
+  -e, --log-end=NUM          stop display log at NUM th cycle
+  -h, --help                 print program help info
+```
+
 ## 查看波形
 
 在`oscpu`目录下使用命令可以通过`gtkwave`查看输出的波形，其中`xxx`表示例程名。

build.sh

@@ -121,7 +121,7 @@ build_soc_proj() {
     mkdir -p $BUILD_PATH/vsrc $BUILD_PATH/csrc
 
     if [[ ! -f "$PROJECT_PATH/$VSRC_FOLDER/ysyx_${ID:0-6}.v" ]]; then
-        echo "$PROJECT_PATH/$VSRC_FOLDER/ysyx_${ID:0-6}.v not detected. Failed to compile with ysyxSoC."
+        echo "$VSRC_FOLDER/ysyx_${ID:0-6}.v not detected. Please follow the README of ysyxSoC to get this file."
         exit 1
     fi
 

projects/soc/csrc/emu.h

@@ -19,10 +19,10 @@ class Emulator
 
     if (args.image == nullptr)
       throw "Image file unspecified. Use -i to provide the image of flash";
+    printf("Initializing flash with \"%s\" ...\n", args.image);
     flash_init(args.image);
-    printf("Flash initialized with \"%s\"\n", args.image);
 
-    printf("Initializing DUT...\n");
+    printf("Initializing and resetting DUT ...\n");
     dut_ptr = new VysyxSoCFull;
     dut_ptr->reset = 1;
     for (int i = 0; i < 10; i++)

projects/soc/csrc/main.cpp

@@ -15,7 +15,7 @@ void sig_handler(int signo)
         puts("SIGINT received, forcely shutting down.\n");
         _exit(0);
     }
-    puts("SIGINT received, gracefully shutting down...\n");
+    puts("SIGINT received, gracefully shutting down... Type Ctrl+C again to stop forcely.\n");
     signal_received = signo;
 }
 
@@ -37,6 +37,7 @@ int main(int argc, char *argv[])
     atexit(release);
 
     emu = new Emulator(argc, argv);
+    printf("Start simulating ...\n");
     while (!Verilated::gotFinish() && signal_received == 0)
     {
         emu->step();