blob: fe396d27ebb7108cbbac9eb2053e6a4281ddc056 [file] [log] [blame]
Thomas Gleixner2874c5f2019-05-27 08:55:01 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Andrew Victor788b1fc2006-06-25 05:48:27 -07002/*
3 * Real Time Clock interface for Linux on Atmel AT91RM9200
4 *
5 * Copyright (C) 2002 Rick Bronson
6 *
7 * Converted to RTC class model by Andrew Victor
8 *
9 * Ported to Linux 2.6 by Steven Scholz
10 * Based on s3c2410-rtc.c Simtec Electronics
11 *
12 * Based on sa1100-rtc.c by Nils Faerber
13 * Based on rtc.c by Paul Gortmaker
Andrew Victor788b1fc2006-06-25 05:48:27 -070014 */
15
Andrew Victor788b1fc2006-06-25 05:48:27 -070016#include <linux/bcd.h>
Alexandre Belloni3c7b90c2019-12-29 21:44:18 +010017#include <linux/bitfield.h>
Alexandre Belloni11f67a82015-07-31 11:39:51 +020018#include <linux/clk.h>
Andrew Victor788b1fc2006-06-25 05:48:27 -070019#include <linux/completion.h>
Alexandre Belloni74000eb2015-07-29 02:01:33 +020020#include <linux/interrupt.h>
21#include <linux/ioctl.h>
Arnd Bergmann14070ad2012-07-04 07:45:16 +000022#include <linux/io.h>
Alexandre Belloni74000eb2015-07-29 02:01:33 +020023#include <linux/kernel.h>
24#include <linux/module.h>
Joachim Eastwood7c1b68d2013-04-29 16:20:15 -070025#include <linux/of_device.h>
Alexandre Belloni74000eb2015-07-29 02:01:33 +020026#include <linux/of.h>
27#include <linux/platform_device.h>
28#include <linux/rtc.h>
29#include <linux/spinlock.h>
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +010030#include <linux/suspend.h>
Alexandre Belloni74000eb2015-07-29 02:01:33 +020031#include <linux/time.h>
Sachin Kamat8ecc0bf2013-07-03 15:05:44 -070032#include <linux/uaccess.h>
Andrew Victorfb0d4ec2008-10-15 22:03:08 -070033
Alexandre Bellonia1243b02019-12-29 21:44:16 +010034#define AT91_RTC_CR 0x00 /* Control Register */
35#define AT91_RTC_UPDTIM BIT(0) /* Update Request Time Register */
36#define AT91_RTC_UPDCAL BIT(1) /* Update Request Calendar Register */
37
38#define AT91_RTC_MR 0x04 /* Mode Register */
Alexandre Bellonif6a46f82020-11-09 00:20:00 +010039#define AT91_RTC_HRMOD BIT(0) /* 12/24 hour mode */
40#define AT91_RTC_NEGPPM BIT(4) /* Negative PPM correction */
41#define AT91_RTC_CORRECTION GENMASK(14, 8) /* Slow clock correction */
42#define AT91_RTC_HIGHPPM BIT(15) /* High PPM correction */
Alexandre Bellonia1243b02019-12-29 21:44:16 +010043
44#define AT91_RTC_TIMR 0x08 /* Time Register */
45#define AT91_RTC_SEC GENMASK(6, 0) /* Current Second */
46#define AT91_RTC_MIN GENMASK(14, 8) /* Current Minute */
47#define AT91_RTC_HOUR GENMASK(21, 16) /* Current Hour */
48#define AT91_RTC_AMPM BIT(22) /* Ante Meridiem Post Meridiem Indicator */
49
50#define AT91_RTC_CALR 0x0c /* Calendar Register */
51#define AT91_RTC_CENT GENMASK(6, 0) /* Current Century */
52#define AT91_RTC_YEAR GENMASK(15, 8) /* Current Year */
53#define AT91_RTC_MONTH GENMASK(20, 16) /* Current Month */
54#define AT91_RTC_DAY GENMASK(23, 21) /* Current Day */
55#define AT91_RTC_DATE GENMASK(29, 24) /* Current Date */
56
57#define AT91_RTC_TIMALR 0x10 /* Time Alarm Register */
58#define AT91_RTC_SECEN BIT(7) /* Second Alarm Enable */
59#define AT91_RTC_MINEN BIT(15) /* Minute Alarm Enable */
60#define AT91_RTC_HOUREN BIT(23) /* Hour Alarm Enable */
61
62#define AT91_RTC_CALALR 0x14 /* Calendar Alarm Register */
63#define AT91_RTC_MTHEN BIT(23) /* Month Alarm Enable */
64#define AT91_RTC_DATEEN BIT(31) /* Date Alarm Enable */
65
66#define AT91_RTC_SR 0x18 /* Status Register */
67#define AT91_RTC_ACKUPD BIT(0) /* Acknowledge for Update */
68#define AT91_RTC_ALARM BIT(1) /* Alarm Flag */
69#define AT91_RTC_SECEV BIT(2) /* Second Event */
70#define AT91_RTC_TIMEV BIT(3) /* Time Event */
71#define AT91_RTC_CALEV BIT(4) /* Calendar Event */
72
73#define AT91_RTC_SCCR 0x1c /* Status Clear Command Register */
74#define AT91_RTC_IER 0x20 /* Interrupt Enable Register */
75#define AT91_RTC_IDR 0x24 /* Interrupt Disable Register */
76#define AT91_RTC_IMR 0x28 /* Interrupt Mask Register */
77
78#define AT91_RTC_VER 0x2c /* Valid Entry Register */
79#define AT91_RTC_NVTIM BIT(0) /* Non valid Time */
80#define AT91_RTC_NVCAL BIT(1) /* Non valid Calendar */
81#define AT91_RTC_NVTIMALR BIT(2) /* Non valid Time Alarm */
82#define AT91_RTC_NVCALALR BIT(3) /* Non valid Calendar Alarm */
David Brownelld73e3cd2007-01-05 16:36:25 -080083
Alexandre Bellonif6a46f82020-11-09 00:20:00 +010084#define AT91_RTC_CORR_DIVIDEND 3906000
85#define AT91_RTC_CORR_LOW_RATIO 20
86
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +080087#define at91_rtc_read(field) \
Ben Dooks6da7bb12015-04-16 12:49:32 -070088 readl_relaxed(at91_rtc_regs + field)
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +080089#define at91_rtc_write(field, val) \
Ben Dooks6da7bb12015-04-16 12:49:32 -070090 writel_relaxed((val), at91_rtc_regs + field)
Andrew Victor788b1fc2006-06-25 05:48:27 -070091
Johan Hovoldde645472013-06-12 14:04:53 -070092struct at91_rtc_config {
Johan Hovolde9f08bb2013-06-12 14:04:56 -070093 bool use_shadow_imr;
Alexandre Bellonif6a46f82020-11-09 00:20:00 +010094 bool has_correction;
Johan Hovoldde645472013-06-12 14:04:53 -070095};
96
97static const struct at91_rtc_config *at91_rtc_config;
Andrew Victor788b1fc2006-06-25 05:48:27 -070098static DECLARE_COMPLETION(at91_rtc_updated);
Boris BREZILLON2fe121e2014-06-06 14:36:09 -070099static DECLARE_COMPLETION(at91_rtc_upd_rdy);
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800100static void __iomem *at91_rtc_regs;
101static int irq;
Johan Hovolde9f08bb2013-06-12 14:04:56 -0700102static DEFINE_SPINLOCK(at91_rtc_lock);
103static u32 at91_rtc_shadow_imr;
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +0100104static bool suspended;
105static DEFINE_SPINLOCK(suspended_lock);
106static unsigned long cached_events;
107static u32 at91_rtc_imr;
Alexandre Belloni11f67a82015-07-31 11:39:51 +0200108static struct clk *sclk;
Andrew Victor788b1fc2006-06-25 05:48:27 -0700109
Johan Hovolde304fcd02013-06-12 14:04:55 -0700110static void at91_rtc_write_ier(u32 mask)
111{
Johan Hovolde9f08bb2013-06-12 14:04:56 -0700112 unsigned long flags;
113
114 spin_lock_irqsave(&at91_rtc_lock, flags);
115 at91_rtc_shadow_imr |= mask;
Johan Hovolde304fcd02013-06-12 14:04:55 -0700116 at91_rtc_write(AT91_RTC_IER, mask);
Johan Hovolde9f08bb2013-06-12 14:04:56 -0700117 spin_unlock_irqrestore(&at91_rtc_lock, flags);
Johan Hovolde304fcd02013-06-12 14:04:55 -0700118}
119
120static void at91_rtc_write_idr(u32 mask)
121{
Johan Hovolde9f08bb2013-06-12 14:04:56 -0700122 unsigned long flags;
123
124 spin_lock_irqsave(&at91_rtc_lock, flags);
Johan Hovolde304fcd02013-06-12 14:04:55 -0700125 at91_rtc_write(AT91_RTC_IDR, mask);
Johan Hovolde9f08bb2013-06-12 14:04:56 -0700126 /*
127 * Register read back (of any RTC-register) needed to make sure
128 * IDR-register write has reached the peripheral before updating
129 * shadow mask.
130 *
131 * Note that there is still a possibility that the mask is updated
132 * before interrupts have actually been disabled in hardware. The only
133 * way to be certain would be to poll the IMR-register, which is is
134 * the very register we are trying to emulate. The register read back
135 * is a reasonable heuristic.
136 */
137 at91_rtc_read(AT91_RTC_SR);
138 at91_rtc_shadow_imr &= ~mask;
139 spin_unlock_irqrestore(&at91_rtc_lock, flags);
Johan Hovolde304fcd02013-06-12 14:04:55 -0700140}
141
142static u32 at91_rtc_read_imr(void)
143{
Johan Hovolde9f08bb2013-06-12 14:04:56 -0700144 unsigned long flags;
145 u32 mask;
146
147 if (at91_rtc_config->use_shadow_imr) {
148 spin_lock_irqsave(&at91_rtc_lock, flags);
149 mask = at91_rtc_shadow_imr;
150 spin_unlock_irqrestore(&at91_rtc_lock, flags);
151 } else {
152 mask = at91_rtc_read(AT91_RTC_IMR);
153 }
154
155 return mask;
Johan Hovolde304fcd02013-06-12 14:04:55 -0700156}
157
Andrew Victor788b1fc2006-06-25 05:48:27 -0700158/*
159 * Decode time/date into rtc_time structure
160 */
Andrew Mortone7a8bb12006-06-25 05:48:27 -0700161static void at91_rtc_decodetime(unsigned int timereg, unsigned int calreg,
162 struct rtc_time *tm)
Andrew Victor788b1fc2006-06-25 05:48:27 -0700163{
164 unsigned int time, date;
165
166 /* must read twice in case it changes */
167 do {
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800168 time = at91_rtc_read(timereg);
169 date = at91_rtc_read(calreg);
170 } while ((time != at91_rtc_read(timereg)) ||
171 (date != at91_rtc_read(calreg)));
Andrew Victor788b1fc2006-06-25 05:48:27 -0700172
Alexandre Belloni3c7b90c2019-12-29 21:44:18 +0100173 tm->tm_sec = bcd2bin(FIELD_GET(AT91_RTC_SEC, time));
174 tm->tm_min = bcd2bin(FIELD_GET(AT91_RTC_MIN, time));
175 tm->tm_hour = bcd2bin(FIELD_GET(AT91_RTC_HOUR, time));
Andrew Victor788b1fc2006-06-25 05:48:27 -0700176
177 /*
178 * The Calendar Alarm register does not have a field for
Alexandre Bellonieaa1dc72017-11-10 09:59:31 +0100179 * the year - so these will return an invalid value.
Andrew Victor788b1fc2006-06-25 05:48:27 -0700180 */
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700181 tm->tm_year = bcd2bin(date & AT91_RTC_CENT) * 100; /* century */
Alexandre Belloni3c7b90c2019-12-29 21:44:18 +0100182 tm->tm_year += bcd2bin(FIELD_GET(AT91_RTC_YEAR, date)); /* year */
Andrew Victor788b1fc2006-06-25 05:48:27 -0700183
Alexandre Belloni3c7b90c2019-12-29 21:44:18 +0100184 tm->tm_wday = bcd2bin(FIELD_GET(AT91_RTC_DAY, date)) - 1; /* day of the week [0-6], Sunday=0 */
185 tm->tm_mon = bcd2bin(FIELD_GET(AT91_RTC_MONTH, date)) - 1;
186 tm->tm_mday = bcd2bin(FIELD_GET(AT91_RTC_DATE, date));
Andrew Victor788b1fc2006-06-25 05:48:27 -0700187}
188
189/*
190 * Read current time and date in RTC
191 */
192static int at91_rtc_readtime(struct device *dev, struct rtc_time *tm)
193{
194 at91_rtc_decodetime(AT91_RTC_TIMR, AT91_RTC_CALR, tm);
195 tm->tm_yday = rtc_year_days(tm->tm_mday, tm->tm_mon, tm->tm_year);
196 tm->tm_year = tm->tm_year - 1900;
197
Andy Shevchenkod422f882018-12-04 23:23:13 +0200198 dev_dbg(dev, "%s(): %ptR\n", __func__, tm);
Andrew Victor788b1fc2006-06-25 05:48:27 -0700199
200 return 0;
201}
202
203/*
204 * Set current time and date in RTC
205 */
206static int at91_rtc_settime(struct device *dev, struct rtc_time *tm)
207{
208 unsigned long cr;
209
Andy Shevchenkod422f882018-12-04 23:23:13 +0200210 dev_dbg(dev, "%s(): %ptR\n", __func__, tm);
Andrew Victor788b1fc2006-06-25 05:48:27 -0700211
Boris BREZILLON2fe121e2014-06-06 14:36:09 -0700212 wait_for_completion(&at91_rtc_upd_rdy);
213
Andrew Victor788b1fc2006-06-25 05:48:27 -0700214 /* Stop Time/Calendar from counting */
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800215 cr = at91_rtc_read(AT91_RTC_CR);
216 at91_rtc_write(AT91_RTC_CR, cr | AT91_RTC_UPDCAL | AT91_RTC_UPDTIM);
Andrew Victor788b1fc2006-06-25 05:48:27 -0700217
Johan Hovolde304fcd02013-06-12 14:04:55 -0700218 at91_rtc_write_ier(AT91_RTC_ACKUPD);
Andrew Mortone7a8bb12006-06-25 05:48:27 -0700219 wait_for_completion(&at91_rtc_updated); /* wait for ACKUPD interrupt */
Johan Hovolde304fcd02013-06-12 14:04:55 -0700220 at91_rtc_write_idr(AT91_RTC_ACKUPD);
Andrew Victor788b1fc2006-06-25 05:48:27 -0700221
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800222 at91_rtc_write(AT91_RTC_TIMR,
Alexandre Belloni3c7b90c2019-12-29 21:44:18 +0100223 FIELD_PREP(AT91_RTC_SEC, bin2bcd(tm->tm_sec))
224 | FIELD_PREP(AT91_RTC_MIN, bin2bcd(tm->tm_min))
225 | FIELD_PREP(AT91_RTC_HOUR, bin2bcd(tm->tm_hour)));
Andrew Victor788b1fc2006-06-25 05:48:27 -0700226
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800227 at91_rtc_write(AT91_RTC_CALR,
Alexandre Belloni3c7b90c2019-12-29 21:44:18 +0100228 FIELD_PREP(AT91_RTC_CENT,
229 bin2bcd((tm->tm_year + 1900) / 100))
230 | FIELD_PREP(AT91_RTC_YEAR, bin2bcd(tm->tm_year % 100))
231 | FIELD_PREP(AT91_RTC_MONTH, bin2bcd(tm->tm_mon + 1))
232 | FIELD_PREP(AT91_RTC_DAY, bin2bcd(tm->tm_wday + 1))
233 | FIELD_PREP(AT91_RTC_DATE, bin2bcd(tm->tm_mday)));
Andrew Victor788b1fc2006-06-25 05:48:27 -0700234
235 /* Restart Time/Calendar */
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800236 cr = at91_rtc_read(AT91_RTC_CR);
Boris BREZILLON2fe121e2014-06-06 14:36:09 -0700237 at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_SECEV);
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800238 at91_rtc_write(AT91_RTC_CR, cr & ~(AT91_RTC_UPDCAL | AT91_RTC_UPDTIM));
Boris BREZILLON2fe121e2014-06-06 14:36:09 -0700239 at91_rtc_write_ier(AT91_RTC_SECEV);
Andrew Victor788b1fc2006-06-25 05:48:27 -0700240
241 return 0;
242}
243
244/*
245 * Read alarm time and date in RTC
246 */
247static int at91_rtc_readalarm(struct device *dev, struct rtc_wkalrm *alrm)
248{
249 struct rtc_time *tm = &alrm->time;
250
251 at91_rtc_decodetime(AT91_RTC_TIMALR, AT91_RTC_CALALR, tm);
Alexandre Bellonieaa1dc72017-11-10 09:59:31 +0100252 tm->tm_year = -1;
Andrew Victor788b1fc2006-06-25 05:48:27 -0700253
Johan Hovolde304fcd02013-06-12 14:04:55 -0700254 alrm->enabled = (at91_rtc_read_imr() & AT91_RTC_ALARM)
David Brownella2db8df2006-12-13 00:35:08 -0800255 ? 1 : 0;
256
Andy Shevchenkod422f882018-12-04 23:23:13 +0200257 dev_dbg(dev, "%s(): %ptR %sabled\n", __func__, tm,
Alexandre Bellonieaa1dc72017-11-10 09:59:31 +0100258 alrm->enabled ? "en" : "dis");
Andrew Victor788b1fc2006-06-25 05:48:27 -0700259
260 return 0;
261}
262
263/*
264 * Set alarm time and date in RTC
265 */
266static int at91_rtc_setalarm(struct device *dev, struct rtc_wkalrm *alrm)
267{
Alexandre Belloni565205d2019-12-29 21:44:17 +0100268 struct rtc_time tm = alrm->time;
Andrew Victor788b1fc2006-06-25 05:48:27 -0700269
Johan Hovolde304fcd02013-06-12 14:04:55 -0700270 at91_rtc_write_idr(AT91_RTC_ALARM);
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800271 at91_rtc_write(AT91_RTC_TIMALR,
Alexandre Belloni3c7b90c2019-12-29 21:44:18 +0100272 FIELD_PREP(AT91_RTC_SEC, bin2bcd(alrm->time.tm_sec))
273 | FIELD_PREP(AT91_RTC_MIN, bin2bcd(alrm->time.tm_min))
274 | FIELD_PREP(AT91_RTC_HOUR, bin2bcd(alrm->time.tm_hour))
Andrew Victor788b1fc2006-06-25 05:48:27 -0700275 | AT91_RTC_HOUREN | AT91_RTC_MINEN | AT91_RTC_SECEN);
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800276 at91_rtc_write(AT91_RTC_CALALR,
Alexandre Belloni3c7b90c2019-12-29 21:44:18 +0100277 FIELD_PREP(AT91_RTC_MONTH, bin2bcd(alrm->time.tm_mon + 1))
278 | FIELD_PREP(AT91_RTC_DATE, bin2bcd(alrm->time.tm_mday))
Andrew Victor788b1fc2006-06-25 05:48:27 -0700279 | AT91_RTC_DATEEN | AT91_RTC_MTHEN);
280
David Brownell449321b2008-07-23 21:30:46 -0700281 if (alrm->enabled) {
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800282 at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);
Johan Hovolde304fcd02013-06-12 14:04:55 -0700283 at91_rtc_write_ier(AT91_RTC_ALARM);
David Brownell449321b2008-07-23 21:30:46 -0700284 }
David Brownell5d4675a2007-02-20 13:58:14 -0800285
Andy Shevchenkod422f882018-12-04 23:23:13 +0200286 dev_dbg(dev, "%s(): %ptR\n", __func__, &tm);
Andrew Victor788b1fc2006-06-25 05:48:27 -0700287
288 return 0;
289}
290
John Stultz16380c12011-02-02 17:02:41 -0800291static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
292{
Jingoo Han65882082013-02-21 16:45:28 -0800293 dev_dbg(dev, "%s(): cmd=%08x\n", __func__, enabled);
John Stultz16380c12011-02-02 17:02:41 -0800294
295 if (enabled) {
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800296 at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);
Johan Hovolde304fcd02013-06-12 14:04:55 -0700297 at91_rtc_write_ier(AT91_RTC_ALARM);
Johan Hovolde24b0bf2013-04-05 18:16:34 +0200298 } else
Johan Hovolde304fcd02013-06-12 14:04:55 -0700299 at91_rtc_write_idr(AT91_RTC_ALARM);
John Stultz16380c12011-02-02 17:02:41 -0800300
301 return 0;
302}
Andrew Victor788b1fc2006-06-25 05:48:27 -0700303
Alexandre Bellonif6a46f82020-11-09 00:20:00 +0100304static int at91_rtc_readoffset(struct device *dev, long *offset)
305{
306 u32 mr = at91_rtc_read(AT91_RTC_MR);
307 long val = FIELD_GET(AT91_RTC_CORRECTION, mr);
308
309 if (!val) {
310 *offset = 0;
311 return 0;
312 }
313
314 val++;
315
316 if (!(mr & AT91_RTC_NEGPPM))
317 val = -val;
318
319 if (!(mr & AT91_RTC_HIGHPPM))
320 val *= AT91_RTC_CORR_LOW_RATIO;
321
322 *offset = DIV_ROUND_CLOSEST(AT91_RTC_CORR_DIVIDEND, val);
323
324 return 0;
325}
326
327static int at91_rtc_setoffset(struct device *dev, long offset)
328{
329 long corr;
330 u32 mr;
331
332 if (offset > AT91_RTC_CORR_DIVIDEND / 2)
333 return -ERANGE;
334 if (offset < -AT91_RTC_CORR_DIVIDEND / 2)
335 return -ERANGE;
336
337 mr = at91_rtc_read(AT91_RTC_MR);
338 mr &= ~(AT91_RTC_NEGPPM | AT91_RTC_CORRECTION | AT91_RTC_HIGHPPM);
339
340 if (offset > 0)
341 mr |= AT91_RTC_NEGPPM;
342 else
343 offset = -offset;
344
345 /* offset less than 764 ppb, disable correction*/
346 if (offset < 764) {
347 at91_rtc_write(AT91_RTC_MR, mr & ~AT91_RTC_NEGPPM);
348
349 return 0;
350 }
351
352 /*
353 * 29208 ppb is the perfect cutoff between low range and high range
354 * low range values are never better than high range value after that.
355 */
356 if (offset < 29208) {
357 corr = DIV_ROUND_CLOSEST(AT91_RTC_CORR_DIVIDEND, offset * AT91_RTC_CORR_LOW_RATIO);
358 } else {
359 corr = DIV_ROUND_CLOSEST(AT91_RTC_CORR_DIVIDEND, offset);
360 mr |= AT91_RTC_HIGHPPM;
361 }
362
363 if (corr > 128)
364 corr = 128;
365
366 mr |= FIELD_PREP(AT91_RTC_CORRECTION, corr - 1);
367
368 at91_rtc_write(AT91_RTC_MR, mr);
369
370 return 0;
371}
372
Andrew Victor788b1fc2006-06-25 05:48:27 -0700373/*
374 * IRQ handler for the RTC
375 */
David Howells7d12e782006-10-05 14:55:46 +0100376static irqreturn_t at91_rtc_interrupt(int irq, void *dev_id)
Andrew Victor788b1fc2006-06-25 05:48:27 -0700377{
Andrew Mortone7a8bb12006-06-25 05:48:27 -0700378 struct platform_device *pdev = dev_id;
Andrew Victor788b1fc2006-06-25 05:48:27 -0700379 struct rtc_device *rtc = platform_get_drvdata(pdev);
380 unsigned int rtsr;
381 unsigned long events = 0;
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +0100382 int ret = IRQ_NONE;
Andrew Victor788b1fc2006-06-25 05:48:27 -0700383
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +0100384 spin_lock(&suspended_lock);
Johan Hovolde304fcd02013-06-12 14:04:55 -0700385 rtsr = at91_rtc_read(AT91_RTC_SR) & at91_rtc_read_imr();
Andrew Victor788b1fc2006-06-25 05:48:27 -0700386 if (rtsr) { /* this interrupt is shared! Is it ours? */
387 if (rtsr & AT91_RTC_ALARM)
388 events |= (RTC_AF | RTC_IRQF);
Boris BREZILLON2fe121e2014-06-06 14:36:09 -0700389 if (rtsr & AT91_RTC_SECEV) {
390 complete(&at91_rtc_upd_rdy);
391 at91_rtc_write_idr(AT91_RTC_SECEV);
392 }
Andrew Victor788b1fc2006-06-25 05:48:27 -0700393 if (rtsr & AT91_RTC_ACKUPD)
394 complete(&at91_rtc_updated);
395
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800396 at91_rtc_write(AT91_RTC_SCCR, rtsr); /* clear status reg */
Andrew Victor788b1fc2006-06-25 05:48:27 -0700397
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +0100398 if (!suspended) {
399 rtc_update_irq(rtc, 1, events);
Andrew Victor788b1fc2006-06-25 05:48:27 -0700400
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +0100401 dev_dbg(&pdev->dev, "%s(): num=%ld, events=0x%02lx\n",
402 __func__, events >> 8, events & 0x000000FF);
403 } else {
404 cached_events |= events;
405 at91_rtc_write_idr(at91_rtc_imr);
406 pm_system_wakeup();
407 }
Andrew Victor788b1fc2006-06-25 05:48:27 -0700408
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +0100409 ret = IRQ_HANDLED;
Andrew Victor788b1fc2006-06-25 05:48:27 -0700410 }
Dan Carpenter88601682015-03-17 16:38:10 +0100411 spin_unlock(&suspended_lock);
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +0100412
413 return ret;
Andrew Victor788b1fc2006-06-25 05:48:27 -0700414}
415
Johan Hovoldde645472013-06-12 14:04:53 -0700416static const struct at91_rtc_config at91rm9200_config = {
417};
418
Johan Hovoldbba00e52013-06-12 14:04:57 -0700419static const struct at91_rtc_config at91sam9x5_config = {
420 .use_shadow_imr = true,
421};
422
Alexandre Bellonif6a46f82020-11-09 00:20:00 +0100423static const struct at91_rtc_config sama5d4_config = {
424 .has_correction = true,
425};
426
Johan Hovoldde645472013-06-12 14:04:53 -0700427static const struct of_device_id at91_rtc_dt_ids[] = {
428 {
429 .compatible = "atmel,at91rm9200-rtc",
430 .data = &at91rm9200_config,
431 }, {
Johan Hovoldbba00e52013-06-12 14:04:57 -0700432 .compatible = "atmel,at91sam9x5-rtc",
433 .data = &at91sam9x5_config,
434 }, {
Alexandre Bellonica3fdc92019-12-29 21:44:15 +0100435 .compatible = "atmel,sama5d4-rtc",
Alexandre Bellonif6a46f82020-11-09 00:20:00 +0100436 .data = &sama5d4_config,
Alexandre Bellonica3fdc92019-12-29 21:44:15 +0100437 }, {
438 .compatible = "atmel,sama5d2-rtc",
Alexandre Bellonif6a46f82020-11-09 00:20:00 +0100439 .data = &sama5d4_config,
Alexandre Bellonica3fdc92019-12-29 21:44:15 +0100440 }, {
Alexandre Bellonibfca1c92020-11-17 14:39:20 +0100441 .compatible = "microchip,sam9x60-rtc",
442 .data = &sama5d4_config,
443 }, {
Johan Hovoldde645472013-06-12 14:04:53 -0700444 /* sentinel */
445 }
446};
447MODULE_DEVICE_TABLE(of, at91_rtc_dt_ids);
Johan Hovoldde645472013-06-12 14:04:53 -0700448
David Brownellff8371a2006-09-30 23:28:17 -0700449static const struct rtc_class_ops at91_rtc_ops = {
Andrew Victor788b1fc2006-06-25 05:48:27 -0700450 .read_time = at91_rtc_readtime,
451 .set_time = at91_rtc_settime,
452 .read_alarm = at91_rtc_readalarm,
453 .set_alarm = at91_rtc_setalarm,
John Stultz16380c12011-02-02 17:02:41 -0800454 .alarm_irq_enable = at91_rtc_alarm_irq_enable,
Andrew Victor788b1fc2006-06-25 05:48:27 -0700455};
456
Alexandre Bellonif6a46f82020-11-09 00:20:00 +0100457static const struct rtc_class_ops sama5d4_rtc_ops = {
458 .read_time = at91_rtc_readtime,
459 .set_time = at91_rtc_settime,
460 .read_alarm = at91_rtc_readalarm,
461 .set_alarm = at91_rtc_setalarm,
462 .alarm_irq_enable = at91_rtc_alarm_irq_enable,
463 .set_offset = at91_rtc_setoffset,
464 .read_offset = at91_rtc_readoffset,
465};
466
Andrew Victor788b1fc2006-06-25 05:48:27 -0700467/*
468 * Initialize and install RTC driver
469 */
470static int __init at91_rtc_probe(struct platform_device *pdev)
471{
472 struct rtc_device *rtc;
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800473 struct resource *regs;
474 int ret = 0;
Andrew Victor788b1fc2006-06-25 05:48:27 -0700475
Claudiu Beznea288d9cf2019-09-26 15:15:32 +0300476 at91_rtc_config = of_device_get_match_data(&pdev->dev);
Johan Hovoldde645472013-06-12 14:04:53 -0700477 if (!at91_rtc_config)
478 return -ENODEV;
479
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800480 regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
481 if (!regs) {
482 dev_err(&pdev->dev, "no mmio resource defined\n");
483 return -ENXIO;
484 }
485
486 irq = platform_get_irq(pdev, 0);
Stephen Boydfaac9102019-07-30 11:15:39 -0700487 if (irq < 0)
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800488 return -ENXIO;
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800489
Sachin Kamatf3766252013-11-12 15:10:29 -0800490 at91_rtc_regs = devm_ioremap(&pdev->dev, regs->start,
491 resource_size(regs));
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800492 if (!at91_rtc_regs) {
493 dev_err(&pdev->dev, "failed to map registers, aborting.\n");
494 return -ENOMEM;
495 }
496
Alexandre Belloni735ae202017-07-06 11:42:01 +0200497 rtc = devm_rtc_allocate_device(&pdev->dev);
498 if (IS_ERR(rtc))
499 return PTR_ERR(rtc);
500 platform_set_drvdata(pdev, rtc);
501
Alexandre Belloni11f67a82015-07-31 11:39:51 +0200502 sclk = devm_clk_get(&pdev->dev, NULL);
503 if (IS_ERR(sclk))
504 return PTR_ERR(sclk);
505
506 ret = clk_prepare_enable(sclk);
507 if (ret) {
508 dev_err(&pdev->dev, "Could not enable slow clock\n");
509 return ret;
510 }
511
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800512 at91_rtc_write(AT91_RTC_CR, 0);
Alexandre Bellonif6a46f82020-11-09 00:20:00 +0100513 at91_rtc_write(AT91_RTC_MR, at91_rtc_read(AT91_RTC_MR) & ~AT91_RTC_HRMOD);
Andrew Victor788b1fc2006-06-25 05:48:27 -0700514
515 /* Disable all interrupts */
Johan Hovolde304fcd02013-06-12 14:04:55 -0700516 at91_rtc_write_idr(AT91_RTC_ACKUPD | AT91_RTC_ALARM |
Andrew Mortone7a8bb12006-06-25 05:48:27 -0700517 AT91_RTC_SECEV | AT91_RTC_TIMEV |
518 AT91_RTC_CALEV);
Andrew Victor788b1fc2006-06-25 05:48:27 -0700519
Sachin Kamatf3766252013-11-12 15:10:29 -0800520 ret = devm_request_irq(&pdev->dev, irq, at91_rtc_interrupt,
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +0100521 IRQF_SHARED | IRQF_COND_SUSPEND,
522 "at91_rtc", pdev);
Andrew Victor788b1fc2006-06-25 05:48:27 -0700523 if (ret) {
Jingoo Han65882082013-02-21 16:45:28 -0800524 dev_err(&pdev->dev, "IRQ %d already in use.\n", irq);
Alexandre Belloni11f67a82015-07-31 11:39:51 +0200525 goto err_clk;
Andrew Victor788b1fc2006-06-25 05:48:27 -0700526 }
527
David Brownell5d4675a2007-02-20 13:58:14 -0800528 /* cpu init code should really have flagged this device as
529 * being wake-capable; if it didn't, do that here.
530 */
531 if (!device_can_wakeup(&pdev->dev))
532 device_init_wakeup(&pdev->dev, 1);
533
Alexandre Bellonif6a46f82020-11-09 00:20:00 +0100534 if (at91_rtc_config->has_correction)
535 rtc->ops = &sama5d4_rtc_ops;
536 else
537 rtc->ops = &at91_rtc_ops;
538
Alexandre Belloni6c78a872018-05-17 22:17:28 +0200539 rtc->range_min = RTC_TIMESTAMP_BEGIN_1900;
540 rtc->range_max = RTC_TIMESTAMP_END_2099;
Bartosz Golaszewskifdcfd852020-11-09 17:34:08 +0100541 ret = devm_rtc_register_device(rtc);
Alexandre Belloni735ae202017-07-06 11:42:01 +0200542 if (ret)
Alexandre Belloni11f67a82015-07-31 11:39:51 +0200543 goto err_clk;
Andrew Victor788b1fc2006-06-25 05:48:27 -0700544
Boris BREZILLON2fe121e2014-06-06 14:36:09 -0700545 /* enable SECEV interrupt in order to initialize at91_rtc_upd_rdy
546 * completion.
547 */
548 at91_rtc_write_ier(AT91_RTC_SECEV);
549
Jingoo Han65882082013-02-21 16:45:28 -0800550 dev_info(&pdev->dev, "AT91 Real Time Clock driver.\n");
Andrew Victor788b1fc2006-06-25 05:48:27 -0700551 return 0;
Alexandre Belloni11f67a82015-07-31 11:39:51 +0200552
553err_clk:
554 clk_disable_unprepare(sclk);
555
556 return ret;
Andrew Victor788b1fc2006-06-25 05:48:27 -0700557}
558
559/*
560 * Disable and remove the RTC driver
561 */
David Brownell5d4675a2007-02-20 13:58:14 -0800562static int __exit at91_rtc_remove(struct platform_device *pdev)
Andrew Victor788b1fc2006-06-25 05:48:27 -0700563{
Andrew Victor788b1fc2006-06-25 05:48:27 -0700564 /* Disable all interrupts */
Johan Hovolde304fcd02013-06-12 14:04:55 -0700565 at91_rtc_write_idr(AT91_RTC_ACKUPD | AT91_RTC_ALARM |
Andrew Mortone7a8bb12006-06-25 05:48:27 -0700566 AT91_RTC_SECEV | AT91_RTC_TIMEV |
567 AT91_RTC_CALEV);
Andrew Victor788b1fc2006-06-25 05:48:27 -0700568
Alexandre Belloni11f67a82015-07-31 11:39:51 +0200569 clk_disable_unprepare(sclk);
570
Andrew Victor788b1fc2006-06-25 05:48:27 -0700571 return 0;
572}
573
Johan Hovold51a0d032013-11-21 14:32:04 -0800574static void at91_rtc_shutdown(struct platform_device *pdev)
575{
576 /* Disable all interrupts */
577 at91_rtc_write(AT91_RTC_IDR, AT91_RTC_ACKUPD | AT91_RTC_ALARM |
578 AT91_RTC_SECEV | AT91_RTC_TIMEV |
579 AT91_RTC_CALEV);
580}
581
Jingoo Han6975a9c2013-04-29 16:19:56 -0700582#ifdef CONFIG_PM_SLEEP
Andrew Victor788b1fc2006-06-25 05:48:27 -0700583
584/* AT91RM9200 RTC Power management control */
585
David Brownelldac94d92009-09-22 16:46:31 -0700586static int at91_rtc_suspend(struct device *dev)
Andrew Victor788b1fc2006-06-25 05:48:27 -0700587{
David Brownell90b4d642006-09-30 23:28:17 -0700588 /* this IRQ is shared with DBGU and other hardware which isn't
589 * necessarily doing PM like we are...
590 */
Wenyou Yang921372b2015-10-12 16:39:23 +0800591 at91_rtc_write(AT91_RTC_SCCR, AT91_RTC_ALARM);
592
Johan Hovolde304fcd02013-06-12 14:04:55 -0700593 at91_rtc_imr = at91_rtc_read_imr()
Johan Hovolde24b0bf2013-04-05 18:16:34 +0200594 & (AT91_RTC_ALARM|AT91_RTC_SECEV);
595 if (at91_rtc_imr) {
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +0100596 if (device_may_wakeup(dev)) {
597 unsigned long flags;
598
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800599 enable_irq_wake(irq);
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +0100600
601 spin_lock_irqsave(&suspended_lock, flags);
602 suspended = true;
603 spin_unlock_irqrestore(&suspended_lock, flags);
604 } else {
Johan Hovolde304fcd02013-06-12 14:04:55 -0700605 at91_rtc_write_idr(at91_rtc_imr);
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +0100606 }
Johan Hovolde24b0bf2013-04-05 18:16:34 +0200607 }
Andrew Victor788b1fc2006-06-25 05:48:27 -0700608 return 0;
609}
610
David Brownelldac94d92009-09-22 16:46:31 -0700611static int at91_rtc_resume(struct device *dev)
Andrew Victor788b1fc2006-06-25 05:48:27 -0700612{
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +0100613 struct rtc_device *rtc = dev_get_drvdata(dev);
614
Johan Hovolde24b0bf2013-04-05 18:16:34 +0200615 if (at91_rtc_imr) {
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +0100616 if (device_may_wakeup(dev)) {
617 unsigned long flags;
618
619 spin_lock_irqsave(&suspended_lock, flags);
620
621 if (cached_events) {
622 rtc_update_irq(rtc, 1, cached_events);
623 cached_events = 0;
624 }
625
626 suspended = false;
627 spin_unlock_irqrestore(&suspended_lock, flags);
628
Jean-Christophe PLAGNIOL-VILLARDd28bdfc2011-11-14 14:24:53 +0800629 disable_irq_wake(irq);
Boris BREZILLONdd1f1f32015-03-02 10:18:15 +0100630 }
631 at91_rtc_write_ier(at91_rtc_imr);
David Brownell90b4d642006-09-30 23:28:17 -0700632 }
Andrew Victor788b1fc2006-06-25 05:48:27 -0700633 return 0;
634}
Andrew Victor788b1fc2006-06-25 05:48:27 -0700635#endif
636
Jingoo Han6975a9c2013-04-29 16:19:56 -0700637static SIMPLE_DEV_PM_OPS(at91_rtc_pm_ops, at91_rtc_suspend, at91_rtc_resume);
638
Andrew Victor788b1fc2006-06-25 05:48:27 -0700639static struct platform_driver at91_rtc_driver = {
David Brownell5d4675a2007-02-20 13:58:14 -0800640 .remove = __exit_p(at91_rtc_remove),
Johan Hovold51a0d032013-11-21 14:32:04 -0800641 .shutdown = at91_rtc_shutdown,
Andrew Victor788b1fc2006-06-25 05:48:27 -0700642 .driver = {
643 .name = "at91_rtc",
Jingoo Han6975a9c2013-04-29 16:19:56 -0700644 .pm = &at91_rtc_pm_ops,
Joachim Eastwood7c1b68d2013-04-29 16:20:15 -0700645 .of_match_table = of_match_ptr(at91_rtc_dt_ids),
Andrew Victor788b1fc2006-06-25 05:48:27 -0700646 },
647};
648
Jingoo Hanac369602013-04-29 16:18:36 -0700649module_platform_driver_probe(at91_rtc_driver, at91_rtc_probe);
Andrew Victor788b1fc2006-06-25 05:48:27 -0700650
651MODULE_AUTHOR("Rick Bronson");
652MODULE_DESCRIPTION("RTC driver for Atmel AT91RM9200");
653MODULE_LICENSE("GPL");
Kay Sieversad28a072008-04-10 21:29:25 -0700654MODULE_ALIAS("platform:at91_rtc");