1. 编译 Linux 固件¶

1.1. 获取 SDK¶

首先准备一个空文件夹用于存放 SDK，建议在 home 目录下，本文以~/proj为例

注意：

1. SDK 采用交叉编译，所以要在 X86_64 电脑上使用 SDK，不要将 SDK 下载到板子上

2. 编译环境请使用 Ubuntu18.04（真机或 docker 容器），如果使用其他版本可能导致编译出错

3. 不要在虚拟机共享文件夹以及非英文目录存放、解压SDK

4. 获取、编译 SDK 请全程使用普通用户，不允许也不需要使用 root 权限（除非需要 apt 安装软件）

1.1.1. 安装工具¶

获取 SDK 需要先安装：

sudo apt update
sudo apt install -y repo git python

1.1.2. 初始化仓库¶

方法一（推荐国内用户使用）

SDK 源码存放于 gitlab，国内用户可能下载完整的 SDK 仓库速度比较慢，所以我们提供了一个 SDK 基础包(Linux SDK)，国内用户只需要在此基础包上同步 gitlab 上的代码就可以了

下载完成后先验证一下 MD5 码：

$ md5sum rk3588_linux_release_20230114_v1.0.6c_0*
c3bcb3f92bd139f72551c89f75d39bfa  rk3588_linux_release_20230114_v1.0.6c_00
ebb658571a645d4af1e2b569709480b7  rk3588_linux_release_20230114_v1.0.6c_01
9761cc324e9f7133500b590c441b0307  rk3588_linux_release_20230114_v1.0.6c_02
7adc9fe2158d7681554dce1def238f49  rk3588_linux_release_20230114_v1.0.6c_03
3d9201e3849b8a523c05920bebe28b39  rk3588_linux_release_20230114_v1.0.6c_04
6faaee006fe60fc9be60a64a01506cb6  rk3588_linux_release_20230114_v1.0.6c_05

确认无误后，就可以解压：

# 解压
mkdir -p ~/proj/rk3588_sdk
cd ~/proj/rk3588_sdk
cat path/to/rk3588_linux_release_20230114_v1.0.6c_0* | tar -xv

# 导出数据
.repo/repo/repo sync -l

方法二

通过 repo 拉取代码，此方法对网络要求较高，有条件可以使用

可选择获取完整 SDK 或者 BSP：

mkdir ~/proj/rk3588_sdk/
cd ~/proj/rk3588_sdk/

## 完整 SDK
repo init --no-clone-bundle --repo-url https://gitlab.com/firefly-linux/git-repo.git -u https://gitlab.com/firefly-linux/manifests.git -b master -m rk3588_linux_release.xml

## BSP （ 只包含基础仓库和编译工具 ）
## BSP 包括 device/rockchip 、docs 、 kernel 、 u-boot 、 rkbin 、 tools 和交叉编译链
repo init --no-clone-bundle --repo-url https://gitlab.com/firefly-linux/git-repo.git -u https://gitlab.com/firefly-linux/manifests.git -b master -m rk3588_linux_bsp_release.xml

1.1.3. 同步代码¶

执行如下命令同步代码：

# 进入 SDK 根目录
cd ~/proj/rk3588_sdk

# 同步
.repo/repo/repo sync -c --no-tags
.repo/repo/repo start firefly --all

后续可以使用以下命令更新 SDK：

.repo/repo/repo sync -c --no-tags

因为网络环境等原因，.repo/repo/repo sync -c --no-tags 命令更新代码可能会失败，可多次反复执行。

1.2. Linux SDK 配置介绍¶

1.2.1. 目录介绍¶

$ tree -L 1
.
├── app
├── buildroot                                               # Buildroot 根文件系统编译目录
├── build.sh -> device/rockchip/common/build.sh             # 编译脚本
├── device                                                  # 编译相关配置文件
├── docs                                                    # 文档
├── envsetup.sh -> buildroot/build/envsetup.sh
├── external
├── kernel
├── Makefile -> buildroot/build/Makefile
├── mkfirmware.sh -> device/rockchip/common/mkfirmware.sh   # 链接脚本
├── prebuilts                                               # 交叉编译工具链
├── rkbin
├── rkflash.sh -> device/rockchip/common/rkflash.sh         # 烧写脚本
├── tools                                                   # 工具目录
├── u-boot

1.2.2. 配置文件介绍¶

