diff options
author | Sakari Ailus <sakari.ailus@linux.intel.com> | 2018-07-17 10:19:19 -0400 |
---|---|---|
committer | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2018-07-23 06:44:52 -0400 |
commit | e58b1c6a9422b97b30838e77b7d1d2bbed121e96 (patch) | |
tree | b09890f7fd880a140579e7d7e4d5bceaf94f46fa | |
parent | e4702b2ca7b4aa81cc067c1b8e7aaa1350239fa2 (diff) |
ACPI: property: graph: Fix graph documentation
Address a few issues in the ACPI _DSD properties graph documentation:
- the extension for port nodes is a data extension (and not property
extension),
- clean up language in port hierarchical data extension definition,
- add examples of port and endpoint packages,
- port property value is the number of the "port" and not the number
of the "port node",
- remove word "individual" from endpoint data node description, it
was redundant,
- remove the extra "The" in the endpoint property description,
- refer to hierarchical data extension keys and targets instead of
first and second package list entries.
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
-rw-r--r-- | Documentation/acpi/dsd/graph.txt | 28 |
1 files changed, 16 insertions, 12 deletions
diff --git a/Documentation/acpi/dsd/graph.txt b/Documentation/acpi/dsd/graph.txt index 591c47509c63..0b007fceda0e 100644 --- a/Documentation/acpi/dsd/graph.txt +++ b/Documentation/acpi/dsd/graph.txt | |||
@@ -36,20 +36,24 @@ The port and endpoint concepts are very similar to those in Devicetree | |||
36 | [3]. A port represents an interface in a device, and an endpoint | 36 | [3]. A port represents an interface in a device, and an endpoint |
37 | represents a connection to that interface. | 37 | represents a connection to that interface. |
38 | 38 | ||
39 | All port nodes are located under the device's "_DSD" node in the | 39 | All port nodes are located under the device's "_DSD" node in the hierarchical |
40 | hierarchical data extension tree. The property extension related to | 40 | data extension tree. The data extension related to each port node must begin |
41 | each port node must contain the key "port" and an integer value which | 41 | with "port" and must be followed by the number of the port as its key. The |
42 | is the number of the port. The object it refers to should be called "PRTX", | 42 | target object it refers to should be called "PRTX", where "X" is the number of |
43 | where "X" is the number of the port. | 43 | the port. An example of such a package would be: |
44 | 44 | ||
45 | Further on, endpoints are located under the individual port nodes. The | 45 | Package() { "port4", PRT4 } |
46 | first hierarchical data extension package list entry of the endpoint | 46 | |
47 | nodes must begin with "endpoint" and must be followed by the number | 47 | Further on, endpoints are located under the port nodes. The hierarchical data |
48 | of the endpoint. The object it refers to should be called "EPXY", where | 48 | extension key of the endpoint nodes must begin with "endpoint" and must be |
49 | "X" is the number of the port and "Y" is the number of the endpoint. | 49 | followed by the number of the endpoint. The object it refers to should be called |
50 | "EPXY", where "X" is the number of the port and "Y" is the number of the | ||
51 | endpoint. An example of such a package would be: | ||
52 | |||
53 | Package() { "endpoint0", EP40 } | ||
50 | 54 | ||
51 | Each port node contains a property extension key "port", the value of | 55 | Each port node contains a property extension key "port", the value of |
52 | which is the number of the port node. The each endpoint is similarly numbered | 56 | which is the number of the port. Each endpoint is similarly numbered |
53 | with a property extension key "endpoint". Port numbers must be unique within a | 57 | with a property extension key "endpoint". Port numbers must be unique within a |
54 | device and endpoint numbers must be unique within a port. | 58 | device and endpoint numbers must be unique within a port. |
55 | 59 | ||