Patchwork [8/9] rtc: Philips/NXP PCF2123 driver

login
register
mail settings
Submitter Alessandro Zummo
Date June 20, 2009, 4:09 p.m.
Message ID <20090620160919.6953.41552.stgit@i1501.lan.towertech.it>
Download mbox | patch
Permalink /patch/28940/
State Accepted
Headers show

Comments

Alessandro Zummo - June 20, 2009, 4:09 p.m.
From: Chris Verges <chrisv@cyberswitching.com>

Here's a patch for the Philips/NXP PCF2123 RTC.

This code successfully compiles both as built-in and as a module.  I
welcome any feedback, so please look it over and forward any comments!
Our hardware should arrive in early July, so I'll update (v0.3?) based
on testing after that.

Signed-off-by: Chris Verges <chrisv@cyberswitching.com>
Signed-off-by: Alessandro Zummo <a.zummo@towertech.it>
---

 drivers/rtc/Kconfig       |    9 ++
 drivers/rtc/Makefile      |    1 
 drivers/rtc/rtc-pcf2123.c |  245 +++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 255 insertions(+), 0 deletions(-)
 create mode 100644 drivers/rtc/rtc-pcf2123.c



--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to "rtc-linux".
Membership options at http://groups.google.com/group/rtc-linux .
Please read http://groups.google.com/group/rtc-linux/web/checklist
before submitting a driver.
-~----------~----~----~----~------~----~------~--~---
Andrew Morton - June 26, 2009, 11:07 p.m.
On Sat, 20 Jun 2009 18:09:19 +0200
Alessandro Zummo <a.zummo@towertech.it> wrote:

> From: Chris Verges <chrisv@cyberswitching.com>
> 
> Here's a patch for the Philips/NXP PCF2123 RTC.
> 
> This code successfully compiles both as built-in and as a module.  I
> welcome any feedback, so please look it over and forward any comments!
> Our hardware should arrive in early July, so I'll update (v0.3?) based
> on testing after that.
> 
> Signed-off-by: Chris Verges <chrisv@cyberswitching.com>
> Signed-off-by: Alessandro Zummo <a.zummo@towertech.it>
> ---
> 
>  drivers/rtc/Kconfig       |    9 ++
>  drivers/rtc/Makefile      |    1 
>  drivers/rtc/rtc-pcf2123.c |  245 +++++++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 255 insertions(+), 0 deletions(-)
>  create mode 100644 drivers/rtc/rtc-pcf2123.c
> 
> diff --git a/drivers/rtc/Kconfig b/drivers/rtc/Kconfig
> index 723a00c..6248c1d 100644
> --- a/drivers/rtc/Kconfig
> +++ b/drivers/rtc/Kconfig
> @@ -224,6 +224,15 @@ config RTC_DRV_PCF8583
>  	  This driver can also be built as a module. If so, the module
>  	  will be called rtc-pcf8583.
>  
> +config RTC_DRV_PCF2123
> +	tristate "NXP PCF2123"
> +	help
> +	  If you say yes here you get support for the NXP PCF2123
> +	  RTC chip.
> +
> +	  This driver can also be built as a module. If so, the module
> +	  will be called rtc-pcf2123.

This has no dependencies?

If has an I2C dependency due to position in Kconfig, but no SPI
dependency, for example.

Please check.

>  config RTC_DRV_M41T80
>  	tristate "ST M41T62/65/M41T80/81/82/83/84/85/87"
>  	help
>
> ...
>
> +static int __devinit pcf2123_probe(struct spi_device *spi)
> +{
> +	struct rtc_device *rtc;
> +	struct pcf2123_plat_data *pdata;
> +	u8 txbuf[2], rxbuf[1];
> +	int ret;
> +
> +	pdata = kzalloc(sizeof(struct pcf2123_plat_data), GFP_KERNEL);
> +	if (!pdata)
> +		return -ENOMEM;
> +	spi->dev.platform_data = pdata;
> +
> +	/* Send a software reset command */
> +	txbuf[0] = PCF2123_CMD_W(PCF2123_REG_CTRL1);
> +	txbuf[1] = 0x58;
> +	ret = spi_write(spi, txbuf, sizeof(txbuf));
> +	udelay(30); /* Trec 30us */
> +	if (ret < 0)
> +		return ret;
> +
> +	/* Stop the counter */
> +	txbuf[0] = PCF2123_CMD_W(PCF2123_REG_CTRL1);
> +	txbuf[1] = 0x20;
> +	ret = spi_write(spi, txbuf, sizeof(txbuf));
> +	udelay(30); /* Trec 30us */

What's "Trec"?

> +	if (ret < 0)
> +		return ret;

We could do this before the delay and save 30 usecs ;)

