[PATCH v2 1/2] dt-bindings: Document the hi3559a clock bindings

From: Dongjiu Geng
Date: Thu Nov 12 2020 - 08:58:44 EST


Add DT bindings documentation for hi3559a SoC clock.

Signed-off-by: Dongjiu Geng <gengdongjiu@xxxxxxxxxx>
---
.../bindings/clock/hi3559av100-clock.txt | 40 +++++++++++++++++++
1 file changed, 40 insertions(+)
create mode 100644 Documentation/devicetree/bindings/clock/hi3559av100-clock.txt

diff --git a/Documentation/devicetree/bindings/clock/hi3559av100-clock.txt b/Documentation/devicetree/bindings/clock/hi3559av100-clock.txt
new file mode 100644
index 000000000000..0fb4ccc72cfe
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/hi3559av100-clock.txt
@@ -0,0 +1,40 @@
+* Hisilicon Hi3559A Clock Controller
+
+The Hi3559A clock controller generates and supplies clock to various
+controllers within the Hi3559A SoC.
+
+Required Properties:
+
+- compatible: the compatible should be one of the following strings to
+ indicate the clock controller functionality.
+
+ - "hisilicon,hi3559av100-clock"
+
+- reg: physical base address of the controller and length of memory mapped
+ region.
+
+- #clock-cells: should be 1.
+
+Each clock is assigned an identifier and client nodes use this identifier
+to specify the clock which they consume.
+
+All these identifier could be found in <dt-bindings/clock/hi3559av100-clock.h>.
+
+Examples:
+
+ clock: clock0 {
+ compatible = "hisilicon,hi3559av100-clock", "syscon";
+ #clock-cells = <1>;
+ #reset-cells = <2>;
+ #address-cells = <1>;
+ #size-cells = <1>;
+ reg = <0x0 0x12010000 0x0 0x10000>;
+ };
+
+ uart0: uart@12100000 {
+ compatible = "arm,pl011", "arm,primecell";
+ reg = <0x12100000 0x1000>;
+ interrupts = <0 6 4>;
+ clocks = <&clock HI3559AV100_UART0_CLK>;
+ clock-names = "apb_pclk";
+ };
--
2.17.1