Skip to contentSkip to conversation

Add RTC for MStar SoCs

PATCH Superseded Romain Perier 4 participants 10 messages Aug 1, 2021 – Aug 19, 2021

Subsystems (3)

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore

Romain Perier

author maintainer
#0 lore raw

v2 cover Add RTC for MStar SoCs

This patches series adds a new driver for the RTC found in the Mstar MSC313e SoCs and newer. It adds a basic rtc driver, the corresponding devicetree bindings and its documentation.

The rtctest (from selftests) has been passed on this driver, with the following output:

$ rtctest 
TAP version 13
1..7
# Starting 7 tests from 2 test cases.
#  RUN           rtc.date_read ...
# rtctest.c:47:date_read:Current RTC date/time is 01/01/1970 00:02:03.
#            OK  rtc.date_read
ok 1 rtc.date_read
#  RUN           rtc.uie_read ...
#            OK  rtc.uie_read
ok 2 rtc.uie_read
#  RUN           rtc.uie_select ...
#            OK  rtc.uie_select
ok 3 rtc.uie_select
#  RUN           rtc.alarm_alm_set ...
# rtctest.c:136:alarm_alm_set:Alarm time now set to 00:02:12.
# rtctest.c:156:alarm_alm_set:data: 1a0
#            OK  rtc.alarm_alm_set
ok 4 rtc.alarm_alm_set
#  RUN           rtc.alarm_wkalm_set ...
# rtctest.c:192:alarm_wkalm_set:Alarm time now set to 01/01/1970 00:02:15.
#            OK  rtc.alarm_wkalm_set
ok 5 rtc.alarm_wkalm_set
#  RUN           rtc.alarm_alm_set_minute ...
# rtctest.c:238:alarm_alm_set_minute:Alarm time now set to 00:03:00.
# rtctest.c:258:alarm_alm_set_minute:data: 1a0
#            OK  rtc.alarm_alm_set_minute
ok 6 [  180.545015] random: fast init done
rtc.alarm_alm_set_minute
#  RUN           rtc.alarm_wkalm_set_minute ...
# rtctest.c:294:alarm_wkalm_set_minute:Alarm time now set to 01/01/1970 00:04:00.
#            OK  rtc.alarm_wkalm_set_minute
ok 7 rtc.alarm_wkalm_set_minute
# PASSED: 7 / 7 tests passed.
# Totals: pass:7 fail:0 xfail:0 xpass:0 skip:0 error:0

Changes since v1:
- Fixed the DT bindings documentation and fixed dt_binding_check (an include was missing)
- Added || COMPILE_TEST to kconfig
- Removed rtc_valid_tm from msc313_rtc_read_time()
- Removed the last write of the msc313_rtc_set_time() function (not required) and improved comments
- Replaced the relaxed io by normal io in msc313_rtc_interrupt()
- Added checks to be sure that the alarm fired in msc313_rtc_interrupt()
- Removed msc313_rtc_remove() (replaced by devm_add_action_or_reset)
- Removed unnecessary software reset of the IP in the probe function (the soft reset is never executed, it is a mistake from the initial refactoring)
- Switched to devm_rtc_allocate_device() and devm_rtc_register_device(), and dropped the error message related to the rtc device allocation
- Added an RTC range by setting .range_min and .range_max
- Added the "start-year" property to the DT bindings documentation

Daniel Palmer (1):
rtc: Add support for the MSTAR MSC313 RTC

Romain Perier (2):
dt-bindings: rtc: Add Mstar MSC313e RTC devicetree bindings
documentation
ARM: dts: mstar: Add rtc device node

 .../bindings/rtc/mstar,msc313-rtc.yaml        |  49 ++++
 MAINTAINERS                                   |   1 +
 arch/arm/boot/dts/mstar-v7.dtsi               |   7 +
 drivers/rtc/Kconfig                           |  10 +
 drivers/rtc/Makefile                          |   1 +
 drivers/rtc/rtc-msc313.c                      | 246 ++++++++++++++++++
 6 files changed, 314 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/mstar,msc313-rtc.yaml
 create mode 100644 drivers/rtc/rtc-msc313.c
Signature · 1 line
2.30.2
author maintainer
#1 lore raw

PATCH v2 1/3 dt-bindings: rtc: Add Mstar MSC313e RTC devicetree bindings documentation

This adds the documentation for the devicetree bindings of the Mstar MSC313e RTC driver, found from MSC313e SoCs and newer.

---
 .../bindings/rtc/mstar,msc313-rtc.yaml        | 49 +++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/mstar,msc313-rtc.yaml
