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
62# PLM->TF-A Parameter Passing
63------------------------------
64The PLM populates a data structure with image information for the TF-A. The TF-A
65uses that data to hand off to the loaded images. The address of the handoff
66data structure is passed in the ```PMC_GLOBAL_GLOB_GEN_STORAGE4``` register.
67The register is free to be used by other software once the TF-A is bringing up
68further firmware images.
69
70Reference DEN0028E SMC calling convention
71------------------------------------------
72
73Allocated subranges of Function Identifier to SIP services
74----------------------------------------------------------
75
76+-----------------------+-------------------------------------------------------+
77|    SMC Function       | Identifier Service type                               |
78+-----------------------+-------------------------------------------------------+
79| 0xC2000000-0xC200FFFF | Fast SMC64 SiP Service Calls as per SMCCC Section 6.1 |
80+-----------------------+-------------------------------------------------------+
81
82IPI SMC call ranges
83-------------------
84
85+---------------------------+-----------------------------------------------------------+
86| SMC Function Identifier   | Service type                                              |
87+---------------------------+-----------------------------------------------------------+
88| 0xc2001000-0xc2001FFF     | Fast SMC64 SiP Service call range used for AMD-Xilinx IPI |
89+---------------------------+-----------------------------------------------------------+
90
91PM SMC call ranges for SiP SVC version 0.1
92--------------------------------------------------------
93
94+---------------------------+---------------------------------------------------------------------------+
95|   SMC Function Identifier |  Service type                                                             |
96+---------------------------+---------------------------------------------------------------------------+
97| 0xc2000000-0xc2000FFF     | Fast SMC64 SiP Service call range used for AMD-Xilinx Platform Management |
98+---------------------------+---------------------------------------------------------------------------+
99
100PM SMC call ranges for SiP SVC version 0.2
101--------------------------------------------------------
102
103+---------------------------+---------------------------------------------------------------------------+
104|   SMC Function Identifier |  Service type                                                             |
105+---------------------------+---------------------------------------------------------------------------+
106| 0xc2000FFF                | Fast SMC64 SiP Service call used for pass-through of AMD-Xilinx Platform  |
107|                           | Management APIs to firmware                                               |
108+---------------------------+---------------------------------------------------------------------------+
109| 0xc2000A00-0xc2000AFF     | Fast SMC64 SiP Service call range used for AMD-Xilinx Platform Management |
110|                           | specific TF-A APIs                                                        |
111+---------------------------+---------------------------------------------------------------------------+
112
113SMC function IDs for SiP Service queries
114----------------------------------------
115
116+--------------+--------------+--------------+
117|  Service     | Call UID     | Revision     |
118+--------------+--------------+--------------+
119|  SiP Service | 0x8200_FF01  | 0x8200_FF03  |
120+--------------+--------------+--------------+
121
122Call UID Query – Returns a unique identifier of the service provider.
123
124Revision Query – Returns revision details of the service implementor.
125