Merge branch 'overlayfs-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mszer...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / clock / amlogic,gxbb-clkc.txt
1 * Amlogic GXBB Clock and Reset Unit
2
3 The Amlogic GXBB clock controller generates and supplies clock to various
4 controllers within the SoC.
5
6 Required Properties:
7
8 - compatible: should be:
9                 "amlogic,gxbb-clkc" for GXBB SoC,
10                 "amlogic,gxl-clkc" for GXL and GXM SoC,
11                 "amlogic,axg-clkc" for AXG SoC.
12
13 - reg: physical base address of the clock controller and length of memory
14        mapped region.
15
16 - #clock-cells: should be 1.
17
18 Each clock is assigned an identifier and client nodes can use this identifier
19 to specify the clock which they consume. All available clocks are defined as
20 preprocessor macros in the dt-bindings/clock/gxbb-clkc.h header and can be
21 used in device tree sources.
22
23 Example: Clock controller node:
24
25         clkc: clock-controller@c883c000 {
26                 #clock-cells = <1>;
27                 compatible = "amlogic,gxbb-clkc";
28                 reg = <0x0 0xc883c000 0x0 0x3db>;
29         };
30
31 Example: UART controller node that consumes the clock generated by the clock
32   controller:
33
34         uart_AO: serial@c81004c0 {
35                 compatible = "amlogic,meson-uart";
36                 reg = <0xc81004c0 0x14>;
37                 interrupts = <0 90 1>;
38                 clocks = <&clkc CLKID_CLK81>;
39         };