blob: ec10ebbc26078c606aba11a9c9b77cd53541e648 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
Simon Glassadfb2bf2015-08-30 16:55:43 -06002#
3# Copyright (C) 2015 Google. Inc
4# Written by Simon Glass <sjg@chromium.org>
Simon Glassadfb2bf2015-08-30 16:55:43 -06005
6U-Boot on Rockchip
7==================
8
Simon Glass0c14c362019-01-21 14:53:23 -07009A wide range of Rockchip SoCs are supported in mainline U-Boot
Simon Glassadfb2bf2015-08-30 16:55:43 -060010
11
12Prerequisites
13=============
14
15You will need:
16
Simon Glassf1387132016-01-21 19:45:25 -070017 - Firefly RK3288 board or something else with a supported RockChip SoC
Simon Glassadfb2bf2015-08-30 16:55:43 -060018 - 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)
21 - rkflashtool [3]
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
26
27
28Building
29========
30
Simon Glass16217f92019-01-21 14:53:22 -070031At present 12 RK3288 boards are supported:
Simon Glassadfb2bf2015-08-30 16:55:43 -060032
Xu Ziyuan744368d2016-07-05 18:06:30 +080033 - EVB RK3288 - use evb-rk3288 configuration
jk.kernel@gmail.comd7ca67b2016-07-26 18:28:29 +080034 - Fennec RK3288 - use fennec-rk3288 configuration
Xu Ziyuan1c62d992016-08-01 08:46:19 +080035 - Firefly RK3288 - use firefly-rk3288 configuration
36 - Hisense Chromebook - use chromebook_jerry configuration
Simon Glass16217f92019-01-21 14:53:22 -070037 - Asus C100P Chromebook - use chromebook_minnie configuration
38 - Asus Chromebit - use chromebook_mickey configuration
Jernej Skrabec7da86802017-03-30 01:23:14 +020039 - MiQi RK3288 - use miqi-rk3288 configuration
Wadim Egorova84b5892017-06-19 12:36:41 +020040 - phyCORE-RK3288 RDK - use phycore-rk3288 configuration
jk.kernel@gmail.comdd63fbc2016-07-26 18:28:30 +080041 - PopMetal RK3288 - use popmetal-rk3288 configuration
Xu Ziyuan1c62d992016-08-01 08:46:19 +080042 - Radxa Rock 2 - use rock2 configuration
Jernej Skrabec43b5c782017-03-30 01:23:13 +020043 - Tinker RK3288 - use tinker-rk3288 configuration
Simon Glass16217f92019-01-21 14:53:22 -070044 - Vyasa RK3288 - use vyasa-rk3288 configuration
Simon Glassadfb2bf2015-08-30 16:55:43 -060045
Simon Glass16217f92019-01-21 14:53:22 -070046Two RK3036 boards are supported:
huang lin1d5a6962015-11-17 14:20:31 +080047
Simon Glassf1387132016-01-21 19:45:25 -070048 - EVB RK3036 - use evb-rk3036 configuration
49 - Kylin - use kylin_rk3036 configuration
huang lin1d5a6962015-11-17 14:20:31 +080050
Simon Glass16217f92019-01-21 14:53:22 -070051One RK3328 board is supported:
52
53 - EVB RK3328
54
Simon Glass9e921162019-01-21 14:53:36 -070055Size RK3399 boards are supported (aarch64):
Simon Glass16217f92019-01-21 14:53:22 -070056
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
Simon Glass9e921162019-01-21 14:53:36 -070062 - Bob - use chromebook_bob configuration
Simon Glass16217f92019-01-21 14:53:22 -070063
64Four RK3368 boards are supported:
65
66 - Sheep - use sheep-rk3368 configuration
67 - Lion - use lion-rk3368 configuration
68 - Geekbox - use geekbox configuration
69 - EVB PX5 - use evb-px5 configuration
70
71One RK3128 board is supported:
72
73 - EVB RK3128 - use evb-rk3128 configuration
74
75One RK3229 board is supported:
76
77 - EVB RK3229 - use evb-rk3229 configuration
78
79Two RV1108 boards are supported:
80
81 - EVB RV1108 - use evb-rv1108 configuration
82 - Elgin R1 - use elgin-rv1108 configuration
83
84One RV3188 baord is supported:
85
86 - Raxda Rock - use rock configuration
87
88
Simon Glassadfb2bf2015-08-30 16:55:43 -060089For example:
90
91 CROSS_COMPILE=arm-linux-gnueabi- make O=firefly firefly-rk3288_defconfig all
92
93(or you can use another cross compiler if you prefer)
94
Simon Glassadfb2bf2015-08-30 16:55:43 -060095
96Writing to the board with USB
97=============================
98
99For USB to work you must get your board into ROM boot mode, either by erasing
100your MMC or (perhaps) holding the recovery button when you boot the board.
101To erase your MMC, you can boot into Linux and type (as root)
102
103 dd if=/dev/zero of=/dev/mmcblk0 bs=1M
104
105Connect your board's OTG port to your computer.
106
107To create a suitable image and write it to the board:
108
Jeffy Chen717f8842015-11-27 12:07:18 +0800109 ./firefly-rk3288/tools/mkimage -n rk3288 -T rkimage -d \
Simon Glassf2acc552015-08-30 16:55:52 -0600110 ./firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
Simon Glassadfb2bf2015-08-30 16:55:43 -0600111 cat out | openssl rc4 -K 7c4e0304550509072d2c7b38170d1711 | rkflashtool l
112
113If all goes well you should something like:
114
115 U-Boot SPL 2015.07-rc1-00383-ge345740-dirty (Jun 03 2015 - 10:06:49)
116 Card did not respond to voltage select!
117 spl: mmc init failed with error: -17
118 ### ERROR ### Please RESET the board ###
119
120You will need to reset the board before each time you try. Yes, that's all
121it does so far. If support for the Rockchip USB protocol or DFU were added
122in SPL then we could in principle load U-Boot and boot to a prompt from USB
123as several other platforms do. However it does not seem to be possible to
124use the existing boot ROM code from SPL.
125
126
127Booting from an SD card
128=======================
129
130To write an image that boots from an SD card (assumed to be /dev/sdc):
131
Jeffy Chen717f8842015-11-27 12:07:18 +0800132 ./firefly-rk3288/tools/mkimage -n rk3288 -T rksd -d \
Simon Glassf2acc552015-08-30 16:55:52 -0600133 firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
134 sudo dd if=out of=/dev/sdc seek=64 && \
Kever Yang73e6dbe2017-11-02 15:16:35 +0800135 sudo dd if=firefly-rk3288/u-boot-dtb.img of=/dev/sdc seek=16384
Simon Glassadfb2bf2015-08-30 16:55:43 -0600136
137This puts the Rockchip header and SPL image first and then places the U-Boot
Goldschmidt Simon341e44e2017-11-10 11:38:32 +0000138image at block 16384 (i.e. 8MB from the start of the SD card). This
Simon Glassadfb2bf2015-08-30 16:55:43 -0600139corresponds with this setting in U-Boot:
140
Kever Yang73e6dbe2017-11-02 15:16:35 +0800141 #define CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR 0x4000
Simon Glassadfb2bf2015-08-30 16:55:43 -0600142
143Put this SD (or micro-SD) card into your board and reset it. You should see
144something like:
145
Simon Glassf1387132016-01-21 19:45:25 -0700146 U-Boot 2016.01-rc2-00309-ge5bad3b-dirty (Jan 02 2016 - 23:41:59 -0700)
Simon Glassadfb2bf2015-08-30 16:55:43 -0600147
Simon Glassf1387132016-01-21 19:45:25 -0700148 Model: Radxa Rock 2 Square
Simon Glassadfb2bf2015-08-30 16:55:43 -0600149 DRAM: 2 GiB
Simon Glassf1387132016-01-21 19:45:25 -0700150 MMC: dwmmc@ff0f0000: 0, dwmmc@ff0c0000: 1
151 *** Warning - bad CRC, using default environment
Simon Glassadfb2bf2015-08-30 16:55:43 -0600152
Simon Glassf1387132016-01-21 19:45:25 -0700153 In: serial
154 Out: vop@ff940000.vidconsole
155 Err: serial
156 Net: Net Initialization Skipped
157 No ethernet found.
158 Hit any key to stop autoboot: 0
Simon Glassadfb2bf2015-08-30 16:55:43 -0600159 =>
160
Xu Ziyuanb47ea792016-07-12 19:09:49 +0800161The rockchip bootrom can load and boot an initial spl, then continue to
Heinrich Schuchardt760b9572018-06-03 20:41:29 +0200162load a second-stage bootloader (ie. U-Boot) as soon as the control is returned
163to the bootrom. Both the RK3288 and the RK3036 use this special boot sequence.
164The configuration option enabling this is:
Xu Ziyuanb47ea792016-07-12 19:09:49 +0800165
Heinrich Schuchardt760b9572018-06-03 20:41:29 +0200166 CONFIG_SPL_ROCKCHIP_BACK_TO_BROM=y
Xu Ziyuanb47ea792016-07-12 19:09:49 +0800167
168You can create the image via the following operations:
169
170 ./firefly-rk3288/tools/mkimage -n rk3288 -T rksd -d \
171 firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
172 cat firefly-rk3288/u-boot-dtb.bin >> out && \
173 sudo dd if=out of=/dev/sdc seek=64
174
Simon Glassf1387132016-01-21 19:45:25 -0700175If you have an HDMI cable attached you should see a video console.
176
huang lin1d5a6962015-11-17 14:20:31 +0800177For evb_rk3036 board:
Jeffy Chen717f8842015-11-27 12:07:18 +0800178 ./evb-rk3036/tools/mkimage -n rk3036 -T rksd -d evb-rk3036/spl/u-boot-spl.bin out && \
huang lin1d5a6962015-11-17 14:20:31 +0800179 cat evb-rk3036/u-boot-dtb.bin >> out && \
180 sudo dd if=out of=/dev/sdc seek=64
181
182Note: rk3036 SDMMC and debug uart use the same iomux, so if you boot from SD, the
183 debug uart must be disabled
Simon Glassadfb2bf2015-08-30 16:55:43 -0600184
Heiko Stübnerf46b8592017-03-24 00:41:34 +0100185
Jagan Teki532cb7f2017-09-27 23:03:12 +0530186Booting from an SD card on RK3288 with TPL
187==========================================
188
189Since the size of SPL can't be exceeded 0x8000 bytes in RK3288, it is not possible add
190new SPL features like Falcon mode or etc.
191
192So introduce TPL so-that adding new features to SPL is possible because now TPL should
193run minimal with code like DDR, clock etc and rest of new features in SPL.
194
195As of now TPL is added on Vyasa-RK3288 board.
196
197To write an image that boots from an SD card (assumed to be /dev/mmcblk0):
198
199 ./tools/mkimage -n rk3288 -T rksd -d ./tpl/u-boot-tpl.bin out &&
200 cat ./spl/u-boot-spl-dtb.bin >> out &&
201 sudo dd if=out of=/dev/mmcblk0 seek=64 &&
Jagan Tekid80599e2017-11-10 17:18:43 +0530202 sudo dd if=u-boot-dtb.img of=/dev/mmcblk0 seek=16384
Jagan Teki532cb7f2017-09-27 23:03:12 +0530203
Heiko Stübnerf46b8592017-03-24 00:41:34 +0100204Booting from an SD card on RK3188
205=================================
206
207For rk3188 boards the general storage onto the card stays the same as
208described above, but the image creation needs a bit more care.
209
210The bootrom of rk3188 expects to find a small 1kb loader which returns
211control to the bootrom, after which it will load the real loader, which
Philipp Tomsich4d9253f2017-10-10 16:21:15 +0200212can then be up to 29kb in size and does the regular ddr init. This is
213handled by a single image (built as the SPL stage) that tests whether
214it is handled for the first or second time via code executed from the
215boot0-hook.
Heiko Stübnerf46b8592017-03-24 00:41:34 +0100216
217Additionally the rk3188 requires everything the bootrom loads to be
218rc4-encrypted. Except for the very first stage the bootrom always reads
219and decodes 2kb pages, so files should be sized accordingly.
220
221# copy tpl, pad to 1020 bytes and append spl
Philipp Tomsich4d9253f2017-10-10 16:21:15 +0200222tools/mkimage -n rk3188 -T rksd -d spl/u-boot-spl.bin out
Heiko Stübnerf46b8592017-03-24 00:41:34 +0100223
224# truncate, encode and append u-boot.bin
225truncate -s %2048 u-boot.bin
226cat u-boot.bin | split -b 512 --filter='openssl rc4 -K 7C4E0304550509072D2C7B38170D1711' >> out
227
228
Xu Ziyuana16e2e02016-07-18 09:56:46 +0800229Using fastboot on rk3288
230========================
Xu Ziyuana16e2e02016-07-18 09:56:46 +0800231- Write GPT partition layout to mmc device which fastboot want to use it to
232store the image
233
234 => gpt write mmc 1 $partitions
235
236- Invoke fastboot command to prepare
237
238 => fastboot 1
239
240- Start fastboot request on PC
241
242 fastboot -i 0x2207 flash loader evb-rk3288/spl/u-boot-spl-dtb.bin
243
244You should see something like:
245
246 => fastboot 1
247 WARNING: unknown variable: partition-type:loader
248 Starting download of 357796 bytes
249 ..
250 downloading of 357796 bytes finished
251 Flashing Raw Image
252 ........ wrote 357888 bytes to 'loader'
253
Simon Glassadfb2bf2015-08-30 16:55:43 -0600254Booting from SPI
255================
256
Simon Glass9e921162019-01-21 14:53:36 -0700257To write an image that boots from SPI flash (e.g. for the Haier Chromebook or
258Bob):
Simon Glassadfb2bf2015-08-30 16:55:43 -0600259
Simon Glassdd8e4292015-12-29 05:22:45 -0700260 ./chromebook_jerry/tools/mkimage -n rk3288 -T rkspi \
261 -d chromebook_jerry/spl/u-boot-spl-dtb.bin spl.bin && \
262 dd if=spl.bin of=spl-out.bin bs=128K conv=sync && \
263 cat spl-out.bin chromebook_jerry/u-boot-dtb.img >out.bin && \
Simon Glassadfb2bf2015-08-30 16:55:43 -0600264 dd if=out.bin of=out.bin.pad bs=4M conv=sync
265
266This converts the SPL image to the required SPI format by adding the Rockchip
Simon Glass6cecc2b2019-01-21 14:53:27 -0700267header and skipping every second 2KB block. Then the U-Boot image is written at
Simon Glassadfb2bf2015-08-30 16:55:43 -0600268offset 128KB and the whole image is padded to 4MB which is the SPI flash size.
269The position of U-Boot is controlled with this setting in U-Boot:
270
271 #define CONFIG_SYS_SPI_U_BOOT_OFFS (128 << 10)
272
273If you have a Dediprog em100pro connected then you can write the image with:
274
275 sudo em100 -s -c GD25LQ32 -d out.bin.pad -r
276
277When booting you should see something like:
278
279 U-Boot SPL 2015.07-rc2-00215-g9a58220-dirty (Jun 23 2015 - 12:11:32)
280
281
282 U-Boot 2015.07-rc2-00215-g9a58220-dirty (Jun 23 2015 - 12:11:32 -0600)
283
284 Model: Google Jerry
285 DRAM: 2 GiB
286 MMC:
287 Using default environment
288
289 In: serial@ff690000
290 Out: serial@ff690000
291 Err: serial@ff690000
292 =>
293
Simon Glassadfb2bf2015-08-30 16:55:43 -0600294Future work
295===========
296
297Immediate priorities are:
298
Simon Glassadfb2bf2015-08-30 16:55:43 -0600299- USB host
300- USB device
Simon Glassf1387132016-01-21 19:45:25 -0700301- Run CPU at full speed (code exists but we only see ~60 DMIPS maximum)
Simon Glassadfb2bf2015-08-30 16:55:43 -0600302- NAND flash
Simon Glassadfb2bf2015-08-30 16:55:43 -0600303- Boot U-Boot proper over USB OTG (at present only SPL works)
304
305
306Development Notes
307=================
308
309There are plenty of patches in the links below to help with this work.
310
311[1] https://github.com/rkchrome/uboot.git
312[2] https://github.com/linux-rockchip/u-boot-rockchip.git branch u-boot-rk3288
313[3] https://github.com/linux-rockchip/rkflashtool.git
314[4] http://wiki.t-firefly.com/index.php/Firefly-RK3288/Serial_debug/en
315
316rkimage
317-------
318
319rkimage.c produces an SPL image suitable for sending directly to the boot ROM
320over USB OTG. This is a very simple format - just the string RK32 (as 4 bytes)
321followed by u-boot-spl-dtb.bin.
322
323The boot ROM loads image to 0xff704000 which is in the internal SRAM. The SRAM
324starts at 0xff700000 and extends to 0xff718000 where we put the stack.
325
326rksd
327----
328
329rksd.c produces an image consisting of 32KB of empty space, a header and
330u-boot-spl-dtb.bin. The header is defined by 'struct header0_info' although
331most of the fields are unused by U-Boot. We just need to specify the
332signature, a flag and the block offset and size of the SPL image.
333
334The header occupies a single block but we pad it out to 4 blocks. The header
335is encoding using RC4 with the key 7c4e0304550509072d2c7b38170d1711. The SPL
336image can be encoded too but we don't do that.
337
338The maximum size of u-boot-spl-dtb.bin which the boot ROM will read is 32KB,
339or 0x40 blocks. This is a severe and annoying limitation. There may be a way
340around this limitation, since there is plenty of SRAM, but at present the
341board refuses to boot if this limit is exceeded.
342
343The image produced is padded up to a block boundary (512 bytes). It should be
344written to the start of an SD card using dd.
345
346Since this image is set to load U-Boot from the SD card at block offset,
347CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, dd should be used to write
348u-boot-dtb.img to the SD card at that offset. See above for instructions.
349
350rkspi
351-----
352
353rkspi.c produces an image consisting of a header and u-boot-spl-dtb.bin. The
354resulting image is then spread out so that only the first 2KB of each 4KB
355sector is used. The header is the same as with rksd and the maximum size is
356also 32KB (before spreading). The image should be written to the start of
357SPI flash.
358
359See above for instructions on how to write a SPI image.
360
Simon Glass002c6342016-01-21 19:45:08 -0700361rkmux.py
362--------
363
364You can use this script to create #defines for SoC register access. See the
365script for usage.
366
Simon Glassadfb2bf2015-08-30 16:55:43 -0600367
368Device tree and driver model
369----------------------------
370
371Where possible driver model is used to provide a structure to the
372functionality. Device tree is used for configuration. However these have an
373overhead and in SPL with a 32KB size limit some shortcuts have been taken.
374In general all Rockchip drivers should use these features, with SPL-specific
375modifications where required.
376
Jacob Chen3f3e1e32016-10-08 13:47:42 +0800377GPT partition layout
378----------------------------
379
380Rockchip use a unified GPT partition layout in open source support.
381With this GPT partition layout, uboot can be compatilbe with other components,
382like miniloader, trusted-os, arm-trust-firmware.
383
384There are some documents about partitions in the links below.
385http://rockchip.wikidot.com/partitions
Simon Glassadfb2bf2015-08-30 16:55:43 -0600386
387--
388Simon Glass <sjg@chromium.org>
38924 June 2015