diff mbox series

[1/2] dt-bindings: zynqmp: add destination mailbox compatible

Message ID 20231005170825.3521669-1-tanmay.shah@amd.com
State Superseded
Headers show
Series [1/2] dt-bindings: zynqmp: add destination mailbox compatible | expand

Commit Message

Tanmay Shah Oct. 5, 2023, 5:08 p.m. UTC 
Current dt-bindings does not contain compatible property
for child mailbox node. Child mailbox nodes are used
to represent destination (remote) IPI agents. The compatible
property for all destination mailboxes must be required.

Signed-off-by: Tanmay Shah <tanmay.shah@amd.com>
---
 .../bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml           | 6 ++++++
 1 file changed, 6 insertions(+)


base-commit: 7d730f1bf6f39ece2d9f3ae682f12e5b593d534d

Comments

Rob Herring (Arm) Oct. 6, 2023, 5:53 p.m. UTC | #1 
On Thu, Oct 05, 2023 at 10:08:24AM -0700, Tanmay Shah wrote:
> Current dt-bindings does not contain compatible property
> for child mailbox node. Child mailbox nodes are used
> to represent destination (remote) IPI agents. The compatible
> property for all destination mailboxes must be required.
> 
> Signed-off-by: Tanmay Shah <tanmay.shah@amd.com>
> ---
>  .../bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml           | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml b/Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml
> index aeaddbf574b0..8b15a0532120 100644
> --- a/Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml
> +++ b/Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml
> @@ -74,6 +74,10 @@ patternProperties:
>      type: object  # DT nodes are json objects
>      additionalProperties: false
>      properties:
> +
> +      compatible:
> +        const: xlnx,zynqmp-ipi-dest-mailbox
> +
>        xlnx,ipi-id:
>          description:
>            Remote Xilinx IPI agent ID of which the mailbox is connected to.
> @@ -95,6 +99,7 @@ patternProperties:
>            - const: remote_response_region
>  
>      required:
> +      - compatible

A new required property is an ABI break, but nothing about that in the 
commit msg.

>        - reg
>        - reg-names
>        - "#mbox-cells"
> @@ -124,6 +129,7 @@ examples:
>          ranges;
>  
>          mailbox: mailbox@ff9905c0 {
> +          compatible = "xlnx,zynqmp-ipi-dest-mailbox";
>            reg = <0x0 0xff9905c0 0x0 0x20>,
>                  <0x0 0xff9905e0 0x0 0x20>,
>                  <0x0 0xff990e80 0x0 0x20>,
> 
> base-commit: 7d730f1bf6f39ece2d9f3ae682f12e5b593d534d
> -- 
> 2.25.1
>
Tanmay Shah Oct. 6, 2023, 6:24 p.m. UTC | #2 
On 10/6/23 12:53 PM, Rob Herring wrote:
> On Thu, Oct 05, 2023 at 10:08:24AM -0700, Tanmay Shah wrote:
> > Current dt-bindings does not contain compatible property
> > for child mailbox node. Child mailbox nodes are used
> > to represent destination (remote) IPI agents. The compatible
> > property for all destination mailboxes must be required.
> > 
> > Signed-off-by: Tanmay Shah <tanmay.shah@amd.com>
> > ---
> >  .../bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml           | 6 ++++++
> >  1 file changed, 6 insertions(+)
> > 
> > diff --git a/Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml b/Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml
> > index aeaddbf574b0..8b15a0532120 100644
> > --- a/Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml
> > +++ b/Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml
> > @@ -74,6 +74,10 @@ patternProperties:
> >      type: object  # DT nodes are json objects
> >      additionalProperties: false
> >      properties:
> > +
> > +      compatible:
> > +        const: xlnx,zynqmp-ipi-dest-mailbox
> > +
> >        xlnx,ipi-id:
> >          description:
> >            Remote Xilinx IPI agent ID of which the mailbox is connected to.
> > @@ -95,6 +99,7 @@ patternProperties:
> >            - const: remote_response_region
> >  
> >      required:
> > +      - compatible
>
> A new required property is an ABI break, but nothing about that in the 
> commit msg.


Hi Rob,

Thanks for reviews. This does not break backward compatibility yet as

relative zynqmp mailbox driver isn't expecting compatible property.

But, any new functionality should consider using it.

I will explain this in commit message in next revision. Other than that, I hope it's

correct to add such compatible property to identify the node.


Thanks,

Tanmay

>
> >        - reg
> >        - reg-names
> >        - "#mbox-cells"
> > @@ -124,6 +129,7 @@ examples:
> >          ranges;
> >  
> >          mailbox: mailbox@ff9905c0 {
> > +          compatible = "xlnx,zynqmp-ipi-dest-mailbox";
> >            reg = <0x0 0xff9905c0 0x0 0x20>,
> >                  <0x0 0xff9905e0 0x0 0x20>,
> >                  <0x0 0xff990e80 0x0 0x20>,
> > 
> > base-commit: 7d730f1bf6f39ece2d9f3ae682f12e5b593d534d
> > -- 
> > 2.25.1
> >
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml b/Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml
index aeaddbf574b0..8b15a0532120 100644
--- a/Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml
+++ b/Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml
@@ -74,6 +74,10 @@  patternProperties:
     type: object  # DT nodes are json objects
     additionalProperties: false
     properties:
+
+      compatible:
+        const: xlnx,zynqmp-ipi-dest-mailbox
+
       xlnx,ipi-id:
         description:
           Remote Xilinx IPI agent ID of which the mailbox is connected to.
@@ -95,6 +99,7 @@  patternProperties:
           - const: remote_response_region
 
     required:
+      - compatible
       - reg
       - reg-names
       - "#mbox-cells"
@@ -124,6 +129,7 @@  examples:
         ranges;
 
         mailbox: mailbox@ff9905c0 {
+          compatible = "xlnx,zynqmp-ipi-dest-mailbox";
           reg = <0x0 0xff9905c0 0x0 0x20>,
                 <0x0 0xff9905e0 0x0 0x20>,
                 <0x0 0xff990e80 0x0 0x20>,