Difference between revisions of "Rock5/install/spi"
| Line 4: | Line 4: | ||
[[rock5 | ROCK 5]] > [[rock5/install | Installation]] > [[rock5/install/spi | Install the bootloader to the SPI NOR flash]] | [[rock5 | ROCK 5]] > [[rock5/install | Installation]] > [[rock5/install/spi | Install the bootloader to the SPI NOR flash]] | ||
| − | + | = Install the bootloader to the SPI NOR flash = | |
| Line 18: | Line 18: | ||
---- | ---- | ||
| − | + | == Simple method == | |
| − | + | === Requirements === | |
* ROCK 5B with proper power | * ROCK 5B with proper power | ||
| Line 30: | Line 30: | ||
| − | + | === Procedure === | |
| − | + | ==== 1) Boot linux from µSD card/eMMC ==== | |
The first step is to boot the ROCK 5 with linux from an µSD card or an eMMC module. | The first step is to boot the ROCK 5 with linux from an µSD card or an eMMC module. | ||
| Line 41: | Line 41: | ||
''or check [[rock5/install/eMMC | this guide]] to flash a new image to an eMMC module)'' | ''or check [[rock5/install/eMMC | this guide]] to flash a new image to an eMMC module)'' | ||
| − | + | ==== 2) Download required files on the rock ==== | |
You can download files by using <code>wget DOWNLOADURLTOTHEFILE</code> | You can download files by using <code>wget DOWNLOADURLTOTHEFILE</code> | ||
| Line 60: | Line 60: | ||
| − | + | ==== 3) Flash the SPI flash ==== | |
Make sure the SPI flash is available: | Make sure the SPI flash is available: | ||
| Line 77: | Line 77: | ||
sync | sync | ||
| − | + | ==== 4) Reboot ==== | |
Now you are done flashing a bootloader supporting NVMe booting. | Now you are done flashing a bootloader supporting NVMe booting. | ||
| Line 93: | Line 93: | ||
| − | + | == Advanced (external) method == | |
| − | + | === Requirements === | |
* ROCK 5B with proper power | * ROCK 5B with proper power | ||
| Line 105: | Line 105: | ||
| − | + | === Procedure === | |
| − | === | + | ==== 1) Install Tools & Drivers ==== |
| − | Please check this guide, [[rock5/install/rockchip-flash-tools | Install rockchip flash tools under Windows/Linux/MacOS PC]] | + | Please check this guide, [[rock5/install/rockchip-flash-tools | Install rockchip flash tools under Windows/Linux/MacOS PC.]] |
| − | + | The PC tools we use to communicate with ROCK 5 in Maskrom mode are the '''rkdeveloptool''' on Linux/macOS and '''RkDevtool''' on Windows PC. | |
| − | ==== | + | ==== 2) Get RK3588 loader and U-Boot images ==== |
* Download the loader image from: | * Download the loader image from: | ||
| Line 126: | Line 126: | ||
| − | === | + | ==== 3) Boot the board to Maskrom mode ==== |
[[File:Rock-5b-typec-maskrom.jpeg|400px]] | [[File:Rock-5b-typec-maskrom.jpeg|400px]] | ||
| Line 138: | Line 138: | ||
* Release the golded button. | * Release the golded button. | ||
* Check usb device | * Check usb device | ||
| − | ** For macOS host: lsusb result: | + | ** For macOS host: <code>lsusb</code> a result should be: <code>... ID 2207:350b Fuzhou Rockchip Electronics Co., Ltd. Composite Device</code> |
| − | ** For Linux host: lsusb result: | + | ** For Linux host: <code>lsusb</code> a result should be: <code>... ID 2207:350b Fuzhou Rockchip Electronics Company</code> |
** For Windows host: Open RKDevTool and you would see the device is in '''Found One MASKROM Device''' | ** For Windows host: Open RKDevTool and you would see the device is in '''Found One MASKROM Device''' | ||
| − | === | + | ==== 4) Write u-boot images to SPI NOR flash or erase SPI NOR flash ==== |
| − | ==== Option 1 | + | ===== Option 1: Flash with Linux PC/Mac ===== |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | On | + | On linux or Mac, run the rkdeveloptool |
sudo rkdeveloptool ld | sudo rkdeveloptool ld | ||
DevNo=1 Vid=0x2207,Pid=0x350b,LocationID=106 Maskrom | DevNo=1 Vid=0x2207,Pid=0x350b,LocationID=106 Maskrom | ||
| − | This will load the loader (flash helper, downloaded from | + | This will load the loader (flash helper, downloaded from 2) to run on ROCK 5B and init the ram and prepare the flashing environment etc. |
sudo rkdeveloptool db /path/to/rk3588_spl_loader_v1.08.111.bin # will output: | sudo rkdeveloptool db /path/to/rk3588_spl_loader_v1.08.111.bin # will output: | ||
| Line 181: | Line 168: | ||
now, the device should boot on SPI Nor Flash. And '''the blue led is on'''. | now, the device should boot on SPI Nor Flash. And '''the blue led is on'''. | ||
| − | ==== Option | + | ===== Option 2: Flash with Windows PC ===== |
Double click the RKDevTool.exe and you will see the following interface: | Double click the RKDevTool.exe and you will see the following interface: | ||
Double click the '''RKDevTool.exe''' and you will see the following interface: | Double click the '''RKDevTool.exe''' and you will see the following interface: | ||
| − | ===== Step 1: | + | ===== Step 1: confirm that ROCK 5B is in maskrom mode ===== |
If your ROCK 5B is in maskrom mode and connects to PC, you can see that the program detects it, as the red arrow below | If your ROCK 5B is in maskrom mode and connects to PC, you can see that the program detects it, as the red arrow below | ||
| Line 211: | Line 198: | ||
[[File: rock-5b-spi-flash-02.png |1000px]] | [[File: rock-5b-spi-flash-02.png |1000px]] | ||
| − | == Addition: Erase the SPI | + | == Addition: Erase the SPI NOR flash == |
==== Option 1: Operate on ROCK 5B ==== | ==== Option 1: Operate on ROCK 5B ==== | ||
| − | Boot your ROCK 5B with | + | Boot your ROCK 5B with linux running on µSD card or eMMC module: |
Make sure the SPI flash is available: | Make sure the SPI flash is available: | ||
| Line 225: | Line 212: | ||
==== Option 2: Erase with Linux PC/Mac ==== | ==== Option 2: Erase with Linux PC/Mac ==== | ||
| − | Please notice that when you want to erase SPI | + | Please notice that when you want to erase SPI NOR flash, fire these commands. If you don't have zero.img, download this one please. [https://dl.radxa.com/rock5/sw/images/others/zero.img.gz zero.img] |
And extract it. | And extract it. | ||
| Line 234: | Line 221: | ||
==== Option3: Erase with Windows PC==== | ==== Option3: Erase with Windows PC==== | ||
| − | Before Erasing, please confirm that ROCK 5B is in | + | Before Erasing, please confirm that ROCK 5B is in maskrom mode |
===== Step 1: Download ===== | ===== Step 1: Download ===== | ||
Revision as of 21:03, 1 February 2023
ROCK 5 > Installation > Install the bootloader to the SPI NOR flash
Contents
- 1 Install the bootloader to the SPI NOR flash
- 1.1 Simple method
- 1.2 Advanced (external) method
- 1.3 Addition: Erase the SPI NOR flash
- 1.4 Troubleshooting
Install the bootloader to the SPI NOR flash
ROCK 5 has a SPI flash on the board, it contains the bootloader for backup booting and support other booting media that the SoC maskrom mode itself does not direct support (such as NVMe, SATA or USB 3).
This page describe how to write/install the bootloader to the SPI flash on the ROCK 5B.
There are two methods available:
- simple method - flash the SPI from the ROCK 5 itself
- advanced method - flash the SPI with an external computer
Simple method
Requirements
- ROCK 5B with proper power
- SD card or eMMC module
- Linux image for ROCK 5B - (Android images are not supported yet)
Procedure
1) Boot linux from µSD card/eMMC
The first step is to boot the ROCK 5 with linux from an µSD card or an eMMC module.
(check this guide to flash a new image to an µSD card or check this guide to flash a new image to an eMMC module)
2) Download required files on the rock
You can download files by using wget DOWNLOADURLTOTHEFILE
for example to download the file to clear the spi: wget https://dl.radxa.com/rock5/sw/images/others/zero.img.gz
Download the:
and the latest SPI bootloader:
- release version with u-boot serial console disabled (Recommend for everything except armbian)
- armbian version (Use this if you like to boot armbian from the M.2 NVME SSD)
- debug version with u-boot serial console enabled (This is an debug bootloader if you need to troubleshoot booting issue with serial)
3) Flash the SPI flash
Make sure the SPI flash is available:
ls /dev/mtdblock*
It should give /dev/mtdblock0 back
extract/uncompress the prevois downloaded SPI clearing file: (gzip should be already installed otherwise install it)
gzip -d zero.gz
completely clear the SPI flash:
sudo dd if=zero.img of=/dev/mtdblock0
now write you desired bootloader to the SPI flash: (replace spi-image.img with the name of you downloaded image - eg: rock-5b-spi-image-g49da44e116d.img for the normal bootloader)
sudo dd if=spi-image.img of=/dev/mtdblock0 sync
4) Reboot
Now you are done flashing a bootloader supporting NVMe booting.
I you do not flashed the NVMe already check this guide to flash it. (again there are two options available)
Otherwise power off the ROCK 5, remove the µSD card or eMMC module and power it back up.
It should now boot from your NVMe. 😉
Advanced (external) method
Requirements
- ROCK 5B with proper power
- Linux image for ROCK 5B, Android image is not supported yet
- SD card or eMMC module
- USB Type C cable
- Windows/linux/macOS PC
Procedure
1) Install Tools & Drivers
Please check this guide, Install rockchip flash tools under Windows/Linux/MacOS PC.
The PC tools we use to communicate with ROCK 5 in Maskrom mode are the rkdeveloptool on Linux/macOS and RkDevtool on Windows PC.
2) Get RK3588 loader and U-Boot images
- Download the loader image from:
- RK3588 loader - USB flashing helper
- Download the latest SPI image from:
- release version with u-boot serial console disabled(Recommend)
- debug version with u-boot serial console enabled(Use it when you need to troubleshoot booting issue)
- armbian version (Use it when you need to install the armbian Image to M.2 NVME SSD)
3) Boot the board to Maskrom mode
To boot ROCK 5B to Maskrom mode is simple:
- Power off the board.
- Remove bootable device like MicroSD card, eMMC module, etc.
- Press the golden (or silver on some board revisions) button and hold it.
- Plug the USB-A to Type-C cable to ROCK 5B Type-C port, the other side to PC.
- Release the golded button.
- Check usb device
- For macOS host:
lsusba result should be:... ID 2207:350b Fuzhou Rockchip Electronics Co., Ltd. Composite Device - For Linux host:
lsusba result should be:... ID 2207:350b Fuzhou Rockchip Electronics Company - For Windows host: Open RKDevTool and you would see the device is in Found One MASKROM Device
- For macOS host:
4) Write u-boot images to SPI NOR flash or erase SPI NOR flash
Option 1: Flash with Linux PC/Mac
On linux or Mac, run the rkdeveloptool
sudo rkdeveloptool ld DevNo=1 Vid=0x2207,Pid=0x350b,LocationID=106 Maskrom
This will load the loader (flash helper, downloaded from 2) to run on ROCK 5B and init the ram and prepare the flashing environment etc.
sudo rkdeveloptool db /path/to/rk3588_spl_loader_v1.08.111.bin # will output: Downloading bootloader succeeded.
Next, write SPI image from PC/Mac to ROCK 5B SPI flash
You can use the image download from Step 2.
sudo rkdeveloptool wl 0 rock-5b-spi-image-g49da44e116d.img Write LBA from file (100%)
Reboot the device
rkdeveloptool rd
now, the device should boot on SPI Nor Flash. And the blue led is on.
Option 2: Flash with Windows PC
Double click the RKDevTool.exe and you will see the following interface: Double click the RKDevTool.exe and you will see the following interface:
Step 1: confirm that ROCK 5B is in maskrom mode
If your ROCK 5B is in maskrom mode and connects to PC, you can see that the program detects it, as the red arrow below
Step 2: Load Configuration File
Right-click in the list box and select Load Config,Then select the configuration file in the resource management folder（The configuration file and RKDevTool are in the same directory）
Step 3: Select Loader
Next, click the right last columns in the "Loader" row to select rk3588_spl_loader_v1.08.111.bin
Step 4: Select SPI image
Next, click the right last columns in the "spi" row to select spi-image.
Step 5: Excute
Finally, click the "Excute" button, and you will see the content in the red box on the right. When the progress reaches 100%, the download is completed.
Addition: Erase the SPI NOR flash
Option 1: Operate on ROCK 5B
Boot your ROCK 5B with linux running on µSD card or eMMC module:
Make sure the SPI flash is available:
ls /dev/mtdblk*
sudo dd if=/dev/zero of=/dev/mtdblock0 sync
Option 2: Erase with Linux PC/Mac
Please notice that when you want to erase SPI NOR flash, fire these commands. If you don't have zero.img, download this one please. zero.img And extract it.
rkdeveloptool db rk3588_spl_loader_v1.08.111.bin rkdeveloptool wl 0 zero.img rkdeveloptool rd
Option3: Erase with Windows PC
Before Erasing, please confirm that ROCK 5B is in maskrom mode
Step 1: Download
Choose the "Advanced features" button, then select rk3588_spl_loader_v1.08.111.bin, next click the "Download" button
Step 2: Erase all
Click the "erase all" button
Step 3: Reboot device
Troubleshooting
- If you have issue with flashing via USB OTG, start a new post on the forum, https://forum.radxa.com/c/rock5.