Difference between revisions of "Rockpi4/dev/usb-install"

Latest revision as of 07:50, 14 January 2023

English

    ROCK Pi 4 >  Development >  Install image to eMMC from USB OTG port

Install image to eMMC from USB OTG port

ROCK Pi 4 supports Maskrom mode, which is a special operation mode for CPU to wait for USB OTG port command. The Linux/macOS PC tool we use to communicate with ROCK Pi 4 in Maskrom mode are the rkdeveloptool and RKDevTool. We use tool rkdeveloptool in Linux/macOS and RKDevTool tool under Windows.

Requirement

ROCK Pi 4 mainboard
- ROCK Pi 4A
- ROCK Pi 4A Plus
- ROCK Pi 4B
- ROCK Pi 4B Plus
- ROCK Pi 4C
eMMC on board or eMMC module
Power adapter
USB Male A to Male A cable(important) USB C to USB A cable does not working on all PCs. See discussion.

Install Tools&Drivers

Please check this guide, Install rockchip flash tools, rkdeveloptool/RKDevTool, under Windows/Linux/MacOS PC.

Boot the board to maskrom mode

To boot ROCK Pi 4 into maskrom mode is simple:

1. Power off the board
2. Short-circuit SPI Nor Flash if there is one SPI Nor Flash on board.

3. Remove microSD card
4. Insert removable eMMC module ( Skip this when there in one eMMC on board)
5. Plug the USB Male A to Male A cable to ROCK Pi 4 OTG port(the upper USB3 port), the other side to PC
6. Press and hold the Maskrom key if your board is Plus version with soldered eMMC (1: Reset 2: Maskrom 3: Recovery)

7. Power on the board and release the maskrom key(important)

8. Confirm that ROCK Pi 4 is in Maskrom mode .
- For macOS host: lsusb result: Bus 000 Device 004: ID 2207:330c Fuzhou Rockchip Electronics Co., Ltd. Composite Device
- For Linux host: lsusb result: Bus 001 Device 112: ID 2207:330c Fuzhou Rockchip Electronics Company
- For Windows host: Open RKDevTool and you would see the device is in Found One MASKROM Device.

Alternatively, if you are running Android and can access ADB, you can reboot the device to loader mode `adb reboot bootloader` then use the rkdeveloptool to reset the device into maskrom mode `rkdeveloptool rd 3` or Windows AndroidTool Switch button to go to maskrom mode.

Begin Installation USB -> eMMC

Linux/macOS

On your PC, run the rkdeveloptool

sudo rkdeveloptool ld        # List the device
DevNo=1	Vid=0x2207,Pid=0x330c,LocationID=305	Maskrom

Download the loader (flash helper) to init the ram and prepare the flashing environment etc. If you don't have it, you can download it from here

sudo rkdeveloptool db rk3399_loader_v1.27.126.bin

Write the GPT image to eMMC, start to write from offset 0.

sudo rkdeveloptool wl 0 /path/to/rockpi4b-xxx-gpt.img

Reboot the device

sudo rkdeveloptool rd

Now the device should boot the new image on eMMC.

Please note that when you want to erase eMMC on board, you can use these commands.

dd if=/dev/zero of=./zero.img bs=1M count=64
sudo rkdeveloptool db rk3399_loader_v1.27.126.bin
sudo rkdeveloptool wl 0 zero.img

Windows

Double click the RKDevTool.exe and you will see the following interface: If your ROCK Pi 4 is in maskrom mode and connects to PC, you can see that the program detect it, as the red box shown below:

Step 1: Select Loader

Next, click the button in the red box on the right last columns select the loader "rk3399_ loader_ xxxxx.bin ",

Note: the loader (flash helper) is used to init the ram and prepare the flashing environment etc. If you don't have it, you can download it from here

Step 2: Select Image

Then click the right last columns to in the Image row and choose the image you want to flash.

Note: Normally the image name should ends with xxx-gpt.img. If the image name ends with xxx-rkupdate.img, you can not flash with this method.

Step 3: Run

Finally, click the "run" button in the red box below, and you will see the content in the red box on the right. When the progress reaches 100%, the download is completed.

