Merge branch 'master' of git://git.denx.de/u-boot-sh
[oweals/u-boot.git] / doc / README.rockchip
1 # SPDX-License-Identifier: GPL-2.0+
2 #
3 # Copyright (C) 2015 Google. Inc
4 # Written by Simon Glass <sjg@chromium.org>
5
6 U-Boot on Rockchip
7 ==================
8
9 A wide range of Rockchip SoCs are supported in mainline U-Boot
10
11
12 Prerequisites
13 =============
14
15 You will need:
16
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)
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
28 Building
29 ========
30
31 At present 11 RK3288 boards are supported:
32
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
44
45 Two RK3036 boards are supported:
46
47    - EVB RK3036 - use evb-rk3036 configuration
48    - Kylin - use kylin_rk3036 configuration
49
50 Two RK3308 boards are supported:
51
52    - EVB RK3308 - use evb-rk3308 configuration
53    - ROC-CC-RK3308 - use roc-rk3308-cc configuration
54
55 Two RK3328 board are supported:
56
57    - EVB RK3328 - use evb-rk3328_defconfig
58    - Pine64 Rock64 board - use rock64-rk3328_defconfig
59
60 Size RK3399 boards are supported (aarch64):
61
62    - EBV RK3399 - use evb_rk3399 configuration
63    - Firefly RK3399 - use the firefly_rk3399 configuration
64    - Puma - use puma_rk3399 configuration
65    - Ficus - use ficus-rk3399 configuration
66    - Rock960 (Vamrs) - use rock960-rk3399 configuration
67    - Bob - use chromebook_bob configuration
68
69 Four RK3368 boards are supported:
70
71    - Sheep - use sheep-rk3368 configuration
72    - Lion - use lion-rk3368 configuration
73    - Geekbox - use geekbox configuration
74    - EVB PX5 - use evb-px5  configuration
75
76 One RK3128 board is supported:
77
78    - EVB RK3128 - use evb-rk3128 configuration
79
80 One RK3229 board is supported:
81
82    - EVB RK3229 - use evb-rk3229 configuration
83
84 Two RV1108 boards are supported:
85
86    - EVB RV1108 - use evb-rv1108 configuration
87    - Elgin R1 - use elgin-rv1108 configuration
88
89 One RV3188 baord is supported:
90
91    - Raxda Rock - use rock configuration
92
93
94 For example:
95
96 1. To build RK3288 board:
97
98    CROSS_COMPILE=arm-linux-gnueabi- make O=firefly firefly-rk3288_defconfig all
99
100     (or you can use another cross compiler if you prefer)
101
102 2. To build RK3308 board:
103    - Get the rkbin
104      => git clone https://github.com/rockchip-linux/rkbin.git
105
106    - Compile U-Boot
107      => cd /path/to/u-boot
108      => export BL31=/path/to/rkbin/bin/rk33/rk3308_bl31_v2.22.elf
109      => make roc-rk3308-cc_defconfig
110      => make CROSS_COMPILE=aarch64-linux-gnu- all
111      => make CROSS_COMPILE=aarch64-linux-gnu- u-boot.itb
112      => ./tools/mkimage -n rk3308 -T rksd -d /path/to/rkbin/bin/rk33/rk3308_ddr_589MHz_uart2_m0_v1.26.bin idbloader.img
113      => cat spl/u-boot-spl.bin  >> idbloader.img
114
115 3. To build RK3399 board:
116
117    Option 1: Package the image with Rockchip miniloader:
118
119    - Compile U-Boot
120
121      => cd /path/to/u-boot
122      => make nanopi-neo4-rk3399_defconfig
123      => make
124
125    - Get the rkbin
126
127      => git clone https://github.com/rockchip-linux/rkbin.git
128
129    - Create trust.img
130
131      => cd /path/to/rkbin
132      => ./tools/trust_merger RKTRUST/RK3399TRUST.ini
133
134    - Create uboot.img
135
136      => cd /path/to/rkbin
137      => ./tools/loaderimage --pack --uboot /path/to/u-boot/u-boot-dtb.bin uboot.img
138
139      (Get trust.img and uboot.img)
140
141    Option 2: Package the image with SPL:
142
143    - Export cross compiler path for aarch64
144
145    - Compile ATF
146
147      For Puma board.
148
149         => git clone git://git.theobroma-systems.com/arm-trusted-firmware.git
150         => cd arm-trusted-firmware
151         => make CROSS_COMPILE=aarch64-linux-gnu- PLAT=rk3399 bl31
152
153         (export bl31.bin)
154         => export BL31=/path/to/arm-trusted-firmware/build/rk3399/release/bl31/bl31.bin
155
156      For rest of rk3399 boards.
157
158         => git clone https://github.com/ARM-software/arm-trusted-firmware.git
159         => cd arm-trusted-firmware
160
161         (export cross compiler path for Cortex-M0 MCU likely arm-none-eabi-)
162         => make realclean
163         => make CROSS_COMPILE=aarch64-linux-gnu- PLAT=rk3399
164
165         (export bl31.elf)
166         => export BL31=/path/to/arm-trusted-firmware/build/rk3399/release/bl31/bl31.elf
167
168    - Compile PMU M0 firmware
169
170      This is optional for most of the rk3399 boards and required only for Puma board.
171
172      => git clone git://git.theobroma-systems.com/rk3399-cortex-m0.git
173      => cd rk3399-cortex-m0
174
175      (export cross compiler path for Cortex-M0 PMU)
176      => make CROSS_COMPILE=arm-cortex_m0-eabi-
177
178      (export rk3399m0.bin)
179      => export PMUM0=/path/to/rk3399-cortex-m0/rk3399m0.bin
180
181    - Compile U-Boot
182
183      => cd /path/to/u-boot
184      => make orangepi-rk3399_defconfig
185      => make
186
187      (Get spl/u-boot-spl-dtb.bin, u-boot.itb images and some boards would get
188       spl/u-boot-spl.bin since it doesn't enable CONFIG_SPL_OF_CONTROL
189
190       If TPL enabled on the target, get tpl/u-boot-tpl-dtb.bin or tpl/u-boot-tpl.bin
191       if CONFIG_TPL_OF_CONTROL not enabled)
192
193 Writing to the board with USB
194 =============================
195
196 For USB to work you must get your board into ROM boot mode, either by erasing
197 your MMC or (perhaps) holding the recovery button when you boot the board.
198 To erase your MMC, you can boot into Linux and type (as root)
199
200    dd if=/dev/zero of=/dev/mmcblk0 bs=1M
201
202 Connect your board's OTG port to your computer.
203
204 To create a suitable image and write it to the board:
205
206    ./firefly-rk3288/tools/mkimage -n rk3288 -T rkimage -d \
207         ./firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
208    cat out | openssl rc4 -K 7c4e0304550509072d2c7b38170d1711 | rkflashtool l
209
210 If all goes well you should something like:
211
212    U-Boot SPL 2015.07-rc1-00383-ge345740-dirty (Jun 03 2015 - 10:06:49)
213    Card did not respond to voltage select!
214    spl: mmc init failed with error: -17
215    ### ERROR ### Please RESET the board ###
216
217 You will need to reset the board before each time you try. Yes, that's all
218 it does so far. If support for the Rockchip USB protocol or DFU were added
219 in SPL then we could in principle load U-Boot and boot to a prompt from USB
220 as several other platforms do. However it does not seem to be possible to
221 use the existing boot ROM code from SPL.
222
223
224 Writing to the eMMC with USB on ROC-RK3308-CC
225 =============================================
226 For USB to work you must get your board into Bootrom mode,
227 either by erasing the eMMC or short circuit the GND and D0
228 on core board.
229
230 Connect the board to your computer via tyepc.
231 => rkdeveloptool db rk3308_loader_v1.26.117.bin
232 => rkdeveloptool wl 0x40 idbloader.img
233 => rkdeveloptool wl 0x4000 u-boot.itb
234 => rkdeveloptool rd
235
236 Then you will see the boot log from Debug UART at baud rate 1500000:
237 DDR Version V1.26
238 REGFB: 0x00000032, 0x00000032
239 In
240 589MHz
241 DDR3
242  Col=10 Bank=8 Row=14 Size=256MB
243 msch:1
244 Returning to boot ROM...
245
246 U-Boot SPL 2020.01-rc1-00225-g34b681327f (Nov 14 2019 - 10:58:04 +0800)
247 Trying to boot from MMC1
248 INFO:    Preloader serial: 2
249 NOTICE:  BL31: v1.3(release):30f1405
250 NOTICE:  BL31: Built : 17:08:28, Sep 23 2019
251 INFO:    Lastlog: last=0x100000, realtime=0x102000, size=0x2000
252 INFO:    ARM GICv2 driver initialized
253 INFO:    Using opteed sec cpu_context!
254 INFO:    boot cpu mask: 1
255 INFO:    plat_rockchip_pmu_init: pd status 0xe b
256 INFO:    BL31: Initializing runtime services
257 WARNING: No OPTEE provided by BL2 boot loader, Booting device without OPTEE initialization. SMC`s destined for OPTEE will rK
258 ERROR:   Error initializing runtime service opteed_fast
259 INFO:    BL31: Preparing for EL3 exit to normal world
260 INFO:    Entry point address = 0x600000
261 INFO:    SPSR = 0x3c9
262
263
264 U-Boot 2020.01-rc1-00225-g34b681327f (Nov 14 2019 - 10:58:47 +0800)
265
266 Model: Firefly ROC-RK3308-CC board
267 DRAM:  254 MiB
268 MMC:   dwmmc@ff480000: 0, dwmmc@ff490000: 1
269 rockchip_dnl_key_pressed read adc key val failed
270 Net:   No ethernet found.
271 Hit any key to stop autoboot:  0
272 Card did not respond to voltage select!
273 switch to partitions #0, OK
274 mmc1(part 0) is current device
275 Scanning mmc 1:4...
276 Found /extlinux/extlinux.conf
277 Retrieving file: /extlinux/extlinux.conf
278 151 bytes read in 3 ms (48.8 KiB/s)
279 1:      kernel-mainline
280 Retrieving file: /Image
281 14737920 bytes read in 377 ms (37.3 MiB/s)
282 append: earlycon=uart8250,mmio32,0xff0c0000 console=ttyS2,1500000n8
283 Retrieving file: /rk3308-roc-cc.dtb
284 28954 bytes read in 4 ms (6.9 MiB/s)
285 Flattened Device Tree blob at 01f00000
286 Booting using the fdt blob at 0x1f00000
287 ## Loading Device Tree to 000000000df3a000, end 000000000df44119 ... OK
288
289 Starting kernel ...
290 [    0.000000] Booting Linux on physical CPU 0x0000000000 [0x410fd042]
291 [    0.000000] Linux version 5.4.0-rc1-00040-g4dc2d508fa47-dirty (andy@B150) (gcc version 6.3.1 20170404 (Linaro GCC 6.3-209
292 [    0.000000] Machine model: Firefly ROC-RK3308-CC board
293 [    0.000000] earlycon: uart8250 at MMIO32 0x00000000ff0c0000 (options '')
294 [    0.000000] printk: bootconsole [uart8250] enabled
295
296 Booting from an SD card
297 =======================
298
299 To write an image that boots from an SD card (assumed to be /dev/sdc):
300
301    ./firefly-rk3288/tools/mkimage -n rk3288 -T rksd -d \
302         firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
303    sudo dd if=out of=/dev/sdc seek=64 && \
304    sudo dd if=firefly-rk3288/u-boot-dtb.img of=/dev/sdc seek=16384
305
306 This puts the Rockchip header and SPL image first and then places the U-Boot
307 image at block 16384 (i.e. 8MB from the start of the SD card). This
308 corresponds with this setting in U-Boot:
309
310    #define CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR      0x4000
311
312 Put this SD (or micro-SD) card into your board and reset it. You should see
313 something like:
314
315    U-Boot 2016.01-rc2-00309-ge5bad3b-dirty (Jan 02 2016 - 23:41:59 -0700)
316
317    Model: Radxa Rock 2 Square
318    DRAM:  2 GiB
319    MMC:   dwmmc@ff0f0000: 0, dwmmc@ff0c0000: 1
320    *** Warning - bad CRC, using default environment
321
322    In:    serial
323    Out:   vop@ff940000.vidconsole
324    Err:   serial
325    Net:   Net Initialization Skipped
326    No ethernet found.
327    Hit any key to stop autoboot:  0
328    =>
329
330 The rockchip bootrom can load and boot an initial spl, then continue to
331 load a second-stage bootloader (ie. U-Boot) as soon as the control is returned
332 to the bootrom. Both the RK3288 and the RK3036 use this special boot sequence.
333 The configuration option enabling this is:
334
335         CONFIG_SPL_ROCKCHIP_BACK_TO_BROM=y
336
337 You can create the image via the following operations:
338
339    ./firefly-rk3288/tools/mkimage -n rk3288 -T rksd -d \
340         firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
341    cat firefly-rk3288/u-boot-dtb.bin >> out && \
342    sudo dd if=out of=/dev/sdc seek=64
343
344 If you have an HDMI cable attached you should see a video console.
345
346 For evb_rk3036 board:
347         ./evb-rk3036/tools/mkimage -n rk3036 -T rksd  -d evb-rk3036/spl/u-boot-spl.bin out && \
348         cat evb-rk3036/u-boot-dtb.bin >> out && \
349         sudo dd if=out of=/dev/sdc seek=64
350
351 Note: rk3036 SDMMC and debug uart use the same iomux, so if you boot from SD, the
352       debug uart must be disabled
353
354
355 Booting from an SD card on RK3288 with TPL
356 ==========================================
357
358 Since the size of SPL can't be exceeded 0x8000 bytes in RK3288, it is not possible add
359 new SPL features like Falcon mode or etc.
360
361 So introduce TPL so-that adding new features to SPL is possible because now TPL should
362 run minimal with code like DDR, clock etc and rest of new features in SPL.
363
364 As of now TPL is added on Vyasa-RK3288 board.
365
366 To write an image that boots from an SD card (assumed to be /dev/mmcblk0):
367
368     sudo dd if=idbloader.img of=/dev/mmcblk0 seek=64 &&
369     sudo dd if=u-boot-dtb.img of=/dev/mmcblk0 seek=16384
370
371 Booting from an SD card on RK3188
372 =================================
373
374 For rk3188 boards the general storage onto the card stays the same as
375 described above, but the image creation needs a bit more care.
376
377 The bootrom of rk3188 expects to find a small 1kb loader which returns
378 control to the bootrom, after which it will load the real loader, which
379 can then be up to 29kb in size and does the regular ddr init.  This is
380 handled by a single image (built as the SPL stage) that tests whether
381 it is handled for the first or second time via code executed from the
382 boot0-hook.
383
384 Additionally the rk3188 requires everything the bootrom loads to be
385 rc4-encrypted. Except for the very first stage the bootrom always reads
386 and decodes 2kb pages, so files should be sized accordingly.
387
388 # copy tpl, pad to 1020 bytes and append spl
389 tools/mkimage -n rk3188 -T rksd -d spl/u-boot-spl.bin out
390
391 # truncate, encode and append u-boot.bin
392 truncate -s %2048 u-boot.bin
393 cat u-boot.bin | split -b 512 --filter='openssl rc4 -K 7C4E0304550509072D2C7B38170D1711' >> out
394
395 Booting from an SD card on Pine64 Rock64 (RK3328)
396 =================================================
397
398 For Rock64 rk3328 board the following three parts are required:
399 TPL, SPL, and the u-boot image tree blob.
400
401   - Write TPL/SPL image at 64 sector
402
403     => sudo dd if=idbloader.img of=/dev/mmcblk0 seek=64
404
405   - Write u-boot image tree blob at 16384 sector
406
407     => sudo dd if=u-boot.itb of=/dev/mmcblk0 seek=16384
408
409 Booting from an SD card on RK3399
410 =================================
411
412 To write an image that boots from an SD card (assumed to be /dev/sdc):
413
414 Option 1: Package the image with Rockchip miniloader:
415
416   - Create idbloader.img
417
418     => cd /path/to/u-boot
419     => ./tools/mkimage  -n rk3399 -T rksd -d /path/to/rkbin/bin/rk33/rk3399_ddr_800MHz_v1.20.bin idbloader.img
420     => cat /path/to/rkbin/bin/rk33/rk3399_miniloader_v1.19.bin >> idbloader.img
421
422   - Write idbloader.img at 64 sector
423
424     => sudo dd if=idbloader.img of=/dev/sdc seek=64
425
426   - Write trust.img at 24576
427
428     => sudo dd if=trust.img of=/dev/sdc seek=24576
429
430   - Write uboot.img at 16384 sector
431
432     => sudo dd if=uboot.img of=/dev/sdc seek=16384
433     => sync
434
435 Put this SD (or micro-SD) card into your board and reset it. You should see
436 something like:
437
438 DDR Version 1.20 20190314
439 In
440 Channel 0: DDR3, 933MHz
441 Bus Width=32 Col=10 Bank=8 Row=15 CS=1 Die Bus-Width=16 Size=1024MB
442 no stride
443 ch 0 ddrconfig = 0x101, ddrsize = 0x20
444 pmugrf_os_reg[2] = 0x10006281, stride = 0x17
445 OUT
446 Boot1: 2019-03-14, version: 1.19
447 CPUId = 0x0
448 ChipType = 0x10, 239
449 mmc: ERROR: SDHCI ERR:cmd:0x102,stat:0x18000
450 mmc: ERROR: Card did not respond to voltage select!
451 emmc reinit
452 mmc: ERROR: SDHCI ERR:cmd:0x102,stat:0x18000
453 mmc: ERROR: Card did not respond to voltage select!
454 emmc reinit
455 mmc: ERROR: SDHCI ERR:cmd:0x102,stat:0x18000
456 mmc: ERROR: Card did not respond to voltage select!
457 SdmmcInit=2 1
458 mmc0:cmd5,20
459 SdmmcInit=0 0
460 BootCapSize=0
461 UserCapSize=60543MB
462 FwPartOffset=2000 , 0
463 StorageInit ok = 45266
464 SecureMode = 0
465 SecureInit read PBA: 0x4
466 SecureInit read PBA: 0x404
467 SecureInit read PBA: 0x804
468 SecureInit read PBA: 0xc04
469 SecureInit read PBA: 0x1004
470 SecureInit read PBA: 0x1404
471 SecureInit read PBA: 0x1804
472 SecureInit read PBA: 0x1c04
473 SecureInit ret = 0, SecureMode = 0
474 atags_set_bootdev: ret:(0)
475 GPT 0x3380ec0 signature is wrong
476 recovery gpt...
477 GPT 0x3380ec0 signature is wrong
478 recovery gpt fail!
479 LoadTrust Addr:0x4000
480 No find bl30.bin
481 Load uboot, ReadLba = 2000
482 hdr 0000000003380880 + 0x0:0x88,0x41,0x3e,0x97,0xe6,0x61,0x54,0x23,0xe9,0x5a,0xd1,0x2b,0xdc,0x2f,0xf9,0x35,
483
484 Load OK, addr=0x200000, size=0x9c9c0
485 RunBL31 0x10000
486 NOTICE:  BL31: v1.3(debug):370ab80
487 NOTICE:  BL31: Built : 09:23:41, Mar  4 2019
488 NOTICE:  BL31: Rockchip release version: v1.1
489 INFO:    GICv3 with legacy support detected. ARM GICV3 driver initialized in EL3
490 INFO:    Using opteed sec cpu_context!
491 INFO:    boot cpu mask: 0
492 INFO:    plat_rockchip_pmu_init(1181): pd status 3e
493 INFO:    BL31: Initializing runtime services
494 INFO:    BL31: Initializing BL32
495 INF [0x0] TEE-CORE:init_primary_helper:337: Initializing (1.1.0-195-g8f090d20 #6 Fri Dec  7 06:11:20 UTC 2018 aarch64)
496
497 INF [0x0] TEE-CORE:init_primary_helper:338: Release version: 1.2
498
499 INF [0x0] TEE-CORE:init_teecore:83: teecore inits done
500 INFO:    BL31: Preparing for EL3 exit to normal world
501 INFO:    Entry point address = 0x200000
502 INFO:    SPSR = 0x3c9
503
504
505 U-Boot 2019.04-rc4-00136-gfd121f9641-dirty (Apr 16 2019 - 14:02:47 +0530)
506
507 Model: FriendlyARM NanoPi NEO4
508 DRAM:  1022 MiB
509 MMC:   dwmmc@fe310000: 2, dwmmc@fe320000: 1, sdhci@fe330000: 0
510 Loading Environment from MMC... *** Warning - bad CRC, using default environment
511
512 In:    serial@ff1a0000
513 Out:   serial@ff1a0000
514 Err:   serial@ff1a0000
515 Model: FriendlyARM NanoPi NEO4
516 Net:   eth0: ethernet@fe300000
517 Hit any key to stop autoboot:  0
518 =>
519
520 Option 2: Package the image with SPL:
521
522   - Prefix rk3399 header to SPL image
523
524     => cd /path/to/u-boot
525     => ./tools/mkimage -n rk3399 -T rksd -d spl/u-boot-spl-dtb.bin out
526
527   - Write prefixed SPL at 64th sector
528
529     => sudo dd if=out of=/dev/sdc seek=64
530
531   - Write U-Boot proper at 16384 sector
532
533     => sudo dd if=u-boot.itb of=/dev/sdc seek=16384
534     => sync
535
536 Put this SD (or micro-SD) card into your board and reset it. You should see
537 something like:
538
539 U-Boot SPL board init
540 Trying to boot from MMC1
541
542
543 U-Boot 2019.01-00004-g14db5ee998 (Mar 11 2019 - 13:18:41 +0530)
544
545 Model: Orange Pi RK3399 Board
546 DRAM:  2 GiB
547 MMC:   dwmmc@fe310000: 2, dwmmc@fe320000: 1, sdhci@fe330000: 0
548 Loading Environment from MMC... OK
549 In:    serial@ff1a0000
550 Out:   serial@ff1a0000
551 Err:   serial@ff1a0000
552 Model: Orange Pi RK3399 Board
553 Net:   eth0: ethernet@fe300000
554 Hit any key to stop autoboot:  0
555 =>
556
557 Option 3: Package the image with TPL:
558
559   - Write tpl+spl at 64th sector
560
561     => sudo dd if=idbloader.img of=/dev/sdc seek=64
562
563   - Write U-Boot proper at 16384 sector
564
565     => sudo dd if=u-boot.itb of=/dev/sdc seek=16384
566     => sync
567
568 Put this SD (or micro-SD) card into your board and reset it. You should see
569 something like:
570
571 U-Boot TPL board init
572 Trying to boot from BOOTROM
573 Returning to boot ROM...
574
575 U-Boot SPL board init
576 Trying to boot from MMC1
577
578
579 U-Boot 2019.07-rc1-00241-g5b3244767a (May 08 2019 - 10:51:06 +0530)
580
581 Model: Orange Pi RK3399 Board
582 DRAM:  2 GiB
583 MMC:   dwmmc@fe310000: 2, dwmmc@fe320000: 1, sdhci@fe330000: 0
584 Loading Environment from MMC... OK
585 In:    serial@ff1a0000
586 Out:   serial@ff1a0000
587 Err:   serial@ff1a0000
588 Model: Orange Pi RK3399 Board
589 Net:   eth0: ethernet@fe300000
590 Hit any key to stop autoboot:  0
591 =>
592
593 Using fastboot on rk3288
594 ========================
595 - Write GPT partition layout to mmc device which fastboot want to use it to
596 store the image
597
598         => gpt write mmc 1 $partitions
599
600 - Invoke fastboot command to prepare
601
602         => fastboot 1
603
604 - Start fastboot request on PC
605
606         fastboot -i 0x2207 flash loader evb-rk3288/spl/u-boot-spl-dtb.bin
607
608 You should see something like:
609
610         => fastboot 1
611         WARNING: unknown variable: partition-type:loader
612         Starting download of 357796 bytes
613         ..
614         downloading of 357796 bytes finished
615         Flashing Raw Image
616         ........ wrote 357888 bytes to 'loader'
617
618 Booting from SPI
619 ================
620
621 To write an image that boots from SPI flash (e.g. for the Haier Chromebook or
622 Bob):
623
624    ./chromebook_jerry/tools/mkimage -n rk3288 -T rkspi \
625         -d chromebook_jerry/spl/u-boot-spl-dtb.bin spl.bin && \
626    dd if=spl.bin of=spl-out.bin bs=128K conv=sync && \
627    cat spl-out.bin chromebook_jerry/u-boot-dtb.img >out.bin && \
628    dd if=out.bin of=out.bin.pad bs=4M conv=sync
629
630 This converts the SPL image to the required SPI format by adding the Rockchip
631 header and skipping every second 2KB block. Then the U-Boot image is written at
632 offset 128KB and the whole image is padded to 4MB which is the SPI flash size.
633 The position of U-Boot is controlled with this setting in U-Boot:
634
635    #define CONFIG_SYS_SPI_U_BOOT_OFFS   0x20000
636
637 If you have a Dediprog em100pro connected then you can write the image with:
638
639       sudo em100 -s -c GD25LQ32 -d out.bin.pad -r
640
641 When booting you should see something like:
642
643    U-Boot SPL 2015.07-rc2-00215-g9a58220-dirty (Jun 23 2015 - 12:11:32)
644
645
646    U-Boot 2015.07-rc2-00215-g9a58220-dirty (Jun 23 2015 - 12:11:32 -0600)
647
648    Model: Google Jerry
649    DRAM:  2 GiB
650    MMC:
651    Using default environment
652
653    In:    serial@ff690000
654    Out:   serial@ff690000
655    Err:   serial@ff690000
656    =>
657
658 Future work
659 ===========
660
661 Immediate priorities are:
662
663 - USB host
664 - USB device
665 - Run CPU at full speed (code exists but we only see ~60 DMIPS maximum)
666 - NAND flash
667 - Boot U-Boot proper over USB OTG (at present only SPL works)
668
669
670 Development Notes
671 =================
672
673 There are plenty of patches in the links below to help with this work.
674
675 [1] https://github.com/rkchrome/uboot.git
676 [2] https://github.com/linux-rockchip/u-boot-rockchip.git branch u-boot-rk3288
677 [3] https://github.com/linux-rockchip/rkflashtool.git
678 [4] http://wiki.t-firefly.com/index.php/Firefly-RK3288/Serial_debug/en
679
680 rkimage
681 -------
682
683 rkimage.c produces an SPL image suitable for sending directly to the boot ROM
684 over USB OTG. This is a very simple format - just the string RK32 (as 4 bytes)
685 followed by u-boot-spl-dtb.bin.
686
687 The boot ROM loads image to 0xff704000 which is in the internal SRAM. The SRAM
688 starts at 0xff700000 and extends to 0xff718000 where we put the stack.
689
690 rksd
691 ----
692
693 rksd.c produces an image consisting of 32KB of empty space, a header and
694 u-boot-spl-dtb.bin. The header is defined by 'struct header0_info' although
695 most of the fields are unused by U-Boot. We just need to specify the
696 signature, a flag and the block offset and size of the SPL image.
697
698 The header occupies a single block but we pad it out to 4 blocks. The header
699 is encoding using RC4 with the key 7c4e0304550509072d2c7b38170d1711. The SPL
700 image can be encoded too but we don't do that.
701
702 The maximum size of u-boot-spl-dtb.bin which the boot ROM will read is 32KB,
703 or 0x40 blocks. This is a severe and annoying limitation. There may be a way
704 around this limitation, since there is plenty of SRAM, but at present the
705 board refuses to boot if this limit is exceeded.
706
707 The image produced is padded up to a block boundary (512 bytes). It should be
708 written to the start of an SD card using dd.
709
710 Since this image is set to load U-Boot from the SD card at block offset,
711 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, dd should be used to write
712 u-boot-dtb.img to the SD card at that offset. See above for instructions.
713
714 rkspi
715 -----
716
717 rkspi.c produces an image consisting of a header and u-boot-spl-dtb.bin. The
718 resulting image is then spread out so that only the first 2KB of each 4KB
719 sector is used. The header is the same as with rksd and the maximum size is
720 also 32KB (before spreading). The image should be written to the start of
721 SPI flash.
722
723 See above for instructions on how to write a SPI image.
724
725 rkmux.py
726 --------
727
728 You can use this script to create #defines for SoC register access. See the
729 script for usage.
730
731
732 Device tree and driver model
733 ----------------------------
734
735 Where possible driver model is used to provide a structure to the
736 functionality. Device tree is used for configuration. However these have an
737 overhead and in SPL with a 32KB size limit some shortcuts have been taken.
738 In general all Rockchip drivers should use these features, with SPL-specific
739 modifications where required.
740
741 GPT partition layout
742 ----------------------------
743
744 Rockchip use a unified GPT partition layout  in open source support.
745 With this GPT partition layout, uboot can be compatilbe with other components,
746 like miniloader, trusted-os, arm-trust-firmware.
747
748 There are some documents about partitions in the links below.
749 http://rockchip.wikidot.com/partitions
750
751 --
752 Jagan Teki <jagan@amarulasolutions.com>
753 27 Mar 2019
754 Simon Glass <sjg@chromium.org>
755 24 June 2015