2. Upgrade the firmware via USB cable¶

2.1. Introduction¶

This article describes how to upgrade the firmware file on the host to the flash memory of the development board through the Type-C data cable. When upgrading, you need to choose the appropriate upgrade mode according to the host operating system and firmware type.

2.2. Preparatory Tools¶

ROC-RK3566-PC development board
Firmware
host computer
Type-C data cable

There are two types of firmware files:

A single unified firmware

The unified firmware is a single file packaged and merged by all files such as the partition table, bootloader, uboot, kernel, system and so on. The firmware officially released by Firefly adopts a unified firmware format. Upgrading the unified firmware will update the data and partition table of all partitions on the motherboard, and erase all data on the motherboard.
Multiple partition images

That is, files with independent functions, such as partition table, bootloader, and kernel, are generated during the development phase. The independent partition image can only update the specified partition, while keeping other partition data from being destroyed, it will be very convenient to debug during the development process.

Through the unified firmware unpacking / packing tool, the unified firmware can be unpacked into multiple partition images, or multiple partition images can be merged into a unified firmware.

In order to avoid the burning problem caused by the upgrade tool version, it is recommended to use the tool packaged inside the public firmware package for burning. After decompressing the public firmware package, it is as follows:

XXXX_Android11_HDMI_XXXX
├── XXXX_Android11_HDMI_XXXX.img
├── linux
│   └── Linux_Upgrade_Tool_v1.59.zip
└── windows
    ├── DriverAssitant_v5.1.1.zip
    └── RKDevTool_Release_v2.81.zip

2.2.1. Windows¶

Tool: Use tools in the firmware package or download here Androidtool_xxx (version number)

AndroidTool defaults to display in Chinese. We need to change it to English. Open config.ini with an text editor (like notepad). The starting lines are:

#Language Selection: Selected=1(Chinese); Selected=2(English)
[Language]
Kinds=2
Selected=1
LangPath=Language\

Change Selected=1 to Selected=2, and save. From now on, AndroidTool will display in English.Now, run AndroidTool.exe: (Note: If using Windows 7/8, you’ll need to right click it, select to run it as Administrator)

_images/upgrade_firmware_androidtool_zh.png

2.2.1.1. Install RK USB drive¶

Download Release_DriverAssistant.zip, extract, and then run the DriverInstall.exe inside . In order for all devices to use the updated driver, first select Driver uninstall(驱动卸载) and then select Driver install(驱动安装).

_images/upgrade_firmware_install_RK_USB.png

2.2.1.2. Connect devices¶

we can put the device into upgrade mode by hardware as follows:

Disconnect the power adapter first:
- Press the RECOVERY button(on the phone jack side) on the device and hold.
- Type-C data cable connects one end to the host and the other end to the development board.
- About two seconds later, release the RECOVERY button.

put the device into upgrade mode by software as follows:

Type-C data cable is connected, use the command in the serial debugging terminal or adb shell

reboot loader

The host should prompt for new hardware and configure the driver. Open Device manager and you will see the new Device Rockusb Device appear as shown below. If not, you need to go back to the previous step and reinstall the driver.

_images/upgrade_firmware_new_equipment.png

2.2.2. Linux¶

There is no need to install device driver under Linux. Please refer to the Windows section to connect the device.

Tool : Use tools in the firmware package or download here upgrade_tool_xxx (version number)
Tool : [Linux_adb_fastboot]

2.2.2.1. Upgrade_tool¶

Install it into the system as follows for easy invocation:

unzip Linux_Upgrade_Tool_xxxx.zip
cd Linux_UpgradeTool_xxxx
sudo mv upgrade_tool /usr/local/bin
sudo chown root:root /usr/local/bin/upgrade_tool
sudo chmod a+x /usr/local/bin/upgrade_tool

2.3. Upgrade the firmware¶

Determine the board ROC-RK3566-PC before upgrading unified firmware update.img whether has Nor Flash, as shown in the figure below:

