2 * Copyright (c) 2013 Samsung Electronics Co., Ltd
3 * http://www.samsung.com
5 * Copyright (C) 2013 Google, Inc
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
18 #include <linux/module.h>
19 #include <linux/i2c.h>
20 #include <linux/slab.h>
21 #include <linux/bcd.h>
22 #include <linux/bitops.h>
23 #include <linux/regmap.h>
24 #include <linux/rtc.h>
25 #include <linux/delay.h>
26 #include <linux/platform_device.h>
27 #include <linux/mfd/samsung/core.h>
28 #include <linux/mfd/samsung/irq.h>
29 #include <linux/mfd/samsung/rtc.h>
32 * Maximum number of retries for checking changes in UDR field
33 * of S5M_RTC_UDR_CON register (to limit possible endless loop).
35 * After writing to RTC registers (setting time or alarm) read the UDR field
36 * in S5M_RTC_UDR_CON register. UDR is auto-cleared when data have
39 #define UDR_READ_RETRY_CNT 5
43 struct i2c_client *i2c;
44 struct sec_pmic_dev *s5m87xx;
45 struct regmap *regmap;
46 struct rtc_device *rtc_dev;
53 static const struct regmap_config s5m_rtc_regmap_config = {
57 .max_register = S5M_RTC_REG_MAX,
60 static const struct regmap_config s2mps14_rtc_regmap_config = {
64 .max_register = S2MPS_RTC_REG_MAX,
67 static void s5m8767_data_to_tm(u8 *data, struct rtc_time *tm,
70 tm->tm_sec = data[RTC_SEC] & 0x7f;
71 tm->tm_min = data[RTC_MIN] & 0x7f;
73 tm->tm_hour = data[RTC_HOUR] & 0x1f;
75 tm->tm_hour = data[RTC_HOUR] & 0x0f;
76 if (data[RTC_HOUR] & HOUR_PM_MASK)
80 tm->tm_wday = ffs(data[RTC_WEEKDAY] & 0x7f);
81 tm->tm_mday = data[RTC_DATE] & 0x1f;
82 tm->tm_mon = (data[RTC_MONTH] & 0x0f) - 1;
83 tm->tm_year = (data[RTC_YEAR1] & 0x7f) + 100;
88 static int s5m8767_tm_to_data(struct rtc_time *tm, u8 *data)
90 data[RTC_SEC] = tm->tm_sec;
91 data[RTC_MIN] = tm->tm_min;
93 if (tm->tm_hour >= 12)
94 data[RTC_HOUR] = tm->tm_hour | HOUR_PM_MASK;
96 data[RTC_HOUR] = tm->tm_hour & ~HOUR_PM_MASK;
98 data[RTC_WEEKDAY] = 1 << tm->tm_wday;
99 data[RTC_DATE] = tm->tm_mday;
100 data[RTC_MONTH] = tm->tm_mon + 1;
101 data[RTC_YEAR1] = tm->tm_year > 100 ? (tm->tm_year - 100) : 0;
103 if (tm->tm_year < 100) {
104 pr_err("s5m8767 RTC cannot handle the year %d.\n",
113 * Read RTC_UDR_CON register and wait till UDR field is cleared.
114 * This indicates that time/alarm update ended.
116 static inline int s5m8767_wait_for_udr_update(struct s5m_rtc_info *info)
118 int ret, retry = UDR_READ_RETRY_CNT;
122 ret = regmap_read(info->regmap, S5M_RTC_UDR_CON, &data);
123 } while (--retry && (data & S5M_RTC_UDR_MASK) && !ret);
126 dev_err(info->dev, "waiting for UDR update, reached max number of retries\n");
131 static inline int s5m8767_rtc_set_time_reg(struct s5m_rtc_info *info)
136 ret = regmap_read(info->regmap, S5M_RTC_UDR_CON, &data);
138 dev_err(info->dev, "failed to read update reg(%d)\n", ret);
142 data |= S5M_RTC_TIME_EN_MASK;
143 data |= S5M_RTC_UDR_MASK;
145 ret = regmap_write(info->regmap, S5M_RTC_UDR_CON, data);
147 dev_err(info->dev, "failed to write update reg(%d)\n", ret);
151 ret = s5m8767_wait_for_udr_update(info);
156 static inline int s5m8767_rtc_set_alarm_reg(struct s5m_rtc_info *info)
161 ret = regmap_read(info->regmap, S5M_RTC_UDR_CON, &data);
163 dev_err(info->dev, "%s: fail to read update reg(%d)\n",
168 data &= ~S5M_RTC_TIME_EN_MASK;
169 data |= S5M_RTC_UDR_MASK;
171 ret = regmap_write(info->regmap, S5M_RTC_UDR_CON, data);
173 dev_err(info->dev, "%s: fail to write update reg(%d)\n",
178 ret = s5m8767_wait_for_udr_update(info);
183 static void s5m8763_data_to_tm(u8 *data, struct rtc_time *tm)
185 tm->tm_sec = bcd2bin(data[RTC_SEC]);
186 tm->tm_min = bcd2bin(data[RTC_MIN]);
188 if (data[RTC_HOUR] & HOUR_12) {
189 tm->tm_hour = bcd2bin(data[RTC_HOUR] & 0x1f);
190 if (data[RTC_HOUR] & HOUR_PM)
193 tm->tm_hour = bcd2bin(data[RTC_HOUR] & 0x3f);
196 tm->tm_wday = data[RTC_WEEKDAY] & 0x07;
197 tm->tm_mday = bcd2bin(data[RTC_DATE]);
198 tm->tm_mon = bcd2bin(data[RTC_MONTH]);
199 tm->tm_year = bcd2bin(data[RTC_YEAR1]) + bcd2bin(data[RTC_YEAR2]) * 100;
203 static void s5m8763_tm_to_data(struct rtc_time *tm, u8 *data)
205 data[RTC_SEC] = bin2bcd(tm->tm_sec);
206 data[RTC_MIN] = bin2bcd(tm->tm_min);
207 data[RTC_HOUR] = bin2bcd(tm->tm_hour);
208 data[RTC_WEEKDAY] = tm->tm_wday;
209 data[RTC_DATE] = bin2bcd(tm->tm_mday);
210 data[RTC_MONTH] = bin2bcd(tm->tm_mon);
211 data[RTC_YEAR1] = bin2bcd(tm->tm_year % 100);
212 data[RTC_YEAR2] = bin2bcd((tm->tm_year + 1900) / 100);
215 static int s5m_rtc_read_time(struct device *dev, struct rtc_time *tm)
217 struct s5m_rtc_info *info = dev_get_drvdata(dev);
221 ret = regmap_bulk_read(info->regmap, S5M_RTC_SEC, data, 8);
225 switch (info->device_type) {
227 s5m8763_data_to_tm(data, tm);
231 s5m8767_data_to_tm(data, tm, info->rtc_24hr_mode);
238 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
239 1900 + tm->tm_year, 1 + tm->tm_mon, tm->tm_mday,
240 tm->tm_hour, tm->tm_min, tm->tm_sec, tm->tm_wday);
242 return rtc_valid_tm(tm);
245 static int s5m_rtc_set_time(struct device *dev, struct rtc_time *tm)
247 struct s5m_rtc_info *info = dev_get_drvdata(dev);
251 switch (info->device_type) {
253 s5m8763_tm_to_data(tm, data);
256 ret = s5m8767_tm_to_data(tm, data);
265 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
266 1900 + tm->tm_year, 1 + tm->tm_mon, tm->tm_mday,
267 tm->tm_hour, tm->tm_min, tm->tm_sec, tm->tm_wday);
269 ret = regmap_raw_write(info->regmap, S5M_RTC_SEC, data, 8);
273 ret = s5m8767_rtc_set_time_reg(info);
278 static int s5m_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
280 struct s5m_rtc_info *info = dev_get_drvdata(dev);
285 ret = regmap_bulk_read(info->regmap, S5M_ALARM0_SEC, data, 8);
289 switch (info->device_type) {
291 s5m8763_data_to_tm(data, &alrm->time);
292 ret = regmap_read(info->regmap, S5M_ALARM0_CONF, &val);
296 alrm->enabled = !!val;
298 ret = regmap_read(info->regmap, S5M_RTC_STATUS, &val);
305 s5m8767_data_to_tm(data, &alrm->time, info->rtc_24hr_mode);
306 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
307 1900 + alrm->time.tm_year, 1 + alrm->time.tm_mon,
308 alrm->time.tm_mday, alrm->time.tm_hour,
309 alrm->time.tm_min, alrm->time.tm_sec,
313 for (i = 0; i < 7; i++) {
314 if (data[i] & ALARM_ENABLE_MASK) {
321 ret = regmap_read(info->regmap, S5M_RTC_STATUS, &val);
330 if (val & S5M_ALARM0_STATUS)
338 static int s5m_rtc_stop_alarm(struct s5m_rtc_info *info)
344 ret = regmap_bulk_read(info->regmap, S5M_ALARM0_SEC, data, 8);
348 s5m8767_data_to_tm(data, &tm, info->rtc_24hr_mode);
349 dev_dbg(info->dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
350 1900 + tm.tm_year, 1 + tm.tm_mon, tm.tm_mday,
351 tm.tm_hour, tm.tm_min, tm.tm_sec, tm.tm_wday);
353 switch (info->device_type) {
355 ret = regmap_write(info->regmap, S5M_ALARM0_CONF, 0);
359 for (i = 0; i < 7; i++)
360 data[i] &= ~ALARM_ENABLE_MASK;
362 ret = regmap_raw_write(info->regmap, S5M_ALARM0_SEC, data, 8);
366 ret = s5m8767_rtc_set_alarm_reg(info);
377 static int s5m_rtc_start_alarm(struct s5m_rtc_info *info)
384 ret = regmap_bulk_read(info->regmap, S5M_ALARM0_SEC, data, 8);
388 s5m8767_data_to_tm(data, &tm, info->rtc_24hr_mode);
389 dev_dbg(info->dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
390 1900 + tm.tm_year, 1 + tm.tm_mon, tm.tm_mday,
391 tm.tm_hour, tm.tm_min, tm.tm_sec, tm.tm_wday);
393 switch (info->device_type) {
396 ret = regmap_write(info->regmap, S5M_ALARM0_CONF, alarm0_conf);
400 data[RTC_SEC] |= ALARM_ENABLE_MASK;
401 data[RTC_MIN] |= ALARM_ENABLE_MASK;
402 data[RTC_HOUR] |= ALARM_ENABLE_MASK;
403 data[RTC_WEEKDAY] &= ~ALARM_ENABLE_MASK;
404 if (data[RTC_DATE] & 0x1f)
405 data[RTC_DATE] |= ALARM_ENABLE_MASK;
406 if (data[RTC_MONTH] & 0xf)
407 data[RTC_MONTH] |= ALARM_ENABLE_MASK;
408 if (data[RTC_YEAR1] & 0x7f)
409 data[RTC_YEAR1] |= ALARM_ENABLE_MASK;
411 ret = regmap_raw_write(info->regmap, S5M_ALARM0_SEC, data, 8);
414 ret = s5m8767_rtc_set_alarm_reg(info);
425 static int s5m_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
427 struct s5m_rtc_info *info = dev_get_drvdata(dev);
431 switch (info->device_type) {
433 s5m8763_tm_to_data(&alrm->time, data);
437 s5m8767_tm_to_data(&alrm->time, data);
444 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
445 1900 + alrm->time.tm_year, 1 + alrm->time.tm_mon,
446 alrm->time.tm_mday, alrm->time.tm_hour, alrm->time.tm_min,
447 alrm->time.tm_sec, alrm->time.tm_wday);
449 ret = s5m_rtc_stop_alarm(info);
453 ret = regmap_raw_write(info->regmap, S5M_ALARM0_SEC, data, 8);
457 ret = s5m8767_rtc_set_alarm_reg(info);
462 ret = s5m_rtc_start_alarm(info);
467 static int s5m_rtc_alarm_irq_enable(struct device *dev,
468 unsigned int enabled)
470 struct s5m_rtc_info *info = dev_get_drvdata(dev);
473 return s5m_rtc_start_alarm(info);
475 return s5m_rtc_stop_alarm(info);
478 static irqreturn_t s5m_rtc_alarm_irq(int irq, void *data)
480 struct s5m_rtc_info *info = data;
482 rtc_update_irq(info->rtc_dev, 1, RTC_IRQF | RTC_AF);
487 static const struct rtc_class_ops s5m_rtc_ops = {
488 .read_time = s5m_rtc_read_time,
489 .set_time = s5m_rtc_set_time,
490 .read_alarm = s5m_rtc_read_alarm,
491 .set_alarm = s5m_rtc_set_alarm,
492 .alarm_irq_enable = s5m_rtc_alarm_irq_enable,
495 static void s5m_rtc_enable_wtsr(struct s5m_rtc_info *info, bool enable)
498 ret = regmap_update_bits(info->regmap, S5M_WTSR_SMPL_CNTL,
500 enable ? WTSR_ENABLE_MASK : 0);
502 dev_err(info->dev, "%s: fail to update WTSR reg(%d)\n",
506 static void s5m_rtc_enable_smpl(struct s5m_rtc_info *info, bool enable)
509 ret = regmap_update_bits(info->regmap, S5M_WTSR_SMPL_CNTL,
511 enable ? SMPL_ENABLE_MASK : 0);
513 dev_err(info->dev, "%s: fail to update SMPL reg(%d)\n",
517 static int s5m8767_rtc_init_reg(struct s5m_rtc_info *info)
520 unsigned int tp_read;
524 ret = regmap_read(info->regmap, S5M_RTC_UDR_CON, &tp_read);
526 dev_err(info->dev, "%s: fail to read control reg(%d)\n",
531 /* Set RTC control register : Binary mode, 24hour mode */
532 data[0] = (1 << BCD_EN_SHIFT) | (1 << MODEL24_SHIFT);
533 data[1] = (0 << BCD_EN_SHIFT) | (1 << MODEL24_SHIFT);
535 info->rtc_24hr_mode = 1;
536 ret = regmap_raw_write(info->regmap, S5M_ALARM0_CONF, data, 2);
538 dev_err(info->dev, "%s: fail to write controlm reg(%d)\n",
543 /* In first boot time, Set rtc time to 1/1/2012 00:00:00(SUN) */
544 if ((tp_read & RTC_TCON_MASK) == 0) {
545 dev_dbg(info->dev, "rtc init\n");
555 ret = s5m_rtc_set_time(info->dev, &tm);
558 ret = regmap_update_bits(info->regmap, S5M_RTC_UDR_CON,
559 RTC_TCON_MASK, tp_read | RTC_TCON_MASK);
561 dev_err(info->dev, "%s: fail to update TCON reg(%d)\n",
567 static int s5m_rtc_probe(struct platform_device *pdev)
569 struct sec_pmic_dev *s5m87xx = dev_get_drvdata(pdev->dev.parent);
570 struct sec_platform_data *pdata = s5m87xx->pdata;
571 struct s5m_rtc_info *info;
572 const struct regmap_config *regmap_cfg;
576 dev_err(pdev->dev.parent, "Platform data not supplied\n");
580 info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
584 switch (pdata->device_type) {
586 regmap_cfg = &s2mps14_rtc_regmap_config;
589 regmap_cfg = &s5m_rtc_regmap_config;
592 regmap_cfg = &s5m_rtc_regmap_config;
595 dev_err(&pdev->dev, "Device type is not supported by RTC driver\n");
599 info->i2c = i2c_new_dummy(s5m87xx->i2c->adapter, RTC_I2C_ADDR);
601 dev_err(&pdev->dev, "Failed to allocate I2C for RTC\n");
605 info->regmap = devm_regmap_init_i2c(info->i2c, regmap_cfg);
606 if (IS_ERR(info->regmap)) {
607 ret = PTR_ERR(info->regmap);
608 dev_err(&pdev->dev, "Failed to allocate RTC register map: %d\n",
613 info->dev = &pdev->dev;
614 info->s5m87xx = s5m87xx;
615 info->device_type = s5m87xx->device_type;
616 info->wtsr_smpl = s5m87xx->wtsr_smpl;
618 switch (pdata->device_type) {
620 info->irq = regmap_irq_get_virq(s5m87xx->irq_data,
625 info->irq = regmap_irq_get_virq(s5m87xx->irq_data,
631 dev_err(&pdev->dev, "Unsupported device type: %d\n", ret);
635 platform_set_drvdata(pdev, info);
637 ret = s5m8767_rtc_init_reg(info);
639 if (info->wtsr_smpl) {
640 s5m_rtc_enable_wtsr(info, true);
641 s5m_rtc_enable_smpl(info, true);
644 device_init_wakeup(&pdev->dev, 1);
646 info->rtc_dev = devm_rtc_device_register(&pdev->dev, "s5m-rtc",
647 &s5m_rtc_ops, THIS_MODULE);
649 if (IS_ERR(info->rtc_dev)) {
650 ret = PTR_ERR(info->rtc_dev);
654 ret = devm_request_threaded_irq(&pdev->dev, info->irq, NULL,
655 s5m_rtc_alarm_irq, 0, "rtc-alarm0",
658 dev_err(&pdev->dev, "Failed to request alarm IRQ: %d: %d\n",
666 i2c_unregister_device(info->i2c);
671 static void s5m_rtc_shutdown(struct platform_device *pdev)
673 struct s5m_rtc_info *info = platform_get_drvdata(pdev);
675 unsigned int val = 0;
676 if (info->wtsr_smpl) {
677 for (i = 0; i < 3; i++) {
678 s5m_rtc_enable_wtsr(info, false);
679 regmap_read(info->regmap, S5M_WTSR_SMPL_CNTL, &val);
680 pr_debug("%s: WTSR_SMPL reg(0x%02x)\n", __func__, val);
681 if (val & WTSR_ENABLE_MASK)
682 pr_emerg("%s: fail to disable WTSR\n",
685 pr_info("%s: success to disable WTSR\n",
691 /* Disable SMPL when power off */
692 s5m_rtc_enable_smpl(info, false);
695 static int s5m_rtc_remove(struct platform_device *pdev)
697 struct s5m_rtc_info *info = platform_get_drvdata(pdev);
699 /* Perform also all shutdown steps when removing */
700 s5m_rtc_shutdown(pdev);
701 i2c_unregister_device(info->i2c);
706 #ifdef CONFIG_PM_SLEEP
707 static int s5m_rtc_resume(struct device *dev)
709 struct s5m_rtc_info *info = dev_get_drvdata(dev);
712 if (device_may_wakeup(dev))
713 ret = disable_irq_wake(info->irq);
718 static int s5m_rtc_suspend(struct device *dev)
720 struct s5m_rtc_info *info = dev_get_drvdata(dev);
723 if (device_may_wakeup(dev))
724 ret = enable_irq_wake(info->irq);
728 #endif /* CONFIG_PM_SLEEP */
730 static SIMPLE_DEV_PM_OPS(s5m_rtc_pm_ops, s5m_rtc_suspend, s5m_rtc_resume);
732 static const struct platform_device_id s5m_rtc_id[] = {
736 static struct platform_driver s5m_rtc_driver = {
739 .owner = THIS_MODULE,
740 .pm = &s5m_rtc_pm_ops,
742 .probe = s5m_rtc_probe,
743 .remove = s5m_rtc_remove,
744 .shutdown = s5m_rtc_shutdown,
745 .id_table = s5m_rtc_id,
748 module_platform_driver(s5m_rtc_driver);
750 /* Module information */
751 MODULE_AUTHOR("Sangbeom Kim <sbkim73@samsung.com>");
752 MODULE_DESCRIPTION("Samsung S5M RTC driver");
753 MODULE_LICENSE("GPL");
754 MODULE_ALIAS("platform:s5m-rtc");