Documentation/devicetree/bindings/rtc/mstar,msc313-rtc.yaml new file +49 -0
new file mode 100644
index 000000000000..62bc12b1feb6
@@ -0,0 +1,49 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/mstar,msc313-rtc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Mstar MSC313e RTC Device Tree Bindings
+
+allOf:
+  - $ref: "rtc.yaml#"
+
+maintainers:
+  - Daniel Palmer <[email protected]>
+  - Romain Perier <[email protected]>
+
+properties:
+  compatible:
+    enum:
+      - mstar,msc313-rtc
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  start-year: true
+
+  clocks:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    rtc@2400 {
+        compatible = "mstar,msc313-rtc";
+        reg = <0x2400 0x40>;
+        clocks = <&xtal_div2>;
+        interrupts-extended = <&intc_irq GIC_SPI 44 IRQ_TYPE_LEVEL_HIGH>;
+    };
+...
Signature · 1 line
2.30.2
maintainer
#2 lore raw

Re: [PATCH v2 1/3] dt-bindings: rtc: Add Mstar MSC313e RTC devicetree bindings documentation

Quoted 15 lines · Romain Perier

This adds the documentation for the devicetree bindings of the Mstar MSC313e RTC driver, found from MSC313e SoCs and newer.

---
 .../bindings/rtc/mstar,msc313-rtc.yaml        | 49 +++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/mstar,msc313-rtc.yaml
Documentation/devicetree/bindings/rtc/mstar,msc313-rtc.yaml new file +0 -0
new file mode 100644
index 000000000000..62bc12b1feb6

Documentation/devicetree/bindings/rtc/mstar,msc313-rtc.yaml line 1

Quoted 1 line
Documentation/devicetree/bindings/rtc/mstar,msc313-rtc.yaml new file +1 -0
@@ -0,0 +1,49 @@
+# SPDX-License-Identifier: GPL-2.0

As checkpatch.pl will tell you, should be dual licensed.

Quoted 52 lines
Documentation/devicetree/bindings/rtc/mstar,msc313-rtc.yaml new file +48 -0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/rtc/mstar,msc313-rtc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Mstar MSC313e RTC Device Tree Bindings
+
+allOf:
+  - $ref: "rtc.yaml#"
+
+maintainers:
+  - Daniel Palmer <[email protected]>
+  - Romain Perier <[email protected]>
+
+properties:
+  compatible:
+    enum:
+      - mstar,msc313-rtc
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  start-year: true
+
+  clocks:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    rtc@2400 {
+        compatible = "mstar,msc313-rtc";
+        reg = <0x2400 0x40>;
+        clocks = <&xtal_div2>;
+        interrupts-extended = <&intc_irq GIC_SPI 44 IRQ_TYPE_LEVEL_HIGH>;
+    };
+...
Signature · 1 line
2.30.2
author maintainer
#3 lore raw

Re: [PATCH v2 1/3] dt-bindings: rtc: Add Mstar MSC313e RTC devicetree bindings documentation

Hi,

Quoted 11 lines · Rob Herring
Quoted 9 lines · Romain Perier

This adds the documentation for the devicetree bindings of the Mstar MSC313e RTC driver, found from MSC313e SoCs and newer.

---
 .../bindings/rtc/mstar,msc313-rtc.yaml        | 49 +++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/rtc/mstar,msc313-rtc.yaml
Quoted 9 lines

Documentation/devicetree/bindings/rtc/mstar,msc313-rtc.yaml line 1

Quoted 7 lines
Documentation/devicetree/bindings/rtc/mstar,msc313-rtc.yaml new file +1 -0
new file mode 100644
index 000000000000..62bc12b1feb6
@@ -0,0 +1,49 @@
+# SPDX-License-Identifier: GPL-2.0

As checkpatch.pl will tell you, should be dual licensed.

Arf, sorry for this, I have completely missed it (it will be fixed in v3).

Romain

author maintainer
#4 lore raw

PATCH v2 2/3 rtc: Add support for the MSTAR MSC313 RTC

In reply to Romain Perier

From: Daniel Palmer <[email protected]>

This adds support for the RTC block on the Mstar MSC313e SoCs and newer.

---
 MAINTAINERS              |   1 +
 drivers/rtc/Kconfig      |  10 ++
 drivers/rtc/Makefile     |   1 +
 drivers/rtc/rtc-msc313.c | 246 +++++++++++++++++++++++++++++++++++++++
 4 files changed, 258 insertions(+)
 create mode 100644 drivers/rtc/rtc-msc313.c