在 device/rockchip/rk3588/ 目录下，有不同板型的配置文件(xxxx.mk)，用于管理 SDK 每个环节的编译配置，相关配置介绍：

# Target arch
export RK_ARCH=arm64 # 64位 ARM 架构
# Uboot defconfig
export RK_UBOOT_DEFCONFIG=xxxx_defconfig # u-boot 配置文件
# Kernel defconfig
export RK_KERNEL_DEFCONFIG=xxxx_defconfig # kernel 配置文件
# Kernel defconfig fragment
export RK_KERNEL_DEFCONFIG_FRAGMENT=xxxx.config # kernel 配置文件（fragment）
# Kernel dts
export RK_KERNEL_DTS=xxxx.dts # dts 文件
# parameter for GPT table
export RK_PARAMETER=parameter-xxxx.txt # 分区表
# rootfs image path
export RK_ROOTFS_IMG=ubuntu_rootfs/rootfs.img # 根文件系统路径

1.2.3. 分区说明¶

1.2.3.1. parameter 分区表¶

parameter.txt 文件中包含了固件的分区信息，以 parameter-ubuntu-fit.txt 为例：

路径：device/rockchip/rk3588/parameter-xxxxxx-fit.txt

FIRMWARE_VER: 1.0
MACHINE_MODEL: RK3588
MACHINE_ID: 007
MANUFACTURER: RK3588
MAGIC: 0x5041524B
ATAG: 0x00200800
MACHINE: 0xffffffff
CHECK_MASK: 0x80
PWR_HLD: 0,0,A,0,1
TYPE: GPT
CMDLINE: mtdparts=rk29xxnand:0x00002000@0x00004000(uboot),0x00002000@0x00006000(misc),0x00020000@0x00008000(boot:bootable),0x00040000@0x00028000(recovery),0x00010000@0x00068000(backup),0x00c00000@0x00078000(rootfs),0x00040000@0x00c78000(oem),-@0x00cb8000(userdata:grow)
uuid:rootfs=614e0000-0000-4b53-8000-1d28000054a9

CMDLINE 属性是我们关注的地方，以 uboot 为例， 0x00002000@0x00004000(uboot) 中 0x00004000 为uboot 分区的起始位置，0x00002000 为分区的大小，以此类推。

1.2.3.2. package-file¶

package-file 文件用于打包固件时确定需要的分区镜像和镜像路径，同时它需要与 parameter.txt 文件保持一致。

路径：tools/linux/Linux_Pack_Firmware/rockdev/rk3588-package-file

# NAME          Relative path
#
#HWDEF          HWDEF
package-file    package-file
bootloader      Image/MiniLoaderAll.bin
parameter       Image/parameter.txt
uboot           Image/uboot.img
misc            Image/misc.img
boot            Image/boot.img
recovery        Image/recovery.img
rootfs          Image/rootfs.img
userdata        RESERVED
backup          RESERVED

1.3. 编译 Ubuntu 固件¶

本章介绍 Ubuntu 固件的编译流程，推荐在 Ubuntu 18.04 系统环境下进行开发，若使用其它系统版本，可能需要对编译环境做相应调整。

本教程的编译部分适用于 v1.0.6e 以上 SDK 版本

$ readlink -f .repo/manifest.xml
/home/daijh/p/rk3588/.repo/manifests/rk3588/rk3588_linux_release_20230301_v1.0.6e.xml

1.3.1. 准备工作¶

1.3.1.1. 搭建编译环境¶

sudo apt-get install repo git ssh make gcc libssl-dev liblz4-tool \
expect g++ patchelf chrpath gawk texinfo chrpath diffstat binfmt-support \
qemu-user-static live-build bison flex fakeroot cmake gcc-multilib g++-multilib \
unzip \
device-tree-compiler ncurses-dev \

1.3.2. 编译 SDK¶

1.3.2.1. 编译前配置¶

在 device/rockchip/rk3588/ 目录下，有不同板型的配置文件，选择配置文件：

./build.sh aio-3588sg-ubuntu.mk 

or

./build.sh aio-3588sg-ubuntu.mk # MIPI 屏幕

1.3.2.2. 编译¶

1.3.2.2.1. 全自动编译¶

下载根文件系统：Ubuntu 根文件系统(64位)，放到 SDK 路径下

