EFlasher/zh

1 eFlasher介绍
2 eFlasher 的安装
3 更新 eflasher 到最新版本
4 eFlasher系统的登录
5 启动图形界面版本的eFlasher
6 启动命令行版本的eFlasher
- 6.1 命令行直接安装系统
- 6.2 命令行交互模式
7 开机自动烧写指定的系统
- 7.1 配置方法
- 7.2 自动烧写的进度指示
8 烧写或恢复系统完成后做些其他事情
9 eMMC Flash的备份和恢复
10 针对量产用户的定制选项
11 更改IP地址为DHCP动态获取

1 eFlasher介绍

eFlasher (eMMC-flasher) 是FriendlyElec官方发布的工具，让用户能方便和轻松地将系统安装到板载的eMMC上运行，甚至可以抛开电脑，就能让你在多个系统中，选择并安装上你想要的系统。

eFlasher同时为量产提供了灵活的设置选项，以方便工厂量产时安装定制系统。

eFlasher为方便使用，提供了图形界面与命令行两个版本，为方便描述，这里为它们分别命名为: eflasher-gui 和 eflasher-console:
1) eflasher-gui: 有图形界面的eFlasher，推荐有LCD屏或者HDMI显示的用户使用，可以使用触摸屏操作，没有触摸屏时也可以使用鼠标操作;
2) eflasher-console: 命令行版本的eFlasher，可在串口终端或者ssh命令行上使用;

2 eFlasher 的安装

第一步: 下载包含eflasher工具的固件

到你所购买的板子相关WiKi页面，找到下载固件的章节，下载固件文件名为：XXXX-eflasher-YYYYMMDD-full.img.7z 的固件(其中XXXX替换为板子所在的平台型号, YYYYMMDD是该固件发布的日期),
这个固件内已经包含了所属平台的所有官方系统映象，包括最新版本的 Debian, Android5, Android4.4和Ubuntu core 系统 (不同的平台提供的系统有所不同)；
将 XXXX-eflasher-YYYYMMDD-full.img.7z 下载到电脑上，在Windows下制作SD卡，还需要下载Windows下的烧写工具: win32diskimager.rar；

第二步: 用eflasher固件制作SD启动卡

将固件用7z软件解压，得到.img结尾的文件，在Windows下插入SDHC卡（限4G及以上的卡)，以管理员身份运行Win32DiskImager，选择 Image File载入固件，选择你的SD卡盘符，点 Write 即开始写Image到SD卡；
如果你的电脑用的是Linux系统，你也可以用 dd 命令将解压后得到的 .img 文件直接写入SD卡完成启动卡的制作；

第三步: 启动eFlasher工具

将制作好的SD卡插入开发板，按住标住有“BOOT”字样的按键，上电，如你有HDMI、LCD或者USB2LCD，可以在上电之前先连接好。

3 更新 eflasher 到最新版本

在开发板上执行以下命令：

git clone https://github.com/friendlyarm/eflasher-updater
cd eflasher-updater/
./update.sh

4 eFlasher系统的登录

在命令行模式下使用以下帐号登录：
用户名: root
密码: fa
如果通过ssh登录，eFlasher系统的IP地址默认为 192.168.1.231

5 启动图形界面版本的eFlasher

系统启动时，图形界面版本的eFlasher会随系统自动启动，如你有连接HDMI或者LCD，应该会看到如下所示的界面：

点击触摸屏，或者用鼠标选择你需要烧写到eMMC的系统即可。

6 启动命令行版本的eFlasher

6.1 命令行直接安装系统

显示帮助信息:

# eflasher --help
-------------------------------------------------------
USAGE: eflasher [-i, --install <arg>]

OPTIONAL:
-i, --install <path>:  Install OS to eMMC without UI operation
-r, --restore <file>:  Restore backup file to eMMC without UI operation
-e, --exclude <files>: Ignore certain files, multiple files separated by commas
--low-format:          Low format the flash before burning
--auto-exit:           Automatically exit eflahser after burning or restoring
--disable-overlayfs:   Disable overlay filesystem
-c, --conf <arg>:      Set eflasher configuration file
-l, --list-devices:    List the supported board models
-v, --version:         Output version information
-h, --help:            Show this usage
-g, --gui:             Start eflasher gui

指定路径直接安装系统:

# eflasher -i /mnt/sdcard/friendlycore-xenial_4.14_armhf
Using config file:  "/tmp/eflasher.conf"
-------------------------------------------------------
>>friendlycore-xenial_4.14_armhf
Ready to Go with FriendlyCore,Total size: 1.10 GB,
Installing FriendlyCore ..., , ,
Finish!,Speed: 20.71 MB/s