> +	/* See if the counter was actually stopped */
> +	txbuf[0] = PCF2123_CMD_R(PCF2123_REG_CTRL1);
> +	ret = spi_write_then_read(spi, txbuf, 1, rxbuf, sizeof(rxbuf));
> +	udelay(30); /* Trec 30us */
> +	if (ret < 0)
> +		goto kfree_exit;

dittoes

> +	if (!(rxbuf[0] & 0x20)) {
> +		dev_err(&spi->dev, "not found.\n");
> +		goto kfree_exit;
> +	}
> +
> +	dev_info(&spi->dev, "chip found, driver version " DRV_VERSION "\n");
> +	dev_info(&spi->dev, "spiclk %u KHz.\n",
> +			(spi->max_speed_hz + 500) / 1000);
> +
> +	/* Start the counter */
> +	txbuf[0] = PCF2123_CMD_W(PCF2123_REG_CTRL1);
> +	txbuf[1] = 0x00;
> +	ret = spi_write(spi, txbuf, sizeof(txbuf));
> +	udelay(30); /* Trec 30us */
> +	if (ret < 0)
> +		goto kfree_exit;
> +
> +	/* Finalize the initialization */
> +	rtc = rtc_device_register(pcf2123_driver.driver.name, &spi->dev,
> +			&pcf2123_rtc_ops, THIS_MODULE);
> +
> +	if (IS_ERR(rtc)) {
> +		ret = PTR_ERR(rtc);
> +		goto kfree_exit;
> +	}
> +
> +	pdata->rtc = rtc;
> +
> +	return 0;
> +kfree_exit:
> +	kfree(pdata);
> +	return ret;
> +}
>
> ...
>


--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to "rtc-linux".
Membership options at http://groups.google.com/group/rtc-linux .
Please read http://groups.google.com/group/rtc-linux/web/checklist
before submitting a driver.
-~----------~----~----~----~------~----~------~--~---
Chris Verges - June 27, 2009, 7:06 p.m.
> *snipped*

Hi Andrew,

Thanks for your feedback!  Definitely right on the dependencies missing from Kconfig -- should require SPI at the least.  I'll add in some better comments regarding Trec, too; it's from the PCF2123 datasheet, but extra explanation would be good.

I should have an updated version for you sometime next week -- currently traveling.

Thanks again,
Chris

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to "rtc-linux".
Membership options at http://groups.google.com/group/rtc-linux .
Please read http://groups.google.com/group/rtc-linux/web/checklist
before submitting a driver.
-~----------~----~----~----~------~----~------~--~---

Patch

diff --git a/drivers/rtc/Kconfig b/drivers/rtc/Kconfig
index 723a00c..6248c1d 100644
--- a/drivers/rtc/Kconfig
+++ b/drivers/rtc/Kconfig
@@ -224,6 +224,15 @@  config RTC_DRV_PCF8583
 	  This driver can also be built as a module. If so, the module
 	  will be called rtc-pcf8583.
 
+config RTC_DRV_PCF2123
+	tristate "NXP PCF2123"
+	help
+	  If you say yes here you get support for the NXP PCF2123
+	  RTC chip.
+
+	  This driver can also be built as a module. If so, the module
+	  will be called rtc-pcf2123.
+
 config RTC_DRV_M41T80
 	tristate "ST M41T62/65/M41T80/81/82/83/84/85/87"
 	help
diff --git a/drivers/rtc/Makefile b/drivers/rtc/Makefile
index 2150a17..4e607bf 100644
--- a/drivers/rtc/Makefile
+++ b/drivers/rtc/Makefile
@@ -55,6 +55,7 @@  obj-$(CONFIG_RTC_DRV_MV)	+= rtc-mv.o
 obj-$(CONFIG_RTC_DRV_OMAP)	+= rtc-omap.o
 obj-$(CONFIG_RTC_DRV_PCF8563)	+= rtc-pcf8563.o
 obj-$(CONFIG_RTC_DRV_PCF8583)	+= rtc-pcf8583.o
+obj-$(CONFIG_RTC_DRV_PCF2123)	+= rtc-pcf2123.o
 obj-$(CONFIG_RTC_DRV_PL030)	+= rtc-pl030.o
 obj-$(CONFIG_RTC_DRV_PL031)	+= rtc-pl031.o
 obj-$(CONFIG_RTC_DRV_GENERIC)	+= rtc-generic.o
