Skip to contentSkip to conversation

rtc: at91rm9200: add correction support

PATCH In review Alexandre Belloni 2 participants 3 messages Nov 8, 2020 – Nov 15, 2020

Subsystems (2)
lore
Share & tools
lore

Alexandre Belloni

author maintainer
#0 lore raw

PATCH 1/1 rtc: at91rm9200: add correction support

The sama5d4 and sama5d2 RTCs are able to correct for imprecise crystals, up to 1953 ppm.

---
 drivers/rtc/rtc-at91rm9200.c | 103 +++++++++++++++++++++++++++++++++--
 1 file changed, 99 insertions(+), 4 deletions(-)
drivers/rtc/rtc-at91rm9200.c +99 -4
index 5e811e04cb21..1eea187d9850 100644
@@ -36,6 +36,10 @@
 #define		AT91_RTC_UPDCAL		BIT(1)		/* Update Request Calendar Register */
 
 #define	AT91_RTC_MR		0x04			/* Mode Register */
+#define		AT91_RTC_HRMOD		BIT(0)		/* 12/24 hour mode */
+#define		AT91_RTC_NEGPPM		BIT(4)		/* Negative PPM correction */
+#define		AT91_RTC_CORRECTION	GENMASK(14, 8)	/* Slow clock correction */
+#define		AT91_RTC_HIGHPPM	BIT(15)		/* High PPM correction */
 
 #define	AT91_RTC_TIMR		0x08			/* Time Register */
 #define		AT91_RTC_SEC		GENMASK(6, 0)	/* Current Second */
@@ -77,6 +81,9 @@
 #define		AT91_RTC_NVTIMALR	BIT(2)		/* Non valid Time Alarm */
 #define		AT91_RTC_NVCALALR	BIT(3)		/* Non valid Calendar Alarm */
 
+#define AT91_RTC_CORR_DIVIDEND		3906000
+#define AT91_RTC_CORR_LOW_RATIO		20
+
 #define at91_rtc_read(field) \
 	readl_relaxed(at91_rtc_regs + field)
 #define at91_rtc_write(field, val) \
@@ -84,6 +91,7 @@
 
 struct at91_rtc_config {
 	bool use_shadow_imr;
+	bool has_correction;
 };
 
 static const struct at91_rtc_config *at91_rtc_config;
@@ -293,6 +301,75 @@ static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
 	return 0;
 }
 
+static int at91_rtc_readoffset(struct device *dev, long *offset)
+{
+	u32 mr = at91_rtc_read(AT91_RTC_MR);
+	long val = FIELD_GET(AT91_RTC_CORRECTION, mr);
+
+	if (!val) {
+		*offset = 0;
+		return 0;
+	}
+
+	val++;
+
+	if (!(mr & AT91_RTC_NEGPPM))
+		val = -val;
+
+	if (!(mr & AT91_RTC_HIGHPPM))
+		val *= AT91_RTC_CORR_LOW_RATIO;
+
+	*offset = DIV_ROUND_CLOSEST(AT91_RTC_CORR_DIVIDEND, val);
+
+	return 0;
+}
+
+static int at91_rtc_setoffset(struct device *dev, long offset)
+{
+	long corr;
+	u32 mr;
+
+	if (offset > AT91_RTC_CORR_DIVIDEND / 2)
+		return -ERANGE;
+	if (offset < -AT91_RTC_CORR_DIVIDEND / 2)
+		return -ERANGE;
+
+	mr = at91_rtc_read(AT91_RTC_MR);
+	mr &= ~(AT91_RTC_NEGPPM | AT91_RTC_CORRECTION | AT91_RTC_HIGHPPM);
+
+	if (offset > 0)
+		mr |= AT91_RTC_NEGPPM;
+	else
+		offset = -offset;
+
+	/* offset less than 764 ppb, disable correction*/
+	if (offset < 764) {
+		at91_rtc_write(AT91_RTC_MR, mr & ~AT91_RTC_NEGPPM);
+
+		return 0;
+	}
+
+	/*
+	 * 29208 ppb is the perfect cutoff between low range and high range
+	 * low range values are never better than high range value after that.
+	 */
+	if (offset < 29208) {
+		corr = DIV_ROUND_CLOSEST(AT91_RTC_CORR_DIVIDEND, offset * AT91_RTC_CORR_LOW_RATIO);
+	} else {
+		corr = DIV_ROUND_CLOSEST(AT91_RTC_CORR_DIVIDEND, offset);
+		mr |= AT91_RTC_HIGHPPM;
+	}
+
+	if (corr > 128)
+		corr = 128;
+
+	mr |= FIELD_PREP(AT91_RTC_CORRECTION, corr - 1);
+
+	at91_rtc_write(AT91_RTC_MR, mr);
+
+	return 0;
+}
+
 /*
  * IRQ handler for the RTC
  */
