Skip to contentSkip to conversation

dt-bindings: mailbox: xlnx,zynqmp-ipi-mailbox: Document msg region requirement

PATCH Applied Harini T 3 participants 3 messages Jan 9 – Jan 18

Subsystems (3)
lore
Share & tools
lore

Harini T

author
#0 lore raw

PATCH v2 1/1 dt-bindings: mailbox: xlnx,zynqmp-ipi-mailbox: Document msg region requirement

Add description clarifying that for Versal IPI mailboxes, both host and remote agents must have the "msg" register region defined for successful message passing. Without both, only notification-based communication works.

---
Changes in V2:
- The description regarding the "msg" register region requirement for Versal IPI mailboxes was moved from the conditional schema section to the main description block at the top of the YAML file.

V1 link: https://lore.kernel.org/all/[email protected]/

---
 .../bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml     | 11 +++++++++++
 1 file changed, 11 insertions(+)
Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml +11 -0
index 04d6473d666f..a5205ee5ad0f 100644
@@ -11,6 +11,17 @@ description: |
   messaging between two Xilinx Zynq UltraScale+ MPSoC IPI agents. Each IPI
   agent owns registers used for notification and buffers for message.
 
+  For Versal devices, there are two types of IPI channels:
+    - Buffered channels: Support message passing and require the "msg"
+    register region to be present on both the host and remote IPI agents.
+    - Buffer-less channels: Support notification only and do not require the
+    "msg" register region. For these channels, the "msg" region should be
+    omitted.
+
+  For message passing, both the host and remote IPI agents must define the "msg"
+  register region. If either agent omits the "msg" region, only notification
+  based communication is possible.
+
                +-------------------------------------+
                | Xilinx ZynqMP IPI Controller        |
                +-------------------------------------+
Signature · 1 line
2.43.0
maintainer Acked-by on v2 1/1
#1 lore raw
Quoted 12 lines · Harini T

Add description clarifying that for Versal IPI mailboxes, both host and remote agents must have the "msg" register region defined for successful message passing. Without both, only notification-based communication works.

---
Changes in V2:
- The description regarding the "msg" register region requirement for Versal IPI mailboxes was moved from the conditional schema section to the main description block at the top of the YAML file.

Quoted 5 lines

V1 link: https://lore.kernel.org/all/[email protected]/

---
 .../bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml     | 11 +++++++++++
 1 file changed, 11 insertions(+)
maintainer Applied
#2 lore raw
In reply to Harini T
Quoted 41 lines · Harini T

Add description clarifying that for Versal IPI mailboxes, both host and remote agents must have the "msg" register region defined for successful message passing. Without both, only notification-based communication works.

---
Changes in V2:
- The description regarding the "msg" register region requirement for Versal IPI mailboxes was moved from the conditional schema section to the main description block at the top of the YAML file.

V1 link: https://lore.kernel.org/all/[email protected]/

---
 .../bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml     | 11 +++++++++++
 1 file changed, 11 insertions(+)
Documentation/devicetree/bindings/mailbox/xlnx,zynqmp-ipi-mailbox.yaml +11 -1
index 04d6473d666f..a5205ee5ad0f 100644
@@ -11,6 +11,17 @@ description: |
   messaging between two Xilinx Zynq UltraScale+ MPSoC IPI agents. Each IPI
   agent owns registers used for notification and buffers for message.
 
+  For Versal devices, there are two types of IPI channels:
+    - Buffered channels: Support message passing and require the "msg"
+    register region to be present on both the host and remote IPI agents.
+    - Buffer-less channels: Support notification only and do not require the
+    "msg" register region. For these channels, the "msg" region should be
+    omitted.
+
+  For message passing, both the host and remote IPI agents must define the "msg"
+  register region. If either agent omits the "msg" region, only notification
+  based communication is possible.
+
                +-------------------------------------+
                | Xilinx ZynqMP IPI Controller        |
                +-------------------------------------+
--
Quoted 2 lines

2.43.0

Applied to mailbox/for-next.
Thanks.