1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * RTC class driver for "CMOS RTC": PCs, ACPI, etc
5 * Copyright (C) 1996 Paul Gortmaker (drivers/char/rtc.c)
6 * Copyright (C) 2006 David Brownell (convert to new framework)
10 * The original "cmos clock" chip was an MC146818 chip, now obsolete.
11 * That defined the register interface now provided by all PCs, some
12 * non-PC systems, and incorporated into ACPI. Modern PC chipsets
13 * integrate an MC146818 clone in their southbridge, and boards use
14 * that instead of discrete clones like the DS12887 or M48T86. There
15 * are also clones that connect using the LPC bus.
17 * That register API is also used directly by various other drivers
18 * (notably for integrated NVRAM), infrastructure (x86 has code to
19 * bypass the RTC framework, directly reading the RTC during boot
20 * and updating minutes/seconds for systems using NTP synch) and
21 * utilities (like userspace 'hwclock', if no /dev node exists).
23 * So **ALL** calls to CMOS_READ and CMOS_WRITE must be done with
24 * interrupts disabled, holding the global rtc_lock, to exclude those
25 * other drivers and utilities on correctly configured systems.
28 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
30 #include <linux/kernel.h>
31 #include <linux/module.h>
32 #include <linux/init.h>
33 #include <linux/interrupt.h>
34 #include <linux/spinlock.h>
35 #include <linux/platform_device.h>
36 #include <linux/log2.h>
39 #include <linux/of_platform.h>
41 #include <asm/i8259.h>
42 #include <asm/processor.h>
43 #include <linux/dmi.h>
46 /* this is for "generic access to PC-style RTC" using CMOS_READ/CMOS_WRITE */
47 #include <linux/mc146818rtc.h>
51 * Use ACPI SCI to replace HPET interrupt for RTC Alarm event
53 * If cleared, ACPI SCI is only used to wake up the system from suspend
55 * If set, ACPI SCI is used to handle UIE/AIE and system wakeup
58 static bool use_acpi_alarm;
59 module_param(use_acpi_alarm, bool, 0444);
61 static inline int cmos_use_acpi_alarm(void)
63 return use_acpi_alarm;
65 #else /* !CONFIG_ACPI */
67 static inline int cmos_use_acpi_alarm(void)
74 struct rtc_device *rtc;
77 struct resource *iomem;
78 time64_t alarm_expires;
80 void (*wake_on)(struct device *);
81 void (*wake_off)(struct device *);
86 /* newer hardware extends the original register set */
91 struct rtc_wkalrm saved_wkalrm;
94 /* both platform and pnp busses use negative numbers for invalid irqs */
95 #define is_valid_irq(n) ((n) > 0)
97 static const char driver_name[] = "rtc_cmos";
99 /* The RTC_INTR register may have e.g. RTC_PF set even if RTC_PIE is clear;
100 * always mask it against the irq enable bits in RTC_CONTROL. Bit values
101 * are the same: PF==PIE, AF=AIE, UF=UIE; so RTC_IRQMASK works with both.
103 #define RTC_IRQMASK (RTC_PF | RTC_AF | RTC_UF)
105 static inline int is_intr(u8 rtc_intr)
107 if (!(rtc_intr & RTC_IRQF))
109 return rtc_intr & RTC_IRQMASK;
112 /*----------------------------------------------------------------*/
114 /* Much modern x86 hardware has HPETs (10+ MHz timers) which, because
115 * many BIOS programmers don't set up "sane mode" IRQ routing, are mostly
116 * used in a broken "legacy replacement" mode. The breakage includes
117 * HPET #1 hijacking the IRQ for this RTC, and being unavailable for
118 * other (better) use.
120 * When that broken mode is in use, platform glue provides a partial
121 * emulation of hardware RTC IRQ facilities using HPET #1. We don't
122 * want to use HPET for anything except those IRQs though...
124 #ifdef CONFIG_HPET_EMULATE_RTC
125 #include <asm/hpet.h>
128 static inline int is_hpet_enabled(void)
133 static inline int hpet_mask_rtc_irq_bit(unsigned long mask)
138 static inline int hpet_set_rtc_irq_bit(unsigned long mask)
144 hpet_set_alarm_time(unsigned char hrs, unsigned char min, unsigned char sec)
149 static inline int hpet_set_periodic_freq(unsigned long freq)
154 static inline int hpet_rtc_dropped_irq(void)
159 static inline int hpet_rtc_timer_init(void)
164 extern irq_handler_t hpet_rtc_interrupt;
166 static inline int hpet_register_irq_handler(irq_handler_t handler)
171 static inline int hpet_unregister_irq_handler(irq_handler_t handler)
178 /* Don't use HPET for RTC Alarm event if ACPI Fixed event is used */
179 static inline int use_hpet_alarm(void)
181 return is_hpet_enabled() && !cmos_use_acpi_alarm();
184 /*----------------------------------------------------------------*/
188 /* Most newer x86 systems have two register banks, the first used
189 * for RTC and NVRAM and the second only for NVRAM. Caller must
190 * own rtc_lock ... and we won't worry about access during NMI.
192 #define can_bank2 true
194 static inline unsigned char cmos_read_bank2(unsigned char addr)
196 outb(addr, RTC_PORT(2));
197 return inb(RTC_PORT(3));
200 static inline void cmos_write_bank2(unsigned char val, unsigned char addr)
202 outb(addr, RTC_PORT(2));
203 outb(val, RTC_PORT(3));
208 #define can_bank2 false
210 static inline unsigned char cmos_read_bank2(unsigned char addr)
215 static inline void cmos_write_bank2(unsigned char val, unsigned char addr)
221 /*----------------------------------------------------------------*/
223 static int cmos_read_time(struct device *dev, struct rtc_time *t)
226 * If pm_trace abused the RTC for storage, set the timespec to 0,
227 * which tells the caller that this RTC value is unusable.
229 if (!pm_trace_rtc_valid())
232 /* REVISIT: if the clock has a "century" register, use
233 * that instead of the heuristic in mc146818_get_time().
234 * That'll make Y3K compatility (year > 2070) easy!
236 mc146818_get_time(t);
240 static int cmos_set_time(struct device *dev, struct rtc_time *t)
242 /* REVISIT: set the "century" register if available
244 * NOTE: this ignores the issue whereby updating the seconds
245 * takes effect exactly 500ms after we write the register.
246 * (Also queueing and other delays before we get this far.)
248 return mc146818_set_time(t);
251 static int cmos_read_alarm(struct device *dev, struct rtc_wkalrm *t)
253 struct cmos_rtc *cmos = dev_get_drvdata(dev);
254 unsigned char rtc_control;
256 /* This not only a rtc_op, but also called directly */
257 if (!is_valid_irq(cmos->irq))
260 /* Basic alarms only support hour, minute, and seconds fields.
261 * Some also support day and month, for alarms up to a year in
265 spin_lock_irq(&rtc_lock);
266 t->time.tm_sec = CMOS_READ(RTC_SECONDS_ALARM);
267 t->time.tm_min = CMOS_READ(RTC_MINUTES_ALARM);
268 t->time.tm_hour = CMOS_READ(RTC_HOURS_ALARM);
270 if (cmos->day_alrm) {
271 /* ignore upper bits on readback per ACPI spec */
272 t->time.tm_mday = CMOS_READ(cmos->day_alrm) & 0x3f;
273 if (!t->time.tm_mday)
274 t->time.tm_mday = -1;
276 if (cmos->mon_alrm) {
277 t->time.tm_mon = CMOS_READ(cmos->mon_alrm);
283 rtc_control = CMOS_READ(RTC_CONTROL);
284 spin_unlock_irq(&rtc_lock);
286 if (!(rtc_control & RTC_DM_BINARY) || RTC_ALWAYS_BCD) {
287 if (((unsigned)t->time.tm_sec) < 0x60)
288 t->time.tm_sec = bcd2bin(t->time.tm_sec);
291 if (((unsigned)t->time.tm_min) < 0x60)
292 t->time.tm_min = bcd2bin(t->time.tm_min);
295 if (((unsigned)t->time.tm_hour) < 0x24)
296 t->time.tm_hour = bcd2bin(t->time.tm_hour);
298 t->time.tm_hour = -1;
300 if (cmos->day_alrm) {
301 if (((unsigned)t->time.tm_mday) <= 0x31)
302 t->time.tm_mday = bcd2bin(t->time.tm_mday);
304 t->time.tm_mday = -1;
306 if (cmos->mon_alrm) {
307 if (((unsigned)t->time.tm_mon) <= 0x12)
308 t->time.tm_mon = bcd2bin(t->time.tm_mon)-1;
315 t->enabled = !!(rtc_control & RTC_AIE);
321 static void cmos_checkintr(struct cmos_rtc *cmos, unsigned char rtc_control)
323 unsigned char rtc_intr;
325 /* NOTE after changing RTC_xIE bits we always read INTR_FLAGS;
326 * allegedly some older rtcs need that to handle irqs properly
328 rtc_intr = CMOS_READ(RTC_INTR_FLAGS);
330 if (use_hpet_alarm())
333 rtc_intr &= (rtc_control & RTC_IRQMASK) | RTC_IRQF;
334 if (is_intr(rtc_intr))
335 rtc_update_irq(cmos->rtc, 1, rtc_intr);
338 static void cmos_irq_enable(struct cmos_rtc *cmos, unsigned char mask)
340 unsigned char rtc_control;
342 /* flush any pending IRQ status, notably for update irqs,
343 * before we enable new IRQs
345 rtc_control = CMOS_READ(RTC_CONTROL);
346 cmos_checkintr(cmos, rtc_control);
349 CMOS_WRITE(rtc_control, RTC_CONTROL);
350 if (use_hpet_alarm())
351 hpet_set_rtc_irq_bit(mask);
353 if ((mask & RTC_AIE) && cmos_use_acpi_alarm()) {
355 cmos->wake_on(cmos->dev);
358 cmos_checkintr(cmos, rtc_control);
361 static void cmos_irq_disable(struct cmos_rtc *cmos, unsigned char mask)
363 unsigned char rtc_control;
365 rtc_control = CMOS_READ(RTC_CONTROL);
366 rtc_control &= ~mask;
367 CMOS_WRITE(rtc_control, RTC_CONTROL);
368 if (use_hpet_alarm())
369 hpet_mask_rtc_irq_bit(mask);
371 if ((mask & RTC_AIE) && cmos_use_acpi_alarm()) {
373 cmos->wake_off(cmos->dev);
376 cmos_checkintr(cmos, rtc_control);
379 static int cmos_validate_alarm(struct device *dev, struct rtc_wkalrm *t)
381 struct cmos_rtc *cmos = dev_get_drvdata(dev);
384 cmos_read_time(dev, &now);
386 if (!cmos->day_alrm) {
390 t_max_date = rtc_tm_to_time64(&now);
391 t_max_date += 24 * 60 * 60 - 1;
392 t_alrm = rtc_tm_to_time64(&t->time);
393 if (t_alrm > t_max_date) {
395 "Alarms can be up to one day in the future\n");
398 } else if (!cmos->mon_alrm) {
399 struct rtc_time max_date = now;
404 if (max_date.tm_mon == 11) {
406 max_date.tm_year += 1;
408 max_date.tm_mon += 1;
410 max_mday = rtc_month_days(max_date.tm_mon, max_date.tm_year);
411 if (max_date.tm_mday > max_mday)
412 max_date.tm_mday = max_mday;
414 t_max_date = rtc_tm_to_time64(&max_date);
416 t_alrm = rtc_tm_to_time64(&t->time);
417 if (t_alrm > t_max_date) {
419 "Alarms can be up to one month in the future\n");
423 struct rtc_time max_date = now;
428 max_date.tm_year += 1;
429 max_mday = rtc_month_days(max_date.tm_mon, max_date.tm_year);
430 if (max_date.tm_mday > max_mday)
431 max_date.tm_mday = max_mday;
433 t_max_date = rtc_tm_to_time64(&max_date);
435 t_alrm = rtc_tm_to_time64(&t->time);
436 if (t_alrm > t_max_date) {
438 "Alarms can be up to one year in the future\n");
446 static int cmos_set_alarm(struct device *dev, struct rtc_wkalrm *t)
448 struct cmos_rtc *cmos = dev_get_drvdata(dev);
449 unsigned char mon, mday, hrs, min, sec, rtc_control;
452 /* This not only a rtc_op, but also called directly */
453 if (!is_valid_irq(cmos->irq))
456 ret = cmos_validate_alarm(dev, t);
460 mon = t->time.tm_mon + 1;
461 mday = t->time.tm_mday;
462 hrs = t->time.tm_hour;
463 min = t->time.tm_min;
464 sec = t->time.tm_sec;
466 spin_lock_irq(&rtc_lock);
467 rtc_control = CMOS_READ(RTC_CONTROL);
468 spin_unlock_irq(&rtc_lock);
470 if (!(rtc_control & RTC_DM_BINARY) || RTC_ALWAYS_BCD) {
471 /* Writing 0xff means "don't care" or "match all". */
472 mon = (mon <= 12) ? bin2bcd(mon) : 0xff;
473 mday = (mday >= 1 && mday <= 31) ? bin2bcd(mday) : 0xff;
474 hrs = (hrs < 24) ? bin2bcd(hrs) : 0xff;
475 min = (min < 60) ? bin2bcd(min) : 0xff;
476 sec = (sec < 60) ? bin2bcd(sec) : 0xff;
479 spin_lock_irq(&rtc_lock);
481 /* next rtc irq must not be from previous alarm setting */
482 cmos_irq_disable(cmos, RTC_AIE);
485 CMOS_WRITE(hrs, RTC_HOURS_ALARM);
486 CMOS_WRITE(min, RTC_MINUTES_ALARM);
487 CMOS_WRITE(sec, RTC_SECONDS_ALARM);
489 /* the system may support an "enhanced" alarm */
490 if (cmos->day_alrm) {
491 CMOS_WRITE(mday, cmos->day_alrm);
493 CMOS_WRITE(mon, cmos->mon_alrm);
496 if (use_hpet_alarm()) {
498 * FIXME the HPET alarm glue currently ignores day_alrm
501 hpet_set_alarm_time(t->time.tm_hour, t->time.tm_min,
506 cmos_irq_enable(cmos, RTC_AIE);
508 spin_unlock_irq(&rtc_lock);
510 cmos->alarm_expires = rtc_tm_to_time64(&t->time);
515 static int cmos_alarm_irq_enable(struct device *dev, unsigned int enabled)
517 struct cmos_rtc *cmos = dev_get_drvdata(dev);
520 spin_lock_irqsave(&rtc_lock, flags);
523 cmos_irq_enable(cmos, RTC_AIE);
525 cmos_irq_disable(cmos, RTC_AIE);
527 spin_unlock_irqrestore(&rtc_lock, flags);
531 #if IS_ENABLED(CONFIG_RTC_INTF_PROC)
533 static int cmos_procfs(struct device *dev, struct seq_file *seq)
535 struct cmos_rtc *cmos = dev_get_drvdata(dev);
536 unsigned char rtc_control, valid;
538 spin_lock_irq(&rtc_lock);
539 rtc_control = CMOS_READ(RTC_CONTROL);
540 valid = CMOS_READ(RTC_VALID);
541 spin_unlock_irq(&rtc_lock);
543 /* NOTE: at least ICH6 reports battery status using a different
544 * (non-RTC) bit; and SQWE is ignored on many current systems.
547 "periodic_IRQ\t: %s\n"
549 "HPET_emulated\t: %s\n"
550 // "square_wave\t: %s\n"
553 "periodic_freq\t: %d\n"
554 "batt_status\t: %s\n",
555 (rtc_control & RTC_PIE) ? "yes" : "no",
556 (rtc_control & RTC_UIE) ? "yes" : "no",
557 use_hpet_alarm() ? "yes" : "no",
558 // (rtc_control & RTC_SQWE) ? "yes" : "no",
559 (rtc_control & RTC_DM_BINARY) ? "no" : "yes",
560 (rtc_control & RTC_DST_EN) ? "yes" : "no",
562 (valid & RTC_VRT) ? "okay" : "dead");
568 #define cmos_procfs NULL
571 static const struct rtc_class_ops cmos_rtc_ops = {
572 .read_time = cmos_read_time,
573 .set_time = cmos_set_time,
574 .read_alarm = cmos_read_alarm,
575 .set_alarm = cmos_set_alarm,
577 .alarm_irq_enable = cmos_alarm_irq_enable,
580 static const struct rtc_class_ops cmos_rtc_ops_no_alarm = {
581 .read_time = cmos_read_time,
582 .set_time = cmos_set_time,
586 /*----------------------------------------------------------------*/
589 * All these chips have at least 64 bytes of address space, shared by
590 * RTC registers and NVRAM. Most of those bytes of NVRAM are used
591 * by boot firmware. Modern chips have 128 or 256 bytes.
594 #define NVRAM_OFFSET (RTC_REG_D + 1)
596 static int cmos_nvram_read(void *priv, unsigned int off, void *val,
599 unsigned char *buf = val;
603 spin_lock_irq(&rtc_lock);
604 for (retval = 0; count; count--, off++, retval++) {
606 *buf++ = CMOS_READ(off);
608 *buf++ = cmos_read_bank2(off);
612 spin_unlock_irq(&rtc_lock);
617 static int cmos_nvram_write(void *priv, unsigned int off, void *val,
620 struct cmos_rtc *cmos = priv;
621 unsigned char *buf = val;
624 /* NOTE: on at least PCs and Ataris, the boot firmware uses a
625 * checksum on part of the NVRAM data. That's currently ignored
626 * here. If userspace is smart enough to know what fields of
627 * NVRAM to update, updating checksums is also part of its job.
630 spin_lock_irq(&rtc_lock);
631 for (retval = 0; count; count--, off++, retval++) {
632 /* don't trash RTC registers */
633 if (off == cmos->day_alrm
634 || off == cmos->mon_alrm
635 || off == cmos->century)
638 CMOS_WRITE(*buf++, off);
640 cmos_write_bank2(*buf++, off);
644 spin_unlock_irq(&rtc_lock);
649 /*----------------------------------------------------------------*/
651 static struct cmos_rtc cmos_rtc;
653 static irqreturn_t cmos_interrupt(int irq, void *p)
659 spin_lock_irqsave(&rtc_lock, flags);
661 /* When the HPET interrupt handler calls us, the interrupt
662 * status is passed as arg1 instead of the irq number. But
663 * always clear irq status, even when HPET is in the way.
665 * Note that HPET and RTC are almost certainly out of phase,
666 * giving different IRQ status ...
668 irqstat = CMOS_READ(RTC_INTR_FLAGS);
669 rtc_control = CMOS_READ(RTC_CONTROL);
670 if (use_hpet_alarm())
671 irqstat = (unsigned long)irq & 0xF0;
673 /* If we were suspended, RTC_CONTROL may not be accurate since the
674 * bios may have cleared it.
676 if (!cmos_rtc.suspend_ctrl)
677 irqstat &= (rtc_control & RTC_IRQMASK) | RTC_IRQF;
679 irqstat &= (cmos_rtc.suspend_ctrl & RTC_IRQMASK) | RTC_IRQF;
681 /* All Linux RTC alarms should be treated as if they were oneshot.
682 * Similar code may be needed in system wakeup paths, in case the
683 * alarm woke the system.
685 if (irqstat & RTC_AIE) {
686 cmos_rtc.suspend_ctrl &= ~RTC_AIE;
687 rtc_control &= ~RTC_AIE;
688 CMOS_WRITE(rtc_control, RTC_CONTROL);
689 if (use_hpet_alarm())
690 hpet_mask_rtc_irq_bit(RTC_AIE);
691 CMOS_READ(RTC_INTR_FLAGS);
693 spin_unlock_irqrestore(&rtc_lock, flags);
695 if (is_intr(irqstat)) {
696 rtc_update_irq(p, 1, irqstat);
706 #define INITSECTION __init
709 static int INITSECTION
710 cmos_do_probe(struct device *dev, struct resource *ports, int rtc_irq)
712 struct cmos_rtc_board_info *info = dev_get_platdata(dev);
714 unsigned char rtc_control;
715 unsigned address_space;
717 struct nvmem_config nvmem_cfg = {
718 .name = "cmos_nvram",
721 .reg_read = cmos_nvram_read,
722 .reg_write = cmos_nvram_write,
726 /* there can be only one ... */
733 /* Claim I/O ports ASAP, minimizing conflict with legacy driver.
735 * REVISIT non-x86 systems may instead use memory space resources
736 * (needing ioremap etc), not i/o space resources like this ...
739 ports = request_region(ports->start, resource_size(ports),
742 ports = request_mem_region(ports->start, resource_size(ports),
745 dev_dbg(dev, "i/o registers already in use\n");
749 cmos_rtc.irq = rtc_irq;
750 cmos_rtc.iomem = ports;
752 /* Heuristic to deduce NVRAM size ... do what the legacy NVRAM
753 * driver did, but don't reject unknown configs. Old hardware
754 * won't address 128 bytes. Newer chips have multiple banks,
755 * though they may not be listed in one I/O resource.
757 #if defined(CONFIG_ATARI)
759 #elif defined(__i386__) || defined(__x86_64__) || defined(__arm__) \
760 || defined(__sparc__) || defined(__mips__) \
761 || defined(__powerpc__)
764 #warning Assuming 128 bytes of RTC+NVRAM address space, not 64 bytes.
767 if (can_bank2 && ports->end > (ports->start + 1))
770 /* For ACPI systems extension info comes from the FADT. On others,
771 * board specific setup provides it as appropriate. Systems where
772 * the alarm IRQ isn't automatically a wakeup IRQ (like ACPI, and
773 * some almost-clones) can provide hooks to make that behave.
775 * Note that ACPI doesn't preclude putting these registers into
776 * "extended" areas of the chip, including some that we won't yet
777 * expect CMOS_READ and friends to handle.
782 if (info->address_space)
783 address_space = info->address_space;
785 if (info->rtc_day_alarm && info->rtc_day_alarm < 128)
786 cmos_rtc.day_alrm = info->rtc_day_alarm;
787 if (info->rtc_mon_alarm && info->rtc_mon_alarm < 128)
788 cmos_rtc.mon_alrm = info->rtc_mon_alarm;
789 if (info->rtc_century && info->rtc_century < 128)
790 cmos_rtc.century = info->rtc_century;
792 if (info->wake_on && info->wake_off) {
793 cmos_rtc.wake_on = info->wake_on;
794 cmos_rtc.wake_off = info->wake_off;
799 dev_set_drvdata(dev, &cmos_rtc);
801 cmos_rtc.rtc = devm_rtc_allocate_device(dev);
802 if (IS_ERR(cmos_rtc.rtc)) {
803 retval = PTR_ERR(cmos_rtc.rtc);
807 rename_region(ports, dev_name(&cmos_rtc.rtc->dev));
809 spin_lock_irq(&rtc_lock);
811 if (!(flags & CMOS_RTC_FLAGS_NOFREQ)) {
812 /* force periodic irq to CMOS reset default of 1024Hz;
814 * REVISIT it's been reported that at least one x86_64 ALI
815 * mobo doesn't use 32KHz here ... for portability we might
816 * need to do something about other clock frequencies.
818 cmos_rtc.rtc->irq_freq = 1024;
819 if (use_hpet_alarm())
820 hpet_set_periodic_freq(cmos_rtc.rtc->irq_freq);
821 CMOS_WRITE(RTC_REF_CLCK_32KHZ | 0x06, RTC_FREQ_SELECT);
825 if (is_valid_irq(rtc_irq))
826 cmos_irq_disable(&cmos_rtc, RTC_PIE | RTC_AIE | RTC_UIE);
828 rtc_control = CMOS_READ(RTC_CONTROL);
830 spin_unlock_irq(&rtc_lock);
832 if (is_valid_irq(rtc_irq) && !(rtc_control & RTC_24H)) {
833 dev_warn(dev, "only 24-hr supported\n");
838 if (use_hpet_alarm())
839 hpet_rtc_timer_init();
841 if (is_valid_irq(rtc_irq)) {
842 irq_handler_t rtc_cmos_int_handler;
844 if (use_hpet_alarm()) {
845 rtc_cmos_int_handler = hpet_rtc_interrupt;
846 retval = hpet_register_irq_handler(cmos_interrupt);
848 hpet_mask_rtc_irq_bit(RTC_IRQMASK);
849 dev_warn(dev, "hpet_register_irq_handler "
850 " failed in rtc_init().");
854 rtc_cmos_int_handler = cmos_interrupt;
856 retval = request_irq(rtc_irq, rtc_cmos_int_handler,
857 0, dev_name(&cmos_rtc.rtc->dev),
860 dev_dbg(dev, "IRQ %d is already in use\n", rtc_irq);
864 cmos_rtc.rtc->ops = &cmos_rtc_ops;
866 cmos_rtc.rtc->ops = &cmos_rtc_ops_no_alarm;
869 cmos_rtc.rtc->nvram_old_abi = true;
870 retval = rtc_register_device(cmos_rtc.rtc);
874 /* export at least the first block of NVRAM */
875 nvmem_cfg.size = address_space - NVRAM_OFFSET;
876 if (rtc_nvmem_register(cmos_rtc.rtc, &nvmem_cfg))
877 dev_err(dev, "nvmem registration failed\n");
879 dev_info(dev, "%s%s, %d bytes nvram%s\n",
880 !is_valid_irq(rtc_irq) ? "no alarms" :
881 cmos_rtc.mon_alrm ? "alarms up to one year" :
882 cmos_rtc.day_alrm ? "alarms up to one month" :
883 "alarms up to one day",
884 cmos_rtc.century ? ", y3k" : "",
886 use_hpet_alarm() ? ", hpet irqs" : "");
891 if (is_valid_irq(rtc_irq))
892 free_irq(rtc_irq, cmos_rtc.rtc);
897 release_region(ports->start, resource_size(ports));
899 release_mem_region(ports->start, resource_size(ports));
903 static void cmos_do_shutdown(int rtc_irq)
905 spin_lock_irq(&rtc_lock);
906 if (is_valid_irq(rtc_irq))
907 cmos_irq_disable(&cmos_rtc, RTC_IRQMASK);
908 spin_unlock_irq(&rtc_lock);
911 static void cmos_do_remove(struct device *dev)
913 struct cmos_rtc *cmos = dev_get_drvdata(dev);
914 struct resource *ports;
916 cmos_do_shutdown(cmos->irq);
918 if (is_valid_irq(cmos->irq)) {
919 free_irq(cmos->irq, cmos->rtc);
920 if (use_hpet_alarm())
921 hpet_unregister_irq_handler(cmos_interrupt);
928 release_region(ports->start, resource_size(ports));
930 release_mem_region(ports->start, resource_size(ports));
936 static int cmos_aie_poweroff(struct device *dev)
938 struct cmos_rtc *cmos = dev_get_drvdata(dev);
942 unsigned char rtc_control;
944 if (!cmos->alarm_expires)
947 spin_lock_irq(&rtc_lock);
948 rtc_control = CMOS_READ(RTC_CONTROL);
949 spin_unlock_irq(&rtc_lock);
951 /* We only care about the situation where AIE is disabled. */
952 if (rtc_control & RTC_AIE)
955 cmos_read_time(dev, &now);
956 t_now = rtc_tm_to_time64(&now);
959 * When enabling "RTC wake-up" in BIOS setup, the machine reboots
960 * automatically right after shutdown on some buggy boxes.
961 * This automatic rebooting issue won't happen when the alarm
962 * time is larger than now+1 seconds.
964 * If the alarm time is equal to now+1 seconds, the issue can be
965 * prevented by cancelling the alarm.
967 if (cmos->alarm_expires == t_now + 1) {
968 struct rtc_wkalrm alarm;
970 /* Cancel the AIE timer by configuring the past time. */
971 rtc_time64_to_tm(t_now - 1, &alarm.time);
973 retval = cmos_set_alarm(dev, &alarm);
974 } else if (cmos->alarm_expires > t_now + 1) {
981 static int cmos_suspend(struct device *dev)
983 struct cmos_rtc *cmos = dev_get_drvdata(dev);
986 /* only the alarm might be a wakeup event source */
987 spin_lock_irq(&rtc_lock);
988 cmos->suspend_ctrl = tmp = CMOS_READ(RTC_CONTROL);
989 if (tmp & (RTC_PIE|RTC_AIE|RTC_UIE)) {
992 if (device_may_wakeup(dev))
993 mask = RTC_IRQMASK & ~RTC_AIE;
997 CMOS_WRITE(tmp, RTC_CONTROL);
998 if (use_hpet_alarm())
999 hpet_mask_rtc_irq_bit(mask);
1000 cmos_checkintr(cmos, tmp);
1002 spin_unlock_irq(&rtc_lock);
1004 if ((tmp & RTC_AIE) && !cmos_use_acpi_alarm()) {
1005 cmos->enabled_wake = 1;
1009 enable_irq_wake(cmos->irq);
1012 memset(&cmos->saved_wkalrm, 0, sizeof(struct rtc_wkalrm));
1013 cmos_read_alarm(dev, &cmos->saved_wkalrm);
1015 dev_dbg(dev, "suspend%s, ctrl %02x\n",
1016 (tmp & RTC_AIE) ? ", alarm may wake" : "",
1022 /* We want RTC alarms to wake us from e.g. ACPI G2/S5 "soft off", even
1023 * after a detour through G3 "mechanical off", although the ACPI spec
1024 * says wakeup should only work from G1/S4 "hibernate". To most users,
1025 * distinctions between S4 and S5 are pointless. So when the hardware
1026 * allows, don't draw that distinction.
1028 static inline int cmos_poweroff(struct device *dev)
1030 if (!IS_ENABLED(CONFIG_PM))
1033 return cmos_suspend(dev);
1036 static void cmos_check_wkalrm(struct device *dev)
1038 struct cmos_rtc *cmos = dev_get_drvdata(dev);
1039 struct rtc_wkalrm current_alarm;
1041 time64_t t_current_expires;
1042 time64_t t_saved_expires;
1043 struct rtc_time now;
1045 /* Check if we have RTC Alarm armed */
1046 if (!(cmos->suspend_ctrl & RTC_AIE))
1049 cmos_read_time(dev, &now);
1050 t_now = rtc_tm_to_time64(&now);
1053 * ACPI RTC wake event is cleared after resume from STR,
1054 * ACK the rtc irq here
1056 if (t_now >= cmos->alarm_expires && cmos_use_acpi_alarm()) {
1057 cmos_interrupt(0, (void *)cmos->rtc);
1061 memset(¤t_alarm, 0, sizeof(struct rtc_wkalrm));
1062 cmos_read_alarm(dev, ¤t_alarm);
1063 t_current_expires = rtc_tm_to_time64(¤t_alarm.time);
1064 t_saved_expires = rtc_tm_to_time64(&cmos->saved_wkalrm.time);
1065 if (t_current_expires != t_saved_expires ||
1066 cmos->saved_wkalrm.enabled != current_alarm.enabled) {
1067 cmos_set_alarm(dev, &cmos->saved_wkalrm);
1071 static void cmos_check_acpi_rtc_status(struct device *dev,
1072 unsigned char *rtc_control);
1074 static int __maybe_unused cmos_resume(struct device *dev)
1076 struct cmos_rtc *cmos = dev_get_drvdata(dev);
1079 if (cmos->enabled_wake && !cmos_use_acpi_alarm()) {
1081 cmos->wake_off(dev);
1083 disable_irq_wake(cmos->irq);
1084 cmos->enabled_wake = 0;
1087 /* The BIOS might have changed the alarm, restore it */
1088 cmos_check_wkalrm(dev);
1090 spin_lock_irq(&rtc_lock);
1091 tmp = cmos->suspend_ctrl;
1092 cmos->suspend_ctrl = 0;
1093 /* re-enable any irqs previously active */
1094 if (tmp & RTC_IRQMASK) {
1097 if (device_may_wakeup(dev) && use_hpet_alarm())
1098 hpet_rtc_timer_init();
1101 CMOS_WRITE(tmp, RTC_CONTROL);
1102 if (use_hpet_alarm())
1103 hpet_set_rtc_irq_bit(tmp & RTC_IRQMASK);
1105 mask = CMOS_READ(RTC_INTR_FLAGS);
1106 mask &= (tmp & RTC_IRQMASK) | RTC_IRQF;
1107 if (!use_hpet_alarm() || !is_intr(mask))
1110 /* force one-shot behavior if HPET blocked
1111 * the wake alarm's irq
1113 rtc_update_irq(cmos->rtc, 1, mask);
1115 hpet_mask_rtc_irq_bit(RTC_AIE);
1116 } while (mask & RTC_AIE);
1119 cmos_check_acpi_rtc_status(dev, &tmp);
1121 spin_unlock_irq(&rtc_lock);
1123 dev_dbg(dev, "resume, ctrl %02x\n", tmp);
1128 static SIMPLE_DEV_PM_OPS(cmos_pm_ops, cmos_suspend, cmos_resume);
1130 /*----------------------------------------------------------------*/
1132 /* On non-x86 systems, a "CMOS" RTC lives most naturally on platform_bus.
1133 * ACPI systems always list these as PNPACPI devices, and pre-ACPI PCs
1134 * probably list them in similar PNPBIOS tables; so PNP is more common.
1136 * We don't use legacy "poke at the hardware" probing. Ancient PCs that
1137 * predate even PNPBIOS should set up platform_bus devices.
1142 #include <linux/acpi.h>
1144 static u32 rtc_handler(void *context)
1146 struct device *dev = context;
1147 struct cmos_rtc *cmos = dev_get_drvdata(dev);
1148 unsigned char rtc_control = 0;
1149 unsigned char rtc_intr;
1150 unsigned long flags;
1154 * Always update rtc irq when ACPI is used as RTC Alarm.
1155 * Or else, ACPI SCI is enabled during suspend/resume only,
1156 * update rtc irq in that case.
1158 if (cmos_use_acpi_alarm())
1159 cmos_interrupt(0, (void *)cmos->rtc);
1161 /* Fix me: can we use cmos_interrupt() here as well? */
1162 spin_lock_irqsave(&rtc_lock, flags);
1163 if (cmos_rtc.suspend_ctrl)
1164 rtc_control = CMOS_READ(RTC_CONTROL);
1165 if (rtc_control & RTC_AIE) {
1166 cmos_rtc.suspend_ctrl &= ~RTC_AIE;
1167 CMOS_WRITE(rtc_control, RTC_CONTROL);
1168 rtc_intr = CMOS_READ(RTC_INTR_FLAGS);
1169 rtc_update_irq(cmos->rtc, 1, rtc_intr);
1171 spin_unlock_irqrestore(&rtc_lock, flags);
1174 pm_wakeup_hard_event(dev);
1175 acpi_clear_event(ACPI_EVENT_RTC);
1176 acpi_disable_event(ACPI_EVENT_RTC, 0);
1177 return ACPI_INTERRUPT_HANDLED;
1180 static inline void rtc_wake_setup(struct device *dev)
1182 acpi_install_fixed_event_handler(ACPI_EVENT_RTC, rtc_handler, dev);
1184 * After the RTC handler is installed, the Fixed_RTC event should
1185 * be disabled. Only when the RTC alarm is set will it be enabled.
1187 acpi_clear_event(ACPI_EVENT_RTC);
1188 acpi_disable_event(ACPI_EVENT_RTC, 0);
1191 static void rtc_wake_on(struct device *dev)
1193 acpi_clear_event(ACPI_EVENT_RTC);
1194 acpi_enable_event(ACPI_EVENT_RTC, 0);
1197 static void rtc_wake_off(struct device *dev)
1199 acpi_disable_event(ACPI_EVENT_RTC, 0);
1203 /* Enable use_acpi_alarm mode for Intel platforms no earlier than 2015 */
1204 static void use_acpi_alarm_quirks(void)
1206 if (boot_cpu_data.x86_vendor != X86_VENDOR_INTEL)
1209 if (!(acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0))
1212 if (!is_hpet_enabled())
1215 if (dmi_get_bios_year() < 2015)
1218 use_acpi_alarm = true;
1221 static inline void use_acpi_alarm_quirks(void) { }
1224 /* Every ACPI platform has a mc146818 compatible "cmos rtc". Here we find
1225 * its device node and pass extra config data. This helps its driver use
1226 * capabilities that the now-obsolete mc146818 didn't have, and informs it
1227 * that this board's RTC is wakeup-capable (per ACPI spec).
1229 static struct cmos_rtc_board_info acpi_rtc_info;
1231 static void cmos_wake_setup(struct device *dev)
1236 use_acpi_alarm_quirks();
1238 rtc_wake_setup(dev);
1239 acpi_rtc_info.wake_on = rtc_wake_on;
1240 acpi_rtc_info.wake_off = rtc_wake_off;
1242 /* workaround bug in some ACPI tables */
1243 if (acpi_gbl_FADT.month_alarm && !acpi_gbl_FADT.day_alarm) {
1244 dev_dbg(dev, "bogus FADT month_alarm (%d)\n",
1245 acpi_gbl_FADT.month_alarm);
1246 acpi_gbl_FADT.month_alarm = 0;
1249 acpi_rtc_info.rtc_day_alarm = acpi_gbl_FADT.day_alarm;
1250 acpi_rtc_info.rtc_mon_alarm = acpi_gbl_FADT.month_alarm;
1251 acpi_rtc_info.rtc_century = acpi_gbl_FADT.century;
1253 /* NOTE: S4_RTC_WAKE is NOT currently useful to Linux */
1254 if (acpi_gbl_FADT.flags & ACPI_FADT_S4_RTC_WAKE)
1255 dev_info(dev, "RTC can wake from S4\n");
1257 dev->platform_data = &acpi_rtc_info;
1259 /* RTC always wakes from S1/S2/S3, and often S4/STD */
1260 device_init_wakeup(dev, 1);
1263 static void cmos_check_acpi_rtc_status(struct device *dev,
1264 unsigned char *rtc_control)
1266 struct cmos_rtc *cmos = dev_get_drvdata(dev);
1267 acpi_event_status rtc_status;
1270 if (acpi_gbl_FADT.flags & ACPI_FADT_FIXED_RTC)
1273 status = acpi_get_event_status(ACPI_EVENT_RTC, &rtc_status);
1274 if (ACPI_FAILURE(status)) {
1275 dev_err(dev, "Could not get RTC status\n");
1276 } else if (rtc_status & ACPI_EVENT_FLAG_SET) {
1278 *rtc_control &= ~RTC_AIE;
1279 CMOS_WRITE(*rtc_control, RTC_CONTROL);
1280 mask = CMOS_READ(RTC_INTR_FLAGS);
1281 rtc_update_irq(cmos->rtc, 1, mask);
1287 static void cmos_wake_setup(struct device *dev)
1291 static void cmos_check_acpi_rtc_status(struct device *dev,
1292 unsigned char *rtc_control)
1300 #include <linux/pnp.h>
1302 static int cmos_pnp_probe(struct pnp_dev *pnp, const struct pnp_device_id *id)
1304 cmos_wake_setup(&pnp->dev);
1306 if (pnp_port_start(pnp, 0) == 0x70 && !pnp_irq_valid(pnp, 0)) {
1307 unsigned int irq = 0;
1309 /* Some machines contain a PNP entry for the RTC, but
1310 * don't define the IRQ. It should always be safe to
1311 * hardcode it on systems with a legacy PIC.
1313 if (nr_legacy_irqs())
1316 return cmos_do_probe(&pnp->dev,
1317 pnp_get_resource(pnp, IORESOURCE_IO, 0), irq);
1319 return cmos_do_probe(&pnp->dev,
1320 pnp_get_resource(pnp, IORESOURCE_IO, 0),
1325 static void cmos_pnp_remove(struct pnp_dev *pnp)
1327 cmos_do_remove(&pnp->dev);
1330 static void cmos_pnp_shutdown(struct pnp_dev *pnp)
1332 struct device *dev = &pnp->dev;
1333 struct cmos_rtc *cmos = dev_get_drvdata(dev);
1335 if (system_state == SYSTEM_POWER_OFF) {
1336 int retval = cmos_poweroff(dev);
1338 if (cmos_aie_poweroff(dev) < 0 && !retval)
1342 cmos_do_shutdown(cmos->irq);
1345 static const struct pnp_device_id rtc_ids[] = {
1346 { .id = "PNP0b00", },
1347 { .id = "PNP0b01", },
1348 { .id = "PNP0b02", },
1351 MODULE_DEVICE_TABLE(pnp, rtc_ids);
1353 static struct pnp_driver cmos_pnp_driver = {
1354 .name = driver_name,
1355 .id_table = rtc_ids,
1356 .probe = cmos_pnp_probe,
1357 .remove = cmos_pnp_remove,
1358 .shutdown = cmos_pnp_shutdown,
1360 /* flag ensures resume() gets called, and stops syslog spam */
1361 .flags = PNP_DRIVER_RES_DO_NOT_CHANGE,
1367 #endif /* CONFIG_PNP */
1370 static const struct of_device_id of_cmos_match[] = {
1372 .compatible = "motorola,mc146818",
1376 MODULE_DEVICE_TABLE(of, of_cmos_match);
1378 static __init void cmos_of_init(struct platform_device *pdev)
1380 struct device_node *node = pdev->dev.of_node;
1386 val = of_get_property(node, "ctrl-reg", NULL);
1388 CMOS_WRITE(be32_to_cpup(val), RTC_CONTROL);
1390 val = of_get_property(node, "freq-reg", NULL);
1392 CMOS_WRITE(be32_to_cpup(val), RTC_FREQ_SELECT);
1395 static inline void cmos_of_init(struct platform_device *pdev) {}
1397 /*----------------------------------------------------------------*/
1399 /* Platform setup should have set up an RTC device, when PNP is
1400 * unavailable ... this could happen even on (older) PCs.
1403 static int __init cmos_platform_probe(struct platform_device *pdev)
1405 struct resource *resource;
1409 cmos_wake_setup(&pdev->dev);
1412 resource = platform_get_resource(pdev, IORESOURCE_IO, 0);
1414 resource = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1415 irq = platform_get_irq(pdev, 0);
1419 return cmos_do_probe(&pdev->dev, resource, irq);
1422 static int cmos_platform_remove(struct platform_device *pdev)
1424 cmos_do_remove(&pdev->dev);
1428 static void cmos_platform_shutdown(struct platform_device *pdev)
1430 struct device *dev = &pdev->dev;
1431 struct cmos_rtc *cmos = dev_get_drvdata(dev);
1433 if (system_state == SYSTEM_POWER_OFF) {
1434 int retval = cmos_poweroff(dev);
1436 if (cmos_aie_poweroff(dev) < 0 && !retval)
1440 cmos_do_shutdown(cmos->irq);
1443 /* work with hotplug and coldplug */
1444 MODULE_ALIAS("platform:rtc_cmos");
1446 static struct platform_driver cmos_platform_driver = {
1447 .remove = cmos_platform_remove,
1448 .shutdown = cmos_platform_shutdown,
1450 .name = driver_name,
1452 .of_match_table = of_match_ptr(of_cmos_match),
1457 static bool pnp_driver_registered;
1459 static bool platform_driver_registered;
1461 static int __init cmos_init(void)
1466 retval = pnp_register_driver(&cmos_pnp_driver);
1468 pnp_driver_registered = true;
1471 if (!cmos_rtc.dev) {
1472 retval = platform_driver_probe(&cmos_platform_driver,
1473 cmos_platform_probe);
1475 platform_driver_registered = true;
1482 if (pnp_driver_registered)
1483 pnp_unregister_driver(&cmos_pnp_driver);
1487 module_init(cmos_init);
1489 static void __exit cmos_exit(void)
1492 if (pnp_driver_registered)
1493 pnp_unregister_driver(&cmos_pnp_driver);
1495 if (platform_driver_registered)
1496 platform_driver_unregister(&cmos_platform_driver);
1498 module_exit(cmos_exit);
1501 MODULE_AUTHOR("David Brownell");
1502 MODULE_DESCRIPTION("Driver for PC-style 'CMOS' RTCs");
1503 MODULE_LICENSE("GPL");