1TF-A Build Instructions for Marvell Platforms 2============================================= 3 4This section describes how to compile the Trusted Firmware-A (TF-A) project for Marvell's platforms. 5 6Build Instructions 7------------------ 8(1) Set the cross compiler 9 10 .. code:: shell 11 12 > export CROSS_COMPILE=/path/to/toolchain/aarch64-linux-gnu- 13 14(2) Set path for FIP images: 15 16Set U-Boot image path (relatively to TF-A root or absolute path) 17 18 .. code:: shell 19 20 > export BL33=path/to/u-boot.bin 21 22For example: if U-Boot project (and its images) is located at ``~/project/u-boot``, 23BL33 should be ``~/project/u-boot/u-boot.bin`` 24 25 .. note:: 26 27 *u-boot.bin* should be used and not *u-boot-spl.bin* 28 29Set MSS/SCP image path (mandatory only for A7K/8K/CN913x when MSS_SUPPORT=1) 30 31 .. code:: shell 32 33 > export SCP_BL2=path/to/mrvl_scp_bl2*.img 34 35(3) Armada-37x0 build requires WTP tools installation. 36 37See below in the section "Tools and external components installation". 38Install ARM 32-bit cross compiler, which is required for building WTMI image for CM3 39 40 .. code:: shell 41 42 > sudo apt-get install gcc-arm-linux-gnueabi 43 44(4) Clean previous build residuals (if any) 45 46 .. code:: shell 47 48 > make distclean 49 50(5) Build TF-A 51 52There are several build options: 53 54- PLAT 55 56 Supported Marvell platforms are: 57 58 - a3700 - A3720 DB, EspressoBin and Turris MOX 59 - a70x0 60 - a70x0_amc - AMC board 61 - a80x0 62 - a80x0_mcbin - MacchiatoBin 63 - a80x0_puzzle - IEI Puzzle-M801 64 - t9130 - CN913x 65 - t9130_cex7_eval - CN913x CEx7 Evaluation Board 66 67- DEBUG 68 69 Default is without debug information (=0). in order to enable it use ``DEBUG=1``. 70 Must be disabled when building UART recovery images due to current console driver 71 implementation that is not compatible with Xmodem protocol used for boot image download. 72 73- LOG_LEVEL 74 75 Defines the level of logging which will be purged to the default output port. 76 77 - 0 - LOG_LEVEL_NONE 78 - 10 - LOG_LEVEL_ERROR 79 - 20 - LOG_LEVEL_NOTICE (default for DEBUG=0) 80 - 30 - LOG_LEVEL_WARNING 81 - 40 - LOG_LEVEL_INFO (default for DEBUG=1) 82 - 50 - LOG_LEVEL_VERBOSE 83 84- USE_COHERENT_MEM 85 86 This flag determines whether to include the coherent memory region in the 87 BL memory map or not. Enabled by default. 88 89- LLC_ENABLE 90 91 Flag defining the LLC (L3) cache state. The cache is enabled by default (``LLC_ENABLE=1``). 92 93- LLC_SRAM 94 95 Flag enabling the LLC (L3) cache SRAM support. The LLC SRAM is activated and used 96 by Trusted OS (OP-TEE OS, BL32). The TF-A only prepares CCU address translation windows 97 for SRAM address range at BL31 execution stage with window target set to DRAM-0. 98 When Trusted OS activates LLC SRAM, the CCU window target is changed to SRAM. 99 There is no reason to enable this feature if OP-TEE OS built with CFG_WITH_PAGER=n. 100 Only set LLC_SRAM=1 if OP-TEE OS is built with CFG_WITH_PAGER=y. 101 102- MARVELL_SECURE_BOOT 103 104 Build trusted(=1)/non trusted(=0) image, default is non trusted. 105 This parameter is used only for ``mrvl_flash`` and ``mrvl_uart`` targets. 106 107- MV_DDR_PATH 108 109 This parameter is required for ``mrvl_flash`` and ``mrvl_uart`` targets. 110 For A7K/8K/CN913x it is used for BLE build and for Armada37x0 it used 111 for ddr_tool build. 112 113 Specify path to the full checkout of Marvell mv-ddr-marvell git 114 repository. Checkout must contain also .git subdirectory because 115 mv-ddr build process calls git commands. 116 117 Do not remove any parts of git checkout becuase build process and other 118 applications need them for correct building and version determination. 119 120 121CN913x specific build options: 122 123- CP_NUM 124 125 Total amount of CPs (South Bridge) connected to AP. When the parameter is omitted, 126 the build uses the default number of CPs, which is a number of embedded CPs inside the 127 package: 1 or 2 depending on the SoC used. The parameter is valid for OcteonTX2 CN913x SoC 128 family (PLAT=t9130), which can have external CPs connected to the MCI ports. Valid 129 values with CP_NUM are in a range of 1 to 3. 130 131 132A7K/8K/CN913x specific build options: 133 134- BLE_PATH 135 136 Points to BLE (Binary ROM extension) sources folder. 137 The parameter is optional, its default value is ``plat/marvell/armada/a8k/common/ble`` 138 which uses TF-A in-tree BLE implementation. 139 140- MSS_SUPPORT 141 142 When ``MSS_SUPPORT=1``, then TF-A includes support for Management SubSystem (MSS). 143 When enabled it is required to specify path to the MSS firmware image via ``SCP_BL2`` 144 option. 145 146 This option is by default enabled. 147 148- SCP_BL2 149 150 Specify path to the MSS fimware image binary which will run on Cortex-M3 coprocessor. 151 It is available in Marvell binaries-marvell git repository. Required when ``MSS_SUPPORT=1``. 152 153 154Armada37x0 specific build options: 155 156- CM3_SYSTEM_RESET 157 158 When ``CM3_SYSTEM_RESET=1``, the Cortex-M3 secure coprocessor will be used for system reset. 159 160 TF-A will send command 0x0009 with a magic value via the rWTM mailbox interface to the 161 Cortex-M3 secure coprocessor. 162 The firmware running in the coprocessor must either implement this functionality or 163 ignore the 0x0009 command (which is true for the firmware from A3700-utils-marvell 164 repository). If this option is enabled but the firmware does not support this command, 165 an error message will be printed prior trying to reboot via the usual way. 166 167 This option is needed on Turris MOX as a workaround to a HW bug which causes reset to 168 sometime hang the board. 169 170- A3720_DB_PM_WAKEUP_SRC 171 172 For Armada 3720 Development Board only, when ``A3720_DB_PM_WAKEUP_SRC=1``, 173 TF-A will setup PM wake up src configuration. This option is disabled by default. 174 175 176Armada37x0 specific build options for ``mrvl_flash`` and ``mrvl_uart`` targets: 177 178- DDR_TOPOLOGY 179 180 The DDR topology map index/name, default is 0. 181 182 Supported Options: 183 - 0 - DDR3 1CS 512MB (DB-88F3720-DDR3-Modular, EspressoBin V3-V5) 184 - 1 - DDR4 1CS 512MB (DB-88F3720-DDR4-Modular) 185 - 2 - DDR3 2CS 1GB (EspressoBin V3-V5) 186 - 3 - DDR4 2CS 4GB (DB-88F3720-DDR4-Modular) 187 - 4 - DDR3 1CS 1GB (DB-88F3720-DDR3-Modular, EspressoBin V3-V5) 188 - 5 - DDR4 1CS 1GB (EspressoBin V7, EspressoBin-Ultra) 189 - 6 - DDR4 2CS 2GB (EspressoBin V7) 190 - 7 - DDR3 2CS 2GB (EspressoBin V3-V5) 191 - CUST - CUSTOMER BOARD (Customer board settings) 192 193- CLOCKSPRESET 194 195 The clock tree configuration preset including CPU and DDR frequency, 196 default is CPU_800_DDR_800. 197 198 - CPU_600_DDR_600 - CPU at 600 MHz, DDR at 600 MHz 199 - CPU_800_DDR_800 - CPU at 800 MHz, DDR at 800 MHz 200 - CPU_1000_DDR_800 - CPU at 1000 MHz, DDR at 800 MHz 201 - CPU_1200_DDR_750 - CPU at 1200 MHz, DDR at 750 MHz 202 203 Look at Armada37x0 chip package marking on board to identify correct CPU frequency. 204 The last line on package marking (next line after the 88F37x0 line) should contain: 205 206 - C080 or I080 - chip with 800 MHz CPU - use ``CLOCKSPRESET=CPU_800_DDR_800`` 207 - C100 or I100 - chip with 1000 MHz CPU - use ``CLOCKSPRESET=CPU_1000_DDR_800`` 208 - C120 - chip with 1200 MHz CPU - use ``CLOCKSPRESET=CPU_1200_DDR_750`` 209 210- BOOTDEV 211 212 The flash boot device, default is ``SPINOR``. 213 214 Currently, Armada37x0 only supports ``SPINOR``, ``SPINAND``, ``EMMCNORM`` and ``SATA``: 215 216 - SPINOR - SPI NOR flash boot 217 - SPINAND - SPI NAND flash boot 218 - EMMCNORM - eMMC Download Mode 219 220 Download boot loader or program code from eMMC flash into CM3 or CA53 221 Requires full initialization and command sequence 222 223 - SATA - SATA device boot 224 225 Image needs to be stored at disk LBA 0 or at disk partition with 226 MBR type 0x4d (ASCII 'M' as in Marvell) or at disk partition with 227 GPT name ``MARVELL BOOT PARTITION``. 228 229- PARTNUM 230 231 The boot partition number, default is 0. 232 233 To boot from eMMC, the value should be aligned with the parameter in 234 U-Boot with name of ``CONFIG_SYS_MMC_ENV_PART``, whose value by default is 235 1. For details about CONFIG_SYS_MMC_ENV_PART, please refer to the U-Boot 236 build instructions. 237 238- WTMI_IMG 239 240 The path of the binary can point to an image which 241 does nothing, an image which supports EFUSE or a customized CM3 firmware 242 binary. The default image is ``fuse.bin`` that built from sources in WTP 243 folder, which is the next option. If the default image is OK, then this 244 option should be skipped. 245 246 Please note that this is not a full WTMI image, just a main loop without 247 hardware initialization code. Final WTMI image is built from this WTMI_IMG 248 binary and sys-init code from the WTP directory which sets DDR and CPU 249 clocks according to DDR_TOPOLOGY and CLOCKSPRESET options. 250 251 CZ.NIC as part of Turris project released free and open source WTMI 252 application firmware ``wtmi_app.bin`` for all Armada 3720 devices. 253 This firmware includes additional features like access to Hardware 254 Random Number Generator of Armada 3720 SoC which original Marvell's 255 ``fuse.bin`` image does not have. 256 257 CZ.NIC's Armada 3720 Secure Firmware is available at website: 258 259 https://gitlab.nic.cz/turris/mox-boot-builder/ 260 261- WTP 262 263 Specify path to the full checkout of Marvell A3700-utils-marvell git 264 repository. Checkout must contain also .git subdirectory because WTP 265 build process calls git commands. 266 267 WTP build process uses also Marvell mv-ddr-marvell git repository 268 specified in MV_DDR_PATH option. 269 270 Do not remove any parts of git checkout becuase build process and other 271 applications need them for correct building and version determination. 272 273- CRYPTOPP_PATH 274 275 Use this parameter to point to Crypto++ source code 276 directory. If this option is specified then Crypto++ source code in 277 CRYPTOPP_PATH directory will be automatically compiled. Crypto++ library 278 is required for building WTP image tool. Either CRYPTOPP_PATH or 279 CRYPTOPP_LIBDIR with CRYPTOPP_INCDIR needs to be specified for Armada37x0. 280 281- CRYPTOPP_LIBDIR 282 283 Use this parameter to point to the directory with 284 compiled Crypto++ library. By default it points to the CRYPTOPP_PATH. 285 286- CRYPTOPP_INCDIR 287 288 Use this parameter to point to the directory with 289 header files of Crypto++ library. By default it points to the CRYPTOPP_PATH. 290 291 292For example, in order to build the image in debug mode with log level up to 'notice' level run 293 294.. code:: shell 295 296 > make DEBUG=1 USE_COHERENT_MEM=0 LOG_LEVEL=20 PLAT=<MARVELL_PLATFORM> mrvl_flash 297 298And if we want to build a Armada37x0 image in debug mode with log level up to 'notice' level, 299the image has the preset CPU at 1000 MHz, preset DDR3 at 800 MHz, the DDR topology of DDR4 2CS, 300the image boot from SPI NOR flash partition 0, and the image is non trusted in WTP, the command 301line is as following 302 303.. code:: shell 304 305 > make DEBUG=1 USE_COHERENT_MEM=0 LOG_LEVEL=20 CLOCKSPRESET=CPU_1000_DDR_800 \ 306 MARVELL_SECURE_BOOT=0 DDR_TOPOLOGY=3 BOOTDEV=SPINOR PARTNUM=0 PLAT=a3700 \ 307 MV_DDR_PATH=/path/to/mv-ddr-marvell/ WTP=/path/to/A3700-utils-marvell/ \ 308 CRYPTOPP_PATH=/path/to/cryptopp/ BL33=/path/to/u-boot.bin \ 309 all fip mrvl_bootimage mrvl_flash mrvl_uart 310 311To build just TF-A without WTMI image (useful for A3720 Turris MOX board), run following command: 312 313.. code:: shell 314 315 > make USE_COHERENT_MEM=0 PLAT=a3700 CM3_SYSTEM_RESET=1 BL33=/path/to/u-boot.bin \ 316 CROSS_COMPILE=aarch64-linux-gnu- mrvl_bootimage 317 318Here is full example how to build production release of Marvell firmware image (concatenated 319binary of Marvell's A3720 sys-init, CZ.NIC's Armada 3720 Secure Firmware, TF-A and U-Boot) for 320EspressoBin board (PLAT=a3700) with 1GHz CPU (CLOCKSPRESET=CPU_1000_DDR_800) and 3211GB DDR4 RAM (DDR_TOPOLOGY=5): 322 323.. code:: shell 324 325 > git clone https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git 326 > git clone https://source.denx.de/u-boot/u-boot.git 327 > git clone https://github.com/weidai11/cryptopp.git 328 > git clone https://github.com/MarvellEmbeddedProcessors/mv-ddr-marvell.git 329 > git clone https://github.com/MarvellEmbeddedProcessors/A3700-utils-marvell.git 330 > git clone https://gitlab.nic.cz/turris/mox-boot-builder.git 331 > make -C u-boot CROSS_COMPILE=aarch64-linux-gnu- mvebu_espressobin-88f3720_defconfig u-boot.bin 332 > make -C mox-boot-builder CROSS_CM3=arm-linux-gnueabi- wtmi_app.bin 333 > make -C trusted-firmware-a CROSS_COMPILE=aarch64-linux-gnu- CROSS_CM3=arm-linux-gnueabi- \ 334 USE_COHERENT_MEM=0 PLAT=a3700 CLOCKSPRESET=CPU_1000_DDR_800 DDR_TOPOLOGY=5 \ 335 MV_DDR_PATH=$PWD/mv-ddr-marvell/ WTP=$PWD/A3700-utils-marvell/ \ 336 CRYPTOPP_PATH=$PWD/cryptopp/ BL33=$PWD/u-boot/u-boot.bin \ 337 WTMI_IMG=$PWD/mox-boot-builder/wtmi_app.bin FIP_ALIGN=0x100 mrvl_flash 338 339Produced Marvell firmware flash image: ``trusted-firmware-a/build/a3700/release/flash-image.bin`` 340 341Special Build Flags 342-------------------- 343 344- PLAT_RECOVERY_IMAGE_ENABLE 345 When set this option to enable secondary recovery function when build atf. 346 In order to build UART recovery image this operation should be disabled for 347 A7K/8K/CN913x because of hardware limitation (boot from secondary image 348 can interrupt UART recovery process). This MACRO definition is set in 349 ``plat/marvell/armada/a8k/common/include/platform_def.h`` file. 350 351- DDR32 352 In order to work in 32bit DDR, instead of the default 64bit ECC DDR, 353 this flag should be set to 1. 354 355For more information about build options, please refer to the 356:ref:`Build Options` document. 357 358 359Build output 360------------ 361Marvell's TF-A compilation generates 8 files: 362 363 - ble.bin - BLe image (not available for Armada37x0) 364 - bl1.bin - BL1 image 365 - bl2.bin - BL2 image 366 - bl31.bin - BL31 image 367 - fip.bin - FIP image (contains BL2, BL31 & BL33 (U-Boot) images) 368 - boot-image.bin - TF-A image (contains BL1 and FIP images) 369 - flash-image.bin - Flashable Marvell firmware image. For Armada37x0 it 370 contains TIM, WTMI and boot-image.bin images. For other platforms it contains 371 BLe and boot-image.bin images. Should be placed on the boot flash/device. 372 - uart-images.tgz.bin - GZIPed TAR archive which contains Armada37x0 images 373 for booting via UART. Could be loaded via Marvell's WtpDownload tool from 374 A3700-utils-marvell repository. 375 376Additional make target ``mrvl_bootimage`` produce ``boot-image.bin`` file. Target 377``mrvl_flash`` produce final ``flash-image.bin`` file and target ``mrvl_uart`` 378produce ``uart-images.tgz.bin`` file. 379 380 381Tools and external components installation 382------------------------------------------ 383 384Armada37x0 Builds require installation of additional components 385~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 386 387(1) ARM cross compiler capable of building images for the service CPU (CM3). 388 This component is usually included in the Linux host packages. 389 On Debian/Ubuntu hosts the default GNU ARM tool chain can be installed 390 using the following command 391 392 .. code:: shell 393 394 > sudo apt-get install gcc-arm-linux-gnueabi 395 396 Only if required, the default tool chain prefix ``arm-linux-gnueabi-`` can be 397 overwritten using the environment variable ``CROSS_CM3``. 398 Example for BASH shell 399 400 .. code:: shell 401 402 > export CROSS_CM3=/opt/arm-cross/bin/arm-linux-gnueabi 403 404(2) DDR initialization library sources (mv_ddr) available at the following repository 405 (use the "master" branch): 406 407 https://github.com/MarvellEmbeddedProcessors/mv-ddr-marvell.git 408 409(3) Armada3700 tools available at the following repository 410 (use the "master" branch): 411 412 https://github.com/MarvellEmbeddedProcessors/A3700-utils-marvell.git 413 414(4) Crypto++ library available at the following repository: 415 416 https://github.com/weidai11/cryptopp.git 417 418(5) Optional CZ.NIC's Armada 3720 Secure Firmware: 419 420 https://gitlab.nic.cz/turris/mox-boot-builder.git 421 422Armada70x0, Armada80x0 and CN913x Builds require installation of additional components 423~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 424 425(1) DDR initialization library sources (mv_ddr) available at the following repository 426 (use the "master" branch): 427 428 https://github.com/MarvellEmbeddedProcessors/mv-ddr-marvell.git 429 430(2) MSS Management SubSystem Firmware available at the following repository 431 (use the "binaries-marvell-armada-SDK10.0.1.0" branch): 432 433 https://github.com/MarvellEmbeddedProcessors/binaries-marvell.git 434