[PATCH] [RTC] Add Freescale MC13783 RTC driver

[PATCH] [RTC] Add Freescale MC13783 RTC driver

[Uwe Kleine-König]

This driver provides support for the RTC part integrated into the
Freescale MC13783 PMIC and bases on patch created earlier by Sascha
Hauer.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Signed-off-by: Uwe Kleine-K?nig <u.kleine-k?nig@pengutronix.de>
Cc: Valentin Longchamp <valentin.longchamp@epfl.ch>
Cc: Paul Gortmaker <p_gortmaker@yahoo.com>
Cc: Alessandro Zummo <a.zummo@towertech.it>
Cc: rtc-linux at googlegroups.com
---
Hello,

this patch depends on

	mfd/mc13783: near complete rewrite

sent earlier on lkml[1].  Compared to the earlier version of rtc support
on mc13783 as sent by Sascha, this driver got reset detection and
therefore depends on the patch above.

A tree runnable on Phytec's PCM038 is available in my git tree

	git://git.pengutronix.de/git/ukl/linux-2.6.git mc13783

.  (Maybe I will rewrite these commits, so please expect it might change
in a non-fast-forward manner.)

Best regards
Uwe

[1] http://mid.gmane.org/1256330323-13300-1-git-send-email-u.kleine-koenig at pengutronix.de

 drivers/rtc/Kconfig       |    6 +
 drivers/rtc/Makefile      |    1 +
 drivers/rtc/rtc-mc13783.c |  262 +++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 269 insertions(+), 0 deletions(-)
 create mode 100644 drivers/rtc/rtc-mc13783.c

diff --git a/drivers/rtc/Kconfig b/drivers/rtc/Kconfig
index 3c20dae..7fa8db3 100644
--- a/drivers/rtc/Kconfig
+++ b/drivers/rtc/Kconfig
@@ -827,4 +827,10 @@ config RTC_DRV_PCAP
 	  If you say Y here you will get support for the RTC found on
 	  the PCAP2 ASIC used on some Motorola phones.
 
+config RTC_DRV_MC13783
+	depends on MFD_MC13783
+	tristate "Freescale MC13783 RTC"
+	help
+	  This enables support for the Freescale MC13783 PMIC RTC
+
 endif # RTC_CLASS
diff --git a/drivers/rtc/Makefile b/drivers/rtc/Makefile
index aa3fbd5..f4d01ba 100644
--- a/drivers/rtc/Makefile
+++ b/drivers/rtc/Makefile
@@ -52,6 +52,7 @@ obj-$(CONFIG_RTC_DRV_M48T86)	+= rtc-m48t86.o
 obj-$(CONFIG_RTC_MXC)		+= rtc-mxc.o
 obj-$(CONFIG_RTC_DRV_MAX6900)	+= rtc-max6900.o
 obj-$(CONFIG_RTC_DRV_MAX6902)	+= rtc-max6902.o
+obj-$(CONFIG_RTC_DRV_MC13783)	+= rtc-mc13783.o
 obj-$(CONFIG_RTC_DRV_MV)	+= rtc-mv.o
 obj-$(CONFIG_RTC_DRV_OMAP)	+= rtc-omap.o
 obj-$(CONFIG_RTC_DRV_PCAP)	+= rtc-pcap.o
