sd-fuse_rk3588

Introduction

This repository is a bunch of scripts to build bootable SD card images for FriendlyElec RK3588 boards, the main features are as follows:

Create root ﬁlesystem image from a directory
Build bootable SD card image
Easy way to compile kernel、uboot and third-party driver

Read this in other languages: 简体中文

Requirements

Supports x86_64 and arm64 platforms (Note: requires A53 or higher on arm64)
Recommended Host OS: Ubuntu 20.04 LTS (Focal Fossa) 64-bit or Higher (Note: Build will fail on Ubuntu Bionic since package lz4 is required)
The script will prompt for the installation of necessary packages.
Docker container: https://github.com/friendlyarm/docker-cross-compiler-novnc

Kernel Version Support

The sd-fuse use multiple git branches to support each version of the kernel, the current branche supported kernel version is as follows:

6.1.y

For other kernel versions, please switch to the related git branch.

Target board OS Supported

Notes: The OS name is the same as the directory name, it is written in the script so it cannot be renamed.

debian-bullseye-desktop-arm64
debian-bullseye-minimal-arm64
debian-bookworm-core-arm64
ubuntu-jammy-desktop-arm64
ubuntu-jammy-minimal-arm64
ubuntu-jammy-x11-desktop-arm64
ubuntu-focal-desktop-arm64
friendlywrt23
friendlywrt23-docker
friendlywrt21
friendlywrt21-docker
eflasher
openmediavault-arm64

To build an SD card image for ubuntu-jammy-desktop, for example like this:

./mk-sd-image.sh ubuntu-jammy-desktop-arm64

Where to download files

The following files may be required to build SD card image:

kernel source code: In the directory "07_Source codes" of NetDrive, or download from Github, the branch name is nanopi6-v6.1.y
uboot source code: In the directory "07_Source codes" of NetDrive, or download from Github, the branch name is nanopi6-v2017.09
pre-built partition image: In the directory "03_Partition image files" of NetDrive, or download from HTTP server
compressed root file system tar ball: In the directory "06_File systems" of NetDrive, or download from HTTP server

If the files are not prepared in advance, the script will automatically download the required files, but the speed may be slower due to the bandwidth of the http server.

Script Functions

fusing.sh: Flash the image to SD card
mk-sd-image.sh: Build SD card image
mk-emmc-image.sh: Build SD-to-eMMC image, used to install system to eMMC
build-rootfs-img.sh: Create root ﬁlesystem image(rootfs.img) from a directory
build-kernel.sh: Compile the kernel, or kernel headers
build-uboot.sh: Compile uboot

Usage

Build your own SD card image

Note: Here we use ubuntu-jammy-desktop system as an example
Clone this repository locally, then download and uncompress the pre-built images, due to the bandwidth of the http server, we recommend downloading the file from the NetDrive:

git clone https://github.com/friendlyarm/sd-fuse_rk3588 -b kernel-6.1.y --single-branch sd-fuse_rk3588-kernel6.1
cd sd-fuse_rk3588-kernel6.1
wget http://112.124.9.243/dvdfiles/rk3588/images-for-eflasher/ubuntu-jammy-desktop-arm64-images.tgz
tar xvzf ubuntu-jammy-desktop-arm64-images.tgz

After decompressing, you will get a directory named ubuntu-jammy-desktop-arm64, you can change the files in the directory as needed, for example, replace rootfs.img with your own modified version, or your own compiled kernel and uboot, finally, flash the image to the SD card by entering the following command (The below steps assume your SD card is device /dev/sdX):

sudo ./fusing.sh /dev/sdX ubuntu-jammy-desktop-arm64

Or, package it as an SD card image file:

./mk-sd-image.sh ubuntu-jammy-desktop-arm64

The following flashable image file will be generated, it is now ready to be used to boot the device into ubuntu-jammy-desktop:

out/rk3588-sd-ubuntu-jammy-desktop-6.1-arm64-YYYYMMDD.img

Create an SD card image that does not use OverlayFS

The following command will create an SD card image with OverlayFS disabled:

cp prebuilt/parameter-plain.txt ubuntu-jammy-desktop-arm64/parameter.txt
./mk-sd-image.sh ubuntu-jammy-desktop-arm64

