[PATCH] dt-bindings: documentation: add clock bindings information for N5X

[PATCH] dt-bindings: documentation: add clock bindings information for N5X

[Dinh Nguyen]

Document the N5X clock bindings.

Signed-off-by: Dinh Nguyen <dinguyen@kernel.org>
---
 .../devicetree/bindings/clock/intel,n5x.yaml  | 46 +++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/clock/intel,n5x.yaml

diff --git a/Documentation/devicetree/bindings/clock/intel,n5x.yaml b/Documentation/devicetree/bindings/clock/intel,n5x.yaml
new file mode 100644
index 000000000000..9f022cff57ea
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/intel,n5x.yaml
@@ -0,0 +1,46 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/clock/intel,agilex.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Intel SoCFPGA eASIC N5X platform clock controller binding
+
+maintainers:
+  - Dinh Nguyen <dinguyen@kernel.org>
+
+description:
+  The Intel N5X Clock controller is an integrated clock controller, which
+  generates and supplies to all modules.
+
+properties:
+  compatible:
+    const: intel,n5x-clkmgr
+
+  '#clock-cells':
+    const: 1
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - '#clock-cells'
+
+additionalProperties: false
+
+examples:
+  # Clock controller node:
+  - |
+    clkmgr: clock-controller@ffd10000 {
+      compatible = "intel,n5x-clkmgr";
+      reg = <0xffd10000 0x1000>;
+      clocks = <&osc1>;
+      #clock-cells = <1>;
+    };
+...
-- 
2.25.1

Re: [PATCH] dt-bindings: documentation: add clock bindings information for N5X

[Rob Herring]

On Mon, 22 Mar 2021 10:04:06 -0500, Dinh Nguyen wrote:
> Document the N5X clock bindings.
> 
> Signed-off-by: Dinh Nguyen <dinguyen@kernel.org>
> ---
>  .../devicetree/bindings/clock/intel,n5x.yaml  | 46 +++++++++++++++++++
>  1 file changed, 46 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/clock/intel,n5x.yaml
> 

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

yamllint warnings/errors:

dtschema/dtc warnings/errors:
./Documentation/devicetree/bindings/clock/intel,n5x.yaml: $id: relative path/filename doesn't match actual path or filename
	expected: http://devicetree.org/schemas/clock/intel,n5x.yaml#
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/clock/intel,agilex.yaml: duplicate '$id' value 'http://devicetree.org/schemas/clock/intel,agilex.yaml#'

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

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.