Skip to content

Commit 9957cdd

Browse files
authored
Merge pull request #850 from EESN-W/rock5t
fix: modify rock5t nvme boot detail
2 parents 8565a33 + 0655b5e commit 9957cdd

File tree

3 files changed

+101
-66
lines changed

3 files changed

+101
-66
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -374,3 +374,4 @@ docs/e/e24c/README.md @jack-ma
374374
i18n/en/docusaurus-plugin-content-docs/current/orion/o6/bios/install-bios.md @melooooooooooo
375375
docs/orion/o6/app-development/artificial-intelligence/npu-introduction.md @vamrs-feng
376376
docs/common/radxa-os/_autologin.mdx @Ken-Vamrs
377+
docs/common/dev/_nvme.mdx @nascs

docs/common/dev/_nvme.mdx

Lines changed: 39 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,32 @@
11
import { Image } from "@site/src/utils/docs";
22
import { PreView } from "@site/src/utils/docs";
33

4-
### 整体步骤
4+
## 整体步骤
55

6-
- 准备一张 SD 卡或者 eMMC Module, 充当启动盘
6+
- 准备一张 MicroSD 卡充当启动盘
77

88
- 使用系统工具 rsetup 刷 SPI
99

1010
- 将系统镜像刷到 NVME SSD 里面
1111

12-
- 拔掉 SD 卡, 从 NVME 启动
12+
- 拔掉 MicroSD 卡, 从 NVME 启动
1313

14-
### 准备一张 SD 卡或者 eMMC Module, 充当启动盘
14+
## 正常启动系统
1515

16-
参考<a href={props.etcher_path}>制作 MicroSD 启动盘部分</a>将系统安装在 SD 卡 当中。
16+
参考 <a href={props.etcher_path}>制作 MicroSD 启动盘部分</a> 将系统安装在 MicroSD 卡 当中。
1717

18-
这里 SD 卡 的作用相当于 x86 的启动盘,目的是拿到 spi.img, 将 spi.img 刷到 spi flash 中。
18+
这里 MicroSD 卡 的作用相当于 x86 的启动盘,目的是拿到 spi.img, 将 spi.img 刷到 spi flash 中。
1919

20-
SD 卡 启动后,执行一下命令以更新系统:
20+
MicroSD 卡 启动后,执行一下命令以更新系统:
2121

2222
```
2323
sudo apt-get update
2424
sudo apt-get full-upgrade
2525
```
2626

27-
### 使用系统工具 <a href={props.rsetup_path}> rsetup </a> 刷 SPI
27+
## 使用系统工具 <a href={props.rsetup_path}> rsetup </a> 刷 SPI
28+
29+
选择`System Maintenance` 选项:
2830

2931
<img
3032
src="/img/common/nvme/system_maintenance.webp"
@@ -33,24 +35,30 @@ sudo apt-get full-upgrade
3335
alt="system maintenance"
3436
/>
3537

38+
选择`Update SPI Bootloader` 选项:
39+
3640
<img
3741
src="/img/common/nvme/update_spi_bootloader.webp"
3842
width="700"
3943
alt="update spi bootloader"
4044
/>
4145

46+
选择菜单栏候选框的文选项,然后按照提示更新 SPI Flash:
47+
4248
<Image
4349
src="/img/common/nvme/rsetup-select-bootloader-#model#.webp"
4450
model={props.model}
4551
fallback={props.model}
4652
width="700"
4753
/>
4854

55+
等待更新完成。
56+
4957
<img src="/img/common/nvme/writing_mtd.webp" width="700" alt="writing to mtd" />
5058

5159
<img src="/img/common/nvme/success.webp" width="700" alt="success" />
5260

53-
### 将系统镜像刷到 NVME SSD 里面
61+
## 将系统镜像刷到 NVME SSD 里面
5462

5563
将 NVME SSD 插入到板子上,确认 NVME 是否被系统识别,
5664

@@ -70,7 +78,13 @@ sudo apt-get full-upgrade
7078

7179
如上所示系统已经识别到 NVME SSD 即 nvme0n1(在 Linux 中,NVMe 设备通常被识别为 nvmeXnY)
7280

73-
从<a href={props.download_path}>资源下载汇总</a>下载系统镜像,将系统镜像拷贝到当前系统下。
81+
从<a href={props.download_path}>资源下载汇总</a>下载系统镜像到主板上,我这里演示使用 `wget` 命令在主板上下载系统镜像,其中网址链接可以进入<a href={props.download_path}>资源下载汇总</a>页面复制。
82+
83+
:::tip 其他下载系统镜像方法
84+
85+
1. 直接在主板访问 <a href={props.download_path}>资源下载汇总</a> 页面,然后通过浏览器下载系统镜像。
86+
2. 下载系统镜像在 PC 上,然后使用 U 盘或者在线传输(如 FTP、SCP 等)的方式将系统镜像文件复制到主板上。
87+
:::
7488

