2 * Copyright (c) 2013-2014 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
41 /* Registers used by the driver which are different between chipsets. */
42 struct s5m_rtc_reg_config {
43 /* Number of registers used for setting time/alarm0/alarm1 */
44 unsigned int regs_count;
45 /* First register for time, seconds */
47 /* RTC control register */
49 /* First register for alarm 0, seconds */
51 /* First register for alarm 1, seconds */
53 /* SMPL/WTSR register */
54 unsigned int smpl_wtsr;
56 * Register for update flag (UDR). Typically setting UDR field to 1
57 * will enable update of time or alarm register. Then it will be
58 * auto-cleared after successful update.
60 unsigned int rtc_udr_update;
61 /* Mask for UDR field in 'rtc_udr_update' register */
62 unsigned int rtc_udr_mask;
65 /* Register map for S5M8763 and S5M8767 */
66 static const struct s5m_rtc_reg_config s5m_rtc_regs = {
69 .ctrl = S5M_ALARM1_CONF,
70 .alarm0 = S5M_ALARM0_SEC,
71 .alarm1 = S5M_ALARM1_SEC,
72 .smpl_wtsr = S5M_WTSR_SMPL_CNTL,
73 .rtc_udr_update = S5M_RTC_UDR_CON,
74 .rtc_udr_mask = S5M_RTC_UDR_MASK,
79 struct i2c_client *i2c;
80 struct sec_pmic_dev *s5m87xx;
81 struct regmap *regmap;
82 struct rtc_device *rtc_dev;
87 const struct s5m_rtc_reg_config *regs;
90 static const struct regmap_config s5m_rtc_regmap_config = {
94 .max_register = S5M_RTC_REG_MAX,
97 static const struct regmap_config s2mps14_rtc_regmap_config = {
101 .max_register = S2MPS_RTC_REG_MAX,
104 static void s5m8767_data_to_tm(u8 *data, struct rtc_time *tm,
107 tm->tm_sec = data[RTC_SEC] & 0x7f;
108 tm->tm_min = data[RTC_MIN] & 0x7f;
110 tm->tm_hour = data[RTC_HOUR] & 0x1f;
112 tm->tm_hour = data[RTC_HOUR] & 0x0f;
113 if (data[RTC_HOUR] & HOUR_PM_MASK)
117 tm->tm_wday = ffs(data[RTC_WEEKDAY] & 0x7f);
118 tm->tm_mday = data[RTC_DATE] & 0x1f;
119 tm->tm_mon = (data[RTC_MONTH] & 0x0f) - 1;
120 tm->tm_year = (data[RTC_YEAR1] & 0x7f) + 100;
125 static int s5m8767_tm_to_data(struct rtc_time *tm, u8 *data)
127 data[RTC_SEC] = tm->tm_sec;
128 data[RTC_MIN] = tm->tm_min;
130 if (tm->tm_hour >= 12)
131 data[RTC_HOUR] = tm->tm_hour | HOUR_PM_MASK;
133 data[RTC_HOUR] = tm->tm_hour & ~HOUR_PM_MASK;
135 data[RTC_WEEKDAY] = 1 << tm->tm_wday;
136 data[RTC_DATE] = tm->tm_mday;
137 data[RTC_MONTH] = tm->tm_mon + 1;
138 data[RTC_YEAR1] = tm->tm_year > 100 ? (tm->tm_year - 100) : 0;
140 if (tm->tm_year < 100) {
141 pr_err("s5m8767 RTC cannot handle the year %d.\n",
150 * Read RTC_UDR_CON register and wait till UDR field is cleared.
151 * This indicates that time/alarm update ended.
153 static inline int s5m8767_wait_for_udr_update(struct s5m_rtc_info *info)
155 int ret, retry = UDR_READ_RETRY_CNT;
159 ret = regmap_read(info->regmap, info->regs->rtc_udr_update,
161 } while (--retry && (data & info->regs->rtc_udr_mask) && !ret);
164 dev_err(info->dev, "waiting for UDR update, reached max number of retries\n");
169 static inline int s5m_check_peding_alarm_interrupt(struct s5m_rtc_info *info,
170 struct rtc_wkalrm *alarm)
175 switch (info->device_type) {
178 ret = regmap_read(info->regmap, S5M_RTC_STATUS, &val);
179 val &= S5M_ALARM0_STATUS;
195 static inline int s5m8767_rtc_set_time_reg(struct s5m_rtc_info *info)
200 ret = regmap_read(info->regmap, info->regs->rtc_udr_update, &data);
202 dev_err(info->dev, "failed to read update reg(%d)\n", ret);
206 data |= S5M_RTC_TIME_EN_MASK;
207 data |= info->regs->rtc_udr_mask;
209 ret = regmap_write(info->regmap, info->regs->rtc_udr_update, data);
211 dev_err(info->dev, "failed to write update reg(%d)\n", ret);
215 ret = s5m8767_wait_for_udr_update(info);
220 static inline int s5m8767_rtc_set_alarm_reg(struct s5m_rtc_info *info)
225 ret = regmap_read(info->regmap, info->regs->rtc_udr_update, &data);
227 dev_err(info->dev, "%s: fail to read update reg(%d)\n",
232 data &= ~S5M_RTC_TIME_EN_MASK;
233 data |= info->regs->rtc_udr_mask;
235 ret = regmap_write(info->regmap, info->regs->rtc_udr_update, data);
237 dev_err(info->dev, "%s: fail to write update reg(%d)\n",
242 ret = s5m8767_wait_for_udr_update(info);
247 static void s5m8763_data_to_tm(u8 *data, struct rtc_time *tm)
249 tm->tm_sec = bcd2bin(data[RTC_SEC]);
250 tm->tm_min = bcd2bin(data[RTC_MIN]);
252 if (data[RTC_HOUR] & HOUR_12) {
253 tm->tm_hour = bcd2bin(data[RTC_HOUR] & 0x1f);
254 if (data[RTC_HOUR] & HOUR_PM)
257 tm->tm_hour = bcd2bin(data[RTC_HOUR] & 0x3f);
260 tm->tm_wday = data[RTC_WEEKDAY] & 0x07;
261 tm->tm_mday = bcd2bin(data[RTC_DATE]);
262 tm->tm_mon = bcd2bin(data[RTC_MONTH]);
263 tm->tm_year = bcd2bin(data[RTC_YEAR1]) + bcd2bin(data[RTC_YEAR2]) * 100;
267 static void s5m8763_tm_to_data(struct rtc_time *tm, u8 *data)
269 data[RTC_SEC] = bin2bcd(tm->tm_sec);
270 data[RTC_MIN] = bin2bcd(tm->tm_min);
271 data[RTC_HOUR] = bin2bcd(tm->tm_hour);
272 data[RTC_WEEKDAY] = tm->tm_wday;
273 data[RTC_DATE] = bin2bcd(tm->tm_mday);
274 data[RTC_MONTH] = bin2bcd(tm->tm_mon);
275 data[RTC_YEAR1] = bin2bcd(tm->tm_year % 100);
276 data[RTC_YEAR2] = bin2bcd((tm->tm_year + 1900) / 100);
279 static int s5m_rtc_read_time(struct device *dev, struct rtc_time *tm)
281 struct s5m_rtc_info *info = dev_get_drvdata(dev);
282 u8 data[info->regs->regs_count];
285 ret = regmap_bulk_read(info->regmap, info->regs->time, data,
286 info->regs->regs_count);
290 switch (info->device_type) {
292 s5m8763_data_to_tm(data, tm);
296 s5m8767_data_to_tm(data, tm, info->rtc_24hr_mode);
303 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
304 1900 + tm->tm_year, 1 + tm->tm_mon, tm->tm_mday,
305 tm->tm_hour, tm->tm_min, tm->tm_sec, tm->tm_wday);
307 return rtc_valid_tm(tm);
310 static int s5m_rtc_set_time(struct device *dev, struct rtc_time *tm)
312 struct s5m_rtc_info *info = dev_get_drvdata(dev);
313 u8 data[info->regs->regs_count];
316 switch (info->device_type) {
318 s5m8763_tm_to_data(tm, data);
321 ret = s5m8767_tm_to_data(tm, data);
330 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
331 1900 + tm->tm_year, 1 + tm->tm_mon, tm->tm_mday,
332 tm->tm_hour, tm->tm_min, tm->tm_sec, tm->tm_wday);
334 ret = regmap_raw_write(info->regmap, info->regs->time, data,
335 info->regs->regs_count);
339 ret = s5m8767_rtc_set_time_reg(info);
344 static int s5m_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
346 struct s5m_rtc_info *info = dev_get_drvdata(dev);
347 u8 data[info->regs->regs_count];
351 ret = regmap_bulk_read(info->regmap, info->regs->alarm0, data,
352 info->regs->regs_count);
356 switch (info->device_type) {
358 s5m8763_data_to_tm(data, &alrm->time);
359 ret = regmap_read(info->regmap, S5M_ALARM0_CONF, &val);
363 alrm->enabled = !!val;
367 s5m8767_data_to_tm(data, &alrm->time, info->rtc_24hr_mode);
369 for (i = 0; i < info->regs->regs_count; i++) {
370 if (data[i] & ALARM_ENABLE_MASK) {
381 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
382 1900 + alrm->time.tm_year, 1 + alrm->time.tm_mon,
383 alrm->time.tm_mday, alrm->time.tm_hour,
384 alrm->time.tm_min, alrm->time.tm_sec,
387 ret = s5m_check_peding_alarm_interrupt(info, alrm);
392 static int s5m_rtc_stop_alarm(struct s5m_rtc_info *info)
394 u8 data[info->regs->regs_count];
398 ret = regmap_bulk_read(info->regmap, info->regs->alarm0, data,
399 info->regs->regs_count);
403 s5m8767_data_to_tm(data, &tm, info->rtc_24hr_mode);
404 dev_dbg(info->dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
405 1900 + tm.tm_year, 1 + tm.tm_mon, tm.tm_mday,
406 tm.tm_hour, tm.tm_min, tm.tm_sec, tm.tm_wday);
408 switch (info->device_type) {
410 ret = regmap_write(info->regmap, S5M_ALARM0_CONF, 0);
414 for (i = 0; i < info->regs->regs_count; i++)
415 data[i] &= ~ALARM_ENABLE_MASK;
417 ret = regmap_raw_write(info->regmap, info->regs->alarm0, data,
418 info->regs->regs_count);
422 ret = s5m8767_rtc_set_alarm_reg(info);
433 static int s5m_rtc_start_alarm(struct s5m_rtc_info *info)
436 u8 data[info->regs->regs_count];
440 ret = regmap_bulk_read(info->regmap, info->regs->alarm0, data,
441 info->regs->regs_count);
445 s5m8767_data_to_tm(data, &tm, info->rtc_24hr_mode);
446 dev_dbg(info->dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
447 1900 + tm.tm_year, 1 + tm.tm_mon, tm.tm_mday,
448 tm.tm_hour, tm.tm_min, tm.tm_sec, tm.tm_wday);
450 switch (info->device_type) {
453 ret = regmap_write(info->regmap, S5M_ALARM0_CONF, alarm0_conf);
457 data[RTC_SEC] |= ALARM_ENABLE_MASK;
458 data[RTC_MIN] |= ALARM_ENABLE_MASK;
459 data[RTC_HOUR] |= ALARM_ENABLE_MASK;
460 data[RTC_WEEKDAY] &= ~ALARM_ENABLE_MASK;
461 if (data[RTC_DATE] & 0x1f)
462 data[RTC_DATE] |= ALARM_ENABLE_MASK;
463 if (data[RTC_MONTH] & 0xf)
464 data[RTC_MONTH] |= ALARM_ENABLE_MASK;
465 if (data[RTC_YEAR1] & 0x7f)
466 data[RTC_YEAR1] |= ALARM_ENABLE_MASK;
468 ret = regmap_raw_write(info->regmap, info->regs->alarm0, data,
469 info->regs->regs_count);
472 ret = s5m8767_rtc_set_alarm_reg(info);
483 static int s5m_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
485 struct s5m_rtc_info *info = dev_get_drvdata(dev);
486 u8 data[info->regs->regs_count];
489 switch (info->device_type) {
491 s5m8763_tm_to_data(&alrm->time, data);
495 s5m8767_tm_to_data(&alrm->time, data);
502 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
503 1900 + alrm->time.tm_year, 1 + alrm->time.tm_mon,
504 alrm->time.tm_mday, alrm->time.tm_hour, alrm->time.tm_min,
505 alrm->time.tm_sec, alrm->time.tm_wday);
507 ret = s5m_rtc_stop_alarm(info);
511 ret = regmap_raw_write(info->regmap, info->regs->alarm0, data,
512 info->regs->regs_count);
516 ret = s5m8767_rtc_set_alarm_reg(info);
521 ret = s5m_rtc_start_alarm(info);
526 static int s5m_rtc_alarm_irq_enable(struct device *dev,
527 unsigned int enabled)
529 struct s5m_rtc_info *info = dev_get_drvdata(dev);
532 return s5m_rtc_start_alarm(info);
534 return s5m_rtc_stop_alarm(info);
537 static irqreturn_t s5m_rtc_alarm_irq(int irq, void *data)
539 struct s5m_rtc_info *info = data;
541 rtc_update_irq(info->rtc_dev, 1, RTC_IRQF | RTC_AF);
546 static const struct rtc_class_ops s5m_rtc_ops = {
547 .read_time = s5m_rtc_read_time,
548 .set_time = s5m_rtc_set_time,
549 .read_alarm = s5m_rtc_read_alarm,
550 .set_alarm = s5m_rtc_set_alarm,
551 .alarm_irq_enable = s5m_rtc_alarm_irq_enable,
554 static void s5m_rtc_enable_wtsr(struct s5m_rtc_info *info, bool enable)
557 ret = regmap_update_bits(info->regmap, info->regs->smpl_wtsr,
559 enable ? WTSR_ENABLE_MASK : 0);
561 dev_err(info->dev, "%s: fail to update WTSR reg(%d)\n",
565 static void s5m_rtc_enable_smpl(struct s5m_rtc_info *info, bool enable)
568 ret = regmap_update_bits(info->regmap, info->regs->smpl_wtsr,
570 enable ? SMPL_ENABLE_MASK : 0);
572 dev_err(info->dev, "%s: fail to update SMPL reg(%d)\n",
576 static int s5m8767_rtc_init_reg(struct s5m_rtc_info *info)
581 /* UDR update time. Default of 7.32 ms is too long. */
582 ret = regmap_update_bits(info->regmap, S5M_RTC_UDR_CON,
583 S5M_RTC_UDR_T_MASK, S5M_RTC_UDR_T_450_US);
585 dev_err(info->dev, "%s: fail to change UDR time: %d\n",
588 /* Set RTC control register : Binary mode, 24hour mode */
589 data[0] = (1 << BCD_EN_SHIFT) | (1 << MODEL24_SHIFT);
590 data[1] = (0 << BCD_EN_SHIFT) | (1 << MODEL24_SHIFT);
592 info->rtc_24hr_mode = 1;
593 ret = regmap_raw_write(info->regmap, S5M_ALARM0_CONF, data, 2);
595 dev_err(info->dev, "%s: fail to write controlm reg(%d)\n",
603 static int s5m_rtc_probe(struct platform_device *pdev)
605 struct sec_pmic_dev *s5m87xx = dev_get_drvdata(pdev->dev.parent);
606 struct sec_platform_data *pdata = s5m87xx->pdata;
607 struct s5m_rtc_info *info;
608 const struct regmap_config *regmap_cfg;
612 dev_err(pdev->dev.parent, "Platform data not supplied\n");
616 info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
620 switch (pdata->device_type) {
622 regmap_cfg = &s2mps14_rtc_regmap_config;
625 regmap_cfg = &s5m_rtc_regmap_config;
626 info->regs = &s5m_rtc_regs;
629 regmap_cfg = &s5m_rtc_regmap_config;
630 info->regs = &s5m_rtc_regs;
633 dev_err(&pdev->dev, "Device type is not supported by RTC driver\n");
637 info->i2c = i2c_new_dummy(s5m87xx->i2c->adapter, RTC_I2C_ADDR);
639 dev_err(&pdev->dev, "Failed to allocate I2C for RTC\n");
643 info->regmap = devm_regmap_init_i2c(info->i2c, regmap_cfg);
644 if (IS_ERR(info->regmap)) {
645 ret = PTR_ERR(info->regmap);
646 dev_err(&pdev->dev, "Failed to allocate RTC register map: %d\n",
651 info->dev = &pdev->dev;
652 info->s5m87xx = s5m87xx;
653 info->device_type = s5m87xx->device_type;
654 info->wtsr_smpl = s5m87xx->wtsr_smpl;
656 switch (pdata->device_type) {
658 info->irq = regmap_irq_get_virq(s5m87xx->irq_data,
663 info->irq = regmap_irq_get_virq(s5m87xx->irq_data,
669 dev_err(&pdev->dev, "Unsupported device type: %d\n", ret);
673 platform_set_drvdata(pdev, info);
675 ret = s5m8767_rtc_init_reg(info);
677 if (info->wtsr_smpl) {
678 s5m_rtc_enable_wtsr(info, true);
679 s5m_rtc_enable_smpl(info, true);
682 device_init_wakeup(&pdev->dev, 1);
684 info->rtc_dev = devm_rtc_device_register(&pdev->dev, "s5m-rtc",
685 &s5m_rtc_ops, THIS_MODULE);
687 if (IS_ERR(info->rtc_dev)) {
688 ret = PTR_ERR(info->rtc_dev);
692 ret = devm_request_threaded_irq(&pdev->dev, info->irq, NULL,
693 s5m_rtc_alarm_irq, 0, "rtc-alarm0",
696 dev_err(&pdev->dev, "Failed to request alarm IRQ: %d: %d\n",
704 i2c_unregister_device(info->i2c);
709 static void s5m_rtc_shutdown(struct platform_device *pdev)
711 struct s5m_rtc_info *info = platform_get_drvdata(pdev);
713 unsigned int val = 0;
714 if (info->wtsr_smpl) {
715 for (i = 0; i < 3; i++) {
716 s5m_rtc_enable_wtsr(info, false);
717 regmap_read(info->regmap, info->regs->smpl_wtsr, &val);
718 pr_debug("%s: WTSR_SMPL reg(0x%02x)\n", __func__, val);
719 if (val & WTSR_ENABLE_MASK)
720 pr_emerg("%s: fail to disable WTSR\n",
723 pr_info("%s: success to disable WTSR\n",
729 /* Disable SMPL when power off */
730 s5m_rtc_enable_smpl(info, false);
733 static int s5m_rtc_remove(struct platform_device *pdev)
735 struct s5m_rtc_info *info = platform_get_drvdata(pdev);
737 /* Perform also all shutdown steps when removing */
738 s5m_rtc_shutdown(pdev);
739 i2c_unregister_device(info->i2c);
744 #ifdef CONFIG_PM_SLEEP
745 static int s5m_rtc_resume(struct device *dev)
747 struct s5m_rtc_info *info = dev_get_drvdata(dev);
750 if (device_may_wakeup(dev))
751 ret = disable_irq_wake(info->irq);
756 static int s5m_rtc_suspend(struct device *dev)
758 struct s5m_rtc_info *info = dev_get_drvdata(dev);
761 if (device_may_wakeup(dev))
762 ret = enable_irq_wake(info->irq);
766 #endif /* CONFIG_PM_SLEEP */
768 static SIMPLE_DEV_PM_OPS(s5m_rtc_pm_ops, s5m_rtc_suspend, s5m_rtc_resume);
770 static const struct platform_device_id s5m_rtc_id[] = {
774 static struct platform_driver s5m_rtc_driver = {
777 .owner = THIS_MODULE,
778 .pm = &s5m_rtc_pm_ops,
780 .probe = s5m_rtc_probe,
781 .remove = s5m_rtc_remove,
782 .shutdown = s5m_rtc_shutdown,
783 .id_table = s5m_rtc_id,
786 module_platform_driver(s5m_rtc_driver);
788 /* Module information */
789 MODULE_AUTHOR("Sangbeom Kim <sbkim73@samsung.com>");
790 MODULE_DESCRIPTION("Samsung S5M RTC driver");
791 MODULE_LICENSE("GPL");
792 MODULE_ALIAS("platform:s5m-rtc");