xref: /freebsd/sys/contrib/device-tree/Bindings/rtc/maxim,ds3231.txt (revision c66ec88fed842fbaad62c30d510644ceb7bd2d71)
1*c66ec88fSEmmanuel Vadot* Maxim DS3231 Real Time Clock
2*c66ec88fSEmmanuel Vadot
3*c66ec88fSEmmanuel VadotRequired properties:
4*c66ec88fSEmmanuel Vadot- compatible: Should contain "maxim,ds3231".
5*c66ec88fSEmmanuel Vadot- reg: I2C address for chip.
6*c66ec88fSEmmanuel Vadot
7*c66ec88fSEmmanuel VadotOptional property:
8*c66ec88fSEmmanuel Vadot- #clock-cells: Should be 1.
9*c66ec88fSEmmanuel Vadot- clock-output-names:
10*c66ec88fSEmmanuel Vadot  overwrite the default clock names "ds3231_clk_sqw" and "ds3231_clk_32khz".
11*c66ec88fSEmmanuel Vadot
12*c66ec88fSEmmanuel VadotEach clock is assigned an identifier and client nodes can use this identifier
13*c66ec88fSEmmanuel Vadotto specify the clock which they consume. Following indices are allowed:
14*c66ec88fSEmmanuel Vadot    - 0: square-wave output on the SQW pin
15*c66ec88fSEmmanuel Vadot    - 1: square-wave output on the 32kHz pin
16*c66ec88fSEmmanuel Vadot
17*c66ec88fSEmmanuel Vadot- interrupts: rtc alarm/event interrupt. When this property is selected,
18*c66ec88fSEmmanuel Vadot  clock on the SQW pin cannot be used.
19*c66ec88fSEmmanuel Vadot
20*c66ec88fSEmmanuel VadotExample:
21*c66ec88fSEmmanuel Vadot
22*c66ec88fSEmmanuel Vadotds3231: ds3231@51 {
23*c66ec88fSEmmanuel Vadot	compatible = "maxim,ds3231";
24*c66ec88fSEmmanuel Vadot	reg = <0x68>;
25*c66ec88fSEmmanuel Vadot	#clock-cells = <1>;
26*c66ec88fSEmmanuel Vadot};
27*c66ec88fSEmmanuel Vadot
28*c66ec88fSEmmanuel Vadotdevice1 {
29*c66ec88fSEmmanuel Vadot...
30*c66ec88fSEmmanuel Vadot	clocks = <&ds3231 0>;
31*c66ec88fSEmmanuel Vadot...
32*c66ec88fSEmmanuel Vadot};
33*c66ec88fSEmmanuel Vadot
34*c66ec88fSEmmanuel Vadotdevice2 {
35*c66ec88fSEmmanuel Vadot...
36*c66ec88fSEmmanuel Vadot	clocks = <&ds3231 1>;
37*c66ec88fSEmmanuel Vadot...
38*c66ec88fSEmmanuel Vadot};
39