Merge tag 'trace-v5.1' of git://git.kernel.org/pub/scm/linux/kernel/git/rostedt/linux...
[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 - quartz-load-femtofarads : The capacitive load of the quartz(x-tal),
31                             expressed in femto Farad (fF).
32                             The default value shall be listed (if optional),
33                             and likewise all valid values.
34
35 Trivial RTCs
36 ------------
37
38 This is a list of trivial RTC devices that have simple device tree
39 bindings, consisting only of a compatible field, an address and
40 possibly an interrupt line.
41
42
43 Compatible              Vendor / Chip
44 ==========              =============
45 abracon,abb5zes3        AB-RTCMC-32.768kHz-B5ZE-S3: Real Time Clock/Calendar Module with I2C Interface
46 abracon,abeoz9          AB-RTCMC-32.768kHz-EOZ9: Real Time Clock/Calendar Module with I2C Interface
47 dallas,ds1374           I2C, 32-Bit Binary Counter Watchdog RTC with Trickle Charger and Reset Input/Output
48 dallas,ds1672           Dallas DS1672 Real-time Clock
49 dallas,ds3232           Extremely Accurate I²C RTC with Integrated Crystal and SRAM
50 epson,rx8010            I2C-BUS INTERFACE REAL TIME CLOCK MODULE
51 epson,rx8571            I2C-BUS INTERFACE REAL TIME CLOCK MODULE with Battery Backed RAM
52 epson,rx8581            I2C-BUS INTERFACE REAL TIME CLOCK MODULE
53 emmicro,em3027          EM Microelectronic EM3027 Real-time Clock
54 isil,isl1208            Intersil ISL1208 Low Power RTC with Battery Backed SRAM
55 isil,isl1218            Intersil ISL1218 Low Power RTC with Battery Backed SRAM
56 isil,isl12022           Intersil ISL12022 Real-time Clock
57 microcrystal,rv3028     Real Time Clock Module with I2C-Bus
58 microcrystal,rv3029     Real Time Clock Module with I2C-Bus
59 microcrystal,rv8523     Real Time Clock
60 nxp,pcf2127             Real-time clock
61 nxp,pcf2129             Real-time clock
62 nxp,pcf8563             Real-time clock/calendar
63 pericom,pt7c4338        Real-time Clock Module
64 ricoh,r2025sd           I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC
65 ricoh,r2221tl           I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC
66 ricoh,rs5c372a          I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC
67 ricoh,rs5c372b          I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC
68 ricoh,rv5c386           I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC
69 ricoh,rv5c387a          I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC
70 sii,s35390a             2-wire CMOS real-time clock
71 whwave,sd3078           I2C bus SERIAL INTERFACE REAL-TIME CLOCK IC