diff --git a/drivers/rtc/rtc-mc13783.c b/drivers/rtc/rtc-mc13783.c
new file mode 100644
index 0000000..7a1019e
--- /dev/null
+++ b/drivers/rtc/rtc-mc13783.c
@@ -0,0 +1,262 @@
+/*
+ * Real Time Clock driver for Freescale MC13783 PMIC
+ *
+ * (C) 2009 Sascha Hauer, Pengutronix
+ * (C) 2009 Uwe Kleine-Koenig, Pengutronix
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ */
+
+#include <linux/mfd/mc13783.h>
+#include <linux/platform_device.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/rtc.h>
+
+#define DRIVER_NAME "mc13783-rtc"
+
+#define MC13783_RTCTOD	20
+#define MC13783_RTCTODA	21
+#define MC13783_RTCDAY	22
+#define MC13783_RTCDAYA	23
+
+struct mc13783_rtc {
+	struct rtc_device *rtc;
+	struct mc13783 *mc13783;
+	int valid;
+};
+
+static int mc13783_rtc_read_time(struct device *dev, struct rtc_time *tm)
+{
+	struct mc13783_rtc *priv = dev_get_drvdata(dev);
+	unsigned int seconds, days1, days2;
+	unsigned long s1970;
+	int ret;
+
+	mc13783_lock(priv->mc13783);
+
+	if (!priv->valid) {
+		ret = -ENODATA;
+		goto out;
+	}
+
+	ret = mc13783_reg_read(priv->mc13783, MC13783_RTCDAY, &days1);
+	if (unlikely(ret))
+		goto out;
+
+	ret = mc13783_reg_read(priv->mc13783, MC13783_RTCTOD, &seconds);
+	if (unlikely(ret))
+		goto out;
+
+	ret = mc13783_reg_read(priv->mc13783, MC13783_RTCDAY, &days2);
+out:
+	mc13783_unlock(priv->mc13783);
+
+	if (ret)
+		return ret;
+
+	if (days2 == days1 + 1) {
+		if (seconds >= 86400 / 2)
+			days2 = days1;
+		else
+			days1 = days2;
+	}
+
+	if (days1 != days2)
+		return -EIO;
+
+	s1970 = days1 * 86400 + seconds;
+
+	rtc_time_to_tm(s1970, tm);
+
+	return rtc_valid_tm(tm);
+}
+
+static int mc13783_rtc_set_mmss(struct device *dev, unsigned long secs)
+{
+	struct mc13783_rtc *priv = dev_get_drvdata(dev);
+	unsigned int seconds, days;
+	int ret;
+
+	seconds = secs % 86400;
+	days = secs / 86400;
+
+	mc13783_lock(priv->mc13783);
+
+	/*
+	 * first write seconds=0 to prevent a day switch between writing days
+	 * and seconds below
+	 */
+	ret = mc13783_reg_write(priv->mc13783, MC13783_RTCTOD, 0);
+	if (unlikely(ret))
+		goto out;
+
+	ret = mc13783_reg_write(priv->mc13783, MC13783_RTCDAY, days);
+	if (unlikely(ret))
+		goto out;
+
+	ret = mc13783_reg_write(priv->mc13783, MC13783_RTCTOD, seconds);
+	if (unlikely(ret))
+		goto out;
+
+	ret = mc13783_ackirq(priv->mc13783, MC13783_IRQ_RTCRST);
+	if (unlikely(ret))
+		goto out;
+
+	ret = mc13783_unmask(priv->mc13783, MC13783_IRQ_RTCRST);
+out:
+	priv->valid = !ret;
+
+	mc13783_unlock(priv->mc13783);
+
+	return ret;
+}
+
+static irqreturn_t mc13783_rtc_update_handler(struct mc13783 *mc13783,
+		unsigned int irq, void *dev)
+{
+	struct mc13783_rtc *priv = dev;
+
+	dev_dbg(&priv->rtc->dev, "1HZ\n");
+
+	rtc_update_irq(priv->rtc, 1, RTC_IRQF | RTC_UF);
+
+	mc13783_ackirq(mc13783, irq);
+
+	return IRQ_HANDLED;
+}
+
+static int mc13783_rtc_update_irq_enable(struct device *dev,
+		unsigned int enabled)
+{
+	struct mc13783_rtc *priv = dev_get_drvdata(dev);
+	int ret = -ENODATA;
+
+	mc13783_lock(priv->mc13783);
+	if (!priv->valid)
+		goto out;
+
+	ret = (enabled ? mc13783_unmask : mc13783_mask)(priv->mc13783,
+			MC13783_IRQ_1HZ);
+out:
+	mc13783_unlock(priv->mc13783);
+
+	return ret;
+}
+
+static const struct rtc_class_ops mc13783_rtc_ops = {
+	.read_time = mc13783_rtc_read_time,
+	.set_mmss = mc13783_rtc_set_mmss,
+	.update_irq_enable = mc13783_rtc_update_irq_enable,
+};
+
+static irqreturn_t mc13783_rtc_reset_handler(struct mc13783 *mc13783,
+		unsigned int irq, void *dev)
+{
+	struct mc13783_rtc *priv = dev;
+
+	dev_dbg(&priv->rtc->dev, "RTCRST\n");
+	priv->valid = 0;
+
+	mc13783_mask(mc13783, irq);
+
+	return IRQ_HANDLED;
+}
+
+static int __devinit mc13783_rtc_probe(struct platform_device *pdev)
+{
+	int ret;
+	struct mc13783_rtc *priv;
+
+	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
+	if (!priv)
+		return -ENOMEM;
+
+	priv->mc13783 = dev_get_drvdata(pdev->dev.parent);
+	platform_set_drvdata(pdev, priv);
+
+	priv->valid = 1;
+
+	mc13783_lock(priv->mc13783);
+
+	ret = mc13783_irq_request(priv->mc13783, MC13783_IRQ_RTCRST,
+			mc13783_rtc_reset_handler, DRIVER_NAME, priv);
+	if (ret)
+		goto err_reset_irq_request;
+
+	ret = mc13783_irq_request_nounmask(priv->mc13783, MC13783_IRQ_1HZ,
+			mc13783_rtc_update_handler, DRIVER_NAME, priv);
+	if (ret)
+		goto err_update_irq_request;
+
+	mc13783_unlock(priv->mc13783);
+
+	priv->rtc = rtc_device_register(pdev->name,
+			&pdev->dev, &mc13783_rtc_ops, THIS_MODULE);
+
+	if (IS_ERR(priv->rtc)) {
+		ret = PTR_ERR(priv->rtc);
+
+		mc13783_lock(priv->mc13783);
+
+		mc13783_irq_free(priv->mc13783, MC13783_IRQ_1HZ, priv);
+err_update_irq_request:
+
+		mc13783_irq_free(priv->mc13783, MC13783_IRQ_RTCRST, priv);
+err_reset_irq_request:
+
+		mc13783_unlock(priv->mc13783);
+
+		platform_set_drvdata(pdev, NULL);
+		kfree(priv);
+	}
+
+	return ret;
+}
+
+static int __devexit mc13783_rtc_remove(struct platform_device *pdev)
+{
+	struct mc13783_rtc *priv = platform_get_drvdata(pdev);
+
+	rtc_device_unregister(priv->rtc);
+
+	mc13783_lock(priv->mc13783);
+
+	mc13783_irq_free(priv->mc13783, MC13783_IRQ_1HZ, priv);
+	mc13783_irq_free(priv->mc13783, MC13783_IRQ_RTCRST, priv);
+
+	mc13783_unlock(priv->mc13783);
+
+	platform_set_drvdata(pdev, NULL);
+
+	kfree(priv);
+
+	return 0;
+}
+
+static struct platform_driver mc13783_rtc_driver = {
+	.remove = __devexit_p(mc13783_rtc_remove),
+	.driver = {
+		.name = DRIVER_NAME,
+		.owner = THIS_MODULE,
+	},
+};
+
+static int __init mc13783_rtc_init(void)
+{
+	return platform_driver_probe(&mc13783_rtc_driver, &mc13783_rtc_probe);
+}
+module_init(mc13783_rtc_init);
+
+static void __exit mc13783_rtc_exit(void)
+{
+	platform_driver_unregister(&mc13783_rtc_driver);
+}
+module_exit(mc13783_rtc_exit);
+
+MODULE_AUTHOR("Sascha Hauer <s.hauer@pengutronix.de>");
+MODULE_DESCRIPTION("RTC driver for Freescale MC13783 PMIC");
+MODULE_LICENSE("GPL v2");
+MODULE_ALIAS("platform:" DRIVER_NAME);
-- 
1.6.5

