diff mbox series

[1/5] dt-bindings: misc: convert fastrpc bindings to yaml and add property

Message ID 1637849744-24844-2-git-send-email-jeyr@codeaurora.org (mailing list archive)
State Not Applicable
Headers show
Series Add secure domains support | expand

Commit Message

Jeya R Nov. 25, 2021, 2:15 p.m. UTC
Convert Qualcomm FastRPC bindings to yaml format and add a property
to set dsp domain as non-secure.

Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
Signed-off-by: Jeya R <jeyr@codeaurora.org>
---
 .../devicetree/bindings/misc/qcom,fastrpc.txt      | 78 -----------------
 .../devicetree/bindings/misc/qcom,fastrpc.yaml     | 97 ++++++++++++++++++++++
 2 files changed, 97 insertions(+), 78 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/misc/qcom,fastrpc.txt
 create mode 100644 Documentation/devicetree/bindings/misc/qcom,fastrpc.yaml

Comments

Srinivas Kandagatla Nov. 25, 2021, 2:41 p.m. UTC | #1
Hi Jeya,

You should retain the original patch ownership while sending the patches.

On 25/11/2021 14:15, Jeya R wrote:
> Convert Qualcomm FastRPC bindings to yaml format and add a property
> to set dsp domain as non-secure.
> 
> Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
> Signed-off-by: Jeya R <jeyr@codeaurora.org>
> ---
>   .../devicetree/bindings/misc/qcom,fastrpc.txt      | 78 -----------------
>   .../devicetree/bindings/misc/qcom,fastrpc.yaml     | 97 ++++++++++++++++++++++
>   2 files changed, 97 insertions(+), 78 deletions(-)
>   delete mode 100644 Documentation/devicetree/bindings/misc/qcom,fastrpc.txt
>   create mode 100644 Documentation/devicetree/bindings/misc/qcom,fastrpc.yaml
> 
> diff --git a/Documentation/devicetree/bindings/misc/qcom,fastrpc.txt b/Documentation/devicetree/bindings/misc/qcom,fastrpc.txt
> deleted file mode 100644
> index 2a1827a..0000000
> --- a/Documentation/devicetree/bindings/misc/qcom,fastrpc.txt
> +++ /dev/null
> @@ -1,78 +0,0 @@
> -Qualcomm Technologies, Inc. FastRPC Driver
> -
> -The FastRPC implements an IPC (Inter-Processor Communication)
> -mechanism that allows for clients to transparently make remote method
> -invocations across DSP and APPS boundaries. This enables developers
> -to offload tasks to the DSP and free up the application processor for
> -other tasks.
> -
> -- compatible:
> -	Usage: required
> -	Value type: <stringlist>
> -	Definition: must be "qcom,fastrpc"
> -
> -- label
> -	Usage: required
> -	Value type: <string>
> -	Definition: should specify the dsp domain name this fastrpc
> -	corresponds to. must be one of this: "adsp", "mdsp", "sdsp", "cdsp"
> -
> -- #address-cells
> -	Usage: required
> -	Value type: <u32>
> -	Definition: Must be 1
> -
> -- #size-cells
> -	Usage: required
> -	Value type: <u32>
> -	Definition: Must be 0
> -
> -= COMPUTE BANKS
> -Each subnode of the Fastrpc represents compute context banks available
> -on the dsp.
> -- All Compute context banks MUST contain the following properties:
> -
> -- compatible:
> -	Usage: required
> -	Value type: <stringlist>
> -	Definition: must be "qcom,fastrpc-compute-cb"
> -
> -- reg
> -	Usage: required
> -	Value type: <u32>
> -	Definition: Context Bank ID.
> -
> -- qcom,nsessions:
> -	Usage: Optional
> -	Value type: <u32>
> -	Defination: A value indicating how many sessions can share this
> -		    context bank. Defaults to 1 when this property
> -		    is not specified.
> -
> -Example:
> -
> -adsp-pil {
> -	compatible = "qcom,msm8996-adsp-pil";
> -	...
> -	smd-edge {
> -		label = "lpass";
> -		fastrpc {
> -			compatible = "qcom,fastrpc";
> -			qcom,smd-channels = "fastrpcsmd-apps-dsp";
> -			label = "adsp";
> -			#address-cells = <1>;
> -			#size-cells = <0>;
> -
> -			cb@1 {
> -				compatible = "qcom,fastrpc-compute-cb";
> -				reg = <1>;
> -			};
> -
> -			cb@2 {
> -				compatible = "qcom,fastrpc-compute-cb";
> -				reg = <2>;
> -			};
> -			...
> -		};
> -	};
> -};
> diff --git a/Documentation/devicetree/bindings/misc/qcom,fastrpc.yaml b/Documentation/devicetree/bindings/misc/qcom,fastrpc.yaml
> new file mode 100644
> index 0000000..c3fe39b2
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/misc/qcom,fastrpc.yaml
> @@ -0,0 +1,97 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/misc/qcom,fastrpc.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> +
> +title: Qualcomm Technologies, Inc. FastRPC Driver
> +
> +maintainers:
> +  - Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
> +
> +description: |
> +  This binding describes Qualcomm FastRPC an IPC (Inter-Processor Communication)
> +  mechanism that allows for clients to transparently make remote method
> +  invocations across DSP and APPS boundaries. This enables developers
> +  to offload tasks to the DSP and free up the application processor for
> +  other tasks.
> +
> +properties:
> +  compatible:
> +    const: qcom,fastrpc
> +
> +  label:
> +    enum:
> +      - adsp
> +      - mdsp
> +      - sdsp
> +      - cdsp
> +
> +  qcom,non-secure-domain: true
> +    # Specify that dsp domain is non-secure.
> +