6.2 命令行交互模式

如果板子没有连接显示设备，可以通过串口或ssh登录开发板，在命令行终端下输入命令 eflasher也可以进入eflasher的命令行交互界面，命令行交互界面如下图所示:

----------------------------------------------------------------------
  EFlasher v1.2 b190111 running on NanoPC-T4
    Doc: http://wiki.friendlyelec.com/wiki/index.php/EFlasher
    eMMC: 14.56 GB
----------------------------------------------------------------------
  # Select an OS to install:
    1) Android 8
   
  # Select your backup target device:
     tf) [*] TF card  (/dev/mmcblk0p1 - 4.27 GB free - 5.67 GB total - fuseblk)
    usb) [ ] USB disk  (<none>)
   
  # Backup eMMC flash to TF card:
    Not enough free disk space on your TF card
   
  # Restore eMMC flash from backup file:
    No backup files found
   
  # Configure automatic job:
    aui) Automatic installing (Curr:Off)
    aur) Automatic restoring (Curr:Off)
   
  # Format drive
    ftf) Format TF card back to original size
----------------------------------------------------------------------
>>> Enter an option (1/tf/usb/aui/aur/ftf) :

7 开机自动烧写指定的系统

7.1 配置方法

有三种途径可以进行配置：

方法1：在图形界面上，选择你要烧写的系统，在Ready to Go预览界面上，在屏幕下方钩选 "Start automatically at startup" 。
方法2: 将SD卡挂载到Windows电脑上，用notepad+文本编辑器在SD卡的Fat分区上新建一个名为eflasher.conf文件 (如果已存在就直接编辑即可)，其内容如下:

[General]
autoStart=/mnt/sdcard/XXXXXX

其中，XXXXXX替换成SD卡中存放固件的目录名，例如H3平台的FriendlyCore系统目录名为 friendlycore-xenial_4.14_armhf。

方法3: 开发板运行状态下，通过串口终端，用vi编辑文件：/mnt/sdcard/eflasher.conf，文件不存在就新增一个，内容同上面的方法2。

7.2 自动烧写的进度指示

上电开机时，板上的状态灯先是呈呼吸灯状态，开机烧写固件时状态灯会快闪，烧写完成后变成慢闪，并一直停留在慢闪状态。
状态灯通常为蓝灯，某些平台板子可能会是其他颜色。
也可以利用 LCD2USB 模块，或者LCD和HDMI屏幕，得到可视化的进度指示。

8 烧写或恢复系统完成后做些其他事情

在量产时，你可能会希望在烧写系统完成后做一些额外的事情，比如点亮某个LED，你可以修改 /opt/run-eflasher.sh 脚本，在 "./eflasher-gui" 开头这一行的后面加入代码，例如下面的示例，在烧写完成后，设置某个GPIO针脚：

./eflasher-gui -qws >/dev/null 2>&1
echo 13 > /sys/class/gpio/export 
echo out > /sys/class/gpio/gpio13/direction 
echo 0 > /sys/class/gpio/gpio13/value
echo 13 > /sys/class/gpio/unexport

以下脚本则演示在S5P4418/S5P6818平台上, 烧写系统后, 将cpu id写入到eMMC系统的 /etc/cpuid.txt 文件中:

./eflasher-gui -qws >/dev/null 2>&1
partprobe /dev/mmcblk1
mount /dev/mmcblk1p2 /media/
cat /sys/devices/platform/cpu/uuid > /media/etc/cpuid.txt
umount /media/

要让上面的脚本正常运作，我们还需要设置让 eflasher-gui 在烧写完成后自动退出，需要做以下设置：
用notepad+文本编辑器在SD卡的Fat分区上编辑并新建一个名为eflasher.conf文件，将AutoExit字段设置为True：

[General]
autoStart=/mnt/sdcard/friendlycore-xenial
autoExit=true

autoStart字段则是指定开机自动烧写指定的系统而无需交互, 如果没有连接屏幕, 可以通过 LED 烧来识别烧写状态, 默认情况下, 绿色LED快闪表示正在烧写.

9 eMMC Flash的备份和恢复

这个功能类拟于电脑上面的 ghost 软件，可以将整个 eMMC Flash 的数据备份到 U盘或移动硬盘，或者从 U盘恢复系统到 eMMC Flash，恢复系统时，可以恢复到同一个开发板，也可以恢复到同型号同规格的其他开发板。

为产品量产提供的便利：
在一块开发板上做好定制，比如预装好软件和设置，然后备份一份出来，恢复到其他开发板上，以达到量产的目的，由于是对eMMC Flash进行祼读和祼写，所以支持包括 Android和Linux 在内的所有系统及数据。

