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/bcd.h>
21 #include <linux/regmap.h>
22 #include <linux/rtc.h>
23 #include <linux/platform_device.h>
24 #include <linux/mfd/samsung/core.h>
25 #include <linux/mfd/samsung/irq.h>
26 #include <linux/mfd/samsung/rtc.h>
27 #include <linux/mfd/samsung/s2mps14.h>
30 * Maximum number of retries for checking changes in UDR field
31 * of S5M_RTC_UDR_CON register (to limit possible endless loop).
33 * After writing to RTC registers (setting time or alarm) read the UDR field
34 * in S5M_RTC_UDR_CON register. UDR is auto-cleared when data have
37 #define UDR_READ_RETRY_CNT 5
39 /* Registers used by the driver which are different between chipsets. */
40 struct s5m_rtc_reg_config {
41 /* Number of registers used for setting time/alarm0/alarm1 */
42 unsigned int regs_count;
43 /* First register for time, seconds */
45 /* RTC control register */
47 /* First register for alarm 0, seconds */
49 /* First register for alarm 1, seconds */
52 * Register for update flag (UDR). Typically setting UDR field to 1
53 * will enable update of time or alarm register. Then it will be
54 * auto-cleared after successful update.
56 unsigned int rtc_udr_update;
57 /* Mask for UDR field in 'rtc_udr_update' register */
58 unsigned int rtc_udr_mask;
61 /* Register map for S5M8763 and S5M8767 */
62 static const struct s5m_rtc_reg_config s5m_rtc_regs = {
65 .ctrl = S5M_ALARM1_CONF,
66 .alarm0 = S5M_ALARM0_SEC,
67 .alarm1 = S5M_ALARM1_SEC,
68 .rtc_udr_update = S5M_RTC_UDR_CON,
69 .rtc_udr_mask = S5M_RTC_UDR_MASK,
73 * Register map for S2MPS14.
74 * It may be also suitable for S2MPS11 but this was not tested.
76 static const struct s5m_rtc_reg_config s2mps_rtc_regs = {
78 .time = S2MPS_RTC_SEC,
79 .ctrl = S2MPS_RTC_CTRL,
80 .alarm0 = S2MPS_ALARM0_SEC,
81 .alarm1 = S2MPS_ALARM1_SEC,
82 .rtc_udr_update = S2MPS_RTC_UDR_CON,
83 .rtc_udr_mask = S2MPS_RTC_WUDR_MASK,
88 struct i2c_client *i2c;
89 struct sec_pmic_dev *s5m87xx;
90 struct regmap *regmap;
91 struct rtc_device *rtc_dev;
95 const struct s5m_rtc_reg_config *regs;
98 static const struct regmap_config s5m_rtc_regmap_config = {
102 .max_register = S5M_RTC_REG_MAX,
105 static const struct regmap_config s2mps14_rtc_regmap_config = {
109 .max_register = S2MPS_RTC_REG_MAX,
112 static void s5m8767_data_to_tm(u8 *data, struct rtc_time *tm,
115 tm->tm_sec = data[RTC_SEC] & 0x7f;
116 tm->tm_min = data[RTC_MIN] & 0x7f;
118 tm->tm_hour = data[RTC_HOUR] & 0x1f;
120 tm->tm_hour = data[RTC_HOUR] & 0x0f;
121 if (data[RTC_HOUR] & HOUR_PM_MASK)
125 tm->tm_wday = ffs(data[RTC_WEEKDAY] & 0x7f);
126 tm->tm_mday = data[RTC_DATE] & 0x1f;
127 tm->tm_mon = (data[RTC_MONTH] & 0x0f) - 1;
128 tm->tm_year = (data[RTC_YEAR1] & 0x7f) + 100;
133 static int s5m8767_tm_to_data(struct rtc_time *tm, u8 *data)
135 data[RTC_SEC] = tm->tm_sec;
136 data[RTC_MIN] = tm->tm_min;
138 if (tm->tm_hour >= 12)
139 data[RTC_HOUR] = tm->tm_hour | HOUR_PM_MASK;
141 data[RTC_HOUR] = tm->tm_hour & ~HOUR_PM_MASK;
143 data[RTC_WEEKDAY] = 1 << tm->tm_wday;
144 data[RTC_DATE] = tm->tm_mday;
145 data[RTC_MONTH] = tm->tm_mon + 1;
146 data[RTC_YEAR1] = tm->tm_year > 100 ? (tm->tm_year - 100) : 0;
148 if (tm->tm_year < 100) {
149 pr_err("s5m8767 RTC cannot handle the year %d.\n",
158 * Read RTC_UDR_CON register and wait till UDR field is cleared.
159 * This indicates that time/alarm update ended.
161 static inline int s5m8767_wait_for_udr_update(struct s5m_rtc_info *info)
163 int ret, retry = UDR_READ_RETRY_CNT;
167 ret = regmap_read(info->regmap, info->regs->rtc_udr_update,
169 } while (--retry && (data & info->regs->rtc_udr_mask) && !ret);
172 dev_err(info->dev, "waiting for UDR update, reached max number of retries\n");
177 static inline int s5m_check_peding_alarm_interrupt(struct s5m_rtc_info *info,
178 struct rtc_wkalrm *alarm)
183 switch (info->device_type) {
186 ret = regmap_read(info->regmap, S5M_RTC_STATUS, &val);
187 val &= S5M_ALARM0_STATUS;
191 ret = regmap_read(info->s5m87xx->regmap_pmic, S2MPS14_REG_ST2,
193 val &= S2MPS_ALARM0_STATUS;
209 static inline int s5m8767_rtc_set_time_reg(struct s5m_rtc_info *info)
214 ret = regmap_read(info->regmap, info->regs->rtc_udr_update, &data);
216 dev_err(info->dev, "failed to read update reg(%d)\n", ret);
220 data |= info->regs->rtc_udr_mask;
221 if (info->device_type == S5M8763X || info->device_type == S5M8767X)
222 data |= S5M_RTC_TIME_EN_MASK;
224 ret = regmap_write(info->regmap, info->regs->rtc_udr_update, data);
226 dev_err(info->dev, "failed to write update reg(%d)\n", ret);
230 ret = s5m8767_wait_for_udr_update(info);
235 static inline int s5m8767_rtc_set_alarm_reg(struct s5m_rtc_info *info)
240 ret = regmap_read(info->regmap, info->regs->rtc_udr_update, &data);
242 dev_err(info->dev, "%s: fail to read update reg(%d)\n",
247 data |= info->regs->rtc_udr_mask;
248 switch (info->device_type) {
251 data &= ~S5M_RTC_TIME_EN_MASK;
254 data |= S2MPS_RTC_RUDR_MASK;
257 data |= S2MPS13_RTC_AUDR_MASK;
263 ret = regmap_write(info->regmap, info->regs->rtc_udr_update, data);
265 dev_err(info->dev, "%s: fail to write update reg(%d)\n",
270 ret = s5m8767_wait_for_udr_update(info);
272 /* On S2MPS13 the AUDR is not auto-cleared */
273 if (info->device_type == S2MPS13X)
274 regmap_update_bits(info->regmap, info->regs->rtc_udr_update,
275 S2MPS13_RTC_AUDR_MASK, 0);
280 static void s5m8763_data_to_tm(u8 *data, struct rtc_time *tm)
282 tm->tm_sec = bcd2bin(data[RTC_SEC]);
283 tm->tm_min = bcd2bin(data[RTC_MIN]);
285 if (data[RTC_HOUR] & HOUR_12) {
286 tm->tm_hour = bcd2bin(data[RTC_HOUR] & 0x1f);
287 if (data[RTC_HOUR] & HOUR_PM)
290 tm->tm_hour = bcd2bin(data[RTC_HOUR] & 0x3f);
293 tm->tm_wday = data[RTC_WEEKDAY] & 0x07;
294 tm->tm_mday = bcd2bin(data[RTC_DATE]);
295 tm->tm_mon = bcd2bin(data[RTC_MONTH]);
296 tm->tm_year = bcd2bin(data[RTC_YEAR1]) + bcd2bin(data[RTC_YEAR2]) * 100;
300 static void s5m8763_tm_to_data(struct rtc_time *tm, u8 *data)
302 data[RTC_SEC] = bin2bcd(tm->tm_sec);
303 data[RTC_MIN] = bin2bcd(tm->tm_min);
304 data[RTC_HOUR] = bin2bcd(tm->tm_hour);
305 data[RTC_WEEKDAY] = tm->tm_wday;
306 data[RTC_DATE] = bin2bcd(tm->tm_mday);
307 data[RTC_MONTH] = bin2bcd(tm->tm_mon);
308 data[RTC_YEAR1] = bin2bcd(tm->tm_year % 100);
309 data[RTC_YEAR2] = bin2bcd((tm->tm_year + 1900) / 100);
312 static int s5m_rtc_read_time(struct device *dev, struct rtc_time *tm)
314 struct s5m_rtc_info *info = dev_get_drvdata(dev);
315 u8 data[info->regs->regs_count];
318 if (info->device_type == S2MPS14X || info->device_type == S2MPS13X) {
319 ret = regmap_update_bits(info->regmap,
320 info->regs->rtc_udr_update,
321 S2MPS_RTC_RUDR_MASK, S2MPS_RTC_RUDR_MASK);
324 "Failed to prepare registers for time reading: %d\n",
329 ret = regmap_bulk_read(info->regmap, info->regs->time, data,
330 info->regs->regs_count);
334 switch (info->device_type) {
336 s5m8763_data_to_tm(data, tm);
342 s5m8767_data_to_tm(data, tm, info->rtc_24hr_mode);
349 dev_dbg(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 return rtc_valid_tm(tm);
356 static int s5m_rtc_set_time(struct device *dev, struct rtc_time *tm)
358 struct s5m_rtc_info *info = dev_get_drvdata(dev);
359 u8 data[info->regs->regs_count];
362 switch (info->device_type) {
364 s5m8763_tm_to_data(tm, data);
369 ret = s5m8767_tm_to_data(tm, data);
378 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
379 1900 + tm->tm_year, 1 + tm->tm_mon, tm->tm_mday,
380 tm->tm_hour, tm->tm_min, tm->tm_sec, tm->tm_wday);
382 ret = regmap_raw_write(info->regmap, info->regs->time, data,
383 info->regs->regs_count);
387 ret = s5m8767_rtc_set_time_reg(info);
392 static int s5m_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
394 struct s5m_rtc_info *info = dev_get_drvdata(dev);
395 u8 data[info->regs->regs_count];
399 ret = regmap_bulk_read(info->regmap, info->regs->alarm0, data,
400 info->regs->regs_count);
404 switch (info->device_type) {
406 s5m8763_data_to_tm(data, &alrm->time);
407 ret = regmap_read(info->regmap, S5M_ALARM0_CONF, &val);
411 alrm->enabled = !!val;
417 s5m8767_data_to_tm(data, &alrm->time, info->rtc_24hr_mode);
419 for (i = 0; i < info->regs->regs_count; i++) {
420 if (data[i] & ALARM_ENABLE_MASK) {
431 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
432 1900 + alrm->time.tm_year, 1 + alrm->time.tm_mon,
433 alrm->time.tm_mday, alrm->time.tm_hour,
434 alrm->time.tm_min, alrm->time.tm_sec,
437 ret = s5m_check_peding_alarm_interrupt(info, alrm);
442 static int s5m_rtc_stop_alarm(struct s5m_rtc_info *info)
444 u8 data[info->regs->regs_count];
448 ret = regmap_bulk_read(info->regmap, info->regs->alarm0, data,
449 info->regs->regs_count);
453 s5m8767_data_to_tm(data, &tm, info->rtc_24hr_mode);
454 dev_dbg(info->dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
455 1900 + tm.tm_year, 1 + tm.tm_mon, tm.tm_mday,
456 tm.tm_hour, tm.tm_min, tm.tm_sec, tm.tm_wday);
458 switch (info->device_type) {
460 ret = regmap_write(info->regmap, S5M_ALARM0_CONF, 0);
466 for (i = 0; i < info->regs->regs_count; i++)
467 data[i] &= ~ALARM_ENABLE_MASK;
469 ret = regmap_raw_write(info->regmap, info->regs->alarm0, data,
470 info->regs->regs_count);
474 ret = s5m8767_rtc_set_alarm_reg(info);
485 static int s5m_rtc_start_alarm(struct s5m_rtc_info *info)
488 u8 data[info->regs->regs_count];
492 ret = regmap_bulk_read(info->regmap, info->regs->alarm0, data,
493 info->regs->regs_count);
497 s5m8767_data_to_tm(data, &tm, info->rtc_24hr_mode);
498 dev_dbg(info->dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
499 1900 + tm.tm_year, 1 + tm.tm_mon, tm.tm_mday,
500 tm.tm_hour, tm.tm_min, tm.tm_sec, tm.tm_wday);
502 switch (info->device_type) {
505 ret = regmap_write(info->regmap, S5M_ALARM0_CONF, alarm0_conf);
511 data[RTC_SEC] |= ALARM_ENABLE_MASK;
512 data[RTC_MIN] |= ALARM_ENABLE_MASK;
513 data[RTC_HOUR] |= ALARM_ENABLE_MASK;
514 data[RTC_WEEKDAY] &= ~ALARM_ENABLE_MASK;
515 if (data[RTC_DATE] & 0x1f)
516 data[RTC_DATE] |= ALARM_ENABLE_MASK;
517 if (data[RTC_MONTH] & 0xf)
518 data[RTC_MONTH] |= ALARM_ENABLE_MASK;
519 if (data[RTC_YEAR1] & 0x7f)
520 data[RTC_YEAR1] |= ALARM_ENABLE_MASK;
522 ret = regmap_raw_write(info->regmap, info->regs->alarm0, data,
523 info->regs->regs_count);
526 ret = s5m8767_rtc_set_alarm_reg(info);
537 static int s5m_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
539 struct s5m_rtc_info *info = dev_get_drvdata(dev);
540 u8 data[info->regs->regs_count];
543 switch (info->device_type) {
545 s5m8763_tm_to_data(&alrm->time, data);
551 s5m8767_tm_to_data(&alrm->time, data);
558 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
559 1900 + alrm->time.tm_year, 1 + alrm->time.tm_mon,
560 alrm->time.tm_mday, alrm->time.tm_hour, alrm->time.tm_min,
561 alrm->time.tm_sec, alrm->time.tm_wday);
563 ret = s5m_rtc_stop_alarm(info);
567 ret = regmap_raw_write(info->regmap, info->regs->alarm0, data,
568 info->regs->regs_count);
572 ret = s5m8767_rtc_set_alarm_reg(info);
577 ret = s5m_rtc_start_alarm(info);
582 static int s5m_rtc_alarm_irq_enable(struct device *dev,
583 unsigned int enabled)
585 struct s5m_rtc_info *info = dev_get_drvdata(dev);
588 return s5m_rtc_start_alarm(info);
590 return s5m_rtc_stop_alarm(info);
593 static irqreturn_t s5m_rtc_alarm_irq(int irq, void *data)
595 struct s5m_rtc_info *info = data;
597 rtc_update_irq(info->rtc_dev, 1, RTC_IRQF | RTC_AF);
602 static const struct rtc_class_ops s5m_rtc_ops = {
603 .read_time = s5m_rtc_read_time,
604 .set_time = s5m_rtc_set_time,
605 .read_alarm = s5m_rtc_read_alarm,
606 .set_alarm = s5m_rtc_set_alarm,
607 .alarm_irq_enable = s5m_rtc_alarm_irq_enable,
610 static int s5m8767_rtc_init_reg(struct s5m_rtc_info *info)
615 switch (info->device_type) {
618 /* UDR update time. Default of 7.32 ms is too long. */
619 ret = regmap_update_bits(info->regmap, S5M_RTC_UDR_CON,
620 S5M_RTC_UDR_T_MASK, S5M_RTC_UDR_T_450_US);
622 dev_err(info->dev, "%s: fail to change UDR time: %d\n",
625 /* Set RTC control register : Binary mode, 24hour mode */
626 data[0] = (1 << BCD_EN_SHIFT) | (1 << MODEL24_SHIFT);
627 data[1] = (0 << BCD_EN_SHIFT) | (1 << MODEL24_SHIFT);
629 ret = regmap_raw_write(info->regmap, S5M_ALARM0_CONF, data, 2);
634 data[0] = (0 << BCD_EN_SHIFT) | (1 << MODEL24_SHIFT);
635 ret = regmap_write(info->regmap, info->regs->ctrl, data[0]);
642 info->rtc_24hr_mode = 1;
644 dev_err(info->dev, "%s: fail to write controlm reg(%d)\n",
652 static int s5m_rtc_probe(struct platform_device *pdev)
654 struct sec_pmic_dev *s5m87xx = dev_get_drvdata(pdev->dev.parent);
655 struct sec_platform_data *pdata = s5m87xx->pdata;
656 struct s5m_rtc_info *info;
657 const struct regmap_config *regmap_cfg;
661 dev_err(pdev->dev.parent, "Platform data not supplied\n");
665 info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
669 switch (pdata->device_type) {
672 regmap_cfg = &s2mps14_rtc_regmap_config;
673 info->regs = &s2mps_rtc_regs;
674 alarm_irq = S2MPS14_IRQ_RTCA0;
677 regmap_cfg = &s5m_rtc_regmap_config;
678 info->regs = &s5m_rtc_regs;
679 alarm_irq = S5M8763_IRQ_ALARM0;
682 regmap_cfg = &s5m_rtc_regmap_config;
683 info->regs = &s5m_rtc_regs;
684 alarm_irq = S5M8767_IRQ_RTCA1;
687 dev_err(&pdev->dev, "Device type is not supported by RTC driver\n");
691 info->i2c = i2c_new_dummy(s5m87xx->i2c->adapter, RTC_I2C_ADDR);
693 dev_err(&pdev->dev, "Failed to allocate I2C for RTC\n");
697 info->regmap = devm_regmap_init_i2c(info->i2c, regmap_cfg);
698 if (IS_ERR(info->regmap)) {
699 ret = PTR_ERR(info->regmap);
700 dev_err(&pdev->dev, "Failed to allocate RTC register map: %d\n",
705 info->dev = &pdev->dev;
706 info->s5m87xx = s5m87xx;
707 info->device_type = s5m87xx->device_type;
709 if (s5m87xx->irq_data) {
710 info->irq = regmap_irq_get_virq(s5m87xx->irq_data, alarm_irq);
711 if (info->irq <= 0) {
713 dev_err(&pdev->dev, "Failed to get virtual IRQ %d\n",
719 platform_set_drvdata(pdev, info);
721 ret = s5m8767_rtc_init_reg(info);
723 device_init_wakeup(&pdev->dev, 1);
725 info->rtc_dev = devm_rtc_device_register(&pdev->dev, "s5m-rtc",
726 &s5m_rtc_ops, THIS_MODULE);
728 if (IS_ERR(info->rtc_dev)) {
729 ret = PTR_ERR(info->rtc_dev);
734 dev_info(&pdev->dev, "Alarm IRQ not available\n");
738 ret = devm_request_threaded_irq(&pdev->dev, info->irq, NULL,
739 s5m_rtc_alarm_irq, 0, "rtc-alarm0",
742 dev_err(&pdev->dev, "Failed to request alarm IRQ: %d: %d\n",
750 i2c_unregister_device(info->i2c);
755 static int s5m_rtc_remove(struct platform_device *pdev)
757 struct s5m_rtc_info *info = platform_get_drvdata(pdev);
759 i2c_unregister_device(info->i2c);
764 #ifdef CONFIG_PM_SLEEP
765 static int s5m_rtc_resume(struct device *dev)
767 struct s5m_rtc_info *info = dev_get_drvdata(dev);
770 if (info->irq && device_may_wakeup(dev))
771 ret = disable_irq_wake(info->irq);
776 static int s5m_rtc_suspend(struct device *dev)
778 struct s5m_rtc_info *info = dev_get_drvdata(dev);
781 if (info->irq && device_may_wakeup(dev))
782 ret = enable_irq_wake(info->irq);
786 #endif /* CONFIG_PM_SLEEP */
788 static SIMPLE_DEV_PM_OPS(s5m_rtc_pm_ops, s5m_rtc_suspend, s5m_rtc_resume);
790 static const struct platform_device_id s5m_rtc_id[] = {
791 { "s5m-rtc", S5M8767X },
792 { "s2mps13-rtc", S2MPS13X },
793 { "s2mps14-rtc", S2MPS14X },
797 static struct platform_driver s5m_rtc_driver = {
800 .pm = &s5m_rtc_pm_ops,
802 .probe = s5m_rtc_probe,
803 .remove = s5m_rtc_remove,
804 .id_table = s5m_rtc_id,
807 module_platform_driver(s5m_rtc_driver);
809 /* Module information */
810 MODULE_AUTHOR("Sangbeom Kim <sbkim73@samsung.com>");
811 MODULE_DESCRIPTION("Samsung S5M/S2MPS14 RTC driver");
812 MODULE_LICENSE("GPL");
813 MODULE_ALIAS("platform:s5m-rtc");