[PATCH] dt-binding: soc: qcom: convert Qualcomm Command DB documentation to yaml

[PATCH] dt-binding: soc: qcom: convert Qualcomm Command DB documentation to yaml

[David Heidelberg]

Convert Qualcomm Command DB documentation into yaml format.

Signed-off-by: David Heidelberg <david@ixit.cz>
---
 .../bindings/reserved-memory/qcom,cmd-db.txt  | 37 ---------------
 .../bindings/reserved-memory/qcom,cmd-db.yaml | 46 +++++++++++++++++++
 2 files changed, 46 insertions(+), 37 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt
 create mode 100644 Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml

diff --git a/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt b/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt
deleted file mode 100644
index 68395530c0a5..000000000000
--- a/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt
+++ /dev/null
@@ -1,37 +0,0 @@
-Command DB
----------
-
-Command DB is a database that provides a mapping between resource key and the
-resource address for a system resource managed by a remote processor. The data
-is stored in a shared memory region and is loaded by the remote processor.
-
-Some of the Qualcomm Technologies Inc SoC's have hardware accelerators for
-controlling shared resources. Depending on the board configuration the shared
-resource properties may change. These properties are dynamically probed by the
-remote processor and made available in the shared memory.
-
-The bindings for Command DB is specified in the reserved-memory section in
-devicetree. The devicetree representation of the command DB driver should be:
-
-Properties:
-- compatible:
-	Usage: required
-	Value type: <string>
-	Definition: Should be "qcom,cmd-db"
-
-- reg:
-	Usage: required
-	Value type: <prop encoded array>
-	Definition: The register address that points to the actual location of
-		    the Command DB in memory.
-
-Example:
-
-	reserved-memory {
-		[...]
-		reserved-memory@85fe0000 {
-			reg = <0x0 0x85fe0000 0x0 0x20000>;
-			compatible = "qcom,cmd-db";
-			no-map;
-		};
-	};
diff --git a/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml b/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml
new file mode 100644
index 000000000000..fa5cd6a77634
--- /dev/null
+++ b/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml
@@ -0,0 +1,46 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/reserved-memory/qcom,cmd-db.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Qualcomm Command DB
+
+description: |
+  Command DB is a database that provides a mapping between resource key and the
+  resource address for a system resource managed by a remote processor. The data
+  is stored in a shared memory region and is loaded by the remote processor.
+
+  Some of the Qualcomm Technologies Inc SoC's have hardware accelerators for
+  controlling shared resources. Depending on the board configuration the shared
+  resource properties may change. These properties are dynamically probed by the
+  remote processor and made available in the shared memory.
+
+maintainers:
+  - Mahesh Sivasubramanian <msivasub@codeaurora.org>
+
+allOf:
+  - $ref: "reserved-memory.yaml"
+
+properties:
+  compatible:
+    const: qcom,cmd-db
+
+required:
+  - reg
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    reserved-memory {
+        #address-cells = <1>;
+        #size-cells = <1>;
+        ranges;
+
+        reserved-memory@85fe0000 {
+            reg = <0x85fe0000 0x20000>;
+            compatible = "qcom,cmd-db";
+            no-map;
+        };
+    };
-- 
2.34.1

Re: [PATCH] dt-binding: soc: qcom: convert Qualcomm Command DB documentation to yaml

[David Heidelberg]

