Merge branch 'drm-next' of git://people.freedesktop.org/~airlied/linux
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / rtc / maxim,ds3231.txt
1 * Maxim DS3231 Real Time Clock
2
3 Required properties:
4 see: Documentation/devicetree/bindings/i2c/trivial-devices.txt
5
6 Optional property:
7 - #clock-cells: Should be 1.
8 - clock-output-names:
9   overwrite the default clock names "ds3231_clk_sqw" and "ds3231_clk_32khz".
10
11 Each clock is assigned an identifier and client nodes can use this identifier
12 to specify the clock which they consume. Following indices are allowed:
13     - 0: square-wave output on the SQW pin
14     - 1: square-wave output on the 32kHz pin
15
16 - interrupts: rtc alarm/event interrupt. When this property is selected,
17   clock on the SQW pin cannot be used.
18
19 Example:
20
21 ds3231: ds3231@51 {
22         compatible = "maxim,ds3231";
23         reg = <0x68>;
24         #clock-cells = <1>;
25 };
26
27 device1 {
28 ...
29         clocks = <&ds3231 0>;
30 ...
31 };
32
33 device2 {
34 ...
35         clocks = <&ds3231 1>;
36 ...
37 };