Skip to contentSkip to conversation

rtc: Add real-time clock driver for Tegra.

PATCH In review [email protected] 3 participants 3 messages Oct 18, 2010 – Oct 21, 2010

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 rtc: Add real-time clock driver for Tegra.

From: Andrew Chew <[email protected]>

This is a platform driver that supports the built-in real-time clock on Tegra SOCs.

---
Applied Alessandro Zummo's corrections.
Applied Wan ZongShun's corrections.
Jon Mayo addressed comments by Erik Gilling, to wit:
Removed RTC_TEGRA_RETRIES.
Renamed macros to match the prefix used in the rest of the code. Improved function comments to provide more detail.
Implemented the TODO in tegra_rtc_wait_while_busy(), commented. Removed tegra_rtc_write_not_busy.
Fixed several places where tegra_rtc_check_busy() was called before a call to
tegra_rtc_wait_while_busy().
Removed locks on some read-only accesses.
Commented the lock in tegra_rtc_read_time() to explain why it was necessary. Fixed race in tegra_rtc_alarm_irq_enable()
Protect tegra_rtc_irq_handler() with a busy check that uses udelay(). Fixed a race with clearing of all interrupts. Only clear the ones that
activated the interrupt.
Added request_mem_region() (and a corresponding release_mem_region()). Protected tegra_rtc_suspend() with a busy flag check.
In addition:
Removed unnecessary status/interrupt code from tegra_rtc_resume(). Fixed all races and bad behavior with waiting/sleeping between spinlocks.

 drivers/rtc/Kconfig     |   10 +
 drivers/rtc/Makefile    |    1 +
 drivers/rtc/rtc-tegra.c |  488 +++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 499 insertions(+), 0 deletions(-)
 create mode 100644 drivers/rtc/rtc-tegra.c
drivers/rtc/Kconfig +10 -0
index 2432541..ca0da79 100644
@@ -963,4 +963,14 @@ config RTC_DRV_JZ4740
 	  This driver can also be buillt as a module. If so, the module
 	  will be called rtc-jz4740.
 
+config RTC_DRV_TEGRA
+	tristate "NVIDIA Tegra Internal RTC driver"
+	depends on RTC_CLASS && ARCH_TEGRA
+	help
+	  If you say yes here you get support for the
+	  Tegra 200 series internal RTC module.
+
+	  This drive can also be built as a module. If so, the module
+	  will be called rtc-tegra.
+
 endif # RTC_CLASS
drivers/rtc/Makefile +1 -0
index 4ff4b88..a7f3617 100644
@@ -91,6 +91,7 @@ obj-$(CONFIG_RTC_DRV_STARFIRE)	+= rtc-starfire.o
 obj-$(CONFIG_RTC_DRV_STK17TA8)	+= rtc-stk17ta8.o
 obj-$(CONFIG_RTC_DRV_STMP)	+= rtc-stmp3xxx.o
 obj-$(CONFIG_RTC_DRV_SUN4V)	+= rtc-sun4v.o
+obj-$(CONFIG_RTC_DRV_TEGRA)	+= rtc-tegra.o
 obj-$(CONFIG_RTC_DRV_TEST)	+= rtc-test.o
 obj-$(CONFIG_RTC_DRV_TWL4030)	+= rtc-twl.o
 obj-$(CONFIG_RTC_DRV_TX4939)	+= rtc-tx4939.o
drivers/rtc/rtc-tegra.c new file +488 -0

488 lines not on this page · raw message

Signature · 1 line
1.7.0.4
#2 lore raw
In reply to [email protected]
Quoted 18 lines · On Mon, 18 Oct 2010 16:33:16 -0700 [email protected] wrote:

From: Andrew Chew <[email protected]>

This is a platform driver that supports the built-in real-time clock on Tegra SOCs.

...

