Re: [PATCHv2 2/3] dt-bindings: documentation: add clock bindings information for Agilex

From: Stephen Boyd
Date: Mon Mar 09 2020 - 18:30:06 EST


Quoting Dinh Nguyen (2020-03-09 10:16:52)
> diff --git a/Documentation/devicetree/bindings/clock/intc,agilex.yaml b/Documentation/devicetree/bindings/clock/intc,agilex.yaml
> new file mode 100644
> index 000000000000..bd5c4f590e12
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/clock/intc,agilex.yaml
> @@ -0,0 +1,79 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/clock/intc,agilex.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Intel SoCFPGA Agilex platform clock controller binding
> +
> +maintainers:
> + - Dinh Nguyen <dinguyen@xxxxxxxxxx>
> +
> +description: |
> + The Intel Agilex Clock controller is an integrated clock controller, which
> + generates and supplies to all modules.
> +
> + This binding uses the common clock binding[1].
> + [1] Documentation/devicetree/bindings/clock/clock-bindings.txt

I think you can remove this last sentence, and drop the | on the
description because formatting doesn't matter.

> +
> +properties:
> + compatible:
> + oneOf:
> + - items:
> + - enum:
> + - intel,agilex-clkmgr
> +

Just use

compatible:
const: intel,agilex-clkmgr

> + '#clock-cells':
> + const: 1
> +
> +required:
> + - compatible
> + - reg
> + - '#clock-cells'
> +
> +examples:
> + # Clock controller node
> + - |
> + clkmgr: clock-controller@ffd10000 {
> + compatible = "intel,agilex-clkmgr";
> + reg = <0xffd10000 0x1000>;
> + #clock-cells = <1>;

Does it consume any clks?

> + };
> +
> + # External clocks

Everything below here is not necessary and shouldn't be in the binding.