2 * Copyright (c) 2011 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.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <linux/module.h>
23 #include <linux/i2c.h>
24 #include <linux/slab.h>
25 #include <linux/bcd.h>
26 #include <linux/bitops.h>
27 #include <linux/regmap.h>
28 #include <linux/rtc.h>
29 #include <linux/delay.h>
30 #include <linux/platform_device.h>
31 #include <linux/mfd/s5m87xx/s5m-core.h>
32 #include <linux/mfd/s5m87xx/s5m-rtc.h>
36 struct s5m87xx_dev *s5m87xx;
38 struct rtc_device *rtc_dev;
45 static void s5m8767_data_to_tm(u8 *data, struct rtc_time *tm,
48 tm->tm_sec = data[RTC_SEC] & 0x7f;
49 tm->tm_min = data[RTC_MIN] & 0x7f;
51 tm->tm_hour = data[RTC_HOUR] & 0x1f;
53 tm->tm_hour = data[RTC_HOUR] & 0x0f;
54 if (data[RTC_HOUR] & HOUR_PM_MASK)
58 tm->tm_wday = ffs(data[RTC_WEEKDAY] & 0x7f);
59 tm->tm_mday = data[RTC_DATE] & 0x1f;
60 tm->tm_mon = (data[RTC_MONTH] & 0x0f) - 1;
61 tm->tm_year = (data[RTC_YEAR1] & 0x7f) + 100;
66 static int s5m8767_tm_to_data(struct rtc_time *tm, u8 *data)
68 data[RTC_SEC] = tm->tm_sec;
69 data[RTC_MIN] = tm->tm_min;
71 if (tm->tm_hour >= 12)
72 data[RTC_HOUR] = tm->tm_hour | HOUR_PM_MASK;
74 data[RTC_HOUR] = tm->tm_hour & ~HOUR_PM_MASK;
76 data[RTC_WEEKDAY] = 1 << tm->tm_wday;
77 data[RTC_DATE] = tm->tm_mday;
78 data[RTC_MONTH] = tm->tm_mon + 1;
79 data[RTC_YEAR1] = tm->tm_year > 100 ? (tm->tm_year - 100) : 0 ;
81 if (tm->tm_year < 100) {
83 "s5m8767 RTC cannot handle the year %d.\n",
91 static inline int s5m8767_rtc_set_time_reg(struct s5m_rtc_info *info)
96 ret = regmap_read(info->rtc, S5M87XX_RTC_UDR_CON, &data);
98 dev_err(info->dev, "%s: fail to read update reg(%d)\n",
103 data |= RTC_TIME_EN_MASK;
104 data |= RTC_UDR_MASK;
106 ret = regmap_write(info->rtc, S5M87XX_RTC_UDR_CON, data);
108 dev_err(info->dev, "%s: fail to write update reg(%d)\n",
114 ret = regmap_read(info->rtc, S5M87XX_RTC_UDR_CON, &data);
115 } while ((data & RTC_UDR_MASK) && !ret);
120 static inline int s5m8767_rtc_set_alarm_reg(struct s5m_rtc_info *info)
125 ret = regmap_read(info->rtc, S5M87XX_RTC_UDR_CON, &data);
127 dev_err(info->dev, "%s: fail to read update reg(%d)\n",
132 data &= ~RTC_TIME_EN_MASK;
133 data |= RTC_UDR_MASK;
135 ret = regmap_write(info->rtc, S5M87XX_RTC_UDR_CON, data);
137 dev_err(info->dev, "%s: fail to write update reg(%d)\n",
143 ret = regmap_read(info->rtc, S5M87XX_RTC_UDR_CON, &data);
144 } while ((data & RTC_UDR_MASK) && !ret);
149 static void s5m8763_data_to_tm(u8 *data, struct rtc_time *tm)
151 tm->tm_sec = bcd2bin(data[RTC_SEC]);
152 tm->tm_min = bcd2bin(data[RTC_MIN]);
154 if (data[RTC_HOUR] & HOUR_12) {
155 tm->tm_hour = bcd2bin(data[RTC_HOUR] & 0x1f);
156 if (data[RTC_HOUR] & HOUR_PM)
159 tm->tm_hour = bcd2bin(data[RTC_HOUR] & 0x3f);
161 tm->tm_wday = data[RTC_WEEKDAY] & 0x07;
162 tm->tm_mday = bcd2bin(data[RTC_DATE]);
163 tm->tm_mon = bcd2bin(data[RTC_MONTH]);
164 tm->tm_year = bcd2bin(data[RTC_YEAR1]) + bcd2bin(data[RTC_YEAR2]) * 100;
168 static void s5m8763_tm_to_data(struct rtc_time *tm, u8 *data)
170 data[RTC_SEC] = bin2bcd(tm->tm_sec);
171 data[RTC_MIN] = bin2bcd(tm->tm_min);
172 data[RTC_HOUR] = bin2bcd(tm->tm_hour);
173 data[RTC_WEEKDAY] = tm->tm_wday;
174 data[RTC_DATE] = bin2bcd(tm->tm_mday);
175 data[RTC_MONTH] = bin2bcd(tm->tm_mon);
176 data[RTC_YEAR1] = bin2bcd(tm->tm_year % 100);
177 data[RTC_YEAR2] = bin2bcd((tm->tm_year + 1900) / 100);
180 static int s5m_rtc_read_time(struct device *dev, struct rtc_time *tm)
182 struct s5m_rtc_info *info = dev_get_drvdata(dev);
186 ret = regmap_bulk_read(info->rtc, S5M87XX_RTC_SEC, data, 8);
190 switch (info->device_type) {
192 s5m8763_data_to_tm(data, tm);
196 s5m8767_data_to_tm(data, tm, info->rtc_24hr_mode);
203 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
204 1900 + tm->tm_year, 1 + tm->tm_mon, tm->tm_mday,
205 tm->tm_hour, tm->tm_min, tm->tm_sec, tm->tm_wday);
207 return rtc_valid_tm(tm);
210 static int s5m_rtc_set_time(struct device *dev, struct rtc_time *tm)
212 struct s5m_rtc_info *info = dev_get_drvdata(dev);
216 switch (info->device_type) {
218 s5m8763_tm_to_data(tm, data);
221 ret = s5m8767_tm_to_data(tm, data);
230 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
231 1900 + tm->tm_year, 1 + tm->tm_mon, tm->tm_mday,
232 tm->tm_hour, tm->tm_min, tm->tm_sec, tm->tm_wday);
234 ret = regmap_raw_write(info->rtc, S5M87XX_RTC_SEC, data, 8);
238 ret = s5m8767_rtc_set_time_reg(info);
243 static int s5m_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
245 struct s5m_rtc_info *info = dev_get_drvdata(dev);
250 ret = regmap_bulk_read(info->rtc, S5M87XX_ALARM0_SEC, data, 8);
254 switch (info->device_type) {
256 s5m8763_data_to_tm(data, &alrm->time);
257 ret = regmap_read(info->rtc, S5M87XX_ALARM0_CONF, &val);
261 alrm->enabled = !!val;
263 ret = regmap_read(info->rtc, S5M87XX_RTC_STATUS, &val);
270 s5m8767_data_to_tm(data, &alrm->time, info->rtc_24hr_mode);
271 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
272 1900 + alrm->time.tm_year, 1 + alrm->time.tm_mon,
273 alrm->time.tm_mday, alrm->time.tm_hour,
274 alrm->time.tm_min, alrm->time.tm_sec,
278 for (i = 0; i < 7; i++) {
279 if (data[i] & ALARM_ENABLE_MASK) {
286 ret = regmap_read(info->rtc, S5M87XX_RTC_STATUS, &val);
295 if (val & ALARM0_STATUS)
303 static int s5m_rtc_stop_alarm(struct s5m_rtc_info *info)
309 ret = regmap_bulk_read(info->rtc, S5M87XX_ALARM0_SEC, data, 8);
313 s5m8767_data_to_tm(data, &tm, info->rtc_24hr_mode);
314 dev_dbg(info->dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
315 1900 + tm.tm_year, 1 + tm.tm_mon, tm.tm_mday,
316 tm.tm_hour, tm.tm_min, tm.tm_sec, tm.tm_wday);
318 switch (info->device_type) {
320 ret = regmap_write(info->rtc, S5M87XX_ALARM0_CONF, 0);
324 for (i = 0; i < 7; i++)
325 data[i] &= ~ALARM_ENABLE_MASK;
327 ret = regmap_raw_write(info->rtc, S5M87XX_ALARM0_SEC, data, 8);
331 ret = s5m8767_rtc_set_alarm_reg(info);
342 static int s5m_rtc_start_alarm(struct s5m_rtc_info *info)
349 ret = regmap_bulk_read(info->rtc, S5M87XX_ALARM0_SEC, data, 8);
353 s5m8767_data_to_tm(data, &tm, info->rtc_24hr_mode);
354 dev_dbg(info->dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
355 1900 + tm.tm_year, 1 + tm.tm_mon, tm.tm_mday,
356 tm.tm_hour, tm.tm_min, tm.tm_sec, tm.tm_wday);
358 switch (info->device_type) {
361 ret = regmap_write(info->rtc, S5M87XX_ALARM0_CONF, alarm0_conf);
365 data[RTC_SEC] |= ALARM_ENABLE_MASK;
366 data[RTC_MIN] |= ALARM_ENABLE_MASK;
367 data[RTC_HOUR] |= ALARM_ENABLE_MASK;
368 data[RTC_WEEKDAY] &= ~ALARM_ENABLE_MASK;
369 if (data[RTC_DATE] & 0x1f)
370 data[RTC_DATE] |= ALARM_ENABLE_MASK;
371 if (data[RTC_MONTH] & 0xf)
372 data[RTC_MONTH] |= ALARM_ENABLE_MASK;
373 if (data[RTC_YEAR1] & 0x7f)
374 data[RTC_YEAR1] |= ALARM_ENABLE_MASK;
376 ret = regmap_raw_write(info->rtc, S5M87XX_ALARM0_SEC, data, 8);
379 ret = s5m8767_rtc_set_alarm_reg(info);
390 static int s5m_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
392 struct s5m_rtc_info *info = dev_get_drvdata(dev);
396 switch (info->device_type) {
398 s5m8763_tm_to_data(&alrm->time, data);
402 s5m8767_tm_to_data(&alrm->time, data);
409 dev_dbg(dev, "%s: %d/%d/%d %d:%d:%d(%d)\n", __func__,
410 1900 + alrm->time.tm_year, 1 + alrm->time.tm_mon,
411 alrm->time.tm_mday, alrm->time.tm_hour, alrm->time.tm_min,
412 alrm->time.tm_sec, alrm->time.tm_wday);
414 ret = s5m_rtc_stop_alarm(info);
418 ret = regmap_raw_write(info->rtc, S5M87XX_ALARM0_SEC, data, 8);
422 ret = s5m8767_rtc_set_alarm_reg(info);
427 ret = s5m_rtc_start_alarm(info);
432 static int s5m_rtc_alarm_irq_enable(struct device *dev,
433 unsigned int enabled)
435 struct s5m_rtc_info *info = dev_get_drvdata(dev);
438 return s5m_rtc_start_alarm(info);
440 return s5m_rtc_stop_alarm(info);
443 static irqreturn_t s5m_rtc_alarm_irq(int irq, void *data)
445 struct s5m_rtc_info *info = data;
447 rtc_update_irq(info->rtc_dev, 1, RTC_IRQF | RTC_AF);
452 static const struct rtc_class_ops s5m_rtc_ops = {
453 .read_time = s5m_rtc_read_time,
454 .set_time = s5m_rtc_set_time,
455 .read_alarm = s5m_rtc_read_alarm,
456 .set_alarm = s5m_rtc_set_alarm,
457 .alarm_irq_enable = s5m_rtc_alarm_irq_enable,
460 static void s5m_rtc_enable_wtsr(struct s5m_rtc_info *info, bool enable)
463 ret = regmap_update_bits(info->rtc, S5M87XX_WTSR_SMPL_CNTL,
465 enable ? WTSR_ENABLE_MASK : 0);
467 dev_err(info->dev, "%s: fail to update WTSR reg(%d)\n",
471 static void s5m_rtc_enable_smpl(struct s5m_rtc_info *info, bool enable)
474 ret = regmap_update_bits(info->rtc, S5M87XX_WTSR_SMPL_CNTL,
476 enable ? SMPL_ENABLE_MASK : 0);
478 dev_err(info->dev, "%s: fail to update SMPL reg(%d)\n",
482 static int s5m8767_rtc_init_reg(struct s5m_rtc_info *info)
485 unsigned int tp_read;
489 ret = regmap_read(info->rtc, S5M87XX_RTC_UDR_CON, &tp_read);
491 dev_err(info->dev, "%s: fail to read control reg(%d)\n",
496 /* Set RTC control register : Binary mode, 24hour mode */
497 data[0] = (1 << BCD_EN_SHIFT) | (1 << MODEL24_SHIFT);
498 data[1] = (0 << BCD_EN_SHIFT) | (1 << MODEL24_SHIFT);
500 info->rtc_24hr_mode = 1;
501 ret = regmap_raw_write(info->rtc, S5M87XX_ALARM0_CONF, data, 2);
503 dev_err(info->dev, "%s: fail to write controlm reg(%d)\n",
508 /* In first boot time, Set rtc time to 1/1/2012 00:00:00(SUN) */
509 if ((tp_read & RTC_TCON_MASK) == 0) {
510 dev_dbg(info->dev, "rtc init\n");
520 ret = s5m_rtc_set_time(info->dev, &tm);
523 ret = regmap_update_bits(info->rtc, S5M87XX_RTC_UDR_CON,
524 RTC_TCON_MASK, tp_read | RTC_TCON_MASK);
526 dev_err(info->dev, "%s: fail to update TCON reg(%d)\n",
532 static int __devinit s5m_rtc_probe(struct platform_device *pdev)
534 struct s5m87xx_dev *s5m87xx = dev_get_drvdata(pdev->dev.parent);
535 struct s5m_platform_data *pdata = s5m87xx->pdata;
536 struct s5m_rtc_info *info;
540 dev_err(pdev->dev.parent, "Platform data not supplied\n");
544 info = devm_kzalloc(&pdev->dev, sizeof(struct s5m_rtc_info),
549 info->dev = &pdev->dev;
550 info->s5m87xx = s5m87xx;
551 info->rtc = s5m87xx->rtc;
552 info->device_type = s5m87xx->device_type;
553 info->wtsr_smpl = s5m87xx->wtsr_smpl;
555 switch (pdata->device_type) {
557 info->irq = s5m87xx->irq_base + S5M8763_IRQ_ALARM0;
561 info->irq = s5m87xx->irq_base + S5M8767_IRQ_RTCA1;
566 dev_err(&pdev->dev, "Unsupported device type: %d\n", ret);
570 platform_set_drvdata(pdev, info);
572 ret = s5m8767_rtc_init_reg(info);
574 if (info->wtsr_smpl) {
575 s5m_rtc_enable_wtsr(info, true);
576 s5m_rtc_enable_smpl(info, true);
579 device_init_wakeup(&pdev->dev, 1);
581 info->rtc_dev = rtc_device_register("s5m-rtc", &pdev->dev,
582 &s5m_rtc_ops, THIS_MODULE);
584 if (IS_ERR(info->rtc_dev)) {
585 ret = PTR_ERR(info->rtc_dev);
586 dev_err(&pdev->dev, "Failed to register RTC device: %d\n", ret);
590 ret = request_threaded_irq(info->irq, NULL, s5m_rtc_alarm_irq, 0,
594 dev_err(&pdev->dev, "Failed to request alarm IRQ: %d: %d\n",
597 dev_info(&pdev->dev, "RTC CHIP NAME: %s\n", pdev->id_entry->name);
602 static int __devexit s5m_rtc_remove(struct platform_device *pdev)
604 struct s5m_rtc_info *info = platform_get_drvdata(pdev);
607 free_irq(info->irq, info);
608 rtc_device_unregister(info->rtc_dev);
614 static void s5m_rtc_shutdown(struct platform_device *pdev)
616 struct s5m_rtc_info *info = platform_get_drvdata(pdev);
618 unsigned int val = 0;
619 if (info->wtsr_smpl) {
620 for (i = 0; i < 3; i++) {
621 s5m_rtc_enable_wtsr(info, false);
622 regmap_read(info->rtc, S5M87XX_WTSR_SMPL_CNTL, &val);
623 pr_debug("%s: WTSR_SMPL reg(0x%02x)\n", __func__, val);
624 if (val & WTSR_ENABLE_MASK)
625 pr_emerg("%s: fail to disable WTSR\n",
628 pr_info("%s: success to disable WTSR\n",
634 /* Disable SMPL when power off */
635 s5m_rtc_enable_smpl(info, false);
638 static const struct platform_device_id s5m_rtc_id[] = {
642 static struct platform_driver s5m_rtc_driver = {
645 .owner = THIS_MODULE,
647 .probe = s5m_rtc_probe,
648 .remove = __devexit_p(s5m_rtc_remove),
649 .shutdown = s5m_rtc_shutdown,
650 .id_table = s5m_rtc_id,
653 module_platform_driver(s5m_rtc_driver);
655 /* Module information */
656 MODULE_AUTHOR("Sangbeom Kim <sbkim73@samsung.com>");
657 MODULE_DESCRIPTION("Samsung S5M RTC driver");
658 MODULE_LICENSE("GPL");
659 MODULE_ALIAS("platform:s5m-rtc");