7589
<PreView
7690
params={{
@@ -80,13 +94,16 @@ sudo apt-get full-upgrade
8094
}}
8195
>
8296
{`
83-
PC Host: scp /path/to/img radxa@boardIP:/home/radxa/
84-
例如:
85-
scp ~/Download/#model#_xx.img.xz [email protected]:/home/radxa/
97+
# 安装 wget
98+
sudo apt-get install wget
99+
# 下载系统镜像文件
100+
wget [URL]
86101
`}
87102
</PreView>
88103

89-
然后在**板子**上将系统镜像 dd 到 NVME 中。
104+
- wget : 下载文件,将 [URL] 替换成实际下载链接。
105+
106+
然后在**主板**上使用 `dd` 命令将系统镜像写入 NVME SSD 中。
90107

91108
<PreView
92109
params={{
@@ -96,13 +113,18 @@ sudo apt-get full-upgrade
96113
}}
97114
>
98115
{`
99-
On Board:
100116
sudo xzcat /path/to/img | sudo dd of=/path/to/nvme bs=1M status=progress
101-
例如
117+
示例
102118
sudo xzcat /home/radxa/#model#_xx.img.xz | sudo dd of=/dev/nvme0n1 bs=1M status=progress
103119
`}
104120
</PreView>
105121

106-
### 拔掉 SD 卡, 从 NVME 启动
122+
- xzcat : 解压 xz 格式的系统镜像文件
123+
- dd : 复制并写入到 NVMe SSD 设备(⚠️注意:使用 `dd` 命令时请确认设备名称,错误的设备名可能导致数据丢失)
124+
- of=/dev/nvme0n1 : 指定写入的设备为 nvme0n1(可以根据实际情况修改)
125+
- bs=1M : 指定写入的块大小为 1M,提高写入速度
126+
- status=progress : 显示写入进度,让您了解写入状态
127+
128+
## 拔掉 SD 卡, 从 NVME 启动
107129

108130
拔掉 SD 卡后,使用 {props.pwr} 电源适配器上电,然后系统开始从 NVME 中启动,HDMI显示桌面。
Lines changed: 61 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,94 @@
11
import { Image } from "@site/src/utils/docs";
22
import { PreView } from "@site/src/utils/docs";
33

4-
### Overall steps:
4+
## Overall Steps
55

6-
- Prepare an SD card or eMMC Module as a boot disk.
6+
- Prepare a MicroSD card as a boot disk
77

8-
- Use the system utility rsetup to flash the SPI.
8+
- Use the system tool rsetup to flash SPI
99

10-
- Flash the system image to the NVME SSD.
10+
- Flash the system image to the NVMe SSD
1111

12-
- Unplug the SD card and boot from NVME.
12+
- Remove the MicroSD card and boot from NVMe
1313

14-
### Prepare an SD card or eMMC Module as a boot disk.
14+
## Booting the System Normally
1515

16-
Refer to the section on <a href={props.etcher_path}> making a MicroSD boot disc </a> to install the system on the SD card.
16+
Refer to the <a href={props.etcher_path}>Create MicroSD Boot Disk</a> section to install the system on a MicroSD card.
1717

18-
Here the SD card acts as a boot disk for x86, the purpose is to get the spi.img, and flash the spi.img to the spi flash.
18+
The MicroSD card here serves a similar purpose to a boot disk in x86 systems, which is to obtain spi.img and flash it to the SPI flash.
1919

20-
After booting from the SD card, execute the following command to update the system.
20+
After booting from the MicroSD card, run the following commands to update the system:
2121

2222
```
2323
sudo apt-get update
2424
sudo apt-get full-upgrade
2525
```
2626

27-
### Use the system utility <a href={props.rsetup_path}> rsetup </a> to flash the SPI.
27+
## Using System Tool <a href={props.rsetup_path}>rsetup</a> to Flash SPI
28+
29+
Select the `System Maintenance` option:
2830

2931
<img
30-
src="/img/common/nvme/system_maintenance.webp"
32+
src="/en/img/common/nvme/system_maintenance.webp"
3133
width="700"
3234
height="500"
3335
alt="system maintenance"
3436
/>
3537

38+
Select the `Update SPI Bootloader` option:
39+
3640
<img
37-
src="/img/common/nvme/update_spi_bootloader.webp"
41+
src="/en/img/common/nvme/update_spi_bootloader.webp"
3842
width="700"
3943
alt="update spi bootloader"
4044
/>
4145

46+
Select the bootloader option from the menu, then follow the prompts to update the SPI Flash:
47+
4248
<Image
43-
src="/img/common/nvme/rsetup-select-bootloader-#model#.webp"
49+
src="/en/img/common/nvme/rsetup-select-bootloader-#model#.webp"
4450
model={props.model}
4551
fallback={props.model}
4652
width="700"
4753
/>
4854

49-
<img src="/img/common/nvme/writing_mtd.webp" width="700" alt="writing to mtd" />
55+
Wait for the update to complete.
5056

51-
<img src="/img/common/nvme/success.webp" width="700" alt="success" />
57+
<img
58+
src="/en/img/common/nvme/writing_mtd.webp"
59+
width="700"
60+
alt="writing to mtd"
61+
/>
62+
63+
<img src="/en/img/common/nvme/success.webp" width="700" alt="success" />
5264