7z x ubuntu-aarch64-rootfs.7z
mkdir ubuntu_rootfs
mv ubuntu-aarch64-rootfs.img ubuntu_rootfs/rootfs.img

开始编译

./build.sh

生成的完整固件会保存到 rockdev/pack/ 目录。

1.3.2.2.2. 部分编译¶

编译 u-boot

./build.sh uboot

编译 kernel

./build.sh extboot

编译 recovery

./build.sh recovery

下载根文件系统：Ubuntu 根文件系统(64位)，放到 SDK 路径下

7z x ubuntu-aarch64-rootfs.7z
mkdir ubuntu_rootfs
mv ubuntu-aarch64-rootfs.img ubuntu_rootfs/rootfs.img

更新各部分镜像链接到 rockdev/ 目录：

./mkfirmware.sh

打包固件，生成的完整固件会保存到 rockdev/pack/ 目录。

./build.sh updateimg

1.4. 编译 Yocto 固件¶

1.4.1. 获取SDK¶

repo init --no-clone-bundle --repo-url https://gitlab.com/firefly-linux/git-repo.git -u https://gitlab.com/firefly-linux/manifests.git -b master -m rk3588_yocto_kirkstone_release.xml
.repo/repo/repo sync -c

1.4.2. 编译¶

1.4.2.1. 选择映像¶

Yocto 项目提供了一些可用于不 layer 的映像。下表列出目前支持构建的映像和相关配方。

映像名字	描述	提供的layer
core-image-minimal	A small image that only allows a device to boot	Poky
core-image-minimal-xfce	A XFCE minimal demo image	meta-openembedded/meta-xfce
core-image-sato	Image with Sato, a mobile environment and visual style for mobile devices. The image supports X11 with a Sato theme, Pimlico applications, and contains terminal, editor, and file manager	Poky
core-image-weston	A very basic Wayland image with a terminal	Poky
core-image-x11	A very basic X11 image with a terminal	Poky

1.4.3. 编译映像文件¶

使用 bitbake 命令构建的过程需要保证网络连接正常，如果是中国内陆客户需要保证能 ping 通外网

进入目录 <path/to/yocto/poky> ，按顺序执行如下命令

# Install the required environment packages
# sudo apt install zstd
source oe-init-build-env

# 添加 layer（只需要执行一次）
bitbake-layers add-layer ../../meta-openembedded/meta-oe
bitbake-layers add-layer ../../meta-openembedded/meta-python
bitbake-layers add-layer ../../meta-openembedded/meta-networking
bitbake-layers add-layer ../../meta-openembedded/meta-multimedia
bitbake-layers add-layer ../../meta-openembedded/meta-gnome
bitbake-layers add-layer ../../meta-openembedded/meta-xfce
bitbake-layers add-layer ../../meta-lts-mixins
bitbake-layers add-layer ../../meta-clang
bitbake-layers add-layer ../../meta-browser/meta-chromium
bitbake-layers add-layer ../../meta-rockchip

选择其中之一命令来编译完整 core-image recipes 。以下是基于 x11 的 core-image 。

MACHINE=aio-3588sg bitbake core-image-minimal
MACHINE=aio-3588sg bitbake core-image-minimal-xfce
MACHINE=aio-3588sg bitbake core-image-x11
MACHINE=aio-3588sg bitbake core-image-sato

以下是基于 wayland 的 core-image 。需要在 /path/to/yocto/meta-rockchip/conf/machine/include/display.conf 修改 DISPLAY_PLATFORM 为 wayland 。修改如下：

DISPLAY_PLATFORM ?= "wayland"
# DISPLAY_PLATFORM ?= "x11"

完成上述修改后，执行命令编译 core-image-weston

MACHINE=aio-3588sg bitbake core-image-weston

注意：如果在已经进行了完整编译一次 core-image 的基础上，需要更换编译的 core-image recipes 。需要将当前编译过 core-image 的清理掉，再开始编译新的 core-image 。

例如：当前编译的是 core-image-minimal 。需要更换成 core-image-sato 。

MACHINE=aio-3588sg bitbake core-image-minimal -c clean
MACHINE=aio-3588sg bitbake core-image-sato

如果想单独编译部分 recipes 可以参考以下内容：

# kernel
MACHINE=aio-3588sg bitbake linux-rockchip
        
# u-boot
MACHINE=aio-3588sg bitbake u-boot-rockchip
        
# rkmpp
MACHINE=aio-3588sg bitbake rockchip-mpp
        
