How to make your own SD-bootable ROM/zh
Contents
1 制作RK3399平台的系统映像
请参考这个git仓库: https://github.com/friendlyarm/sd-fuse_rk3399
2 制作S5P4418平台的系统映像
请参考这个git仓库: https://github.com/friendlyarm/sd-fuse_s5p4418
3 制作S5P6818平台的系统映像
请参考这个git仓库: https://github.com/friendlyarm/sd-fuse_s5p6818
4 制作H3 平台的系统映像
如果你定制了U-boot、Linux内核、文件系统，并且想基于自己定制的文件制作Linux系统映像文件 (以下简称为ROM文件)，你可以选择用dd命令将带有你的应用程序和配置的SD卡的数据完整地拷贝出来，这种方法简单粗暴，但是效率不高。另外，你也可以使用FriendlyElec 提供的rom-maker-lite工具。
rom-maker-lite是一套通用的制作映像文件的脚本工具，目前支持为 H3/H5 系列的开发板制作Linux平台的sd/eflasher ROM文件(尚未支持Android)。
- 执行./mkimage.sh查看帮助信息:
$ ./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
参数 说明 -c <filesystem type> -c 用于指定ROM Image内各分区的文件系统格式，对于H3/H5系列的开发板：
-c 1表示使用“misc(bootloader) + fat32 boot.img + ext4 rootfs.img”布局，适用于FriendlyCore/Ubuntu/Debian/OpenWrt等sd ROM；
-c 2表示使用"misc(bootloader) + fat32 boot.img + ext4 rootfs.img + exfat friendlyarm.img"布局，适用于eflasher ROM。-m <partmap> -m 用于指定制作ROM时需要的partmap文件。
partmap文件用于指定ROM Image的组成文件和分区的大小，不同的板子或者是同一板子不同版本的BSP使用的partmap文件是不一样的。-d "<misc dir>;<partition1 dir>;<partition2 dir>;..." -d 用于指定系统文件所在的目录，每个路径之间用“；”分割，对于H3/H5系列的开发板:
<misc dir>: 用于指定bootloader所在的目录路径；
<partition1 dir>: 用于指定boot分区的目录路径；
<partition2 dir>： 用于指定rootfs分区的目录路径；
最后的...表示就还可以接收更多的目录路径。当制作eflasher ROM时，就需要添加friendlyarm分区的目录路径；
- 准备工作
经测试过PC机 Ubuntu版本包括:
1) ubuntu-16.04.5-desktop-amd64.iso
2) ubuntu-18.04.1-desktop-amd64.iso
如果你当前PC机使用的Ubuntu系统无法成功执行出系统映像，请尝试切换到上面这两个版本的Ubuntu系统。
在开始制作系统映像前，必须先安装下列软件包:
$ apt-get install tree exfat-utils dosfstools python3-tk
由于制作系统映像需要root权限，请先切换到root用户:
$ su root
4.1 制作sd ROM
4.1.1 Linux-4.14
- 事实上，对于Linux-4.14 BSP，相同rootfs的所有H3 板子的sd ROM文件都是同一个。
- 所以对于这个版本的BSP，所有H3 系列的板子的sd ROM 的制作命令是一样的。
- 这里以制作FriendlyCore sd ROM为例进行讲解，Ubuntu、Debian、OpenWrt等sd ROM文件的制作方法是一样的。
- 准备FriendlyCore的rootfs目录
有2种方式可以准备FriendlyCore的rootfs目录：
1) 制作一张带FriendlyCore系统的SD卡，然后基于该SD卡进行定制开发，当开发完毕后，在PC机上挂载该SD卡的rootfs分区;
2) 解压DVD光盘里/rootfs/rootfs_friendlycore_4.14_YYYYMMDD.tgz
- 假设rootfs目录的路径为./rom-maker-lite/part2/h3/4.14/friendlycore/rootfs/，执行下面的命令可生成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/"
- 对于所有使用Linux-4.14 BSP的H3板子，使用的都是同一个partmap文件: partmap/h3_linux-4.14/partmap.txt。
- 如果有需要，你可以将misc/uboot-2017_h3、part1/boot_linux-4.14_h3目录下的文件替换为你自己定制编译的文件，通过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
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 │ └── u-boot-sunxi-with-spl.bin ├── SD-bootable-1.img
- part1/boot_linux-4.14_h3/目录被制作成了boot.img;
- part2/h3/4.14/friendlycore/rootfs/目录被制作成了rootfs.img;
- SD-bootable-1.img则为最终的sd ROM文件，它是由SD-bootable-1目录下的所有文件组装而来的，等效于FriendlyElec 发布的nanopi-[h3]_sd_friendlycore-xenial_4.14_armhf_YYYYMMDD.img;
4.1.2 Linux-3.4
- 与Linux-4.14 sd ROM不同，相同rootfs的不同的H3板子的Linux-3.4 sd ROM是不同的。
- 这里以制作NanoPi M1的Linux-3.4 FriendlyCore sd ROM为例进行讲解，Ubuntu、Debian、OpenWrt等sd ROM的制作方法是一样的。
- 准备FriendlyCore的rootfs目录
有1种方式可以准备FriendlyCore的rootfs目录：
1) 制作一张带FriendlyCore系统的SD卡，然后基于该SD卡进行定制开发，当开发完毕后，在PC机上挂载该SD卡的rootfs分区;
- 假设rootfs目录的路径为./rom-maker-lite/part2/m1/3.4/friendlycore/rootfs/，执行下面的命令可以生成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"
- 对于所有使用Linux-3.4 BSP的H3板子，使用的都是同一个partmap文件: partmap/h3_linux-3.4/partmap.txt。
- 如果有需要，你可以将misc/uboot-2011_m1、part1/boot_linux-3.4_m1目录下的文件替换为你自己定制编译的文件，通过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
mkimage.sh执行成功后，会生成out/SD-bootable-1(这里的"1"对应参数“-c 1”)目录，，其内容如下:
$ 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
- part1/boot_linux-3.4_m1目录被制作成了boot.img;
- part2/h3/3.14/friendlycore/rootfs/目录被制作成了rootfs.img;
- SD-bootable-1.img则为最终的sd ROM文件，它是由SD-bootable-1目录下的所有文件组装而来的，等效于FriendlyElec 发布的nanopi-m1_sd_friendlycore-xenial_3.4_armhf_YYYYMMDD.img;
- 以此类推，NanoPi M1 Plus 的sd ROM 制作命令如下:
$ ./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"
生成的SD-bootable-1.img等效于FriendlyElec 发布的nanopi-m1-plus_sd_friendlycore-xenial_3.4_armhf_YYYYMMDD.img.zip。NanoPi NEO / NanoPi NEO Air也是同样的道理，这样不再赘述。
4.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 │ └── u-boot-sunxi-with-spl.bin
- 准备eflasher的rootfs目录
有2种方式可以准备eflasher的rootfs目录：
1) 制作一张带eflasher 系统的SD卡，然后基于该SD卡进行定制开发，当开发完毕后，在PC机上挂载该SD卡的rootfs分区;
2) 解压DVD光盘里/rootfs/rootfs_eflasher_4.14_YYYYMMDD.tgz
- 假设eflasher rootfs目录的路径为./rom-maker-lite/part2/h3/4.14/eflasher/rootfs/，执行下面的命令可生成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/"
mkimage.sh执行成功后，会生成out/SD-bootable-2目录，其内容如下:
$ tree out/ out/ ├── 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
part1/boot_linux-4.14_h3/目录被制作成了boot.img;
part2/h3/4.14/eflasher/rootfs/目录被制作成了rootfs.img;
out/SD-bootable-1/目录被制作成了friendlyarm.img;
SD-bootable-2.img则为最终的eflasher ROM文件，它是由SD-bootable-２目录下的所有文件组装而来的，等效于FriendlyElec 发布的nanopi-[h3]_eflasher_friendlycore-xenial_4.14_armhf_YYYYMMDD.img;
事实下，FriendlyElec发布的所有H3板子的nanopi-[h3]_eflasher_friendlycore-xenial_4.14_armhf_YYYYMMDD.img.zip都是同一个文件。
4.3 仅制作boot.img/rootfs.img
rom-maker-lite是通过./tools/mk_fsimg.sh脚本来生成分区文件(boot.img、rootfs.img)的，其用法如下： </syntaxhighlight>
参数 说明 参数１ 指定分区格式，支持vfat/ext4/exfat
参数2 指定输出文件;
参数3 指定输入目录;
参数4 指定输出文件的大小，单位是MByte，必须大于输入目录。
可根据输入目录实际情况填写，通常情况下由于需要保存文件系统的信息，需要比输入目录大一点，如果提示空间不足，则需要增大该参数。参数５ 指定分区的标签;
4.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_h3/ 40 boot $ ./tools/mk_fsimg.sh ext4 rootfs.img ./part2/h3/4.14/friendlycore/rootfs/ 4096 rootfs
上述命令适用于所有H3的板子。
4.3.2 Linux-3.4
单独为NanoPi M1 Linux-3.14 sd ROM生成boot.img和rootfs.img的命令如下：
$ 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/ 4096 rootfs
其他H3的板子的命令也是类似的.
5 制作H5 平台的系统映像
如果你定制了U-boot、Linux内核、文件系统，并且想基于自己定制的文件制作Linux系统映像文件 (以下简称为ROM文件)，你可以选择用dd命令将带有你的应用程序和配置的SD卡的数据完整地拷贝出来，这种方法简单粗暴，但是效率不高。另外，你也可以使用FriendlyElec 提供的rom-maker-lite工具。
rom-maker-lite是一套通用的制作映像文件的脚本工具，目前支持为 H3/H5 系列的开发板制作Linux平台的sd/eflasher ROM文件(尚未支持Android)。
- 执行./mkimage.sh查看帮助信息:
$ ./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
参数 说明 -c <filesystem type> -c 用于指定ROM Image内各分区的文件系统格式，对于H3/H5系列的开发板：
-c 1表示使用“misc(bootloader) + fat32 boot.img + ext4 rootfs.img”布局，适用于FriendlyCore/Ubuntu/Debian/OpenWrt等sd ROM；
-c 2表示使用"misc(bootloader) + fat32 boot.img + ext4 rootfs.img + exfat friendlyarm.img"布局，适用于eflasher ROM。-m <partmap> -m 用于指定制作ROM时需要的partmap文件。
partmap文件用于指定ROM Image的组成文件和分区的大小，不同的板子或者是同一板子不同版本的BSP使用的partmap文件是不一样的。-d "<misc dir>;<partition1 dir>;<partition2 dir>;..." -d 用于指定系统文件所在的目录，每个路径之间用“；”分割，对于H3/H5系列的开发板:
<misc dir>: 用于指定bootloader所在的目录路径；
<partition1 dir>: 用于指定boot分区的目录路径；
<partition2 dir>： 用于指定rootfs分区的目录路径；
最后的...表示就还可以接收更多的目录路径。当制作eflasher ROM时，就需要添加friendlyarm分区的目录路径；
- 准备工作
经测试过PC机 Ubuntu版本包括:
1) ubuntu-16.04.5-desktop-amd64.iso
2) ubuntu-18.04.1-desktop-amd64.iso
如果你当前PC机使用的Ubuntu系统无法成功执行出系统映像，请尝试切换到上面这两个版本的Ubuntu系统。
在开始制作系统映像前，必须先安装下列软件包:
$ apt-get install tree exfat-utils dosfstools python3-tk
由于制作系统映像需要root权限，请先切换到root用户:
$ su root
- 为H5 系列的板子制作基于Uboot-2017 + Linux-4.14 的sd ROM(例如FriendlyCore/Debian/OpenWrt...)
事实上，对于Uboot-2017 + Linux-4.14版本的BSP，所有H5 系列的板子的sd ROM文件都是同一个。所以对于这个版本的BSP，所有H3 系列的板子的sd ROM 的制作命令是一样的。
这里以制作FriendlyCore sd ROM为例进行讲解，Debian、OpenWrt等sd ROM文件的制作方法是类似的。
假设你已经有一张带有FriendlyCore系统的SD卡，并且该SD卡的rootfs目录下已经包含了你自己的应用程序和设置。请将该SD卡插入PC机中，然后挂载SD卡的rootfs分区(假设挂载路径为rom-maker-lite/part2/h3/4.14/friendlycore/rootfs/, 请注意使用真实路径)，使用下面的命令可以生成你自己定制的ROM文件:
$ ./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/"
如果有需要，可以将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
对于所有使用Linux-4.14 BSP的H5板子，使用的都是同一个partmap文件partmap/h5_linux-4.14/partmap.txt。
mkimage.sh执行成功后，会生成out/SD-bootable-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.img则为最终的sd ROM文件，它等效于FriendlyElec 发布的nanopi-[h5]_sd_friendlycore-xenial_4.14_arm64_YYYYMMDD.img.zip，你可以用win32diskimager或者dd命令将SD-bootable-1.img烧写到SD卡中。
- 为H5 系列的板子制作基于Uboot-2014 + Linux-3.10 的sd ROM(例如FriendlyCore/Debian/OpenWrt...)
无论是基于什么版本的BSP，做rom的原理都是一样的，这里不再赘述。这里以制作NanoPi NEO2的FriendlyCore sd ROM为例进行讲解，Debian、OpenWrt等sd ROM的制作方法是类似的。
执行命令:
$ ./mkimage.sh -c 1 -m partmap/h5_linux-3.10/partmap.txt -d "misc/uboot-2014_neo2/;part1/boot_linux-3.10_neo2/;part2/neo2/3.10/friendlycore/rootfs"
生成的SD-bootable-1.img等效于FriendlyElec 发布的nanopi-neo2_sd_friendlycore-xenial_3.10_arm64_YYYYMMDD.img.zip，如果有需要，可以将对应目录下的文件替换为你自己的定制文件。对于所有使用Linux-3.10 BSP的H5板子，使用的都是同一个partmap文件partmap/h5_linux-3.10/partmap.txt。
以此类推，NanoPi NEO Plus2 的sd ROM 制作命令如下:
$ ./mkimage.sh -c 1 -m partmap/h5_linux-3.10/partmap.txt -d "misc/uboot-2014_neo-plus2/;part1/boot_linux-3.10_neo-plus2/;part2/neo-plus2/3.10/friendlycore/rootfs"
生成的SD-bootable-1.img等效于FriendlyElec 发布的nanopi-neo-plus2_sd_friendlycore-xenial_3.10_arm64_YYYYMMDD.img.zip
- 为H5 系列的板子制作基于Uboot-2017 + Linux-4.14 的eflasher ROM
制作eflasher ROM的前提条件是已经成功制作出了FriendlyCore/Debian/OpenWrt等sd ROM，即已经有待烧写到eMMC的原材料文件，例如基于Uboot-2017 + Linux-4.14的FriendlyCore系统:
$ tree out/ out/ ├── SD-bootable-1 │ └── your_company │ ├── boot.img │ ├── info.conf │ ├── partmap.txt │ ├── rootfs.img │ ├── sunxi-spl.bin │ └── u-boot.itb
假设你有一张带有eflasher 系统的SD卡，请将该SD卡插入PC机中，然后挂载SD卡的rootfs分区(假设挂载路径为part2/h5/4.14/eflasher/rootfs, 请注意使用真实路径)，然后通过以下命令就可以生成eflasher ROM:
$ ./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/ out/ ├── SD-bootable-1 │ └── your_company │ ├── boot.img │ ├── info.conf │ ├── partmap.txt │ ├── rootfs.img │ ├── sunxi-spl.bin │ └── u-boot.itb ├── SD-bootable-1.img ├── 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
SD-bootable-2.img即为最终的eflasher ROM文件，它等效于FriendlyElec 发布的nanopi-[h5]_eflasher_friendlycore-xenial_4.14_arm64_YYYYMMDD.img.zip。eflasher ROM能烧写什么系统到eMMC完全取决于out/SD-bootable-1/里包含了什么系统，你可以用win32diskimager或者dd命令将SD-bootable-2.img烧写到SD卡中。
