diff mbox series

[3/7] Documentation: ACPI: Fix data node reference documentation

Message ID 20211130153250.935726-3-sakari.ailus@linux.intel.com
State Accepted
Commit a11174952205d082f1658fab4314f0caf706e0a8
Headers show
Series [1/7] device property: Fix fwnode_graph_devcon_match() fwnode leak | expand

Commit Message

Sakari Ailus Nov. 30, 2021, 3:32 p.m. UTC
The data node reference documentation was missing a package that must
contain the property values, instead property name and multiple values
being present in a single package. This is not aligned with the _DSD spec.
Fix it by adding the package for the values.

Also add the missing "reg" properties to two numbered nodes.

Fixes: b10134a3643d ("ACPI: property: Document hierarchical data extension references")
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 .../firmware-guide/acpi/dsd/data-node-references.rst      | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

Comments

Andy Shevchenko Nov. 30, 2021, 3:55 p.m. UTC | #1
On Tue, Nov 30, 2021 at 05:32:46PM +0200, Sakari Ailus wrote:
> The data node reference documentation was missing a package that must
> contain the property values, instead property name and multiple values
> being present in a single package. This is not aligned with the _DSD spec.
> Fix it by adding the package for the values.
> 
> Also add the missing "reg" properties to two numbered nodes.
> 
> Fixes: b10134a3643d ("ACPI: property: Document hierarchical data extension references")
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> ---
>  .../firmware-guide/acpi/dsd/data-node-references.rst      | 8 ++++++--
>  1 file changed, 6 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/firmware-guide/acpi/dsd/data-node-references.rst b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> index b7ad47df49de0..166bf9a944bc8 100644
> --- a/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> +++ b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> @@ -5,7 +5,7 @@
>  Referencing hierarchical data nodes
>  ===================================
>  
> -:Copyright: |copy| 2018 Intel Corporation
> +:Copyright: |copy| 2018, 2021 Intel Corporation
>  :Author: Sakari Ailus <sakari.ailus@linux.intel.com>
>  
>  ACPI in general allows referring to device objects in the tree only.
> @@ -52,12 +52,14 @@ the ANOD object which is also the final target node of the reference.
>  	    Name (NOD0, Package() {
>  		ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
>  		Package () {
> +		    Package () { "reg", 0 },
>  		    Package () { "random-property", 3 },
>  		}
>  	    })
>  	    Name (NOD1, Package() {
>  		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
>  		Package () {
> +		    Package () { "reg", 1 },
>  		    Package () { "anothernode", "ANOD" },
>  		}
>  	    })
> @@ -74,7 +76,9 @@ the ANOD object which is also the final target node of the reference.
>  	    Name (_DSD, Package () {
>  		ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
>  		Package () {
> -		    Package () { "reference", ^DEV0, "node@1", "anothernode" },

> +		    Package () { "reference",
> +				 Package () { ^DEV0,
> +					      "node@1", "anothernode" } },

Can it be rather this

		    Package () {
		        "reference", Package () { ^DEV0, "node@1", "anothernode" }
		    },

or this way

		    Package () {
		        "reference", Package () {
			   ^DEV0, "node@1", "anothernode"
			}
		    },

?

>  		}
>  	    })
>  	}
> -- 
> 2.30.2
>
Sakari Ailus Nov. 30, 2021, 8:42 p.m. UTC | #2
On Tue, Nov 30, 2021 at 05:55:52PM +0200, Andy Shevchenko wrote:
> On Tue, Nov 30, 2021 at 05:32:46PM +0200, Sakari Ailus wrote:
> > The data node reference documentation was missing a package that must
> > contain the property values, instead property name and multiple values
> > being present in a single package. This is not aligned with the _DSD spec.
> > Fix it by adding the package for the values.
> > 
> > Also add the missing "reg" properties to two numbered nodes.
> > 
> > Fixes: b10134a3643d ("ACPI: property: Document hierarchical data extension references")
> > Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> > ---
> >  .../firmware-guide/acpi/dsd/data-node-references.rst      | 8 ++++++--
> >  1 file changed, 6 insertions(+), 2 deletions(-)
> > 
> > diff --git a/Documentation/firmware-guide/acpi/dsd/data-node-references.rst b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> > index b7ad47df49de0..166bf9a944bc8 100644
> > --- a/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> > +++ b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> > @@ -5,7 +5,7 @@
> >  Referencing hierarchical data nodes
> >  ===================================
> >  
> > -:Copyright: |copy| 2018 Intel Corporation
> > +:Copyright: |copy| 2018, 2021 Intel Corporation
> >  :Author: Sakari Ailus <sakari.ailus@linux.intel.com>
> >  
> >  ACPI in general allows referring to device objects in the tree only.
> > @@ -52,12 +52,14 @@ the ANOD object which is also the final target node of the reference.
> >  	    Name (NOD0, Package() {
> >  		ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
> >  		Package () {
> > +		    Package () { "reg", 0 },
> >  		    Package () { "random-property", 3 },
> >  		}
> >  	    })
> >  	    Name (NOD1, Package() {
> >  		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
> >  		Package () {
> > +		    Package () { "reg", 1 },
> >  		    Package () { "anothernode", "ANOD" },
> >  		}
> >  	    })
> > @@ -74,7 +76,9 @@ the ANOD object which is also the final target node of the reference.
> >  	    Name (_DSD, Package () {
> >  		ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
> >  		Package () {
> > -		    Package () { "reference", ^DEV0, "node@1", "anothernode" },
> 
> > +		    Package () { "reference",
> > +				 Package () { ^DEV0,
> > +					      "node@1", "anothernode" } },
> 
> Can it be rather this
> 
> 		    Package () {
> 		        "reference", Package () { ^DEV0, "node@1", "anothernode" }
> 		    },
> 
> or this way
> 
> 		    Package () {
> 		        "reference", Package () {
> 			   ^DEV0, "node@1", "anothernode"
> 			}
> 		    },
> 
> ?

How about:

		    Package () {
		        "reference",
		        Package () { ^DEV0, "node@1", "anothernode" },
		    },
diff mbox series

Patch

diff --git a/Documentation/firmware-guide/acpi/dsd/data-node-references.rst b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
index b7ad47df49de0..166bf9a944bc8 100644
--- a/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
+++ b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
@@ -5,7 +5,7 @@ 
 Referencing hierarchical data nodes
 ===================================
 
-:Copyright: |copy| 2018 Intel Corporation
+:Copyright: |copy| 2018, 2021 Intel Corporation
 :Author: Sakari Ailus <sakari.ailus@linux.intel.com>
 
 ACPI in general allows referring to device objects in the tree only.
@@ -52,12 +52,14 @@  the ANOD object which is also the final target node of the reference.
 	    Name (NOD0, Package() {
 		ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
 		Package () {
+		    Package () { "reg", 0 },
 		    Package () { "random-property", 3 },
 		}
 	    })
 	    Name (NOD1, Package() {
 		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
 		Package () {
+		    Package () { "reg", 1 },
 		    Package () { "anothernode", "ANOD" },
 		}
 	    })
@@ -74,7 +76,9 @@  the ANOD object which is also the final target node of the reference.
 	    Name (_DSD, Package () {
 		ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
 		Package () {
-		    Package () { "reference", ^DEV0, "node@1", "anothernode" },
+		    Package () { "reference",
+				 Package () { ^DEV0,
+					      "node@1", "anothernode" } },
 		}
 	    })
 	}