1 # SPDX-License-Identifier: GPL-2.0+
3 # Copyright (C) 2015 Google. Inc
4 # Written by Simon Glass <sjg@chromium.org>
9 A wide range of Rockchip SoCs are supported in mainline U-Boot
17 - Firefly RK3288 board or something else with a supported RockChip SoC
18 - Power connection to 5V using the supplied micro-USB power cable
19 - Separate USB serial cable attached to your computer and the Firefly
20 (connect to the micro-USB connector below the logo)
22 - openssl (sudo apt-get install openssl)
23 - Serial UART connection [4]
24 - Suitable ARM cross compiler, e.g.:
25 sudo apt-get install gcc-4.7-arm-linux-gnueabi
31 At present 12 RK3288 boards are supported:
33 - EVB RK3288 - use evb-rk3288 configuration
34 - Fennec RK3288 - use fennec-rk3288 configuration
35 - Firefly RK3288 - use firefly-rk3288 configuration
36 - Hisense Chromebook - use chromebook_jerry configuration
37 - Asus C100P Chromebook - use chromebook_minnie configuration
38 - Asus Chromebit - use chromebook_mickey configuration
39 - MiQi RK3288 - use miqi-rk3288 configuration
40 - phyCORE-RK3288 RDK - use phycore-rk3288 configuration
41 - PopMetal RK3288 - use popmetal-rk3288 configuration
42 - Radxa Rock 2 - use rock2 configuration
43 - Tinker RK3288 - use tinker-rk3288 configuration
44 - Vyasa RK3288 - use vyasa-rk3288 configuration
46 Two RK3036 boards are supported:
48 - EVB RK3036 - use evb-rk3036 configuration
49 - Kylin - use kylin_rk3036 configuration
51 Two RK3328 board are supported:
53 - EVB RK3328 - use evb-rk3328_defconfig
54 - Pine64 Rock64 board - use rock64-rk3328_defconfig
56 Size RK3399 boards are supported (aarch64):
58 - EBV RK3399 - use evb_rk3399 configuration
59 - Firefly RK3399 - use the firefly_rk3399 configuration
60 - Puma - use puma_rk3399 configuration
61 - Ficus - use ficus-rk3399 configuration
62 - Rock960 (Vamrs) - use rock960-rk3399 configuration
63 - Bob - use chromebook_bob configuration
65 Four RK3368 boards are supported:
67 - Sheep - use sheep-rk3368 configuration
68 - Lion - use lion-rk3368 configuration
69 - Geekbox - use geekbox configuration
70 - EVB PX5 - use evb-px5 configuration
72 One RK3128 board is supported:
74 - EVB RK3128 - use evb-rk3128 configuration
76 One RK3229 board is supported:
78 - EVB RK3229 - use evb-rk3229 configuration
80 Two RV1108 boards are supported:
82 - EVB RV1108 - use evb-rv1108 configuration
83 - Elgin R1 - use elgin-rv1108 configuration
85 One RV3188 baord is supported:
87 - Raxda Rock - use rock configuration
92 1. To build RK3288 board:
94 CROSS_COMPILE=arm-linux-gnueabi- make O=firefly firefly-rk3288_defconfig all
96 (or you can use another cross compiler if you prefer)
98 2. To build RK3399 board:
100 Option 1: Package the image with Rockchip miniloader:
104 => cd /path/to/u-boot
105 => make nanopi-neo4-rk3399_defconfig
111 => git clone https://github.com/rockchip-linux/rkbin.git
116 => ./tools/trust_merger RKTRUST/RK3399TRUST.ini
121 => ./tools/loaderimage --pack --uboot /path/to/u-boot/u-boot-dtb.bin uboot.img
123 (Get trust.img and uboot.img)
125 Option 2: Package the image with SPL:
127 - We need the Python elftools.elf.elffile library for make_fit_atf.py to work
129 => sudo apt-get install python-pyelftools
131 - Export cross compiler path for aarch64
137 => git clone git://git.theobroma-systems.com/arm-trusted-firmware.git
138 => cd arm-trusted-firmware
139 => make CROSS_COMPILE=aarch64-linux-gnu- PLAT=rk3399 bl31
142 => export BL31=/path/to/arm-trusted-firmware/build/rk3399/release/bl31/bl31.bin
144 For rest of rk3399 boards.
146 => git clone https://github.com/ARM-software/arm-trusted-firmware.git
147 => cd arm-trusted-firmware
149 (export cross compiler path for Cortex-M0 MCU likely arm-none-eabi-)
151 => make CROSS_COMPILE=aarch64-linux-gnu- PLAT=rk3399
154 => export BL31=/path/to/arm-trusted-firmware/build/rk3399/release/bl31/bl31.elf
156 - Compile PMU M0 firmware
158 This is optional for most of the rk3399 boards and required only for Puma board.
160 => git clone git://git.theobroma-systems.com/rk3399-cortex-m0.git
161 => cd rk3399-cortex-m0
163 (export cross compiler path for Cortex-M0 PMU)
164 => make CROSS_COMPILE=arm-cortex_m0-eabi-
166 (export rk3399m0.bin)
167 => export PMUM0=/path/to/rk3399-cortex-m0/rk3399m0.bin
171 => cd /path/to/u-boot
172 => make orangepi-rk3399_defconfig
176 (Get spl/u-boot-spl-dtb.bin, u-boot.itb images and some boards would get
177 spl/u-boot-spl.bin since it doesn't enable CONFIG_SPL_OF_CONTROL
179 If TPL enabled on the target, get tpl/u-boot-tpl-dtb.bin or tpl/u-boot-tpl.bin
180 if CONFIG_TPL_OF_CONTROL not enabled)
182 Writing to the board with USB
183 =============================
185 For USB to work you must get your board into ROM boot mode, either by erasing
186 your MMC or (perhaps) holding the recovery button when you boot the board.
187 To erase your MMC, you can boot into Linux and type (as root)
189 dd if=/dev/zero of=/dev/mmcblk0 bs=1M
191 Connect your board's OTG port to your computer.
193 To create a suitable image and write it to the board:
195 ./firefly-rk3288/tools/mkimage -n rk3288 -T rkimage -d \
196 ./firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
197 cat out | openssl rc4 -K 7c4e0304550509072d2c7b38170d1711 | rkflashtool l
199 If all goes well you should something like:
201 U-Boot SPL 2015.07-rc1-00383-ge345740-dirty (Jun 03 2015 - 10:06:49)
202 Card did not respond to voltage select!
203 spl: mmc init failed with error: -17
204 ### ERROR ### Please RESET the board ###
206 You will need to reset the board before each time you try. Yes, that's all
207 it does so far. If support for the Rockchip USB protocol or DFU were added
208 in SPL then we could in principle load U-Boot and boot to a prompt from USB
209 as several other platforms do. However it does not seem to be possible to
210 use the existing boot ROM code from SPL.
213 Booting from an SD card
214 =======================
216 To write an image that boots from an SD card (assumed to be /dev/sdc):
218 ./firefly-rk3288/tools/mkimage -n rk3288 -T rksd -d \
219 firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
220 sudo dd if=out of=/dev/sdc seek=64 && \
221 sudo dd if=firefly-rk3288/u-boot-dtb.img of=/dev/sdc seek=16384
223 This puts the Rockchip header and SPL image first and then places the U-Boot
224 image at block 16384 (i.e. 8MB from the start of the SD card). This
225 corresponds with this setting in U-Boot:
227 #define CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR 0x4000
229 Put this SD (or micro-SD) card into your board and reset it. You should see
232 U-Boot 2016.01-rc2-00309-ge5bad3b-dirty (Jan 02 2016 - 23:41:59 -0700)
234 Model: Radxa Rock 2 Square
236 MMC: dwmmc@ff0f0000: 0, dwmmc@ff0c0000: 1
237 *** Warning - bad CRC, using default environment
240 Out: vop@ff940000.vidconsole
242 Net: Net Initialization Skipped
244 Hit any key to stop autoboot: 0
247 The rockchip bootrom can load and boot an initial spl, then continue to
248 load a second-stage bootloader (ie. U-Boot) as soon as the control is returned
249 to the bootrom. Both the RK3288 and the RK3036 use this special boot sequence.
250 The configuration option enabling this is:
252 CONFIG_SPL_ROCKCHIP_BACK_TO_BROM=y
254 You can create the image via the following operations:
256 ./firefly-rk3288/tools/mkimage -n rk3288 -T rksd -d \
257 firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
258 cat firefly-rk3288/u-boot-dtb.bin >> out && \
259 sudo dd if=out of=/dev/sdc seek=64
261 If you have an HDMI cable attached you should see a video console.
263 For evb_rk3036 board:
264 ./evb-rk3036/tools/mkimage -n rk3036 -T rksd -d evb-rk3036/spl/u-boot-spl.bin out && \
265 cat evb-rk3036/u-boot-dtb.bin >> out && \
266 sudo dd if=out of=/dev/sdc seek=64
268 Note: rk3036 SDMMC and debug uart use the same iomux, so if you boot from SD, the
269 debug uart must be disabled
272 Booting from an SD card on RK3288 with TPL
273 ==========================================
275 Since the size of SPL can't be exceeded 0x8000 bytes in RK3288, it is not possible add
276 new SPL features like Falcon mode or etc.
278 So introduce TPL so-that adding new features to SPL is possible because now TPL should
279 run minimal with code like DDR, clock etc and rest of new features in SPL.
281 As of now TPL is added on Vyasa-RK3288 board.
283 To write an image that boots from an SD card (assumed to be /dev/mmcblk0):
285 ./tools/mkimage -n rk3288 -T rksd -d ./tpl/u-boot-tpl.bin out &&
286 cat ./spl/u-boot-spl-dtb.bin >> out &&
287 sudo dd if=out of=/dev/mmcblk0 seek=64 &&
288 sudo dd if=u-boot-dtb.img of=/dev/mmcblk0 seek=16384
290 Booting from an SD card on RK3188
291 =================================
293 For rk3188 boards the general storage onto the card stays the same as
294 described above, but the image creation needs a bit more care.
296 The bootrom of rk3188 expects to find a small 1kb loader which returns
297 control to the bootrom, after which it will load the real loader, which
298 can then be up to 29kb in size and does the regular ddr init. This is
299 handled by a single image (built as the SPL stage) that tests whether
300 it is handled for the first or second time via code executed from the
303 Additionally the rk3188 requires everything the bootrom loads to be
304 rc4-encrypted. Except for the very first stage the bootrom always reads
305 and decodes 2kb pages, so files should be sized accordingly.
307 # copy tpl, pad to 1020 bytes and append spl
308 tools/mkimage -n rk3188 -T rksd -d spl/u-boot-spl.bin out
310 # truncate, encode and append u-boot.bin
311 truncate -s %2048 u-boot.bin
312 cat u-boot.bin | split -b 512 --filter='openssl rc4 -K 7C4E0304550509072D2C7B38170D1711' >> out
314 Booting from an SD card on Pine64 Rock64 (RK3328)
315 =================================================
317 For Rock64 rk3328 board the following three parts are required:
318 TPL, SPL, and the u-boot image tree blob. While u-boot-spl.bin and
319 u-boot.itb are to be compiled as usual, TPL is currently not
320 implemented in u-boot, so you need to pick one from rkbin:
324 => git clone https://github.com/rockchip-linux/rkbin.git
326 - Create TPL/SPL image
328 => tools/mkimage -n rk3328 -T rksd -d rkbin/bin/rk33/rk3328_ddr_333MHz_v1.16.bin idbloader.img
329 => cat spl/u-boot-spl.bin >> idbloader.img
331 - Write TPL/SPL image at 64 sector
333 => sudo dd if=idbloader.img of=/dev/mmcblk0 seek=64
335 - Write u-boot image tree blob at 16384 sector
337 => sudo dd if=u-boot.itb of=/dev/mmcblk0 seek=16384
339 Booting from an SD card on RK3399
340 =================================
342 To write an image that boots from an SD card (assumed to be /dev/sdc):
344 Option 1: Package the image with Rockchip miniloader:
346 - Create idbloader.img
348 => cd /path/to/u-boot
349 => ./tools/mkimage -n rk3399 -T rksd -d /path/to/rkbin/bin/rk33/rk3399_ddr_800MHz_v1.20.bin idbloader.img
350 => cat /path/to/rkbin/bin/rk33/rk3399_miniloader_v1.19.bin >> idbloader.img
352 - Write idbloader.img at 64 sector
354 => sudo dd if=idbloader.img of=/dev/sdc seek=64
356 - Write trust.img at 24576
358 => sudo dd if=trust.img of=/dev/sdc seek=24576
360 - Write uboot.img at 16384 sector
362 => sudo dd if=uboot.img of=/dev/sdc seek=16384
365 Put this SD (or micro-SD) card into your board and reset it. You should see
368 DDR Version 1.20 20190314
370 Channel 0: DDR3, 933MHz
371 Bus Width=32 Col=10 Bank=8 Row=15 CS=1 Die Bus-Width=16 Size=1024MB
373 ch 0 ddrconfig = 0x101, ddrsize = 0x20
374 pmugrf_os_reg[2] = 0x10006281, stride = 0x17
376 Boot1: 2019-03-14, version: 1.19
379 mmc: ERROR: SDHCI ERR:cmd:0x102,stat:0x18000
380 mmc: ERROR: Card did not respond to voltage select!
382 mmc: ERROR: SDHCI ERR:cmd:0x102,stat:0x18000
383 mmc: ERROR: Card did not respond to voltage select!
385 mmc: ERROR: SDHCI ERR:cmd:0x102,stat:0x18000
386 mmc: ERROR: Card did not respond to voltage select!
392 FwPartOffset=2000 , 0
393 StorageInit ok = 45266
395 SecureInit read PBA: 0x4
396 SecureInit read PBA: 0x404
397 SecureInit read PBA: 0x804
398 SecureInit read PBA: 0xc04
399 SecureInit read PBA: 0x1004
400 SecureInit read PBA: 0x1404
401 SecureInit read PBA: 0x1804
402 SecureInit read PBA: 0x1c04
403 SecureInit ret = 0, SecureMode = 0
404 atags_set_bootdev: ret:(0)
405 GPT 0x3380ec0 signature is wrong
407 GPT 0x3380ec0 signature is wrong
409 LoadTrust Addr:0x4000
411 Load uboot, ReadLba = 2000
412 hdr 0000000003380880 + 0x0:0x88,0x41,0x3e,0x97,0xe6,0x61,0x54,0x23,0xe9,0x5a,0xd1,0x2b,0xdc,0x2f,0xf9,0x35,
414 Load OK, addr=0x200000, size=0x9c9c0
416 NOTICE: BL31: v1.3(debug):370ab80
417 NOTICE: BL31: Built : 09:23:41, Mar 4 2019
418 NOTICE: BL31: Rockchip release version: v1.1
419 INFO: GICv3 with legacy support detected. ARM GICV3 driver initialized in EL3
420 INFO: Using opteed sec cpu_context!
421 INFO: boot cpu mask: 0
422 INFO: plat_rockchip_pmu_init(1181): pd status 3e
423 INFO: BL31: Initializing runtime services
424 INFO: BL31: Initializing BL32
425 INF [0x0] TEE-CORE:init_primary_helper:337: Initializing (1.1.0-195-g8f090d20 #6 Fri Dec 7 06:11:20 UTC 2018 aarch64)
427 INF [0x0] TEE-CORE:init_primary_helper:338: Release version: 1.2
429 INF [0x0] TEE-CORE:init_teecore:83: teecore inits done
430 INFO: BL31: Preparing for EL3 exit to normal world
431 INFO: Entry point address = 0x200000
435 U-Boot 2019.04-rc4-00136-gfd121f9641-dirty (Apr 16 2019 - 14:02:47 +0530)
437 Model: FriendlyARM NanoPi NEO4
439 MMC: dwmmc@fe310000: 2, dwmmc@fe320000: 1, sdhci@fe330000: 0
440 Loading Environment from MMC... *** Warning - bad CRC, using default environment
445 Model: FriendlyARM NanoPi NEO4
446 Net: eth0: ethernet@fe300000
447 Hit any key to stop autoboot: 0
450 Option 2: Package the image with SPL:
452 - Prefix rk3399 header to SPL image
454 => cd /path/to/u-boot
455 => ./tools/mkimage -n rk3399 -T rksd -d spl/u-boot-spl-dtb.bin out
457 - Write prefixed SPL at 64th sector
459 => sudo dd if=out of=/dev/sdc seek=64
461 - Write U-Boot proper at 16384 sector
463 => sudo dd if=u-boot.itb of=/dev/sdc seek=16384
466 Put this SD (or micro-SD) card into your board and reset it. You should see
469 U-Boot SPL board init
470 Trying to boot from MMC1
473 U-Boot 2019.01-00004-g14db5ee998 (Mar 11 2019 - 13:18:41 +0530)
475 Model: Orange Pi RK3399 Board
477 MMC: dwmmc@fe310000: 2, dwmmc@fe320000: 1, sdhci@fe330000: 0
478 Loading Environment from MMC... OK
482 Model: Orange Pi RK3399 Board
483 Net: eth0: ethernet@fe300000
484 Hit any key to stop autoboot: 0
487 Option 3: Package the image with TPL:
489 - Prefix rk3399 header to TPL image
491 => cd /path/to/u-boot
492 => ./tools/mkimage -n rk3399 -T rksd -d tpl/u-boot-tpl-dtb.bin out
494 - Concatinate tpl with spl
496 => cd /path/to/u-boot
497 => cat ./spl/u-boot-spl-dtb.bin >> out
499 - Write tpl+spl at 64th sector
501 => sudo dd if=out of=/dev/sdc seek=64
503 - Write U-Boot proper at 16384 sector
505 => sudo dd if=u-boot.itb of=/dev/sdc seek=16384
508 Put this SD (or micro-SD) card into your board and reset it. You should see
511 U-Boot TPL board init
512 Trying to boot from BOOTROM
513 Returning to boot ROM...
515 U-Boot SPL board init
516 Trying to boot from MMC1
519 U-Boot 2019.07-rc1-00241-g5b3244767a (May 08 2019 - 10:51:06 +0530)
521 Model: Orange Pi RK3399 Board
523 MMC: dwmmc@fe310000: 2, dwmmc@fe320000: 1, sdhci@fe330000: 0
524 Loading Environment from MMC... OK
528 Model: Orange Pi RK3399 Board
529 Net: eth0: ethernet@fe300000
530 Hit any key to stop autoboot: 0
533 Using fastboot on rk3288
534 ========================
535 - Write GPT partition layout to mmc device which fastboot want to use it to
538 => gpt write mmc 1 $partitions
540 - Invoke fastboot command to prepare
544 - Start fastboot request on PC
546 fastboot -i 0x2207 flash loader evb-rk3288/spl/u-boot-spl-dtb.bin
548 You should see something like:
551 WARNING: unknown variable: partition-type:loader
552 Starting download of 357796 bytes
554 downloading of 357796 bytes finished
556 ........ wrote 357888 bytes to 'loader'
561 To write an image that boots from SPI flash (e.g. for the Haier Chromebook or
564 ./chromebook_jerry/tools/mkimage -n rk3288 -T rkspi \
565 -d chromebook_jerry/spl/u-boot-spl-dtb.bin spl.bin && \
566 dd if=spl.bin of=spl-out.bin bs=128K conv=sync && \
567 cat spl-out.bin chromebook_jerry/u-boot-dtb.img >out.bin && \
568 dd if=out.bin of=out.bin.pad bs=4M conv=sync
570 This converts the SPL image to the required SPI format by adding the Rockchip
571 header and skipping every second 2KB block. Then the U-Boot image is written at
572 offset 128KB and the whole image is padded to 4MB which is the SPI flash size.
573 The position of U-Boot is controlled with this setting in U-Boot:
575 #define CONFIG_SYS_SPI_U_BOOT_OFFS (128 << 10)
577 If you have a Dediprog em100pro connected then you can write the image with:
579 sudo em100 -s -c GD25LQ32 -d out.bin.pad -r
581 When booting you should see something like:
583 U-Boot SPL 2015.07-rc2-00215-g9a58220-dirty (Jun 23 2015 - 12:11:32)
586 U-Boot 2015.07-rc2-00215-g9a58220-dirty (Jun 23 2015 - 12:11:32 -0600)
591 Using default environment
601 Immediate priorities are:
605 - Run CPU at full speed (code exists but we only see ~60 DMIPS maximum)
607 - Boot U-Boot proper over USB OTG (at present only SPL works)
613 There are plenty of patches in the links below to help with this work.
615 [1] https://github.com/rkchrome/uboot.git
616 [2] https://github.com/linux-rockchip/u-boot-rockchip.git branch u-boot-rk3288
617 [3] https://github.com/linux-rockchip/rkflashtool.git
618 [4] http://wiki.t-firefly.com/index.php/Firefly-RK3288/Serial_debug/en
623 rkimage.c produces an SPL image suitable for sending directly to the boot ROM
624 over USB OTG. This is a very simple format - just the string RK32 (as 4 bytes)
625 followed by u-boot-spl-dtb.bin.
627 The boot ROM loads image to 0xff704000 which is in the internal SRAM. The SRAM
628 starts at 0xff700000 and extends to 0xff718000 where we put the stack.
633 rksd.c produces an image consisting of 32KB of empty space, a header and
634 u-boot-spl-dtb.bin. The header is defined by 'struct header0_info' although
635 most of the fields are unused by U-Boot. We just need to specify the
636 signature, a flag and the block offset and size of the SPL image.
638 The header occupies a single block but we pad it out to 4 blocks. The header
639 is encoding using RC4 with the key 7c4e0304550509072d2c7b38170d1711. The SPL
640 image can be encoded too but we don't do that.
642 The maximum size of u-boot-spl-dtb.bin which the boot ROM will read is 32KB,
643 or 0x40 blocks. This is a severe and annoying limitation. There may be a way
644 around this limitation, since there is plenty of SRAM, but at present the
645 board refuses to boot if this limit is exceeded.
647 The image produced is padded up to a block boundary (512 bytes). It should be
648 written to the start of an SD card using dd.
650 Since this image is set to load U-Boot from the SD card at block offset,
651 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, dd should be used to write
652 u-boot-dtb.img to the SD card at that offset. See above for instructions.
657 rkspi.c produces an image consisting of a header and u-boot-spl-dtb.bin. The
658 resulting image is then spread out so that only the first 2KB of each 4KB
659 sector is used. The header is the same as with rksd and the maximum size is
660 also 32KB (before spreading). The image should be written to the start of
663 See above for instructions on how to write a SPI image.
668 You can use this script to create #defines for SoC register access. See the
672 Device tree and driver model
673 ----------------------------
675 Where possible driver model is used to provide a structure to the
676 functionality. Device tree is used for configuration. However these have an
677 overhead and in SPL with a 32KB size limit some shortcuts have been taken.
678 In general all Rockchip drivers should use these features, with SPL-specific
679 modifications where required.
682 ----------------------------
684 Rockchip use a unified GPT partition layout in open source support.
685 With this GPT partition layout, uboot can be compatilbe with other components,
686 like miniloader, trusted-os, arm-trust-firmware.
688 There are some documents about partitions in the links below.
689 http://rockchip.wikidot.com/partitions
692 Jagan Teki <jagan@amarulasolutions.com>
694 Simon Glass <sjg@chromium.org>