53-
### Flashing the system image to the NVME SSD
65+
## Flashing the System Image to NVMe SSD
5466

55-
Insert the NVME SSD into the board and verify that the NVME is recognized by the system,
67+
Insert the NVMe SSD into the board and verify that the system recognizes it,
5668

5769
<PreView params={{ model: props.model }}>
5870
{`
5971
radxa@#model#:~$ lsblk
60-
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
61-
mmcblk0 179:0 0 14.5G 0 disk
62-
├─mmcblk0p1 179:1 0 16M 0 part /config
63-
└─mmcblk0p2 179:2 0 14.4G 0 part /config
64-
mmcblk0boot0 179:32 0 4M 1 disk
65-
mmcblk0boot1 179:64 0 4M 1 disk
66-
zram0 254:0 0 3.8G 0 disk [SWAP]
67-
nvme0n1 259:0 0 238.5G 0 disk
72+
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
73+
mmcblk0 179:0 0 14.5G 0 disk
74+
├─mmcblk0p1 179:1 0 16M 0 part /config
75+
└─mmcblk0p2 179:2 0 14.4G 0 part /
76+
mmcblk0boot0 179:32 0 4M 1 disk
77+
mmcblk0boot1 179:64 0 4M 1 disk
78+
zram0 254:0 0 3.8G 0 disk [SWAP]
79+
nvme0n1 259:0 0 238.5G 0 disk
6880
`}
6981
</PreView>
7082

71-
As shown above the system already recognizes the NVME SSD as nvme0n1 (in Linux NVMe devices are usually recognized as nvmeXnY)
83+
As shown above, the system has recognized the NVMe SSD as nvme0n1 (in Linux, NVMe devices are typically recognized as nvmeXnY)
7284

73-
Download the following system image to your PC,
85+
Download the system image to the board from the <a href={props.download_path}>Resource Download</a>. Here we'll demonstrate using the `wget` command to download the system image on the board. You can copy the URL from the <a href={props.download_path}>Resource Download</a> page.
7486

75-
<PreView
76-
params={{
77-
model: props.model,
78-
release_num: props.release_num,
79-
desktop: props.desktop,
80-
}}
81-
>
82-
{`
83-
https://github.com/radxa-build/#model#/releases/download/#release_num#/#model#_debian_bullseye_#desktop#_#release_num#.img.xz
84-
`}
85-
</PreView>
87+
:::tip Alternative Methods to Download System Image
8688

87-
Copy the system image to the current system,
89+
1. Access the <a href={props.download_path}>Resource Download</a> directly on the board and download the system image through the browser.
90+
2. Download the system image on your PC, then transfer it to the board using a USB drive or online transfer (such as FTP, SCP, etc.).
91+
:::
8892

8993
<PreView
9094
params={{
@@ -94,13 +98,16 @@ Copy the system image to the current system,
9498
}}
9599
>
96100
{`
97-
PC Host: scp /path/to/img radxa@boardIP:/home/radxa/
98-
eg:
99-
scp ~/Download/#model#_debian_bullseye_#desktop#_#release_num#.img.xz [email protected]:/home/radxa/
101+
# Install wget
102+
sudo apt-get install wget
103+
# Download system image
104+
wget [URL]
100105
`}
101106
</PreView>
102107

103-
Then dd the system image into NVME on the **board**.
108+
- wget : Download files, replace [URL] with the actual download link.
109+
110+
Then use the `dd` command on the **board** to write the system image to the NVMe SSD.
104111

105112
<PreView
106113
params={{
@@ -110,13 +117,18 @@ Then dd the system image into NVME on the **board**.
110117
}}
111118
>
112119
{`
113-
On Board:
114-
sudo xzcat /path/to/img | dd of=/path/to/nvme bs=1M status=progress
115-
eg:
116-
sudo xzcat /home/radxa/#model#_debian_bullseye_#desktop#_#release_num#.img.xz | sudo dd of=/dev/nvme0n1 bs=1M status=progress
120+
sudo xzcat /path/to/img | sudo dd of=/path/to/nvme bs=1M status=progress
121+
Example:
122+
sudo xzcat /home/radxa/#model#_xx.img.xz | sudo dd of=/dev/nvme0n1 bs=1M status=progress
117123
`}
118124
</PreView>
119125

120-
### Unplug the SD card and boot from NVME
126+
- xzcat : Decompress the xz-format system image file
127+
- dd : Copy and write to the NVMe SSD device (⚠️Warning: Verify the device name when using the `dd` command, as incorrect device names may cause data loss)
128+
- of=/dev/nvme0n1 : Specify the target device as nvme0n1 (can be modified according to actual situation)
129+
- bs=1M : Set the block size to 1M to improve write speed
130+
- status=progress : Show write progress to monitor the status
131+
132+
## Remove SD Card and Boot from NVMe
121133

122-
After removing the SD card, power up the system using the {props.pwr} power adapter, then the system starts booting from NVME and HDMI displays the desktop.
134+
After removing the SD card, power on the device using the {props.pwr} power adapter. The system will then boot from the NVMe drive, and the desktop will be displayed via HDMI.

0 commit comments

Comments
 (0)