1 // SPDX-License-Identifier: GPL-2.0+
3 // Copyright (c) 2013-2014 Samsung Electronics Co., Ltd
4 // http://www.samsung.com
6 // Copyright (C) 2013 Google, Inc
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10 #include <linux/module.h>
11 #include <linux/i2c.h>
12 #include <linux/bcd.h>
13 #include <linux/regmap.h>
14 #include <linux/rtc.h>
15 #include <linux/platform_device.h>
16 #include <linux/mfd/samsung/core.h>
17 #include <linux/mfd/samsung/irq.h>
18 #include <linux/mfd/samsung/rtc.h>
19 #include <linux/mfd/samsung/s2mps14.h>
22 * Maximum number of retries for checking changes in UDR field
23 * of S5M_RTC_UDR_CON register (to limit possible endless loop).
25 * After writing to RTC registers (setting time or alarm) read the UDR field
26 * in S5M_RTC_UDR_CON register. UDR is auto-cleared when data have
29 #define UDR_READ_RETRY_CNT 5
40 /* Make sure this is always the last enum name. */
45 * Registers used by the driver which are different between chipsets.
47 * Operations like read time and write alarm/time require updating
48 * specific fields in UDR register. These fields usually are auto-cleared
49 * (with some exceptions).
51 * Table of operations per device:
53 * Device | Write time | Read time | Write alarm
54 * =================================================
55 * S5M8767 | UDR + TIME | | UDR
56 * S2MPS11/14 | WUDR | RUDR | WUDR + RUDR
57 * S2MPS13 | WUDR | RUDR | WUDR + AUDR
58 * S2MPS15 | WUDR | RUDR | AUDR
60 struct s5m_rtc_reg_config
{
61 /* Number of registers used for setting time/alarm0/alarm1 */
62 unsigned int regs_count
;
63 /* First register for time, seconds */
65 /* RTC control register */
67 /* First register for alarm 0, seconds */
69 /* First register for alarm 1, seconds */
72 * Register for update flag (UDR). Typically setting UDR field to 1
73 * will enable update of time or alarm register. Then it will be
74 * auto-cleared after successful update.
76 unsigned int udr_update
;
77 /* Auto-cleared mask in UDR field for writing time and alarm */
78 unsigned int autoclear_udr_mask
;
80 * Masks in UDR field for time and alarm operations.
81 * The read time mask can be 0. Rest should not.
83 unsigned int read_time_udr_mask
;
84 unsigned int write_time_udr_mask
;
85 unsigned int write_alarm_udr_mask
;
88 /* Register map for S5M8767 */
89 static const struct s5m_rtc_reg_config s5m_rtc_regs
= {
92 .ctrl
= S5M_ALARM1_CONF
,
93 .alarm0
= S5M_ALARM0_SEC
,
94 .alarm1
= S5M_ALARM1_SEC
,
95 .udr_update
= S5M_RTC_UDR_CON
,
96 .autoclear_udr_mask
= S5M_RTC_UDR_MASK
,
97 .read_time_udr_mask
= 0, /* Not needed */
98 .write_time_udr_mask
= S5M_RTC_UDR_MASK
| S5M_RTC_TIME_EN_MASK
,
99 .write_alarm_udr_mask
= S5M_RTC_UDR_MASK
,
102 /* Register map for S2MPS13 */
103 static const struct s5m_rtc_reg_config s2mps13_rtc_regs
= {
105 .time
= S2MPS_RTC_SEC
,
106 .ctrl
= S2MPS_RTC_CTRL
,
107 .alarm0
= S2MPS_ALARM0_SEC
,
108 .alarm1
= S2MPS_ALARM1_SEC
,
109 .udr_update
= S2MPS_RTC_UDR_CON
,
110 .autoclear_udr_mask
= S2MPS_RTC_WUDR_MASK
,
111 .read_time_udr_mask
= S2MPS_RTC_RUDR_MASK
,
112 .write_time_udr_mask
= S2MPS_RTC_WUDR_MASK
,
113 .write_alarm_udr_mask
= S2MPS_RTC_WUDR_MASK
| S2MPS13_RTC_AUDR_MASK
,
116 /* Register map for S2MPS11/14 */
117 static const struct s5m_rtc_reg_config s2mps14_rtc_regs
= {
119 .time
= S2MPS_RTC_SEC
,
120 .ctrl
= S2MPS_RTC_CTRL
,
121 .alarm0
= S2MPS_ALARM0_SEC
,
122 .alarm1
= S2MPS_ALARM1_SEC
,
123 .udr_update
= S2MPS_RTC_UDR_CON
,
124 .autoclear_udr_mask
= S2MPS_RTC_WUDR_MASK
,
125 .read_time_udr_mask
= S2MPS_RTC_RUDR_MASK
,
126 .write_time_udr_mask
= S2MPS_RTC_WUDR_MASK
,
127 .write_alarm_udr_mask
= S2MPS_RTC_WUDR_MASK
| S2MPS_RTC_RUDR_MASK
,
131 * Register map for S2MPS15 - in comparison to S2MPS14 the WUDR and AUDR bits
134 static const struct s5m_rtc_reg_config s2mps15_rtc_regs
= {
136 .time
= S2MPS_RTC_SEC
,
137 .ctrl
= S2MPS_RTC_CTRL
,
138 .alarm0
= S2MPS_ALARM0_SEC
,
139 .alarm1
= S2MPS_ALARM1_SEC
,
140 .udr_update
= S2MPS_RTC_UDR_CON
,
141 .autoclear_udr_mask
= S2MPS_RTC_WUDR_MASK
,
142 .read_time_udr_mask
= S2MPS_RTC_RUDR_MASK
,
143 .write_time_udr_mask
= S2MPS15_RTC_WUDR_MASK
,
144 .write_alarm_udr_mask
= S2MPS15_RTC_AUDR_MASK
,
147 struct s5m_rtc_info
{
149 struct i2c_client
*i2c
;
150 struct sec_pmic_dev
*s5m87xx
;
151 struct regmap
*regmap
;
152 struct rtc_device
*rtc_dev
;
154 enum sec_device_type device_type
;
156 const struct s5m_rtc_reg_config
*regs
;
159 static const struct regmap_config s5m_rtc_regmap_config
= {
163 .max_register
= S5M_RTC_REG_MAX
,
166 static const struct regmap_config s2mps14_rtc_regmap_config
= {
170 .max_register
= S2MPS_RTC_REG_MAX
,
173 static void s5m8767_data_to_tm(u8
*data
, struct rtc_time
*tm
,
176 tm
->tm_sec
= data
[RTC_SEC
] & 0x7f;
177 tm
->tm_min
= data
[RTC_MIN
] & 0x7f;
179 tm
->tm_hour
= data
[RTC_HOUR
] & 0x1f;
181 tm
->tm_hour
= data
[RTC_HOUR
] & 0x0f;
182 if (data
[RTC_HOUR
] & HOUR_PM_MASK
)
186 tm
->tm_wday
= ffs(data
[RTC_WEEKDAY
] & 0x7f);
187 tm
->tm_mday
= data
[RTC_DATE
] & 0x1f;
188 tm
->tm_mon
= (data
[RTC_MONTH
] & 0x0f) - 1;
189 tm
->tm_year
= (data
[RTC_YEAR1
] & 0x7f) + 100;
194 static int s5m8767_tm_to_data(struct rtc_time
*tm
, u8
*data
)
196 data
[RTC_SEC
] = tm
->tm_sec
;
197 data
[RTC_MIN
] = tm
->tm_min
;
199 if (tm
->tm_hour
>= 12)
200 data
[RTC_HOUR
] = tm
->tm_hour
| HOUR_PM_MASK
;
202 data
[RTC_HOUR
] = tm
->tm_hour
& ~HOUR_PM_MASK
;
204 data
[RTC_WEEKDAY
] = 1 << tm
->tm_wday
;
205 data
[RTC_DATE
] = tm
->tm_mday
;
206 data
[RTC_MONTH
] = tm
->tm_mon
+ 1;
207 data
[RTC_YEAR1
] = tm
->tm_year
- 100;
213 * Read RTC_UDR_CON register and wait till UDR field is cleared.
214 * This indicates that time/alarm update ended.
216 static int s5m8767_wait_for_udr_update(struct s5m_rtc_info
*info
)
218 int ret
, retry
= UDR_READ_RETRY_CNT
;
222 ret
= regmap_read(info
->regmap
, info
->regs
->udr_update
, &data
);
223 } while (--retry
&& (data
& info
->regs
->autoclear_udr_mask
) && !ret
);
226 dev_err(info
->dev
, "waiting for UDR update, reached max number of retries\n");
231 static int s5m_check_peding_alarm_interrupt(struct s5m_rtc_info
*info
,
232 struct rtc_wkalrm
*alarm
)
237 switch (info
->device_type
) {
239 ret
= regmap_read(info
->regmap
, S5M_RTC_STATUS
, &val
);
240 val
&= S5M_ALARM0_STATUS
;
245 ret
= regmap_read(info
->s5m87xx
->regmap_pmic
, S2MPS14_REG_ST2
,
247 val
&= S2MPS_ALARM0_STATUS
;
263 static int s5m8767_rtc_set_time_reg(struct s5m_rtc_info
*info
)
268 ret
= regmap_read(info
->regmap
, info
->regs
->udr_update
, &data
);
270 dev_err(info
->dev
, "failed to read update reg(%d)\n", ret
);
274 data
|= info
->regs
->write_time_udr_mask
;
276 ret
= regmap_write(info
->regmap
, info
->regs
->udr_update
, data
);
278 dev_err(info
->dev
, "failed to write update reg(%d)\n", ret
);
282 ret
= s5m8767_wait_for_udr_update(info
);
287 static int s5m8767_rtc_set_alarm_reg(struct s5m_rtc_info
*info
)
292 ret
= regmap_read(info
->regmap
, info
->regs
->udr_update
, &data
);
294 dev_err(info
->dev
, "%s: fail to read update reg(%d)\n",
299 data
|= info
->regs
->write_alarm_udr_mask
;
300 switch (info
->device_type
) {
302 data
&= ~S5M_RTC_TIME_EN_MASK
;
307 /* No exceptions needed */
313 ret
= regmap_write(info
->regmap
, info
->regs
->udr_update
, data
);
315 dev_err(info
->dev
, "%s: fail to write update reg(%d)\n",
320 ret
= s5m8767_wait_for_udr_update(info
);
322 /* On S2MPS13 the AUDR is not auto-cleared */
323 if (info
->device_type
== S2MPS13X
)
324 regmap_update_bits(info
->regmap
, info
->regs
->udr_update
,
325 S2MPS13_RTC_AUDR_MASK
, 0);
330 static int s5m_rtc_read_time(struct device
*dev
, struct rtc_time
*tm
)
332 struct s5m_rtc_info
*info
= dev_get_drvdata(dev
);
333 u8 data
[RTC_MAX_NUM_TIME_REGS
];
336 if (info
->regs
->read_time_udr_mask
) {
337 ret
= regmap_update_bits(info
->regmap
,
338 info
->regs
->udr_update
,
339 info
->regs
->read_time_udr_mask
,
340 info
->regs
->read_time_udr_mask
);
343 "Failed to prepare registers for time reading: %d\n",
348 ret
= regmap_bulk_read(info
->regmap
, info
->regs
->time
, data
,
349 info
->regs
->regs_count
);
353 switch (info
->device_type
) {
358 s5m8767_data_to_tm(data
, tm
, info
->rtc_24hr_mode
);
365 dev_dbg(dev
, "%s: %ptR(%d)\n", __func__
, tm
, tm
->tm_wday
);
370 static int s5m_rtc_set_time(struct device
*dev
, struct rtc_time
*tm
)
372 struct s5m_rtc_info
*info
= dev_get_drvdata(dev
);
373 u8 data
[RTC_MAX_NUM_TIME_REGS
];
376 switch (info
->device_type
) {
381 ret
= s5m8767_tm_to_data(tm
, data
);
390 dev_dbg(dev
, "%s: %ptR(%d)\n", __func__
, tm
, tm
->tm_wday
);
392 ret
= regmap_raw_write(info
->regmap
, info
->regs
->time
, data
,
393 info
->regs
->regs_count
);
397 ret
= s5m8767_rtc_set_time_reg(info
);
402 static int s5m_rtc_read_alarm(struct device
*dev
, struct rtc_wkalrm
*alrm
)
404 struct s5m_rtc_info
*info
= dev_get_drvdata(dev
);
405 u8 data
[RTC_MAX_NUM_TIME_REGS
];
408 ret
= regmap_bulk_read(info
->regmap
, info
->regs
->alarm0
, data
,
409 info
->regs
->regs_count
);
413 switch (info
->device_type
) {
418 s5m8767_data_to_tm(data
, &alrm
->time
, info
->rtc_24hr_mode
);
420 for (i
= 0; i
< info
->regs
->regs_count
; i
++) {
421 if (data
[i
] & ALARM_ENABLE_MASK
) {
432 dev_dbg(dev
, "%s: %ptR(%d)\n", __func__
, &alrm
->time
, alrm
->time
.tm_wday
);
434 return s5m_check_peding_alarm_interrupt(info
, alrm
);
437 static int s5m_rtc_stop_alarm(struct s5m_rtc_info
*info
)
439 u8 data
[RTC_MAX_NUM_TIME_REGS
];
443 ret
= regmap_bulk_read(info
->regmap
, info
->regs
->alarm0
, data
,
444 info
->regs
->regs_count
);
448 s5m8767_data_to_tm(data
, &tm
, info
->rtc_24hr_mode
);
449 dev_dbg(info
->dev
, "%s: %ptR(%d)\n", __func__
, &tm
, tm
.tm_wday
);
451 switch (info
->device_type
) {
456 for (i
= 0; i
< info
->regs
->regs_count
; i
++)
457 data
[i
] &= ~ALARM_ENABLE_MASK
;
459 ret
= regmap_raw_write(info
->regmap
, info
->regs
->alarm0
, data
,
460 info
->regs
->regs_count
);
464 ret
= s5m8767_rtc_set_alarm_reg(info
);
475 static int s5m_rtc_start_alarm(struct s5m_rtc_info
*info
)
478 u8 data
[RTC_MAX_NUM_TIME_REGS
];
481 ret
= regmap_bulk_read(info
->regmap
, info
->regs
->alarm0
, data
,
482 info
->regs
->regs_count
);
486 s5m8767_data_to_tm(data
, &tm
, info
->rtc_24hr_mode
);
487 dev_dbg(info
->dev
, "%s: %ptR(%d)\n", __func__
, &tm
, tm
.tm_wday
);
489 switch (info
->device_type
) {
494 data
[RTC_SEC
] |= ALARM_ENABLE_MASK
;
495 data
[RTC_MIN
] |= ALARM_ENABLE_MASK
;
496 data
[RTC_HOUR
] |= ALARM_ENABLE_MASK
;
497 data
[RTC_WEEKDAY
] &= ~ALARM_ENABLE_MASK
;
498 if (data
[RTC_DATE
] & 0x1f)
499 data
[RTC_DATE
] |= ALARM_ENABLE_MASK
;
500 if (data
[RTC_MONTH
] & 0xf)
501 data
[RTC_MONTH
] |= ALARM_ENABLE_MASK
;
502 if (data
[RTC_YEAR1
] & 0x7f)
503 data
[RTC_YEAR1
] |= ALARM_ENABLE_MASK
;
505 ret
= regmap_raw_write(info
->regmap
, info
->regs
->alarm0
, data
,
506 info
->regs
->regs_count
);
509 ret
= s5m8767_rtc_set_alarm_reg(info
);
520 static int s5m_rtc_set_alarm(struct device
*dev
, struct rtc_wkalrm
*alrm
)
522 struct s5m_rtc_info
*info
= dev_get_drvdata(dev
);
523 u8 data
[RTC_MAX_NUM_TIME_REGS
];
526 switch (info
->device_type
) {
531 s5m8767_tm_to_data(&alrm
->time
, data
);
538 dev_dbg(dev
, "%s: %ptR(%d)\n", __func__
, &alrm
->time
, alrm
->time
.tm_wday
);
540 ret
= s5m_rtc_stop_alarm(info
);
544 ret
= regmap_raw_write(info
->regmap
, info
->regs
->alarm0
, data
,
545 info
->regs
->regs_count
);
549 ret
= s5m8767_rtc_set_alarm_reg(info
);
554 ret
= s5m_rtc_start_alarm(info
);
559 static int s5m_rtc_alarm_irq_enable(struct device
*dev
,
560 unsigned int enabled
)
562 struct s5m_rtc_info
*info
= dev_get_drvdata(dev
);
565 return s5m_rtc_start_alarm(info
);
567 return s5m_rtc_stop_alarm(info
);
570 static irqreturn_t
s5m_rtc_alarm_irq(int irq
, void *data
)
572 struct s5m_rtc_info
*info
= data
;
574 rtc_update_irq(info
->rtc_dev
, 1, RTC_IRQF
| RTC_AF
);
579 static const struct rtc_class_ops s5m_rtc_ops
= {
580 .read_time
= s5m_rtc_read_time
,
581 .set_time
= s5m_rtc_set_time
,
582 .read_alarm
= s5m_rtc_read_alarm
,
583 .set_alarm
= s5m_rtc_set_alarm
,
584 .alarm_irq_enable
= s5m_rtc_alarm_irq_enable
,
587 static int s5m8767_rtc_init_reg(struct s5m_rtc_info
*info
)
592 switch (info
->device_type
) {
594 /* UDR update time. Default of 7.32 ms is too long. */
595 ret
= regmap_update_bits(info
->regmap
, S5M_RTC_UDR_CON
,
596 S5M_RTC_UDR_T_MASK
, S5M_RTC_UDR_T_450_US
);
598 dev_err(info
->dev
, "%s: fail to change UDR time: %d\n",
601 /* Set RTC control register : Binary mode, 24hour mode */
602 data
[0] = (1 << BCD_EN_SHIFT
) | (1 << MODEL24_SHIFT
);
603 data
[1] = (0 << BCD_EN_SHIFT
) | (1 << MODEL24_SHIFT
);
605 ret
= regmap_raw_write(info
->regmap
, S5M_ALARM0_CONF
, data
, 2);
611 data
[0] = (0 << BCD_EN_SHIFT
) | (1 << MODEL24_SHIFT
);
612 ret
= regmap_write(info
->regmap
, info
->regs
->ctrl
, data
[0]);
617 * Should set WUDR & (RUDR or AUDR) bits to high after writing
618 * RTC_CTRL register like writing Alarm registers. We can't find
619 * the description from datasheet but vendor code does that
622 ret
= s5m8767_rtc_set_alarm_reg(info
);
629 info
->rtc_24hr_mode
= 1;
631 dev_err(info
->dev
, "%s: fail to write controlm reg(%d)\n",
639 static int s5m_rtc_probe(struct platform_device
*pdev
)
641 struct sec_pmic_dev
*s5m87xx
= dev_get_drvdata(pdev
->dev
.parent
);
642 struct s5m_rtc_info
*info
;
643 const struct regmap_config
*regmap_cfg
;
646 info
= devm_kzalloc(&pdev
->dev
, sizeof(*info
), GFP_KERNEL
);
650 switch (platform_get_device_id(pdev
)->driver_data
) {
652 regmap_cfg
= &s2mps14_rtc_regmap_config
;
653 info
->regs
= &s2mps15_rtc_regs
;
654 alarm_irq
= S2MPS14_IRQ_RTCA0
;
657 regmap_cfg
= &s2mps14_rtc_regmap_config
;
658 info
->regs
= &s2mps14_rtc_regs
;
659 alarm_irq
= S2MPS14_IRQ_RTCA0
;
662 regmap_cfg
= &s2mps14_rtc_regmap_config
;
663 info
->regs
= &s2mps13_rtc_regs
;
664 alarm_irq
= S2MPS14_IRQ_RTCA0
;
667 regmap_cfg
= &s5m_rtc_regmap_config
;
668 info
->regs
= &s5m_rtc_regs
;
669 alarm_irq
= S5M8767_IRQ_RTCA1
;
673 "Device type %lu is not supported by RTC driver\n",
674 platform_get_device_id(pdev
)->driver_data
);
678 info
->i2c
= devm_i2c_new_dummy_device(&pdev
->dev
, s5m87xx
->i2c
->adapter
,
680 if (IS_ERR(info
->i2c
)) {
681 dev_err(&pdev
->dev
, "Failed to allocate I2C for RTC\n");
682 return PTR_ERR(info
->i2c
);
685 info
->regmap
= devm_regmap_init_i2c(info
->i2c
, regmap_cfg
);
686 if (IS_ERR(info
->regmap
)) {
687 ret
= PTR_ERR(info
->regmap
);
688 dev_err(&pdev
->dev
, "Failed to allocate RTC register map: %d\n",
693 info
->dev
= &pdev
->dev
;
694 info
->s5m87xx
= s5m87xx
;
695 info
->device_type
= platform_get_device_id(pdev
)->driver_data
;
697 if (s5m87xx
->irq_data
) {
698 info
->irq
= regmap_irq_get_virq(s5m87xx
->irq_data
, alarm_irq
);
699 if (info
->irq
<= 0) {
700 dev_err(&pdev
->dev
, "Failed to get virtual IRQ %d\n",
706 platform_set_drvdata(pdev
, info
);
708 ret
= s5m8767_rtc_init_reg(info
);
712 info
->rtc_dev
= devm_rtc_allocate_device(&pdev
->dev
);
713 if (IS_ERR(info
->rtc_dev
))
714 return PTR_ERR(info
->rtc_dev
);
716 info
->rtc_dev
->ops
= &s5m_rtc_ops
;
718 info
->rtc_dev
->range_min
= RTC_TIMESTAMP_BEGIN_2000
;
719 info
->rtc_dev
->range_max
= RTC_TIMESTAMP_END_2099
;
722 clear_bit(RTC_FEATURE_ALARM
, info
->rtc_dev
->features
);
724 ret
= devm_request_threaded_irq(&pdev
->dev
, info
->irq
, NULL
,
725 s5m_rtc_alarm_irq
, 0, "rtc-alarm0",
728 dev_err(&pdev
->dev
, "Failed to request alarm IRQ: %d: %d\n",
732 device_init_wakeup(&pdev
->dev
, 1);
735 return devm_rtc_register_device(info
->rtc_dev
);
738 #ifdef CONFIG_PM_SLEEP
739 static int s5m_rtc_resume(struct device
*dev
)
741 struct s5m_rtc_info
*info
= dev_get_drvdata(dev
);
744 if (info
->irq
&& device_may_wakeup(dev
))
745 ret
= disable_irq_wake(info
->irq
);
750 static int s5m_rtc_suspend(struct device
*dev
)
752 struct s5m_rtc_info
*info
= dev_get_drvdata(dev
);
755 if (info
->irq
&& device_may_wakeup(dev
))
756 ret
= enable_irq_wake(info
->irq
);
760 #endif /* CONFIG_PM_SLEEP */
762 static SIMPLE_DEV_PM_OPS(s5m_rtc_pm_ops
, s5m_rtc_suspend
, s5m_rtc_resume
);
764 static const struct platform_device_id s5m_rtc_id
[] = {
765 { "s5m-rtc", S5M8767X
},
766 { "s2mps13-rtc", S2MPS13X
},
767 { "s2mps14-rtc", S2MPS14X
},
768 { "s2mps15-rtc", S2MPS15X
},
771 MODULE_DEVICE_TABLE(platform
, s5m_rtc_id
);
773 static struct platform_driver s5m_rtc_driver
= {
776 .pm
= &s5m_rtc_pm_ops
,
778 .probe
= s5m_rtc_probe
,
779 .id_table
= s5m_rtc_id
,
782 module_platform_driver(s5m_rtc_driver
);
784 /* Module information */
785 MODULE_AUTHOR("Sangbeom Kim <sbkim73@samsung.com>");
786 MODULE_DESCRIPTION("Samsung S5M/S2MPS14 RTC driver");
787 MODULE_LICENSE("GPL");