Install by partitions(Advanced)

Linux/macOS

Sometimes we only want to update a partition of the image, for example only the boot partition to update kernel only. We can flash by partitions

| Part Number | Offset | Name    | Description                |
| ----------- | ------ | ------- | -------------------------- |
| 1           | 32KB   | loader1 | First stage loader         |
| 2           | 8MB    | loader2 | U-boot image               |
| 3           | 12MB   | trust   | ATF                        |
| 4           | 16MB   | boot    | Kernel partition, bootable |
| 5           | 128MB  | rootfs  | Rootfs                     |

When the board is in maskrom mode, flash the partitions with the following command and offset:

   sudo rkdeveloptool db rk3399_loader_*.bin
   sudo rkdeveloptool wl 64 idbloader.img
   sudo rkdeveloptool wl 16384 uboot.img
   sudo rkdeveloptool wl 24576 trust.img
   sudo rkdeveloptool wl 32768 boot.img
   sudo rkdeveloptool wl 262144 rootfs.img

Windows

TBD.

FAQ

If you meet such these situations, you can try to change the bin file by rk3399_loader_v1.27.126.bin

Troubleshooting

If you have issue with flashing via USB OTG, start a new post on the forum. https://forum.radxa.com/c/dev

@@ Line 1: / Line 1: @@
 {{rockpi4_header}}
 {{Languages|rockpi4/dev/usb-install}}
-     [[rockpi4 | ROCK Pi 4]] > [[rockpi4/dev | Development]] > [[rockpi4/dev/usb-install | Install from USB OTG port]]
+     [[rockpi4 | ROCK Pi 4]] > [[rockpi4/dev | Development]] > [[rockpi4/dev/usb-install | Install image to eMMC from USB OTG port]]
-ROCK Pi supports maskrom mode, which is a special running mode the CPU is waiting for command from USB OTG port. The PC tool we use to communicate with ROCK Pi in maskrom mode is rkdevelop tool, an open source tool by Rockchip.
+== Install image to eMMC from USB OTG port ==
+ROCK Pi 4 supports Maskrom mode, which is a special operation mode for CPU to wait for USB OTG port command.
+The Linux/macOS PC tool we use to communicate with ROCK Pi 4  in Maskrom mode are the '''rkdeveloptool''' and '''RKDevTool'''.
+We use tool rkdeveloptool in Linux/macOS and RKDevTool tool under Windows.
 === Requirement ===
 * ROCK Pi 4 mainboard
-* eMMC module
+** ROCK Pi 4A
+** ROCK Pi 4A Plus
+** ROCK Pi 4B
+** ROCK Pi 4B Plus
+** ROCK Pi 4C
+* eMMC on board or eMMC module
 * Power adapter
