diff options
author | Changbin Du <changbin.du@gmail.com> | 2019-04-24 13:52:49 -0400 |
---|---|---|
committer | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2019-04-25 17:07:19 -0400 |
commit | 538f6f76b9ca5cbcd521db80e137d1c43e55556b (patch) | |
tree | aafb3c8d62d5bd428027ab076e317c6c649ec952 | |
parent | 97a63dd43477a93fa0fc53ff082af8d64ff618e1 (diff) |
Documentation: ACPI: move DSD-properties-rules.txt to firmware-guide/acpi and covert 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/DSD-properties-rules.rst (renamed from Documentation/acpi/DSD-properties-rules.txt) | 21 | ||||
-rw-r--r-- | Documentation/firmware-guide/acpi/index.rst | 1 |
2 files changed, 13 insertions, 9 deletions
diff --git a/Documentation/acpi/DSD-properties-rules.txt b/Documentation/firmware-guide/acpi/DSD-properties-rules.rst index 3e4862bdad98..4306f29b6103 100644 --- a/Documentation/acpi/DSD-properties-rules.txt +++ b/Documentation/firmware-guide/acpi/DSD-properties-rules.rst | |||
@@ -1,8 +1,11 @@ | |||
1 | .. SPDX-License-Identifier: GPL-2.0 | ||
2 | |||
3 | ================================== | ||
1 | _DSD Device Properties Usage Rules | 4 | _DSD Device Properties Usage Rules |
2 | ---------------------------------- | 5 | ================================== |
3 | 6 | ||
4 | Properties, Property Sets and Property Subsets | 7 | Properties, Property Sets and Property Subsets |
5 | ---------------------------------------------- | 8 | ============================================== |
6 | 9 | ||
7 | The _DSD (Device Specific Data) configuration object, introduced in ACPI 5.1, | 10 | The _DSD (Device Specific Data) configuration object, introduced in ACPI 5.1, |
8 | allows any type of device configuration data to be provided via the ACPI | 11 | allows any type of device configuration data to be provided via the ACPI |
@@ -18,7 +21,7 @@ specific type) associated with it. | |||
18 | 21 | ||
19 | In the ACPI _DSD context it is an element of the sub-package following the | 22 | In the ACPI _DSD context it is an element of the sub-package following the |
20 | generic Device Properties UUID in the _DSD return package as specified in the | 23 | generic Device Properties UUID in the _DSD return package as specified in the |
21 | Device Properties UUID definition document [1]. | 24 | Device Properties UUID definition document [1]_. |
22 | 25 | ||
23 | It also may be regarded as the definition of a key and the associated data type | 26 | It also may be regarded as the definition of a key and the associated data type |
24 | that can be returned by _DSD in the Device Properties UUID sub-package for a | 27 | that can be returned by _DSD in the Device Properties UUID sub-package for a |
@@ -33,14 +36,14 @@ Property subsets are nested collections of properties. Each of them is | |||
33 | associated with an additional key (name) allowing the subset to be referred | 36 | associated with an additional key (name) allowing the subset to be referred |
34 | to as a whole (and to be treated as a separate entity). The canonical | 37 | to as a whole (and to be treated as a separate entity). The canonical |
35 | representation of property subsets is via the mechanism specified in the | 38 | representation of property subsets is via the mechanism specified in the |
36 | Hierarchical Properties Extension UUID definition document [2]. | 39 | Hierarchical Properties Extension UUID definition document [2]_. |
37 | 40 | ||
38 | Property sets may be hierarchical. That is, a property set may contain | 41 | Property sets may be hierarchical. That is, a property set may contain |
39 | multiple property subsets that each may contain property subsets of its | 42 | multiple property subsets that each may contain property subsets of its |
40 | own and so on. | 43 | own and so on. |
41 | 44 | ||
42 | General Validity Rule for Property Sets | 45 | General Validity Rule for Property Sets |
43 | --------------------------------------- | 46 | ======================================= |
44 | 47 | ||
45 | Valid property sets must follow the guidance given by the Device Properties UUID | 48 | Valid property sets must follow the guidance given by the Device Properties UUID |
46 | definition document [1]. | 49 | definition document [1]. |
@@ -73,7 +76,7 @@ suitable for the ACPI environment and consequently they cannot belong to a valid | |||
73 | property set. | 76 | property set. |
74 | 77 | ||
75 | Property Sets and Device Tree Bindings | 78 | Property Sets and Device Tree Bindings |
76 | -------------------------------------- | 79 | ====================================== |
77 | 80 | ||
78 | It often is useful to make _DSD return property sets that follow Device Tree | 81 | It often is useful to make _DSD return property sets that follow Device Tree |
79 | bindings. | 82 | bindings. |
@@ -91,7 +94,7 @@ expected to automatically work in the ACPI environment regardless of their | |||
91 | contents. | 94 | contents. |
92 | 95 | ||
93 | References | 96 | References |
94 | ---------- | 97 | ========== |
95 | 98 | ||
96 | [1] http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf | 99 | .. [1] http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf |
97 | [2] http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf | 100 | .. [2] http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf |
diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst index 868bd25a3398..0e05b843521c 100644 --- a/Documentation/firmware-guide/acpi/index.rst +++ b/Documentation/firmware-guide/acpi/index.rst | |||
@@ -10,3 +10,4 @@ ACPI Support | |||
10 | namespace | 10 | namespace |
11 | enumeration | 11 | enumeration |
12 | osi | 12 | osi |
13 | DSD-properties-rules | ||