[PATCH v4 05/11] Documentation: dt: add ti,am3353_wkup_m3 bindings

Dave Gerlach
2014-07-11T02:57:36Z

Add the device tree bindings document for am3353 wkup_m3.

Signed-off-by: Dave Gerlach <d-gerlach@ti.com>
CC: Ohad Ben-Cohen <ohad@wizery.com>
CC: Benoit Cousson <bcousson@baylibre.com>
---
.../bindings/remoteproc/wkup_m3_rproc.txt | 46 ++++++++++++++++++++++
1 file changed, 46 insertions(+)
create mode 100644 Documentation/devicetree/bindings/remoteproc/wkup_m3_rproc.txt

diff --git a/Documentation/devicetree/bindings/remoteproc/wkup_m3_rproc.txt b/Documentation/devicetree/bindings/remoteproc/wkup_m3_rproc.txt
new file mode 100644
index 0000000..e9dd909
--- /dev/null
+++ b/Documentation/devicetree/bindings/remoteproc/wkup_m3_rproc.txt
@@ -0,0 +1,46 @@
+Wakeup M3 Remote Proc Driver
+=====================
+
+TI AMx3 Family devices use a Cortex M3 co-processor to help with various
+low power tasks that cannot be controlled from the MPU. The CM3 requires
+a firmware binary to accomplish this and communicates with the MPU through
+IPC registers present in the SoCs control module. The wkup_m3 remoteproc
+driver handles the loading of the firmware and exposes an API to
+communicate with the wkup_m3 through the use of the IPC registers and a
+mailbox.
+
+Wkup M3 Device Node:
+====================
+A wkup_m3 device node is used to represent a wakeup M3 IP instance within
+a SoC. The sub-mailboxes are represented as child node of this parent node.
+
+Required properties:
+--------------------
+- compatible: Should be "ti,am3353-wkup-m3" for AM33xx SoCs
+- reg: Contains the wkup_m3 register address ranges for
+ umem, dmem, and ipc-regs.
+- reg-names: Names for reg addresses given above
+- interrupts: Contains the interrupt information for the wkup_m3
+ interrupt that signals the MPU.
+- ti,hwmods: Name of the hwmod associated with the mailbox
+- ti,no-reset-on-init: Reset is handled after fw has been loaded, not at
+ init of hwmod.
+- mbox-names: Name of the mbox channel for the IPC framework
+- mbox: Phandle used by IPC framework to get correct mbox
+ channel for communication.
+
+Example:
+--------
+/* AM33xx */
+wkup_m3: wkup_m3@44d00000 {
+ compatible = "ti,am3353-wkup-m3";
+ reg = <0x44d00000 0x4000
+ 0x44d80000 0x2000
+ 0x44e11324 0x0024>;
+ reg-names = "m3_umem", "m3_dmem", "ipc_regs";
+ interrupts = <78>;
+ ti,hwmods = "wkup_m3";
+ ti,no-reset-on-init;
+ mbox-names = "wkup_m3";
+ mbox = <&mailbox &mbox_wkupm3>;
+};
--
1.9.0