_images/nor_flash-position.jpg

If the board has Nor Flash, please refer to chapter Switching Upgrade Storage for upgrading, else please follow the steps below to continue:

Notice：Linux SDK v1.2.4a and later using extboot, please use extboot.img instead of boot.img in the following instructions（Linux only, ignore it if using Android）

How to check SDK version:

The version format is vx.x.xx, eg: v1.2.4a
Firmware filename has SDK version(…_vx.x.xx_date.img)
Buildroot usecat /etc/versionto get version(rk356x_linux_release_date_vx.x.xx.xml)
Ubuntu useffgo versionto get(rk356x_linux_release_date_vx.x.xx.xml)
In SDK check the link:ls -l .repo/manifests/rk356x_linux_release.xml
If you can’t get version by methods above, that means you are using old version, no support for extboot

Do not burn extboot.img into old version firmware!

Besides, extboot ubuntu support update kernel by deb package, please see Ubuntu Manual

2.3.1. Windows¶

2.3.1.1. Upgrade unified firmware - update.img¶

The steps to update the unified firmware update.img are as follows:

Switch to the “upgrade firmware” page.
Press the “firmware” button to open the firmware file to be upgraded. The upgrade tool displays detailed firmware information.
Press the “upgrade” button to start the upgrade.
If the upgrade fails, you can try methods in Switching Upgrade Storage

2.3.1.2. Upgrade Partition image¶

The steps to upgrade the partition image are as follows:

Switch to the “download image” page.
Click Dev Partition
Check the partition to be burned, and select multiple.
Make sure the path of the image file is correct. If necessary, click the blank table cell on the right side of the path to select it again.
Click “Run” button to start the upgrade, and the device will restart automatically after the upgrade.

_images/upgrade_firmware_androidtool_zh.png

2.3.2. Linux¶

2.3.2.1. Upgrade unified firmware - update.img¶

sudo upgrade_tool uf update.img

If the upgrade fails, you can try methods in Switching Upgrade Storage

2.3.2.2. Upgrade Partition image¶

sudo upgrade_tool di -b /path/to/boot.img
sudo upgrade_tool di -r /path/to/recovery.img
sudo upgrade_tool di -m /path/to/misc.img
sudo upgrade_tool di -u /path/to/uboot.img
sudo upgrade_tool di -dtbo /path/to/dtbo.img
sudo upgrade_tool di -p paramater   #upgrade parameter
sudo upgrade_tool ul bootloader.bin #upgrade bootloader

2.3.2.3. Android fastboot¶

Download Linux_adb_fastboot, And according to the following method to install into the system, easy to call：

sudo mv adb /usr/local/bin
sudo chown root:root /usr/local/bin/adb
sudo chmod a+x /usr/local/bin/adb

sudo mv fastboot /usr/local/bin
sudo chown root:root /usr/local/bin/fastboot
sudo chmod a+x /usr/local/bin/fastboot

fastboot Burn dynamic partitions

adb reboot fastboot # enter bootloader
sudo fastboot flash vendor vendor.img
sudo fastboot flash system system.img
sudo fastboot reboot # After the burn is successful, restart

2.4. FAQs¶

2.4.1. 1. How to forcibly enter MaskRom mode¶

A1 : If the board does not enter Loader mode, you can try to force your way into MaskRom mode. See operation method “How to enter MaskRom mode”.

2.4.2. 2. Analysis of programming failure¶

If Download Boot Fail occurs during the programming process, or an error occurs during the programming process, as shown in the figure below, it is usually caused by the poor connection of the USB cable, the inferior cable, or the insufficient drive capability of the USB port of the computer. Troubleshoot the computer USB port.

_images/upgrade_downloadfail.png

2.4.3. 3. Has Spi Flash(Nor Flash)，After MaskRom，Download failure¶

If board has Spi Flash and eMMC，After MaskRom，need select Storage，See operation method “Switching Upgrade Storage” 。