drivers/rtc/rtc-tegra.c new file +10 -0
+static int tegra_rtc_wait_while_busy(struct device *dev)
+{
+	struct tegra_rtc_info *info = dev_get_drvdata(dev);
+
+	int retries = 500; /* ~490 us is the worst case, ~250 us is best. */
+
+	/* first wait for the RTC to become busy. this is when it
+	 * posts its updated seconds+msec registers to AHB side. */
+	while (tegra_rtc_check_busy(info)) {
+		if (!retries--)

drivers/rtc/rtc-tegra.c line 103

Quoted 10 lines
drivers/rtc/rtc-tegra.c new file +10 -0
+			goto retry_failed;
+		udelay(1);
+	}
+
+	/* now we have about 250 us to manipulate registers */
+	return 0;
+
+retry_failed:
+	dev_err(dev, "write failed:retry count exceeded.\n");
+	return -ETIMEDOUT;

Grumble. Pet peeve.

ETIMEDOUT is a networking error. "Connection attempt timed out". If this errno gets sent back to userspace from an operation against the RTC hardware then the user would be fully entitied to ask WTF? and wonder what we had been smoking.

Also, most callers of tegra_rtc_wait_while_busy() simply ignore this error and proceed pretending that it didn't happen.

drivers/rtc/rtc-tegra.c line 203

Quoted 10 lines
drivers/rtc/rtc-tegra.c new file +7 -0
+}
+
 
...
 
+static int tegra_rtc_alarm_irq_enable(struct device *dev, unsigned int enabled)
+{
+	struct tegra_rtc_info *info = dev_get_drvdata(dev);
+	unsigned status;
+	unsigned long sl_irq_flags;

Plain old "flags" is idiomatic, and sufficient.

Quoted 17 lines
drivers/rtc/rtc-tegra.c new file +17 -0
+	tegra_rtc_wait_while_busy(dev);
+	spin_lock_irqsave(&info->tegra_rtc_lock, sl_irq_flags);
+
+	/* read the original value, and OR in the flag. */
+	status = readl(info->rtc_base + TEGRA_RTC_REG_INTR_MASK);
+	if (enabled)
+		status |= TEGRA_RTC_INTR_MASK_SEC_ALARM0; /* set it */
+	else
+		status &= ~TEGRA_RTC_INTR_MASK_SEC_ALARM0; /* clear it */
+
+	writel(status, info->rtc_base + TEGRA_RTC_REG_INTR_MASK);
+
+	spin_unlock_irqrestore(&info->tegra_rtc_lock, sl_irq_flags);
+
+	return 0;
+}
+

drivers/rtc/rtc-tegra.c line 264

Quoted 10 lines
drivers/rtc/rtc-tegra.c new file +7 -0
 
...
 
+static int tegra_rtc_proc(struct device *dev, struct seq_file *seq)
+{
+	if (!dev || !dev->driver)
+		return 0;
+
+	return seq_printf(seq, "name\t\t: %s\n", dev_name(dev));
+}

hm, what does the rtc_class_ops.proc() handler do? There seems to be no consistency between different drivers which somewhat defeats the purpose of having a standardised RTC framework.

Quoted 20 lines
drivers/rtc/rtc-tegra.c new file +20 -0
+static irqreturn_t tegra_rtc_irq_handler(int irq, void *data)
+{
+	struct device *dev = data;
+	struct tegra_rtc_info *info = dev_get_drvdata(dev);
+	unsigned long events = 0;
+	unsigned status;
+	unsigned long sl_irq_flags;
+
+	status = readl(info->rtc_base + TEGRA_RTC_REG_INTR_STATUS);
+	if (status) {
+		/* clear the interrupt masks and status on any irq. */
+		tegra_rtc_wait_while_busy(dev);
+		spin_lock_irqsave(&info->tegra_rtc_lock, sl_irq_flags);
+		writel(0, info->rtc_base + TEGRA_RTC_REG_INTR_MASK);
+		writel(status, info->rtc_base + TEGRA_RTC_REG_INTR_STATUS);
+		spin_unlock_irqrestore(&info->tegra_rtc_lock, sl_irq_flags);
+	}
+
+	/* check if Alarm */
+	if ((status & TEGRA_RTC_INTR_STATUS_SEC_ALARM0))

drivers/rtc/rtc-tegra.c line 295

Quoted 10 lines
drivers/rtc/rtc-tegra.c new file +10 -0
+		events |= RTC_IRQF | RTC_AF;
+
+	/* check if Periodic */
+	if ((status & TEGRA_RTC_INTR_STATUS_SEC_CDN_ALARM))
+		events |= RTC_IRQF | RTC_PF;
+
+	rtc_update_irq(info->rtc_dev, 1, events);
+
+	return IRQ_HANDLED;
+}