# rockchip-librga
MACHINE=aio-3588sg bitbake rockchip-librga
        
# 参看更多编译对象
MACHINE=aio-3588sg bitbake -s

1.4.4. 调整编译速度¶

修改文件/path/to/yocto/meta-rockchip/conf/machine/firefly-rk3588.conf 中的 BB_NUMBER_THREADS 和 PARALLEL_MAKE 变量配置。若线程数量设置过大可能会导致机器内存不足，导致编译失败。请根据编译机器的配置来设置编译速度。

BB_NUMBER_THREADS = "4"
PARALLEL_MAKE = "-j 4"

BB_NUMBER_THREADS: The maximum number of threads BitBake simultaneously executes.
BB_NUMBER_PARSE_THREADS: The number of threads BitBake uses during parsing.
PARALLEL_MAKE: Extra options passed to the make command during the do_compile task in order to specify parallel compilation on the local build host.
PARALLEL_MAKEINST: Extra options passed to the make command during the do_install task in order to specify parallel installation on the local build host.

1.4.5. 更多 bitbake 选项¶

从根本上说，BitBake 是一个通用任务执行引擎，它允许 shell 和 Python 任务高效并行运行，同时在复杂的任务间依赖约束下工作。 BitBake 的主要用户之一，OpenEmbedded，利用这个核心并使用面向任务的方法构建嵌入式 Linux 软件堆栈。更多详细使用方法请查看《bitbake-user-manual》。

MACHINE=aio-3588sg bitbake <target> <paramater>
# e.g
MACHINE=aio-3588sg bitbake u-boot-rockchip -c clean
MACHINE=aio-3588sg bitbake u-boot-rockchip

Bitbake paramater	描述
-c fetch	拉取目标所需要的代码
-c clean	清除目标的输出文件
-c cleanall	删除目标所有输出文件、共享高速缓存（shared state cache）和源代码
-c compile -f	使用此选项可在部署映像后强制重新编译，但不建议使用，除非 Yocto Project 不知道目标代码已经发生改变
-c listtasks	列出目标定义的所有 target

1.4.6. 分区固件烧写¶

编译生成的固件位于目录<path/to/yocto>/build/tmp/deploy/images/<board>/

$ sudo upgrade_tool di -boot boot.img
$ sudo upgrade_tool di -uboot uboot.img
$ sudo upgrade_tool di -misc misc.img
$ sudo upgrade_tool di -recovery recovery.img

分区烧写适用于调试阶段，固件验证请使用下文的统一固件烧写
rootfs 不支持单独烧写，需要打包完整固件再烧写

1.4.7. 统一固件烧写¶

编译生成的固件位于目录<path/to/yocto>/build/tmp/deploy/images/<board>/，待下载的文件为.wic与update.img，进入loader模式后执行如下命令：

$ sudo upgrade_tool wl 0 <IMAGE NAME>.wic
$ sudo upgrade_tool uf update.img

固件默认登录账号为：root，密码为：firefly 。固件含有普通用户账号名称为：firefly ，密码为：firefly 。

注意：如果客户在 Windows PC 上开发，使用 RKdevtool 直接烧录 update.img 即可，不需要烧录 <IMAGE NAME>.wic。但是要注意一点是 update.img 是一个链接文件，实际得选择链接文件所指向的实际文件。

1.4.8. 相关概述¶

Yocto Project 是一个专注于嵌入式 Linux® 操作系统开发的开源协作项目，它提供灵活的工具集和开发环境，允许全球的嵌入式设备开发人员通过共享技术，软件堆栈，配置和用于创建这些定制的Linux映像的最佳实践进行协作。有关 Yocto 项目的更多信息，请参阅 Yocto Project 官网：www.yoctoproject.org/。 Yocto Project 官网上有 Yocto Project Reference Manual 和 Yocto Project Overview 等相关文档详细描述了如何构建系统。

1.4.9. Yocto Project Release layer 介绍¶

layer	路径	优先级(数字越大优先级越高)	描述
meta-oe	meta-openembedded/meta-oe	6	contains a large amount of additional recipes
meta-python	meta-openembedded/meta-python	7	Provide Python recipes
meta-qt5	meta-qt5	7	Provides QT5 recipes
meta-clang	meta-clang	7	clang compiler
meta-rockchip	meta-rockchip	9	Rockchip board level support available
meta	meta	5	Contains the OpenEmbedded-Core metadata
meta-poky	meta-poky	5	Holds the configuration for the Poky reference distribution
meta-yocto-bsp	meta-yocto-bsp	5	Configuration for the Yocto Project reference hardware board support package.
meta-chromium	meta-chromium	7	Provide chromium browser recipe

