update readme

Author: rcitach

bsp/xuantie/virt64/c906/README.md

@@ -1,78 +1,228 @@
-# XuanTie - C906  Series
+# QEMU/RISCV64/C906 VIRT Board Support Package User Guide
 
-## 一 简介
+English | [中文](./README_cn.md)
 
-### 1. 内核
+<!-- TOC -->
 
-C906 是基于 RISC-V 指令架构的 64 位超高能效处理器，主要面向安防监控、智能音箱、扫码/刷脸支付等领域。  
+- [QEMU/RISCV64/C906 VIRT Board Support Package User Guide](#qemuriscv64c906-virt-board-support-package-user-guide)
+  - [1. Introduction](#1-introduction)
+  - [2. Building](#2-building)
+    - [2.1. Installing the toolchain](#21-installing-the-toolchain)
+    - [2.2. Setting RT-Thread toolchain environment variables](#22-setting-rt-thread-toolchain-environment-variables)
+    - [2.3. Downloading the kernel](#23-downloading-the-kernel)
+    - [2.4. Configuring the kernel](#24-configuring-the-kernel)
+    - [2.5. Compiling the kernel](#25-compiling-the-kernel)
+  - [3. Running](#3-running)
+    - [3.1. Installing QEMU](#31-installing-qemu)
+    - [3.2. Running QEMU](#32-running-qemu)
+      - [3.2.1. Running RT-Thread Smart version](#321-running-rt-thread-smart-version)
 
-### 2.特点
+<!-- /TOC -->
 
-•  RV64IMA[FD]C[V] 指令架构；
+## 1. Introduction
 
-• 5 级单发按序执行流水线；
+RISC-V is an open and free instruction set architecture (ISA). This project is based on QEMU's RISC-V64 VIRT platform, ported to the C906 processor platform.
 
-• 一级哈佛结构的指令和数据缓存，大小为 8KB/16KB/32KB/64KB 可配置，缓存行为 64B；
+## 2. Building
 
-• Sv39 内存管理单元，实现虚实地址转换与内存管理；
+Working system: take Ubuntu 24.04 as an example:
 
-• 支持 AXI4.0 128 比特 Master 接口；
+```shell
+$ lsb_release -a
+No LSB modules are available.
+Distributor ID: Ubuntu
+Description:    Ubuntu 24.04.2 LTS
+Release:        24.04
+Codename:       noble
+```
+
+### 2.1. Installing the toolchain
+
+- Compiler: [Xuantie-900-gcc-linux-6.6.0-musl64-x86_64-V3.0.2-20250410.tar.gz](https://www.xrvm.cn/community/download?id=4433353576298909696)
+- Emulator: [Xuantie-qemu-x86_64-Ubuntu-20.04-V5.0.5-B20250108-0335.tar.gz](https://www.xrvm.cn/community/download?id=4397435198627713024)
+
+Note: If the emulator in the above link does not work, you can compile the emulator using the following repository
+> [XUANTIE-RV/qemu](https://github.com/XUANTIE-RV/qemu )
+
+### 2.2. Setting RT-Thread toolchain environment variables
+
+There are three environment variables related to the RT-Thread toolchain
+
+- `RTT_CC` is the toolchain name, which is `"gcc"` here
+- `RTT_CC_PREFIX`: is the toolchain prefix, in this case `"riscv64-unknown-elf-"` for the Standard Edition and `"riscv64-unknown-linux-musl-"` for the Smart Edition.
+- `RTT_EXEC_PATH`: the path to the bin folder of the toolchain, e.g. `"$HOME/tools/Xuantie-900-gcc-linux-6.6.0-musl64-x86_64-V3.0.2/bin"`, this is based on the path of the toolchain that was downloaded and unpacked by the user. Thread Standard and Smart versions are two different toolchains, and the path name of `RTT_EXEC_PATH` should be set to `bin`.
+
+>Note: This may vary for different toolchains `RTT_CC_PREFIX`, which can be viewed in the toolchain bin folder path.  
+It is recommended to export these three environment variables in the `.bashrc` file if you use them all the time.
+
+### 2.3. Downloading the kernel
+
+Assume that the working path is `$WORKSPACE`.
+
+```shell
+cd $WORKSPACE
+git clone [email protected]:RT-Thread/rt-thread.git
+```
+
+Enter xuantie/virt64/c906 the location of the BSP directory, the latter operation is not otherwise described, the default is in this directory.
+
+```shell
+cd $WORKSPACE/rt-thread/bsp/xuantie/virt64/c906
+```
 
-• 支持核内中断 CLINT 和中断控制器 PLIC；
+### 2.4. Configuring the kernel
 
-• 支持 RISC-V Debug 标准。
+Refresh the configuration file before compiling for the first time.
 
-• 遵循 RISC-V V 矢量扩展标准（revision 0.7.1）；
+```shell
+scons --menuconfig
+```
 
-• 算力可达 4G Flops（@1GHz）；
+If you want to use the RT-Thread Smart version, at least turn on the `RT_USING_SMART` option after entering the configuration menu (see the figure below), and the rest depends on your needs.
 
-• 支持矢量执行单元运算宽度 64 位和 128 位硬件可配置；
+```kconfiglib
+(Top) → RT-Thread Kernel
+                                        RT-Thread Project Configuration
+(24) The maximal size of kernel object name
+[ ] Use the data types defined in ARCH_CPU
+[*] Enable RT-Thread Smart (microkernel on kernel/userland)
+[ ] Enable RT-Thread Nano
+...
+```
 
-• 支持 INT8/INT16/INT32/INT64/FP16/FP32/BFP16 矢量运算；  
+Save and exit after modification.
 
-### 3.BSP支持情况
+### 2.5. Compiling the kernel
 
-- 当前BSP支持下述内核：
+If you have compiled before, you can clean it up:
 
-  ```asciiarmor
-  c906 c906fd c906fdv
-  ```
+```shell
+scons --clean
+```
 
-- 当前BSP默认设置的内核是c906，该架构支持[F] [D]扩展，可以通过menuconfig工具使能[F]扩展或者[F] [D] 扩展。
+Or compile directly:
 
-- 当使用其他内核架构时需要修改，rtconfig.py文件中的`MCPU`字段。
+```shell
+scons -j$(nproc)
+```
 
-### 4.运行QEMU
+The kernel binary file `rtthread.bin` will be generated in the `$WORKSPACE/rt-thread/bsp/xuantie/virt64/c906`.
 
-- BSP根目录下存在`qemu.bat`脚本，生成可执行文件后可点击该脚本直接启动QEMU.
+## 3. Running
 
-## 二 工具
+### 3.1. Installing QEMU
 
-- 编译器： https://www.xrvm.cn/community/download?id=4433353576298909696
-- 模拟器： https://www.xrvm.cn/community/download?id=4397435198627713024
+Here the qemu emulator is installed by compiling the `XUANTIE-RV/qemu` repository.
 
-注：若上述链接中的编译器与模拟器不能使用，可以使用下述CDK中的编译器与模拟器
+```shell
 
-- SDK：https://www.xrvm.cn/community/download?id=4397799570420076544
+git clone [email protected]:XUANTIE-RV/qemu.git
 
-## 三 调试方法
+mkdir build
 
-**下述调试方法以E906举例，本BSP操作方式一致**，搭建完成RT-Thread开发环境，在BSP根目录使用env工具在当前目录打开env。
+cd build
 
-![](figures/1.env.png)
+../configure --target-list="riscv64-softmmu riscv64-linux-user"
 
-使用前执行一次**menuconfig**命令，更新rtconfig.h配置，然后在当前目录执行**scons -j12**命令编译生成可可执行文件。
+make -j8
 
-<img src="figures/2.scons.png" alt="env" style="zoom: 95%;" />
+make install
+```
+
+After the installation is complete, you can check the version.
+
+```shell
+$ qemu-system-riscv64 --version
+QEMU emulator version 8.2.94 (v6.1.0-22774-ge0ace167ef)
+Copyright (c) 2003-2024 Fabrice Bellard and the QEMU Project developers
+```
+
+### 3.2. Running QEMU
 
-生成可执行文件，可以直接在命令行启动qemu或者配置vscode脚本借助vscode强大的插件进行图形化调试，qemu的相关命令可以查看玄铁qemu的[用户手册](https://www.xrvm.cn/community/download?id=4397435198627713024)，下述是启动qemu的命令，在powershell或命令行可直接执行下述命令，注意qemu需要导出至环境变量或者使用绝对路径。
+The repository has provided a ready-made execution script, which can be executed directly:
 
 ```shell
-qemu-system-riscv64 -machine smartl -nographic -kernel rtthread.elf -cpu e906
+./run.sh
 ```
 
-下述是使用vscode调试的展示。
+#### 3.2.1. Running RT-Thread Smart version
 
-<img src="figures/3.vscode.png" alt="env" style="zoom: 63%;" />
+The following is an example:
 
-一起为RISC-V加油！
+```shell
+$ ./run.sh
+
+OpenSBI v1.4
+   ____                    _____ ____ _____
+  / __ \                  / ____|  _ \_   _|
+ | |  | |_ __   ___ _ __ | (___ | |_) || |
+ | |  | | '_ \ / _ \ '_ \ \___ \|  _ < | |
+ | |__| | |_) |  __/ | | |____) | |_) || |_
+  \____/| .__/ \___|_| |_|_____/|____/_____|
+        | |
+        |_|
+
+Platform Name             : riscv-virtio,qemu
+Platform Features         : medeleg
+Platform HART Count       : 1
+Platform IPI Device       : aclint-mswi
+Platform Timer Device     : aclint-mtimer @ 10000000Hz
+Platform Console Device   : uart8250
+Platform HSM Device       : ---
+Platform PMU Device       : ---
+Platform Reboot Device    : syscon-reboot
+Platform Shutdown Device  : syscon-poweroff
+Platform Suspend Device   : ---
+Platform CPPC Device      : ---
+Firmware Base             : 0x80000000
+Firmware Size             : 323 KB
+Firmware RW Offset        : 0x40000
+Firmware RW Size          : 67 KB
+Firmware Heap Offset      : 0x48000
+Firmware Heap Size        : 35 KB (total), 2 KB (reserved), 9 KB (used), 23 KB (free)
+Firmware Scratch Size     : 4096 B (total), 328 B (used), 3768 B (free)
+Runtime SBI Version       : 2.0
+
+Domain0 Name              : root
+Domain0 Boot HART         : 0
+Domain0 HARTs             : 0*
+Domain0 Region00          : 0x0000000000100000-0x0000000000100fff M: (I,R,W) S/U: (R,W)
+Domain0 Region01          : 0x0000000010000000-0x0000000010000fff M: (I,R,W) S/U: (R,W)
+Domain0 Region02          : 0x0000000002000000-0x000000000200ffff M: (I,R,W) S/U: ()
+Domain0 Region03          : 0x0000000080040000-0x000000008005ffff M: (R,W) S/U: ()
+Domain0 Region04          : 0x0000000080000000-0x000000008003ffff M: (R,X) S/U: ()
+Domain0 Region05          : 0x000000000c400000-0x000000000c5fffff M: (I,R,W) S/U: (R,W)
+Domain0 Region06          : 0x000000000c000000-0x000000000c3fffff M: (I,R,W) S/U: (R,W)
+Domain0 Region07          : 0x0000000000000000-0xffffffffffffffff M: () S/U: (R,W,X)
+Domain0 Next Address      : 0x0000000080200000
+Domain0 Next Arg1         : 0x000000008fe00000
+Domain0 Next Mode         : S-mode
+Domain0 SysReset          : yes
+Domain0 SysSuspend        : yes
+
+Boot HART ID              : 0
+Boot HART Domain          : root
+Boot HART Priv Version    : v1.10
+Boot HART Base ISA        : rv64imafdc
+Boot HART ISA Extensions  : zicntr,zihpm
+Boot HART PMP Count       : 16
+Boot HART PMP Granularity : 2 bits
+Boot HART PMP Address Bits: 54
+Boot HART MHPM Info       : 16 (0x0007fff8)
+Boot HART MIDELEG         : 0x0000000000000222
+Boot HART MEDELEG         : 0x000000000000b109
+heap: [0x003280c0 - 0x043280c0]
+
+ \ | /
+- RT -     Thread Smart Operating System
+ / | \     5.2.1 build Jun  9 2025 09:03:23
+ 2006 - 2024 Copyright by RT-Thread team
+lwIP-2.0.3 initialized!
+[I/sal.skt] Socket Abstraction Layer initialize success.
+[I/utest] utest is initialize success.
+[I/utest] total utest testcase num: (1)
+[I/drivers.serial] Using /dev/ttyS0 as default console
+file system initialization done!
+Hello RISC-V
+msh />
+```