Merge tag 'for-linus-5.0-rc6-tag' of git://git.kernel.org/pub/scm/linux/kernel/git...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / rtc / sun6i-rtc.txt
1 * sun6i Real Time Clock
2
3 RTC controller for the Allwinner A31
4
5 Required properties:
6 - compatible    : Should be one of the following combinations:
7                     - "allwinner,sun6i-a31-rtc"
8                     - "allwinner,sun8i-a23-rtc"
9                     - "allwinner,sun8i-h3-rtc"
10                     - "allwinner,sun8i-r40-rtc", "allwinner,sun8i-h3-rtc"
11                     - "allwinner,sun8i-v3-rtc"
12                     - "allwinner,sun50i-a64-rtc", "allwinner,sun8i-h3-rtc"
13                     - "allwinner,sun50i-h5-rtc"
14
15                   Where there are two or more compatible strings, this
16                   denotes the hardware covered by the most specific one
17                   is backward-compatible with the latter ones, and the
18                   implementation for the latter ones can be used, albeit
19                   with reduced functionality.
20
21 - reg           : physical base address of the controller and length of
22                   memory mapped region.
23 - interrupts    : IRQ lines for the RTC alarm 0 and alarm 1, in that order.
24
25 Required properties for new device trees
26 - clocks        : phandle to the 32kHz external oscillator
27 - clock-output-names : names of up to three clock outputs. See below.
28 - #clock-cells  : must be equal to 1.
29
30 The RTC provides the following clocks at the given indices:
31 - 0: LOSC
32 - 1: LOSC external output, known as X32KFOUT in the datasheet.
33      This clock is not available on the A31 and is deprecated for old
34      device trees still using the "allwinner,sun6i-a31-rtc" compatible.
35 - 2: InternalOSC, or internal RC oscillator (A64/H3/H5 only)
36
37 Example:
38
39 rtc: rtc@1f00000 {
40         compatible = "allwinner,sun6i-a31-rtc";
41         reg = <0x01f00000 0x400>;
42         interrupts = <0 40 4>, <0 41 4>;
43         clock-output-names = "osc32k";
44         clocks = <&ext_osc32k>;
45         #clock-cells = <1>;
46 };