README.rockchip 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354
  1. # SPDX-License-Identifier: GPL-2.0+
  2. #
  3. # Copyright (C) 2015 Google. Inc
  4. # Written by Simon Glass <sjg@chromium.org>
  5. U-Boot on Rockchip
  6. ==================
  7. There are several repositories available with versions of U-Boot that support
  8. many Rockchip devices [1] [2].
  9. The current mainline support is experimental only and is not useful for
  10. anything. It should provide a base on which to build.
  11. So far only support for the RK3288 and RK3036 is provided.
  12. Prerequisites
  13. =============
  14. You will need:
  15. - Firefly RK3288 board or something else with a supported RockChip SoC
  16. - Power connection to 5V using the supplied micro-USB power cable
  17. - Separate USB serial cable attached to your computer and the Firefly
  18. (connect to the micro-USB connector below the logo)
  19. - rkflashtool [3]
  20. - openssl (sudo apt-get install openssl)
  21. - Serial UART connection [4]
  22. - Suitable ARM cross compiler, e.g.:
  23. sudo apt-get install gcc-4.7-arm-linux-gnueabi
  24. Building
  25. ========
  26. At present nine RK3288 boards are supported:
  27. - EVB RK3288 - use evb-rk3288 configuration
  28. - Fennec RK3288 - use fennec-rk3288 configuration
  29. - Firefly RK3288 - use firefly-rk3288 configuration
  30. - Hisense Chromebook - use chromebook_jerry configuration
  31. - MiQi RK3288 - use miqi-rk3288 configuration
  32. - phyCORE-RK3288 RDK - use phycore-rk3288 configuration
  33. - PopMetal RK3288 - use popmetal-rk3288 configuration
  34. - Radxa Rock 2 - use rock2 configuration
  35. - Tinker RK3288 - use tinker-rk3288 configuration
  36. Two RK3036 board are supported:
  37. - EVB RK3036 - use evb-rk3036 configuration
  38. - Kylin - use kylin_rk3036 configuration
  39. For example:
  40. CROSS_COMPILE=arm-linux-gnueabi- make O=firefly firefly-rk3288_defconfig all
  41. (or you can use another cross compiler if you prefer)
  42. Writing to the board with USB
  43. =============================
  44. For USB to work you must get your board into ROM boot mode, either by erasing
  45. your MMC or (perhaps) holding the recovery button when you boot the board.
  46. To erase your MMC, you can boot into Linux and type (as root)
  47. dd if=/dev/zero of=/dev/mmcblk0 bs=1M
  48. Connect your board's OTG port to your computer.
  49. To create a suitable image and write it to the board:
  50. ./firefly-rk3288/tools/mkimage -n rk3288 -T rkimage -d \
  51. ./firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
  52. cat out | openssl rc4 -K 7c4e0304550509072d2c7b38170d1711 | rkflashtool l
  53. If all goes well you should something like:
  54. U-Boot SPL 2015.07-rc1-00383-ge345740-dirty (Jun 03 2015 - 10:06:49)
  55. Card did not respond to voltage select!
  56. spl: mmc init failed with error: -17
  57. ### ERROR ### Please RESET the board ###
  58. You will need to reset the board before each time you try. Yes, that's all
  59. it does so far. If support for the Rockchip USB protocol or DFU were added
  60. in SPL then we could in principle load U-Boot and boot to a prompt from USB
  61. as several other platforms do. However it does not seem to be possible to
  62. use the existing boot ROM code from SPL.
  63. Booting from an SD card
  64. =======================
  65. To write an image that boots from an SD card (assumed to be /dev/sdc):
  66. ./firefly-rk3288/tools/mkimage -n rk3288 -T rksd -d \
  67. firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
  68. sudo dd if=out of=/dev/sdc seek=64 && \
  69. sudo dd if=firefly-rk3288/u-boot-dtb.img of=/dev/sdc seek=16384
  70. This puts the Rockchip header and SPL image first and then places the U-Boot
  71. image at block 16384 (i.e. 8MB from the start of the SD card). This
  72. corresponds with this setting in U-Boot:
  73. #define CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR 0x4000
  74. Put this SD (or micro-SD) card into your board and reset it. You should see
  75. something like:
  76. U-Boot 2016.01-rc2-00309-ge5bad3b-dirty (Jan 02 2016 - 23:41:59 -0700)
  77. Model: Radxa Rock 2 Square
  78. DRAM: 2 GiB
  79. MMC: dwmmc@ff0f0000: 0, dwmmc@ff0c0000: 1
  80. *** Warning - bad CRC, using default environment
  81. In: serial
  82. Out: vop@ff940000.vidconsole
  83. Err: serial
  84. Net: Net Initialization Skipped
  85. No ethernet found.
  86. Hit any key to stop autoboot: 0
  87. =>
  88. The rockchip bootrom can load and boot an initial spl, then continue to
  89. load a second-stage bootloader (ie. U-Boot) as soon as the control is returned
  90. to the bootrom. Both the RK3288 and the RK3036 use this special boot sequence.
  91. The configuration option enabling this is:
  92. CONFIG_SPL_ROCKCHIP_BACK_TO_BROM=y
  93. You can create the image via the following operations:
  94. ./firefly-rk3288/tools/mkimage -n rk3288 -T rksd -d \
  95. firefly-rk3288/spl/u-boot-spl-dtb.bin out && \
  96. cat firefly-rk3288/u-boot-dtb.bin >> out && \
  97. sudo dd if=out of=/dev/sdc seek=64
  98. If you have an HDMI cable attached you should see a video console.
  99. For evb_rk3036 board:
  100. ./evb-rk3036/tools/mkimage -n rk3036 -T rksd -d evb-rk3036/spl/u-boot-spl.bin out && \
  101. cat evb-rk3036/u-boot-dtb.bin >> out && \
  102. sudo dd if=out of=/dev/sdc seek=64
  103. Note: rk3036 SDMMC and debug uart use the same iomux, so if you boot from SD, the
  104. debug uart must be disabled
  105. Booting from an SD card on RK3288 with TPL
  106. ==========================================
  107. Since the size of SPL can't be exceeded 0x8000 bytes in RK3288, it is not possible add
  108. new SPL features like Falcon mode or etc.
  109. So introduce TPL so-that adding new features to SPL is possible because now TPL should
  110. run minimal with code like DDR, clock etc and rest of new features in SPL.
  111. As of now TPL is added on Vyasa-RK3288 board.
  112. To write an image that boots from an SD card (assumed to be /dev/mmcblk0):
  113. ./tools/mkimage -n rk3288 -T rksd -d ./tpl/u-boot-tpl.bin out &&
  114. cat ./spl/u-boot-spl-dtb.bin >> out &&
  115. sudo dd if=out of=/dev/mmcblk0 seek=64 &&
  116. sudo dd if=u-boot-dtb.img of=/dev/mmcblk0 seek=16384
  117. Booting from an SD card on RK3188
  118. =================================
  119. For rk3188 boards the general storage onto the card stays the same as
  120. described above, but the image creation needs a bit more care.
  121. The bootrom of rk3188 expects to find a small 1kb loader which returns
  122. control to the bootrom, after which it will load the real loader, which
  123. can then be up to 29kb in size and does the regular ddr init. This is
  124. handled by a single image (built as the SPL stage) that tests whether
  125. it is handled for the first or second time via code executed from the
  126. boot0-hook.
  127. Additionally the rk3188 requires everything the bootrom loads to be
  128. rc4-encrypted. Except for the very first stage the bootrom always reads
  129. and decodes 2kb pages, so files should be sized accordingly.
  130. # copy tpl, pad to 1020 bytes and append spl
  131. tools/mkimage -n rk3188 -T rksd -d spl/u-boot-spl.bin out
  132. # truncate, encode and append u-boot.bin
  133. truncate -s %2048 u-boot.bin
  134. cat u-boot.bin | split -b 512 --filter='openssl rc4 -K 7C4E0304550509072D2C7B38170D1711' >> out
  135. Using fastboot on rk3288
  136. ========================
  137. - Write GPT partition layout to mmc device which fastboot want to use it to
  138. store the image
  139. => gpt write mmc 1 $partitions
  140. - Invoke fastboot command to prepare
  141. => fastboot 1
  142. - Start fastboot request on PC
  143. fastboot -i 0x2207 flash loader evb-rk3288/spl/u-boot-spl-dtb.bin
  144. You should see something like:
  145. => fastboot 1
  146. WARNING: unknown variable: partition-type:loader
  147. Starting download of 357796 bytes
  148. ..
  149. downloading of 357796 bytes finished
  150. Flashing Raw Image
  151. ........ wrote 357888 bytes to 'loader'
  152. Booting from SPI
  153. ================
  154. To write an image that boots from SPI flash (e.g. for the Haier Chromebook):
  155. ./chromebook_jerry/tools/mkimage -n rk3288 -T rkspi \
  156. -d chromebook_jerry/spl/u-boot-spl-dtb.bin spl.bin && \
  157. dd if=spl.bin of=spl-out.bin bs=128K conv=sync && \
  158. cat spl-out.bin chromebook_jerry/u-boot-dtb.img >out.bin && \
  159. dd if=out.bin of=out.bin.pad bs=4M conv=sync
  160. This converts the SPL image to the required SPI format by adding the Rockchip
  161. header and skipping every 2KB block. Then the U-Boot image is written at
  162. offset 128KB and the whole image is padded to 4MB which is the SPI flash size.
  163. The position of U-Boot is controlled with this setting in U-Boot:
  164. #define CONFIG_SYS_SPI_U_BOOT_OFFS (128 << 10)
  165. If you have a Dediprog em100pro connected then you can write the image with:
  166. sudo em100 -s -c GD25LQ32 -d out.bin.pad -r
  167. When booting you should see something like:
  168. U-Boot SPL 2015.07-rc2-00215-g9a58220-dirty (Jun 23 2015 - 12:11:32)
  169. U-Boot 2015.07-rc2-00215-g9a58220-dirty (Jun 23 2015 - 12:11:32 -0600)
  170. Model: Google Jerry
  171. DRAM: 2 GiB
  172. MMC:
  173. Using default environment
  174. In: serial@ff690000
  175. Out: serial@ff690000
  176. Err: serial@ff690000
  177. =>
  178. Future work
  179. ===========
  180. Immediate priorities are:
  181. - USB host
  182. - USB device
  183. - Run CPU at full speed (code exists but we only see ~60 DMIPS maximum)
  184. - NAND flash
  185. - Support for other Rockchip parts
  186. - Boot U-Boot proper over USB OTG (at present only SPL works)
  187. Development Notes
  188. =================
  189. There are plenty of patches in the links below to help with this work.
  190. [1] https://github.com/rkchrome/uboot.git
  191. [2] https://github.com/linux-rockchip/u-boot-rockchip.git branch u-boot-rk3288
  192. [3] https://github.com/linux-rockchip/rkflashtool.git
  193. [4] http://wiki.t-firefly.com/index.php/Firefly-RK3288/Serial_debug/en
  194. rkimage
  195. -------
  196. rkimage.c produces an SPL image suitable for sending directly to the boot ROM
  197. over USB OTG. This is a very simple format - just the string RK32 (as 4 bytes)
  198. followed by u-boot-spl-dtb.bin.
  199. The boot ROM loads image to 0xff704000 which is in the internal SRAM. The SRAM
  200. starts at 0xff700000 and extends to 0xff718000 where we put the stack.
  201. rksd
  202. ----
  203. rksd.c produces an image consisting of 32KB of empty space, a header and
  204. u-boot-spl-dtb.bin. The header is defined by 'struct header0_info' although
  205. most of the fields are unused by U-Boot. We just need to specify the
  206. signature, a flag and the block offset and size of the SPL image.
  207. The header occupies a single block but we pad it out to 4 blocks. The header
  208. is encoding using RC4 with the key 7c4e0304550509072d2c7b38170d1711. The SPL
  209. image can be encoded too but we don't do that.
  210. The maximum size of u-boot-spl-dtb.bin which the boot ROM will read is 32KB,
  211. or 0x40 blocks. This is a severe and annoying limitation. There may be a way
  212. around this limitation, since there is plenty of SRAM, but at present the
  213. board refuses to boot if this limit is exceeded.
  214. The image produced is padded up to a block boundary (512 bytes). It should be
  215. written to the start of an SD card using dd.
  216. Since this image is set to load U-Boot from the SD card at block offset,
  217. CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, dd should be used to write
  218. u-boot-dtb.img to the SD card at that offset. See above for instructions.
  219. rkspi
  220. -----
  221. rkspi.c produces an image consisting of a header and u-boot-spl-dtb.bin. The
  222. resulting image is then spread out so that only the first 2KB of each 4KB
  223. sector is used. The header is the same as with rksd and the maximum size is
  224. also 32KB (before spreading). The image should be written to the start of
  225. SPI flash.
  226. See above for instructions on how to write a SPI image.
  227. rkmux.py
  228. --------
  229. You can use this script to create #defines for SoC register access. See the
  230. script for usage.
  231. Device tree and driver model
  232. ----------------------------
  233. Where possible driver model is used to provide a structure to the
  234. functionality. Device tree is used for configuration. However these have an
  235. overhead and in SPL with a 32KB size limit some shortcuts have been taken.
  236. In general all Rockchip drivers should use these features, with SPL-specific
  237. modifications where required.
  238. GPT partition layout
  239. ----------------------------
  240. Rockchip use a unified GPT partition layout in open source support.
  241. With this GPT partition layout, uboot can be compatilbe with other components,
  242. like miniloader, trusted-os, arm-trust-firmware.
  243. There are some documents about partitions in the links below.
  244. http://rockchip.wikidot.com/partitions
  245. --
  246. Simon Glass <sjg@chromium.org>
  247. 24 June 2015