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 11 RK3288 boards are supported:
33 - EVB RK3288 - use evb-rk3288 configuration
34 - Firefly RK3288 - use firefly-rk3288 configuration
35 - Hisense Chromebook - use chromebook_jerry configuration
36 - Asus C100P Chromebook - use chromebook_minnie configuration
37 - Asus Chromebit - use chromebook_mickey configuration
38 - MiQi RK3288 - use miqi-rk3288 configuration
39 - phyCORE-RK3288 RDK - use phycore-rk3288 configuration
40 - PopMetal RK3288 - use popmetal-rk3288 configuration
41 - Radxa Rock 2 - use rock2 configuration
42 - Tinker RK3288 - use tinker-rk3288 configuration
43 - Vyasa RK3288 - use vyasa-rk3288 configuration
45 Two RK3036 boards are supported:
47 - EVB RK3036 - use evb-rk3036 configuration
48 - Kylin - use kylin_rk3036 configuration
50 Two RK3328 board are supported:
52 - EVB RK3328 - use evb-rk3328_defconfig
53 - Pine64 Rock64 board - use rock64-rk3328_defconfig
55 Size RK3399 boards are supported (aarch64):
57 - EBV RK3399 - use evb_rk3399 configuration
58 - Firefly RK3399 - use the firefly_rk3399 configuration
59 - Puma - use puma_rk3399 configuration
60 - Ficus - use ficus-rk3399 configuration
61 - Rock960 (Vamrs) - use rock960-rk3399 configuration
62 - Bob - use chromebook_bob configuration
64 Four RK3368 boards are supported:
66 - Sheep - use sheep-rk3368 configuration
67 - Lion - use lion-rk3368 configuration
68 - Geekbox - use geekbox configuration
69 - EVB PX5 - use evb-px5 configuration
71 One RK3128 board is supported:
73 - EVB RK3128 - use evb-rk3128 configuration
75 One RK3229 board is supported:
77 - EVB RK3229 - use evb-rk3229 configuration
79 Two RV1108 boards are supported:
81 - EVB RV1108 - use evb-rv1108 configuration
82 - Elgin R1 - use elgin-rv1108 configuration
84 One RV3188 baord is supported:
86 - Raxda Rock - use rock configuration
91 1. To build RK3288 board:
93 CROSS_COMPILE=arm-linux-gnueabi- make O=firefly firefly-rk3288_defconfig all
95 (or you can use another cross compiler if you prefer)
97 2. To build RK3399 board:
99 Option 1: Package the image with Rockchip miniloader:
103 => cd /path/to/u-boot
104 => make nanopi-neo4-rk3399_defconfig
109 => git clone https://github.com/rockchip-linux/rkbin.git
114 => ./tools/trust_merger RKTRUST/RK3399TRUST.ini
119 => ./tools/loaderimage --pack --uboot /path/to/u-boot/u-boot-dtb.bin uboot.img
121 (Get trust.img and uboot.img)
123 Option 2: Package the image with SPL:
125 - Export cross compiler path for aarch64
131 => git clone git://git.theobroma-systems.com/arm-trusted-firmware.git
132 => cd arm-trusted-firmware
133 => make CROSS_COMPILE=aarch64-linux-gnu- PLAT=rk3399 bl31
136 => export BL31=/path/to/arm-trusted-firmware/build/rk3399/release/bl31/bl31.bin
138 For rest of rk3399 boards.
140 => git clone https://github.com/ARM-software/arm-trusted-firmware.git
141 => cd arm-trusted-firmware
143 (export cross compiler path for Cortex-M0 MCU likely arm-none-eabi-)
145 => make CROSS_COMPILE=aarch64-linux-gnu- PLAT=rk3399
148 => export BL31=/path/to/arm-trusted-firmware/build/rk3399/release/bl31/bl31.elf
150 - Compile PMU M0 firmware
152 This is optional for most of the rk3399 boards and required only for Puma board.
154 => git clone git://git.theobroma-systems.com/rk3399-cortex-m0.git
155 => cd rk3399-cortex-m0
157 (export cross compiler path for Cortex-M0 PMU)
158 => make CROSS_COMPILE=arm-cortex_m0-eabi-
160 (export rk3399m0.bin)
161 => export PMUM0=/path/to/rk3399-cortex-m0/rk3399m0.bin
165 => cd /path/to/u-boot
166 => make orangepi-rk3399_defconfig
169 (Get spl/u-boot-spl-dtb.bin, u-boot.itb images and some boards would get
170 spl/u-boot-spl.bin since it doesn't enable CONFIG_SPL_OF_CONTROL
172 If TPL enabled on the target, get tpl/u-boot-tpl-dtb.bin or tpl/u-boot-tpl.bin
173 if CONFIG_TPL_OF_CONTROL not enabled)
175 Writing to the board with USB
176 =============================
178 For USB to work you must get your board into ROM boot mode, either by erasing
179 your MMC or (perhaps) holding the recovery button when you boot the board.
180 To erase your MMC, you can boot into Linux and type (as root)
182 dd if=/dev/zero of=/dev/mmcblk0 bs=1M
184 Connect your board's OTG port to your computer.
186 To create a suitable image and write it to the board:
188 ./firefly-rk3288/tools/mkimage -n rk3288 -T rkimage -d \
189 ./firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
190 cat out | openssl rc4 -K 7c4e0304550509072d2c7b38170d1711 | rkflashtool l
192 If all goes well you should something like:
194 U-Boot SPL 2015.07-rc1-00383-ge345740-dirty (Jun 03 2015 - 10:06:49)
195 Card did not respond to voltage select!
196 spl: mmc init failed with error: -17
197 ### ERROR ### Please RESET the board ###
199 You will need to reset the board before each time you try. Yes, that's all
200 it does so far. If support for the Rockchip USB protocol or DFU were added
201 in SPL then we could in principle load U-Boot and boot to a prompt from USB
202 as several other platforms do. However it does not seem to be possible to
203 use the existing boot ROM code from SPL.
206 Booting from an SD card
207 =======================
209 To write an image that boots from an SD card (assumed to be /dev/sdc):
211 ./firefly-rk3288/tools/mkimage -n rk3288 -T rksd -d \
212 firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
213 sudo dd if=out of=/dev/sdc seek=64 && \
214 sudo dd if=firefly-rk3288/u-boot-dtb.img of=/dev/sdc seek=16384
216 This puts the Rockchip header and SPL image first and then places the U-Boot
217 image at block 16384 (i.e. 8MB from the start of the SD card). This
218 corresponds with this setting in U-Boot:
220 #define CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR 0x4000
222 Put this SD (or micro-SD) card into your board and reset it. You should see
225 U-Boot 2016.01-rc2-00309-ge5bad3b-dirty (Jan 02 2016 - 23:41:59 -0700)
227 Model: Radxa Rock 2 Square
229 MMC: dwmmc@ff0f0000: 0, dwmmc@ff0c0000: 1
230 *** Warning - bad CRC, using default environment
233 Out: vop@ff940000.vidconsole
235 Net: Net Initialization Skipped
237 Hit any key to stop autoboot: 0
240 The rockchip bootrom can load and boot an initial spl, then continue to
241 load a second-stage bootloader (ie. U-Boot) as soon as the control is returned
242 to the bootrom. Both the RK3288 and the RK3036 use this special boot sequence.
243 The configuration option enabling this is:
245 CONFIG_SPL_ROCKCHIP_BACK_TO_BROM=y
247 You can create the image via the following operations:
249 ./firefly-rk3288/tools/mkimage -n rk3288 -T rksd -d \
250 firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
251 cat firefly-rk3288/u-boot-dtb.bin >> out && \
252 sudo dd if=out of=/dev/sdc seek=64
254 If you have an HDMI cable attached you should see a video console.
256 For evb_rk3036 board:
257 ./evb-rk3036/tools/mkimage -n rk3036 -T rksd -d evb-rk3036/spl/u-boot-spl.bin out && \
258 cat evb-rk3036/u-boot-dtb.bin >> out && \
259 sudo dd if=out of=/dev/sdc seek=64
261 Note: rk3036 SDMMC and debug uart use the same iomux, so if you boot from SD, the
262 debug uart must be disabled
265 Booting from an SD card on RK3288 with TPL
266 ==========================================
268 Since the size of SPL can't be exceeded 0x8000 bytes in RK3288, it is not possible add
269 new SPL features like Falcon mode or etc.
271 So introduce TPL so-that adding new features to SPL is possible because now TPL should
272 run minimal with code like DDR, clock etc and rest of new features in SPL.
274 As of now TPL is added on Vyasa-RK3288 board.
276 To write an image that boots from an SD card (assumed to be /dev/mmcblk0):
278 ./tools/mkimage -n rk3288 -T rksd -d ./tpl/u-boot-tpl.bin out &&
279 cat ./spl/u-boot-spl-dtb.bin >> out &&
280 sudo dd if=out of=/dev/mmcblk0 seek=64 &&
281 sudo dd if=u-boot-dtb.img of=/dev/mmcblk0 seek=16384
283 Booting from an SD card on RK3188
284 =================================
286 For rk3188 boards the general storage onto the card stays the same as
287 described above, but the image creation needs a bit more care.
289 The bootrom of rk3188 expects to find a small 1kb loader which returns
290 control to the bootrom, after which it will load the real loader, which
291 can then be up to 29kb in size and does the regular ddr init. This is
292 handled by a single image (built as the SPL stage) that tests whether
293 it is handled for the first or second time via code executed from the
296 Additionally the rk3188 requires everything the bootrom loads to be
297 rc4-encrypted. Except for the very first stage the bootrom always reads
298 and decodes 2kb pages, so files should be sized accordingly.
300 # copy tpl, pad to 1020 bytes and append spl
301 tools/mkimage -n rk3188 -T rksd -d spl/u-boot-spl.bin out
303 # truncate, encode and append u-boot.bin
304 truncate -s %2048 u-boot.bin
305 cat u-boot.bin | split -b 512 --filter='openssl rc4 -K 7C4E0304550509072D2C7B38170D1711' >> out
307 Booting from an SD card on Pine64 Rock64 (RK3328)
308 =================================================
310 For Rock64 rk3328 board the following three parts are required:
311 TPL, SPL, and the u-boot image tree blob.
313 - Create TPL/SPL image
315 => tools/mkimage -n rk3328 -T rksd -d tpl/u-boot-tpl.bin idbloader.img
316 => cat spl/u-boot-spl.bin >> idbloader.img
318 - Write TPL/SPL image at 64 sector
320 => sudo dd if=idbloader.img of=/dev/mmcblk0 seek=64
322 - Write u-boot image tree blob at 16384 sector
324 => sudo dd if=u-boot.itb of=/dev/mmcblk0 seek=16384
326 Booting from an SD card on RK3399
327 =================================
329 To write an image that boots from an SD card (assumed to be /dev/sdc):
331 Option 1: Package the image with Rockchip miniloader:
333 - Create idbloader.img
335 => cd /path/to/u-boot
336 => ./tools/mkimage -n rk3399 -T rksd -d /path/to/rkbin/bin/rk33/rk3399_ddr_800MHz_v1.20.bin idbloader.img
337 => cat /path/to/rkbin/bin/rk33/rk3399_miniloader_v1.19.bin >> idbloader.img
339 - Write idbloader.img at 64 sector
341 => sudo dd if=idbloader.img of=/dev/sdc seek=64
343 - Write trust.img at 24576
345 => sudo dd if=trust.img of=/dev/sdc seek=24576
347 - Write uboot.img at 16384 sector
349 => sudo dd if=uboot.img of=/dev/sdc seek=16384
352 Put this SD (or micro-SD) card into your board and reset it. You should see
355 DDR Version 1.20 20190314
357 Channel 0: DDR3, 933MHz
358 Bus Width=32 Col=10 Bank=8 Row=15 CS=1 Die Bus-Width=16 Size=1024MB
360 ch 0 ddrconfig = 0x101, ddrsize = 0x20
361 pmugrf_os_reg[2] = 0x10006281, stride = 0x17
363 Boot1: 2019-03-14, version: 1.19
366 mmc: ERROR: SDHCI ERR:cmd:0x102,stat:0x18000
367 mmc: ERROR: Card did not respond to voltage select!
369 mmc: ERROR: SDHCI ERR:cmd:0x102,stat:0x18000
370 mmc: ERROR: Card did not respond to voltage select!
372 mmc: ERROR: SDHCI ERR:cmd:0x102,stat:0x18000
373 mmc: ERROR: Card did not respond to voltage select!
379 FwPartOffset=2000 , 0
380 StorageInit ok = 45266
382 SecureInit read PBA: 0x4
383 SecureInit read PBA: 0x404
384 SecureInit read PBA: 0x804
385 SecureInit read PBA: 0xc04
386 SecureInit read PBA: 0x1004
387 SecureInit read PBA: 0x1404
388 SecureInit read PBA: 0x1804
389 SecureInit read PBA: 0x1c04
390 SecureInit ret = 0, SecureMode = 0
391 atags_set_bootdev: ret:(0)
392 GPT 0x3380ec0 signature is wrong
394 GPT 0x3380ec0 signature is wrong
396 LoadTrust Addr:0x4000
398 Load uboot, ReadLba = 2000
399 hdr 0000000003380880 + 0x0:0x88,0x41,0x3e,0x97,0xe6,0x61,0x54,0x23,0xe9,0x5a,0xd1,0x2b,0xdc,0x2f,0xf9,0x35,
401 Load OK, addr=0x200000, size=0x9c9c0
403 NOTICE: BL31: v1.3(debug):370ab80
404 NOTICE: BL31: Built : 09:23:41, Mar 4 2019
405 NOTICE: BL31: Rockchip release version: v1.1
406 INFO: GICv3 with legacy support detected. ARM GICV3 driver initialized in EL3
407 INFO: Using opteed sec cpu_context!
408 INFO: boot cpu mask: 0
409 INFO: plat_rockchip_pmu_init(1181): pd status 3e
410 INFO: BL31: Initializing runtime services
411 INFO: BL31: Initializing BL32
412 INF [0x0] TEE-CORE:init_primary_helper:337: Initializing (1.1.0-195-g8f090d20 #6 Fri Dec 7 06:11:20 UTC 2018 aarch64)
414 INF [0x0] TEE-CORE:init_primary_helper:338: Release version: 1.2
416 INF [0x0] TEE-CORE:init_teecore:83: teecore inits done
417 INFO: BL31: Preparing for EL3 exit to normal world
418 INFO: Entry point address = 0x200000
422 U-Boot 2019.04-rc4-00136-gfd121f9641-dirty (Apr 16 2019 - 14:02:47 +0530)
424 Model: FriendlyARM NanoPi NEO4
426 MMC: dwmmc@fe310000: 2, dwmmc@fe320000: 1, sdhci@fe330000: 0
427 Loading Environment from MMC... *** Warning - bad CRC, using default environment
432 Model: FriendlyARM NanoPi NEO4
433 Net: eth0: ethernet@fe300000
434 Hit any key to stop autoboot: 0
437 Option 2: Package the image with SPL:
439 - Prefix rk3399 header to SPL image
441 => cd /path/to/u-boot
442 => ./tools/mkimage -n rk3399 -T rksd -d spl/u-boot-spl-dtb.bin out
444 - Write prefixed SPL at 64th sector
446 => sudo dd if=out of=/dev/sdc seek=64
448 - Write U-Boot proper at 16384 sector
450 => sudo dd if=u-boot.itb of=/dev/sdc seek=16384
453 Put this SD (or micro-SD) card into your board and reset it. You should see
456 U-Boot SPL board init
457 Trying to boot from MMC1
460 U-Boot 2019.01-00004-g14db5ee998 (Mar 11 2019 - 13:18:41 +0530)
462 Model: Orange Pi RK3399 Board
464 MMC: dwmmc@fe310000: 2, dwmmc@fe320000: 1, sdhci@fe330000: 0
465 Loading Environment from MMC... OK
469 Model: Orange Pi RK3399 Board
470 Net: eth0: ethernet@fe300000
471 Hit any key to stop autoboot: 0
474 Option 3: Package the image with TPL:
476 - Prefix rk3399 header to TPL image
478 => cd /path/to/u-boot
479 => ./tools/mkimage -n rk3399 -T rksd -d tpl/u-boot-tpl-dtb.bin out
481 - Concatinate tpl with spl
483 => cd /path/to/u-boot
484 => cat ./spl/u-boot-spl-dtb.bin >> out
486 - Write tpl+spl at 64th sector
488 => sudo dd if=out of=/dev/sdc seek=64
490 - Write U-Boot proper at 16384 sector
492 => sudo dd if=u-boot.itb of=/dev/sdc seek=16384
495 Put this SD (or micro-SD) card into your board and reset it. You should see
498 U-Boot TPL board init
499 Trying to boot from BOOTROM
500 Returning to boot ROM...
502 U-Boot SPL board init
503 Trying to boot from MMC1
506 U-Boot 2019.07-rc1-00241-g5b3244767a (May 08 2019 - 10:51:06 +0530)
508 Model: Orange Pi RK3399 Board
510 MMC: dwmmc@fe310000: 2, dwmmc@fe320000: 1, sdhci@fe330000: 0
511 Loading Environment from MMC... OK
515 Model: Orange Pi RK3399 Board
516 Net: eth0: ethernet@fe300000
517 Hit any key to stop autoboot: 0
520 Using fastboot on rk3288
521 ========================
522 - Write GPT partition layout to mmc device which fastboot want to use it to
525 => gpt write mmc 1 $partitions
527 - Invoke fastboot command to prepare
531 - Start fastboot request on PC
533 fastboot -i 0x2207 flash loader evb-rk3288/spl/u-boot-spl-dtb.bin
535 You should see something like:
538 WARNING: unknown variable: partition-type:loader
539 Starting download of 357796 bytes
541 downloading of 357796 bytes finished
543 ........ wrote 357888 bytes to 'loader'
548 To write an image that boots from SPI flash (e.g. for the Haier Chromebook or
551 ./chromebook_jerry/tools/mkimage -n rk3288 -T rkspi \
552 -d chromebook_jerry/spl/u-boot-spl-dtb.bin spl.bin && \
553 dd if=spl.bin of=spl-out.bin bs=128K conv=sync && \
554 cat spl-out.bin chromebook_jerry/u-boot-dtb.img >out.bin && \
555 dd if=out.bin of=out.bin.pad bs=4M conv=sync
557 This converts the SPL image to the required SPI format by adding the Rockchip
558 header and skipping every second 2KB block. Then the U-Boot image is written at
559 offset 128KB and the whole image is padded to 4MB which is the SPI flash size.
560 The position of U-Boot is controlled with this setting in U-Boot:
562 #define CONFIG_SYS_SPI_U_BOOT_OFFS (128 << 10)
564 If you have a Dediprog em100pro connected then you can write the image with:
566 sudo em100 -s -c GD25LQ32 -d out.bin.pad -r
568 When booting you should see something like:
570 U-Boot SPL 2015.07-rc2-00215-g9a58220-dirty (Jun 23 2015 - 12:11:32)
573 U-Boot 2015.07-rc2-00215-g9a58220-dirty (Jun 23 2015 - 12:11:32 -0600)
578 Using default environment
588 Immediate priorities are:
592 - Run CPU at full speed (code exists but we only see ~60 DMIPS maximum)
594 - Boot U-Boot proper over USB OTG (at present only SPL works)
600 There are plenty of patches in the links below to help with this work.
602 [1] https://github.com/rkchrome/uboot.git
603 [2] https://github.com/linux-rockchip/u-boot-rockchip.git branch u-boot-rk3288
604 [3] https://github.com/linux-rockchip/rkflashtool.git
605 [4] http://wiki.t-firefly.com/index.php/Firefly-RK3288/Serial_debug/en
610 rkimage.c produces an SPL image suitable for sending directly to the boot ROM
611 over USB OTG. This is a very simple format - just the string RK32 (as 4 bytes)
612 followed by u-boot-spl-dtb.bin.
614 The boot ROM loads image to 0xff704000 which is in the internal SRAM. The SRAM
615 starts at 0xff700000 and extends to 0xff718000 where we put the stack.
620 rksd.c produces an image consisting of 32KB of empty space, a header and
621 u-boot-spl-dtb.bin. The header is defined by 'struct header0_info' although
622 most of the fields are unused by U-Boot. We just need to specify the
623 signature, a flag and the block offset and size of the SPL image.
625 The header occupies a single block but we pad it out to 4 blocks. The header
626 is encoding using RC4 with the key 7c4e0304550509072d2c7b38170d1711. The SPL
627 image can be encoded too but we don't do that.
629 The maximum size of u-boot-spl-dtb.bin which the boot ROM will read is 32KB,
630 or 0x40 blocks. This is a severe and annoying limitation. There may be a way
631 around this limitation, since there is plenty of SRAM, but at present the
632 board refuses to boot if this limit is exceeded.
634 The image produced is padded up to a block boundary (512 bytes). It should be
635 written to the start of an SD card using dd.
637 Since this image is set to load U-Boot from the SD card at block offset,
638 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, dd should be used to write
639 u-boot-dtb.img to the SD card at that offset. See above for instructions.
644 rkspi.c produces an image consisting of a header and u-boot-spl-dtb.bin. The
645 resulting image is then spread out so that only the first 2KB of each 4KB
646 sector is used. The header is the same as with rksd and the maximum size is
647 also 32KB (before spreading). The image should be written to the start of
650 See above for instructions on how to write a SPI image.
655 You can use this script to create #defines for SoC register access. See the
659 Device tree and driver model
660 ----------------------------
662 Where possible driver model is used to provide a structure to the
663 functionality. Device tree is used for configuration. However these have an
664 overhead and in SPL with a 32KB size limit some shortcuts have been taken.
665 In general all Rockchip drivers should use these features, with SPL-specific
666 modifications where required.
669 ----------------------------
671 Rockchip use a unified GPT partition layout in open source support.
672 With this GPT partition layout, uboot can be compatilbe with other components,
673 like miniloader, trusted-os, arm-trust-firmware.
675 There are some documents about partitions in the links below.
676 http://rockchip.wikidot.com/partitions
679 Jagan Teki <jagan@amarulasolutions.com>
681 Simon Glass <sjg@chromium.org>