dt-bindings: timer: Document allwinner,erratum-unknown1 property
[linux-2.6-microblaze.git] / Documentation / devicetree / bindings / clock / ingenic,cgu.txt
1 Ingenic SoC CGU binding
2
3 The CGU in an Ingenic SoC provides all the clocks generated on-chip. It
4 typically includes a variety of PLLs, multiplexers, dividers & gates in order
5 to provide many different clock signals derived from only 2 external source
6 clocks.
7
8 Required properties:
9 - compatible : Should be one of:
10   * ingenic,jz4740-cgu
11   * ingenic,jz4725b-cgu
12   * ingenic,jz4770-cgu
13   * ingenic,jz4780-cgu
14   * ingenic,x1000-cgu
15 - reg : The address & length of the CGU registers.
16 - clocks : List of phandle & clock specifiers for clocks external to the CGU.
17   Two such external clocks should be specified - first the external crystal
18   "ext" and second the RTC clock source "rtc".
19 - clock-names : List of name strings for the external clocks.
20 - #clock-cells: Should be 1.
21   Clock consumers specify this argument to identify a clock. The valid values
22   may be found in <dt-bindings/clock/<soctype>-cgu.h>.
23
24 Example SoC include file:
25
26 / {
27         cgu: jz4740-cgu {
28                 compatible = "ingenic,jz4740-cgu";
29                 reg = <0x10000000 0x100>;
30                 #clock-cells = <1>;
31         };
32
33         uart0: serial@10030000 {
34                 clocks = <&cgu JZ4740_CLK_UART0>;
35         };
36 };
37
38 Example board file:
39
40 / {
41         ext: clock@0 {
42                 compatible = "fixed-clock";
43                 #clock-cells = <0>;
44                 clock-frequency = <12000000>;
45         };
46
47         rtc: clock@1 {
48                 compatible = "fixed-clock";
49                 #clock-cells = <0>;
50                 clock-frequency = <32768>;
51         };
52
53         &cgu {
54                 clocks = <&ext> <&rtc>;
55                 clock-names: "ext", "rtc";
56         };
57 };