Merge tag 'scsi-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/jejb/scsi
[linux-2.6-block.git] / drivers / rtc / rtc-zynqmp.c
CommitLineData
28e7861c 1// SPDX-License-Identifier: GPL-2.0
11143c19
SG
2/*
3 * Xilinx Zynq Ultrascale+ MPSoC Real Time Clock Driver
4 *
5 * Copyright (C) 2015 Xilinx, Inc.
6 *
11143c19
SG
7 */
8
9#include <linux/delay.h>
10#include <linux/init.h>
11#include <linux/io.h>
12#include <linux/module.h>
13#include <linux/of.h>
14#include <linux/platform_device.h>
15#include <linux/rtc.h>
16
17/* RTC Registers */
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
24#define RTC_ALRM 0x18
25#define RTC_INT_STS 0x20
26#define RTC_INT_MASK 0x24
27#define RTC_INT_EN 0x28
28#define RTC_INT_DIS 0x2C
29#define RTC_CTRL 0x40
30
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)
9092984f 37#define RTC_BATT_EN BIT(31)
11143c19
SG
38
39#define RTC_CALIB_DEF 0x198233
40#define RTC_CALIB_MASK 0x1FFFFF
11143c19
SG
41
42struct xlnx_rtc_dev {
43 struct rtc_device *rtc;
44 void __iomem *reg_base;
45 int alarm_irq;
46 int sec_irq;
58c4ed3b 47 int calibval;
11143c19
SG
48};
49
50static int xlnx_rtc_set_time(struct device *dev, struct rtc_time *tm)
51{
52 struct xlnx_rtc_dev *xrtcdev = dev_get_drvdata(dev);
53 unsigned long new_time;
54
b62c3a11
AKV
55 /*
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.
59 */
60 new_time = rtc_tm_to_time64(tm) + 1;
11143c19 61
58c4ed3b
AKV
62 /*
63 * Writing into calibration register will clear the Tick Counter and
64 * force the next second to be signaled exactly in 1 second period
65 */
66 xrtcdev->calibval &= RTC_CALIB_MASK;
67 writel(xrtcdev->calibval, (xrtcdev->reg_base + RTC_CALIB_WR));
68
11143c19
SG
69 writel(new_time, xrtcdev->reg_base + RTC_SET_TM_WR);
70
b62c3a11
AKV
71 /*
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
78 */
79 writel(RTC_INT_SEC, xrtcdev->reg_base + RTC_INT_STS);
80
11143c19
SG
81 return 0;
82}
83
84static int xlnx_rtc_read_time(struct device *dev, struct rtc_time *tm)
85{
b62c3a11
AKV
86 u32 status;
87 unsigned long read_time;
11143c19
SG
88 struct xlnx_rtc_dev *xrtcdev = dev_get_drvdata(dev);
89
b62c3a11
AKV
90 status = readl(xrtcdev->reg_base + RTC_INT_STS);
91
92 if (status & RTC_INT_SEC) {
93 /*
94 * RTC has updated the CURRENT_TIME with the time written into
95 * SET_TIME_WRITE register.
96 */
97 rtc_time64_to_tm(readl(xrtcdev->reg_base + RTC_CUR_TM), tm);
98 } else {
99 /*
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
104 * reading.
105 */
106 read_time = readl(xrtcdev->reg_base + RTC_SET_TM_RD) - 1;
107 rtc_time64_to_tm(read_time, tm);
108 }
11143c19 109
146d21bd 110 return 0;
11143c19
SG
111}
112
113static int xlnx_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
114{
115 struct xlnx_rtc_dev *xrtcdev = dev_get_drvdata(dev);
116
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;
119
120 return 0;
121}
122
123static int xlnx_rtc_alarm_irq_enable(struct device *dev, u32 enabled)
124{
125 struct xlnx_rtc_dev *xrtcdev = dev_get_drvdata(dev);
126
127 if (enabled)
128 writel(RTC_INT_ALRM, xrtcdev->reg_base + RTC_INT_EN);
129 else
130 writel(RTC_INT_ALRM, xrtcdev->reg_base + RTC_INT_DIS);
131
132 return 0;
133}
134
135static int xlnx_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
136{
137 struct xlnx_rtc_dev *xrtcdev = dev_get_drvdata(dev);
138 unsigned long alarm_time;
139
140 alarm_time = rtc_tm_to_time64(&alrm->time);
141
11143c19
SG
142 writel((u32)alarm_time, (xrtcdev->reg_base + RTC_ALRM));
143
144 xlnx_rtc_alarm_irq_enable(dev, alrm->enabled);
145
146 return 0;
147}
148
58c4ed3b 149static void xlnx_init_rtc(struct xlnx_rtc_dev *xrtcdev)
11143c19 150{
9092984f
AKV
151 u32 rtc_ctrl;
152
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);
157
11143c19
SG
158 /*
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.
163 */
58c4ed3b
AKV
164 xrtcdev->calibval &= RTC_CALIB_MASK;
165 writel(xrtcdev->calibval, (xrtcdev->reg_base + RTC_CALIB_WR));
11143c19
SG
166}
167
168static 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,
174};
175
176static irqreturn_t xlnx_rtc_interrupt(int irq, void *id)
177{
178 struct xlnx_rtc_dev *xrtcdev = (struct xlnx_rtc_dev *)id;
179 unsigned int status;
180
181 status = readl(xrtcdev->reg_base + RTC_INT_STS);
182 /* Check if interrupt asserted */
183 if (!(status & (RTC_INT_SEC | RTC_INT_ALRM)))
184 return IRQ_NONE;
185
b62c3a11
AKV
186 /* Clear RTC_INT_ALRM interrupt only */
187 writel(RTC_INT_ALRM, xrtcdev->reg_base + RTC_INT_STS);
11143c19 188
11143c19
SG
189 if (status & RTC_INT_ALRM)
190 rtc_update_irq(xrtcdev->rtc, 1, RTC_IRQF | RTC_AF);
191
192 return IRQ_HANDLED;
193}
194
195static int xlnx_rtc_probe(struct platform_device *pdev)
196{
197 struct xlnx_rtc_dev *xrtcdev;
198 struct resource *res;
199 int ret;
11143c19
SG
200
201 xrtcdev = devm_kzalloc(&pdev->dev, sizeof(*xrtcdev), GFP_KERNEL);
202 if (!xrtcdev)
203 return -ENOMEM;
204
205 platform_set_drvdata(pdev, xrtcdev);
206
b8541798
AB
207 xrtcdev->rtc = devm_rtc_allocate_device(&pdev->dev);
208 if (IS_ERR(xrtcdev->rtc))
209 return PTR_ERR(xrtcdev->rtc);
210
211 xrtcdev->rtc->ops = &xlnx_rtc_ops;
3199fc3d 212 xrtcdev->rtc->range_max = U32_MAX;
b8541798 213
11143c19
SG
214 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
215
216 xrtcdev->reg_base = devm_ioremap_resource(&pdev->dev, res);
217 if (IS_ERR(xrtcdev->reg_base))
218 return PTR_ERR(xrtcdev->reg_base);
219
220 xrtcdev->alarm_irq = platform_get_irq_byname(pdev, "alarm");
221 if (xrtcdev->alarm_irq < 0) {
222 dev_err(&pdev->dev, "no irq resource\n");
223 return xrtcdev->alarm_irq;
224 }
225 ret = devm_request_irq(&pdev->dev, xrtcdev->alarm_irq,
226 xlnx_rtc_interrupt, 0,
227 dev_name(&pdev->dev), xrtcdev);
228 if (ret) {
229 dev_err(&pdev->dev, "request irq failed\n");
230 return ret;
231 }
232
233 xrtcdev->sec_irq = platform_get_irq_byname(pdev, "sec");
234 if (xrtcdev->sec_irq < 0) {
235 dev_err(&pdev->dev, "no irq resource\n");
236 return xrtcdev->sec_irq;
237 }
238 ret = devm_request_irq(&pdev->dev, xrtcdev->sec_irq,
239 xlnx_rtc_interrupt, 0,
240 dev_name(&pdev->dev), xrtcdev);
241 if (ret) {
242 dev_err(&pdev->dev, "request irq failed\n");
243 return ret;
244 }
245
246 ret = of_property_read_u32(pdev->dev.of_node, "calibration",
58c4ed3b 247 &xrtcdev->calibval);
11143c19 248 if (ret)
58c4ed3b 249 xrtcdev->calibval = RTC_CALIB_DEF;
11143c19 250
58c4ed3b 251 xlnx_init_rtc(xrtcdev);
11143c19
SG
252
253 device_init_wakeup(&pdev->dev, 1);
254
b8541798 255 return rtc_register_device(xrtcdev->rtc);
11143c19
SG
256}
257
258static int xlnx_rtc_remove(struct platform_device *pdev)
259{
260 xlnx_rtc_alarm_irq_enable(&pdev->dev, 0);
261 device_init_wakeup(&pdev->dev, 0);
262
263 return 0;
264}
265
266static int __maybe_unused xlnx_rtc_suspend(struct device *dev)
267{
85368bb9 268 struct xlnx_rtc_dev *xrtcdev = dev_get_drvdata(dev);
11143c19 269
85368bb9 270 if (device_may_wakeup(dev))
11143c19
SG
271 enable_irq_wake(xrtcdev->alarm_irq);
272 else
273 xlnx_rtc_alarm_irq_enable(dev, 0);
274
275 return 0;
276}
277
278static int __maybe_unused xlnx_rtc_resume(struct device *dev)
279{
85368bb9 280 struct xlnx_rtc_dev *xrtcdev = dev_get_drvdata(dev);
11143c19 281
85368bb9 282 if (device_may_wakeup(dev))
11143c19
SG
283 disable_irq_wake(xrtcdev->alarm_irq);
284 else
285 xlnx_rtc_alarm_irq_enable(dev, 1);
286
287 return 0;
288}
289
290static SIMPLE_DEV_PM_OPS(xlnx_rtc_pm_ops, xlnx_rtc_suspend, xlnx_rtc_resume);
291
292static const struct of_device_id xlnx_rtc_of_match[] = {
293 {.compatible = "xlnx,zynqmp-rtc" },
294 { }
295};
296MODULE_DEVICE_TABLE(of, xlnx_rtc_of_match);
297
298static struct platform_driver xlnx_rtc_driver = {
299 .probe = xlnx_rtc_probe,
300 .remove = xlnx_rtc_remove,
301 .driver = {
302 .name = KBUILD_MODNAME,
303 .pm = &xlnx_rtc_pm_ops,
304 .of_match_table = xlnx_rtc_of_match,
305 },
306};
307
308module_platform_driver(xlnx_rtc_driver);
309
310MODULE_DESCRIPTION("Xilinx Zynq MPSoC RTC driver");
311MODULE_AUTHOR("Xilinx Inc.");
312MODULE_LICENSE("GPL v2");