diff mbox series

[v12,1/5] dt-bindings: add documentation of xilinx clocking wizard

Message ID 20210810072533.27620-2-shubhrajyoti.datta@xilinx.com
State Superseded
Headers show
Series clk: clocking-wizard: Driver updates | expand

Commit Message

Shubhrajyoti Datta Aug. 10, 2021, 7:25 a.m. UTC
Add the devicetree binding for the xilinx clocking wizard.

Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@xilinx.com>
---
 v6:
 Fix a yaml warning
 v7:
 Add vendor prefix speed-grade
 v8:
 Fix the warnings
 v10:
 Add nr-outputs
 v11:
 add the compatibles for various versions
 rename nr-outputs to xlnx,nr-outputs
 v12:
 No change

 .../bindings/clock/xlnx,clocking-wizard.yaml  | 77 +++++++++++++++++++
 1 file changed, 77 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml

Comments

Rob Herring (Arm) Aug. 17, 2021, 7:52 p.m. UTC | #1
On Tue, Aug 10, 2021 at 12:55:29PM +0530, Shubhrajyoti Datta wrote:
> Add the devicetree binding for the xilinx clocking wizard.

> 

> Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@xilinx.com>

> ---

>  v6:

>  Fix a yaml warning

>  v7:

>  Add vendor prefix speed-grade

>  v8:

>  Fix the warnings

>  v10:

>  Add nr-outputs

>  v11:

>  add the compatibles for various versions

>  rename nr-outputs to xlnx,nr-outputs

>  v12:

>  No change

> 

>  .../bindings/clock/xlnx,clocking-wizard.yaml  | 77 +++++++++++++++++++

>  1 file changed, 77 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml

> 

> diff --git a/Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml b/Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml

> new file mode 100644

> index 000000000000..74a121988e92

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml

> @@ -0,0 +1,77 @@

> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

> +%YAML 1.2

> +---

> +$id: "http://devicetree.org/schemas/clock/xlnx,clocking-wizard.yaml#"

> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"

> +

> +title: Xilinx clocking wizard

> +

> +maintainers:

> +  - Shubhrajyoti Datta <shubhrajyoti.datta@xilinx.com>

> +

> +description:

> +  The clocking wizard is a soft ip clocking block of Xilinx versal. It

> +  reads required input clock frequencies from the devicetree and acts as clock

> +  clock output.

> +

> +properties:

> +  compatible:

> +    enum:

> +      - xlnx,clocking-wizard


What version is this one?

> +      - xlnx,clocking-wizard-v5-2 # version 5.2

> +      - xlnx,clocking-wizard-v6-0 # version 6.0


The comment is pretty pointless. And periods are allowed in compatible 
strings, so just do '-v5.2'.

> +

> +

> +  reg:

> +    maxItems: 1

> +

> +  "#clock-cells":

> +    const: 1

> +

> +  clocks:

> +    items:

> +      - description: clock input

> +      - description: axi clock

> +

> +  clock-names:

> +    items:

> +      - const: clk_in1

> +      - const: s_axi_aclk

> +

> +

> +  xlnx,speed-grade:

> +    $ref: /schemas/types.yaml#/definitions/uint32

> +    enum: [1, 2, 3]

> +    description:

> +      Speed grade of the device. Higher the speed grade faster is the FPGA device.

> +

> +  xlnx,nr-outputs:

> +    $ref: /schemas/types.yaml#/definitions/uint32

> +    minimum: 1

> +    maximum: 8

> +    description:

> +      Number of outputs.

> +

> +required:

> +  - compatible

> +  - reg

> +  - "#clock-cells"

> +  - clocks

> +  - clock-names

> +  - xlnx,speed-grade

> +  - xlnx,nr-outputs

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    clock-controller@b0000000  {

> +        compatible = "xlnx,clocking-wizard";

> +        reg = <0xb0000000 0x10000>;

> +        #clock-cells = <1>;

> +        xlnx,speed-grade = <1>;

> +        xlnx,nr-outputs = <6>;

> +        clock-names = "clk_in1", "s_axi_aclk";

> +        clocks = <&clkc 15>, <&clkc 15>;

> +    };

> +...

> -- 

> 2.17.1

> 

