Re: [PATCH v3 14/15] dt-bindings: bus: Convert GISB arbiter to YAML

Rob Herring
2021-12-14T19:14:26Z

On Tue, Dec 07, 2021 at 04:37:25PM -0800, Florian Fainelli wrote:
> Convert the Broadcom STB GISB bus arbiter to YAML to help with
> validation.
>
> Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
> ---
> .../devicetree/bindings/bus/brcm,gisb-arb.txt | 34 ----------
> .../bindings/bus/brcm,gisb-arb.yaml | 66 +++++++++++++++++++
> 2 files changed, 66 insertions(+), 34 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/bus/brcm,gisb-arb.txt
> create mode 100644 Documentation/devicetree/bindings/bus/brcm,gisb-arb.yaml
>
> diff --git a/Documentation/devicetree/bindings/bus/brcm,gisb-arb.txt b/Documentation/devicetree/bindings/bus/brcm,gisb-arb.txt
> deleted file mode 100644
> index 10f6d0a8159d..000000000000
> --- a/Documentation/devicetree/bindings/bus/brcm,gisb-arb.txt
> +++ /dev/null
> @@ -1,34 +0,0 @@
> -Broadcom GISB bus Arbiter controller
> -
> -Required properties:
> -
> -- compatible:
> - "brcm,bcm7278-gisb-arb" for V7 28nm chips
> - "brcm,gisb-arb" or "brcm,bcm7445-gisb-arb" for other 28nm chips
> - "brcm,bcm7435-gisb-arb" for newer 40nm chips
> - "brcm,bcm7400-gisb-arb" for older 40nm chips and all 65nm chips
> - "brcm,bcm7038-gisb-arb" for 130nm chips
> -- reg: specifies the base physical address and size of the registers
> -- interrupts: specifies the two interrupts (timeout and TEA) to be used from
> - the parent interrupt controller. A third optional interrupt may be specified
> - for breakpoints.
> -
> -Optional properties:
> -
> -- brcm,gisb-arb-master-mask: 32-bits wide bitmask used to specify which GISB
> - masters are valid at the system level
> -- brcm,gisb-arb-master-names: string list of the litteral name of the GISB
> - masters. Should match the number of bits set in brcm,gisb-master-mask and
> - the order in which they appear
> -
> -Example:
> -
> -gisb-arb@f0400000 {
> - compatible = "brcm,gisb-arb";
> - reg = <0xf0400000 0x800>;
> - interrupts = <0>, <2>;
> - interrupt-parent = <&sun_l2_intc>;
> -
> - brcm,gisb-arb-master-mask = <0x7>;
> - brcm,gisb-arb-master-names = "bsp_0", "scpu_0", "cpu_0";
> -};
> diff --git a/Documentation/devicetree/bindings/bus/brcm,gisb-arb.yaml b/Documentation/devicetree/bindings/bus/brcm,gisb-arb.yaml
> new file mode 100644
> index 000000000000..483b019275cd
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/bus/brcm,gisb-arb.yaml
> @@ -0,0 +1,66 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/bus/brcm,gisb-arb.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Broadcom GISB bus Arbiter controller
> +
> +maintainers:
> + - Florian Fainelli <f.fainelli@gmail.com>
> +
> +properties:
> + compatible:
> + oneOf:
> + - items:
> + - enum:
> + - brcm,bcm7445-gisb-arb
> + - const: brcm,gisb-arb

> + - items:
> + - const: brcm,bcm7278-gisb-arb
> + - items:
> + - const: brcm,bcm7435-gisb-arb
> + - items:
> + - const: brcm,bcm7400-gisb-arb
> + - items:
> + - const: brcm,bcm7038-gisb-arb
> + - items:
> + - const: brcm,gisb-arb

All these can be 1 enum.

> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + minItems: 2
> + maxItems: 3

We lost what is each interrupt. Do something like this:

minItems: 2
items:
- description: ...
- description: ...
- description: ...

> +
> + brcm,gisb-arb-master-mask:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: >
> + 32-bits wide bitmask used to specify which GISB masters are valid at the
> + system level
> +
> + brcm,gisb-arb-master-names:
> + $ref: /schemas/types.yaml#/definitions/string-array
> + description: >
> + String list of the litteral name of the GISB masters. Should match the
> + number of bits set in brcm,gisb-master-mask and the order in which they

LSB to MSB or ???

> + appear

period ^

> +
> +required:
> + - compatible
> + - reg
> + - interrupts
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + gisb-arb@f0400000 {
> + compatible = "brcm,gisb-arb";
> + reg = <0xf0400000 0x800>;
> + interrupts = <0>, <2>;
> + interrupt-parent = <&sun_l2_intc>;
> + brcm,gisb-arb-master-mask = <0x7>;
> + brcm,gisb-arb-master-names = "bsp_0", "scpu_0", "cpu_0";
> + };
> --
> 2.25.1
>
>