summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/rtc/maxim,ds3231.txt
diff options
context:
space:
mode:
authorAkinobu Mita <akinobu.mita@gmail.com>2016-01-31 17:10:10 +0300
committerAlexandre Belloni <alexandre.belloni@free-electrons.com>2016-03-14 19:08:13 +0300
commit6c6ff145b3346b071e7d80f9bd33aa7de0e438bc (patch)
treebdd4e8997f5b9c64ec1d00d219e0d18cd27999d8 /Documentation/devicetree/bindings/rtc/maxim,ds3231.txt
parentf3937549a975fadec9b517b059616f08f9cb7653 (diff)
downloadlinux-6c6ff145b3346b071e7d80f9bd33aa7de0e438bc.tar.xz
rtc: ds1307: add clock provider support for DS3231
DS3231 has programmable square-wave output signal. This enables to use this feature as a clock provider of common clock framework. Signed-off-by: Akinobu Mita <akinobu.mita@gmail.com> Reviewed-by: Michael Turquette <mturquette@baylibre.com> Signed-off-by: Alexandre Belloni <alexandre.belloni@free-electrons.com>
Diffstat (limited to 'Documentation/devicetree/bindings/rtc/maxim,ds3231.txt')
-rw-r--r--Documentation/devicetree/bindings/rtc/maxim,ds3231.txt37
1 files changed, 37 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/rtc/maxim,ds3231.txt b/Documentation/devicetree/bindings/rtc/maxim,ds3231.txt
new file mode 100644
index 000000000000..ddef330d2709
--- /dev/null
+++ b/Documentation/devicetree/bindings/rtc/maxim,ds3231.txt
@@ -0,0 +1,37 @@
+* Maxim DS3231 Real Time Clock
+
+Required properties:
+see: Documentation/devicetree/bindings/i2c/trivial-devices.txt
+
+Optional property:
+- #clock-cells: Should be 1.
+- clock-output-names:
+ overwrite the default clock names "ds3231_clk_sqw" and "ds3231_clk_32khz".
+
+Each clock is assigned an identifier and client nodes can use this identifier
+to specify the clock which they consume. Following indices are allowed:
+ - 0: square-wave output on the SQW pin
+ - 1: square-wave output on the 32kHz pin
+
+- interrupts: rtc alarm/event interrupt. When this property is selected,
+ clock on the SQW pin cannot be used.
+
+Example:
+
+ds3231: ds3231@51 {
+ compatible = "maxim,ds3231";
+ reg = <0x68>;
+ #clock-cells = <1>;
+};
+
+device1 {
+...
+ clocks = <&ds3231 0>;
+...
+};
+
+device2 {
+...
+ clocks = <&ds3231 1>;
+...
+};