Convert the ti,secure-proxy to yaml for better checks and documentation.
Differences being mostly in the examples:
- I've dropped the example usage of mailbox client, it is better done in
tisci node definition
- included header in example for buildable example
NOTE: The following checkpatch warning is generated since we do include
the header
in the example, but this is a false positive warning.
WARNING: DT binding docs and includes should be a separate patch. See:
Documentation/devicetree/bindings/submitting-patches.rst
Signed-off-by: Nishanth Menon
---
Depending on how [1] turns out in discussion, we might want to queue [2]
appropriately.
[1]
https://lore.kernel.org/linux-arm-kernel/cak8p3a1l8rwpr5b66v6su8-m7-sca0wzqr_g_4knv4dnrky...@mail.gmail.com/
[2] https://lore.kernel.org/linux-arm-kernel/20210414001926.20002-1...@ti.com/
.../bindings/mailbox/ti,message-manager.txt | 50 -
.../bindings/mailbox/ti,message-manager.yaml | 75 +++
2 files changed, 75 insertions(+), 50 deletions(-)
delete mode 100644
Documentation/devicetree/bindings/mailbox/ti,message-manager.txt
create mode 100644
Documentation/devicetree/bindings/mailbox/ti,message-manager.yaml
diff --git a/Documentation/devicetree/bindings/mailbox/ti,message-manager.txt
b/Documentation/devicetree/bindings/mailbox/ti,message-manager.txt
deleted file mode 100644
index ebf0e3710cee..
--- a/Documentation/devicetree/bindings/mailbox/ti,message-manager.txt
+++ /dev/null
@@ -1,50 +0,0 @@
-Texas Instruments' Message Manager Driver
-
-
-The Texas Instruments' Message Manager is a mailbox controller that has
-configurable queues selectable at SoC(System on Chip) integration. The Message
-manager is broken up into queues in different address regions that are called
-"proxies" - each instance is unidirectional and is instantiated at SoC
-integration level to indicate receive or transmit path.
-
-Message Manager Device Node:
-===
-Required properties:
-
-- compatible: Shall be: "ti,k2g-message-manager"
-- reg-namesqueue_proxy_region - Map the queue proxy region.
- queue_state_debug_region - Map the queue state debug
- region.
-- reg: Contains the register map per reg-names.
-- #mbox-cells Shall be 2. Contains the queue ID and proxy ID in that
- order referring to the transfer path.
-- interrupt-names: Contains interrupt names matching the rx transfer path
- for a given SoC. Receive interrupts shall be of the
- format: "rx_".
- For ti,k2g-message-manager, this shall contain:
- "rx_005", "rx_057"
-- interrupts: Contains the interrupt information corresponding to
- interrupt-names property.
-
-Example(K2G):
-
-
- msgmgr: msgmgr@2a0 {
- compatible = "ti,k2g-message-manager";
- #mbox-cells = <2>;
- reg-names = "queue_proxy_region", "queue_state_debug_region";
- reg = <0x02a0 0x40>, <0x028c3400 0x400>;
- interrupt-names = "rx_005", "rx_057";
- interrupts = ,
-;
- };
-
- pmmc: pmmc {
- [...]
- mbox-names = "rx", "tx";
- # RX queue ID is 5, proxy ID is 2
- # TX queue ID is 0, proxy ID is 0
- mboxes= < 5 2>,
- < 0 0>;
- [...]
- };
diff --git a/Documentation/devicetree/bindings/mailbox/ti,message-manager.yaml
b/Documentation/devicetree/bindings/mailbox/ti,message-manager.yaml
new file mode 100644
index ..4987e803ac37
--- /dev/null
+++ b/Documentation/devicetree/bindings/mailbox/ti,message-manager.yaml
@@ -0,0 +1,75 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mailbox/ti,message-manager.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments' Message Manager Driver
+
+maintainers:
+ - Nishanth Menon
+
+description: |
+ The Texas Instruments' Message Manager is a mailbox controller that has
+ configurable queues selectable at SoC(System on Chip) integration. The
Message
+ manager is broken up into queues in different address regions that are called
+ "proxies" - each instance is unidirectional and is instantiated at SoC
+ integration level to indicate receive or transmit path.
+
+properties:
+ $nodename:
+pattern: "^mailbox@[0-9a-f]+$"
+
+ compatible:
+const: ti,k2g-message-manager
+
+ "#mbox-cells":
+const: 2
+description:
+ Contains the queue ID and proxy ID in that order referring to the
+ transfer path.
+
+ reg-names:
+items:
+ - const: queue_proxy_region
+ -
