[v9,2/6] dt-bindings: mvebu-uart: document DT bindings for marvell, armada-3700-uart-clock

Commit Message

Marek Behún Feb. 19, 2022, 3:28 p.m. UTC

From: Pali Rohár <[e-mail]>

Add DT bindings documentation for device nodes with compatible string
"marvell,armada-3700-uart-clock".

Signed-off-by: Pali Rohár <[e-mail]>
Reviewed-by: Rob Herring <[e-mail]>
Reviewed-by: Marek Behún <[e-mail]>
Signed-off-by: Marek Behún <[e-mail]>
---
 .../clock/marvell,armada-3700-uart-clock.yaml | 59 +++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/clock/marvell,armada-3700-uart-clock.yaml

Comments

Stephen Boyd Feb. 24, 2022, 11:01 p.m. UTC | #1

Quoting Marek Behún (2022-02-19 07:28:14)
> From: Pali Rohár <[e-mail]>
> 
> Add DT bindings documentation for device nodes with compatible string
> "marvell,armada-3700-uart-clock".
> 
> Signed-off-by: Pali Rohár <[e-mail]>
> Reviewed-by: Rob Herring <[e-mail]>
> Reviewed-by: Marek Behún <[e-mail]>
> Signed-off-by: Marek Behún <[e-mail]>
> ---

Reviewed-by: Stephen Boyd <[e-mail]>

Patch

diff --git a/Documentation/devicetree/bindings/clock/marvell,armada-3700-uart-clock.yaml b/Documentation/devicetree/bindings/clock/marvell,armada-3700-uart-clock.yaml
new file mode 100644
index 000000000000..175f5c8f2bc5
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/marvell,armada-3700-uart-clock.yaml
@@ -0,0 +1,59 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/clock/marvell,armada-3700-uart-clock.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+title: Marvell Armada 3720 UART clocks
+
+maintainers:
+  - Pali Rohár <[e-mail]>
+
+properties:
+  compatible:
+    const: marvell,armada-3700-uart-clock
+
+  reg:
+    items:
+      - description: UART Clock Control Register
+      - description: UART 2 Baud Rate Divisor Register
+
+  clocks:
+    description: |
+      List of parent clocks suitable for UART from following set:
+        "TBG-A-P", "TBG-B-P", "TBG-A-S", "TBG-B-S", "xtal"
+      UART clock can use one from this set and when more are provided
+      then kernel would choose and configure the most suitable one.
+      It is suggest to specify at least one TBG clock to achieve
+      baudrates above 230400 and also to specify clock which bootloader
+      used for UART (most probably xtal) for smooth boot log on UART.
+
+  clock-names:
+    items:
+      - const: TBG-A-P
+      - const: TBG-B-P
+      - const: TBG-A-S
+      - const: TBG-B-S
+      - const: xtal
+    minItems: 1
+
+  '#clock-cells':
+    const: 1
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-names
+  - '#clock-cells'
+
+additionalProperties: false
+
+examples:
+  - |
+    uartclk: clock-controller@12010 {
+      compatible = "marvell,armada-3700-uart-clock";
+      reg = <0x12010 0x4>, <0x12210 0x4>;
+      clocks = <&tbg 0>, <&tbg 1>, <&tbg 2>, <&tbg 3>, <&xtalclk>;
+      clock-names = "TBG-A-P", "TBG-B-P", "TBG-A-S", "TBG-B-S", "xtal";
+      #clock-cells = <1>;
+    };