serial: max310x: Document clock setup
authorJan Kundrát <jan.kundrat@cesnet.cz>
Fri, 8 Dec 2017 23:54:33 +0000 (00:54 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Tue, 19 Dec 2017 08:59:02 +0000 (09:59 +0100)
As a kernel newcomer, I got bitten by lack of examples on this front. I
had troubles figuring out where these clocks could be defined ("/clocks"
is where the generic infrastructure expects them).

One should also ensure that a unique name is used. Generic names such as
"osc" tend to be already used by some board-wide clock crystals.

Signed-off-by: Jan Kundrát <jan.kundrat@cesnet.cz>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/devicetree/bindings/serial/maxim,max310x.txt

index 0c58052a18bba00ef33aa0c4bcfc2b09e1448b01..823f77dd79786b0eec26bc71480dbca460d1ed38 100644 (file)
@@ -24,13 +24,27 @@ Optional properties:
     1 = active low.
 
 Example:
+
+/ {
+       clocks {
+               spi_uart_clk: osc_max14830 {
+                       compatible = "fixed-clock";
+                       #clock-cells = <0>;
+                       clock-frequency = <3686400>;
+               };
+
+       };
+};
+
+&spi0 {
        max14830: max14830@0 {
                compatible = "maxim,max14830";
                reg = <0>;
-               clocks = <&clk20m>;
+               clocks = <&spi_uart_clk>;
                clock-names = "osc";
                interrupt-parent = <&gpio3>;
                interrupts = <7 IRQ_TYPE_LEVEL_LOW>;
                gpio-controller;
                #gpio-cells = <2>;
        };
+};