>
Shubhrajyoti Datta Aug. 19, 2021, 10:27 a.m. UTC | #2
On Wed, Aug 18, 2021 at 1:22 AM Rob Herring <robh@kernel.org> wrote:
>

> On Tue, Aug 10, 2021 at 12:55:29PM +0530, Shubhrajyoti Datta wrote:

> > Add the devicetree binding for the xilinx clocking wizard.

> >

> > Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@xilinx.com>

> > ---

> >  v6:

> >  Fix a yaml warning

> >  v7:

> >  Add vendor prefix speed-grade

> >  v8:

> >  Fix the warnings

> >  v10:

> >  Add nr-outputs

> >  v11:

> >  add the compatibles for various versions

> >  rename nr-outputs to xlnx,nr-outputs

> >  v12:

> >  No change

> >

> >  .../bindings/clock/xlnx,clocking-wizard.yaml  | 77 +++++++++++++++++++

> >  1 file changed, 77 insertions(+)

> >  create mode 100644 Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml

> >

> > diff --git a/Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml b/Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml

> > new file mode 100644

> > index 000000000000..74a121988e92

> > --- /dev/null

> > +++ b/Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml

> > @@ -0,0 +1,77 @@

> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

> > +%YAML 1.2

> > +---

> > +$id: "http://devicetree.org/schemas/clock/xlnx,clocking-wizard.yaml#"

> > +$schema: "http://devicetree.org/meta-schemas/core.yaml#"

> > +

> > +title: Xilinx clocking wizard

> > +

> > +maintainers:

> > +  - Shubhrajyoti Datta <shubhrajyoti.datta@xilinx.com>

> > +

> > +description:

> > +  The clocking wizard is a soft ip clocking block of Xilinx versal. It

> > +  reads required input clock frequencies from the devicetree and acts as clock

> > +  clock output.

> > +

> > +properties:

> > +  compatible:

> > +    enum:

> > +      - xlnx,clocking-wizard

>

> What version is this one?


This is kept for backward compatibility the current driver expects this string
>

> > +      - xlnx,clocking-wizard-v5-2 # version 5.2

> > +      - xlnx,clocking-wizard-v6-0 # version 6.0

>

> The comment is pretty pointless. And periods are allowed in compatible

> strings, so just do '-v5.2'.

sure will do.

>

> > +

> > +

> > +  reg:

> > +    maxItems: 1

> > +
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml b/Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml
new file mode 100644
index 000000000000..74a121988e92
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml
@@ -0,0 +1,77 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/clock/xlnx,clocking-wizard.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Xilinx clocking wizard
+
+maintainers:
+  - Shubhrajyoti Datta <shubhrajyoti.datta@xilinx.com>
+
+description:
+  The clocking wizard is a soft ip clocking block of Xilinx versal. It
+  reads required input clock frequencies from the devicetree and acts as clock
+  clock output.
+
+properties:
+  compatible:
+    enum:
+      - xlnx,clocking-wizard
+      - xlnx,clocking-wizard-v5-2 # version 5.2
+      - xlnx,clocking-wizard-v6-0 # version 6.0
+
+
+  reg:
+    maxItems: 1
+
+  "#clock-cells":
+    const: 1
+
+  clocks:
+    items:
+      - description: clock input
+      - description: axi clock
+
+  clock-names:
+    items:
+      - const: clk_in1
+      - const: s_axi_aclk
+
+
+  xlnx,speed-grade:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [1, 2, 3]
+    description:
+      Speed grade of the device. Higher the speed grade faster is the FPGA device.
+
+  xlnx,nr-outputs:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    minimum: 1
+    maximum: 8
+    description:
+      Number of outputs.
+
+required:
+  - compatible
+  - reg
+  - "#clock-cells"
+  - clocks
+  - clock-names
+  - xlnx,speed-grade
+  - xlnx,nr-outputs
+
+additionalProperties: false
+
+examples:
+  - |
+    clock-controller@b0000000  {
+        compatible = "xlnx,clocking-wizard";
+        reg = <0xb0000000 0x10000>;
+        #clock-cells = <1>;
+        xlnx,speed-grade = <1>;
+        xlnx,nr-outputs = <6>;
+        clock-names = "clk_in1", "s_axi_aclk";
+        clocks = <&clkc 15>, <&clkc 15>;
+    };
+...