Merge branch 'irq-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / clock / amlogic,meson8b-clkc.txt
1 * Amlogic Meson8, Meson8b and Meson8m2 Clock and Reset Unit
2
3 The Amlogic Meson8 / Meson8b / Meson8m2 clock controller generates and
4 supplies clock to various controllers within the SoC.
5
6 Required Properties:
7
8 - compatible: must be one of:
9         - "amlogic,meson8-clkc" for Meson8 (S802) SoCs
10         - "amlogic,meson8b-clkc" for Meson8 (S805) SoCs
11         - "amlogic,meson8m2-clkc" for Meson8m2 (S812) SoCs
12 - reg: it must be composed by two tuples:
13         0) physical base address of the xtal register and length of memory
14            mapped region.
15         1) physical base address of the clock controller and length of memory
16            mapped region.
17
18 - #clock-cells: should be 1.
19 - #reset-cells: should be 1.
20
21 Each clock is assigned an identifier and client nodes can use this identifier
22 to specify the clock which they consume. All available clocks are defined as
23 preprocessor macros in the dt-bindings/clock/meson8b-clkc.h header and can be
24 used in device tree sources.
25
26 Similarly a preprocessor macro for each reset line is defined in
27 dt-bindings/reset/amlogic,meson8b-clkc-reset.h (which can be used from the
28 device tree sources).
29
30
31 Example: Clock controller node:
32
33         clkc: clock-controller@c1104000 {
34                 compatible = "amlogic,meson8b-clkc";
35                 reg = <0xc1108000 0x4>, <0xc1104000 0x460>;
36                 #clock-cells = <1>;
37                 #reset-cells = <1>;
38         };
39
40
41 Example: UART controller node that consumes the clock generated by the clock
42   controller:
43
44         uart_AO: serial@c81004c0 {
45                 compatible = "amlogic,meson-uart";
46                 reg = <0xc81004c0 0x14>;
47                 interrupts = <0 90 1>;
48                 clocks = <&clkc CLKID_CLK81>;
49         };