faa6d8ac583412557118a53c3bebb22ea0ab159a
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / clock / amlogic,gxbb-aoclkc.txt
1 * Amlogic GXBB AO Clock and Reset Unit
2
3 The Amlogic GXBB AO clock controller generates and supplies clock to various
4 controllers within the Always-On part of the SoC.
5
6 Required Properties:
7
8 - compatible: should be "amlogic,gxbb-aoclkc"
9 - reg: physical base address of the clock controller and length of memory
10        mapped region.
11
12 - #clock-cells: should be 1.
13
14 Each clock is assigned an identifier and client nodes can use this identifier
15 to specify the clock which they consume. All available clocks are defined as
16 preprocessor macros in the dt-bindings/clock/gxbb-aoclkc.h header and can be
17 used in device tree sources.
18
19 - #reset-cells: should be 1.
20
21 Each reset is assigned an identifier and client nodes can use this identifier
22 to specify the reset which they consume. All available resets are defined as
23 preprocessor macros in the dt-bindings/reset/gxbb-aoclkc.h header and can be
24 used in device tree sources.
25
26 Example: AO Clock controller node:
27
28         clkc_AO: clock-controller@040 {
29                 compatible = "amlogic,gxbb-aoclkc";
30                 reg = <0x0 0x040 0x0 0x4>;
31                 #clock-cells = <1>;
32                 #reset-cells = <1>;
33         };
34
35 Example: UART controller node that consumes the clock and reset generated
36   by the clock controller:
37
38         uart_AO: serial@4c0 {
39                 compatible = "amlogic,meson-uart";
40                 reg = <0x4c0 0x14>;
41                 interrupts = <0 90 1>;
42                 clocks = <&clkc_AO CLKID_AO_UART1>;
43                 resets = <&clkc_AO RESET_AO_UART1>;
44         };