1 // SPDX-License-Identifier: GPL-2.0-only
3 * rtc-ds1307.c - RTC driver for some mostly-compatible I2C chips.
5 * Copyright (C) 2005 James Chapman (ds1337 core)
6 * Copyright (C) 2006 David Brownell
7 * Copyright (C) 2009 Matthias Fuchs (rx8025 support)
8 * Copyright (C) 2012 Bertrand Achard (nvram access fixes)
11 #include <linux/bcd.h>
12 #include <linux/i2c.h>
13 #include <linux/init.h>
14 #include <linux/kstrtox.h>
15 #include <linux/mod_devicetable.h>
16 #include <linux/module.h>
17 #include <linux/property.h>
18 #include <linux/rtc/ds1307.h>
19 #include <linux/rtc.h>
20 #include <linux/slab.h>
21 #include <linux/string.h>
22 #include <linux/hwmon.h>
23 #include <linux/hwmon-sysfs.h>
24 #include <linux/clk-provider.h>
25 #include <linux/regmap.h>
26 #include <linux/watchdog.h>
29 * We can't determine type by probing, but if we expect pre-Linux code
30 * to have set the chip up as a clock (turning on the oscillator and
31 * setting the date and time), Linux can ignore the non-clock features.
32 * That's a natural job for a factory or repair bench.
35 unknown_ds_type
, /* always first and 0 */
51 last_ds_type
/* always last */
52 /* rs5c372 too? different address... */
55 /* RTC registers don't differ much, except for the century flag */
56 #define DS1307_REG_SECS 0x00 /* 00-59 */
57 # define DS1307_BIT_CH 0x80
58 # define DS1340_BIT_nEOSC 0x80
59 # define MCP794XX_BIT_ST 0x80
60 #define DS1307_REG_MIN 0x01 /* 00-59 */
61 # define M41T0_BIT_OF 0x80
62 #define DS1307_REG_HOUR 0x02 /* 00-23, or 1-12{am,pm} */
63 # define DS1307_BIT_12HR 0x40 /* in REG_HOUR */
64 # define DS1307_BIT_PM 0x20 /* in REG_HOUR */
65 # define DS1340_BIT_CENTURY_EN 0x80 /* in REG_HOUR */
66 # define DS1340_BIT_CENTURY 0x40 /* in REG_HOUR */
67 #define DS1307_REG_WDAY 0x03 /* 01-07 */
68 # define MCP794XX_BIT_OSCRUN BIT(5)
69 # define MCP794XX_BIT_VBATEN 0x08
70 #define DS1307_REG_MDAY 0x04 /* 01-31 */
71 #define DS1307_REG_MONTH 0x05 /* 01-12 */
72 # define DS1337_BIT_CENTURY 0x80 /* in REG_MONTH */
73 #define DS1307_REG_YEAR 0x06 /* 00-99 */
76 * Other registers (control, status, alarms, trickle charge, NVRAM, etc)
77 * start at 7, and they differ a LOT. Only control and status matter for
78 * basic RTC date and time functionality; be careful using them.
80 #define DS1307_REG_CONTROL 0x07 /* or ds1338 */
81 # define DS1307_BIT_OUT 0x80
82 # define DS1338_BIT_OSF 0x20
83 # define DS1307_BIT_SQWE 0x10
84 # define DS1307_BIT_RS1 0x02
85 # define DS1307_BIT_RS0 0x01
86 #define DS1337_REG_CONTROL 0x0e
87 # define DS1337_BIT_nEOSC 0x80
88 # define DS1339_BIT_BBSQI 0x20
89 # define DS3231_BIT_BBSQW 0x40 /* same as BBSQI */
90 # define DS1337_BIT_RS2 0x10
91 # define DS1337_BIT_RS1 0x08
92 # define DS1337_BIT_INTCN 0x04
93 # define DS1337_BIT_A2IE 0x02
94 # define DS1337_BIT_A1IE 0x01
95 #define DS1340_REG_CONTROL 0x07
96 # define DS1340_BIT_OUT 0x80
97 # define DS1340_BIT_FT 0x40
98 # define DS1340_BIT_CALIB_SIGN 0x20
99 # define DS1340_M_CALIBRATION 0x1f
100 #define DS1340_REG_FLAG 0x09
101 # define DS1340_BIT_OSF 0x80
102 #define DS1337_REG_STATUS 0x0f
103 # define DS1337_BIT_OSF 0x80
104 # define DS3231_BIT_EN32KHZ 0x08
105 # define DS1337_BIT_A2I 0x02
106 # define DS1337_BIT_A1I 0x01
107 #define DS1339_REG_ALARM1_SECS 0x07
109 #define DS13XX_TRICKLE_CHARGER_MAGIC 0xa0
111 #define RX8025_REG_CTRL1 0x0e
112 # define RX8025_BIT_2412 0x20
113 #define RX8025_REG_CTRL2 0x0f
114 # define RX8025_BIT_PON 0x10
115 # define RX8025_BIT_VDET 0x40
116 # define RX8025_BIT_XST 0x20
118 #define RX8130_REG_ALARM_MIN 0x17
119 #define RX8130_REG_ALARM_HOUR 0x18
120 #define RX8130_REG_ALARM_WEEK_OR_DAY 0x19
121 #define RX8130_REG_EXTENSION 0x1c
122 #define RX8130_REG_EXTENSION_WADA BIT(3)
123 #define RX8130_REG_FLAG 0x1d
124 #define RX8130_REG_FLAG_VLF BIT(1)
125 #define RX8130_REG_FLAG_AF BIT(3)
126 #define RX8130_REG_CONTROL0 0x1e
127 #define RX8130_REG_CONTROL0_AIE BIT(3)
128 #define RX8130_REG_CONTROL1 0x1f
129 #define RX8130_REG_CONTROL1_INIEN BIT(4)
130 #define RX8130_REG_CONTROL1_CHGEN BIT(5)
132 #define MCP794XX_REG_CONTROL 0x07
133 # define MCP794XX_BIT_ALM0_EN 0x10
134 # define MCP794XX_BIT_ALM1_EN 0x20
135 #define MCP794XX_REG_ALARM0_BASE 0x0a
136 #define MCP794XX_REG_ALARM0_CTRL 0x0d
137 #define MCP794XX_REG_ALARM1_BASE 0x11
138 #define MCP794XX_REG_ALARM1_CTRL 0x14
139 # define MCP794XX_BIT_ALMX_IF BIT(3)
140 # define MCP794XX_BIT_ALMX_C0 BIT(4)
141 # define MCP794XX_BIT_ALMX_C1 BIT(5)
142 # define MCP794XX_BIT_ALMX_C2 BIT(6)
143 # define MCP794XX_BIT_ALMX_POL BIT(7)
144 # define MCP794XX_MSK_ALMX_MATCH (MCP794XX_BIT_ALMX_C0 | \
145 MCP794XX_BIT_ALMX_C1 | \
146 MCP794XX_BIT_ALMX_C2)
148 #define M41TXX_REG_CONTROL 0x07
149 # define M41TXX_BIT_OUT BIT(7)
150 # define M41TXX_BIT_FT BIT(6)
151 # define M41TXX_BIT_CALIB_SIGN BIT(5)
152 # define M41TXX_M_CALIBRATION GENMASK(4, 0)
154 #define DS1388_REG_WDOG_HUN_SECS 0x08
155 #define DS1388_REG_WDOG_SECS 0x09
156 #define DS1388_REG_FLAG 0x0b
157 # define DS1388_BIT_WF BIT(6)
158 # define DS1388_BIT_OSF BIT(7)
159 #define DS1388_REG_CONTROL 0x0c
160 # define DS1388_BIT_RST BIT(0)
161 # define DS1388_BIT_WDE BIT(1)
162 # define DS1388_BIT_nEOSC BIT(7)
164 /* negative offset step is -2.034ppm */
165 #define M41TXX_NEG_OFFSET_STEP_PPB 2034
166 /* positive offset step is +4.068ppm */
167 #define M41TXX_POS_OFFSET_STEP_PPB 4068
168 /* Min and max values supported with 'offset' interface by M41TXX */
169 #define M41TXX_MIN_OFFSET ((-31) * M41TXX_NEG_OFFSET_STEP_PPB)
170 #define M41TXX_MAX_OFFSET ((31) * M41TXX_POS_OFFSET_STEP_PPB)
175 struct regmap
*regmap
;
177 struct rtc_device
*rtc
;
178 #ifdef CONFIG_COMMON_CLK
179 struct clk_hw clks
[2];
187 u8 offset
; /* register's offset */
189 u8 century_enable_bit
;
192 irq_handler_t irq_handler
;
193 const struct rtc_class_ops
*rtc_ops
;
194 u16 trickle_charger_reg
;
195 u8 (*do_trickle_setup
)(struct ds1307
*, u32
,
197 /* Does the RTC require trickle-resistor-ohms to select the value of
198 * the resistor between Vcc and Vbackup?
200 bool requires_trickle_resistor
;
201 /* Some RTC's batteries and supercaps were charged by default, others
202 * allow charging but were not configured previously to do so.
203 * Remember this behavior to stay backwards compatible.
208 static const struct chip_desc chips
[last_ds_type
];
210 static int ds1307_get_time(struct device
*dev
, struct rtc_time
*t
)
212 struct ds1307
*ds1307
= dev_get_drvdata(dev
);
214 const struct chip_desc
*chip
= &chips
[ds1307
->type
];
217 if (ds1307
->type
== rx_8130
) {
218 unsigned int regflag
;
219 ret
= regmap_read(ds1307
->regmap
, RX8130_REG_FLAG
, ®flag
);
221 dev_err(dev
, "%s error %d\n", "read", ret
);
225 if (regflag
& RX8130_REG_FLAG_VLF
) {
226 dev_warn_once(dev
, "oscillator failed, set time!\n");
231 /* read the RTC date and time registers all at once */
232 ret
= regmap_bulk_read(ds1307
->regmap
, chip
->offset
, regs
,
235 dev_err(dev
, "%s error %d\n", "read", ret
);
239 dev_dbg(dev
, "%s: %7ph\n", "read", regs
);
241 /* if oscillator fail bit is set, no data can be trusted */
242 if (ds1307
->type
== m41t0
&&
243 regs
[DS1307_REG_MIN
] & M41T0_BIT_OF
) {
244 dev_warn_once(dev
, "oscillator failed, set time!\n");
246 } else if (ds1307
->type
== mcp794xx
&&
247 !(regs
[DS1307_REG_WDAY
] & MCP794XX_BIT_OSCRUN
)) {
248 dev_warn_once(dev
, "oscillator failed, set time!\n");
252 tmp
= regs
[DS1307_REG_SECS
];
253 switch (ds1307
->type
) {
258 if (tmp
& DS1307_BIT_CH
)
263 if (tmp
& DS1307_BIT_CH
)
266 ret
= regmap_read(ds1307
->regmap
, DS1307_REG_CONTROL
, &tmp
);
269 if (tmp
& DS1338_BIT_OSF
)
273 if (tmp
& DS1340_BIT_nEOSC
)
276 ret
= regmap_read(ds1307
->regmap
, DS1340_REG_FLAG
, &tmp
);
279 if (tmp
& DS1340_BIT_OSF
)
283 ret
= regmap_read(ds1307
->regmap
, DS1388_REG_FLAG
, &tmp
);
286 if (tmp
& DS1388_BIT_OSF
)
290 if (!(tmp
& MCP794XX_BIT_ST
))
298 t
->tm_sec
= bcd2bin(regs
[DS1307_REG_SECS
] & 0x7f);
299 t
->tm_min
= bcd2bin(regs
[DS1307_REG_MIN
] & 0x7f);
300 tmp
= regs
[DS1307_REG_HOUR
] & 0x3f;
301 t
->tm_hour
= bcd2bin(tmp
);
302 /* rx8130 is bit position, not BCD */
303 if (ds1307
->type
== rx_8130
)
304 t
->tm_wday
= fls(regs
[DS1307_REG_WDAY
] & 0x7f);
306 t
->tm_wday
= bcd2bin(regs
[DS1307_REG_WDAY
] & 0x07) - 1;
307 t
->tm_mday
= bcd2bin(regs
[DS1307_REG_MDAY
] & 0x3f);
308 tmp
= regs
[DS1307_REG_MONTH
] & 0x1f;
309 t
->tm_mon
= bcd2bin(tmp
) - 1;
310 t
->tm_year
= bcd2bin(regs
[DS1307_REG_YEAR
]) + 100;
312 if (regs
[chip
->century_reg
] & chip
->century_bit
&&
313 IS_ENABLED(CONFIG_RTC_DRV_DS1307_CENTURY
))
316 dev_dbg(dev
, "%s secs=%d, mins=%d, "
317 "hours=%d, mday=%d, mon=%d, year=%d, wday=%d\n",
318 "read", t
->tm_sec
, t
->tm_min
,
319 t
->tm_hour
, t
->tm_mday
,
320 t
->tm_mon
, t
->tm_year
, t
->tm_wday
);
325 static int ds1307_set_time(struct device
*dev
, struct rtc_time
*t
)
327 struct ds1307
*ds1307
= dev_get_drvdata(dev
);
328 const struct chip_desc
*chip
= &chips
[ds1307
->type
];
333 dev_dbg(dev
, "%s secs=%d, mins=%d, "
334 "hours=%d, mday=%d, mon=%d, year=%d, wday=%d\n",
335 "write", t
->tm_sec
, t
->tm_min
,
336 t
->tm_hour
, t
->tm_mday
,
337 t
->tm_mon
, t
->tm_year
, t
->tm_wday
);
339 if (t
->tm_year
< 100)
342 #ifdef CONFIG_RTC_DRV_DS1307_CENTURY
343 if (t
->tm_year
> (chip
->century_bit
? 299 : 199))
346 if (t
->tm_year
> 199)
350 regs
[DS1307_REG_SECS
] = bin2bcd(t
->tm_sec
);
351 regs
[DS1307_REG_MIN
] = bin2bcd(t
->tm_min
);
352 regs
[DS1307_REG_HOUR
] = bin2bcd(t
->tm_hour
);
353 /* rx8130 is bit position, not BCD */
354 if (ds1307
->type
== rx_8130
)
355 regs
[DS1307_REG_WDAY
] = 1 << t
->tm_wday
;
357 regs
[DS1307_REG_WDAY
] = bin2bcd(t
->tm_wday
+ 1);
358 regs
[DS1307_REG_MDAY
] = bin2bcd(t
->tm_mday
);
359 regs
[DS1307_REG_MONTH
] = bin2bcd(t
->tm_mon
+ 1);
361 /* assume 20YY not 19YY */
362 tmp
= t
->tm_year
% 100;
363 regs
[DS1307_REG_YEAR
] = bin2bcd(tmp
);
365 if (chip
->century_enable_bit
)
366 regs
[chip
->century_reg
] |= chip
->century_enable_bit
;
367 if (t
->tm_year
> 199 && chip
->century_bit
)
368 regs
[chip
->century_reg
] |= chip
->century_bit
;
370 switch (ds1307
->type
) {
373 regmap_update_bits(ds1307
->regmap
, DS1307_REG_CONTROL
,
377 regmap_update_bits(ds1307
->regmap
, DS1340_REG_FLAG
,
381 regmap_update_bits(ds1307
->regmap
, DS1388_REG_FLAG
,
386 * these bits were cleared when preparing the date/time
387 * values and need to be set again before writing the
388 * regsfer out to the device.
390 regs
[DS1307_REG_SECS
] |= MCP794XX_BIT_ST
;
391 regs
[DS1307_REG_WDAY
] |= MCP794XX_BIT_VBATEN
;
397 dev_dbg(dev
, "%s: %7ph\n", "write", regs
);
399 result
= regmap_bulk_write(ds1307
->regmap
, chip
->offset
, regs
,
402 dev_err(dev
, "%s error %d\n", "write", result
);
406 if (ds1307
->type
== rx_8130
) {
407 /* clear Voltage Loss Flag as data is available now */
408 result
= regmap_write(ds1307
->regmap
, RX8130_REG_FLAG
,
409 ~(u8
)RX8130_REG_FLAG_VLF
);
411 dev_err(dev
, "%s error %d\n", "write", result
);
419 static int ds1337_read_alarm(struct device
*dev
, struct rtc_wkalrm
*t
)
421 struct ds1307
*ds1307
= dev_get_drvdata(dev
);
425 /* read all ALARM1, ALARM2, and status registers at once */
426 ret
= regmap_bulk_read(ds1307
->regmap
, DS1339_REG_ALARM1_SECS
,
429 dev_err(dev
, "%s error %d\n", "alarm read", ret
);
433 dev_dbg(dev
, "%s: %4ph, %3ph, %2ph\n", "alarm read",
434 ®s
[0], ®s
[4], ®s
[7]);
437 * report alarm time (ALARM1); assume 24 hour and day-of-month modes,
438 * and that all four fields are checked matches
440 t
->time
.tm_sec
= bcd2bin(regs
[0] & 0x7f);
441 t
->time
.tm_min
= bcd2bin(regs
[1] & 0x7f);
442 t
->time
.tm_hour
= bcd2bin(regs
[2] & 0x3f);
443 t
->time
.tm_mday
= bcd2bin(regs
[3] & 0x3f);
446 t
->enabled
= !!(regs
[7] & DS1337_BIT_A1IE
);
447 t
->pending
= !!(regs
[8] & DS1337_BIT_A1I
);
449 dev_dbg(dev
, "%s secs=%d, mins=%d, "
450 "hours=%d, mday=%d, enabled=%d, pending=%d\n",
451 "alarm read", t
->time
.tm_sec
, t
->time
.tm_min
,
452 t
->time
.tm_hour
, t
->time
.tm_mday
,
453 t
->enabled
, t
->pending
);
458 static int ds1337_set_alarm(struct device
*dev
, struct rtc_wkalrm
*t
)
460 struct ds1307
*ds1307
= dev_get_drvdata(dev
);
461 unsigned char regs
[9];
465 dev_dbg(dev
, "%s secs=%d, mins=%d, "
466 "hours=%d, mday=%d, enabled=%d, pending=%d\n",
467 "alarm set", t
->time
.tm_sec
, t
->time
.tm_min
,
468 t
->time
.tm_hour
, t
->time
.tm_mday
,
469 t
->enabled
, t
->pending
);
471 /* read current status of both alarms and the chip */
472 ret
= regmap_bulk_read(ds1307
->regmap
, DS1339_REG_ALARM1_SECS
, regs
,
475 dev_err(dev
, "%s error %d\n", "alarm write", ret
);
481 dev_dbg(dev
, "%s: %4ph, %3ph, %02x %02x\n", "alarm set (old status)",
482 ®s
[0], ®s
[4], control
, status
);
484 /* set ALARM1, using 24 hour and day-of-month modes */
485 regs
[0] = bin2bcd(t
->time
.tm_sec
);
486 regs
[1] = bin2bcd(t
->time
.tm_min
);
487 regs
[2] = bin2bcd(t
->time
.tm_hour
);
488 regs
[3] = bin2bcd(t
->time
.tm_mday
);
490 /* set ALARM2 to non-garbage */
496 regs
[7] = control
& ~(DS1337_BIT_A1IE
| DS1337_BIT_A2IE
);
497 regs
[8] = status
& ~(DS1337_BIT_A1I
| DS1337_BIT_A2I
);
499 ret
= regmap_bulk_write(ds1307
->regmap
, DS1339_REG_ALARM1_SECS
, regs
,
502 dev_err(dev
, "can't set alarm time\n");
506 /* optionally enable ALARM1 */
508 dev_dbg(dev
, "alarm IRQ armed\n");
509 regs
[7] |= DS1337_BIT_A1IE
; /* only ALARM1 is used */
510 regmap_write(ds1307
->regmap
, DS1337_REG_CONTROL
, regs
[7]);
516 static int ds1307_alarm_irq_enable(struct device
*dev
, unsigned int enabled
)
518 struct ds1307
*ds1307
= dev_get_drvdata(dev
);
520 return regmap_update_bits(ds1307
->regmap
, DS1337_REG_CONTROL
,
522 enabled
? DS1337_BIT_A1IE
: 0);
525 static u8
do_trickle_setup_ds1339(struct ds1307
*ds1307
, u32 ohms
, bool diode
)
527 u8 setup
= (diode
) ? DS1307_TRICKLE_CHARGER_DIODE
:
528 DS1307_TRICKLE_CHARGER_NO_DIODE
;
530 setup
|= DS13XX_TRICKLE_CHARGER_MAGIC
;
534 setup
|= DS1307_TRICKLE_CHARGER_250_OHM
;
537 setup
|= DS1307_TRICKLE_CHARGER_2K_OHM
;
540 setup
|= DS1307_TRICKLE_CHARGER_4K_OHM
;
543 dev_warn(ds1307
->dev
,
544 "Unsupported ohm value %u in dt\n", ohms
);
550 static u8
do_trickle_setup_rx8130(struct ds1307
*ds1307
, u32 ohms
, bool diode
)
552 /* make sure that the backup battery is enabled */
553 u8 setup
= RX8130_REG_CONTROL1_INIEN
;
555 setup
|= RX8130_REG_CONTROL1_CHGEN
;
560 static irqreturn_t
rx8130_irq(int irq
, void *dev_id
)
562 struct ds1307
*ds1307
= dev_id
;
566 rtc_lock(ds1307
->rtc
);
568 /* Read control registers. */
569 ret
= regmap_bulk_read(ds1307
->regmap
, RX8130_REG_EXTENSION
, ctl
,
573 if (!(ctl
[1] & RX8130_REG_FLAG_AF
))
575 ctl
[1] &= ~RX8130_REG_FLAG_AF
;
576 ctl
[2] &= ~RX8130_REG_CONTROL0_AIE
;
578 ret
= regmap_bulk_write(ds1307
->regmap
, RX8130_REG_EXTENSION
, ctl
,
583 rtc_update_irq(ds1307
->rtc
, 1, RTC_AF
| RTC_IRQF
);
586 rtc_unlock(ds1307
->rtc
);
591 static int rx8130_read_alarm(struct device
*dev
, struct rtc_wkalrm
*t
)
593 struct ds1307
*ds1307
= dev_get_drvdata(dev
);
597 /* Read alarm registers. */
598 ret
= regmap_bulk_read(ds1307
->regmap
, RX8130_REG_ALARM_MIN
, ald
,
603 /* Read control registers. */
604 ret
= regmap_bulk_read(ds1307
->regmap
, RX8130_REG_EXTENSION
, ctl
,
609 t
->enabled
= !!(ctl
[2] & RX8130_REG_CONTROL0_AIE
);
610 t
->pending
= !!(ctl
[1] & RX8130_REG_FLAG_AF
);
612 /* Report alarm 0 time assuming 24-hour and day-of-month modes. */
614 t
->time
.tm_min
= bcd2bin(ald
[0] & 0x7f);
615 t
->time
.tm_hour
= bcd2bin(ald
[1] & 0x7f);
616 t
->time
.tm_wday
= -1;
617 t
->time
.tm_mday
= bcd2bin(ald
[2] & 0x7f);
619 t
->time
.tm_year
= -1;
620 t
->time
.tm_yday
= -1;
621 t
->time
.tm_isdst
= -1;
623 dev_dbg(dev
, "%s, sec=%d min=%d hour=%d wday=%d mday=%d mon=%d enabled=%d\n",
624 __func__
, t
->time
.tm_sec
, t
->time
.tm_min
, t
->time
.tm_hour
,
625 t
->time
.tm_wday
, t
->time
.tm_mday
, t
->time
.tm_mon
, t
->enabled
);
630 static int rx8130_set_alarm(struct device
*dev
, struct rtc_wkalrm
*t
)
632 struct ds1307
*ds1307
= dev_get_drvdata(dev
);
636 dev_dbg(dev
, "%s, sec=%d min=%d hour=%d wday=%d mday=%d mon=%d "
637 "enabled=%d pending=%d\n", __func__
,
638 t
->time
.tm_sec
, t
->time
.tm_min
, t
->time
.tm_hour
,
639 t
->time
.tm_wday
, t
->time
.tm_mday
, t
->time
.tm_mon
,
640 t
->enabled
, t
->pending
);
642 /* Read control registers. */
643 ret
= regmap_bulk_read(ds1307
->regmap
, RX8130_REG_EXTENSION
, ctl
,
648 ctl
[0] &= RX8130_REG_EXTENSION_WADA
;
649 ctl
[1] &= ~RX8130_REG_FLAG_AF
;
650 ctl
[2] &= ~RX8130_REG_CONTROL0_AIE
;
652 ret
= regmap_bulk_write(ds1307
->regmap
, RX8130_REG_EXTENSION
, ctl
,
657 /* Hardware alarm precision is 1 minute! */
658 ald
[0] = bin2bcd(t
->time
.tm_min
);
659 ald
[1] = bin2bcd(t
->time
.tm_hour
);
660 ald
[2] = bin2bcd(t
->time
.tm_mday
);
662 ret
= regmap_bulk_write(ds1307
->regmap
, RX8130_REG_ALARM_MIN
, ald
,
670 ctl
[2] |= RX8130_REG_CONTROL0_AIE
;
672 return regmap_write(ds1307
->regmap
, RX8130_REG_CONTROL0
, ctl
[2]);
675 static int rx8130_alarm_irq_enable(struct device
*dev
, unsigned int enabled
)
677 struct ds1307
*ds1307
= dev_get_drvdata(dev
);
680 ret
= regmap_read(ds1307
->regmap
, RX8130_REG_CONTROL0
, ®
);
685 reg
|= RX8130_REG_CONTROL0_AIE
;
687 reg
&= ~RX8130_REG_CONTROL0_AIE
;
689 return regmap_write(ds1307
->regmap
, RX8130_REG_CONTROL0
, reg
);
692 static irqreturn_t
mcp794xx_irq(int irq
, void *dev_id
)
694 struct ds1307
*ds1307
= dev_id
;
695 struct mutex
*lock
= &ds1307
->rtc
->ops_lock
;
700 /* Check and clear alarm 0 interrupt flag. */
701 ret
= regmap_read(ds1307
->regmap
, MCP794XX_REG_ALARM0_CTRL
, ®
);
704 if (!(reg
& MCP794XX_BIT_ALMX_IF
))
706 reg
&= ~MCP794XX_BIT_ALMX_IF
;
707 ret
= regmap_write(ds1307
->regmap
, MCP794XX_REG_ALARM0_CTRL
, reg
);
711 /* Disable alarm 0. */
712 ret
= regmap_update_bits(ds1307
->regmap
, MCP794XX_REG_CONTROL
,
713 MCP794XX_BIT_ALM0_EN
, 0);
717 rtc_update_irq(ds1307
->rtc
, 1, RTC_AF
| RTC_IRQF
);
725 static int mcp794xx_read_alarm(struct device
*dev
, struct rtc_wkalrm
*t
)
727 struct ds1307
*ds1307
= dev_get_drvdata(dev
);
731 /* Read control and alarm 0 registers. */
732 ret
= regmap_bulk_read(ds1307
->regmap
, MCP794XX_REG_CONTROL
, regs
,
737 t
->enabled
= !!(regs
[0] & MCP794XX_BIT_ALM0_EN
);
739 /* Report alarm 0 time assuming 24-hour and day-of-month modes. */
740 t
->time
.tm_sec
= bcd2bin(regs
[3] & 0x7f);
741 t
->time
.tm_min
= bcd2bin(regs
[4] & 0x7f);
742 t
->time
.tm_hour
= bcd2bin(regs
[5] & 0x3f);
743 t
->time
.tm_wday
= bcd2bin(regs
[6] & 0x7) - 1;
744 t
->time
.tm_mday
= bcd2bin(regs
[7] & 0x3f);
745 t
->time
.tm_mon
= bcd2bin(regs
[8] & 0x1f) - 1;
746 t
->time
.tm_year
= -1;
747 t
->time
.tm_yday
= -1;
748 t
->time
.tm_isdst
= -1;
750 dev_dbg(dev
, "%s, sec=%d min=%d hour=%d wday=%d mday=%d mon=%d "
751 "enabled=%d polarity=%d irq=%d match=%lu\n", __func__
,
752 t
->time
.tm_sec
, t
->time
.tm_min
, t
->time
.tm_hour
,
753 t
->time
.tm_wday
, t
->time
.tm_mday
, t
->time
.tm_mon
, t
->enabled
,
754 !!(regs
[6] & MCP794XX_BIT_ALMX_POL
),
755 !!(regs
[6] & MCP794XX_BIT_ALMX_IF
),
756 (regs
[6] & MCP794XX_MSK_ALMX_MATCH
) >> 4);
762 * We may have a random RTC weekday, therefore calculate alarm weekday based
763 * on current weekday we read from the RTC timekeeping regs
765 static int mcp794xx_alm_weekday(struct device
*dev
, struct rtc_time
*tm_alarm
)
767 struct rtc_time tm_now
;
768 int days_now
, days_alarm
, ret
;
770 ret
= ds1307_get_time(dev
, &tm_now
);
774 days_now
= div_s64(rtc_tm_to_time64(&tm_now
), 24 * 60 * 60);
775 days_alarm
= div_s64(rtc_tm_to_time64(tm_alarm
), 24 * 60 * 60);
777 return (tm_now
.tm_wday
+ days_alarm
- days_now
) % 7 + 1;
780 static int mcp794xx_set_alarm(struct device
*dev
, struct rtc_wkalrm
*t
)
782 struct ds1307
*ds1307
= dev_get_drvdata(dev
);
783 unsigned char regs
[10];
786 wday
= mcp794xx_alm_weekday(dev
, &t
->time
);
790 dev_dbg(dev
, "%s, sec=%d min=%d hour=%d wday=%d mday=%d mon=%d "
791 "enabled=%d pending=%d\n", __func__
,
792 t
->time
.tm_sec
, t
->time
.tm_min
, t
->time
.tm_hour
,
793 t
->time
.tm_wday
, t
->time
.tm_mday
, t
->time
.tm_mon
,
794 t
->enabled
, t
->pending
);
796 /* Read control and alarm 0 registers. */
797 ret
= regmap_bulk_read(ds1307
->regmap
, MCP794XX_REG_CONTROL
, regs
,
802 /* Set alarm 0, using 24-hour and day-of-month modes. */
803 regs
[3] = bin2bcd(t
->time
.tm_sec
);
804 regs
[4] = bin2bcd(t
->time
.tm_min
);
805 regs
[5] = bin2bcd(t
->time
.tm_hour
);
807 regs
[7] = bin2bcd(t
->time
.tm_mday
);
808 regs
[8] = bin2bcd(t
->time
.tm_mon
+ 1);
810 /* Clear the alarm 0 interrupt flag. */
811 regs
[6] &= ~MCP794XX_BIT_ALMX_IF
;
812 /* Set alarm match: second, minute, hour, day, date, month. */
813 regs
[6] |= MCP794XX_MSK_ALMX_MATCH
;
814 /* Disable interrupt. We will not enable until completely programmed */
815 regs
[0] &= ~MCP794XX_BIT_ALM0_EN
;
817 ret
= regmap_bulk_write(ds1307
->regmap
, MCP794XX_REG_CONTROL
, regs
,
824 regs
[0] |= MCP794XX_BIT_ALM0_EN
;
825 return regmap_write(ds1307
->regmap
, MCP794XX_REG_CONTROL
, regs
[0]);
828 static int mcp794xx_alarm_irq_enable(struct device
*dev
, unsigned int enabled
)
830 struct ds1307
*ds1307
= dev_get_drvdata(dev
);
832 return regmap_update_bits(ds1307
->regmap
, MCP794XX_REG_CONTROL
,
833 MCP794XX_BIT_ALM0_EN
,
834 enabled
? MCP794XX_BIT_ALM0_EN
: 0);
837 static int m41txx_rtc_read_offset(struct device
*dev
, long *offset
)
839 struct ds1307
*ds1307
= dev_get_drvdata(dev
);
840 unsigned int ctrl_reg
;
843 regmap_read(ds1307
->regmap
, M41TXX_REG_CONTROL
, &ctrl_reg
);
845 val
= ctrl_reg
& M41TXX_M_CALIBRATION
;
847 /* check if positive */
848 if (ctrl_reg
& M41TXX_BIT_CALIB_SIGN
)
849 *offset
= (val
* M41TXX_POS_OFFSET_STEP_PPB
);
851 *offset
= -(val
* M41TXX_NEG_OFFSET_STEP_PPB
);
856 static int m41txx_rtc_set_offset(struct device
*dev
, long offset
)
858 struct ds1307
*ds1307
= dev_get_drvdata(dev
);
859 unsigned int ctrl_reg
;
861 if ((offset
< M41TXX_MIN_OFFSET
) || (offset
> M41TXX_MAX_OFFSET
))
865 ctrl_reg
= DIV_ROUND_CLOSEST(offset
,
866 M41TXX_POS_OFFSET_STEP_PPB
);
867 ctrl_reg
|= M41TXX_BIT_CALIB_SIGN
;
869 ctrl_reg
= DIV_ROUND_CLOSEST(abs(offset
),
870 M41TXX_NEG_OFFSET_STEP_PPB
);
873 return regmap_update_bits(ds1307
->regmap
, M41TXX_REG_CONTROL
,
874 M41TXX_M_CALIBRATION
| M41TXX_BIT_CALIB_SIGN
,
878 #ifdef CONFIG_WATCHDOG_CORE
879 static int ds1388_wdt_start(struct watchdog_device
*wdt_dev
)
881 struct ds1307
*ds1307
= watchdog_get_drvdata(wdt_dev
);
885 ret
= regmap_update_bits(ds1307
->regmap
, DS1388_REG_FLAG
,
890 ret
= regmap_update_bits(ds1307
->regmap
, DS1388_REG_CONTROL
,
891 DS1388_BIT_WDE
| DS1388_BIT_RST
, 0);
896 * watchdog timeouts are measured in seconds. So ignore hundredths of
900 regs
[1] = bin2bcd(wdt_dev
->timeout
);
902 ret
= regmap_bulk_write(ds1307
->regmap
, DS1388_REG_WDOG_HUN_SECS
, regs
,
907 return regmap_update_bits(ds1307
->regmap
, DS1388_REG_CONTROL
,
908 DS1388_BIT_WDE
| DS1388_BIT_RST
,
909 DS1388_BIT_WDE
| DS1388_BIT_RST
);
912 static int ds1388_wdt_stop(struct watchdog_device
*wdt_dev
)
914 struct ds1307
*ds1307
= watchdog_get_drvdata(wdt_dev
);
916 return regmap_update_bits(ds1307
->regmap
, DS1388_REG_CONTROL
,
917 DS1388_BIT_WDE
| DS1388_BIT_RST
, 0);
920 static int ds1388_wdt_ping(struct watchdog_device
*wdt_dev
)
922 struct ds1307
*ds1307
= watchdog_get_drvdata(wdt_dev
);
925 return regmap_bulk_read(ds1307
->regmap
, DS1388_REG_WDOG_HUN_SECS
, regs
,
929 static int ds1388_wdt_set_timeout(struct watchdog_device
*wdt_dev
,
932 struct ds1307
*ds1307
= watchdog_get_drvdata(wdt_dev
);
935 wdt_dev
->timeout
= val
;
937 regs
[1] = bin2bcd(wdt_dev
->timeout
);
939 return regmap_bulk_write(ds1307
->regmap
, DS1388_REG_WDOG_HUN_SECS
, regs
,
944 static const struct rtc_class_ops rx8130_rtc_ops
= {
945 .read_time
= ds1307_get_time
,
946 .set_time
= ds1307_set_time
,
947 .read_alarm
= rx8130_read_alarm
,
948 .set_alarm
= rx8130_set_alarm
,
949 .alarm_irq_enable
= rx8130_alarm_irq_enable
,
952 static const struct rtc_class_ops mcp794xx_rtc_ops
= {
953 .read_time
= ds1307_get_time
,
954 .set_time
= ds1307_set_time
,
955 .read_alarm
= mcp794xx_read_alarm
,
956 .set_alarm
= mcp794xx_set_alarm
,
957 .alarm_irq_enable
= mcp794xx_alarm_irq_enable
,
960 static const struct rtc_class_ops m41txx_rtc_ops
= {
961 .read_time
= ds1307_get_time
,
962 .set_time
= ds1307_set_time
,
963 .read_alarm
= ds1337_read_alarm
,
964 .set_alarm
= ds1337_set_alarm
,
965 .alarm_irq_enable
= ds1307_alarm_irq_enable
,
966 .read_offset
= m41txx_rtc_read_offset
,
967 .set_offset
= m41txx_rtc_set_offset
,
970 static const struct chip_desc chips
[last_ds_type
] = {
981 .century_reg
= DS1307_REG_MONTH
,
982 .century_bit
= DS1337_BIT_CENTURY
,
990 .century_reg
= DS1307_REG_MONTH
,
991 .century_bit
= DS1337_BIT_CENTURY
,
992 .bbsqi_bit
= DS1339_BIT_BBSQI
,
993 .trickle_charger_reg
= 0x10,
994 .do_trickle_setup
= &do_trickle_setup_ds1339
,
995 .requires_trickle_resistor
= true,
996 .charge_default
= true,
999 .century_reg
= DS1307_REG_HOUR
,
1000 .century_enable_bit
= DS1340_BIT_CENTURY_EN
,
1001 .century_bit
= DS1340_BIT_CENTURY
,
1002 .do_trickle_setup
= &do_trickle_setup_ds1339
,
1003 .trickle_charger_reg
= 0x08,
1004 .requires_trickle_resistor
= true,
1005 .charge_default
= true,
1008 .century_reg
= DS1307_REG_MONTH
,
1009 .century_bit
= DS1337_BIT_CENTURY
,
1013 .trickle_charger_reg
= 0x0a,
1017 .century_reg
= DS1307_REG_MONTH
,
1018 .century_bit
= DS1337_BIT_CENTURY
,
1019 .bbsqi_bit
= DS3231_BIT_BBSQW
,
1023 /* this is battery backed SRAM */
1024 .nvram_offset
= 0x20,
1025 .nvram_size
= 4, /* 32bit (4 word x 8 bit) */
1027 .irq_handler
= rx8130_irq
,
1028 .rtc_ops
= &rx8130_rtc_ops
,
1029 .trickle_charger_reg
= RX8130_REG_CONTROL1
,
1030 .do_trickle_setup
= &do_trickle_setup_rx8130
,
1033 .rtc_ops
= &m41txx_rtc_ops
,
1036 .rtc_ops
= &m41txx_rtc_ops
,
1039 /* this is battery backed SRAM */
1042 .rtc_ops
= &m41txx_rtc_ops
,
1046 /* this is battery backed SRAM */
1047 .nvram_offset
= 0x20,
1049 .irq_handler
= mcp794xx_irq
,
1050 .rtc_ops
= &mcp794xx_rtc_ops
,
1054 static const struct i2c_device_id ds1307_id
[] = {
1055 { "ds1307", ds_1307
},
1056 { "ds1308", ds_1308
},
1057 { "ds1337", ds_1337
},
1058 { "ds1338", ds_1338
},
1059 { "ds1339", ds_1339
},
1060 { "ds1388", ds_1388
},
1061 { "ds1340", ds_1340
},
1062 { "ds1341", ds_1341
},
1063 { "ds3231", ds_3231
},
1065 { "m41t00", m41t00
},
1066 { "m41t11", m41t11
},
1067 { "mcp7940x", mcp794xx
},
1068 { "mcp7941x", mcp794xx
},
1069 { "pt7c4338", ds_1307
},
1070 { "rx8025", rx_8025
},
1071 { "isl12057", ds_1337
},
1072 { "rx8130", rx_8130
},
1075 MODULE_DEVICE_TABLE(i2c
, ds1307_id
);
1077 static const struct of_device_id ds1307_of_match
[] = {
1079 .compatible
= "dallas,ds1307",
1080 .data
= (void *)ds_1307
1083 .compatible
= "dallas,ds1308",
1084 .data
= (void *)ds_1308
1087 .compatible
= "dallas,ds1337",
1088 .data
= (void *)ds_1337
1091 .compatible
= "dallas,ds1338",
1092 .data
= (void *)ds_1338
1095 .compatible
= "dallas,ds1339",
1096 .data
= (void *)ds_1339
1099 .compatible
= "dallas,ds1388",
1100 .data
= (void *)ds_1388
1103 .compatible
= "dallas,ds1340",
1104 .data
= (void *)ds_1340
1107 .compatible
= "dallas,ds1341",
1108 .data
= (void *)ds_1341
1111 .compatible
= "maxim,ds3231",
1112 .data
= (void *)ds_3231
1115 .compatible
= "st,m41t0",
1116 .data
= (void *)m41t0
1119 .compatible
= "st,m41t00",
1120 .data
= (void *)m41t00
1123 .compatible
= "st,m41t11",
1124 .data
= (void *)m41t11
1127 .compatible
= "microchip,mcp7940x",
1128 .data
= (void *)mcp794xx
1131 .compatible
= "microchip,mcp7941x",
1132 .data
= (void *)mcp794xx
1135 .compatible
= "pericom,pt7c4338",
1136 .data
= (void *)ds_1307
1139 .compatible
= "epson,rx8025",
1140 .data
= (void *)rx_8025
1143 .compatible
= "isil,isl12057",
1144 .data
= (void *)ds_1337
1147 .compatible
= "epson,rx8130",
1148 .data
= (void *)rx_8130
1152 MODULE_DEVICE_TABLE(of
, ds1307_of_match
);
1155 * The ds1337 and ds1339 both have two alarms, but we only use the first
1156 * one (with a "seconds" field). For ds1337 we expect nINTA is our alarm
1157 * signal; ds1339 chips have only one alarm signal.
1159 static irqreturn_t
ds1307_irq(int irq
, void *dev_id
)
1161 struct ds1307
*ds1307
= dev_id
;
1162 struct mutex
*lock
= &ds1307
->rtc
->ops_lock
;
1166 ret
= regmap_read(ds1307
->regmap
, DS1337_REG_STATUS
, &stat
);
1170 if (stat
& DS1337_BIT_A1I
) {
1171 stat
&= ~DS1337_BIT_A1I
;
1172 regmap_write(ds1307
->regmap
, DS1337_REG_STATUS
, stat
);
1174 ret
= regmap_update_bits(ds1307
->regmap
, DS1337_REG_CONTROL
,
1175 DS1337_BIT_A1IE
, 0);
1179 rtc_update_irq(ds1307
->rtc
, 1, RTC_AF
| RTC_IRQF
);
1188 /*----------------------------------------------------------------------*/
1190 static const struct rtc_class_ops ds13xx_rtc_ops
= {
1191 .read_time
= ds1307_get_time
,
1192 .set_time
= ds1307_set_time
,
1193 .read_alarm
= ds1337_read_alarm
,
1194 .set_alarm
= ds1337_set_alarm
,
1195 .alarm_irq_enable
= ds1307_alarm_irq_enable
,
1198 static ssize_t
frequency_test_store(struct device
*dev
,
1199 struct device_attribute
*attr
,
1200 const char *buf
, size_t count
)
1202 struct ds1307
*ds1307
= dev_get_drvdata(dev
->parent
);
1206 ret
= kstrtobool(buf
, &freq_test_en
);
1208 dev_err(dev
, "Failed to store RTC Frequency Test attribute\n");
1212 regmap_update_bits(ds1307
->regmap
, M41TXX_REG_CONTROL
, M41TXX_BIT_FT
,
1213 freq_test_en
? M41TXX_BIT_FT
: 0);
1218 static ssize_t
frequency_test_show(struct device
*dev
,
1219 struct device_attribute
*attr
,
1222 struct ds1307
*ds1307
= dev_get_drvdata(dev
->parent
);
1223 unsigned int ctrl_reg
;
1225 regmap_read(ds1307
->regmap
, M41TXX_REG_CONTROL
, &ctrl_reg
);
1227 return sysfs_emit(buf
, (ctrl_reg
& M41TXX_BIT_FT
) ? "on\n" : "off\n");
1230 static DEVICE_ATTR_RW(frequency_test
);
1232 static struct attribute
*rtc_freq_test_attrs
[] = {
1233 &dev_attr_frequency_test
.attr
,
1237 static const struct attribute_group rtc_freq_test_attr_group
= {
1238 .attrs
= rtc_freq_test_attrs
,
1241 static int ds1307_add_frequency_test(struct ds1307
*ds1307
)
1245 switch (ds1307
->type
) {
1249 err
= rtc_add_group(ds1307
->rtc
, &rtc_freq_test_attr_group
);
1260 /*----------------------------------------------------------------------*/
1262 static int ds1307_nvram_read(void *priv
, unsigned int offset
, void *val
,
1265 struct ds1307
*ds1307
= priv
;
1266 const struct chip_desc
*chip
= &chips
[ds1307
->type
];
1268 return regmap_bulk_read(ds1307
->regmap
, chip
->nvram_offset
+ offset
,
1272 static int ds1307_nvram_write(void *priv
, unsigned int offset
, void *val
,
1275 struct ds1307
*ds1307
= priv
;
1276 const struct chip_desc
*chip
= &chips
[ds1307
->type
];
1278 return regmap_bulk_write(ds1307
->regmap
, chip
->nvram_offset
+ offset
,
1282 /*----------------------------------------------------------------------*/
1284 static u8
ds1307_trickle_init(struct ds1307
*ds1307
,
1285 const struct chip_desc
*chip
)
1287 u32 ohms
, chargeable
;
1288 bool diode
= chip
->charge_default
;
1290 if (!chip
->do_trickle_setup
)
1293 if (device_property_read_u32(ds1307
->dev
, "trickle-resistor-ohms",
1294 &ohms
) && chip
->requires_trickle_resistor
)
1297 /* aux-voltage-chargeable takes precedence over the deprecated
1298 * trickle-diode-disable
1300 if (!device_property_read_u32(ds1307
->dev
, "aux-voltage-chargeable",
1302 switch (chargeable
) {
1310 dev_warn(ds1307
->dev
,
1311 "unsupported aux-voltage-chargeable value\n");
1314 } else if (device_property_read_bool(ds1307
->dev
,
1315 "trickle-diode-disable")) {
1319 return chip
->do_trickle_setup(ds1307
, ohms
, diode
);
1322 /*----------------------------------------------------------------------*/
1324 #if IS_REACHABLE(CONFIG_HWMON)
1327 * Temperature sensor support for ds3231 devices.
1330 #define DS3231_REG_TEMPERATURE 0x11
1333 * A user-initiated temperature conversion is not started by this function,
1334 * so the temperature is updated once every 64 seconds.
1336 static int ds3231_hwmon_read_temp(struct device
*dev
, s32
*mC
)
1338 struct ds1307
*ds1307
= dev_get_drvdata(dev
);
1343 ret
= regmap_bulk_read(ds1307
->regmap
, DS3231_REG_TEMPERATURE
,
1344 temp_buf
, sizeof(temp_buf
));
1348 * Temperature is represented as a 10-bit code with a resolution of
1349 * 0.25 degree celsius and encoded in two's complement format.
1351 temp
= (temp_buf
[0] << 8) | temp_buf
[1];
1358 static ssize_t
ds3231_hwmon_show_temp(struct device
*dev
,
1359 struct device_attribute
*attr
, char *buf
)
1364 ret
= ds3231_hwmon_read_temp(dev
, &temp
);
1368 return sprintf(buf
, "%d\n", temp
);
1370 static SENSOR_DEVICE_ATTR(temp1_input
, 0444, ds3231_hwmon_show_temp
,
1373 static struct attribute
*ds3231_hwmon_attrs
[] = {
1374 &sensor_dev_attr_temp1_input
.dev_attr
.attr
,
1377 ATTRIBUTE_GROUPS(ds3231_hwmon
);
1379 static void ds1307_hwmon_register(struct ds1307
*ds1307
)
1383 if (ds1307
->type
!= ds_3231
)
1386 dev
= devm_hwmon_device_register_with_groups(ds1307
->dev
, ds1307
->name
,
1388 ds3231_hwmon_groups
);
1390 dev_warn(ds1307
->dev
, "unable to register hwmon device %ld\n",
1397 static void ds1307_hwmon_register(struct ds1307
*ds1307
)
1401 #endif /* CONFIG_RTC_DRV_DS1307_HWMON */
1403 /*----------------------------------------------------------------------*/
1406 * Square-wave output support for DS3231
1407 * Datasheet: https://datasheets.maximintegrated.com/en/ds/DS3231.pdf
1409 #ifdef CONFIG_COMMON_CLK
1416 #define clk_sqw_to_ds1307(clk) \
1417 container_of(clk, struct ds1307, clks[DS3231_CLK_SQW])
1418 #define clk_32khz_to_ds1307(clk) \
1419 container_of(clk, struct ds1307, clks[DS3231_CLK_32KHZ])
1421 static int ds3231_clk_sqw_rates
[] = {
1428 static int ds1337_write_control(struct ds1307
*ds1307
, u8 mask
, u8 value
)
1430 struct mutex
*lock
= &ds1307
->rtc
->ops_lock
;
1434 ret
= regmap_update_bits(ds1307
->regmap
, DS1337_REG_CONTROL
,
1441 static unsigned long ds3231_clk_sqw_recalc_rate(struct clk_hw
*hw
,
1442 unsigned long parent_rate
)
1444 struct ds1307
*ds1307
= clk_sqw_to_ds1307(hw
);
1448 ret
= regmap_read(ds1307
->regmap
, DS1337_REG_CONTROL
, &control
);
1451 if (control
& DS1337_BIT_RS1
)
1453 if (control
& DS1337_BIT_RS2
)
1456 return ds3231_clk_sqw_rates
[rate_sel
];
1459 static long ds3231_clk_sqw_round_rate(struct clk_hw
*hw
, unsigned long rate
,
1460 unsigned long *prate
)
1464 for (i
= ARRAY_SIZE(ds3231_clk_sqw_rates
) - 1; i
>= 0; i
--) {
1465 if (ds3231_clk_sqw_rates
[i
] <= rate
)
1466 return ds3231_clk_sqw_rates
[i
];
1472 static int ds3231_clk_sqw_set_rate(struct clk_hw
*hw
, unsigned long rate
,
1473 unsigned long parent_rate
)
1475 struct ds1307
*ds1307
= clk_sqw_to_ds1307(hw
);
1479 for (rate_sel
= 0; rate_sel
< ARRAY_SIZE(ds3231_clk_sqw_rates
);
1481 if (ds3231_clk_sqw_rates
[rate_sel
] == rate
)
1485 if (rate_sel
== ARRAY_SIZE(ds3231_clk_sqw_rates
))
1489 control
|= DS1337_BIT_RS1
;
1491 control
|= DS1337_BIT_RS2
;
1493 return ds1337_write_control(ds1307
, DS1337_BIT_RS1
| DS1337_BIT_RS2
,
1497 static int ds3231_clk_sqw_prepare(struct clk_hw
*hw
)
1499 struct ds1307
*ds1307
= clk_sqw_to_ds1307(hw
);
1501 return ds1337_write_control(ds1307
, DS1337_BIT_INTCN
, 0);
1504 static void ds3231_clk_sqw_unprepare(struct clk_hw
*hw
)
1506 struct ds1307
*ds1307
= clk_sqw_to_ds1307(hw
);
1508 ds1337_write_control(ds1307
, DS1337_BIT_INTCN
, DS1337_BIT_INTCN
);
1511 static int ds3231_clk_sqw_is_prepared(struct clk_hw
*hw
)
1513 struct ds1307
*ds1307
= clk_sqw_to_ds1307(hw
);
1516 ret
= regmap_read(ds1307
->regmap
, DS1337_REG_CONTROL
, &control
);
1520 return !(control
& DS1337_BIT_INTCN
);
1523 static const struct clk_ops ds3231_clk_sqw_ops
= {
1524 .prepare
= ds3231_clk_sqw_prepare
,
1525 .unprepare
= ds3231_clk_sqw_unprepare
,
1526 .is_prepared
= ds3231_clk_sqw_is_prepared
,
1527 .recalc_rate
= ds3231_clk_sqw_recalc_rate
,
1528 .round_rate
= ds3231_clk_sqw_round_rate
,
1529 .set_rate
= ds3231_clk_sqw_set_rate
,
1532 static unsigned long ds3231_clk_32khz_recalc_rate(struct clk_hw
*hw
,
1533 unsigned long parent_rate
)
1538 static int ds3231_clk_32khz_control(struct ds1307
*ds1307
, bool enable
)
1540 struct mutex
*lock
= &ds1307
->rtc
->ops_lock
;
1544 ret
= regmap_update_bits(ds1307
->regmap
, DS1337_REG_STATUS
,
1546 enable
? DS3231_BIT_EN32KHZ
: 0);
1552 static int ds3231_clk_32khz_prepare(struct clk_hw
*hw
)
1554 struct ds1307
*ds1307
= clk_32khz_to_ds1307(hw
);
1556 return ds3231_clk_32khz_control(ds1307
, true);
1559 static void ds3231_clk_32khz_unprepare(struct clk_hw
*hw
)
1561 struct ds1307
*ds1307
= clk_32khz_to_ds1307(hw
);
1563 ds3231_clk_32khz_control(ds1307
, false);
1566 static int ds3231_clk_32khz_is_prepared(struct clk_hw
*hw
)
1568 struct ds1307
*ds1307
= clk_32khz_to_ds1307(hw
);
1571 ret
= regmap_read(ds1307
->regmap
, DS1337_REG_STATUS
, &status
);
1575 return !!(status
& DS3231_BIT_EN32KHZ
);
1578 static const struct clk_ops ds3231_clk_32khz_ops
= {
1579 .prepare
= ds3231_clk_32khz_prepare
,
1580 .unprepare
= ds3231_clk_32khz_unprepare
,
1581 .is_prepared
= ds3231_clk_32khz_is_prepared
,
1582 .recalc_rate
= ds3231_clk_32khz_recalc_rate
,
1585 static const char *ds3231_clks_names
[] = {
1586 [DS3231_CLK_SQW
] = "ds3231_clk_sqw",
1587 [DS3231_CLK_32KHZ
] = "ds3231_clk_32khz",
1590 static struct clk_init_data ds3231_clks_init
[] = {
1591 [DS3231_CLK_SQW
] = {
1592 .ops
= &ds3231_clk_sqw_ops
,
1594 [DS3231_CLK_32KHZ
] = {
1595 .ops
= &ds3231_clk_32khz_ops
,
1599 static int ds3231_clks_register(struct ds1307
*ds1307
)
1601 struct device_node
*node
= ds1307
->dev
->of_node
;
1602 struct clk_onecell_data
*onecell
;
1605 onecell
= devm_kzalloc(ds1307
->dev
, sizeof(*onecell
), GFP_KERNEL
);
1609 onecell
->clk_num
= ARRAY_SIZE(ds3231_clks_init
);
1610 onecell
->clks
= devm_kcalloc(ds1307
->dev
, onecell
->clk_num
,
1611 sizeof(onecell
->clks
[0]), GFP_KERNEL
);
1615 /* optional override of the clockname */
1616 device_property_read_string_array(ds1307
->dev
, "clock-output-names",
1618 ARRAY_SIZE(ds3231_clks_names
));
1620 for (i
= 0; i
< ARRAY_SIZE(ds3231_clks_init
); i
++) {
1621 struct clk_init_data init
= ds3231_clks_init
[i
];
1624 * Interrupt signal due to alarm conditions and square-wave
1625 * output share same pin, so don't initialize both.
1627 if (i
== DS3231_CLK_SQW
&& test_bit(RTC_FEATURE_ALARM
, ds1307
->rtc
->features
))
1630 init
.name
= ds3231_clks_names
[i
];
1631 ds1307
->clks
[i
].init
= &init
;
1633 onecell
->clks
[i
] = devm_clk_register(ds1307
->dev
,
1635 if (IS_ERR(onecell
->clks
[i
]))
1636 return PTR_ERR(onecell
->clks
[i
]);
1640 of_clk_add_provider(node
, of_clk_src_onecell_get
, onecell
);
1645 static void ds1307_clks_register(struct ds1307
*ds1307
)
1649 if (ds1307
->type
!= ds_3231
)
1652 ret
= ds3231_clks_register(ds1307
);
1654 dev_warn(ds1307
->dev
, "unable to register clock device %d\n",
1661 static void ds1307_clks_register(struct ds1307
*ds1307
)
1665 #endif /* CONFIG_COMMON_CLK */
1667 #ifdef CONFIG_WATCHDOG_CORE
1668 static const struct watchdog_info ds1388_wdt_info
= {
1669 .options
= WDIOF_SETTIMEOUT
| WDIOF_KEEPALIVEPING
| WDIOF_MAGICCLOSE
,
1670 .identity
= "DS1388 watchdog",
1673 static const struct watchdog_ops ds1388_wdt_ops
= {
1674 .owner
= THIS_MODULE
,
1675 .start
= ds1388_wdt_start
,
1676 .stop
= ds1388_wdt_stop
,
1677 .ping
= ds1388_wdt_ping
,
1678 .set_timeout
= ds1388_wdt_set_timeout
,
1682 static void ds1307_wdt_register(struct ds1307
*ds1307
)
1684 struct watchdog_device
*wdt
;
1688 if (ds1307
->type
!= ds_1388
)
1691 wdt
= devm_kzalloc(ds1307
->dev
, sizeof(*wdt
), GFP_KERNEL
);
1695 err
= regmap_read(ds1307
->regmap
, DS1388_REG_FLAG
, &val
);
1696 if (!err
&& val
& DS1388_BIT_WF
)
1697 wdt
->bootstatus
= WDIOF_CARDRESET
;
1699 wdt
->info
= &ds1388_wdt_info
;
1700 wdt
->ops
= &ds1388_wdt_ops
;
1702 wdt
->max_timeout
= 99;
1703 wdt
->min_timeout
= 1;
1705 watchdog_init_timeout(wdt
, 0, ds1307
->dev
);
1706 watchdog_set_drvdata(wdt
, ds1307
);
1707 devm_watchdog_register_device(ds1307
->dev
, wdt
);
1710 static void ds1307_wdt_register(struct ds1307
*ds1307
)
1713 #endif /* CONFIG_WATCHDOG_CORE */
1715 static const struct regmap_config regmap_config
= {
1720 static int ds1307_probe(struct i2c_client
*client
)
1722 const struct i2c_device_id
*id
= i2c_client_get_device_id(client
);
1723 struct ds1307
*ds1307
;
1727 const struct chip_desc
*chip
;
1729 bool ds1307_can_wakeup_device
= false;
1730 unsigned char regs
[8];
1731 struct ds1307_platform_data
*pdata
= dev_get_platdata(&client
->dev
);
1732 u8 trickle_charger_setup
= 0;
1734 ds1307
= devm_kzalloc(&client
->dev
, sizeof(struct ds1307
), GFP_KERNEL
);
1738 dev_set_drvdata(&client
->dev
, ds1307
);
1739 ds1307
->dev
= &client
->dev
;
1740 ds1307
->name
= client
->name
;
1742 ds1307
->regmap
= devm_regmap_init_i2c(client
, ®map_config
);
1743 if (IS_ERR(ds1307
->regmap
)) {
1744 dev_err(ds1307
->dev
, "regmap allocation failed\n");
1745 return PTR_ERR(ds1307
->regmap
);
1748 i2c_set_clientdata(client
, ds1307
);
1750 match
= device_get_match_data(&client
->dev
);
1752 ds1307
->type
= (uintptr_t)match
;
1753 chip
= &chips
[ds1307
->type
];
1755 chip
= &chips
[id
->driver_data
];
1756 ds1307
->type
= id
->driver_data
;
1761 want_irq
= client
->irq
> 0 && chip
->alarm
;
1764 trickle_charger_setup
= ds1307_trickle_init(ds1307
, chip
);
1765 else if (pdata
->trickle_charger_setup
)
1766 trickle_charger_setup
= pdata
->trickle_charger_setup
;
1768 if (trickle_charger_setup
&& chip
->trickle_charger_reg
) {
1769 dev_dbg(ds1307
->dev
,
1770 "writing trickle charger info 0x%x to 0x%x\n",
1771 trickle_charger_setup
, chip
->trickle_charger_reg
);
1772 regmap_write(ds1307
->regmap
, chip
->trickle_charger_reg
,
1773 trickle_charger_setup
);
1777 * For devices with no IRQ directly connected to the SoC, the RTC chip
1778 * can be forced as a wakeup source by stating that explicitly in
1779 * the device's .dts file using the "wakeup-source" boolean property.
1780 * If the "wakeup-source" property is set, don't request an IRQ.
1781 * This will guarantee the 'wakealarm' sysfs entry is available on the device,
1782 * if supported by the RTC.
1784 if (chip
->alarm
&& device_property_read_bool(&client
->dev
, "wakeup-source"))
1785 ds1307_can_wakeup_device
= true;
1787 switch (ds1307
->type
) {
1792 /* get registers that the "rtc" read below won't read... */
1793 err
= regmap_bulk_read(ds1307
->regmap
, DS1337_REG_CONTROL
,
1796 dev_dbg(ds1307
->dev
, "read error %d\n", err
);
1800 /* oscillator off? turn it on, so clock can tick. */
1801 if (regs
[0] & DS1337_BIT_nEOSC
)
1802 regs
[0] &= ~DS1337_BIT_nEOSC
;
1805 * Using IRQ or defined as wakeup-source?
1806 * Disable the square wave and both alarms.
1807 * For some variants, be sure alarms can trigger when we're
1808 * running on Vbackup (BBSQI/BBSQW)
1810 if (want_irq
|| ds1307_can_wakeup_device
) {
1811 regs
[0] |= DS1337_BIT_INTCN
| chip
->bbsqi_bit
;
1812 regs
[0] &= ~(DS1337_BIT_A2IE
| DS1337_BIT_A1IE
);
1815 regmap_write(ds1307
->regmap
, DS1337_REG_CONTROL
,
1818 /* oscillator fault? clear flag, and warn */
1819 if (regs
[1] & DS1337_BIT_OSF
) {
1820 regmap_write(ds1307
->regmap
, DS1337_REG_STATUS
,
1821 regs
[1] & ~DS1337_BIT_OSF
);
1822 dev_warn(ds1307
->dev
, "SET TIME!\n");
1827 err
= regmap_bulk_read(ds1307
->regmap
,
1828 RX8025_REG_CTRL1
<< 4 | 0x08, regs
, 2);
1830 dev_dbg(ds1307
->dev
, "read error %d\n", err
);
1834 /* oscillator off? turn it on, so clock can tick. */
1835 if (!(regs
[1] & RX8025_BIT_XST
)) {
1836 regs
[1] |= RX8025_BIT_XST
;
1837 regmap_write(ds1307
->regmap
,
1838 RX8025_REG_CTRL2
<< 4 | 0x08,
1840 dev_warn(ds1307
->dev
,
1841 "oscillator stop detected - SET TIME!\n");
1844 if (regs
[1] & RX8025_BIT_PON
) {
1845 regs
[1] &= ~RX8025_BIT_PON
;
1846 regmap_write(ds1307
->regmap
,
1847 RX8025_REG_CTRL2
<< 4 | 0x08,
1849 dev_warn(ds1307
->dev
, "power-on detected\n");
1852 if (regs
[1] & RX8025_BIT_VDET
) {
1853 regs
[1] &= ~RX8025_BIT_VDET
;
1854 regmap_write(ds1307
->regmap
,
1855 RX8025_REG_CTRL2
<< 4 | 0x08,
1857 dev_warn(ds1307
->dev
, "voltage drop detected\n");
1860 /* make sure we are running in 24hour mode */
1861 if (!(regs
[0] & RX8025_BIT_2412
)) {
1864 /* switch to 24 hour mode */
1865 regmap_write(ds1307
->regmap
,
1866 RX8025_REG_CTRL1
<< 4 | 0x08,
1867 regs
[0] | RX8025_BIT_2412
);
1869 err
= regmap_bulk_read(ds1307
->regmap
,
1870 RX8025_REG_CTRL1
<< 4 | 0x08,
1873 dev_dbg(ds1307
->dev
, "read error %d\n", err
);
1878 hour
= bcd2bin(regs
[DS1307_REG_HOUR
]);
1881 if (regs
[DS1307_REG_HOUR
] & DS1307_BIT_PM
)
1884 regmap_write(ds1307
->regmap
,
1885 DS1307_REG_HOUR
<< 4 | 0x08, hour
);
1889 err
= regmap_read(ds1307
->regmap
, DS1388_REG_CONTROL
, &tmp
);
1891 dev_dbg(ds1307
->dev
, "read error %d\n", err
);
1895 /* oscillator off? turn it on, so clock can tick. */
1896 if (tmp
& DS1388_BIT_nEOSC
) {
1897 tmp
&= ~DS1388_BIT_nEOSC
;
1898 regmap_write(ds1307
->regmap
, DS1388_REG_CONTROL
, tmp
);
1905 /* read RTC registers */
1906 err
= regmap_bulk_read(ds1307
->regmap
, chip
->offset
, regs
,
1909 dev_dbg(ds1307
->dev
, "read error %d\n", err
);
1913 if (ds1307
->type
== mcp794xx
&&
1914 !(regs
[DS1307_REG_WDAY
] & MCP794XX_BIT_VBATEN
)) {
1915 regmap_write(ds1307
->regmap
, DS1307_REG_WDAY
,
1916 regs
[DS1307_REG_WDAY
] |
1917 MCP794XX_BIT_VBATEN
);
1920 tmp
= regs
[DS1307_REG_HOUR
];
1921 switch (ds1307
->type
) {
1927 * NOTE: ignores century bits; fix before deploying
1928 * systems that will run through year 2100.
1934 if (!(tmp
& DS1307_BIT_12HR
))
1938 * Be sure we're in 24 hour mode. Multi-master systems
1941 tmp
= bcd2bin(tmp
& 0x1f);
1944 if (regs
[DS1307_REG_HOUR
] & DS1307_BIT_PM
)
1946 regmap_write(ds1307
->regmap
, chip
->offset
+ DS1307_REG_HOUR
,
1950 ds1307
->rtc
= devm_rtc_allocate_device(ds1307
->dev
);
1951 if (IS_ERR(ds1307
->rtc
))
1952 return PTR_ERR(ds1307
->rtc
);
1954 if (want_irq
|| ds1307_can_wakeup_device
)
1955 device_set_wakeup_capable(ds1307
->dev
, true);
1957 clear_bit(RTC_FEATURE_ALARM
, ds1307
->rtc
->features
);
1959 if (ds1307_can_wakeup_device
&& !want_irq
) {
1960 dev_info(ds1307
->dev
,
1961 "'wakeup-source' is set, request for an IRQ is disabled!\n");
1962 /* We cannot support UIE mode if we do not have an IRQ line */
1963 clear_bit(RTC_FEATURE_UPDATE_INTERRUPT
, ds1307
->rtc
->features
);
1967 err
= devm_request_threaded_irq(ds1307
->dev
, client
->irq
, NULL
,
1968 chip
->irq_handler
?: ds1307_irq
,
1969 IRQF_SHARED
| IRQF_ONESHOT
,
1970 ds1307
->name
, ds1307
);
1973 device_set_wakeup_capable(ds1307
->dev
, false);
1974 clear_bit(RTC_FEATURE_ALARM
, ds1307
->rtc
->features
);
1975 dev_err(ds1307
->dev
, "unable to request IRQ!\n");
1977 dev_dbg(ds1307
->dev
, "got IRQ %d\n", client
->irq
);
1981 ds1307
->rtc
->ops
= chip
->rtc_ops
?: &ds13xx_rtc_ops
;
1982 err
= ds1307_add_frequency_test(ds1307
);
1986 err
= devm_rtc_register_device(ds1307
->rtc
);
1990 if (chip
->nvram_size
) {
1991 struct nvmem_config nvmem_cfg
= {
1992 .name
= "ds1307_nvram",
1995 .size
= chip
->nvram_size
,
1996 .reg_read
= ds1307_nvram_read
,
1997 .reg_write
= ds1307_nvram_write
,
2001 devm_rtc_nvmem_register(ds1307
->rtc
, &nvmem_cfg
);
2004 ds1307_hwmon_register(ds1307
);
2005 ds1307_clks_register(ds1307
);
2006 ds1307_wdt_register(ds1307
);
2014 static struct i2c_driver ds1307_driver
= {
2016 .name
= "rtc-ds1307",
2017 .of_match_table
= ds1307_of_match
,
2019 .probe
= ds1307_probe
,
2020 .id_table
= ds1307_id
,
2023 module_i2c_driver(ds1307_driver
);
2025 MODULE_DESCRIPTION("RTC driver for DS1307 and similar chips");
2026 MODULE_LICENSE("GPL");