Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 1 | # |
| 2 | # Copyright (C) 2015 Google. Inc |
| 3 | # Written by Simon Glass <sjg@chromium.org> |
| 4 | # |
| 5 | # SPDX-License-Identifier: GPL-2.0+ |
| 6 | # |
| 7 | |
| 8 | U-Boot on Rockchip |
| 9 | ================== |
| 10 | |
| 11 | There are several repositories available with versions of U-Boot that support |
| 12 | many Rockchip devices [1] [2]. |
| 13 | |
| 14 | The current mainline support is experimental only and is not useful for |
| 15 | anything. It should provide a base on which to build. |
| 16 | |
Simon Glass | f138713 | 2016-01-21 19:45:25 -0700 | [diff] [blame] | 17 | So far only support for the RK3288 and RK3036 is provided. |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 18 | |
| 19 | |
| 20 | Prerequisites |
| 21 | ============= |
| 22 | |
| 23 | You will need: |
| 24 | |
Simon Glass | f138713 | 2016-01-21 19:45:25 -0700 | [diff] [blame] | 25 | - Firefly RK3288 board or something else with a supported RockChip SoC |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 26 | - Power connection to 5V using the supplied micro-USB power cable |
| 27 | - Separate USB serial cable attached to your computer and the Firefly |
| 28 | (connect to the micro-USB connector below the logo) |
| 29 | - rkflashtool [3] |
| 30 | - openssl (sudo apt-get install openssl) |
| 31 | - Serial UART connection [4] |
| 32 | - Suitable ARM cross compiler, e.g.: |
| 33 | sudo apt-get install gcc-4.7-arm-linux-gnueabi |
| 34 | |
| 35 | |
| 36 | Building |
| 37 | ======== |
| 38 | |
Wadim Egorov | a84b589 | 2017-06-19 12:36:41 +0200 | [diff] [blame] | 39 | At present nine RK3288 boards are supported: |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 40 | |
Xu Ziyuan | 744368d | 2016-07-05 18:06:30 +0800 | [diff] [blame] | 41 | - EVB RK3288 - use evb-rk3288 configuration |
jk.kernel@gmail.com | d7ca67b | 2016-07-26 18:28:29 +0800 | [diff] [blame] | 42 | - Fennec RK3288 - use fennec-rk3288 configuration |
Xu Ziyuan | 1c62d99 | 2016-08-01 08:46:19 +0800 | [diff] [blame] | 43 | - Firefly RK3288 - use firefly-rk3288 configuration |
| 44 | - Hisense Chromebook - use chromebook_jerry configuration |
Jernej Skrabec | 7da8680 | 2017-03-30 01:23:14 +0200 | [diff] [blame] | 45 | - MiQi RK3288 - use miqi-rk3288 configuration |
Wadim Egorov | a84b589 | 2017-06-19 12:36:41 +0200 | [diff] [blame] | 46 | - phyCORE-RK3288 RDK - use phycore-rk3288 configuration |
jk.kernel@gmail.com | dd63fbc | 2016-07-26 18:28:30 +0800 | [diff] [blame] | 47 | - PopMetal RK3288 - use popmetal-rk3288 configuration |
Xu Ziyuan | 1c62d99 | 2016-08-01 08:46:19 +0800 | [diff] [blame] | 48 | - Radxa Rock 2 - use rock2 configuration |
Jernej Skrabec | 43b5c78 | 2017-03-30 01:23:13 +0200 | [diff] [blame] | 49 | - Tinker RK3288 - use tinker-rk3288 configuration |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 50 | |
Simon Glass | f138713 | 2016-01-21 19:45:25 -0700 | [diff] [blame] | 51 | Two RK3036 board are supported: |
huang lin | 1d5a696 | 2015-11-17 14:20:31 +0800 | [diff] [blame] | 52 | |
Simon Glass | f138713 | 2016-01-21 19:45:25 -0700 | [diff] [blame] | 53 | - EVB RK3036 - use evb-rk3036 configuration |
| 54 | - Kylin - use kylin_rk3036 configuration |
huang lin | 1d5a696 | 2015-11-17 14:20:31 +0800 | [diff] [blame] | 55 | |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 56 | For example: |
| 57 | |
| 58 | CROSS_COMPILE=arm-linux-gnueabi- make O=firefly firefly-rk3288_defconfig all |
| 59 | |
| 60 | (or you can use another cross compiler if you prefer) |
| 61 | |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 62 | |
| 63 | Writing to the board with USB |
| 64 | ============================= |
| 65 | |
| 66 | For USB to work you must get your board into ROM boot mode, either by erasing |
| 67 | your MMC or (perhaps) holding the recovery button when you boot the board. |
| 68 | To erase your MMC, you can boot into Linux and type (as root) |
| 69 | |
| 70 | dd if=/dev/zero of=/dev/mmcblk0 bs=1M |
| 71 | |
| 72 | Connect your board's OTG port to your computer. |
| 73 | |
| 74 | To create a suitable image and write it to the board: |
| 75 | |
Jeffy Chen | 717f884 | 2015-11-27 12:07:18 +0800 | [diff] [blame] | 76 | ./firefly-rk3288/tools/mkimage -n rk3288 -T rkimage -d \ |
Simon Glass | f2acc55e | 2015-08-30 16:55:52 -0600 | [diff] [blame] | 77 | ./firefly-rk3288/spl/u-boot-spl-dtb.bin out && \ |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 78 | cat out | openssl rc4 -K 7c4e0304550509072d2c7b38170d1711 | rkflashtool l |
| 79 | |
| 80 | If all goes well you should something like: |
| 81 | |
| 82 | U-Boot SPL 2015.07-rc1-00383-ge345740-dirty (Jun 03 2015 - 10:06:49) |
| 83 | Card did not respond to voltage select! |
| 84 | spl: mmc init failed with error: -17 |
| 85 | ### ERROR ### Please RESET the board ### |
| 86 | |
| 87 | You will need to reset the board before each time you try. Yes, that's all |
| 88 | it does so far. If support for the Rockchip USB protocol or DFU were added |
| 89 | in SPL then we could in principle load U-Boot and boot to a prompt from USB |
| 90 | as several other platforms do. However it does not seem to be possible to |
| 91 | use the existing boot ROM code from SPL. |
| 92 | |
| 93 | |
| 94 | Booting from an SD card |
| 95 | ======================= |
| 96 | |
| 97 | To write an image that boots from an SD card (assumed to be /dev/sdc): |
| 98 | |
Jeffy Chen | 717f884 | 2015-11-27 12:07:18 +0800 | [diff] [blame] | 99 | ./firefly-rk3288/tools/mkimage -n rk3288 -T rksd -d \ |
Simon Glass | f2acc55e | 2015-08-30 16:55:52 -0600 | [diff] [blame] | 100 | firefly-rk3288/spl/u-boot-spl-dtb.bin out && \ |
| 101 | sudo dd if=out of=/dev/sdc seek=64 && \ |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 102 | sudo dd if=firefly-rk3288/u-boot-dtb.img of=/dev/sdc seek=256 |
| 103 | |
| 104 | This puts the Rockchip header and SPL image first and then places the U-Boot |
| 105 | image at block 256 (i.e. 128KB from the start of the SD card). This |
| 106 | corresponds with this setting in U-Boot: |
| 107 | |
| 108 | #define CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR 256 |
| 109 | |
| 110 | Put this SD (or micro-SD) card into your board and reset it. You should see |
| 111 | something like: |
| 112 | |
Simon Glass | f138713 | 2016-01-21 19:45:25 -0700 | [diff] [blame] | 113 | U-Boot 2016.01-rc2-00309-ge5bad3b-dirty (Jan 02 2016 - 23:41:59 -0700) |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 114 | |
Simon Glass | f138713 | 2016-01-21 19:45:25 -0700 | [diff] [blame] | 115 | Model: Radxa Rock 2 Square |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 116 | DRAM: 2 GiB |
Simon Glass | f138713 | 2016-01-21 19:45:25 -0700 | [diff] [blame] | 117 | MMC: dwmmc@ff0f0000: 0, dwmmc@ff0c0000: 1 |
| 118 | *** Warning - bad CRC, using default environment |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 119 | |
Simon Glass | f138713 | 2016-01-21 19:45:25 -0700 | [diff] [blame] | 120 | In: serial |
| 121 | Out: vop@ff940000.vidconsole |
| 122 | Err: serial |
| 123 | Net: Net Initialization Skipped |
| 124 | No ethernet found. |
| 125 | Hit any key to stop autoboot: 0 |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 126 | => |
| 127 | |
Xu Ziyuan | b47ea79 | 2016-07-12 19:09:49 +0800 | [diff] [blame] | 128 | The rockchip bootrom can load and boot an initial spl, then continue to |
| 129 | load a second-level bootloader(ie. U-BOOT) as soon as it returns to bootrom. |
| 130 | Therefore RK3288 has another loading sequence like RK3036. The option of |
| 131 | U-Boot is controlled with this setting in U-Boot: |
| 132 | |
Philipp Tomsich | ee14d29 | 2017-06-29 11:21:15 +0200 | [diff] [blame] | 133 | #define CONFIG_SPL_ROCKCHIP_BACK_TO_BROM |
Xu Ziyuan | b47ea79 | 2016-07-12 19:09:49 +0800 | [diff] [blame] | 134 | |
| 135 | You can create the image via the following operations: |
| 136 | |
| 137 | ./firefly-rk3288/tools/mkimage -n rk3288 -T rksd -d \ |
| 138 | firefly-rk3288/spl/u-boot-spl-dtb.bin out && \ |
| 139 | cat firefly-rk3288/u-boot-dtb.bin >> out && \ |
| 140 | sudo dd if=out of=/dev/sdc seek=64 |
| 141 | |
Simon Glass | f138713 | 2016-01-21 19:45:25 -0700 | [diff] [blame] | 142 | If you have an HDMI cable attached you should see a video console. |
| 143 | |
huang lin | 1d5a696 | 2015-11-17 14:20:31 +0800 | [diff] [blame] | 144 | For evb_rk3036 board: |
Jeffy Chen | 717f884 | 2015-11-27 12:07:18 +0800 | [diff] [blame] | 145 | ./evb-rk3036/tools/mkimage -n rk3036 -T rksd -d evb-rk3036/spl/u-boot-spl.bin out && \ |
huang lin | 1d5a696 | 2015-11-17 14:20:31 +0800 | [diff] [blame] | 146 | cat evb-rk3036/u-boot-dtb.bin >> out && \ |
| 147 | sudo dd if=out of=/dev/sdc seek=64 |
| 148 | |
| 149 | Note: rk3036 SDMMC and debug uart use the same iomux, so if you boot from SD, the |
| 150 | debug uart must be disabled |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 151 | |
Heiko Stübner | f46b859 | 2017-03-24 00:41:34 +0100 | [diff] [blame] | 152 | |
Jagan Teki | 532cb7f | 2017-09-27 23:03:12 +0530 | [diff] [blame^] | 153 | Booting from an SD card on RK3288 with TPL |
| 154 | ========================================== |
| 155 | |
| 156 | Since the size of SPL can't be exceeded 0x8000 bytes in RK3288, it is not possible add |
| 157 | new SPL features like Falcon mode or etc. |
| 158 | |
| 159 | So introduce TPL so-that adding new features to SPL is possible because now TPL should |
| 160 | run minimal with code like DDR, clock etc and rest of new features in SPL. |
| 161 | |
| 162 | As of now TPL is added on Vyasa-RK3288 board. |
| 163 | |
| 164 | To write an image that boots from an SD card (assumed to be /dev/mmcblk0): |
| 165 | |
| 166 | ./tools/mkimage -n rk3288 -T rksd -d ./tpl/u-boot-tpl.bin out && |
| 167 | cat ./spl/u-boot-spl-dtb.bin >> out && |
| 168 | sudo dd if=out of=/dev/mmcblk0 seek=64 && |
| 169 | sudo dd if=u-boot-dtb.img of=/dev/mmcblk0 seek=256 |
| 170 | |
Heiko Stübner | f46b859 | 2017-03-24 00:41:34 +0100 | [diff] [blame] | 171 | Booting from an SD card on RK3188 |
| 172 | ================================= |
| 173 | |
| 174 | For rk3188 boards the general storage onto the card stays the same as |
| 175 | described above, but the image creation needs a bit more care. |
| 176 | |
| 177 | The bootrom of rk3188 expects to find a small 1kb loader which returns |
| 178 | control to the bootrom, after which it will load the real loader, which |
| 179 | can then be up to 29kb in size and does the regular ddr init. |
| 180 | |
| 181 | Additionally the rk3188 requires everything the bootrom loads to be |
| 182 | rc4-encrypted. Except for the very first stage the bootrom always reads |
| 183 | and decodes 2kb pages, so files should be sized accordingly. |
| 184 | |
| 185 | # copy tpl, pad to 1020 bytes and append spl |
| 186 | cat tpl/u-boot-tpl.bin > tplspl.bin |
| 187 | truncate -s 1020 tplspl.bin |
| 188 | cat spl/u-boot-spl.bin >> tplspl.bin |
| 189 | tools/mkimage -n rk3188 -T rksd -d tplspl.bin out |
| 190 | |
| 191 | # truncate, encode and append u-boot.bin |
| 192 | truncate -s %2048 u-boot.bin |
| 193 | cat u-boot.bin | split -b 512 --filter='openssl rc4 -K 7C4E0304550509072D2C7B38170D1711' >> out |
| 194 | |
| 195 | |
Xu Ziyuan | a16e2e0 | 2016-07-18 09:56:46 +0800 | [diff] [blame] | 196 | Using fastboot on rk3288 |
| 197 | ======================== |
Xu Ziyuan | a16e2e0 | 2016-07-18 09:56:46 +0800 | [diff] [blame] | 198 | - Write GPT partition layout to mmc device which fastboot want to use it to |
| 199 | store the image |
| 200 | |
| 201 | => gpt write mmc 1 $partitions |
| 202 | |
| 203 | - Invoke fastboot command to prepare |
| 204 | |
| 205 | => fastboot 1 |
| 206 | |
| 207 | - Start fastboot request on PC |
| 208 | |
| 209 | fastboot -i 0x2207 flash loader evb-rk3288/spl/u-boot-spl-dtb.bin |
| 210 | |
| 211 | You should see something like: |
| 212 | |
| 213 | => fastboot 1 |
| 214 | WARNING: unknown variable: partition-type:loader |
| 215 | Starting download of 357796 bytes |
| 216 | .. |
| 217 | downloading of 357796 bytes finished |
| 218 | Flashing Raw Image |
| 219 | ........ wrote 357888 bytes to 'loader' |
| 220 | |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 221 | Booting from SPI |
| 222 | ================ |
| 223 | |
| 224 | To write an image that boots from SPI flash (e.g. for the Haier Chromebook): |
| 225 | |
Simon Glass | dd8e429 | 2015-12-29 05:22:45 -0700 | [diff] [blame] | 226 | ./chromebook_jerry/tools/mkimage -n rk3288 -T rkspi \ |
| 227 | -d chromebook_jerry/spl/u-boot-spl-dtb.bin spl.bin && \ |
| 228 | dd if=spl.bin of=spl-out.bin bs=128K conv=sync && \ |
| 229 | cat spl-out.bin chromebook_jerry/u-boot-dtb.img >out.bin && \ |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 230 | dd if=out.bin of=out.bin.pad bs=4M conv=sync |
| 231 | |
| 232 | This converts the SPL image to the required SPI format by adding the Rockchip |
| 233 | header and skipping every 2KB block. Then the U-Boot image is written at |
| 234 | offset 128KB and the whole image is padded to 4MB which is the SPI flash size. |
| 235 | The position of U-Boot is controlled with this setting in U-Boot: |
| 236 | |
| 237 | #define CONFIG_SYS_SPI_U_BOOT_OFFS (128 << 10) |
| 238 | |
| 239 | If you have a Dediprog em100pro connected then you can write the image with: |
| 240 | |
| 241 | sudo em100 -s -c GD25LQ32 -d out.bin.pad -r |
| 242 | |
| 243 | When booting you should see something like: |
| 244 | |
| 245 | U-Boot SPL 2015.07-rc2-00215-g9a58220-dirty (Jun 23 2015 - 12:11:32) |
| 246 | |
| 247 | |
| 248 | U-Boot 2015.07-rc2-00215-g9a58220-dirty (Jun 23 2015 - 12:11:32 -0600) |
| 249 | |
| 250 | Model: Google Jerry |
| 251 | DRAM: 2 GiB |
| 252 | MMC: |
| 253 | Using default environment |
| 254 | |
| 255 | In: serial@ff690000 |
| 256 | Out: serial@ff690000 |
| 257 | Err: serial@ff690000 |
| 258 | => |
| 259 | |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 260 | Future work |
| 261 | =========== |
| 262 | |
| 263 | Immediate priorities are: |
| 264 | |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 265 | - USB host |
| 266 | - USB device |
Simon Glass | f138713 | 2016-01-21 19:45:25 -0700 | [diff] [blame] | 267 | - Run CPU at full speed (code exists but we only see ~60 DMIPS maximum) |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 268 | - NAND flash |
| 269 | - Support for other Rockchip parts |
| 270 | - Boot U-Boot proper over USB OTG (at present only SPL works) |
| 271 | |
| 272 | |
| 273 | Development Notes |
| 274 | ================= |
| 275 | |
| 276 | There are plenty of patches in the links below to help with this work. |
| 277 | |
| 278 | [1] https://github.com/rkchrome/uboot.git |
| 279 | [2] https://github.com/linux-rockchip/u-boot-rockchip.git branch u-boot-rk3288 |
| 280 | [3] https://github.com/linux-rockchip/rkflashtool.git |
| 281 | [4] http://wiki.t-firefly.com/index.php/Firefly-RK3288/Serial_debug/en |
| 282 | |
| 283 | rkimage |
| 284 | ------- |
| 285 | |
| 286 | rkimage.c produces an SPL image suitable for sending directly to the boot ROM |
| 287 | over USB OTG. This is a very simple format - just the string RK32 (as 4 bytes) |
| 288 | followed by u-boot-spl-dtb.bin. |
| 289 | |
| 290 | The boot ROM loads image to 0xff704000 which is in the internal SRAM. The SRAM |
| 291 | starts at 0xff700000 and extends to 0xff718000 where we put the stack. |
| 292 | |
| 293 | rksd |
| 294 | ---- |
| 295 | |
| 296 | rksd.c produces an image consisting of 32KB of empty space, a header and |
| 297 | u-boot-spl-dtb.bin. The header is defined by 'struct header0_info' although |
| 298 | most of the fields are unused by U-Boot. We just need to specify the |
| 299 | signature, a flag and the block offset and size of the SPL image. |
| 300 | |
| 301 | The header occupies a single block but we pad it out to 4 blocks. The header |
| 302 | is encoding using RC4 with the key 7c4e0304550509072d2c7b38170d1711. The SPL |
| 303 | image can be encoded too but we don't do that. |
| 304 | |
| 305 | The maximum size of u-boot-spl-dtb.bin which the boot ROM will read is 32KB, |
| 306 | or 0x40 blocks. This is a severe and annoying limitation. There may be a way |
| 307 | around this limitation, since there is plenty of SRAM, but at present the |
| 308 | board refuses to boot if this limit is exceeded. |
| 309 | |
| 310 | The image produced is padded up to a block boundary (512 bytes). It should be |
| 311 | written to the start of an SD card using dd. |
| 312 | |
| 313 | Since this image is set to load U-Boot from the SD card at block offset, |
| 314 | CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, dd should be used to write |
| 315 | u-boot-dtb.img to the SD card at that offset. See above for instructions. |
| 316 | |
| 317 | rkspi |
| 318 | ----- |
| 319 | |
| 320 | rkspi.c produces an image consisting of a header and u-boot-spl-dtb.bin. The |
| 321 | resulting image is then spread out so that only the first 2KB of each 4KB |
| 322 | sector is used. The header is the same as with rksd and the maximum size is |
| 323 | also 32KB (before spreading). The image should be written to the start of |
| 324 | SPI flash. |
| 325 | |
| 326 | See above for instructions on how to write a SPI image. |
| 327 | |
Simon Glass | 002c634 | 2016-01-21 19:45:08 -0700 | [diff] [blame] | 328 | rkmux.py |
| 329 | -------- |
| 330 | |
| 331 | You can use this script to create #defines for SoC register access. See the |
| 332 | script for usage. |
| 333 | |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 334 | |
| 335 | Device tree and driver model |
| 336 | ---------------------------- |
| 337 | |
| 338 | Where possible driver model is used to provide a structure to the |
| 339 | functionality. Device tree is used for configuration. However these have an |
| 340 | overhead and in SPL with a 32KB size limit some shortcuts have been taken. |
| 341 | In general all Rockchip drivers should use these features, with SPL-specific |
| 342 | modifications where required. |
| 343 | |
Jacob Chen | 3f3e1e3 | 2016-10-08 13:47:42 +0800 | [diff] [blame] | 344 | GPT partition layout |
| 345 | ---------------------------- |
| 346 | |
| 347 | Rockchip use a unified GPT partition layout in open source support. |
| 348 | With this GPT partition layout, uboot can be compatilbe with other components, |
| 349 | like miniloader, trusted-os, arm-trust-firmware. |
| 350 | |
| 351 | There are some documents about partitions in the links below. |
| 352 | http://rockchip.wikidot.com/partitions |
Simon Glass | adfb2bf | 2015-08-30 16:55:43 -0600 | [diff] [blame] | 353 | |
| 354 | -- |
| 355 | Simon Glass <sjg@chromium.org> |
| 356 | 24 June 2015 |