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