xref: /linux/Documentation/arch/arm64/booting.rst (revision feafee284579d29537a5a56ba8f23894f0463f3d)
1=====================
2Booting AArch64 Linux
3=====================
4
5Author: Will Deacon <will.deacon@arm.com>
6
7Date  : 07 September 2012
8
9This document is based on the ARM booting document by Russell King and
10is relevant to all public releases of the AArch64 Linux kernel.
11
12The AArch64 exception model is made up of a number of exception levels
13(EL0 - EL3), with EL0, EL1 and EL2 having a secure and a non-secure
14counterpart.  EL2 is the hypervisor level, EL3 is the highest priority
15level and exists only in secure mode. Both are architecturally optional.
16
17For the purposes of this document, we will use the term `boot loader`
18simply to define all software that executes on the CPU(s) before control
19is passed to the Linux kernel.  This may include secure monitor and
20hypervisor code, or it may just be a handful of instructions for
21preparing a minimal boot environment.
22
23Essentially, the boot loader should provide (as a minimum) the
24following:
25
261. Setup and initialise the RAM
272. Setup the device tree
283. Decompress the kernel image
294. Call the kernel image
30
31
321. Setup and initialise RAM
33---------------------------
34
35Requirement: MANDATORY
36
37The boot loader is expected to find and initialise all RAM that the
38kernel will use for volatile data storage in the system.  It performs
39this in a machine dependent manner.  (It may use internal algorithms
40to automatically locate and size all RAM, or it may use knowledge of
41the RAM in the machine, or any other method the boot loader designer
42sees fit.)
43
44For Arm Confidential Compute Realms this includes ensuring that all
45protected RAM has a Realm IPA state (RIPAS) of "RAM".
46
47
482. Setup the device tree
49-------------------------
50
51Requirement: MANDATORY
52
53The device tree blob (dtb) must be placed on an 8-byte boundary and must
54not exceed 2 megabytes in size. Since the dtb will be mapped cacheable
55using blocks of up to 2 megabytes in size, it must not be placed within
56any 2M region which must be mapped with any specific attributes.
57
58NOTE: versions prior to v4.2 also require that the DTB be placed within
59the 512 MB region starting at text_offset bytes below the kernel Image.
60
613. Decompress the kernel image
62------------------------------
63
64Requirement: OPTIONAL
65
66The AArch64 kernel does not currently provide a decompressor and
67therefore requires decompression (gzip etc.) to be performed by the boot
68loader if a compressed Image target (e.g. Image.gz) is used.  For
69bootloaders that do not implement this requirement, the uncompressed
70Image target is available instead.
71
72
734. Call the kernel image
74------------------------
75
76Requirement: MANDATORY
77
78The decompressed kernel image contains a 64-byte header as follows::
79
80  u32 code0;			/* Executable code */
81  u32 code1;			/* Executable code */
82  u64 text_offset;		/* Image load offset, little endian */
83  u64 image_size;		/* Effective Image size, little endian */
84  u64 flags;			/* kernel flags, little endian */
85  u64 res2	= 0;		/* reserved */
86  u64 res3	= 0;		/* reserved */
87  u64 res4	= 0;		/* reserved */
88  u32 magic	= 0x644d5241;	/* Magic number, little endian, "ARM\x64" */
89  u32 res5;			/* reserved (used for PE COFF offset) */
90
91
92Header notes:
93
94- As of v3.17, all fields are little endian unless stated otherwise.
95
96- code0/code1 are responsible for branching to stext.
97
98- when booting through EFI, code0/code1 are initially skipped.
99  res5 is an offset to the PE header and the PE header has the EFI
100  entry point (efi_stub_entry).  When the stub has done its work, it
101  jumps to code0 to resume the normal boot process.
102
103- Prior to v3.17, the endianness of text_offset was not specified.  In
104  these cases image_size is zero and text_offset is 0x80000 in the
105  endianness of the kernel.  Where image_size is non-zero image_size is
106  little-endian and must be respected.  Where image_size is zero,
107  text_offset can be assumed to be 0x80000.
108
109- The flags field (introduced in v3.17) is a little-endian 64-bit field
110  composed as follows:
111
112  ============= ===============================================================
113  Bit 0		Kernel endianness.  1 if BE, 0 if LE.
114  Bit 1-2	Kernel Page size.
115
116			* 0 - Unspecified.
117			* 1 - 4K
118			* 2 - 16K
119			* 3 - 64K
120  Bit 3		Kernel physical placement
121
122			0
123			  2MB aligned base should be as close as possible
124			  to the base of DRAM, since memory below it is not
125			  accessible via the linear mapping
126			1
127			  2MB aligned base such that all image_size bytes
128			  counted from the start of the image are within
129			  the 48-bit addressable range of physical memory
130  Bits 4-63	Reserved.
131  ============= ===============================================================
132
133- When image_size is zero, a bootloader should attempt to keep as much
134  memory as possible free for use by the kernel immediately after the
135  end of the kernel image. The amount of space required will vary
136  depending on selected features, and is effectively unbound.
137
138The Image must be placed text_offset bytes from a 2MB aligned base
139address anywhere in usable system RAM and called there. The region
140between the 2 MB aligned base address and the start of the image has no
141special significance to the kernel, and may be used for other purposes.
142At least image_size bytes from the start of the image must be free for
143use by the kernel.
144NOTE: versions prior to v4.6 cannot make use of memory below the
145physical offset of the Image so it is recommended that the Image be
146placed as close as possible to the start of system RAM.
147
148If an initrd/initramfs is passed to the kernel at boot, it must reside
149entirely within a 1 GB aligned physical memory window of up to 32 GB in
150size that fully covers the kernel Image as well.
151
152Any memory described to the kernel (even that below the start of the
153image) which is not marked as reserved from the kernel (e.g., with a
154memreserve region in the device tree) will be considered as available to
155the kernel.
156
157Before jumping into the kernel, the following conditions must be met:
158
159- Quiesce all DMA capable devices so that memory does not get
160  corrupted by bogus network packets or disk data.  This will save
161  you many hours of debug.
162
163- Primary CPU general-purpose register settings:
164
165    - x0 = physical address of device tree blob (dtb) in system RAM.
166    - x1 = 0 (reserved for future use)
167    - x2 = 0 (reserved for future use)
168    - x3 = 0 (reserved for future use)
169
170- CPU mode
171
172  All forms of interrupts must be masked in PSTATE.DAIF (Debug, SError,
173  IRQ and FIQ).
174  The CPU must be in non-secure state, either in EL2 (RECOMMENDED in order
175  to have access to the virtualisation extensions), or in EL1.
176
177- Caches, MMUs
178
179  The MMU must be off.
180
181  The instruction cache may be on or off, and must not hold any stale
182  entries corresponding to the loaded kernel image.
183
184  The address range corresponding to the loaded kernel image must be
185  cleaned to the PoC. In the presence of a system cache or other
186  coherent masters with caches enabled, this will typically require
187  cache maintenance by VA rather than set/way operations.
188  System caches which respect the architected cache maintenance by VA
189  operations must be configured and may be enabled.
190  System caches which do not respect architected cache maintenance by VA
191  operations (not recommended) must be configured and disabled.
192
193- Architected timers
194
195  CNTFRQ must be programmed with the timer frequency and CNTVOFF must
196  be programmed with a consistent value on all CPUs.  If entering the
197  kernel at EL1, CNTHCTL_EL2 must have EL1PCTEN (bit 0) set where
198  available.
199
200- Coherency
201
202  All CPUs to be booted by the kernel must be part of the same coherency
203  domain on entry to the kernel.  This may require IMPLEMENTATION DEFINED
204  initialisation to enable the receiving of maintenance operations on
205  each CPU.
206
207- System registers
208
209  All writable architected system registers at or below the exception
210  level where the kernel image will be entered must be initialised by
211  software at a higher exception level to prevent execution in an UNKNOWN
212  state.
213
214  For all systems:
215  - If EL3 is present:
216
217    - SCR_EL3.FIQ must have the same value across all CPUs the kernel is
218      executing on.
219    - The value of SCR_EL3.FIQ must be the same as the one present at boot
220      time whenever the kernel is executing.
221
222  - If EL3 is present and the kernel is entered at EL2:
223
224    - SCR_EL3.HCE (bit 8) must be initialised to 0b1.
225
226  For systems with a GICv5 interrupt controller to be used in v5 mode:
227
228  - If the kernel is entered at EL1 and EL2 is present:
229
230      - ICH_HFGRTR_EL2.ICC_PPI_ACTIVERn_EL1 (bit 20) must be initialised to 0b1.
231      - ICH_HFGRTR_EL2.ICC_PPI_PRIORITYRn_EL1 (bit 19) must be initialised to 0b1.
232      - ICH_HFGRTR_EL2.ICC_PPI_PENDRn_EL1 (bit 18) must be initialised to 0b1.
233      - ICH_HFGRTR_EL2.ICC_PPI_ENABLERn_EL1 (bit 17) must be initialised to 0b1.
234      - ICH_HFGRTR_EL2.ICC_PPI_HMRn_EL1 (bit 16) must be initialised to 0b1.
235      - ICH_HFGRTR_EL2.ICC_IAFFIDR_EL1 (bit 7) must be initialised to 0b1.
236      - ICH_HFGRTR_EL2.ICC_ICSR_EL1 (bit 6) must be initialised to 0b1.
237      - ICH_HFGRTR_EL2.ICC_PCR_EL1 (bit 5) must be initialised to 0b1.
238      - ICH_HFGRTR_EL2.ICC_HPPIR_EL1 (bit 4) must be initialised to 0b1.
239      - ICH_HFGRTR_EL2.ICC_HAPR_EL1 (bit 3) must be initialised to 0b1.
240      - ICH_HFGRTR_EL2.ICC_CR0_EL1 (bit 2) must be initialised to 0b1.
241      - ICH_HFGRTR_EL2.ICC_IDRn_EL1 (bit 1) must be initialised to 0b1.
242      - ICH_HFGRTR_EL2.ICC_APR_EL1 (bit 0) must be initialised to 0b1.
243
244      - ICH_HFGWTR_EL2.ICC_PPI_ACTIVERn_EL1 (bit 20) must be initialised to 0b1.
245      - ICH_HFGWTR_EL2.ICC_PPI_PRIORITYRn_EL1 (bit 19) must be initialised to 0b1.
246      - ICH_HFGWTR_EL2.ICC_PPI_PENDRn_EL1 (bit 18) must be initialised to 0b1.
247      - ICH_HFGWTR_EL2.ICC_PPI_ENABLERn_EL1 (bit 17) must be initialised to 0b1.
248      - ICH_HFGWTR_EL2.ICC_ICSR_EL1 (bit 6) must be initialised to 0b1.
249      - ICH_HFGWTR_EL2.ICC_PCR_EL1 (bit 5) must be initialised to 0b1.
250      - ICH_HFGWTR_EL2.ICC_CR0_EL1 (bit 2) must be initialised to 0b1.
251      - ICH_HFGWTR_EL2.ICC_APR_EL1 (bit 0) must be initialised to 0b1.
252
253      - ICH_HFGITR_EL2.GICRCDNMIA (bit 10) must be initialised to 0b1.
254      - ICH_HFGITR_EL2.GICRCDIA (bit 9) must be initialised to 0b1.
255      - ICH_HFGITR_EL2.GICCDDI (bit 8) must be initialised to 0b1.
256      - ICH_HFGITR_EL2.GICCDEOI (bit 7) must be initialised to 0b1.
257      - ICH_HFGITR_EL2.GICCDHM (bit 6) must be initialised to 0b1.
258      - ICH_HFGITR_EL2.GICCDRCFG (bit 5) must be initialised to 0b1.
259      - ICH_HFGITR_EL2.GICCDPEND (bit 4) must be initialised to 0b1.
260      - ICH_HFGITR_EL2.GICCDAFF (bit 3) must be initialised to 0b1.
261      - ICH_HFGITR_EL2.GICCDPRI (bit 2) must be initialised to 0b1.
262      - ICH_HFGITR_EL2.GICCDDIS (bit 1) must be initialised to 0b1.
263      - ICH_HFGITR_EL2.GICCDEN (bit 0) must be initialised to 0b1.
264
265  - The DT or ACPI tables must describe a GICv5 interrupt controller.
266
267  For systems with a GICv3 interrupt controller to be used in v3 mode:
268  - If EL3 is present:
269
270      - ICC_SRE_EL3.Enable (bit 3) must be initialised to 0b1.
271      - ICC_SRE_EL3.SRE (bit 0) must be initialised to 0b1.
272      - ICC_CTLR_EL3.PMHE (bit 6) must be set to the same value across
273        all CPUs the kernel is executing on, and must stay constant
274        for the lifetime of the kernel.
275
276  - If the kernel is entered at EL1:
277
278      - ICC_SRE_EL2.Enable (bit 3) must be initialised to 0b1
279      - ICC_SRE_EL2.SRE (bit 0) must be initialised to 0b1.
280
281  - The DT or ACPI tables must describe a GICv3 interrupt controller.
282
283  For systems with a GICv3 interrupt controller to be used in
284  compatibility (v2) mode:
285
286  - If EL3 is present:
287
288      ICC_SRE_EL3.SRE (bit 0) must be initialised to 0b0.
289
290  - If the kernel is entered at EL1:
291
292      ICC_SRE_EL2.SRE (bit 0) must be initialised to 0b0.
293
294  - The DT or ACPI tables must describe a GICv2 interrupt controller.
295
296  For CPUs with pointer authentication functionality:
297
298  - If EL3 is present:
299
300    - SCR_EL3.APK (bit 16) must be initialised to 0b1
301    - SCR_EL3.API (bit 17) must be initialised to 0b1
302
303  - If the kernel is entered at EL1:
304
305    - HCR_EL2.APK (bit 40) must be initialised to 0b1
306    - HCR_EL2.API (bit 41) must be initialised to 0b1
307
308  For CPUs with Activity Monitors Unit v1 (AMUv1) extension present:
309
310  - If EL3 is present:
311
312    - CPTR_EL3.TAM (bit 30) must be initialised to 0b0
313    - CPTR_EL2.TAM (bit 30) must be initialised to 0b0
314    - AMCNTENSET0_EL0 must be initialised to 0b1111
315    - AMCNTENSET1_EL0 must be initialised to a platform specific value
316      having 0b1 set for the corresponding bit for each of the auxiliary
317      counters present.
318
319  - If the kernel is entered at EL1:
320
321    - AMCNTENSET0_EL0 must be initialised to 0b1111
322    - AMCNTENSET1_EL0 must be initialised to a platform specific value
323      having 0b1 set for the corresponding bit for each of the auxiliary
324      counters present.
325
326  For CPUs with the Fine Grained Traps (FEAT_FGT) extension present:
327
328  - If EL3 is present and the kernel is entered at EL2:
329
330    - SCR_EL3.FGTEn (bit 27) must be initialised to 0b1.
331
332  For CPUs with the Fine Grained Traps 2 (FEAT_FGT2) extension present:
333
334  - If EL3 is present and the kernel is entered at EL2:
335
336    - SCR_EL3.FGTEn2 (bit 59) must be initialised to 0b1.
337
338  For CPUs with support for HCRX_EL2 (FEAT_HCX) present:
339
340  - If EL3 is present and the kernel is entered at EL2:
341
342    - SCR_EL3.HXEn (bit 38) must be initialised to 0b1.
343
344  For CPUs with Advanced SIMD and floating point support:
345
346  - If EL3 is present:
347
348    - CPTR_EL3.TFP (bit 10) must be initialised to 0b0.
349
350  - If EL2 is present and the kernel is entered at EL1:
351
352    - CPTR_EL2.TFP (bit 10) must be initialised to 0b0.
353
354  For CPUs with the Scalable Vector Extension (FEAT_SVE) present:
355
356  - if EL3 is present:
357
358    - CPTR_EL3.EZ (bit 8) must be initialised to 0b1.
359
360    - ZCR_EL3.LEN must be initialised to the same value for all CPUs the
361      kernel is executed on.
362
363  - If the kernel is entered at EL1 and EL2 is present:
364
365    - CPTR_EL2.TZ (bit 8) must be initialised to 0b0.
366
367    - CPTR_EL2.ZEN (bits 17:16) must be initialised to 0b11.
368
369    - ZCR_EL2.LEN must be initialised to the same value for all CPUs the
370      kernel will execute on.
371
372  For CPUs with the Scalable Matrix Extension (FEAT_SME):
373
374  - If EL3 is present:
375
376    - CPTR_EL3.ESM (bit 12) must be initialised to 0b1.
377
378    - SCR_EL3.EnTP2 (bit 41) must be initialised to 0b1.
379
380    - SMCR_EL3.LEN must be initialised to the same value for all CPUs the
381      kernel will execute on.
382
383 - If the kernel is entered at EL1 and EL2 is present:
384
385    - CPTR_EL2.TSM (bit 12) must be initialised to 0b0.
386
387    - CPTR_EL2.SMEN (bits 25:24) must be initialised to 0b11.
388
389    - SCTLR_EL2.EnTP2 (bit 60) must be initialised to 0b1.
390
391    - SMCR_EL2.LEN must be initialised to the same value for all CPUs the
392      kernel will execute on.
393
394    - HWFGRTR_EL2.nTPIDR2_EL0 (bit 55) must be initialised to 0b01.
395
396    - HWFGWTR_EL2.nTPIDR2_EL0 (bit 55) must be initialised to 0b01.
397
398    - HWFGRTR_EL2.nSMPRI_EL1 (bit 54) must be initialised to 0b01.
399
400    - HWFGWTR_EL2.nSMPRI_EL1 (bit 54) must be initialised to 0b01.
401
402  For CPUs with the Scalable Matrix Extension FA64 feature (FEAT_SME_FA64):
403
404  - If EL3 is present:
405
406    - SMCR_EL3.FA64 (bit 31) must be initialised to 0b1.
407
408 - If the kernel is entered at EL1 and EL2 is present:
409
410    - SMCR_EL2.FA64 (bit 31) must be initialised to 0b1.
411
412  For CPUs with the Memory Tagging Extension feature (FEAT_MTE2):
413
414  - If EL3 is present:
415
416    - SCR_EL3.ATA (bit 26) must be initialised to 0b1.
417
418  - If the kernel is entered at EL1 and EL2 is present:
419
420    - HCR_EL2.ATA (bit 56) must be initialised to 0b1.
421
422  For CPUs with the Scalable Matrix Extension version 2 (FEAT_SME2):
423
424  - If EL3 is present:
425
426    - SMCR_EL3.EZT0 (bit 30) must be initialised to 0b1.
427
428 - If the kernel is entered at EL1 and EL2 is present:
429
430    - SMCR_EL2.EZT0 (bit 30) must be initialised to 0b1.
431
432  For CPUs with the Branch Record Buffer Extension (FEAT_BRBE):
433
434  - If EL3 is present:
435
436    - MDCR_EL3.SBRBE (bits 33:32) must be initialised to 0b01 or 0b11.
437
438  - If the kernel is entered at EL1 and EL2 is present:
439
440    - BRBCR_EL2.CC (bit 3) must be initialised to 0b1.
441    - BRBCR_EL2.MPRED (bit 4) must be initialised to 0b1.
442
443    - HDFGRTR_EL2.nBRBDATA (bit 61) must be initialised to 0b1.
444    - HDFGRTR_EL2.nBRBCTL  (bit 60) must be initialised to 0b1.
445    - HDFGRTR_EL2.nBRBIDR  (bit 59) must be initialised to 0b1.
446
447    - HDFGWTR_EL2.nBRBDATA (bit 61) must be initialised to 0b1.
448    - HDFGWTR_EL2.nBRBCTL  (bit 60) must be initialised to 0b1.
449
450    - HFGITR_EL2.nBRBIALL (bit 56) must be initialised to 0b1.
451    - HFGITR_EL2.nBRBINJ  (bit 55) must be initialised to 0b1.
452
453  For CPUs with the Performance Monitors Extension (FEAT_PMUv3p9):
454
455 - If EL3 is present:
456
457    - MDCR_EL3.EnPM2 (bit 7) must be initialised to 0b1.
458
459 - If the kernel is entered at EL1 and EL2 is present:
460
461    - HDFGRTR2_EL2.nPMICNTR_EL0 (bit 2) must be initialised to 0b1.
462    - HDFGRTR2_EL2.nPMICFILTR_EL0 (bit 3) must be initialised to 0b1.
463    - HDFGRTR2_EL2.nPMUACR_EL1 (bit 4) must be initialised to 0b1.
464
465    - HDFGWTR2_EL2.nPMICNTR_EL0 (bit 2) must be initialised to 0b1.
466    - HDFGWTR2_EL2.nPMICFILTR_EL0 (bit 3) must be initialised to 0b1.
467    - HDFGWTR2_EL2.nPMUACR_EL1 (bit 4) must be initialised to 0b1.
468
469  For CPUs with SPE data source filtering (FEAT_SPE_FDS):
470
471  - If EL3 is present:
472
473    - MDCR_EL3.EnPMS3 (bit 42) must be initialised to 0b1.
474
475  - If the kernel is entered at EL1 and EL2 is present:
476
477    - HDFGRTR2_EL2.nPMSDSFR_EL1 (bit 19) must be initialised to 0b1.
478    - HDFGWTR2_EL2.nPMSDSFR_EL1 (bit 19) must be initialised to 0b1.
479
480  For CPUs with Memory Copy and Memory Set instructions (FEAT_MOPS):
481
482  - If the kernel is entered at EL1 and EL2 is present:
483
484    - HCRX_EL2.MSCEn (bit 11) must be initialised to 0b1.
485
486    - HCRX_EL2.MCE2 (bit 10) must be initialised to 0b1 and the hypervisor
487      must handle MOPS exceptions as described in :ref:`arm64_mops_hyp`.
488
489  For CPUs with the Extended Translation Control Register feature (FEAT_TCR2):
490
491  - If EL3 is present:
492
493    - SCR_EL3.TCR2En (bit 43) must be initialised to 0b1.
494
495 - If the kernel is entered at EL1 and EL2 is present:
496
497    - HCRX_EL2.TCR2En (bit 14) must be initialised to 0b1.
498
499  For CPUs with the Stage 1 Permission Indirection Extension feature (FEAT_S1PIE):
500
501  - If EL3 is present:
502
503    - SCR_EL3.PIEn (bit 45) must be initialised to 0b1.
504
505  - If the kernel is entered at EL1 and EL2 is present:
506
507    - HFGRTR_EL2.nPIR_EL1 (bit 58) must be initialised to 0b1.
508
509    - HFGWTR_EL2.nPIR_EL1 (bit 58) must be initialised to 0b1.
510
511    - HFGRTR_EL2.nPIRE0_EL1 (bit 57) must be initialised to 0b1.
512
513    - HFGRWR_EL2.nPIRE0_EL1 (bit 57) must be initialised to 0b1.
514
515 - For CPUs with Guarded Control Stacks (FEAT_GCS):
516
517  - GCSCR_EL1 must be initialised to 0.
518
519  - GCSCRE0_EL1 must be initialised to 0.
520
521  - If EL3 is present:
522
523    - SCR_EL3.GCSEn (bit 39) must be initialised to 0b1.
524
525  - If EL2 is present:
526
527    - GCSCR_EL2 must be initialised to 0.
528
529 - If the kernel is entered at EL1 and EL2 is present:
530
531    - HCRX_EL2.GCSEn must be initialised to 0b1.
532
533    - HFGITR_EL2.nGCSEPP (bit 59) must be initialised to 0b1.
534
535    - HFGITR_EL2.nGCSSTR_EL1 (bit 58) must be initialised to 0b1.
536
537    - HFGITR_EL2.nGCSPUSHM_EL1 (bit 57) must be initialised to 0b1.
538
539    - HFGRTR_EL2.nGCS_EL1 (bit 53) must be initialised to 0b1.
540
541    - HFGRTR_EL2.nGCS_EL0 (bit 52) must be initialised to 0b1.
542
543    - HFGWTR_EL2.nGCS_EL1 (bit 53) must be initialised to 0b1.
544
545    - HFGWTR_EL2.nGCS_EL0 (bit 52) must be initialised to 0b1.
546
547 - For CPUs with debug architecture i.e FEAT_Debugv8pN (all versions):
548
549 - If EL3 is present:
550
551   - MDCR_EL3.TDA (bit 9) must be initialized to 0b0
552
553 - For CPUs with FEAT_PMUv3:
554
555 - If EL3 is present:
556
557   - MDCR_EL3.TPM (bit 6) must be initialized to 0b0
558
559The requirements described above for CPU mode, caches, MMUs, architected
560timers, coherency and system registers apply to all CPUs.  All CPUs must
561enter the kernel in the same exception level.  Where the values documented
562disable traps it is permissible for these traps to be enabled so long as
563those traps are handled transparently by higher exception levels as though
564the values documented were set.
565
566The boot loader is expected to enter the kernel on each CPU in the
567following manner:
568
569- The primary CPU must jump directly to the first instruction of the
570  kernel image.  The device tree blob passed by this CPU must contain
571  an 'enable-method' property for each cpu node.  The supported
572  enable-methods are described below.
573
574  It is expected that the bootloader will generate these device tree
575  properties and insert them into the blob prior to kernel entry.
576
577- CPUs with a "spin-table" enable-method must have a 'cpu-release-addr'
578  property in their cpu node.  This property identifies a
579  naturally-aligned 64-bit zero-initalised memory location.
580
581  These CPUs should spin outside of the kernel in a reserved area of
582  memory (communicated to the kernel by a /memreserve/ region in the
583  device tree) polling their cpu-release-addr location, which must be
584  contained in the reserved region.  A wfe instruction may be inserted
585  to reduce the overhead of the busy-loop and a sev will be issued by
586  the primary CPU.  When a read of the location pointed to by the
587  cpu-release-addr returns a non-zero value, the CPU must jump to this
588  value.  The value will be written as a single 64-bit little-endian
589  value, so CPUs must convert the read value to their native endianness
590  before jumping to it.
591
592- CPUs with a "psci" enable method should remain outside of
593  the kernel (i.e. outside of the regions of memory described to the
594  kernel in the memory node, or in a reserved area of memory described
595  to the kernel by a /memreserve/ region in the device tree).  The
596  kernel will issue CPU_ON calls as described in ARM document number ARM
597  DEN 0022A ("Power State Coordination Interface System Software on ARM
598  processors") to bring CPUs into the kernel.
599
600  The device tree should contain a 'psci' node, as described in
601  Documentation/devicetree/bindings/arm/psci.yaml.
602
603- Secondary CPU general-purpose register settings
604
605  - x0 = 0 (reserved for future use)
606  - x1 = 0 (reserved for future use)
607  - x2 = 0 (reserved for future use)
608  - x3 = 0 (reserved for future use)
609