diff --git a/docs/design/_category_.json b/docs/design/_category_.json index ae7fa04..427a535 100644 --- a/docs/design/_category_.json +++ b/docs/design/_category_.json @@ -1,6 +1,6 @@ { "label": "Design", - "position": 2, + "position": 3, "link": { "type": "generated-index" } diff --git a/docs/examples/_category_.json b/docs/examples/_category_.json deleted file mode 100644 index c543bc0..0000000 --- a/docs/examples/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Examples", - "position": 3, - "link": { - "type": "generated-index" - } -} diff --git a/docs/examples/arm/_category_.json b/docs/examples/arm/_category_.json deleted file mode 100644 index 1924b17..0000000 --- a/docs/examples/arm/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "ARM", - "position": 2, - "link": { - "type": "generated-index" - } -} diff --git a/docs/examples/arm/phytiumpi.md b/docs/examples/arm/phytiumpi.md deleted file mode 100644 index bad3188..0000000 --- a/docs/examples/arm/phytiumpi.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -sidebar_position: 1 ---- - -# 飞腾派 - -TODO - - -## 飞腾派 1 - -TODO - -## 飞腾派 2 - -TODO \ No newline at end of file diff --git a/docs/examples/arm/raspberrypi.md b/docs/examples/arm/raspberrypi.md deleted file mode 100644 index cf6e861..0000000 --- a/docs/examples/arm/raspberrypi.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -sidebar_position: 1 ---- - -# 树莓派 - -TODO - - -## 树莓派 1 - -TODO - -## 树莓派 2 - -TODO \ No newline at end of file diff --git a/docs/examples/riscv/_category_.json b/docs/examples/riscv/_category_.json deleted file mode 100644 index a12a311..0000000 --- a/docs/examples/riscv/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "RISC-V", - "position": 3, - "link": { - "type": "generated-index" - } -} diff --git a/docs/examples/riscv/xxpi.md b/docs/examples/riscv/xxpi.md deleted file mode 100644 index 6d6f147..0000000 --- a/docs/examples/riscv/xxpi.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -sidebar_position: 1 ---- - -# XX 派 - -TODO - - -## XX 派 1 - -TODO - -## XX 派 2 - -TODO \ No newline at end of file diff --git a/docs/examples/x86_64/_category_.json b/docs/examples/x86_64/_category_.json deleted file mode 100644 index b5bb677..0000000 --- a/docs/examples/x86_64/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "x86_64", - "position": 3, - "link": { - "type": "generated-index" - } -} diff --git a/docs/examples/x86_64/x86_64.md b/docs/examples/x86_64/x86_64.md deleted file mode 100644 index 9137522..0000000 --- a/docs/examples/x86_64/x86_64.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -sidebar_position: 1 ---- - -# x86_64 - -TODO - - -## x86_64 1 - -TODO - -## x86_64 2 - -TODO \ No newline at end of file diff --git a/docs/quickstart/images/load_driver.png b/docs/quickstart/images/load_driver.png new file mode 100644 index 0000000..1851557 Binary files /dev/null and b/docs/quickstart/images/load_driver.png differ diff --git a/docs/quickstart/images/load_jailhouse.png b/docs/quickstart/images/load_jailhouse.png new file mode 100644 index 0000000..7662471 Binary files /dev/null and b/docs/quickstart/images/load_jailhouse.png differ diff --git a/docs/quickstart/images/load_jailhouse_driver_auto.png b/docs/quickstart/images/load_jailhouse_driver_auto.png new file mode 100644 index 0000000..81f7d83 Binary files /dev/null and b/docs/quickstart/images/load_jailhouse_driver_auto.png differ diff --git a/docs/quickstart/images/phytium_jailhouse_cell_arceos.png b/docs/quickstart/images/phytium_jailhouse_cell_arceos.png new file mode 100644 index 0000000..04a86b7 Binary files /dev/null and b/docs/quickstart/images/phytium_jailhouse_cell_arceos.png differ diff --git a/docs/quickstart/images/phytium_jailhouse_cell_loader_arceos.png b/docs/quickstart/images/phytium_jailhouse_cell_loader_arceos.png new file mode 100644 index 0000000..ba97d43 Binary files /dev/null and b/docs/quickstart/images/phytium_jailhouse_cell_loader_arceos.png differ diff --git a/docs/quickstart/images/phytium_jailhouse_cell_start_arceos.png b/docs/quickstart/images/phytium_jailhouse_cell_start_arceos.png new file mode 100644 index 0000000..2cef87a Binary files /dev/null and b/docs/quickstart/images/phytium_jailhouse_cell_start_arceos.png differ diff --git a/docs/quickstart/images/phytium_jailhouse_disable.png b/docs/quickstart/images/phytium_jailhouse_disable.png new file mode 100644 index 0000000..d7c5536 Binary files /dev/null and b/docs/quickstart/images/phytium_jailhouse_disable.png differ diff --git a/docs/quickstart/images/phytium_jailhouse_enable.png b/docs/quickstart/images/phytium_jailhouse_enable.png new file mode 100644 index 0000000..19d50e9 Binary files /dev/null and b/docs/quickstart/images/phytium_jailhouse_enable.png differ diff --git a/docs/quickstart/images/rpi4_jailhouse_cell_arceos.png b/docs/quickstart/images/rpi4_jailhouse_cell_arceos.png new file mode 100644 index 0000000..e250f21 Binary files /dev/null and b/docs/quickstart/images/rpi4_jailhouse_cell_arceos.png differ diff --git a/docs/quickstart/images/rpi4_jailhouse_cell_loader_arceos.png b/docs/quickstart/images/rpi4_jailhouse_cell_loader_arceos.png new file mode 100644 index 0000000..5ce1a61 Binary files /dev/null and b/docs/quickstart/images/rpi4_jailhouse_cell_loader_arceos.png differ diff --git a/docs/quickstart/images/rpi4_jailhouse_cell_start_arceos.png b/docs/quickstart/images/rpi4_jailhouse_cell_start_arceos.png new file mode 100644 index 0000000..61e065b Binary files /dev/null and b/docs/quickstart/images/rpi4_jailhouse_cell_start_arceos.png differ diff --git a/docs/quickstart/images/rpi4_jailhouse_disable.png b/docs/quickstart/images/rpi4_jailhouse_disable.png new file mode 100644 index 0000000..a81d3b9 Binary files /dev/null and b/docs/quickstart/images/rpi4_jailhouse_disable.png differ diff --git a/docs/quickstart/images/rpi4_jailhouse_enable.png b/docs/quickstart/images/rpi4_jailhouse_enable.png new file mode 100644 index 0000000..898ef7e Binary files /dev/null and b/docs/quickstart/images/rpi4_jailhouse_enable.png differ diff --git a/docs/quickstart/images/write_sd_windows.png b/docs/quickstart/images/write_sd_windows.png new file mode 100644 index 0000000..2251f48 Binary files /dev/null and b/docs/quickstart/images/write_sd_windows.png differ diff --git a/docs/quickstart/quickstart.md b/docs/quickstart/quickstart.md new file mode 100644 index 0000000..c342328 --- /dev/null +++ b/docs/quickstart/quickstart.md @@ -0,0 +1,124 @@ +--- +sidebar_position: 2 +--- + +# QuickStart + +在 [infisecos-images](https://github.com/qclic/infisecos-images) 这个仓库中，我们提供了预编译的适用于飞腾派和树莓派 4B 开发版的镜像文件，可以快速体验 InfisecOS 的运行效果。 + +## 文件介绍 + +目录文件介绍如下： +```c +infisecos-images +├── README.md +├── README_CN.md +├── arceos # 不再需要，已经直接集成到了对应的开发板镜像中 +│ ├── phytiumpi.bin +│ └── raspberrypi.bin +├── phytiumpi +│ └── infisecos-image-phytiumpi.img # 飞腾派开发板镜像 +└── raspberrypi4 + └── infisecos-image-raspberrypi4-64.img # 树莓派 4B 开发板镜像 +``` + +## 烧写 + +首先使用 `git clone git@github.com:qclic/infisecos-images.git` 命令下载镜像文件，[infisecos-images](https://github.com/qclic/infisecos-images) 中提供的是 SD 卡镜像文件，因此，需要准备一张 SD 卡，将镜像烧写到 SD 卡来进行启动 + +### Linux +在 Linux 系统中，可以直接使用命令 `sudo dd iflag=sync oflag=sync bs=4M if=infisecos-image-phytiumpi.img of=/dev/sdb status=progress` 来进行烧写 + +- `if=` 指定输入文件，即我们要烧写的镜像文件。飞腾派对应 infisecos-image-phytiumpi.img，树莓派对应 infisecos-image-raspberrypi4-64.img + +- `of=` 指定输出设备，即我们的 SD 卡盘符。 + +- `bs=4M` 设置块大小为 4MB，这对于大型文件来说可以提高写入效率。 + +- `status=progress` 显示写入过程中的进度信息。 + +- `oflag=sync` 确保写入操作同步进行，数据更改立即被写入设备。 + +### Windows + +在 Windows 系统中，有很多 GUI 程序可以用来烧写 SD 卡。对于飞腾派，可以使用 `Win32DiskImager2.0.1.8.exe`，对于树莓派，官方提供了一个名为 `Raspberry Pi Imager` 烧写工具 + +![write_sd_windows](./images/write_sd_windows.png) + +## 启动验证 + +将烧写好的 SD 卡插入到开发板中，然后上电启动。默认的用户为 root，没有密码。 + +### 处理终端输入太长后返回行头 + +  默认生成的 InfisecOS 系统中，如果在终端输入内容太长时就会返回行开头，非常影响使用！这通常是由于 Buildroot 构建的 Linux 系统终端的缓冲区大小不足以处理太长的输入导致的。 +1. 解决方法一：直接 `nano /etc/profile` 或其他用户配置文件，然后在其中添加 `export COLUMNS=200` 和 `export LINES=200`，重启后生效！ +2. 解决方法二：每次登陆终端后，使用命令 `stty rows [number_of_rows] cols [number_of_columns]` 动态修改 + +### 找不到 jailhouse 命令 + +  此时如果直接运行 `jailhouse` 命令会提示找不到该命令，这是因为 `jailhouse` 编译后默认的安装路径并不在我们构建的 InfisecOS 环境变量里面。直接 `nano /etc/profile` 并在其中的 `export PATH=` 内容的最后面输入 `:/usr/local/sbin`，保存后 `source /etc/profile` 即可 + +![load_jailhouse](./images/load_jailhouse.png) + +### 加载 Jailhouse 驱动 + +  Jailhouse 的驱动 `jailhouse.ko` 位于 `/lib/modules/5.10.0-openeuler/jailhouse/driver/` 目录中，默认是没有被加载进内核的。我们需要手动执行 `insmod /lib/modules/$(uname -r)/jailhouse/driver/jailhouse.ko` 或者 `modprobe jailhouse` 来进行加载，否则会报错 `opening /dev/jailhouse: No such file or directory`。 + +![load_driver](./images/load_driver.png) + +  也可以配置一下开机自动加载，不过，虽然 Linux 在启动时加载 ko 的方式有很多，但是针对嵌入式的 Linux，很多方式都是不支持的。最简单有效的方法就通过修改启动过程的 rc 脚本。直接 `nano /etc/init.d/rcS`，然后在文件最后添加 `modprobe jailhouse` 即可 + +![load_jailhouse_driver_auto](./images/load_jailhouse_driver_auto.png) + +  修改后重启，就会在启动 LOG 中看到 `jailhouse: loading out-of-tree module taints kernel.` 这条记录。关于污染内核的这个描述，并不影响功能，Linux 官方文档 https://docs.kernel.org/admin-guide/tainted-kernels.html 有详细说明 。 + +### 飞腾派 + +#### 启动 Jailhouse + +  首先直接 `jailhouse enable /etc/jailhouse/phytiumpi.cell` 就可以启动 Jailhouse。启动后，当前 Linux 系统就会称为 Root Cell。 + +![phytium_jailhouse_enable](./images/phytium_jailhouse_enable.png) + +#### 启动 ArceOS + +1. 首先创建 ArceOS 对应的 Cell：`jailhouse cell create /etc/jailhouse/phytiumpi-arceos.cell`。执行后一个 Non-root Cell 就创建好了 + ![phytium_jailhouse_cell_arceos](./images/phytium_jailhouse_cell_arceos.png) + +2. 然后加载 ArceOS 的 Loader 程序以及 ArceOS 镜像：`jailhouse cell load 1 /usr/local/libexec/jailhouse/arceos-loader-phytiumpi.bin /usr/local/libexec/jailhouse/demos/arceos.bin -a 0xb2000000`。这里的 1 是指的我们上面创建的 Non-root Cell 的 ID，也可以使用 Cell 的名字（注意是 Cell 中定义的 name，不是文件名）。 + ![phytium_jailhouse_cell_loader_arceos](./images/phytium_jailhouse_cell_loader_arceos.png) + +3. 最后启动 ArceOS：`jailhouse cell start 1` + ![phytium_jailhouse_cell_start_arceos](./images/phytium_jailhouse_cell_start_arceos.png) + +#### 关闭 Jailhouse + +  直接使用命令 `jailhouse disable` 就可以关闭 Jailhouse。 + +![phytium_jailhouse_disable](./images/phytium_jailhouse_disable.png) + +### 树莓派 + +#### 启动 Jailhouse + +  首先直接 `jailhouse enable /etc/jailhouse/rpi4.cell` 就可以启动 Jailhouse。启动后，当前 Linux 系统就会称为 Root Cell。 + +![rpi4_jailhouse_enable](./images/rpi4_jailhouse_enable.png) + +#### 启动 ArceOS + +1. 首先创建 ArceOS 对应的 Cell：`jailhouse cell create /etc/jailhouse/rpi4-arceos.cell`。执行后一个 Non-root Cell 就创建好了 + ![rpi4_jailhouse_cell_arceos](./images/rpi4_jailhouse_cell_arceos.png) + +2. 加载 ArceOS 的 Loader 程序以及 ArceOS 镜像：`jailhouse cell load 1 /usr/local/libexec/jailhouse/arceos-loader-rpi4.bin /usr/local/libexec/jailhouse/demos/arceos.bin -a 0x42000000`。这里的 1 是指的我们上面创建的 Non-root Cell 的 ID，也可以使用 Cell 的名字（注意是 Cell 中定义的 name，不是文件名）。 + ![rpi4_jailhouse_cell_loader_arceos](./images/rpi4_jailhouse_cell_loader_arceos.png) + +3. 启动：`jailhouse cell start 1` + ![rpi4_jailhouse_cell_start_arceos](./images/rpi4_jailhouse_cell_start_arceos.png) + +#### 关闭 Jailhouse + +  直接使用命令 `jailhouse disable` 就可以关闭 Jailhouse。 + +![rpi4_jailhouse_disable](./images/rpi4_jailhouse_disable.png) diff --git a/i18n/zh/code.json b/i18n/zh/code.json index d037037..fdfeaba 100644 --- a/i18n/zh/code.json +++ b/i18n/zh/code.json @@ -6,31 +6,31 @@ "message": "一个专注于 AIoT 领域的安全操作系统" }, "Component-based design": { - "message": "Component-based design" + "message": "组件化设计" }, "Features multiple kernel architecture forms": { - "message": "Features multiple kernel architecture forms" + "message": "多内核架构形态支持" }, "Support for multiple application scenarios": { - "message": "Support for multiple application scenarios" + "message": "多应用场景支持" }, "Developed using the Rust programming language": { - "message": "Developed using the Rust programming language" + "message": "采用 Rust 语言开发" }, "Supports RTOS, BareMetal, and Linux as subsystems": { - "message": "Supports RTOS, BareMetal, and Linux as subsystems" + "message": "支持 RTOS, BareMetal 和 Linux 作为子系统" }, "Adopted the MIT permissive open-source license": { - "message": "Adopted the MIT permissive open-source license" + "message": "MIT 宽松协议" }, "Multi-architecture support, verified on the following architectures": { - "message": "Multi-architecture support, verified on the following architectures" + "message": "多种 CPU 架构支持，已验证的架构有：" }, - "Getting Started Guide": { - "message": "阅读指南" + "Quick Start": { + "message": "快速上手" }, - "Download and Experience": { - "message": "下载体验" + "Get Started": { + "message": "阅读指南" }, "Multiple kernel architecture forms": { "message": "Multiple kernel architecture forms" diff --git a/src/infisecos.drawio b/src/infisecos.drawio index 890001a..e63255e 100644 --- a/src/infisecos.drawio +++ b/src/infisecos.drawio @@ -5,7 +5,7 @@ - + @@ -273,14 +273,17 @@ - + + + + - + @@ -319,7 +322,7 @@ - + @@ -335,19 +338,19 @@ - + - + - + @@ -369,74 +372,95 @@ - - + + + + + - - + + - - + + - - + + - + - + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - + - - + + - - + + + + + + + + + + + + + + + + + + + + - - + + - - + + diff --git a/src/pages/index.js b/src/pages/index.js index 5b28f1b..5bbb043 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -39,12 +39,12 @@ function HomepageBanner() {
- - Getting Started Guide + + Quick Start - Download and Experience + Get Started