Commit | Line | Data |
---|---|---|
b6743615 | 1 | // SPDX-License-Identifier: GPL-2.0 |
defb4514 SB |
2 | /* |
3 | * Driver for the RTC in Marvell SoCs. | |
defb4514 SB |
4 | */ |
5 | ||
6 | #include <linux/init.h> | |
7 | #include <linux/kernel.h> | |
8 | #include <linux/rtc.h> | |
9 | #include <linux/bcd.h> | |
fe561336 | 10 | #include <linux/bitops.h> |
defb4514 SB |
11 | #include <linux/io.h> |
12 | #include <linux/platform_device.h> | |
ea983ede | 13 | #include <linux/of.h> |
9d1d4f9e | 14 | #include <linux/delay.h> |
89c58c19 | 15 | #include <linux/clk.h> |
5a0e3ad6 | 16 | #include <linux/gfp.h> |
2113852b | 17 | #include <linux/module.h> |
defb4514 SB |
18 | |
19 | ||
20 | #define RTC_TIME_REG_OFFS 0 | |
21 | #define RTC_SECONDS_OFFS 0 | |
22 | #define RTC_MINUTES_OFFS 8 | |
23 | #define RTC_HOURS_OFFS 16 | |
24 | #define RTC_WDAY_OFFS 24 | |
fe561336 | 25 | #define RTC_HOURS_12H_MODE BIT(22) /* 12 hour mode */ |
defb4514 SB |
26 | |
27 | #define RTC_DATE_REG_OFFS 4 | |
28 | #define RTC_MDAY_OFFS 0 | |
29 | #define RTC_MONTH_OFFS 8 | |
30 | #define RTC_YEAR_OFFS 16 | |
31 | ||
aeedacae SB |
32 | #define RTC_ALARM_TIME_REG_OFFS 8 |
33 | #define RTC_ALARM_DATE_REG_OFFS 0xc | |
fe561336 | 34 | #define RTC_ALARM_VALID BIT(7) |
aeedacae SB |
35 | |
36 | #define RTC_ALARM_INTERRUPT_MASK_REG_OFFS 0x10 | |
37 | #define RTC_ALARM_INTERRUPT_CASUE_REG_OFFS 0x14 | |
defb4514 SB |
38 | |
39 | struct rtc_plat_data { | |
40 | struct rtc_device *rtc; | |
41 | void __iomem *ioaddr; | |
aeedacae | 42 | int irq; |
89c58c19 | 43 | struct clk *clk; |
defb4514 SB |
44 | }; |
45 | ||
46 | static int mv_rtc_set_time(struct device *dev, struct rtc_time *tm) | |
47 | { | |
48 | struct rtc_plat_data *pdata = dev_get_drvdata(dev); | |
49 | void __iomem *ioaddr = pdata->ioaddr; | |
50 | u32 rtc_reg; | |
51 | ||
52 | rtc_reg = (bin2bcd(tm->tm_sec) << RTC_SECONDS_OFFS) | | |
53 | (bin2bcd(tm->tm_min) << RTC_MINUTES_OFFS) | | |
54 | (bin2bcd(tm->tm_hour) << RTC_HOURS_OFFS) | | |
55 | (bin2bcd(tm->tm_wday) << RTC_WDAY_OFFS); | |
56 | writel(rtc_reg, ioaddr + RTC_TIME_REG_OFFS); | |
57 | ||
58 | rtc_reg = (bin2bcd(tm->tm_mday) << RTC_MDAY_OFFS) | | |
59 | (bin2bcd(tm->tm_mon + 1) << RTC_MONTH_OFFS) | | |
b46c5815 | 60 | (bin2bcd(tm->tm_year - 100) << RTC_YEAR_OFFS); |
defb4514 SB |
61 | writel(rtc_reg, ioaddr + RTC_DATE_REG_OFFS); |
62 | ||
63 | return 0; | |
64 | } | |
65 | ||
66 | static int mv_rtc_read_time(struct device *dev, struct rtc_time *tm) | |
67 | { | |
68 | struct rtc_plat_data *pdata = dev_get_drvdata(dev); | |
69 | void __iomem *ioaddr = pdata->ioaddr; | |
70 | u32 rtc_time, rtc_date; | |
71 | unsigned int year, month, day, hour, minute, second, wday; | |
72 | ||
73 | rtc_time = readl(ioaddr + RTC_TIME_REG_OFFS); | |
74 | rtc_date = readl(ioaddr + RTC_DATE_REG_OFFS); | |
75 | ||
76 | second = rtc_time & 0x7f; | |
77 | minute = (rtc_time >> RTC_MINUTES_OFFS) & 0x7f; | |
4042a147 | 78 | hour = (rtc_time >> RTC_HOURS_OFFS) & 0x3f; /* assume 24 hour mode */ |
defb4514 SB |
79 | wday = (rtc_time >> RTC_WDAY_OFFS) & 0x7; |
80 | ||
81 | day = rtc_date & 0x3f; | |
82 | month = (rtc_date >> RTC_MONTH_OFFS) & 0x3f; | |
83 | year = (rtc_date >> RTC_YEAR_OFFS) & 0xff; | |
84 | ||
85 | tm->tm_sec = bcd2bin(second); | |
86 | tm->tm_min = bcd2bin(minute); | |
87 | tm->tm_hour = bcd2bin(hour); | |
88 | tm->tm_mday = bcd2bin(day); | |
89 | tm->tm_wday = bcd2bin(wday); | |
90 | tm->tm_mon = bcd2bin(month) - 1; | |
91 | /* hw counts from year 2000, but tm_year is relative to 1900 */ | |
92 | tm->tm_year = bcd2bin(year) + 100; | |
93 | ||
22652ba7 | 94 | return 0; |
defb4514 SB |
95 | } |
96 | ||
aeedacae SB |
97 | static int mv_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alm) |
98 | { | |
99 | struct rtc_plat_data *pdata = dev_get_drvdata(dev); | |
100 | void __iomem *ioaddr = pdata->ioaddr; | |
101 | u32 rtc_time, rtc_date; | |
102 | unsigned int year, month, day, hour, minute, second, wday; | |
103 | ||
104 | rtc_time = readl(ioaddr + RTC_ALARM_TIME_REG_OFFS); | |
105 | rtc_date = readl(ioaddr + RTC_ALARM_DATE_REG_OFFS); | |
106 | ||
107 | second = rtc_time & 0x7f; | |
108 | minute = (rtc_time >> RTC_MINUTES_OFFS) & 0x7f; | |
4042a147 | 109 | hour = (rtc_time >> RTC_HOURS_OFFS) & 0x3f; /* assume 24 hour mode */ |
aeedacae SB |
110 | wday = (rtc_time >> RTC_WDAY_OFFS) & 0x7; |
111 | ||
112 | day = rtc_date & 0x3f; | |
113 | month = (rtc_date >> RTC_MONTH_OFFS) & 0x3f; | |
114 | year = (rtc_date >> RTC_YEAR_OFFS) & 0xff; | |
115 | ||
116 | alm->time.tm_sec = bcd2bin(second); | |
117 | alm->time.tm_min = bcd2bin(minute); | |
118 | alm->time.tm_hour = bcd2bin(hour); | |
119 | alm->time.tm_mday = bcd2bin(day); | |
120 | alm->time.tm_wday = bcd2bin(wday); | |
121 | alm->time.tm_mon = bcd2bin(month) - 1; | |
122 | /* hw counts from year 2000, but tm_year is relative to 1900 */ | |
123 | alm->time.tm_year = bcd2bin(year) + 100; | |
124 | ||
aeedacae | 125 | alm->enabled = !!readl(ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS); |
959e8b77 AB |
126 | |
127 | return rtc_valid_tm(&alm->time); | |
aeedacae SB |
128 | } |
129 | ||
130 | static int mv_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alm) | |
131 | { | |
132 | struct rtc_plat_data *pdata = dev_get_drvdata(dev); | |
133 | void __iomem *ioaddr = pdata->ioaddr; | |
134 | u32 rtc_reg = 0; | |
135 | ||
136 | if (alm->time.tm_sec >= 0) | |
137 | rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_sec)) | |
138 | << RTC_SECONDS_OFFS; | |
139 | if (alm->time.tm_min >= 0) | |
140 | rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_min)) | |
141 | << RTC_MINUTES_OFFS; | |
142 | if (alm->time.tm_hour >= 0) | |
143 | rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_hour)) | |
144 | << RTC_HOURS_OFFS; | |
145 | ||
146 | writel(rtc_reg, ioaddr + RTC_ALARM_TIME_REG_OFFS); | |
147 | ||
148 | if (alm->time.tm_mday >= 0) | |
149 | rtc_reg = (RTC_ALARM_VALID | bin2bcd(alm->time.tm_mday)) | |
150 | << RTC_MDAY_OFFS; | |
151 | else | |
152 | rtc_reg = 0; | |
153 | ||
154 | if (alm->time.tm_mon >= 0) | |
155 | rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_mon + 1)) | |
156 | << RTC_MONTH_OFFS; | |
157 | ||
158 | if (alm->time.tm_year >= 0) | |
b46c5815 | 159 | rtc_reg |= (RTC_ALARM_VALID | bin2bcd(alm->time.tm_year - 100)) |
aeedacae SB |
160 | << RTC_YEAR_OFFS; |
161 | ||
162 | writel(rtc_reg, ioaddr + RTC_ALARM_DATE_REG_OFFS); | |
163 | writel(0, ioaddr + RTC_ALARM_INTERRUPT_CASUE_REG_OFFS); | |
164 | writel(alm->enabled ? 1 : 0, | |
165 | ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS); | |
166 | ||
167 | return 0; | |
168 | } | |
169 | ||
16380c15 | 170 | static int mv_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled) |
aeedacae | 171 | { |
85368bb9 | 172 | struct rtc_plat_data *pdata = dev_get_drvdata(dev); |
aeedacae SB |
173 | void __iomem *ioaddr = pdata->ioaddr; |
174 | ||
175 | if (pdata->irq < 0) | |
16380c15 JS |
176 | return -EINVAL; /* fall back into rtc-dev's emulation */ |
177 | ||
178 | if (enabled) | |
aeedacae | 179 | writel(1, ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS); |
16380c15 JS |
180 | else |
181 | writel(0, ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS); | |
aeedacae SB |
182 | return 0; |
183 | } | |
184 | ||
185 | static irqreturn_t mv_rtc_interrupt(int irq, void *data) | |
186 | { | |
187 | struct rtc_plat_data *pdata = data; | |
188 | void __iomem *ioaddr = pdata->ioaddr; | |
189 | ||
190 | /* alarm irq? */ | |
191 | if (!readl(ioaddr + RTC_ALARM_INTERRUPT_CASUE_REG_OFFS)) | |
192 | return IRQ_NONE; | |
193 | ||
194 | /* clear interrupt */ | |
195 | writel(0, ioaddr + RTC_ALARM_INTERRUPT_CASUE_REG_OFFS); | |
196 | rtc_update_irq(pdata->rtc, 1, RTC_IRQF | RTC_AF); | |
197 | return IRQ_HANDLED; | |
198 | } | |
199 | ||
defb4514 SB |
200 | static const struct rtc_class_ops mv_rtc_ops = { |
201 | .read_time = mv_rtc_read_time, | |
202 | .set_time = mv_rtc_set_time, | |
aeedacae SB |
203 | .read_alarm = mv_rtc_read_alarm, |
204 | .set_alarm = mv_rtc_set_alarm, | |
16380c15 | 205 | .alarm_irq_enable = mv_rtc_alarm_irq_enable, |
aeedacae SB |
206 | }; |
207 | ||
b69af437 | 208 | static int __init mv_rtc_probe(struct platform_device *pdev) |
defb4514 | 209 | { |
defb4514 | 210 | struct rtc_plat_data *pdata; |
defb4514 | 211 | u32 rtc_time; |
89c58c19 | 212 | int ret = 0; |
defb4514 | 213 | |
defb4514 SB |
214 | pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL); |
215 | if (!pdata) | |
216 | return -ENOMEM; | |
217 | ||
09ef18bc | 218 | pdata->ioaddr = devm_platform_ioremap_resource(pdev, 0); |
7c1d69ee JL |
219 | if (IS_ERR(pdata->ioaddr)) |
220 | return PTR_ERR(pdata->ioaddr); | |
defb4514 | 221 | |
89c58c19 AL |
222 | pdata->clk = devm_clk_get(&pdev->dev, NULL); |
223 | /* Not all SoCs require a clock.*/ | |
224 | if (!IS_ERR(pdata->clk)) | |
225 | clk_prepare_enable(pdata->clk); | |
226 | ||
4042a147 | 227 | /* make sure the 24 hour mode is enabled */ |
defb4514 SB |
228 | rtc_time = readl(pdata->ioaddr + RTC_TIME_REG_OFFS); |
229 | if (rtc_time & RTC_HOURS_12H_MODE) { | |
4042a147 | 230 | dev_err(&pdev->dev, "12 Hour mode is enabled but not supported.\n"); |
89c58c19 AL |
231 | ret = -EINVAL; |
232 | goto out; | |
defb4514 SB |
233 | } |
234 | ||
9d1d4f9e NP |
235 | /* make sure it is actually functional */ |
236 | if (rtc_time == 0x01000000) { | |
237 | ssleep(1); | |
238 | rtc_time = readl(pdata->ioaddr + RTC_TIME_REG_OFFS); | |
239 | if (rtc_time == 0x01000000) { | |
240 | dev_err(&pdev->dev, "internal RTC not ticking\n"); | |
89c58c19 AL |
241 | ret = -ENODEV; |
242 | goto out; | |
9d1d4f9e NP |
243 | } |
244 | } | |
245 | ||
aeedacae SB |
246 | pdata->irq = platform_get_irq(pdev, 0); |
247 | ||
defb4514 | 248 | platform_set_drvdata(pdev, pdata); |
aeedacae | 249 | |
5b25a71b | 250 | pdata->rtc = devm_rtc_allocate_device(&pdev->dev); |
89c58c19 AL |
251 | if (IS_ERR(pdata->rtc)) { |
252 | ret = PTR_ERR(pdata->rtc); | |
253 | goto out; | |
254 | } | |
defb4514 | 255 | |
aeedacae SB |
256 | if (pdata->irq >= 0) { |
257 | writel(0, pdata->ioaddr + RTC_ALARM_INTERRUPT_MASK_REG_OFFS); | |
258 | if (devm_request_irq(&pdev->dev, pdata->irq, mv_rtc_interrupt, | |
2f6e5f94 | 259 | IRQF_SHARED, |
aeedacae SB |
260 | pdev->name, pdata) < 0) { |
261 | dev_warn(&pdev->dev, "interrupt not available.\n"); | |
262 | pdata->irq = -1; | |
263 | } | |
264 | } | |
265 | ||
b0d42def | 266 | if (pdata->irq >= 0) |
5b25a71b | 267 | device_init_wakeup(&pdev->dev, 1); |
b0d42def AB |
268 | else |
269 | clear_bit(RTC_FEATURE_ALARM, pdata->rtc->features); | |
5b25a71b | 270 | |
b0d42def | 271 | pdata->rtc->ops = &mv_rtc_ops; |
b46c5815 AB |
272 | pdata->rtc->range_min = RTC_TIMESTAMP_BEGIN_2000; |
273 | pdata->rtc->range_max = RTC_TIMESTAMP_END_2099; | |
274 | ||
fdcfd854 | 275 | ret = devm_rtc_register_device(pdata->rtc); |
5b25a71b AB |
276 | if (!ret) |
277 | return 0; | |
89c58c19 AL |
278 | out: |
279 | if (!IS_ERR(pdata->clk)) | |
280 | clk_disable_unprepare(pdata->clk); | |
281 | ||
282 | return ret; | |
defb4514 SB |
283 | } |
284 | ||
285 | static int __exit mv_rtc_remove(struct platform_device *pdev) | |
286 | { | |
287 | struct rtc_plat_data *pdata = platform_get_drvdata(pdev); | |
288 | ||
aeedacae SB |
289 | if (pdata->irq >= 0) |
290 | device_init_wakeup(&pdev->dev, 0); | |
291 | ||
89c58c19 AL |
292 | if (!IS_ERR(pdata->clk)) |
293 | clk_disable_unprepare(pdata->clk); | |
294 | ||
defb4514 SB |
295 | return 0; |
296 | } | |
297 | ||
ea983ede | 298 | #ifdef CONFIG_OF |
4621bc56 | 299 | static const struct of_device_id rtc_mv_of_match_table[] = { |
77843504 | 300 | { .compatible = "marvell,orion-rtc", }, |
ea983ede JC |
301 | {} |
302 | }; | |
73798d5c | 303 | MODULE_DEVICE_TABLE(of, rtc_mv_of_match_table); |
ea983ede JC |
304 | #endif |
305 | ||
defb4514 SB |
306 | static struct platform_driver mv_rtc_driver = { |
307 | .remove = __exit_p(mv_rtc_remove), | |
308 | .driver = { | |
309 | .name = "rtc-mv", | |
ea983ede | 310 | .of_match_table = of_match_ptr(rtc_mv_of_match_table), |
defb4514 SB |
311 | }, |
312 | }; | |
313 | ||
1963f7cd | 314 | module_platform_driver_probe(mv_rtc_driver, mv_rtc_probe); |
defb4514 SB |
315 | |
316 | MODULE_AUTHOR("Saeed Bishara <saeed@marvell.com>"); | |
317 | MODULE_DESCRIPTION("Marvell RTC driver"); | |
318 | MODULE_LICENSE("GPL"); | |
319 | MODULE_ALIAS("platform:rtc-mv"); |