MAINTAINERS +1 -0
index c9467d2839f5..bff16c7bafb8 100644
@@ -2220,6 +2220,7 @@ F:	arch/arm/boot/dts/mstar-*
 F:	arch/arm/mach-mstar/
 F:	drivers/clk/mstar/
 F:	drivers/gpio/gpio-msc313.c
+F:	drivers/rtc/rtc-msc313.c
 F:	drivers/watchdog/msc313e_wdt.c
 F:	include/dt-bindings/clock/mstar-*
 F:	include/dt-bindings/gpio/msc313-gpio.h
drivers/rtc/Kconfig +10 -0
index 12153d5801ce..9ce4baab5fcf 100644
@@ -1925,4 +1925,14 @@ config RTC_DRV_WILCO_EC
 	  This can also be built as a module. If so, the module will
 	  be named "rtc_wilco_ec".
 
+config RTC_DRV_MSC313
+	tristate "MStar MSC313 RTC"
+        depends on ARCH_MSTARV7 || COMPILE_TEST
+	help
+	  If you say yes here you get support for the Mstar MSC313e On-Chip
+	  Real Time Clock.
+
+	  This driver can also be built as a module, if so, the module
+	  will be called "rtc-msc313".
+
 endif # RTC_CLASS
drivers/rtc/Makefile +1 -0
index 2dd0dd956b0e..5efda8a60cee 100644
@@ -101,6 +101,7 @@ obj-$(CONFIG_RTC_DRV_MCP795)	+= rtc-mcp795.o
 obj-$(CONFIG_RTC_DRV_MESON)	+= rtc-meson.o
 obj-$(CONFIG_RTC_DRV_MOXART)	+= rtc-moxart.o
 obj-$(CONFIG_RTC_DRV_MPC5121)	+= rtc-mpc5121.o
+obj-$(CONFIG_RTC_DRV_MSC313)	+= rtc-msc313.o
 obj-$(CONFIG_RTC_DRV_MSM6242)	+= rtc-msm6242.o
 obj-$(CONFIG_RTC_DRV_MT2712)	+= rtc-mt2712.o
 obj-$(CONFIG_RTC_DRV_MT6397)	+= rtc-mt6397.o
drivers/rtc/rtc-msc313.c new file +246 -0

246 lines not on this page · raw message

Signature · 1 line
2.30.2
#5 lore raw

Re: [PATCH v2 2/3] rtc: Add support for the MSTAR MSC313 RTC

Hello,