-* '''USB Male A to Male A cable'''(important)
+* '''USB Male A to Male A cable'''(important) USB C to USB A cable does not working on all PCs. [https://forum.radxa.com/t/otg-flashing-not-working/717 See discussion].
-=== Make sure rkdeveloptool is set up on host computer ===
+=== Install Tools&Drivers ===
-==== Linux====
+Please check this guide, [[rockpi4/install/rockchip-flash-tools | Install rockchip flash tools,  rkdeveloptool/RKDevTool, under Windows/Linux/MacOS PC]].
-To build rkdeveloptool on a debain based Linux distribution, follow the instruction below:
-Install build dependecy:
+=== Boot the board to maskrom mode ===
-  sudo apt-get install libudev-dev libusb-1.0-0-dev dh-autoreconf
-Clone the source code and build:
+To boot ROCK Pi 4 into maskrom mode is simple:
-  git clone https://github.com/rockchip-linux/rkdeveloptool
-  cd rkdeveloptool
-  autoreconf -i
-  ./configure
-  make
-Now you have rkdeveloptool executable at the current directory.
+* 1. Power off the board
-  sudo cp rkdeveloptool /usr/local/bin/
+* 2. Short-circuit SPI Nor Flash if there is one SPI Nor Flash on board.
-==== MacOS ====
+[[File:Spi_clk_gnd.jpg | 200px]]
-To build rkdeveloptool on macOS, you need [https://brew.sh/ homebrew](or similar package manager) to install required packages.
+* 3. Remove microSD card
+* 4. Insert removable eMMC module ( Skip this when there in one eMMC on board)
+* 5. Plug the USB Male A to Male A cable to ROCK Pi 4 OTG port(the upper USB3 port), the other side to PC
+* 6. Press and hold the Maskrom key if your board is Plus version with soldered eMMC (1: Reset 2: Maskrom 3: Recovery)
-Install build dependency:
+[[File:Rockpi4bplus_key.jpg|400px]]
-    brew install automake autoconf libusb
+* 7. Power on the board and release the maskrom key(important)
-Clone the source code and build:
+* 8. Confirm that ROCK Pi 4 is in Maskrom mode .
+** For macOS host: lsusb result: '''Bus 000 Device 004: ID 2207:330c Fuzhou Rockchip Electronics Co., Ltd. Composite Device'''
+** For Linux host: lsusb result: '''Bus 001 Device 112: ID 2207:330c Fuzhou Rockchip Electronics Company'''
+** For Windows host: Open RKDevTool and you would see the device is in '''Found One MASKROM Device'''.
+[[File:AndroidTool1.PNG | 800px]]
-    git clone https://github.com/rockchip-linux/rkdeveloptool
+Alternatively, if you are running Android and can access ADB, you can reboot the device to loader mode `adb reboot bootloader` then use the rkdeveloptool to reset the device into maskrom mode `rkdeveloptool rd 3` or Windows AndroidTool '''Switch''' button to go to maskrom mode.
-    cd rkdeveloptool
-    autoreconf -i
-    ./configure
-    make
-Now you have rkdeveloptool executable at the current directory.
+=== Begin Installation USB -> eMMC ===
+<div class="toccolours mw-collapsible " style="width:800px; overflow:auto;">
+==== Linux/macOS ====
+<div class="mw-collapsible-content">
+On your PC, run the rkdeveloptool
-    sudo cp rkdeveloptool /usr/local/bin/
+ sudo rkdeveloptool ld        # List the device
+ DevNo=1	Vid=0x2207,Pid=0x330c,LocationID=305	Maskrom
-=== Boot the board to maskrom mode ===
+Download the loader (flash helper) to init the ram and prepare the flashing environment etc. If you don't have it, you can download it from [https://dl.radxa.com/rockpi/images/loader/rk3399_loader_v1.27.126.bin here]
-To boot ROCK Pi into maskrom mode is simple, you don't need to press any key
-* Power off the board and '''remove any bootable storage media''', remove microSD card, remove eMMC module.
+ sudo rkdeveloptool db rk3399_loader_v1.27.126.bin
-* Plug the USB Male A to Mail A cable to ROCK Pi 4 OTG port(the upper USB3 port), the other side to PC
-* Power on the board
-Now on your Linux PC, '''lsusb''' command show show the following usb devices
+Write the GPT image to eMMC, start to write from offset '''0'''.
-    Bus 003 Device 005: ID 2207:330c
+ sudo rkdeveloptool wl 0 /path/to/rockpi4b-xxx-gpt.img
-It means the device is in '''maskrom mode''' now.
+Reboot the device
-* Now plug the eMMC module and proceed the next step to flash.
+ sudo rkdeveloptool rd
-=== Install to eMMC via USB ===
+Now the device should boot the new image on eMMC.
-On your PC, run the rkdeveloptool
-    rkdeveloptool ld        # List the device
+Please note that when you want to erase eMMC on board, you can use these commands.
-    DevNo=1	Vid=0x2207,Pid=0x330c,LocationID=305	Maskrom
-Download the loader (flash helper) to init the ram and prepare the flashing environment etc. If you don't have it, you can download it from [https://dl.radxa.com/rockpi/images/loader/ here]
+ dd if=/dev/zero of=./zero.img bs=1M count=64
+ sudo rkdeveloptool db rk3399_loader_v1.27.126.bin
+ sudo rkdeveloptool wl 0 zero.img
-    rkdeveloptool db rk3399_loader_vxxxx.bin
+</div>
+</div>
-Write the GPT image to eMMC, start to write from offset '''0'''.
+<div class="toccolours mw-collapsible" style="width:800px; overflow:auto;">
-    rkdeveloptool wl 0 /path/to/rockpi4b-xxx-gpt.img
+==== Windows ====
+<div class="mw-collapsible-content">
-Reboot the device
+Double click the '''RKDevTool.exe''' and you will see the following interface:
+If your ROCK Pi 4 is in maskrom mode and connects to PC, you can see that the program detect it, as the red box shown below:
-    rkdeveloptool rd
+[[File:AndroidTool1.PNG | 1000px]]
-Now the device should boot the new image on eMMC
+===== Step 1: Select Loader =====
-==== Install by partitions(optional) ====
+Next, click the button in the red box on the right last columns select the loader "rk3399_ loader_ xxxxx.bin ",
+[[File:AndroidTool8.PNG | 1000px]]
+''Note:'' the loader (flash helper) is used to init the ram and prepare the flashing environment etc. If you don't have it, you can download it from [https://dl.radxa.com/rockpi/images/loader/ here]
+===== Step 2: Select Image =====
+Then click the right last columns to in the Image row and choose the image you want to flash.
+''Note'': Normally the image name should ends with xxx-gpt.img. If the image name ends with xxx-rkupdate.img, you can not flash with this method.
+===== Step 3: Run =====
+Finally, click the "run" button in the red box below, and you will see the content in the red box on the right. When the progress reaches 100%, the download is completed.
+[[File:Androidtool5.PNG | 1000px]]
+</div>
+</div>
+=== Install by partitions(Advanced) ===
+<div class="toccolours mw-collapsible mw-collapsed" style="width:800px; overflow:auto;">
+==== Linux/macOS ====
+<div class="mw-collapsible-content">
 Sometimes we only want to update a partition of the image, for example only the boot partition to update kernel only. We can flash by partitions
+<pre>
+| Part Number | Offset | Name    | Description                |
+| ----------- | ------ | ------- | -------------------------- |
+| 1           | 32KB   | loader1 | First stage loader         |
+| 2           | 8MB    | loader2 | U-boot image               |
+| 3           | 12MB   | trust   | ATF                        |
+| 4           | 16MB   | boot    | Kernel partition, bootable |
+| 5           | 128MB  | rootfs  | Rootfs                     |
+</pre>
+When the board is in maskrom mode, flash the partitions with the following command and offset:
+    sudo rkdeveloptool db rk3399_loader_*.bin
+    sudo rkdeveloptool wl 64 idbloader.img
+    sudo rkdeveloptool wl 16384 uboot.img
+    sudo rkdeveloptool wl 24576 trust.img
+    sudo rkdeveloptool wl 32768 boot.img
+    sudo rkdeveloptool wl 262144 rootfs.img
+</div>
+</div>
+<div class="toccolours mw-collapsible" style="width:800px; overflow:auto;">
+==== Windows ====
+<div class="mw-collapsible-content">
+TBD.
+</div>
+</div>
+=== FAQ ===
+If you meet such these situations, you can try to change the bin file by [https://dl.radxa.com/rockpi/images/loader/rk3399_loader_v1.27.126.bin rk3399_loader_v1.27.126.bin]
+[[File:error-loader1.png | 1000px]]
+[[File:error-loader2.png | 1000px]]
 === Troubleshooting ===
 * If you have issue with flashing via USB OTG, start a new post on the forum. https://forum.radxa.com/c/dev

Difference between revisions of "Rockpi4/dev/usb-install"

Latest revision as of 07:50, 14 January 2023

Contents

Install image to eMMC from USB OTG port

Requirement

Install Tools&Drivers

Boot the board to maskrom mode

Begin Installation USB -> eMMC

Linux/macOS

Windows

Step 1: Select Loader

Step 2: Select Image

Step 3: Run

Install by partitions(Advanced)

Linux/macOS

Windows

FAQ

Troubleshooting