2. Buildroot 开发

Buildroot 是 Linux 平台上一个构建嵌入式 Linux 系统的框架。整个 Buildroot 是由 Makefile(*.mk) 脚本和 Kconfig(Config.in) 配置文件构成的。你可以和编译 Linux 内核一样,通过 buildroot 配置,menuconfig 修改,编译出一个完整的可以直接烧写到机器上运行的 Linux 系统软件(包含 boot、kernel、rootfs 以及 rootfs 中的各种库和应用程序)。若您要了解更多 Buildroot 开发相关内容,可以参考 Buildroot 官方的 《开发手册》

下面以 ROC-RK3568-PCBuildroot 开发为例进行阐述。

2.1. 交叉编译 Qt-5.12.2

若您想在 Firefly 官方发布的 Buildroot 系统上进行 Qt 开发,需详细阅读本章节。

2.1.1. 交叉编译工具链

Firefly 提取了 Buildroot 的交叉编译工具链,您可以直接使用该工具链开发 Buildroot 上的 Qt 应用程序,而无需下载编译 SDK 代码。

工具链支持 EGLFS、LinuxFB、Wayland 等插件。

使用环境:

主机:x86-64 / Ubuntu 18.04
设备:Firefly RK3568 RK3566 RK3399 RK3288 PX30 .. / Buildroot

2.1.1.1. 下载

对于 32 位芯片,如 RK3288,下载 firefly-qt-5.12.2-arm.tar.gz;对于其它 64 位芯片,如 RK3568,下载 firefly-qt-5.12.2-aarch64.tar.gz

下载链接(提取码:6dg7)

下文将以 firefly-qt-5.12.2-aarch64.tar.gz 为例进行说明。

2.1.1.2. 目录结构

解压下载好的压缩包:

tar -zxvf firefly-qt-5.12.2-aarch64.tar.gz

目录结构:

firefly-qt-5.12.2-aarch64/
├── aarch64.tar.gz # 用于 Qt 程序运行的库文件、插件等
├── demo
│   └── mainwindow # demo 程序
├── firefly-qt-5.12.2-aarch64 # 交叉编译工具链
└── ReadMe # 使用说明

2.1.2. 配置交叉编译环境

将工具链拷贝到主机的指定目录:

cd firefly-qt-5.12.2-aarch64/
# 该目录 `/opt/` 不可修改
cp -rdf firefly-qt-5.12.2-aarch64 /opt/

若拷贝失败,先修改下目录权限,再执行上述操作:

sudo chmod 777 /opt/

2.1.2.1. 交叉编译

以 demo 程序为例,运行如下命令:

cd demo/mainwindow/
/opt/firefly-qt-5.12.2-aarch64/host/bin/qmake
make

编译完成后,会生成可执行程序 demo/mainwindow/mainwindow

2.1.3. 配置运行环境

使用 U 盘将 aarch64.tar 拷贝到设备上:

cp /media/usb0/aarch64.tar /userdata/

解压:

cd /userdata/
tar -xvf aarch64.tar

将文件拷贝到对应目录:

cd aarch64/
cp -rdf usr/lib/* /usr/lib/
cp -rdf usr/qml/* /usr/qml/
cp usr/bin/gdbserver /usr/bin/

2.1.3.1. 运行程序

将编译好的可执行程序 mainwindow 拷贝到设备上。

默认板子运行了 Wayland 桌面环境,按如下方式运行:

# 设置环境变量
export XDG_RUNTIME_DIR=/tmp/.xdg
# 运行
./mainwindow -platform wayland

使用 eglfs 插件运行:

# 退出 Wayland 桌面环境
/etc/init.d/S50launcher stop
# 运行
./mainwindow -platform eglfs

2.2. 目录结构

Buildroot SDK 位于 Firefly_Linux_SDK 目录,其目录结构如下:

buildroot/
├── arch                # CPU 架构的构建、配置文件
├── board               # 具体单板相关的文件
├── boot                # Bootloaders 的构建、配置文件
├── build
├── CHANGES             # Buildroot 修改日志
├── Config.in
├── Config.in.legacy
├── configs             # 具体单板的 Buildroot 配置文件
├── COPYING
├── DEVELOPERS
├── dl                  # 下载的程序、源码压缩包、补丁等
├── docs                # 文档
├── fs                  # 各种文件系统的构建、配置文件
├── linux               # Linux 的构建、配置文件
├── Makefile
├── Makefile.legacy
├── output              # 编译输出目录
├── package             # 所有软件包的构建、配置文件
├── README              # Buildroot 简单说明
├── support             # 为 Bulidroot 提供功能支持的脚本、配置文件
├── system              # 制作根文件系统的构建、配置文件
├── toolchain           # 交叉编译工具链的构建、配置文件
└── utils               # 实用工具

2.3. 配置

选择默认配置文件:

# 进入 Firefly_Linux_SDK 根目录
cd path/to/Firefly_Linux_SDK/
# 选择配置文件
# `configs/rockchip_rk3568_defconfig`
source envsetup.sh rockchip_rk3568

执行完成后会生成编译输出目录,output/rockchip_rk3568,后续也可以在该目录下执行 make 相关操作。

2.3.1. 软件包配置

打开配置界面:

make menuconfig

_images/Buildroot_menuconfig.png

我们可以在配置界面添加或裁剪一些工具,按需求定制系统功能。以添加 qt53d 为例:

输入 / 进入搜索界面,输入要查找的内容 qt53d,按回车进行搜索:

_images/Buildroot_serach_qt53d.png

_images/Buildroot_qt53d.png

选择 1 跳转到对应页面,按空格选中配置:

_images/Buildroot_select_qt53d.png

配置完成后,移动到 Save 按回车保存到 .config;移动到 Exit 按回车退出。

_images/Buildroot_Save-Exit.png

保存配置文件:

make savedefconfig

将修改保存到配置文件 configs/rockchip_rk3568_defconfig

2.3.2. Busybox 配置

打开配置界面,进行配置:

make busybox-menuconfig

_images/Buildroot_busybox-menuconfig.png

配置完成后,移动到 Exit 按回车退出,在弹窗页面选择 Yes 保存到 .config

_images/Buildroot_busybox-save.png

保存配置文件:

make busybox-update-config

将修改保存到配置文件 board/rockchip/common/base/busybox.config

2.4. 编译

配置好 Buildroot 后,直接运行 make 进行编译。

2.4.1. 编译说明

运行 make 进行编译时,会执行以下过程:

  1. 下载源码;

  2. 配置、编译、安装交叉编译工具链;

  3. 配置、编译、安装选择的软件包;

  4. 按选择的格式生成根文件系统;

关于 make 的更多用法,可通过 make help 获得。

2.4.2. 编译软件包

我们可以执行 make <package> 单独编译某个软件包。软件包的编译主要包括下载,解压,打补丁,配置,编译,安装等过程,具体可以查看 package/pkg-generic.mk

  • 下载

    Buildroot 会根据配置 package/<package>/<package>.mk,自动从网络获取对应的软件包,包括一些第三方库,插件,实用工具等,放在 dl/ 目录。

  • 解压

    软件包会解压在 output/rockchip_rk3568/build/<package>-<version> 目录下。

  • 打补丁

    补丁集中放在 package/<packgae>/ 目录,Buildroot 会在解压软件包后为其打上相应的补丁。如果要修改源码,可以通过打补丁的方式进行修改。

  • 配置

  • 编译

  • 安装

    编译完成后,会将需要的编译生成文件拷贝到 output/rockchip_rk3568/target/ 目录。

对于某个软件包,我们可以通过 make <package>-<target> 调用软件包构建中的某一步骤,如下:

Package-specific:
  <pkg>                  - Build and install <pkg> and all its dependencies
  <pkg>-source           - Only download the source files for <pkg>
  <pkg>-extract          - Extract <pkg> sources
  <pkg>-patch            - Apply patches to <pkg>
  <pkg>-depends          - Build <pkg>'s dependencies
  <pkg>-configure        - Build <pkg> up to the configure step
  <pkg>-build            - Build <pkg> up to the build step
  <pkg>-graph-depends    - Generate a graph of <pkg>'s dependencies
  <pkg>-dirclean         - Remove <pkg> build directory
  <pkg>-reconfigure      - Restart the build from the configure step
  <pkg>-rebuild          - Restart the build from the build step

2.5. 编译输出目录

编译完成后,在编译输出目录 output/rockchip_rk3568 会生成子目录,说明如下:

  • build/ 包含所有的源文件,包括 Buildroot 所需主机工具和选择的软件包,这个目录包含所有软件包源码。

  • host/ 主机端编译需要的工具,包括交叉编译工具。

  • images/ 包含压缩好的根文件系统镜像文件。

  • staging/ 这个目录类似根文件系统的目录结构,包含编译生成的所有头文件和库,以及其他开发文件,不过它们没有裁剪,比较庞大,不适用于目标文件系统。

  • target/ 包含完整的根文件系统,对比 staging/,它没有开发文件,不包含头文件,二进制文件也经过 strip 处理。

2.6. 交叉编译工具

Buildroot 编译完成后,会在 output/rockchip_rk3568/host/ 目录下,生成交叉编译工具,我们可以用来编译目标程序。

  • 交叉编译工具目录

output/rockchip_rk3568/host/bin/

  • 编译示例 hello.c

#include <stdio.h>
#include <stdlib.h>

int main(int argc, char *argv[])
{
        printf("Hello World!\n");
        return 0;
}
  • 编译

.../host/bin/arm-buildroot-linux-gnueabihf-gcc hello.c -o hello
  • 运行

将可执行程序 hello 拷贝到设备,运行 ./hello,则会看到打印信息 Hello World!

2.7. 重建

对于重建的具体说明,可以查看文档 buildroot/docs/manual/rebuilding-packages.txt

2.7.1. 重建软件包

在开发过程中,若修改了某个软件包的源码,Buildroot 是不会重新编译该软件包的。可以按如下方式操作:

  • 方式一

make <package>-rebuild
  • 方式二

# 删除软件包的编译输出目录
rm -rf output/rockchip_rk3568/build/<package>-<version>
# 编译
make <package>

2.7.2. 完全重建

当通过 make menuconfigmake xconfig 或其他配置工具之一更改系统配置时,Buildroot 不会尝试检测应重建系统的哪些部分。在某些情况下,Buildroot 应该重建整个系统,在某些情况下,仅应重建软件包的特定子集。但是以完全可靠的方式检测到这一点非常困难,因此 Buildroot 开发人员已决定不尝试这样做。

2.7.2.1. 何时需要完全重建

  • 更改目标体系结构配置时,需要完全重建;

  • 更改工具链配置时,需要完全重建;

  • 将其他软件包添加到配置中时,不一定需要完全重建;

  • 从配置中删除软件包时,Buildroot 不会执行任何特殊操作。它不会从目标根文件系统或工具链中删除此软件包安装的文件。需要完全重建才能删除这些文件;

  • 更改软件包的子选项时,不会自动重建软件包;

  • 对根文件系统框架进行更改时,需要完全重建;

一般而言,当你遇到构建错误并且不确定所做的配置更改可能带来的后果时,请进行完全重建。具体说明可以查看文档 rebuilding-packages.txt

2.7.2.2. 如何完全重建

  • 方式一

直接删除编译输出目录,之后重新进行配置、编译。

rm -rf output/
  • 方式二

执行如下命令,会删除编译输出并重新编译。

make clean all

2.8. 新增本地源码包

开发过程中,Buildroot 自带的软件包有时可能无法满足我们的需求,为此我们需要添加自定义的软件包。Buildroot 支持多种格式的软件包,包括 generic-package、cmake-package、autotools-package 等,我们以 generic-package 举例说明。

  • 创建工程目录

cd path/to/Firefly_Linux_SDK/
mkdir buildroot/package/rockchip/firefly_demo/
  • 新建 Config.in

firefly_demo/ 下添加 Config.in:

config BR2_PACKAGE_FIREFLY_DEMO
        bool "Simple Firefly Demo"
  • 新建 firefly_demo.mk

firefly_demo/ 下添加 firefly_demo.mk:

##################################################
###########
#
### firefly_demo
#
##################################################
###########
ifeq ($(BR2_PACKAGE_FIREFLY_DEMO), y)

        FIREFLY_DEMO_VERSION:=1.0.0
        FIREFLY_DEMO_SITE=$(TOPDIR)/../external/firefly_demo/src
        FIREFLY_DEMO_SITE_METHOD=local

define FIREFLY_DEMO_BUILD_CMDS
        $(TARGET_MAKE_ENV) $(MAKE) CC=$(TARGET_CC) CXX=$(TARGET_CXX) -C $(@D)
endef

define FIREFLY_DEMO_CLEAN_CMDS
        $(TARGET_MAKE_ENV) $(MAKE) -C $(@D) clean
endef

define FIREFLY_DEMO_INSTALL_TARGET_CMDS
        $(TARGET_MAKE_ENV) $(MAKE) -C $(@D) install
endef

define FIREFLY_DEMO_UNINSTALL_TARGET_CMDS
        $(TARGET_MAKE_ENV) $(MAKE) -C $(@D) uninstall
endef

$(eval $(generic-package))
endif
  • 创建源码目录

上文的 Makefile 文件里已经指定了源码目录 external/firefly_demo/src

cd path/to/Firefly_Linux_SDK/
mkdir external/firefly_demo/src
  • 编写源码 firefly_demo.c

firefly_demo/src/ 下添加 firefly_demo.c:

#include <stdio.h>
#include <stdlib.h>

int main(int argc, char *argv[])
{
        printf("Hello World!\n");
        return 0;
}
  • 编写 Makefile

firefly_demo/src/ 下添加 Makefile:

DEPS =
OBJ = firefly_demo.o
CFLAGS =
%.o: %.c $(DEPS)
        $(CC) -c -o $@ $< $(CFLAGS)

firefly_demo: $(OBJ)
        $(CXX) -o $@ $^ $(CFLAGS)

.PHONY: clean
clean:
        rm -f *.o *~ firefly_demo

.PHONY: install
install:
        cp -f firefly_demo $(TARGET_DIR)/usr/bin/

.PHONY: uninstall
uninstall:
        rm -f $(TARGET_DIR)/usr/bin/firefly_demo
  • 修改上一级 Config.in

buildroot/package/rockchip/Config.in 末尾添加一行:

source "package/rockchip/firefly_demo/Config.in"
  • 配置软件包

打开配置菜单 make menuconfig,找到 firefly_demo 并选中配置。

  • 编译

# 编译 firefly_demo
make firefly_demo
# 打包进根文件系统
make
# 若修改源码,重新编译软件包
make firefly_demo-rebuild

2.9. rootfs-overlay

rootfs-overly 是一个相当不错的功能,它能够在目标文件系统编译完成后将指定文件覆盖到某个目录。通过这种方式,我们可以方便地添加或修改一些文件到根文件系统。

假设我们要在根文件系统的 /etc/ 目录下添加文件 overlay-test,可以按如下步骤操作:

  • 设置 rootfs-overlay 根目录

打开配置菜单 make menuconfig,通过设置 BR2_ROOTFS_OVERLAY 选项,添加用于覆盖的根目录。对于 RK3568,默认已添加了目录 board/rockchip/rk356x/fs-overlay/

  • 添加文件到覆盖目录

cd buildroot/board/rockchip/rk356x/fs-overlay/
mkdir etc/
touch etc/overlay-test
  • 编译

make
  • 下载根文件系统

将编译好的根文件系统 output/rockchip_rk3568/images/rootfs.ext2 下载到设备。启动设备,可以看到已添加文件 /etc/overlay-test

也可以通过查看 target/ 目录,验证是否添加成功:

ls buildroot/output/rockchip_rk3568/target/etc/overlay-test