How to make your own SD-bootable ROM
Contents
1 Make Image Files for RK3399
Refer to this repo: https://github.com/friendlyarm/sd-fuse_rk3399
2 Make Image Files for S5P4418
Refer to this repo: https://github.com/friendlyarm/sd-fuse_s5p4418
3 Make Image Files for S5P6818
Refer to this repo: https://github.com/friendlyarm/sd-fuse_s5p6818
4 Make Image Files for H3
If you have a customized U-boot, Linux kernel and file system and want to use them to make a customized Linux image file(we call it "ROM" in the following sections) you can do it this way: use the "dd" command to copy all the data and files from an existing SD card with a Linux ROM, replace the U-boot, kernel or file system with your customzied files and use the "dd" command again to combine these files to a ROM. However this is inefficient. We suggest you use our rom-maker-lite utility to do it, which can be downloaded at rom-maker-lite.
The rom-maker-lite utility is a general tool to make a ROM. It currently supports making a Linux based sd/eflasher ROM for FriendlyElec's H3/H5 boards .Making an Android image is not supported yet.
- Run ./mkimage.sh to check usage info:
$ ./mkimage.sh Usage: $ apt-get install tree exfat-utils dosfstools python3-tk $ ./mkimage.sh -c <filesystem type> -m <partmap> -d "<misc dir>;<partition1 dir>;<partition2 dir>;..." -c <filesystem type>: 1: misc(bootloader) + fat32 boot.img + ext4 rootfs.img 2: misc(bootloader) + fat32 boot.img + ext4 rootfs.img + exfat friendlyarm.img 3: misc(bootloader) + ext4 boot.img + ext4 rootfs.img
Parameter Comment -c <filesystem type> -c specifies file systems' formats for the partitions in a ROM Image. Specifically for an H3/H5 based board:
-c 1 stands for "misc(bootloader) + fat32 boot.img + ext4 rootfs.img" and this applies to an sd ROM of FriendlyCore/Ubuntu/Debian/OpenWrt;
-c 2 stands for "misc(bootloader) + fat32 boot.img + ext4 rootfs.img + exfat friendlyarm.img" and this applies to an eflasher ROM.-m <partmap> -m specifies a partmap file for making a ROM.
A partmap file is used to specify the files and their sizes included in a ROM. ROMs made for different boards or BSPs may need different partmap files.-d "<misc dir>;<partition1 dir>;<partition2 dir>;..." -d specifies file system's path and each path is separated by a ";". Specifically for an H3/H5 based board:
<misc dir>: specifies the bootloader's path;
<partition1 dir>: specifies the boot partition's path;
<partition2 dir>: specifies the rootfs partition's path;
"..." means more paths can be defined. When you make an eflasher ROM you need to include the friendlyarm partition's path;
- Preparations
We tested the following Ubuntu versions that worked with a PC host:
1) ubuntu-16.04.5-desktop-amd64.iso
2) ubuntu-18.04.1-desktop-amd64.iso
If you cannot make a ROM under a Linux system with your PC host you'd better use either one of the above two systems we tested.
Before proceed make sure you have installed the following packages:
$ apt-get install tree exfat-utils dosfstools python3-tk
You need the root access right to make a ROM:
$ su root
4.1 Make SD ROM
4.1.1 Linux-4.14
For Linux-4.14 BSP all FriendlyElec's H3 platforms that have the same rootfs share the same SD ROM. Therefore the steps to make an sd ROM for all FriendlyElec's H3 platforms that support this BSP are the same.
We take FriendlyCore's sd ROM as an example to show how to do it. The steps for making an sd ROM for Ubuntu,Debian,OpenWrt are the same.
- Get a Full FriendlyCore's rootfs Directory
There are two ways to do it:
1) Make an SD card with FriendlyCore and mount the SD card's rootfs partition on a PC host;
2) Extract the /rootfs/rootfs_friendlycore_4.14_YYYYMMDD.tgz file
- Suppose rootfs' path is "./rom-maker-lite/part2/h3/4.14/friendlycore/rootfs/". After you run the following command you will be able to get an sd ROM:
$ cd rom-maker-lite $ ./mkimage.sh -c 1 -m partmap/h3_linux-4.14/partmap.txt -d "misc/uboot-2017_h3/;part1/boot_linux-4.14_h3/;part2/h3/4.14/friendlycore/rootfs/"
- All FriendlyElec's H3 platforms that run the Linux-4.14 BSP use the same partmap file: partmap/h3_linux-4.14/partmap.txt .
- You can replace the files under "misc/uboot-2017_h3" and "part1/boot_linux-4.14_h3" with your application files. You can check the existing files by commanding "tree":
$ tree misc/uboot-2017_h3/ part1/boot_linux-4.14_h3/ misc/uboot-2017_h3/ └── u-boot-sunxi-with-spl.bin part1/boot_linux-4.14_h3/ ├── boot.cmd ├── boot.scr ├── rootfs.cpio.gz ├── sun8i-h2-plus-nanopi-duo.dtb ├── sun8i-h3-nanopi-duo2.dtb ├── sun8i-h3-nanopi-m1.dtb ├── sun8i-h3-nanopi-m1-plus.dtb ├── sun8i-h3-nanopi-neo-air.dtb ├── sun8i-h3-nanopi-neo-core.dtb ├── sun8i-h3-nanopi-neo.dtb └── zImage
After the mkimage.sh script is run successfully an "out/SD-bootable-1" directory ("1" corresponds to parameter "-c 1"). Here is what it will show:
$ tree out/ out/ ├── SD-bootable-1 │ └── your_company │ ├── boot.img │ ├── info.conf │ ├── partmap.txt │ ├── rootfs.img │ └── u-boot-sunxi-with-spl.bin ├── SD-bootable-1.img
- The "part1/boot_linux-4.14_h3/" directory will be converted to "boot.img";
- The "part2/h3/4.14/friendlycore/rootfs/" directory will be converted to "rootfs.img";
- The "SD-bootable-1.img" file will be an sd ROM which is composed of all files under the "SD-bootable-1" directory and is equivalent to a nanopi-[h3]_sd_friendlycore-xenial_4.14_armhf_YYYYMMDD.img file released by FriendlyElec;
4.1.2 Linux-3.4
- For Linux-3.4 BSP different FriendlyElec's H3 platforms use different sd ROMs although they may use the same rootfs.
- We take FriendlyCore as an example to show how to make a Linux-3.4 sd ROM for the NanoPi M1. The steps for making an sd ROM for Ubuntu,Debian,OpenWrt are the same.
- Get a Full FriendlyCore's rootfs Directory
Here is how to do it:
1) Make an SD card with FriendlyCore and mount the SD card's rootfs partition on a PC host;
- Suppose rootfs' path is "./rom-maker-lite/part2/m1/3.4/friendlycore/rootfs/".After you run the following command you will be able to get an sd ROM:
$ cd rom-maker-lite $ ./mkimage.sh -c 1 -m partmap/h3_linux-3.4/partmap.txt -d "misc/uboot-2011_m1/;part1/boot_linux-3.4_m1/;part2/m1/3.4/friendlycore/rootfs"
- All FriendlyElec's H3 platforms that run the Linux-3.4 BSP use the same partmap file: partmap/h3_linux-3.4/partmap.txt.
- You can replace the files under "misc/uboot-2011_m1" and "part1/boot_linux-3.4_m1" with your application files. You can check the existing files by commanding "tree":
$ tree misc/uboot-2011_m1 part1/boot_linux-3.4_m1 misc/uboot-2011_m1 ├── boot0_sdcard.fex └── u-boot.fex part1/boot_linux-3.4_m1 ├── boot.img └── bootlogo.bmp
After the mkimage.sh script is run successfully an "out/SD-bootable-1" directory ("1" corresponds to parameter "-c 1"). Here is what it will show:
$ tree out/ out/ ├── SD-bootable-1 │ └── your_company │ ├── boot0_sdcard.fex │ ├── boot.img │ ├── info.conf │ ├── partmap.txt │ ├── rootfs.img │ └── u-boot.fex ├── SD-bootable-1.img
- The "part1/boot_linux-3.4_m1" directory will be converted to "boot.img";
- The "part2/h3/3.4/friendlycore/rootfs/" directory will be converted to "rootfs.img";
- The "SD-bootable-1.img" file will be an sd ROM which is composed of all files under the "SD-bootable-1" directory and is equivalent to a nanopi-m1_sd_friendlycore-xenial_3.4_armhf_YYYYMMDD.img file released by FriendlyElec;
- Similarly the steps to make an sd ROM image for the NanoPi M1 Plus are as follows:
$ ./mkimage.sh -c 1 -m partmap/h3_linux-3.4/partmap.txt -d "misc/uboot-2011_m1-plus/;part1/boot_linux-3.4_m1-plus/;part2/m1-plus/3.4/friendlycore/rootfs"
The generated "SD-bootable-1.img" file is equivalent to the nanopi-m1-plus_sd_friendlycore-xenial_3.4_armhf_YYYYMMDD.img file released by FriendlyElec. This applies to both the NanoPi NEO and NanoPi NEO Air.
4.2 Make eflasher ROM
Before you make an eflasher ROM make sure you have already made a FriendlyCore/Debian/OpenWrt sd ROM.
For example if you want to make a Linux-4.14 based FriendlyCore eflasher ROM you need to have a Linux-4.14 based FriendlyCore sd ROM. You can check the existing files by commanding "tree":
$ tree out/ out/ ├── SD-bootable-1 │ └── your_company │ ├── boot.img │ ├── info.conf │ ├── partmap.txt │ ├── rootfs.img │ └── u-boot-sunxi-with-spl.bin
- Get a Full eflasher rootfs Directory
There are two ways to do it:
1) Make an eflasher SD card and mount the SD card's rootfs partition on a PC host;
2) Extract the /rootfs/rootfs_eflasher_4.14_YYYYMMDD.tgz file
- Suppose eflasher rootfs' path is "./rom-maker-lite/part2/h3/4.14/eflasher/rootfs/",After you run the following command you will be able to get an eflasher ROM:
$ cd rom-maker-lite $ ./mkimage.sh -c 2 -m partmap/h3_eflasher-4.14/partmap.txt -d "misc/uboot-2017_h3/;part1/boot_linux-4.14_h3/;part2/h3/4.14/eflasher/rootfs;out/SD-bootable-1/"
After the mkimage.sh script is run successfully an "out/SD-bootable-2" directory. Here is what it will show:
$ tree out/ out/SD-bootable-2 ├── SD-bootable-2 │ └── your_company │ ├── boot.img │ ├── friendlyarm.img │ ├── info.conf │ ├── partmap.txt │ ├── rootfs.img │ └── u-boot-sunxi-with-spl.bin └── SD-bootable-2.img
- The "part1/boot_linux-4.14_h3" directory will be converted to "boot.img";
- The "part2/h3/4.14/eflasher/rootfs/" directory will be converted to "rootfs.img";
- The "out/SD-bootable-1/" directory will be converted to "friendlyarm.img";
- The "SD-bootable-2.img" file will be an eflasher ROM which is composed of all files under the "SD-bootable-2" directory and is equivalent to a nanopi-[h3]_eflasher_friendlycore-xenial_4.14_armhf_YYYYMMDD.img file released by FriendlyElec;
Actually all FriendlyElec's H3 platforms use the same file "nanopi-[h3]_eflasher_friendlycore-xenial_4.14_armhf_YYYYMMDD.img".
4.3 Make boot.img/rootfs.img
Actually the rom-maker-lite utility calls the "./tools/mk_fsimg.sh" script to generate a boot.img and rootfs.img. Here are the popular parameters the "mk_fsimg.sh" script usually takes:
Parameter Comment Parameter１ Specifies a partition format. It currently supports vfat/ext4/exfat
Parameter 2 Specifies an output file;
Parameter 3 Specifies an input directory;
Parameter 4 Specifies an output file's size and the unit is MByte. This size should be greater than the input directory's size and less than the corresponding size specified(in "length") in the partmap.txt file;
Since some file system information needs to be included in an image file this size will be greater than the input directory's size;
Parameter ５ Specifies a partition's tag;
4.3.1 Linux-4.14
You can run the following commands to generate a boot.img and rootfs.img for a Linux-4.14 based sd ROM:
$ cd rom-maker-lite $ ./tools/mk_fsimg.sh vfat boot.img ./part1/boot_linux-4.14_h3/ 40 boot $ ./tools/mk_fsimg.sh ext4 rootfs.img ./part2/h3/4.14/friendlycore/rootfs/ 2048 rootfs
These commands apply to all FriendlyElec's H3 platforms.
4.3.2 Linux-3.4
You can run the following commands to generate a boot.img and rootfs.img for a Linux-3.4 based sd ROM for the NanoPi M1:
$ cd rom-maker-lite $ ./tools/mk_fsimg.sh vfat boot.img ./part1/boot_linux-3.4_m1/ 40 boot $ ./tools/mk_fsimg.sh ext4 rootfs.img ./part2/h3/3.4/friendlycore/rootfs/ 2048 rootfs
These commands only apply to the NanoPi M1. But these commands with minors changes will work for other H3 platforms.
5 制作H5 平台的系统映像
If you have a customized U-boot, Linux kernel and file system and want to use them to make a customized Linux image file(we call it "ROM" in the following sections) you can do it this way: use the "dd" command to copy all the data and files from an existing SD card with a Linux ROM, replace the U-boot, kernel or file system with your customzied files and use the "dd" command again to combine these files to a ROM. However this is inefficient. We suggest you use our rom-maker-lite utility to do it, which can be downloaded at rom-maker-lite.
The rom-maker-lite utility is a general tool to make a ROM. It currently supports making a Linux based sd/eflasher ROM for FriendlyElec's H3/H5 boards .Making an Android image is not supported yet.
- Run ./mkimage.sh to check usage info:
$ ./mkimage.sh Usage: $ apt-get install tree exfat-utils dosfstools python3-tk $ ./mkimage.sh -c <filesystem type> -m <partmap> -d "<misc dir>;<partition1 dir>;<partition2 dir>;..." -c <filesystem type>: 1: misc(bootloader) + fat32 boot.img + ext4 rootfs.img 2: misc(bootloader) + fat32 boot.img + ext4 rootfs.img + exfat friendlyarm.img 3: misc(bootloader) + ext4 boot.img + ext4 rootfs.img
Parameter Comment -c <filesystem type> -c specifies file systems' formats for the partitions in a ROM Image. Specifically for an H3/H5 based board:
-c 1 stands for "misc(bootloader) + fat32 boot.img + ext4 rootfs.img" and this applies to an sd ROM of FriendlyCore/Ubuntu/Debian/OpenWrt;
-c 2 stands for "misc(bootloader) + fat32 boot.img + ext4 rootfs.img + exfat friendlyarm.img" and this applies to an eflasher ROM.-m <partmap> -m specifies a partmap file for making a ROM.
A partmap file is used to specify the files and their sizes included in a ROM. ROMs made for different boards or BSPs may need different partmap files.-d "<misc dir>;<partition1 dir>;<partition2 dir>;..." -d specifies file system's path and each path is separated by a ";". Specifically for an H3/H5 based board:
<misc dir>: specifies the bootloader's path;
<partition1 dir>: specifies the boot partition's path;
<partition2 dir>: specifies the rootfs partition's path;
"..." means more paths can be defined. When you make an eflasher ROM you need to include the friendlyarm partition's path;
- Preparations
We tested the following Ubuntu versions that worked with a PC host:
1) ubuntu-16.04.5-desktop-amd64.iso
2) ubuntu-18.04.1-desktop-amd64.iso
If you cannot make a ROM under a Linux system with your PC host you'd better use either one of the above two systems we tested.
Before proceed make sure you have installed the following packages:
$ apt-get install tree exfat-utils dosfstools python3-tk
You need the root access right to make a ROM:
$ su root
5.1 制作sd ROM
5.1.1 Linux-4.14
事实上，对于Linux-4.14 BSP，相同rootfs的所有H5 板子的sd ROM文件都是同一个，所以对于这个版本的BSP，所有H5 的板子的sd ROM 的制作命令是一样的。
这里以制作FriendlyCore sd ROM为例进行讲解，Ubuntu、Debian、OpenWrt等sd ROM文件的制作方法是一样的。
- 准备FriendlyCore的rootfs目录
有2种方式可以准备FriendlyCore的rootfs目录：
1) 制作一张带FriendlyCore系统的SD卡，然后基于该SD卡进行定制开发，当开发完毕后，在PC机上挂载该SD卡的rootfs分区;
2) 解压网盘里的/rootfs/rootfs_friendlycore_4.14_YYYYMMDD.tgz
- 假设rootfs目录的路径为./rom-maker-lite/part2/h5/4.14/friendlycore/rootfs/，执行下面的命令可生成sd ROM:
$ cd rom-maker-lite $ ./mkimage.sh -c 1 -m partmap/h5_linux-4.14/partmap.txt -d "misc/uboot-2017_h5/;part1/boot_linux-4.14_h5/;part2/h5/4.14/friendlycore/rootfs/"
- 对于所有使用Linux-4.14 BSP的H5板子，使用的都是同一个partmap文件: partmap/h5_linux-4.14/partmap.txt。
- 如果有需要，你可以将misc/uboot-2017_h5、part1/boot_linux-4.14_h5目录下的文件替换为你自己定制编译的文件，通过tree命令可查看有哪些可替换的文件:
$ tree misc/uboot-2017_h5/ part1/boot_linux-4.14_h5/ misc/uboot-2017_h5/ ├── sunxi-spl.bin └── u-boot.itb part1/boot_linux-4.14_h5/ ├── boot.cmd ├── boot.scr ├── Image ├── overlays │ └── sun50i-h5-gpio-dvfs-overlay.dtb ├── rootfs.cpio.gz ├── sun50i-h5-nanopi-k1-plus.dtb ├── sun50i-h5-nanopi-neo2.dtb ├── sun50i-h5-nanopi-neo-core2.dtb └── sun50i-h5-nanopi-neo-plus2.dtb
mkimage.sh执行成功后，会生成out/SD-bootable-1目录(这里的"1"对应参数“-c 1”)，，其内容如下:
$ tree out/ out/ ├── SD-bootable-1 │ └── your_company │ ├── boot.img │ ├── info.conf │ ├── partmap.txt │ ├── rootfs.img │ ├── sunxi-spl.bin │ └── u-boot.itb ├── SD-bootable-1.img
- part1/boot_linux-4.14_h5/目录被制作成了boot.img;
- part2/h5/4.14/friendlycore/rootfs/目录被制作成了rootfs.img;
- SD-bootable-1.img则为最终的sd ROM文件，它是由SD-bootable-1目录下的所有文件组装而来的，等效于FriendlyElec 发布的nanopi-[h5]_sd_friendlycore-xenial_4.14_arm64_YYYYMMDD.img;
5.2 制作eflasher ROM
制作eflasher ROM的前提条件是已经成功制作出了FriendlyCore/Debian/OpenWrt等sd ROM，即已经有待烧写到eMMC的原材料文件。
例如想制作用于烧写“Linux-4.14的FriendlyCore”的eflasher ROM，先要有"Linux-4.14的FriendlyCore"的sd ROM原材料，即：
$ tree out/ out/ ├── SD-bootable-1 │ └── your_company │ ├── boot.img │ ├── info.conf │ ├── partmap.txt │ ├── rootfs.img │ ├── sunxi-spl.bin │ └── u-boot.itb
- 准备eflasher的rootfs目录
有2种方式可以准备eflasher的rootfs目录：
1) 制作一张带eflasher 系统的SD卡，然后基于该SD卡进行定制开发，当开发完毕后，在PC机上挂载该SD卡的rootfs分区;
2) 解压网盘里的/rootfs/rootfs_eflasher_4.14_YYYYMMDD.tgz
- 假设eflasher rootfs目录的路径为./rom-maker-lite/part2/h5/4.14/eflasher/rootfs/，执行下面的命令可生成eflasher ROM:
$ cd rom-maker-lite $ ./mkimage.sh -c 2 -m partmap/h5_eflasher-4.14/partmap.txt -d "misc/uboot-2017_h5/;part1/boot_linux-4.14_h5/;part2/h5/4.14/eflasher/rootfs;out/SD-bootable-1"
mkimage.sh执行成功后，会生成out/SD-bootable-2目录，其内容如下:
$ tree out/SD-bootable-2 out/SD-bootable-2 ├── SD-bootable-2 │ └── your_company │ ├── boot.img │ ├── friendlyarm.img │ ├── info.conf │ ├── partmap.txt │ ├── rootfs.img │ ├── sunxi-spl.bin │ └── u-boot.itb └── SD-bootable-2.img
- part1/boot_linux-4.14_h5/目录被制作成了boot.img;
- part2/h5/4.14/eflasher/rootfs/目录被制作成了rootfs.img;
- out/SD-bootable-1/目录被制作成了friendlyarm.img;
- SD-bootable-2.img则为最终的eflasher ROM文件，它是由SD-bootable-2目录下的所有文件组装而来的，等效于FriendlyElec 发布的nanopi-[h5]_eflasher_friendlycore-xenial_4.14_arm64_YYYYMMDD.img;
事实上，FriendlyElec发布的所有H5板子的nanopi-[h5]_eflasher_friendlycore-xenial_4.14_arm64_YYYYMMDD.img都是同一个文件。
5.3 仅制作boot.img/rootfs.img
Actually the rom-maker-lite utility calls the "./tools/mk_fsimg.sh" script to generate a boot.img and rootfs.img. Here are the popular parameters the "mk_fsimg.sh" script usually takes:
Parameter Comment Parameter１ Specifies a partition format. It currently supports vfat/ext4/exfat
Parameter 2 Specifies an output file;
Parameter 3 Specifies an input directory;
Parameter 4 Specifies an output file's size and the unit is MByte. This size should be greater than the input directory's size and less than the corresponding size specified(in "length") in the partmap.txt file;
Since some file system information needs to be included in an image file this size will be greater than the input directory's size;
Parameter ５ Specifies a partition's tag;
5.3.1 Linux-4.14
为Linux-4.14 sd ROM生成boot.img和rootfs.img的命令如下：
$ cd rom-maker-lite $ ./tools/mk_fsimg.sh vfat boot.img ./part1/boot_linux-4.14_h5/ 40 boot $ ./tools/mk_fsimg.sh ext4 rootfs.img ./part2/h5/4.14/friendlycore/rootfs/ 2048 rootfs
上述命令适用于所有H5的板子。
