docs/plat/marvell/build.txt

   1 TF-A Build Instructions
   2 ======================
   3
   4 This section describes how to compile the ARM Trusted Firmware (TF-A) project for Marvell's platforms.
   5
   6 Build Instructions
   7 ------------------
   8 (1) Set the cross compiler::
   9
  10                 > export CROSS_COMPILE=/path/to/toolchain/aarch64-linux-gnu-
  11
  12 (2) Set path for FIP images:
  13
  14         Set U-Boot image path (relatively to TF-A root or absolute path)::
  15
  16                 > export BL33=path/to/u-boot.bin
  17
  18         For example: if U-Boot project (and its images) is located at ~/project/u-boot,
  19         BL33 should be ~/project/u-boot/u-boot.bin
  20
  21         .. note::
  22
  23            u-boot.bin should be used and not u-boot-spl.bin
  24
  25         Set MSS/SCP image path (mandatory only for Armada80x0)::
  26
  27                 > export SCP_BL2=path/to/mrvl_scp_bl2*.img
  28
  29 (3) Armada-37x0 build requires WTP tools installation.
  30
  31         See below in the section "Tools and external components installation".
  32         Install ARM 32-bit cross compiler, which is required for building WTMI image for CM3::
  33
  34                 > sudo apt-get install gcc-arm-linux-gnueabi
  35
  36 (4) Clean previous build residuals (if any)::
  37
  38                 > make distclean
  39
  40 (5) Build TF-A:
  41
  42         There are several build options:
  43
  44         - DEBUG: default is without debug information (=0). in order to enable it use DEBUG=1
  45                 Must be disabled when building UART recovery images due to current console driver
  46                 implementation that is not compatible with Xmodem protocol used for boot image download.
  47
  48         - LOG_LEVEL: defines the level of logging which will be purged to the default output port.
  49
  50                 LOG_LEVEL_NONE          0
  51                 LOG_LEVEL_ERROR         10
  52                 LOG_LEVEL_NOTICE        20
  53                 LOG_LEVEL_WARNING       30
  54                 LOG_LEVEL_INFO          40
  55                 LOG_LEVEL_VERBOSE       50
  56
  57         - USE_COHERENT_MEM: This flag determines whether to include the coherent memory region in the
  58                 BL memory map or not.
  59
  60         - LLC_ENABLE: Flag defining the LLC (L3) cache state. The cache is enabled by default (LLC_ENABLE=1).
  61
  62         - MARVELL_SECURE_BOOT: build trusted(=1)/non trusted(=0) image, default is non trusted.
  63
  64         - BLE_PATH:
  65                 Points to BLE (Binary ROM extension) sources folder. Only required for A8K builds.
  66                 The parameter is optional, its default value is "plat/marvell/a8k/common/ble".
  67
  68         - MV_DDR_PATH:
  69                 For A7/8K, use this parameter to point to mv_ddr driver sources to allow BLE build. For A37x0,
  70                 it is used for ddr_tool build.
  71                 Usage example: MV_DDR_PATH=path/to/mv_ddr
  72                 The parameter is optional for A7/8K, when this parameter is not set, the mv_ddr
  73                 sources are expected to be located at: drivers/marvell/mv_ddr. However, the parameter
  74                 is necessary for A37x0.
  75                 For the mv_ddr source location, check the section "Tools and external components installation"
  76
  77         - DDR_TOPOLOGY: For Armada37x0 only, the DDR topology map index/name, default is 0.
  78                 Supported Options:
  79                         - DDR3 1CS (0): DB-88F3720-DDR3-Modular (512MB); EspressoBIN (512MB)
  80                         - DDR4 1CS (1): DB-88F3720-DDR4-Modular (512MB)
  81                         - DDR3 2CS (2): EspressoBIN V3-V5 (1GB)
  82                         - DDR4 2CS (3): DB-88F3720-DDR4-Modular (4GB)
  83                         - DDR3 1CS (4): DB-88F3720-DDR3-Modular (1GB)
  84                         - DDR4 1CS (5): EspressoBin V7 (1GB)
  85                         - DDR4 2CS (6): EspressoBin V7 (2GB)
  86                         - CUSTOMER (CUST): Customer board, DDR3 1CS 512MB
  87
  88         - CLOCKSPRESET: For Armada37x0 only, the clock tree configuration preset including CPU and DDR frequency,
  89                 default is CPU_800_DDR_800.
  90                         - CPU_600_DDR_600       -       CPU at 600 MHz, DDR at 600 MHz
  91                         - CPU_800_DDR_800       -       CPU at 800 MHz, DDR at 800 MHz
  92                         - CPU_1000_DDR_800      -       CPU at 1000 MHz, DDR at 800 MHz
  93                         - CPU_1200_DDR_750      -       CPU at 1200 MHz, DDR at 750 MHz
  94
  95         - BOOTDEV: For Armada37x0 only, the flash boot device, default is SPINOR,
  96                 Currently, Armada37x0 only supports SPINOR, SPINAND, EMMCNORM and SATA:
  97
  98                         - SPINOR - SPI NOR flash boot
  99                         - SPINAND - SPI NAND flash boot
 100                         - EMMCNORM - eMMC Download Mode
 101                                 Download boot loader or program code from eMMC flash into CM3 or CA53
 102                                 Requires full initialization and command sequence
 103                         - SATA - SATA device boot
 104
 105         - PARTNUM: For Armada37x0 only, the boot partition number, default is 0. To boot from eMMC, the value
 106                 should be aligned with the parameter in U-Boot with name of CONFIG_SYS_MMC_ENV_PART, whose
 107                 value by default is 1.
 108                 For details about CONFIG_SYS_MMC_ENV_PART, please refer to the U-Boot build instructions.
 109
 110         - WTMI_IMG: For Armada37x0 only, the path of the WTMI image can point to an image which does
 111                 nothing, an image which supports EFUSE or a customized CM3 firmware binary. The default image
 112                 is wtmi.bin that built from sources in WTP folder, which is the next option. If the default
 113                 image is OK, then this option should be skipped.
 114
 115         - WTP: For Armada37x0 only, use this parameter to point to wtptools source code directory, which
 116                 can be found as a3700_utils.zip in the release.
 117                 Usage example: WTP=/path/to/a3700_utils
 118
 119         For example, in order to build the image in debug mode with log level up to 'notice' level run::
 120
 121                 > make DEBUG=1 USE_COHERENT_MEM=0 LOG_LEVEL=20 PLAT=<MARVELL_PLATFORM> all fip
 122
 123         And if we want to build a Armada37x0 image in debug mode with log level up to 'notice' level,
 124         the image has the preset CPU at 1000 MHz, preset DDR3 at 800 MHz, the DDR topology of DDR4 2CS,
 125         the image boot from SPI NOR flash partition 0, and the image is non trusted in WTP, the command
 126         line is as following::
 127
 128                 > make DEBUG=1 USE_COHERENT_MEM=0 LOG_LEVEL=20 CLOCKSPRESET=CPU_1000_DDR_800 \
 129                         MARVELL_SECURE_BOOT=0 DDR_TOPOLOGY=3 BOOTDEV=SPINOR PARTNUM=0 PLAT=a3700 all fip
 130
 131         Supported MARVELL_PLATFORM are:
 132                 - a3700 (for both A3720 DB and EspressoBin)
 133                 - a70x0
 134                 - a70x0_amc (for AMC board)
 135                 - a80x0
 136                 - a80x0_mcbin (for MacciatoBin)
 137
 138 Special Build Flags
 139 --------------------
 140         - PLAT_RECOVERY_IMAGE_ENABLE: When set this option to enable secondary recovery function when build
 141                 atf. In order to build UART recovery image this operation should be disabled for a70x0 and a80x0
 142                 because of hardware limitation (boot from secondary image can interrupt UART recovery process).
 143                 This MACRO definition is set in plat/marvell/a8k/common/include/platform_def.h file
 144
 145 (for more information about build options, please refer to section 'Summary of build options' in  TF-A user-guide:
 146  https://github.com/ARM-software/arm-trusted-firmware/blob/master/docs/user-guide.md)
 147
 148
 149 Build output
 150 -------------
 151 Marvell's TF-A compilation generates 7 files:
 152         - ble.bin               - BLe image
 153         - bl1.bin               - BL1 image
 154         - bl2.bin               - BL2 image
 155         - bl31.bin              - BL31 image
 156         - fip.bin               - FIP image (contains BL2, BL31 & BL33 (U-Boot) images)
 157         - boot-image.bin        - TF-A image (contains BL1 and FIP images)
 158         - flash-image.bin       - Image which contains boot-image.bin and SPL image;
 159                                   should be placed on the boot flash/device.
 160
 161
 162 Tools and external components installation
 163 ==========================================
 164
 165 Armada37x0 Builds require installation of 3 components
 166 -------------------------------------------------------
 167
 168 (1) ARM cross compiler capable of building images for the service CPU (CM3).
 169     This component is usually included in the Linux host packages.
 170     On Debian/Ubuntu hosts the default GNU ARM tool chain can be installed
 171     using the following command::
 172
 173                 > sudo apt-get install gcc-arm-linux-gnueabi
 174
 175     Only if required, the default tool chain prefix "arm-linux-gnueabi-" can be
 176     overwritten using the environment variable CROSS_CM3.
 177     Example for BASH shell::
 178
 179                 > export CROSS_CM3=/opt/arm-cross/bin/arm-linux-gnueabi
 180
 181 (2) DDR initialization library sources (mv_ddr) available at the following repository
 182     (use the "mv_ddr-armada-atf-mainline" branch)::
 183     https://github.com/MarvellEmbeddedProcessors/mv-ddr-marvell.git
 184
 185 (3) Armada3700 tools available at the following repository (use the latest release branch)::
 186     https://github.com/MarvellEmbeddedProcessors/A3700-utils-marvell.git
 187
 188 Armada70x0 and Armada80x0 Builds require installation of an additional component
 189 --------------------------------------------------------------------------------
 190
 191 (1) DDR initialization library sources (mv_ddr) available at the following repository
 192     (use the "mv_ddr-armada-atf-mainline" branch)::
 193     https://github.com/MarvellEmbeddedProcessors/mv-ddr-marvell.git
 194