[PATCH v2 0/2] Fix ACPI object references

[PATCH v2 0/2] Fix ACPI object references

[Sakari Ailus]

Hi all,

This set adds one patch for converting spaces to tabs before fixing the
object references. Also rebased on the patch converting the text
documentation to ReST.

Sakari Ailus (2):
  Documentation: ACPI: Use tabs for indentation
  Documentation: ACPI: Direct references are allowed to devices only

 .../acpi/dsd/data-node-references.rst              |   6 +-
 Documentation/firmware-guide/acpi/dsd/graph.rst    | 120 ++++++++++-----------
 2 files changed, 63 insertions(+), 63 deletions(-)

-- 
2.11.0

[PATCH v2 1/2] Documentation: ACPI: Use tabs for indentation

[Sakari Ailus]

Use tabs to indent the graph documentation, not spaces.

Fixes: f2dde1ed0f28 ("Documentation: ACPI: move dsd/graph.txt to firmware-guide/acpi and convert to reST")
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 Documentation/firmware-guide/acpi/dsd/graph.rst | 116 ++++++++++++------------
 1 file changed, 58 insertions(+), 58 deletions(-)

diff --git a/Documentation/firmware-guide/acpi/dsd/graph.rst b/Documentation/firmware-guide/acpi/dsd/graph.rst
index e0baed35b037e..8a9019a38b66d 100644
--- a/Documentation/firmware-guide/acpi/dsd/graph.rst
+++ b/Documentation/firmware-guide/acpi/dsd/graph.rst
@@ -82,68 +82,68 @@ A simple example of this is show below::
 
     Scope (\_SB.PCI0.I2C2)
     {
-        Device (CAM0)
-        {
-            Name (_DSD, Package () {
-                ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
-                Package () {
-                    Package () { "compatible", Package () { "nokia,smia" } },
-                },
-                ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
-                Package () {
-                    Package () { "port@0", PRT0 },
-                }
-            })
-            Name (PRT0, Package() {
-                ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
-                Package () {
-                    Package () { "reg", 0 },
-                },
-                ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
-                Package () {
-                    Package () { "endpoint@0", EP00 },
-                }
-            })
-            Name (EP00, Package() {
-                ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
-                Package () {
-                    Package () { "reg", 0 },
-                    Package () { "remote-endpoint", Package() { \_SB.PCI0.ISP, "port@4", "endpoint@0" } },
-                }
-            })
-        }
+	Device (CAM0)
+	{
+	    Name (_DSD, Package () {
+		ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
+		Package () {
+		    Package () { "compatible", Package () { "nokia,smia" } },
+		},
+		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
+		Package () {
+		    Package () { "port@0", PRT0 },
+		}
+	    })
+	    Name (PRT0, Package() {
+		ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
+		Package () {
+		    Package () { "reg", 0 },
+		},
+		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
+		Package () {
+		    Package () { "endpoint@0", EP00 },
+		}
+	    })
+	    Name (EP00, Package() {
+		ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
+		Package () {
+		    Package () { "reg", 0 },
+		    Package () { "remote-endpoint", Package() { \_SB.PCI0.ISP, "port@4", "endpoint@0" } },
+		}
+	    })
+	}
     }
 
     Scope (\_SB.PCI0)
     {
-        Device (ISP)
-        {
-            Name (_DSD, Package () {
-                ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
-                Package () {
-                    Package () { "port@4", PRT4 },
-                }
-            })
-
-            Name (PRT4, Package() {
-                ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
-                Package () {
-                    Package () { "reg", 4 }, /* CSI-2 port number */
-                },
-                ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
-                Package () {
-                    Package () { "endpoint@0", EP40 },
-                }
-            })
-
-            Name (EP40, Package() {
-                ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
-                Package () {
-                    Package () { "reg", 0 },
-                    Package () { "remote-endpoint", Package () { \_SB.PCI0.I2C2.CAM0, "port@0", "endpoint@0" } },
-                }
-            })
-        }
+	Device (ISP)
+	{
+	    Name (_DSD, Package () {
+		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
+		Package () {
+		    Package () { "port@4", PRT4 },
+		}
+	    })
+
+	    Name (PRT4, Package() {
+		ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
+		Package () {
+		    Package () { "reg", 4 }, /* CSI-2 port number */
+		},
+		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
+		Package () {
+		    Package () { "endpoint@0", EP40 },
+		}
+	    })
+
+	    Name (EP40, Package() {
+		ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"),
+		Package () {
+		    Package () { "reg", 0 },
+		    Package () { "remote-endpoint", Package () { \_SB.PCI0.I2C2.CAM0, "port@0", "endpoint@0" } },
+		}
+	    })
+	}
     }
 
 Here, the port 0 of the "CAM0" device is connected to the port 4 of
