Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Documentation: ACPI: Update references

Update references for the ACPI _DSD documentation. In particular:

- Substitute _DSD property and hierarchical data extension documents with
the newer DSD guide that replaces both, and use its HTML form.

- Refer to the latest ACPI spec.

- Add data node reference documentation reference to graph documentation.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

authored by

Sakari Ailus and committed by
Rafael J. Wysocki
59f3f982 a1117495

+58 -68
+7 -11
Documentation/firmware-guide/acpi/dsd/data-node-references.rst
··· 13 13 document defines a scheme to implement such references. 14 14 15 15 A reference consist of the device object name followed by one or more 16 - hierarchical data extension [1] keys. Specifically, the hierarchical data 17 - extension node which is referred to by the key shall lie directly under the 18 - parent object i.e. either the device object or another hierarchical data 16 + hierarchical data extension [dsd-guide] keys. Specifically, the hierarchical 17 + data extension node which is referred to by the key shall lie directly under 18 + the parent object i.e. either the device object or another hierarchical data 19 19 extension node. 20 20 21 21 The keys in the hierarchical data nodes shall consist of the name of the node, ··· 33 33 Example 34 34 ======= 35 35 36 - In the ASL snippet below, the "reference" _DSD property [2] contains a 36 + In the ASL snippet below, the "reference" _DSD property contains a 37 37 device object reference to DEV0 and under that device object, a 38 38 hierarchical data extension key "node@1" referring to the NOD1 object 39 39 and lastly, a hierarchical data extension key "anothernode" referring to ··· 91 91 References 92 92 ========== 93 93 94 - [1] Hierarchical Data Extension UUID For _DSD. 95 - <https://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf>, 96 - referenced 2018-07-17. 97 - 98 - [2] Device Properties UUID For _DSD. 99 - <https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf>, 100 - referenced 2016-10-04. 94 + [dsd-guide] DSD Guide. 95 + https://github.com/UEFI/DSD-Guide/blob/main/dsd-guide.adoc, referenced 96 + 2021-11-30.
+18 -22
Documentation/firmware-guide/acpi/dsd/graph.rst
··· 7 7 _DSD 8 8 ==== 9 9 10 - _DSD (Device Specific Data) [7] is a predefined ACPI device 10 + _DSD (Device Specific Data) [dsd-guide] is a predefined ACPI device 11 11 configuration object that can be used to convey information on 12 12 hardware features which are not specifically covered by the ACPI 13 - specification [1][6]. There are two _DSD extensions that are relevant 14 - for graphs: property [4] and hierarchical data extensions [5]. The 13 + specification [acpi]. There are two _DSD extensions that are relevant 14 + for graphs: property [dsd-guide] and hierarchical data extensions. The 15 15 property extension provides generic key-value pairs whereas the 16 16 hierarchical data extension supports nodes with references to other 17 17 nodes, forming a tree. The nodes in the tree may contain properties as ··· 36 36 =================== 37 37 38 38 The port and endpoint concepts are very similar to those in Devicetree 39 - [3]. A port represents an interface in a device, and an endpoint 40 - represents a connection to that interface. 39 + [devicetree, graph-bindings]. A port represents an interface in a device, and 40 + an endpoint represents a connection to that interface. Also see [data-node-ref] 41 + for generic data node references. 41 42 42 43 All port nodes are located under the device's "_DSD" node in the hierarchical 43 44 data extension tree. The data extension related to each port node must begin ··· 154 153 References 155 154 ========== 156 155 157 - [1] _DSD (Device Specific Data) Implementation Guide. 158 - https://www.uefi.org/sites/default/files/resources/_DSD-implementation-guide-toplevel-1_1.htm, 159 - referenced 2016-10-03. 156 + [acpi] Advanced Configuration and Power Interface Specification. 157 + https://uefi.org/specifications/ACPI/6.4/, referenced 2021-11-30. 160 158 161 - [2] Devicetree. https://www.devicetree.org, referenced 2016-10-03. 159 + [data-node-ref] Documentation/firmware-guide/acpi/dsd/data-node-references.rst 162 160 163 - [3] Documentation/devicetree/bindings/graph.txt 161 + [devicetree] Devicetree. https://www.devicetree.org, referenced 2016-10-03. 164 162 165 - [4] Device Properties UUID For _DSD. 166 - https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf, 167 - referenced 2016-10-04. 163 + [dsd-guide] DSD Guide. 164 + https://github.com/UEFI/DSD-Guide/blob/main/dsd-guide.adoc, referenced 165 + 2021-11-30. 168 166 169 - [5] Hierarchical Data Extension UUID For _DSD. 170 - https://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf, 171 - referenced 2016-10-04. 172 - 173 - [6] Advanced Configuration and Power Interface Specification. 174 - https://www.uefi.org/sites/default/files/resources/ACPI_6_1.pdf, 175 - referenced 2016-10-04. 176 - 177 - [7] _DSD Device Properties Usage Rules. 167 + [dsd-rules] _DSD Device Properties Usage Rules. 178 168 Documentation/firmware-guide/acpi/DSD-properties-rules.rst 169 + 170 + [graph-bindings] Common bindings for device graphs (Devicetree). 171 + https://github.com/devicetree-org/dt-schema/blob/main/schemas/graph.yaml, 172 + referenced 2021-11-30.
+18 -22
Documentation/firmware-guide/acpi/dsd/leds.rst
··· 5 5 Describing and referring to LEDs in ACPI 6 6 ======================================== 7 7 8 - Individual LEDs are described by hierarchical data extension [6] nodes under the 8 + Individual LEDs are described by hierarchical data extension [5] nodes under the 9 9 device node, the LED driver chip. The "reg" property in the LED specific nodes 10 10 tells the numerical ID of each individual LED output to which the LEDs are 11 - connected. [3] The hierarchical data nodes are named "led@X", where X is the 11 + connected. [leds] The hierarchical data nodes are named "led@X", where X is the 12 12 number of the LED output. 13 13 14 - Referring to LEDs in Device tree is documented in [4], in "flash-leds" property 15 - documentation. In short, LEDs are directly referred to by using phandles. 14 + Referring to LEDs in Device tree is documented in [video-interfaces], in 15 + "flash-leds" property documentation. In short, LEDs are directly referred to by 16 + using phandles. 16 17 17 - While Device tree allows referring to any node in the tree[1], in ACPI 18 - references are limited to device nodes only [2]. For this reason using the same 19 - mechanism on ACPI is not possible. A mechanism to refer to non-device ACPI nodes 20 - is documented in [7]. 18 + While Device tree allows referring to any node in the tree [devicetree], in 19 + ACPI references are limited to device nodes only [acpi]. For this reason using 20 + the same mechanism on ACPI is not possible. A mechanism to refer to non-device 21 + ACPI nodes is documented in [data-node-ref]. 21 22 22 23 ACPI allows (as does DT) using integer arguments after the reference. A 23 24 combination of the LED driver device reference and an integer argument, ··· 91 90 References 92 91 ========== 93 92 94 - [1] Device tree. https://www.devicetree.org, referenced 2019-02-21. 93 + [acpi] Advanced Configuration and Power Interface Specification. 94 + https://uefi.org/specifications/ACPI/6.4/, referenced 2021-11-30. 95 95 96 - [2] Advanced Configuration and Power Interface Specification. 97 - https://uefi.org/sites/default/files/resources/ACPI_6_3_final_Jan30.pdf, 98 - referenced 2019-02-21. 96 + [data-node-ref] Documentation/firmware-guide/acpi/dsd/data-node-references.rst 99 97 100 - [3] Documentation/devicetree/bindings/leds/common.txt 98 + [devicetree] Devicetree. https://www.devicetree.org, referenced 2019-02-21. 101 99 102 - [4] Documentation/devicetree/bindings/media/video-interfaces.txt 100 + [dsd-guide] DSD Guide. 101 + https://github.com/UEFI/DSD-Guide/blob/main/dsd-guide.adoc, referenced 102 + 2021-11-30. 103 103 104 - [5] Device Properties UUID For _DSD. 105 - https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf, 106 - referenced 2019-02-21. 104 + [leds] Documentation/devicetree/bindings/leds/common.yaml 107 105 108 - [6] Hierarchical Data Extension UUID For _DSD. 109 - https://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf, 110 - referenced 2019-02-21. 111 - 112 - [7] Documentation/firmware-guide/acpi/dsd/data-node-references.rst 106 + [video-interfaces] Documentation/devicetree/bindings/media/video-interfaces.yaml
+15 -13
Documentation/firmware-guide/acpi/dsd/phy.rst
··· 4 4 MDIO bus and PHYs in ACPI 5 5 ========================= 6 6 7 - The PHYs on an MDIO bus [1] are probed and registered using 7 + The PHYs on an MDIO bus [phy] are probed and registered using 8 8 fwnode_mdiobus_register_phy(). 9 9 10 10 Later, for connecting these PHYs to their respective MACs, the PHYs registered 11 11 on the MDIO bus have to be referenced. 12 12 13 13 This document introduces two _DSD properties that are to be used 14 - for connecting PHYs on the MDIO bus [3] to the MAC layer. 14 + for connecting PHYs on the MDIO bus [dsd-properties-rules] to the MAC layer. 15 15 16 16 These properties are defined in accordance with the "Device 17 - Properties UUID For _DSD" [2] document and the 17 + Properties UUID For _DSD" [dsd-guide] document and the 18 18 daffd814-6eba-4d8c-8a91-bc9bbf4aa301 UUID must be used in the Device 19 19 Data Descriptors containing them. 20 20 ··· 48 48 phy-mode 49 49 -------- 50 50 The "phy-mode" _DSD property is used to describe the connection to 51 - the PHY. The valid values for "phy-mode" are defined in [4]. 51 + the PHY. The valid values for "phy-mode" are defined in [ethernet-controller]. 52 52 53 53 managed 54 54 ------- 55 55 Optional property, which specifies the PHY management type. 56 - The valid values for "managed" are defined in [4]. 56 + The valid values for "managed" are defined in [ethernet-controller]. 57 57 58 58 fixed-link 59 59 ---------- 60 60 The "fixed-link" is described by a data-only subnode of the 61 61 MAC port, which is linked in the _DSD package via 62 62 hierarchical data extension (UUID dbb8e3e6-5886-4ba6-8795-1319f52a966b 63 - in accordance with [5] "_DSD Implementation Guide" document). 63 + in accordance with [dsd-guide] "_DSD Implementation Guide" document). 64 64 The subnode should comprise a required property ("speed") and 65 65 possibly the optional ones - complete list of parameters and 66 - their values are specified in [4]. 66 + their values are specified in [ethernet-controller]. 67 67 68 68 The following ASL example illustrates the usage of these properties. 69 69 ··· 188 188 References 189 189 ========== 190 190 191 - [1] Documentation/networking/phy.rst 191 + [phy] Documentation/networking/phy.rst 192 192 193 - [2] https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf 193 + [dsd-properties-rules] 194 + Documentation/firmware-guide/acpi/DSD-properties-rules.rst 194 195 195 - [3] Documentation/firmware-guide/acpi/DSD-properties-rules.rst 196 + [ethernet-controller] 197 + Documentation/devicetree/bindings/net/ethernet-controller.yaml 196 198 197 - [4] Documentation/devicetree/bindings/net/ethernet-controller.yaml 198 - 199 - [5] https://github.com/UEFI/DSD-Guide/blob/main/dsd-guide.pdf 199 + [dsd-guide] DSD Guide. 200 + https://github.com/UEFI/DSD-Guide/blob/main/dsd-guide.adoc, referenced 201 + 2021-11-30.