1.5. 编译 Debian 固件¶

本章介绍 Debian 固件的编译流程，推荐在 Ubuntu 18.04 系统环境下进行开发，若使用其它系统版本，可能需要对编译环境做相应调整。

本教程的编译部分适用于 v1.0.6e 以上 SDK 版本

$ readlink -f .repo/manifest.xml
/home/daijh/p/rk3588/.repo/manifests/rk3588/rk3588_linux_release_20230301_v1.0.6e.xml

1.5.1. 准备工作¶

1.5.1.1. 搭建编译环境¶

sudo apt-get install repo git ssh make gcc libssl-dev liblz4-tool \
expect g++ patchelf chrpath gawk texinfo chrpath diffstat binfmt-support \
qemu-user-static live-build bison flex fakeroot cmake gcc-multilib g++-multilib \
unzip \
device-tree-compiler ncurses-dev \

1.5.2. 编译 SDK¶

1.5.2.1. 编译前配置¶

在 device/rockchip/rk3588/ 目录下，有不同板型的配置文件，选择配置文件：

./build.sh aio-3588sg-debian.mk

or

./build.sh aio-3588sg-debian.mk # MIPI 屏幕

1.5.2.2. 编译¶

1.5.2.2.1. 全自动编译¶

下载根文件系统：Debian 根文件系统(64位)，放到 SDK 路径下

7z x debian_rk3588_rootfs_xxx.7z
mkdir debian
mv debianxx-rootfs.img debian/debian-rootfs.img

开始编译

./build.sh

生成的完整固件会保存到 rockdev/pack/ 目录。

1.5.2.2.2. 部分编译¶

编译 u-boot

./build.sh uboot

编译 kernel

./build.sh extboot

编译 recovery

./build.sh recovery

下载根文件系统：Debian 根文件系统(64位)，放到 SDK 路径下

7z x debian_rk3588_rootfs_xxx.7z
mkdir debian
mv debianxx-rootfs.img debian/rootfs.img

更新各部分镜像链接到 rockdev/ 目录：

./mkfirmware.sh

打包固件，生成的完整固件会保存到 rockdev/pack/ 目录。

./build.sh updateimg

1.6. 编译 Buildroot 固件¶

本章介绍 Buildroot 固件的编译流程，推荐在 Ubuntu 18.04 系统环境下进行开发，若使用其它系统版本，可能需要对编译环境做相应调整。

本教程的编译部分适用于 v1.0.6e 以上 SDK 版本

$ readlink -f .repo/manifest.xml
/home/daijh/p/rk3588/.repo/manifests/rk3588/rk3588_linux_release_20230301_v1.0.6e.xml

1.6.1. 准备工作¶

1.6.1.1. 搭建编译环境¶

sudo apt-get install repo git ssh make gcc libssl-dev liblz4-tool \
expect g++ patchelf chrpath gawk texinfo chrpath diffstat binfmt-support \
qemu-user-static live-build bison flex fakeroot cmake gcc-multilib g++-multilib \
unzip \
device-tree-compiler ncurses-dev \

1.6.2. 编译 SDK¶

1.6.2.1. 编译前配置¶

在 device/rockchip/rk3588/ 目录下，有不同板型的配置文件，选择配置文件：

./build.sh aio-3588sg-buildroot.mk

or

./build.sh aio-3588sg-buildroot.mk # MIPI 屏幕

1.6.2.2. 编译¶

1.6.2.2.1. 全自动编译¶

全自动编译会执行上述编译、打包操作，生成 RK 固件。

./build.sh

打包固件，生成的完整固件会保存到 rockdev/pack/ 目录。

1.6.2.2.2. 部分编译¶

编译 u-boot

./build.sh uboot

编译 kernel

./build.sh extboot

编译 recovery

./build.sh recovery

编译 buildroot

./build.sh rootfs

更新各部分镜像链接到 rockdev/ 目录：

./mkfirmware.sh

打包固件，生成的完整固件会保存到 rockdev/pack/ 目录。

./build.sh updateimg