rtc-cmos,rtc-mc146818-lib: fixes
Subsystems (9)
v4 cover rtc-cmos,rtc-mc146818-lib: fixes
Hello,
This patch series fixes some issues in the RTC CMOS handling code:
1. A missing spin_lock_irq() / spin_unlock_irq() pair in cmos_set_alarm().
2. A failing presence check of the RTC: the clock was misdetected as broken since Linux 5.11 on one of our home systems.
3. Do not touch the RTC alarm registers when the RTC update is in progress. (On some Intel chipsets, this causes bogus values being read or writes to fail silently.)
This is my first patch series, so please review carefully.
v2: Drop the last patch:
Revert "rtc: cmos: Replace spin_lock_irqsave with spin_lock in hard IRQ"
which was made obsolete by mainlining of
commit 13be2efc390a ("rtc: cmos: Disable irq around direct invocation of cmos_interrupt()")
v3: Rework solution to problem 3 (I'd like to thank Greg KH for comment), drop x86 refactoring patches (I'll send them later).
v4: Fixed some issues pointed out by Mr Alexandre Belloni:
- do not add strings to rtc-mc146818-lib.c - I moved the error printing code to callers of mc146818_get_time(). This resulted in two new patches in the series,
- other small issues.
I have noticed that mach_get_cmos_time() in arch/x86/kernel/rtc.c performs a similar function to mc146818_get_time() in drivers/rtc/rtc-cmos.c . In the future, I'm going to post a new series that removes this duplicated code and makes mach_get_cmos_time() use mc146818_get_time(). This will likely include reducing polling interval in mc146818_avoid_UIP() from 1ms to 100us to make it more similar to mach_get_cmos_time()'s current behaviour.
Greetings,
Mateusz
PATCH v4 1/9 rtc-cmos: take rtc_lock while reading from CMOS
Reading from the CMOS involves writing to the index register and then reading from the data register. Therefore access to the CMOS has to be serialized with rtc_lock. This invocation of CMOS_READ was not serialized, which could cause trouble when other code is accessing CMOS at the same time.
Use spin_lock_irq() like the rest of the function.
Nothing in kernel modifies the RTC_DM_BINARY bit, so there could be a separate pair of spin_lock_irq() / spin_unlock_irq() before doing the math.
---
drivers/rtc/rtc-cmos.c | 3 +++ 1 file changed, 3 insertions(+)
drivers/rtc/rtc-cmos.c +3 -0
@@ -457,7 +457,10 @@ static int cmos_set_alarm(struct device *dev, struct rtc_wkalrm *t) min = t->time.tm_min; sec = t->time.tm_sec; +spin_lock_irq (&rtc_lock); rtc_control =CMOS_READ (RTC_CONTROL ); +spin_unlock_irq (&rtc_lock); +if (!(rtc_control &RTC_DM_BINARY ) ||RTC_ALWAYS_BCD ) {/* Writing 0xff means "don't care" or "match all". */ mon = (mon <=12 ) ?bin2bcd (mon) :0xff ;
Signature · 1 line
2.25.1
PATCH v4 2/9 rtc: change return values of mc146818_get_time()
In reply to Mateusz JończykNo function is checking mc146818_get_time() return values yet, so correct them to make them more customary.
---
v4: Added this patch
drivers/rtc/rtc-mc146818-lib.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/rtc/rtc-mc146818-lib.c +2 -2
@@ -25,7 +25,7 @@ unsigned int mc146818_get_time(struct rtc_time *time)if (WARN_ON_ONCE ((CMOS_READ (RTC_VALID ) &0x40 ) !=0 )) {spin_unlock_irqrestore (&rtc_lock, flags);memset (time,0xff ,sizeof (*time)); -return 0 ; +return -EIO ; }/*
@@ -116,7 +116,7 @@ unsigned int mc146818_get_time(struct rtc_time *time) time->tm_mon--; -return RTC_24H ; +return 0 ; }EXPORT_SYMBOL_GPL (mc146818_get_time);
Signature · 1 line
2.25.1
PATCH v4 3/9 Check return value from mc146818_get_time()
In reply to Mateusz JończykThere are 4 users of mc146818_get_time() and none of them was checking the return value from this function. Change this.
Print the appropriate warnings in callers of mc146818_get_time() instead of in the function mc146818_get_time() itself, in order not to add strings to rtc-mc146818-lib.c, which is kind of a library.
The callers of alpha_rtc_read_time() and cmos_read_time() may use the contents of (struct rtc_time *) even when the functions return a failure code. Therefore, set the contents of (struct rtc_time *) to 0x00, which looks more sensible then 0xff and aligns with the (possibly stale?) comment in cmos_read_time:
/* * If pm_trace abused the RTC for storage, set the timespec to 0, * which tells the caller that this RTC value is unusable. */
For consistency, do this in mc146818_get_time().
Note: hpet_rtc_interrupt() may call mc146818_get_time() many times a second. It is very unlikely, though, that the RTC suddenly stops working and mc146818_get_time() would consistently fail.
Only compile-tested on alpha.
---
TODO: would it be appropriate to add attribute __must_check to
mc146818_get_time()?
v4: Added this patch
arch/alpha/kernel/rtc.c | 7 ++++++- arch/x86/kernel/hpet.c | 8 ++++++-- drivers/base/power/trace.c | 6 +++++- drivers/rtc/rtc-cmos.c | 9 ++++++++- drivers/rtc/rtc-mc146818-lib.c | 2 +- 5 files changed, 26 insertions(+), 6 deletions(-)
arch/alpha/kernel/rtc.c +6 -1
@@ -80,7 +80,12 @@ init_rtc_epoch(void)static int alpha_rtc_read_time (struct device *dev,struct rtc_time *tm) { -mc146818_get_time (tm); +int ret =mc146818_get_time (tm); + +if (ret <0 ) { +dev_err_ratelimited (dev,"unable to read current time\n" ); +return ret; + }/* Adjust for non-default epochs. It's easier to depend on the generic __get_rtc_time and adjust the epoch here than create
arch/x86/kernel/hpet.c +6 -2
@@ -1435,8 +1435,12 @@ irqreturn_t hpet_rtc_interrupt(int irq, void *dev_id)hpet_rtc_timer_reinit ();memset (&curr_time,0 ,sizeof (struct rtc_time )); -if (hpet_rtc_flags & (RTC_UIE |RTC_AIE )) -mc146818_get_time (&curr_time); +if (hpet_rtc_flags & (RTC_UIE |RTC_AIE )) { +if (unlikely (mc146818_get_time (&curr_time) <0 )) { +pr_err_ratelimited ("unable to read current time from RTC\n" ); +return IRQ_HANDLED ; + } + }if (hpet_rtc_flags &RTC_UIE && curr_time.tm_sec != hpet_prev_update_sec) {
drivers/base/power/trace.c +5 -1
@@ -120,7 +120,11 @@ static unsigned int read_magic_time(void)struct rtc_time time;unsigned int val; -mc146818_get_time (&time); +if (mc146818_get_time (&time) <0 ) { +pr_err ("Unable to read current time from RTC\n" ); +return 0 ; + } +pr_info ("RTC time: %ptRt, date: %ptRd\n" , &time, &time); val = time.tm_year;/* 100 years */ if (val >100 )
drivers/rtc/rtc-cmos.c +8 -1
@@ -222,6 +222,8 @@ static inline void cmos_write_bank2(unsigned char val, unsigned char addr)static int cmos_read_time (struct device *dev,struct rtc_time *t) { +int ret; +/* * If pm_trace abused the RTC for storage, set the timespec to 0, * which tells the caller that this RTC value is unusable.
@@ -229,7 +231,12 @@ static int cmos_read_time(struct device *dev, struct rtc_time *t)if (!pm_trace_rtc_valid ())return -EIO ; -mc146818_get_time (t); + ret =mc146818_get_time (t); +if (ret <0 ) { +dev_err_ratelimited (dev,"unable to read current time\n" ); +return ret; + } +return 0 ; }
drivers/rtc/rtc-mc146818-lib.c +1 -1
@@ -24,7 +24,7 @@ unsigned int mc146818_get_time(struct rtc_time *time)/* Ensure that the RTC is accessible. Bit 6 must be 0! */ if (WARN_ON_ONCE ((CMOS_READ (RTC_VALID ) &0x40 ) !=0 )) {spin_unlock_irqrestore (&rtc_lock, flags); -memset (time,0xff ,sizeof (*time)); +memset (time,0 ,sizeof (*time));return -EIO ; }
Signature · 1 line
2.25.1
PATCH v4 4/9 rtc-mc146818-lib: fix RTC presence check
In reply to Mateusz JończykTo prevent an infinite loop in mc146818_get_time(), commit 211e5db19d15 ("rtc: mc146818: Detect and handle broken RTCs") added a check for RTC availability. Together with a later fix, it checked if bit 6 in register 0x0d is cleared.
This, however, caused a false negative on a motherboard with an AMD SB710 southbridge; according to the specification [1], bit 6 of register 0x0d of this chipset is a scratchbit. This caused a regression in Linux 5.11 - the RTC was determined broken by the kernel and not used by rtc-cmos.c [3]. This problem was also reported in Fedora [4].
As a better alternative, check whether the UIP ("Update-in-progress") bit is set for longer then 10ms. If that is the case, then apparently the RTC is either absent (and all register reads return 0xff) or broken. Also limit the number of loop iterations in mc146818_get_time() to 10 to prevent an infinite loop there.
The functions mc146818_get_time() and mc146818_does_rtc_work() will be refactored later in this patch series, in order to fix a separate problem with reading / setting the RTC alarm time. This is done so to avoid a confusion about what is being fixed when.
In a previous approach to this problem, I implemented a check whether the RTC_HOURS register contains a value <= 24. This, however, sometimes did not work correctly on my Intel Kaby Lake laptop. According to Intel's documentation [2], "the time and date RAM locations (0-9) are disconnected from the external bus" during the update cycle so reading this register without checking the UIP bit is incorrect.
[1] AMD SB700/710/750 Register Reference Guide, page 308,
https://developer.amd.com/wordpress/media/2012/10/43009_sb7xx_rrg_pub_1.00.pdf
[2] 7th Generation Intel ® Processor Family I/O for U/Y Platforms [...] Datasheet Volume 1 of 2, page 209
Intel's Document Number: 334658-006,
https://www.intel.com/content/dam/www/public/us/en/documents/datasheets/7th-and-8th-gen-core-family-mobile-u-y-processor-lines-i-o-datasheet-vol-1.pdf
[3] Functions in arch/x86/kernel/rtc.c apparently were using it.
[4] https://bugzilla.redhat.com/show_bug.cgi?id=1936688
---
v2: - tweak commit description,
- remove "Cc: stable" (I'll send it manually after some regression testing).
v3: - add "EXPORT_SYMBOL_GPL(mc146818_does_rtc_work)",
- change return type from mc146818_does_rtc_work to bool.
v4: - drop pr_err_ratelimited() in mc146818_get_time(), callers of this
function are now required to notify the user,
- tweak commit description.
drivers/rtc/rtc-cmos.c | 10 ++++------ drivers/rtc/rtc-mc146818-lib.c | 34 ++++++++++++++++++++++++++++++---- include/linux/mc146818rtc.h | 1 + 3 files changed, 35 insertions(+), 10 deletions(-)
drivers/rtc/rtc-cmos.c +4 -6
@@ -800,16 +800,14 @@ cmos_do_probe(struct device *dev, struct resource *ports, int rtc_irq)rename_region (ports,dev_name (&cmos_rtc.rtc->dev)); -spin_lock_irq (&rtc_lock); - -/* Ensure that the RTC is accessible. Bit 6 must be 0! */ -if ((CMOS_READ (RTC_VALID ) &0x40 ) !=0 ) { -spin_unlock_irq (&rtc_lock); -dev_warn (dev,"not accessible\n" ); +if (!mc146818_does_rtc_work ()) { +dev_warn (dev,"broken or not accessible\n" ); retval = -ENXIO ; goto cleanup1; } +spin_lock_irq (&rtc_lock); +if (!(flags &CMOS_RTC_FLAGS_NOFREQ )) {/* force periodic irq to CMOS reset default of 1024Hz; *
drivers/rtc/rtc-mc146818-lib.c +30 -4
@@ -8,10 +8,36 @@#include <linux/acpi.h> #endif +/* +* If the UIP (Update-in-progress) bit of the RTC is set for more then +* 10ms, the RTC is apparently broken or not present. +*/ +bool mc146818_does_rtc_work (void ) +{ +int i; +unsigned char val; +unsigned long flags; + +for (i =0 ; i <10 ; i++) { +spin_lock_irqsave (&rtc_lock, flags); + val =CMOS_READ (RTC_FREQ_SELECT ); +spin_unlock_irqrestore (&rtc_lock, flags); + +if ((val &RTC_UIP ) ==0 ) +return true; + +mdelay (1 ); + } + +return false; +} +EXPORT_SYMBOL_GPL (mc146818_does_rtc_work); +unsigned int mc146818_get_time (struct rtc_time *time) {unsigned char ctrl;unsigned long flags; +unsigned int iter_count =0 ;unsigned char century =0 ;bool retry;
@@ -20,13 +46,13 @@ unsigned int mc146818_get_time(struct rtc_time *time)#endif again: -spin_lock_irqsave (&rtc_lock, flags); -/* Ensure that the RTC is accessible. Bit 6 must be 0! */ -if (WARN_ON_ONCE ((CMOS_READ (RTC_VALID ) &0x40 ) !=0 )) { -spin_unlock_irqrestore (&rtc_lock, flags); +if (iter_count >10 ) {memset (time,0 ,sizeof (*time));return -EIO ; } + iter_count++; + +spin_lock_irqsave (&rtc_lock, flags);/* * Check whether there is an update in progress during which the
include/linux/mc146818rtc.h +1 -0
@@ -123,6 +123,7 @@ struct cmos_rtc_board_info {#define RTC_IO_EXTENT_USED RTC_IO_EXTENT#endif /* ARCH_RTC_LOCATION */ +bool mc146818_does_rtc_work (void );unsigned int mc146818_get_time (struct rtc_time *time);int mc146818_set_time (struct rtc_time *time);
Signature · 1 line
2.25.1
PATCH v4 5/9 rtc-mc146818-lib: extract mc146818_avoid_UIP
In reply to Mateusz JończykFunction mc146818_get_time() contains an elaborate mechanism of reading the RTC time while no RTC update is in progress. It turns out that reading the RTC alarm clock also requires avoiding the RTC update. Therefore, the mechanism in mc146818_get_time() should be reused - so extract it into a separate function.
The logic in mc146818_avoid_UIP() is same as in mc146818_get_time() except that after every
if (CMOS_READ(RTC_FREQ_SELECT) & RTC_UIP) {there is now "mdelay(1)".
To avoid producing a very unreadable patch, mc146818_get_time() will be refactored to use mc146818_avoid_UIP() in the next patch.
---
v4: rename mc146818_do_avoiding_UIP() to mc146818_avoid_UIP(),
remove definition of mc146818_callback_t,
drivers/rtc/rtc-mc146818-lib.c | 70 ++++++++++++++++++++++++++++++++++ include/linux/mc146818rtc.h | 3 ++ 2 files changed, 73 insertions(+)
drivers/rtc/rtc-mc146818-lib.c +70 -0
@@ -8,6 +8,76 @@#include <linux/acpi.h> #endif +/* +* Execute a function while the UIP (Update-in-progress) bit of the RTC is +* unset. +* +* Warning: callback may be executed more then once. +*/ +bool mc146818_avoid_UIP (void (*callback)(unsigned char seconds,void *param), +void *param) +{ +int i; +unsigned long flags; +unsigned char seconds; + +for (i =0 ; i <10 ; i++) { +spin_lock_irqsave (&rtc_lock, flags); + +/* +* Check whether there is an update in progress during which the +* readout is unspecified. The maximum update time is ~2ms. Poll +* every msec for completion. +* +* Store the second value before checking UIP so a long lasting +* NMI which happens to hit after the UIP check cannot make +* an update cycle invisible. +*/ + seconds =CMOS_READ (RTC_SECONDS ); + +if (CMOS_READ (RTC_FREQ_SELECT ) &RTC_UIP ) { +spin_unlock_irqrestore (&rtc_lock, flags); +mdelay (1 ); +continue ; + } + +/* Revalidate the above readout */ +if (seconds !=CMOS_READ (RTC_SECONDS )) { +spin_unlock_irqrestore (&rtc_lock, flags); +continue ; + } + +if (callback) +callback (seconds, param); + +/* +* Check for the UIP bit again. If it is set now then +* the above values may contain garbage. +*/ +if (CMOS_READ (RTC_FREQ_SELECT ) &RTC_UIP ) { +spin_unlock_irqrestore (&rtc_lock, flags); +mdelay (1 ); +continue ; + } + +/* +* A NMI might have interrupted the above sequence so check +* whether the seconds value has changed which indicates that +* the NMI took longer than the UIP bit was set. Unlikely, but +* possible and there is also virt... +*/ +if (seconds !=CMOS_READ (RTC_SECONDS )) { +spin_unlock_irqrestore (&rtc_lock, flags); +continue ; + } +spin_unlock_irqrestore (&rtc_lock, flags); + +return true; + } +return false; +} +EXPORT_SYMBOL_GPL (mc146818_avoid_UIP); +/* * If the UIP (Update-in-progress) bit of the RTC is set for more then * 10ms, the RTC is apparently broken or not present.
include/linux/mc146818rtc.h +3 -0
@@ -127,4 +127,7 @@ bool mc146818_does_rtc_work(void);unsigned int mc146818_get_time (struct rtc_time *time);int mc146818_set_time (struct rtc_time *time); +bool mc146818_avoid_UIP (void (*callback)(unsigned char seconds,void *param), +void *param); +#endif /* _MC146818RTC_H */
Signature · 1 line
2.25.1
PATCH v4 6/9 rtc-mc146818-lib: refactor mc146818_get_time
In reply to Mateusz JończykRefactor mc146818_get_time() so that it uses mc146818_avoid_UIP().
---
I'm sorry that the diff is so unreadable, but I was unable to fix this easily.
drivers/rtc/rtc-mc146818-lib.c | 109 +++++++++++++-------------------- 1 file changed, 42 insertions(+), 67 deletions(-)
drivers/rtc/rtc-mc146818-lib.c +42 -67
@@ -103,49 +103,20 @@ bool mc146818_does_rtc_work(void) }EXPORT_SYMBOL_GPL (mc146818_does_rtc_work); -unsigned int mc146818_get_time (struct rtc_time *time) -{ +struct mc146818_get_time_callback_param { +struct rtc_time *time;unsigned char ctrl; -unsigned long flags; -unsigned int iter_count =0 ; -unsigned char century =0 ; -bool retry; - +#ifdef CONFIG_ACPI +unsigned char century; +#endif #ifdef CONFIG_MACH_DECSTATION unsigned int real_year;#endif +}; -again: -if (iter_count >10 ) { -memset (time,0 ,sizeof (*time)); -return -EIO ; - } - iter_count++; - -spin_lock_irqsave (&rtc_lock, flags); - -/* -* Check whether there is an update in progress during which the -* readout is unspecified. The maximum update time is ~2ms. Poll -* every msec for completion. -* -* Store the second value before checking UIP so a long lasting NMI -* which happens to hit after the UIP check cannot make an update -* cycle invisible. -*/ - time->tm_sec =CMOS_READ (RTC_SECONDS ); - -if (CMOS_READ (RTC_FREQ_SELECT ) &RTC_UIP ) { -spin_unlock_irqrestore (&rtc_lock, flags); -mdelay (1 ); - goto again; - } - -/* Revalidate the above readout */ -if (time->tm_sec !=CMOS_READ (RTC_SECONDS )) { -spin_unlock_irqrestore (&rtc_lock, flags); - goto again; - } +static void mc146818_get_time_callback (unsigned char seconds,void *param_in) +{ +struct mc146818_get_time_callback_param *p = param_in;/* * Only the values that we read from the RTC are set. We leave
@@ -153,39 +124,39 @@ unsigned int mc146818_get_time(struct rtc_time *time)* RTC has RTC_DAY_OF_WEEK, we ignore it, as it is only updated * by the RTC when initially set to a non-zero value. */ - time->tm_min =CMOS_READ (RTC_MINUTES ); - time->tm_hour =CMOS_READ (RTC_HOURS ); - time->tm_mday =CMOS_READ (RTC_DAY_OF_MONTH ); - time->tm_mon =CMOS_READ (RTC_MONTH ); - time->tm_year =CMOS_READ (RTC_YEAR ); + p->time->tm_sec = seconds; + p->time->tm_min =CMOS_READ (RTC_MINUTES ); + p->time->tm_hour =CMOS_READ (RTC_HOURS ); + p->time->tm_mday =CMOS_READ (RTC_DAY_OF_MONTH ); + p->time->tm_mon =CMOS_READ (RTC_MONTH ); + p->time->tm_year =CMOS_READ (RTC_YEAR );#ifdef CONFIG_MACH_DECSTATION - real_year =CMOS_READ (RTC_DEC_YEAR ); + p->real_year =CMOS_READ (RTC_DEC_YEAR );#endif #ifdef CONFIG_ACPI if (acpi_gbl_FADT.header.revision >=FADT2_REVISION_ID && - acpi_gbl_FADT.century) - century =CMOS_READ (acpi_gbl_FADT.century); + acpi_gbl_FADT.century) { + p->century =CMOS_READ (acpi_gbl_FADT.century); + }else { + p->century =0 ; + }#endif - ctrl =CMOS_READ (RTC_CONTROL ); -/* -* Check for the UIP bit again. If it is set now then -* the above values may contain garbage. -*/ - retry =CMOS_READ (RTC_FREQ_SELECT ) &RTC_UIP ; -/* -* A NMI might have interrupted the above sequence so check whether -* the seconds value has changed which indicates that the NMI took -* longer than the UIP bit was set. Unlikely, but possible and -* there is also virt... -*/ - retry |= time->tm_sec !=CMOS_READ (RTC_SECONDS ); -spin_unlock_irqrestore (&rtc_lock, flags); + p->ctrl =CMOS_READ (RTC_CONTROL ); +} -if (retry) - goto again; +unsigned int mc146818_get_time (struct rtc_time *time) +{ +struct mc146818_get_time_callback_param p = { + .time = time + }; + +if (!mc146818_avoid_UIP (mc146818_get_time_callback, &p)) { +memset (time,0 ,sizeof (*time)); +return -EIO ; + } -if (!(ctrl &RTC_DM_BINARY ) ||RTC_ALWAYS_BCD ) +if (!(p.ctrl &RTC_DM_BINARY ) ||RTC_ALWAYS_BCD ) { time->tm_sec =bcd2bin (time->tm_sec); time->tm_min =bcd2bin (time->tm_min);
@@ -193,15 +164,19 @@ unsigned int mc146818_get_time(struct rtc_time *time) time->tm_mday =bcd2bin (time->tm_mday); time->tm_mon =bcd2bin (time->tm_mon); time->tm_year =bcd2bin (time->tm_year); - century =bcd2bin (century); +#ifdef CONFIG_ACPI + p.century =bcd2bin (p.century); +#endif }#ifdef CONFIG_MACH_DECSTATION - time->tm_year += real_year -72 ; + time->tm_year += p.real_year -72 ;#endif -if (century >20 ) - time->tm_year += (century -19 ) *100 ; +#ifdef CONFIG_ACPI +if (p.century >20 ) + time->tm_year += (p.century -19 ) *100 ; +#endif /* * Account for differences between how the RTC uses the values
Signature · 1 line
2.25.1
PATCH v4 7/9 rtc-mc146818-lib: refactor mc146818_does_rtc_work
In reply to Mateusz JończykRefactor mc146818_does_rtc_work() so that it uses mc146818_avoid_UIP(). It is enough to call mc146818_avoid_UIP() with no callback.
---
v4: fixed a mistake in the patch description.
drivers/rtc/rtc-mc146818-lib.c | 17 +---------------- 1 file changed, 1 insertion(+), 16 deletions(-)
drivers/rtc/rtc-mc146818-lib.c +1 -16
@@ -84,22 +84,7 @@ EXPORT_SYMBOL_GPL(mc146818_avoid_UIP);*/ bool mc146818_does_rtc_work (void ) { -int i; -unsigned char val; -unsigned long flags; - -for (i =0 ; i <10 ; i++) { -spin_lock_irqsave (&rtc_lock, flags); - val =CMOS_READ (RTC_FREQ_SELECT ); -spin_unlock_irqrestore (&rtc_lock, flags); - -if ((val &RTC_UIP ) ==0 ) -return true; - -mdelay (1 ); - } - -return false; +return mc146818_avoid_UIP (NULL ,NULL ); }EXPORT_SYMBOL_GPL (mc146818_does_rtc_work);
Signature · 1 line
2.25.1
PATCH v4 8/9 rtc-cmos: avoid UIP when reading alarm time
In reply to Mateusz JończykSome Intel chipsets disconnect the time and date RTC registers when the clock update is in progress: during this time reads may return bogus values and writes fail silently. This includes the RTC alarm registers.
[1]
cmos_read_alarm() did not take account for that, which caused alarm time reads to sometimes return bogus values. This can be shown with a test patch that I am attaching to this patch series.
Fix this, by using mc146818_avoid_UIP().
[1] 7th Generation Intel ® Processor Family I/O for U/Y Platforms [...] Datasheet, Volume 1 of 2 (Intel's Document Number: 334658-006) Page 208
https://www.intel.com/content/dam/www/public/us/en/documents/datasheets/7th-and-8th-gen-core-family-mobile-u-y-processor-lines-i-o-datasheet-vol-1.pdf
"If a RAM read from the ten time and date bytes is attempted during an update cycle, the value read do not necessarily represent the true contents of those locations. Any RAM writes under the same conditions are ignored."
---
v4: fix some checkpatch --strict warnings
drivers/rtc/rtc-cmos.c | 72 ++++++++++++++++++++++++++++-------------- 1 file changed, 49 insertions(+), 23 deletions(-)
drivers/rtc/rtc-cmos.c +49 -23
@@ -249,10 +249,46 @@ static int cmos_set_time(struct device *dev, struct rtc_time *t)return mc146818_set_time (t); } +struct cmos_read_alarm_callback_param { +struct cmos_rtc *cmos; +struct rtc_time *time; +unsigned char rtc_control; +}; + +static void cmos_read_alarm_callback (unsigned char __always_unused seconds, +void *param_in) +{ +struct cmos_read_alarm_callback_param *p = + (struct cmos_read_alarm_callback_param *)param_in; +struct rtc_time *time = p->time; + + time->tm_sec =CMOS_READ (RTC_SECONDS_ALARM ); + time->tm_min =CMOS_READ (RTC_MINUTES_ALARM ); + time->tm_hour =CMOS_READ (RTC_HOURS_ALARM ); + +if (p->cmos->day_alrm) { +/* ignore upper bits on readback per ACPI spec */ + time->tm_mday =CMOS_READ (p->cmos->day_alrm) &0x3f ; +if (!time->tm_mday) + time->tm_mday =-1 ; + +if (p->cmos->mon_alrm) { + time->tm_mon =CMOS_READ (p->cmos->mon_alrm); +if (!time->tm_mon) + time->tm_mon =-1 ; + } + } + + p->rtc_control =CMOS_READ (RTC_CONTROL ); +} +static int cmos_read_alarm (struct device *dev,struct rtc_wkalrm *t) {struct cmos_rtc *cmos =dev_get_drvdata (dev); -unsigned char rtc_control; +struct cmos_read_alarm_callback_param p = { + .cmos = cmos, + .time = &t->time, + };/* This not only a rtc_op, but also called directly */ if (!is_valid_irq (cmos->irq))
@@ -263,28 +299,18 @@ static int cmos_read_alarm(struct device *dev, struct rtc_wkalrm *t)* the future. */ -spin_lock_irq (&rtc_lock); - t->time.tm_sec =CMOS_READ (RTC_SECONDS_ALARM ); - t->time.tm_min =CMOS_READ (RTC_MINUTES_ALARM ); - t->time.tm_hour =CMOS_READ (RTC_HOURS_ALARM ); - -if (cmos->day_alrm) { -/* ignore upper bits on readback per ACPI spec */ - t->time.tm_mday =CMOS_READ (cmos->day_alrm) &0x3f ; -if (!t->time.tm_mday) - t->time.tm_mday =-1 ; - -if (cmos->mon_alrm) { - t->time.tm_mon =CMOS_READ (cmos->mon_alrm); -if (!t->time.tm_mon) - t->time.tm_mon =-1 ; - } - } - - rtc_control =CMOS_READ (RTC_CONTROL ); -spin_unlock_irq (&rtc_lock); +/* Some Intel chipsets disconnect the alarm registers when the clock +* update is in progress - during this time reads return bogus values +* and writes may fail silently. See for example "7th Generation Intel® +* Processor Family I/O for U/Y Platforms [...] Datasheet", section +* 27.7.1 +* +* Use the mc146818_avoid_UIP() function to avoid this. +*/ +if (!mc146818_avoid_UIP (cmos_read_alarm_callback, &p)) +return -EIO ; -if (!(rtc_control &RTC_DM_BINARY ) ||RTC_ALWAYS_BCD ) { +if (!(p.rtc_control &RTC_DM_BINARY ) ||RTC_ALWAYS_BCD ) {if (((unsigned )t->time.tm_sec) <0x60 ) t->time.tm_sec =bcd2bin (t->time.tm_sec);else
@@ -313,7 +339,7 @@ static int cmos_read_alarm(struct device *dev, struct rtc_wkalrm *t) } } - t->enabled = !!(rtc_control &RTC_AIE ); + t->enabled = !!(p.rtc_control &RTC_AIE ); t->pending =0 ;return 0 ;
Signature · 1 line
2.25.1
PATCH v4 1/1 rtc-cmos: cmos_read_alarm bug demonstration
Before my commit "rtc-cmos: avoid UIP when reading alarm time", applying this patch and reading the CMOS time like so:
while true; do cat /sys/class/rtc/rtc0/time ; sleep 0.5; done
produces errors in dmesg on my Intel Kaby Lake laptop.
--- drivers/rtc/rtc-cmos.c | 61 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+)
drivers/rtc/rtc-cmos.c +61 -0
@@ -43,6 +43,9 @@#include <linux/dmi.h> #endif +#include <linux/ktime.h> +#include <linux/timekeeping.h> +/* this is for "generic access to PC-style RTC" using CMOS_READ/CMOS_WRITE */ #include <linux/mc146818rtc.h>
@@ -220,6 +223,8 @@ static inline void cmos_write_bank2(unsigned char val, unsigned char addr)/*----------------------------------------------------------------*/ +static void cmos_read_alarm_uip_debugging (struct device *dev); +static int cmos_read_time (struct device *dev,struct rtc_time *t) {/*
@@ -230,6 +235,8 @@ static int cmos_read_time(struct device *dev, struct rtc_time *t)return -EIO ;mc146818_get_time (t); + +cmos_read_alarm_uip_debugging (dev);return 0 ; }
@@ -338,6 +345,60 @@ static int cmos_read_alarm(struct device *dev, struct rtc_wkalrm *t)return 0 ; } +static void cmos_read_alarm_uip_debugging (struct device *dev) +{ +unsigned long flags; +unsigned char rtc_uip_baseline, rtc_uip; +struct rtc_wkalrm t_baseline, t; +ktime_t time_start, time_end; +int i; + +spin_lock_irqsave (&rtc_lock, flags); + rtc_uip_baseline =CMOS_READ (RTC_FREQ_SELECT ) &RTC_UIP ; +spin_unlock_irqrestore (&rtc_lock, flags); + +cmos_read_alarm (dev, &t_baseline); + + time_start =ktime_get (); + +for (i =0 ; i <2000 ; i++) { +spin_lock_irqsave (&rtc_lock, flags); + rtc_uip =CMOS_READ (RTC_FREQ_SELECT ) &RTC_UIP ; +spin_unlock_irqrestore (&rtc_lock, flags); + +cmos_read_alarm (dev, &t); + +if (t_baseline.time.tm_sec != t.time.tm_sec) { +dev_err (dev, +"Inconsistent alarm tm_sec value: %d != %d (RTC_UIP = %d; %d)\n" , + t_baseline.time.tm_sec, + t.time.tm_sec, + rtc_uip_baseline, rtc_uip); + } +if (t_baseline.time.tm_min != t.time.tm_min) { +dev_err (dev, +"Inconsistent alarm tm_min value: %d != %d (RTC_UIP = %d; %d)\n" , + t_baseline.time.tm_min, + t.time.tm_min, + rtc_uip_baseline, rtc_uip); + } +if (t_baseline.time.tm_hour != t.time.tm_hour) { +dev_err (dev, +"Inconsistent alarm tm_hour value: %d != %d (RTC_UIP = %d; %d)\n" , + t_baseline.time.tm_hour, + t.time.tm_hour, + rtc_uip_baseline, rtc_uip); + } + + } + + time_end =ktime_get (); + +pr_info_ratelimited ("%s: loop executed in %lld ns\n" , + __func__,ktime_to_ns (ktime_sub (time_end, time_start))); +} + +static void cmos_checkintr (struct cmos_rtc *cmos,unsigned char rtc_control) {unsigned char rtc_intr;
Signature · 1 line
2.25.1
PATCH v4 9/9 rtc-cmos: avoid UIP when writing alarm time
In reply to Mateusz JończykSome Intel chipsets disconnect the time and date RTC registers when the clock update is in progress: during this time reads may return bogus values and writes fail silently. This includes the RTC alarm registers.
[1]
cmos_set_alarm() did not take account for that, fix it.
[1] 7th Generation Intel ® Processor Family I/O for U/Y Platforms [...] Datasheet, Volume 1 of 2 (Intel's Document Number: 334658-006) Page 208
https://www.intel.com/content/dam/www/public/us/en/documents/datasheets/7th-and-8th-gen-core-family-mobile-u-y-processor-lines-i-o-datasheet-vol-1.pdf
"If a RAM read from the ten time and date bytes is attempted during an update cycle, the value read do not necessarily represent the true contents of those locations. Any RAM writes under the same conditions are ignored."
---
v4: fix some checkpatch --strict warnings
drivers/rtc/rtc-cmos.c | 107 +++++++++++++++++++++++++---------------- 1 file changed, 66 insertions(+), 41 deletions(-)
drivers/rtc/rtc-cmos.c +66 -41
@@ -470,10 +470,57 @@ static int cmos_validate_alarm(struct device *dev, struct rtc_wkalrm *t)return 0 ; } +struct cmos_set_alarm_callback_param { +struct cmos_rtc *cmos; +unsigned char mon, mday, hrs, min, sec; +struct rtc_wkalrm *t; +}; + +/* Note: this function may be executed by mc146818_avoid_UIP() more then +* once +*/ +static void cmos_set_alarm_callback (unsigned char __always_unused seconds, +void *param_in) +{ +struct cmos_set_alarm_callback_param *p = + (struct cmos_set_alarm_callback_param *)param_in; + +/* next rtc irq must not be from previous alarm setting */ +cmos_irq_disable (p->cmos,RTC_AIE ); + +/* update alarm */ +CMOS_WRITE (p->hrs,RTC_HOURS_ALARM ); +CMOS_WRITE (p->min,RTC_MINUTES_ALARM ); +CMOS_WRITE (p->sec,RTC_SECONDS_ALARM ); + +/* the system may support an "enhanced" alarm */ +if (p->cmos->day_alrm) { +CMOS_WRITE (p->mday, p->cmos->day_alrm); +if (p->cmos->mon_alrm) +CMOS_WRITE (p->mon, p->cmos->mon_alrm); + } + +if (use_hpet_alarm ()) { +/* +* FIXME the HPET alarm glue currently ignores day_alrm +* and mon_alrm ... +*/ +hpet_set_alarm_time (p->t->time.tm_hour, p->t->time.tm_min, + p->t->time.tm_sec); + } + +if (p->t->enabled) +cmos_irq_enable (p->cmos,RTC_AIE ); +} +static int cmos_set_alarm (struct device *dev,struct rtc_wkalrm *t) {struct cmos_rtc *cmos =dev_get_drvdata (dev); -unsigned char mon, mday, hrs, min, sec, rtc_control; +struct cmos_set_alarm_callback_param p = { + .cmos = cmos, + .t = t + }; +unsigned char rtc_control;int ret;/* This not only a rtc_op, but also called directly */
@@ -484,11 +531,11 @@ static int cmos_set_alarm(struct device *dev, struct rtc_wkalrm *t)if (ret <0 )return ret; - mon = t->time.tm_mon +1 ; - mday = t->time.tm_mday; - hrs = t->time.tm_hour; - min = t->time.tm_min; - sec = t->time.tm_sec; + p.mon = t->time.tm_mon +1 ; + p.mday = t->time.tm_mday; + p.hrs = t->time.tm_hour; + p.min = t->time.tm_min; + p.sec = t->time.tm_sec;spin_lock_irq (&rtc_lock); rtc_control =CMOS_READ (RTC_CONTROL );
@@ -496,43 +543,21 @@ static int cmos_set_alarm(struct device *dev, struct rtc_wkalrm *t)if (!(rtc_control &RTC_DM_BINARY ) ||RTC_ALWAYS_BCD ) {/* Writing 0xff means "don't care" or "match all". */ - mon = (mon <=12 ) ?bin2bcd (mon) :0xff ; - mday = (mday >=1 && mday <=31 ) ?bin2bcd (mday) :0xff ; - hrs = (hrs <24 ) ?bin2bcd (hrs) :0xff ; - min = (min <60 ) ?bin2bcd (min) :0xff ; - sec = (sec <60 ) ?bin2bcd (sec) :0xff ; - } - -spin_lock_irq (&rtc_lock); - -/* next rtc irq must not be from previous alarm setting */ -cmos_irq_disable (cmos,RTC_AIE ); - -/* update alarm */ -CMOS_WRITE (hrs,RTC_HOURS_ALARM ); -CMOS_WRITE (min,RTC_MINUTES_ALARM ); -CMOS_WRITE (sec,RTC_SECONDS_ALARM ); - -/* the system may support an "enhanced" alarm */ -if (cmos->day_alrm) { -CMOS_WRITE (mday, cmos->day_alrm); -if (cmos->mon_alrm) -CMOS_WRITE (mon, cmos->mon_alrm); - } - -if (use_hpet_alarm ()) { -/* -* FIXME the HPET alarm glue currently ignores day_alrm -* and mon_alrm ... -*/ -hpet_set_alarm_time (t->time.tm_hour, t->time.tm_min, - t->time.tm_sec); + p.mon = (p.mon <=12 ) ?bin2bcd (p.mon) :0xff ; + p.mday = (p.mday >=1 && p.mday <=31 ) ?bin2bcd (p.mday) :0xff ; + p.hrs = (p.hrs <24 ) ?bin2bcd (p.hrs) :0xff ; + p.min = (p.min <60 ) ?bin2bcd (p.min) :0xff ; + p.sec = (p.sec <60 ) ?bin2bcd (p.sec) :0xff ; } -if (t->enabled) -cmos_irq_enable (cmos,RTC_AIE ); - -spin_unlock_irq (&rtc_lock); +/* +* Some Intel chipsets disconnect the alarm registers when the clock +* update is in progress - during this time writes fail silently. +* +* Use mc146818_avoid_UIP() to avoid this. +*/ +if (!mc146818_avoid_UIP (cmos_set_alarm_callback, &p)) +return -EIO ; cmos->alarm_expires =rtc_tm_to_time64 (&t->time);
Signature · 1 line
2.25.1