Quoted 17 lines · Romain Perier
drivers/rtc/rtc-msc313.c new file +17 -0
+static int msc313_rtc_probe(struct platform_device *pdev)
+{
+	struct device *dev = &pdev->dev;
+	struct msc313_rtc *priv;
+	int ret;
+	int irq;
+	unsigned long rate;
+	u16 reg;
+
+	priv = devm_kzalloc(&pdev->dev, sizeof(struct msc313_rtc), GFP_KERNEL);
+	if (!priv)
+		return -ENOMEM;
+
+	priv->rtc_base = devm_platform_ioremap_resource(pdev, 0);
+	if (IS_ERR(priv->rtc_base))
+		return PTR_ERR(priv->rtc_base);
+

drivers/rtc/rtc-msc313.c line 188

Quoted 10 lines
drivers/rtc/rtc-msc313.c new file +10 -0
+	irq = platform_get_irq(pdev, 0);
+	if (irq < 0)
+		return -EINVAL;
+
+	priv->rtc_dev = devm_rtc_allocate_device(dev);
+	if (IS_ERR(priv->rtc_dev))
+		return PTR_ERR(priv->rtc_dev);
+
+	priv->rtc_dev->ops = &msc313_rtc_ops;
+	priv->rtc_dev->range_min = RTC_TIMESTAMP_BEGIN_0000;

I'm pretty sure this doesn't fit in this RTC registers, you should probably leave range_min to 0 (i.e. not set it at all).

drivers/rtc/rtc-msc313.c line 189

Quoted 1 line
drivers/rtc/rtc-msc313.c new file +1 -0
+	priv->rtc_dev->range_max = U32_MAX - 1; /* 2106-02-07 06:28:14 */

I guess this one should be U32_MAX

Quoted 22 lines
drivers/rtc/rtc-msc313.c new file +22 -0
+
+	ret = devm_request_irq(dev, irq, msc313_rtc_interrupt, IRQF_SHARED,
+			       dev_name(&pdev->dev), &pdev->dev);
+	if (ret) {
+		dev_err(dev, "Could not request IRQ\n");
+		return ret;
+	}
+
+	priv->clk = devm_clk_get(dev, NULL);
+	if (IS_ERR(priv->clk)) {
+		dev_err(dev, "No input reference clock\n");
+		return PTR_ERR(priv->clk);
+	}
+
+	ret = clk_prepare_enable(priv->clk);
+	if (ret) {
+		dev_err(dev, "Failed to enable the reference clock, %d\n", ret);
+		return ret;
+	}
+
+	ret = devm_add_action_or_reset(dev, (void (*) (void *))clk_disable_unprepare, priv->clk);
+	if (ret)

drivers/rtc/rtc-msc313.c line 221

Quoted 10 lines
drivers/rtc/rtc-msc313.c new file +10 -0
+		return ret;
+
+	rate = clk_get_rate(priv->clk);
+	writew(rate & 0xFFFF, priv->rtc_base + REG_RTC_FREQ_CW_L);
+	writew((rate >> 16) & 0xFFFF, priv->rtc_base + REG_RTC_FREQ_CW_H);
+
+	reg = readw(priv->rtc_base + REG_RTC_CTRL);
+	reg |= CNT_EN_BIT;
+	writew(reg, priv->rtc_base + REG_RTC_CTRL);
+

If on POR, CNT_EN_BIT is not set, then it would be nice to use that to know whether the RTC is properly set. You can then check CNT_EN_BIT in .read_time and return -EINVAL if it is not set. Then you can set the bit in .set_time. It is anyway useless to let the RTC running if it is not set.

Quoted 28 lines
drivers/rtc/rtc-msc313.c new file +25 -0
+	platform_set_drvdata(pdev, priv);
+
+	return devm_rtc_register_device(priv->rtc_dev);
+}
+
+static const struct of_device_id msc313_rtc_of_match_table[] = {
+	{ .compatible = "mstar,msc313-rtc" },
+	{ }
+};
+MODULE_DEVICE_TABLE(of, ms_rtc_of_match_table);
+
+static struct platform_driver msc313_rtc_driver = {
+	.probe = msc313_rtc_probe,
+	.driver = {
+		.name = "msc313-rtc",
+		.of_match_table = msc313_rtc_of_match_table,
+	},
+};
+
+module_platform_driver(msc313_rtc_driver);
+
+MODULE_AUTHOR("Daniel Palmer <[email protected]>");
+MODULE_AUTHOR("Romain Perier <[email protected]>");
+MODULE_DESCRIPTION("MStar RTC Driver");
+MODULE_LICENSE("GPL v2");
Signature · 1 line
2.30.2
Signature · 3 lines
Alexandre Belloni, co-owner and COO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
author maintainer
#6 lore raw

Re: [PATCH v2 2/3] rtc: Add support for the MSTAR MSC313 RTC

Hello,

Quoted 26 lines · Alexandre Belloni

Hello,

