Re: [PATCH v4] dt-bindings: mailbox: zynqmp_ipi: convert to yaml

[Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>]

On 28/04/2022 18:50, Shubhrajyoti Datta wrote:
> Convert the ipi doc to yaml.
> 
> Signed-off-by: Shubhrajyoti Datta <shubhrajyoti.datta@xilinx.com>
> ---
> v2:

(...)

> +maintainers:
> +  - Shubhrajyoti Datta <shubhrajyoti.datta@xilinx.com>
> +
> +properties:
> +  compatible:
> +    const: xlnx,zynqmp-ipi-mailbox
> +
> +  method:
> +    description: |
> +                 The method of calling the PM-API firmware layer.
> +                 Permitted values are.
> +                 - "smc" : SMC #0, following the SMCCC
> +                 - "hvc" : HVC #0, following the SMCCC

Wrong alignment of entire description.

> +
> +    $ref: /schemas/types.yaml#/definitions/string-array

This does not look like string array, but regular string.

> +    enum:
> +      - smc
> +      - hvc
> +    default: smc
> +
> +  '#address-cells':
> +    const: 2
> +
> +  '#size-cells':
> +    const: 2
> +
> +  xlnx,ipi-id:
> +    description: |
> +      Remote Xilinx IPI agent ID of which the mailbox is connected to.
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  ranges: true
> +
> +additionalProperties: false
> +
> +required:
> +  - compatible
> +  - interrupts
> +  - '#address-cells'
> +  - '#size-cells'

Missing required xlnx,ipi-id. Such change was not explained in commit msg.

> +
> +patternProperties:

Put patternProperties just after "properties".

> +  '^mailbox@[0-9a-f]+$':
> +    description: Internal ipi mailbox node
> +    type: object  # DT nodes are json objects
> +    properties:
> +      xlnx,ipi-id:
> +        description:
> +          Remote Xilinx IPI agent ID of which the mailbox is connected to.
> +        $ref: /schemas/types.yaml#/definitions/uint32
> +
> +      "#mbox-cells":

Wrong quotes. Keep it consistent.

> +        const: 1
> +        description:
> +          It contains  tx(0) or rx(1) channel IPI id number.

No need for double space ^^.

> +
> +      reg:
> +        maxItems: 4
> +
> +      reg-names:
> +        items:
> +          - const: local_request_region
> +          - const: local_response_region
> +          - const: remote_request_region
> +          - const: remote_response_region
> +
> +
> +    required:
> +      - reg
> +      - "#mbox-cells"

Missing required properties.

> +
> +examples:
> +  - |
> +    amba {
> +      #address-cells = <0x2>;
> +      #size-cells = <0x2>;
> +      zynqmp_ipi {

Generic node names (mailbox?), no underscores in node names.

> +        compatible = "xlnx,zynqmp-ipi-mailbox";
> +        interrupts = <0 29 4>;

interrupts look like common flags, so use defines.

> +        xlnx,ipi-id = <0>;
> +        #address-cells = <2>;
> +        #size-cells = <2>;
> +        ranges;
> +
> +        ipi_mailbox_rpu0: mailbox@ff9905c0 {
> +          reg = <0x0 0xff9905c0 0x0 0x20>,
> +                <0x0 0xff9905e0 0x0 0x20>,
> +                <0x0 0xff990e80 0x0 0x20>,
> +                <0x0 0xff990ea0 0x0 0x20>;
> +          reg-names = "local_request_region",
> +                "local_response_region",

These needs alignment with first string.

> +                "remote_request_region",
> +                "remote_response_region";
> +          #mbox-cells = <1>;
> +          xlnx,ipi-id = <4>;
> +        };
> +      };
> +    };
> +
> +    rpu0 {
> +      mboxes = <&ipi_mailbox_rpu0 0>,
> +               <&ipi_mailbox_rpu0 1>;
> +      mbox-names = "tx", "rx";
> +    };

Skip consumer example, it's obvious.

> +...


Best regards,
Krzysztof