1Xilinx Versal 2============= 3 4Trusted Firmware-A implements the EL3 firmware layer for Xilinx Versal. 5The platform only uses the runtime part of TF-A as Xilinx Versal already has a 6BootROM (BL1) and PMC FW (BL2). 7 8BL31 is TF-A. 9BL32 is an optional Secure Payload. 10BL33 is the non-secure world software (U-Boot, Linux etc). 11 12To build: 13```bash 14make RESET_TO_BL31=1 CROSS_COMPILE=aarch64-none-elf- PLAT=versal bl31 15``` 16 17To build bl32 TSP you have to rebuild bl31 too 18```bash 19make CROSS_COMPILE=aarch64-none-elf- PLAT=versal SPD=tspd RESET_TO_BL31=1 bl31 bl32 20``` 21 22To build TF-A for JTAG DCC console 23```bash 24make RESET_TO_BL31=1 CROSS_COMPILE=aarch64-none-elf- PLAT=versal bl31 VERSAL_CONSOLE=dcc 25``` 26 27To build TF-A with Errata management interface 28```bash 29make RESET_TO_BL31=1 CROSS_COMPILE=aarch64-none-elf- PLAT=versal bl31 ERRATA_ABI_SUPPORT=1 30``` 31 32To build TF-A with Straight-Line Speculation(SLS) 33```bash 34make RESET_TO_BL31=1 CROSS_COMPILE=aarch64-none-elf- PLAT=versal bl31 HARDEN_SLS_ALL=1 35``` 36 37Xilinx Versal platform specific build options 38--------------------------------------------- 39 40* `VERSAL_ATF_MEM_BASE`: Specifies the base address of the bl31 binary. 41* `VERSAL_ATF_MEM_SIZE`: Specifies the size of the memory region of the bl31 binary. 42* `VERSAL_BL32_MEM_BASE`: Specifies the base address of the bl32 binary. 43* `VERSAL_BL32_MEM_SIZE`: Specifies the size of the memory region of the bl32 binary. 44 45* `VERSAL_CONSOLE`: Select the console driver. Options: 46 - `pl011`, `pl011_0`: ARM pl011 UART 0 47 - `pl011_1` : ARM pl011 UART 1 48 49* `CPU_PWRDWN_SGI`: Select the SGI for triggering CPU power down request to 50 secondary cores on receiving power down callback from 51 firmware. Options: 52 53 - `0` : SGI 0 54 - `1` : SGI 1 55 - `2` : SGI 2 56 - `3` : SGI 3 57 - `4` : SGI 4 58 - `5` : SGI 5 59 - `6` : SGI 6 (Default) 60 - `7` : SGI 7 61 62Configurable Stack Size 63----------------------- 64 65The stack size in TF-A for the Versal platform is configurable. 66The custom package can define the desired stack size as per the requirement in 67the makefile as follows: 68 69.. code-block:: shell 70 71 PLATFORM_STACK_SIZE := <value> 72 73 $(eval $(call add_define,PLATFORM_STACK_SIZE)) 74 75Configurable APU IPI ID 76----------------------- 77 78The APU IPI ID in TF-A for the Versal platform is configurable as per the design. 79 80To build PLAT_IPI_ID_APU: 81 82.. code-block:: shell 83 84 make CROSS_COMPILE=aarch64-none-elf- PLAT=versal RESET_TO_BL31=1 bl31 PLAT_IPI_ID_APU=<value> 85 86 $(eval $(call add_define,PLAT_IPI_ID_APU)) 87 88CUSTOM SIP Service Support 89-------------------------- 90 91- Dedicated SMC FID ``SOC_SIP_SVC_CUSTOM(0x82002000)`` (32-bit) / 92 ``(0xC2002000)`` (64-bit) is used by a custom package for providing 93 CUSTOM SIP service. 94 95- By default, the platform provides a bare minimum definition for 96 ``custom_smc_handler`` in this service. 97 98- To use this service, the custom package should implement its own SMC handler 99 named ``custom_smc_handler``. Once the custom package is included in the 100 TF-A build, its definition of ``custom_smc_handler`` is enabled. 101 102Custom Package Makefile Fragment Inclusion in TF-A Build 103-------------------------------------------------------- 104 105- Custom package is not directly part of the TF-A source. 106 107- ``<CUSTOM_PKG_PATH>`` is the location where the user clones a 108 custom package locally. 109 110- The custom package must implement a makefile fragment named 111 ``custom_pkg.mk`` so it can be included in the TF-A build. 112 113- ``custom_pkg.mk`` should specify all the rules to include custom package 114 specific header files, dependent libraries, and source files that are 115 required to be part of the TF-A build. 116 117- When ``<CUSTOM_PKG_PATH>`` is specified in the TF-A build command, 118 ``custom_pkg.mk`` is included from ``<CUSTOM_PKG_PATH>``. 119 120- Example TF-A build command: 121 122.. code-block:: shell 123 124 make CROSS_COMPILE=aarch64-none-elf- PLAT=versal RESET_TO_BL31=1 bl31 CUSTOM_PKG_PATH=<...> 125 126# PLM->TF-A Parameter Passing 127------------------------------ 128The PLM populates a data structure with image information for the TF-A. The TF-A 129uses that data to hand off to the loaded images. The address of the handoff 130data structure is passed in the ```PMC_GLOBAL_GLOB_GEN_STORAGE4``` register. 131The register is free to be used by other software once the TF-A is bringing up 132further firmware images. 133 134Reference DEN0028E SMC calling convention 135------------------------------------------ 136 137Allocated subranges of Function Identifier to SIP services 138---------------------------------------------------------- 139 140+-----------------------+-------------------------------------------------------+ 141| SMC Function | Identifier Service type | 142+-----------------------+-------------------------------------------------------+ 143| 0xC2000000-0xC200FFFF | Fast SMC64 SiP Service Calls as per SMCCC Section 6.1 | 144+-----------------------+-------------------------------------------------------+ 145 146IPI SMC call ranges 147------------------- 148 149+---------------------------+-----------------------------------------------------------+ 150| SMC Function Identifier | Service type | 151+---------------------------+-----------------------------------------------------------+ 152| 0xc2001000-0xc2001FFF | Fast SMC64 SiP Service call range used for AMD-Xilinx IPI | 153+---------------------------+-----------------------------------------------------------+ 154 155PM SMC call ranges for SiP SVC version 0.1 156-------------------------------------------------------- 157 158+---------------------------+---------------------------------------------------------------------------+ 159| SMC Function Identifier | Service type | 160+---------------------------+---------------------------------------------------------------------------+ 161| 0xc2000000-0xc2000FFF | Fast SMC64 SiP Service call range used for AMD-Xilinx Platform Management | 162+---------------------------+---------------------------------------------------------------------------+ 163 164PM SMC call ranges for SiP SVC version 0.2 165-------------------------------------------------------- 166 167+---------------------------+---------------------------------------------------------------------------+ 168| SMC Function Identifier | Service type | 169+---------------------------+---------------------------------------------------------------------------+ 170| 0xc2000FFF | Fast SMC64 SiP Service call used for pass-through of AMD-Xilinx Platform | 171| | Management APIs to firmware | 172+---------------------------+---------------------------------------------------------------------------+ 173| 0xc2000A00-0xc2000AFF | Fast SMC64 SiP Service call range used for AMD-Xilinx Platform Management | 174| | specific TF-A APIs | 175+---------------------------+---------------------------------------------------------------------------+ 176 177SMC function IDs for SiP Service queries 178---------------------------------------- 179 180+--------------+--------------+--------------+ 181| Service | Call UID | Revision | 182+--------------+--------------+--------------+ 183| SiP Service | 0x8200_FF01 | 0x8200_FF03 | 184+--------------+--------------+--------------+ 185 186Call UID Query – Returns a unique identifier of the service provider. 187 188Revision Query – Returns revision details of the service implementor. 189