diff --git a/docs/Home.md b/docs/Home.md index 1af036f0c..f6d88e3c2 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -180,6 +180,22 @@ sidebar_custom_props: }, ], }, + { + products_name: "ROCK 4D", + products_photo_url: "/home/product-pictures/rock4d.webp", + products_link: "/rock4/rock4d", + docs: + [ + { + docs_link: "/rock4/rock4d", + docs_photo_type: "Overview", + docs_name_en: "Overview", + docs_name_zh: "ROCK 4D 概览", + docs_info_en: "Overview of the ROCK 4D", + docs_info_zh: "ROCK 4D 概览", + }, + ], + }, ], }, { diff --git a/docs/common/dev/_rkdeveloptoolV2.mdx b/docs/common/dev/_rkdeveloptoolV2.mdx index e4a0bcd3c..2b00e219c 100644 --- a/docs/common/dev/_rkdeveloptoolV2.mdx +++ b/docs/common/dev/_rkdeveloptoolV2.mdx @@ -132,7 +132,7 @@ rkdeveloptool 不支持选择 Maskrom 设备，也无法选择待写入的存储 > {` -1. 解压镜像文件（镜像文件请到 "文件下载" 部分下载， 此处 以 #model#_debian_bullseye-test_#desktop#_#release_num#.img.xz 为例） +1. 解压镜像文件（镜像文件请到 "文件下载" 部分下载， 此处 以 #model#_debian_bullseye-test_#desktop#_#release_num#.img.xz 为例） xz -d #model#\_debian_bullseye-test_#desktop#\_#release_num#.img.xz 2. 烧录 Loader (Loader文件请到本文 "文件下载" 部分下载) sudo rkdeveloptool db #loader# diff --git a/docs/common/radxa-os/_mali-gpu.mdx b/docs/common/radxa-os/_mali-gpu.mdx index 3a225b10e..539f4a5d4 100644 --- a/docs/common/radxa-os/_mali-gpu.mdx +++ b/docs/common/radxa-os/_mali-gpu.mdx @@ -110,7 +110,7 @@ blacklist panfrost #blacklist midgard_kbase ``` -## 关闭 Zink 支持 +## 关闭 Zinc 支持 ```bash echo "LIBGL_KOPPER_DISABLE=true" | sudo tee -a /etc/environment diff --git a/docs/e/e54c/getting-started/install-os/boot_from_nvme.md b/docs/e/e54c/getting-started/install-os/boot_from_nvme.md index afc237e1f..355e448b6 100644 --- a/docs/e/e54c/getting-started/install-os/boot_from_nvme.md +++ b/docs/e/e54c/getting-started/install-os/boot_from_nvme.md @@ -65,6 +65,7 @@ rsetup 为防止 SPI Flash 中存放的 bootloader 在平时使用被误写入，默认 SPI Flash 设备是关闭的。通过以下方式使能 SPI Flash 设备。 选择 `Overlays` → `Manage Overlays` ： +
@@ -92,6 +93,7 @@ rsetup 重启系统后，再次打开系统配置工具 `rsetup`。 选择 `System` → `Bootloader Management` → `Update SPI Bootloader` : +
@@ -194,7 +196,9 @@ sudo xzcat ~/radxa-e54c_bookworm_cli_b2.output.img.xz | sudo dd of=/dev/nvme0n1 ``` + sudo fdisk -l /dev/nvme0n1 + ``` @@ -221,8 +225,10 @@ sudo fdisk -l /dev/nvme0n1 ``` + lsblk df -h + ``` @@ -255,7 +261,9 @@ df -h ``` + sudo apt update && sudo apt upgrade + ``` @@ -273,7 +281,9 @@ sudo apt update && sudo apt upgrade ``` + sudo dd if=/dev/nvme0n1 of=/dev/null bs=1M count=1024 iflag=direct + ``` @@ -281,11 +291,15 @@ sudo dd if=/dev/nvme0n1 of=/dev/null bs=1M count=1024 iflag=direct ``` + # 安装 nvme-cli + sudo apt install nvme-cli # 检查温度 + sudo nvme smart-log /dev/nvme0n1 | grep "temperature" + ``` @@ -293,10 +307,13 @@ sudo nvme smart-log /dev/nvme0n1 | grep "temperature" ``` + sudo nvme list + ```
-
\ No newline at end of file + +``` diff --git a/docs/orion/o6/bios/install-bios.md b/docs/orion/o6/bios/install-bios.md index 34041ad5f..4f8679237 100644 --- a/docs/orion/o6/bios/install-bios.md +++ b/docs/orion/o6/bios/install-bios.md @@ -27,13 +27,13 @@ description: "" ``` -BuildOptions -BurnImage.efi -cix_flash_all.bin -cix_flash_ota.bin -FlashUpdate.efi -setup.nsh -Shell.efi +BuildOptions +BurnImage.efi +cix_flash_all.bin +cix_flash_ota.bin +FlashUpdate.efi +setup.nsh +Shell.efi VariableInfo.efi ``` @@ -133,23 +133,28 @@ Please make sure the power stays on during the operation. Enter 'q' to quit, any other key to continue: -************************************************************************ +--- + Updating BIOS... -************************************************************************ + +--- ======================================================================== - Copyright 2024 Cix Technology Group Co., Ltd. All Rights Reserved. - FlashUpdate Utility v1.04. - Build Date:Jan 16 2025 +Copyright 2024 Cix Technology Group Co., Ltd. All Rights Reserved. +FlashUpdate Utility v1.04. +Build Date:Jan 16 2025 ======================================================================== Old Version:0.2.2-1 New Version:0.2.2-1 [00.15] Processing... Flash update success. -************************************************************************ +--- + BIOS Update completed! -************************************************************************ + +--- + System will now power off. You MUST fully remove all connected power source before connecting them. Failure to do so may prevent some components to use the updated code. @@ -183,9 +188,11 @@ Reset with BIOS Update (24 bytes) ``` + Tianocore/EDK2 firmware version 0.2.2-1 Press ESCAPE for boot options ..... + ``` @@ -194,28 +201,21 @@ Press ESCAPE for boot options ``` - Radxa Orion O6 - CIX P1 CD8180 1.80 GHz - 0.2.2-1 65536 MB RAM - - - - Select Language This is the option - one adjusts to change - > Device Manager the language for the - > Boot Manager current system - > Boot Maintenance Manager +Radxa Orion O6 +CIX P1 CD8180 1.80 GHz +0.2.2-1 65536 MB RAM - Continue - Reset +Select Language This is the option +one adjusts to change +> Device Manager the language for the +> Boot Manager current system +> Boot Maintenance Manager +Continue +Reset - - - - - ^v=Move Highlight =Select Entry +^v=Move Highlight =Select Entry ``` @@ -228,29 +228,27 @@ Press ESCAPE for boot options ``` + /------------------------------------------------------------------------------\ -| Boot Manager | +| Boot Manager | \------------------------------------------------------------------------------/ Device Path : - Boot Manager Menu Fv(9A15AA37-D555-4A4E- - B541-86391FF68164)/FvF - debian ile(7C04A583-9E3E-4F1C - UEFI aigo U330 90003C33924E4D12 -AD65-E05268D0B4D1) - UEFI KINGBANK KP230 K19010J001612 - UEFI Shell - - Use the <^> and keys to choose a boot option, - the key to select a boot option, and the - key to exit the Boot Manager Menu. - - +Boot Manager Menu Fv(9A15AA37-D555-4A4E- +B541-86391FF68164)/FvF +debian ile(7C04A583-9E3E-4F1C +UEFI aigo U330 90003C33924E4D12 -AD65-E05268D0B4D1) +UEFI KINGBANK KP230 K19010J001612 +UEFI Shell +Use the <^> and keys to choose a boot option, +the key to select a boot option, and the + key to exit the Boot Manager Menu. /------------------------------------------------------------------------------\ -| | -| ^v=Move Highlight =Select Entry Esc=Exit | +| | +| ^v=Move Highlight =Select Entry Esc=Exit | \------------------------------------------------------------------------------/ ``` @@ -260,33 +258,35 @@ Press ESCAPE for boot options ``` + UEFI Interactive Shell v2.2 EDK II UEFI v2.70 (EDK II, 0x00010000) Mapping table - FS0: Alias(s):HD0b:;BLK1: - PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 +FS0: Alias(s):HD0b:;BLK1: +PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 1)/HD(1,GPT,80810833-48A5-4976-A296-0209E1012834,0x800,0x100000) - FS1: Alias(s):HD1b0c:;BLK6: - VenHw(0D51905B-B77E-452A-A2C0-ECA0CC8D514A,00801D090000000000)/USB(0x1 +FS1: Alias(s):HD1b0c:;BLK6: +VenHw(0D51905B-B77E-452A-A2C0-ECA0CC8D514A,00801D090000000000)/USB(0x1 ,0x0)/HD(2,GPT,3A7E1703-AD97-4EE2-A0E0-BDC978C453D0,0x8800,0x3A8F000) - BLK0: Alias(s): - PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 -1) - BLK2: Alias(s): - PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 -1)/HD(2,GPT,02EC7511-B73F-4F06-ABBF-ACEF796021D2,0x100800,0xEB93000) - BLK3: Alias(s): - PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 -1)/HD(3,GPT,19A46BB8-BDB9-4A8B-A2A8-03CE65C39A29,0xEC93800,0x1E8800) - BLK4: Alias(s): - VenHw(0D51905B-B77E-452A-A2C0-ECA0CC8D514A,00801D090000000000)/USB(0x1 -,0x0) - BLK5: Alias(s): - VenHw(0D51905B-B77E-452A-A2C0-ECA0CC8D514A,00801D090000000000)/USB(0x1 -,0x0)/HD(1,GPT,EE706585-639D-48CE-B236-4C372373E325,0x800,0x8000) -Press ESC in 1 seconds to skip startup.nsh or any other key to continue. -Shell> +BLK0: Alias(s): +PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 + +1. BLK2: Alias(s): + PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 + 1)/HD(2,GPT,02EC7511-B73F-4F06-ABBF-ACEF796021D2,0x100800,0xEB93000) + BLK3: Alias(s): + PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 + 1)/HD(3,GPT,19A46BB8-BDB9-4A8B-A2A8-03CE65C39A29,0xEC93800,0x1E8800) + BLK4: Alias(s): + VenHw(0D51905B-B77E-452A-A2C0-ECA0CC8D514A,00801D090000000000)/USB(0x1 + ,0x0) + BLK5: Alias(s): + VenHw(0D51905B-B77E-452A-A2C0-ECA0CC8D514A,00801D090000000000)/USB(0x1 + ,0x0)/HD(1,GPT,EE706585-639D-48CE-B236-4C372373E325,0x800,0x8000) + Press ESC in 1 seconds to skip startup.nsh or any other key to continue. + Shell> + ``` @@ -296,33 +296,42 @@ Shell> ``` + FS1:\> setup.nsh -************************************************************************ + +--- + Radxa BIOS Update Utility -************************************************************************ + +--- You are about to update the BIOS. Please make sure the power stays on during the operation. Enter 'q' to quit, any other key to continue: -************************************************************************ +--- + Updating BIOS... -************************************************************************ + +--- ======================================================================== - Copyright 2024 Cix Technology Group Co., Ltd. All Rights Reserved. - FlashUpdate Utility v1.04. - Build Date:Jan 16 2025 +Copyright 2024 Cix Technology Group Co., Ltd. All Rights Reserved. +FlashUpdate Utility v1.04. +Build Date:Jan 16 2025 ======================================================================== Old Version:0.2.2-1 New Version:0.2.2-1 [00.15] Processing... Flash update success. -************************************************************************ +--- + BIOS Update completed! -************************************************************************ + +--- + System will now power off. You MUST fully remove all connected power source before connecting them. Failure to do so may prevent some components to use the updated code. @@ -341,3 +350,4 @@ Reset with BIOS Update (24 bytes) ### 方法三：离线更新 BIOS 对于需要从损坏的BIOS中恢复或偏好直接硬件访问的高级用户，可以使用 Serial Flash 编程器（如CH341A）将BIOS固件（cix_flash_all.bin）直接刷写到SPI NOR Flash芯片中。此方法完全绕过操作系统，即使在设备无法启动的情况下也能工作。有关详细的步骤说明和硬件要求，请参阅社区成员Meco提供的全面[论坛指南](https://forum.radxa.com/t/guide-flash-bios-with-ch341a-macos-linux/26742)，其中涵盖了在macOS和Linux平台上的操作过程。 +``` diff --git a/docs/productlist.md b/docs/productlist.md index 4a4766299..01b9503d9 100644 --- a/docs/productlist.md +++ b/docs/productlist.md @@ -24,6 +24,7 @@ displayed_sidebar: home | ROCK 4A+ / 4B+ (2021) | 基于 OP1 支持 4K HDMI 标准接口和板载 eMMC | | [ROCK 4SE](/rock4/rock4se/) (2022) | 基于 RK3399-T 支持 4K HDMI 标准接口 | | [ROCK 4C+](/rock4/rock4c+/) (2022) | 基于 RK3399-T 支持 4K + 2K micro HDMI 接口 | +| [ROCK 4D](/rock4/rock4d/) (2025) | 基于 RK3576 支持 4K HDMI 标准接口 | ### ROCK 5 系列 diff --git a/docs/rock4/rock4d/README.md b/docs/rock4/rock4d/README.md new file mode 100644 index 000000000..f0fc5d7be --- /dev/null +++ b/docs/rock4/rock4d/README.md @@ -0,0 +1,105 @@ +--- +sidebar_position: 11 +sidebar_label: ROCK 4D +--- + +# ROCK 4D - 工业级 AI 单板计算机 + +## 产品概述 + +Radxa ROCK 4D 是一款紧凑型单板计算机 (SBC)，拥有众多一流功能、特性和扩展选项。 + +ROCK 4D 搭载 Rockchip RK3576 或 RK3576J SoC，配备八核 CPU（4 个 Cortex-A72 + 4 个 Cortex-A53）、Mali-G52 GPU 和强大的 6 TOPS NPU，非常适合 AI 和多媒体任务。 + +对于创客、物联网爱好者、业余爱好者、游戏玩家、PC 用户、OEM 厂商、工业应用以及所有需要高性能和高可靠性的高性能平台的用户而言，ROCK 4D 都是理想之选。 + +Radxa ROCK 4D 提供两个版本：基于 RK3576 的商业级 ROCK 4D 和 基于 RK3576J 的工业级 ROCK 4D。 + +## 产品外观 + +
+ Radxa ROCK 4D 正面 + + Radxa ROCK 4D 背面 + +
+ +## 产品规格 + +| 类别 | 规格 | +| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| 处理器 | 系统级芯片 (SoC)： 瑞芯微 RK3576 / RK3576J
中央处理器 (CPU)： 4 核 Cortex-A72 + 4 核 Cortex-A53
图形处理器 (GPU)： Arm Mali-G52 MC3
神经网络加速器 (NPU)： 6 TOPS（支持 INT4 / INT8 / INT16 / FP16 / BF16 / TF32） | +| 内存 (RAM) | LPDDR5，可选：2GB / 4GB / 8GB / 16GB | +| 存储 | 启动存储： 16MB SPI NOR Flash
拓展存储： eMMC / UFS 模块接口，MicroSD 卡槽 | +| 网络 | 有线连接： 1 个千兆以太网口（支持 PoE，需外接 HAT）
无线连接： Wi-Fi 6、蓝牙 5.4，外接天线接口 | +| 视频输出 | HDMI 接口： 1× HDMI 2.1，最高支持 4K@120fps
MIPI DSI 接口： 1× 4-lane MIPI DSI | +| 摄像头接口 | MIPI CSI 接口 : 1 路 4-lane（可分为 2 路 2-lane）+ 1 路 2-lane CSI | +| 音频 | 音频接口 ： 3.5mm 四段耳机插孔，支持麦克风输入
音频输出 ： 支持立体声输出，可直接驱动 32Ω 耳机 | +| USB 接口 | USB 3.0 ： 1× Type-A HOST，1× Type-A OTG/HOST
USB 2.0 ： 2× Type-A HOST | +| 拓展接口 | GPIO 引脚排针 ： 支持 UART、SPI、I2C、I2S、PWM、CAN、ADC 等
PCIE 插槽 ： 通过 FPC 接口提供 PCIe 2.1 x1 通道
风扇接口 ： 1× 2-pin 1.25mm PWM 控制风扇接口 | +| 电源接口 | 电源接口 ： 支持 USB Type-C 接口和 GPIO 引脚供电 | +| 操作系统 | 操作系统 ： 支持 Debian Linux、Android 14、Yocto、Buildroot | +| 工作温度 | 工作温度（商业级）： 0°C ~ 60°C（RK3576）
工作温度（工业级）： -40°C ~ 85°C（RK3576J） | + +## 接口说明 + +
+ +
+ +| 序号 | 说明 | 数量 | +| :--: | :---------------------- | :--: | +| ① | USB Type-C 供电接口 | 1 | +| ② | 用户指示灯 | 1 | +| ③ | 电源指示灯 | 1 | +| ④ | 电源按键 | 1 | +| ⑤ | FPC 接口 | 1 | +| ⑥ | WiFi6 和 蓝牙 5.4 | 1 | +| ⑦ | 外接天线接口 | 1 | +| ⑧ | 40 Pin GPIO | 1 | +| ⑨ | LPDDR5 内存 | 1 | +| ⑩ | PoE 接口 | 1 | +| ⑪ | Maskrom 按键 | 1 | +| ⑫ | USB 2.0 Type-A | 2 | +| ⑬ | Rockchip RK3576（J） | 1 | +| ⑭ | USB 3.0 Type-A | 2 | +| ⑮ | SPI NOR Flash | 1 | +| ⑯ | 千兆以太网口（支持PoE） | 1 | +| ⑰ | 风扇接口 | 1 | +| ⑱ | 耳机插孔 | 1 | +| ⑲ | MIPI CSI 接口 | 1 | +| ⑳ | HDMI 2.1 接口 | 1 | +| ㉑ | Recovery 接口 | 1 | +| ㉒ | UFS 模块接口 | 1 | +| ㉓ | RTC 接口 | 1 | +| ㉔ | eMMC 模块接口 | 1 | +| ㉕ | MIPI CSI 接口 | 1 | +| ㉖ | MicroSD 卡槽 | 1 | +| ㉗ | MIPI DSI 接口 | 1 | + +## 应用场景 + +### Linux 初学者 + +作为一款基于 Linux 的单板计算机，ROCK 4D 可以用于 Linux 入门学习、进阶底层和应用层开发。 + +### 机器人开发 + +作为机器人开发的主控，提供优秀的性能和丰富的硬件接口，方便用户开发机器人应用。 + +### 嵌入式开发 + +引出丰富的 GPIO 接口，支持UART、SPI、I2C、I2S等通讯方式，方便用户驱动各种硬件。 + +### AI 开发 + +具有高达 6 TOPS 的神经网络加速器，可用于 AI 推理和训练。 + +## 系统平台 + +ROCK 4D 基于 RK3576 或 RK3576J 芯片组，支持 ArmV8 指令集和多种操作系统。 + +- Debian Linux +- Yocto Linux +- Buildroot +- Android 14 diff --git a/docs/rock4/rock4d/download.md b/docs/rock4/rock4d/download.md new file mode 100644 index 000000000..e1ee12d6b --- /dev/null +++ b/docs/rock4/rock4d/download.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 15 +--- + +# 资源下载汇总 + +## Loader文件下载 + +USB 刷机使用，Loader 文件用于 USB 下载初始化。 + +- Loader： [rk3576_spl_loader.bin](https://dl.radxa.com/rock4/4d/images/rk3576_spl_loader.bin) + +## 系统镜像下载 + +Linux 系统镜像，可以直接写入系统镜像到 MicroSD 卡 / UFS 模块 / NVME 启动系统。 + +- 适用于 MicroSD 卡 / NVME SSD / U 盘 等介质启动的系统镜像： [rk3576_bookworm_kde_512.img.xz](https://github.com/radxa-build/radxa-rk3576/releases/download/rsdk-b1/radxa-rk3576_bookworm_kde_b1.output_512.img.xz) + +- 适用于 UFS 启动的系统镜像： [rk3576_bookworm_kde_4096.img.xz](https://github.com/radxa-build/radxa-rk3576/releases/download/rsdk-b1/radxa-rk3576_bookworm_kde_b1.output_4096.img.xz) + +:::caution + +1. 请根据自己的系统启动介质下载对应系统镜像文件，下载错误的镜像会导致无法启动系统， UFS 镜像和普通镜像主要区别是 UFS 镜像的块大小是 4K 字节，普通镜像块大小是 512 字节。 +2. 下载的系统镜像是经过压缩的，请务必解压后再写入到 MicroSD 卡/UFS 模块/NVME 启动系统。 + ::: + +## 硬件设计 + +- [原理图](https://dl.radxa.com/rock4/4d/docs/hw/Radxa_ROCK_4D_SCH_V1.11.pdf) +- [位号图](https://dl.radxa.com/rock4/4d/docs/hw/Radxa_ROCK_4D_SMD_V1.11.pdf) +- [3D 模型](https://dl.radxa.com/rock4/4d/docs/hw/Radxa_ROCK_4D_3D_v1_11_20250328.stp) + +## 参考文档 + +- [Radxa ROCK 4D 特性图](https://dl.radxa.com/rock4/4d/docs/ROCK4D_Quick_Features_EN.pdf) +- [Radxa ROCK 4D 规格书](https://dl.radxa.com/rock4/4d/docs/radxa_rock4d_product_brief.pdf) diff --git a/docs/rock4/rock4d/getting-started/README.md b/docs/rock4/rock4d/getting-started/README.md new file mode 100644 index 000000000..268361ef0 --- /dev/null +++ b/docs/rock4/rock4d/getting-started/README.md @@ -0,0 +1,15 @@ +--- +sidebar_position: 11 +--- + +# 上手指南 + +上手指南可以让用户快速了解和使用 Radxa ROCK 4D 开发板。 + +### [快速上手](/rock4/rock4d/getting-started/quickly_start) + +以 MicroSD 卡启动系统的方式，详细说明使用 Radxa ROCK 4D 需要准备的硬件、软件以及安装和使用系统的方法。 + +### [安装系统](/rock4/rock4d/getting-started/install-system) + +主要介绍 Radxa ROCK 4D 如何通过不同启动介质（如 MicroSD 卡、UFS 模块、M.2 NVMe SSD 等）来安装和启动系统。 diff --git a/docs/rock4/rock4d/getting-started/install-system/README.md b/docs/rock4/rock4d/getting-started/install-system/README.md new file mode 100644 index 000000000..093f83da8 --- /dev/null +++ b/docs/rock4/rock4d/getting-started/install-system/README.md @@ -0,0 +1,27 @@ +# 安装系统 + +Radxa ROCK 4D 支持 MicroSD 卡、UFS 模块和 M.2 NVMe SSD 三种方式安装系统，用户可以根据自己的需求选择对应的系统启动介质。 + +- 使用 MicroSD 卡安装系统 - 操作简单，只需要读卡器就可以完成系统安装；但是读写速度相比于 UFS 模块和 M.2 NVMe SSD 卡较慢。 + +- 使用 UFS 模块安装系统 - 相比于 MicroSD 卡读写速度更快，Radxa ROCK 4D 支持可插拔 UFS 模块，关于 UFS 模块信息可以参考[瑞莎 UFS 模块页面](https://radxa.com/products/accessories/ufs-module) + +- 使用 M.2 NVMe SSD 安装系统 - 相比于 UFS 模块读写速度更快，但是需要搭配专门的转接板使用。 + +总的来说，如果对读写性能没有过高要求，可以使用 MicroSD 卡作为系统启动介质；如果对读写速度有要求而且不需要借助额外的转接板连接 Radxa ROCK 4D，可以使用 UFS 模块安装系统；如果对读写速度有更高的要求，可以使用 M.2 NVMe SSD 安装系统。 + +### [安装系统到 MicroSD 卡](/rock4/rock4d/getting-started/install-system/boot_sd) + +主要介绍 Radxa ROCK 4D 使用 MicroSD 卡安装系统和启动系统的方法。 + +### [安装系统到 UFS 模块](/rock4/rock4d/getting-started/install-system/ufs-system) + +主要介绍 Radxa ROCK 4D 使用 UFS 模块安装系统和启动系统的方法。 + +### [安装系统到 M.2 NVMe SSD](/rock4/rock4d/getting-started/install-system/nvme-system) + +主要介绍 Radxa ROCK 4D 使用 M.2 NVMe SSD 安装系统和启动系统的方法。 + +### [下载并烧录 SPI 启动固件文件](/rock4/rock4d/getting-started/install-system/boot_start) + +主要介绍如何下载并烧录 SPI 启动固件文件到 Radxa ROCK 4D。 diff --git a/docs/rock4/rock4d/getting-started/install-system/boot_sd.md b/docs/rock4/rock4d/getting-started/install-system/boot_sd.md new file mode 100644 index 000000000..4a0aff058 --- /dev/null +++ b/docs/rock4/rock4d/getting-started/install-system/boot_sd.md @@ -0,0 +1,165 @@ +--- +sidebar_position: 1 +--- + +# 安装系统到 MicroSD 卡 + +本节教程主要介绍如何给 MicroSD 卡安装系统。 + +## 硬件准备 + +您需要提前准备好以下硬件设备才可以完成安装和启动系统的所有操作。 + +#### 安装系统 + +- 读卡器：MicroSD 卡读卡器 +- 系统启动介质：MicroSD 卡（推荐容量 32GB 或以上） + +#### 启动系统 + +- 开发板： Radxa ROCK 4D +- 电源适配器：Type-C 电源适配器( 支持 PD 协议，5V 电源输入，建议电流 3A 以上) + +:::tip +Radxa ROCK 4D 主板仅支持 5V 电源输入，建议电流 3A 以上，确保所有外设稳定运行。 + +参考电源： + +- [瑞莎 PD 30W电源适配器(推荐使用)](https://radxa.com/products/accessories/power-pd-30w) + +- 标准 Type-C 电源适配器( 5V 电源输入，支持 PD 协议，建议电流 3A 以上) + ::: + +## 安装系统 + +安装系统会格式化 MicroSD 卡，如果有重要数据请提前备份。 + +### 下载系统镜像 + +在 PC 上访问 [资源下载汇总](../../download) 页面，在下载页面找到 MicroSD 卡对应的系统镜像。 + +下载完成后，解压系统镜像文件，得到的 `*.img` 文件就是待烧写到 MicroSD 卡中的系统镜像文件。 + +:::tip +下载的系统镜像是一个压缩文件，需要解压后才能通过镜像烧录软件安装到SD卡, 未解压就直接烧录到SD卡，可能会出现安装系统失败或者启动系统失败的情况。 +::: + +### 硬件连接 + +将 MicroSD 卡插入读卡器中，然后将读卡器插入 PC 的 USB 端口上。 + +
+ +
+ +### 安装系统镜像 + +使用开源镜像烧录工具 Etcher 烧写系统镜像文件到 MicroSD 卡。 + +#### 下载 Etcher + +进入 Balena Etcher 官网下载系统对应平台的软件：balenaEtcher。 + +
+ +
+ +根据自己的系统平台和架构下载对应的软件安装包。 + +
+ +
+ +#### 使用 Etcher + +下载完成后，双击打开 Etcher 应用。 + +:::tip + +- Windows + +下载的文件是 `*.exe` 格式的安装包，双击程序就可以运行。 + +- Linux + +推荐下载 `*.zip` 格式的压缩包，解压后双击程序就可以运行。 + +- MacOS + +根据自己的系统架构下载对应的 `*.dmg` 文件,双击打开后，将软件拖拽到 Applications 文件夹进行安装，安装完成后双击应用图标运行。 + +::: + +
+ +
+ +#### 安装系统镜像 + +1. 选择镜像文件 + +点击 `Flash from file` 选项，选择自己提前下载并解压好的系统镜像文件。 + +
+ +
+ +2. 选择存储设备 + +点击 `Select target` 选项，选择自己待安装系统镜像对应存储设备。 + +:::danger +请勿选错存储设备，否则 Etcher 将格式化被选中的存储设备，造成重要数据丢失！ + +您可以插拔存储设备，观察可选存储设备的变化，从而进一步判断待安装的存储设备。 +::: + +
+ +
+ +① ： 选择需要安装系统镜像的存储设备 + +② ： 点击 `Select 1` 选项确认设备选择 + +
+ +
+ +3. 安装系统镜像 + +点击 `Flash` 选项，等待软件自动进行系统镜像的安装和校验。 + +
+ +
+ +
+等待系统安装完成 + +
+ +
+等待系统校验完成 + + 成功安装系统镜像后，关闭 Etcher 软件！ +
+ +## 系统信息 + +您使用我们提供的系统镜像，首次需要使用我们设置的用户名和密码登录系统。 + +Debian Linux +用户账号：radxa + +用户密码：radxa + +## 启动系统 + +完成系统镜像的安装后，将 MicroSD 卡从读卡器上取下来，然后将卡插入主板的 MicroSD 卡槽中，使用 5V Type-C 电源适配器启动系统。 + +启动系统后，蓝色和绿色 LED 灯会同时亮起，大概过几秒左右，绿灯常亮、蓝色指示灯会闪烁，一般表示系统启动成功。 + +
+ +
diff --git a/docs/rock4/rock4d/getting-started/install-system/boot_start.md b/docs/rock4/rock4d/getting-started/install-system/boot_start.md new file mode 100644 index 000000000..34fe81203 --- /dev/null +++ b/docs/rock4/rock4d/getting-started/install-system/boot_start.md @@ -0,0 +1,112 @@ +--- +sidebar_position: 4 +--- + +# 烧录 SPI 启动固件 + +您可以将 SPI 启动固件想象成您个人电脑中的 **BIOS/UEFI**。正如 PC 的 BIOS/UEFI 负责在 Windows 或 Linux 等操作系统启动前初始化基本硬件（如内存、硬盘、键盘等）一样，嵌入式设备上的 SPI 启动固件也承担着类似的角色。 + +SPI 启动固件的核心任务是**初始化关键硬件**，例如： + +- **DDR 内存**：为主系统运行准备好内存空间。 +- **时钟频率**：设置芯片各部分的工作速度。 +- **存储控制器**：让系统能够访问 Micro SD 卡、UFS 模块或 M.2 NVMe SSD 等存储设备。 +- **GPIO (通用输入输出引脚)**：配置引脚功能，用于连接各种外设。 + +完成这些初始化后，SPI 启动固件就从 eMMC / SD卡 / NVMe SSD / U 盘 加载操作系统内核。这个 SPI 启动固件文件通常存储在主板上的一个特殊存储芯片中，称为 **SPI Nor Flash**，这块芯片的角色也类似于 PC 主板上存储 BIOS/UEFI 的那块芯片。 + +## 何时需要烧录 SPI 启动固件？ + +ROCK 4D 出厂时已预装适配的 SPI 启动固件。**如果您的设备工作正常，或未执行过擦除 SPI Nor Flash 的操作，通常无需进行此步骤。** + +仅在以下情况下需要重新烧录 SPI 启动固件： + +- **SPI Flash 内容损坏**：类似于个人电脑 BIOS 损坏导致无法启动 +- **需要升级固件版本**：获取新功能支持或修复已知问题 +- **特定开发需求**：例如从空白 SPI Flash 开始，或需要引导非官方支持的系统 +- **学习探索目的**：深入了解设备的底层启动机制 + +本教程将指导您完成 SPI 启动固件的烧录过程，这是在常规安装系统的基础上增加的初始引导程序写入步骤。 + +## 获取最新的 SPI 启动固件 + +你需要让 Radxa ROCK 4D 通过 MicroSD 卡启动系统，可以参考 [快速上手](../quickly_start) 教程完成。 + +成功启动系统并且确保系统连接网络正常，我们可以打开 Radxa ROCK 4D 终端命令行，使用 Rsetup 工具来更新系统。 + + +``` +sudo rsetup +``` + + +
+Rsetup 首页界面 + +
+ +:::tip +rsetup 工具使用指南：详细使用教程参考 [Rsetup 工具](../../system-config/rsetup) + +- 选中选项 ： 对应选项会高亮显示 +- 确认选择 ： 按 `Enter` +- 取消选择 ： 按 `ESC` +- 切换选项 ： 按 `Up` 、 `Down` 、 `Left` 、 `Right` 控制 +- 多选界面 ： 按 `Space` 选择，按 `Enter` 确认选择 + ::: + +进入 Rsetup 工具后，选择 `System` → `System Update`: + +
+ +
+ +选择 yes 继续操作，然后按照系统提示完成剩下操作： + +
+ +
+ +完成后所有操作后，使用命令重启系统。 + + +``` +sudo reboot +``` + + +## 烧录 SPI 启动固件 + +重启系统后，再次打开 Rsetup 工具。 + +选择 `System` → `Bootloader Management` → `Update SPI Bootloader` : + +
+ +
+ +选择 yes 继续操作，然后按照系统提示完成剩下操作。 + +
+ +
+ +选择安装的 Bootloader 文件:若选择的 Bootloader 有多个选项，优先选择带有 spi 后缀的选项。 + +
+ +
+ +系统会自动下载最新的 `spi.img` 然后烧录到 SPI Nor Flash 中。 + +
+ +
+ +完成后所有操作后，使用命令重启系统。 + + +``` +sudo reboot +``` + diff --git a/docs/rock4/rock4d/getting-started/install-system/nvme-system/README.md b/docs/rock4/rock4d/getting-started/install-system/nvme-system/README.md new file mode 100644 index 000000000..5423e165e --- /dev/null +++ b/docs/rock4/rock4d/getting-started/install-system/nvme-system/README.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 3 +--- + +# 安装系统到 NVMe SSD + +M.2 NVMe SSD 是一种高速、高容量、低成本的存储设备，其读写速度快于 MicroSD 卡和 UFS 模块，对于想进一步提高系统读写和启动速度的用户来说，是个不错的选择。 + +我们介绍两种方式安装系统到 M.2 NVMe SSD： + +- 对于有 M.2 NVMe 固态硬盘盒的用户，安装系统步骤和 MicroSD 卡安装系统的步骤类似，比较简单。 + +- 对于没有 M.2 NVMe 固态硬盘盒的用户，使用 `dd` 命令将系统镜像安装到 M.2 NVMe SSD。 + +:::tip + +Radxa ROCK 4D 上预留一个 FPC 接口，提供了 PCIe Gen2 ×1 通道的扩展能力。 + +使用 FPC 接口需要提前购买 PCIe 转 M.2 M Key HAT ，并按照配件说明正确安装。 + +::: + +### [使用 M.2 NVMe 固态硬盘盒](/rock4/rock4d/getting-started/install-system/nvme-system/nvme_reader) + +主要介绍用户在有 M.2 NVMe 固态硬盘盒的情况下，如何安装系统和启动系统。 + +### [不使用 M.2 NVMe 固态硬盘盒](/rock4/rock4d/getting-started/install-system/nvme-system/no_nvme_reader) + +主要介绍用户在没有 M.2 NVMe 固态硬盘盒的情况下，如何安装系统和启动系统。 diff --git a/docs/rock4/rock4d/getting-started/install-system/nvme-system/no_nvme_reader.md b/docs/rock4/rock4d/getting-started/install-system/nvme-system/no_nvme_reader.md new file mode 100644 index 000000000..e9b792294 --- /dev/null +++ b/docs/rock4/rock4d/getting-started/install-system/nvme-system/no_nvme_reader.md @@ -0,0 +1,183 @@ +--- +sidebar_position: 2 +--- + +# 不使用 M.2 NVMe 固态硬盘盒 + +本节教程适用于没有 M.2 NVMe 固态硬盘盒的用户，主要介绍如何在 MicroSD 卡启动系统的基础上将系统安装到 M.2 NVMe SSD 中。 + +:::tip +M.2 NVMe SSD 是指支持 M.2 接口和 NVMe 协议的固态硬盘。 +::: + +## 硬件准备 + +在没有 M.2 NVMe 固态硬盘盒的情况下安装系统，需要 Radxa ROCK 4D 通过 MicroSD 卡能正常启动系统。 + +**注意： 若 MicroSD 卡启动异常，可以参考 [安装系统到 MicroSD 卡](../boot_sd)教程，先安装系统到 MicroSD 卡上。** + +我们会在 MicroSD 卡上的系统进行操作，使用 `dd` 命令将系统安装到 M.2 NVMe SSD 中。 + +**注意：使用 M.2 NVMe SSD 启动系统都需要搭配 PCIe 转 M.2 M Key HAT 使用。** + +您需要准备以下硬件： + +- 开发板：Radxa ROCK 4D +- 正常启动系统的 MicroSD 卡 +- M.2 NVMe SSD: 自行购买 +- PCIe 转 M.2 M Key HAT : 自行购买 +- 电源适配器：Type-C 电源适配器( 支持 PD 协议，5V 电源输入，建议电流 3A 以上) + +:::tip +Radxa ROCK 4D 主板仅支持 5V 电源输入，建议电流 3A 以上，确保所有外设稳定运行。 + +参考电源： + +- [瑞莎 PD 30W电源适配器(推荐使用)](https://radxa.com/products/accessories/power-pd-30w) + +- 标准 Type-C 电源适配器( 5V 电源输入，支持 PD 协议，建议电流 3A 以上) + ::: + +## 重装系统 + +重装系统会格式化 M.2 NVMe SSD，如果有重要数据请提前备份。 + +### 下载系统镜像 + +下载 Radxa ROCK 4D 的系统镜像文件到 Radxa ROCK 4D 上：可以直接使用 `wget` 命令下载文件到当前目录，其中网址链接可以进入 [资源汇总下载](../../../download) 复制。 + +:::tip +你也可以通过其他方式将系统镜像文件复制到 Radxa ROCK 4D 上，比如通过 FTP、SCP 等方式 +::: + + +``` +# 安装 wget +sudo apt-get install wget +# 下载系统镜像文件 +wget [URL] +``` + +- wget : 下载文件，将 [URL] 替换成实际下载链接。 + +### 硬件连接 + +1. 将 M.2 NVMe 固态硬盘安装到 PCIe 转 M.2 M Key HAT 上 +2. 将 PCIe 转 M.2 M Key HAT 安装到 Radxa ROCK 4D 上 +3. 连接 Radxa ROCK 4D 的电源 + +
+ +
+ +### 安装系统镜像 + +#### 写入系统镜像到 M.2 NVMe SSD + +使用命令将压缩的系统镜像解压并直接写入到 M.2 NVMe SSD，请根据实际下载的系统镜像文件名进行修改。 + + +``` +sudo xzcat ~/radxa-rk3576_bookworm_kde_t2.output_512.img.xz | sudo dd of=/dev/nvme0n1 bs=1M status=progress +``` + + +- xzcat : 解压 xz 格式的系统镜像文件 +- dd : 复制并写入到 M.2 NVMe SSD 设备（⚠️注意：使用dd命令时请确认设备名称，错误的设备名可能导致数据丢失） +- of=/dev/nvme0n1 : 指定写入的设备为 nvme0n1（可以根据实际情况修改） +- bs=1M : 指定写入的块大小为 1M，提高写入速度 +- status=progress : 显示写入进度，让您了解写入状态 + +#### 验证写入结果 + +写入完成后，您可以验证 M.2 NVMe SSD 中的分区表是否正确创建： + + +``` +sudo fdisk -l /dev/nvme0n1 +``` + + +正确写入后，应该会看到类似以下的分区信息： + + +``` +Disk /dev/nvme0n1: 465.76 GiB, 500107862016 bytes, 976773168 sectors +Disk model: Samsung SSD 980 500GB +Units: sectors of 1 \* 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 16384 bytes / 131072 bytes +Disklabel type: gpt +Disk identifier: 9ABAF4B4-329B-41A8-908A-088211D43542 + +Device Start End Sectors Size Type +/dev/nvme0n1p1 32768 65535 32768 16M Linux filesystem +/dev/nvme0n1p2 65536 679935 614400 300M EFI System +/dev/nvme0n1p3 679936 15620800 14940865 7.1G EFI System +``` + + + +## 系统信息 + +您使用我们提供的系统镜像，首次需要使用我们设置的用户名和密码登录系统。 + +- Debian Linux + +用户账号：radxa + +用户密码：radxa + +## 启动系统 + +完成系统镜像的安装后： + +1. 关闭系统：`sudo shutdown -h now` +2. 断开 Radxa ROCK 4D 的电源 +3. 移除 MicroSD 卡 +4. 重新连接 Radxa ROCK 4D 的电源 +5. 等待系统从 M.2 NVMe SSD 启动 + +
+ +
+ +启动系统后，蓝色和绿色 LED 灯会同时亮起，大概过几秒左右，绿灯常亮、蓝色指示灯会闪烁，一般表示系统启动成功。 + +## 验证系统 + +系统启动后，您可以使用 `lsblk` 命令查看系统分区信息： + + +``` +sudo lsblk +``` + + +如果您看到 `/dev/nvme0n1p3` 被挂载为根目录 `/`，则表示系统已成功从 M.2 NVMe SSD 启动。 + + +``` +mtdblock0 31:0 0 16M 0 disk +zram0 253:0 0 1.9G 0 disk [SWAP] +nvme0n1 259:0 0 465.8G 0 disk +├─nvme0n1p1 259:1 0 16M 0 part /config +├─nvme0n1p2 259:2 0 300M 0 part /boot/efi +└─nvme0n1p3 259:3 0 465.4G 0 part / +``` + + +:::tip + +如果在启动过程中遇到问题，请尝试以下解决方案： + +- 系统无法启动： + + - 尝试重新安装 M.2 NVMe SSD，启动系统 + - 尝试 [下载并烧录最新 SPI 启动固件](../boot_start) + - 尝试重新安装系统到 M.2 NVMe SSD + +- 系统可以启动但无法登录： + - 默认用户名：radxa，密码：radxa + - 如密码错误，重新下载系统镜像和安装系统到 M.2 NVMe SSD + ::: diff --git a/docs/rock4/rock4d/getting-started/install-system/nvme-system/nvme_reader.md b/docs/rock4/rock4d/getting-started/install-system/nvme-system/nvme_reader.md new file mode 100644 index 000000000..881522044 --- /dev/null +++ b/docs/rock4/rock4d/getting-started/install-system/nvme-system/nvme_reader.md @@ -0,0 +1,215 @@ +--- +sidebar_position: 1 +--- + +# 使用 M.2 NVMe 固态硬盘盒 + +本节教程适用于有 M.2 NVMe 固态硬盘盒的用户，主要介绍如何通过 M.2 NVMe 固态硬盘盒给 M.2 NVMe SSD 安装系统。 + +:::tip +M.2 NVMe SSD 是指支持 M.2 接口和 NVMe 协议的固态硬盘。 +::: + +## 硬件准备 + +使用固态硬盘盒 给 M.2 NVMe SSD 安装系统，不需要依赖 MicroSD 卡，直接将 M.2 NVMe SSD 插入固态硬盘盒中，使用 Etcher 软件安装系统到 M.2 NVMe SSD 中。 + +**注意：使用 M.2 NVMe SSD 启动系统都需要搭配 PCIe 转 M.2 M Key HAT 使用。** + +您需要准备以下硬件： + +- 开发板：Radxa ROCK 4D +- M.2 NVMe SSD: 自行购买 +- M.2 NVMe 固态硬盘盒: 自行购买 +- PCIe 转 M.2 M Key HAT : 自行购买 +- 电源适配器：Type-C 电源适配器( 支持 PD 协议，5V 电源输入，建议电流 3A 以上) + +:::tip +Radxa ROCK 4D 主板仅支持 5V 电源输入，建议电流 3A 以上，确保所有外设稳定运行。 + +参考电源： + +- [瑞莎 PD 30W电源适配器(推荐使用)](https://radxa.com/products/accessories/power-pd-30w) + +- 标准 Type-C 电源适配器( 5V 电源输入，支持 PD 协议，建议电流 3A 以上) + ::: + +## 重装系统 + +重装系统会格式化 M.2 NVMe 固态硬盘，如果有重要数据请提前备份。 + +### 下载系统镜像 + +在 PC 上访问 [资源下载汇总](../../../download) 页面，在下载页面找到 M.2 NVMe SSD 对应的系统镜像文件，下载并解压。 + +下载完成后，得到的 `*.img` 文件就是待烧写到 M.2 NVMe SSD 中的系统镜像文件。 + +:::tip +下载的系统镜像是一个压缩文件，需要解压后才能通过镜像烧录软件安装到 M.2 NVMe SSD , 未解压就直接烧录到 M.2 NVMe SSD ，可能出现安装系统失败或者启动系统失败的情况。 +::: + +### 硬件连接 + +将 M.2 NVMe 固态硬盘插入固态硬盘盒中，然后将固态硬盘盒插入 PC 的 USB 端口上。 + +
+ +
+ +### 安装系统镜像 + +使用开源镜像烧录工具 Etcher 烧写系统镜像文件到 M.2 NVMe 固态硬盘中。 + +#### 下载 Etcher + +进入 Balena Etcher 官网下载系统对应平台的软件：balenaEtcher。 + +
+ +
+ +根据自己的系统平台和架构下载对应的软件安装包。 + +
+ +
+ +#### 使用 Etcher + +下载完成后，双击打开 Etcher 应用。 + +:::tip + +- Windows + +下载的文件是 `*.exe` 格式的安装包，双击程序就可以运行。 + +- Linux + +推荐下载 `*.zip` 格式的压缩包，解压后双击程序就可以运行。 + +- MacOS + +根据自己的系统架构下载对应的 `*.dmg` 文件,双击打开后，将软件拖拽到 Applications 文件夹进行安装，安装完成后双击应用图标运行。 + +::: + +
+ +
+ +#### 安装系统镜像 + +1. 选择镜像文件 + +点击 `Flash from file` 选项，选择自己提前下载并解压好的系统镜像文件。 + +
+ +
+ +2. 选择存储设备 + +点击 `Select target` 选项，选择自己待安装系统镜像对应存储设备。 + +:::danger +请勿选错存储设备，否则 Etcher 将格式化被选中的存储设备，造成重要数据丢失！ + +您可以插拔存储设备，观察可选存储设备的变化，从而进一步判断待安装的存储设备。 +::: + +
+ +
+ +① ： 选择需要安装系统镜像的存储设备 + +② ： 点击 `Select 1` 选项确认设备选择 + +
+ +
+ +3. 安装系统镜像 + +点击 `Flash` 选项，等待软件自动进行系统镜像的安装和校验。 + +
+ +
+ +
+等待系统安装完成 + +
+ +
+等待系统校验完成 + + 成功安装系统镜像后，关闭 Etcher 软件！ +
+ +## 系统信息 + +您使用我们提供的系统镜像，首次需要使用我们设置的用户名和密码登录系统。 + +- Debian Linux + +用户账号：radxa + +用户密码：radxa + +## 启动系统 + +完成系统镜像的安装后： + +1. 将 M.2 NVMe SSD 从 M.2 固态硬盘盒中取出 +2. 取下 Radxa ROCK 4D 上的 MicroSD 卡 +3. 将 M.2 NVMe SSD 安装到 PCIe 转 M.2 M Key HAT +4. 将 PCIe 转 M.2 M Key HAT 安装到 Radxa ROCK 4D 上 +5. 连接 Radxa ROCK 4D 的电源 +6. 等待系统从 M.2 NVMe SSD 启动 + +启动系统后，蓝色和绿色 LED 灯会同时亮起，大概过几秒左右，绿灯常亮、蓝色指示灯会闪烁，一般表示系统启动成功。 + +
+ +
+ +## 验证系统 + +系统启动后，您可以使用 `lsblk` 命令查看系统分区信息： + + +``` +sudo lsblk +``` + + +如果您看到 `/dev/nvme0n1p3` 被挂载为根目录 `/`，则表示系统已成功从 M.2 NVMe SSD 启动。 + + +``` +mtdblock0 31:0 0 16M 0 disk +zram0 253:0 0 1.9G 0 disk [SWAP] +nvme0n1 259:0 0 465.8G 0 disk +├─nvme0n1p1 259:1 0 16M 0 part /config +├─nvme0n1p2 259:2 0 300M 0 part /boot/efi +└─nvme0n1p3 259:3 0 465.4G 0 part / +``` + + +:::tip + +如果在启动过程中遇到问题，请尝试以下解决方案： + +- 系统无法启动： + + - 尝试重新安装 M.2 NVMe SSD，启动系统 + - 尝试 [下载并烧录最新 SPI 启动固件](../boot_start) + - 尝试重新安装系统到 M.2 NVMe SSD + +- 系统可以启动但无法登录： + - 默认用户名：radxa，密码：radxa + - 如密码错误，重新下载系统镜像和安装系统到 M.2 NVMe SSD + ::: diff --git a/docs/rock4/rock4d/getting-started/install-system/ufs-system/README.md b/docs/rock4/rock4d/getting-started/install-system/ufs-system/README.md new file mode 100644 index 000000000..d859b13ee --- /dev/null +++ b/docs/rock4/rock4d/getting-started/install-system/ufs-system/README.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 2 +--- + +# 安装系统到 UFS 模块 + +UFS 模块相比于 MicroSD 卡读写速度快，对于想提高系统读写和启动速度的用户来说，是个不错的选择。 + +我们介绍两种方式安装系统到 UFS 模块： + +- 对于有瑞莎 eMMC / UFS 二合一模块读卡器的用户，直接在 PC 上通过瑞莎 eMMC / UFS 二合一模块读卡器写入系统镜像。 + +- 对于没有瑞莎 eMMC / UFS 二合一模块读卡器的用户，需要额外使用 MicroSD 卡启动系统，使用 `dd` 命令将系统镜像安装到 UFS 模块。 + +更多关于瑞莎 eMMC / UFS 二合一模块读卡器的信息可以参考[瑞莎 eMMC/UFS 二合一模块读卡器页面](https://radxa.com/products/accessories/emmc-ufs-module-reader)。 + +### [使用瑞莎 eMMC/UFS 二合一模块读卡器](/rock4/rock4d/getting-started/install-system/ufs-system/ufs_reader) + +主要介绍用户在有瑞莎 eMMC / UFS 二合一模块读卡器的情况下，如何安装系统和启动系统。 + +### [不使用瑞莎 eMMC/UFS 二合一模块读卡器](/rock4/rock4d/getting-started/install-system/ufs-system/no_ufs_reader) + +主要介绍用户在不使用瑞莎 eMMC / UFS 二合一模块读卡器的情况下，如何安装系统和启动系统。 diff --git a/docs/rock4/rock4d/getting-started/install-system/ufs-system/no_ufs_reader.md b/docs/rock4/rock4d/getting-started/install-system/ufs-system/no_ufs_reader.md new file mode 100644 index 000000000..403ca075d --- /dev/null +++ b/docs/rock4/rock4d/getting-started/install-system/ufs-system/no_ufs_reader.md @@ -0,0 +1,201 @@ +--- +sidebar_position: 2 +--- + +# 不使用瑞莎 eMMC / UFS 二合一模块读卡器 + +本节教程适用于没有瑞莎 eMMC / UFS 二合一模块读卡器的用户，主要介绍如何在 MicroSD 卡启动系统的基础上将系统安装到 UFS 模块中。 + +## 硬件准备 + +在没有瑞莎 eMMC / UFS 二合一模块读卡器的情况下安装系统到 UFS 模块，需要 Radxa ROCK 4D 通过 MicroSD 卡能正常启动系统。 + +我们会在 MicroSD 卡上的系统进行操作，使用 `dd` 命令将系统安装到 UFS 模块中。 + +注意： 若 MicroSD 卡启动异常，可以参考 [安装系统到 MicroSD 卡](../boot_sd)教程，先安装系统到 MicroSD 卡上。 + +**您需要准备以下硬件：** + +- 开发板： Radxa ROCK 4D +- [UFS 模块](https://radxa.com/products/accessories/ufs-module) +- 正常启动系统的 MicroSD 卡 +- 电源适配器：Type-C 电源适配器( 支持 PD 协议，5V 电源输入，建议电流 3A 以上) + +:::tip +Radxa ROCK 4D 主板仅支持 5V 电源输入，建议电流 3A 以上，确保所有外设稳定运行。 + +参考电源： + +- [瑞莎 PD 30W电源适配器(推荐使用)](https://radxa.com/products/accessories/power-pd-30w) + +- 标准 Type-C 电源适配器( 5V 电源输入，支持 PD 协议，建议电流 3A 以上) + ::: + +## 安装系统 + +安装系统会格式化 UFS 模块，如果有重要数据请提前备份。 + +### 下载系统镜像 + +下载 Radxa ROCK 4D 的系统镜像文件到 Radxa ROCK 4D 上：可以直接使用 `wget` 命令下载文件到当前目录，其中网址链接可以进入 [资源汇总下载](../../../download) 复制。 + +:::tip +您也可以通过其他方式将系统镜像文件复制到 Radxa ROCK 4D 上，比如通过 FTP、SCP 等方式 +::: + + +``` +# 安装 wget +sudo apt-get install wget +# 下载系统镜像文件 +wget [URL] +``` + +- wget : 下载文件，将 [URL] 替换成实际下载链接。 + +### 硬件连接 + +将 UFS 模块安装到主板的 eMMC/UFS 模块接口中，然后使用 5V Type-C 电源适配器启动系统。 + +
+ +
+ +:::caution + +UFS 模块安装步骤： + +1. 确保 UFS 模块的缺角和 Radxa ROCK 4D 的 eMMC / UFS 模块接口方向一致 +2. 确保 UFS 模块底部卡槽接口和 Radxa ROCK 4D 的 eMMC / UFS 模块接口对齐 +3. 轻微用力按压 UFS 模块一端的接口，听到滴的声音说明安装成功，同样的方法按压另一端的接口，确保 UFS 模块安装成功。 + ::: + +### 安装系统镜像 + +#### 写入系统镜像到 UFS 模块 + +使用命令将压缩的系统镜像解压并直接写入到 UFS 模块，请根据实际下载的系统镜像文件名进行修改。 + + +``` + +sudo xzcat ~/radxa-rk3576_bookworm_kde_b1.output_4096.img.xz | sudo dd of=/dev/sda bs=1M status=progress + +``` + + +- xzcat : 解压 xz 格式的系统镜像文件 +- dd : 复制并写入到 UFS 模块（⚠️注意：使用dd命令时请确认设备名称，错误的设备名可能导致数据丢失） +- of=/dev/sda : 指定写入的设备为 sda（可以根据实际情况修改） +- bs=1M : 指定写入的块大小为 1M，提高写入速度 +- status=progress : 显示写入进度，让您了解写入状态 + +#### 验证写入结果 + +写入完成后，您可以验证 UFS 模块中的分区表是否正确创建： + + +``` + +sudo fdisk -l /dev/sda + +``` + + +正确写入后，应该会看到类似以下的分区信息： + +``` + +Disk /dev/sda: 119.15 GiB, 127934660608 bytes, 31234048 sectors +Disk model: KLUDG4UHDC-B0E1 +Units: sectors of 1 \* 4096 = 4096 bytes +Sector size (logical/physical): 4096 bytes / 4096 bytes +I/O size (minimum/optimal): 524288 bytes / 524288 bytes +Disklabel type: gpt +Disk identifier: 33349998-C3CC-40F0-B818-DDDD8383A64D + +Device Start End Sectors Size Type +/dev/sda1 32768 65535 32768 128M Linux filesystem +/dev/sda2 65536 679935 614400 2.3G EFI System +/dev/sda3 679936 31234014 30554079 116.6G EFI System + +``` + + +## 系统信息 + +您使用我们提供的系统镜像，首次需要使用我们设置的用户名和密码登录系统。 + +- Debian Linux + +用户账号：radxa + +用户密码：radxa + +## 启动系统 + +完成系统镜像的安装后： + +1. 关闭系统：`sudo shutdown -h now` +2. 断开 Radxa ROCK 4D 的电源 +3. 移除 MicroSD 卡 +4. 重新连接电源 +5. 等待系统从 UFS 模块启动 + +
+ +
+ +:::caution + +UFS 模块安装步骤： + +1. 确保 UFS 模块的缺角和 Radxa ROCK 4D 的 eMMC / UFS 模块接口方向一致 +2. 确保 UFS 模块底部卡槽接口和 Radxa ROCK 4D 的 eMMC / UFS 模块接口对齐 +3. 轻微用力按压 UFS 模块一端的接口，听到滴的声音说明安装成功，同样的方法按压另一端的接口，确保 UFS 模块安装成功。 +::: + +启动系统后，蓝色和绿色 LED 灯会同时亮起，大概过几秒左右，绿灯常亮、蓝色指示灯会闪烁，一般表示系统启动成功。 + +## 验证系统 + +系统启动后，您可以使用 `lsblk` 命令查看系统分区信息： + + +``` + +sudo lsblk + +``` + + +如果您看到 `/dev/sda3` 被挂载为根目录 `/`，则表示系统已成功从 UFS 模块启动。 + + +``` + +NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS +sda 8:0 0 119.1G 0 disk +├─sda1 8:1 0 128M 0 part /config +├─sda2 8:2 0 2.3G 0 part /boot/efi +└─sda3 8:3 0 116.6G 0 part / +mtdblock0 31:0 0 16M 0 disk +zram0 253:0 0 1.9G 0 disk [SWAP] + +``` + + +:::tip + +如果在启动过程中遇到问题，请尝试以下解决方案： + +- 系统无法启动： + - 尝试重新安装 UFS 模块，启动系统 + - 尝试 [下载并烧录最新 SPI 启动固件](../boot_start) + - 尝试重新安装系统到 UFS 模块 + +- 系统可以启动但无法登录： + - 默认用户名：radxa，密码：radxa + - 如密码错误，重新下载系统镜像和安装系统到 UFS 模块 +::: +``` diff --git a/docs/rock4/rock4d/getting-started/install-system/ufs-system/ufs_reader.md b/docs/rock4/rock4d/getting-started/install-system/ufs-system/ufs_reader.md new file mode 100644 index 000000000..c49cfc26d --- /dev/null +++ b/docs/rock4/rock4d/getting-started/install-system/ufs-system/ufs_reader.md @@ -0,0 +1,226 @@ +--- +sidebar_position: 1 +--- + +# 使用瑞莎 eMMC / UFS 二合一模块读卡器 + +本节教程适用于有瑞莎 eMMC / UFS 二合一模块读卡器的用户，主要介绍如何通过瑞莎 eMMC / UFS 二合一模块读卡器给 UFS 模块安装系统。 + +## 硬件准备 + +使用瑞莎 eMMC / UFS 二合一模块读卡器安装系统，不需要依赖MicroSD 卡，直接将 UFS 模块插入 eMMC / UFS 模块读卡器中，使用 Etcher 软件安装系统到 UFS 模块中。 + +**您需要准备以下硬件：** + +- 开发板： Radxa ROCK 4D +- [UFS 模块](https://radxa.com/products/accessories/ufs-module) +- [瑞莎 eMMC / UFS 二合一模块读卡器](https://radxa.com/products/accessories/emmc-ufs-module-reader) +- 电源适配器：Type-C 电源适配器( 支持 PD 协议，5V 电源输入，建议电流 3A 以上) + +:::tip +Radxa ROCK 4D 主板仅支持 5V 电源输入，建议电流 3A 以上，确保所有外设稳定运行。 + +参考电源： + +- [瑞莎 PD 30W电源适配器(推荐使用)](https://radxa.com/products/accessories/power-pd-30w) + +- 标准 Type-C 电源适配器( 5V 电源输入，支持 PD 协议，建议电流 3A 以上) + ::: + +## 安装系统 + +安装系统会格式化 UFS 模块，如果有重要数据请提前备份。 + +### 下载系统镜像 + +在 PC 上访问 [资源下载汇总](../../../download) 页面，在下载页面找到 UFS 模块对应的系统镜像。 + +下载完成后，解压系统镜像文件，得到的 `*.img` 文件就是待烧写到 UFS 模块中的系统镜像文件。 + +:::tip +下载的系统镜像是一个压缩文件，需要解压后才能通过镜像烧录软件安装到 UFS 模块, 未解压就直接烧录到 UFS 模块，可能会出现安装系统失败或者启动系统失败的情况。 +::: + +### 硬件连接 + +将 UFS 模块插入瑞莎 eMMC / UFS 二合一模块读卡器中，然后将读卡器插入 PC 的 USB 端口上。 + +
+ +
+ +:::caution + +UFS 模块安装步骤： + +1. 确保 UFS 模块的缺角和读卡器的接口方向一致 +2. 确保 UFS 模块底部卡槽接口和瑞莎 eMMC / UFS 二合一模块读卡器的接口对齐 +3. 轻微用力按压 UFS 模块一端的接口，听到滴的声音说明安装成功，同样的方法按压另一端的接口，确保 UFS 模块安装成功。 + ::: + +### 安装系统镜像 + +使用开源镜像烧录工具 Etcher 烧写系统镜像文件到 UFS 模块。 + +#### 下载 Etcher + +进入 Balena Etcher 官网下载系统对应平台的软件：[balenaEtcher](https://etcher.balena.io) + +
+ +
+ +根据自己的系统平台和架构下载对应的软件安装包。 + +
+ +
+ +#### 使用 Etcher + +下载完成后，双击打开 Etcher 应用。 + +:::tip + +- Windows + +下载的文件是 `*.exe` 格式的安装包，双击程序就可以运行。 + +- Linux + +推荐下载 `*.zip` 格式的压缩包，解压后双击程序就可以运行。 + +- MacOS + +根据自己的系统架构下载对应的 `*.dmg` 文件,双击打开后，将软件拖拽到 Applications 文件夹进行安装，安装完成后双击应用图标运行。 + +::: + +
+ +
+ +#### 安装系统镜像 + +1. 选择镜像文件 + +点击 `Flash from file` 选项，选择自己提前下载并解压好的系统镜像文件。 + +
+ +
+ +2. 选择存储设备 + +点击 `Select target` 选项，选择自己待安装系统镜像对应存储设备。 + +:::danger +请勿选错存储设备，否则 Etcher 将格式化被选中的存储设备，造成重要数据丢失！ + +您可以插拔存储设备，观察可选存储设备的变化，从而进一步判断待安装的存储设备。 +::: + +
+ +
+ +① ： 选择需要安装系统镜像的存储设备 + +② ： 点击 `Select 1` 选项确认设备选择 + +
+ +
+ +3. 安装系统镜像 + +点击 `Flash` 选项，等待软件自动进行系统镜像的安装和校验。 + +
+ +
+ +
+等待系统安装完成 + +
+ +
+等待系统校验完成 + + 成功安装系统镜像后，关闭 Etcher 软件！ +
+ +## 系统信息 + +您使用我们提供的系统镜像，首次需要使用我们设置的用户名和密码登录系统。 + +- Debian Linux + +用户账号：radxa + +用户密码：radxa + +## 启动系统 + +完成系统镜像的安装后： + +1. 将 UFS 模块从瑞莎 eMMC / UFS 二合一模块读卡器上取下来 +2. 取下 Radxa ROCK 4D 上的 MicroSD 卡 +3. 将 UFS 模块安装到 Radxa ROCK 4D的 eMMC / UFS 模块接口上 +4. 连接 Radxa ROCK 4D 的电源 +5. 等待系统从 UFS 模块启动 + +
+ +
+ +:::caution + +UFS 模块安装步骤： + +1. 确保 UFS 模块的缺角和 Radxa ROCK 4D 的 eMMC / UFS 模块接口方向一致 +2. 确保 UFS 模块底部卡槽接口和 Radxa ROCK 4D 的 eMMC / UFS 模块接口对齐 +3. 轻微用力按压 UFS 模块一端的接口，听到滴的声音说明安装成功，同样的方法按压另一端的接口，确保 UFS 模块安装成功。 + ::: + +启动系统后，蓝色和绿色 LED 灯会同时亮起，大概过几秒左右，绿灯常亮、蓝色指示灯会闪烁，一般表示系统启动成功。 + +## 验证系统 + +系统启动后，您可以使用 `lsblk` 命令查看系统分区信息： + + +``` +sudo lsblk +``` + + +如果您看到 `/dev/sda3` 被挂载为根目录 `/`，则表示系统已成功从 UFS 模块启动。 + + +``` +NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS +sda 8:0 0 119.1G 0 disk +├─sda1 8:1 0 128M 0 part /config +├─sda2 8:2 0 2.3G 0 part /boot/efi +└─sda3 8:3 0 116.6G 0 part / +mtdblock0 31:0 0 16M 0 disk +zram0 253:0 0 1.9G 0 disk [SWAP] +``` + + +:::tip + +如果在启动过程中遇到问题，请尝试以下解决方案： + +- 系统无法启动： + + - 尝试重新安装 UFS 模块，启动系统 + - 尝试 [下载并烧录最新 SPI 启动固件](../boot_start) + - 尝试重新安装系统到 UFS 模块 + +- 系统可以启动但无法登录： + - 默认用户名：radxa，密码：radxa + - 如密码错误，重新下载系统镜像和安装系统到 UFS 模块 + ::: diff --git a/docs/rock4/rock4d/getting-started/quickly_start.md b/docs/rock4/rock4d/getting-started/quickly_start.md new file mode 100644 index 000000000..372a54370 --- /dev/null +++ b/docs/rock4/rock4d/getting-started/quickly_start.md @@ -0,0 +1,378 @@ +--- +sidebar_position: 2 +--- + +# 快速上手 + +本章节的目的是为了让大家快速使用 Radxa ROCK 4D，大家可以按照该教程进行操作。 + +## 产品实物 + +
+ Radxa ROCK 4D 正面 + + Radxa ROCK 4D 背面 + +
+ +## 使用前提 + +### 硬件设备 + +您需要提前准备以下硬件设备，以便完成快速上手教程的所有操作。 + +- 开发板： Radxa ROCK 4D +- 系统启动介质：MicroSD 卡 +- USB串口数据线（可选）：用于串口调试和登录 +- 显示器（可选）：HDMI 显示器和 HDMI 数据线 +- 电源适配器：Type-C 电源适配器( 支持 PD 协议，5V 电源输入，建议电流 3A 以上) + +**说明**：用户需要在 USB串口数据线和显示器二选一，我们优先推荐使用显示器搭配Rock 4D进行使用和开发。 + +:::tip +对于不同开发能力的用户，我们建议额外增加以下配件使用 Radxa ROCK 4D，这样会缩短熟悉产品和开发的时间。 + +- **初学者** + +准备配件：电源适配器、系统启动介质、显示器、HDMI数据线 + +- **开发者** + +准备配件：电源适配器、系统启动介质、调试数据线( USB串口数据线) + +**说明**：其中显示器可以显示系统界面和进行图形化操作！ +::: + +### 主板供电 + +Radxa ROCK 4D 主板支持 Type-C 和 GPIO 供电，我们推荐使用 Type-C 电源适配器供电，请确保电源适配器能够提供 5V 电源输入，并且能够兼容 PD 协议。 + +:::tip +Radxa ROCK 4D 主板仅支持 5V 电源输入，建议电流 3A 以上，确保所有外设稳定运行。 + +参考电源： + +- [瑞莎 PD 30W电源适配器(推荐使用)](https://radxa.com/products/accessories/power-pd-30w) + +- 标准 Type-C 电源适配器( 5V 电源输入，支持 PD 协议，建议电流 3A 以上) + ::: + +### 系统启动介质 + +Radxa ROCK 4D 支持 MicroSD 卡、NVME、UFS启动，但是快速上手教程只介绍 MicroSD卡启动。 + +### 串口调试 + +Radxa ROCK 4D 主板支持通过 USB 串口数据线进行串口调试，您需要将 USB 串口数据线连接到 Radxa ROCK 4D 的 UART0_TX、UART0_RX 和 GND 引脚。 + +## 写入系统镜像 + +您需要在 PC 上下载待写入的系统镜像文件，并将其烧写到 MicroSD 卡中。 + +### 下载系统镜像 + +在 PC 上访问[资源下载汇总](../download)页面，下载 Radxa ROCK 4D 对应的系统镜像压缩包，下载完成后解压系统镜像压缩包，得到的 `*.img` 文件就是待烧写到 MicroSD 卡中的系统镜像文件。 + +:::tip +下载的系统镜像是一个压缩文件，需要解压后才能通过镜像烧录软件写入到SD卡, 未解压就直接烧录到SD卡，可能会出现写入系统失败或者启动系统失败的情况。 +::: + +### 写入系统镜像 + +将 MicroSD 卡插入读卡器中，然后将读卡器插入 PC 的 USB 端口上。 + +
+ +
+ +- **镜像烧录软件：Balena Etcher** + +我们推荐使用瑞莎合作伙伴 Balena 开发的开源镜像烧录工具 Etcher，该软件使用简单，功能强大，支持 Windows/Linux/MacOS 系统使用。 + +进入官网下载系统对应平台的软件：[balenaEtcher](https://etcher.balena.io) + +
+ +
+ +进入下载页面后，选择对应的系统平台进行 Etcher 软件下载。 + +
+ +
+ +:::tip +Windows 和 Linux 只需要打开对应程序就可以使用，无需安装！ +::: + +
+ +
+ +- 安装系统镜像 + +1. 选择主板对应的系统镜像：点击 `Flash from file` 选项，选择自己提前下载并解压好的系统镜像文件。 + +
+ +
+ +2. 选择 MicroSD 卡对应的磁盘：点击 `Select target` 选项，选择自己接入 PC 的读卡器对应磁盘设备。 + +:::danger +请勿选错磁盘，否则 Etcher 将格式化被选中的磁盘，造成重要数据丢失！ +::: + +
+ +
+ +① ： 选择需要安装系统镜像的磁盘设备 + +② ： 点击 `Select 1` 选项确认设备选择 + +
+ +
+ +3.开始写入系统镜像：点击 `Flash` 选项，等待软件自动进行系统镜像的写入和校验。 + +
+ +
+ +
+等待系统写入完成 + +
+ +
+等待系统校验完成 + +
+ +4.成功写入系统镜像后，关闭 Etcher 软件！ + +## 系统信息 + +您使用我们提供的系统镜像，首次需要使用我们设置的用户名和密码登录系统。 + +- Debian Linux + +用户账号：radxa + +用户密码：radxa + +## 启动系统 + +在 MicroSD 卡上完成系统镜像的写入后，我们可以将读卡器上的 MicroSD 卡装入 Radxa ROCK 4D 的 MicroSD 卡槽中，然后使用 5V Type-C 电源适配器启动系统。 + +启动系统后，蓝色和绿色 LED 灯会同时亮起，大概过几秒左右，绿灯常亮、蓝色指示灯会闪烁，一般表示系统启动成功。 + +使用系统建议： + +1. 若您有显示器，启动 Radxa ROCK 4D 后可以使用 HDMI 数据线连接显示器和主板，直接通过显示器查看系统界面。 + +2. 若您没有显示器，可以使用串口调试工具查看系统输出信息，确认系统是否启动成功以及登录系统使用 Radxa ROCK 4D。 + +## 串口登录系统 + +:::tip + +- Radxa ROCK 4D 串口参数 + +波特率：1500000 + +数据位：8 + +停止位：1 + +无校验位 + +::: + +- 硬件连接 + +:::danger +使用 USB 串口数据线和 Radxa ROCK 4D 进行串口调试时，请确保引脚连接正确，否则会导致主板硬件损坏。 +::: + +使用 USB 串口数据线的 USB 接口连接 PC ，另一端连接 Radxa ROCK 4D 的 GPIO串口 引脚。 + +| 序号 | 引脚功能 | 连接方式 | +| ---- | --------------------------------- | ----------------------------------- | +| ① | Radxa ROCK 4D : GND（Pin6） | 连接 USB 串口数据线的 GND 引脚 | +| ② | Radxa ROCK 4D : UART0_TX（Pin8） | 连接 USB 串口数据线的 RX 引脚 | +| ③ | Radxa ROCK 4D : UART0_RX（Pin10） | 连接 USB 串口数据线的 TX 引脚 | +| ④ | USB 串口数据线 : GND（黑色线） | 连接 Radxa ROCK 4D 的 GND 引脚 | +| ⑤ | USB 串口数据线 : RX（白色线） | 连接 Radxa ROCK 4D 的 UART0_TX 引脚 | +| ⑥ | USB 串口数据线 : TX（绿色线） | 连接 Radxa ROCK 4D 的 UART0_RX 引脚 | +| ⑦ | USB 串口数据线 : VCC（红色线） | 不连接 | + +
+ 引脚说明和连接示意图 + +
+ + + + + +Windows 平台推荐使用 PuTTY 软件串口登陆 Radxa ROCK 4D 系统。 + +- PuTTY使用 + +Radxa ROCK 4D 和 PC 通过 USB 串口数据线连接后，可以进入系统的设备管理器查看 Radxa ROCK 4D 对应的串口号(示意图中 COM4 就是当前系统中对应的 Radxa ROCK 4D 设备)。 + +
+ +
+ +:::tip + +若系统无法正确识别设备或者设备前面带有感叹号，需要自行安装[CH340驱动](https://www.wch.cn/downloads/CH341SER_EXE.html)，完成安装后重启系统。 + +::: + +- 串口登陆选项 + +① --> Connection type：选择 `Serial` + +② --> Serial line：填写 `COM4` (根据设备管理器显示的串口号信息) + +③ --> Speed：填写 `1500000` + +④ --> Open：串口连接 Radxa ROCK 4D 系统 + +
+ +
+ +- 登陆系统 + +终端内按回车会出现登陆信息，然后使用对应系统的用户账号和密码进行登陆。 + +终端输入密码不会显示出来，输入完密码按回车登陆。 + +
+ +
+ + + + + +Linux 推荐使用 Screen 软件串口登陆 Radxa ROCK 4D 系统。 + +- 安装Screen + + +``` +sudo apt update +sudo apt install screen +``` + + +- 查找串口设备 + +打开终端使用 ls 命令查看串口设备: + +若 PC 只有一个串口设备，系统默认是 ttyUSB0； + +若 PC 有多个串口设备，可以插拔 USB 设备，使用下面命令观察变化的设备号。 + + +``` +ls /dev/ttyUSB* +``` + + +- 串口登陆选项 + +使用 Screen 连接串口，只需要设置串口号和波特率。 + + +``` +sudo screen /dev/ttyUSB0 1500000 +``` + + +- 登陆系统 + +终端内按回车会出现登陆信息，然后使用对应系统的用户账号和密码进行登陆。 + +终端输入密码不会显示出来，输入完密码按回车登陆。 + + + + + +MacOS 平台推荐使用 Screen 软件串口登陆 Radxa ROCK 4D 系统。 + +:::tip + +若系统无法正确识别设备，需要自行安装[CH340驱动](https://www.wch.cn/downloads/CH341SER_MAC_ZIP.html)，完成安装后重启系统。 + +::: + +- 查找串口设备 + +打开终端使用 ls 命令查看串口设备: + +找到类似 /dev/tty.wchusbserial14xx0 的设备名称，若 PC 有多个串口设备，可以插拔 USB 设备，使用下面命令观察变化的设备号。 + + +``` +ls /dev/tty.* +``` + + +- 串口登陆选项 + +使用 Screen 连接串口，只需要设置串口号和波特率。 + + +``` +screen /dev/tty.wchusbserial14xx0 1500000 +``` + + +- 登陆系统 + +终端内按回车会出现登陆信息，然后使用对应系统的用户账号和密码进行登陆。 + +终端输入密码不会显示出来，输入完密码按回车登陆。 + + + + + +## 系统使用 + +### 有屏模式 + +若您是 Radxa ROCK 4D 搭配显示器使用，使用系统就变的比较简单，你可以根据显示器上的系统界面进行操作。 + +### 无屏模式 + +若您是 Radxa ROCK 4D 搭配 USB 串口数据线使用，您可以通过串口调试工具进行系统操作。 + +:::tip +对于无屏模式的用户，我们提供以下建议助力您快速熟悉系统使用。 + +1. 配置网络 + +您可以直接给 Radxa ROCK 4D 插入网线，确保系统能够连接网络。 + +2. 串口调试 + +您可以通过 [串口调试](../system-config/uart_debug) 查看系统的输出信息，比如 IP 地址、系统启动信息等。 + +3. 配置 SSH 远程 + +配置 [SSH 远程](../system-config/ssh-remote) 登录可以去掉 USB 串口数据线，直接使用 SSH 远程登录系统。 + +4. 配置 VNC 远程 + +若系统本身带有图形化界面，配置 [VNC 远程](../system-config/vnc-remote) 登录可以让您直接看到系统画面，无需使用显示器。 +::: diff --git a/docs/rock4/rock4d/hardware-info/README.md b/docs/rock4/rock4d/hardware-info/README.md new file mode 100644 index 000000000..1d06c9749 --- /dev/null +++ b/docs/rock4/rock4d/hardware-info/README.md @@ -0,0 +1,11 @@ +--- +sidebar_position: 13 +--- + +# 硬件信息 + +主要对 Radxa ROCK 4D 的硬件信息进行介绍。 + +### [接口信息](/rock4/rock4d/hardware-info/interface_info) + +主要介绍 Radxa ROCK 4D 硬件信息，包括主板的芯片框图、系统框图以及接口使用等。 diff --git a/docs/rock4/rock4d/hardware-info/interface_info.md b/docs/rock4/rock4d/hardware-info/interface_info.md new file mode 100644 index 000000000..f0b2b8ada --- /dev/null +++ b/docs/rock4/rock4d/hardware-info/interface_info.md @@ -0,0 +1,180 @@ +--- +sidebar_position: 3 +--- + +# 接口信息 + +## 芯片框图 + +
+ +
+ +## 系统框图 + +
+ +
+ +## 接口说明 + +
+ +
+ +| 序号 | 说明 | 数量 | +| :--: | :---------------------- | :--: | +| ① | USB Type-C 供电接口 | 1 | +| ② | 用户指示灯 | 1 | +| ③ | 电源指示灯 | 1 | +| ④ | 电源按键 | 1 | +| ⑤ | FPC 接口 | 1 | +| ⑥ | WiFi6 和 蓝牙 5.4 | 1 | +| ⑦ | 外接天线接口 | 1 | +| ⑧ | 40 Pin GPIO | 1 | +| ⑨ | LPDDR5 内存 | 1 | +| ⑩ | PoE 接口 | 1 | +| ⑪ | Maskrom 按键 | 1 | +| ⑫ | USB 2.0 Type-A | 2 | +| ⑬ | Rockchip RK3576（J） | 1 | +| ⑭ | USB 3.0 Type-A | 2 | +| ⑮ | SPI NOR Flash | 1 | +| ⑯ | 千兆以太网口（支持PoE） | 1 | +| ⑰ | 风扇接口 | 1 | +| ⑱ | 耳机插孔 | 1 | +| ⑲ | MIPI CSI 接口 | 1 | +| ⑳ | HDMI 2.1 接口 | 1 | +| ㉑ | Recovery 接口 | 1 | +| ㉒ | UFS 模块接口 | 1 | +| ㉓ | RTC 接口 | 1 | +| ㉔ | eMMC 模块接口 | 1 | +| ㉕ | MIPI CSI 接口 | 1 | +| ㉖ | MicroSD 卡槽 | 1 | +| ㉗ | MIPI DSI 接口 | 1 | + +## 接口使用 + +主要对 Radxa ROCK 4D 可以外拓的接口进行使用说明介绍。 + +### 40 Pin GPIO + +支持给板载的 GPIO 引脚外接外部设备，支持 UART、SPI、I2C、I2S、PWM、CAN、ADC 等。 + +| Function7 | Function6 | Function5 | Function4 | Function3 | Function2 | Function1 | Pin | Pin | Function1 | Function2 | Function3 | Function4 | Function5 | Function6 | Function7 | +| ------------- | ------------ | ----------- | ------------ | ----------- | ------------- | ---------- | --- | --- | ---------- | ----------------- | -------------- | ------------ | ----------- | ------------ | ------------- | +| | | | | | | 3V3 | 1 | 2 | 5V | | | | | | | +| | PDM0_SDI1_M2 | | | I2C8_SDA_M1 | UART2_RX_M0 | GPIO1_C7_d | 3 | 4 | 5V | | | | | | | +| | PDM0_SDI0_M2 | | | I2C8_SCL_M1 | UART2_TX_M0 | GPIO1_C6_d | 5 | 6 | GND | | | | | | | +| | | | SPI2_CSN0_M1 | I2C6_SDA_M1 | UART4_CTSN_M1 | GPIO1_C3_u | 7 | 8 | GPIO0_D4_u | UART0_TX_M0_DEBUG | | | | | | +| | | | | | | GND | 9 | 10 | GPIO0_D5_u | UART0_RX_M0_DEBUG | | | | | | +| UART2_RTSN_M0 | | | SPI2_MOSI_M1 | | UART4_TX_M1 | GPIO1_C4_d | 11 | 12 | GPIO1_D1_d | UART10_RX_M1 | I3C0_SDA_PU_M1 | | | SAI2_SCLK_M0 | | +| | | PWM1_CH0_M2 | | | | GPIO2_C0_d | 13 | 14 | GND | | | | | | | +| UART2_CTSN_M0 | | | SPI2_MISO_M1 | | UART4_RX_M1 | GPIO1_C5_d | 15 | 16 | GPIO2_B6_d | UART7_TX_M0 | I2C8_SCL_M2 | | | | | +| | | | | | | 3V3 | 17 | 18 | GPIO2_B7_d | UART7_RX_M0 | I2C8_SDA_M2 | | | | | +| | SAI3_LRCK_M1 | PWM1_CH1_M1 | SPI1_MOSI_M0 | I2C9_SCL_M1 | | GPIO1_B5_d | 19 | 20 | GND | | | | | | | +| | SAI3_SDO_M1 | | SPI1_MISO_M0 | | UART3_CTSN_M2 | GPIO1_B6_d | 21 | 22 | GPIO2_D7_d | | | | PWM2_CH7_M2 | | | +| | SAI3_SCLK_M1 | PWM1_CH0_M1 | SPI1_CLK_M0 | I2C9_SDA_M1 | | GPIO1_B4_d | 23 | 24 | GPIO1_B7_d | | | SPI1_CSN0_M0 | | SAI3_SDI_M1 | UART3_RTSN_M2 | +| | | | | | | GND | 25 | 26 | GPIO1_C0_d | UART3_TX_M2 | | SPI1_CSN1_M0 | PWM0_CH0_M1 | PDM0_SDI2_M2 | | +| CAN1_RX_M1 | SAI4_SCLK_M2 | PWM2_CH3_M1 | | I2C6_SDA_M3 | | GPIO4_C7_d | 27 | 28 | GPIO4_C6_d | | I2C6_SCL_M3 | | PWM2_CH2_M1 | SAI4_SDI_M2 | CAN1_TX_M1 | +| CAN1_TX_M3 | | | | | | GPIO3_A2_d | 29 | 30 | GND | | | | | | | +| PDM0_CLK0_M2 | SAI3_MCLK_M1 | | | | UART3_RX_M2 | GPIO1_C1_d | 31 | 32 | GPIO1_D5_d | UART10_CTSN_M1 | I2C5_SDA_M1 | SPI2_CLK_M1 | | PDM0_CLK1_M2 | | +| | | PWM1_CH2_M1 | SPI2_CSN1_M1 | I2C6_SCL_M1 | UART4_RTSN_M1 | GPIO1_C2_u | 33 | 34 | GND | | | | | | | +| | SAI2_LRCK_M0 | PWM1_CH3_M1 | | I3C0_SCL_M1 | | GPIO1_D2_d | 35 | 36 | GPIO1_D4_d | UART10_RTSN_M1 | I2C5_SCL_M1 | | | SAI2_MCLK_M0 | PDM0_SDI3_M2 | +| CAN1_RX_M3 | | | | | | GPIO3_A3_d | 37 | 38 | GPIO1_D3_d | | I3C0_SDA_M1 | | PWM1_CH4_M1 | SAI2_SDI_M0 | | +| | | | | | | GND | 39 | 40 | GPIO1_D0_d | UART10_TX_M1 | | | | SAI2_SDO_M0 | | + +### USB Type-C 供电接口 + +Radxa ROCK 4D 主板支持 Type-C 和 GPIO 供电，我们推荐使用 Type-C 电源适配器供电，请确保电源适配器能够提供 5V 电源输入，并且能够兼容 PD 协议。 + +:::tip +Radxa ROCK 4D 主板仅支持 5V 电源输入，建议电流 3A 以上，确保所有外设稳定运行。 + +参考电源： + +- [瑞莎 PD 30W电源适配器(推荐使用)](https://radxa.com/products/accessories/power-pd-30w) + +- 标准 Type-C 电源适配器( 5V 电源输入，支持 PD 协议，建议电流 3A 以上) + ::: + +### 电源按键 + +短按触发开机或者电源菜单选项，长按关机。 + +### FPC 接口 + +支持 FPC PCIe 拓展接口，可用于连接扩展配件。 + +### 外接天线接口 + +支持给板载的 WiFi6 和 蓝牙 5.4 芯片外接天线。 + +### PoE 接口 + +支持给板载的 PoE 接口外接 PoE 电源。 + +### Maskrom 按键 + +上电前按下 Maskrom 按键，上电后松开，进入 Maskrom 模式。 + +### USB 2.0 Type-A + +提供两个 USB 2.0 接口，用于连接外部设备，如键盘、鼠标、存储设备等。 + +### USB 3.0 Type-A + +提供高速 USB 3.0 接口，用于连接外部设备，如存储设备、网络适配器等。 + +:::tip + +1. 可以通过反复插拔 USB 设备，在系统命令行输入 `lsusb` 命令查看设备是否被识别 +2. USB 3.0 的上层 Type-A 接口支持 OTG 功能 + ::: + +### 千兆网口接口 + +千兆以太网口（支持 PoE，需外接 HAT）。 + +### 风扇接口 + +1× 2-pin 1.25mm PWM 控制风扇接口。 + +### 耳机插孔 + +3.5mm 四段耳机插孔，支持麦克风输入。 + +### MIPI CSI 接口 + +支持 MIPI CSI 接口，可用于连接高清摄像头。 + +### HDMI 2.1 接口 + +HDMI 2.1 接口支持高清视频输出，最高支持 4K@120fps。 + +### Recovery 接口 + +短接 Recovery 接口，进入 Recovery 模式。 + +### UFS 模块接口 + +支持 UFS 2.0 接口，可用于连接扩展存储设备和启动系统。 + +### RTC 接口 + +支持 RTC 实时时钟模块接口，可以连接 RTC 模块以保持系统时间。 + +### eMMC 5.1 模块接口 + +支持 eMMC 5.1 接口，可用于连接扩展存储设备和启动系统。 + +### MIPI CSI 接口 + +支持 MIPI CSI 接口，可用于连接高清摄像头。 + +### MicroSD 卡槽 + +支持 MicroSD 卡槽，可用于连接扩展存储设备和启动系统。 + +### MIPI DSI 接口 + +支持 MIPI DSI 接口，可用于连接高清显示屏。 diff --git a/docs/rock4/rock4d/system-config/README.md b/docs/rock4/rock4d/system-config/README.md new file mode 100644 index 000000000..c83861f6d --- /dev/null +++ b/docs/rock4/rock4d/system-config/README.md @@ -0,0 +1,35 @@ +--- +sidebar_position: 12 +--- + +# 系统使用 + +对系统使用过程中常用的功能进行介绍。 + +### [有屏模式](/rock4/rock4d/system-config/display-mode) + +主要介绍 Radxa Rock 4D 如何连接显示屏和在有屏模式下的使用和开发。 + +### [无屏模式](/rock4/rock4d/system-config/no-display-mode) + +主要介绍 Radxa Rock 4D在无屏模式下的使用和开发。 + +### [串口调试](/rock4/rock4d/system-config/uart_debug) + +主要介绍 Radxa Rock 4D 串口调试的硬件连接和使用方法。 + +### [网络配置](/rock4/rock4d/system-config/web-config) + +主要介绍 Radxa Rock 4D 在有屏和无屏模式下配置有线网络和WiFi网络的方法。 + +### [SSH 远程](/rock4/rock4d/system-config/ssh-remote) + +主要介绍 Radxa Rock 4D 开启和使用 SSH 远程连接的方法。 + +### [VNC 远程](/rock4/rock4d/system-config/vnc-remote) + +主要介绍 Radxa Rock 4D 开启 VNC 和使用 VNC Viewer 进行远程连接的方法。 + +### [Rsetup 工具](/rock4/rock4d/system-config/rsetup) + +主要介绍 Radxa Rock 4D Rsetup 工具的使用方法。 diff --git a/docs/rock4/rock4d/system-config/display-mode.md b/docs/rock4/rock4d/system-config/display-mode.md new file mode 100644 index 000000000..cc9ec3ccf --- /dev/null +++ b/docs/rock4/rock4d/system-config/display-mode.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 1 +--- + +# 有屏模式 + +有屏模式是指 Radxa ROCK 4D 接显示屏，通过 HDMI 输出系统画面，适合新手用户使用。 + +## 准备工作 + +使用 HDMI 数据线连接显示屏，确认显示屏是否正常显示系统画面。 + +## 控制界面 + +用户使用显示器搭配 Radxa ROCK 4D 进行使用，可以很方便地进行系统设置、应用管理、文件管理等操作。 + +
+ +
diff --git a/docs/rock4/rock4d/system-config/no-display-mode.md b/docs/rock4/rock4d/system-config/no-display-mode.md new file mode 100644 index 000000000..d922ef067 --- /dev/null +++ b/docs/rock4/rock4d/system-config/no-display-mode.md @@ -0,0 +1,45 @@ +--- +sidebar_position: 2 +--- + +# 无屏模式 + +无屏模式是指 Radxa ROCK 4D 不接显示屏，通过串口/ SSH / VNC 控制开发板，适合有一定开发经验的用户使用。 + +具体控制思路 : 通过串口调试的方法获取 Radxa ROCK 4D 的 IP 地址，然后配置好对应的 SSH 和 VNC 环境，进一步通过 SSH 或 VNC 远程登录 Radxa ROCK 4D 进行控制。 + +:::tip + +- 串口调试 : 详细步骤参考 [串口调试](./uart_debug) 教程 +- SSH 远程登录 : 详细步骤参考 [远程登录](./ssh-remote) 教程 +- VNC 远程登录 : 详细步骤参考 [VNC远程登录](./vnc-remote) 教程 + ::: + +## 准备工作 + +可以按照 [串口调试](./uart_debug) 和 [远程登录](./remote-login) 教程连接Radxa ROCK 4D。 + +## 控制界面 + +无屏模式下的串口/ SSH控制是命令行模式，VNC控制是图形界面模式。 + +### 命令行模式 + +串口控制需要依赖数据线，而 SSH 控制不需要依赖数据线，只需要保证设备在同一局域网下。 + +① ： 打开 Linux 终端，通过串口方式登录 Radxa ROCK 4D + +② ： 打开 Linux 终端，通过 SSH 方式登录 Radxa ROCK 4D + +
+ +
+ +### 图形界面模式 + +VNC 控制需要保证控制和被控设备都处于同一局域网下。 + +
+VNC远程登录成功 + +
diff --git a/docs/rock4/rock4d/system-config/rsetup.md b/docs/rock4/rock4d/system-config/rsetup.md new file mode 100644 index 000000000..5dcf60e27 --- /dev/null +++ b/docs/rock4/rock4d/system-config/rsetup.md @@ -0,0 +1,106 @@ +--- +sidebar_position: 9 +--- + +# Rsetup 工具 + +Rsetup 是一个适用于 Radxa OS 的系统配置工具，它可以帮助用户轻松地进行系统配置，包括系统设置、硬件设置、软件设置、网络设置、用户设置、语言设置等。 + +## 使用 Rsetup + +在终端命令行运行 `rsetup` 命令启动 Rsetup 工具。 + +:::tip +rsetup 工具使用指南： + +- 选中选项 ： 对应选项会高亮显示 +- 确认选择 ： 按 `Enter` +- 取消选择 ： 按 `ESC` +- 切换选项 ： 按 `Up` 、 `Down` 、 `Left` 、 `Right` 控制 +- 多选界面 ： 按 `Space` 选择，按 `Enter` 确认选择 + +::: + + +``` +sudo rsetup +``` + + +## Rsetup 选项 + +启动 Rsetup 后，会出现类似下面的选项列表：可能会因为版本界面有微小差异，请以实际情况为准! + +
+ +
+ +### System + +System 选项用于系统升级、修改启动方式和配置 Bootloader 等。 + +
+ +
+ +:::tip +我们推荐使用 `System Update` 选项来升级系统，确保您的系统是最新版本。 + +使用 `sudo apt update && sudo apt upgrade` 命令来升级系统可能会导致更新不完全或者系统异常。 +::: + +### Hardware + +Hardware 选项用于管理板载硬件，包括视频捕获设备、LED 控制、GPIO 控制等。 + +
+ +
+ +### Overlays + +Overlays 选项用于管理设备树覆盖（Device Tree Overlays），可以启用或禁用特定的硬件功能。 + +
+ +
+ +### Connectivity + +Connectivity 选项用于管理网络连接，包括有线网络和无线网络的设置。 + +
+ +
+ +### User Settings + +User Settings 选项用于管理系统当前用户名、密码以及设置自动登录。 + +
+ +
+ +### Localization + +Localization 选项用于设置系统时区、区域以及 WiFi 国家。 + +
+ +
+ +### Common Tasks + +Common Tasks 选项用于执行一些常见的系统任务。 + +
+ +
+ +### 2.8 About + +About 选项用于查看 Rsetup 工具的信息。 + +
+ +
diff --git a/docs/rock4/rock4d/system-config/ssh-remote.md b/docs/rock4/rock4d/system-config/ssh-remote.md new file mode 100644 index 000000000..bc5c9457a --- /dev/null +++ b/docs/rock4/rock4d/system-config/ssh-remote.md @@ -0,0 +1,96 @@ +--- +sidebar_position: 4 +--- + +# SSH 远程 + +远程登录是指通过网络远程控制主板，教程只介绍局域网下进行 SSH 的远程控制的方法。 + +无显示器的用户可以通过 [串口调试](./uart_debug) 的方法运行下面命令配置 SSH 远程登录。 + +:::tip +确保远程双方设备处于同一局域网： + +1. 确认两台设备的 IP 地址是否在同一网段。 +2. 两台设备相互 `ping` 彼此 IP 地址是否正常。 + ::: + +## 安装 OpenSSH + +SSH 远程控制需要安装 OpenSSH 服务器, 在 Radxa ROCK 4D 的终端命令行运行以下命令安装： + + +``` +sudo apt update +sudo apt install openssh-server -y +``` + + +## 启动 SSH 服务 + +在 Radxa ROCK 4D 的终端命令行运行以下命令启动 SSH 服务： + + +``` +sudo systemctl start ssh +``` + + +## 设置 SSH 服务自启动 + +在 Radxa ROCK 4D 的终端命令行运行以下命令设置 SSH 服务自启动： + + +``` +sudo systemctl enable ssh +``` + + +## 查看 SSH 服务状态 + +在 Radxa ROCK 4D 的终端命令行运行以下命令查看 SSH 服务状态： + + +``` +sudo systemctl status ssh +``` + + +终端会输出类似信息: 提示您 SSH 服务是否自启动和当前运行状态。 + + +``` +● ssh.service - OpenBSD Secure Shell server + Loaded: loaded (/lib/systemd/system/ssh.service; enabled; preset: enabled) + Active: active (running) since Tue 2025-05-27 10:18:30 UTC; 4min 39s ago + Docs: man:sshd(8) + man:sshd_config(5) + Main PID: 1841 (sshd) + Tasks: 1 (limit: 4659) + Memory: 5.3M + CPU: 608ms + CGroup: /system.slice/ssh.service +``` + + +## 远程登录 + +在另一台设备上打开终端，输入以下命令进行远程登录：可以使用 `ip a` 命令查看 Radxa ROCK 4D 的 IP 地址。 + + +``` +ssh @ +``` + + +其中，`` 和 `` 分别是 Radxa ROCK 4D 的用户名和 IP 地址。 + +① ： 查询 Radxa ROCK 4D 的 IP 地址（此时我是通过串口连接到 Radxa ROCK 4D 查询的 IP 地址）。 + +② ： Radxa ROCK 4D 的实际 IP 地址。 + +③ ： 通过 SSH 远程登录 Radxa ROCK 4D。 + +
+ +
diff --git a/docs/rock4/rock4d/system-config/uart_debug.md b/docs/rock4/rock4d/system-config/uart_debug.md new file mode 100644 index 000000000..940a811ad --- /dev/null +++ b/docs/rock4/rock4d/system-config/uart_debug.md @@ -0,0 +1,190 @@ +--- +sidebar_position: 3 +--- + +# 串口调试 + +串口调试是嵌入式开发中通过串行通信接口 (UART) 与开发板交互的核心手段，通过串口工具可以查看系统输出的信息和进行调试。 + +## 硬件准备 + +- 开发板： Radxa ROCK 4D +- USB 串口数据线： 将开发板的 UART0 接口连接到 PC 机的 USB 端口 +- 电源适配器： 给开发板供电（支持 PD 协议，5V 电源输入） + +## 硬件连接 + +您需要将 USB 串口数据线连接到 Radxa ROCK 4D 的 UART0_TX、UART0_RX 和 GND 引脚。 + +:::danger +使用 USB 串口数据线和 Radxa ROCK 4D 进行串口调试时，请确保引脚连接正确，否则会导致主板硬件损坏。 +::: + +使用 USB 串口数据线的 USB 接口连接 PC ，另一端连接 Radxa ROCK 4D 的 GPIO 串口引脚。 + +
+ + 引脚说明和连接示意图 +
+ +| 序号 | 引脚功能 | 连接方式 | +| ---- | --------------------------------- | ----------------------------------- | +| ① | Radxa ROCK 4D : GND（Pin6） | 连接 USB 串口数据线的 GND 引脚 | +| ② | Radxa ROCK 4D : UART0_TX（Pin8） | 连接 USB 串口数据线的 RX 引脚 | +| ③ | Radxa ROCK 4D : UART0_RX（Pin10） | 连接 USB 串口数据线的 TX 引脚 | +| ④ | USB 串口数据线 : GND（黑色线） | 连接 Radxa ROCK 4D 的 GND 引脚 | +| ⑤ | USB 串口数据线 : RX（白色线） | 连接 Radxa ROCK 4D 的 UART0_TX 引脚 | +| ⑥ | USB 串口数据线 : TX（绿色线） | 连接 Radxa ROCK 4D 的 UART0_RX 引脚 | +| ⑦ | USB 串口数据线 : VCC（红色线） | 不连接 | + +## 串口登录 + +:::tip + +- Radxa ROCK 4D 串口通讯参数 + +波特率：1500000 + +数据位：8 + +停止位：1 + +无校验位 +::: + + + + + +Windows 平台推荐使用 PuTTY 软件串口登陆 Radxa ROCK 4D 系统。 + +- PuTTY使用 + +Radxa ROCK 4D 和 PC 通过 USB 串口数据线连接后，可以进入系统的设备管理器查看 Radxa ROCK 4D 对应的串口号(示意图中 COM4 就是当前系统中对应的 Radxa ROCK 4D 设备)。 + +
+ +
+ +:::tip + +若系统无法正确识别设备或者设备前面带有感叹号，需要自行安装[CH340驱动](https://www.wch.cn/downloads/CH341SER_EXE.html)，完成安装后重启系统。 + +::: + +- 串口登陆选项 + +① --> Connection type：选择 `Serial` + +② --> Serial line：填写 `COM4` (根据设备管理器显示的串口号信息) + +③ --> Speed：填写 `1500000` + +④ --> Open：串口连接 Radxa ROCK 4D 系统 + +
+ +
+ +- 登陆系统 + +终端内按回车会出现登陆信息，然后使用对应系统的用户账号和密码进行登陆。 + +终端输入密码不会显示出来，输入完密码按回车登陆。 + +
+ +
+ + + + + +Linux 推荐使用 Screen 软件串口登陆 Radxa ROCK 4D 系统。 + +- 安装Screen + + +``` +sudo apt update +sudo apt install screen +``` + + +- 查找串口设备 + +打开终端使用 ls 命令查看串口设备: + +若 PC 只有一个串口设备，系统默认是 ttyUSB0； + +若 PC 有多个串口设备，可以插拔 USB 设备，使用下面命令观察变化的设备号。 + + +``` +ls /dev/ttyUSB* +``` + + +- 串口登陆选项 + +使用 Screen 连接串口，只需要设置串口号和波特率。 + + +``` +sudo screen /dev/ttyUSB0 1500000 +``` + + +- 登陆系统 + +终端内按回车会出现登陆信息，然后使用对应系统的用户账号和密码进行登陆。 + +终端输入密码不会显示出来，输入完密码按回车登陆。 + +
+ +
+ + + + + +MacOS 平台推荐使用 Screen 软件串口登陆 Radxa ROCK 4D 系统。 + +:::tip + +若系统无法正确识别设备，需要自行安装[CH340驱动](https://www.wch.cn/downloads/CH341SER_MAC_ZIP.html)，完成安装后重启系统。 + +::: + +- 查找串口设备 + +打开终端使用 ls 命令查看串口设备: + +找到类似 /dev/tty.wchusbserial14xx0 的设备名称，若 PC 有多个串口设备，可以插拔 USB 设备，使用下面命令观察变化的设备号。 + + +``` +ls /dev/tty.* +``` + + +- 串口登陆选项 + +使用 Screen 连接串口，只需要设置串口号和波特率。 + + +``` +screen /dev/tty.wchusbserial14xx0 1500000 +``` + + +- 登陆系统 + +终端内按回车会出现登陆信息，然后使用对应系统的用户账号和密码进行登陆。 + +终端输入密码不会显示出来，输入完密码按回车登陆。 + + + + diff --git a/docs/rock4/rock4d/system-config/vnc-remote.md b/docs/rock4/rock4d/system-config/vnc-remote.md new file mode 100644 index 000000000..6b88d9f54 --- /dev/null +++ b/docs/rock4/rock4d/system-config/vnc-remote.md @@ -0,0 +1,267 @@ +--- +sidebar_position: 5 +--- + +# VNC 远程 + +远程登录是指通过网络远程控制主板，教程只介绍局域网下进行 VNC 的远程控制的方法。 + +无显示器的用户可以通过 [串口调试](./uart_debug) 的方法运行下面命令配置 VNC 远程登录。 + +:::tip +VNC 远程控制适合带有图形界面的系统，若系统没有图形化桌面，推荐使用 SSH 远程控制。 +::: + +## 使用 VNC（Windows / Linux） + +### 下载 VNC Viewer + +我们需要在远程设备，也就是 PC 上安装 VNC Viewer 软件控制主板。 + +进入 [RealVNC](https://www.realvnc.com/en/connect/download/viewer) 官网下载系统平台对应的 VNC Viewer 安装包。 + +
+ +
+ +### 安装 VNC Viewer + + + + + +下载 windows 版本的 `*.exe` 安装包后。 + +- 运行安装包 + +以管理员身份运行 `VNC-Viewer-xxx.exe` 安装程序。 + +
+ +
+- 软件语言 + +选择 `English` 语言，点击 `OK` 进入下一步。 + +
+ +
+ +- 进入安装 + +点击 `Next` 进入安装程序。 + +
+ +
+ +- 同意协议 + +勾选 `I accept the terms in the License Agreement` 选项，点击 `Next` 进入下一步。 + +
+ +
+ +- 安装路径 + +建议选择软件默认安装路径，点击 `Next` 进入下一步。 + +
+ +
+ +- 正式安装 + +点击 `Install` 开始正式安装。 + +
+ +
+ +- 完成安装 + +点击 `Finish` 完成安装。 + +
+ +
+ + + + + +下载 Linux 版本的 `*.deb` 安装包后，在终端命令行运行以下命令安装 VNC Viewer： + + +``` +sudo dpkg -i VNC-Viewer-xxx.deb +``` + + + + + + +### 运行 VNC Viewer + +安装完成后，打开 VNC Viewer 软件: 用户可以选择不登录账号使用 VNC Viewer 软件。 + +
+ +
+ +
+VNC Viewer 界面 + +
+ +## 使用 VNC（Radxa ROCK 4D） + +### 安装 VNC 服务器 + +在 Radxa ROCK 4D 的终端命令行运行以下命令安装 VNC 服务器： + + +``` +sudo apt update +sudo apt install tigervnc-standalone-server tigervnc-common -y +``` + + +### 设置 VNC 远程密码 + +在 Radxa ROCK 4D 的终端命令行运行以下命令设置 VNC 远程密码： + + +``` +vncpasswd +``` + + + +:::tip +输入密码和确认密码不会显示在屏幕上，系统提示是否创建一个只读密码，选择 `n`（否）。 +::: + +完成密码设置后，系统会提示类似信息： + + +``` +Password: +Verify: +Would you like to enter a view-only password (y/n)? n +A view-only password is not used +``` + + +### 配置 VNC 启动文件 + +在 Radxa ROCK 4D 编辑 `~/.vnc/xstartup` 文件： + + +``` +sudo vi ~/.vnc/xstartup +``` + + +修改 `~/.vnc/xstartup` 文件内容为： + + +``` +#!/bin/sh +unset SESSION_MANAGER +unset DBUS_SESSION_BUS_ADDRESS +export XDG_SESSION_TYPE=x11 +export DESKTOP_SESSION=plasma +exec startplasma-x11 +``` + + +编辑 `~/.vnc/xstartup` 文件后，需要赋予该文件可执行权限： + + +``` +sudo chmod +x ~/.vnc/xstartup +``` + + +### 启动 VNC 服务器 + +在 Radxa ROCK 4D 的终端命令行运行以下命令启动 VNC 服务器：使用 `-localhost no` 参数可以允许远程访问。 + + +``` +vncserver -localhost no +``` + + +启动成功后，会提示 VNC 服务器的端口号，例如： + + +``` +New Xtigervnc server 'rock-4d-spi:1 (radxa)' on port 5901 for display :1. +Use xtigervncviewer -SecurityTypes VncAuth -passwd /tmp/tigervnc.VQ4DfI/passwd :1 to connect to the VNC server. +``` + + +### 查看 VNC 服务器状态 + +在 Radxa ROCK 4D 的终端命令行运行以下命令查看 VNC 服务器状态： + + +``` +vncserver -list +``` + + +终端会输出类似信息： + + +``` +TigerVNC server sessions: + +X DISPLAY # RFB PORT # RFB UNIX PATH PROCESS ID # SERVER +1 5901 3283 Xtigervnc +``` + + + +### 关闭 VNC 服务器 + +在 Radxa ROCK 4D 的终端命令行运行以下命令可以关闭 VNC 服务器：其中命令中的 `:1` 代表 VNC 服务器的显示编号。 + + +``` +vncserver -kill :1 +``` + + +关闭 VNC 服务器后，VNC Viewer 软件会自动断开连接。 + +## VNC 远程登录 + +在另一台设备上打开 VNC Viewer 软件，根据 Radxa ROCK 4D 的 IP 地址和端口号进行 VNC 连接。 + +① ： 填写 Radxa ROCK 4D 的 IP 地址和端口号 + +② ： 点击 `Connect to address ···` 连接 Radxa ROCK 4D + +
+ +
+ +① ： 输入 VNC 远程设置的密码 + +② ： 勾选 `Remember password` 选项可以保存密码，方便下次登录 + +③ ： 点击 `OK` 进行连接 + +
+ +
+ +
+VNC远程登录成功 + +
diff --git a/docs/rock4/rock4d/system-config/web-config.md b/docs/rock4/rock4d/system-config/web-config.md new file mode 100644 index 000000000..9c8cb5a1f --- /dev/null +++ b/docs/rock4/rock4d/system-config/web-config.md @@ -0,0 +1,190 @@ +--- +sidebar_position: 3 +--- + +# 网络配置 + +## 有线网络 + + + + + +使用网线连接 Radxa ROCK 4D 千兆网口和路由器，连接成功后；路由器会自动分配 IP 地址给 Radxa ROCK 4D。 + +① ： 点击网络图标 + +② ： 选择 `Details` 选项可以看到网络连接的详细信息，如 IP 地址、子网掩码、网关地址等。 + +其中 `192.168.2.106` 就是路由器分配的 IP 地址。 + +
+ +
+ + + + + +使用网线连接 Radxa ROCK 4D 千兆网口和路由器，连接成功后；路由器会自动分配 IP 地址给 Radxa ROCK 4D。 + +终端命令行输入以下命令可以查看网络连接的详细信息： + + +``` +ip a +``` + + +终端会输出类似如下信息：其中 `192.168.2.106` 就是路由器分配的 IP 地址。 + + +``` +1: lo: mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000 + link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 + inet 127.0.0.1/8 scope host lo + valid_lft forever preferred_lft forever + inet6 ::1/128 scope host noprefixroute + valid_lft forever preferred_lft forever +2: end0: mtu 1500 qdisc mq state UP group default qlen 1000 + link/ether 5a:cb:6b:3c:ed:ae brd ff:ff:ff:ff:ff:ff + inet 192.168.2.106/24 brd 192.168.2.255 scope global dynamic noprefixroute end0 + valid_lft 2652sec preferred_lft 2652sec + inet6 fdaa::dd7/128 scope global dynamic noprefixroute + valid_lft 2494sec preferred_lft 2494sec + inet6 240e:3b7:3246:54f0::dd7/128 scope global dynamic noprefixroute + valid_lft 2494sec preferred_lft 2494sec + inet6 240e:3b7:3246:54f0:4732:d5f3:184e:7827/64 scope global dynamic noprefixroute + valid_lft 236440sec preferred_lft 150040sec + inet6 fdaa::9d81:8d0f:7ee4:5760/64 scope global noprefixroute + valid_lft forever preferred_lft forever + inet6 fe80::379f:ead8:706f:5d6/64 scope link noprefixroute + valid_lft forever preferred_lft forever +``` + + + + + + +## 无线网络 + +通过 Radxa ROCK 4D 的板载 WiFi 连接无线路由器，连接成功后，路由器会自动分配 IP 地址给 Radxa ROCK 4D。 + +:::tip +Radxa ROCK 4D 预留两个板载天线接口，您需要将天线安装到接口位置，不然WiFi信号会很差 +::: + + + + + +① ： 点击网络图标 + +② ： 点击需要连接的 WiFi 名称后面的 `Connect` 按钮 + +③ ： 输入 WiFi 密码并根据后续的提示进行连接 + +
+ +
+ +连接成功后，选择 `Details` 选项可以看到网络连接的详细信息，如 IP 地址、子网掩码、网关地址等。 + +其中 `192.168.31.53` 就是路由器分配的 IP 地址。 + +
+ +
+ + + + + +1. 开启 WiFi 功能 + + +``` +sudo nmcli radio wifi on +``` + + +2. 搜索附近 WiFi 网络 + + +``` +sudo nmcli device wifi list +``` + + +3. 连接 WiFi 网络 + + +``` +sudo nmcli device wifi connect password +# 示例 +sudo nmcli device wifi connect wifi_demo password 12345678 +``` + + +4. 查看网络连接的详细信息 + + +``` +ip a +``` + + +终端会输出类似如下信息：其中 `192.168.31.53` 就是路由器分配的 IP 地址。 + + +``` +1: lo: mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000 + link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 + inet 127.0.0.1/8 scope host lo + valid_lft forever preferred_lft forever + inet6 ::1/128 scope host noprefixroute + valid_lft forever preferred_lft forever +2: end0: mtu 1500 qdisc mq state UP group default qlen 1000 + link/ether 5a:cb:6b:3c:ed:ae brd ff:ff:ff:ff:ff:ff + inet 192.168.2.106/24 brd 192.168.2.255 scope global dynamic noprefixroute end0 + valid_lft 3125sec preferred_lft 3125sec + inet6 fdaa::dd7/128 scope global dynamic noprefixroute + valid_lft 3119sec preferred_lft 3119sec + inet6 240e:3b7:3246:54f0::dd7/128 scope global dynamic noprefixroute + valid_lft 3119sec preferred_lft 3119sec + inet6 240e:3b7:3246:54f0:4732:d5f3:184e:7827/64 scope global dynamic noprefixroute + valid_lft 235266sec preferred_lft 148866sec + inet6 fdaa::9d81:8d0f:7ee4:5760/64 scope global noprefixroute + valid_lft forever preferred_lft forever + inet6 fe80::379f:ead8:706f:5d6/64 scope link noprefixroute + valid_lft forever preferred_lft forever +3: wlx94706c5ee946: mtu 1500 qdisc mq state UP group default qlen 1000 + link/ether 94:70:6c:5e:e9:46 brd ff:ff:ff:ff:ff:ff + inet 192.168.31.53/24 brd 192.168.31.255 scope global dynamic noprefixroute wlx94706c5ee946 + valid_lft 3556sec preferred_lft 3556sec + inet6 fdaa:0:0:30::dd7/128 scope global dynamic noprefixroute + valid_lft 3555sec preferred_lft 3555sec + inet6 240e:3b7:3246:54f2::dd7/128 scope global dynamic noprefixroute + valid_lft 3555sec preferred_lft 3555sec + inet6 240e:3b7:3246:54f2:518e:da68:272f:928/64 scope global dynamic noprefixroute + valid_lft 235266sec preferred_lft 148866sec + inet6 fdaa::30:f642:3a8c:dd7b:4ada/64 scope global noprefixroute + valid_lft forever preferred_lft forever + inet6 fe80::ff38:edfe:b892:b694/64 scope link noprefixroute + valid_lft forever preferred_lft forever +``` + + +:::tip +Nmcli 是 Network Manager Command Line Interface 的简称，是 Linux 下管理网络的命令行工具。 + +拓展命令： + +- `nmcli radio wifi off`：关闭 WiFi 功能。 +- `nmcli connection delete ` ：删除指定的 WiFi 网络。 + ::: + + + + diff --git a/i18n/en/docusaurus-plugin-content-docs/current/common/radxa-os/_mali-gpu.mdx b/i18n/en/docusaurus-plugin-content-docs/current/common/radxa-os/_mali-gpu.mdx index 89180c1ad..890180e8b 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/common/radxa-os/_mali-gpu.mdx +++ b/i18n/en/docusaurus-plugin-content-docs/current/common/radxa-os/_mali-gpu.mdx @@ -111,7 +111,7 @@ blacklist panfrost #blacklist midgard_kbase ``` -## Turn off Zink support +## Turn off Zinc support ```bash echo "LIBGL_KOPPER_DISABLE=true" | sudo tee -a /etc/environment diff --git a/i18n/en/docusaurus-plugin-content-docs/current/compute-module/cm5/README.md b/i18n/en/docusaurus-plugin-content-docs/current/compute-module/cm5/README.md index d24b18cca..dd5bdf5fa 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/compute-module/cm5/README.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/compute-module/cm5/README.md @@ -18,7 +18,7 @@ The Radxa CM5 is a System on Module (SoM) based on a the Rockchip RK3588S System | Features | Description | | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| SoC | Rockchip RK3588S/RK3588S2 | +| SoC | Rockchip RK3588S/RK3588S2 | | CPU | Quad Cortex®‑A76 @ 2.2~2.4GHz and a quad Cortex®‑A55 @ 1.8GHz
based on Arm® DynamIQ™ configuration | | GPU | Arm Mali™ G610MP4 GPU ‑ OpenGL® ES1.1, ES2.0, and ES3.2 ‑ OpenCL®
1.1, 1.2 and 2.2 ‑ Vulkan® 1.1 and 1.2 ‑ Embedded high performance 2D
image acceleration module | | NPU | NPU supporting INT4 / INT8 / INT16 / FP16 / BF16 and TF32 acceleration
and computing power is up to 6TOPs | @@ -69,7 +69,7 @@ Introduces system installation, system login, accessory usage, etc. letting user ### [Radxa OS](/compute-module/cm5/radxa-os) Radxa OS is an operating system customized by Radxa based on Debian Linux. -This chapter introduces system login, networking, and more, helping users familiarize themselves with the system quickly. +This chapter introduces system login, networking, and more, helping users familiarize themselves with the system quickly. ### [Android](/compute-module/cm5/android) diff --git a/i18n/en/docusaurus-plugin-content-docs/current/e/e54c/getting-started/install-os/boot_from_nvme.md b/i18n/en/docusaurus-plugin-content-docs/current/e/e54c/getting-started/install-os/boot_from_nvme.md index fe5d3335d..6aa4f306f 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/e/e54c/getting-started/install-os/boot_from_nvme.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/e/e54c/getting-started/install-os/boot_from_nvme.md @@ -33,7 +33,7 @@ rsetup Tool Guide: Interface may vary slightly between versions. Please refer to - Cancel selection: Press `ESC` - Toggle options: Use arrow keys - Multi-selection interface: Press `Space` to select, then `Enter` to confirm -::: + ::: Open the system command line and run the `rsetup` tool to update. @@ -64,6 +64,7 @@ Restart the system after completing all operations. To prevent accidental writes to the bootloader stored in the SPI Flash during normal use, the SPI Flash device is disabled by default. Enable it as follows: Select `Overlays` → `Manage Overlays`: +
@@ -91,6 +92,7 @@ Restart the system after completing all operations. After rebooting, open the `rsetup` configuration tool again. Select `System` → `Bootloader Management` → `Update SPI Bootloader`: +
@@ -160,6 +162,7 @@ You can also transfer the system image file to the Radxa E54C using other method sudo apt-get install wget # Download the system image file + wget https://github.com/radxa-build/radxa-e54c/releases/download/rsdk-b2/radxa-e54c_bookworm_cli_b2.output.img.xz ``` @@ -173,7 +176,9 @@ Use the following command to extract and write the compressed system image direc ``` + sudo xzcat ~/radxa-e54c_bookworm_cli_b2.output.img.xz | sudo dd of=/dev/nvme0n1 bs=1M status=progress + ``` @@ -189,7 +194,9 @@ After writing is complete, verify that the partition table in the NVMe was creat ``` + sudo fdisk -l /dev/nvme0n1 + ``` @@ -216,8 +223,10 @@ After the system boots, verify that it successfully booted from NVMe using the f ``` + lsblk df -h + ``` @@ -250,7 +259,9 @@ After successfully booting from NVMe, you can perform the following actions: ``` + sudo apt update && sudo apt upgrade + ``` @@ -266,7 +277,9 @@ Test read speed (1GB of data): ``` + sudo dd if=/dev/nvme0n1 of=/dev/null bs=1M count=1024 iflag=direct + ``` @@ -274,11 +287,15 @@ sudo dd if=/dev/nvme0n1 of=/dev/null bs=1M count=1024 iflag=direct ``` + # Install nvme-cli + sudo apt install nvme-cli # Check temperature + sudo nvme smart-log /dev/nvme0n1 | grep "temperature" + ``` @@ -286,10 +303,13 @@ sudo nvme smart-log /dev/nvme0n1 | grep "temperature" ``` + sudo nvme list + ```
-
\ No newline at end of file + +``` diff --git a/i18n/en/docusaurus-plugin-content-docs/current/orion/o6/bios/install-bios.md b/i18n/en/docusaurus-plugin-content-docs/current/orion/o6/bios/install-bios.md index 6e80679d0..2b9bcbe2b 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/orion/o6/bios/install-bios.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/orion/o6/bios/install-bios.md @@ -29,13 +29,13 @@ Please refer to the relevant content on the [download page](../download#bios). ``` -BuildOptions -BurnImage.efi -cix_flash_all.bin -cix_flash_ota.bin -FlashUpdate.efi -setup.nsh -Shell.efi +BuildOptions +BurnImage.efi +cix_flash_all.bin +cix_flash_ota.bin +FlashUpdate.efi +setup.nsh +Shell.efi VariableInfo.efi ``` @@ -133,23 +133,28 @@ Please make sure the power stays on during the operation. Enter 'q' to quit, any other key to continue: -************************************************************************ +--- + Updating BIOS... -************************************************************************ + +--- ======================================================================== - Copyright 2024 Cix Technology Group Co., Ltd. All Rights Reserved. - FlashUpdate Utility v1.04. - Build Date:Jan 16 2025 +Copyright 2024 Cix Technology Group Co., Ltd. All Rights Reserved. +FlashUpdate Utility v1.04. +Build Date:Jan 16 2025 ======================================================================== Old Version:0.2.2-1 New Version:0.2.2-1 [00.15] Processing... Flash update success. -************************************************************************ +--- + BIOS Update completed! -************************************************************************ + +--- + System will now power off. You MUST fully remove all connected power source before connecting them. Failure to do so may prevent some components to use the updated code. @@ -183,9 +188,11 @@ After the burning is completed, unplug the power of the O6 and then power it on ``` + Tianocore/EDK2 firmware version 0.2.2-1 Press ESCAPE for boot options ..... + ``` @@ -194,28 +201,21 @@ Press ESCAPE for boot options ``` - Radxa Orion O6 - CIX P1 CD8180 1.80 GHz - 0.2.2-1 65536 MB RAM - - - - Select Language This is the option - one adjusts to change - > Device Manager the language for the - > Boot Manager current system - > Boot Maintenance Manager +Radxa Orion O6 +CIX P1 CD8180 1.80 GHz +0.2.2-1 65536 MB RAM - Continue - Reset +Select Language This is the option +one adjusts to change +> Device Manager the language for the +> Boot Manager current system +> Boot Maintenance Manager +Continue +Reset - - - - - ^v=Move Highlight =Select Entry +^v=Move Highlight =Select Entry ``` @@ -230,29 +230,27 @@ The `Boot Manager` screen is shown below: ``` + /------------------------------------------------------------------------------\ -| Boot Manager | +| Boot Manager | \------------------------------------------------------------------------------/ Device Path : - Boot Manager Menu Fv(9A15AA37-D555-4A4E- - B541-86391FF68164)/FvF - debian ile(7C04A583-9E3E-4F1C - UEFI aigo U330 90003C33924E4D12 -AD65-E05268D0B4D1) - UEFI KINGBANK KP230 K19010J001612 - UEFI Shell - - Use the <^> and keys to choose a boot option, - the key to select a boot option, and the - key to exit the Boot Manager Menu. - - +Boot Manager Menu Fv(9A15AA37-D555-4A4E- +B541-86391FF68164)/FvF +debian ile(7C04A583-9E3E-4F1C +UEFI aigo U330 90003C33924E4D12 -AD65-E05268D0B4D1) +UEFI KINGBANK KP230 K19010J001612 +UEFI Shell +Use the <^> and keys to choose a boot option, +the key to select a boot option, and the + key to exit the Boot Manager Menu. /------------------------------------------------------------------------------\ -| | -| ^v=Move Highlight =Select Entry Esc=Exit | +| | +| ^v=Move Highlight =Select Entry Esc=Exit | \------------------------------------------------------------------------------/ ``` @@ -264,33 +262,35 @@ Select `UEFI Shell` to enter the shell environment. ``` + UEFI Interactive Shell v2.2 EDK II UEFI v2.70 (EDK II, 0x00010000) Mapping table - FS0: Alias(s):HD0b:;BLK1: - PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 +FS0: Alias(s):HD0b:;BLK1: +PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 1)/HD(1,GPT,80810833-48A5-4976-A296-0209E1012834,0x800,0x100000) - FS1: Alias(s):HD1b0c:;BLK6: - VenHw(0D51905B-B77E-452A-A2C0-ECA0CC8D514A,00801D090000000000)/USB(0x1 +FS1: Alias(s):HD1b0c:;BLK6: +VenHw(0D51905B-B77E-452A-A2C0-ECA0CC8D514A,00801D090000000000)/USB(0x1 ,0x0)/HD(2,GPT,3A7E1703-AD97-4EE2-A0E0-BDC978C453D0,0x8800,0x3A8F000) - BLK0: Alias(s): - PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 -1) - BLK2: Alias(s): - PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 -1)/HD(2,GPT,02EC7511-B73F-4F06-ABBF-ACEF796021D2,0x100800,0xEB93000) - BLK3: Alias(s): - PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 -1)/HD(3,GPT,19A46BB8-BDB9-4A8B-A2A8-03CE65C39A29,0xEC93800,0x1E8800) - BLK4: Alias(s): - VenHw(0D51905B-B77E-452A-A2C0-ECA0CC8D514A,00801D090000000000)/USB(0x1 -,0x0) - BLK5: Alias(s): - VenHw(0D51905B-B77E-452A-A2C0-ECA0CC8D514A,00801D090000000000)/USB(0x1 -,0x0)/HD(1,GPT,EE706585-639D-48CE-B236-4C372373E325,0x800,0x8000) -Press ESC in 1 seconds to skip startup.nsh or any other key to continue. -Shell> +BLK0: Alias(s): +PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 + +1. BLK2: Alias(s): + PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 + 1)/HD(2,GPT,02EC7511-B73F-4F06-ABBF-ACEF796021D2,0x100800,0xEB93000) + BLK3: Alias(s): + PciRoot(0x1)/Pci(0x0,0x0)/Pci(0x0,0x0)/NVMe(0x1,00-00-00-00-00-00-00-0 + 1)/HD(3,GPT,19A46BB8-BDB9-4A8B-A2A8-03CE65C39A29,0xEC93800,0x1E8800) + BLK4: Alias(s): + VenHw(0D51905B-B77E-452A-A2C0-ECA0CC8D514A,00801D090000000000)/USB(0x1 + ,0x0) + BLK5: Alias(s): + VenHw(0D51905B-B77E-452A-A2C0-ECA0CC8D514A,00801D090000000000)/USB(0x1 + ,0x0)/HD(1,GPT,EE706585-639D-48CE-B236-4C372373E325,0x800,0x8000) + Press ESC in 1 seconds to skip startup.nsh or any other key to continue. + Shell> + ``` @@ -301,33 +301,42 @@ Under Shell, output the command `setup.nsh` and press Enter to execute it. ``` + FS1:\> setup.nsh -************************************************************************ + +--- + Radxa BIOS Update Utility -************************************************************************ + +--- You are about to update the BIOS. Please make sure the power stays on during the operation. Enter 'q' to quit, any other key to continue: -************************************************************************ +--- + Updating BIOS... -************************************************************************ + +--- ======================================================================== - Copyright 2024 Cix Technology Group Co., Ltd. All Rights Reserved. - FlashUpdate Utility v1.04. - Build Date:Jan 16 2025 +Copyright 2024 Cix Technology Group Co., Ltd. All Rights Reserved. +FlashUpdate Utility v1.04. +Build Date:Jan 16 2025 ======================================================================== Old Version:0.2.2-1 New Version:0.2.2-1 [00.15] Processing... Flash update success. -************************************************************************ +--- + BIOS Update completed! -************************************************************************ + +--- + System will now power off. You MUST fully remove all connected power source before connecting them. Failure to do so may prevent some components to use the updated code. @@ -346,3 +355,4 @@ You can refer to the demo: https://radxa-pkg.github.io/edk2-cix/install.html ### Method 3: Offline BIOS update For advanced users who need to recover from a corrupted BIOS or prefer direct hardware access, a Serial Flash programmer (such as CH341A) can be used to flash the BIOS firmware (cix_flash_all.bin) directly to the SPI NOR Flash chip. This method bypasses the operating system entirely and works even when the device cannot boot. For detailed step-by-step instructions and hardware requirements, please refer to the comprehensive [Forum Guide](https://forum.radxa.com/t/guide-flash-bios-with-ch341a-macos-linux/26742) contributed by community member Meco, which covers the process on macOS and Linux platforms. +``` diff --git a/i18n/en/docusaurus-plugin-content-docs/current/productlist.md b/i18n/en/docusaurus-plugin-content-docs/current/productlist.md index ac936c5e7..c84875af2 100644 --- a/i18n/en/docusaurus-plugin-content-docs/current/productlist.md +++ b/i18n/en/docusaurus-plugin-content-docs/current/productlist.md @@ -23,6 +23,7 @@ sidebar_position: 2 | ROCK 4A+ / 4B+ (2021) | OP1 with 4K HDMI and Onboard eMMC | | [ROCK 4SE](/rock4/rock4se/) (2022) | RK3399-T with 4K HDMI | | [ROCK 4C+](/rock4/rock4c+/) (2022) | RK3399-T with 4K + 2K HDMI | +| [ROCK 4D](/rock4/rock4d/) (2025) | RK3576 with 4K HDMI | ### ROCK 5 Series diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/README.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/README.md new file mode 100644 index 000000000..735da7e1e --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/README.md @@ -0,0 +1,105 @@ +--- +sidebar_position: 11 +sidebar_label: ROCK 4D +--- + +# ROCK 4D - Industrial Grade AI Single Board Computer + +## Product Overview + +Radxa ROCK 4D is a compact single board computer (SBC) with numerous top-tier features, characteristics, and expansion options. + +ROCK 4D is equipped with Rockchip RK3576 or RK3576J SoC, featuring an octa-core CPU (4 Cortex-A72 + 4 Cortex-A53 cores), Mali-G52 GPU, and powerful 6 TOPS NPU, making it ideal for AI and multimedia tasks. + +ROCK 4D is perfect for makers, IoT enthusiasts, hobbyists, gamers, PC users, OEM manufacturers, industrial applications, and all users who need high-performance and high-reliability platforms. + +Radxa ROCK 4D comes in two versions: Commercial-grade ROCK 4D based on RK3576 and Industrial-grade ROCK 4D based on RK3576J. + +## Product Appearance + +
+ Radxa ROCK 4D Front + + Radxa ROCK 4D Back + +
+ +## Product Specifications + +| Category | Specifications | +| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Processor | System-on-Chip (SoC): Rockchip RK3576 / RK3576J
Central Processing Unit (CPU): 4-core Cortex-A72 + 4-core Cortex-A53
Graphics Processing Unit (GPU): Arm Mali-G52 MC3
Neural Processing Unit (NPU): 6 TOPS (Supports INT4 / INT8 / INT16 / FP16 / BF16 / TF32) | +| Memory (RAM) | LPDDR5, Options: 2GB / 4GB / 8GB / 16GB | +| Storage | Boot Storage: 16MB SPI NOR Flash
Expansion Storage: eMMC / UFS Module Interface, MicroSD Card Slot | +| Network | Wired Connection: 1 Gigabit Ethernet Port (Supports PoE, requires external HAT)
Wireless Connection: Wi-Fi 6, Bluetooth 5.4, External Antenna Interface | +| Video Output | HDMI Interface: 1× HDMI 2.1, Supports up to 4K@120fps
MIPI DSI Interface: 1× 4-lane MIPI DSI | +| Camera Interface | MIPI CSI Interface: 1× 4-lane (can be split into 2× 2-lane) + 1× 2-lane CSI | +| Audio | Audio Interface: 3.5mm 4-pole Headphone Jack, Supports Microphone Input
Audio Output: Supports Stereo Output, Can Directly Drive 32Ω Headphones | +| USB Ports | USB 3.0: 1× Type-A HOST, 1× Type-A OTG/HOST
USB 2.0: 2× Type-A HOST | +| Expansion Interfaces | GPIO Pin Headers: Supports UART, SPI, I2C, I2S, PWM, CAN, ADC, etc.
PCIe Slot: Provides PCIe 2.1 x1 Channel via FPC Interface
Fan Connector: 1× 2-pin 1.25mm PWM Fan Control Interface | +| Power Interface | Supports USB Type-C and GPIO Pin Power Supply | +| Operating System | Supports Debian Linux, Android 14, Yocto, Buildroot | +| Operating Temperature | Operating Temperature (Commercial Grade): 0°C ~ 60°C (RK3576)
Operating Temperature (Industrial Grade): -40°C ~ 85°C (RK3576J) | + +## Interface Description + +
+ +
+ +| Number | Description | Quantity | +| :----: | :----------------------------------- | :------: | +| ① | USB Type-C Power Port | 1 | +| ② | User LED | 1 | +| ③ | Power LED | 1 | +| ④ | Power Button | 1 | +| ⑤ | FPC Interface | 1 | +| ⑥ | WiFi6 and Bluetooth 5.4 | 1 | +| ⑦ | External Antenna Port | 1 | +| ⑧ | 40 Pin GPIO | 1 | +| ⑨ | LPDDR5 Memory | 1 | +| ⑩ | PoE Interface | 1 | +| ⑪ | Maskrom Button | 1 | +| ⑫ | USB 2.0 Type-A | 2 | +| ⑬ | Rockchip RK3576（J） | 1 | +| ⑭ | USB 3.0 Type-A | 2 | +| ⑮ | SPI NOR Flash | 1 | +| ⑯ | Gigabit Ethernet Port (Supports PoE) | 1 | +| ⑰ | Fan Connector | 1 | +| ⑱ | Headphone Jack | 1 | +| ⑲ | MIPI CSI Interface | 1 | +| ⑳ | HDMI 2.1 Interface | 1 | +| ㉑ | Recovery Interface | 1 | +| ㉒ | UFS Module Interface | 1 | +| ㉓ | RTC Interface | 1 | +| ㉔ | eMMC Module Interface | 1 | +| ㉕ | MIPI CSI Interface | 1 | +| ㉖ | MicroSD Card Slot | 1 | +| ㉗ | MIPI DSI Interface | 1 | + +## Application Scenarios + +### Linux Beginners + +As a Linux-based single board computer, ROCK 4D can be used for Linux beginners to learn Linux, develop low-level and application-layer development. + +### Robot Development + +As the main controller for robot development, it offers excellent performance and rich hardware interfaces, making it convenient for users to develop robot applications. + +### Embedded Development + +It provides rich GPIO interfaces, supporting UART, SPI, I2C, I2S communication methods, making it convenient for users to drive various hardware. + +### AI Development + +Equipped with a powerful 6 TOPS neural network accelerator, suitable for AI inference and training. + +## System Platform + +ROCK 4D is based on RK3576 or RK3576J chipset, supporting ArmV8 instruction set and multiple operating systems. + +- Debian Linux +- Yocto Linux +- Buildroot +- Android 14 diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/download.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/download.md new file mode 100644 index 000000000..d61bafb7f --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/download.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 15 +--- + +# Resource Download + +## Loader Download + +For USB flashing, the Loader file is used for USB download initialization. + +- Loader: [rk3576_spl_loader.bin](https://dl.radxa.com/rock4/4d/images/rk3576_spl_loader.bin) + +## System Image Download + +Linux system images that can be directly written to MicroSD card / UFS module / NVME to boot the system. + +- System image for MicroSD card / NVME SSD / USB drive booting: [rk3576_bookworm_kde_512.img.xz](https://github.com/radxa-build/radxa-rk3576/releases/download/rsdk-b1/radxa-rk3576_bookworm_kde_b1.output_512.img.xz) + +- System image for UFS booting: [rk3576_bookworm_kde_4096.img.xz](https://github.com/radxa-build/radxa-rk3576/releases/download/rsdk-b1/radxa-rk3576_bookworm_kde_b1.output_4096.img.xz) + +:::caution + +1. Please download the corresponding system image file based on your boot medium. Downloading the wrong image will prevent the system from booting. The main difference between UFS and regular images is that the UFS image has a block size of 4K bytes, while the regular image has a block size of 512 bytes. +2. The downloaded system image is compressed. Please decompress it before writing it to the MicroSD card/UFS module/NVME to boot the system. + ::: + +## Hardware Design + +- [Schematic](https://dl.radxa.com/rock4/4d/docs/hw/Radxa_ROCK_4D_SCH_V1.11.pdf) +- [Component Placement](https://dl.radxa.com/rock4/4d/docs/hw/Radxa_ROCK_4D_SMD_V1.11.pdf) +- [3D Model](https://dl.radxa.com/rock4/4d/docs/hw/Radxa_ROCK_4D_3D_v1_11_20250328.stp) + +## Reference Documents + +- [Radxa ROCK 4D Feature Sheet](https://dl.radxa.com/rock4/4d/docs/ROCK4D_Quick_Features_EN.pdf) +- [Radxa ROCK 4D Product Brief](https://dl.radxa.com/rock4/4d/docs/radxa_rock4d_product_brief.pdf) diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/README.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/README.md new file mode 100644 index 000000000..bfa7bfb6e --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/README.md @@ -0,0 +1,15 @@ +--- +sidebar_position: 11 +--- + +# Getting Started Guide + +The Getting Started Guide helps users quickly understand and use the Radxa ROCK 4D development board. + +### [Quick Start](/rock4/rock4d/getting-started/quickly_start) + +This guide provides detailed instructions on the hardware and software requirements for using the Radxa ROCK 4D, along with methods for installing and using the system, focusing on booting from a MicroSD card. + +### [System Installation](/rock4/rock4d/getting-started/install-system) + +This section explains how to install and boot the system on the Radxa ROCK 4D using different boot media (such as MicroSD cards, UFS modules, M.2 NVMe SSDs, etc.). diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/README.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/README.md new file mode 100644 index 000000000..44203ed03 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/README.md @@ -0,0 +1,27 @@ +# Install System + +Radxa ROCK 4D supports three ways to install the system: MicroSD card, UFS module, and M.2 NVMe SSD. Users can choose the corresponding system startup medium based on their needs. + +- Use MicroSD card to install the system - Simple operation, just need a card reader to complete the system installation; but the read and write speed is slower than UFS module and M.2 NVMe SSD card. + +- Use UFS module to install the system - Compared with MicroSD card, the read and write speed is faster, and Radxa ROCK 4D supports pluggable UFS modules, and you can refer to the [Radxa UFS Module](https://radxa.com/products/accessories/ufs-module) for more information. + +- Use M.2 NVMe SSD to install the system - Compared with UFS module, the read and write speed is faster, but it needs to be used with a special adapter. + +Overall, if there is no high requirement for read and write performance, you can use MicroSD card as the system startup medium; if there is a requirement for read and write speed and does not need to connect Radxa ROCK 4D with an additional adapter, you can use UFS module to install the system; if there is a higher requirement for read and write speed, you can use M.2 NVMe SSD to install the system. + +### [Install System to MicroSD Card](/rock4/rock4d/getting-started/install-system/boot_sd) + +Mainly introduce Radxa ROCK 4D using MicroSD card to install the system and start the system. + +### [Install System to UFS Module](/rock4/rock4d/getting-started/install-system/ufs-system) + +Mainly introduce Radxa ROCK 4D using UFS module to install the system and start the system. + +### [Install System to M.2 NVMe SSD](/rock4/rock4d/getting-started/install-system/nvme-system) + +Mainly introduce Radxa ROCK 4D using M.2 NVMe SSD to install the system and start the system. + +### [Download and Flash SPI Boot Firmware](/rock4/rock4d/getting-started/install-system/boot_start) + +Mainly introduce how to download and flash SPI boot firmware to Radxa ROCK 4D. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/boot_sd.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/boot_sd.md new file mode 100644 index 000000000..00c28b697 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/boot_sd.md @@ -0,0 +1,164 @@ +--- +sidebar_position: 1 +--- + +# Installing System to MicroSD Card + +This tutorial explains how to install the system on a MicroSD card. + +## Hardware Requirements + +You'll need to prepare the following hardware devices to complete the system installation and boot process. + +#### For System Installation + +- Card reader: MicroSD card reader +- Boot media: MicroSD card (32GB or larger recommended) + +#### For System Booting + +- Development board: Radxa ROCK 4D +- Power adapter: Type-C power adapter (PD protocol supported, 5V input, 3A or higher current recommended) + +:::tip +The Radxa ROCK 4D motherboard only supports 5V power input. A current of 3A or higher is recommended to ensure stable operation of all peripherals. + +Recommended power supplies: + +- [Radxa PD 30W Power Adapter (Recommended)](https://radxa.com/products/accessories/power-pd-30w) +- Standard Type-C power adapter (5V input, PD protocol supported, 3A or higher current recommended) + ::: + +## System Installation + +Installing the system will format the MicroSD card. Please back up any important data in advance. + +### Download System Image + +Visit the [Resource Downloads](../../download) page on your PC and locate the system image for the MicroSD card. + +After downloading, extract the system image file. The resulting `*.img` file is the system image that will be written to the MicroSD card. + +:::tip +The downloaded system image is a compressed file that must be extracted before it can be written to the SD card using the image writing software. Writing the compressed file directly to the SD card may result in installation failure or boot issues. +::: + +### Hardware Connection + +Insert the MicroSD card into the card reader, then connect the card reader to a USB port on your PC. + +
+ +
+ +### Installing the System Image + +Use the open-source image writing tool Etcher to write the system image to the MicroSD card. + +#### Downloading Etcher + +Go to the official Balena Etcher website and download the software for your platform: balenaEtcher. + +
+ +
+ +Download the appropriate software package for your system platform and architecture. + +
+ +
+ +#### Using Etcher + +After downloading, double-click to open the Etcher application. + +:::tip + +- Windows + +The downloaded file is an `*.exe` installer. Double-click to run the program. + +- Linux + +It's recommended to download the `*.zip` archive. After extraction, double-click to run the program. + +- macOS + +Download the appropriate `*.dmg` file for your system architecture. After opening, drag the application to the Applications folder to install. Then double-click the application icon to run it. + +::: + +
+ +
+ +#### Installing the System Image + +1. Select Image File + +Click the `Flash from file` option and select the system image file you downloaded and extracted earlier. + +
+ +
+ +2. Select Target Device + +Click the `Select target` option and choose the storage device where you want to install the system image. + +:::danger +Be careful not to select the wrong storage device, as Etcher will format the selected device, potentially causing data loss! + +You can unplug and replug your storage device to observe changes in the available devices and help identify the correct one. +::: + +
+ +
+ +① : Select the storage device for the system image + +② : Click `Select 1` to confirm device selection + +
+ +
+ +3. Flash the System Image + +Click the `Flash` option and wait for the software to automatically install and verify the system image. + +
+ +
+ +
+Waiting for system installation to complete + +
+ +
+Waiting for system verification to complete + + After successfully installing the system image, close the Etcher software! +
+ +## System Information + +When using our provided system image, you'll need to log in with the following default credentials on first boot: + +Debian Linux +Username: radxa + +Password: radxa + +## Booting the System + +After completing the system image installation, remove the MicroSD card from the card reader, insert it into the MicroSD card slot on the motherboard, and power on the system using a 5V Type-C power adapter. + +When the system boots, both the blue and green LEDs will light up simultaneously. After a few seconds, the green LED will stay lit while the blue LED will blink, indicating that the system has successfully booted. + +
+ +
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/boot_start.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/boot_start.md new file mode 100644 index 000000000..cd5c3b761 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/boot_start.md @@ -0,0 +1,112 @@ +--- +sidebar_position: 4 +--- + +# Flashing SPI Boot Firmware + +You can think of the SPI boot firmware as the **BIOS/UEFI** in your personal computer. Just like how a PC's BIOS/UEFI is responsible for initializing basic hardware (such as memory, hard drives, keyboards, etc.) before the operating system (like Windows or Linux) starts up, the SPI boot firmware on embedded devices serves a similar role. + +The core tasks of the SPI boot firmware include **initializing critical hardware** such as: + +- **DDR Memory**: Prepares the memory space for the main system operation. +- **Clock Frequencies**: Sets the operating speed for different parts of the chip. +- **Storage Controllers**: Enables the system to access storage devices like Micro SD cards, UFS modules, or M.2 NVMe SSDs. +- **GPIO (General-Purpose Input/Output Pins)**: Configures pin functions for connecting various peripherals. + +After completing these initializations, the SPI boot firmware loads the operating system kernel from eMMC/SD card/NVMe SSD/USB drive. This SPI boot firmware is typically stored in a special storage chip on the motherboard called **SPI Nor Flash**, which serves a similar role to the chip on a PC motherboard that stores the BIOS/UEFI. + +## When Do You Need to Flash SPI Boot Firmware? + +The ROCK 4D comes pre-installed with compatible SPI boot firmware. **If your device is functioning normally or you haven't performed any operations to erase the SPI Nor Flash, this step is usually unnecessary.** + +You only need to reflash the SPI boot firmware in the following situations: + +- **SPI Flash Content Corruption**: Similar to when a PC's BIOS is corrupted and cannot boot +- **Firmware Version Upgrade Required**: To gain support for new features or fix known issues +- **Specific Development Needs**: Such as starting with a blank SPI Flash or needing to boot an unofficially supported system +- **Educational Purposes**: To gain a deeper understanding of the device's low-level boot mechanisms + +This tutorial will guide you through the process of flashing the SPI boot firmware, which is an additional step after the regular system installation for writing the initial bootloader. + +## Obtaining the Latest SPI Boot Firmware + +You'll need to boot the Radxa ROCK 4D system using a MicroSD card. You can refer to the [Quick Start](../quickly_start) guide to complete this step. + +Once the system has successfully booted and you've confirmed the network connection is working, open the Radxa ROCK 4D terminal and use the Rsetup tool to update the system. + + +``` +sudo rsetup +``` + + +
+Rsetup Home Interface + +
+ +:::tip +Rsetup Tool Guide: For detailed usage instructions, refer to the [Rsetup Tool](../../system-config/rsetup) + +- Select Option: The corresponding option will be highlighted +- Confirm Selection: Press `Enter` +- Cancel Selection: Press `ESC` +- Navigate Options: Use `Up`, `Down`, `Left`, `Right` arrow keys +- Multi-selection Interface: Press `Space` to select, `Enter` to confirm selection + ::: + +After entering the Rsetup tool, select `System` → `System Update`: + +
+ +
+ +Select "yes" to continue, then follow the on-screen prompts to complete the remaining operations: + +
+ +
+ +After completing all operations, use the following command to reboot the system: + + +``` +sudo reboot +``` + + +## Flashing the SPI Boot Firmware + +After the system reboots, open the Rsetup tool again. + +Select `System` → `Bootloader Management` → `Update SPI Bootloader`: + +
+ +
+ +Select "yes" to continue, then follow the on-screen prompts to complete the remaining operations. + +
+ +
+ +Select the Bootloader file to install: If there are multiple Bootloader options available, prioritize the one with the "spi" suffix. + +
+ +
+ +The system will automatically download the latest `spi.img` and flash it to the SPI Nor Flash. + +
+ +
+ +After completing all operations, use the following command to reboot the system: + + +``` +sudo reboot +``` + diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/nvme-system/README.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/nvme-system/README.md new file mode 100644 index 000000000..fcb13e785 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/nvme-system/README.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 3 +--- + +# Installing System to NVMe SSD + +M.2 NVMe SSD is a high-speed, high-capacity, and cost-effective storage device that offers faster read/write speeds compared to MicroSD cards and UFS modules. It's an excellent choice for users looking to further enhance their system's read/write and boot performance. + +We provide two methods to install the system on an M.2 NVMe SSD: + +- For users who have an M.2 NVMe SSD enclosure, the installation process is similar to that of installing the system on a MicroSD card and is relatively straightforward. + +- For users without an M.2 NVMe SSD enclosure, you can use the `dd` command to install the system image to the M.2 NVMe SSD. + +:::tip + +The Radxa ROCK 4D comes with an FPC interface that provides PCIe Gen2 ×1 channel expansion capability. + +To use the FPC interface, you'll need to purchase a PCIe to M.2 M Key HAT in advance and install it correctly according to the accessory instructions. + +::: + +### [Using an M.2 NVMe SSD Enclosure](/rock4/rock4d/getting-started/install-system/nvme-system/nvme_reader) + +This guide explains how to install and boot the system when you have an M.2 NVMe SSD enclosure. + +### [Without an M.2 NVMe SSD Enclosure](/rock4/rock4d/getting-started/install-system/nvme-system/no_nvme_reader) + +This guide explains how to install and boot the system when you don't have an M.2 NVMe SSD enclosure. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/nvme-system/no_nvme_reader.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/nvme-system/no_nvme_reader.md new file mode 100644 index 000000000..e3d2c5f16 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/nvme-system/no_nvme_reader.md @@ -0,0 +1,182 @@ +--- +sidebar_position: 2 +--- + +# Not Using M.2 NVMe SSD Enclosure + +This tutorial is for users who don't have an M.2 NVMe SSD enclosure. It explains how to install the system to an M.2 NVMe SSD using a MicroSD card as the boot medium. + +:::tip +An M.2 NVMe SSD refers to a solid-state drive that supports the M.2 interface and NVMe protocol. +::: + +## Hardware Requirements + +To install the system without an M.2 NVMe SSD enclosure, you'll need a Radxa ROCK 4D that can boot normally from a MicroSD card. + +**Note: If the MicroSD card doesn't boot properly, please refer to the [Install System to MicroSD Card](../boot_sd) guide to install the system on a MicroSD card first.** + +We'll operate within the system on the MicroSD card and use the `dd` command to install the system to the M.2 NVMe SSD. + +**Note: Booting from an M.2 NVMe SSD requires a PCIe to M.2 M Key HAT.** + +You will need the following hardware: + +- Development board: Radxa ROCK 4D +- MicroSD card with a working system +- M.2 NVMe SSD: Purchase separately +- PCIe to M.2 M Key HAT: Purchase separately +- Power adapter: Type-C power adapter (PD protocol supported, 5V input, 3A or higher current recommended) + +:::tip +The Radxa ROCK 4D motherboard only supports 5V power input. A current of 3A or higher is recommended to ensure stable operation of all peripherals. + +Recommended power supplies: + +- [Radxa PD 30W Power Adapter (Recommended)](https://radxa.com/products/accessories/power-pd-30w) +- Standard Type-C power adapter (5V input, PD protocol supported, 3A or higher current recommended) + ::: + +## Reinstalling the System + +Reinstalling the system will format the M.2 NVMe SSD. Please back up any important data in advance. + +### Download System Image + +Download the Radxa ROCK 4D system image to your device: You can use the `wget` command to download the file to the current directory. The download link can be copied from the [Resource Downloads](../../../download) page. + +:::tip +You can also transfer the system image to your Radxa ROCK 4D using other methods like FTP or SCP. +::: + + +``` +# Install wget if not already installed +sudo apt-get install wget +# Download system image file +wget [URL] +``` + +- wget: Downloads files. Replace [URL] with the actual download link. + +### Hardware Connection + +1. Install the M.2 NVMe SSD onto the PCIe to M.2 M Key HAT +2. Install the PCIe to M.2 M Key HAT onto the Radxa ROCK 4D +3. Connect the power to the Radxa ROCK 4D + +
+ +
+ +### Installing the System Image + +#### Writing the System Image to M.2 NVMe SSD + +Use the following command to extract the compressed system image and write it directly to the M.2 NVMe SSD. Modify the filename according to the actual system image you downloaded. + + +``` +sudo xzcat ~/radxa-rk3576_bookworm_kde_t2.output_512.img.xz | sudo dd of=/dev/nvme0n1 bs=1M status=progress +``` + + +- xzcat: Decompresses the xz-format system image file +- dd: Copies and writes to the M.2 NVMe SSD device (⚠️Warning: Double-check the device name before using dd as incorrect device names may cause data loss) +- of=/dev/nvme0n1: Specifies the target device as nvme0n1 (modify according to your actual device) +- bs=1M: Sets the block size to 1M for faster writing +- status=progress: Shows the writing progress + +#### Verifying the Write Result + +After writing is complete, you can verify that the partition table on the M.2 NVMe SSD was created correctly: + + +``` +sudo fdisk -l /dev/nvme0n1 +``` + + +If successful, you should see partition information similar to the following: + + +``` +Disk /dev/nvme0n1: 465.76 GiB, 500107862016 bytes, 976773168 sectors +Disk model: Samsung SSD 980 500GB +Units: sectors of 1 * 512 = 512 bytes +Sector size (logical/physical): 512 bytes / 512 bytes +I/O size (minimum/optimal): 16384 bytes / 131072 bytes +Disklabel type: gpt +Disk identifier: 9ABAF4B4-329B-41A8-908A-088211D43542 + +Device Start End Sectors Size Type +/dev/nvme0n1p1 32768 65535 32768 16M Linux filesystem +/dev/nvme0n1p2 65536 679935 614400 300M EFI System +/dev/nvme0n1p3 679936 15620800 14940865 7.1G EFI System +``` + + + +## System Information + +When using our provided system image, you'll need to log in with the following default credentials on first boot: + +- Debian Linux + +Username: radxa + +Password: radxa + +## Booting the System + +After completing the system image installation: + +1. Shut down the system: `sudo shutdown -h now` +2. Disconnect power from the Radxa ROCK 4D +3. Remove the MicroSD card +4. Reconnect power to the Radxa ROCK 4D +5. Wait for the system to boot from the M.2 NVMe SSD + +
+ +
+ +When the system boots, both the blue and green LEDs will light up simultaneously. After a few seconds, the green LED will stay lit while the blue LED will blink, indicating that the system has successfully booted. + +## Verifying the System + +After the system boots, you can check the system partition information using the `lsblk` command: + + +``` +sudo lsblk +``` + + +If you see `/dev/nvme0n1p3` mounted as the root directory `/`, it means the system has successfully booted from the M.2 NVMe SSD. + + +``` +mtdblock0 31:0 0 16M 0 disk +zram0 253:0 0 1.9G 0 disk [SWAP] +nvme0n1 259:0 0 465.8G 0 disk +├─nvme0n1p1 259:1 0 16M 0 part /config +├─nvme0n1p2 259:2 0 300M 0 part /boot/efi +└─nvme0n1p3 259:3 0 465.4G 0 part / +``` + + +:::tip + +If you encounter issues during the boot process, try the following solutions: + +- System fails to boot: + + - Try reinstalling the M.2 NVMe SSD and boot again + - Try [downloading and flashing the latest SPI boot firmware](../boot_start) + - Try reinstalling the system to the M.2 NVMe SSD + +- System boots but cannot log in: + - Default username: radxa, password: radxa + - If the password is incorrect, redownload the system image and reinstall to the M.2 NVMe SSD + ::: diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/nvme-system/nvme_reader.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/nvme-system/nvme_reader.md new file mode 100644 index 000000000..7d38dad6d --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/nvme-system/nvme_reader.md @@ -0,0 +1,214 @@ +--- +sidebar_position: 1 +--- + +# Using an M.2 NVMe SSD Enclosure + +This tutorial is for users who have an M.2 NVMe SSD enclosure. It explains how to install the system on an M.2 NVMe SSD using the enclosure. + +:::tip +An M.2 NVMe SSD refers to a solid-state drive that supports the M.2 interface and NVMe protocol. +::: + +## Hardware Requirements + +Using an SSD enclosure to install the system on an M.2 NVMe SSD doesn't require a MicroSD card. Simply insert the M.2 NVMe SSD into the enclosure and use the Etcher software to install the system. + +**Note: Booting from an M.2 NVMe SSD requires a PCIe to M.2 M Key HAT.** + +You will need the following hardware: + +- Development board: Radxa ROCK 4D +- M.2 NVMe SSD: Purchase separately +- M.2 NVMe SSD Enclosure: Purchase separately +- PCIe to M.2 M Key HAT: Purchase separately +- Power adapter: Type-C power adapter (PD protocol supported, 5V input, 3A or higher current recommended) + +:::tip +The Radxa ROCK 4D motherboard only supports 5V power input. A current of 3A or higher is recommended to ensure stable operation of all peripherals. + +Recommended power supplies: + +- [Radxa PD 30W Power Adapter (Recommended)](https://radxa.com/products/accessories/power-pd-30w) +- Standard Type-C power adapter (5V input, PD protocol supported, 3A or higher current recommended) + ::: + +## Reinstalling the System + +Reinstalling the system will format the M.2 NVMe SSD. Please back up any important data in advance. + +### Download System Image + +On your PC, visit the [Resource Downloads](../../../download) page, find the system image file for M.2 NVMe SSD, download and extract it. + +After downloading, you'll get a `*.img` file, which is the system image file to be written to the M.2 NVMe SSD. + +:::tip +The downloaded system image is a compressed file that needs to be extracted before it can be installed to the M.2 NVMe SSD using the image burning software. If you try to burn the compressed file directly to the M.2 NVMe SSD, the system installation or boot may fail. +::: + +### Hardware Connection + +Insert the M.2 NVMe SSD into the SSD enclosure, then connect the enclosure to your PC's USB port. + +
+ +
+ +### Installing the System Image + +Use the open-source image burning tool Etcher to write the system image file to the M.2 NVMe SSD. + +#### Downloading Etcher + +Go to the official Balena Etcher website and download the software for your platform: balenaEtcher. + +
+ +
+ +Download the appropriate software package for your system platform and architecture. + +
+ +
+ +#### Using Etcher + +After downloading, double-click to open the Etcher application. + +:::tip + +- Windows + +The downloaded file is an `*.exe` installer. Double-click to run the program. + +- Linux + +It's recommended to download the `*.zip` archive. After extraction, double-click the program to run it. + +- macOS + +Download the appropriate `*.dmg` file for your system architecture. Double-click to open it, then drag the application to the Applications folder to install. After installation, double-click the application icon to run it. + +::: + +
+ +
+ +#### Installing the System Image + +1. Select the Image File + +Click the `Flash from file` option and select the system image file you downloaded and extracted earlier. + +
+ +
+ +2. Select the Target Device + +Click the `Select target` option and choose the storage device where you want to install the system image. + +:::danger +Be careful not to select the wrong storage device, as Etcher will format the selected device, which could result in data loss! + +You can plug and unplug storage devices to observe changes in the available devices to help identify the correct target device. +::: + +
+ +
+ +① : Select the storage device where you want to install the system image + +② : Click the `Select 1` option to confirm your device selection + +
+ +
+ +3. Install the System Image + +Click the `Flash` option and wait for the software to automatically install and verify the system image. + +
+ +
+ +
+Waiting for system installation to complete + +
+ +
+Waiting for system verification to complete + + After successfully installing the system image, close the Etcher software! +
+ +## System Information + +When using our provided system image, you'll need to log in with the following default credentials on first boot: + +- Debian Linux + +Username: radxa + +Password: radxa + +## Booting the System + +After completing the system image installation: + +1. Remove the M.2 NVMe SSD from the M.2 SSD enclosure +2. Remove any MicroSD card from the Radxa ROCK 4D +3. Install the M.2 NVMe SSD onto the PCIe to M.2 M Key HAT +4. Install the PCIe to M.2 M Key HAT onto the Radxa ROCK 4D +5. Connect power to the Radxa ROCK 4D +6. Wait for the system to boot from the M.2 NVMe SSD + +When the system boots, both the blue and green LEDs will light up simultaneously. After a few seconds, the green LED will stay lit while the blue LED will blink, indicating that the system has successfully booted. + +
+ +
+ +## Verifying the System + +After the system boots, you can check the system partition information using the `lsblk` command: + + +``` +sudo lsblk +``` + + +If you see `/dev/nvme0n1p3` mounted as the root directory `/`, it means the system has successfully booted from the M.2 NVMe SSD. + + +``` +mtdblock0 31:0 0 16M 0 disk +zram0 253:0 0 1.9G 0 disk [SWAP] +nvme0n1 259:0 0 465.8G 0 disk +├─nvme0n1p1 259:1 0 16M 0 part /config +├─nvme0n1p2 259:2 0 300M 0 part /boot/efi +└─nvme0n1p3 259:3 0 465.4G 0 part / +``` + + +:::tip + +If you encounter issues during the boot process, try the following solutions: + +- System fails to boot: + + - Try reinstalling the M.2 NVMe SSD and boot again + - Try [downloading and flashing the latest SPI boot firmware](../boot_start) + - Try reinstalling the system to the M.2 NVMe SSD + +- System boots but cannot log in: + - Default username: radxa, password: radxa + - If the password is incorrect, redownload the system image and reinstall to the M.2 NVMe SSD + ::: diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/ufs-system/README.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/ufs-system/README.md new file mode 100644 index 000000000..fe766dc5c --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/ufs-system/README.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 2 +--- + +# Installing System to UFS Module + +Compared to MicroSD cards, UFS modules offer faster read/write speeds, making them an excellent choice for users looking to improve system performance and boot times. + +We provide two methods to install the system on a UFS module: + +- For users with a Radxa eMMC/UFS combo module reader: Write the system image directly from your PC using the Radxa eMMC/UFS combo module reader. + +- For users without a Radxa eMMC/UFS combo module reader: Boot the system from a MicroSD card and use the `dd` command to install the system image to the UFS module. + +For more information about the Radxa eMMC/UFS combo module reader, please refer to the [Radxa eMMC/UFS Combo Module Reader page](https://radxa.com/products/accessories/emmc-ufs-module-reader). + +### [Using Radxa eMMC/UFS Combo Module Reader](/rock4/rock4d/getting-started/install-system/ufs-system/ufs_reader) + +This guide explains how to install and boot the system when you have a Radxa eMMC/UFS combo module reader. + +### [Not Using Radxa eMMC/UFS Combo Module Reader](/rock4/rock4d/getting-started/install-system/ufs-system/no_ufs_reader) + +This guide explains how to install and boot the system without using a Radxa eMMC/UFS combo module reader. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/ufs-system/no_ufs_reader.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/ufs-system/no_ufs_reader.md new file mode 100644 index 000000000..299d0b884 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/ufs-system/no_ufs_reader.md @@ -0,0 +1,192 @@ +--- +sidebar_position: 2 +--- + +# Not Using Radxa eMMC/UFS Combo Module Reader + +This guide is for users who don't have a Radxa eMMC/UFS combo module reader. It explains how to install the system to a UFS module using a MicroSD card as the boot medium. + +## Hardware Requirements + +To install the system on a UFS module without a Radxa eMMC/UFS combo module reader, you'll need a Radxa ROCK 4D that can boot normally from a MicroSD card. + +We'll be working within the system on the MicroSD card and use the `dd` command to install the system to the UFS module. + +Note: If you encounter issues booting from the MicroSD card, please refer to the [Install System to MicroSD Card](../boot_sd) guide first to install the system on a MicroSD card. + +**You will need the following hardware:** + +- Development board: Radxa ROCK 4D +- [UFS Module](https://radxa.com/products/accessories/ufs-module) +- MicroSD card with a working system +- Power adapter: Type-C power adapter (PD protocol supported, 5V input, 3A or higher current recommended) + +:::tip +The Radxa ROCK 4D motherboard only supports 5V power input. A current of 3A or higher is recommended to ensure stable operation of all peripherals. + +Recommended power supplies: + +- [Radxa PD 30W Power Adapter (Recommended)](https://radxa.com/products/accessories/power-pd-30w) +- Standard Type-C power adapter (5V input, PD protocol supported, 3A or higher current recommended) + ::: + +## System Installation + +Installing the system will format the UFS module. Please back up any important data in advance. + +### Download System Image + +Download the Radxa ROCK 4D system image to your Radxa ROCK 4D board: You can use the `wget` command to download the file to the current directory. The download link can be copied from the [Resource Downloads](../../../download) page. + +:::tip +You can also transfer the system image to your Radxa ROCK 4D using other methods like FTP or SCP. +::: + + +``` +# Install wget if not already installed +sudo apt-get install wget +# Download system image file +wget [URL] +``` + +- wget: Downloads files. Replace [URL] with the actual download link. + +### Hardware Connection + +Install the UFS module into the eMMC/UFS module interface on the motherboard, then power on the system using a 5V Type-C power adapter. + +
+ +
+ +:::caution + +UFS Module Installation Steps: + +1. Ensure the notch on the UFS module aligns with the eMMC/UFS module interface on the Radxa ROCK 4D +2. Make sure the slot interface at the bottom of the UFS module is properly aligned with the eMMC/UFS module interface on the Radxa ROCK 4D +3. Gently press down on one end of the UFS module until you hear a click, then repeat for the other end to ensure the UFS module is properly installed. + ::: + +### Installing the System Image + +#### Writing the System Image to UFS Module + +Use the following command to extract the compressed system image and write it directly to the UFS module. Modify the filename according to the actual system image you downloaded. + + +``` +sudo xzcat ~/radxa-rk3576_bookworm_kde_b1.output_4096.img.xz | sudo dd of=/dev/sda bs=1M status=progress +``` + + +- xzcat: Decompresses the xz-format system image file +- dd: Copies and writes to the UFS module (⚠️Warning: Double-check the device name before using dd as incorrect device names may cause data loss) +- of=/dev/sda: Specifies the target device as sda (modify according to your actual device) +- bs=1M: Sets the block size to 1M for faster writing +- status=progress: Shows the writing progress + +#### Verifying the Write Result + +After writing is complete, you can verify that the partition table on the UFS module was created correctly: + + +``` +sudo fdisk -l /dev/sda +``` + + +If successful, you should see partition information similar to the following: + + +``` +Disk /dev/sda: 119.15 GiB, 127934660608 bytes, 31234048 sectors +Disk model: KLUDG4UHDC-B0E1 +Units: sectors of 1 \* 4096 = 4096 bytes +Sector size (logical/physical): 4096 bytes / 4096 bytes +I/O size (minimum/optimal): 524288 bytes / 524288 bytes +Disklabel type: gpt +Disk identifier: 33349998-C3CC-40F0-B818-DDDD8383A64D + +Device Start End Sectors Size Type +/dev/sda1 32768 65535 32768 128M Linux filesystem +/dev/sda2 65536 679935 614400 2.3G EFI System +/dev/sda3 679936 31234014 30554079 116.6G EFI System +``` + + + +## System Information + +When using our provided system image, you'll need to log in with the following default credentials on first boot: + +- Debian Linux + +Username: radxa + +Password: radxa + +## Booting the System + +After completing the system image installation: + +1. Shut down the system: `sudo shutdown -h now` +2. Disconnect power from the Radxa ROCK 4D +3. Remove the MicroSD card +4. Reconnect the power +5. Wait for the system to boot from the UFS module + +
+ +
+ +:::caution + +UFS Module Installation Steps: + +1. Ensure the notch on the UFS module aligns with the eMMC/UFS module interface on the Radxa ROCK 4D +2. Make sure the slot interface at the bottom of the UFS module is properly aligned with the eMMC/UFS module interface on the Radxa ROCK 4D +3. Gently press down on one end of the UFS module until you hear a click, then repeat for the other end to ensure the UFS module is properly installed. + ::: + +When the system boots, both the blue and green LEDs will light up simultaneously. After a few seconds, the green LED will stay lit while the blue LED will blink, indicating that the system has successfully booted. + +## Verifying the System + +After the system boots, you can check the system partition information using the `lsblk` command: + + +``` +sudo lsblk +``` + + +If you see `/dev/sda3` mounted as the root directory `/`, it means the system has successfully booted from the UFS module. + + +``` +NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS +sda 8:0 0 119.1G 0 disk +├─sda1 8:1 0 128M 0 part /config +├─sda2 8:2 0 2.3G 0 part /boot/efi +└─sda3 8:3 0 116.6G 0 part / +mtdblock0 31:0 0 16M 0 disk +zram0 253:0 0 1.9G 0 disk [SWAP] +``` + + +:::tip + +If you encounter issues during the boot process, try the following solutions: + +- System fails to boot: + + - Try reinstalling the UFS module and booting again + - Try [downloading and flashing the latest SPI boot firmware](../boot_start) + - Try reinstalling the system to the UFS module + +- System boots but cannot log in: + - Default username: radxa, password: radxa + - If the password is incorrect, redownload the system image and reinstall to the UFS module + ::: diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/ufs-system/ufs_reader.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/ufs-system/ufs_reader.md new file mode 100644 index 000000000..8de9b04e2 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/install-system/ufs-system/ufs_reader.md @@ -0,0 +1,225 @@ +--- +sidebar_position: 1 +--- + +# Using Radxa eMMC/UFS Combo Module Reader + +This tutorial is for users who have a Radxa eMMC/UFS combo module reader. It explains how to install the system on a UFS module using the Radxa eMMC/UFS combo module reader. + +## Hardware Requirements + +Using the Radxa eMMC/UFS combo module reader to install the system doesn't require a MicroSD card. Simply insert the UFS module into the eMMC/UFS module reader and use the Etcher software to install the system to the UFS module. + +**You will need the following hardware:** + +- Development board: Radxa ROCK 4D +- [UFS Module](https://radxa.com/products/accessories/ufs-module) +- [Radxa eMMC/UFS Combo Module Reader](https://radxa.com/products/accessories/emmc-ufs-module-reader) +- Power adapter: Type-C power adapter (PD protocol supported, 5V input, 3A or higher current recommended) + +:::tip +The Radxa ROCK 4D motherboard only supports 5V power input. A current of 3A or higher is recommended to ensure stable operation of all peripherals. + +Recommended power supplies: + +- [Radxa PD 30W Power Adapter (Recommended)](https://radxa.com/products/accessories/power-pd-30w) +- Standard Type-C power adapter (5V input, PD protocol supported, 3A or higher current recommended) + ::: + +## Installing the System + +Installing the system will format the UFS module. Please back up any important data in advance. + +### Download System Image + +On your PC, visit the [Resource Downloads](../../../download) page and find the system image for the UFS module. + +After downloading, extract the system image file. The resulting `*.img` file is the system image file to be written to the UFS module. + +:::tip +The downloaded system image is a compressed file that needs to be extracted before it can be installed to the UFS module using the image burning software. If you try to burn the compressed file directly to the UFS module, the system installation or boot may fail. +::: + +### Hardware Connection + +Insert the UFS module into the Radxa eMMC/UFS combo module reader, then connect the reader to your PC's USB port. + +
+ +
+ +:::caution + +UFS Module Installation Steps: + +1. Ensure the notch on the UFS module aligns with the reader's interface direction +2. Make sure the slot interface at the bottom of the UFS module is properly aligned with the Radxa eMMC/UFS combo module reader's interface +3. Gently press down on one end of the UFS module until you hear a click, then repeat for the other end to ensure the UFS module is properly installed. + ::: + +### Installing the System Image + +Use the open-source image burning tool Etcher to write the system image file to the UFS module. + +#### Downloading Etcher + +Go to the official Balena Etcher website and download the software for your platform: [balenaEtcher](https://etcher.balena.io) + +
+ +
+ +Download the appropriate software package for your system platform and architecture. + +
+ +
+ +#### Using Etcher + +After downloading, double-click to open the Etcher application. + +:::tip + +- Windows + +The downloaded file is an `*.exe` installer. Double-click to run the program. + +- Linux + +It's recommended to download the `*.zip` archive. After extraction, double-click the program to run it. + +- macOS + +Download the appropriate `*.dmg` file for your system architecture. Double-click to open it, then drag the application to the Applications folder to install. After installation, double-click the application icon to run it. + +::: + +
+ +
+ +#### Installing the System Image + +1. Select the Image File + +Click the `Flash from file` option and select the system image file you downloaded and extracted earlier. + +
+ +
+ +2. Select the Target Device + +Click the `Select target` option and choose the storage device where you want to install the system image. + +:::danger +Be careful not to select the wrong storage device, as Etcher will format the selected device, which could result in data loss! + +You can plug and unplug storage devices to observe changes in the available devices to help identify the correct target device. +::: + +
+ +
+ +① : Select the storage device where you want to install the system image + +② : Click the `Select 1` option to confirm your device selection + +
+ +
+ +3. Install the System Image + +Click the `Flash` option and wait for the software to automatically install and verify the system image. + +
+ +
+ +
+Waiting for system installation to complete + +
+ +
+Waiting for system verification to complete + + After successfully installing the system image, close the Etcher software! +
+ +## System Information + +When using our provided system image, you'll need to log in with the following default credentials on first boot: + +- Debian Linux + +Username: radxa + +Password: radxa + +## Booting the System + +After completing the system image installation: + +1. Remove the UFS module from the Radxa eMMC/UFS combo module reader +2. Remove any MicroSD card from the Radxa ROCK 4D +3. Install the UFS module onto the eMMC/UFS module interface of the Radxa ROCK 4D +4. Connect power to the Radxa ROCK 4D +5. Wait for the system to boot from the UFS module + +
+ +
+ +:::caution + +UFS Module Installation Steps: + +1. Ensure the notch on the UFS module aligns with the eMMC/UFS module interface on the Radxa ROCK 4D +2. Make sure the slot interface at the bottom of the UFS module is properly aligned with the eMMC/UFS module interface on the Radxa ROCK 4D +3. Gently press down on one end of the UFS module until you hear a click, then repeat for the other end to ensure the UFS module is properly installed. + ::: + +When the system boots, both the blue and green LEDs will light up simultaneously. After a few seconds, the green LED will stay lit while the blue LED will blink, indicating that the system has successfully booted. + +## Verifying the System + +After the system boots, you can check the system partition information using the `lsblk` command: + + +``` +sudo lsblk +``` + + +If you see `/dev/sda3` mounted as the root directory `/`, it means the system has successfully booted from the UFS module. + + +``` +NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINTS +sda 8:0 0 119.1G 0 disk +├─sda1 8:1 0 128M 0 part /config +├─sda2 8:2 0 2.3G 0 part /boot/efi +└─sda3 8:3 0 116.6G 0 part / +mtdblock0 31:0 0 16M 0 disk +zram0 253:0 0 1.9G 0 disk [SWAP] +``` + + +:::tip + +If you encounter issues booting from the UFS module, please try the following solutions: + +- System cannot boot: + + - Try reinserting the UFS module and booting the system + - Try [downloading and burning the latest SPI boot firmware](../boot_start) + - Try reinstalling the system to the UFS module + +- System can boot but cannot log in: + - Default username: radxa, password: radxa + - If the password is incorrect, download the system image and reinstall the system to the UFS module + ::: diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/quickly_start.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/quickly_start.md new file mode 100644 index 000000000..56a98908f --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/getting-started/quickly_start.md @@ -0,0 +1,378 @@ +--- +sidebar_position: 2 +--- + +# Quickly Start + +The purpose of this chapter is to help you quickly use Radxa ROCK 4D. You can follow this tutorial. + +## Product + +
+ Radxa ROCK 4D front + + Radxa ROCK 4D back + +
+ +## Prerequisites + +### Hardware Devices + +You need to prepare the following hardware devices in advance to complete all operations in the quickly starting tutorial. + +- Development board: Radxa ROCK 4D +- System startup medium: MicroSD card +- USB serial data line (optional): used for serial debugging and login +- Display (optional): HDMI display and HDMI data line +- Power adapter: Type-C power adapter (support PD protocol, 5V power input, recommended current 3A above) + +**Note**: Users need to choose between USB serial data line and display, we recommend using display to use and develop Rock 4D. + +:::tip +For users with different development capabilities, we suggest adding the following accessories to use Radxa ROCK 4D, which will shorten the time to become familiar with the product and development. + +- **Beginner** + +Prepare accessories: power adapter, system startup medium, display, HDMI data line + +- **Developer** + +Prepare accessories: power adapter, system startup medium, debugging data line (USB serial data line) + +**Note**: The display can display the system interface and perform graphic operations! +::: + +### Mainboard Power Supply + +Radxa ROCK 4D mainboard supports Type-C and GPIO power supply, we recommend using Type-C power adapter power supply, please ensure that the power adapter can provide 5V power input and be compatible with PD protocol. + +:::tip +Radxa ROCK 4D mainboard only supports 5V power input, it is recommended to use a current of 3A above to ensure stable operation of all peripherals. + +Reference power: + +- [Radxa 30W PD Power Adapter (Recommended)](https://radxa.com/products/accessories/power-pd-30w) + +- Standard Type-C Power Adapter (5V power input, PD protocol supported, recommended current 3A above) + ::: + +### System Startup Medium + +Radxa ROCK 4D supports MicroSD card, NVME, UFS startup, but the quick start tutorial only introduces MicroSD card startup. + +### Serial Debug + +Radxa ROCK 4D mainboard supports serial debugging through USB serial data line, you need to connect the USB serial data line to the Radxa ROCK 4D's UART0_TX, UART0_RX and GND pins. + +## Write System Image + +You need to download the system image file to be written on the PC and burn it to the MicroSD card. + +### Download System Image + +Access the [Resource Download Summary](../download) page on the PC, download the system image compression package corresponding to Radxa ROCK 4D, decompress the system image compression package after downloading, and the `*.img` file obtained is the system image file to be written to the MicroSD card. + +:::tip +The downloaded system image is a compressed file that needs to be extracted before being written to the SD card using the image burning software. Writing the compressed file directly to the SD card may result in write failure or boot failure. +::: + +### Writing the System Image + +Insert the MicroSD card into a card reader, then connect the card reader to a USB port on your PC. + +
+ +
+ +- **Image Burning Software: Balena Etcher** + +We recommend using Balena Etcher, an open-source image burning tool developed by Radxa's partner Balena. This software is user-friendly, powerful, and supports Windows, Linux, and macOS. + +Download the software from the official website: [balenaEtcher](https://etcher.balena.io) + +
+ +
+ +On the download page, select the appropriate platform to download the Etcher software. + +
+ +
+ +:::tip +For Windows and Linux, you can run the program directly without installation! +::: + +
+ +
+ +- Installing the System Image + +1. Select the system image for your board: Click the `Flash from file` option and choose the system image file you downloaded and extracted earlier. + +
+ +
+ +2. Select the disk corresponding to your MicroSD card: Click the `Select target` option and choose the disk device that corresponds to your card reader connected to the PC. + +:::danger +Be careful not to select the wrong disk, as Etcher will format the selected disk, potentially causing data loss! +::: + +
+ +
+ +① : Select the disk device where you want to install the system image + +② : Click the `Select 1` option to confirm device selection + +
+ +
+ +3. Start writing the system image: Click the `Flash` option and wait for the software to automatically write and verify the system image. + +
+ +
+ +
+Waiting for system write to complete + +
+ +
+Waiting for system verification to complete + +
+ +4. After successfully writing the system image, close the Etcher software! + +## System Information + +When using our provided system image for the first time, you will need to log in with the following default credentials: + +- Debian Linux + +Username: radxa + +Password: radxa + +## Booting the System + +After writing the system image to the MicroSD card, insert the card into the Radxa ROCK 4D's MicroSD card slot, then power on the system using a 5V Type-C power adapter. + +After powering on, both the blue and green LED indicators will light up. After a few seconds, the green LED will stay on while the blue LED will blink, indicating that the system has booted successfully. + +Usage recommendations: + +1. If you have a display, after starting the Radxa ROCK 4D, you can connect it to the display using an HDMI cable to view the system interface directly. + +2. If you don't have a display, you can use a serial debugging tool to view the system output, confirm whether the system has booted successfully, and log in to use the Radxa ROCK 4D. + +## Serial Console Login + +:::tip + +- Radxa ROCK 4D Serial Port Parameters + +Baud Rate: 1500000 + +Data Bits: 8 + +Stop Bits: 1 + +No Parity + +::: + +- Hardware Connection + +:::danger +When using a USB to UART cable for serial debugging with Radxa ROCK 4D, make sure the pins are connected correctly to avoid damaging the board. +::: + +Connect the USB end of the USB to UART cable to your PC, and connect the other end to the GPIO UART pins on the Radxa ROCK 4D. + +| Number | Pin Function | Connection Method | +| ------ | ------------------------------------- | ---------------------------------------- | +| ① | Radxa ROCK 4D : GND（Pin6） | Connect to GND pin of USB to UART cable | +| ② | Radxa ROCK 4D : UART0_TX（Pin8） | Connect to RX pin of USB to UART cable | +| ③ | Radxa ROCK 4D : UART0_RX（Pin10） | Connect to TX pin of USB to UART cable | +| ④ | USB to UART cable : GND（Black wire） | Connect to GND pin of Radxa ROCK 4D | +| ⑤ | USB to UART cable : RX（White wire） | Connect to UART0_TX pin of Radxa ROCK 4D | +| ⑥ | USB to UART cable : TX（Green wire） | Connect to UART0_RX pin of Radxa ROCK 4D | +| ⑦ | USB to UART cable : VCC（Red wire） | Do not connect | + +
+ Pin Description and Connection Diagram + +
+ + + + + +For Windows, we recommend using PuTTY for serial console login to the Radxa ROCK 4D system. + +- Using PuTTY + +After connecting the Radxa ROCK 4D to your PC via USB-to-UART cable, you can check the corresponding COM port in the Device Manager (in the example, COM4 is the port assigned to the Radxa ROCK 4D). + +
+ +
+ +:::tip + +If the system fails to recognize the device or shows an exclamation mark, you'll need to install the [CH340 driver](https://www.wch.cn/downloads/CH341SER_EXE.html) manually and restart your system after installation. + +::: + +- Serial Port Login Options + +① --> Connection type: Select `Serial` + +② --> Serial line: Enter `COM4` (or your specific COM port number as shown in Device Manager) + +③ --> Speed: Enter `1500000` + +④ --> Click Open to connect to the Radxa ROCK 4D system via serial + +
+ +
+ +- Logging In + +Press Enter in the terminal to see the login prompt, then enter the username and password for your system. + +Note: The password won't be displayed as you type. Press Enter after entering your password. + +
+ +
+ + + + + +For Linux, we recommend using the Screen utility for serial console login to the Radxa ROCK 4D system. + +- Install Screen + + +``` +sudo apt update +sudo apt install screen +``` + + +- Find Serial Device + +Open a terminal and use the ls command to list serial devices: + +If your PC has only one serial device, it will typically be ttyUSB0. + +If your PC has multiple serial devices, you can plug and unplug the USB device while running the following command to identify the correct device. + + +``` +ls /dev/ttyUSB* +``` + + +- Serial Port Login Options + +To connect using Screen, you only need to specify the serial port and baud rate. + + +``` +sudo screen /dev/ttyUSB0 1500000 +``` + + +- Logging In + +Press Enter in the terminal to see the login prompt, then enter the username and password for your system. + +Note: The password won't be displayed as you type. Press Enter after entering your password. + + + + + +For macOS, we recommend using the Screen utility for serial console login to the Radxa ROCK 4D system. + +:::tip + +If your system fails to recognize the device, you'll need to install the [CH340 driver](https://www.wch.cn/downloads/CH341SER_MAC_ZIP.html) manually and restart your system after installation. + +::: + +- Find Serial Device + +Open Terminal and use the ls command to list serial devices: + +Look for a device name similar to /dev/tty.wchusbserial14xx0. If your Mac has multiple serial devices, you can plug and unplug the USB device while running the following command to identify the correct device. + + +``` +ls /dev/tty.* +``` + + +- Serial Port Login Options + +To connect using Screen, you only need to specify the serial port and baud rate. + + +``` +screen /dev/tty.wchusbserial14xx0 1500000 +``` + + +- Logging In + +Press Enter in the terminal to see the login prompt, then enter the username and password for your system. + +Note: The password won't be displayed as you type. Press Enter after entering your password. + + + + + +## System Usage + +### With Display + +If you're using Radxa ROCK 4D with a display, the system usage becomes straightforward as you can operate it through the graphical interface shown on the display. + +### Without Display + +If you're using Radxa ROCK 4D with only a USB-to-UART cable, you can operate the system through serial console. + +:::tip +For users operating without a display, here are some recommendations to help you get started quickly: + +1. **Network Configuration** + + Simply connect an Ethernet cable to your Radxa ROCK 4D to ensure network connectivity. + +2. **Serial Debugging** + + Use [serial debugging](../system-config/uart_debug) to view system output, including IP addresses and boot messages. + +3. **SSH Remote Access** + + Configure [SSH remote access](../system-config/ssh-remote) to log in to your system without needing the USB-to-UART cable. + +4. **VNC Remote Access** + + If your system has a graphical interface, set up [VNC remote access](../system-config/vnc-remote) to view and control the desktop environment without a physical display. + ::: diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/hardware-info/README.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/hardware-info/README.md new file mode 100644 index 000000000..4da0e8172 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/hardware-info/README.md @@ -0,0 +1,11 @@ +--- +sidebar_position: 13 +--- + +# Hardware Information + +This article mainly introduces the hardware information of Radxa ROCK 4D. + +### [Interface Information](/rock4/rock4d/hardware-info/interface_info) + +This article mainly introduces the hardware information of Radxa ROCK 4D, including the chip frame diagram of the mainboard, the system frame diagram, and the interface usage. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/hardware-info/interface_info.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/hardware-info/interface_info.md new file mode 100644 index 000000000..d18943e7b --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/hardware-info/interface_info.md @@ -0,0 +1,180 @@ +--- +sidebar_position: 3 +--- + +# Interface Information + +## Chip Block Diagram + +
+ +
+ +## System Block Diagram + +
+ +
+ +## Interface Specifications + +
+ +
+ +| No. | Description | Qty | +| :-: | :----------------------------- | :-: | +| ① | USB Type-C Power Port | 1 | +| ② | User LED | 1 | +| ③ | Power LED | 1 | +| ④ | Power Button | 1 | +| ⑤ | FPC Connector | 1 | +| ⑥ | WiFi6 and Bluetooth 5.4 | 1 | +| ⑦ | External Antenna Connector | 1 | +| ⑧ | 40 Pin GPIO | 1 | +| ⑨ | LPDDR5 Memory | 1 | +| ⑩ | PoE Port | 1 | +| ⑪ | Maskrom Button | 1 | +| ⑫ | USB 2.0 Type-A | 2 | +| ⑬ | Rockchip RK3576 (J) | 1 | +| ⑭ | USB 3.0 Type-A | 2 | +| ⑮ | SPI NOR Flash | 1 | +| ⑯ | Gigabit Ethernet (PoE Support) | 1 | +| ⑰ | Fan Connector | 1 | +| ⑱ | Headphone Jack | 1 | +| ⑲ | MIPI CSI Connector | 1 | +| ⑳ | HDMI 2.1 Port | 1 | +| ㉑ | Recovery Port | 1 | +| ㉒ | UFS Module Connector | 1 | +| ㉓ | RTC Connector | 1 | +| ㉔ | eMMC Module Connector | 1 | +| ㉕ | MIPI CSI Connector | 1 | +| ㉖ | MicroSD Card Slot | 1 | +| ㉗ | MIPI DSI Connector | 1 | + +## Interface Usage + +Mainly introduce the interfaces that can be expanded on Radxa ROCK 4D. + +### 40 Pin GPIO + +Support external expansion of the GPIO pins on the board, supporting UART, SPI, I2C, I2S, PWM, CAN, ADC, etc. + +| Function7 | Function6 | Function5 | Function4 | Function3 | Function2 | Function1 | Pin | Pin | Function1 | Function2 | Function3 | Function4 | Function5 | Function6 | Function7 | +| ------------- | ------------ | ----------- | ------------ | ----------- | ------------- | ---------- | --- | --- | ---------- | ----------------- | -------------- | ------------ | ----------- | ------------ | ------------- | +| | | | | | | 3V3 | 1 | 2 | 5V | | | | | | | +| | PDM0_SDI1_M2 | | | I2C8_SDA_M1 | UART2_RX_M0 | GPIO1_C7_d | 3 | 4 | 5V | | | | | | | +| | PDM0_SDI0_M2 | | | I2C8_SCL_M1 | UART2_TX_M0 | GPIO1_C6_d | 5 | 6 | GND | | | | | | | +| | | | SPI2_CSN0_M1 | I2C6_SDA_M1 | UART4_CTSN_M1 | GPIO1_C3_u | 7 | 8 | GPIO0_D4_u | UART0_TX_M0_DEBUG | | | | | | +| | | | | | | GND | 9 | 10 | GPIO0_D5_u | UART0_RX_M0_DEBUG | | | | | | +| UART2_RTSN_M0 | | | SPI2_MOSI_M1 | | UART4_TX_M1 | GPIO1_C4_d | 11 | 12 | GPIO1_D1_d | UART10_RX_M1 | I3C0_SDA_PU_M1 | | | SAI2_SCLK_M0 | | +| | | PWM1_CH0_M2 | | | | GPIO2_C0_d | 13 | 14 | GND | | | | | | | +| UART2_CTSN_M0 | | | SPI2_MISO_M1 | | UART4_RX_M1 | GPIO1_C5_d | 15 | 16 | GPIO2_B6_d | UART7_TX_M0 | I2C8_SCL_M2 | | | | | +| | | | | | | 3V3 | 17 | 18 | GPIO2_B7_d | UART7_RX_M0 | I2C8_SDA_M2 | | | | | +| | SAI3_LRCK_M1 | PWM1_CH1_M1 | SPI1_MOSI_M0 | I2C9_SCL_M1 | | GPIO1_B5_d | 19 | 20 | GND | | | | | | | +| | SAI3_SDO_M1 | | SPI1_MISO_M0 | | UART3_CTSN_M2 | GPIO1_B6_d | 21 | 22 | GPIO2_D7_d | | | | PWM2_CH7_M2 | | | +| | SAI3_SCLK_M1 | PWM1_CH0_M1 | SPI1_CLK_M0 | I2C9_SDA_M1 | | GPIO1_B4_d | 23 | 24 | GPIO1_B7_d | | | SPI1_CSN0_M0 | | SAI3_SDI_M1 | UART3_RTSN_M2 | +| | | | | | | GND | 25 | 26 | GPIO1_C0_d | UART3_TX_M2 | | SPI1_CSN1_M0 | PWM0_CH0_M1 | PDM0_SDI2_M2 | | +| CAN1_RX_M1 | SAI4_SCLK_M2 | PWM2_CH3_M1 | | I2C6_SDA_M3 | | GPIO4_C7_d | 27 | 28 | GPIO4_C6_d | | I2C6_SCL_M3 | | PWM2_CH2_M1 | SAI4_SDI_M2 | CAN1_TX_M1 | +| CAN1_TX_M3 | | | | | | GPIO3_A2_d | 29 | 30 | GND | | | | | | | +| PDM0_CLK0_M2 | SAI3_MCLK_M1 | | | | UART3_RX_M2 | GPIO1_C1_d | 31 | 32 | GPIO1_D5_d | UART10_CTSN_M1 | I2C5_SDA_M1 | SPI2_CLK_M1 | | PDM0_CLK1_M2 | | +| | | PWM1_CH2_M1 | SPI2_CSN1_M1 | I2C6_SCL_M1 | UART4_RTSN_M1 | GPIO1_C2_u | 33 | 34 | GND | | | | | | | +| | SAI2_LRCK_M0 | PWM1_CH3_M1 | | I3C0_SCL_M1 | | GPIO1_D2_d | 35 | 36 | GPIO1_D4_d | UART10_RTSN_M1 | I2C5_SCL_M1 | | | SAI2_MCLK_M0 | PDM0_SDI3_M2 | +| CAN1_RX_M3 | | | | | | GPIO3_A3_d | 37 | 38 | GPIO1_D3_d | | I3C0_SDA_M1 | | PWM1_CH4_M1 | SAI2_SDI_M0 | | +| | | | | | | GND | 39 | 40 | GPIO1_D0_d | UART10_TX_M1 | | | | SAI2_SDO_M0 | | + +### USB Type-C Power Port + +Radxa ROCK 4D supports Type-C and GPIO power supply. We recommend using a Type-C power adapter to power it. Please ensure that the power adapter can provide 5V power input and be compatible with PD protocol. + +:::tip +Radxa ROCK 4D only supports 5V power input, it is recommended to use a current of 3A or more to ensure stable operation of all peripherals. + +Reference power: + +- [Radxa PD 30W Power Adapter (Recommended)](https://radxa.com/products/accessories/power-pd-30w) + +- Standard Type-C power adapter (5V power input, PD protocol supported, recommended current 3A or more) + ::: + +### Power Button + +Short press to trigger power-on or power menu, long press to power off. + +### FPC Connector + +Support FPC PCIe expansion interface, can be used to connect expansion accessories. + +### External Antenna Connector + +Support external antenna connection for the board's WiFi6 and Bluetooth 5.4 chips. + +### PoE Port + +Support external PoE power connection for the board's PoE interface. + +### Maskrom Button + +Press the Maskrom button before power-on, and release it after power-on to enter Maskrom mode. + +### USB 2.0 Type-A + +Support two USB 2.0 interfaces, used to connect external devices such as keyboards, mice, storage devices, etc. + +### USB 3.0 Type-A + +Support high-speed USB 3.0 interface, used to connect external devices such as storage devices, network adapters, etc. + +:::tip + +1. You can check if the USB device is recognized by repeatedly plugging and unplugging the USB device, and then inputting the `lsusb` command in the system command line. +2. The upper layer Type-A interface of USB 3.0 supports OTG function. + ::: + +### Gigabit Ethernet Port + +Support 1Gbps Ethernet port (support PoE, need to connect HAT). + +### Fan Connector + +Support 1× 2-pin 1.25mm PWM control fan interface. + +### Headphone Jack + +Support 3.5mm four-segment headphone jack, supporting microphone input. + +### MIPI CSI Connector + +Support MIPI CSI interface, used to connect high-definition cameras. + +### HDMI 2.1 Port + +Support HDMI 2.1 interface, supports high-definition video output, up to 4K@120fps. + +### Recovery Connector + +Short-circuit the Recovery connector to enter Recovery mode. + +### UFS Module Connector + +Support UFS 2.0 interface, used to connect expansion storage devices and boot systems. + +### RTC Connector + +Support RTC real-time clock module interface, can connect RTC module to maintain system time. + +### eMMC 5.1 Connector + +Support eMMC 5.1 interface, used to connect expansion storage devices and boot systems. + +### MIPI CSI Connector + +Support MIPI CSI interface, used to connect high-definition cameras. + +### MicroSD Card Slot + +Support MicroSD card slot, used to connect expansion storage devices and boot systems. + +### MIPI DSI Connector + +Support MIPI DSI interface, used to connect high-definition displays. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/README.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/README.md new file mode 100644 index 000000000..7953b6c97 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/README.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 12 +--- + +# System Usage + +This article mainly introduces the common functions used in the system usage process. + +### [Display Mode](/rock4/rock4d/system-config/display-mode) + +This article mainly introduces how to connect the display and use and develop in the display mode of Radxa Rock 4D. + +### [No Display Mode](/rock4/rock4d/system-config/no-display-mode) + +This article mainly introduces how to use and develop in the no display mode of Radxa Rock 4D. + +### [Serial Debug](/rock4/rock4d/system-config/uart_debug) + +This article mainly introduces the hardware connection and usage method of Radxa Rock 4D serial debugging. + +### [USB Connection](/rock4/rock4d/system-config/usb_connection) + +This article mainly introduces the USB connection method of Radxa Rock 4D. + +### [Network Configuration](/rock4/rock4d/system-config/web-config) + +This article mainly introduces the configuration method of Radxa Rock 4D in the display mode and no display mode. + +### [SSH Remote](/rock4/rock4d/system-config/ssh-remote) + +This article mainly introduces the method of opening and using SSH remote connection of Radxa Rock 4D. + +### [VNC Remote](/rock4/rock4d/system-config/vnc-remote) + +This article mainly introduces the method of opening VNC and using VNC Viewer for remote connection of Radxa Rock 4D. + +### [Rsetup Tool](/rock4/rock4d/system-config/rsetup) + +This article mainly introduces the usage method of Radxa Rock 4D Rsetup tool. diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/display-mode.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/display-mode.md new file mode 100644 index 000000000..c1239ed2e --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/display-mode.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 1 +--- + +# Display Mode + +Display mode refers to connecting Radxa ROCK 4D to a display screen, outputting system images through HDMI, which is suitable for beginner users. + +## Preparation + +Connect the display screen using an HDMI cable and confirm whether the display screen is showing the system image correctly. + +## Control Interface + +Users can easily perform system settings, application management, file management, and other operations by using Radxa ROCK 4D with a display screen. + +
+ +
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/no-display-mode.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/no-display-mode.md new file mode 100644 index 000000000..ba89e8ef7 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/no-display-mode.md @@ -0,0 +1,45 @@ +--- +sidebar_position: 2 +--- + +# No Display Mode + +No display mode refers to using Radxa ROCK 4D without a display screen, controlling the development board through serial port/SSH/VNC, suitable for users with some development experience. + +The control approach: Obtain the IP address of Radxa ROCK 4D through serial port debugging, then configure the corresponding SSH and VNC environment, and further control Radxa ROCK 4D through SSH or VNC remote login. + +:::tip + +- Serial Port Debugging: Refer to the [Serial Port Debugging](./uart_debug) guide for detailed steps +- SSH Remote Login: Refer to the [Remote Login](./ssh-remote) guide for detailed steps +- VNC Remote Login: Refer to the [VNC Remote Login](./vnc-remote) guide for detailed steps + ::: + +## Preparation + +Follow the [Serial Port Debugging](./uart_debug) and [Remote Login](./remote-login) guides to connect Radxa ROCK 4D. + +## Control Interface + +In no display mode, serial port/SSH control is in command-line mode, while VNC control is in graphical interface mode. + +### Command Line Mode + +Serial port control requires a data cable, while SSH control does not require a data cable, it only needs to ensure that the device is on the same local network. + +① : Open Linux terminal and log in to Radxa ROCK 4D through serial port + +② : Open Linux terminal and log in to Radxa ROCK 4D through SSH + +
+ +
+ +### Graphical Interface Mode + +VNC control requires both the control and controlled devices to be on the same local network. + +
+VNC Remote Login Successful + +
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/rsetup.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/rsetup.md new file mode 100644 index 000000000..eebf47e12 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/rsetup.md @@ -0,0 +1,106 @@ +--- +sidebar_position: 9 +--- + +# Rsetup Tool + +Rsetup is a system configuration tool for Radxa OS that helps users easily configure various system settings, including system settings, hardware settings, software settings, network settings, user settings, language settings, and more. + +## Using Rsetup + +Run the `rsetup` command in the terminal to start the Rsetup tool. + +:::tip +Rsetup Usage Guide: + +- Select an option: The corresponding option will be highlighted +- Confirm selection: Press `Enter` +- Cancel selection: Press `ESC` +- Navigate between options: Use `Up`, `Down`, `Left`, `Right` arrow keys +- Multiple selection interface: Press `Space` to select, `Enter` to confirm selection + +::: + + +``` +sudo rsetup +``` + + +## Rsetup Options + +After launching Rsetup, you will see a list of options similar to the following. Note that the interface may vary slightly depending on the version. Please refer to your actual interface. + +
+ +
+ +### System + +The System option is used for system upgrades, modifying boot methods, configuring Bootloader, and more. + +
+ +
+ +:::tip +We recommend using the `System Update` option to upgrade your system and ensure you have the latest version. + +Using the `sudo apt update && sudo apt upgrade` command for system upgrades may result in incomplete updates or system instability. +::: + +### Hardware + +The Hardware option is used to manage onboard hardware, including video capture devices, LED control, GPIO control, and more. + +
+ +
+ +### Overlays + +The Overlays option is used to manage Device Tree Overlays, allowing you to enable or disable specific hardware features. + +
+ +
+ +### Connectivity + +The Connectivity option is used to manage network connections, including wired and wireless network settings. + +
+ +
+ +### User Settings + +The User Settings option is used to manage the current username, password, and configure auto-login. + +
+ +
+ +### Localization + +The Localization option is used to set the system timezone, locale, and WiFi country. + +
+ +
+ +### Common Tasks + +The Common Tasks option is used to perform common system tasks. + +
+ +
+ +### About + +The About option is used to view information about the Rsetup tool. + +
+ +
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/ssh-remote.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/ssh-remote.md new file mode 100644 index 000000000..12e0e9017 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/ssh-remote.md @@ -0,0 +1,96 @@ +--- +sidebar_position: 4 +--- + +# SSH Remote Access + +Remote access allows you to control the board over a network. This tutorial only covers the method of SSH remote control within a local area network (LAN). + +Users without a display can configure SSH remote access by following the [UART Debug](./uart_debug) method to run the commands below. + +:::tip +Ensure both devices are on the same local area network: + +1. Verify that both devices have IP addresses on the same subnet. +2. Test connectivity by running `ping` between the devices using their IP addresses. + ::: + +## Install OpenSSH + +SSH remote control requires the OpenSSH server. Run the following commands in the terminal of your Radxa ROCK 4D to install it: + + +``` +sudo apt update +sudo apt install openssh-server -y +``` + + +## Start SSH Service + +Run the following command in the terminal of your Radxa ROCK 4D to start the SSH service: + + +``` +sudo systemctl start ssh +``` + + +## Enable SSH Service at Boot + +Run the following command in the terminal of your Radxa ROCK 4D to enable the SSH service to start automatically on boot: + + +``` +sudo systemctl enable ssh +``` + + +## Check SSH Service Status + +Run the following command in the terminal of your Radxa ROCK 4D to check the status of the SSH service: + + +``` +sudo systemctl status ssh +``` + + +The terminal will display information indicating whether the SSH service is enabled to start on boot and its current running status. + + +``` +● ssh.service - OpenBSD Secure Shell server + Loaded: loaded (/lib/systemd/system/ssh.service; enabled; preset: enabled) + Active: active (running) since Tue 2025-05-27 10:18:30 UTC; 4min 39s ago + Docs: man:sshd(8) + man:sshd_config(5) + Main PID: 1841 (sshd) + Tasks: 1 (limit: 4659) + Memory: 5.3M + CPU: 608ms + CGroup: /system.slice/ssh.service +``` + + +## Remote Login + +On another device, open a terminal and enter the following command to log in remotely. You can use the `ip a` command to check the IP address of your Radxa ROCK 4D. + + +``` +ssh @ +``` + + +Where `` and `` are the username and IP address of your Radxa ROCK 4D, respectively. + +① : Query the IP address of the Radxa ROCK 4D (in this case, I'm querying the IP address through a serial connection to the Radxa ROCK 4D). + +② : The actual IP address of the Radxa ROCK 4D. + +③ : Remotely log in to the Radxa ROCK 4D via SSH. + +
+ +
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/uart_debug.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/uart_debug.md new file mode 100644 index 000000000..89bbff0fc --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/uart_debug.md @@ -0,0 +1,190 @@ +--- +sidebar_position: 3 +--- + +# Serial Debugging + +Serial debugging is a core means of interacting with embedded development boards through serial communication interfaces (UART), allowing users to view system output information and perform debugging. + +## Hardware Preparation + +- Development Board: Radxa ROCK 4D +- USB Serial Data Cable: Connect the UART0 interface of the development board to the USB port of the PC +- Power Adapter: Power the development board (supports PD protocol, 5V power input) + +## Hardware Connection + +You need to connect the USB serial data cable to the UART0_TX, UART0_RX, and GND pins of Radxa ROCK 4D. + +:::danger +When using the USB serial data cable to debug the Radxa ROCK 4D, please ensure that the pin connections are correct, otherwise it may cause damage to the motherboard hardware. +::: + +Connect the USB port of the USB serial data cable to the PC, and the other end to the GPIO serial port pin of Radxa ROCK 4D. + +
+ + Pinout and Connection Diagram +
+ +| No. | Pin Function | Connection Method | +| --- | -------------------------------- | ---------------------------------------- | +| ① | Radxa ROCK 4D: GND (Pin6) | Connect to GND pin of USB UART cable | +| ② | Radxa ROCK 4D: UART0_TX (Pin8) | Connect to RX pin of USB UART cable | +| ③ | Radxa ROCK 4D: UART0_RX (Pin10) | Connect to TX pin of USB UART cable | +| ④ | USB UART Cable: GND (Black wire) | Connect to GND pin of Radxa ROCK 4D | +| ⑤ | USB UART Cable: RX (White wire) | Connect to UART0_TX pin of Radxa ROCK 4D | +| ⑥ | USB UART Cable: TX (Green wire) | Connect to UART0_RX pin of Radxa ROCK 4D | +| ⑦ | USB UART Cable: VCC (Red wire) | Leave unconnected | + +## Serial Login + +:::tip + +- Radxa ROCK 4D Serial Communication Parameters + +Baud rate: 1500000 + +Data bits: 8 + +Stop bits: 1 + +Parity: None +::: + + + + + +Windows platform is recommended to use PuTTY software to log in to the Radxa ROCK 4D system through the serial port. + +- PuTTY usage + +Radxa ROCK 4D and PC are connected through a USB serial data cable, and you can check the corresponding COM port in the Device Manager (in the example, COM4 is the port assigned to the Radxa ROCK 4D). + +
+ +
+ +:::tip + +If the system cannot correctly identify the device or the device has an exclamation mark, you need to install the [CH340 driver](https://www.wch.cn/downloads/CH341SER_EXE.html) by yourself, and restart the system after installation. + +::: + +- Serial Port Login Options + +① --> Connection type: Select `Serial` + +② --> Serial line: Enter `COM4` (or your specific COM port number as shown in Device Manager) + +③ --> Speed: Enter `1500000` + +④ --> Click Open to connect to the Radxa ROCK 4D system via serial + +
+ +
+ +- Login System + +Press Enter after typing the password will show the login information, then use the corresponding system username and password to log in. + +The password will not be displayed when typing. Press Enter after typing the password. + +
+ +
+ + + + + +Linux platform is recommended to use Screen software to log in to the Radxa ROCK 4D system through the serial port. + +- Install Screen + + +``` +sudo apt update +sudo apt install screen +``` + + +- Find Serial Port Device + +Open the terminal and use the `ls` command to view the serial port device: + +If the PC has only one serial port device, the system defaults to ttyUSB0; + +If the PC has multiple serial port devices, you can plug and unplug the USB device to observe the changes in the device number. + + +``` +ls /dev/ttyUSB* +``` + + +- Serial Login Options + +Use Screen to connect to the serial port, only setting the serial port number and baud rate is required. + + +``` +sudo screen /dev/ttyUSB0 1500000 +``` + + +- Login System + +After pressing Enter, you will see the login information. Then use the corresponding system username and password to log in. + +The password will not be displayed when typing. Press Enter after typing the password. + +
+ +
+ + + + + +MacOS platform is recommended to use Screen software to log in to the Radxa ROCK 4D system through the serial port. + +:::tip + +If the system cannot correctly identify the device, you need to install the [CH340 driver](https://www.wch.cn/downloads/CH341SER_MAC_ZIP.html) by yourself, and restart the system after installation. + +::: + +- Find Serial Port Device + +Open the terminal and use the `ls` command to view the serial port device: + +Find the device name similar to /dev/tty.wchusbserial14xx0. If the PC has multiple serial port devices, you can plug and unplug the USB device to observe the changes in the device number. + + +``` +ls /dev/tty.* +``` + + +- Serial Login Options + +Use Screen to connect to the serial port, only setting the serial port number and baud rate is required. + + +``` +screen /dev/tty.wchusbserial14xx0 1500000 +``` + + +- Login System + +After pressing Enter, you will see the login information. Then use the corresponding system username and password to log in. + +The password will not be displayed when typing. Press Enter after typing the password. + + + + diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/vnc-remote.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/vnc-remote.md new file mode 100644 index 000000000..8d3e2b1c1 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/vnc-remote.md @@ -0,0 +1,268 @@ +--- +sidebar_position: 5 +--- + +# VNC Remote + +Remote login refers to remote control of the board through the network, and this tutorial only introduces the method of remote control using VNC in a local area network (LAN). + +Users without a display can configure VNC remote login by following the [Serial Debugging](./uart_debug) method to run the commands below. + +:::tip +VNC remote control is suitable for systems with a graphical interface. If the system does not have a graphical desktop, it is recommended to use SSH remote control. +::: + +## Using VNC (Windows / Linux) + +### Download VNC Viewer + +We need to install VNC Viewer software on the remote device, which is the PC, to control the board. + +Enter the [RealVNC](https://www.realvnc.com/en/connect/download/viewer) official website to download the VNC Viewer installation package corresponding to the system platform. + +
+ +
+ +### Install VNC Viewer + + + + + +Download the `*.exe` installation package after downloading the Windows version. + +- Run the installation package + +Run `VNC-Viewer-xxx.exe` installation program as administrator. + +
+ +
+ +- Software language + +Select `English` language, click `OK` to enter the next step. + +
+ +
+ +- Enter the installation page + +Click `Next` to enter the security agreement page. + +
+ +
+ +- Agree to the agreement + +Select `I accept the terms in the License Agreement` option, click `Next` to enter the next step. + +
+ +
+ +- Installation path + +Select the default installation path of the software, click `Next` to enter the next step. + +
+ +
+ +- Formal installation + +Click `Install` to start the formal installation. + +
+ +
+ +- Complete installation + +Click `Finish` to complete the installation. + +
+ +
+ + + + + +Download the Linux version of the `*.deb` installation package and run the following command in the terminal to install VNC Viewer: + + +``` +sudo dpkg -i VNC-Viewer-xxx.deb +``` + + + + + + +### Run VNC Viewer + +After installation, open the VNC Viewer software: users can choose to use VNC Viewer software without logging in to an account. + +
+ +
+ +
+VNC Viewer interface + +
+ +## Install VNC Server (Radxa ROCK 4D) + +### Install VNC Server + +Run the following command in the terminal of Radxa ROCK 4D to install VNC Server: + + +``` +sudo apt update +sudo apt install tigervnc-standalone-server tigervnc-common -y +``` + + +### Set VNC Remote Password + +Run the following command in the terminal of Radxa ROCK 4D to set the VNC remote password: + + +``` +vncpasswd +``` + + + +:::tip +Input password and confirm password will not be displayed on the screen, the system will prompt whether to create a read-only password, select `n` (no). +::: + +After setting the password, the system will prompt similar information: + + +``` +Password: +Verify: +Would you like to enter a view-only password (y/n)? n +A view-only password is not used +``` + + +### Configure VNC startup file + +Edit the `~/.vnc/xstartup` file on Radxa ROCK 4D: + + +``` +sudo vi ~/.vnc/xstartup +``` + + +Modify the `~/.vnc/xstartup` file content as follows: + + +``` +#!/bin/sh +unset SESSION_MANAGER +unset DBUS_SESSION_BUS_ADDRESS +export XDG_SESSION_TYPE=x11 +export DESKTOP_SESSION=plasma +exec startplasma-x11 +``` + + +After editing the `~/.vnc/xstartup` file, you need to grant the file executable permissions: + + +``` +sudo chmod +x ~/.vnc/xstartup +``` + + +### Start VNC Server + +Run the following command in the terminal of Radxa ROCK 4D to start the VNC server: use the `-localhost no` parameter to allow remote access. + + +``` +vncserver -localhost no +``` + + +After starting successfully, it will prompt similar information to show the VNC server port number, for example: + + +``` +New Xtigervnc server 'rock-4d-spi:1 (radxa)' on port 5901 for display :1. +Use xtigervncviewer -SecurityTypes VncAuth -passwd /tmp/tigervnc.VQ4DfI/passwd :1 to connect to the VNC server. +``` + + +### View VNC Server Status + +Run the following command in the terminal of Radxa ROCK 4D to view the VNC server status: + + +``` +vncserver -list +``` + + +The terminal will output similar information: + + +``` +TigerVNC server sessions: + +X DISPLAY # RFB PORT # RFB UNIX PATH PROCESS ID # SERVER +1 5901 3283 Xtigervnc +``` + + + +### Close VNC Server + +Run the following command in the terminal of Radxa ROCK 4D to close the VNC server. The `:1` in the command represents the display number of the VNC server. + + +``` +vncserver -kill :1 +``` + + +After closing the VNC server, the VNC Viewer software will automatically disconnect. + +## VNC Remote Login + +Open the VNC Viewer software on another device and connect to Radxa ROCK 4D using its IP address and port number. + +① : Fill in the IP address and port number of Radxa ROCK 4D + +② : Click `Connect to address ···` to connect to Radxa ROCK 4D + +
+ +
+ +① : Enter the VNC remote password set on Radxa ROCK 4D + +② : Check the `Remember password` option to save the password for easy login next time + +③ : Click `OK` to connect + +
+ +
+ +
+VNC remote login successful + +
diff --git a/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/web-config.md b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/web-config.md new file mode 100644 index 000000000..c6919eeb2 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/rock4/rock4d/system-config/web-config.md @@ -0,0 +1,190 @@ +--- +sidebar_position: 3 +--- + +# Network Configuration + +## Wired Network + + + + + +Connect Radxa ROCK 4D to the router using a network cable, and the router will automatically assign an IP address to Radxa ROCK 4D. + +① : Click the network icon + +② : Select the `Details` option to view the network connection details, such as IP address, subnet mask, gateway address, etc. + +`192.168.2.106` is the IP address assigned by the router. + +
+ +
+ + + + + +Connect Radxa ROCK 4D to the router using a network cable, and the router will automatically assign an IP address to Radxa ROCK 4D. + +Terminal command line input the following command to view network connection details: + + +``` +ip a +``` + + +The terminal will output similar information: `192.168.2.106` is the IP address assigned by the router. + + +``` +1: lo: mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000 + link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 + inet 127.0.0.1/8 scope host lo + valid_lft forever preferred_lft forever + inet6 ::1/128 scope host noprefixroute + valid_lft forever preferred_lft forever +2: end0: mtu 1500 qdisc mq state UP group default qlen 1000 + link/ether 5a:cb:6b:3c:ed:ae brd ff:ff:ff:ff:ff:ff + inet 192.168.2.106/24 brd 192.168.2.255 scope global dynamic noprefixroute end0 + valid_lft 2652sec preferred_lft 2652sec + inet6 fdaa::dd7/128 scope global dynamic noprefixroute + valid_lft 2494sec preferred_lft 2494sec + inet6 240e:3b7:3246:54f0::dd7/128 scope global dynamic noprefixroute + valid_lft 2494sec preferred_lft 2494sec + inet6 240e:3b7:3246:54f0:4732:d5f3:184e:7827/64 scope global dynamic noprefixroute + valid_lft 236440sec preferred_lft 150040sec + inet6 fdaa::9d81:8d0f:7ee4:5760/64 scope global noprefixroute + valid_lft forever preferred_lft forever + inet6 fe80::379f:ead8:706f:5d6/64 scope link noprefixroute + valid_lft forever preferred_lft forever +``` + + + + + + +## Wireless Network + +Connect Radxa ROCK 4D to the router using a network cable, and the router will automatically assign an IP address to Radxa ROCK 4D. + +:::tip +Radxa ROCK 4D has two onboard antenna interfaces, you need to install the antenna to the interface position, otherwise the WiFi signal will be very weak +::: + + + + + +① : Click the network icon + +② : Click the `Connect` button next to the WiFi name you want to connect to + +③ : Enter the WiFi password and follow the subsequent prompts to connect + +
+ +
+ +After connecting successfully, click `Details` to view the network connection details, such as IP address, subnet mask, gateway address, etc. + +`192.168.31.53` is the IP address assigned by the router. + +
+ +
+ + + + + +1. Enable WiFi function + + +``` +sudo nmcli radio wifi on +``` + + +2. Search for nearby WiFi networks + + +``` +sudo nmcli device wifi list +``` + + +3. Connect to WiFi network + + +``` +sudo nmcli device wifi connect password +# Example +sudo nmcli device wifi connect wifi_demo password 12345678 +``` + + +4. View network connection details + + +``` +ip a +``` + + +The terminal will output similar information: `192.168.31.53` is the IP address assigned by the router. + + +``` +1: lo: mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000 + link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 + inet 127.0.0.1/8 scope host lo + valid_lft forever preferred_lft forever + inet6 ::1/128 scope host noprefixroute + valid_lft forever preferred_lft forever +2: end0: mtu 1500 qdisc mq state UP group default qlen 1000 + link/ether 5a:cb:6b:3c:ed:ae brd ff:ff:ff:ff:ff:ff + inet 192.168.2.106/24 brd 192.168.2.255 scope global dynamic noprefixroute end0 + valid_lft 3125sec preferred_lft 3125sec + inet6 fdaa::dd7/128 scope global dynamic noprefixroute + valid_lft 3119sec preferred_lft 3119sec + inet6 240e:3b7:3246:54f0::dd7/128 scope global dynamic noprefixroute + valid_lft 3119sec preferred_lft 3119sec + inet6 240e:3b7:3246:54f0:4732:d5f3:184e:7827/64 scope global dynamic noprefixroute + valid_lft 235266sec preferred_lft 148866sec + inet6 fdaa::9d81:8d0f:7ee4:5760/64 scope global noprefixroute + valid_lft forever preferred_lft forever + inet6 fe80::379f:ead8:706f:5d6/64 scope link noprefixroute + valid_lft forever preferred_lft forever +3: wlx94706c5ee946: mtu 1500 qdisc mq state UP group default qlen 1000 + link/ether 94:70:6c:5e:e9:46 brd ff:ff:ff:ff:ff:ff + inet 192.168.31.53/24 brd 192.168.31.255 scope global dynamic noprefixroute wlx94706c5ee946 + valid_lft 3556sec preferred_lft 3556sec + inet6 fdaa:0:0:30::dd7/128 scope global dynamic noprefixroute + valid_lft 3555sec preferred_lft 3555sec + inet6 240e:3b7:3246:54f2::dd7/128 scope global dynamic noprefixroute + valid_lft 3555sec preferred_lft 3555sec + inet6 240e:3b7:3246:54f2:518e:da68:272f:928/64 scope global dynamic noprefixroute + valid_lft 235266sec preferred_lft 148866sec + inet6 fdaa::30:f642:3a8c:dd7b:4ada/64 scope global noprefixroute + valid_lft forever preferred_lft forever + inet6 fe80::ff38:edfe:b892:b694/64 scope link noprefixroute + valid_lft forever preferred_lft forever +``` + + +:::tip +Nmcli is the Network Manager Command Line Interface, which is a command-line tool for managing networks in Linux. + +Additional commands: + +- `nmcli radio wifi off`：Turn off WiFi function. +- `nmcli connection delete ` : Delete the specified WiFi network. + ::: + + + + diff --git a/i18n/en/docusaurus-theme-classic/navbar.json b/i18n/en/docusaurus-theme-classic/navbar.json index 395500a13..b12f0f5d2 100644 --- a/i18n/en/docusaurus-theme-classic/navbar.json +++ b/i18n/en/docusaurus-theme-classic/navbar.json @@ -159,6 +159,10 @@ "message": "→ ROCK 4SE", "description": "Navbar item with label → ROCK 4SE" }, + "item.label.→ ROCK 4D": { + "message": "→ ROCK 4D", + "description": "Navbar item with label → ROCK 4D" + }, "item.label.→ ROCK Pi E": { "message": "→ ROCK Pi E", "description": "Navbar item with label → ROCK Pi E" diff --git a/static/home/product-pictures/rock4d.webp b/static/home/product-pictures/rock4d.webp new file mode 100644 index 000000000..809559086 Binary files /dev/null and b/static/home/product-pictures/rock4d.webp differ diff --git a/static/img/rock4/4d.webp b/static/img/rock4/4d.webp new file mode 100644 index 000000000..29ed9d6f4 Binary files /dev/null and b/static/img/rock4/4d.webp differ diff --git a/static/img/rock4/4d/boot-nvme-01.webp b/static/img/rock4/4d/boot-nvme-01.webp new file mode 100644 index 000000000..af80f7f36 Binary files /dev/null and b/static/img/rock4/4d/boot-nvme-01.webp differ diff --git a/static/img/rock4/4d/boot-nvme.webp b/static/img/rock4/4d/boot-nvme.webp new file mode 100644 index 000000000..c30bc0dee Binary files /dev/null and b/static/img/rock4/4d/boot-nvme.webp differ diff --git a/static/img/rock4/4d/boot-sd.webp b/static/img/rock4/4d/boot-sd.webp new file mode 100644 index 000000000..63679c16b Binary files /dev/null and b/static/img/rock4/4d/boot-sd.webp differ diff --git a/static/img/rock4/4d/boot-ufs-sd.webp b/static/img/rock4/4d/boot-ufs-sd.webp new file mode 100644 index 000000000..090e5a6a2 Binary files /dev/null and b/static/img/rock4/4d/boot-ufs-sd.webp differ diff --git a/static/img/rock4/4d/boot-ufs.webp b/static/img/rock4/4d/boot-ufs.webp new file mode 100644 index 000000000..2cdcc82f3 Binary files /dev/null and b/static/img/rock4/4d/boot-ufs.webp differ diff --git a/static/img/rock4/4d/display-login.webp b/static/img/rock4/4d/display-login.webp new file mode 100644 index 000000000..e8428cfa6 Binary files /dev/null and b/static/img/rock4/4d/display-login.webp differ diff --git a/static/img/rock4/4d/down-etcher-00.webp b/static/img/rock4/4d/down-etcher-00.webp new file mode 100644 index 000000000..8a284245f Binary files /dev/null and b/static/img/rock4/4d/down-etcher-00.webp differ diff --git a/static/img/rock4/4d/down-etcher-01.webp b/static/img/rock4/4d/down-etcher-01.webp new file mode 100644 index 000000000..2e37d1b8a Binary files /dev/null and b/static/img/rock4/4d/down-etcher-01.webp differ diff --git a/static/img/rock4/4d/down-etcher-02.webp b/static/img/rock4/4d/down-etcher-02.webp new file mode 100644 index 000000000..b1e592cff Binary files /dev/null and b/static/img/rock4/4d/down-etcher-02.webp differ diff --git a/static/img/rock4/4d/etcher-01.webp b/static/img/rock4/4d/etcher-01.webp new file mode 100644 index 000000000..2a017d4d8 Binary files /dev/null and b/static/img/rock4/4d/etcher-01.webp differ diff --git a/static/img/rock4/4d/etcher-02.webp b/static/img/rock4/4d/etcher-02.webp new file mode 100644 index 000000000..ed861e7ed Binary files /dev/null and b/static/img/rock4/4d/etcher-02.webp differ diff --git a/static/img/rock4/4d/etcher-03.webp b/static/img/rock4/4d/etcher-03.webp new file mode 100644 index 000000000..77f2d97a4 Binary files /dev/null and b/static/img/rock4/4d/etcher-03.webp differ diff --git a/static/img/rock4/4d/etcher-04.webp b/static/img/rock4/4d/etcher-04.webp new file mode 100644 index 000000000..84557be41 Binary files /dev/null and b/static/img/rock4/4d/etcher-04.webp differ diff --git a/static/img/rock4/4d/etcher-05.webp b/static/img/rock4/4d/etcher-05.webp new file mode 100644 index 000000000..8a7f82ae3 Binary files /dev/null and b/static/img/rock4/4d/etcher-05.webp differ diff --git a/static/img/rock4/4d/etcher-06.webp b/static/img/rock4/4d/etcher-06.webp new file mode 100644 index 000000000..123e6ab19 Binary files /dev/null and b/static/img/rock4/4d/etcher-06.webp differ diff --git a/static/img/rock4/4d/etcher-07.webp b/static/img/rock4/4d/etcher-07.webp new file mode 100644 index 000000000..7e0ef982d Binary files /dev/null and b/static/img/rock4/4d/etcher-07.webp differ diff --git a/static/img/rock4/4d/hardware-rk3576-1.webp b/static/img/rock4/4d/hardware-rk3576-1.webp new file mode 100644 index 000000000..4a6efb35c Binary files /dev/null and b/static/img/rock4/4d/hardware-rk3576-1.webp differ diff --git a/static/img/rock4/4d/hardware-rk3576.webp b/static/img/rock4/4d/hardware-rk3576.webp new file mode 100644 index 000000000..ce354b8aa Binary files /dev/null and b/static/img/rock4/4d/hardware-rk3576.webp differ diff --git a/static/img/rock4/4d/loader-mode.webp b/static/img/rock4/4d/loader-mode.webp new file mode 100644 index 000000000..ea404d937 Binary files /dev/null and b/static/img/rock4/4d/loader-mode.webp differ diff --git a/static/img/rock4/4d/loader-to-maskrom.webp b/static/img/rock4/4d/loader-to-maskrom.webp new file mode 100644 index 000000000..b50a8bd11 Binary files /dev/null and b/static/img/rock4/4d/loader-to-maskrom.webp differ diff --git a/static/img/rock4/4d/loader.webp b/static/img/rock4/4d/loader.webp new file mode 100644 index 000000000..0ebe29d97 Binary files /dev/null and b/static/img/rock4/4d/loader.webp differ diff --git a/static/img/rock4/4d/maskrom-mode.webp b/static/img/rock4/4d/maskrom-mode.webp new file mode 100644 index 000000000..90fb83ee0 Binary files /dev/null and b/static/img/rock4/4d/maskrom-mode.webp differ diff --git a/static/img/rock4/4d/maskrom.webp b/static/img/rock4/4d/maskrom.webp new file mode 100644 index 000000000..c5ea501a0 Binary files /dev/null and b/static/img/rock4/4d/maskrom.webp differ diff --git a/static/img/rock4/4d/nodiplay-login.webp b/static/img/rock4/4d/nodiplay-login.webp new file mode 100644 index 000000000..1c22ea0da Binary files /dev/null and b/static/img/rock4/4d/nodiplay-login.webp differ diff --git a/static/img/rock4/4d/rkddevtool.webp b/static/img/rock4/4d/rkddevtool.webp new file mode 100644 index 000000000..112b913b5 Binary files /dev/null and b/static/img/rock4/4d/rkddevtool.webp differ diff --git a/static/img/rock4/4d/rock4d-bottom.webp b/static/img/rock4/4d/rock4d-bottom.webp new file mode 100644 index 000000000..dc646df31 Binary files /dev/null and b/static/img/rock4/4d/rock4d-bottom.webp differ diff --git a/static/img/rock4/4d/rock4d-interface.webp b/static/img/rock4/4d/rock4d-interface.webp new file mode 100644 index 000000000..5ad5ef76e Binary files /dev/null and b/static/img/rock4/4d/rock4d-interface.webp differ diff --git a/static/img/rock4/4d/rock4d-top.webp b/static/img/rock4/4d/rock4d-top.webp new file mode 100644 index 000000000..33bdca9de Binary files /dev/null and b/static/img/rock4/4d/rock4d-top.webp differ diff --git a/static/img/rock4/4d/rsetup-01.webp b/static/img/rock4/4d/rsetup-01.webp new file mode 100644 index 000000000..1f7c8594f Binary files /dev/null and b/static/img/rock4/4d/rsetup-01.webp differ diff --git a/static/img/rock4/4d/rsetup-02.webp b/static/img/rock4/4d/rsetup-02.webp new file mode 100644 index 000000000..9d2919a31 Binary files /dev/null and b/static/img/rock4/4d/rsetup-02.webp differ diff --git a/static/img/rock4/4d/rsetup-03.webp b/static/img/rock4/4d/rsetup-03.webp new file mode 100644 index 000000000..4135d60f5 Binary files /dev/null and b/static/img/rock4/4d/rsetup-03.webp differ diff --git a/static/img/rock4/4d/rsetup-04.webp b/static/img/rock4/4d/rsetup-04.webp new file mode 100644 index 000000000..3a0c4306f Binary files /dev/null and b/static/img/rock4/4d/rsetup-04.webp differ diff --git a/static/img/rock4/4d/rsetup-05.webp b/static/img/rock4/4d/rsetup-05.webp new file mode 100644 index 000000000..546aed5d6 Binary files /dev/null and b/static/img/rock4/4d/rsetup-05.webp differ diff --git a/static/img/rock4/4d/rsetup-06.webp b/static/img/rock4/4d/rsetup-06.webp new file mode 100644 index 000000000..50e9cdc15 Binary files /dev/null and b/static/img/rock4/4d/rsetup-06.webp differ diff --git a/static/img/rock4/4d/rsetup-07.webp b/static/img/rock4/4d/rsetup-07.webp new file mode 100644 index 000000000..e9cee5637 Binary files /dev/null and b/static/img/rock4/4d/rsetup-07.webp differ diff --git a/static/img/rock4/4d/rsetup-08.webp b/static/img/rock4/4d/rsetup-08.webp new file mode 100644 index 000000000..ab3a4f5ee Binary files /dev/null and b/static/img/rock4/4d/rsetup-08.webp differ diff --git a/static/img/rock4/4d/rsetup-09.webp b/static/img/rock4/4d/rsetup-09.webp new file mode 100644 index 000000000..d572f7318 Binary files /dev/null and b/static/img/rock4/4d/rsetup-09.webp differ diff --git a/static/img/rock4/4d/rsetup-spi-01.webp b/static/img/rock4/4d/rsetup-spi-01.webp new file mode 100644 index 000000000..6ab47a76d Binary files /dev/null and b/static/img/rock4/4d/rsetup-spi-01.webp differ diff --git a/static/img/rock4/4d/rsetup-spi-02.webp b/static/img/rock4/4d/rsetup-spi-02.webp new file mode 100644 index 000000000..de145def2 Binary files /dev/null and b/static/img/rock4/4d/rsetup-spi-02.webp differ diff --git a/static/img/rock4/4d/rsetup-spi-03.webp b/static/img/rock4/4d/rsetup-spi-03.webp new file mode 100644 index 000000000..68dc79ef3 Binary files /dev/null and b/static/img/rock4/4d/rsetup-spi-03.webp differ diff --git a/static/img/rock4/4d/rsetup-spi-04.webp b/static/img/rock4/4d/rsetup-spi-04.webp new file mode 100644 index 000000000..fed78c6e6 Binary files /dev/null and b/static/img/rock4/4d/rsetup-spi-04.webp differ diff --git a/static/img/rock4/4d/rsetup-spi-05.webp b/static/img/rock4/4d/rsetup-spi-05.webp new file mode 100644 index 000000000..f326953c0 Binary files /dev/null and b/static/img/rock4/4d/rsetup-spi-05.webp differ diff --git a/static/img/rock4/4d/rsetup-spi-06.webp b/static/img/rock4/4d/rsetup-spi-06.webp new file mode 100644 index 000000000..fa7946467 Binary files /dev/null and b/static/img/rock4/4d/rsetup-spi-06.webp differ diff --git a/static/img/rock4/4d/rsetup-spi-07.webp b/static/img/rock4/4d/rsetup-spi-07.webp new file mode 100644 index 000000000..d5199f265 Binary files /dev/null and b/static/img/rock4/4d/rsetup-spi-07.webp differ diff --git a/static/img/rock4/4d/sd-insert.webp b/static/img/rock4/4d/sd-insert.webp new file mode 100644 index 000000000..6a568a5d7 Binary files /dev/null and b/static/img/rock4/4d/sd-insert.webp differ diff --git a/static/img/rock4/4d/serial-01.webp b/static/img/rock4/4d/serial-01.webp new file mode 100644 index 000000000..26bcde49d Binary files /dev/null and b/static/img/rock4/4d/serial-01.webp differ diff --git a/static/img/rock4/4d/serial-02.webp b/static/img/rock4/4d/serial-02.webp new file mode 100644 index 000000000..09607c81c Binary files /dev/null and b/static/img/rock4/4d/serial-02.webp differ diff --git a/static/img/rock4/4d/serial-03.webp b/static/img/rock4/4d/serial-03.webp new file mode 100644 index 000000000..f0db22de0 Binary files /dev/null and b/static/img/rock4/4d/serial-03.webp differ diff --git a/static/img/rock4/4d/serial-connect.webp b/static/img/rock4/4d/serial-connect.webp new file mode 100644 index 000000000..e03421428 Binary files /dev/null and b/static/img/rock4/4d/serial-connect.webp differ diff --git a/static/img/rock4/4d/serial-port-en.webp b/static/img/rock4/4d/serial-port-en.webp new file mode 100644 index 000000000..e56ed311c Binary files /dev/null and b/static/img/rock4/4d/serial-port-en.webp differ diff --git a/static/img/rock4/4d/ssh-login.webp b/static/img/rock4/4d/ssh-login.webp new file mode 100644 index 000000000..a30c75183 Binary files /dev/null and b/static/img/rock4/4d/ssh-login.webp differ diff --git a/static/img/rock4/4d/uart-debug-01.webp b/static/img/rock4/4d/uart-debug-01.webp new file mode 100644 index 000000000..cd82aae6e Binary files /dev/null and b/static/img/rock4/4d/uart-debug-01.webp differ diff --git a/static/img/rock4/4d/vnc-connect-01.webp b/static/img/rock4/4d/vnc-connect-01.webp new file mode 100644 index 000000000..f7b5e2777 Binary files /dev/null and b/static/img/rock4/4d/vnc-connect-01.webp differ diff --git a/static/img/rock4/4d/vnc-connect-02.webp b/static/img/rock4/4d/vnc-connect-02.webp new file mode 100644 index 000000000..3859fc630 Binary files /dev/null and b/static/img/rock4/4d/vnc-connect-02.webp differ diff --git a/static/img/rock4/4d/vnc-connect-03.webp b/static/img/rock4/4d/vnc-connect-03.webp new file mode 100644 index 000000000..c0f6eca72 Binary files /dev/null and b/static/img/rock4/4d/vnc-connect-03.webp differ diff --git a/static/img/rock4/4d/vnc-download.webp b/static/img/rock4/4d/vnc-download.webp new file mode 100644 index 000000000..221be5f44 Binary files /dev/null and b/static/img/rock4/4d/vnc-download.webp differ diff --git a/static/img/rock4/4d/vnc-windows-install-01.webp b/static/img/rock4/4d/vnc-windows-install-01.webp new file mode 100644 index 000000000..95a9f6c7a Binary files /dev/null and b/static/img/rock4/4d/vnc-windows-install-01.webp differ diff --git a/static/img/rock4/4d/vnc-windows-install-02.webp b/static/img/rock4/4d/vnc-windows-install-02.webp new file mode 100644 index 000000000..fbfe9b557 Binary files /dev/null and b/static/img/rock4/4d/vnc-windows-install-02.webp differ diff --git a/static/img/rock4/4d/vnc-windows-install-03.webp b/static/img/rock4/4d/vnc-windows-install-03.webp new file mode 100644 index 000000000..01579f651 Binary files /dev/null and b/static/img/rock4/4d/vnc-windows-install-03.webp differ diff --git a/static/img/rock4/4d/vnc-windows-install-04.webp b/static/img/rock4/4d/vnc-windows-install-04.webp new file mode 100644 index 000000000..71c7c1afe Binary files /dev/null and b/static/img/rock4/4d/vnc-windows-install-04.webp differ diff --git a/static/img/rock4/4d/vnc-windows-install-05.webp b/static/img/rock4/4d/vnc-windows-install-05.webp new file mode 100644 index 000000000..4befd55fa Binary files /dev/null and b/static/img/rock4/4d/vnc-windows-install-05.webp differ diff --git a/static/img/rock4/4d/vnc-windows-install-06.webp b/static/img/rock4/4d/vnc-windows-install-06.webp new file mode 100644 index 000000000..911502b1b Binary files /dev/null and b/static/img/rock4/4d/vnc-windows-install-06.webp differ diff --git a/static/img/rock4/4d/vnc-windows-install-07.webp b/static/img/rock4/4d/vnc-windows-install-07.webp new file mode 100644 index 000000000..be36a477e Binary files /dev/null and b/static/img/rock4/4d/vnc-windows-install-07.webp differ diff --git a/static/img/rock4/4d/vnc-windows-use-01.webp b/static/img/rock4/4d/vnc-windows-use-01.webp new file mode 100644 index 000000000..0fd1bbe41 Binary files /dev/null and b/static/img/rock4/4d/vnc-windows-use-01.webp differ diff --git a/static/img/rock4/4d/vnc-windows-use-02.webp b/static/img/rock4/4d/vnc-windows-use-02.webp new file mode 100644 index 000000000..23b3b9392 Binary files /dev/null and b/static/img/rock4/4d/vnc-windows-use-02.webp differ diff --git a/static/img/rock4/4d/web-01.webp b/static/img/rock4/4d/web-01.webp new file mode 100644 index 000000000..4cb923abe Binary files /dev/null and b/static/img/rock4/4d/web-01.webp differ diff --git a/static/img/rock4/4d/wifi-connect-01.webp b/static/img/rock4/4d/wifi-connect-01.webp new file mode 100644 index 000000000..10685610c Binary files /dev/null and b/static/img/rock4/4d/wifi-connect-01.webp differ diff --git a/static/img/rock4/4d/wifi-connect-02.webp b/static/img/rock4/4d/wifi-connect-02.webp new file mode 100644 index 000000000..2703295ec Binary files /dev/null and b/static/img/rock4/4d/wifi-connect-02.webp differ diff --git a/static/img/rock4/4d/write-loader.webp b/static/img/rock4/4d/write-loader.webp new file mode 100644 index 000000000..6a6435897 Binary files /dev/null and b/static/img/rock4/4d/write-loader.webp differ diff --git a/static/img/rock4/4d/write-nvme.webp b/static/img/rock4/4d/write-nvme.webp new file mode 100644 index 000000000..3aca55756 Binary files /dev/null and b/static/img/rock4/4d/write-nvme.webp differ diff --git a/static/img/rock4/4d/write-ufs.webp b/static/img/rock4/4d/write-ufs.webp new file mode 100644 index 000000000..c3eb9ad6e Binary files /dev/null and b/static/img/rock4/4d/write-ufs.webp differ