[PATCH] [RTC] Add Freescale MC13783 RTC driver

[Uwe Kleine-König]

Hello,

On Sat, Oct 24, 2009 at 10:35:42AM +0200, Uwe Kleine-K?nig wrote:
> This driver provides support for the RTC part integrated into the
> Freescale MC13783 PMIC and bases on patch created earlier by Sascha
> Hauer.
> 
> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
> Signed-off-by: Uwe Kleine-K?nig <u.kleine-k?nig@pengutronix.de>
> Cc: Valentin Longchamp <valentin.longchamp@epfl.ch>
> Cc: Paul Gortmaker <p_gortmaker@yahoo.com>
> Cc: Alessandro Zummo <a.zummo@towertech.it>
> Cc: rtc-linux at googlegroups.com
> ---
> Hello,
> 
> this patch depends on
> 
> 	mfd/mc13783: near complete rewrite
> 
> sent earlier on lkml[1].  Compared to the earlier version of rtc support
> on mc13783 as sent by Sascha, this driver got reset detection and
> therefore depends on the patch above.
> 
> A tree runnable on Phytec's PCM038 is available in my git tree
> 
> 	git://git.pengutronix.de/git/ukl/linux-2.6.git mc13783
> 
> .  (Maybe I will rewrite these commits, so please expect it might change
> in a non-fast-forward manner.)