This change was not there in the original patch that I shared, you 
should add this change in a separate patch, as first patch converts to 
yaml and next one adds new bindings.

This is also not following yaml style bindings.
Please take some time to look at 
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/devicetree/bindings/example-schema.yaml?h=v5.16-rc2
to add new binding.



--srini

> +  "#address-cells":
> +    const: 1
> +
> +  "#size-cells":
> +    const: 0
> +
> +patternProperties:
> +  "^cb@[0-9a-f]$":
> +    type: object
> +    description: |
> +      Compute context bank
> +
> +    properties:
> +      compatible:
> +        const: qcom,fastrpc-compute-cb
> +
> +      reg:
> +        maxItems: 1
> +        description: Context Bank ID
> +
> +      qcom,nsessions:
> +        $ref: /schemas/types.yaml#/definitions/uint32
> +        description: How many sessions can share this context bank.
> +                     Defaults to 1 when this property is not specified.
> +
> +    required:
> +      - compatible
> +      - reg
> +
> +    additionalProperties: false
> +
> +required:
> +  - compatible
> +  - label
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    adsp-pil {
> +        compatible = "qqcom,msm8996-adsp-pil";
> +
> +        smd-edge {
> +            label = "lpass";
> +
> +            fastrpc {
> +                compatible = "qcom,fastrpc";
> +                label = "adsp";
> +                #address-cells = <1>;
> +                #size-cells = <0>;
> +
> +                cb@1 {
> +                    compatible = "qcom,fastrpc-compute-cb";
> +                    reg = <1>;
> +                };
> +
> +                cb@2 {
> +                    compatible = "qcom,fastrpc-compute-cb";
> +                    reg = <2>;
> +                };
> +            };
> +        };
> +    };
> +
> +
>
Jeya R Nov. 26, 2021, 4:54 a.m. UTC | #2
On 2021-11-25 20:11, Srinivas Kandagatla wrote:
> Hi Jeya,
> 
> You should retain the original patch ownership while sending the 
> patches.
Sure Srini, will add new property as dependent to yaml conversion patch.
> 
> On 25/11/2021 14:15, Jeya R wrote:
>> Convert Qualcomm FastRPC bindings to yaml format and add a property
>> to set dsp domain as non-secure.
>> 
>> Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
>> Signed-off-by: Jeya R <jeyr@codeaurora.org>
>> ---
>>   .../devicetree/bindings/misc/qcom,fastrpc.txt      | 78 
>> -----------------
>>   .../devicetree/bindings/misc/qcom,fastrpc.yaml     | 97 
>> ++++++++++++++++++++++
>>   2 files changed, 97 insertions(+), 78 deletions(-)
>>   delete mode 100644 
>> Documentation/devicetree/bindings/misc/qcom,fastrpc.txt
>>   create mode 100644 
>> Documentation/devicetree/bindings/misc/qcom,fastrpc.yaml
>> 
>> diff --git a/Documentation/devicetree/bindings/misc/qcom,fastrpc.txt 
>> b/Documentation/devicetree/bindings/misc/qcom,fastrpc.txt
>> deleted file mode 100644
>> index 2a1827a..0000000
>> --- a/Documentation/devicetree/bindings/misc/qcom,fastrpc.txt
>> +++ /dev/null
>> @@ -1,78 +0,0 @@
>> -Qualcomm Technologies, Inc. FastRPC Driver
>> -
>> -The FastRPC implements an IPC (Inter-Processor Communication)
>> -mechanism that allows for clients to transparently make remote method
>> -invocations across DSP and APPS boundaries. This enables developers
>> -to offload tasks to the DSP and free up the application processor for
>> -other tasks.
>> -
>> -- compatible:
>> -	Usage: required
>> -	Value type: <stringlist>
>> -	Definition: must be "qcom,fastrpc"
>> -
>> -- label
>> -	Usage: required
>> -	Value type: <string>
>> -	Definition: should specify the dsp domain name this fastrpc
>> -	corresponds to. must be one of this: "adsp", "mdsp", "sdsp", "cdsp"
>> -
>> -- #address-cells
>> -	Usage: required
>> -	Value type: <u32>
>> -	Definition: Must be 1
>> -
>> -- #size-cells
>> -	Usage: required
>> -	Value type: <u32>
>> -	Definition: Must be 0
>> -
>> -= COMPUTE BANKS
>> -Each subnode of the Fastrpc represents compute context banks 
>> available
>> -on the dsp.
>> -- All Compute context banks MUST contain the following properties:
>> -
>> -- compatible:
>> -	Usage: required
>> -	Value type: <stringlist>
>> -	Definition: must be "qcom,fastrpc-compute-cb"
>> -
>> -- reg
>> -	Usage: required
>> -	Value type: <u32>
>> -	Definition: Context Bank ID.
>> -
>> -- qcom,nsessions:
>> -	Usage: Optional
>> -	Value type: <u32>
>> -	Defination: A value indicating how many sessions can share this
>> -		    context bank. Defaults to 1 when this property
>> -		    is not specified.
>> -
>> -Example:
>> -
>> -adsp-pil {
>> -	compatible = "qcom,msm8996-adsp-pil";
>> -	...
>> -	smd-edge {
>> -		label = "lpass";
>> -		fastrpc {
>> -			compatible = "qcom,fastrpc";
>> -			qcom,smd-channels = "fastrpcsmd-apps-dsp";
>> -			label = "adsp";
>> -			#address-cells = <1>;
>> -			#size-cells = <0>;
>> -
>> -			cb@1 {
>> -				compatible = "qcom,fastrpc-compute-cb";
>> -				reg = <1>;
>> -			};
>> -
>> -			cb@2 {
>> -				compatible = "qcom,fastrpc-compute-cb";
>> -				reg = <2>;
>> -			};
>> -			...
>> -		};
>> -	};
>> -};
>> diff --git a/Documentation/devicetree/bindings/misc/qcom,fastrpc.yaml 
>> b/Documentation/devicetree/bindings/misc/qcom,fastrpc.yaml
>> new file mode 100644
>> index 0000000..c3fe39b2
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/misc/qcom,fastrpc.yaml
>> @@ -0,0 +1,97 @@
>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: "http://devicetree.org/schemas/misc/qcom,fastrpc.yaml#"
>> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
>> +
>> +title: Qualcomm Technologies, Inc. FastRPC Driver
>> +
>> +maintainers:
>> +  - Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
>> +
>> +description: |
>> +  This binding describes Qualcomm FastRPC an IPC (Inter-Processor 
>> Communication)
>> +  mechanism that allows for clients to transparently make remote 
>> method
>> +  invocations across DSP and APPS boundaries. This enables developers
>> +  to offload tasks to the DSP and free up the application processor 
>> for
>> +  other tasks.
>> +
>> +properties:
>> +  compatible:
>> +    const: qcom,fastrpc
>> +
>> +  label:
>> +    enum:
>> +      - adsp
>> +      - mdsp
>> +      - sdsp
>> +      - cdsp
>> +
>> +  qcom,non-secure-domain: true
>> +    # Specify that dsp domain is non-secure.
>> +
> 
> This change was not there in the original patch that I shared, you
> should add this change in a separate patch, as first patch converts to
> yaml and next one adds new bindings.
> 
> This is also not following yaml style bindings.
> Please take some time to look at
> https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/devicetree/bindings/example-schema.yaml?h=v5.16-rc2
> to add new binding.
> 
> 
> 
> --srini
This will be corrected as a new patch. Thanks.

