2 * Micro Crystal RV-3029 rtc class driver
4 * Author: Gregory Hermant <gregory.hermant@calao-systems.com>
5 * Michael Buesch <m@bues.ch>
7 * based on previously existing rtc class drivers
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
15 #include <linux/module.h>
16 #include <linux/i2c.h>
17 #include <linux/bcd.h>
18 #include <linux/rtc.h>
19 #include <linux/delay.h>
25 #define RV3029_ONOFF_CTRL 0x00
26 #define RV3029_ONOFF_CTRL_WE BIT(0)
27 #define RV3029_ONOFF_CTRL_TE BIT(1)
28 #define RV3029_ONOFF_CTRL_TAR BIT(2)
29 #define RV3029_ONOFF_CTRL_EERE BIT(3)
30 #define RV3029_ONOFF_CTRL_SRON BIT(4)
31 #define RV3029_ONOFF_CTRL_TD0 BIT(5)
32 #define RV3029_ONOFF_CTRL_TD1 BIT(6)
33 #define RV3029_ONOFF_CTRL_CLKINT BIT(7)
34 #define RV3029_IRQ_CTRL 0x01
35 #define RV3029_IRQ_CTRL_AIE BIT(0)
36 #define RV3029_IRQ_CTRL_TIE BIT(1)
37 #define RV3029_IRQ_CTRL_V1IE BIT(2)
38 #define RV3029_IRQ_CTRL_V2IE BIT(3)
39 #define RV3029_IRQ_CTRL_SRIE BIT(4)
40 #define RV3029_IRQ_FLAGS 0x02
41 #define RV3029_IRQ_FLAGS_AF BIT(0)
42 #define RV3029_IRQ_FLAGS_TF BIT(1)
43 #define RV3029_IRQ_FLAGS_V1IF BIT(2)
44 #define RV3029_IRQ_FLAGS_V2IF BIT(3)
45 #define RV3029_IRQ_FLAGS_SRF BIT(4)
46 #define RV3029_STATUS 0x03
47 #define RV3029_STATUS_VLOW1 BIT(2)
48 #define RV3029_STATUS_VLOW2 BIT(3)
49 #define RV3029_STATUS_SR BIT(4)
50 #define RV3029_STATUS_PON BIT(5)
51 #define RV3029_STATUS_EEBUSY BIT(7)
52 #define RV3029_RST_CTRL 0x04
53 #define RV3029_RST_CTRL_SYSR BIT(4)
54 #define RV3029_CONTROL_SECTION_LEN 0x05
57 #define RV3029_W_SEC 0x08
58 #define RV3029_W_MINUTES 0x09
59 #define RV3029_W_HOURS 0x0A
60 #define RV3029_REG_HR_12_24 BIT(6) /* 24h/12h mode */
61 #define RV3029_REG_HR_PM BIT(5) /* PM/AM bit in 12h mode */
62 #define RV3029_W_DATE 0x0B
63 #define RV3029_W_DAYS 0x0C
64 #define RV3029_W_MONTHS 0x0D
65 #define RV3029_W_YEARS 0x0E
66 #define RV3029_WATCH_SECTION_LEN 0x07
69 #define RV3029_A_SC 0x10
70 #define RV3029_A_MN 0x11
71 #define RV3029_A_HR 0x12
72 #define RV3029_A_DT 0x13
73 #define RV3029_A_DW 0x14
74 #define RV3029_A_MO 0x15
75 #define RV3029_A_YR 0x16
76 #define RV3029_ALARM_SECTION_LEN 0x07
79 #define RV3029_TIMER_LOW 0x18
80 #define RV3029_TIMER_HIGH 0x19
82 /* temperature section */
83 #define RV3029_TEMP_PAGE 0x20
85 /* eeprom data section */
86 #define RV3029_E2P_EEDATA1 0x28
87 #define RV3029_E2P_EEDATA2 0x29
88 #define RV3029_E2PDATA_SECTION_LEN 0x02
90 /* eeprom control section */
91 #define RV3029_CONTROL_E2P_EECTRL 0x30
92 #define RV3029_EECTRL_THP BIT(0) /* temp scan interval */
93 #define RV3029_EECTRL_THE BIT(1) /* thermometer enable */
94 #define RV3029_EECTRL_FD0 BIT(2) /* CLKOUT */
95 #define RV3029_EECTRL_FD1 BIT(3) /* CLKOUT */
96 #define RV3029_TRICKLE_1K BIT(4) /* 1.5K resistance */
97 #define RV3029_TRICKLE_5K BIT(5) /* 5K resistance */
98 #define RV3029_TRICKLE_20K BIT(6) /* 20K resistance */
99 #define RV3029_TRICKLE_80K BIT(7) /* 80K resistance */
100 #define RV3029_TRICKLE_MASK (RV3029_TRICKLE_1K |\
102 RV3029_TRICKLE_20K |\
104 #define RV3029_TRICKLE_SHIFT 4
105 #define RV3029_CONTROL_E2P_XOFFS 0x31 /* XTAL offset */
106 #define RV3029_CONTROL_E2P_XOFFS_SIGN BIT(7) /* Sign: 1->pos, 0->neg */
107 #define RV3029_CONTROL_E2P_QCOEF 0x32 /* XTAL temp drift coef */
108 #define RV3029_CONTROL_E2P_TURNOVER 0x33 /* XTAL turnover temp (in *C) */
109 #define RV3029_CONTROL_E2P_TOV_MASK 0x3F /* XTAL turnover temp mask */
111 /* user ram section */
112 #define RV3029_USR1_RAM_PAGE 0x38
113 #define RV3029_USR1_SECTION_LEN 0x04
114 #define RV3029_USR2_RAM_PAGE 0x3C
115 #define RV3029_USR2_SECTION_LEN 0x04
118 rv3029_i2c_read_regs(struct i2c_client
*client
, u8 reg
, u8
*buf
,
123 if ((reg
> RV3029_USR1_RAM_PAGE
+ 7) ||
124 (reg
+ len
> RV3029_USR1_RAM_PAGE
+ 8))
127 ret
= i2c_smbus_read_i2c_block_data(client
, reg
, len
, buf
);
136 rv3029_i2c_write_regs(struct i2c_client
*client
, u8 reg
, u8
const buf
[],
139 if ((reg
> RV3029_USR1_RAM_PAGE
+ 7) ||
140 (reg
+ len
> RV3029_USR1_RAM_PAGE
+ 8))
143 return i2c_smbus_write_i2c_block_data(client
, reg
, len
, buf
);
147 rv3029_i2c_update_bits(struct i2c_client
*client
, u8 reg
, u8 mask
, u8 set
)
152 ret
= rv3029_i2c_read_regs(client
, reg
, &buf
, 1);
157 ret
= rv3029_i2c_write_regs(client
, reg
, &buf
, 1);
165 rv3029_i2c_get_sr(struct i2c_client
*client
, u8
*buf
)
167 int ret
= rv3029_i2c_read_regs(client
, RV3029_STATUS
, buf
, 1);
171 dev_dbg(&client
->dev
, "status = 0x%.2x (%d)\n", buf
[0], buf
[0]);
176 rv3029_i2c_set_sr(struct i2c_client
*client
, u8 val
)
182 sr
= rv3029_i2c_write_regs(client
, RV3029_STATUS
, buf
, 1);
183 dev_dbg(&client
->dev
, "status = 0x%.2x (%d)\n", buf
[0], buf
[0]);
189 static int rv3029_eeprom_busywait(struct i2c_client
*client
)
194 for (i
= 100; i
> 0; i
--) {
195 ret
= rv3029_i2c_get_sr(client
, &sr
);
198 if (!(sr
& RV3029_STATUS_EEBUSY
))
200 usleep_range(1000, 10000);
203 dev_err(&client
->dev
, "EEPROM busy wait timeout.\n");
210 static int rv3029_eeprom_exit(struct i2c_client
*client
)
212 /* Re-enable eeprom refresh */
213 return rv3029_i2c_update_bits(client
, RV3029_ONOFF_CTRL
,
214 RV3029_ONOFF_CTRL_EERE
,
215 RV3029_ONOFF_CTRL_EERE
);
218 static int rv3029_eeprom_enter(struct i2c_client
*client
)
223 /* Check whether we are in the allowed voltage range. */
224 ret
= rv3029_i2c_get_sr(client
, &sr
);
227 if (sr
& (RV3029_STATUS_VLOW1
| RV3029_STATUS_VLOW2
)) {
228 /* We clear the bits and retry once just in case
229 * we had a brown out in early startup.
231 sr
&= ~RV3029_STATUS_VLOW1
;
232 sr
&= ~RV3029_STATUS_VLOW2
;
233 ret
= rv3029_i2c_set_sr(client
, sr
);
236 usleep_range(1000, 10000);
237 ret
= rv3029_i2c_get_sr(client
, &sr
);
240 if (sr
& (RV3029_STATUS_VLOW1
| RV3029_STATUS_VLOW2
)) {
241 dev_err(&client
->dev
,
242 "Supply voltage is too low to safely access the EEPROM.\n");
247 /* Disable eeprom refresh. */
248 ret
= rv3029_i2c_update_bits(client
, RV3029_ONOFF_CTRL
,
249 RV3029_ONOFF_CTRL_EERE
, 0);
253 /* Wait for any previous eeprom accesses to finish. */
254 ret
= rv3029_eeprom_busywait(client
);
256 rv3029_eeprom_exit(client
);
261 static int rv3029_eeprom_read(struct i2c_client
*client
, u8 reg
,
262 u8 buf
[], size_t len
)
266 err
= rv3029_eeprom_enter(client
);
270 ret
= rv3029_i2c_read_regs(client
, reg
, buf
, len
);
272 err
= rv3029_eeprom_exit(client
);
279 static int rv3029_eeprom_write(struct i2c_client
*client
, u8 reg
,
280 u8
const buf
[], size_t len
)
286 err
= rv3029_eeprom_enter(client
);
290 for (i
= 0; i
< len
; i
++, reg
++) {
291 ret
= rv3029_i2c_read_regs(client
, reg
, &tmp
, 1);
295 ret
= rv3029_i2c_write_regs(client
, reg
, &buf
[i
], 1);
299 ret
= rv3029_eeprom_busywait(client
);
304 err
= rv3029_eeprom_exit(client
);
311 static int rv3029_eeprom_update_bits(struct i2c_client
*client
,
312 u8 reg
, u8 mask
, u8 set
)
317 ret
= rv3029_eeprom_read(client
, reg
, &buf
, 1);
322 ret
= rv3029_eeprom_write(client
, reg
, &buf
, 1);
330 rv3029_i2c_read_time(struct i2c_client
*client
, struct rtc_time
*tm
)
334 u8 regs
[RV3029_WATCH_SECTION_LEN
] = { 0, };
336 ret
= rv3029_i2c_get_sr(client
, buf
);
338 dev_err(&client
->dev
, "%s: reading SR failed\n", __func__
);
342 ret
= rv3029_i2c_read_regs(client
, RV3029_W_SEC
, regs
,
343 RV3029_WATCH_SECTION_LEN
);
345 dev_err(&client
->dev
, "%s: reading RTC section failed\n",
350 tm
->tm_sec
= bcd2bin(regs
[RV3029_W_SEC
-RV3029_W_SEC
]);
351 tm
->tm_min
= bcd2bin(regs
[RV3029_W_MINUTES
-RV3029_W_SEC
]);
353 /* HR field has a more complex interpretation */
355 const u8 _hr
= regs
[RV3029_W_HOURS
-RV3029_W_SEC
];
357 if (_hr
& RV3029_REG_HR_12_24
) {
359 tm
->tm_hour
= bcd2bin(_hr
& 0x1f);
360 if (_hr
& RV3029_REG_HR_PM
) /* PM flag set */
362 } else /* 24h format */
363 tm
->tm_hour
= bcd2bin(_hr
& 0x3f);
366 tm
->tm_mday
= bcd2bin(regs
[RV3029_W_DATE
-RV3029_W_SEC
]);
367 tm
->tm_mon
= bcd2bin(regs
[RV3029_W_MONTHS
-RV3029_W_SEC
]) - 1;
368 tm
->tm_year
= bcd2bin(regs
[RV3029_W_YEARS
-RV3029_W_SEC
]) + 100;
369 tm
->tm_wday
= bcd2bin(regs
[RV3029_W_DAYS
-RV3029_W_SEC
]) - 1;
374 static int rv3029_rtc_read_time(struct device
*dev
, struct rtc_time
*tm
)
376 return rv3029_i2c_read_time(to_i2c_client(dev
), tm
);
380 rv3029_i2c_read_alarm(struct i2c_client
*client
, struct rtc_wkalrm
*alarm
)
382 struct rtc_time
*const tm
= &alarm
->time
;
386 ret
= rv3029_i2c_get_sr(client
, regs
);
388 dev_err(&client
->dev
, "%s: reading SR failed\n", __func__
);
392 ret
= rv3029_i2c_read_regs(client
, RV3029_A_SC
, regs
,
393 RV3029_ALARM_SECTION_LEN
);
396 dev_err(&client
->dev
, "%s: reading alarm section failed\n",
401 tm
->tm_sec
= bcd2bin(regs
[RV3029_A_SC
-RV3029_A_SC
] & 0x7f);
402 tm
->tm_min
= bcd2bin(regs
[RV3029_A_MN
-RV3029_A_SC
] & 0x7f);
403 tm
->tm_hour
= bcd2bin(regs
[RV3029_A_HR
-RV3029_A_SC
] & 0x3f);
404 tm
->tm_mday
= bcd2bin(regs
[RV3029_A_DT
-RV3029_A_SC
] & 0x3f);
405 tm
->tm_mon
= bcd2bin(regs
[RV3029_A_MO
-RV3029_A_SC
] & 0x1f) - 1;
406 tm
->tm_year
= bcd2bin(regs
[RV3029_A_YR
-RV3029_A_SC
] & 0x7f) + 100;
407 tm
->tm_wday
= bcd2bin(regs
[RV3029_A_DW
-RV3029_A_SC
] & 0x07) - 1;
413 rv3029_rtc_read_alarm(struct device
*dev
, struct rtc_wkalrm
*alarm
)
415 return rv3029_i2c_read_alarm(to_i2c_client(dev
), alarm
);
418 static int rv3029_rtc_i2c_alarm_set_irq(struct i2c_client
*client
,
423 /* enable/disable AIE irq */
424 ret
= rv3029_i2c_update_bits(client
, RV3029_IRQ_CTRL
,
426 (enable
? RV3029_IRQ_CTRL_AIE
: 0));
428 dev_err(&client
->dev
, "can't update INT reg\n");
435 static int rv3029_rtc_i2c_set_alarm(struct i2c_client
*client
,
436 struct rtc_wkalrm
*alarm
)
438 struct rtc_time
*const tm
= &alarm
->time
;
443 * The clock has an 8 bit wide bcd-coded register (they never learn)
444 * for the year. tm_year is an offset from 1900 and we are interested
445 * in the 2000-2099 range, so any value less than 100 is invalid.
447 if (tm
->tm_year
< 100)
450 ret
= rv3029_i2c_get_sr(client
, regs
);
452 dev_err(&client
->dev
, "%s: reading SR failed\n", __func__
);
455 regs
[RV3029_A_SC
-RV3029_A_SC
] = bin2bcd(tm
->tm_sec
& 0x7f);
456 regs
[RV3029_A_MN
-RV3029_A_SC
] = bin2bcd(tm
->tm_min
& 0x7f);
457 regs
[RV3029_A_HR
-RV3029_A_SC
] = bin2bcd(tm
->tm_hour
& 0x3f);
458 regs
[RV3029_A_DT
-RV3029_A_SC
] = bin2bcd(tm
->tm_mday
& 0x3f);
459 regs
[RV3029_A_MO
-RV3029_A_SC
] = bin2bcd((tm
->tm_mon
& 0x1f) - 1);
460 regs
[RV3029_A_DW
-RV3029_A_SC
] = bin2bcd((tm
->tm_wday
& 7) - 1);
461 regs
[RV3029_A_YR
-RV3029_A_SC
] = bin2bcd((tm
->tm_year
& 0x7f) - 100);
463 ret
= rv3029_i2c_write_regs(client
, RV3029_A_SC
, regs
,
464 RV3029_ALARM_SECTION_LEN
);
468 if (alarm
->enabled
) {
470 ret
= rv3029_i2c_update_bits(client
, RV3029_IRQ_FLAGS
,
471 RV3029_IRQ_FLAGS_AF
, 0);
473 dev_err(&client
->dev
, "can't clear alarm flag\n");
477 ret
= rv3029_rtc_i2c_alarm_set_irq(client
, 1);
481 dev_dbg(&client
->dev
, "alarm IRQ armed\n");
483 /* disable AIE irq */
484 ret
= rv3029_rtc_i2c_alarm_set_irq(client
, 0);
488 dev_dbg(&client
->dev
, "alarm IRQ disabled\n");
494 static int rv3029_rtc_set_alarm(struct device
*dev
, struct rtc_wkalrm
*alarm
)
496 return rv3029_rtc_i2c_set_alarm(to_i2c_client(dev
), alarm
);
500 rv3029_i2c_set_time(struct i2c_client
*client
, struct rtc_time
const *tm
)
506 * The clock has an 8 bit wide bcd-coded register (they never learn)
507 * for the year. tm_year is an offset from 1900 and we are interested
508 * in the 2000-2099 range, so any value less than 100 is invalid.
510 if (tm
->tm_year
< 100)
513 regs
[RV3029_W_SEC
-RV3029_W_SEC
] = bin2bcd(tm
->tm_sec
);
514 regs
[RV3029_W_MINUTES
-RV3029_W_SEC
] = bin2bcd(tm
->tm_min
);
515 regs
[RV3029_W_HOURS
-RV3029_W_SEC
] = bin2bcd(tm
->tm_hour
);
516 regs
[RV3029_W_DATE
-RV3029_W_SEC
] = bin2bcd(tm
->tm_mday
);
517 regs
[RV3029_W_MONTHS
-RV3029_W_SEC
] = bin2bcd(tm
->tm_mon
+1);
518 regs
[RV3029_W_DAYS
-RV3029_W_SEC
] = bin2bcd((tm
->tm_wday
& 7)+1);
519 regs
[RV3029_W_YEARS
-RV3029_W_SEC
] = bin2bcd(tm
->tm_year
- 100);
521 ret
= rv3029_i2c_write_regs(client
, RV3029_W_SEC
, regs
,
522 RV3029_WATCH_SECTION_LEN
);
526 ret
= rv3029_i2c_get_sr(client
, regs
);
528 dev_err(&client
->dev
, "%s: reading SR failed\n", __func__
);
532 ret
= rv3029_i2c_set_sr(client
, (regs
[0] & ~RV3029_STATUS_PON
));
534 dev_err(&client
->dev
, "%s: reading SR failed\n", __func__
);
541 static int rv3029_rtc_set_time(struct device
*dev
, struct rtc_time
*tm
)
543 return rv3029_i2c_set_time(to_i2c_client(dev
), tm
);
546 static const struct rv3029_trickle_tab_elem
{
547 u32 r
; /* resistance in ohms */
548 u8 conf
; /* trickle config bits */
549 } rv3029_trickle_tab
[] = {
552 .conf
= RV3029_TRICKLE_1K
| RV3029_TRICKLE_5K
|
553 RV3029_TRICKLE_20K
| RV3029_TRICKLE_80K
,
556 .conf
= RV3029_TRICKLE_1K
| RV3029_TRICKLE_5K
|
560 .conf
= RV3029_TRICKLE_1K
| RV3029_TRICKLE_5K
|
564 .conf
= RV3029_TRICKLE_1K
| RV3029_TRICKLE_5K
,
567 .conf
= RV3029_TRICKLE_1K
| RV3029_TRICKLE_20K
|
571 .conf
= RV3029_TRICKLE_1K
| RV3029_TRICKLE_20K
,
574 .conf
= RV3029_TRICKLE_1K
| RV3029_TRICKLE_80K
,
577 .conf
= RV3029_TRICKLE_1K
,
580 .conf
= RV3029_TRICKLE_5K
| RV3029_TRICKLE_20K
|
584 .conf
= RV3029_TRICKLE_5K
| RV3029_TRICKLE_20K
,
587 .conf
= RV3029_TRICKLE_5K
| RV3029_TRICKLE_80K
,
590 .conf
= RV3029_TRICKLE_5K
,
593 .conf
= RV3029_TRICKLE_20K
| RV3029_TRICKLE_80K
,
596 .conf
= RV3029_TRICKLE_20K
,
599 .conf
= RV3029_TRICKLE_80K
,
603 static void rv3029_trickle_config(struct i2c_client
*client
)
605 struct device_node
*of_node
= client
->dev
.of_node
;
606 const struct rv3029_trickle_tab_elem
*elem
;
614 /* Configure the trickle charger. */
615 err
= of_property_read_u32(of_node
, "trickle-resistor-ohms", &ohms
);
617 /* Disable trickle charger. */
618 trickle_set_bits
= 0;
620 /* Enable trickle charger. */
621 for (i
= 0; i
< ARRAY_SIZE(rv3029_trickle_tab
); i
++) {
622 elem
= &rv3029_trickle_tab
[i
];
626 trickle_set_bits
= elem
->conf
;
627 dev_info(&client
->dev
,
628 "Trickle charger enabled at %d ohms resistance.\n",
631 err
= rv3029_eeprom_update_bits(client
, RV3029_CONTROL_E2P_EECTRL
,
635 dev_err(&client
->dev
,
636 "Failed to update trickle charger config\n");
640 static const struct rtc_class_ops rv3029_rtc_ops
= {
641 .read_time
= rv3029_rtc_read_time
,
642 .set_time
= rv3029_rtc_set_time
,
643 .read_alarm
= rv3029_rtc_read_alarm
,
644 .set_alarm
= rv3029_rtc_set_alarm
,
647 static struct i2c_device_id rv3029_id
[] = {
652 MODULE_DEVICE_TABLE(i2c
, rv3029_id
);
654 static int rv3029_probe(struct i2c_client
*client
,
655 const struct i2c_device_id
*id
)
657 struct rtc_device
*rtc
;
661 if (!i2c_check_functionality(client
->adapter
, I2C_FUNC_SMBUS_EMUL
))
664 rc
= rv3029_i2c_get_sr(client
, buf
);
666 dev_err(&client
->dev
, "reading status failed\n");
670 rv3029_trickle_config(client
);
672 rtc
= devm_rtc_device_register(&client
->dev
, client
->name
,
673 &rv3029_rtc_ops
, THIS_MODULE
);
678 i2c_set_clientdata(client
, rtc
);
683 static struct i2c_driver rv3029_driver
= {
685 .name
= "rtc-rv3029c2",
687 .probe
= rv3029_probe
,
688 .id_table
= rv3029_id
,
691 module_i2c_driver(rv3029_driver
);
693 MODULE_AUTHOR("Gregory Hermant <gregory.hermant@calao-systems.com>");
694 MODULE_AUTHOR("Michael Buesch <m@bues.ch>");
695 MODULE_DESCRIPTION("Micro Crystal RV3029 RTC driver");
696 MODULE_LICENSE("GPL");