blob: 2a98d0e931a4eeeef6545be86adffddd50e544c5 [file] [log] [blame] [view]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001ARM Trusted Firmware Porting Guide
2==================================
3
4Contents
5--------
6
71. Introduction
82. Common Modifications
9 * Common mandatory modifications
Vikram Kanigirie452cd82014-05-23 15:56:12 +010010 * Handling reset
Achin Gupta4f6ad662013-10-25 09:08:21 +010011 * Common optional modifications
123. Boot Loader stage specific modifications
13 * Boot Loader stage 1 (BL1)
14 * Boot Loader stage 2 (BL2)
15 * Boot Loader stage 3-1 (BL3-1)
16 * PSCI implementation (in BL3-1)
Achin Guptaa4fa3cb2014-06-02 22:27:36 +010017 * Interrupt Management framework (in BL3-1)
Harry Liebeld265bd72014-01-31 19:04:10 +0000184. C Library
195. Storage abstraction layer
Achin Gupta4f6ad662013-10-25 09:08:21 +010020
21- - - - - - - - - - - - - - - - - -
22
231. Introduction
24----------------
25
26Porting the ARM Trusted Firmware to a new platform involves making some
27mandatory and optional modifications for both the cold and warm boot paths.
28Modifications consist of:
29
30* Implementing a platform-specific function or variable,
31* Setting up the execution context in a certain way, or
32* Defining certain constants (for example #defines).
33
Dan Handleyb68954c2014-05-29 12:30:24 +010034The platform-specific functions and variables are all declared in
35[include/plat/common/platform.h]. The firmware provides a default implementation
36of variables and functions to fulfill the optional requirements. These
37implementations are all weakly defined; they are provided to ease the porting
38effort. Each platform port can override them with its own implementation if the
39default implementation is inadequate.
Achin Gupta4f6ad662013-10-25 09:08:21 +010040
41Some modifications are common to all Boot Loader (BL) stages. Section 2
42discusses these in detail. The subsequent sections discuss the remaining
43modifications for each BL stage in detail.
44
45This document should be read in conjunction with the ARM Trusted Firmware
46[User Guide].
47
48
492. Common modifications
50------------------------
51
52This section covers the modifications that should be made by the platform for
53each BL stage to correctly port the firmware stack. They are categorized as
54either mandatory or optional.
55
56
572.1 Common mandatory modifications
58----------------------------------
59A platform port must enable the Memory Management Unit (MMU) with identity
60mapped page tables, and enable both the instruction and data caches for each BL
61stage. In the ARM FVP port, each BL stage configures the MMU in its platform-
62specific architecture setup function, for example `blX_plat_arch_setup()`.
63
64Each platform must allocate a block of identity mapped secure memory with
65Device-nGnRE attributes aligned to page boundary (4K) for each BL stage. This
66memory is identified by the section name `tzfw_coherent_mem` so that its
67possible for the firmware to place variables in it using the following C code
68directive:
69
70 __attribute__ ((section("tzfw_coherent_mem")))
71
72Or alternatively the following assembler code directive:
73
74 .section tzfw_coherent_mem
75
76The `tzfw_coherent_mem` section is used to allocate any data structures that are
77accessed both when a CPU is executing with its MMU and caches enabled, and when
78it's running with its MMU and caches disabled. Examples are given below.
79
80The following variables, functions and constants must be defined by the platform
81for the firmware to work correctly.
82
83
Dan Handleyb68954c2014-05-29 12:30:24 +010084### File : platform_def.h [mandatory]
Achin Gupta4f6ad662013-10-25 09:08:21 +010085
Dan Handleyb68954c2014-05-29 12:30:24 +010086Each platform must ensure that a header file of this name is in the system
87include path with the following constants defined. This may require updating the
88list of `PLAT_INCLUDES` in the `platform.mk` file. In the ARM FVP port, this
89file is found in [plat/fvp/include/platform_def.h].
Achin Gupta4f6ad662013-10-25 09:08:21 +010090
James Morrisseyba3155b2013-10-29 10:56:46 +000091* **#define : PLATFORM_LINKER_FORMAT**
Achin Gupta4f6ad662013-10-25 09:08:21 +010092
93 Defines the linker format used by the platform, for example
94 `elf64-littleaarch64` used by the FVP.
95
James Morrisseyba3155b2013-10-29 10:56:46 +000096* **#define : PLATFORM_LINKER_ARCH**
Achin Gupta4f6ad662013-10-25 09:08:21 +010097
98 Defines the processor architecture for the linker by the platform, for
99 example `aarch64` used by the FVP.
100
James Morrisseyba3155b2013-10-29 10:56:46 +0000101* **#define : PLATFORM_STACK_SIZE**
Achin Gupta4f6ad662013-10-25 09:08:21 +0100102
103 Defines the normal stack memory available to each CPU. This constant is used
Andrew Thoelke2bf28e62014-03-20 10:48:23 +0000104 by [plat/common/aarch64/platform_mp_stack.S] and
105 [plat/common/aarch64/platform_up_stack.S].
106
107* **#define : PCPU_DV_MEM_STACK_SIZE**
108
109 Defines the coherent stack memory available to each CPU. This constant is used
110 by [plat/common/aarch64/platform_mp_stack.S] and
111 [plat/common/aarch64/platform_up_stack.S].
Achin Gupta4f6ad662013-10-25 09:08:21 +0100112
James Morrisseyba3155b2013-10-29 10:56:46 +0000113* **#define : FIRMWARE_WELCOME_STR**
Achin Gupta4f6ad662013-10-25 09:08:21 +0100114
115 Defines the character string printed by BL1 upon entry into the `bl1_main()`
116 function.
117
James Morrisseyba3155b2013-10-29 10:56:46 +0000118* **#define : BL2_IMAGE_NAME**
Achin Gupta4f6ad662013-10-25 09:08:21 +0100119
120 Name of the BL2 binary image on the host file-system. This name is used by
Harry Liebeld265bd72014-01-31 19:04:10 +0000121 BL1 to load BL2 into secure memory from non-volatile storage.
122
123* **#define : BL31_IMAGE_NAME**
124
125 Name of the BL3-1 binary image on the host file-system. This name is used by
126 BL2 to load BL3-1 into secure memory from platform storage.
127
128* **#define : BL33_IMAGE_NAME**
129
130 Name of the BL3-3 binary image on the host file-system. This name is used by
131 BL2 to load BL3-3 into non-secure memory from platform storage.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100132
James Morrisseyba3155b2013-10-29 10:56:46 +0000133* **#define : PLATFORM_CACHE_LINE_SIZE**
Achin Gupta4f6ad662013-10-25 09:08:21 +0100134
135 Defines the size (in bytes) of the largest cache line across all the cache
136 levels in the platform.
137
James Morrisseyba3155b2013-10-29 10:56:46 +0000138* **#define : PLATFORM_CLUSTER_COUNT**
Achin Gupta4f6ad662013-10-25 09:08:21 +0100139
140 Defines the total number of clusters implemented by the platform in the
141 system.
142
James Morrisseyba3155b2013-10-29 10:56:46 +0000143* **#define : PLATFORM_CORE_COUNT**
Achin Gupta4f6ad662013-10-25 09:08:21 +0100144
145 Defines the total number of CPUs implemented by the platform across all
146 clusters in the system.
147
James Morrisseyba3155b2013-10-29 10:56:46 +0000148* **#define : PLATFORM_MAX_CPUS_PER_CLUSTER**
Achin Gupta4f6ad662013-10-25 09:08:21 +0100149
150 Defines the maximum number of CPUs that can be implemented within a cluster
151 on the platform.
152
Andrew Thoelke6c0b45d2014-06-20 00:36:14 +0100153* **#define : PLATFORM_NUM_AFFS**
154
155 Defines the total number of nodes in the affinity heirarchy at all affinity
156 levels used by the platform.
157
James Morrisseyba3155b2013-10-29 10:56:46 +0000158* **#define : PRIMARY_CPU**
Achin Gupta4f6ad662013-10-25 09:08:21 +0100159
160 Defines the `MPIDR` of the primary CPU on the platform. This value is used
161 after a cold boot to distinguish between primary and secondary CPUs.
162
James Morrisseyba3155b2013-10-29 10:56:46 +0000163* **#define : TZROM_BASE**
Achin Gupta4f6ad662013-10-25 09:08:21 +0100164
165 Defines the base address of secure ROM on the platform, where the BL1 binary
166 is loaded. This constant is used by the linker scripts to ensure that the
167 BL1 image fits into the available memory.
168
James Morrisseyba3155b2013-10-29 10:56:46 +0000169* **#define : TZROM_SIZE**
Achin Gupta4f6ad662013-10-25 09:08:21 +0100170
171 Defines the size of secure ROM on the platform. This constant is used by the
172 linker scripts to ensure that the BL1 image fits into the available memory.
173
James Morrisseyba3155b2013-10-29 10:56:46 +0000174* **#define : TZRAM_BASE**
Achin Gupta4f6ad662013-10-25 09:08:21 +0100175
176 Defines the base address of the secure RAM on platform, where the data
177 section of the BL1 binary is loaded. The BL2 and BL3-1 images are also
178 loaded in this secure RAM region. This constant is used by the linker
179 scripts to ensure that the BL1 data section and BL2/BL3-1 binary images fit
180 into the available memory.
181
James Morrisseyba3155b2013-10-29 10:56:46 +0000182* **#define : TZRAM_SIZE**
Achin Gupta4f6ad662013-10-25 09:08:21 +0100183
184 Defines the size of the secure RAM on the platform. This constant is used by
185 the linker scripts to ensure that the BL1 data section and BL2/BL3-1 binary
186 images fit into the available memory.
187
Sandrine Bailleux638363e2014-05-21 17:08:26 +0100188* **#define : BL1_RO_BASE**
189
190 Defines the base address in secure ROM where BL1 originally lives. Must be
191 aligned on a page-size boundary.
192
193* **#define : BL1_RO_LIMIT**
194
195 Defines the maximum address in secure ROM that BL1's actual content (i.e.
196 excluding any data section allocated at runtime) can occupy.
197
198* **#define : BL1_RW_BASE**
199
200 Defines the base address in secure RAM where BL1's read-write data will live
201 at runtime. Must be aligned on a page-size boundary.
202
203* **#define : BL1_RW_LIMIT**
204
205 Defines the maximum address in secure RAM that BL1's read-write data can
206 occupy at runtime.
207
James Morrisseyba3155b2013-10-29 10:56:46 +0000208* **#define : BL2_BASE**
Achin Gupta4f6ad662013-10-25 09:08:21 +0100209
210 Defines the base address in secure RAM where BL1 loads the BL2 binary image.
Sandrine Bailleuxcd29b0a2013-11-27 10:32:17 +0000211 Must be aligned on a page-size boundary.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100212
Sandrine Bailleux638363e2014-05-21 17:08:26 +0100213* **#define : BL2_LIMIT**
214
215 Defines the maximum address in secure RAM that the BL2 image can occupy.
216
James Morrisseyba3155b2013-10-29 10:56:46 +0000217* **#define : BL31_BASE**
Achin Gupta4f6ad662013-10-25 09:08:21 +0100218
219 Defines the base address in secure RAM where BL2 loads the BL3-1 binary
Sandrine Bailleuxcd29b0a2013-11-27 10:32:17 +0000220 image. Must be aligned on a page-size boundary.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100221
Sandrine Bailleux638363e2014-05-21 17:08:26 +0100222* **#define : BL31_LIMIT**
223
224 Defines the maximum address in secure RAM that the BL3-1 image can occupy.
225
Harry Liebeld265bd72014-01-31 19:04:10 +0000226* **#define : NS_IMAGE_OFFSET**
Sandrine Bailleux2467f702014-05-20 17:22:24 +0100227
Harry Liebeld265bd72014-01-31 19:04:10 +0000228 Defines the base address in non-secure DRAM where BL2 loads the BL3-3 binary
229 image. Must be aligned on a page-size boundary.
230
Sandrine Bailleux2467f702014-05-20 17:22:24 +0100231If the BL3-2 image is supported by the platform, the following constants must
232be defined as well:
233
234* **#define : TSP_SEC_MEM_BASE**
235
236 Defines the base address of the secure memory used by the BL3-2 image on the
237 platform.
238
239* **#define : TSP_SEC_MEM_SIZE**
240
241 Defines the size of the secure memory used by the BL3-2 image on the
242 platform.
243
244* **#define : BL32_BASE**
245
246 Defines the base address in secure memory where BL2 loads the BL3-2 binary
247 image. Must be inside the secure memory identified by `TSP_SEC_MEM_BASE` and
248 `TSP_SEC_MEM_SIZE` constants. Must also be aligned on a page-size boundary.
249
250* **#define : BL32_LIMIT**
251
252 Defines the maximum address that the BL3-2 image can occupy. Must be inside
253 the secure memory identified by `TSP_SEC_MEM_BASE` and `TSP_SEC_MEM_SIZE`
254 constants.
255
256
Dan Handleyb68954c2014-05-29 12:30:24 +0100257### File : plat_macros.S [mandatory]
Soby Mathewa43d4312014-04-07 15:28:55 +0100258
Dan Handleyb68954c2014-05-29 12:30:24 +0100259Each platform must ensure a file of this name is in the system include path with
260the following macro defined. In the ARM FVP port, this file is found in
261[plat/fvp/include/plat_macros.S].
Soby Mathewa43d4312014-04-07 15:28:55 +0100262
263* **Macro : plat_print_gic_regs**
264
265 This macro allows the crash reporting routine to print GIC registers
266 in case of an unhandled IRQ or FIQ in BL3-1. This aids in debugging and
267 this macro can be defined to be empty in case GIC register reporting is
268 not desired.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100269
270### Other mandatory modifications
271
James Morrisseyba3155b2013-10-29 10:56:46 +0000272The following mandatory modifications may be implemented in any file
Achin Gupta4f6ad662013-10-25 09:08:21 +0100273the implementer chooses. In the ARM FVP port, they are implemented in
Andrew Thoelke2bf28e62014-03-20 10:48:23 +0000274[plat/fvp/aarch64/plat_common.c].
Achin Gupta4f6ad662013-10-25 09:08:21 +0100275
Sandrine Bailleux9e864902014-03-31 11:25:18 +0100276* **Function : uint64_t plat_get_syscnt_freq(void)**
277
278 This function is used by the architecture setup code to retrieve the
279 counter frequency for the CPU's generic timer. This value will be
280 programmed into the `CNTFRQ_EL0` register.
281 In the ARM FVP port, it returns the base frequency of the system counter,
282 which is retrieved from the first entry in the frequency modes table.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100283
Andrew Thoelke2bf28e62014-03-20 10:48:23 +0000284
Vikram Kanigirie452cd82014-05-23 15:56:12 +01002852.2 Handling Reset
286------------------
287
288BL1 by default implements the reset vector where execution starts from a cold
289or warm boot. BL3-1 can be optionally set as a reset vector using the
290RESET_TO_BL31 make variable.
291
292For each CPU, the reset vector code is responsible for the following tasks:
293
2941. Distinguishing between a cold boot and a warm boot.
295
2962. In the case of a cold boot and the CPU being a secondary CPU, ensuring that
297 the CPU is placed in a platform-specific state until the primary CPU
298 performs the necessary steps to remove it from this state.
299
3003. In the case of a warm boot, ensuring that the CPU jumps to a platform-
301 specific address in the BL3-1 image in the same processor mode as it was
302 when released from reset.
303
304The following functions need to be implemented by the platform port to enable
305reset vector code to perform the above tasks.
306
307
308### Function : platform_get_entrypoint() [mandatory]
309
310 Argument : unsigned long
311 Return : unsigned int
312
313This function is called with the `SCTLR.M` and `SCTLR.C` bits disabled. The CPU
314is identified by its `MPIDR`, which is passed as the argument. The function is
315responsible for distinguishing between a warm and cold reset using platform-
316specific means. If it's a warm reset then it returns the entrypoint into the
317BL3-1 image that the CPU must jump to. If it's a cold reset then this function
318must return zero.
319
320This function is also responsible for implementing a platform-specific mechanism
321to handle the condition where the CPU has been warm reset but there is no
322entrypoint to jump to.
323
324This function does not follow the Procedure Call Standard used by the
325Application Binary Interface for the ARM 64-bit architecture. The caller should
326not assume that callee saved registers are preserved across a call to this
327function.
328
329This function fulfills requirement 1 and 3 listed above.
330
331
332### Function : plat_secondary_cold_boot_setup() [mandatory]
333
334 Argument : void
335 Return : void
336
337This function is called with the MMU and data caches disabled. It is responsible
338for placing the executing secondary CPU in a platform-specific state until the
339primary CPU performs the necessary actions to bring it out of that state and
340allow entry into the OS.
341
342In the ARM FVP port, each secondary CPU powers itself off. The primary CPU is
343responsible for powering up the secondary CPU when normal world software
344requires them.
345
346This function fulfills requirement 2 above.
347
348
349### Function : platform_mem_init() [mandatory]
350
351 Argument : void
352 Return : void
353
354This function is called before any access to data is made by the firmware, in
355order to carry out any essential memory initialization.
356
357The ARM FVP port uses this function to initialize the mailbox memory used for
358providing the warm-boot entry-point addresses.
359
360
361
3622.3 Common optional modifications
Achin Gupta4f6ad662013-10-25 09:08:21 +0100363---------------------------------
364
365The following are helper functions implemented by the firmware that perform
366common platform-specific tasks. A platform may choose to override these
367definitions.
368
369
370### Function : platform_get_core_pos()
371
372 Argument : unsigned long
373 Return : int
374
375A platform may need to convert the `MPIDR` of a CPU to an absolute number, which
376can be used as a CPU-specific linear index into blocks of memory (for example
377while allocating per-CPU stacks). This routine contains a simple mechanism
378to perform this conversion, using the assumption that each cluster contains a
379maximum of 4 CPUs:
380
381 linear index = cpu_id + (cluster_id * 4)
382
383 cpu_id = 8-bit value in MPIDR at affinity level 0
384 cluster_id = 8-bit value in MPIDR at affinity level 1
385
386
387### Function : platform_set_coherent_stack()
388
389 Argument : unsigned long
390 Return : void
391
392A platform may need stack memory that is coherent with main memory to perform
393certain operations like:
394
395* Turning the MMU on, or
396* Flushing caches prior to powering down a CPU or cluster.
397
398Each BL stage allocates this coherent stack memory for each CPU in the
Andrew Thoelke2bf28e62014-03-20 10:48:23 +0000399`tzfw_coherent_mem` section.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100400
Andrew Thoelke2bf28e62014-03-20 10:48:23 +0000401This function sets the current stack pointer to the coherent stack that
402has been allocated for the CPU specified by MPIDR. For BL images that only
403require a stack for the primary CPU the parameter is ignored. The size of
404the stack allocated to each CPU is specified by the platform defined constant
Achin Gupta4f6ad662013-10-25 09:08:21 +0100405`PCPU_DV_MEM_STACK_SIZE`.
406
Andrew Thoelke2bf28e62014-03-20 10:48:23 +0000407Common implementations of this function for the UP and MP BL images are
408provided in [plat/common/aarch64/platform_up_stack.S] and
409[plat/common/aarch64/platform_mp_stack.S]
410
Achin Gupta4f6ad662013-10-25 09:08:21 +0100411
412### Function : platform_is_primary_cpu()
413
414 Argument : unsigned long
415 Return : unsigned int
416
417This function identifies a CPU by its `MPIDR`, which is passed as the argument,
418to determine whether this CPU is the primary CPU or a secondary CPU. A return
419value of zero indicates that the CPU is not the primary CPU, while a non-zero
420return value indicates that the CPU is the primary CPU.
421
422
423### Function : platform_set_stack()
424
425 Argument : unsigned long
426 Return : void
427
Andrew Thoelke2bf28e62014-03-20 10:48:23 +0000428This function sets the current stack pointer to the normal memory stack that
429has been allocated for the CPU specificed by MPIDR. For BL images that only
430require a stack for the primary CPU the parameter is ignored. The size of
431the stack allocated to each CPU is specified by the platform defined constant
432`PLATFORM_STACK_SIZE`.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100433
Andrew Thoelke2bf28e62014-03-20 10:48:23 +0000434Common implementations of this function for the UP and MP BL images are
435provided in [plat/common/aarch64/platform_up_stack.S] and
436[plat/common/aarch64/platform_mp_stack.S]
Achin Gupta4f6ad662013-10-25 09:08:21 +0100437
438
Achin Guptac8afc782013-11-25 18:45:02 +0000439### Function : platform_get_stack()
440
441 Argument : unsigned long
442 Return : unsigned long
443
Andrew Thoelke2bf28e62014-03-20 10:48:23 +0000444This function returns the base address of the normal memory stack that
445has been allocated for the CPU specificed by MPIDR. For BL images that only
446require a stack for the primary CPU the parameter is ignored. The size of
447the stack allocated to each CPU is specified by the platform defined constant
448`PLATFORM_STACK_SIZE`.
Achin Guptac8afc782013-11-25 18:45:02 +0000449
Andrew Thoelke2bf28e62014-03-20 10:48:23 +0000450Common implementations of this function for the UP and MP BL images are
451provided in [plat/common/aarch64/platform_up_stack.S] and
452[plat/common/aarch64/platform_mp_stack.S]
Achin Guptac8afc782013-11-25 18:45:02 +0000453
454
Achin Gupta4f6ad662013-10-25 09:08:21 +0100455### Function : plat_report_exception()
456
457 Argument : unsigned int
458 Return : void
459
460A platform may need to report various information about its status when an
461exception is taken, for example the current exception level, the CPU security
462state (secure/non-secure), the exception type, and so on. This function is
463called in the following circumstances:
464
465* In BL1, whenever an exception is taken.
466* In BL2, whenever an exception is taken.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100467
468The default implementation doesn't do anything, to avoid making assumptions
469about the way the platform displays its status information.
470
471This function receives the exception type as its argument. Possible values for
Andrew Thoelke2bf28e62014-03-20 10:48:23 +0000472exceptions types are listed in the [include/runtime_svc.h] header file. Note
Achin Gupta4f6ad662013-10-25 09:08:21 +0100473that these constants are not related to any architectural exception code; they
474are just an ARM Trusted Firmware convention.
475
476
4773. Modifications specific to a Boot Loader stage
478-------------------------------------------------
479
4803.1 Boot Loader Stage 1 (BL1)
481-----------------------------
482
483BL1 implements the reset vector where execution starts from after a cold or
484warm boot. For each CPU, BL1 is responsible for the following tasks:
485
Vikram Kanigirie452cd82014-05-23 15:56:12 +01004861. Handling the reset as described in section 2.2
Achin Gupta4f6ad662013-10-25 09:08:21 +0100487
4882. In the case of a cold boot and the CPU being the primary CPU, ensuring that
489 only this CPU executes the remaining BL1 code, including loading and passing
490 control to the BL2 stage.
491
Vikram Kanigirie452cd82014-05-23 15:56:12 +01004923. Loading the BL2 image from non-volatile storage into secure memory at the
Achin Gupta4f6ad662013-10-25 09:08:21 +0100493 address specified by the platform defined constant `BL2_BASE`.
494
Vikram Kanigirie452cd82014-05-23 15:56:12 +01004954. Populating a `meminfo` structure with the following information in memory,
Achin Gupta4f6ad662013-10-25 09:08:21 +0100496 accessible by BL2 immediately upon entry.
497
498 meminfo.total_base = Base address of secure RAM visible to BL2
499 meminfo.total_size = Size of secure RAM visible to BL2
500 meminfo.free_base = Base address of secure RAM available for
501 allocation to BL2
502 meminfo.free_size = Size of secure RAM available for allocation to BL2
503
504 BL1 places this `meminfo` structure at the beginning of the free memory
505 available for its use. Since BL1 cannot allocate memory dynamically at the
506 moment, its free memory will be available for BL2's use as-is. However, this
507 means that BL2 must read the `meminfo` structure before it starts using its
508 free memory (this is discussed in Section 3.2).
509
510 In future releases of the ARM Trusted Firmware it will be possible for
511 the platform to decide where it wants to place the `meminfo` structure for
512 BL2.
513
Sandrine Bailleux8f55dfb2014-06-24 14:02:34 +0100514 BL1 implements the `bl1_init_bl2_mem_layout()` function to populate the
Achin Gupta4f6ad662013-10-25 09:08:21 +0100515 BL2 `meminfo` structure. The platform may override this implementation, for
516 example if the platform wants to restrict the amount of memory visible to
517 BL2. Details of how to do this are given below.
518
519The following functions need to be implemented by the platform port to enable
520BL1 to perform the above tasks.
521
522
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100523### Function : bl1_plat_arch_setup() [mandatory]
Achin Gupta4f6ad662013-10-25 09:08:21 +0100524
525 Argument : void
526 Return : void
527
Achin Gupta4f6ad662013-10-25 09:08:21 +0100528This function performs any platform-specific and architectural setup that the
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100529platform requires. Platform-specific setup might include configuration of
530memory controllers, configuration of the interconnect to allow the cluster
531to service cache snoop requests from another cluster, and so on.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100532
533In the ARM FVP port, this function enables CCI snoops into the cluster that the
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100534primary CPU is part of. It also enables the MMU.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100535
536This function helps fulfill requirement 2 above.
537
538
539### Function : bl1_platform_setup() [mandatory]
540
541 Argument : void
542 Return : void
543
544This function executes with the MMU and data caches enabled. It is responsible
545for performing any remaining platform-specific setup that can occur after the
546MMU and data cache have been enabled.
547
Harry Liebeld265bd72014-01-31 19:04:10 +0000548This function is also responsible for initializing the storage abstraction layer
549which is used to load further bootloader images.
550
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100551This function helps fulfill requirement 3 above.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100552
553
Sandrine Bailleuxee12f6f2013-11-28 14:55:58 +0000554### Function : bl1_plat_sec_mem_layout() [mandatory]
Achin Gupta4f6ad662013-10-25 09:08:21 +0100555
556 Argument : void
Sandrine Bailleuxee12f6f2013-11-28 14:55:58 +0000557 Return : meminfo *
Achin Gupta4f6ad662013-10-25 09:08:21 +0100558
Sandrine Bailleuxee12f6f2013-11-28 14:55:58 +0000559This function should only be called on the cold boot path. It executes with the
560MMU and data caches enabled. The pointer returned by this function must point to
561a `meminfo` structure containing the extents and availability of secure RAM for
562the BL1 stage.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100563
564 meminfo.total_base = Base address of secure RAM visible to BL1
565 meminfo.total_size = Size of secure RAM visible to BL1
566 meminfo.free_base = Base address of secure RAM available for allocation
567 to BL1
568 meminfo.free_size = Size of secure RAM available for allocation to BL1
569
570This information is used by BL1 to load the BL2 image in secure RAM. BL1 also
571populates a similar structure to tell BL2 the extents of memory available for
572its own use.
573
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100574This function helps fulfill requirement 3 above.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100575
576
Sandrine Bailleux8f55dfb2014-06-24 14:02:34 +0100577### Function : bl1_init_bl2_mem_layout() [optional]
Achin Gupta4f6ad662013-10-25 09:08:21 +0100578
579 Argument : meminfo *, meminfo *, unsigned int, unsigned long
580 Return : void
581
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100582BL1 needs to tell the next stage the amount of secure RAM available
583for it to use. This information is populated in a `meminfo`
Achin Gupta4f6ad662013-10-25 09:08:21 +0100584structure.
585
586Depending upon where BL2 has been loaded in secure RAM (determined by
587`BL2_BASE`), BL1 calculates the amount of free memory available for BL2 to use.
588BL1 also ensures that its data sections resident in secure RAM are not visible
589to BL2. An illustration of how this is done in the ARM FVP port is given in the
590[User Guide], in the Section "Memory layout on Base FVP".
591
592
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100593### Function : bl1_plat_set_bl2_ep_info() [mandatory]
594
595 Argument : image_info *, entry_point_info *
596 Return : void
597
598This function is called after loading BL2 image and it can be used to overwrite
599the entry point set by loader and also set the security state and SPSR which
600represents the entry point system state for BL2.
601
602On FVP, we are setting the security state and the SPSR for the BL2 entrypoint
603
604
Achin Gupta4f6ad662013-10-25 09:08:21 +01006053.2 Boot Loader Stage 2 (BL2)
606-----------------------------
607
608The BL2 stage is executed only by the primary CPU, which is determined in BL1
609using the `platform_is_primary_cpu()` function. BL1 passed control to BL2 at
610`BL2_BASE`. BL2 executes in Secure EL1 and is responsible for:
611
Sandrine Bailleux93d81d62014-06-24 14:19:36 +01006121. (Optional) Loading the BL3-0 binary image (if present) from platform
613 provided non-volatile storage. To load the BL3-0 image, BL2 makes use of
614 the `meminfo` returned by the `bl2_plat_get_bl30_meminfo()` function.
615 The platform also defines the address in memory where BL3-0 is loaded
616 through the optional constant `BL30_BASE`. BL2 uses this information
617 to determine if there is enough memory to load the BL3-0 image.
618 Subsequent handling of the BL3-0 image is platform-specific and is
619 implemented in the `bl2_plat_handle_bl30()` function.
620 If `BL30_BASE` is not defined then this step is not performed.
621
6222. Loading the BL3-1 binary image into secure RAM from non-volatile storage. To
Harry Liebeld265bd72014-01-31 19:04:10 +0000623 load the BL3-1 image, BL2 makes use of the `meminfo` structure passed to it
624 by BL1. This structure allows BL2 to calculate how much secure RAM is
625 available for its use. The platform also defines the address in secure RAM
626 where BL3-1 is loaded through the constant `BL31_BASE`. BL2 uses this
627 information to determine if there is enough memory to load the BL3-1 image.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100628
Sandrine Bailleux93d81d62014-06-24 14:19:36 +01006293. (Optional) Loading the BL3-2 binary image (if present) from platform
Dan Handley1151c822014-04-15 11:38:38 +0100630 provided non-volatile storage. To load the BL3-2 image, BL2 makes use of
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100631 the `meminfo` returned by the `bl2_plat_get_bl32_meminfo()` function.
632 The platform also defines the address in memory where BL3-2 is loaded
633 through the optional constant `BL32_BASE`. BL2 uses this information
634 to determine if there is enough memory to load the BL3-2 image.
635 If `BL32_BASE` is not defined then this and the next step is not performed.
Achin Guptaa3050ed2014-02-19 17:52:35 +0000636
Sandrine Bailleux93d81d62014-06-24 14:19:36 +01006374. (Optional) Arranging to pass control to the BL3-2 image (if present) that
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100638 has been pre-loaded at `BL32_BASE`. BL2 populates an `entry_point_info`
Dan Handley1151c822014-04-15 11:38:38 +0100639 structure in memory provided by the platform with information about how
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100640 BL3-1 should pass control to the BL3-2 image.
Achin Guptaa3050ed2014-02-19 17:52:35 +0000641
Sandrine Bailleux93d81d62014-06-24 14:19:36 +01006425. Loading the normal world BL3-3 binary image into non-secure DRAM from
643 platform storage and arranging for BL3-1 to pass control to this image. This
644 address is determined using the `plat_get_ns_image_entrypoint()` function
645 described below.
646
6476. BL2 populates an `entry_point_info` structure in memory provided by the
648 platform with information about how BL3-1 should pass control to the
649 other BL images.
650
Achin Gupta4f6ad662013-10-25 09:08:21 +0100651The following functions must be implemented by the platform port to enable BL2
652to perform the above tasks.
653
654
655### Function : bl2_early_platform_setup() [mandatory]
656
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100657 Argument : meminfo *
Achin Gupta4f6ad662013-10-25 09:08:21 +0100658 Return : void
659
660This function executes with the MMU and data caches disabled. It is only called
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100661by the primary CPU. The arguments to this function is the address of the
662`meminfo` structure populated by BL1.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100663
664The platform must copy the contents of the `meminfo` structure into a private
665variable as the original memory may be subsequently overwritten by BL2. The
666copied structure is made available to all BL2 code through the
Achin Guptae4d084e2014-02-19 17:18:23 +0000667`bl2_plat_sec_mem_layout()` function.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100668
669
670### Function : bl2_plat_arch_setup() [mandatory]
671
672 Argument : void
673 Return : void
674
675This function executes with the MMU and data caches disabled. It is only called
676by the primary CPU.
677
678The purpose of this function is to perform any architectural initialization
679that varies across platforms, for example enabling the MMU (since the memory
680map differs across platforms).
681
682
683### Function : bl2_platform_setup() [mandatory]
684
685 Argument : void
686 Return : void
687
688This function may execute with the MMU and data caches enabled if the platform
689port does the necessary initialization in `bl2_plat_arch_setup()`. It is only
690called by the primary CPU.
691
Achin Guptae4d084e2014-02-19 17:18:23 +0000692The purpose of this function is to perform any platform initialization
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100693specific to BL2. Platform security components are configured if required.
694For the Base FVP the TZC-400 TrustZone controller is configured to only
695grant non-secure access to DRAM. This avoids aliasing between secure and
696non-secure accesses in the TLB and cache - secure execution states can use
697the NS attributes in the MMU translation tables to access the DRAM.
Harry Liebelce19cf12014-04-01 19:28:07 +0100698
Harry Liebeld265bd72014-01-31 19:04:10 +0000699This function is also responsible for initializing the storage abstraction layer
700which is used to load further bootloader images.
701
Achin Gupta4f6ad662013-10-25 09:08:21 +0100702
Sandrine Bailleuxee12f6f2013-11-28 14:55:58 +0000703### Function : bl2_plat_sec_mem_layout() [mandatory]
Achin Gupta4f6ad662013-10-25 09:08:21 +0100704
705 Argument : void
Sandrine Bailleuxee12f6f2013-11-28 14:55:58 +0000706 Return : meminfo *
Achin Gupta4f6ad662013-10-25 09:08:21 +0100707
Sandrine Bailleuxee12f6f2013-11-28 14:55:58 +0000708This function should only be called on the cold boot path. It may execute with
709the MMU and data caches enabled if the platform port does the necessary
710initialization in `bl2_plat_arch_setup()`. It is only called by the primary CPU.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100711
Sandrine Bailleuxee12f6f2013-11-28 14:55:58 +0000712The purpose of this function is to return a pointer to a `meminfo` structure
713populated with the extents of secure RAM available for BL2 to use. See
Achin Gupta4f6ad662013-10-25 09:08:21 +0100714`bl2_early_platform_setup()` above.
715
716
Sandrine Bailleux93d81d62014-06-24 14:19:36 +0100717### Function : bl2_plat_get_bl30_meminfo() [mandatory]
718
719 Argument : meminfo *
720 Return : void
721
722This function is used to get the memory limits where BL2 can load the
723BL3-0 image. The meminfo provided by this is used by load_image() to
724validate whether the BL3-0 image can be loaded within the given
725memory from the given base.
726
727
728### Function : bl2_plat_handle_bl30() [mandatory]
729
730 Argument : image_info *
731 Return : int
732
733This function is called after loading BL3-0 image and it is used to perform any
734platform-specific actions required to handle the SCP firmware. Typically it
735transfers the image into SCP memory using a platform-specific protocol and waits
736until SCP executes it and signals to the Application Processor (AP) for BL2
737execution to continue.
738
739This function returns 0 on success, a negative error code otherwise.
740
741
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100742### Function : bl2_plat_get_bl31_params() [mandatory]
Harry Liebeld265bd72014-01-31 19:04:10 +0000743
744 Argument : void
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100745 Return : bl31_params *
Harry Liebeld265bd72014-01-31 19:04:10 +0000746
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100747BL2 platform code needs to return a pointer to a `bl31_params` structure it
748will use for passing information to BL3-1. The `bl31_params` structure carries
749the following information.
750 - Header describing the version information for interpreting the bl31_param
751 structure
752 - Information about executing the BL3-3 image in the `bl33_ep_info` field
753 - Information about executing the BL3-2 image in the `bl32_ep_info` field
754 - Information about the type and extents of BL3-1 image in the
755 `bl31_image_info` field
756 - Information about the type and extents of BL3-2 image in the
757 `bl32_image_info` field
758 - Information about the type and extents of BL3-3 image in the
759 `bl33_image_info` field
760
761The memory pointed by this structure and its sub-structures should be
762accessible from BL3-1 initialisation code. BL3-1 might choose to copy the
763necessary content, or maintain the structures until BL3-3 is initialised.
Harry Liebeld265bd72014-01-31 19:04:10 +0000764
765
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100766### Funtion : bl2_plat_get_bl31_ep_info() [mandatory]
Achin Gupta4f6ad662013-10-25 09:08:21 +0100767
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100768 Argument : void
769 Return : entry_point_info *
770
771BL2 platform code returns a pointer which is used to populate the entry point
772information for BL3-1 entry point. The location pointed by it should be
773accessible from BL1 while processing the synchronous exception to run to BL3-1.
774
775On FVP this is allocated inside an bl2_to_bl31_params_mem structure which
776is allocated at an address pointed by PARAMS_BASE.
777
778
779### Function : bl2_plat_set_bl31_ep_info() [mandatory]
780
781 Argument : image_info *, entry_point_info *
Achin Gupta4f6ad662013-10-25 09:08:21 +0100782 Return : void
783
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100784This function is called after loading BL3-1 image and it can be used to
785overwrite the entry point set by loader and also set the security state
786and SPSR which represents the entry point system state for BL3-1.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100787
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100788On FVP, we are setting the security state and the SPSR for the BL3-1
789entrypoint.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100790
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100791### Function : bl2_plat_set_bl32_ep_info() [mandatory]
792
793 Argument : image_info *, entry_point_info *
794 Return : void
795
796This function is called after loading BL3-2 image and it can be used to
797overwrite the entry point set by loader and also set the security state
798and SPSR which represents the entry point system state for BL3-2.
799
800On FVP, we are setting the security state and the SPSR for the BL3-2
801entrypoint
802
803### Function : bl2_plat_set_bl33_ep_info() [mandatory]
804
805 Argument : image_info *, entry_point_info *
806 Return : void
807
808This function is called after loading BL3-3 image and it can be used to
809overwrite the entry point set by loader and also set the security state
810and SPSR which represents the entry point system state for BL3-3.
811
812On FVP, we are setting the security state and the SPSR for the BL3-3
813entrypoint
814
815### Function : bl2_plat_get_bl32_meminfo() [mandatory]
816
817 Argument : meminfo *
818 Return : void
819
820This function is used to get the memory limits where BL2 can load the
821BL3-2 image. The meminfo provided by this is used by load_image() to
822validate whether the BL3-2 image can be loaded with in the given
823memory from the given base.
824
825### Function : bl2_plat_get_bl33_meminfo() [mandatory]
826
827 Argument : meminfo *
828 Return : void
829
830This function is used to get the memory limits where BL2 can load the
831BL3-3 image. The meminfo provided by this is used by load_image() to
832validate whether the BL3-3 image can be loaded with in the given
833memory from the given base.
834
835### Function : bl2_plat_flush_bl31_params() [mandatory]
836
837 Argument : void
838 Return : void
839
840Once BL2 has populated all the structures that needs to be read by BL1
841and BL3-1 including the bl31_params structures and its sub-structures,
842the bl31_ep_info structure and any platform specific data. It flushes
843all these data to the main memory so that it is available when we jump to
844later Bootloader stages with MMU off
Achin Gupta4f6ad662013-10-25 09:08:21 +0100845
846### Function : plat_get_ns_image_entrypoint() [mandatory]
847
848 Argument : void
849 Return : unsigned long
850
851As previously described, BL2 is responsible for arranging for control to be
852passed to a normal world BL image through BL3-1. This function returns the
853entrypoint of that image, which BL3-1 uses to jump to it.
854
Harry Liebeld265bd72014-01-31 19:04:10 +0000855BL2 is responsible for loading the normal world BL3-3 image (e.g. UEFI).
Achin Gupta4f6ad662013-10-25 09:08:21 +0100856
857
8583.2 Boot Loader Stage 3-1 (BL3-1)
859---------------------------------
860
861During cold boot, the BL3-1 stage is executed only by the primary CPU. This is
862determined in BL1 using the `platform_is_primary_cpu()` function. BL1 passes
863control to BL3-1 at `BL31_BASE`. During warm boot, BL3-1 is executed by all
864CPUs. BL3-1 executes at EL3 and is responsible for:
865
8661. Re-initializing all architectural and platform state. Although BL1 performs
867 some of this initialization, BL3-1 remains resident in EL3 and must ensure
868 that EL3 architectural and platform state is completely initialized. It
869 should make no assumptions about the system state when it receives control.
870
8712. Passing control to a normal world BL image, pre-loaded at a platform-
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100872 specific address by BL2. BL3-1 uses the `entry_point_info` structure that BL2
Achin Gupta4f6ad662013-10-25 09:08:21 +0100873 populated in memory to do this.
874
8753. Providing runtime firmware services. Currently, BL3-1 only implements a
876 subset of the Power State Coordination Interface (PSCI) API as a runtime
877 service. See Section 3.3 below for details of porting the PSCI
878 implementation.
879
Achin Gupta35ca3512014-02-19 17:58:33 +00008804. Optionally passing control to the BL3-2 image, pre-loaded at a platform-
881 specific address by BL2. BL3-1 exports a set of apis that allow runtime
882 services to specify the security state in which the next image should be
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100883 executed and run the corresponding image. BL3-1 uses the `entry_point_info`
884 structure populated by BL2 to do this.
885
886If BL3-1 is a reset vector, It also needs to handle the reset as specified in
887section 2.2 before the tasks described above.
Achin Gupta35ca3512014-02-19 17:58:33 +0000888
Achin Gupta4f6ad662013-10-25 09:08:21 +0100889The following functions must be implemented by the platform port to enable BL3-1
890to perform the above tasks.
891
892
893### Function : bl31_early_platform_setup() [mandatory]
894
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100895 Argument : bl31_params *, void *
Achin Gupta4f6ad662013-10-25 09:08:21 +0100896 Return : void
897
898This function executes with the MMU and data caches disabled. It is only called
899by the primary CPU. The arguments to this function are:
900
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100901* The address of the `bl31_params` structure populated by BL2.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100902* An opaque pointer that the platform may use as needed.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100903
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100904The platform can copy the contents of the `bl31_params` structure and its
905sub-structures into private variables if the original memory may be
906subsequently overwritten by BL3-1 and similarly the `void *` pointing
907to the platform data also needs to be saved.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100908
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100909On the ARM FVP port, BL2 passes a pointer to a `bl31_params` structure populated
910in the secure DRAM at address `0x6000000` in the bl31_params * argument and it
911does not use opaque pointer mentioned earlier. BL3-1 does not copy this
912information to internal data structures as it guarantees that the secure
913DRAM memory will not be overwritten. It maintains an internal reference to this
914information in the `bl2_to_bl31_params` variable.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100915
916### Function : bl31_plat_arch_setup() [mandatory]
917
918 Argument : void
919 Return : void
920
921This function executes with the MMU and data caches disabled. It is only called
922by the primary CPU.
923
924The purpose of this function is to perform any architectural initialization
925that varies across platforms, for example enabling the MMU (since the memory
926map differs across platforms).
927
928
929### Function : bl31_platform_setup() [mandatory]
930
931 Argument : void
932 Return : void
933
934This function may execute with the MMU and data caches enabled if the platform
935port does the necessary initialization in `bl31_plat_arch_setup()`. It is only
936called by the primary CPU.
937
938The purpose of this function is to complete platform initialization so that both
939BL3-1 runtime services and normal world software can function correctly.
940
941The ARM FVP port does the following:
942* Initializes the generic interrupt controller.
943* Configures the CLCD controller.
Sandrine Bailleux9e864902014-03-31 11:25:18 +0100944* Enables system-level implementation of the generic timer counter.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100945* Grants access to the system counter timer module
946* Initializes the FVP power controller device
947* Detects the system topology.
948
949
950### Function : bl31_get_next_image_info() [mandatory]
951
Achin Gupta35ca3512014-02-19 17:58:33 +0000952 Argument : unsigned int
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100953 Return : entry_point_info *
Achin Gupta4f6ad662013-10-25 09:08:21 +0100954
955This function may execute with the MMU and data caches enabled if the platform
956port does the necessary initializations in `bl31_plat_arch_setup()`.
957
958This function is called by `bl31_main()` to retrieve information provided by
Achin Gupta35ca3512014-02-19 17:58:33 +0000959BL2 for the next image in the security state specified by the argument. BL3-1
960uses this information to pass control to that image in the specified security
Vikram Kanigirie452cd82014-05-23 15:56:12 +0100961state. This function must return a pointer to the `entry_point_info` structure
Achin Gupta35ca3512014-02-19 17:58:33 +0000962(that was copied during `bl31_early_platform_setup()`) if the image exists. It
963should return NULL otherwise.
Achin Gupta4f6ad662013-10-25 09:08:21 +0100964
965
Achin Gupta4f6ad662013-10-25 09:08:21 +01009663.3 Power State Coordination Interface (in BL3-1)
967------------------------------------------------
968
969The ARM Trusted Firmware's implementation of the PSCI API is based around the
970concept of an _affinity instance_. Each _affinity instance_ can be uniquely
971identified in a system by a CPU ID (the processor `MPIDR` is used in the PSCI
972interface) and an _affinity level_. A processing element (for example, a
973CPU) is at level 0. If the CPUs in the system are described in a tree where the
974node above a CPU is a logical grouping of CPUs that share some state, then
975affinity level 1 is that group of CPUs (for example, a cluster), and affinity
976level 2 is a group of clusters (for example, the system). The implementation
977assumes that the affinity level 1 ID can be computed from the affinity level 0
978ID (for example, a unique cluster ID can be computed from the CPU ID). The
979current implementation computes this on the basis of the recommended use of
980`MPIDR` affinity fields in the ARM Architecture Reference Manual.
981
982BL3-1's platform initialization code exports a pointer to the platform-specific
983power management operations required for the PSCI implementation to function
984correctly. This information is populated in the `plat_pm_ops` structure. The
985PSCI implementation calls members of the `plat_pm_ops` structure for performing
986power management operations for each affinity instance. For example, the target
987CPU is specified by its `MPIDR` in a PSCI `CPU_ON` call. The `affinst_on()`
988handler (if present) is called for each affinity instance as the PSCI
989implementation powers up each affinity level implemented in the `MPIDR` (for
990example, CPU, cluster and system).
991
992The following functions must be implemented to initialize PSCI functionality in
993the ARM Trusted Firmware.
994
995
996### Function : plat_get_aff_count() [mandatory]
997
998 Argument : unsigned int, unsigned long
999 Return : unsigned int
1000
1001This function may execute with the MMU and data caches enabled if the platform
1002port does the necessary initializations in `bl31_plat_arch_setup()`. It is only
1003called by the primary CPU.
1004
1005This function is called by the PSCI initialization code to detect the system
1006topology. Its purpose is to return the number of affinity instances implemented
1007at a given `affinity level` (specified by the first argument) and a given
1008`MPIDR` (specified by the second argument). For example, on a dual-cluster
1009system where first cluster implements 2 CPUs and the second cluster implements 4
1010CPUs, a call to this function with an `MPIDR` corresponding to the first cluster
1011(`0x0`) and affinity level 0, would return 2. A call to this function with an
1012`MPIDR` corresponding to the second cluster (`0x100`) and affinity level 0,
1013would return 4.
1014
1015
1016### Function : plat_get_aff_state() [mandatory]
1017
1018 Argument : unsigned int, unsigned long
1019 Return : unsigned int
1020
1021This function may execute with the MMU and data caches enabled if the platform
1022port does the necessary initializations in `bl31_plat_arch_setup()`. It is only
1023called by the primary CPU.
1024
1025This function is called by the PSCI initialization code. Its purpose is to
1026return the state of an affinity instance. The affinity instance is determined by
1027the affinity ID at a given `affinity level` (specified by the first argument)
1028and an `MPIDR` (specified by the second argument). The state can be one of
1029`PSCI_AFF_PRESENT` or `PSCI_AFF_ABSENT`. The latter state is used to cater for
1030system topologies where certain affinity instances are unimplemented. For
1031example, consider a platform that implements a single cluster with 4 CPUs and
1032another CPU implemented directly on the interconnect with the cluster. The
1033`MPIDR`s of the cluster would range from `0x0-0x3`. The `MPIDR` of the single
1034CPU would be 0x100 to indicate that it does not belong to cluster 0. Cluster 1
1035is missing but needs to be accounted for to reach this single CPU in the
1036topology tree. Hence it is marked as `PSCI_AFF_ABSENT`.
1037
1038
1039### Function : plat_get_max_afflvl() [mandatory]
1040
1041 Argument : void
1042 Return : int
1043
1044This function may execute with the MMU and data caches enabled if the platform
1045port does the necessary initializations in `bl31_plat_arch_setup()`. It is only
1046called by the primary CPU.
1047
1048This function is called by the PSCI implementation both during cold and warm
1049boot, to determine the maximum affinity level that the power management
James Morrisseyba3155b2013-10-29 10:56:46 +00001050operations should apply to. ARMv8-A has support for 4 affinity levels. It is
Achin Gupta4f6ad662013-10-25 09:08:21 +01001051likely that hardware will implement fewer affinity levels. This function allows
1052the PSCI implementation to consider only those affinity levels in the system
1053that the platform implements. For example, the Base AEM FVP implements two
1054clusters with a configurable number of CPUs. It reports the maximum affinity
1055level as 1, resulting in PSCI power control up to the cluster level.
1056
1057
1058### Function : platform_setup_pm() [mandatory]
1059
1060 Argument : plat_pm_ops **
1061 Return : int
1062
1063This function may execute with the MMU and data caches enabled if the platform
1064port does the necessary initializations in `bl31_plat_arch_setup()`. It is only
1065called by the primary CPU.
1066
1067This function is called by PSCI initialization code. Its purpose is to export
1068handler routines for platform-specific power management actions by populating
1069the passed pointer with a pointer to BL3-1's private `plat_pm_ops` structure.
1070
1071A description of each member of this structure is given below. Please refer to
Andrew Thoelke2bf28e62014-03-20 10:48:23 +00001072the ARM FVP specific implementation of these handlers in [plat/fvp/plat_pm.c]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001073as an example. A platform port may choose not implement some of the power
1074management operations. For example, the ARM FVP port does not implement the
1075`affinst_standby()` function.
1076
1077#### plat_pm_ops.affinst_standby()
1078
1079Perform the platform-specific setup to enter the standby state indicated by the
1080passed argument.
1081
1082#### plat_pm_ops.affinst_on()
1083
1084Perform the platform specific setup to power on an affinity instance, specified
1085by the `MPIDR` (first argument) and `affinity level` (fourth argument). The
1086`state` (fifth argument) contains the current state of that affinity instance
1087(ON or OFF). This is useful to determine whether any action must be taken. For
1088example, while powering on a CPU, the cluster that contains this CPU might
1089already be in the ON state. The platform decides what actions must be taken to
1090transition from the current state to the target state (indicated by the power
1091management operation).
1092
1093#### plat_pm_ops.affinst_off()
1094
1095Perform the platform specific setup to power off an affinity instance in the
1096`MPIDR` of the calling CPU. It is called by the PSCI `CPU_OFF` API
1097implementation.
1098
1099The `MPIDR` (first argument), `affinity level` (second argument) and `state`
1100(third argument) have a similar meaning as described in the `affinst_on()`
1101operation. They are used to identify the affinity instance on which the call
1102is made and its current state. This gives the platform port an indication of the
1103state transition it must make to perform the requested action. For example, if
1104the calling CPU is the last powered on CPU in the cluster, after powering down
1105affinity level 0 (CPU), the platform port should power down affinity level 1
1106(the cluster) as well.
1107
1108This function is called with coherent stacks. This allows the PSCI
1109implementation to flush caches at a given affinity level without running into
James Morrisseyba3155b2013-10-29 10:56:46 +00001110stale stack state after turning off the caches. On ARMv8-A cache hits do not
1111occur after the cache has been turned off.
Achin Gupta4f6ad662013-10-25 09:08:21 +01001112
1113#### plat_pm_ops.affinst_suspend()
1114
1115Perform the platform specific setup to power off an affinity instance in the
1116`MPIDR` of the calling CPU. It is called by the PSCI `CPU_SUSPEND` API
1117implementation.
1118
1119The `MPIDR` (first argument), `affinity level` (third argument) and `state`
1120(fifth argument) have a similar meaning as described in the `affinst_on()`
1121operation. They are used to identify the affinity instance on which the call
1122is made and its current state. This gives the platform port an indication of the
1123state transition it must make to perform the requested action. For example, if
1124the calling CPU is the last powered on CPU in the cluster, after powering down
1125affinity level 0 (CPU), the platform port should power down affinity level 1
1126(the cluster) as well.
1127
1128The difference between turning an affinity instance off versus suspending it
1129is that in the former case, the affinity instance is expected to re-initialize
1130its state when its next powered on (see `affinst_on_finish()`). In the latter
1131case, the affinity instance is expected to save enough state so that it can
1132resume execution by restoring this state when its powered on (see
1133`affinst_suspend_finish()`).
1134
1135This function is called with coherent stacks. This allows the PSCI
1136implementation to flush caches at a given affinity level without running into
James Morrisseyba3155b2013-10-29 10:56:46 +00001137stale stack state after turning off the caches. On ARMv8-A cache hits do not
1138occur after the cache has been turned off.
Achin Gupta4f6ad662013-10-25 09:08:21 +01001139
1140#### plat_pm_ops.affinst_on_finish()
1141
1142This function is called by the PSCI implementation after the calling CPU is
1143powered on and released from reset in response to an earlier PSCI `CPU_ON` call.
1144It performs the platform-specific setup required to initialize enough state for
1145this CPU to enter the normal world and also provide secure runtime firmware
1146services.
1147
1148The `MPIDR` (first argument), `affinity level` (second argument) and `state`
1149(third argument) have a similar meaning as described in the previous operations.
1150
1151This function is called with coherent stacks. This allows the PSCI
1152implementation to flush caches at a given affinity level without running into
James Morrisseyba3155b2013-10-29 10:56:46 +00001153stale stack state after turning off the caches. On ARMv8-A cache hits do not
1154occur after the cache has been turned off.
Achin Gupta4f6ad662013-10-25 09:08:21 +01001155
1156#### plat_pm_ops.affinst_on_suspend()
1157
1158This function is called by the PSCI implementation after the calling CPU is
1159powered on and released from reset in response to an asynchronous wakeup
1160event, for example a timer interrupt that was programmed by the CPU during the
1161`CPU_SUSPEND` call. It performs the platform-specific setup required to
1162restore the saved state for this CPU to resume execution in the normal world
1163and also provide secure runtime firmware services.
1164
1165The `MPIDR` (first argument), `affinity level` (second argument) and `state`
1166(third argument) have a similar meaning as described in the previous operations.
1167
1168This function is called with coherent stacks. This allows the PSCI
1169implementation to flush caches at a given affinity level without running into
James Morrisseyba3155b2013-10-29 10:56:46 +00001170stale stack state after turning off the caches. On ARMv8-A cache hits do not
1171occur after the cache has been turned off.
Achin Gupta4f6ad662013-10-25 09:08:21 +01001172
1173BL3-1 platform initialization code must also detect the system topology and
1174the state of each affinity instance in the topology. This information is
1175critical for the PSCI runtime service to function correctly. More details are
1176provided in the description of the `plat_get_aff_count()` and
1177`plat_get_aff_state()` functions above.
1178
Achin Guptaa4fa3cb2014-06-02 22:27:36 +010011793.4 Interrupt Management framework (in BL3-1)
1180----------------------------------------------
1181BL3-1 implements an Interrupt Management Framework (IMF) to manage interrupts
1182generated in either security state and targeted to EL1 or EL2 in the non-secure
1183state or EL3/S-EL1 in the secure state. The design of this framework is
1184described in the [IMF Design Guide]
1185
1186A platform should export the following APIs to support the IMF. The following
1187text briefly describes each api and its implementation on the FVP port. The API
1188implementation depends upon the type of interrupt controller present in the
1189platform. The FVP implements an ARM Generic Interrupt Controller (ARM GIC) as
1190per the version 2.0 of the [ARM GIC Architecture Specification]
1191
1192### Function : plat_interrupt_type_to_line() [mandatory]
1193
1194 Argument : uint32_t, uint32_t
1195 Return : uint32_t
1196
1197The ARM processor signals an interrupt exception either through the IRQ or FIQ
1198interrupt line. The specific line that is signaled depends on how the interrupt
1199controller (IC) reports different interrupt types from an execution context in
1200either security state. The IMF uses this API to determine which interrupt line
1201the platform IC uses to signal each type of interrupt supported by the framework
1202from a given security state.
1203
1204The first parameter will be one of the `INTR_TYPE_*` values (see [IMF Design
1205Guide]) indicating the target type of the interrupt, the second parameter is the
1206security state of the originating execution context. The return result is the
1207bit position in the `SCR_EL3` register of the respective interrupt trap: IRQ=1,
1208FIQ=2.
1209
1210The FVP port configures the ARM GIC to signal S-EL1 interrupts as FIQs and
1211Non-secure interrupts as IRQs from either security state.
1212
1213
1214### Function : plat_ic_get_pending_interrupt_type() [mandatory]
1215
1216 Argument : void
1217 Return : uint32_t
1218
1219This API returns the type of the highest priority pending interrupt at the
1220platform IC. The IMF uses the interrupt type to retrieve the corresponding
1221handler function. `INTR_TYPE_INVAL` is returned when there is no interrupt
1222pending. The valid interrupt types that can be returned are `INTR_TYPE_EL3`,
1223`INTR_TYPE_S_EL1` and `INTR_TYPE_NS`.
1224
1225The FVP port reads the _Highest Priority Pending Interrupt Register_
1226(`GICC_HPPIR`) to determine the id of the pending interrupt. The type of interrupt
1227depends upon the id value as follows.
1228
12291. id < 1022 is reported as a S-EL1 interrupt
12302. id = 1022 is reported as a Non-secure interrupt.
12313. id = 1023 is reported as an invalid interrupt type.
1232
1233
1234### Function : plat_ic_get_pending_interrupt_id() [mandatory]
1235
1236 Argument : void
1237 Return : uint32_t
1238
1239This API returns the id of the highest priority pending interrupt at the
1240platform IC. The IMF passes the id returned by this API to the registered
1241handler for the pending interrupt if the `IMF_READ_INTERRUPT_ID` build time flag
1242is set. INTR_ID_UNAVAILABLE is returned when there is no interrupt pending.
1243
1244The FVP port reads the _Highest Priority Pending Interrupt Register_
1245(`GICC_HPPIR`) to determine the id of the pending interrupt. The id that is
1246returned by API depends upon the value of the id read from the interrupt
1247controller as follows.
1248
12491. id < 1022. id is returned as is.
12502. id = 1022. The _Aliased Highest Priority Pending Interrupt Register_
1251 (`GICC_AHPPIR`) is read to determine the id of the non-secure interrupt. This
1252 id is returned by the API.
12533. id = 1023. `INTR_ID_UNAVAILABLE` is returned.
1254
1255
1256### Function : plat_ic_acknowledge_interrupt() [mandatory]
1257
1258 Argument : void
1259 Return : uint32_t
1260
1261This API is used by the CPU to indicate to the platform IC that processing of
1262the highest pending interrupt has begun. It should return the id of the
1263interrupt which is being processed.
1264
1265The FVP port reads the _Interrupt Acknowledge Register_ (`GICC_IAR`). This
1266changes the state of the highest priority pending interrupt from pending to
1267active in the interrupt controller. It returns the value read from the
1268`GICC_IAR`. This value is the id of the interrupt whose state has been changed.
1269
1270The TSP uses this API to start processing of the secure physical timer
1271interrupt.
1272
1273
1274### Function : plat_ic_end_of_interrupt() [mandatory]
1275
1276 Argument : uint32_t
1277 Return : void
1278
1279This API is used by the CPU to indicate to the platform IC that processing of
1280the interrupt corresponding to the id (passed as the parameter) has
1281finished. The id should be the same as the id returned by the
1282`plat_ic_acknowledge_interrupt()` API.
1283
1284The FVP port writes the id to the _End of Interrupt Register_
1285(`GICC_EOIR`). This deactivates the corresponding interrupt in the interrupt
1286controller.
1287
1288The TSP uses this API to finish processing of the secure physical timer
1289interrupt.
1290
1291
1292### Function : plat_ic_get_interrupt_type() [mandatory]
1293
1294 Argument : uint32_t
1295 Return : uint32_t
1296
1297This API returns the type of the interrupt id passed as the parameter.
1298`INTR_TYPE_INVAL` is returned if the id is invalid. If the id is valid, a valid
1299interrupt type (one of `INTR_TYPE_EL3`, `INTR_TYPE_S_EL1` and `INTR_TYPE_NS`) is
1300returned depending upon how the interrupt has been configured by the platform
1301IC.
1302
1303The FVP port configures S-EL1 interrupts as Group0 interrupts and Non-secure
1304interrupts as Group1 interrupts. It reads the group value corresponding to the
1305interrupt id from the relevant _Interrupt Group Register_ (`GICD_IGROUPRn`). It
1306uses the group value to determine the type of interrupt.
1307
Achin Gupta4f6ad662013-10-25 09:08:21 +01001308
Harry Liebela960f282013-12-12 16:03:44 +000013094. C Library
1310-------------
1311
1312To avoid subtle toolchain behavioral dependencies, the header files provided
1313by the compiler are not used. The software is built with the `-nostdinc` flag
1314to ensure no headers are included from the toolchain inadvertently. Instead the
1315required headers are included in the ARM Trusted Firmware source tree. The
1316library only contains those C library definitions required by the local
1317implementation. If more functionality is required, the needed library functions
1318will need to be added to the local implementation.
1319
1320Versions of [FreeBSD] headers can be found in `include/stdlib`. Some of these
1321headers have been cut down in order to simplify the implementation. In order to
1322minimize changes to the header files, the [FreeBSD] layout has been maintained.
1323The generic C library definitions can be found in `include/stdlib` with more
1324system and machine specific declarations in `include/stdlib/sys` and
1325`include/stdlib/machine`.
1326
1327The local C library implementations can be found in `lib/stdlib`. In order to
1328extend the C library these files may need to be modified. It is recommended to
1329use a release version of [FreeBSD] as a starting point.
1330
1331The C library header files in the [FreeBSD] source tree are located in the
1332`include` and `sys/sys` directories. [FreeBSD] machine specific definitions
1333can be found in the `sys/<machine-type>` directories. These files define things
1334like 'the size of a pointer' and 'the range of an integer'. Since an AArch64
1335port for [FreeBSD] does not yet exist, the machine specific definitions are
1336based on existing machine types with similar properties (for example SPARC64).
1337
1338Where possible, C library function implementations were taken from [FreeBSD]
1339as found in the `lib/libc` directory.
1340
1341A copy of the [FreeBSD] sources can be downloaded with `git`.
1342
1343 git clone git://github.com/freebsd/freebsd.git -b origin/release/9.2.0
1344
1345
Harry Liebeld265bd72014-01-31 19:04:10 +000013465. Storage abstraction layer
1347-----------------------------
1348
1349In order to improve platform independence and portability an storage abstraction
1350layer is used to load data from non-volatile platform storage.
1351
1352Each platform should register devices and their drivers via the Storage layer.
1353These drivers then need to be initialized by bootloader phases as
1354required in their respective `blx_platform_setup()` functions. Currently
1355storage access is only required by BL1 and BL2 phases. The `load_image()`
1356function uses the storage layer to access non-volatile platform storage.
1357
1358It is mandatory to implement at least one storage driver. For the FVP the
1359Firmware Image Package(FIP) driver is provided as the default means to load data
1360from storage (see the "Firmware Image Package" section in the [User Guide]).
1361The storage layer is described in the header file `include/io_storage.h`. The
1362implementation of the common library is in `lib/io_storage.c` and the driver
1363files are located in `drivers/io/`.
1364
1365Each IO driver must provide `io_dev_*` structures, as described in
1366`drivers/io/io_driver.h`. These are returned via a mandatory registration
1367function that is called on platform initialization. The semi-hosting driver
1368implementation in `io_semihosting.c` can be used as an example.
1369
1370The Storage layer provides mechanisms to initialize storage devices before
1371IO operations are called. The basic operations supported by the layer
1372include `open()`, `close()`, `read()`, `write()`, `size()` and `seek()`.
1373Drivers do not have to implement all operations, but each platform must
1374provide at least one driver for a device capable of supporting generic
1375operations such as loading a bootloader image.
1376
1377The current implementation only allows for known images to be loaded by the
Dan Handleyb68954c2014-05-29 12:30:24 +01001378firmware. These images are specified by using their names, as defined in
1379[include/plat/common/platform.h]. The platform layer (`plat_get_image_source()`)
1380then returns a reference to a device and a driver-specific `spec` which will be
1381understood by the driver to allow access to the image data.
Harry Liebeld265bd72014-01-31 19:04:10 +00001382
1383The layer is designed in such a way that is it possible to chain drivers with
1384other drivers. For example, file-system drivers may be implemented on top of
1385physical block devices, both represented by IO devices with corresponding
1386drivers. In such a case, the file-system "binding" with the block device may
1387be deferred until the file-system device is initialised.
1388
1389The abstraction currently depends on structures being statically allocated
1390by the drivers and callers, as the system does not yet provide a means of
1391dynamically allocating memory. This may also have the affect of limiting the
1392amount of open resources per driver.
1393
1394
Achin Gupta4f6ad662013-10-25 09:08:21 +01001395- - - - - - - - - - - - - - - - - - - - - - - - - -
1396
Dan Handleye83b0ca2014-01-14 18:17:09 +00001397_Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved._
Achin Gupta4f6ad662013-10-25 09:08:21 +01001398
1399
Achin Guptaa4fa3cb2014-06-02 22:27:36 +01001400[ARM GIC Architecture Specification]: http://arminfo.emea.arm.com/help/topic/com.arm.doc.ihi0048b/IHI0048B_gic_architecture_specification.pdf
1401[IMF Design Guide]: interrupt-framework-design.md
1402[User Guide]: user-guide.md
1403[FreeBSD]: http://www.freebsd.org
Achin Gupta4f6ad662013-10-25 09:08:21 +01001404
Andrew Thoelke2bf28e62014-03-20 10:48:23 +00001405[plat/common/aarch64/platform_mp_stack.S]: ../plat/common/aarch64/platform_mp_stack.S
1406[plat/common/aarch64/platform_up_stack.S]: ../plat/common/aarch64/platform_up_stack.S
Dan Handleyb68954c2014-05-29 12:30:24 +01001407[plat/fvp/include/platform_def.h]: ../plat/fvp/include/platform_def.h
1408[plat/fvp/include/plat_macros.S]: ../plat/fvp/include/plat_macros.S
Andrew Thoelke2bf28e62014-03-20 10:48:23 +00001409[plat/fvp/aarch64/plat_common.c]: ../plat/fvp/aarch64/plat_common.c
1410[plat/fvp/plat_pm.c]: ../plat/fvp/plat_pm.c
1411[include/runtime_svc.h]: ../include/runtime_svc.h
Dan Handleyb68954c2014-05-29 12:30:24 +01001412[include/plat/common/platform.h]: ../include/plat/common/platform.h