Documentation: ACPI: move dsd/data-node-references.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>
This commit is contained in:
Changbin Du 2019-04-25 01:52:57 +08:00 committed by Rafael J. Wysocki
parent f2dde1ed0f
commit 05000042f3
2 changed files with 21 additions and 16 deletions

View File

@ -1,9 +1,12 @@
Copyright (C) 2018 Intel Corporation .. SPDX-License-Identifier: GPL-2.0
Author: Sakari Ailus <sakari.ailus@linux.intel.com> .. include:: <isonum.txt>
===================================
Referencing hierarchical data nodes Referencing hierarchical data nodes
----------------------------------- ===================================
:Copyright: |copy| 2018 Intel Corporation
:Author: Sakari Ailus <sakari.ailus@linux.intel.com>
ACPI in general allows referring to device objects in the tree only. ACPI in general allows referring to device objects in the tree only.
Hierarchical data extension nodes may not be referred to directly, hence this Hierarchical data extension nodes may not be referred to directly, hence this
@ -28,13 +31,14 @@ extension key.
Example Example
------- =======
In the ASL snippet below, the "reference" _DSD property [2] contains a In the ASL snippet below, the "reference" _DSD property [2] contains a
device object reference to DEV0 and under that device object, a device object reference to DEV0 and under that device object, a
hierarchical data extension key "node@1" referring to the NOD1 object hierarchical data extension key "node@1" referring to the NOD1 object
and lastly, a hierarchical data extension key "anothernode" referring to and lastly, a hierarchical data extension key "anothernode" referring to
the ANOD object which is also the final target node of the reference. the ANOD object which is also the final target node of the reference.
::
Device (DEV0) Device (DEV0)
{ {
@ -75,15 +79,15 @@ Example
}) })
} }
Please also see a graph example in graph.txt . Please also see a graph example in :doc:`graph`.
References References
---------- ==========
[1] Hierarchical Data Extension UUID For _DSD. [1] Hierarchical Data Extension UUID For _DSD.
<URL:http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf>, <http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf>,
referenced 2018-07-17. referenced 2018-07-17.
[2] Device Properties UUID For _DSD. [2] Device Properties UUID For _DSD.
<URL:http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf>, <http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf>,
referenced 2016-10-04. referenced 2016-10-04.

View File

@ -9,6 +9,7 @@ ACPI Support
namespace namespace
dsd/graph dsd/graph
dsd/data-node-references
enumeration enumeration
osi osi
method-customizing method-customizing