diff options
| author | Changbin Du <changbin.du@gmail.com> | 2019-04-24 13:52:57 -0400 |
|---|---|---|
| committer | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2019-04-25 17:07:20 -0400 |
| commit | 05000042f33dd8b2afbeedc1d8fd499486d14b0d (patch) | |
| tree | b66fba5b24c34f14286ea341503e0790894e33d8 | |
| parent | f2dde1ed0f2818405b371c2b65a98fece221b7a0 (diff) | |
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>
| -rw-r--r-- | Documentation/firmware-guide/acpi/dsd/data-node-references.rst (renamed from Documentation/acpi/dsd/data-node-references.txt) | 36 | ||||
| -rw-r--r-- | Documentation/firmware-guide/acpi/index.rst | 1 |
2 files changed, 21 insertions, 16 deletions
diff --git a/Documentation/acpi/dsd/data-node-references.txt b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst index c3871565c8cf..1351984e767c 100644 --- a/Documentation/acpi/dsd/data-node-references.txt +++ b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst | |||
| @@ -1,9 +1,12 @@ | |||
| 1 | Copyright (C) 2018 Intel Corporation | 1 | .. SPDX-License-Identifier: GPL-2.0 |
| 2 | Author: Sakari Ailus <sakari.ailus@linux.intel.com> | 2 | .. include:: <isonum.txt> |
| 3 | |||
| 4 | 3 | ||
| 4 | =================================== | ||
| 5 | Referencing hierarchical data nodes | 5 | Referencing hierarchical data nodes |
| 6 | ----------------------------------- | 6 | =================================== |
| 7 | |||
| 8 | :Copyright: |copy| 2018 Intel Corporation | ||
| 9 | :Author: Sakari Ailus <sakari.ailus@linux.intel.com> | ||
| 7 | 10 | ||
| 8 | ACPI in general allows referring to device objects in the tree only. | 11 | ACPI in general allows referring to device objects in the tree only. |
| 9 | Hierarchical data extension nodes may not be referred to directly, hence this | 12 | Hierarchical data extension nodes may not be referred to directly, hence this |
| @@ -28,13 +31,14 @@ extension key. | |||
| 28 | 31 | ||
| 29 | 32 | ||
| 30 | Example | 33 | Example |
| 31 | ------- | 34 | ======= |
| 32 | 35 | ||
| 33 | In the ASL snippet below, the "reference" _DSD property [2] contains a | 36 | In the ASL snippet below, the "reference" _DSD property [2] contains a |
| 34 | device object reference to DEV0 and under that device object, a | 37 | device object reference to DEV0 and under that device object, a |
| 35 | hierarchical data extension key "node@1" referring to the NOD1 object | 38 | hierarchical data extension key "node@1" referring to the NOD1 object |
| 36 | and lastly, a hierarchical data extension key "anothernode" referring to | 39 | and lastly, a hierarchical data extension key "anothernode" referring to |
| 37 | the ANOD object which is also the final target node of the reference. | 40 | the ANOD object which is also the final target node of the reference. |
| 41 | :: | ||
| 38 | 42 | ||
| 39 | Device (DEV0) | 43 | Device (DEV0) |
| 40 | { | 44 | { |
| @@ -75,15 +79,15 @@ Example | |||
| 75 | }) | 79 | }) |
| 76 | } | 80 | } |
| 77 | 81 | ||
| 78 | Please also see a graph example in graph.txt . | 82 | Please also see a graph example in :doc:`graph`. |
| 79 | 83 | ||
| 80 | References | 84 | References |
| 81 | ---------- | 85 | ========== |
| 82 | 86 | ||
| 83 | [1] Hierarchical Data Extension UUID For _DSD. | 87 | [1] Hierarchical Data Extension UUID For _DSD. |
| 84 | <URL:http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf>, | 88 | <http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf>, |
| 85 | referenced 2018-07-17. | 89 | referenced 2018-07-17. |
| 86 | 90 | ||
| 87 | [2] Device Properties UUID For _DSD. | 91 | [2] Device Properties UUID For _DSD. |
| 88 | <URL:http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf>, | 92 | <http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf>, |
| 89 | referenced 2016-10-04. | 93 | referenced 2016-10-04. |
diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst index f81cfbcb6878..6d4e0df4f063 100644 --- a/Documentation/firmware-guide/acpi/index.rst +++ b/Documentation/firmware-guide/acpi/index.rst | |||
| @@ -9,6 +9,7 @@ ACPI Support | |||
| 9 | 9 | ||
| 10 | namespace | 10 | namespace |
| 11 | dsd/graph | 11 | dsd/graph |
| 12 | dsd/data-node-references | ||
| 12 | enumeration | 13 | enumeration |
| 13 | osi | 14 | osi |
| 14 | method-customizing | 15 | method-customizing |
