Skip to contentSkip to conversation

dt-bindings: soc: ti: wkup_m3_ipc: convert bindings to json-schema

PATCH Superseded Drew Fustini 2 participants 3 messages Apr 7, 2022 Device tree bindings

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 dt-bindings: soc: ti: wkup_m3_ipc: convert bindings to json-schema

Convert the wkup_m3_ipc bindings documentation to json-schema.

---
 .../bindings/soc/ti/wkup_m3_ipc.txt           | 57 -------------
 .../bindings/soc/ti/wkup_m3_ipc.yaml          | 81 +++++++++++++++++++
 2 files changed, 81 insertions(+), 57 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/soc/ti/wkup_m3_ipc.txt
 create mode 100644 Documentation/devicetree/bindings/soc/ti/wkup_m3_ipc.yaml

Changes in v2:
- removed unnecessary line breaks and shorten property descriptions

Documentation/devicetree/bindings/soc/ti/wkup_m3_ipc.txt deleted +0 -57
deleted file mode 100644
index 401550487ed6..000000000000
@@ -1,57 +0,0 @@
-Wakeup M3 IPC Driver
-=====================
-
-The TI AM33xx and AM43xx family of devices use a small Cortex M3 co-processor
-(commonly referred to as Wakeup M3 or CM3) to help with various low power tasks
-that cannot be controlled from the MPU, like suspend/resume and certain deep
-C-states for CPU Idle. Once the wkup_m3_ipc driver uses the wkup_m3_rproc driver
-to boot the wkup_m3, it handles communication with the CM3 using IPC registers
-present in the SoC's control module and a mailbox. The wkup_m3_ipc exposes an
-API to allow the SoC PM code to execute specific PM tasks.
-
-Wkup M3 Device Node:
-====================
-A wkup_m3_ipc device node is used to represent the IPC registers within an
-SoC.
-
-Required properties:
---------------------
-- compatible:		Should be,
-				"ti,am3352-wkup-m3-ipc" for AM33xx SoCs
-				"ti,am4372-wkup-m3-ipc" for AM43xx SoCs
-- reg:			Contains the IPC register address space to communicate
-			with the Wakeup M3 processor
-- interrupts:		Contains the interrupt information for the wkup_m3
-			interrupt that signals the MPU.
-- ti,rproc:		phandle to the wkup_m3 rproc node so the IPC driver
-			can boot it.
-- mboxes:		phandles used by IPC framework to get correct mbox
-			channel for communication. Must point to appropriate
-			mbox_wkupm3 child node.
-
-Example:
---------
-/* AM33xx */
-	l4_wkup: l4_wkup@44c00000 {
-		...
-
-		scm: scm@210000 {
-			compatible = "ti,am3-scm", "simple-bus";
-			reg = <0x210000 0x2000>;
-			#address-cells = <1>;
-			#size-cells = <1>;
-			ranges = <0 0x210000 0x2000>;
-
-			...
-
-			wkup_m3_ipc: wkup_m3_ipc@1324 {
-				compatible = "ti,am3352-wkup-m3-ipc";
-				reg = <0x1324 0x24>;
-				interrupts = <78>;
-				ti,rproc = <&wkup_m3>;
-				mboxes = <&mailbox &mbox_wkupm3>;
-			};
-
-			...
-		};
-	};
Documentation/devicetree/bindings/soc/ti/wkup_m3_ipc.yaml new file +81 -0

81 lines not on this page · raw message

Signature · 1 line
2.32.0
Reviewed-by on v2 1/1
#1 lore raw
Quoted 8 lines · Drew Fustini

Convert the wkup_m3_ipc bindings documentation to json-schema.

---
 .../bindings/soc/ti/wkup_m3_ipc.txt           | 57 -------------
 .../bindings/soc/ti/wkup_m3_ipc.yaml          | 81 +++++++++++++++++++

Changes look good, thanks for fixing, although I forgot about one thing
- all other files are using 'hyphens' in file name, so please keep it consistent with them.

Best regards,
Krzysztof

#2 lore raw
Quoted 10 lines · Krzysztof Kozlowski
Quoted 8 lines · Drew Fustini

Convert the wkup_m3_ipc bindings documentation to json-schema.

---
 .../bindings/soc/ti/wkup_m3_ipc.txt           | 57 -------------
 .../bindings/soc/ti/wkup_m3_ipc.yaml          | 81 +++++++++++++++++++
Quoted 5 lines

Changes look good, thanks for fixing, although I forgot about one thing
- all other files are using 'hyphens' in file name, so please keep it consistent with them.

Thank you for your fast responses. I've submitted v3.

-Drew