Valentin, could you already test this?  Any comments by the others?

Best regards
Uwe

-- 
Pengutronix e.K.                              | Uwe Kleine-K?nig            |
Industrial Linux Solutions                    | http://www.pengutronix.de/  |

[PATCH] [RTC] Add Freescale MC13783 RTC driver

[Uwe Kleine-König]

Hello,

On Sat, Oct 24, 2009 at 10:35:42AM +0200, Uwe Kleine-K?nig wrote:
> This driver provides support for the RTC part integrated into the
> Freescale MC13783 PMIC and bases on patch created earlier by Sascha
> Hauer.
> 
> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
> Signed-off-by: Uwe Kleine-K?nig <u.kleine-k?nig@pengutronix.de>
> Cc: Valentin Longchamp <valentin.longchamp@epfl.ch>
> Cc: Paul Gortmaker <p_gortmaker@yahoo.com>
> Cc: Alessandro Zummo <a.zummo@towertech.it>
> Cc: rtc-linux at googlegroups.com
> ---
> Hello,
> 
> this patch depends on
> 
> 	mfd/mc13783: near complete rewrite
> 
> sent earlier on lkml[1].  Compared to the earlier version of rtc support
> on mc13783 as sent by Sascha, this driver got reset detection and
> therefore depends on the patch above.
> 
> A tree runnable on Phytec's PCM038 is available in my git tree
> 
> 	git://git.pengutronix.de/git/ukl/linux-2.6.git mc13783
> 
> .  (Maybe I will rewrite these commits, so please expect it might change
> in a non-fast-forward manner.)
This happend now.  Based on feed-back for the mc13783-core driver I had
to modify the rtc-driver to.  Only the signature of the irq handler
function changed.

I don't consider that change worth to repost, so if you're interested
please check out my branch.

Best regards
Uwe

-- 
Pengutronix e.K.                              | Uwe Kleine-K?nig            |
Industrial Linux Solutions                    | http://www.pengutronix.de/  |

[PATCH] [RTC] Add Freescale MC13783 RTC driver

[Valentin Longchamp]

Hi Uwe,

Uwe Kleine-K?nig wrote:
> Hello,
> 
> On Sat, Oct 24, 2009 at 10:35:42AM +0200, Uwe Kleine-K?nig wrote:
>> This driver provides support for the RTC part integrated into the
>> Freescale MC13783 PMIC and bases on patch created earlier by Sascha
>> Hauer.
>>
>> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
>> Signed-off-by: Uwe Kleine-K?nig <u.kleine-k?nig@pengutronix.de>
>> Cc: Valentin Longchamp <valentin.longchamp@epfl.ch>
>> Cc: Paul Gortmaker <p_gortmaker@yahoo.com>
>> Cc: Alessandro Zummo <a.zummo@towertech.it>
>> Cc: rtc-linux at googlegroups.com
>> ---
>> Hello,
>>
>> this patch depends on
>>
>> 	mfd/mc13783: near complete rewrite
>>
>> sent earlier on lkml[1].  Compared to the earlier version of rtc support
>> on mc13783 as sent by Sascha, this driver got reset detection and
>> therefore depends on the patch above.
>>
>> A tree runnable on Phytec's PCM038 is available in my git tree
>>
>> 	git://git.pengutronix.de/git/ukl/linux-2.6.git mc13783
>>
>> .  (Maybe I will rewrite these commits, so please expect it might change
>> in a non-fast-forward manner.)
> 
> Valentin, could you already test this?  Any comments by the others?
> 

