Merge tag 'for-linus-5.0-rc3-tag' of git://git.kernel.org/pub/scm/linux/kernel/git...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / rtc / rtc.txt
1 Generic device tree bindings for Real Time Clock devices
2 ========================================================
3
4 This document describes generic bindings which can be used to describe Real Time
5 Clock devices in a device tree.
6
7 Required properties
8 -------------------
9
10 - compatible : name of RTC device following generic names recommended practice.
11
12 For other required properties e.g. to describe register sets,
13 clocks, etc. check the binding documentation of the specific driver.
14
15 Optional properties
16 -------------------
17
18 - start-year : if provided, the default hardware range supported by the RTC is
19                shifted so the first usable year is the specified one.
20
21 The following properties may not be supported by all drivers. However, if a
22 driver wants to support one of the below features, it should adapt the bindings
23 below.
24 - trickle-resistor-ohms : Selected resistor for trickle charger. Should be given
25                           if trickle charger should be enabled
26 - trickle-diode-disable : Do not use internal trickle charger diode Should be
27                           given if internal trickle charger diode should be
28                           disabled
29 - wakeup-source :         Enables wake up of host system on alarm
30
31 Trivial RTCs
32 ------------
33
34 This is a list of trivial RTC devices that have simple device tree
35 bindings, consisting only of a compatible field, an address and
36 possibly an interrupt line.
37
38
39 Compatible              Vendor / Chip
40 ==========              =============
41 abracon,abb5zes3        AB-RTCMC-32.768kHz-B5ZE-S3: Real Time Clock/Calendar Module with I2C Interface
42 dallas,ds1374           I2C, 32-Bit Binary Counter Watchdog RTC with Trickle Charger and Reset Input/Output
43 dallas,ds1672           Dallas DS1672 Real-time Clock
44 dallas,ds3232           Extremely Accurate I²C RTC with Integrated Crystal and SRAM
45 epson,rx8010            I2C-BUS INTERFACE REAL TIME CLOCK MODULE
46 epson,rx8581            I2C-BUS INTERFACE REAL TIME CLOCK MODULE
47 emmicro,em3027          EM Microelectronic EM3027 Real-time Clock
48 isil,isl1208            Intersil ISL1208 Low Power RTC with Battery Backed SRAM
49 isil,isl1218            Intersil ISL1218 Low Power RTC with Battery Backed SRAM
50 isil,isl12022           Intersil ISL12022 Real-time Clock
51 microcrystal,rv3029     Real Time Clock Module with I2C-Bus
52 nxp,pcf2127             Real-time clock
53 nxp,pcf2129             Real-time clock
54 nxp,pcf8523             Real-time Clock
55 nxp,pcf8563             Real-time clock/calendar
56 nxp,pcf85063            Tiny Real-Time Clock
57 pericom,pt7c4338        Real-time Clock Module
58 ricoh,r2025sd           I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC
59 ricoh,r2221tl           I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC
60 ricoh,rs5c372a          I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC
61 ricoh,rs5c372b          I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC
62 ricoh,rv5c386           I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC
63 ricoh,rv5c387a          I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC
64 sii,s35390a             2-wire CMOS real-time clock