> 
>> +  "#address-cells":
>> +    const: 1
>> +
>> +  "#size-cells":
>> +    const: 0
>> +
>> +patternProperties:
>> +  "^cb@[0-9a-f]$":
>> +    type: object
>> +    description: |
>> +      Compute context bank
>> +
>> +    properties:
>> +      compatible:
>> +        const: qcom,fastrpc-compute-cb
>> +
>> +      reg:
>> +        maxItems: 1
>> +        description: Context Bank ID
>> +
>> +      qcom,nsessions:
>> +        $ref: /schemas/types.yaml#/definitions/uint32
>> +        description: How many sessions can share this context bank.
>> +                     Defaults to 1 when this property is not 
>> specified.
>> +
>> +    required:
>> +      - compatible
>> +      - reg
>> +
>> +    additionalProperties: false
>> +
>> +required:
>> +  - compatible
>> +  - label
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    adsp-pil {
>> +        compatible = "qqcom,msm8996-adsp-pil";
>> +
>> +        smd-edge {
>> +            label = "lpass";
>> +
>> +            fastrpc {
>> +                compatible = "qcom,fastrpc";
>> +                label = "adsp";
>> +                #address-cells = <1>;
>> +                #size-cells = <0>;
>> +
>> +                cb@1 {
>> +                    compatible = "qcom,fastrpc-compute-cb";
>> +                    reg = <1>;
>> +                };
>> +
>> +                cb@2 {
>> +                    compatible = "qcom,fastrpc-compute-cb";
>> +                    reg = <2>;
>> +                };
>> +            };
>> +        };
>> +    };
>> +
>> +
>>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/misc/qcom,fastrpc.txt b/Documentation/devicetree/bindings/misc/qcom,fastrpc.txt
deleted file mode 100644
index 2a1827a..0000000
--- a/Documentation/devicetree/bindings/misc/qcom,fastrpc.txt
+++ /dev/null
@@ -1,78 +0,0 @@ 
-Qualcomm Technologies, Inc. FastRPC Driver
-
-The FastRPC implements an IPC (Inter-Processor Communication)
-mechanism that allows for clients to transparently make remote method
-invocations across DSP and APPS boundaries. This enables developers
-to offload tasks to the DSP and free up the application processor for
-other tasks.
-
-- compatible:
-	Usage: required
-	Value type: <stringlist>
-	Definition: must be "qcom,fastrpc"
-
-- label
-	Usage: required
-	Value type: <string>
-	Definition: should specify the dsp domain name this fastrpc
-	corresponds to. must be one of this: "adsp", "mdsp", "sdsp", "cdsp"
-
-- #address-cells
-	Usage: required
-	Value type: <u32>
-	Definition: Must be 1
-
-- #size-cells
-	Usage: required
-	Value type: <u32>
-	Definition: Must be 0
-
-= COMPUTE BANKS
-Each subnode of the Fastrpc represents compute context banks available
-on the dsp.
-- All Compute context banks MUST contain the following properties:
-
-- compatible:
-	Usage: required
-	Value type: <stringlist>
-	Definition: must be "qcom,fastrpc-compute-cb"
-
-- reg
-	Usage: required
-	Value type: <u32>
-	Definition: Context Bank ID.
-
-- qcom,nsessions:
-	Usage: Optional
-	Value type: <u32>
-	Defination: A value indicating how many sessions can share this
-		    context bank. Defaults to 1 when this property
-		    is not specified.
-
-Example:
-
-adsp-pil {
-	compatible = "qcom,msm8996-adsp-pil";
-	...
-	smd-edge {
-		label = "lpass";
-		fastrpc {
-			compatible = "qcom,fastrpc";
-			qcom,smd-channels = "fastrpcsmd-apps-dsp";
-			label = "adsp";
-			#address-cells = <1>;
-			#size-cells = <0>;
-
-			cb@1 {
-				compatible = "qcom,fastrpc-compute-cb";
-				reg = <1>;
-			};
-
-			cb@2 {
-				compatible = "qcom,fastrpc-compute-cb";
-				reg = <2>;
-			};
-			...
-		};
-	};
-};
diff --git a/Documentation/devicetree/bindings/misc/qcom,fastrpc.yaml b/Documentation/devicetree/bindings/misc/qcom,fastrpc.yaml
new file mode 100644
index 0000000..c3fe39b2
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/qcom,fastrpc.yaml
@@ -0,0 +1,97 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/misc/qcom,fastrpc.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Qualcomm Technologies, Inc. FastRPC Driver
+
+maintainers:
+  - Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
+
+description: |
+  This binding describes Qualcomm FastRPC an IPC (Inter-Processor Communication)
+  mechanism that allows for clients to transparently make remote method
+  invocations across DSP and APPS boundaries. This enables developers
+  to offload tasks to the DSP and free up the application processor for
+  other tasks.
+
+properties:
+  compatible:
+    const: qcom,fastrpc
+
+  label:
+    enum:
+      - adsp
+      - mdsp
+      - sdsp
+      - cdsp
+
+  qcom,non-secure-domain: true
+    # Specify that dsp domain is non-secure.
+
+  "#address-cells":
+    const: 1
+
+  "#size-cells":
+    const: 0
+
+patternProperties:
+  "^cb@[0-9a-f]$":
+    type: object
+    description: |
+      Compute context bank
+
+    properties:
+      compatible:
+        const: qcom,fastrpc-compute-cb
+
+      reg:
+        maxItems: 1
+        description: Context Bank ID
+
+      qcom,nsessions:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        description: How many sessions can share this context bank.
+                     Defaults to 1 when this property is not specified.
+
+    required:
+      - compatible
+      - reg
+
+    additionalProperties: false
+
+required:
+  - compatible
+  - label
+
+additionalProperties: false
+
+examples:
+  - |
+    adsp-pil {
+        compatible = "qqcom,msm8996-adsp-pil";
+
+        smd-edge {
+            label = "lpass";
+
+            fastrpc {
+                compatible = "qcom,fastrpc";
+                label = "adsp";
+                #address-cells = <1>;
+                #size-cells = <0>;
+
+                cb@1 {
+                    compatible = "qcom,fastrpc-compute-cb";
+                    reg = <1>;
+                };
+
+                cb@2 {
+                    compatible = "qcom,fastrpc-compute-cb";
+                    reg = <2>;
+                };
+            };
+        };
+    };
+
+