openkylin
/
linux
mirror of https://gitee.com/openkylin/linux.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
Changbin Du 2019-04-25 01:52:49 +08:00 committed by Rafael J. Wysocki
parent 97a63dd434
commit 538f6f76b9
2 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Documentation/acpi/DSD-properties-rules.txt → Documentation/firmware-guide/acpi/DSD-properties-rules.rst
View File

@ -1,8 +1,11 @@
.. SPDX-License-Identifier: GPL-2.0
==================================
_DSD Device Properties Usage Rules _DSD Device Properties Usage Rules
---------------------------------- ==================================
Properties, Property Sets and Property Subsets Properties, Property Sets and Property Subsets
---------------------------------------------- ==============================================
The _DSD (Device Specific Data) configuration object, introduced in ACPI 5.1, The _DSD (Device Specific Data) configuration object, introduced in ACPI 5.1,
allows any type of device configuration data to be provided via the ACPI allows any type of device configuration data to be provided via the ACPI
@ -18,7 +21,7 @@ specific type) associated with it.
In the ACPI _DSD context it is an element of the sub-package following the In the ACPI _DSD context it is an element of the sub-package following the
generic Device Properties UUID in the _DSD return package as specified in the generic Device Properties UUID in the _DSD return package as specified in the
Device Properties UUID definition document [1]. Device Properties UUID definition document [1]_.
It also may be regarded as the definition of a key and the associated data type It also may be regarded as the definition of a key and the associated data type
that can be returned by _DSD in the Device Properties UUID sub-package for a 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
associated with an additional key (name) allowing the subset to be referred associated with an additional key (name) allowing the subset to be referred
to as a whole (and to be treated as a separate entity). The canonical to as a whole (and to be treated as a separate entity). The canonical
representation of property subsets is via the mechanism specified in the representation of property subsets is via the mechanism specified in the
Hierarchical Properties Extension UUID definition document [2]. Hierarchical Properties Extension UUID definition document [2]_.
Property sets may be hierarchical. That is, a property set may contain Property sets may be hierarchical. That is, a property set may contain
multiple property subsets that each may contain property subsets of its multiple property subsets that each may contain property subsets of its
own and so on. own and so on.
General Validity Rule for Property Sets General Validity Rule for Property Sets
--------------------------------------- =======================================
Valid property sets must follow the guidance given by the Device Properties UUID Valid property sets must follow the guidance given by the Device Properties UUID
definition document [1]. definition document [1].
@ -73,7 +76,7 @@ suitable for the ACPI environment and consequently they cannot belong to a valid
property set. property set.
Property Sets and Device Tree Bindings Property Sets and Device Tree Bindings
-------------------------------------- ======================================
It often is useful to make _DSD return property sets that follow Device Tree It often is useful to make _DSD return property sets that follow Device Tree
bindings. bindings.
@ -91,7 +94,7 @@ expected to automatically work in the ACPI environment regardless of their
contents. contents.
References References
---------- ==========
[1] http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf .. [1] http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf
[2] http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf .. [2] http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf

1
Documentation/firmware-guide/acpi/index.rst
View File

@ -10,3 +10,4 @@ ACPI Support
namespace namespace
enumeration enumeration
osi osi
DSD-properties-rules