Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/jikos/hid
[cascardo/linux.git] / Documentation / devicetree / bindings / clock / mvebu-core-clock.txt
1 * Core Clock bindings for Marvell MVEBU SoCs
2
3 Marvell MVEBU SoCs usually allow to determine core clock frequencies by
4 reading the Sample-At-Reset (SAR) register. The core clock consumer should
5 specify the desired clock by having the clock ID in its "clocks" phandle cell.
6
7 The following is a list of provided IDs and clock names on Armada 370/XP:
8  0 = tclk    (Internal Bus clock)
9  1 = cpuclk  (CPU clock)
10  2 = nbclk   (L2 Cache clock)
11  3 = hclk    (DRAM control clock)
12  4 = dramclk (DDR clock)
13
14 The following is a list of provided IDs and clock names on Armada 375:
15  0 = tclk    (Internal Bus clock)
16  1 = cpuclk  (CPU clock)
17  2 = l2clk   (L2 Cache clock)
18  3 = ddrclk  (DDR clock)
19
20 The following is a list of provided IDs and clock names on Armada 380/385:
21  0 = tclk    (Internal Bus clock)
22  1 = cpuclk  (CPU clock)
23  2 = l2clk   (L2 Cache clock)
24  3 = ddrclk  (DDR clock)
25
26 The following is a list of provided IDs and clock names on Armada 39x:
27  0 = tclk    (Internal Bus clock)
28  1 = cpuclk  (CPU clock)
29  2 = nbclk   (Coherent Fabric clock)
30  3 = hclk    (SDRAM Controller Internal Clock)
31  4 = dclk    (SDRAM Interface Clock)
32  5 = refclk  (Reference Clock)
33
34 The following is a list of provided IDs and clock names on Kirkwood and Dove:
35  0 = tclk   (Internal Bus clock)
36  1 = cpuclk (CPU0 clock)
37  2 = l2clk  (L2 Cache clock derived from CPU0 clock)
38  3 = ddrclk (DDR controller clock derived from CPU0 clock)
39
40 The following is a list of provided IDs and clock names on Orion5x:
41  0 = tclk   (Internal Bus clock)
42  1 = cpuclk (CPU0 clock)
43  2 = ddrclk (DDR controller clock derived from CPU0 clock)
44
45 Required properties:
46 - compatible : shall be one of the following:
47         "marvell,armada-370-core-clock" - For Armada 370 SoC core clocks
48         "marvell,armada-375-core-clock" - For Armada 375 SoC core clocks
49         "marvell,armada-380-core-clock" - For Armada 380/385 SoC core clocks
50         "marvell,armada-390-core-clock" - For Armada 39x SoC core clocks
51         "marvell,armada-xp-core-clock" - For Armada XP SoC core clocks
52         "marvell,dove-core-clock" - for Dove SoC core clocks
53         "marvell,kirkwood-core-clock" - for Kirkwood SoC (except mv88f6180)
54         "marvell,mv88f6180-core-clock" - for Kirkwood MV88f6180 SoC
55         "marvell,mv88f5181-core-clock" - for Orion MV88F5181 SoC
56         "marvell,mv88f5182-core-clock" - for Orion MV88F5182 SoC
57         "marvell,mv88f5281-core-clock" - for Orion MV88F5281 SoC
58         "marvell,mv88f6183-core-clock" - for Orion MV88F6183 SoC
59 - reg : shall be the register address of the Sample-At-Reset (SAR) register
60 - #clock-cells : from common clock binding; shall be set to 1
61
62 Optional properties:
63 - clock-output-names : from common clock binding; allows overwrite default clock
64         output names ("tclk", "cpuclk", "l2clk", "ddrclk")
65
66 Example:
67
68 core_clk: core-clocks@d0214 {
69         compatible = "marvell,dove-core-clock";
70         reg = <0xd0214 0x4>;
71         #clock-cells = <1>;
72 };
73
74 spi0: spi@10600 {
75         compatible = "marvell,orion-spi";
76         /* ... */
77         /* get tclk from core clock provider */
78         clocks = <&core_clk 0>;
79 };