[PATCH 4/4] ARM: meson: add documentation for reset/clock controller

[Carlo Caione]

Add documentation for the reset and clock controller

Signed-off-by: Carlo Caione <carlo at caione.org>
---
 .../bindings/clock/amlogic,meson6-clkc.txt         | 45 ++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/clock/amlogic,meson6-clkc.txt

diff --git a/Documentation/devicetree/bindings/clock/amlogic,meson6-clkc.txt b/Documentation/devicetree/bindings/clock/amlogic,meson6-clkc.txt
new file mode 100644
index 0000000..b4a8813
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/amlogic,meson6-clkc.txt
@@ -0,0 +1,45 @@
+* Amlogic Meson6 Clock and Reset Unit
+
+The Amlogic Meson6 clock controller generates and supplies clock to various
+controllers within the SoC and also implements a reset controller for SoC
+peripherals.
+
+Required Properties:
+
+- compatible: should be "amlogic,meson6-clkc"
+- reg: it must be composed by three tuples:
+	0) physical base address of the xtal register and length of memory
+	   mapped region.
+	1) physical base address of the clock controller and length of memory
+	   mapped region.
+	2) physical base address of the AO domain reset register and length
+	   of memory mapped region.
+
+- #clock-cells: should be 1.
+- #reset-cells: should be 1.
+
+Each clock is assigned an identifier and client nodes can use this identifier
+to specify the clock which they consume. All available clocks are defined as
+preprocessor macros in the dt-bindings/clock/meson6-clkc.h header and can be
+used in device tree sources.
+
+Example: Clock controller node:
+
+	clkc: clock-controller at c1104000 {
+		#clock-cells = <1>;
+		#reset-cells = <1>;
+		compatible = "amlogic,meson6-clkc";
+		reg = <0xc1108000 0x4>, <0xc1104000 0x460>, <0xc8100040 0x4>;
+	};
+
+
+Example: UART controller node that consumes the clock generated by the clock
+  controller:
+
+	uart_AO: serial at c81004c0 {
+		compatible = "amlogic,meson-uart";
+		reg = <0xc81004c0 0x14>;
+		interrupts = <0 90 1>;
+		clocks = <&clkc CLKID_CLK81>;
+		status = "disabled";
+	};
-- 
1.9.1