Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

clk: at91: add slow clk documentation

Add slow clk, and slow oscillators documentation.

Signed-off-by: Boris BREZILLON <boris.brezillon@free-electrons.com>
Acked-by: Mike Turquette <mturquette@linaro.org>
Signed-off-by: Nicolas Ferre <nicolas.ferre@atmel.com>

authored by

Boris BREZILLON and committed by
Nicolas Ferre
4d735e54 80eded6c

+72
+72
Documentation/devicetree/bindings/clock/at91-clock.txt
··· 6 6 7 7 Required properties: 8 8 - compatible : shall be one of the following: 9 + "atmel,at91sam9x5-sckc": 10 + at91 SCKC (Slow Clock Controller) 11 + This node contains the slow clock definitions. 12 + 13 + "atmel,at91sam9x5-clk-slow-osc": 14 + at91 slow oscillator 15 + 16 + "atmel,at91sam9x5-clk-slow-rc-osc": 17 + at91 internal slow RC oscillator 18 + 9 19 "atmel,at91rm9200-pmc" or 10 20 "atmel,at91sam9g45-pmc" or 11 21 "atmel,at91sam9n12-pmc" or ··· 24 14 at91 PMC (Power Management Controller) 25 15 All at91 specific clocks (clocks defined below) must be child 26 16 node of the PMC node. 17 + 18 + "atmel,at91sam9x5-clk-slow" (under sckc node) 19 + or 20 + "atmel,at91sam9260-clk-slow" (under pmc node): 21 + at91 slow clk 27 22 28 23 "atmel,at91rm9200-clk-main-osc" 29 24 "atmel,at91sam9x5-clk-main-rc-osc" ··· 73 58 74 59 "atmel,at91sam9x5-clk-utmi": 75 60 at91 utmi clock 61 + 62 + Required properties for SCKC node: 63 + - reg : defines the IO memory reserved for the SCKC. 64 + - #size-cells : shall be 0 (reg is used to encode clk id). 65 + - #address-cells : shall be 1 (reg is used to encode clk id). 66 + 67 + 68 + For example: 69 + sckc: sckc@fffffe50 { 70 + compatible = "atmel,sama5d3-pmc"; 71 + reg = <0xfffffe50 0x4> 72 + #size-cells = <0>; 73 + #address-cells = <1>; 74 + 75 + /* put at91 slow clocks here */ 76 + }; 77 + 78 + 79 + Required properties for internal slow RC oscillator: 80 + - #clock-cells : from common clock binding; shall be set to 0. 81 + - clock-frequency : define the internal RC oscillator frequency. 82 + 83 + Optional properties: 84 + - clock-accuracy : define the internal RC oscillator accuracy. 85 + 86 + For example: 87 + slow_rc_osc: slow_rc_osc { 88 + compatible = "atmel,at91sam9x5-clk-slow-rc-osc"; 89 + clock-frequency = <32768>; 90 + clock-accuracy = <50000000>; 91 + }; 92 + 93 + Required properties for slow oscillator: 94 + - #clock-cells : from common clock binding; shall be set to 0. 95 + - clocks : shall encode the main osc source clk sources (see atmel datasheet). 96 + 97 + Optional properties: 98 + - atmel,osc-bypass : boolean property. Set this when a clock signal is directly 99 + provided on XIN. 100 + 101 + For example: 102 + slow_osc: slow_osc { 103 + compatible = "atmel,at91rm9200-clk-slow-osc"; 104 + #clock-cells = <0>; 105 + clocks = <&slow_xtal>; 106 + }; 107 + 108 + Required properties for slow clock: 109 + - #clock-cells : from common clock binding; shall be set to 0. 110 + - clocks : shall encode the slow clk sources (see atmel datasheet). 111 + 112 + For example: 113 + clk32k: slck { 114 + compatible = "atmel,at91sam9x5-clk-slow"; 115 + #clock-cells = <0>; 116 + clocks = <&slow_rc_osc &slow_osc>; 117 + }; 76 118 77 119 Required properties for PMC node: 78 120 - reg : defines the IO memory reserved for the PMC.