xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/rtc/maxim,ds3231.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun* Maxim DS3231 Real Time Clock
2*4882a593Smuzhiyun
3*4882a593SmuzhiyunRequired properties:
4*4882a593Smuzhiyun- compatible: Should contain "maxim,ds3231".
5*4882a593Smuzhiyun- reg: I2C address for chip.
6*4882a593Smuzhiyun
7*4882a593SmuzhiyunOptional property:
8*4882a593Smuzhiyun- #clock-cells: Should be 1.
9*4882a593Smuzhiyun- clock-output-names:
10*4882a593Smuzhiyun  overwrite the default clock names "ds3231_clk_sqw" and "ds3231_clk_32khz".
11*4882a593Smuzhiyun
12*4882a593SmuzhiyunEach clock is assigned an identifier and client nodes can use this identifier
13*4882a593Smuzhiyunto specify the clock which they consume. Following indices are allowed:
14*4882a593Smuzhiyun    - 0: square-wave output on the SQW pin
15*4882a593Smuzhiyun    - 1: square-wave output on the 32kHz pin
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun- interrupts: rtc alarm/event interrupt. When this property is selected,
18*4882a593Smuzhiyun  clock on the SQW pin cannot be used.
19*4882a593Smuzhiyun
20*4882a593SmuzhiyunExample:
21*4882a593Smuzhiyun
22*4882a593Smuzhiyunds3231: ds3231@51 {
23*4882a593Smuzhiyun	compatible = "maxim,ds3231";
24*4882a593Smuzhiyun	reg = <0x68>;
25*4882a593Smuzhiyun	#clock-cells = <1>;
26*4882a593Smuzhiyun};
27*4882a593Smuzhiyun
28*4882a593Smuzhiyundevice1 {
29*4882a593Smuzhiyun...
30*4882a593Smuzhiyun	clocks = <&ds3231 0>;
31*4882a593Smuzhiyun...
32*4882a593Smuzhiyun};
33*4882a593Smuzhiyun
34*4882a593Smuzhiyundevice2 {
35*4882a593Smuzhiyun...
36*4882a593Smuzhiyun	clocks = <&ds3231 1>;
37*4882a593Smuzhiyun...
38*4882a593Smuzhiyun};
39