doc/board/rockchip/rockchip.rst

   1 .. SPDX-License-Identifier: GPL-2.0+
   2 .. Copyright (C) 2019 Jagan Teki <jagan@amarulasolutions.com>
   3
   4 ROCKCHIP
   5 ========
   6
   7 About this
   8 ----------
   9
  10 This document describes the information about Rockchip supported boards
  11 and it's usage steps.
  12
  13 Rockchip boards
  14 ---------------
  15
  16 Rockchip is a SoC solutions provider for tablets & PCs, streaming media
  17 TV boxes, AI audio & vision, IoT hardware.
  18
  19 A wide range of Rockchip SoCs with associated boards are supported in
  20 mainline U-Boot.
  21
  22 List of mainline supported Rockchip boards:
  23
  24 * px30
  25      - Rockchip Evb-PX30 (evb-px30)
  26      - Engicam PX30.Core C.TOUCH 2.0 (px30-core-ctouch2-px30)
  27      - Engicam PX30.Core C.TOUCH 2.0 10.1 (px30-core-ctouch2-of10-px30)
  28      - Engicam PX30.Core EDIMM2.2 Starter Kit (px30-core-edimm2.2-px30)
  29      - Firefly Core-PX30-JD4 (firefly-px30)
  30      - Theobroma Systems PX30-µQ7 SoM - Ringneck (ringneck-px30)
  31 * rk3036
  32      - Rockchip Evb-RK3036 (evb-rk3036)
  33      - Kylin (kylin_rk3036)
  34 * rk3066
  35      - Rikomagic MK808 (mk808)
  36 * rk3128
  37      - Rockchip Evb-RK3128 (evb-rk3128)
  38 * rk3188
  39      - Radxa Rock (rock)
  40 * rk3229
  41      - Rockchip Evb-RK3229 (evb-rk3229)
  42 * rk3288
  43      - Rockchip Evb-RK3288 (evb-rk3288)
  44      - Firefly-RK3288 (firefly-rk3288)
  45      - MQmaker MiQi (miqi-rk3288)
  46      - Phytec RK3288 PCM-947 (phycore-rk3288)
  47      - PopMetal-RK3288 (popmetal-rk3288)
  48      - Radxa Rock 2 Square (rock2)
  49      - Tinker-RK3288 (tinker-rk3288)
  50      - Google Jerry (chromebook_jerry)
  51      - Google Mickey (chromebook_mickey)
  52      - Google Minnie (chromebook_minnie)
  53      - Google Speedy (chromebook_speedy)
  54      - Amarula Vyasa-RK3288 (vyasa-rk3288)
  55 * rk3308
  56      - Rockchip Evb-RK3308 (evb-rk3308)
  57      - Roc-cc-RK3308 (roc-cc-rk3308)
  58 * rk3326
  59      - ODROID-GO Advance (odroid-go2)
  60 * rk3328
  61      - Rockchip Evb-RK3328 (evb-rk3328)
  62      - Pine64 Rock64 (rock64-rk3328)
  63      - Firefly-RK3328 (roc-cc-rk3328)
  64      - Radxa Rockpi E (rock-pi-e-rk3328)
  65 * rk3368
  66      - GeekBox (geekbox)
  67      - PX5 EVB (evb-px5)
  68      - Rockchip Sheep (sheep-rk3368)
  69      - Theobroma Systems RK3368-uQ7 SoM - Lion (lion-rk3368)
  70 * rk3399
  71      - 96boards RK3399 Ficus (ficus-rk3399)
  72      - 96boards Rock960 (rock960-rk3399)
  73      - Firefly-RK3399 (firefly_rk3399)
  74      - Firefly ROC-RK3399-PC
  75      - FriendlyElec NanoPC-T4 (nanopc-t4-rk3399)
  76      - FriendlyElec NanoPi M4 (nanopi-m4-rk3399)
  77      - FriendlyElec NanoPi M4B (nanopi-m4b-rk3399)
  78      - FriendlyARM NanoPi NEO4 (nanopi-neo4-rk3399)
  79      - Google Bob (chromebook_bob)
  80      - Google Kevin (chromebook_kevin)
  81      - Khadas Edge (khadas-edge-rk3399)
  82      - Khadas Edge-Captain (khadas-edge-captain-rk3399)
  83      - Khadas Edge-V (hadas-edge-v-rk3399)
  84      - Orange Pi RK3399 (orangepi-rk3399)
  85      - Pine64 RockPro64 (rockpro64-rk3399)
  86      - Radxa ROCK Pi 4 (rock-pi-4-rk3399)
  87      - Rockchip Evb-RK3399 (evb_rk3399)
  88      - Theobroma Systems RK3399-Q7 SoM - Puma (puma_rk3399)
  89
  90 * rk3568
  91      - Rockchip Evb-RK3568 (evb-rk3568)
  92
  93 * rk3588
  94      - Edgeble Neural Compute Module 6 SoM - Neu6a (neu6a-io-rk3588)
  95      - Radxa ROCK 5B (rock5b-rk3588)
  96
  97 * rv1108
  98      - Rockchip Evb-rv1108 (evb-rv1108)
  99      - Elgin-R1 (elgin-rv1108)
 100
 101 * rv1126
 102      - Edgeble Neural Compute Module 2 SoM - Neu2/Neu2k (neu2-io-r1126)
 103
 104 Building
 105 --------
 106
 107 TF-A
 108 ^^^^
 109
 110 TF-A is required when building ARM64 Rockchip SoCs images.
 111
 112 To build TF-A:
 113
 114 .. code-block:: bash
 115
 116         git clone --depth 1 https://github.com/ARM-software/arm-trusted-firmware.git
 117         cd arm-trusted-firmware
 118         make realclean
 119         make CROSS_COMPILE=aarch64-linux-gnu- PLAT=rk3399
 120         cd ..
 121
 122 Specify the PLAT= with desired Rockchip platform to build TF-A for.
 123
 124 U-Boot
 125 ^^^^^^
 126
 127 .. code-block:: bash
 128
 129         git clone --depth 1 https://source.denx.de/u-boot/u-boot.git
 130         cd u-boot
 131
 132 To build px30 boards:
 133
 134 .. code-block:: bash
 135
 136         export BL31=../arm-trusted-firmware/build/px30/release/bl31/bl31.elf
 137         make evb-px30_defconfig
 138         make CROSS_COMPILE=aarch64-linux-gnu-
 139
 140 To build rk3066 boards:
 141
 142 .. code-block:: bash
 143
 144         make mk808_defconfig
 145         make CROSS_COMPILE=arm-linux-gnueabihf-
 146
 147 To build rk3288 boards:
 148
 149 .. code-block:: bash
 150
 151         make evb-rk3288_defconfig
 152         make CROSS_COMPILE=arm-linux-gnueabihf-
 153
 154 To build rk3328 boards:
 155
 156 .. code-block:: bash
 157
 158         export BL31=../arm-trusted-firmware/build/rk3328/release/bl31/bl31.elf
 159         make evb-rk3328_defconfig
 160         make CROSS_COMPILE=aarch64-linux-gnu-
 161
 162 To build rk3368 boards:
 163
 164 .. code-block:: bash
 165
 166         export BL31=../arm-trusted-firmware/build/rk3368/release/bl31/bl31.elf
 167         make evb-px5_defconfig
 168         make CROSS_COMPILE=aarch64-linux-gnu-
 169
 170 To build rk3399 boards:
 171
 172 .. code-block:: bash
 173
 174         export BL31=../arm-trusted-firmware/build/rk3399/release/bl31/bl31.elf
 175         make evb-rk3399_defconfig
 176         make CROSS_COMPILE=aarch64-linux-gnu-
 177
 178 To build rk3568 boards:
 179
 180 .. code-block:: bash
 181
 182         export BL31=../arm-trusted-firmware/build/rk3568/release/bl31/bl31.elf
 183         [or]export BL31=../rkbin/bin/rk35/rk3568_bl31_v1.34.elf
 184         export ROCKCHIP_TPL=../rkbin/bin/rk35/rk3568_ddr_1560MHz_v1.13.bin
 185         make evb-rk3568_defconfig
 186         make CROSS_COMPILE=aarch64-linux-gnu-
 187
 188 Flashing
 189 --------
 190
 191 1. Package the image with U-Boot TPL/SPL
 192 -----------------------------------------
 193
 194 SD Card
 195 ^^^^^^^
 196
 197 All Rockchip platforms (except rk3128 which doesn't use SPL) are now
 198 supporting a single boot image using binman and pad_cat.
 199
 200 To write an image that boots from a SD card (assumed to be /dev/sda):
 201
 202 .. code-block:: bash
 203
 204         sudo dd if=u-boot-rockchip.bin of=/dev/sda seek=64
 205         sync
 206
 207 eMMC
 208 ^^^^
 209
 210 eMMC flash would probe on mmc0 in most of the Rockchip platforms.
 211
 212 Create GPT partition layout as defined in $partitions:
 213
 214 .. code-block:: bash
 215
 216         mmc dev 0
 217         gpt write mmc 0 $partitions
 218
 219 Connect the USB-OTG cable between the host and a target device.
 220
 221 Launch fastboot on the target with:
 222
 223 .. code-block:: bash
 224
 225         fastboot 0
 226
 227 Upon a successful gadget connection the host shows the USB device with:
 228
 229 .. code-block:: bash
 230
 231         lsusb
 232         # Bus 001 Device 020: ID 2207:330c Fuzhou Rockchip Electronics Company RK3399 in Mask ROM mode
 233
 234 Program the flash with:
 235
 236 .. code-block:: bash
 237
 238         sudo fastboot -i 0x2207 flash loader1 idbloader.img
 239         sudo fastboot -i 0x2207 flash loader2 u-boot.itb
 240
 241 Note:
 242
 243 For Rockchip 32-bit platforms the U-Boot proper image
 244 is u-boot-dtb.img
 245
 246 SPI
 247 ^^^
 248
 249 The SPI boot method requires the generation of idbloader.img with help of the mkimage tool.
 250
 251 SPL-alone SPI boot image:
 252
 253 .. code-block:: bash
 254
 255         ./tools/mkimage -n rk3399 -T rkspi -d spl/u-boot-spl.bin idbloader.img
 256
 257 TPL+SPL SPI boot image:
 258
 259 .. code-block:: bash
 260
 261         ./tools/mkimage -n rk3399 -T rkspi -d tpl/u-boot-tpl.bin:spl/u-boot-spl.bin idbloader.img
 262
 263 Copy SPI boot images into SD card and boot from SD:
 264
 265 .. code-block:: bash
 266
 267         sf probe
 268         load mmc 1:1 $kernel_addr_r idbloader.img
 269         sf erase 0 +$filesize
 270         sf write $kernel_addr_r 0 ${filesize}
 271         load mmc 1:1 ${kernel_addr_r} u-boot.itb
 272         sf erase 0x60000 +$filesize
 273         sf write $kernel_addr_r 0x60000 ${filesize}
 274
 275 2. Package the image with Rockchip miniloader
 276 ---------------------------------------------
 277
 278 Image package with Rockchip miniloader requires rkbin [1].
 279
 280 .. code-block:: bash
 281
 282         cd ..
 283         git clone --depth 1 https://github.com/rockchip-linux/rkbin
 284
 285 Create idbloader.img:
 286
 287 .. code-block:: bash
 288
 289         cd u-boot
 290         ./tools/mkimage -n px30 -T rksd -d ../rkbin/bin/rk33/px30_ddr_333MHz_v1.16.bin idbloader.img
 291         cat ../rkbin/bin/rk33/px30_miniloader_v1.31.bin >> idbloader.img
 292         sudo dd if=idbloader.img of=/dev/sda seek=64
 293
 294 Create trust.img:
 295
 296 .. code-block:: bash
 297
 298         cd ../rkbin
 299         ./tools/trust_merger RKTRUST/PX30TRUST.ini
 300         sudo dd if=trust.img of=/dev/sda seek=24576
 301
 302 Create uboot.img [2]:
 303
 304 .. code-block:: bash
 305
 306         cd ../u-boot
 307         ../rkbin/tools/loaderimage --pack --uboot u-boot-dtb.bin uboot.img 0x200000
 308         sudo dd if=uboot.img of=/dev/sda seek=16384
 309
 310 Note:
 311
 312 1. rkbin binaries are regularly updated, so it would be recommended to use the latest version.
 313 2. 0x200000 is a load address and is an option for some platforms.
 314
 315 3. Package the RK3066 image with U-Boot TPL/SPL on NAND
 316 -------------------------------------------------------
 317
 318 Unlike later SoC models the rk3066 BootROM doesn't have SDMMC support.
 319 If all other boot options fail then it enters into a BootROM mode on the USB OTG port.
 320 This method loads TPL/SPL on NAND with U-boot and kernel on SD card.
 321
 322 SD Card
 323 ^^^^^^^
 324
 325 U-boot expects a GPT partition map and a boot directory structure with files on the SD card.
 326
 327 .. code-block:: none
 328
 329         Partition Map for MMC device 0  --   Partition Type: EFI
 330         Part     Start LBA         End LBA           Name
 331         1        0x00000040        0x00001f7f        "loader1"
 332         2        0x00004000        0x00005fff        "loader2"
 333         3        0x00006000        0x00007fff        "trust"
 334         4        0x00008000        0x0003ffff        "boot"
 335         5        0x00040000        0x00ed7fde        "rootfs"
 336
 337 Make sure boot and esp flag are set for the boot partition.
 338 Loader1 partition is not used by RK3066.
 339
 340 Boot partition:
 341
 342 .. code-block:: none
 343
 344         extlinux
 345           extlinux.conf
 346
 347         zImage
 348         rk3066a-mk808.dtb
 349
 350 To write a U-boot image to the SD card (assumed to be /dev/sda):
 351
 352 .. code-block:: bash
 353
 354         sudo dd if=u-boot-dtb.img of=/dev/sda seek=16384
 355         sync
 356
 357 NAND
 358 ^^^^
 359
 360 Bring device in BootROM mode:
 361
 362 If bricked and no BootROM mode shows up then connect pin 8 and 9 of the NAND flash
 363 with a needle while reconnecting to the USB OTG port to a PC.
 364
 365 Show connected devices with:
 366
 367 .. code-block:: bash
 368
 369         lsusb
 370         # Bus 001 Device 004: ID 2207:300a Fuzhou Rockchip Electronics Company RK3066 in Mask ROM mode
 371
 372
 373 Create NAND image:
 374
 375 Size of SPL and TPL must be aligned to 2kb.
 376
 377 Program with commands in a bash script ./flash.sh:
 378
 379 .. code-block:: bash
 380
 381         #!/bin/sh
 382
 383         printf "RK30" > tplspl.bin
 384         dd if=u-boot-tpl.bin >> tplspl.bin
 385         truncate -s %2048 tplspl.bin
 386         truncate -s %2048 u-boot-spl.bin
 387         ../tools/boot_merger --verbose config-flash.ini
 388         ../tools/upgrade_tool ul ./RK30xxLoader_uboot.bin
 389
 390 config-flash.ini:
 391
 392 .. code-block:: none
 393
 394         [CHIP_NAME]
 395         NAME=RK30
 396         [VERSION]
 397         MAJOR=2
 398         MINOR=21
 399         [CODE471_OPTION]
 400         NUM=1
 401         Path1=30_LPDDR2_300MHz_DD.bin
 402         [CODE472_OPTION]
 403         NUM=1
 404         Path1=rk30usbplug.bin
 405         [LOADER_OPTION]
 406         NUM=2
 407         LOADER1=FlashData
 408         LOADER2=FlashBoot
 409         FlashData=tplspl.bin
 410         FlashBoot=u-boot-spl.bin
 411         [OUTPUT]
 412         PATH=RK30xxLoader_uboot.bin
 413
 414 TODO
 415 ----
 416
 417 - Add Rockchip idbloader image building
 418 - Add Rockchip TPL image building
 419 - Document SPI flash boot
 420 - Add missing SoC's with it boards list
 421
 422 .. Jagan Teki <jagan@amarulasolutions.com>
 423 .. Wednesday 28 October 2020 06:47:26 PM IST