-- 
2.11.0

[PATCH v2 2/2] Documentation: ACPI: Direct references are allowed to devices only

[Sakari Ailus]

In ACPI it is possible to make references to device objects only, not to
other objects inside a device. In practice this means that hierarchical
data extension targets must be in parentheses to make them strings.

Otherwise an acpica warning is produced.

Reported-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
---
 .../firmware-guide/acpi/dsd/data-node-references.rst         |  6 +++---
 Documentation/firmware-guide/acpi/dsd/graph.rst              | 12 ++++++------
 2 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/Documentation/firmware-guide/acpi/dsd/data-node-references.rst b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
index 1351984e767c8..febccbc5689d0 100644
--- a/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
+++ b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
@@ -45,8 +45,8 @@ the ANOD object which is also the final target node of the reference.
 	    Name (_DSD, Package () {
 		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
 		Package () {
-		    Package () { "node@0", NOD0 },
-		    Package () { "node@1", NOD1 },
+		    Package () { "node@0", "NOD0" },
+		    Package () { "node@1", "NOD1" },
 		}
 	    })
 	    Name (NOD0, Package() {
@@ -58,7 +58,7 @@ the ANOD object which is also the final target node of the reference.
 	    Name (NOD1, Package() {
 		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
 		Package () {
-		    Package () { "anothernode", ANOD },
+		    Package () { "anothernode", "ANOD" },
 		}
 	    })
 	    Name (ANOD, Package() {
diff --git a/Documentation/firmware-guide/acpi/dsd/graph.rst b/Documentation/firmware-guide/acpi/dsd/graph.rst
index 8a9019a38b66d..1a6ce7afba5ea 100644
--- a/Documentation/firmware-guide/acpi/dsd/graph.rst
+++ b/Documentation/firmware-guide/acpi/dsd/graph.rst
@@ -45,7 +45,7 @@ with "port" and must be followed by the "@" character and 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::
 
-    Package() { "port@4", PRT4 }
+    Package() { "port@4", "PRT4" }
 
 Further on, endpoints are located under the port nodes. The hierarchical
 data extension key of the endpoint nodes must begin with
@@ -54,7 +54,7 @@ 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() { "endpoint@0", EP40 }
+    Package() { "endpoint@0", "EP40" }
 
 Each port node contains a property extension key "port", the value of which is
 the number of the port. Each endpoint is similarly numbered with a property
@@ -91,7 +91,7 @@ A simple example of this is show below::
 		},
 		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
 		Package () {
-		    Package () { "port@0", PRT0 },
+		    Package () { "port@0", "PRT0" },
 		}
 	    })
 	    Name (PRT0, Package() {
@@ -101,7 +101,7 @@ A simple example of this is show below::
 		},
 		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
 		Package () {
-		    Package () { "endpoint@0", EP00 },
+		    Package () { "endpoint@0", "EP00" },
 		}
 	    })
 	    Name (EP00, Package() {
@@ -121,7 +121,7 @@ A simple example of this is show below::
 	    Name (_DSD, Package () {
 		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
 		Package () {
-		    Package () { "port@4", PRT4 },
+		    Package () { "port@4", "PRT4" },
 		}
 	    })
 
@@ -132,7 +132,7 @@ A simple example of this is show below::
 		},
 		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
 		Package () {
-		    Package () { "endpoint@0", EP40 },
+		    Package () { "endpoint@0", "EP40" },
 		}
 	    })
 
-- 
2.11.0

Re: [PATCH v2 2/2] Documentation: ACPI: Direct references are allowed to devices only

[Andy Shevchenko]

On Fri, May 10, 2019 at 12:46:03PM +0300, Sakari Ailus wrote:
> In ACPI it is possible to make references to device objects only, not to
> other objects inside a device. In practice this means that hierarchical
> data extension targets must be in parentheses to make them strings.
> 
> Otherwise an acpica warning is produced.
> 

Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