diff --git a/drivers/rtc/rtc-pcf2123.c b/drivers/rtc/rtc-pcf2123.c
new file mode 100644
index 0000000..2705ea1
--- /dev/null
+++ b/drivers/rtc/rtc-pcf2123.c
@@ -0,0 +1,245 @@ 
+/*
+ * An SPI driver for the Philips PCF2123 RTC
+ * Copyright 2009 Cyber Switching, Inc.
+ *
+ * Author: Chris Verges <chrisv@cyberswitching.com>
+ * Maintainers: http://www.cyberswitching.com
+ *
+ * based on the RS5C348 driver in this same directory.
+ *
+ * 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/bcd.h>
+#include <linux/delay.h>
+#include <linux/device.h>
+#include <linux/errno.h>
+#include <linux/init.h>
+#include <linux/kernel.h>
+#include <linux/string.h>
+#include <linux/rtc.h>
+#include <linux/workqueue.h>
+#include <linux/spi/spi.h>
+
+#define DRV_VERSION "0.2"
+
+#define PCF2123_REG_CTRL1	0x00 /* Control Register 1 */
+#define PCF2123_REG_CTRL2	0x01 /* Control Register 2 */
+
+#define PCF2123_REG_SC		0x02 /* datetime */
+#define PCF2123_REG_MN		0x03
+#define PCF2123_REG_HR		0x04
+#define PCF2123_REG_DM		0x05
+#define PCF2123_REG_DW		0x06
+#define PCF2123_REG_MO		0x07
+#define PCF2123_REG_YR		0x08
+
+#define PCF2123_CMD_W(addr)	(((addr) & 0x0F) | 0x40)  /* single write */
+#define PCF2123_CMD_R(addr)	(((addr) & 0x0F) | 0x90)  /* single read */
+
+static struct spi_driver pcf2123_driver;
+
+struct pcf2123_plat_data {
+	struct rtc_device *rtc;
+};
+
+static int pcf2123_rtc_read_time(struct device *dev, struct rtc_time *tm)
+{
+	struct spi_device *spi = to_spi_device(dev);
+	u8 txbuf[1], rxbuf[7];
+	int ret;
+
+	txbuf[0] = PCF2123_CMD_R(PCF2123_REG_SC);
+	ret = spi_write_then_read(spi, txbuf, sizeof(txbuf),
+			rxbuf, sizeof(rxbuf));
+	udelay(30); /* Trec 30us */
+	if (ret < 0)
+		return ret;
+
+	tm->tm_sec = bcd2bin(rxbuf[0] & 0x7F);
+	tm->tm_min = bcd2bin(rxbuf[1] & 0x7F);
+	tm->tm_hour = bcd2bin(rxbuf[2] & 0x3F); /* rtc hr 0-23 */
+	tm->tm_mday = bcd2bin(rxbuf[3] & 0x3F);
+	tm->tm_wday = rxbuf[4] & 0x07;
+	tm->tm_mon = bcd2bin(rxbuf[5] & 0x1F) - 1; /* rtc mn 1-12 */
+	tm->tm_year = bcd2bin(rxbuf[6]);
+	if (tm->tm_year < 70)
+		tm->tm_year += 100;	/* assume we are in 1970...2069 */
+
+	dev_dbg(dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
+			"mday=%d, mon=%d, year=%d, wday=%d\n",
+			__func__,
+			tm->tm_sec, tm->tm_min, tm->tm_hour,
+			tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
+
+	/* the clock can give out invalid datetime, but we cannot return
+	 * -EINVAL otherwise hwclock will refuse to set the time on bootup.
+	 */
+	if (rtc_valid_tm(tm) < 0)
+		dev_err(dev, "retrieved date/time is not valid.\n");
+
+	return 0;
+}
+
+static int pcf2123_rtc_set_time(struct device *dev, struct rtc_time *tm)
+{
+	struct spi_device *spi = to_spi_device(dev);
+	u8 txbuf[8];
+	int ret;
+
+	dev_dbg(dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
+			"mday=%d, mon=%d, year=%d, wday=%d\n",
+			__func__,
+			tm->tm_sec, tm->tm_min, tm->tm_hour,
+			tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
+
+	/* Stop the counter first */
+	txbuf[0] = PCF2123_CMD_W(PCF2123_REG_CTRL1);
+	txbuf[1] = 0x20;
+	ret = spi_write(spi, txbuf, 2);
+	udelay(30); /* Trec 30us */
+	if (ret < 0)
+		return ret;
+
+	/* Set the new time */
+	txbuf[0] = PCF2123_CMD_W(PCF2123_REG_SC);
+	txbuf[1] = bin2bcd(tm->tm_sec & 0x7F);
+	txbuf[2] = bin2bcd(tm->tm_min & 0x7F);
+	txbuf[3] = bin2bcd(tm->tm_hour & 0x3F);
+	txbuf[4] = bin2bcd(tm->tm_mday & 0x3F);
+	txbuf[5] = tm->tm_wday & 0x07;
+	txbuf[6] = bin2bcd((tm->tm_mon + 1) & 0x1F); /* rtc mn 1-12 */
+	txbuf[7] = bin2bcd(tm->tm_year < 100 ? tm->tm_year : tm->tm_year - 100);
+
+	ret = spi_write(spi, txbuf, sizeof(txbuf));
+	udelay(30); /* Trec 30us */
+	if (ret < 0)
+		return ret;
+
+	/* Start the counter */
+	txbuf[0] = PCF2123_CMD_W(PCF2123_REG_CTRL1);
+	txbuf[1] = 0x00;
+	ret = spi_write(spi, txbuf, 2);
+	udelay(30); /* Trec 30us */
+	if (ret < 0)
+		return ret;
+
+	return 0;
+}
+
+static const struct rtc_class_ops pcf2123_rtc_ops = {
+	.read_time	= pcf2123_rtc_read_time,
+	.set_time	= pcf2123_rtc_set_time,
+};
+
+static int __devinit pcf2123_probe(struct spi_device *spi)
+{
+	struct rtc_device *rtc;
+	struct pcf2123_plat_data *pdata;
+	u8 txbuf[2], rxbuf[1];
+	int ret;
+
+	pdata = kzalloc(sizeof(struct pcf2123_plat_data), GFP_KERNEL);
+	if (!pdata)
+		return -ENOMEM;
+	spi->dev.platform_data = pdata;
+
+	/* Send a software reset command */
+	txbuf[0] = PCF2123_CMD_W(PCF2123_REG_CTRL1);
+	txbuf[1] = 0x58;
+	ret = spi_write(spi, txbuf, sizeof(txbuf));
+	udelay(30); /* Trec 30us */
+	if (ret < 0)
+		return ret;
+
+	/* Stop the counter */
+	txbuf[0] = PCF2123_CMD_W(PCF2123_REG_CTRL1);
+	txbuf[1] = 0x20;
+	ret = spi_write(spi, txbuf, sizeof(txbuf));
+	udelay(30); /* Trec 30us */
+	if (ret < 0)
+		return ret;
+
+	/* See if the counter was actually stopped */
+	txbuf[0] = PCF2123_CMD_R(PCF2123_REG_CTRL1);
+	ret = spi_write_then_read(spi, txbuf, 1, rxbuf, sizeof(rxbuf));
+	udelay(30); /* Trec 30us */
+	if (ret < 0)
+		goto kfree_exit;
+
+	if (!(rxbuf[0] & 0x20)) {
+		dev_err(&spi->dev, "not found.\n");
+		goto kfree_exit;
+	}
+
+	dev_info(&spi->dev, "chip found, driver version " DRV_VERSION "\n");
+	dev_info(&spi->dev, "spiclk %u KHz.\n",
+			(spi->max_speed_hz + 500) / 1000);
+
+	/* Start the counter */
+	txbuf[0] = PCF2123_CMD_W(PCF2123_REG_CTRL1);
+	txbuf[1] = 0x00;
+	ret = spi_write(spi, txbuf, sizeof(txbuf));
+	udelay(30); /* Trec 30us */
+	if (ret < 0)
+		goto kfree_exit;
+
+	/* Finalize the initialization */
+	rtc = rtc_device_register(pcf2123_driver.driver.name, &spi->dev,
+			&pcf2123_rtc_ops, THIS_MODULE);
+
+	if (IS_ERR(rtc)) {
+		ret = PTR_ERR(rtc);
+		goto kfree_exit;
+	}
+
+	pdata->rtc = rtc;
+
+	return 0;
+kfree_exit:
+	kfree(pdata);
+	return ret;
+}
+
+static int pcf2123_remove(struct spi_device *spi)
+{
+	struct pcf2123_plat_data *pdata = spi->dev.platform_data;
+	struct rtc_device *rtc = pdata->rtc;
+
+	if (rtc)
+		rtc_device_unregister(rtc);
+
+	kfree(pdata);
+
+	return 0;
+}
+
+static struct spi_driver pcf2123_driver = {
+	.driver	= {
+			.name	= "rtc-pcf2123",
+			.bus	= &spi_bus_type,
+			.owner	= THIS_MODULE,
+	},
+	.probe	= pcf2123_probe,
+	.remove	= __devexit_p(pcf2123_remove),
+};
+
+static int __init pcf2123_init(void)
+{
+	return spi_register_driver(&pcf2123_driver);
+}
+
+static void __exit pcf2123_exit(void)
+{
+	spi_unregister_driver(&pcf2123_driver);
+}
+
+MODULE_AUTHOR("Chris Verges <chrisv@cyberswitching.com>");
+MODULE_DESCRIPTION("NXP PCF2123 RTC driver");
+MODULE_LICENSE("GPL");
+MODULE_VERSION(DRV_VERSION);
+
+module_init(pcf2123_init);
+module_exit(pcf2123_exit);