diff options
author | Changbin Du <changbin.du@gmail.com> | 2019-04-24 13:52:46 -0400 |
---|---|---|
committer | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2019-04-25 17:07:19 -0400 |
commit | 1cf70ae6f07b071affcd4e324803e928e3336a8d (patch) | |
tree | 3a1ec7963d173f6bae6dd686598e3ecfbf11c214 | |
parent | c24bc66e8157ca4956b8be1ed62493d70dfdb547 (diff) |
Documentation: ACPI: move osi.txt to firmware-guide/acpi and convert to reST
This converts the plain text documentation to reStructuredText format
and adds it to Sphinx TOC tree.
No essential content change.
Signed-off-by: Changbin Du <changbin.du@gmail.com>
Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
-rw-r--r-- | Documentation/firmware-guide/acpi/index.rst | 1 | ||||
-rw-r--r-- | Documentation/firmware-guide/acpi/osi.rst (renamed from Documentation/acpi/osi.txt) | 15 |
2 files changed, 10 insertions, 6 deletions
diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst index 99677c73f1fb..868bd25a3398 100644 --- a/Documentation/firmware-guide/acpi/index.rst +++ b/Documentation/firmware-guide/acpi/index.rst | |||
@@ -9,3 +9,4 @@ ACPI Support | |||
9 | 9 | ||
10 | namespace | 10 | namespace |
11 | enumeration | 11 | enumeration |
12 | osi | ||
diff --git a/Documentation/acpi/osi.txt b/Documentation/firmware-guide/acpi/osi.rst index 50cde0ceb9b0..29e9ef79ebc0 100644 --- a/Documentation/acpi/osi.txt +++ b/Documentation/firmware-guide/acpi/osi.rst | |||
@@ -1,5 +1,8 @@ | |||
1 | .. SPDX-License-Identifier: GPL-2.0 | ||
2 | |||
3 | ========================== | ||
1 | ACPI _OSI and _REV methods | 4 | ACPI _OSI and _REV methods |
2 | -------------------------- | 5 | ========================== |
3 | 6 | ||
4 | An ACPI BIOS can use the "Operating System Interfaces" method (_OSI) | 7 | An ACPI BIOS can use the "Operating System Interfaces" method (_OSI) |
5 | to find out what the operating system supports. Eg. If BIOS | 8 | to find out what the operating system supports. Eg. If BIOS |
@@ -14,7 +17,7 @@ This document explains how and why the BIOS and Linux should use these methods. | |||
14 | It also explains how and why they are widely misused. | 17 | It also explains how and why they are widely misused. |
15 | 18 | ||
16 | How to use _OSI | 19 | How to use _OSI |
17 | --------------- | 20 | =============== |
18 | 21 | ||
19 | Linux runs on two groups of machines -- those that are tested by the OEM | 22 | Linux runs on two groups of machines -- those that are tested by the OEM |
20 | to be compatible with Linux, and those that were never tested with Linux, | 23 | to be compatible with Linux, and those that were never tested with Linux, |
@@ -62,7 +65,7 @@ the string when that support is added to the kernel. | |||
62 | That was easy. Read on, to find out how to do it wrong. | 65 | That was easy. Read on, to find out how to do it wrong. |
63 | 66 | ||
64 | Before _OSI, there was _OS | 67 | Before _OSI, there was _OS |
65 | -------------------------- | 68 | ========================== |
66 | 69 | ||
67 | ACPI 1.0 specified "_OS" as an | 70 | ACPI 1.0 specified "_OS" as an |
68 | "object that evaluates to a string that identifies the operating system." | 71 | "object that evaluates to a string that identifies the operating system." |
@@ -96,7 +99,7 @@ That is the *only* viable strategy, as that is what modern Windows does, | |||
96 | and so doing otherwise could steer the BIOS down an untested path. | 99 | and so doing otherwise could steer the BIOS down an untested path. |
97 | 100 | ||
98 | _OSI is born, and immediately misused | 101 | _OSI is born, and immediately misused |
99 | -------------------------------------- | 102 | ===================================== |
100 | 103 | ||
101 | With _OSI, the *BIOS* provides the string describing an interface, | 104 | With _OSI, the *BIOS* provides the string describing an interface, |
102 | and asks the OS: "YES/NO, are you compatible with this interface?" | 105 | and asks the OS: "YES/NO, are you compatible with this interface?" |
@@ -144,7 +147,7 @@ catastrophic failure resulting from the BIOS taking paths that | |||
144 | were never validated under *any* OS. | 147 | were never validated under *any* OS. |
145 | 148 | ||
146 | Do not use _REV | 149 | Do not use _REV |
147 | --------------- | 150 | =============== |
148 | 151 | ||
149 | Since _OSI("Linux") went away, some BIOS writers used _REV | 152 | Since _OSI("Linux") went away, some BIOS writers used _REV |
150 | to support Linux and Windows differences in the same BIOS. | 153 | to support Linux and Windows differences in the same BIOS. |
@@ -164,7 +167,7 @@ from mid-2015 onward. The ACPI specification will also be updated | |||
164 | to reflect that _REV is deprecated, and always returns 2. | 167 | to reflect that _REV is deprecated, and always returns 2. |
165 | 168 | ||
166 | Apple Mac and _OSI("Darwin") | 169 | Apple Mac and _OSI("Darwin") |
167 | ---------------------------- | 170 | ============================ |
168 | 171 | ||
169 | On Apple's Mac platforms, the ACPI BIOS invokes _OSI("Darwin") | 172 | On Apple's Mac platforms, the ACPI BIOS invokes _OSI("Darwin") |
170 | to determine if the machine is running Apple OSX. | 173 | to determine if the machine is running Apple OSX. |