Skip to content

Commit 137477c

Browse files
jmarinhoctmarinas
authored andcommitted
Documentation/arm64: Update ARM and arch reference
This patch clarifies that both Armv8 and v9 are in scope, not just Armv8 systems. Also, ARM is re-written as Arm. Cc: Jeremy Linton <[email protected]> Cc: James Morse <[email protected]> Cc: Rob Herring <[email protected]> Cc: Will Deacon <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: Hanjun Guo <[email protected]> Cc: [email protected] Cc: [email protected] Cc: [email protected] Signed-off-by: Jose Marinho <[email protected]> Reviewed-by: Samer El-Haj-Mahmoud <[email protected]> Reviewed-by: Robin Murphy <[email protected]> Acked-by: Sudeep Holla <[email protected]> Reviewed-by: Jeremy Linton <[email protected]> Reviewed-by: Hanjun Guo <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Catalin Marinas <[email protected]>
1 parent 44c026a commit 137477c

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

Documentation/arm64/arm-acpi.rst

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,41 @@
1-
=====================
2-
ACPI on ARMv8 Servers
3-
=====================
1+
===================
2+
ACPI on Arm systems
3+
===================
44

5-
ACPI can be used for ARMv8 general purpose servers designed to follow
6-
the ARM SBSA (Server Base System Architecture) [0] and SBBR (Server
5+
ACPI can be used for Armv8 and Armv9 systems designed to follow
6+
the Arm SBSA (Server Base System Architecture) [0] and SBBR (Server
77
Base Boot Requirements) [1] specifications. Please note that the SBBR
88
can be retrieved simply by visiting [1], but the SBSA is currently only
99
available to those with an ARM login due to ARM IP licensing concerns.
1010

11-
The ARMv8 kernel implements the reduced hardware model of ACPI version
11+
12+
The Arm kernel implements the reduced hardware model of ACPI version
1213
5.1 or later. Links to the specification and all external documents
1314
it refers to are managed by the UEFI Forum. The specification is
1415
available at http://www.uefi.org/specifications and documents referenced
1516
by the specification can be found via http://www.uefi.org/acpi.
1617

17-
If an ARMv8 system does not meet the requirements of the SBSA and SBBR,
18+
If an Arm system does not meet the requirements of the BSA and BBR,
1819
or cannot be described using the mechanisms defined in the required ACPI
1920
specifications, then ACPI may not be a good fit for the hardware.
2021

2122
While the documents mentioned above set out the requirements for building
22-
industry-standard ARMv8 servers, they also apply to more than one operating
23+
industry-standard Arm systems, they also apply to more than one operating
2324
system. The purpose of this document is to describe the interaction between
24-
ACPI and Linux only, on an ARMv8 system -- that is, what Linux expects of
25+
ACPI and Linux only, on an Arm system -- that is, what Linux expects of
2526
ACPI and what ACPI can expect of Linux.
2627

2728

28-
Why ACPI on ARM?
29+
Why ACPI on Arm?
2930
----------------
3031
Before examining the details of the interface between ACPI and Linux, it is
3132
useful to understand why ACPI is being used. Several technologies already
3233
exist in Linux for describing non-enumerable hardware, after all. In this
3334
section we summarize a blog post [2] from Grant Likely that outlines the
34-
reasoning behind ACPI on ARMv8 servers. Actually, we snitch a good portion
35+
reasoning behind ACPI on Arm systems. Actually, we snitch a good portion
3536
of the summary text almost directly, to be honest.
3637

37-
The short form of the rationale for ACPI on ARM is:
38+
The short form of the rationale for ACPI on Arm is:
3839

3940
- ACPI’s byte code (AML) allows the platform to encode hardware behavior,
4041
while DT explicitly does not support this. For hardware vendors, being
@@ -47,7 +48,7 @@ The short form of the rationale for ACPI on ARM is:
4748

4849
- In the enterprise server environment, ACPI has established bindings (such
4950
as for RAS) which are currently used in production systems. DT does not.
50-
Such bindings could be defined in DT at some point, but doing so means ARM
51+
Such bindings could be defined in DT at some point, but doing so means Arm
5152
and x86 would end up using completely different code paths in both firmware
5253
and the kernel.
5354

@@ -108,7 +109,7 @@ recent version of the kernel.
108109

109110
Relationship with Device Tree
110111
-----------------------------
111-
ACPI support in drivers and subsystems for ARMv8 should never be mutually
112+
ACPI support in drivers and subsystems for Arm should never be mutually
112113
exclusive with DT support at compile time.
113114

114115
At boot time the kernel will only use one description method depending on
@@ -121,11 +122,11 @@ time).
121122

122123
Booting using ACPI tables
123124
-------------------------
124-
The only defined method for passing ACPI tables to the kernel on ARMv8
125+
The only defined method for passing ACPI tables to the kernel on Arm
125126
is via the UEFI system configuration table. Just so it is explicit, this
126127
means that ACPI is only supported on platforms that boot via UEFI.
127128

128-
When an ARMv8 system boots, it can either have DT information, ACPI tables,
129+
When an Arm system boots, it can either have DT information, ACPI tables,
129130
or in some very unusual cases, both. If no command line parameters are used,
130131
the kernel will try to use DT for device enumeration; if there is no DT
131132
present, the kernel will try to use ACPI tables, but only if they are present.
@@ -448,15 +449,15 @@ ASWG
448449
----
449450
The ACPI specification changes regularly. During the year 2014, for instance,
450451
version 5.1 was released and version 6.0 substantially completed, with most of
451-
the changes being driven by ARM-specific requirements. Proposed changes are
452+
the changes being driven by Arm-specific requirements. Proposed changes are
452453
presented and discussed in the ASWG (ACPI Specification Working Group) which
453454
is a part of the UEFI Forum. The current version of the ACPI specification
454455
is 6.1 release in January 2016.
455456

456457
Participation in this group is open to all UEFI members. Please see
457458
http://www.uefi.org/workinggroup for details on group membership.
458459

459-
It is the intent of the ARMv8 ACPI kernel code to follow the ACPI specification
460+
It is the intent of the Arm ACPI kernel code to follow the ACPI specification
460461
as closely as possible, and to only implement functionality that complies with
461462
the released standards from UEFI ASWG. As a practical matter, there will be
462463
vendors that provide bad ACPI tables or violate the standards in some way.
@@ -470,12 +471,12 @@ likely be willing to assist in submitting ECRs.
470471

471472
Linux Code
472473
----------
473-
Individual items specific to Linux on ARM, contained in the Linux
474+
Individual items specific to Linux on Arm, contained in the Linux
474475
source code, are in the list that follows:
475476

476477
ACPI_OS_NAME
477478
This macro defines the string to be returned when
478-
an ACPI method invokes the _OS method. On ARM64
479+
an ACPI method invokes the _OS method. On Arm
479480
systems, this macro will be "Linux" by default.
480481
The command line parameter acpi_os=<string>
481482
can be used to set it to some other value. The

0 commit comments

Comments
 (0)