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