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>
This commit is contained in:
Sakari Ailus 2018-07-17 17:19:19 +03:00 committed by Rafael J. Wysocki
parent e4702b2ca7
commit e58b1c6a94
1 changed files with 15 additions and 11 deletions

View File

@ -36,20 +36,24 @@ The port and endpoint concepts are very similar to those in Devicetree
[3]. A port represents an interface in a device, and an endpoint
represents a connection to that interface.
All port nodes are located under the device's "_DSD" node in the
hierarchical data extension tree. The property extension related to
each port node must contain the key "port" and an integer value which
is the number of the port. The object it refers to should be called "PRTX",
where "X" is the number of the port.
All port nodes are located under the device's "_DSD" node in the hierarchical
data extension tree. The data extension related to each port node must begin
with "port" and must be followed by the number of the port as its key. The
target object it refers to should be called "PRTX", where "X" is the number of
the port. An example of such a package would be:
Further on, endpoints are located under the individual port nodes. The
first hierarchical data extension package list entry of the endpoint
nodes must begin with "endpoint" and must be followed by the number
of the endpoint. The object it refers to should be called "EPXY", where
"X" is the number of the port and "Y" is the number of the endpoint.
Package() { "port4", PRT4 }
Further on, endpoints are located under the port nodes. The hierarchical data
extension key of the endpoint nodes must begin with "endpoint" and must be
followed by the number of the endpoint. The object it refers to should be called
"EPXY", where "X" is the number of the port and "Y" is the number of the
endpoint. An example of such a package would be:
Package() { "endpoint0", EP40 }
Each port node contains a property extension key "port", the value of
which is the number of the port node. The each endpoint is similarly numbered
which is the number of the port. Each endpoint is similarly numbered
with a property extension key "endpoint". Port numbers must be unique within a
device and endpoint numbers must be unique within a port.