1 // SPDX-License-Identifier: GPL-2.0
3 * Xilinx Zynq Ultrascale+ MPSoC Real Time Clock Driver
5 * Copyright (C) 2015 Xilinx, Inc.
9 #include <linux/delay.h>
10 #include <linux/init.h>
12 #include <linux/module.h>
14 #include <linux/platform_device.h>
15 #include <linux/rtc.h>
18 #define RTC_SET_TM_WR 0x00
19 #define RTC_SET_TM_RD 0x04
20 #define RTC_CALIB_WR 0x08
21 #define RTC_CALIB_RD 0x0C
22 #define RTC_CUR_TM 0x10
23 #define RTC_CUR_TICK 0x14
25 #define RTC_INT_STS 0x20
26 #define RTC_INT_MASK 0x24
27 #define RTC_INT_EN 0x28
28 #define RTC_INT_DIS 0x2C
31 #define RTC_FR_EN BIT(20)
32 #define RTC_FR_DATSHIFT 16
33 #define RTC_TICK_MASK 0xFFFF
34 #define RTC_INT_SEC BIT(0)
35 #define RTC_INT_ALRM BIT(1)
36 #define RTC_OSC_EN BIT(24)
37 #define RTC_BATT_EN BIT(31)
39 #define RTC_CALIB_DEF 0x198233
40 #define RTC_CALIB_MASK 0x1FFFFF
43 struct rtc_device *rtc;
44 void __iomem *reg_base;
50 static int xlnx_rtc_set_time(struct device *dev, struct rtc_time *tm)
52 struct xlnx_rtc_dev *xrtcdev = dev_get_drvdata(dev);
53 unsigned long new_time;
56 * The value written will be updated after 1 sec into the
57 * seconds read register, so we need to program time +1 sec
58 * to get the correct time on read.
60 new_time = rtc_tm_to_time64(tm) + 1;
63 * Writing into calibration register will clear the Tick Counter and
64 * force the next second to be signaled exactly in 1 second period
66 xrtcdev->calibval &= RTC_CALIB_MASK;
67 writel(xrtcdev->calibval, (xrtcdev->reg_base + RTC_CALIB_WR));
69 writel(new_time, xrtcdev->reg_base + RTC_SET_TM_WR);
72 * Clear the rtc interrupt status register after setting the
73 * time. During a read_time function, the code should read the
74 * RTC_INT_STATUS register and if bit 0 is still 0, it means
75 * that one second has not elapsed yet since RTC was set and
76 * the current time should be read from SET_TIME_READ register;
77 * otherwise, CURRENT_TIME register is read to report the time
79 writel(RTC_INT_SEC, xrtcdev->reg_base + RTC_INT_STS);
84 static int xlnx_rtc_read_time(struct device *dev, struct rtc_time *tm)
87 unsigned long read_time;
88 struct xlnx_rtc_dev *xrtcdev = dev_get_drvdata(dev);
90 status = readl(xrtcdev->reg_base + RTC_INT_STS);
92 if (status & RTC_INT_SEC) {
94 * RTC has updated the CURRENT_TIME with the time written into
95 * SET_TIME_WRITE register.
97 rtc_time64_to_tm(readl(xrtcdev->reg_base + RTC_CUR_TM), tm);
100 * Time written in SET_TIME_WRITE has not yet updated into
101 * the seconds read register, so read the time from the
102 * SET_TIME_WRITE instead of CURRENT_TIME register.
103 * Since we add +1 sec while writing, we need to -1 sec while
106 read_time = readl(xrtcdev->reg_base + RTC_SET_TM_RD) - 1;
107 rtc_time64_to_tm(read_time, tm);
113 static int xlnx_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
115 struct xlnx_rtc_dev *xrtcdev = dev_get_drvdata(dev);
117 rtc_time64_to_tm(readl(xrtcdev->reg_base + RTC_ALRM), &alrm->time);
118 alrm->enabled = readl(xrtcdev->reg_base + RTC_INT_MASK) & RTC_INT_ALRM;
123 static int xlnx_rtc_alarm_irq_enable(struct device *dev, u32 enabled)
125 struct xlnx_rtc_dev *xrtcdev = dev_get_drvdata(dev);
128 writel(RTC_INT_ALRM, xrtcdev->reg_base + RTC_INT_EN);
130 writel(RTC_INT_ALRM, xrtcdev->reg_base + RTC_INT_DIS);
135 static int xlnx_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
137 struct xlnx_rtc_dev *xrtcdev = dev_get_drvdata(dev);
138 unsigned long alarm_time;
140 alarm_time = rtc_tm_to_time64(&alrm->time);
142 writel((u32)alarm_time, (xrtcdev->reg_base + RTC_ALRM));
144 xlnx_rtc_alarm_irq_enable(dev, alrm->enabled);
149 static void xlnx_init_rtc(struct xlnx_rtc_dev *xrtcdev)
153 /* Enable RTC switch to battery when VCC_PSAUX is not available */
154 rtc_ctrl = readl(xrtcdev->reg_base + RTC_CTRL);
155 rtc_ctrl |= RTC_BATT_EN;
156 writel(rtc_ctrl, xrtcdev->reg_base + RTC_CTRL);
159 * Based on crystal freq of 33.330 KHz
160 * set the seconds counter and enable, set fractions counter
161 * to default value suggested as per design spec
162 * to correct RTC delay in frequency over period of time.
164 xrtcdev->calibval &= RTC_CALIB_MASK;
165 writel(xrtcdev->calibval, (xrtcdev->reg_base + RTC_CALIB_WR));
168 static const struct rtc_class_ops xlnx_rtc_ops = {
169 .set_time = xlnx_rtc_set_time,
170 .read_time = xlnx_rtc_read_time,
171 .read_alarm = xlnx_rtc_read_alarm,
172 .set_alarm = xlnx_rtc_set_alarm,
173 .alarm_irq_enable = xlnx_rtc_alarm_irq_enable,
176 static irqreturn_t xlnx_rtc_interrupt(int irq, void *id)
178 struct xlnx_rtc_dev *xrtcdev = (struct xlnx_rtc_dev *)id;
181 status = readl(xrtcdev->reg_base + RTC_INT_STS);
182 /* Check if interrupt asserted */
183 if (!(status & (RTC_INT_SEC | RTC_INT_ALRM)))
186 /* Clear RTC_INT_ALRM interrupt only */
187 writel(RTC_INT_ALRM, xrtcdev->reg_base + RTC_INT_STS);
189 if (status & RTC_INT_ALRM)
190 rtc_update_irq(xrtcdev->rtc, 1, RTC_IRQF | RTC_AF);
195 static int xlnx_rtc_probe(struct platform_device *pdev)
197 struct xlnx_rtc_dev *xrtcdev;
198 struct resource *res;
201 xrtcdev = devm_kzalloc(&pdev->dev, sizeof(*xrtcdev), GFP_KERNEL);
205 platform_set_drvdata(pdev, xrtcdev);
207 xrtcdev->rtc = devm_rtc_allocate_device(&pdev->dev);
208 if (IS_ERR(xrtcdev->rtc))
209 return PTR_ERR(xrtcdev->rtc);
211 xrtcdev->rtc->ops = &xlnx_rtc_ops;
212 xrtcdev->rtc->range_max = U32_MAX;
214 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
216 xrtcdev->reg_base = devm_ioremap_resource(&pdev->dev, res);
217 if (IS_ERR(xrtcdev->reg_base))
218 return PTR_ERR(xrtcdev->reg_base);
220 xrtcdev->alarm_irq = platform_get_irq_byname(pdev, "alarm");
221 if (xrtcdev->alarm_irq < 0)
222 return xrtcdev->alarm_irq;
223 ret = devm_request_irq(&pdev->dev, xrtcdev->alarm_irq,
224 xlnx_rtc_interrupt, 0,
225 dev_name(&pdev->dev), xrtcdev);
227 dev_err(&pdev->dev, "request irq failed\n");
231 xrtcdev->sec_irq = platform_get_irq_byname(pdev, "sec");
232 if (xrtcdev->sec_irq < 0)
233 return xrtcdev->sec_irq;
234 ret = devm_request_irq(&pdev->dev, xrtcdev->sec_irq,
235 xlnx_rtc_interrupt, 0,
236 dev_name(&pdev->dev), xrtcdev);
238 dev_err(&pdev->dev, "request irq failed\n");
242 ret = of_property_read_u32(pdev->dev.of_node, "calibration",
245 xrtcdev->calibval = RTC_CALIB_DEF;
247 xlnx_init_rtc(xrtcdev);
249 device_init_wakeup(&pdev->dev, 1);
251 return rtc_register_device(xrtcdev->rtc);
254 static int xlnx_rtc_remove(struct platform_device *pdev)
256 xlnx_rtc_alarm_irq_enable(&pdev->dev, 0);
257 device_init_wakeup(&pdev->dev, 0);
262 static int __maybe_unused xlnx_rtc_suspend(struct device *dev)
264 struct xlnx_rtc_dev *xrtcdev = dev_get_drvdata(dev);
266 if (device_may_wakeup(dev))
267 enable_irq_wake(xrtcdev->alarm_irq);
269 xlnx_rtc_alarm_irq_enable(dev, 0);
274 static int __maybe_unused xlnx_rtc_resume(struct device *dev)
276 struct xlnx_rtc_dev *xrtcdev = dev_get_drvdata(dev);
278 if (device_may_wakeup(dev))
279 disable_irq_wake(xrtcdev->alarm_irq);
281 xlnx_rtc_alarm_irq_enable(dev, 1);
286 static SIMPLE_DEV_PM_OPS(xlnx_rtc_pm_ops, xlnx_rtc_suspend, xlnx_rtc_resume);
288 static const struct of_device_id xlnx_rtc_of_match[] = {
289 {.compatible = "xlnx,zynqmp-rtc" },
292 MODULE_DEVICE_TABLE(of, xlnx_rtc_of_match);
294 static struct platform_driver xlnx_rtc_driver = {
295 .probe = xlnx_rtc_probe,
296 .remove = xlnx_rtc_remove,
298 .name = KBUILD_MODNAME,
299 .pm = &xlnx_rtc_pm_ops,
300 .of_match_table = xlnx_rtc_of_match,
304 module_platform_driver(xlnx_rtc_driver);
306 MODULE_DESCRIPTION("Xilinx Zynq MPSoC RTC driver");
307 MODULE_AUTHOR("Xilinx Inc.");
308 MODULE_LICENSE("GPL v2");