Re: [PATCH 1/2] dt-bindings: mailbox: Add the Spreadtrum mailbox documentation

[Rob Herring]

On Fri, Mar 06, 2020 at 02:07:21PM +0800, Baolin Wang wrote:
> From: Baolin Wang <baolin.wang@xxxxxxxxxx>
> 
> Add the Spreadtrum mailbox documentation.
> 
> Signed-off-by: Baolin Wang <baolin.wang@xxxxxxxxxx>
> Signed-off-by: Baolin Wang <baolin.wang7@xxxxxxxxx>
> ---
>  .../devicetree/bindings/mailbox/sprd-mailbox.yaml  | 56 ++++++++++++++++++++++
>  1 file changed, 56 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/mailbox/sprd-mailbox.yaml
> 
> diff --git a/Documentation/devicetree/bindings/mailbox/sprd-mailbox.yaml b/Documentation/devicetree/bindings/mailbox/sprd-mailbox.yaml
> new file mode 100644
> index 0000000..2f2fdcf
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/mailbox/sprd-mailbox.yaml
> @@ -0,0 +1,56 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/mailbox/sprd-mailbox.yaml#";
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#";
> +
> +title: Spreadtrum mailbox controller bindings
> +
> +maintainers:
> +  - Orson Zhai <orsonzhai@xxxxxxxxx>
> +  - Baolin Wang <baolin.wang7@xxxxxxxxx>
> +  - Chunyan Zhang <zhang.lyra@xxxxxxxxx>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - sprd,sc9860-mailbox
> +
> +  reg:
> +    minItems: 2

Need to define what each entry is.

> +
> +  interrupts:
> +    minItems: 2
> +    description:
> +      Contains the inbox and outbox interrupt information.

The description should be split to define each entry:

items:
  - description: inbox interrupt
  - description: outbox interrupt

> +
> +  clocks:
> +    maxItems: 1
> +
> +  clock-names:
> +    items:
> +      - const: enable
> +
> +  "#mbox-cells":
> +    const: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - "#mbox-cells"
> +  - clocks
> +  - clock-names

Add:

additionalProperties: false

> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    mailbox: mailbox@400a0000 {
> +      compatible = "sprd,sc9860-mailbox";
> +      reg = <0 0x400a0000 0 0x8000>, <0 0x400a8000 0 0x8000>;
> +      #mbox-cells = <1>;
> +      clock-names = "enable";
> +      clocks = <&aon_gate 53>;
> +      interrupts = <GIC_SPI 28 IRQ_TYPE_LEVEL_HIGH>, <GIC_SPI 29 IRQ_TYPE_LEVEL_HIGH>;
> +    };
> +...
> -- 
> 1.9.1
>