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 ATF for different platform (supported are "silicon"(default) and "versal_virt")
18```bash
19make RESET_TO_BL31=1 CROSS_COMPILE=aarch64-none-elf- PLAT=versal VERSAL_PLATFORM=versal_virt bl31
20```
21
22To build bl32 TSP you have to rebuild bl31 too
23```bash
24make CROSS_COMPILE=aarch64-none-elf- PLAT=versal SPD=tspd RESET_TO_BL31=1 bl31 bl32
25```
26
27To build TF-A for JTAG DCC console
28```bash
29make RESET_TO_BL31=1 CROSS_COMPILE=aarch64-none-elf- PLAT=versal bl31 VERSAL_CONSOLE=dcc
30```
31
32To build TF-A with Errata management interface
33```bash
34make RESET_TO_BL31=1 CROSS_COMPILE=aarch64-none-elf- PLAT=versal bl31 ERRATA_ABI_SUPPORT=1
35```
36
37To build TF-A with Straight-Line Speculation(SLS)
38```bash
39make RESET_TO_BL31=1 CROSS_COMPILE=aarch64-none-elf- PLAT=versal bl31 HARDEN_SLS_ALL=1
40```
41
42Xilinx Versal platform specific build options
43---------------------------------------------
44
45*   `VERSAL_ATF_MEM_BASE`: Specifies the base address of the bl31 binary.
46*   `VERSAL_ATF_MEM_SIZE`: Specifies the size of the memory region of the bl31 binary.
47*   `VERSAL_BL32_MEM_BASE`: Specifies the base address of the bl32 binary.
48*   `VERSAL_BL32_MEM_SIZE`: Specifies the size of the memory region of the bl32 binary.
49
50*   `VERSAL_CONSOLE`: Select the console driver. Options:
51    -   `pl011`, `pl011_0`: ARM pl011 UART 0
52    -   `pl011_1`         : ARM pl011 UART 1
53
54*   `VERSAL_PLATFORM`: Select the platform. Options:
55    -   `versal_virt`	: Versal Virtual platform
56    -   `spp_itr6`	: SPP ITR6
57    -   `emu_itr6`	: EMU ITR6
58
59*   `CPU_PWRDWN_SGI`: Select the SGI for triggering CPU power down request to
60                      secondary cores on receiving power down callback from
61                      firmware. Options:
62
63    -   `0`   : SGI 0
64    -   `1`   : SGI 1
65    -   `2`   : SGI 2
66    -   `3`   : SGI 3
67    -   `4`   : SGI 4
68    -   `5`   : SGI 5
69    -   `6`   : SGI 6 (Default)
70    -   `7`   : SGI 7
71
72# PLM->TF-A Parameter Passing
73------------------------------
74The PLM populates a data structure with image information for the TF-A. The TF-A
75uses that data to hand off to the loaded images. The address of the handoff
76data structure is passed in the ```PMC_GLOBAL_GLOB_GEN_STORAGE4``` register.
77The register is free to be used by other software once the TF-A is bringing up
78further firmware images.
79
80Reference DEN0028E SMC calling convention
81------------------------------------------
82
83Allocated subranges of Function Identifier to SIP services
84----------------------------------------------------------
85
86+-----------------------+-------------------------------------------------------+
87|    SMC Function       | Identifier Service type                               |
88+-----------------------+-------------------------------------------------------+
89| 0xC2000000-0xC200FFFF | Fast SMC64 SiP Service Calls as per SMCCC Section 6.1 |
90+-----------------------+-------------------------------------------------------+
91
92IPI SMC call ranges
93-------------------
94
95+---------------------------+-----------------------------------------------------------+
96| SMC Function Identifier   | Service type                                              |
97+---------------------------+-----------------------------------------------------------+
98| 0xc2001000-0xc2001FFF     | Fast SMC64 SiP Service call range used for AMD-Xilinx IPI |
99+---------------------------+-----------------------------------------------------------+
100
101PM SMC call ranges
102------------------
103
104+---------------------------+---------------------------------------------------------------------------+
105|   SMC Function Identifier |  Service type                                                             |
106+---------------------------+---------------------------------------------------------------------------+
107| 0xc2000000-0xc2000FFF     | Fast SMC64 SiP Service call range used for AMD-Xilinx Platform Management |
108+---------------------------+---------------------------------------------------------------------------+
109
110SMC function IDs for SiP Service queries
111----------------------------------------
112
113+--------------+--------------+--------------+
114|  Service     | Call UID     | Revision     |
115+--------------+--------------+--------------+
116|  SiP Service | 0x8200_FF01  | 0x8200_FF03  |
117+--------------+--------------+--------------+
118
119Call UID Query – Returns a unique identifier of the service provider.
120
121Revision Query – Returns revision details of the service implementor.
122