功能要求：
此功能要求你有一个容易大过 eMMC Flash 大小的U盘，或者移动硬盘，并且里面没有重要的数据，最好事先格式化为exFat或者ntfs格式，在必要时，EFlasher可能会对你磁盘进行重新分区及格式化（会事先询问）。

9.1 图形界面上执行备份和恢复

在 EFlasher 界面上点击 Backup and Restore 进入备份菜单，根据提示操作即可，如下图所示：

9.1.1 选择备份文件的存储位置

可以将备份文件放在 TF 卡，或者USB存储设备。

9.1.1.1 备份到TF卡

你的TF卡的大小应该大于或等于两倍的eMMC大小，例如eMMC是8G，则你应该准备一张16G的TF card。
默认情况下，8G以上的 TF 卡在 eFlasher 系统下并没有利用上所有的空间，需要做一次格式化，请点击界面上的 "Format TF card back to original size" 按钮进行格式化。

点击 "Backup eMMC Flash" 按钮开始备份整个 eMMC 的所有数据;
点击 "Restore eMMC Flash from backup file" 按钮开始恢复数据到 eMMC;

9.1.1.2 备份到USB存储设备

USB存储设备最好是 ext4/exfat/ntfs 格式的，如果不是，可以点击界面上的 "Re-layout and format USB Drive" 按钮对USB存储设备进行一次格式化，注意，此操作会丢失所有数据。

点击 "Backup eMMC Flash" 按钮开始备份整个 eMMC 的所有数据;
点击 "Restore eMMC Flash from backup file" 按钮开始恢复数据到 eMMC;

9.1.1.3 开始备份

点击 "Backup eMMC Flash" 按钮，选择备份文件 (扩展名为.raw) 的保存路径，然后开始备份，如下图所示：

9.1.1.4 开始恢复

点击 "Restore eMMC Flash from backup file" 按钮，选择raw文件后开始恢复数据到 eMMC，如下图所示：

9.2 命令行进行备份和恢复

在命令行终端执行以下命令启动命令行EFlasher，命令行终端可以是ssh或者串口终端：

# eflasher

然后你会看到如下功能菜单项：

----------------------------------------------------------------------
  EFlasher v1.2 b190111 running on NanoPC-T4
    Doc: http://wiki.friendlyelec.com/wiki/index.php/EFlasher
    eMMC: 14.56 GB
----------------------------------------------------------------------
  # Select an OS to install:
    1) Android 8
   
  # Select your backup target device:
     tf) [*] TF card  (/dev/mmcblk0p1 - 4.27 GB free - 5.67 GB total - fuseblk)
    usb) [ ] USB disk  (<none>)
   
  # Backup eMMC flash to TF card:
    Not enough free disk space on your TF card
   
  # Restore eMMC flash from backup file:
    No backup files found
   
  # Configure automatic job:
    aui) Automatic installing (Curr:Off)
    aur) Automatic restoring (Curr:Off)
   
  # Format drive
    ftf) Format TF card back to original size
----------------------------------------------------------------------
>>> Enter an option (1/tf/usb/aui/aur/ftf) :

9.2.1 选择备份文件的存储位置

可以将备份文件放在 TF 卡，或者USB存储设备，用 tf 和 usb 命令进行切换。

9.2.1.1 备份到TF卡

你的TF卡的大小应该大于或等于两倍的eMMC大小，例如eMMC是8G，则你应该准备一张16G的TF card。
默认情况下，8G以上的 TF 卡在 eFlasher 系统下并没有利用上所有的空间，需要做一次格式化，使用菜单上的 ftf 命令即可。

9.2.1.2 备份到USB存储设备

USB存储设备最好是 ext4/exfat/ntfs 格式的，如果不是，可以使用菜单上的 ftf 对USB存储设备进行一次格式化，注意，此操作会丢失所有数据。

9.2.1.3 开始备份

根椐菜单项前面插号的指示，输入bk并按回车启动备份，在命令行模式下，EFlasher会立即开始备份，存储为扩展名为raw的文件，如下图所示：

----------------------------------------------------------------------
  Backing up eMMC to /mnt/udisk/nanopc-t3-emmc.raw
----------------------------------------------------------------------
  Speed: 15.01 MB/s
  Remaining Time: 00:12:53
  [===========_______________________________________]  22%
----------------------------------------------------------------------
  >>>If you want to cancel, input "c" then press <Enter> key.

9.3 扩展功能

