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