Skip to contentSkip to conversation

Expand oscillator stop flag (OSF) validity check to ds1341

PATCH RESEND New Meagan Lloyd 1 participant 3 messages Jul 14, 2025 Real time clock (RTC)

lore
Share & tools
lore
#0 lore raw

cover Expand oscillator stop flag (OSF) validity check to ds1341

We would like to use CONFIG_RTC_HCTOSYS to sync a supercapacitor-backed DS1342 RTC to the kernel time early in boot. An obstacle is that the sync in rtc_hctosys() is unconditional as long as rtc_read_time() succeeds and in some power loss situations, our RTC comes up with either an unpredictable future time or the default 01/01/00 from the datasheet. Syncing a future time, followed by an NTP sync would not be desired as it would result in a backwards time jump. The sync feature is useful in boot scenarios where power is maintained so syncing only when the RTC data is valid would allow us to make use of the feature.

The DS1342 has the oscillator stop flag (OSF) which is a status flag indicating that the oscillator stopped for a period of time. It can be set due to power loss. Some chip types in the ds1307 driver already use the OSF to determine whether .read_time should provide valid data or return -EINVAL. This patch series expands that handling to the ds1341 chip type (DS1341 and DS1342 share a datasheet).

These changes enable us to make use of CONFIG_RTC_HCTOSYS as they prevent the invalid time from getting synced to the kernel time. It will also prevent userspace programs from getting the invalid time as the fix cuts it off at the source - the .read_time function.

Meagan Lloyd (2):
rtc: ds1307: remove clear of oscillator stop flag (OSF) in probe
rtc: ds1307: handle oscillator stop flag (OSF) for ds1341

 drivers/rtc/rtc-ds1307.c | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)

base-commit: 19272b37aa4f83ca52bdf9c16d5d81bdd1354494

Signature · 1 line
2.49.0
#1 lore raw

PATCH RESEND 1/2 rtc: ds1307: remove clear of oscillator stop flag (OSF) in probe

In using CONFIG_RTC_HCTOSYS, rtc_hctosys() will sync the RTC time to the kernel time as long as rtc_read_time() succeeds. In some power loss situations, our supercapacitor-backed DS1342 RTC comes up with either an unpredictable future time or the default 01/01/00 from the datasheet. The oscillator stop flag (OSF) is set in these scenarios due to the power loss and can be used to determine the validity of the RTC data.

Some chip types in the ds1307 driver already have OSF handling to determine whether .read_time provides valid RTC data or returns -EINVAL.

This change removes the clear of the OSF in .probe as the OSF needs to be preserved to expand the OSF handling to the ds1341 chip type (note that DS1341 and DS1342 share a datasheet).

---
Compile tested on rtc-next. Tested on an older kernel with ds1342 which has the same datasheet as ds1341.

---
 drivers/rtc/rtc-ds1307.c | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)
drivers/rtc/rtc-ds1307.c +1 -3
index 5efbe69bf5ca8..65beb7067e3f5 100644
@@ -1813,10 +1813,8 @@ static int ds1307_probe(struct i2c_client *client)
 		regmap_write(ds1307->regmap, DS1337_REG_CONTROL,
 			     regs[0]);
 
-		/* oscillator fault?  clear flag, and warn */
+		/* oscillator fault? warn */
 		if (regs[1] & DS1337_BIT_OSF) {
-			regmap_write(ds1307->regmap, DS1337_REG_STATUS,
-				     regs[1] & ~DS1337_BIT_OSF);
 			dev_warn(ds1307->dev, "SET TIME!\n");
 		}
 		break;
Signature · 1 line
2.49.0
#2 lore raw

PATCH RESEND 2/2 rtc: ds1307: handle oscillator stop flag (OSF) for ds1341

In reply to Meagan Lloyd

In using CONFIG_RTC_HCTOSYS, rtc_hctosys() will sync the RTC time to the kernel time as long as rtc_read_time() succeeds. In some power loss situations, our supercapacitor-backed DS1342 RTC comes up with either an unpredictable future time or the default 01/01/00 from the datasheet. The oscillator stop flag (OSF) is set in these scenarios due to the power loss and can be used to determine the validity of the RTC data.

This change expands the oscillator stop flag (OSF) handling that has already been implemented for some chips to the ds1341 chip (DS1341 and DS1342 share a datasheet). This handling manages the validity of the RTC data in .read_time and .set_time based on the OSF.

---
Compile tested on rtc-next. Tested on an older kernel with ds1342 which has the same datasheet as ds1341.

---
 drivers/rtc/rtc-ds1307.c | 11 +++++++++++
 1 file changed, 11 insertions(+)
drivers/rtc/rtc-ds1307.c +11 -0
index 65beb7067e3f5..ce0994d9219a2 100644
@@ -279,6 +279,13 @@ static int ds1307_get_time(struct device *dev, struct rtc_time *t)
 		if (tmp & DS1340_BIT_OSF)
 			return -EINVAL;
 		break;
+	case ds_1341:
+		ret = regmap_read(ds1307->regmap, DS1337_REG_STATUS, &tmp);
+		if (ret)
+			return ret;
+		if (tmp & DS1337_BIT_OSF)
+			return -EINVAL;
+		break;
 	case ds_1388:
 		ret = regmap_read(ds1307->regmap, DS1388_REG_FLAG, &tmp);
 		if (ret)
@@ -377,6 +384,10 @@ static int ds1307_set_time(struct device *dev, struct rtc_time *t)
 		regmap_update_bits(ds1307->regmap, DS1340_REG_FLAG,
 				   DS1340_BIT_OSF, 0);
 		break;
+	case ds_1341:
+		regmap_update_bits(ds1307->regmap, DS1337_REG_STATUS,
+				   DS1337_BIT_OSF, 0);
+		break;
 	case ds_1388:
 		regmap_update_bits(ds1307->regmap, DS1388_REG_FLAG,
 				   DS1388_BIT_OSF, 0);
Signature · 1 line
2.49.0