> Reported-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> Signed-off-by: Sakari Ailus <sakari.ailus@linux.intel.com>
> ---
>  .../firmware-guide/acpi/dsd/data-node-references.rst         |  6 +++---
>  Documentation/firmware-guide/acpi/dsd/graph.rst              | 12 ++++++------
>  2 files changed, 9 insertions(+), 9 deletions(-)
> 
> diff --git a/Documentation/firmware-guide/acpi/dsd/data-node-references.rst b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> index 1351984e767c8..febccbc5689d0 100644
> --- a/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> +++ b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
> @@ -45,8 +45,8 @@ the ANOD object which is also the final target node of the reference.
>  	    Name (_DSD, Package () {
>  		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
>  		Package () {
> -		    Package () { "node@0", NOD0 },
> -		    Package () { "node@1", NOD1 },
> +		    Package () { "node@0", "NOD0" },
> +		    Package () { "node@1", "NOD1" },
>  		}
>  	    })
>  	    Name (NOD0, Package() {
> @@ -58,7 +58,7 @@ the ANOD object which is also the final target node of the reference.
>  	    Name (NOD1, Package() {
>  		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
>  		Package () {
> -		    Package () { "anothernode", ANOD },
> +		    Package () { "anothernode", "ANOD" },
>  		}
>  	    })
>  	    Name (ANOD, Package() {
> diff --git a/Documentation/firmware-guide/acpi/dsd/graph.rst b/Documentation/firmware-guide/acpi/dsd/graph.rst
> index 8a9019a38b66d..1a6ce7afba5ea 100644
> --- a/Documentation/firmware-guide/acpi/dsd/graph.rst
> +++ b/Documentation/firmware-guide/acpi/dsd/graph.rst
> @@ -45,7 +45,7 @@ with "port" and must be followed by the "@" character and 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::
>  
> -    Package() { "port@4", PRT4 }
> +    Package() { "port@4", "PRT4" }
>  
>  Further on, endpoints are located under the port nodes. The hierarchical
>  data extension key of the endpoint nodes must begin with
> @@ -54,7 +54,7 @@ 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() { "endpoint@0", EP40 }
> +    Package() { "endpoint@0", "EP40" }
>  
>  Each port node contains a property extension key "port", the value of which is
>  the number of the port. Each endpoint is similarly numbered with a property
> @@ -91,7 +91,7 @@ A simple example of this is show below::
>  		},
>  		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
>  		Package () {
> -		    Package () { "port@0", PRT0 },
> +		    Package () { "port@0", "PRT0" },
>  		}
>  	    })
>  	    Name (PRT0, Package() {
> @@ -101,7 +101,7 @@ A simple example of this is show below::
>  		},
>  		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
>  		Package () {
> -		    Package () { "endpoint@0", EP00 },
> +		    Package () { "endpoint@0", "EP00" },
>  		}
>  	    })
>  	    Name (EP00, Package() {
> @@ -121,7 +121,7 @@ A simple example of this is show below::
>  	    Name (_DSD, Package () {
>  		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
>  		Package () {
> -		    Package () { "port@4", PRT4 },
> +		    Package () { "port@4", "PRT4" },
>  		}
>  	    })
>  
> @@ -132,7 +132,7 @@ A simple example of this is show below::
>  		},
>  		ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b"),
>  		Package () {
> -		    Package () { "endpoint@0", EP40 },
> +		    Package () { "endpoint@0", "EP40" },
>  		}
>  	    })
>  
> -- 
> 2.11.0
> 

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH v2 0/2] Fix ACPI object references

[Rafael J. Wysocki]

On Friday, May 10, 2019 11:46:01 AM CEST Sakari Ailus wrote:
> Hi all,
> 
> This set adds one patch for converting spaces to tabs before fixing the
> object references. Also rebased on the patch converting the text
> documentation to ReST.
> 
> Sakari Ailus (2):
>   Documentation: ACPI: Use tabs for indentation
>   Documentation: ACPI: Direct references are allowed to devices only
> 
>  .../acpi/dsd/data-node-references.rst              |   6 +-
>  Documentation/firmware-guide/acpi/dsd/graph.rst    | 120 ++++++++++-----------
>  2 files changed, 63 insertions(+), 63 deletions(-)
> 
> 

Both patches applied, thanks!