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

Revision as of 07:46, 17 September 2020

    ROCK Pi 4 >  Development >  Write image to SPI flash 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.

Requirement

• ROCK Pi 4 mainboard
• SPI flash soldered on ROCK Pi 4
• Power adapter
• USB Male A to Male A cable(important) USB-C has been seen as not working, an adaptor for USB-C to USB-A has worked. See discussion.

Step 1: Make sure rkdeveloptool is set up on host computer

Linux

To build rkdeveloptool on a debain based Linux distribution, follow the instruction below:

Install build dependecy:

 sudo apt-get install libudev-dev libusb-1.0-0-dev dh-autoreconf

Clone the source code and build:

 git clone https://github.com/rockchip-linux/rkdeveloptool
 cd rkdeveloptool
 autoreconf -i
 ./configure
 make

If you encounter compile error like below

   ./configure: line 4269: syntax error near unexpected token `LIBUSB1,libusb-1.0'
   ./configure: line 4269: `PKG_CHECK_MODULES(LIBUSB1,libusb-1.0)'

You should install pkg-config libusb-1.0

   sudo apt-get install pkg-config libusb-1.0

Then re-run

   autoreconf -i
   ./configure
   make

Now you have rkdeveloptool executable at the current directory.

 sudo cp rkdeveloptool /usr/local/bin/

MacOS

To build rkdeveloptool on macOS, you need homebrew(or similar package manager) to install required packages.

Install build dependency:

   brew install automake autoconf libusb

Clone the source code and build:

   git clone https://github.com/rockchip-linux/rkdeveloptool
   cd rkdeveloptool
   autoreconf -i
   ./configure
   make

If you encounter compile error like below

   ./configure: line 4269: syntax error near unexpected token `LIBUSB1,libusb-1.0'
   ./configure: line 4269: `PKG_CHECK_MODULES(LIBUSB1,libusb-1.0)'

You should install pkg-config libusb-1.0

   brew install pkg-config

Then re-run

   autoreconf -i
   ./configure
   make

Now you have rkdeveloptool executable at the current directory.

   sudo cp rkdeveloptool /usr/local/bin/

Step 2: Boot the board to maskrom mode

Case 1: Empty SPI flash

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.
• Plug the USB Male A to Male A cable to ROCK Pi 4 OTG port (the upper USB3 port), the other side to PC
• Power on the board

Case 2: Update SPI flash with bootloader inside

If the SPI flash already contains a bootable bootloader, you need to disable the SPI flash at boot time by shortcut the SPI1_CLK to GND. Use wire to connect PIN 23 and 25. Checkout the Pinout.

Shown as following:

• Use cable to connect PIN23 and PIN25
• Power off the board and remove any bootable storage media, remove microSD card, remove eMMC module.
• Plug the USB Male A to Male A cable to ROCK Pi 4 OTG port (the upper USB3 port), the other side to PC
• Power on the board
• Remove the cable and disconnect PIN23 and PIN25

Now on your Linux PC, lsusb command show show the following usb devices

   Bus 003 Device 005: ID 2207:330c

It means the device is in maskrom mode now.

• Now we can proceed the next step to flash.

Step 3: Write to SPI flash via USB

On your PC, run the rkdeveloptool

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

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

   sudo rkdeveloptool db /path/to/rk3399_loader_spinor_v1.15.114.bin  # will output: Downloading bootloader succeeded.

Write the packed SPI image of u-boot and trust.img, start to write from offset 0. If you don't have it, you can download it from here download the SPI Bootloader image.

• For ROCK Pi 4A

   sudo rkdeveloptool wl 0 /path/to/rockpi4a-uboot-trust-spi_2017.09-2692-gdf20631bd8_20200824.img    # will output: Write LBA from file (100%)

• For ROCK Pi 4B

   sudo rkdeveloptool wl 0 /path/to/rockpi4b-uboot-trust-spi_2017.09-2692-gdf20631bd8_20200824.img    # will output: Write LBA from file (100%)

• For ROCK Pi 4C

   sudo rkdeveloptool wl 0 /path/to/rockpi4c-uboot-trust-spi_2017.09-2692-gdf20631bd8_20200824.img    # will output: Write LBA from file (100%)

Notes that writing SPI Bootloader image will take at least 15 seconds. If it goes fast, less than 3 seconds, there is something wrong with SPI Flash. Maybe need to change the SPI Flash.

Reboot the device

   sudo rkdeveloptool rd    # will output: Reset Device OK.

Now the device should boot from the SPI flash now.

FAQs

Erase images on SPI flash from PC

To erase images on SPI device, it's the same as writing the image to SPI flash, just the image we write is empty.

Firstly, follow Step 1 and Step 2: Boot the board to maskrom mode, Case 2: Update SPI flash with bootloader inside above to boot ROCK Pi 4 to maskrom mode.

Secondly, on your Linux PC, create zero.img.

   dd if=/dev/zero of=./zero.img bs=1M count=4

Thirdly, flash zero.img to SPI device.

   rkdeveloptool db rk3399_loader_spinor_v1.15.114.bin
   rkdeveloptool wl 0 zero.img
   rkdeveloptool rd    # will output: Reset Device OK.

Finally, on your Linux PC, lsusb command show show the following usb devices

   Bus 003 Device 005: ID 2207:330c

It means the SPI image is erased successfully.

Erase images on SPI flash on ROCK Pi 4

If you could boot into Linux and you have /dev/mtd* device available, you can use the following to erase the SPI flash.

• For ROCK Pi 4A

   sudo /usr/local/sbin/rockpi4a_erase_spi_flash.sh #related package: rockpi4a-rk-u-boot-latest

• For ROCK Pi 4B

   sudo /usr/local/sbin/rockpi4b_erase_spi_flash.sh #related package: rockpi4b-rk-u-boot-latest

• For ROCK Pi 4C

   sudo /usr/local/sbin/rockpi4c_erase_spi_flash.sh #related package: rockpi4c-rk-u-boot-latest

Troubleshooting

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