xref: /openbmc/linux/drivers/rtc/rtc-mt6397.c (revision 82df5b73)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * Copyright (c) 2014-2015 MediaTek Inc.
4 * Author: Tianping.Fang <tianping.fang@mediatek.com>
5 */
6 
7 #include <linux/err.h>
8 #include <linux/interrupt.h>
9 #include <linux/mfd/mt6397/core.h>
10 #include <linux/module.h>
11 #include <linux/mutex.h>
12 #include <linux/of_device.h>
13 #include <linux/platform_device.h>
14 #include <linux/regmap.h>
15 #include <linux/rtc.h>
16 #include <linux/mfd/mt6397/rtc.h>
17 #include <linux/mod_devicetable.h>
18 
19 static int mtk_rtc_write_trigger(struct mt6397_rtc *rtc)
20 {
21 	int ret;
22 	u32 data;
23 
24 	ret = regmap_write(rtc->regmap, rtc->addr_base + rtc->data->wrtgr, 1);
25 	if (ret < 0)
26 		return ret;
27 
28 	ret = regmap_read_poll_timeout(rtc->regmap,
29 					rtc->addr_base + RTC_BBPU, data,
30 					!(data & RTC_BBPU_CBUSY),
31 					MTK_RTC_POLL_DELAY_US,
32 					MTK_RTC_POLL_TIMEOUT);
33 	if (ret < 0)
34 		dev_err(rtc->dev, "failed to write WRTGE: %d\n", ret);
35 
36 	return ret;
37 }
38 
39 static irqreturn_t mtk_rtc_irq_handler_thread(int irq, void *data)
40 {
41 	struct mt6397_rtc *rtc = data;
42 	u32 irqsta, irqen;
43 	int ret;
44 
45 	ret = regmap_read(rtc->regmap, rtc->addr_base + RTC_IRQ_STA, &irqsta);
46 	if ((ret >= 0) && (irqsta & RTC_IRQ_STA_AL)) {
47 		rtc_update_irq(rtc->rtc_dev, 1, RTC_IRQF | RTC_AF);
48 		irqen = irqsta & ~RTC_IRQ_EN_AL;
49 		mutex_lock(&rtc->lock);
50 		if (regmap_write(rtc->regmap, rtc->addr_base + RTC_IRQ_EN,
51 				 irqen) == 0)
52 			mtk_rtc_write_trigger(rtc);
53 		mutex_unlock(&rtc->lock);
54 
55 		return IRQ_HANDLED;
56 	}
57 
58 	return IRQ_NONE;
59 }
60 
61 static int __mtk_rtc_read_time(struct mt6397_rtc *rtc,
62 			       struct rtc_time *tm, int *sec)
63 {
64 	int ret;
65 	u16 data[RTC_OFFSET_COUNT];
66 
67 	mutex_lock(&rtc->lock);
68 	ret = regmap_bulk_read(rtc->regmap, rtc->addr_base + RTC_TC_SEC,
69 			       data, RTC_OFFSET_COUNT);
70 	if (ret < 0)
71 		goto exit;
72 
73 	tm->tm_sec = data[RTC_OFFSET_SEC];
74 	tm->tm_min = data[RTC_OFFSET_MIN];
75 	tm->tm_hour = data[RTC_OFFSET_HOUR];
76 	tm->tm_mday = data[RTC_OFFSET_DOM];
77 	tm->tm_mon = data[RTC_OFFSET_MTH];
78 	tm->tm_year = data[RTC_OFFSET_YEAR];
79 
80 	ret = regmap_read(rtc->regmap, rtc->addr_base + RTC_TC_SEC, sec);
81 exit:
82 	mutex_unlock(&rtc->lock);
83 	return ret;
84 }
85 
86 static int mtk_rtc_read_time(struct device *dev, struct rtc_time *tm)
87 {
88 	time64_t time;
89 	struct mt6397_rtc *rtc = dev_get_drvdata(dev);
90 	int days, sec, ret;
91 
92 	do {
93 		ret = __mtk_rtc_read_time(rtc, tm, &sec);
94 		if (ret < 0)
95 			goto exit;
96 	} while (sec < tm->tm_sec);
97 
98 	/* HW register use 7 bits to store year data, minus
99 	 * RTC_MIN_YEAR_OFFSET before write year data to register, and plus
100 	 * RTC_MIN_YEAR_OFFSET back after read year from register
101 	 */
102 	tm->tm_year += RTC_MIN_YEAR_OFFSET;
103 
104 	/* HW register start mon from one, but tm_mon start from zero. */
105 	tm->tm_mon--;
106 	time = rtc_tm_to_time64(tm);
107 
108 	/* rtc_tm_to_time64 covert Gregorian date to seconds since
109 	 * 01-01-1970 00:00:00, and this date is Thursday.
110 	 */
111 	days = div_s64(time, 86400);
112 	tm->tm_wday = (days + 4) % 7;
113 
114 exit:
115 	return ret;
116 }
117 
118 static int mtk_rtc_set_time(struct device *dev, struct rtc_time *tm)
119 {
120 	struct mt6397_rtc *rtc = dev_get_drvdata(dev);
121 	int ret;
122 	u16 data[RTC_OFFSET_COUNT];
123 
124 	tm->tm_year -= RTC_MIN_YEAR_OFFSET;
125 	tm->tm_mon++;
126 
127 	data[RTC_OFFSET_SEC] = tm->tm_sec;
128 	data[RTC_OFFSET_MIN] = tm->tm_min;
129 	data[RTC_OFFSET_HOUR] = tm->tm_hour;
130 	data[RTC_OFFSET_DOM] = tm->tm_mday;
131 	data[RTC_OFFSET_MTH] = tm->tm_mon;
132 	data[RTC_OFFSET_YEAR] = tm->tm_year;
133 
134 	mutex_lock(&rtc->lock);
135 	ret = regmap_bulk_write(rtc->regmap, rtc->addr_base + RTC_TC_SEC,
136 				data, RTC_OFFSET_COUNT);
137 	if (ret < 0)
138 		goto exit;
139 
140 	/* Time register write to hardware after call trigger function */
141 	ret = mtk_rtc_write_trigger(rtc);
142 
143 exit:
144 	mutex_unlock(&rtc->lock);
145 	return ret;
146 }
147 
148 static int mtk_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alm)
149 {
150 	struct rtc_time *tm = &alm->time;
151 	struct mt6397_rtc *rtc = dev_get_drvdata(dev);
152 	u32 irqen, pdn2;
153 	int ret;
154 	u16 data[RTC_OFFSET_COUNT];
155 
156 	mutex_lock(&rtc->lock);
157 	ret = regmap_read(rtc->regmap, rtc->addr_base + RTC_IRQ_EN, &irqen);
158 	if (ret < 0)
159 		goto err_exit;
160 	ret = regmap_read(rtc->regmap, rtc->addr_base + RTC_PDN2, &pdn2);
161 	if (ret < 0)
162 		goto err_exit;
163 
164 	ret = regmap_bulk_read(rtc->regmap, rtc->addr_base + RTC_AL_SEC,
165 			       data, RTC_OFFSET_COUNT);
166 	if (ret < 0)
167 		goto err_exit;
168 
169 	alm->enabled = !!(irqen & RTC_IRQ_EN_AL);
170 	alm->pending = !!(pdn2 & RTC_PDN2_PWRON_ALARM);
171 	mutex_unlock(&rtc->lock);
172 
173 	tm->tm_sec = data[RTC_OFFSET_SEC] & RTC_AL_SEC_MASK;
174 	tm->tm_min = data[RTC_OFFSET_MIN] & RTC_AL_MIN_MASK;
175 	tm->tm_hour = data[RTC_OFFSET_HOUR] & RTC_AL_HOU_MASK;
176 	tm->tm_mday = data[RTC_OFFSET_DOM] & RTC_AL_DOM_MASK;
177 	tm->tm_mon = data[RTC_OFFSET_MTH] & RTC_AL_MTH_MASK;
178 	tm->tm_year = data[RTC_OFFSET_YEAR] & RTC_AL_YEA_MASK;
179 
180 	tm->tm_year += RTC_MIN_YEAR_OFFSET;
181 	tm->tm_mon--;
182 
183 	return 0;
184 err_exit:
185 	mutex_unlock(&rtc->lock);
186 	return ret;
187 }
188 
189 static int mtk_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alm)
190 {
191 	struct rtc_time *tm = &alm->time;
192 	struct mt6397_rtc *rtc = dev_get_drvdata(dev);
193 	int ret;
194 	u16 data[RTC_OFFSET_COUNT];
195 
196 	tm->tm_year -= RTC_MIN_YEAR_OFFSET;
197 	tm->tm_mon++;
198 
199 	mutex_lock(&rtc->lock);
200 	ret = regmap_bulk_read(rtc->regmap, rtc->addr_base + RTC_AL_SEC,
201 			       data, RTC_OFFSET_COUNT);
202 	if (ret < 0)
203 		goto exit;
204 
205 	data[RTC_OFFSET_SEC] = ((data[RTC_OFFSET_SEC] & ~(RTC_AL_SEC_MASK)) |
206 				(tm->tm_sec & RTC_AL_SEC_MASK));
207 	data[RTC_OFFSET_MIN] = ((data[RTC_OFFSET_MIN] & ~(RTC_AL_MIN_MASK)) |
208 				(tm->tm_min & RTC_AL_MIN_MASK));
209 	data[RTC_OFFSET_HOUR] = ((data[RTC_OFFSET_HOUR] & ~(RTC_AL_HOU_MASK)) |
210 				(tm->tm_hour & RTC_AL_HOU_MASK));
211 	data[RTC_OFFSET_DOM] = ((data[RTC_OFFSET_DOM] & ~(RTC_AL_DOM_MASK)) |
212 				(tm->tm_mday & RTC_AL_DOM_MASK));
213 	data[RTC_OFFSET_MTH] = ((data[RTC_OFFSET_MTH] & ~(RTC_AL_MTH_MASK)) |
214 				(tm->tm_mon & RTC_AL_MTH_MASK));
215 	data[RTC_OFFSET_YEAR] = ((data[RTC_OFFSET_YEAR] & ~(RTC_AL_YEA_MASK)) |
216 				(tm->tm_year & RTC_AL_YEA_MASK));
217 
218 	if (alm->enabled) {
219 		ret = regmap_bulk_write(rtc->regmap,
220 					rtc->addr_base + RTC_AL_SEC,
221 					data, RTC_OFFSET_COUNT);
222 		if (ret < 0)
223 			goto exit;
224 		ret = regmap_write(rtc->regmap, rtc->addr_base + RTC_AL_MASK,
225 				   RTC_AL_MASK_DOW);
226 		if (ret < 0)
227 			goto exit;
228 		ret = regmap_update_bits(rtc->regmap,
229 					 rtc->addr_base + RTC_IRQ_EN,
230 					 RTC_IRQ_EN_ONESHOT_AL,
231 					 RTC_IRQ_EN_ONESHOT_AL);
232 		if (ret < 0)
233 			goto exit;
234 	} else {
235 		ret = regmap_update_bits(rtc->regmap,
236 					 rtc->addr_base + RTC_IRQ_EN,
237 					 RTC_IRQ_EN_ONESHOT_AL, 0);
238 		if (ret < 0)
239 			goto exit;
240 	}
241 
242 	/* All alarm time register write to hardware after calling
243 	 * mtk_rtc_write_trigger. This can avoid race condition if alarm
244 	 * occur happen during writing alarm time register.
245 	 */
246 	ret = mtk_rtc_write_trigger(rtc);
247 exit:
248 	mutex_unlock(&rtc->lock);
249 	return ret;
250 }
251 
252 static const struct rtc_class_ops mtk_rtc_ops = {
253 	.read_time  = mtk_rtc_read_time,
254 	.set_time   = mtk_rtc_set_time,
255 	.read_alarm = mtk_rtc_read_alarm,
256 	.set_alarm  = mtk_rtc_set_alarm,
257 };
258 
259 static int mtk_rtc_probe(struct platform_device *pdev)
260 {
261 	struct resource *res;
262 	struct mt6397_chip *mt6397_chip = dev_get_drvdata(pdev->dev.parent);
263 	struct mt6397_rtc *rtc;
264 	int ret;
265 
266 	rtc = devm_kzalloc(&pdev->dev, sizeof(struct mt6397_rtc), GFP_KERNEL);
267 	if (!rtc)
268 		return -ENOMEM;
269 
270 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
271 	rtc->addr_base = res->start;
272 
273 	rtc->data = of_device_get_match_data(&pdev->dev);
274 
275 	rtc->irq = platform_get_irq(pdev, 0);
276 	if (rtc->irq < 0)
277 		return rtc->irq;
278 
279 	rtc->regmap = mt6397_chip->regmap;
280 	mutex_init(&rtc->lock);
281 
282 	platform_set_drvdata(pdev, rtc);
283 
284 	rtc->rtc_dev = devm_rtc_allocate_device(&pdev->dev);
285 	if (IS_ERR(rtc->rtc_dev))
286 		return PTR_ERR(rtc->rtc_dev);
287 
288 	ret = devm_request_threaded_irq(&pdev->dev, rtc->irq, NULL,
289 					mtk_rtc_irq_handler_thread,
290 					IRQF_ONESHOT | IRQF_TRIGGER_HIGH,
291 					"mt6397-rtc", rtc);
292 
293 	if (ret) {
294 		dev_err(&pdev->dev, "Failed to request alarm IRQ: %d: %d\n",
295 			rtc->irq, ret);
296 		return ret;
297 	}
298 
299 	device_init_wakeup(&pdev->dev, 1);
300 
301 	rtc->rtc_dev->ops = &mtk_rtc_ops;
302 
303 	return rtc_register_device(rtc->rtc_dev);
304 }
305 
306 #ifdef CONFIG_PM_SLEEP
307 static int mt6397_rtc_suspend(struct device *dev)
308 {
309 	struct mt6397_rtc *rtc = dev_get_drvdata(dev);
310 
311 	if (device_may_wakeup(dev))
312 		enable_irq_wake(rtc->irq);
313 
314 	return 0;
315 }
316 
317 static int mt6397_rtc_resume(struct device *dev)
318 {
319 	struct mt6397_rtc *rtc = dev_get_drvdata(dev);
320 
321 	if (device_may_wakeup(dev))
322 		disable_irq_wake(rtc->irq);
323 
324 	return 0;
325 }
326 #endif
327 
328 static SIMPLE_DEV_PM_OPS(mt6397_pm_ops, mt6397_rtc_suspend,
329 			mt6397_rtc_resume);
330 
331 static const struct mtk_rtc_data mt6358_rtc_data = {
332 	.wrtgr = RTC_WRTGR_MT6358,
333 };
334 
335 static const struct mtk_rtc_data mt6397_rtc_data = {
336 	.wrtgr = RTC_WRTGR_MT6397,
337 };
338 
339 static const struct of_device_id mt6397_rtc_of_match[] = {
340 	{ .compatible = "mediatek,mt6323-rtc", .data = &mt6397_rtc_data },
341 	{ .compatible = "mediatek,mt6358-rtc", .data = &mt6358_rtc_data },
342 	{ .compatible = "mediatek,mt6397-rtc", .data = &mt6397_rtc_data },
343 	{ }
344 };
345 MODULE_DEVICE_TABLE(of, mt6397_rtc_of_match);
346 
347 static struct platform_driver mtk_rtc_driver = {
348 	.driver = {
349 		.name = "mt6397-rtc",
350 		.of_match_table = mt6397_rtc_of_match,
351 		.pm = &mt6397_pm_ops,
352 	},
353 	.probe	= mtk_rtc_probe,
354 };
355 
356 module_platform_driver(mtk_rtc_driver);
357 
358 MODULE_LICENSE("GPL v2");
359 MODULE_AUTHOR("Tianping Fang <tianping.fang@mediatek.com>");
360 MODULE_DESCRIPTION("RTC Driver for MediaTek MT6397 PMIC");
361