@@ -343,6 +420,10 @@ static const struct at91_rtc_config at91sam9x5_config = {
 	.use_shadow_imr	= true,
 };
 
+static const struct at91_rtc_config sama5d4_config = {
+	.has_correction = true,
+};
+
 static const struct of_device_id at91_rtc_dt_ids[] = {
 	{
 		.compatible = "atmel,at91rm9200-rtc",
@@ -352,10 +433,10 @@ static const struct of_device_id at91_rtc_dt_ids[] = {
 		.data = &at91sam9x5_config,
 	}, {
 		.compatible = "atmel,sama5d4-rtc",
-		.data = &at91rm9200_config,
+		.data = &sama5d4_config,
 	}, {
 		.compatible = "atmel,sama5d2-rtc",
-		.data = &at91rm9200_config,
+		.data = &sama5d4_config,
 	}, {
 		/* sentinel */
 	}
@@ -370,6 +451,16 @@ static const struct rtc_class_ops at91_rtc_ops = {
 	.alarm_irq_enable = at91_rtc_alarm_irq_enable,
 };
 
+static const struct rtc_class_ops sama5d4_rtc_ops = {
+	.read_time	= at91_rtc_readtime,
+	.set_time	= at91_rtc_settime,
+	.read_alarm	= at91_rtc_readalarm,
+	.set_alarm	= at91_rtc_setalarm,
+	.alarm_irq_enable = at91_rtc_alarm_irq_enable,
+	.set_offset	= at91_rtc_setoffset,
+	.read_offset	= at91_rtc_readoffset,
+};
+
 /*
  * Initialize and install RTC driver
  */
@@ -416,7 +507,7 @@ static int __init at91_rtc_probe(struct platform_device *pdev)
 	}
 
 	at91_rtc_write(AT91_RTC_CR, 0);
-	at91_rtc_write(AT91_RTC_MR, 0);		/* 24 hour mode */
+	at91_rtc_write(AT91_RTC_MR, at91_rtc_read(AT91_RTC_MR) & ~AT91_RTC_HRMOD);
 
 	/* Disable all interrupts */
 	at91_rtc_write_idr(AT91_RTC_ACKUPD | AT91_RTC_ALARM |
@@ -437,7 +528,11 @@ static int __init at91_rtc_probe(struct platform_device *pdev)
 	if (!device_can_wakeup(&pdev->dev))
 		device_init_wakeup(&pdev->dev, 1);
 
-	rtc->ops = &at91_rtc_ops;
+	if (at91_rtc_config->has_correction)
+		rtc->ops = &sama5d4_rtc_ops;
+	else
+		rtc->ops = &at91_rtc_ops;
+
 	rtc->range_min = RTC_TIMESTAMP_BEGIN_1900;
 	rtc->range_max = RTC_TIMESTAMP_END_2099;
 	ret = rtc_register_device(rtc);
Signature · 1 line
2.28.0
maintainer Reviewed-by on v1 1/1
#1 lore raw

Hi Alexandre,

Thanks you for adding this feature to newest at91 RTC IPs.

Quoted 1 line · Alexandre Belloni

The sama5d4 and sama5d2 RTCs are able to correct for imprecise crystals, up

FYI, sam9x60 RTC has the same correction capability.

... and I now realize that sam9x60 using sam9x5-rtc compatibility sting is maybe not the right choice...

Quoted 23 lines

to 1953 ppm.

---
  drivers/rtc/rtc-at91rm9200.c | 103 +++++++++++++++++++++++++++++++++--
  1 file changed, 99 insertions(+), 4 deletions(-)
drivers/rtc/rtc-at91rm9200.c +4 -0
index 5e811e04cb21..1eea187d9850 100644
@@ -36,6 +36,10 @@
  #define                AT91_RTC_UPDCAL         BIT(1)          /* Update Request Calendar Register */
 
  #define        AT91_RTC_MR             0x04                    /* Mode Register */
+#define                AT91_RTC_HRMOD          BIT(0)          /* 12/24 hour mode */
+#define                AT91_RTC_NEGPPM         BIT(4)          /* Negative PPM correction */
+#define                AT91_RTC_CORRECTION     GENMASK(14, 8)  /* Slow clock correction */
+#define                AT91_RTC_HIGHPPM        BIT(15)         /* High PPM correction */
 
  #define        AT91_RTC_TIMR           0x08                    /* Time Register */
  #define                AT91_RTC_SEC            GENMASK(6, 0)   /* Current Second */

drivers/rtc/rtc-at91rm9200.c line 85

Quoted 5 lines
drivers/rtc/rtc-at91rm9200.c +2 -0
@@ -77,6 +81,9 @@
  #define                AT91_RTC_NVTIMALR       BIT(2)          /* Non valid Time Alarm */
  #define                AT91_RTC_NVCALALR       BIT(3)          /* Non valid Calendar Alarm */
 
+#define AT91_RTC_CORR_DIVIDEND         3906000
+#define AT91_RTC_CORR_LOW_RATIO                20

IMHO, it's worth telling here that these values are from the product datasheet in formula coming from explanation of HIGHPPM bit of register RTC_MR.

Quoted 48 lines
drivers/rtc/rtc-at91rm9200.c +34 -0
+
  #define at91_rtc_read(field) \
         readl_relaxed(at91_rtc_regs + field)
  #define at91_rtc_write(field, val) \
@@ -84,6 +91,7 @@
 
  struct at91_rtc_config {
         bool use_shadow_imr;
+       bool has_correction;
  };
 
  static const struct at91_rtc_config *at91_rtc_config;
@@ -293,6 +301,75 @@ static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
         return 0;
  }
 
+static int at91_rtc_readoffset(struct device *dev, long *offset)
+{
+       u32 mr = at91_rtc_read(AT91_RTC_MR);
+       long val = FIELD_GET(AT91_RTC_CORRECTION, mr);
+
+       if (!val) {
+               *offset = 0;
+               return 0;
+       }
+
+       val++;
+
+       if (!(mr & AT91_RTC_NEGPPM))
+               val = -val;
+
+       if (!(mr & AT91_RTC_HIGHPPM))
+               val *= AT91_RTC_CORR_LOW_RATIO;
+
+       *offset = DIV_ROUND_CLOSEST(AT91_RTC_CORR_DIVIDEND, val);
+
+       return 0;
+}
+
+static int at91_rtc_setoffset(struct device *dev, long offset)
+{
+       long corr;
+       u32 mr;
+
+       if (offset > AT91_RTC_CORR_DIVIDEND / 2)
+               return -ERANGE;
+       if (offset < -AT91_RTC_CORR_DIVIDEND / 2)
+               return -ERANGE;

drivers/rtc/rtc-at91rm9200.c static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled) · line 345

Quoted 10 lines
drivers/rtc/rtc-at91rm9200.c +10 -0
+
+       mr = at91_rtc_read(AT91_RTC_MR);
+       mr &= ~(AT91_RTC_NEGPPM | AT91_RTC_CORRECTION | AT91_RTC_HIGHPPM);
+
+       if (offset > 0)
+               mr |= AT91_RTC_NEGPPM;
+       else
+               offset = -offset;
+
+       /* offset less than 764 ppb, disable correction*/

Does it correspond to the 1.5 ppm value of the datasheet? (sorry I'm not so used to these computations?)

drivers/rtc/rtc-at91rm9200.c static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled) · line 354

Quoted 9 lines
drivers/rtc/rtc-at91rm9200.c +9 -0
+       if (offset < 764) {
+               at91_rtc_write(AT91_RTC_MR, mr & ~AT91_RTC_NEGPPM);
+
+               return 0;
+       }
+
+       /*
+        * 29208 ppb is the perfect cutoff between low range and high range
+        * low range values are never better than high range value after that.

And here, I'm lost. Does it correspond to the sentence:
"HIGHPPM set to 1 is recommended for 30 ppm correction and above." ? And rounding using register values, am I right?

drivers/rtc/rtc-at91rm9200.c static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled) · line 363

Quoted 9 lines
drivers/rtc/rtc-at91rm9200.c +9 -0
+        */
+       if (offset < 29208) {
+               corr = DIV_ROUND_CLOSEST(AT91_RTC_CORR_DIVIDEND, offset * AT91_RTC_CORR_LOW_RATIO);
+       } else {
+               corr = DIV_ROUND_CLOSEST(AT91_RTC_CORR_DIVIDEND, offset);
+               mr |= AT91_RTC_HIGHPPM;
+       }
+
+       if (corr > 128)

Okay, it's maximized to the width of register field, got it.

drivers/rtc/rtc-at91rm9200.c static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled) · line 364