This will return IRQ_HANDLED even if no interrupts were pending. That's a bug if the IRQ is shared, and defeats the kernel's "screaming interrupt" detection logic. Probably it's OK in the context of this device, but it does set a poor example for the kiddies.

Quoted 33 lines

...

drivers/rtc/rtc-tegra.c new file +30 -0
+#ifdef CONFIG_PM
+static int tegra_rtc_suspend(struct platform_device *pdev, pm_message_t state)
+{
+	struct device *dev = &pdev->dev;
+	struct tegra_rtc_info *info = platform_get_drvdata(pdev);
+
+	tegra_rtc_wait_while_busy(dev);
+
+	/* only use ALARM0 as a wake source. */
+	writel(0xffffffff, info->rtc_base + TEGRA_RTC_REG_INTR_STATUS);
+	writel(TEGRA_RTC_INTR_STATUS_SEC_ALARM0,
+		info->rtc_base + TEGRA_RTC_REG_INTR_MASK);
+
+	dev_vdbg(dev, "alarm sec = %d\n",
+		readl(info->rtc_base + TEGRA_RTC_REG_SECONDS_ALARM0));
+
+	dev_vdbg(dev, "Suspend (device_may_wakeup=%d) irq:%d\n",
+		device_may_wakeup(dev), info->tegra_rtc_irq);
+
+	/* leave the alarms on as a wake source. */
+	if (device_may_wakeup(dev))
+		enable_irq_wake(info->tegra_rtc_irq);
+
+	return 0;
+}
+
+static int tegra_rtc_resume(struct platform_device *pdev)
+{
+	struct device *dev = &pdev->dev;
+	struct tegra_rtc_info *info = platform_get_drvdata(pdev);

drivers/rtc/rtc-tegra.c line 452

Quoted 10 lines
drivers/rtc/rtc-tegra.c new file +10 -0
+
+	dev_vdbg(dev, "Resume (device_may_wakeup=%d)\n",
+		device_may_wakeup(dev));
+	/* alarms were left on as a wake source, turn them off. */
+	if (device_may_wakeup(dev))
+		disable_irq_wake(info->tegra_rtc_irq);
+
+	return 0;
+}
+#endif

It's more typical to put

#else
#define tegra_rtc_suspend NULL
#define tegra_rtc_resume NULL
#endif

here

Quoted 8 lines
drivers/rtc/rtc-tegra.c new file +8 -0
+static void tegra_rtc_shutdown(struct platform_device *pdev)
+{
+	dev_vdbg(&pdev->dev, "disabling interrupts.\n");
+	tegra_rtc_alarm_irq_enable(&pdev->dev, 0);
+}
+
+MODULE_ALIAS("platform:tegra_rtc");
+static struct platform_driver tegra_rtc_driver = {

drivers/rtc/rtc-tegra.c line 471

Quoted 10 lines
drivers/rtc/rtc-tegra.c new file +10 -0
+	.remove		= __devexit_p(tegra_rtc_remove),
+	.shutdown	= tegra_rtc_shutdown,
+	.driver		= {
+		.name	= "tegra_rtc",
+		.owner	= THIS_MODULE,
+	},
+#ifdef CONFIG_PM
+	.suspend	= tegra_rtc_suspend,
+	.resume		= tegra_rtc_resume,
+#endif

and to omit this ifdef.

Quoted 5 lines
drivers/rtc/rtc-tegra.c new file +2 -0
+};
+
 
...