Add documentation to describe Xilinx firmware driver bindings.
Firmware driver provides an interface to firmware APIs.
Interface APIs can be used by any driver to communicate
to Platform Management Unit.
Signed-off-by: Nava kishore Manne <[email protected]>
---
Changes for v4:
-Added new yaml file for xilinx firmware
as suggested by Rob.
.../firmware/xilinx/xlnx,zynqmp-firmware.yaml | 63 +++++++++++++++++++
1 file changed, 63 insertions(+)
create mode 100644 Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
diff --git a/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
new file mode 100644
index 000000000000..4b97f005bed7
--- /dev/null
+++ b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
@@ -0,0 +1,63 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/firmware/xilinx/xlnx,zynqmp-firmware.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Xilinx firmware driver
+
+maintainers:
+ - Nava kishore Manne <[email protected]>
+
+description:
+ The zynqmp-firmware node describes the interface to platform firmware.
+ ZynqMP has an interface to communicate with secure firmware. Firmware
+ driver provides an interface to firmware APIs. Interface APIs can be
+ used by any driver to communicate to PMUFW(Platform Management Unit).
+ These requests include clock management, pin control, device control,
+ power management service, FPGA service and other platform management
+ services.
+
+properties:
+ compatible:
+ oneOf:
+ - description:
+ For implementations complying for Zynq Ultrascale+ MPSoC.
+ const: xlnx,zynqmp-firmware
+
+ - description:
+ For implementations complying for Versal.
+ const: xlnx,versal-firmware
+
+ method:
+ description: The method of calling the PM-API firmware layer.
+ # Permitted values are:
+ # - "smc" : SMC #0, following the SMCCC
+ # - "hvc" : HVC #0, following the SMCCC
+ $ref: /schemas/types.yaml#/definitions/string-array
+ enum:
+ - smc
+ - hvc
+
+patternProperties:
+ "fpga":
+ description: Compatible of the FPGA device.
+ type: object
+
+ required:
+ - compatible
+
+required:
+ - compatible
+
+examples:
+ - |
+ versal-firmware {
+ compatible = "xlnx,versal-firmware";
+ method = "smc";
+ fpga {
+ compatible = "xlnx,versal-fpga";
+ };
+ };
+
+additionalProperties: false
--
2.17.1
On Thu, 29 Apr 2021 19:34:05 +0530, Nava kishore Manne wrote:
> Add documentation to describe Xilinx firmware driver bindings.
> Firmware driver provides an interface to firmware APIs.
> Interface APIs can be used by any driver to communicate
> to Platform Management Unit.
>
> Signed-off-by: Nava kishore Manne <[email protected]>
> ---
> Changes for v4:
> -Added new yaml file for xilinx firmware
> as suggested by Rob.
>
> .../firmware/xilinx/xlnx,zynqmp-firmware.yaml | 63 +++++++++++++++++++
> 1 file changed, 63 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
>
My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):
yamllint warnings/errors:
dtschema/dtc warnings/errors:
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/clock/xlnx,versal-clk.example.dt.yaml: zynqmp-firmware: 'clock-controller' does not match any of the regexes: 'fpga', 'pinctrl-[0-9]+'
From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/crypto/xlnx,zynqmp-aes.example.dt.yaml: zynqmp-firmware: 'zynqmp-aes' does not match any of the regexes: 'fpga', 'pinctrl-[0-9]+'
From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.example.dt.yaml:0:0: /example-0/versal-firmware/fpga: failed to match any schema with compatible: ['xlnx,versal-fpga']
See https://patchwork.ozlabs.org/patch/1471741
This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.
If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:
pip3 install dtschema --upgrade
Please check and re-submit.
On Thu, Apr 29, 2021 at 07:34:05PM +0530, Nava kishore Manne wrote:
> Add documentation to describe Xilinx firmware driver bindings.
> Firmware driver provides an interface to firmware APIs.
> Interface APIs can be used by any driver to communicate
> to Platform Management Unit.
>
> Signed-off-by: Nava kishore Manne <[email protected]>
> ---
> Changes for v4:
> -Added new yaml file for xilinx firmware
> as suggested by Rob.
>
> .../firmware/xilinx/xlnx,zynqmp-firmware.yaml | 63 +++++++++++++++++++
> 1 file changed, 63 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
What about the old doc?:
Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.txt
>
> diff --git a/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
> new file mode 100644
> index 000000000000..4b97f005bed7
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-firmware.yaml
> @@ -0,0 +1,63 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/firmware/xilinx/xlnx,zynqmp-firmware.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Xilinx firmware driver
> +
> +maintainers:
> + - Nava kishore Manne <[email protected]>
> +
> +description:
> + The zynqmp-firmware node describes the interface to platform firmware.
> + ZynqMP has an interface to communicate with secure firmware. Firmware
> + driver provides an interface to firmware APIs. Interface APIs can be
> + used by any driver to communicate to PMUFW(Platform Management Unit).
> + These requests include clock management, pin control, device control,
> + power management service, FPGA service and other platform management
> + services.
> +
> +properties:
> + compatible:
> + oneOf:
> + - description:
> + For implementations complying for Zynq Ultrascale+ MPSoC.
> + const: xlnx,zynqmp-firmware
> +
> + - description:
> + For implementations complying for Versal.
> + const: xlnx,versal-firmware
> +
> + method:
> + description: The method of calling the PM-API firmware layer.
> + # Permitted values are:
> + # - "smc" : SMC #0, following the SMCCC
> + # - "hvc" : HVC #0, following the SMCCC
Drop the '#'. If you want to maintain the formatting, then use '|' after
'description:' for a literal block.
> + $ref: /schemas/types.yaml#/definitions/string-array
> + enum:
> + - smc
> + - hvc
> +
> +patternProperties:
> + "fpga":
So 'foofpgabar' is valid?
> + description: Compatible of the FPGA device.
> + type: object
> +
> + required:
> + - compatible
This belongs in the fpga schema which should have a $ref here. (Which
means this patch needs to come 2nd.)
> +
> +required:
> + - compatible
> +
> +examples:
> + - |
> + versal-firmware {
> + compatible = "xlnx,versal-firmware";
> + method = "smc";
> + fpga {
> + compatible = "xlnx,versal-fpga";
> + };
> + };
> +
> +additionalProperties: false
> --
> 2.17.1
>
Hi Rob,
Please find my response inline.
> -----Original Message-----
> From: Rob Herring <[email protected]>
> Sent: Saturday, May 1, 2021 1:10 AM
> To: Nava kishore Manne <[email protected]>
> Cc: Michal Simek <[email protected]>; [email protected]; [email protected];
> [email protected]; [email protected]; Rajan Vaja
> <[email protected]>; Amit Sunil Dhamne <[email protected]>;
> Manish Narani <[email protected]>; [email protected]; Sai Krishna
> Potthuri <[email protected]>; [email protected]; Jiaying Liang
> <[email protected]>; [email protected]; [email protected];
> [email protected]; [email protected]; linux-
> [email protected]; [email protected]; git <[email protected]>
> Subject: Re: [PATCH v4 1/4] dt-bindings: firmware: Add bindings for xilinx
> firmware
>
> On Thu, Apr 29, 2021 at 07:34:05PM +0530, Nava kishore Manne wrote:
> > Add documentation to describe Xilinx firmware driver bindings.
> > Firmware driver provides an interface to firmware APIs.
> > Interface APIs can be used by any driver to communicate to Platform
> > Management Unit.
> >
> > Signed-off-by: Nava kishore Manne <[email protected]>
> > ---
> > Changes for v4:
> > -Added new yaml file for xilinx firmware
> > as suggested by Rob.
> >
> > .../firmware/xilinx/xlnx,zynqmp-firmware.yaml | 63
> > +++++++++++++++++++
> > 1 file changed, 63 insertions(+)
> > create mode 100644
> > Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> firmware
> > .yaml
>
> What about the old doc?:
>
As you suggested i have added only the fpga node relevant info here so it's not representing the complete firmware file with other sub node like clk, Aes, ...etc.
Once it completely mature we can deprecate the Old doc.
> Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> firmware.txt
>
> >
> > diff --git
> > a/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> firmwa
> > re.yaml
> > b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> firmwa
> > re.yaml
> > new file mode 100644
> > index 000000000000..4b97f005bed7
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-fi
> > +++ rmware.yaml
> > @@ -0,0 +1,63 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id:
> > +http://devicetree.org/schemas/firmware/xilinx/xlnx,zynqmp-firmware.ya
> > +ml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Xilinx firmware driver
> > +
> > +maintainers:
> > + - Nava kishore Manne <[email protected]>
> > +
> > +description:
> > + The zynqmp-firmware node describes the interface to platform
> firmware.
> > + ZynqMP has an interface to communicate with secure firmware.
> > +Firmware
> > + driver provides an interface to firmware APIs. Interface APIs can
> > +be
> > + used by any driver to communicate to PMUFW(Platform Management
> Unit).
> > + These requests include clock management, pin control, device
> > +control,
> > + power management service, FPGA service and other platform
> > +management
> > + services.
> > +
> > +properties:
> > + compatible:
> > + oneOf:
> > + - description:
> > + For implementations complying for Zynq Ultrascale+ MPSoC.
> > + const: xlnx,zynqmp-firmware
> > +
> > + - description:
> > + For implementations complying for Versal.
> > + const: xlnx,versal-firmware
> > +
> > + method:
> > + description: The method of calling the PM-API firmware layer.
> > + # Permitted values are:
> > + # - "smc" : SMC #0, following the SMCCC
> > + # - "hvc" : HVC #0, following the SMCCC
>
> Drop the '#'. If you want to maintain the formatting, then use '|' after
> 'description:' for a literal block.
>
Will fix in v5.
> > + $ref: /schemas/types.yaml#/definitions/string-array
> > + enum:
> > + - smc
> > + - hvc
> > +
> > +patternProperties:
> > + "fpga":
>
> So 'foofpgabar' is valid?
>
Yes, it's a valid for fpga node.
> > + description: Compatible of the FPGA device.
> > + type: object
> > +
> > + required:
> > + - compatible
>
> This belongs in the fpga schema which should have a $ref here. (Which
> means this patch needs to come 2nd.)
>
Will fix in v5.
Regards,
Navakishore.
On Tue, May 4, 2021 at 4:34 AM Nava kishore Manne <[email protected]> wrote:
>
> Hi Rob,
>
> Please find my response inline.
>
> > -----Original Message-----
> > From: Rob Herring <[email protected]>
> > Sent: Saturday, May 1, 2021 1:10 AM
> > To: Nava kishore Manne <[email protected]>
> > Cc: Michal Simek <[email protected]>; [email protected]; [email protected];
> > [email protected]; [email protected]; Rajan Vaja
> > <[email protected]>; Amit Sunil Dhamne <[email protected]>;
> > Manish Narani <[email protected]>; [email protected]; Sai Krishna
> > Potthuri <[email protected]>; [email protected]; Jiaying Liang
> > <[email protected]>; [email protected]; [email protected];
> > [email protected]; [email protected]; linux-
> > [email protected]; [email protected]; git <[email protected]>
> > Subject: Re: [PATCH v4 1/4] dt-bindings: firmware: Add bindings for xilinx
> > firmware
> >
> > On Thu, Apr 29, 2021 at 07:34:05PM +0530, Nava kishore Manne wrote:
> > > Add documentation to describe Xilinx firmware driver bindings.
> > > Firmware driver provides an interface to firmware APIs.
> > > Interface APIs can be used by any driver to communicate to Platform
> > > Management Unit.
> > >
> > > Signed-off-by: Nava kishore Manne <[email protected]>
> > > ---
> > > Changes for v4:
> > > -Added new yaml file for xilinx firmware
> > > as suggested by Rob.
> > >
> > > .../firmware/xilinx/xlnx,zynqmp-firmware.yaml | 63
> > > +++++++++++++++++++
> > > 1 file changed, 63 insertions(+)
> > > create mode 100644
> > > Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> > firmware
> > > .yaml
> >
> > What about the old doc?:
> >
>
> As you suggested i have added only the fpga node relevant info here so it's not representing the complete firmware file with other sub node like clk, Aes, ...etc.
> Once it completely mature we can deprecate the Old doc.
>
> > Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> > firmware.txt
> >
> > >
> > > diff --git
> > > a/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> > firmwa
> > > re.yaml
> > > b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> > firmwa
> > > re.yaml
> > > new file mode 100644
> > > index 000000000000..4b97f005bed7
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-fi
> > > +++ rmware.yaml
> > > @@ -0,0 +1,63 @@
> > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> > > +---
> > > +$id:
> > > +http://devicetree.org/schemas/firmware/xilinx/xlnx,zynqmp-firmware.ya
> > > +ml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: Xilinx firmware driver
> > > +
> > > +maintainers:
> > > + - Nava kishore Manne <[email protected]>
> > > +
> > > +description:
> > > + The zynqmp-firmware node describes the interface to platform
> > firmware.
> > > + ZynqMP has an interface to communicate with secure firmware.
> > > +Firmware
> > > + driver provides an interface to firmware APIs. Interface APIs can
> > > +be
> > > + used by any driver to communicate to PMUFW(Platform Management
> > Unit).
> > > + These requests include clock management, pin control, device
> > > +control,
> > > + power management service, FPGA service and other platform
> > > +management
> > > + services.
> > > +
> > > +properties:
> > > + compatible:
> > > + oneOf:
> > > + - description:
> > > + For implementations complying for Zynq Ultrascale+ MPSoC.
> > > + const: xlnx,zynqmp-firmware
> > > +
> > > + - description:
> > > + For implementations complying for Versal.
> > > + const: xlnx,versal-firmware
> > > +
> > > + method:
> > > + description: The method of calling the PM-API firmware layer.
> > > + # Permitted values are:
> > > + # - "smc" : SMC #0, following the SMCCC
> > > + # - "hvc" : HVC #0, following the SMCCC
> >
> > Drop the '#'. If you want to maintain the formatting, then use '|' after
> > 'description:' for a literal block.
> >
>
> Will fix in v5.
>
> > > + $ref: /schemas/types.yaml#/definitions/string-array
> > > + enum:
> > > + - smc
> > > + - hvc
> > > +
> > > +patternProperties:
> > > + "fpga":
> >
> > So 'foofpgabar' is valid?
> >
>
> Yes, it's a valid for fpga node.
No, please make the node name more specific.
Rob
Hi Rob,
Please find my response inline.
> -----Original Message-----
> From: Rob Herring <[email protected]>
> Sent: Tuesday, May 4, 2021 7:11 PM
> To: Nava kishore Manne <[email protected]>
> Cc: Michal Simek <[email protected]>; [email protected]; [email protected];
> [email protected]; [email protected]; Rajan Vaja
> <[email protected]>; Amit Sunil Dhamne <[email protected]>;
> Manish Narani <[email protected]>; [email protected]; Sai Krishna
> Potthuri <[email protected]>; [email protected]; Jiaying Liang
> <[email protected]>; [email protected]; [email protected];
> [email protected]; [email protected]; linux-
> [email protected]; [email protected]; git <[email protected]>
> Subject: Re: [PATCH v4 1/4] dt-bindings: firmware: Add bindings for xilinx
> firmware
>
> On Tue, May 4, 2021 at 4:34 AM Nava kishore Manne <[email protected]>
> wrote:
> >
> > Hi Rob,
> >
> > Please find my response inline.
> >
> > > -----Original Message-----
> > > From: Rob Herring <[email protected]>
> > > Sent: Saturday, May 1, 2021 1:10 AM
> > > To: Nava kishore Manne <[email protected]>
> > > Cc: Michal Simek <[email protected]>; [email protected];
> > > [email protected]; [email protected]; [email protected]; Rajan
> > > Vaja <[email protected]>; Amit Sunil Dhamne
> > > <[email protected]>; Manish Narani <[email protected]>;
> > > [email protected]; Sai Krishna Potthuri <[email protected]>;
> > > [email protected]; Jiaying Liang <[email protected]>;
> > > [email protected]; [email protected];
> > > [email protected]; [email protected];
> > > linux- [email protected]; [email protected]; git
> > > <[email protected]>
> > > Subject: Re: [PATCH v4 1/4] dt-bindings: firmware: Add bindings for
> > > xilinx firmware
> > >
> > > On Thu, Apr 29, 2021 at 07:34:05PM +0530, Nava kishore Manne wrote:
> > > > Add documentation to describe Xilinx firmware driver bindings.
> > > > Firmware driver provides an interface to firmware APIs.
> > > > Interface APIs can be used by any driver to communicate to
> > > > Platform Management Unit.
> > > >
> > > > Signed-off-by: Nava kishore Manne <[email protected]>
> > > > ---
> > > > Changes for v4:
> > > > -Added new yaml file for xilinx firmware
> > > > as suggested by Rob.
> > > >
> > > > .../firmware/xilinx/xlnx,zynqmp-firmware.yaml | 63
> > > > +++++++++++++++++++
> > > > 1 file changed, 63 insertions(+)
> > > > create mode 100644
> > > > Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> > > firmware
> > > > .yaml
> > >
> > > What about the old doc?:
> > >
> >
> > As you suggested i have added only the fpga node relevant info here so it's
> not representing the complete firmware file with other sub node like clk, Aes,
> ...etc.
> > Once it completely mature we can deprecate the Old doc.
> >
> > > Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> > > firmware.txt
> > >
> > > >
> > > > diff --git
> > > > a/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> > > firmwa
> > > > re.yaml
> > > > b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqmp-
> > > firmwa
> > > > re.yaml
> > > > new file mode 100644
> > > > index 000000000000..4b97f005bed7
> > > > --- /dev/null
> > > > +++ b/Documentation/devicetree/bindings/firmware/xilinx/xlnx,zynqm
> > > > +++ p-fi
> > > > +++ rmware.yaml
> > > > @@ -0,0 +1,63 @@
> > > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML
> > > > +1.2
> > > > +---
> > > > +$id:
> > > > +http://devicetree.org/schemas/firmware/xilinx/xlnx,zynqmp-firmwar
> > > > +e.ya
> > > > +ml#
> > > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > > +
> > > > +title: Xilinx firmware driver
> > > > +
> > > > +maintainers:
> > > > + - Nava kishore Manne <[email protected]>
> > > > +
> > > > +description:
> > > > + The zynqmp-firmware node describes the interface to platform
> > > firmware.
> > > > + ZynqMP has an interface to communicate with secure firmware.
> > > > +Firmware
> > > > + driver provides an interface to firmware APIs. Interface APIs
> > > > +can be
> > > > + used by any driver to communicate to PMUFW(Platform
> Management
> > > Unit).
> > > > + These requests include clock management, pin control, device
> > > > +control,
> > > > + power management service, FPGA service and other platform
> > > > +management
> > > > + services.
> > > > +
> > > > +properties:
> > > > + compatible:
> > > > + oneOf:
> > > > + - description:
> > > > + For implementations complying for Zynq Ultrascale+ MPSoC.
> > > > + const: xlnx,zynqmp-firmware
> > > > +
> > > > + - description:
> > > > + For implementations complying for Versal.
> > > > + const: xlnx,versal-firmware
> > > > +
> > > > + method:
> > > > + description: The method of calling the PM-API firmware layer.
> > > > + # Permitted values are:
> > > > + # - "smc" : SMC #0, following the SMCCC
> > > > + # - "hvc" : HVC #0, following the SMCCC
> > >
> > > Drop the '#'. If you want to maintain the formatting, then use '|'
> > > after 'description:' for a literal block.
> > >
> >
> > Will fix in v5.
> >
> > > > + $ref: /schemas/types.yaml#/definitions/string-array
> > > > + enum:
> > > > + - smc
> > > > + - hvc
> > > > +
> > > > +patternProperties:
> > > > + "fpga":
> > >
> > > So 'foofpgabar' is valid?
> > >
> >
> > Yes, it's a valid for fpga node.
>
> No, please make the node name more specific.
>
Will fix in v5.
Regards,
Navakishore.