Quoted 1 line
drivers/rtc/rtc-at91rm9200.c +1 -0
+               corr = 128;

I'm kind of following and don't know what other RTC drivers are doing... but would prefer more explanation on numerical values.

Quoted 75 lines
drivers/rtc/rtc-at91rm9200.c +30 -5
+
+       mr |= FIELD_PREP(AT91_RTC_CORRECTION, corr - 1);
+
+       at91_rtc_write(AT91_RTC_MR, mr);
+
+       return 0;
+}
+
  /*
   * IRQ handler for the RTC
   */
@@ -343,6 +420,10 @@ static const struct at91_rtc_config at91sam9x5_config = {
         .use_shadow_imr = true,
  };
 
+static const struct at91_rtc_config sama5d4_config = {
+       .has_correction = true,
+};
+
  static const struct of_device_id at91_rtc_dt_ids[] = {
         {
                 .compatible = "atmel,at91rm9200-rtc",
@@ -352,10 +433,10 @@ static const struct of_device_id at91_rtc_dt_ids[] = {
                 .data = &at91sam9x5_config,
         }, {
                 .compatible = "atmel,sama5d4-rtc",
-               .data = &at91rm9200_config,
+               .data = &sama5d4_config,
         }, {
                 .compatible = "atmel,sama5d2-rtc",
-               .data = &at91rm9200_config,
+               .data = &sama5d4_config,
         }, {
                 /* sentinel */
         }
@@ -370,6 +451,16 @@ static const struct rtc_class_ops at91_rtc_ops = {
         .alarm_irq_enable = at91_rtc_alarm_irq_enable,
  };
 
+static const struct rtc_class_ops sama5d4_rtc_ops = {
+       .read_time      = at91_rtc_readtime,
+       .set_time       = at91_rtc_settime,
+       .read_alarm     = at91_rtc_readalarm,
+       .set_alarm      = at91_rtc_setalarm,
+       .alarm_irq_enable = at91_rtc_alarm_irq_enable,
+       .set_offset     = at91_rtc_setoffset,
+       .read_offset    = at91_rtc_readoffset,
+};
+
  /*
   * Initialize and install RTC driver
   */
@@ -416,7 +507,7 @@ static int __init at91_rtc_probe(struct platform_device *pdev)
         }
 
         at91_rtc_write(AT91_RTC_CR, 0);
-       at91_rtc_write(AT91_RTC_MR, 0);         /* 24 hour mode */
+       at91_rtc_write(AT91_RTC_MR, at91_rtc_read(AT91_RTC_MR) & ~AT91_RTC_HRMOD);
 
         /* Disable all interrupts */
         at91_rtc_write_idr(AT91_RTC_ACKUPD | AT91_RTC_ALARM |
@@ -437,7 +528,11 @@ static int __init at91_rtc_probe(struct platform_device *pdev)
         if (!device_can_wakeup(&pdev->dev))
                 device_init_wakeup(&pdev->dev, 1);
 
-       rtc->ops = &at91_rtc_ops;
+       if (at91_rtc_config->has_correction)
+               rtc->ops = &sama5d4_rtc_ops;
+       else
+               rtc->ops = &at91_rtc_ops;
+
         rtc->range_min = RTC_TIMESTAMP_BEGIN_1900;
         rtc->range_max = RTC_TIMESTAMP_END_2099;
         ret = rtc_register_device(rtc);
--
Quoted 1 line

2.28.0

Alexandre, you know much more than me about the habits of RTC drivers writers. Even if I would like a little more documentation on values used, I absolutely won't hold this feature adoption, so here is my:

Thanks, best regards,
Nicolas

Signature · 1 line
Nicolas Ferre
author maintainer
#2 lore raw
Quoted 5 lines · Nicolas Ferre

Hi Alexandre,

Thanks you for adding this feature to newest at91 RTC IPs.

Quoted 8 lines
Quoted 1 line · Alexandre Belloni

The sama5d4 and sama5d2 RTCs are able to correct for imprecise crystals, up

FYI, sam9x60 RTC has the same correction capability.

... and I now realize that sam9x60 using sam9x5-rtc compatibility sting is maybe not the right choice...

I did see that when I reviewed the sam9x60 dtsi and it has its own compatible string upstream.

Quoted 47 lines
Quoted 23 lines

to 1953 ppm.

---
  drivers/rtc/rtc-at91rm9200.c | 103 +++++++++++++++++++++++++++++++++--
  1 file changed, 99 insertions(+), 4 deletions(-)
drivers/rtc/rtc-at91rm9200.c +4 -0
index 5e811e04cb21..1eea187d9850 100644
@@ -36,6 +36,10 @@
  #define                AT91_RTC_UPDCAL         BIT(1)          /* Update Request Calendar Register */
 
  #define        AT91_RTC_MR             0x04                    /* Mode Register */
+#define                AT91_RTC_HRMOD          BIT(0)          /* 12/24 hour mode */
+#define                AT91_RTC_NEGPPM         BIT(4)          /* Negative PPM correction */
+#define                AT91_RTC_CORRECTION     GENMASK(14, 8)  /* Slow clock correction */
+#define                AT91_RTC_HIGHPPM        BIT(15)         /* High PPM correction */
 
  #define        AT91_RTC_TIMR           0x08                    /* Time Register */
  #define                AT91_RTC_SEC            GENMASK(6, 0)   /* Current Second */

drivers/rtc/rtc-at91rm9200.c line 85

Quoted 5 lines
drivers/rtc/rtc-at91rm9200.c +2 -0
@@ -77,6 +81,9 @@
  #define                AT91_RTC_NVTIMALR       BIT(2)          /* Non valid Time Alarm */
  #define                AT91_RTC_NVCALALR       BIT(3)          /* Non valid Calendar Alarm */
 
+#define AT91_RTC_CORR_DIVIDEND         3906000
+#define AT91_RTC_CORR_LOW_RATIO                20

IMHO, it's worth telling here that these values are from the product datasheet in formula coming from explanation of HIGHPPM bit of register RTC_MR.

Quoted 14 lines
drivers/rtc/rtc-at91rm9200.c +14 -0
+static int at91_rtc_setoffset(struct device *dev, long offset)
+{
+       long corr;
+       u32 mr;
+
+       if (offset > AT91_RTC_CORR_DIVIDEND / 2)
+               return -ERANGE;
+       if (offset < -AT91_RTC_CORR_DIVIDEND / 2)
+               return -ERANGE;
+
+       mr = at91_rtc_read(AT91_RTC_MR);
+       mr &= ~(AT91_RTC_NEGPPM | AT91_RTC_CORRECTION | AT91_RTC_HIGHPPM);
+
+       if (offset > 0)
Quoted 9 lines

drivers/rtc/rtc-at91rm9200.c static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled) · line 345

Quoted 5 lines
drivers/rtc/rtc-at91rm9200.c +5 -0
+               mr |= AT91_RTC_NEGPPM;
+       else
+               offset = -offset;
+
+       /* offset less than 764 ppb, disable correction*/

Does it correspond to the 1.5 ppm value of the datasheet? (sorry I'm not so used to these computations?)

Yes, 764ppb is closer to 1525ppb (the 1.5ppm from the datasheet) than 0 so at that point it starts to make sense to correct the offset.

Quoted 5 lines
Quoted 5 lines
drivers/rtc/rtc-at91rm9200.c +5 -0
+       if (offset < 764) {
+               at91_rtc_write(AT91_RTC_MR, mr & ~AT91_RTC_NEGPPM);
+
+               return 0;
+       }
Quoted 9 lines

drivers/rtc/rtc-at91rm9200.c static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled) · line 354

Quoted 4 lines
drivers/rtc/rtc-at91rm9200.c +4 -0
+
+       /*
+        * 29208 ppb is the perfect cutoff between low range and high range
+        * low range values are never better than high range value after that.

And here, I'm lost. Does it correspond to the sentence:
"HIGHPPM set to 1 is recommended for 30 ppm correction and above." ? And rounding using register values, am I right?

The values in the datasheet are not that well rounded, the comment is really the answer, starting with 29208ppb, with highppm = 1 the values are a superset of the ones with highppm = 0

Quoted 10 lines

drivers/rtc/rtc-at91rm9200.c static int at91_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled) · line 363

Quoted 9 lines
drivers/rtc/rtc-at91rm9200.c +9 -0
+        */
+       if (offset < 29208) {
+               corr = DIV_ROUND_CLOSEST(AT91_RTC_CORR_DIVIDEND, offset * AT91_RTC_CORR_LOW_RATIO);
+       } else {
+               corr = DIV_ROUND_CLOSEST(AT91_RTC_CORR_DIVIDEND, offset);
+               mr |= AT91_RTC_HIGHPPM;
+       }
+
+       if (corr > 128)
Quoted 2 lines

Okay, it's maximized to the width of register field, got it.

Yes, this handles corrections between 764ppb and 1525ppb.

Quoted 5 lines
Quoted 1 line

+ corr = 128;

I'm kind of following and don't know what other RTC drivers are doing... but would prefer more explanation on numerical values.

Well, there isn't much more to explain. However, I think the IP could be a bit more friendly because high correction values means very little correction is happening. Also, NEGPPM is reversed versus other RTCs and it was not 100% clear from the datasheet.

Quoted 6 lines

Alexandre, you know much more than me about the habits of RTC drivers writers. Even if I would like a little more documentation on values used, I absolutely won't hold this feature adoption, so here is my:

The offset calculations are usually coming directly from the datasheet so it is not unusual to have little explanation. It is obviously easier when there is a more direct correlation between the register value and the offset value in ppb.

Signature · 3 lines
Alexandre Belloni, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com