Quoted 22 lines · Romain Perier
drivers/rtc/rtc-msc313.c new file +22 -0
+static int msc313_rtc_probe(struct platform_device *pdev)
+{
+     struct device *dev = &pdev->dev;
+     struct msc313_rtc *priv;
+     int ret;
+     int irq;
+     unsigned long rate;
+     u16 reg;
+
+     priv = devm_kzalloc(&pdev->dev, sizeof(struct msc313_rtc), GFP_KERNEL);
+     if (!priv)
+             return -ENOMEM;
+
+     priv->rtc_base = devm_platform_ioremap_resource(pdev, 0);
+     if (IS_ERR(priv->rtc_base))
+             return PTR_ERR(priv->rtc_base);
+
+     irq = platform_get_irq(pdev, 0);
+     if (irq < 0)
+             return -EINVAL;
+
+     priv->rtc_dev = devm_rtc_allocate_device(dev);
Quoted 8 lines

drivers/rtc/rtc-msc313.c line 188

Quoted 5 lines
drivers/rtc/rtc-msc313.c new file +5 -0
+     if (IS_ERR(priv->rtc_dev))
+             return PTR_ERR(priv->rtc_dev);
+
+     priv->rtc_dev->ops = &msc313_rtc_ops;
+     priv->rtc_dev->range_min = RTC_TIMESTAMP_BEGIN_0000;

I'm pretty sure this doesn't fit in this RTC registers, you should probably leave range_min to 0 (i.e. not set it at all).

ack

Quoted 4 lines
Quoted 2 lines

+ priv->rtc_dev->range_max = U32_MAX - 1; /* 2106-02-07 06:28:14 */

I guess this one should be U32_MAX

ack

Quoted 30 lines
Quoted 30 lines
drivers/rtc/rtc-msc313.c new file +30 -0
+
+     ret = devm_request_irq(dev, irq, msc313_rtc_interrupt, IRQF_SHARED,
+                            dev_name(&pdev->dev), &pdev->dev);
+     if (ret) {
+             dev_err(dev, "Could not request IRQ\n");
+             return ret;
+     }
+
+     priv->clk = devm_clk_get(dev, NULL);
+     if (IS_ERR(priv->clk)) {
+             dev_err(dev, "No input reference clock\n");
+             return PTR_ERR(priv->clk);
+     }
+
+     ret = clk_prepare_enable(priv->clk);
+     if (ret) {
+             dev_err(dev, "Failed to enable the reference clock, %d\n", ret);
+             return ret;
+     }
+
+     ret = devm_add_action_or_reset(dev, (void (*) (void *))clk_disable_unprepare, priv->clk);
+     if (ret)
+             return ret;
+
+     rate = clk_get_rate(priv->clk);
+     writew(rate & 0xFFFF, priv->rtc_base + REG_RTC_FREQ_CW_L);
+     writew((rate >> 16) & 0xFFFF, priv->rtc_base + REG_RTC_FREQ_CW_H);
+
+     reg = readw(priv->rtc_base + REG_RTC_CTRL);
+     reg |= CNT_EN_BIT;
Quoted 8 lines

Review

Quoted 2 lines
(quoted diff) +2 -0
+     writew(reg, priv->rtc_base + REG_RTC_CTRL);
+

If on POR, CNT_EN_BIT is not set, then it would be nice to use that to know whether the RTC is properly set. You can then check CNT_EN_BIT in .read_time and return -EINVAL if it is not set. Then you can set the bit in .set_time. It is anyway useless to let the RTC running if it is not set.

Yeah, this is to be sure that the RTC is alive with a valid value (which makes sense).
Ok I will fix everything in v3, then.

Romain

author maintainer
#7 lore raw

PATCH v2 3/3 ARM: dts: mstar: Add rtc device node

In reply to Romain Perier

This adds the definition of the rtc device node. The RTC being able to work with the oscillator at 12Mhz for now, it shares the same xtal than the watchdog.

---
 arch/arm/boot/dts/mstar-v7.dtsi | 7 +++++++
 1 file changed, 7 insertions(+)
arch/arm/boot/dts/mstar-v7.dtsi +7 -0
index 982dba9d28eb..1d4419aee67d 100644
@@ -116,6 +116,13 @@ watchdog@6000 {
 				clocks = <&xtal_div2>;
 			};
 
+			rtc@2400 {
+				compatible = "mstar,msc313-rtc";
+				reg = <0x2400 0x40>;
+				clocks = <&xtal_div2>;
+				interrupts-extended = <&intc_irq GIC_SPI 44 IRQ_TYPE_LEVEL_HIGH>;
+			};
+
 			intc_fiq: interrupt-controller@201310 {
 				compatible = "mstar,mst-intc";
 				reg = <0x201310 0x40>;
Signature · 1 line
2.30.2
#8 lore raw

Re: [PATCH v2 3/3] ARM: dts: mstar: Add rtc device node

Hi Romain,

arch/arm/boot/dts/mstar-v7.dtsi watchdog@6000 { · line 119

Quoted 6 lines · Romain Perier

+++ b/arch/arm/boot/dts/mstar-v7.dtsi

arch/arm/boot/dts/mstar-v7.dtsi +1 -0
@@ -116,6 +116,13 @@ watchdog@6000 {
                                clocks = <&xtal_div2>;
                        };
 
+                       rtc@2400 {

I think the rtc should be before the watchdog as the address is lower. I think maybe this got flipped around during cherry-picking. I can flip it around when I pull this into an mstar dts for 5.15 branch so you don't need to fix it and send a v3 assuming everything else is ok.

Thanks,

Daniel

author maintainer
#9 lore raw

Re: [PATCH v2 3/3] ARM: dts: mstar: Add rtc device node

Hi,

As I need to send a v3, I can fix it, no worries.

Cheers,
Romain

Quoted 20 lines · Daniel Palmer

Hi Romain,

arch/arm/boot/dts/mstar-v7.dtsi watchdog@6000 { · line 119

Quoted 6 lines · Romain Perier

+++ b/arch/arm/boot/dts/mstar-v7.dtsi

arch/arm/boot/dts/mstar-v7.dtsi +1 -0
@@ -116,6 +116,13 @@ watchdog@6000 {
                                clocks = <&xtal_div2>;
                        };
 
+                       rtc@2400 {

I think the rtc should be before the watchdog as the address is lower. I think maybe this got flipped around during cherry-picking. I can flip it around when I pull this into an mstar dts for 5.15 branch so you don't need to fix it and send a v3 assuming everything else is ok.

Thanks,

Daniel