[PATCH] dt-bindings: mailbox: mtk-gce: Convert txt to json-schema

[Krzysztof Kozlowski]

On 19/05/2022 12:18, AngeloGioacchino Del Regno wrote:
> Convert the mtk-gce documentation from freeform text format to a
> json-schema.
> 
> Signed-off-by: AngeloGioacchino Del Regno <angelogioacchino.delregno at collabora.com>
> ---
>  .../bindings/mailbox/mediatek,gce-mbox.yaml   | 114 ++++++++++++++++++
>  .../devicetree/bindings/mailbox/mtk-gce.txt   |  82 -------------
>  2 files changed, 114 insertions(+), 82 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/mailbox/mediatek,gce-mbox.yaml
>  delete mode 100644 Documentation/devicetree/bindings/mailbox/mtk-gce.txt
> 
> diff --git a/Documentation/devicetree/bindings/mailbox/mediatek,gce-mbox.yaml b/Documentation/devicetree/bindings/mailbox/mediatek,gce-mbox.yaml
> new file mode 100644
> index 000000000000..750391b4038c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mailbox/mediatek,gce-mbox.yaml
> @@ -0,0 +1,114 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/mailbox/mediatek,gce-mbox.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: MediaTek Global Command Engine (GCE) mailbox
> +
> +maintainers:
> +  - Houlong Wei <houlong.wei at mediatek.com>
> +
> +description: |
> +  The Global Command Engine (GCE) is used to help read/write registers
> +  with critical time limitation, such as updating display configuration
> +  during the vblank.
> +  The GCE can be used to implement the Command Queue (CMDQ) driver.

Mention the headers in description.

> +
> +properties:
> +  compatible:
> +    enum:
> +      - mediatek,mt6779-gce
> +      - mediatek,mt8173-gce
> +      - mediatek,mt8183-gce
> +      - mediatek,mt8186-gce
> +      - mediatek,mt8192-gce
> +      - mediatek,mt8195-gce
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  clock-names:
> +    items:
> +      - const: gce
> +
> +  '#mbox-cells':
> +    description: |
> +      The first cell describes the mailbox channel, which is the GCE Thread ID;
> +      The second cell describes the priority of the GCE thread.
> +    const: 2
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks
> +  - clock-names
> +  - '#mbox-cells'
> +
> +additionalProperties: false
> +
> +allOf:
> +  - if:
> +      properties:
> +        compatible:
> +          enum:
> +            - mediatek,mt8195-gce
> +    then:
> +      properties:
> +        clocks:
> +          maxItems: 2

Are you sure this works on mt8195-gce?

> +
> +        clock-names:
> +          items:
> +            - const: gce0
> +            - const: gce1
> +

Best regards,
Krzysztof