The benefits of disabling OverlayFS are as follows:

Docker can choose a file system type with better performance
Enabling Swap becomes more convenient

Build your own SD-to-eMMC Image

Note: Here we use ubuntu-jammy-desktop system as an example
Clone this repository locally, then download and uncompress the pre-built images, here you need to download the ubuntu-jammy-desktop and eflasher pre-built images:

git clone https://github.com/friendlyarm/sd-fuse_rk3588 -b kernel-6.1.y --single-branch sd-fuse_rk3588-kernel6.1
cd sd-fuse_rk3588-kernel6.1
wget http://112.124.9.243/dvdfiles/rk3588/images-for-eflasher/ubuntu-jammy-desktop-arm64-images.tgz
tar xvzf ubuntu-jammy-desktop-arm64-images.tgz
wget http://112.124.9.243/dvdfiles/rk3588/images-for-eflasher/emmc-flasher-images.tgz
tar xvzf emmc-flasher-images.tgz

Then use the following command to build the SD-to-eMMC image, the autostart=yes parameter means it will automatically enter the flash process when booting:

./mk-emmc-image.sh ubuntu-jammy-desktop-arm64 autostart=yes

The following flashable image file will be generated, ready to be used to boot the device into eflasher system and then flash ubuntu-jammy-desktop system to eMMC:

out/rk3588-eflasher-ubuntu-jammy-desktop-6.1-arm64-YYYYMMDD.img

Backup rootfs and create custom SD image (to burn your application into other boards)

Backup rootfs

Run the following commands on your target board. These commands will back up the entire root partition:

sudo passwd root
su root
cd /
tar --warning=no-file-changed -cvpzf /rootfs.tar.gz \
    --exclude=/rootfs.tar.gz --exclude=/var/lib/docker/runtimes \
    --exclude=/etc/firstuser --exclude=/etc/friendlyelec-release \
    --exclude=/usr/local/first_boot_flag --one-file-system /

Making a bootable SD card from a root filesystem

Note: Here we use ubuntu-jammy-desktop system as an example
Clone this repository locally, then download and uncompress the pre-built images:

git clone https://github.com/friendlyarm/sd-fuse_rk3588 -b kernel-6.1.y --single-branch sd-fuse_rk3588-kernel6.1
cd sd-fuse_rk3588-kernel6.1
wget http://112.124.9.243/dvdfiles/rk3588/images-for-eflasher/ubuntu-jammy-desktop-arm64-images.tgz
tar xvzf ubuntu-jammy-desktop-arm64-images.tgz

Extract the rootfs.tar.gz exported in the previous section, the tar command requires root privileges, so you need put sudo in front of the command:

mkdir ubuntu-jammy-desktop-arm64/rootfs
./tools/extract-rootfs-tar.sh rootfs.tar.gz ubuntu-jammy-desktop-arm64/rootfs

or download the filesystem archive from the following URL and extract it:

wget http://112.124.9.243/dvdfiles/rk3588/rootfs/rootfs-ubuntu-jammy-desktop-arm64.tgz
./tools/extract-rootfs-tar.sh rootfs-ubuntu-jammy-desktop-arm64.tgz

Make rootfs to img:

sudo ./build-rootfs-img.sh ubuntu-jammy-desktop-arm64/rootfs ubuntu-jammy-desktop-arm64

Use the new rootfs.img to build SD card image:

./mk-sd-image.sh ubuntu-jammy-desktop-arm64

Or build SD-to-eMMC image:

./mk-emmc-image.sh ubuntu-jammy-desktop-arm64 autostart=yes

If the image path is too big to pack, you can use the RAW_SIZE_MB environment variable to set a new image size. for example, you can set it to 16GB:

RAW_SIZE_MB=16000 ./mk-sd-image.sh ubuntu-jammy-desktop-arm64
RAW_SIZE_MB=16000 ./mk-emmc-image.sh ubuntu-jammy-desktop-arm64

Using BTRFS as your root filesystem

First, use the following command to check if your kernel supports the BTRFS file system:

cat /proc/filesystems | grep btrfs

If not, you can add BTRFS support by add the line CONFIG_BTRFS_FS=y to the .config file, you can refer to the script test/test-btrfs-rootfs.sh for more details.

