1 // SPDX-License-Identifier: GPL-2.0-only
3 * An rtc driver for the Dallas DS1511
5 * Copyright (C) 2006 Atsushi Nemoto <anemo@mba.ocn.ne.jp>
6 * Copyright (C) 2007 Andrew Sharp <andy.sharp@lsi.com>
8 * Real time clock driver for the Dallas 1511 chip, which also
9 * contains a watchdog timer. There is a tiny amount of code that
10 * platform code could use to mess with the watchdog device a little
11 * bit, but not a full watchdog driver.
14 #include <linux/bcd.h>
15 #include <linux/init.h>
16 #include <linux/kernel.h>
17 #include <linux/gfp.h>
18 #include <linux/delay.h>
19 #include <linux/interrupt.h>
20 #include <linux/rtc.h>
21 #include <linux/platform_device.h>
23 #include <linux/module.h>
36 DS1511_AM3_HOUR = 0xa,
37 DS1511_AM4_DATE = 0xb,
40 DS1511_CONTROL_A = 0xe,
41 DS1511_CONTROL_B = 0xf,
42 DS1511_RAMADDR_LSB = 0x10,
46 #define DS1511_BLF1 0x80
47 #define DS1511_BLF2 0x40
48 #define DS1511_PRS 0x20
49 #define DS1511_PAB 0x10
50 #define DS1511_TDF 0x08
51 #define DS1511_KSF 0x04
52 #define DS1511_WDF 0x02
53 #define DS1511_IRQF 0x01
54 #define DS1511_TE 0x80
55 #define DS1511_CS 0x40
56 #define DS1511_BME 0x20
57 #define DS1511_TPE 0x10
58 #define DS1511_TIE 0x08
59 #define DS1511_KIE 0x04
60 #define DS1511_WDE 0x02
61 #define DS1511_WDS 0x01
62 #define DS1511_RAM_MAX 0x100
64 #define RTC_CMD DS1511_CONTROL_B
65 #define RTC_CMD1 DS1511_CONTROL_A
67 #define RTC_ALARM_SEC DS1511_AM1_SEC
68 #define RTC_ALARM_MIN DS1511_AM2_MIN
69 #define RTC_ALARM_HOUR DS1511_AM3_HOUR
70 #define RTC_ALARM_DATE DS1511_AM4_DATE
72 #define RTC_SEC DS1511_SEC
73 #define RTC_MIN DS1511_MIN
74 #define RTC_HOUR DS1511_HOUR
75 #define RTC_DOW DS1511_DOW
76 #define RTC_DOM DS1511_DOM
77 #define RTC_MON DS1511_MONTH
78 #define RTC_YEAR DS1511_YEAR
79 #define RTC_CENTURY DS1511_CENTURY
81 #define RTC_TIE DS1511_TIE
82 #define RTC_TE DS1511_TE
84 struct rtc_plat_data {
85 struct rtc_device *rtc;
86 void __iomem *ioaddr; /* virtual base address */
96 static DEFINE_SPINLOCK(ds1511_lock);
98 static __iomem char *ds1511_base;
99 static u32 reg_spacing = 1;
102 rtc_write(uint8_t val, uint32_t reg)
104 writeb(val, ds1511_base + (reg * reg_spacing));
108 rtc_write_alarm(uint8_t val, enum ds1511reg reg)
110 rtc_write((val | 0x80), reg);
113 static noinline uint8_t
114 rtc_read(enum ds1511reg reg)
116 return readb(ds1511_base + (reg * reg_spacing));
120 rtc_disable_update(void)
122 rtc_write((rtc_read(RTC_CMD) & ~RTC_TE), RTC_CMD);
126 rtc_enable_update(void)
128 rtc_write((rtc_read(RTC_CMD) | RTC_TE), RTC_CMD);
132 * #define DS1511_WDOG_RESET_SUPPORT
134 * Uncomment this if you want to use these routines in
135 * some platform code.
137 #ifdef DS1511_WDOG_RESET_SUPPORT
139 * just enough code to set the watchdog timer so that it
140 * will reboot the system
143 ds1511_wdog_set(unsigned long deciseconds)
146 * the wdog timer can take 99.99 seconds
148 deciseconds %= 10000;
150 * set the wdog values in the wdog registers
152 rtc_write(bin2bcd(deciseconds % 100), DS1511_WD_MSEC);
153 rtc_write(bin2bcd(deciseconds / 100), DS1511_WD_SEC);
155 * set wdog enable and wdog 'steering' bit to issue a reset
157 rtc_write(rtc_read(RTC_CMD) | DS1511_WDE | DS1511_WDS, RTC_CMD);
161 ds1511_wdog_disable(void)
164 * clear wdog enable and wdog 'steering' bits
166 rtc_write(rtc_read(RTC_CMD) & ~(DS1511_WDE | DS1511_WDS), RTC_CMD);
168 * clear the wdog counter
170 rtc_write(0, DS1511_WD_MSEC);
171 rtc_write(0, DS1511_WD_SEC);
176 * set the rtc chip's idea of the time.
177 * stupidly, some callers call with year unmolested;
178 * and some call with year = year - 1900. thanks.
180 static int ds1511_rtc_set_time(struct device *dev, struct rtc_time *rtc_tm)
182 u8 mon, day, dow, hrs, min, sec, yrs, cen;
186 * won't have to change this for a while
188 if (rtc_tm->tm_year < 1900)
189 rtc_tm->tm_year += 1900;
191 if (rtc_tm->tm_year < 1970)
194 yrs = rtc_tm->tm_year % 100;
195 cen = rtc_tm->tm_year / 100;
196 mon = rtc_tm->tm_mon + 1; /* tm_mon starts at zero */
197 day = rtc_tm->tm_mday;
198 dow = rtc_tm->tm_wday & 0x7; /* automatic BCD */
199 hrs = rtc_tm->tm_hour;
200 min = rtc_tm->tm_min;
201 sec = rtc_tm->tm_sec;
203 if ((mon > 12) || (day == 0))
206 if (day > rtc_month_days(rtc_tm->tm_mon, rtc_tm->tm_year))
209 if ((hrs >= 24) || (min >= 60) || (sec >= 60))
213 * each register is a different number of valid bits
215 sec = bin2bcd(sec) & 0x7f;
216 min = bin2bcd(min) & 0x7f;
217 hrs = bin2bcd(hrs) & 0x3f;
218 day = bin2bcd(day) & 0x3f;
219 mon = bin2bcd(mon) & 0x1f;
220 yrs = bin2bcd(yrs) & 0xff;
221 cen = bin2bcd(cen) & 0xff;
223 spin_lock_irqsave(&ds1511_lock, flags);
224 rtc_disable_update();
225 rtc_write(cen, RTC_CENTURY);
226 rtc_write(yrs, RTC_YEAR);
227 rtc_write((rtc_read(RTC_MON) & 0xe0) | mon, RTC_MON);
228 rtc_write(day, RTC_DOM);
229 rtc_write(hrs, RTC_HOUR);
230 rtc_write(min, RTC_MIN);
231 rtc_write(sec, RTC_SEC);
232 rtc_write(dow, RTC_DOW);
234 spin_unlock_irqrestore(&ds1511_lock, flags);
239 static int ds1511_rtc_read_time(struct device *dev, struct rtc_time *rtc_tm)
241 unsigned int century;
244 spin_lock_irqsave(&ds1511_lock, flags);
245 rtc_disable_update();
247 rtc_tm->tm_sec = rtc_read(RTC_SEC) & 0x7f;
248 rtc_tm->tm_min = rtc_read(RTC_MIN) & 0x7f;
249 rtc_tm->tm_hour = rtc_read(RTC_HOUR) & 0x3f;
250 rtc_tm->tm_mday = rtc_read(RTC_DOM) & 0x3f;
251 rtc_tm->tm_wday = rtc_read(RTC_DOW) & 0x7;
252 rtc_tm->tm_mon = rtc_read(RTC_MON) & 0x1f;
253 rtc_tm->tm_year = rtc_read(RTC_YEAR) & 0x7f;
254 century = rtc_read(RTC_CENTURY);
257 spin_unlock_irqrestore(&ds1511_lock, flags);
259 rtc_tm->tm_sec = bcd2bin(rtc_tm->tm_sec);
260 rtc_tm->tm_min = bcd2bin(rtc_tm->tm_min);
261 rtc_tm->tm_hour = bcd2bin(rtc_tm->tm_hour);
262 rtc_tm->tm_mday = bcd2bin(rtc_tm->tm_mday);
263 rtc_tm->tm_wday = bcd2bin(rtc_tm->tm_wday);
264 rtc_tm->tm_mon = bcd2bin(rtc_tm->tm_mon);
265 rtc_tm->tm_year = bcd2bin(rtc_tm->tm_year);
266 century = bcd2bin(century) * 100;
269 * Account for differences between how the RTC uses the values
270 * and how they are defined in a struct rtc_time;
272 century += rtc_tm->tm_year;
273 rtc_tm->tm_year = century - 1900;
281 * write the alarm register settings
283 * we only have the use to interrupt every second, otherwise
284 * known as the update interrupt, or the interrupt if the whole
285 * date/hours/mins/secs matches. the ds1511 has many more
286 * permutations, but the kernel doesn't.
289 ds1511_rtc_update_alarm(struct rtc_plat_data *pdata)
293 spin_lock_irqsave(&pdata->lock, flags);
294 rtc_write(pdata->alrm_mday < 0 || (pdata->irqen & RTC_UF) ?
295 0x80 : bin2bcd(pdata->alrm_mday) & 0x3f,
297 rtc_write(pdata->alrm_hour < 0 || (pdata->irqen & RTC_UF) ?
298 0x80 : bin2bcd(pdata->alrm_hour) & 0x3f,
300 rtc_write(pdata->alrm_min < 0 || (pdata->irqen & RTC_UF) ?
301 0x80 : bin2bcd(pdata->alrm_min) & 0x7f,
303 rtc_write(pdata->alrm_sec < 0 || (pdata->irqen & RTC_UF) ?
304 0x80 : bin2bcd(pdata->alrm_sec) & 0x7f,
306 rtc_write(rtc_read(RTC_CMD) | (pdata->irqen ? RTC_TIE : 0), RTC_CMD);
307 rtc_read(RTC_CMD1); /* clear interrupts */
308 spin_unlock_irqrestore(&pdata->lock, flags);
312 ds1511_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
314 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
319 pdata->alrm_mday = alrm->time.tm_mday;
320 pdata->alrm_hour = alrm->time.tm_hour;
321 pdata->alrm_min = alrm->time.tm_min;
322 pdata->alrm_sec = alrm->time.tm_sec;
324 pdata->irqen |= RTC_AF;
326 ds1511_rtc_update_alarm(pdata);
331 ds1511_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
333 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
338 alrm->time.tm_mday = pdata->alrm_mday < 0 ? 0 : pdata->alrm_mday;
339 alrm->time.tm_hour = pdata->alrm_hour < 0 ? 0 : pdata->alrm_hour;
340 alrm->time.tm_min = pdata->alrm_min < 0 ? 0 : pdata->alrm_min;
341 alrm->time.tm_sec = pdata->alrm_sec < 0 ? 0 : pdata->alrm_sec;
342 alrm->enabled = (pdata->irqen & RTC_AF) ? 1 : 0;
347 ds1511_interrupt(int irq, void *dev_id)
349 struct platform_device *pdev = dev_id;
350 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
351 unsigned long events = 0;
353 spin_lock(&pdata->lock);
355 * read and clear interrupt
357 if (rtc_read(RTC_CMD1) & DS1511_IRQF) {
359 if (rtc_read(RTC_ALARM_SEC) & 0x80)
363 rtc_update_irq(pdata->rtc, 1, events);
365 spin_unlock(&pdata->lock);
366 return events ? IRQ_HANDLED : IRQ_NONE;
369 static int ds1511_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
371 struct rtc_plat_data *pdata = dev_get_drvdata(dev);
376 pdata->irqen |= RTC_AF;
378 pdata->irqen &= ~RTC_AF;
379 ds1511_rtc_update_alarm(pdata);
383 static const struct rtc_class_ops ds1511_rtc_ops = {
384 .read_time = ds1511_rtc_read_time,
385 .set_time = ds1511_rtc_set_time,
386 .read_alarm = ds1511_rtc_read_alarm,
387 .set_alarm = ds1511_rtc_set_alarm,
388 .alarm_irq_enable = ds1511_rtc_alarm_irq_enable,
391 static int ds1511_nvram_read(void *priv, unsigned int pos, void *buf,
396 rtc_write(pos, DS1511_RAMADDR_LSB);
397 for (i = 0; i < size; i++)
398 *(char *)buf++ = rtc_read(DS1511_RAMDATA);
403 static int ds1511_nvram_write(void *priv, unsigned int pos, void *buf,
408 rtc_write(pos, DS1511_RAMADDR_LSB);
409 for (i = 0; i < size; i++)
410 rtc_write(*(char *)buf++, DS1511_RAMDATA);
415 static int ds1511_rtc_probe(struct platform_device *pdev)
417 struct rtc_plat_data *pdata;
419 struct nvmem_config ds1511_nvmem_cfg = {
420 .name = "ds1511_nvram",
423 .size = DS1511_RAM_MAX,
424 .reg_read = ds1511_nvram_read,
425 .reg_write = ds1511_nvram_write,
429 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
433 ds1511_base = devm_platform_ioremap_resource(pdev, 0);
434 if (IS_ERR(ds1511_base))
435 return PTR_ERR(ds1511_base);
436 pdata->ioaddr = ds1511_base;
437 pdata->irq = platform_get_irq(pdev, 0);
440 * turn on the clock and the crystal, etc.
442 rtc_write(DS1511_BME, RTC_CMD);
443 rtc_write(0, RTC_CMD1);
445 * clear the wdog counter
447 rtc_write(0, DS1511_WD_MSEC);
448 rtc_write(0, DS1511_WD_SEC);
455 * check for a dying bat-tree
457 if (rtc_read(RTC_CMD1) & DS1511_BLF1)
458 dev_warn(&pdev->dev, "voltage-low detected.\n");
460 spin_lock_init(&pdata->lock);
461 platform_set_drvdata(pdev, pdata);
463 pdata->rtc = devm_rtc_allocate_device(&pdev->dev);
464 if (IS_ERR(pdata->rtc))
465 return PTR_ERR(pdata->rtc);
467 pdata->rtc->ops = &ds1511_rtc_ops;
469 pdata->rtc->nvram_old_abi = true;
471 ret = rtc_register_device(pdata->rtc);
475 rtc_nvmem_register(pdata->rtc, &ds1511_nvmem_cfg);
478 * if the platform has an interrupt in mind for this device,
479 * then by all means, set it
481 if (pdata->irq > 0) {
483 if (devm_request_irq(&pdev->dev, pdata->irq, ds1511_interrupt,
484 IRQF_SHARED, pdev->name, pdev) < 0) {
486 dev_warn(&pdev->dev, "interrupt not available.\n");
494 /* work with hotplug and coldplug */
495 MODULE_ALIAS("platform:ds1511");
497 static struct platform_driver ds1511_rtc_driver = {
498 .probe = ds1511_rtc_probe,
504 module_platform_driver(ds1511_rtc_driver);
506 MODULE_AUTHOR("Andrew Sharp <andy.sharp@lsi.com>");
507 MODULE_DESCRIPTION("Dallas DS1511 RTC driver");
508 MODULE_LICENSE("GPL");