SBC-sig/documents/瑞芯微等开发板.md

# 瑞芯微等开发板

本仓库提供适用于 Rockchip 等开发板的 openEuler 镜像的构建脚本和相关文档。

<!-- TOC -->

- [瑞芯微等开发板](#瑞芯微等开发板)
    - [文件说明](#文件说明)
    - [最新镜像](#最新镜像)
    - [镜像构建](#镜像构建)
        - [准备环境](#准备环境)
        - [一次构建](#一次构建)
        - [Docker 容器内构建](#docker-容器内构建)
        - [顺序构建](#顺序构建)
    - [刷写镜像](#刷写镜像)
        - [刷写到 SD 卡](#刷写到-sd-卡)
        - [刷写到 EMMC](#刷写到-emmc)
    - [问题汇总](#问题汇总)

<!-- /TOC -->

## 文件说明

- [documents](./rockchip): 使用文档
    - [openEuler镜像的构建](rockchip/openEuler镜像的构建.md)
    - [刷写EMMC镜像](rockchip/刷写EMMC镜像.md)
    - [顺序构建](rockchip/顺序构建.md)
    - [基于Firefly-SDK编译Firefly-RK3399的内核镜像](rockchip/基于Firefly-SDK编译Firefly-RK3399的内核镜像.md)
    - [打包 ITX-RK3588J 一体化烧写镜像](rockchip/打包ITX-RK3588J一体化烧写镜像.md)
    - [设置 SELinux](rockchip/设置SELinux.md)
    - [使用 Docker 构建镜像](rockchip/使用Docker构建镜像.md)
- [scripts](../scripts/rockchip):  构建 openEuler RK3399 等开发板镜像的脚本
    - [一次构建脚本](../scripts/rockchip/build.sh)
    - [boot 镜像构建脚本](../scripts/rockchip/build_boot.sh)
    - [rootfs 镜像构建脚本](../scripts/rockchip/build_rootfs.sh)
    - [u-boot 编译脚本](../scripts/rockchip/build_u-boot.sh)
    - [可启动镜像生成脚本](../scripts/rockchip/gen_image.sh)

## 最新镜像

镜像下载连接及基本信息见 [瑞芯微等其他开发板](../README.md#瑞芯微等其他开发板)。

## 镜像构建

>![](public_sys-resources/icon-notice.gif) **须知：**  
>RK3399 当前支持 openEuler 版本：20.03 LTS、20.03 LTS SP1、20.03 LTS SP2、20.03 LTS SP3、22.03 LTS SP2 和 22.03 LTS SP3。
>RK3566 当前支持 openEuler 版本：24.03 LTS。
>RK3588 当前支持 openEuler 版本：22.03 LTS、22.03 LTS SP2 和 22.03 LTS SP3。
>如果构建包含 Xfce/UKUI/DDE 桌面环境的镜像，需要注意三点：
>1. 构建包含 Xfce 桌面环境的镜像，当前只支持 20.03 LTS SP2、20.03 LTS SP3、21.09、22.03 LTS、22.03 LTS SP3、24.03 LTS 版本。
>2. 构建包含 UKUI 或 DDE 桌面环境的镜像，当前只支持 20.03 LTS SP1、20.03 LTS SP2、20.03 LTS SP3、21.09、22.03 LTS、22.03 LTS SP3、24.03 LTS 版本。
>3. 根据需要设置 -s/--spec，其具体意义见该参数的介绍部分。同时需要设置对应 -r/--repo 参数。

### 准备环境
- 操作系统：openEuler 、CentOS 8
- 架构：AArch64 ，如树莓派、 RK3399 开发板、 RK3588 开发板

详细过程参见 [openEuler 镜像的构建](rockchip/openEuler镜像的构建.md)。

构建脚本见 [scripts/rockchip](../scripts/rockchip)。

### 一次构建

构建镜像需执行命令：

`sudo bash build.sh --board BOARD -n NAME -k KERNEL_URL -b KERNEL_BRANCH -c KERNEL_DEFCONFIG -r REPO_INFO -s SPEC --cores N`

**说明: 基于 build.sh 提供的默认参数，执行 sudo bash build.sh 可构建 Firefly-RK3399 的 openEuler-20.03-LTS 镜像。**

脚本执行完成后，会在脚本所在目录的 build/YYYY-MM-DD 文件夹下生成以下文件：

- 打包后的 EMMC 刷写文件：openEuler-VERSION-BOARD-RELEASE.tar.gz。
- 压缩后的 RAW 原始镜像：openEuler-VERSION-BOARD-ARCH-RELEASE.img.xz。

>打包后的 EMMC 刷写文件和压缩后的 RAW 原始镜像文件有什么区别？

>1. 打包后的 EMMC 刷写文件：指需要使用 RKDevTool 或者 rkdeveloptool 来刷入到例如 Firefly-RK3399 这一类自带 EMMC 储存介质的开发板中。
>2. 压缩后的 RAW 原始镜像文件：通常指的是一个完整的磁盘镜像文件，其中包含了所有磁盘扇区的数据。可以刷写到例如 SD 卡、EMMC 等多种储存介质中。
>3. 带 EMMC 的开发板也可以使用 SD 卡启动镜像，启动选择的储存介质各不相同，如果 EMMC 启动优先级大于 SD 卡，则优先启动 EMMC 内的系统，在这种情况下若想使用 SD 卡内的系统需要先清空 EMMC。
>4. EMMC 刷写过程在 [刷写到 EMMC](#刷写到-emmc) 中介绍；SD 卡刷写过程在 [刷写到 SD 卡](#刷写到-sd-卡) 中介绍。

各个参数意义：

1. --board BOARD

    适用的开发板的版型配置文件在 [boards](../scripts/rockchip/boards) 文件夹中，示例文件 [sample.conf](../scripts/rockchip/boards/sample.conf)，默认为 `firefly-rk3399`。
    
    其包括的配置参数意义如下：

    - platform=PLATFORM

        开发板所使用的平台，目前支持的平台有：rockchip、phytium，默认为 `rockchip`。

    - device-tree=DTB_NAME

        内核设备树中的设备名称，和开发板名称有一点区别，对应 [kernel/arch/arm64/boot/dts/rockchip](https://gitee.com/openeuler/kernel/tree/master/arch/arm64/boot/dts/rockchip) 下的 `DTB_NAME.dts` 文件，默认为 `rk3399-firefly`。

    - ubootconfig=UBOOT_DEFCONFIG

        开发板对应的 defconfig 的文件名称，对应 [u-boot/configs](https://github.com/u-boot/u-boot/tree/master/configs) 下 `UBOOT_DEFCONFIG` 文件，默认为 `firefly-rk3399_defconfig`；如需在 RK3588 开发板上使用预编译的 u-boot，可以将此项设置为 `none`。

2. -n, --name IMAGE_NAME

    构建的镜像名称，例如：`openEuler-20.03-LTS-Firefly-RK3399-aarch64-alpha1` 或 `openEuler-21.09-Firefly-RK3399-aarch64-alpha1`。

3. -k, --kernel KERNEL_URL

   内核源码仓库的项目地址，默认为 `https://gitee.com/openeuler/rockchip-kernel.git`。可根据需要设置为 `git@gitee.com:openeuler/rockchip-kernel.git` 或 `git@gitee.com:openeuler/kernel.git`。

4. -b, --branch KERNEL_BRANCH

    内核源码的对应分支，默认为 openEuler-20.03-LTS。根据 -k 参数有以下选择：

    - -k https://gitee.com/openeuler/rockchip-kernel.git
        - openEuler-20.03-LTS
    - -k https://gitee.com/openeuler/kernel.git
        - openEuler-21.09

5.  -c, --config KERNEL_DEFCONFIG

    内核编译使用的配置文件名称或路径，默认为 `openeuler-raspi_defconfig`。如果该参数为配置文件名称，请确保该文件在内核源码的目录 arch/arm64/configs 下。

6. -r, --repo REPO_INFO

    开发源 repo 文件的 URL 或者路径，也可以是开发源中资源库的 baseurl 列表。注意，如果该参数为资源库的 baseurl 列表，该参数需要使用双引号，各个 baseurl 之间以空格隔开。
    下面分别举例：

    - 开发源 repo 文件的 URL，如 `https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-20.03-LTS/generic.repo`。
    - 开发源的 repo 文件路径：

        `./openEuler-20.03-LTS.repo`：生成 openEuler 20.03 LTS 版本的镜像，该文件内容参考 <https://gitee.com/src-openeuler/openEuler-repos/blob/openEuler-20.03-LTS/generic.repo>。

    - 资源库的 baseurl 列表，如 `http://repo.openeuler.org/openEuler-20.03-LTS/OS/aarch64/ http://repo.openeuler.org/openEuler-20.03-LTS/EPOL/aarch64/`。

7.  -s, --spec SPEC

    构建的镜像版本：
    - `headless`，无图形界面版的镜像。
    - `xfce`，带 Xfce 桌面以及中文字体、输入法等全部配套软件。
    - `ukui`，带 UKUI 桌面及必要的配套软件（不包括中文字体以及输入法）。
    - `dde`，带 DDE 桌面及必要的配套软件（不包括中文字体以及输入法）。
    -  rpmlist 文件路径，其中包含镜像中要安装的软件列表，内容参考 [rpmlist](../scripts/rockchip/configs/rpmlist)。

    默认使用 `headless` 选项。

8.  --cores N

    并行编译的数量，根据运行脚本的宿主机 CPU 实际数目设定，默认为可用的 CPU 总数。

9.  -h, --help

    显示帮助信息。

适用的 RK3399 开发板:

已经测试的开发板如下，其他类型 Rockchip 开发板适用情况待测试。

1. Firefly-RK3399

    已测试的版本如下：

    - openEuler-20.03-LTS，构建命令如下:

        `sudo bash build.sh --board firefly-rk3399 -n openEuler-20.03-LTS-Firefly-RK3399-aarch64-alpha1 -k https://gitee.com/openeuler/rockchip-kernel.git -b openEuler-20.03-LTS -c openeuler_rockchip_defconfig -r https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-20.03-LTS/generic.repo -s headless`

    - openEuler-22.03-LTS-SP3，构建命令如下：

        `sudo bash build.sh --board firefly-rk3399 -n openEuler-22.03-LTS-SP3-Firefly-RK3399-aarch64-alpha1 -k https://gitee.com/openeuler/rockchip-kernel.git -b openEuler-22.03-LTS-SP3 -c openeuler_rockchip_defconfig -r https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-22.03-LTS-SP3/generic.repo -s headless`

2. Radxa RockPi-4A

    已测试的版本如下：

    - openEuler-20.03-LTS，构建命令如下:

        `sudo bash build.sh --board radxa-rockpi-4a -n openEuler-20.03-LTS-RockPi-4A-aarch64-alpha1 -k https://gitee.com/openeuler/rockchip-kernel.git -b openEuler-20.03-LTS -c openeuler_rockchip_defconfig -r https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-20.03-LTS/generic.repo -s headless`

    - openEuler-22.03-LTS，构建命令如下：

        `sudo bash build.sh --board radxa-rockpi-4a -n openEuler-22.03-LTS-RockPi-4A-aarch64-alpha1 -k https://gitee.com/openeuler/kernel.git -b openEuler-22.03-LTS -c openeuler_rockchip_defconfig -r https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-22.03-LTS/generic.repo -s headless`

适用的 RK3588 开发板:

已经测试的开发板如下，其他类型 RK3588 开发板适用情况待测试。

1. Firefly ITX-3588J 

    已测试的版本如下：

    - openEuler-22.03-LTS，构建命令如下:

        `sudo bash build.sh --board firefly-itx-3588j -n openEuler-22.03-RK3588-Firefly-ITX-3588J-aarch64-alpha1 -k https://gitee.com/openeuler/rockchip-kernel.git -b openEuler-22.03-LTS-RK3588 -c openeuler_rk3588_defconfig -r https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-22.03-LTS/generic.repo -s headless`

2. Firefly ROC-RK3588S-PC

    已测试的版本如下：

    - openEuler-22.03-LTS-SP3，构建命令如下:

        `sudo bash build.sh --board firefly-roc-rk3588s-pc -n openEuler-22.03-LTS-SP3-Station-M3-aarch64-alpha1 -k https://gitee.com/openeuler/rockchip-kernel.git -b openEuler-22.03-LTS-SP3 -c openeuler_rockchip_defconfig -r https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-22.03-LTS-SP3/generic.repo -s headless`

3. Radxa Rock-5B

    已测试的版本如下：

    - openEuler-22.03-LTS-SP3，构建命令如下:

        `sudo bash build.sh --board radxa-rock-5b -n openEuler-22.03-LTS-SP3-Rock5B-aarch64-alpha1 -k https://gitee.com/openeuler/rockchip-kernel.git -b openEuler-22.03-LTS-SP3 -c openeuler_rockchip_defconfig -r https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-22.03-LTS-SP3/generic.repo -s headless`

适用的 RK356X 开发板:

已经测试的开发板如下，其他类型 RK356X 开发板适用情况待测试。

1. Firefly ROC-RK3566-PC

    已测试的版本如下：
    
    - openEuler-22.03-LTS-SP2，构建命令如下:

        `sudo bash build.sh --board firefly-roc-rk3566-pc -n openEuler-22.03-LTS-SP2-Station-M2-aarch64-alpha1 -k https://gitee.com/openeuler/rockchip-kernel.git -b openEuler-22.03-LTS-SP2 -c openeuler_rockchip_defconfig -r https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-22.03-LTS-SP2/generic.repo -s headless`
        
    - openEuler-22.03-LTS-SP3，构建命令如下:

        `sudo bash build.sh --board firefly-roc-rk3566-pc -n openEuler-22.03-LTS-SP3-Station-M2-aarch64-alpha1 -k https://gitee.com/openeuler/rockchip-kernel.git -b openEuler-22.03-LTS-SP3 -c openeuler_rockchip_defconfig -r https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-22.03-LTS-SP3/generic.repo -s headless`

    - openEuler-24.03-LTS，构建命令如下:

        `sudo bash build.sh --board firefly-roc-rk3566-pc -n openEuler-24.03-LTS-Station-M2-aarch64-alpha1 -k https://gitee.com/openeuler/rockchip-kernel.git -b openEuler-24.03-LTS -c openeuler_rockchip_defconfig -r https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-24.03-LTS/generic.repo -s headless`
        
2. Firefly ROC-RK3568-PC-SE

    已测试的版本如下：
    
    - openEuler-22.03-LTS-SP2，构建命令如下:

        `sudo bash build.sh --board firefly-roc-rk3568-pc-se -n openEuler-22.03-LTS-SP2-ROC-RK3568-PC-SE-aarch64-alpha1 -k https://gitee.com/openeuler/rockchip-kernel.git -b openEuler-22.03-LTS-SP2 -c openeuler_rockchip_defconfig -r https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-22.03-LTS-SP2/generic.repo -s headless`
        
    - openEuler-22.03-LTS-SP3，构建命令如下:

        `sudo bash build.sh --board firefly-rk3568-pc-se -n openEuler-22.03-LTS-SP3-ROC-RK3568-PC-SE-aarch64-alpha1 -k https://gitee.com/openeuler/rockchip-kernel.git -b openEuler-22.03-LTS-SP3 -c openeuler_rockchip_defconfig -r https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-22.03-LTS-SP3/generic.repo -s headless`

适用的 Phytium 开发板:

已经测试的开发板如下，其他类型 Phytium 开发板适用情况待测试。

1.  Phytium Pi 4GB

    已测试的版本如下：

    - openEuler-22.03-LTS-SP3，构建命令如下:

        `sudo bash build.sh --board phytiumpi-4gb -n openEuler-22.03-LTS-PhytiumPi-4GB-aarch64-alpha1 -k https://gitee.com/openeuler/phytium-kernel.git -b openEuler-22.03-LTS-Phytium -c phytium_defconfig -r https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-22.03-LTS/generic.repo -s headless`

    - openEuler-24.03-LTS，构建命令如下:

        `sudo bash build.sh --board phytium-4gb -n openEuler-24.03-LTS-PhytiumPi-4GB-aarch64-alpha1 -k https://gitee.com/openeuler/phytium-kernel.git -b openEuler-24.03-LTS-Phytium -c phytium_defconfig -r https://gitee.com/src-openeuler/openEuler-repos/raw/openEuler-24.03-LTS/generic.repo -s headless`

### Docker 容器内构建

#### 使用脚本构建镜像需执行命令：

`sudo bash build-image-docker.sh --board BOARD -d DOCKER_FILE -n IMAGE_NAME -k KERNEL_URL -b KERNEL_BRANCH -c KERNEL_DEFCONFIG -r REPO --cores N`

脚本运行结束后，镜像默认保存在脚本运行所在目录的 `build/YYYY-MM-DD` 下。

注意！！！运行该脚本前，需安装 Docker 运行环境。该脚本会自动将 DOCKER_FILE 参数对应的 Docker 镜像导入本机系统中。

除参数 DOCKER_FILE 外，剩余参数与[一次构建](#一次构建)中对应参数一致：

1.  -d, --docker DOCKER_FILE

    Docker 镜像的 URL 或者路径， 默认为 `https://repo.openeuler.org/openEuler-22.03-LTS-SP3/docker_img/aarch64/openEuler-docker.aarch64.tar.xz`。使用该默认参数时，脚本会自动下载 openEuler 22.03 LTS SP3 的 Docker 镜像，并导入本机系统中。

#### 使用 Docker 分步构建

请参考文档：[使用 Docker 构建镜像](rockchip/使用Docker构建镜像.md)

### 顺序构建

依次执行脚本构建生成压缩后的 SD 卡启动镜像和打包后的 EMMC 刷写文件，过程参考[顺序构建](rockchip/顺序构建.md)。

## 刷写镜像

### 刷写到 SD 卡

将压缩后的 RAW 原始镜像解压后写入 SD 卡，请参考[树莓派镜像烧录](raspberrypi/刷写镜像.md)，过程中所用到的镜像应为本项目提供适用于 Rockchip 开发板的镜像。

>注意：由于 Firefly-RK3399 与其他 RK3399 开发板不同，会优先启动 EMMC 上的系统，在 Firefly-RK3399 上使用 SD 卡启动镜像之前需要清除 EMMC 上的系统，上电后需要按下电源键来启动。

### 刷写到 EMMC

将 openEuler 安装到 EMMC，详见[刷写EMMC镜像](rockchip/刷写EMMC镜像.md)。


## 问题汇总

1.  自构建 openEuler 镜像登录时提示 Login incorrect：
    
    该问题通常有以下几种特征：

    - 根据提示输入 root / openeuler 后提示 Login incorrect
    
    ```
    openEuler 22.03 LTS
    Kernel 5.10.0 on an aarch64

    openEuler login:root
    Password:

    Login incorrect
    ```

    - chroot 到根目录无法修改密码

    `passwd:Authentication token manipulation error`

    遇到这一类问题有以下解决方法，如果有更多方法，欢迎反馈：

    - [使用 Docker 构建镜像（推荐）](rockchip/使用Docker构建镜像.md)
    
    - [设置 SELinux](rockchip/设置SELinux.md)