Message-Id: <20231206144128.1683354-1-longjin@DragonOS.org>
Date:   Wed,  6 Dec 2023 14:41:28 +0000
From:   "longjin" <longjin@...gonos.org>
To:     <siyanteng@...ngson.cn>, <alexs@...nel.org>
Cc:     <linux-doc@...r.kernel.org>, <linux-kernel@...r.kernel.org>,
        <linux-riscv@...ts.infradead.org>,
        "longjin" <longjin@...gonOS.org>, "longjin" <longjin@...gonos.org>
Subject: [PATCH 1/1] Translated the RISC-V architecture boot documentation.

The patch adds a new file boot.rst to the Documentation/translations/zh_CN/
arch/riscv/ directory, and adds a reference to the new file 
in the index.rst file.

Signed-off-by: longjin <longjin@...gonos.org>

---
 .../translations/zh_CN/arch/riscv/boot.rst    | 144 ++++++++++++++++++
 .../translations/zh_CN/arch/riscv/index.rst   |   1 +
 2 files changed, 145 insertions(+)
 create mode 100644 Documentation/translations/zh_CN/arch/riscv/boot.rst

diff --git a/Documentation/translations/zh_CN/arch/riscv/boot.rst b/Documentation/translations/zh_CN/arch/riscv/boot.rst
new file mode 100644
index 000000000000..0fe8fcfc5601
--- /dev/null
+++ b/Documentation/translations/zh_CN/arch/riscv/boot.rst
@@ -0,0 +1,144 @@
+.. SPDX-License-Identifier: GPL-2.0
+.. include:: ../../disclaimer-zh_CN.rst
+
+:Original: Documentation/arch/riscv/boot.rst
+
+:翻译:
+
+ 龙进 Jin Long <longjin@...gonos.org>
+
+===============================================
+RISC-V内核启动要求和约束
+===============================================
+
+:Author: Alexandre Ghiti <alexghiti@...osinc.com>
+:Date: 23 May 2023
+
+这份文档描述了RISC-V内核对引导加载程序和固件的期望，以及任何开发者在接触早期启动过程时必须
+牢记的约束。在这份文档中， ``早期启动过程`` 指的是在最终虚拟映射设置之前运行的任何代码。
+
+内核预加载的要求和约束
+=======================================
+
+RISC-V内核对引导加载程序和平台固件有以下要求：
+
+寄存器状态
+--------------
+
+RISC-V内核期望：
+
+  * ``$a0`` 应包含当前核心的hartid。
+  * ``$a1`` 应包含内存中设备树的地址。
+
+CSR 寄存器状态
+---------
+
+RISC-V内核期望：
+
+  * ``$satp = 0``： 如果存在MMU，必须将其禁用。
+
+为常驻固件保留的内存
+-------------------------------------
+
+RISC-V内核在直接映射中不能映射任何常驻内存或用PMPs保护的内存，
+因此固件必须根据设备树规范 和/或 UEFI规范正确标记这些区域。
+
+内核的位置
+---------------
+
+RISC-V内核期望被放置在PMD边界（对于rv64为2MB对齐，对于rv32为4MB对齐）。
+请注意，如果不是这样，EFI stub 将重定位内核。
+
+硬件描述
+--------------------
+
+固件可以将设备树或ACPI表传递给RISC-V内核。
+
+设备树可以直接从前一阶段通过$a1寄存器传递给内核，或者在使用UEFI启动时，可以通过EFI配置表传递。
+
+ACPI表通过EFI配置表传递给内核。在这种情况下，EFI stub 仍然会创建一个小的设备树。
+请参阅下面的"EFI stub 和设备树"部分，了解这个设备树的详细信息。
+
+内核入口
+------------
+
+在SMP系统中，有两种方法可以进入内核：
+
+在SMP系统中，有两种方法可以进入内核：
+
+- ``RISCV_BOOT_SPINWAIT``：固件在内核中释放所有的hart，一个hart赢得抽奖并执行早期启动代码，
+而其他的hart则停在那里等待初始化完成。这种方法主要用于支持没有SBI HSM扩展和M模式RISC-V内核的旧固件。
+- ``有序启动``：固件只释放一个将执行初始化阶段的hart，然后使用SBI HSM扩展启动所有其他的hart。
+有序启动方法是启动RISC-V内核的首选启动方法，因为它可以支持CPU热插拔和kexec。
+
+UEFI
+----
+
+UEFI 内存映射
+~~~~~~~~~~~~~~~
+
+使用UEFI启动时，RISC-V内核将只使用EFI内存映射来填充系统内存。
+
+UEFI固件必须解析 ``/reserved-memory`` 设备树节点的子节点，并遵守设备树规范，将这些子节点的属性
+（ ``no-map`` 和 ``reusable`` ）转换为其正确的EFI等价物（参见设备树规范v0.4-rc1的"3.5.4
+/reserved-memory和UEFI"部分）。
+
+RISCV_EFI_BOOT_PROTOCOL
+~~~~~~~~~~~~~~~~~~~~~~~
+
+使用UEFI启动时，EFI stub 需要引导hartid以便将其传递给 ``$a1`` 中的RISC-V内核。
+EFI stub使用以下方法之一获取引导hartid：
+
+- ``RISCV_EFI_BOOT_PROTOCOL``（**首选**）。
+- ``boot-hartid``设备树子节点（**已弃用**）。
+
+任何新的固件都必须实现 ``RISCV_EFI_BOOT_PROTOCOL``，因为基于设备树的方法现已被弃用。
+
+早期启动的要求和约束
+=======================================
+
+RISC-V内核的早期启动过程遵循以下约束：
+
+EFI stub 和设备树
+-----------------------
+
+使用UEFI启动时，EFI stub 会用与arm64相同的参数补充（或创建）设备树，
+这些参数在Documentation/arch/arm/uefi.rst中的"UEFI kernel support on ARM"段落中有描述。
+
+虚拟映射安装
+----------------------------
+
+在RISC-V内核中，虚拟映射的安装分为两步进行：
+
+1. ``setup_vm()``在 ``early_pg_dir``中安装一个临时的内核映射，这允许发现系统内存。
+此时只有内核文本/数据被映射。在建立这个映射时，不能进行分配（因为系统内存还未知），所以
+``early_pg_dir``页表是静态分配的（每个级别只使用一个表）。
+
+2. ``setup_vm_final()``在 ``swapper_pg_dir``中创建最终的内核映射，并利用发现的系统内存
+创建线性映射。在建立这个映射时，内核可以分配内存，但不能直接访问它（因为直接映射还不存在），
+所以它使用fixmap区域的临时映射来访问新分配的页表级别。
+
+为了让 ``virt_to_phys()``和 ``phys_to_virt()``能够正确地将直接映射地址转换为物理地址，
+它们需要知道DRAM的起始位置。这发生在步骤1之后，就在步骤2安装直接映射之前
+（参见arch/riscv/mm/init.c中的 ``setup_bootmem()``函数）。在安装最终虚拟映射之前使用
+这些宏必须仔细检查。
+
+通过fixmap进行设备树映射
+-----------------------------
+
+由于 ``reserved_mem``数组是用 ``setup_vm()``建立的虚拟地址初始化的，并且与
+``setup_vm_final()``建立的映射一起使用，RISC-V内核使用fixmap区域来映射设备树。
+这确保设备树可以通过两种虚拟映射访问。
+
+Pre-MMU执行
+-----------------
+
+在建立第一个虚拟映射之前，需要运行一些代码。这些包括第一个虚拟映射的安装本身，早期替代方案的修补，
+以及内核命令行的早期解析。这些代码必须非常小心地编译，因为：
+
+- ``-fno-pie``：这对于使用``-fPIE``的可重定位内核是必需的，否则，任何对全局符号的访问都将通过
+GOT进行，而GOT只是虚拟地重新定位。
+- ``-mcmodel=medany``：任何对全局符号的访问都必须是PC相对的，以避免在设置MMU之前发生任何重定位。
+- *所有* 的仪表化功能也必须被禁用（包括KASAN，ftrace和其他）。
+
+由于使用来自不同编译单元的符号需要用这些标志编译该单元，我们建议尽可能不要使用外部符号。
diff --git a/Documentation/translations/zh_CN/arch/riscv/index.rst b/Documentation/translations/zh_CN/arch/riscv/index.rst
index 3b041c116169..96573459105e 100644
--- a/Documentation/translations/zh_CN/arch/riscv/index.rst
+++ b/Documentation/translations/zh_CN/arch/riscv/index.rst
@@ -17,6 +17,7 @@ RISC-V 体系结构
 .. toctree::
     :maxdepth: 1
 
+    boot
     boot-image-header
     vm-layout
     patch-acceptance
-- 
2.34.1

Powered by blists - more mailing lists