Commit Graph

7 Commits

Author SHA1 Message Date
Sakari Ailus a4138e7c12 ACPI: property: graph: Update graph documentation to use generic references
Instead of port and endpoint properties for representing ports and
endpoints, use the keys of the hierarchical data extension references
when referring to the port and endpoint nodes. Additionally, use "reg"
properties as in Device Tree to specify the number of the port or the
endpoint.

The keys of the port nodes begin with "port" and the keys of the endpoint
nodes begin with "endpoint", both followed by "@" character and the number
of the port or the endpoint.

These changes have the advantage that no ACPI specific properties need to
be added to refer to non-device nodes. Additionally, using the name of the
node instead of an integer property inside the node is easier to parse in
code and easier for humans to understand.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
2018-07-23 12:44:52 +02:00
Sakari Ailus e49363e96f ACPI: property: graph: Improve graph documentation for port/ep numbering
Document that if a port has a single endpoint only, its value shall be
zero. Similarly, if a device object only has a single port, its value
shlla be zero.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
2018-07-23 12:44:52 +02:00
Sakari Ailus e58b1c6a94 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>
2018-07-23 12:44:52 +02:00
Sakari Ailus e4702b2ca7 ACPI: property: Update documentation for hierarchical data extension 1.1
Hierarchical data extension 1.1 allows using references as the second
entries of the hierearchical data extension packages. Update the
references and the examples.

The quotes are left in documentation for clarity.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
2018-07-23 12:44:52 +02:00
Sakari Ailus 2285e6d9f6 ACPI: property: Document key numbering for hierarchical data extension refs
As part of the hierarchical data extension key naming, introduce numbering
scheme for the nodes that may be referred to using hierarchical data
extension references. This allows iterating over particular kind of nodes
recognised by the node name whilst allowing numbering the nodes, bringing
ACPI to feature parity with DT in this respect.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
2018-07-23 12:44:52 +02:00
Sakari Ailus b10134a364 ACPI: property: Document hierarchical data extension references
Add documentation on how to refer to hierarchical data nodes in a
generic way. This brings ACPI to feature parity with Device Tree in
terms of being able to refer to any node in the tree.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
2018-07-23 12:44:52 +02:00
Sakari Ailus aef1b7b21b ACPI / DSD: Document references, ports and endpoints
Document the use of references into the hierarchical data extension
structure, as well as the use of port and endpoint concepts that are very
similar to those in Devicetree.

Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Reviewed-by: Mika Westerberg <mika.westerberg@linux.intel.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
2017-03-29 00:00:29 +02:00