EFlasher允许你编写一些 Linux shell 脚本，来对 eMMC 的 boot分区或者根文件系统分区进行内容更改，比如：
1）增加个性化的开机LOGO
2）为板子分配静态的IP地址，或者MAC地址
3）通过网络更新数据，软件
4) 等等
EFlasher在完成对 eMMC 的恢复操作之后，自动执行你的脚本。
你的脚本需要放在一个单独的目录下，这个目录需要与备份文件同级，目录名称的命令规则是: 备份文件名+.d，例如备份文件名是 xxxx.raw，则脚本目录名应为 xxxx.raw.d。
EFlasher 在默认情况下，会为你的备份文件生成一个清理脚本，其作用是对文件系统做一些常规的清理工作，例如清理 tmp 目录下的临时文件、var目录下的log等等。
你可以通过参考 EFlasher 生成的清理脚本来了解应该如何访问 eMMC 的boot分区和根分区。

root@NanoPC-T3:/mnt/udisk/nanopc-t3-emmc.raw.d# tree
.
|-- cleanup.sh
`-- README.txt
 
0 directories, 2 files
root@NanoPC-T3:/mnt/udisk/nanopc-t3-emmc.raw.d#

(注: 使用开机自动还原功能时，此特性不起作用)

9.4 开机自动恢复指定的备份

有三种途径可以进行配置：

方法1：在图形界面上，进入Backup and restore界面，先选择备份文件所在的存储设备，可选择TF card或者USB disk，选择 Turn on "Automatic restoring" ，然后选择要恢复的文件即可。
方法2: 将存放有备份文件的设备（TF卡或U盘）挂载到电脑上，用notepad+文本编辑器在根目录新建一个名为eflasher.conf文件 (如果已存在就直接编辑即可)，示例内容如下:

[General]
autoStart=/mnt/sdcard/nanopct3-backup-20190101.raw

其中，/mnt/sdcard/代表TF card，/mnt/udisk代表USB磁盘.

方法3: 开发板运行状态下，通过串口终端，如果备份文件位于TF卡，用vi编辑文件：/mnt/sdcard/eflasher.conf，如果备份文件位于 USB存储设备，用vi编辑文件：/mnt/udisk/eflasher.conf，文件不存在就新增一个，内容同上面的方法2。

10 针对量产用户的定制选项

10.1 EFlasher对系统映象的管理

EFlasher会从SD卡的Fat分区读取系统映象文件，将SD卡插入Windows的电脑，你可以直接管理这些映象文件。
在SD卡的Fat分区，根目录下的每一个子目录，代表一个OS，目录名称可随意命令（但不能是中文）,
如果SD卡的Fat分区空间不够用，你也可以在一个U盘中存放这些系统文件，目录结构与SD卡的相同。

例如Fat分区有下面4个目录：

对应以下4个可安装的系统：

每个目录下的文件，分别说明如下：
烧写配置文件：

env.conf	用于设置uboot环境变量，内核启动参数
info.conf	用于个性化烧写程序界面上的名称、图标以及定义该系统所属的硬件平台，示例说明： title=Android 5 ---> 系统名称显示为Android5 require-board=s5p4418 ---> 所属平台 s5p4418, 可选的值还有 s5p6818, h3, a64 等 version=2016-11-17 ---> 该rom的版本（或制作的日期) icon=androidos.png ---> 图标上面的定义对应的显示所下：

系统映象文件, 不同的系统可能不同：

2ndboot.bin	Second Boot
boot.img	boot分区映象文件
bootloader	U-Boot
cache.img	Android Cache分区映象
system.img	系统分区的映象
userdata.img	数据分区的映象
partmap.txt	分区描述文件

以上映象文件默认已经预装在eFlasher的固件中，不过你也可以到指定板子的下载地址下载它们，进入官方的下载地址指向的网盘目录，这些系统映象放在一个名为 images-for-eflasher 的目录下，以下是S5P6818开发板的网盘目录:

可以下载这个目录下的文件然后解压到SD卡的Fat分区或者U盘即可。

10.2 制作自已的量产Eflasher烧写卡

请参考 How to make your own SD-bootable ROM/zh

10.3 在EFlasher系统中连接WiFi

写入如下内容到配置文件：/etc/wpa_supplicant/wpa_supplicant.conf，其中，SSID和PASSWORD请替换为路由器的SSID和密码：

ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev
update_config=1
country=CN
network={
  ssid="SSID"
  psk="PASSWORD"
  key_mgmt=WPA-PSK
}

如果WiFi路由并没有设置密码，请将key_mgmt设置为NONE, 删除psk=这一行。

11 更改IP地址为DHCP动态获取

For faster startup speed, we set the eflasher to static ip address: 192.168.1.231,

If you want to change to dhcp, you can modify this file:
/etc/network/interfaces.d/eth0

Change the contents of this file to:

auto eth0
iface eth0 inet dhcp