diff mbox

[1/9] Documentation: dt-bindings: add support for mailbox client shared memory

Message ID 1498492513-29771-2-git-send-email-sudeep.holla@arm.com
State Not Applicable, archived
Headers show

Commit Message

Sudeep Holla June 26, 2017, 3:55 p.m. UTC
Many users of the mailbox controllers depend on the shared memory between the
two end points to exchange the main data while using simple doorbell mechanism
to alert the end points of the presence of a message.

This patch defines device tree bindings to represent such shared memory in a
generic way.

Cc: Rob Herring <robh+dt@kernel.org>
Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
---
 .../devicetree/bindings/mailbox/mailbox.txt        | 28 ++++++++++++++++++++++
 1 file changed, 28 insertions(+)

Comments

Rob Herring June 28, 2017, 10:56 p.m. UTC | #1
On Mon, Jun 26, 2017 at 04:55:05PM +0100, Sudeep Holla wrote:
> Many users of the mailbox controllers depend on the shared memory between the
> two end points to exchange the main data while using simple doorbell mechanism
> to alert the end points of the presence of a message.

"dt-bindings: mailbox: ..." for the subject.

> 
> This patch defines device tree bindings to represent such shared memory in a
> generic way.
> 
> Cc: Rob Herring <robh+dt@kernel.org>
> Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
> ---
>  .../devicetree/bindings/mailbox/mailbox.txt        | 28 ++++++++++++++++++++++
>  1 file changed, 28 insertions(+)

Otherwise,

Acked-by: Rob Herring <robh@kernel.org>
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Sudeep Holla June 30, 2017, 10:24 a.m. UTC | #2
On 28/06/17 23:56, Rob Herring wrote:
> On Mon, Jun 26, 2017 at 04:55:05PM +0100, Sudeep Holla wrote:
>> Many users of the mailbox controllers depend on the shared memory between the
>> two end points to exchange the main data while using simple doorbell mechanism
>> to alert the end points of the presence of a message.
> 
> "dt-bindings: mailbox: ..." for the subject.
> 

Fixed locally now.

>>
>> This patch defines device tree bindings to represent such shared memory in a
>> generic way.
>>
>> Cc: Rob Herring <robh+dt@kernel.org>
>> Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
>> ---
>>  .../devicetree/bindings/mailbox/mailbox.txt        | 28 ++++++++++++++++++++++
>>  1 file changed, 28 insertions(+)
> 
> Otherwise,
> 
> Acked-by: Rob Herring <robh@kernel.org>
> 

Thanks
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/mailbox/mailbox.txt b/Documentation/devicetree/bindings/mailbox/mailbox.txt
index be05b9746c69..af8ecee2ac68 100644
--- a/Documentation/devicetree/bindings/mailbox/mailbox.txt
+++ b/Documentation/devicetree/bindings/mailbox/mailbox.txt
@@ -23,6 +23,11 @@  assign appropriate mailbox channel to client drivers.
 
 Optional property:
 - mbox-names: List of identifier strings for each mailbox channel.
+- shmem : List of phandle pointing to the shared memory(SHM) area between the
+	  users of these mailboxes for IPC, one for each mailbox. This shared
+	  memory can be part of any memory reserved for the purpose of this
+	  communication between the mailbox client and the remote.
+
 
 Example:
 	pwr_cntrl: power {
@@ -30,3 +35,26 @@  assign appropriate mailbox channel to client drivers.
 		mbox-names = "pwr-ctrl", "rpc";
 		mboxes = <&mailbox 0 &mailbox 1>;
 	};
+
+Example with shared memory(shmem):
+
+	sram: sram@50000000 {
+		compatible = "mmio-sram";
+		reg = <0x50000000 0x10000>;
+
+		#address-cells = <1>;
+		#size-cells = <1>;
+		ranges = <0 0x50000000 0x10000>;
+
+		cl_shmem: shmem@0 {
+			compatible = "client-shmem";
+			reg = <0x0 0x200>;
+		};
+	};
+
+	client@2e000000 {
+		...
+		mboxes = <&mailbox 0>;
+		shmem = <&cl_shmem>;
+		..
+	};