diff mbox series

[v8,1/7] dt-bindings: add documentation of xilinx clocking wizard

Message ID 1612446810-6113-2-git-send-email-shubhrajyoti.datta@xilinx.com
State New
Headers show
Series clk: clk-wizard: clock-wizard: Driver updates | expand

Commit Message

Shubhrajyoti Datta Feb. 4, 2021, 1:53 p.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

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

Comments

Rob Herring (Arm) Feb. 4, 2021, 3:20 p.m. UTC | #1
On Thu, 04 Feb 2021 19:23:24 +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
> 
>  .../bindings/clock/xlnx,clocking-wizard.yaml       | 62 ++++++++++++++++++++++
>  1 file changed, 62 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml
> 

My bot found errors running 'make dt_binding_check' on your patch:

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.example.dt.yaml: clock-generator@40040000: 'speed-grade' is a required property
	From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.example.dt.yaml: clock-generator@40040000: 'clock-output-names', 'reg' do not match any of the regexes: 'pinctrl-[0-9]+'
	From schema: /builds/robherring/linux-dt-review/Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml

See https://patchwork.ozlabs.org/patch/1436021

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.
Stephen Boyd Feb. 5, 2021, 6:36 p.m. UTC | #2
Quoting Shubhrajyoti Datta (2021-02-04 05:53:24)
> 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


Please run the dt binding checks.

> 

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

>  1 file changed, 62 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 0000000..579bcc1

> --- /dev/null

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

> @@ -0,0 +1,62 @@

> +# 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:

> +    const: xlnx,clocking-wizard

> +

> +  "#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.

> +

> +required:

> +  - compatible

> +  - "#clock-cells"

> +  - clocks

> +  - clock-names

> +  - speed-grade


Should be xlnx,speed-grade.

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    clock-generator@40040000 {


Just clock-controller please.

> +        #clock-cells = <1>;

> +        reg = <0x40040000 0x1000>;

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

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

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

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

> +        clock-output-names = "clk_out1", "clk_out2",


Please remove this property and auto-generate clk names if necessary.

> +        "clk_out3", "clk_out4", "clk_out5",

> +        "clk_out6", "clk_out7";

> +    };

>
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 0000000..579bcc1
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/xlnx,clocking-wizard.yaml
@@ -0,0 +1,62 @@ 
+# 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:
+    const: xlnx,clocking-wizard
+
+  "#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.
+
+required:
+  - compatible
+  - "#clock-cells"
+  - clocks
+  - clock-names
+  - speed-grade
+
+additionalProperties: false
+
+examples:
+  - |
+    clock-generator@40040000 {
+        #clock-cells = <1>;
+        reg = <0x40040000 0x1000>;
+        compatible = "xlnx,clocking-wizard";
+        xlnx,speed-grade = <1>;
+        clock-names = "clk_in1", "s_axi_aclk";
+        clocks = <&clkc 15>, <&clkc 15>;
+        clock-output-names = "clk_out1", "clk_out2",
+        "clk_out3", "clk_out4", "clk_out5",
+        "clk_out6", "clk_out7";
+    };
+...