| Message ID | 20211208101508.24582-1-david@ixit.cz |
|---|---|
| State | New |
| Headers | show |
| Series | [v4] dt-bindings: misc: fastrpc convert bindings to yaml | expand |
On Wed, Dec 08, 2021 at 11:15:08AM +0100, David Heidelberg wrote: > Convert Qualcomm FastRPC bindings to yaml format, so that we could validate > dt-entries correctly and any future additions can go into yaml format. > > Also: > - simplify example > - embrace compute-cb@ subnodes instead of just cb@ > > Signed-off-by: Srinivas Kandagatla <srinivas.kandagatla@linaro.org> > Signed-off-by: David Heidelberg <david@ixit.cz> > --- > v4: > - combined mine and Srinivas versions of the patch > - previously found issues should be fixed > > .../devicetree/bindings/misc/qcom,fastrpc.txt | 78 --------------- > .../bindings/misc/qcom,fastrpc.yaml | 94 +++++++++++++++++++ > 2 files changed, 94 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 2a1827ab50d2..000000000000 > --- 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 000000000000..f42ab208a7fc > --- /dev/null > +++ b/Documentation/devicetree/bindings/misc/qcom,fastrpc.yaml > @@ -0,0 +1,94 @@ > +# SPDX-License-Identifier: (GPL-2.0-only 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 FastRPC Driver > + > +maintainers: > + - Srinivas Kandagatla <srinivas.kandagatla@linaro.org> > + > +description: | > + 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. > + > +properties: > + compatible: > + items: > + - const: qcom,fastrpc > + > + label: > + items: > + enum: > + - adsp > + - mdsp > + - sdsp > + - cdsp > + > + '#address-cells': > + const: 1 > + > + '#size-cells': > + const: 0 > + > +patternProperties: > + "(compute-)?cb@[0-9]$": > + type: object > + > + description: > > + Each subnode of the Fastrpc represents compute context banks available on the dsp. > + > + properties: > + compatible: > + items: > + - const: qcom,fastrpc-compute-cb > + > + reg: > + maxItems: 1 > + > + qcom,nsession: > + $ref: /schemas/types.yaml#/definitions/uint32 > + default: 1 > + description: > > + A value indicating how many sessions can share this context bank. > + > + required: > + - compatible > + - reg > + > + additionalProperties: true Why? What other properties are present. > + > +required: > + - compatible > + - label > + - '#address-cells' > + - '#size-cells' > + > +additionalProperties: true Why? What other properties are present. This is generally never correct. Rob
Well, since this is a subnode, some nodes are not converted yet and at least know it'll bash about iommus, qcom,glink-channels and qcom,smd-channels. I can change it to false, bit it'll print these additional warnings, until other binding don't get converted. David > + required: > + - compatible > + - reg > + > + additionalProperties: true Why? What other properties are present. > + > +required: > + - compatible > + - label > + - '#address-cells' > + - '#size-cells' > + > +additionalProperties: true Why? What other properties are present. This is generally never correct. Rob
Should I pick different approach or keeping additionalProperties: true is suitable solution in this situation? Thanks David Heidelberg On Sun, Dec 12 2021 at 13:03:40 +0000, David Heidelberg <david@ixit.cz> wrote: > Well, since this is a subnode, some nodes are not converted yet and > at least know it'll bash about iommus, qcom,glink-channels and > qcom,smd-channels. I can change it to false, bit it'll print these > additional warnings, until other binding don't get converted. > > David > > >> + required: >> + - compatible >> + - reg >> + >> + additionalProperties: true > > Why? What other properties are present. > >> + >> +required: >> + - compatible >> + - label >> + - '#address-cells' >> + - '#size-cells' >> + >> +additionalProperties: true > > Why? What other properties are present. This is generally never > correct. > > Rob >
diff --git a/Documentation/devicetree/bindings/misc/qcom,fastrpc.txt b/Documentation/devicetree/bindings/misc/qcom,fastrpc.txt deleted file mode 100644 index 2a1827ab50d2..000000000000 --- 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 000000000000..f42ab208a7fc --- /dev/null +++ b/Documentation/devicetree/bindings/misc/qcom,fastrpc.yaml @@ -0,0 +1,94 @@ +# SPDX-License-Identifier: (GPL-2.0-only 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 FastRPC Driver + +maintainers: + - Srinivas Kandagatla <srinivas.kandagatla@linaro.org> + +description: | + 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. + +properties: + compatible: + items: + - const: qcom,fastrpc + + label: + items: + enum: + - adsp + - mdsp + - sdsp + - cdsp + + '#address-cells': + const: 1 + + '#size-cells': + const: 0 + +patternProperties: + "(compute-)?cb@[0-9]$": + type: object + + description: > + Each subnode of the Fastrpc represents compute context banks available on the dsp. + + properties: + compatible: + items: + - const: qcom,fastrpc-compute-cb + + reg: + maxItems: 1 + + qcom,nsession: + $ref: /schemas/types.yaml#/definitions/uint32 + default: 1 + description: > + A value indicating how many sessions can share this context bank. + + required: + - compatible + - reg + + additionalProperties: true + +required: + - compatible + - label + - '#address-cells' + - '#size-cells' + +additionalProperties: true + +examples: + - | + smd-edge { + label = "lpass"; + fastrpc { + compatible = "qcom,fastrpc"; + label = "adsp"; + qcom,smd-channels = "fastrpcsmd-apps-dsp"; + #address-cells = <1>; + #size-cells = <0>; + + compute-cb@1 { + compatible = "qcom,fastrpc-compute-cb"; + reg = <1>; + }; + + compute-cb@2 { + compatible = "qcom,fastrpc-compute-cb"; + reg = <2>; + }; + }; + };