1 # SPDX-License-Identifier: GPL-2.0+
3 # Copyright (C) 2015 Google. Inc
4 # Written by Simon Glass <sjg@chromium.org>
9 There are several repositories available with versions of U-Boot that support
10 many Rockchip devices [1] [2].
12 The current mainline support is experimental only and is not useful for
13 anything. It should provide a base on which to build.
15 So far only support for the RK3288 and RK3036 is provided.
23 - Firefly RK3288 board or something else with a supported RockChip SoC
24 - Power connection to 5V using the supplied micro-USB power cable
25 - Separate USB serial cable attached to your computer and the Firefly
26 (connect to the micro-USB connector below the logo)
28 - openssl (sudo apt-get install openssl)
29 - Serial UART connection [4]
30 - Suitable ARM cross compiler, e.g.:
31 sudo apt-get install gcc-4.7-arm-linux-gnueabi
37 At present 12 RK3288 boards are supported:
39 - EVB RK3288 - use evb-rk3288 configuration
40 - Fennec RK3288 - use fennec-rk3288 configuration
41 - Firefly RK3288 - use firefly-rk3288 configuration
42 - Hisense Chromebook - use chromebook_jerry configuration
43 - Asus C100P Chromebook - use chromebook_minnie configuration
44 - Asus Chromebit - use chromebook_mickey configuration
45 - MiQi RK3288 - use miqi-rk3288 configuration
46 - phyCORE-RK3288 RDK - use phycore-rk3288 configuration
47 - PopMetal RK3288 - use popmetal-rk3288 configuration
48 - Radxa Rock 2 - use rock2 configuration
49 - Tinker RK3288 - use tinker-rk3288 configuration
50 - Vyasa RK3288 - use vyasa-rk3288 configuration
52 Two RK3036 boards are supported:
54 - EVB RK3036 - use evb-rk3036 configuration
55 - Kylin - use kylin_rk3036 configuration
57 One RK3328 board is supported:
61 Five RK3399 boards are supported (aarch64):
63 - EBV RK3399 - use evb_rk3399 configuration
64 - Firefly RK3399 - use the firefly_rk3399 configuration
65 - Puma - use puma_rk3399 configuration
66 - Ficus - use ficus-rk3399 configuration
67 - Rock960 (Vamrs) - use rock960-rk3399 configuration
69 Four RK3368 boards are supported:
71 - Sheep - use sheep-rk3368 configuration
72 - Lion - use lion-rk3368 configuration
73 - Geekbox - use geekbox configuration
74 - EVB PX5 - use evb-px5 configuration
76 One RK3128 board is supported:
78 - EVB RK3128 - use evb-rk3128 configuration
80 One RK3229 board is supported:
82 - EVB RK3229 - use evb-rk3229 configuration
84 Two RV1108 boards are supported:
86 - EVB RV1108 - use evb-rv1108 configuration
87 - Elgin R1 - use elgin-rv1108 configuration
89 One RV3188 baord is supported:
91 - Raxda Rock - use rock configuration
96 CROSS_COMPILE=arm-linux-gnueabi- make O=firefly firefly-rk3288_defconfig all
98 (or you can use another cross compiler if you prefer)
101 Writing to the board with USB
102 =============================
104 For USB to work you must get your board into ROM boot mode, either by erasing
105 your MMC or (perhaps) holding the recovery button when you boot the board.
106 To erase your MMC, you can boot into Linux and type (as root)
108 dd if=/dev/zero of=/dev/mmcblk0 bs=1M
110 Connect your board's OTG port to your computer.
112 To create a suitable image and write it to the board:
114 ./firefly-rk3288/tools/mkimage -n rk3288 -T rkimage -d \
115 ./firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
116 cat out | openssl rc4 -K 7c4e0304550509072d2c7b38170d1711 | rkflashtool l
118 If all goes well you should something like:
120 U-Boot SPL 2015.07-rc1-00383-ge345740-dirty (Jun 03 2015 - 10:06:49)
121 Card did not respond to voltage select!
122 spl: mmc init failed with error: -17
123 ### ERROR ### Please RESET the board ###
125 You will need to reset the board before each time you try. Yes, that's all
126 it does so far. If support for the Rockchip USB protocol or DFU were added
127 in SPL then we could in principle load U-Boot and boot to a prompt from USB
128 as several other platforms do. However it does not seem to be possible to
129 use the existing boot ROM code from SPL.
132 Booting from an SD card
133 =======================
135 To write an image that boots from an SD card (assumed to be /dev/sdc):
137 ./firefly-rk3288/tools/mkimage -n rk3288 -T rksd -d \
138 firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
139 sudo dd if=out of=/dev/sdc seek=64 && \
140 sudo dd if=firefly-rk3288/u-boot-dtb.img of=/dev/sdc seek=16384
142 This puts the Rockchip header and SPL image first and then places the U-Boot
143 image at block 16384 (i.e. 8MB from the start of the SD card). This
144 corresponds with this setting in U-Boot:
146 #define CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR 0x4000
148 Put this SD (or micro-SD) card into your board and reset it. You should see
151 U-Boot 2016.01-rc2-00309-ge5bad3b-dirty (Jan 02 2016 - 23:41:59 -0700)
153 Model: Radxa Rock 2 Square
155 MMC: dwmmc@ff0f0000: 0, dwmmc@ff0c0000: 1
156 *** Warning - bad CRC, using default environment
159 Out: vop@ff940000.vidconsole
161 Net: Net Initialization Skipped
163 Hit any key to stop autoboot: 0
166 The rockchip bootrom can load and boot an initial spl, then continue to
167 load a second-stage bootloader (ie. U-Boot) as soon as the control is returned
168 to the bootrom. Both the RK3288 and the RK3036 use this special boot sequence.
169 The configuration option enabling this is:
171 CONFIG_SPL_ROCKCHIP_BACK_TO_BROM=y
173 You can create the image via the following operations:
175 ./firefly-rk3288/tools/mkimage -n rk3288 -T rksd -d \
176 firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
177 cat firefly-rk3288/u-boot-dtb.bin >> out && \
178 sudo dd if=out of=/dev/sdc seek=64
180 If you have an HDMI cable attached you should see a video console.
182 For evb_rk3036 board:
183 ./evb-rk3036/tools/mkimage -n rk3036 -T rksd -d evb-rk3036/spl/u-boot-spl.bin out && \
184 cat evb-rk3036/u-boot-dtb.bin >> out && \
185 sudo dd if=out of=/dev/sdc seek=64
187 Note: rk3036 SDMMC and debug uart use the same iomux, so if you boot from SD, the
188 debug uart must be disabled
191 Booting from an SD card on RK3288 with TPL
192 ==========================================
194 Since the size of SPL can't be exceeded 0x8000 bytes in RK3288, it is not possible add
195 new SPL features like Falcon mode or etc.
197 So introduce TPL so-that adding new features to SPL is possible because now TPL should
198 run minimal with code like DDR, clock etc and rest of new features in SPL.
200 As of now TPL is added on Vyasa-RK3288 board.
202 To write an image that boots from an SD card (assumed to be /dev/mmcblk0):
204 ./tools/mkimage -n rk3288 -T rksd -d ./tpl/u-boot-tpl.bin out &&
205 cat ./spl/u-boot-spl-dtb.bin >> out &&
206 sudo dd if=out of=/dev/mmcblk0 seek=64 &&
207 sudo dd if=u-boot-dtb.img of=/dev/mmcblk0 seek=16384
209 Booting from an SD card on RK3188
210 =================================
212 For rk3188 boards the general storage onto the card stays the same as
213 described above, but the image creation needs a bit more care.
215 The bootrom of rk3188 expects to find a small 1kb loader which returns
216 control to the bootrom, after which it will load the real loader, which
217 can then be up to 29kb in size and does the regular ddr init. This is
218 handled by a single image (built as the SPL stage) that tests whether
219 it is handled for the first or second time via code executed from the
222 Additionally the rk3188 requires everything the bootrom loads to be
223 rc4-encrypted. Except for the very first stage the bootrom always reads
224 and decodes 2kb pages, so files should be sized accordingly.
226 # copy tpl, pad to 1020 bytes and append spl
227 tools/mkimage -n rk3188 -T rksd -d spl/u-boot-spl.bin out
229 # truncate, encode and append u-boot.bin
230 truncate -s %2048 u-boot.bin
231 cat u-boot.bin | split -b 512 --filter='openssl rc4 -K 7C4E0304550509072D2C7B38170D1711' >> out
234 Using fastboot on rk3288
235 ========================
236 - Write GPT partition layout to mmc device which fastboot want to use it to
239 => gpt write mmc 1 $partitions
241 - Invoke fastboot command to prepare
245 - Start fastboot request on PC
247 fastboot -i 0x2207 flash loader evb-rk3288/spl/u-boot-spl-dtb.bin
249 You should see something like:
252 WARNING: unknown variable: partition-type:loader
253 Starting download of 357796 bytes
255 downloading of 357796 bytes finished
257 ........ wrote 357888 bytes to 'loader'
262 To write an image that boots from SPI flash (e.g. for the Haier Chromebook):
264 ./chromebook_jerry/tools/mkimage -n rk3288 -T rkspi \
265 -d chromebook_jerry/spl/u-boot-spl-dtb.bin spl.bin && \
266 dd if=spl.bin of=spl-out.bin bs=128K conv=sync && \
267 cat spl-out.bin chromebook_jerry/u-boot-dtb.img >out.bin && \
268 dd if=out.bin of=out.bin.pad bs=4M conv=sync
270 This converts the SPL image to the required SPI format by adding the Rockchip
271 header and skipping every 2KB block. Then the U-Boot image is written at
272 offset 128KB and the whole image is padded to 4MB which is the SPI flash size.
273 The position of U-Boot is controlled with this setting in U-Boot:
275 #define CONFIG_SYS_SPI_U_BOOT_OFFS (128 << 10)
277 If you have a Dediprog em100pro connected then you can write the image with:
279 sudo em100 -s -c GD25LQ32 -d out.bin.pad -r
281 When booting you should see something like:
283 U-Boot SPL 2015.07-rc2-00215-g9a58220-dirty (Jun 23 2015 - 12:11:32)
286 U-Boot 2015.07-rc2-00215-g9a58220-dirty (Jun 23 2015 - 12:11:32 -0600)
291 Using default environment
301 Immediate priorities are:
305 - Run CPU at full speed (code exists but we only see ~60 DMIPS maximum)
307 - Support for other Rockchip parts
308 - Boot U-Boot proper over USB OTG (at present only SPL works)
314 There are plenty of patches in the links below to help with this work.
316 [1] https://github.com/rkchrome/uboot.git
317 [2] https://github.com/linux-rockchip/u-boot-rockchip.git branch u-boot-rk3288
318 [3] https://github.com/linux-rockchip/rkflashtool.git
319 [4] http://wiki.t-firefly.com/index.php/Firefly-RK3288/Serial_debug/en
324 rkimage.c produces an SPL image suitable for sending directly to the boot ROM
325 over USB OTG. This is a very simple format - just the string RK32 (as 4 bytes)
326 followed by u-boot-spl-dtb.bin.
328 The boot ROM loads image to 0xff704000 which is in the internal SRAM. The SRAM
329 starts at 0xff700000 and extends to 0xff718000 where we put the stack.
334 rksd.c produces an image consisting of 32KB of empty space, a header and
335 u-boot-spl-dtb.bin. The header is defined by 'struct header0_info' although
336 most of the fields are unused by U-Boot. We just need to specify the
337 signature, a flag and the block offset and size of the SPL image.
339 The header occupies a single block but we pad it out to 4 blocks. The header
340 is encoding using RC4 with the key 7c4e0304550509072d2c7b38170d1711. The SPL
341 image can be encoded too but we don't do that.
343 The maximum size of u-boot-spl-dtb.bin which the boot ROM will read is 32KB,
344 or 0x40 blocks. This is a severe and annoying limitation. There may be a way
345 around this limitation, since there is plenty of SRAM, but at present the
346 board refuses to boot if this limit is exceeded.
348 The image produced is padded up to a block boundary (512 bytes). It should be
349 written to the start of an SD card using dd.
351 Since this image is set to load U-Boot from the SD card at block offset,
352 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, dd should be used to write
353 u-boot-dtb.img to the SD card at that offset. See above for instructions.
358 rkspi.c produces an image consisting of a header and u-boot-spl-dtb.bin. The
359 resulting image is then spread out so that only the first 2KB of each 4KB
360 sector is used. The header is the same as with rksd and the maximum size is
361 also 32KB (before spreading). The image should be written to the start of
364 See above for instructions on how to write a SPI image.
369 You can use this script to create #defines for SoC register access. See the
373 Device tree and driver model
374 ----------------------------
376 Where possible driver model is used to provide a structure to the
377 functionality. Device tree is used for configuration. However these have an
378 overhead and in SPL with a 32KB size limit some shortcuts have been taken.
379 In general all Rockchip drivers should use these features, with SPL-specific
380 modifications where required.
383 ----------------------------
385 Rockchip use a unified GPT partition layout in open source support.
386 With this GPT partition layout, uboot can be compatilbe with other components,
387 like miniloader, trusted-os, arm-trust-firmware.
389 There are some documents about partitions in the links below.
390 http://rockchip.wikidot.com/partitions
393 Simon Glass <sjg@chromium.org>