2. LubanCat-SDK¶
注解
LubanCat-SDK(旧版)将于2024年9月10日起逐步停止支持。RK系列板卡的后续开发支持已经转移到LubanCat-Linux-Generic-SDK(后文中称为LubanCat-SDK)。 原LubanCat-SDK则称为LubanCat-SDK(旧版)，独有内容将在标题添加 (旧版) 标识，未添加此标识则表示内容通用。
2.1. 板卡支持情况¶
2.1.1. rk312x¶
鲁班猫0H系列,使用RK3128主芯片
2.1.2. rk3528¶
鲁班猫Q1系列,使用RK3528A主芯片
2.1.3. rk3562¶
鲁班猫1HS系列,使用RK3562主芯片
2.1.4. rk3566_rk3568¶
鲁班猫0系列,使用RK3566主芯片
鲁班猫1系列,使用RK3566主芯片
鲁班猫2系列,使用RK3568/RK3568J(工业级)主芯片
2.1.5. rk3588¶
鲁班猫4系列,使用RK3588s主芯片
鲁班猫5系列,使用RK3588主芯片
2.2. LubanCat-SDK简介¶
LubanCat-SDK是基于瑞芯微通用Linux SDK工程的深度定制版本，适用于以Rockchip处理器为主芯片的LubanCat-RK系列板卡。
整个SDK工程，目录包含有 debian、kernel、u-boot、device、rkbin、ubuntu等目录。 每个目录或其子目录会对应一个 git 工程，提交需要在各自的目录下进行。
debian：Debian根文件系统构建脚本。
device/rockchip： 存放各芯片板级配置，以及构建进行相关的脚本等。
kernel： 存放 kernel 源码。
prebuilts： 存放交叉编译工具链。
rkbin： 存放 Rockchip 相关的 Binary 和工具。
rockdev： 存放编译输出的镜像文件(软链接到output/firmware)。
output： 存放编译过程中生成的过程文件、日志、编译出的镜像等。
tools： 存放 Linux 和 Windows 操作系统环境下常用工具。
u-boot：存放基于v2017.09版本进行开发的uboot代码。
ubuntu: Ubuntu根文件系统构建脚本
2.3. extboot分区介绍¶
extboot分区系统是野火基于瑞芯微Linux_SDK框架搭建的一种LubanCat-RK系列板卡通用镜像实现方式。 可以实现一个镜像烧录到LubanCat使用同一型号处理器的所有板卡，解决了默认rkboot分区方式设备树固定，导致一个镜像只能适配一款板卡的问题， 大大降低了由于型号众多导致的后期维护的复杂性。
extboot分区使用ext4文件系统格式，在编译过程中将所有LubanCat-RK系列板卡设备树都编译并打包到分区内， 并借助SDRADC读取板卡硬件ID，来实现设备树自动切换。同时支持设备树插件，自动更新内核deb包，在线更新内核和驱动模块等功能。
我们还对系统镜像的分区做了调整，删减一些冗余功能，实现了对系统存储的高效利用。
2.4. SDK 开发环境搭建¶
LubanCat-SDK是基于Ubuntu LTS 系统开发测试的，在开发过程中，主要是用Ubuntu 20.04版本， 我们推荐用户使用Ubuntu20.04或Ubuntu22.04，不支持Ubuntu20.04以下版本开发。
硬件配置推荐：64位系统，硬盘空间⼤于80G。如果您进⾏多个构建，将需要更⼤的硬盘空间。
安装SDK依赖的软件包
1 2 3 4 5 6 7 8 9 | # 安装SDK构建所需要的软件包
# 整体复制下面内容到终端中安装
sudo apt-get update && sudo apt-get install git ssh make gcc libssl-dev \
liblz4-tool expect expect-dev 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 \
libgucharmap-2-90-dev bzip2 expat gpgv2 cpp-aarch64-linux-gnu libgmp-dev \
libmpc-dev bc python-is-python3 python3-pip python2 u-boot-tools curl \
python3-pyelftools dpkg-dev
|
2.5. 安装repo¶
repo是google⽤Python脚本写的调⽤git的⼀个脚本，主要是⽤来下载、管理项⽬的软件仓库。
1 2 3 4 5 6 7 | mkdir ~/bin
curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
# 如果上面的地址无法访问，可以用下面的：
# curl -sSL 'https://gerrit-googlesource.proxy.ustclug.org/git-repo/+/master/repo?format=TEXT' |base64 -d > ~/bin/repo
chmod a+x ~/bin/repo
echo PATH=~/bin:$PATH >> ~/.bashrc
source ~/.bashrc
|
执行完上面的命令后我们来验证repo是否安装成功能正常运行。
1 2 3 4 5 6 7 8 9 10 11 12 13 | repo --version
#返回以下信息
#返回的信息根据Ubuntu版本的不同略有差异
<repo not installed>
repo launcher version 2.32
(from /home/he/bin/repo)
git 2.25.1
Python 3.8.10 (default, Nov 14 2022, 12:59:47)
[GCC 9.4.0]
OS Linux 5.15.0-60-generic (#66~20.04.1-Ubuntu SMP Wed Jan 25 09:41:30 UTC 2023)
CPU x86_64 (x86_64)
Bug reports: https://bugs.chromium.org/p/gerrit/issues/entry?template=Repo+tool+issue
|
2.6. SDK源码获取¶
LubanCat-SDK的代码被划分为了若干git仓库分别进行版本管理， 我们可以使用repo工具对这些git仓库进行统一的下载，提交，切换分支等操作。
运行以下命令，将在当前用户的家目录下创建一个名为LubanCat_SDK的目录，用来放入SDK源码。
1 | mkdir ~/LubanCat_SDK
|
2.6.1. 切换Python 3 版本¶
1 2 | #查看当前Python版本
python -V
|
若返回的版本号为Python3版本，则无需再切换Python版本。若为Python2版本或未发现python，则可以用以下方式切换：
1 2 3 4 5 6 7 8 | #查看当前系统安装的Python版本有哪些
ls /usr/bin/python*
#将python链接到python3
sudo ln -sf /usr/bin/python3 /usr/bin/python
#重新查看默认Python版本
python -V
|
此时系统默认Python版本切换为python3
2.6.2. Git配置¶
设置自己的git信息，以确保后续拉取代码时正常进行，如果不需要提交代码的话可以随意设置用户名和邮箱地址。
1 2 | git config --global user.name "your name"
git config --global user.email "your mail"
|
2.6.3. SDK在线下载并同步¶
LubanCat-SDK可以适配不同的板卡。由于使用这种方式要从Github拉取大量的仓库， 体积很大，对于不能快速访问Github的用户不建议使用这种方式。
1 2 3 4 5 6 7 8 9 | cd ~/LubanCat_SDK
# 拉取LubanCat_Linux_Generic_SDK
repo init -u https://github.com/LubanCat/manifests.git -b linux -m lubancat_linux_generic.xml
#如果运行以上命令失败，提示：fatal: Cannot get https://gerrit.googlesource.com/git-repo/clone.bundle
#则可以在以上命令中添加选项 --repo-url https://mirrors.tuna.tsinghua.edu.cn/git/git-repo
.repo/repo/repo sync -c -j4
|
–depth=1 可以在拉取时进行浅克隆，只拉取最新的一次提交，可以有效减少从网络拉取的内容。 如果想拉取完整的，带有所有Git提交信息的内容，可以删除此选项。
如果同步失败可以重新运行sync命令来同步
2.6.4. SDK离线安装下载¶
由于Github服务器在国外，拉取这么多的仓库需要很多时间，还可能因为网络不畅通而导致下载失败。 为此，我们将需要使用的仓库整体打包，使用网盘下载的方式，以减少连接Github导致的问题。
2.6.4.1. 下载地址¶
访问百度网盘资源介绍页面获取SDK源码压缩包: 8-SDK源码压缩包
下载最新日期的LubanCat_Linux_Generic_SDK压缩包即可。
注解
由于源码压缩包体积很大，仅在有大量修改的稳定版本时更新，其发布日期可能和镜像发布日期无法对应。当我们在本地解压压缩包以后，只需要借助Github做少量更新，即可同步到最新版本。
2.6.4.2. 解压源码¶
以下过程以LubanCat_Linux_Generic_SDK进行演示，实际文件名称以自己下载的SDK为准
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | # 安装tar压缩工具,一般来说系统默认安装了
sudo apt install tar
# 在用户家目录创建LubanCat_SDK目录
mkdir ~/LubanCat_SDK
# 将下载的SDK源码移动到LubanCat_SDK目录下，xxx为日期
mv LubanCat_Linux_Generic_SDK_xxx.tgz ~/LubanCat_SDK
# 进入LubanCat_SDK目录
cd ~/LubanCat_SDK
# 解压SDK压缩包
tar -xzvf LubanCat_Linux_Generic_SDK_xxx.tgz
# 检出.repo目录下的git仓库
.repo/repo/repo sync -l
# 将所有的源码仓库同步到最新版本
.repo/repo/repo sync -c
|
如果repo sync -c执行时提示网络连接超时，请检查并能否通畅访问github。 确认可以正常访问github的话，可以重复多次执行repo sync -c命令来进行同步。 若无法访问github，可以忽略同步源码仓库到最新版本这一步骤。
解压完成后checkout到指定的提交。
建议使用离线源码包的客户在首次检出仓库后更新源码到最新版本。
2.6.5. SDK更新¶
我们会对LubanCat-SDK不断更新，并将修改的内容实时同步到Github， 如果需要在本地LubanCat-SDK同步我们的更新内容，则可以借助repo或git来实现。
2.6.5.1. 使用repo更新整个SDK¶
使用repo可以将SDK更新到我们提供的最新版本。
首先我们要更新.repo/manifests，里面保存了repo的配置文件，记录了仓库的版本信息。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | # 进入.repo/manifests目录
cd .repo/manifests
# 切换分支到Linux
git checkout linux
# 拉取最新的manifests
git pull
#进入SDK根目录
cd ~/LubanCat_SDK
# 同步远端仓库
.repo/repo/repo sync -c
|
2.6.5.2. 使用Git更新单独的源码仓库¶
有时我们只想更新某个仓库，而不是去更新整个SDK。 或者我们已经对SDK的某些仓库做出了修改，使用repo同步的话就会失败。 此时就需要我们对单个仓库进行更新了。
这里以Kernel仓库为例
1 2 3 4 5 6 7 8 9 10 | # 进入kernel目录下
cd kernel
# 检出到当前提交所在的分支
# 可以查看.repo/manifests/lubancat_linux/lubancat_linux_generic_release.xml
# name="kernel"条目中dest-branch就是要切换的分支
git checkout lbc-develop-5.10
# 拉取git仓库
git pull
|
2.7. LubanCat-SDK自动构建¶
LubanCat-SDK的构建脚本可以实现自动构建，具体操作方式如下：
在SDK根目录下，执行以下命令，以选择要构建的板卡主芯片型号和SDK的配置文件。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | # 选择SDK配置文件
./build.sh chip
1. rk312x
2. rk3528
3. rk3562
4. rk3566_rk3568
5. rk3588
# 输入想要构建的板卡主芯片型号的编号，并确认，这里选择rk3588。
Which would you like? [1]: 5
# 选择要构建的根文件系统配置文件
1. rockchip_defconfig
2. LubanCat_rk3588_debian_gnome_defconfig
3. LubanCat_rk3588_debian_lite_defconfig
4. LubanCat_rk3588_ubuntu_gnome_defconfig
5. LubanCat_rk3588_ubuntu_lite_defconfig
Which would you like? [1]: 2
|
注解
芯片型号编号和配置文件编号顺序可能发生变化，以实际为准。
如果我们已经选择过了主芯片，需要切换同一主芯片其他板卡或文件系统类型。
1 2 3 4 5 | # 选择SDK配置文件
./build.sh lunch
# 输入想要构建的板卡及文件系统配置文件编号，并确认，这里选择配置文件LubanCat_rk3588_debian_gnome_defconfig。
Which would you like? [0]: 2
|
我们也可以直接设置SDK配置文件，方法如下
1 2 | # 选择构建LubanCat-RK3588系列板卡debian系统gnome桌面镜像
./build.sh LubanCat_rk3588_debian_gnome_defconfig
|
选择SDK配置文件以后，我们还要安装debian根文件系统构建依赖的软件包，操作如下。
1 2 3 | #安装本地软件包
sudo dpkg -i debian/ubuntu-build-service/packages/*
sudo apt-get install -f
|
注意
由于debain和ubuntu根文件系统不同版本构建所需的依赖包版本不同，当切换了根文件系统版本的选择以后，就需要根据自己所选的根文件系统版本安装不同的依赖包。
如果我们选择了ubuntu根文件系统的SDK配置文件，就需要安装ubuntu根文件系统构建的依赖软件包，操作如下。
1 2 3 | #安装本地软件包
sudo dpkg -i ubuntu/ubuntu-build-service/packages/*
sudo apt-get install -f
|
安装过程中可能会报错，这是正常现象，我们忽略即可。待软件包安装完成后，我们就可以进行一键构建了。
1 2 | # 一键编译u-Boot，kernel，Rootfs并打包为update.img镜像
./build.sh
|
警告
如果在编译过程中出现如下图所示的提示，请根据对应设备树文件中的&pmu_io_domains节点中的电压值选择， 并注意顺序从pmuio2-supply开始。其中vccio_acodec为3v3、vccio_sd为3v3。
构建好的镜像保存在rockdev/目录下，同时在我们也可以使用 ./build.sh release 命令在output-release/目录下进行备份。
2.8. LubanCat-SDK单独构建模块¶
在进行固件开发时，一键构建就显得过于耗时了，每一个改动都要构建整个镜像并重新打包， 这无疑是巨大的时间浪费。此时我们就可以使用SDK单个模块构建的功能。
2.8.1. 选择SDK配置文件¶
首先，还是要选择SDK的配置文件，这里以LubanCat-RK3588系列板卡的debian系统gnome桌面镜像为例
1 2 | # 选择SDK配置文件
./build.sh LubanCat_rk3588_debian_gnome_defconfig
|
2.8.3. Kernel构建¶
extboot分区内核镜像，要先生成内核deb包，然后再编译内核并将生成的deb包打包进extboot分区。
执行以下命令自动完成 kernel 的构建及打包。
1 2 3 | ./build.sh kerneldeb
./build.sh extboot
|
构建生成的kernel镜像为kernel/extboot.img
2.8.4. rootfs构建¶
LubanCat主要支持Ubuntu、Debian、OpenWrt这几种rootfs， 不同rootfs的构建过程不同，这里分开说明。
注解
由于OpenWrt系统的构建不使用LubanCat-SDK，所以不在此处说明，具体构建过程查看LubanCatWRT构建说明
2.8.4.1. Debian¶
首先要确保SDK的配置文件与要构建的rootfs一致， 如果当前配置文件与要构建的rootfs不一致，需要先切换配置文件。
1 2 3 4 5 | # 选择SDK配置文件
./build.sh LubanCat_rk3588_debian_gnome_defconfig
# 构建Debian
./build.sh debian
|
构建生成的rootfs镜像为debian/linaro-rk3588-gnome-rootfs.img，同时被软链接到rockdev/rootfs.img
注意
只有不存在debian/linaro-rk3588-gnome-rootfs.img时，才会重新构建Debian根文件系统。如果我们要重新构建linaro-rk3588-gnome-rootfs.img，需要先手动删除。
2.8.4.2. Ubuntu¶
目前我们提供20.04/22.04的根文件系统构建脚本，默认使用20.04版本分支。
注解
推荐使用Ubuntu20.04版本，这是我们的主要支持版本。
首先要确保SDK的配置文件与要构建的rootfs一致， 如果当前配置文件与要构建的rootfs不一致，需要先切换配置文件。
1 2 3 4 5 | # 选择SDK配置文件
./build.sh LubanCat_rk3588_ubuntu_gnome_defconfig
# 构建Ubuntu
./build.sh ubuntu
|
构建生成的rootfs镜像为ubuntu/ubuntu-rk3588-gnome-rootfs.img，同时被软链接到rockdev/rootfs.img
注意
只有不存在ubuntu/ubuntu-rk3588-gnome-rootfs.img时，才会重新构建Ubuntu根文件系统。如果我们要重新构建ubuntu-rk3588-gnome-rootfs.img，需要先手动删除。
2.8.5. 镜像打包¶
当u-Boot，kernel，Rootfs都构建完成以后，需要再执行./mkfirmware.sh 进行固件打包， 主要是检查分区表文件是否存在，各个分区是否与分区表配置对应，并根据配置文件将所有的文件复制或链接到rockdev/内。
为了方便镜像的发布，我们还可以将各个分立的分区打包成一个文件，打包好的文件就能用于烧录了。
1 2 3 4 5 | # 固件打包
./mkfirmware.sh
# 生成update.img
./build.sh updateimg
|
以debian系统为例，rockdev/目录下的文件如下所示
rockdev/ |
链接文件 |
boot.img |
kernel/boot.img |
MiniLoaderAll.bin |
u-boot/rk3588_spl_loader_v1.17.113.bin |
parameter.txt |
device/rockchip/.chips/rk3588/parameter.txt |
rootfs.img |
debian/linaro-rk3588-gnome-rootfs.img |
uboot.img |
u-boot/uboot.img |
2.9. ./build.sh构建脚本¶
./build.sh 脚本是整个SDK功能的入口，SDK配置文件的选择、修改； 系统各部分配置文件的修改、编译；以及镜像打包等，都离不开./build.sh脚本
可以使用./build.sh help命令查看所有支持的功能。
注意
由于SDK是经二次开发，增删了部分功能，help返回命令中，有些是不生效的，以实际情况为准。
2.9.1. SDK配置文件修改¶
可以使用./build.sh config命令来修改SDK配置文件
./build.sh savedefconfig命令可以将最小SDK配置文件保存在我们选择的配置文件里
在SDK配置中，我们可以对rootfs、loader、kernel、分区表、扩展分区、镜像打包等各部分做详细配置， 不过一般情况字节使用我们已经保存好的配置文件即可。
2.9.2. 内核相关命令¶
使用./build.sh kernel-config或./build.sh kconfig可以直接打开内核配置界面。
当我们退出配置页面后，又会将对内核的修改同步到我们在SDK配置文件中选中的内核配置文件。