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