Commit 538f6f76 authored by Changbin Du's avatar Changbin Du Committed by Rafael J. Wysocki
Browse files

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: default avatarChangbin Du <changbin.du@gmail.com>
Reviewed-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
parent 97a63dd4

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

+12 −9
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



==================================

_DSD Device Properties Usage Rules

----------------------------------

==================================



Properties, Property Sets and Property Subsets

----------------------------------------------

==============================================



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
@@ -18,7 +21,7 @@ specific type) associated with it. 


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

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

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

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

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

multiple property subsets that each may contain property subsets of its

own and so on.



General Validity Rule for Property Sets

---------------------------------------

=======================================



Valid property sets must follow the guidance given by the Device Properties UUID

definition document [1].
@@ -73,7 +76,7 @@ suitable for the ACPI environment and consequently they cannot belong to a valid 
property set.



Property Sets and Device Tree Bindings

--------------------------------------

======================================



It often is useful to make _DSD return property sets that follow Device Tree

bindings.
@@ -91,7 +94,7 @@ expected to automatically work in the ACPI environment regardless of their 
contents.



References

----------

==========



[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
 
.. [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

Documentation/firmware-guide/acpi/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -10,3 +10,4 @@ ACPI Support 
   namespace

   enumeration

   osi

   DSD-properties-rules

CRA Git | Maintained and supported by SUSTech CRA and CCSE