I have tested your patches (taken your mc13783 branch today, and merged 
it into my patches rebased on 2.6.32-rc6).

Your mfd/mc13783 rewrite seems to work for me (but since there is no 
real usage for now, I don't use ADC yet and regulator don't do a lot). 
But it runs fine on my hardware.

However, I get the hctosys: unable to read the hardware clock error 
message at boot (from drivers/rtc/hctosys.c:62). Is it normal ?

Furthermore, the date and time are saved during system off, but the time 
is not updated: if I shut down the system during 10 minutes, my time 
will get a 10 minute delay. Is this a normal behavior with you current 
implementation or is there something we have wrong in our design/code 
(we have battery for the mc13783) ? I will have a further look at this 
later, didn't have time now.

Val

-- 
Valentin Longchamp, PhD Student, EPFL-STI-LSRO1
valentin.longchamp at epfl.ch, Phone: +41216937827
http://people.epfl.ch/valentin.longchamp
MEA3485, Station 9, CH-1015 Lausanne

[PATCH] [RTC] Add Freescale MC13783 RTC driver

[Valentin Longchamp]

Valentin Longchamp wrote:
> Hi Uwe,
> 
> Uwe Kleine-K?nig wrote:
>> Hello,
>>
>> On Sat, Oct 24, 2009 at 10:35:42AM +0200, Uwe Kleine-K?nig wrote:
>>> This driver provides support for the RTC part integrated into the
>>> Freescale MC13783 PMIC and bases on patch created earlier by Sascha
>>> Hauer.
>>>
>>> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
>>> Signed-off-by: Uwe Kleine-K?nig <u.kleine-k?nig@pengutronix.de>
>>> Cc: Valentin Longchamp <valentin.longchamp@epfl.ch>
>>> Cc: Paul Gortmaker <p_gortmaker@yahoo.com>
>>> Cc: Alessandro Zummo <a.zummo@towertech.it>
>>> Cc: rtc-linux at googlegroups.com
>>> ---
>>> Hello,
>>>
>>> this patch depends on
>>>
>>> 	mfd/mc13783: near complete rewrite
>>>
>>> sent earlier on lkml[1].  Compared to the earlier version of rtc support
>>> on mc13783 as sent by Sascha, this driver got reset detection and
>>> therefore depends on the patch above.
>>>
>>> A tree runnable on Phytec's PCM038 is available in my git tree
>>>
>>> 	git://git.pengutronix.de/git/ukl/linux-2.6.git mc13783
>>>
>>> .  (Maybe I will rewrite these commits, so please expect it might change
>>> in a non-fast-forward manner.)
>> Valentin, could you already test this?  Any comments by the others?
>>
> 
> I have tested your patches (taken your mc13783 branch today, and merged 
> it into my patches rebased on 2.6.32-rc6).
> 
> Your mfd/mc13783 rewrite seems to work for me (but since there is no 
> real usage for now, I don't use ADC yet and regulator don't do a lot). 
> But it runs fine on my hardware.
> 
> However, I get the hctosys: unable to read the hardware clock error 
> message at boot (from drivers/rtc/hctosys.c:62). Is it normal ?
> 
> Furthermore, the date and time are saved during system off, but the time 
> is not updated: if I shut down the system during 10 minutes, my time 
> will get a 10 minute delay. Is this a normal behavior with you current 
> implementation or is there something we have wrong in our design/code 
> (we have battery for the mc13783) ? I will have a further look at this 
> later, didn't have time now.
> 

This was due to a small hardware problem on our platform. Your RTC 
driver now works well on mx31moboard. Please consider my ackey-by:

Ackey-by: Valentin Longchamp <valentin.longchamp@epfl.ch>

Val

-- 
Valentin Longchamp, PhD Student, EPFL-STI-LSRO1
valentin.longchamp at epfl.ch, Phone: +41216937827
http://people.epfl.ch/valentin.longchamp
MEA3485, Station 9, CH-1015 Lausanne