Since Mahesh Sivasubramanian <msivasub@codeaurora.org> email doesn't 
exist anymore (returned with 550 User doesn't exist.), who should I 
assign as maintainer for this document?
Davi

On Sat, Dec 18 2021 at 19:46:16 +0100, David Heidelberg <david@ixit.cz> 
wrote:
> Convert Qualcomm Command DB documentation into yaml format.
> 
> Signed-off-by: David Heidelberg <david@ixit.cz>
> ---
>  .../bindings/reserved-memory/qcom,cmd-db.txt  | 37 ---------------
>  .../bindings/reserved-memory/qcom,cmd-db.yaml | 46 
> +++++++++++++++++++
>  2 files changed, 46 insertions(+), 37 deletions(-)
>  delete mode 100644 
> Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt
>  create mode 100644 
> Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml
> 
> diff --git 
> a/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt 
> b/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt
> deleted file mode 100644
> index 68395530c0a5..000000000000
> --- 
> a/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt
> +++ /dev/null
> @@ -1,37 +0,0 @@
> -Command DB
> ----------
> -
> -Command DB is a database that provides a mapping between resource 
> key and the
> -resource address for a system resource managed by a remote 
> processor. The data
> -is stored in a shared memory region and is loaded by the remote 
> processor.
> -
> -Some of the Qualcomm Technologies Inc SoC's have hardware 
> accelerators for
> -controlling shared resources. Depending on the board configuration 
> the shared
> -resource properties may change. These properties are dynamically 
> probed by the
> -remote processor and made available in the shared memory.
> -
> -The bindings for Command DB is specified in the reserved-memory 
> section in
> -devicetree. The devicetree representation of the command DB driver 
> should be:
> -
> -Properties:
> -- compatible:
> -	Usage: required
> -	Value type: <string>
> -	Definition: Should be "qcom,cmd-db"
> -
> -- reg:
> -	Usage: required
> -	Value type: <prop encoded array>
> -	Definition: The register address that points to the actual location 
> of
> -		    the Command DB in memory.
> -
> -Example:
> -
> -	reserved-memory {
> -		[...]
> -		reserved-memory@85fe0000 {
> -			reg = <0x0 0x85fe0000 0x0 0x20000>;
> -			compatible = "qcom,cmd-db";
> -			no-map;
> -		};
> -	};
> diff --git 
> a/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml 
> b/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml
> new file mode 100644
> index 000000000000..fa5cd6a77634
> --- /dev/null
> +++ 
> b/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml
> @@ -0,0 +1,46 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: 
> "http://devicetree.org/schemas/reserved-memory/qcom,cmd-db.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> +
> +title: Qualcomm Command DB
> +
> +description: |
> +  Command DB is a database that provides a mapping between resource 
> key and the
> +  resource address for a system resource managed by a remote 
> processor. The data
> +  is stored in a shared memory region and is loaded by the remote 
> processor.
> +
> +  Some of the Qualcomm Technologies Inc SoC's have hardware 
> accelerators for
> +  controlling shared resources. Depending on the board configuration 
> the shared
> +  resource properties may change. These properties are dynamically 
> probed by the
> +  remote processor and made available in the shared memory.
> +
> +maintainers:
> +  - Mahesh Sivasubramanian <msivasub@codeaurora.org>
> +
> +allOf:
> +  - $ref: "reserved-memory.yaml"
> +
> +properties:
> +  compatible:
> +    const: qcom,cmd-db
> +
> +required:
> +  - reg
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    reserved-memory {
> +        #address-cells = <1>;
> +        #size-cells = <1>;
> +        ranges;
> +
> +        reserved-memory@85fe0000 {
> +            reg = <0x85fe0000 0x20000>;
> +            compatible = "qcom,cmd-db";
> +            no-map;
> +        };
> +    };
> --
> 2.34.1
> 

Re: [PATCH] dt-binding: soc: qcom: convert Qualcomm Command DB documentation to yaml

[Rob Herring]

On Sat, Dec 18, 2021 at 07:48:54PM +0100, David Heidelberg wrote:
> Since Mahesh Sivasubramanian <msivasub@codeaurora.org> email doesn't exist
> anymore (returned with 550 User doesn't exist.), who should I assign as
> maintainer for this document?

I'll update it to Bjorn when applying.

> Davi
> 
> On Sat, Dec 18 2021 at 19:46:16 +0100, David Heidelberg <david@ixit.cz>
> wrote:
> > Convert Qualcomm Command DB documentation into yaml format.
> > 
> > Signed-off-by: David Heidelberg <david@ixit.cz>
> > ---
> >  .../bindings/reserved-memory/qcom,cmd-db.txt  | 37 ---------------
> >  .../bindings/reserved-memory/qcom,cmd-db.yaml | 46 +++++++++++++++++++
> >  2 files changed, 46 insertions(+), 37 deletions(-)
> >  delete mode 100644
> > Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt
> >  create mode 100644
> > Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml
> > 
> > diff --git
> > a/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt
> > b/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt
> > deleted file mode 100644
> > index 68395530c0a5..000000000000
> > --- a/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt
> > +++ /dev/null
> > @@ -1,37 +0,0 @@
> > -Command DB
> > ----------
> > -
> > -Command DB is a database that provides a mapping between resource key
> > and the
> > -resource address for a system resource managed by a remote processor.
> > The data
> > -is stored in a shared memory region and is loaded by the remote
> > processor.
> > -
> > -Some of the Qualcomm Technologies Inc SoC's have hardware accelerators
> > for
> > -controlling shared resources. Depending on the board configuration the
> > shared
> > -resource properties may change. These properties are dynamically probed
> > by the
> > -remote processor and made available in the shared memory.
> > -
> > -The bindings for Command DB is specified in the reserved-memory section
> > in
> > -devicetree. The devicetree representation of the command DB driver
> > should be:
> > -
> > -Properties:
> > -- compatible:
> > -	Usage: required
> > -	Value type: <string>
> > -	Definition: Should be "qcom,cmd-db"
> > -
> > -- reg:
> > -	Usage: required
> > -	Value type: <prop encoded array>
> > -	Definition: The register address that points to the actual location of
> > -		    the Command DB in memory.
> > -
> > -Example:
> > -
> > -	reserved-memory {
> > -		[...]
> > -		reserved-memory@85fe0000 {
> > -			reg = <0x0 0x85fe0000 0x0 0x20000>;
> > -			compatible = "qcom,cmd-db";
> > -			no-map;
> > -		};
> > -	};
> > diff --git
> > a/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml
> > b/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml
> > new file mode 100644
> > index 000000000000..fa5cd6a77634
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml
> > @@ -0,0 +1,46 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: "http://devicetree.org/schemas/reserved-memory/qcom,cmd-db.yaml#"
> > +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> > +
> > +title: Qualcomm Command DB
> > +
> > +description: |
> > +  Command DB is a database that provides a mapping between resource key
> > and the
> > +  resource address for a system resource managed by a remote processor.
> > The data
> > +  is stored in a shared memory region and is loaded by the remote
> > processor.
> > +
> > +  Some of the Qualcomm Technologies Inc SoC's have hardware
> > accelerators for
> > +  controlling shared resources. Depending on the board configuration
> > the shared
> > +  resource properties may change. These properties are dynamically
> > probed by the
> > +  remote processor and made available in the shared memory.
> > +
> > +maintainers:
> > +  - Mahesh Sivasubramanian <msivasub@codeaurora.org>
> > +
> > +allOf:
> > +  - $ref: "reserved-memory.yaml"
> > +
> > +properties:
> > +  compatible:
> > +    const: qcom,cmd-db
> > +
> > +required:
> > +  - reg
> > +
> > +unevaluatedProperties: false
> > +
> > +examples:
> > +  - |
> > +    reserved-memory {
> > +        #address-cells = <1>;
> > +        #size-cells = <1>;
> > +        ranges;
> > +
> > +        reserved-memory@85fe0000 {
> > +            reg = <0x85fe0000 0x20000>;
> > +            compatible = "qcom,cmd-db";
> > +            no-map;
> > +        };
> > +    };
> > --
> > 2.34.1
> > 
> 
> 
> 

Re: [PATCH] dt-binding: soc: qcom: convert Qualcomm Command DB documentation to yaml

[Rob Herring]

On Sat, 18 Dec 2021 19:46:16 +0100, David Heidelberg wrote:
> Convert Qualcomm Command DB documentation into yaml format.
> 
> Signed-off-by: David Heidelberg <david@ixit.cz>
> ---
>  .../bindings/reserved-memory/qcom,cmd-db.txt  | 37 ---------------
>  .../bindings/reserved-memory/qcom,cmd-db.yaml | 46 +++++++++++++++++++
>  2 files changed, 46 insertions(+), 37 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.txt
>  create mode 100644 Documentation/devicetree/bindings/reserved-memory/qcom,cmd-db.yaml
> 

Applied, thanks!