Documentation/acpi/dsd/data-node-references.txt

   1 Copyright (C) 2018 Intel Corporation
   2 Author: Sakari Ailus <sakari.ailus@linux.intel.com>
   3
   4
   5 Referencing hierarchical data nodes
   6 -----------------------------------
   7
   8 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
  10 document defines a scheme to implement such references.
  11
  12 A reference consist of the device object name followed by one or more
  13 hierarchical data extension [1] keys. Specifically, the hierarchical data
  14 extension node which is referred to by the key shall lie directly under the
  15 parent object i.e. either the device object or another hierarchical data
  16 extension node.
  17
  18 Example
  19 -------
  20
  21         In the ASL snippet below, the "reference" _DSD property [2] contains a
  22         device object reference to DEV0 and under that device object, a
  23         hierarchical data extension key "node" referring to the NODE object and
  24         lastly, a hierarchical data extension key "anothernode" referring to the
  25         ANOD object which is also the final target of the reference.
  26
  27         Device (DEV0)
  28         {
  29             Name (_DSD, Package () {
  30                 ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
  31                 Package () {
  32                     Package () { "node", NODE },
  33                 }
  34             })
  35             Name (NODE, Package() {
  36                 ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
  37                 Package () {
  38                     Package () { "anothernode", ANOD },
  39                 }
  40             })
  41             Name (ANOD, Package() {
  42                 ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
  43                 Package () {
  44                     Package () { "random-property", 0 },
  45                 }
  46             })
  47         }
  48
  49         Device (DEV1)
  50         {
  51             Name (_DSD, Package () {
  52                 ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
  53                 Package () {
  54                     Package () { "reference", ^DEV0, "node", "anothernode" },
  55                 }
  56             })
  57         }
  58
  59
  60 References
  61 ----------
  62
  63 [1] Hierarchical Data Extension UUID For _DSD.
  64     <URL:http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf>,
  65     referenced 2018-07-17.
  66
  67 [2] Device Properties UUID For _DSD.
  68     <URL:http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf>,
  69     referenced 2016-10-04.