The following command will create an SD card image with BTRFS root filesystem:

git clone https://github.com/friendlyarm/sd-fuse_rk3588 -b kernel-6.1.y --single-branch sd-fuse_rk3588-kernel6.1
cd sd-fuse_rk3588-kernel6.1
wget http://112.124.9.243/dvdfiles/rk3588/images-for-eflasher/ubuntu-jammy-desktop-arm64-images.tgz
tar xvzf ubuntu-jammy-desktop-arm64-images.tgz
wget http://112.124.9.243/dvdfiles/rk3588/rootfs/rootfs-ubuntu-jammy-desktop-arm64.tgz
./tools/extract-rootfs-tar.sh rootfs-ubuntu-jammy-desktop-arm64.tgz
sudo -E FS_TYPE=btrfs ./build-rootfs-img.sh ubuntu-jammy-desktop-arm64/rootfs \
    ubuntu-jammy-desktop-arm64
./mk-sd-image.sh ubuntu-jammy-desktop-arm64

Compiling the Kernel

Note: Here we use ubuntu-jammy-desktop system as an example
Clone this repository locally, then download and uncompress the pre-built images:

git clone https://github.com/friendlyarm/sd-fuse_rk3588 -b kernel-6.1.y --single-branch sd-fuse_rk3588-kernel6.1
cd sd-fuse_rk3588-kernel6.1
wget http://112.124.9.243/dvdfiles/rk3588/images-for-eflasher/ubuntu-jammy-desktop-arm64-images.tgz
tar xvzf ubuntu-jammy-desktop-arm64-images.tgz

Download the kernel source code from github:

git clone https://github.com/friendlyarm/kernel-rockchip -b nanopi6-v6.1.y --depth 1 kernel

Customize the kernel configuration:

cd kernel
touch .scmversion
make ARCH=arm64 nanopi6_linux_defconfig
make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- menuconfig
make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- savedefconfig
cp defconfig ./arch/arm64/configs/my_defconfig                  # Save the configuration as my_defconfig
git add ./arch/arm64/configs/my_defconfig
cd -

To compile the kernel, use the environment variables KERNEL_SRC and KCFG to set the source code folder and the defconfig file:

KERNEL_SRC=kernel KCFG=my_defconfig ./build-kernel.sh ubuntu-jammy-desktop-arm64

Compiling the kernel headers only

Set the environment variable MK_HEADERS_DEB to 1, which will compile the kernel headers:

MK_HEADERS_DEB=1 ./build-kernel.sh ubuntu-jammy-desktop-arm64

Environment Variables

KERNEL_SRC is used to specify the local kernel source code dir.
KCFG is used to specify the kernel defconfig (located in the arch/arm64/configs/ dir).
Set BUILD_THIRD_PARTY_DRIVER to 0 to skip compiling third-party driver modules
Set SKIP_DISTCLEAN to 1 to skip running distclean before compiling

Compiling the u-boot

Note: Here we use ubuntu-jammy-desktop system as an example Clone this repository locally, then download and uncompress the pre-built images:

git clone https://github.com/friendlyarm/sd-fuse_rk3588 -b kernel-6.1.y --single-branch sd-fuse_rk3588-kernel6.1
cd sd-fuse_rk3588-kernel6.1
wget http://112.124.9.243/dvdfiles/rk3588/images-for-eflasher/ubuntu-jammy-desktop-arm64-images.tgz
tar xvzf ubuntu-jammy-desktop-arm64-images.tgz

Download the u-boot source code from github that matches the OS version, the environment variable UBOOT_SRC is used to specify the local source code directory:

git clone https://github.com/friendlyarm/uboot-rockchip -b nanopi6-v2017.09 --depth 1 uboot
UBOOT_SRC=uboot ./build-uboot.sh ubuntu-jammy-desktop-arm64

Common Issues and Solutions

Unable to boot after creating rootfs (Solution: The file permissions in the file system might be corrupted. Make sure to use the tools/extract-rootfs-tar.sh script to extract rootfs, and use the -cpzf options with the tar command for packaging.)
Process exits during creation (Solution: Ensure the machine has sufficient memory.)

friendlyarm / sd-fuse_rk3588

readme