[deliverable/linux.git] / drivers / rtc / rtc-pcf8563.c

/*
 * An I2C driver for the Philips PCF8563 RTC
 * Copyright 2005-06 Tower Technologies
 *
 * Author: Alessandro Zummo <a.zummo@towertech.it>
 * Maintainers: http://www.nslu2-linux.org/
 *
 * based on the other drivers in this same directory.
 *
 * http://www.semiconductors.philips.com/acrobat/datasheets/PCF8563-04.pdf
 *
 * 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/i2c.h>
#include <linux/bcd.h>
#include <linux/rtc.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/err.h>

#define DRV_VERSION "0.4.4"

#define PCF8563_REG_ST1		0x00 /* status */
#define PCF8563_REG_ST2		0x01
#define PCF8563_BIT_AIE		(1 << 1)
#define PCF8563_BIT_AF		(1 << 3)
#define PCF8563_BITS_ST2_N	(7 << 5)

#define PCF8563_REG_SC		0x02 /* datetime */
#define PCF8563_REG_MN		0x03
#define PCF8563_REG_HR		0x04
#define PCF8563_REG_DM		0x05
#define PCF8563_REG_DW		0x06
#define PCF8563_REG_MO		0x07
#define PCF8563_REG_YR		0x08

#define PCF8563_REG_AMN		0x09 /* alarm */

#define PCF8563_REG_CLKO	0x0D /* clock out */
#define PCF8563_REG_TMRC	0x0E /* timer control */
#define PCF8563_TMRC_ENABLE	BIT(7)
#define PCF8563_TMRC_4096	0
#define PCF8563_TMRC_64		1
#define PCF8563_TMRC_1		2
#define PCF8563_TMRC_1_60	3
#define PCF8563_TMRC_MASK	3

#define PCF8563_REG_TMR		0x0F /* timer */

#define PCF8563_SC_LV		0x80 /* low voltage */
#define PCF8563_MO_C		0x80 /* century */

static struct i2c_driver pcf8563_driver;

struct pcf8563 {
	struct rtc_device *rtc;
	/*
	 * The meaning of MO_C bit varies by the chip type.
	 * From PCF8563 datasheet: this bit is toggled when the years
	 * register overflows from 99 to 00
	 *   0 indicates the century is 20xx
	 *   1 indicates the century is 19xx
	 * From RTC8564 datasheet: this bit indicates change of
	 * century. When the year digit data overflows from 99 to 00,
	 * this bit is set. By presetting it to 0 while still in the
	 * 20th century, it will be set in year 2000, ...
	 * There seems no reliable way to know how the system use this
	 * bit.  So let's do it heuristically, assuming we are live in
	 * 1970...2069.
	 */
	int c_polarity;	/* 0: MO_C=1 means 19xx, otherwise MO_C=1 means 20xx */
	int voltage_low; /* incicates if a low_voltage was detected */

	struct i2c_client *client;
};

static int pcf8563_read_block_data(struct i2c_client *client, unsigned char reg,
				   unsigned char length, unsigned char *buf)
{
	struct i2c_msg msgs[] = {
		{/* setup read ptr */
			.addr = client->addr,
			.len = 1,
			.buf = &reg,
		},
		{
			.addr = client->addr,
			.flags = I2C_M_RD,
			.len = length,
			.buf = buf
		},
	};

	if ((i2c_transfer(client->adapter, msgs, 2)) != 2) {
		dev_err(&client->dev, "%s: read error\n", __func__);
		return -EIO;
	}

	return 0;
}

static int pcf8563_write_block_data(struct i2c_client *client,
				   unsigned char reg, unsigned char length,
				   unsigned char *buf)
{
	int i, err;

	for (i = 0; i < length; i++) {
		unsigned char data[2] = { reg + i, buf[i] };

		err = i2c_master_send(client, data, sizeof(data));
		if (err != sizeof(data)) {
			dev_err(&client->dev,
				"%s: err=%d addr=%02x, data=%02x\n",
				__func__, err, data[0], data[1]);
			return -EIO;
		}
	}

	return 0;
}

static int pcf8563_set_alarm_mode(struct i2c_client *client, bool on)
{
	unsigned char buf;
	int err;

	err = pcf8563_read_block_data(client, PCF8563_REG_ST2, 1, &buf);
	if (err < 0)
		return err;

	if (on)
		buf |= PCF8563_BIT_AIE;
	else
		buf &= ~PCF8563_BIT_AIE;

	buf &= ~(PCF8563_BIT_AF | PCF8563_BITS_ST2_N);

	err = pcf8563_write_block_data(client, PCF8563_REG_ST2, 1, &buf);
	if (err < 0) {
		dev_err(&client->dev, "%s: write error\n", __func__);
		return -EIO;
	}

	return 0;
}

static int pcf8563_get_alarm_mode(struct i2c_client *client, unsigned char *en,
				  unsigned char *pen)
{
	unsigned char buf;
	int err;

	err = pcf8563_read_block_data(client, PCF8563_REG_ST2, 1, &buf);
	if (err)
		return err;

	if (en)
		*en = !!(buf & PCF8563_BIT_AIE);
	if (pen)
		*pen = !!(buf & PCF8563_BIT_AF);

	return 0;
}

static irqreturn_t pcf8563_irq(int irq, void *dev_id)
{
	struct pcf8563 *pcf8563 = i2c_get_clientdata(dev_id);
	int err;
	char pending;

	err = pcf8563_get_alarm_mode(pcf8563->client, NULL, &pending);
	if (err)
		return IRQ_NONE;

	if (pending) {
		rtc_update_irq(pcf8563->rtc, 1, RTC_IRQF | RTC_AF);
		pcf8563_set_alarm_mode(pcf8563->client, 1);
		return IRQ_HANDLED;
	}

	return IRQ_NONE;
}

/*
 * In the routines that deal directly with the pcf8563 hardware, we use
 * rtc_time -- month 0-11, hour 0-23, yr = calendar year-epoch.
 */
static int pcf8563_get_datetime(struct i2c_client *client, struct rtc_time *tm)
{
	struct pcf8563 *pcf8563 = i2c_get_clientdata(client);
	unsigned char buf[9];
	int err;

	err = pcf8563_read_block_data(client, PCF8563_REG_ST1, 9, buf);
	if (err)
		return err;

	if (buf[PCF8563_REG_SC] & PCF8563_SC_LV) {
		pcf8563->voltage_low = 1;
		dev_err(&client->dev,
			"low voltage detected, date/time is not reliable.\n");
		return -EINVAL;
	}

	dev_dbg(&client->dev,
		"%s: raw data is st1=%02x, st2=%02x, sec=%02x, min=%02x, hr=%02x, "
		"mday=%02x, wday=%02x, mon=%02x, year=%02x\n",
		__func__,
		buf[0], buf[1], buf[2], buf[3],
		buf[4], buf[5], buf[6], buf[7],
		buf[8]);


	tm->tm_sec = bcd2bin(buf[PCF8563_REG_SC] & 0x7F);
	tm->tm_min = bcd2bin(buf[PCF8563_REG_MN] & 0x7F);
	tm->tm_hour = bcd2bin(buf[PCF8563_REG_HR] & 0x3F); /* rtc hr 0-23 */
	tm->tm_mday = bcd2bin(buf[PCF8563_REG_DM] & 0x3F);
	tm->tm_wday = buf[PCF8563_REG_DW] & 0x07;
	tm->tm_mon = bcd2bin(buf[PCF8563_REG_MO] & 0x1F) - 1; /* rtc mn 1-12 */
	tm->tm_year = bcd2bin(buf[PCF8563_REG_YR]);
	if (tm->tm_year < 70)
		tm->tm_year += 100;	/* assume we are in 1970...2069 */
	/* detect the polarity heuristically. see note above. */
	pcf8563->c_polarity = (buf[PCF8563_REG_MO] & PCF8563_MO_C) ?
		(tm->tm_year >= 100) : (tm->tm_year < 100);

	dev_dbg(&client->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);

	return 0;
}

static int pcf8563_set_datetime(struct i2c_client *client, struct rtc_time *tm)
{
	struct pcf8563 *pcf8563 = i2c_get_clientdata(client);
	unsigned char buf[9];

	dev_dbg(&client->dev, "%s: 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);

	/* hours, minutes and seconds */
	buf[PCF8563_REG_SC] = bin2bcd(tm->tm_sec);
	buf[PCF8563_REG_MN] = bin2bcd(tm->tm_min);
	buf[PCF8563_REG_HR] = bin2bcd(tm->tm_hour);

	buf[PCF8563_REG_DM] = bin2bcd(tm->tm_mday);

	/* month, 1 - 12 */
	buf[PCF8563_REG_MO] = bin2bcd(tm->tm_mon + 1);

	/* year and century */
	buf[PCF8563_REG_YR] = bin2bcd(tm->tm_year % 100);
	if (pcf8563->c_polarity ? (tm->tm_year >= 100) : (tm->tm_year < 100))
		buf[PCF8563_REG_MO] |= PCF8563_MO_C;

	buf[PCF8563_REG_DW] = tm->tm_wday & 0x07;

	return pcf8563_write_block_data(client, PCF8563_REG_SC,
				9 - PCF8563_REG_SC, buf + PCF8563_REG_SC);
}

#ifdef CONFIG_RTC_INTF_DEV
static int pcf8563_rtc_ioctl(struct device *dev, unsigned int cmd, unsigned long arg)
{
	struct pcf8563 *pcf8563 = i2c_get_clientdata(to_i2c_client(dev));
	struct rtc_time tm;

	switch (cmd) {
	case RTC_VL_READ:
		if (pcf8563->voltage_low)
			dev_info(dev, "low voltage detected, date/time is not reliable.\n");

		if (copy_to_user((void __user *)arg, &pcf8563->voltage_low,
					sizeof(int)))
			return -EFAULT;
		return 0;
	case RTC_VL_CLR:
		/*
		 * Clear the VL bit in the seconds register in case
		 * the time has not been set already (which would
		 * have cleared it). This does not really matter
		 * because of the cached voltage_low value but do it
		 * anyway for consistency.
		 */
		if (pcf8563_get_datetime(to_i2c_client(dev), &tm))
			pcf8563_set_datetime(to_i2c_client(dev), &tm);

		/* Clear the cached value. */
		pcf8563->voltage_low = 0;

		return 0;
	default:
		return -ENOIOCTLCMD;
	}
}
#else
#define pcf8563_rtc_ioctl NULL
#endif

static int pcf8563_rtc_read_time(struct device *dev, struct rtc_time *tm)
{
	return pcf8563_get_datetime(to_i2c_client(dev), tm);
}

static int pcf8563_rtc_set_time(struct device *dev, struct rtc_time *tm)
{
	return pcf8563_set_datetime(to_i2c_client(dev), tm);
}

static int pcf8563_rtc_read_alarm(struct device *dev, struct rtc_wkalrm *tm)
{
	struct i2c_client *client = to_i2c_client(dev);
	unsigned char buf[4];
	int err;

	err = pcf8563_read_block_data(client, PCF8563_REG_AMN, 4, buf);
	if (err)
		return err;

	dev_dbg(&client->dev,
		"%s: raw data is min=%02x, hr=%02x, mday=%02x, wday=%02x\n",
		__func__, buf[0], buf[1], buf[2], buf[3]);

	tm->time.tm_min = bcd2bin(buf[0] & 0x7F);
	tm->time.tm_hour = bcd2bin(buf[1] & 0x3F);
	tm->time.tm_mday = bcd2bin(buf[2] & 0x3F);
	tm->time.tm_wday = bcd2bin(buf[3] & 0x7);
	tm->time.tm_mon = -1;
	tm->time.tm_year = -1;
	tm->time.tm_yday = -1;
	tm->time.tm_isdst = -1;

	err = pcf8563_get_alarm_mode(client, &tm->enabled, &tm->pending);
	if (err < 0)
		return err;

	dev_dbg(&client->dev, "%s: tm is mins=%d, hours=%d, mday=%d, wday=%d,"
		" enabled=%d, pending=%d\n", __func__, tm->time.tm_min,
		tm->time.tm_hour, tm->time.tm_mday, tm->time.tm_wday,
		tm->enabled, tm->pending);

	return 0;
}

static int pcf8563_rtc_set_alarm(struct device *dev, struct rtc_wkalrm *tm)
{
	struct i2c_client *client = to_i2c_client(dev);
	unsigned char buf[4];
	int err;

	/* The alarm has no seconds, round up to nearest minute */
	if (tm->time.tm_sec) {
		time64_t alarm_time = rtc_tm_to_time64(&tm->time);

		alarm_time += 60 - tm->time.tm_sec;
		rtc_time64_to_tm(alarm_time, &tm->time);
	}

	dev_dbg(dev, "%s, min=%d hour=%d wday=%d mday=%d "
		"enabled=%d pending=%d\n", __func__,
		tm->time.tm_min, tm->time.tm_hour, tm->time.tm_wday,
		tm->time.tm_mday, tm->enabled, tm->pending);

	buf[0] = bin2bcd(tm->time.tm_min);
	buf[1] = bin2bcd(tm->time.tm_hour);
	buf[2] = bin2bcd(tm->time.tm_mday);
	buf[3] = tm->time.tm_wday & 0x07;

	err = pcf8563_write_block_data(client, PCF8563_REG_AMN, 4, buf);
	if (err)
		return err;

	return pcf8563_set_alarm_mode(client, 1);
}

static int pcf8563_irq_enable(struct device *dev, unsigned int enabled)
{
	dev_dbg(dev, "%s: en=%d\n", __func__, enabled);
	return pcf8563_set_alarm_mode(to_i2c_client(dev), !!enabled);
}

static const struct rtc_class_ops pcf8563_rtc_ops = {
	.ioctl		= pcf8563_rtc_ioctl,
	.read_time	= pcf8563_rtc_read_time,
	.set_time	= pcf8563_rtc_set_time,
	.read_alarm	= pcf8563_rtc_read_alarm,
	.set_alarm	= pcf8563_rtc_set_alarm,
	.alarm_irq_enable = pcf8563_irq_enable,
};

static int pcf8563_probe(struct i2c_client *client,
				const struct i2c_device_id *id)
{
	struct pcf8563 *pcf8563;
	int err;
	unsigned char buf;
	unsigned char alm_pending;

	dev_dbg(&client->dev, "%s\n", __func__);

	if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C))
		return -ENODEV;

	pcf8563 = devm_kzalloc(&client->dev, sizeof(struct pcf8563),
				GFP_KERNEL);
	if (!pcf8563)
		return -ENOMEM;

	dev_info(&client->dev, "chip found, driver version " DRV_VERSION "\n");

	i2c_set_clientdata(client, pcf8563);
	pcf8563->client = client;
	device_set_wakeup_capable(&client->dev, 1);

	/* Set timer to lowest frequency to save power (ref Haoyu datasheet) */
	buf = PCF8563_TMRC_1_60;
	err = pcf8563_write_block_data(client, PCF8563_REG_TMRC, 1, &buf);
	if (err < 0) {
		dev_err(&client->dev, "%s: write error\n", __func__);
		return err;
	}

	err = pcf8563_get_alarm_mode(client, NULL, &alm_pending);
	if (err) {
		dev_err(&client->dev, "%s: read error\n", __func__);
		return err;
	}
	if (alm_pending)
		pcf8563_set_alarm_mode(client, 0);

	pcf8563->rtc = devm_rtc_device_register(&client->dev,
				pcf8563_driver.driver.name,
				&pcf8563_rtc_ops, THIS_MODULE);

	if (IS_ERR(pcf8563->rtc))
		return PTR_ERR(pcf8563->rtc);

	if (client->irq > 0) {
		err = devm_request_threaded_irq(&client->dev, client->irq,
				NULL, pcf8563_irq,
				IRQF_SHARED|IRQF_ONESHOT|IRQF_TRIGGER_FALLING,
				pcf8563->rtc->name, client);
		if (err) {
			dev_err(&client->dev, "unable to request IRQ %d\n",
								client->irq);
			return err;
		}

	}

	/* the pcf8563 alarm only supports a minute accuracy */
	pcf8563->rtc->uie_unsupported = 1;

	return 0;
}

static const struct i2c_device_id pcf8563_id[] = {
	{ "pcf8563", 0 },
	{ "rtc8564", 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, pcf8563_id);

#ifdef CONFIG_OF
static const struct of_device_id pcf8563_of_match[] = {
	{ .compatible = "nxp,pcf8563" },
	{}
};
MODULE_DEVICE_TABLE(of, pcf8563_of_match);
#endif

static struct i2c_driver pcf8563_driver = {
	.driver		= {
		.name	= "rtc-pcf8563",
		.of_match_table = of_match_ptr(pcf8563_of_match),
	},
	.probe		= pcf8563_probe,
	.id_table	= pcf8563_id,
};

module_i2c_driver(pcf8563_driver);

MODULE_AUTHOR("Alessandro Zummo <a.zummo@towertech.it>");
MODULE_DESCRIPTION("Philips PCF8563/Epson RTC8564 RTC driver");
MODULE_LICENSE("GPL");
MODULE_VERSION(DRV_VERSION);
Commit	Line	Data
b5a82d62 AZ	1	/*
	2	* An I2C driver for the Philips PCF8563 RTC
	3	* Copyright 2005-06 Tower Technologies
	4	*
	5	* Author: Alessandro Zummo <a.zummo@towertech.it>
	6	* Maintainers: http://www.nslu2-linux.org/
	7	*
	8	* based on the other drivers in this same directory.
	9	*
	10	* http://www.semiconductors.philips.com/acrobat/datasheets/PCF8563-04.pdf
	11	*
	12	* This program is free software; you can redistribute it and/or modify
	13	* it under the terms of the GNU General Public License version 2 as
	14	* published by the Free Software Foundation.
	15	*/
	16
	17	#include <linux/i2c.h>
	18	#include <linux/bcd.h>
	19	#include <linux/rtc.h>
5a0e3ad6	20	#include <linux/slab.h>
2113852b	21	#include <linux/module.h>
8dccaf06	22	#include <linux/of.h>
23f809ee	23	#include <linux/err.h>
b5a82d62	24
538330cc	25	#define DRV_VERSION "0.4.4"
b5a82d62 AZ	26
	27	#define PCF8563_REG_ST1 0x00 /* status */
	28	#define PCF8563_REG_ST2 0x01
ede3e9d4 VD	29	#define PCF8563_BIT_AIE (1 << 1)
ede3e9d4 VD	30	#define PCF8563_BIT_AF (1 << 3)
45ef0458	31	#define PCF8563_BITS_ST2_N (7 << 5)
b5a82d62 AZ	32
	33	#define PCF8563_REG_SC 0x02 /* datetime */
	34	#define PCF8563_REG_MN 0x03
	35	#define PCF8563_REG_HR 0x04
	36	#define PCF8563_REG_DM 0x05
	37	#define PCF8563_REG_DW 0x06
	38	#define PCF8563_REG_MO 0x07
	39	#define PCF8563_REG_YR 0x08
	40
	41	#define PCF8563_REG_AMN 0x09 /* alarm */
b5a82d62 AZ	42
	43	#define PCF8563_REG_CLKO 0x0D /* clock out */
	44	#define PCF8563_REG_TMRC 0x0E /* timer control */
ff0bc501 JK	45	#define PCF8563_TMRC_ENABLE BIT(7)
	46	#define PCF8563_TMRC_4096 0
	47	#define PCF8563_TMRC_64 1
	48	#define PCF8563_TMRC_1 2
	49	#define PCF8563_TMRC_1_60 3
	50	#define PCF8563_TMRC_MASK 3
	51
b5a82d62 AZ	52	#define PCF8563_REG_TMR 0x0F /* timer */
	53
	54	#define PCF8563_SC_LV 0x80 /* low voltage */
	55	#define PCF8563_MO_C 0x80 /* century */
	56
e5fc9cc0 AZ	57	static struct i2c_driver pcf8563_driver;
e5fc9cc0 AZ	58
cbb94502	59	struct pcf8563 {
e5fc9cc0	60	struct rtc_device *rtc;
cbb94502 AN	61	/*
	62	* The meaning of MO_C bit varies by the chip type.
	63	* From PCF8563 datasheet: this bit is toggled when the years
	64	* register overflows from 99 to 00
	65	* 0 indicates the century is 20xx
	66	* 1 indicates the century is 19xx
	67	* From RTC8564 datasheet: this bit indicates change of
	68	* century. When the year digit data overflows from 99 to 00,
	69	* this bit is set. By presetting it to 0 while still in the
	70	* 20th century, it will be set in year 2000, ...
	71	* There seems no reliable way to know how the system use this
	72	* bit. So let's do it heuristically, assuming we are live in
	73	* 1970...2069.
	74	*/
	75	int c_polarity; /* 0: MO_C=1 means 19xx, otherwise MO_C=1 means 20xx */
0f20b767	76	int voltage_low; /* incicates if a low_voltage was detected */
ede3e9d4 VD	77
ede3e9d4 VD	78	struct i2c_client *client;
cbb94502 AN	79	};
cbb94502 AN	80
2784366c VD	81	static int pcf8563_read_block_data(struct i2c_client *client, unsigned char reg,
2784366c VD	82	unsigned char length, unsigned char *buf)
b5a82d62	83	{
b5a82d62	84	struct i2c_msg msgs[] = {
755e4a4b S	85	{/* setup read ptr */
	86	.addr = client->addr,
	87	.len = 1,
2784366c	88	.buf = &reg,
755e4a4b	89	},
2784366c	90	{
755e4a4b S	91	.addr = client->addr,
755e4a4b S	92	.flags = I2C_M_RD,
2784366c	93	.len = length,
755e4a4b S	94	.buf = buf
755e4a4b S	95	},
b5a82d62 AZ	96	};
b5a82d62 AZ	97
b5a82d62	98	if ((i2c_transfer(client->adapter, msgs, 2)) != 2) {
2a4e2b87	99	dev_err(&client->dev, "%s: read error\n", __func__);
b5a82d62 AZ	100	return -EIO;
	101	}
	102
2784366c VD	103	return 0;
	104	}
	105
	106	static int pcf8563_write_block_data(struct i2c_client *client,
	107	unsigned char reg, unsigned char length,
	108	unsigned char *buf)
	109	{
	110	int i, err;
	111
	112	for (i = 0; i < length; i++) {
	113	unsigned char data[2] = { reg + i, buf[i] };
	114
	115	err = i2c_master_send(client, data, sizeof(data));
	116	if (err != sizeof(data)) {
	117	dev_err(&client->dev,
	118	"%s: err=%d addr=%02x, data=%02x\n",
	119	__func__, err, data[0], data[1]);
	120	return -EIO;
	121	}
	122	}
	123
	124	return 0;
	125	}
	126
ede3e9d4 VD	127	static int pcf8563_set_alarm_mode(struct i2c_client *client, bool on)
ede3e9d4 VD	128	{
17a1e5e8	129	unsigned char buf;
ede3e9d4 VD	130	int err;
ede3e9d4 VD	131
17a1e5e8	132	err = pcf8563_read_block_data(client, PCF8563_REG_ST2, 1, &buf);
ede3e9d4 VD	133	if (err < 0)
	134	return err;
	135
	136	if (on)
17a1e5e8	137	buf \|= PCF8563_BIT_AIE;
ede3e9d4	138	else
17a1e5e8	139	buf &= ~PCF8563_BIT_AIE;
ede3e9d4	140
45ef0458	141	buf &= ~(PCF8563_BIT_AF \| PCF8563_BITS_ST2_N);
ede3e9d4	142
17a1e5e8	143	err = pcf8563_write_block_data(client, PCF8563_REG_ST2, 1, &buf);
ede3e9d4 VD	144	if (err < 0) {
	145	dev_err(&client->dev, "%s: write error\n", __func__);
	146	return -EIO;
	147	}
	148
	149	return 0;
	150	}
	151
	152	static int pcf8563_get_alarm_mode(struct i2c_client client, unsigned char en,
	153	unsigned char *pen)
	154	{
	155	unsigned char buf;
	156	int err;
	157
	158	err = pcf8563_read_block_data(client, PCF8563_REG_ST2, 1, &buf);
	159	if (err)
	160	return err;
	161
	162	if (en)
	163	*en = !!(buf & PCF8563_BIT_AIE);
	164	if (pen)
	165	*pen = !!(buf & PCF8563_BIT_AF);
	166
	167	return 0;
	168	}
	169
	170	static irqreturn_t pcf8563_irq(int irq, void *dev_id)
	171	{
	172	struct pcf8563 *pcf8563 = i2c_get_clientdata(dev_id);
	173	int err;
	174	char pending;
	175
	176	err = pcf8563_get_alarm_mode(pcf8563->client, NULL, &pending);
e698a512	177	if (err)
3ff38237	178	return IRQ_NONE;
ede3e9d4 VD	179
	180	if (pending) {
	181	rtc_update_irq(pcf8563->rtc, 1, RTC_IRQF \| RTC_AF);
	182	pcf8563_set_alarm_mode(pcf8563->client, 1);
	183	return IRQ_HANDLED;
	184	}
	185
	186	return IRQ_NONE;
	187	}
	188
2784366c VD	189	/*
	190	* In the routines that deal directly with the pcf8563 hardware, we use
	191	* rtc_time -- month 0-11, hour 0-23, yr = calendar year-epoch.
	192	*/
	193	static int pcf8563_get_datetime(struct i2c_client client, struct rtc_time tm)
	194	{
	195	struct pcf8563 *pcf8563 = i2c_get_clientdata(client);
	196	unsigned char buf[9];
	197	int err;
	198
	199	err = pcf8563_read_block_data(client, PCF8563_REG_ST1, 9, buf);
	200	if (err)
	201	return err;
	202
0f20b767 AS	203	if (buf[PCF8563_REG_SC] & PCF8563_SC_LV) {
0f20b767 AS	204	pcf8563->voltage_low = 1;
538330cc	205	dev_err(&client->dev,
b5a82d62	206	"low voltage detected, date/time is not reliable.\n");
538330cc	207	return -EINVAL;
0f20b767	208	}
b5a82d62 AZ	209
	210	dev_dbg(&client->dev,
	211	"%s: raw data is st1=%02x, st2=%02x, sec=%02x, min=%02x, hr=%02x, "
	212	"mday=%02x, wday=%02x, mon=%02x, year=%02x\n",
2a4e2b87	213	__func__,
b5a82d62 AZ	214	buf[0], buf[1], buf[2], buf[3],
	215	buf[4], buf[5], buf[6], buf[7],
	216	buf[8]);
	217
	218
fe20ba70 AB	219	tm->tm_sec = bcd2bin(buf[PCF8563_REG_SC] & 0x7F);
	220	tm->tm_min = bcd2bin(buf[PCF8563_REG_MN] & 0x7F);
	221	tm->tm_hour = bcd2bin(buf[PCF8563_REG_HR] & 0x3F); /* rtc hr 0-23 */
	222	tm->tm_mday = bcd2bin(buf[PCF8563_REG_DM] & 0x3F);
b5a82d62	223	tm->tm_wday = buf[PCF8563_REG_DW] & 0x07;
fe20ba70 AB	224	tm->tm_mon = bcd2bin(buf[PCF8563_REG_MO] & 0x1F) - 1; /* rtc mn 1-12 */
fe20ba70 AB	225	tm->tm_year = bcd2bin(buf[PCF8563_REG_YR]);
cbb94502 AN	226	if (tm->tm_year < 70)
	227	tm->tm_year += 100; /* assume we are in 1970...2069 */
	228	/* detect the polarity heuristically. see note above. */
	229	pcf8563->c_polarity = (buf[PCF8563_REG_MO] & PCF8563_MO_C) ?
	230	(tm->tm_year >= 100) : (tm->tm_year < 100);
b5a82d62 AZ	231
	232	dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
	233	"mday=%d, mon=%d, year=%d, wday=%d\n",
2a4e2b87	234	__func__,
b5a82d62 AZ	235	tm->tm_sec, tm->tm_min, tm->tm_hour,
	236	tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
	237
b5a82d62 AZ	238	return 0;
	239	}
	240
	241	static int pcf8563_set_datetime(struct i2c_client client, struct rtc_time tm)
	242	{
e5fc9cc0	243	struct pcf8563 *pcf8563 = i2c_get_clientdata(client);
b5a82d62 AZ	244	unsigned char buf[9];
	245
	246	dev_dbg(&client->dev, "%s: secs=%d, mins=%d, hours=%d, "
	247	"mday=%d, mon=%d, year=%d, wday=%d\n",
2a4e2b87	248	__func__,
b5a82d62 AZ	249	tm->tm_sec, tm->tm_min, tm->tm_hour,
	250	tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
	251
	252	/* hours, minutes and seconds */
fe20ba70 AB	253	buf[PCF8563_REG_SC] = bin2bcd(tm->tm_sec);
	254	buf[PCF8563_REG_MN] = bin2bcd(tm->tm_min);
	255	buf[PCF8563_REG_HR] = bin2bcd(tm->tm_hour);
b5a82d62	256
fe20ba70	257	buf[PCF8563_REG_DM] = bin2bcd(tm->tm_mday);
b5a82d62 AZ	258
b5a82d62 AZ	259	/* month, 1 - 12 */
fe20ba70	260	buf[PCF8563_REG_MO] = bin2bcd(tm->tm_mon + 1);
b5a82d62 AZ	261
b5a82d62 AZ	262	/* year and century */
fe20ba70	263	buf[PCF8563_REG_YR] = bin2bcd(tm->tm_year % 100);
cbb94502	264	if (pcf8563->c_polarity ? (tm->tm_year >= 100) : (tm->tm_year < 100))
b5a82d62 AZ	265	buf[PCF8563_REG_MO] \|= PCF8563_MO_C;
	266
	267	buf[PCF8563_REG_DW] = tm->tm_wday & 0x07;
	268
b0c57b59	269	return pcf8563_write_block_data(client, PCF8563_REG_SC,
2784366c	270	9 - PCF8563_REG_SC, buf + PCF8563_REG_SC);
b5a82d62 AZ	271	}
b5a82d62 AZ	272
0f20b767 AS	273	#ifdef CONFIG_RTC_INTF_DEV
	274	static int pcf8563_rtc_ioctl(struct device *dev, unsigned int cmd, unsigned long arg)
	275	{
	276	struct pcf8563 *pcf8563 = i2c_get_clientdata(to_i2c_client(dev));
	277	struct rtc_time tm;
	278
	279	switch (cmd) {
	280	case RTC_VL_READ:
	281	if (pcf8563->voltage_low)
	282	dev_info(dev, "low voltage detected, date/time is not reliable.\n");
	283
	284	if (copy_to_user((void __user *)arg, &pcf8563->voltage_low,
	285	sizeof(int)))
	286	return -EFAULT;
	287	return 0;
	288	case RTC_VL_CLR:
	289	/*
	290	* Clear the VL bit in the seconds register in case
	291	* the time has not been set already (which would
	292	* have cleared it). This does not really matter
	293	* because of the cached voltage_low value but do it
	294	* anyway for consistency.
	295	*/
	296	if (pcf8563_get_datetime(to_i2c_client(dev), &tm))
	297	pcf8563_set_datetime(to_i2c_client(dev), &tm);
	298
	299	/* Clear the cached value. */
	300	pcf8563->voltage_low = 0;
	301
	302	return 0;
	303	default:
	304	return -ENOIOCTLCMD;
	305	}
	306	}
	307	#else
	308	#define pcf8563_rtc_ioctl NULL
	309	#endif
	310
b5a82d62 AZ	311	static int pcf8563_rtc_read_time(struct device dev, struct rtc_time tm)
	312	{
	313	return pcf8563_get_datetime(to_i2c_client(dev), tm);
	314	}
	315
	316	static int pcf8563_rtc_set_time(struct device dev, struct rtc_time tm)
	317	{
	318	return pcf8563_set_datetime(to_i2c_client(dev), tm);
	319	}
	320
ede3e9d4 VD	321	static int pcf8563_rtc_read_alarm(struct device dev, struct rtc_wkalrm tm)
	322	{
	323	struct i2c_client *client = to_i2c_client(dev);
	324	unsigned char buf[4];
	325	int err;
	326
	327	err = pcf8563_read_block_data(client, PCF8563_REG_AMN, 4, buf);
	328	if (err)
	329	return err;
	330
	331	dev_dbg(&client->dev,
	332	"%s: raw data is min=%02x, hr=%02x, mday=%02x, wday=%02x\n",
	333	__func__, buf[0], buf[1], buf[2], buf[3]);
	334
	335	tm->time.tm_min = bcd2bin(buf[0] & 0x7F);
c7aef4f8 JK	336	tm->time.tm_hour = bcd2bin(buf[1] & 0x3F);
c7aef4f8 JK	337	tm->time.tm_mday = bcd2bin(buf[2] & 0x3F);
ede3e9d4 VD	338	tm->time.tm_wday = bcd2bin(buf[3] & 0x7);
	339	tm->time.tm_mon = -1;
	340	tm->time.tm_year = -1;
	341	tm->time.tm_yday = -1;
	342	tm->time.tm_isdst = -1;
	343
	344	err = pcf8563_get_alarm_mode(client, &tm->enabled, &tm->pending);
	345	if (err < 0)
	346	return err;
	347
	348	dev_dbg(&client->dev, "%s: tm is mins=%d, hours=%d, mday=%d, wday=%d,"
	349	" enabled=%d, pending=%d\n", __func__, tm->time.tm_min,
	350	tm->time.tm_hour, tm->time.tm_mday, tm->time.tm_wday,
	351	tm->enabled, tm->pending);
	352
	353	return 0;
	354	}
	355
	356	static int pcf8563_rtc_set_alarm(struct device dev, struct rtc_wkalrm tm)
	357	{
	358	struct i2c_client *client = to_i2c_client(dev);
	359	unsigned char buf[4];
	360	int err;
599cda55 JK	361
	362	/* The alarm has no seconds, round up to nearest minute */
	363	if (tm->time.tm_sec) {
626fea04 XP	364	time64_t alarm_time = rtc_tm_to_time64(&tm->time);
	365
	366	alarm_time += 60 - tm->time.tm_sec;
	367	rtc_time64_to_tm(alarm_time, &tm->time);
599cda55	368	}
ede3e9d4 VD	369
	370	dev_dbg(dev, "%s, min=%d hour=%d wday=%d mday=%d "
	371	"enabled=%d pending=%d\n", __func__,
	372	tm->time.tm_min, tm->time.tm_hour, tm->time.tm_wday,
	373	tm->time.tm_mday, tm->enabled, tm->pending);
	374
	375	buf[0] = bin2bcd(tm->time.tm_min);
	376	buf[1] = bin2bcd(tm->time.tm_hour);
	377	buf[2] = bin2bcd(tm->time.tm_mday);
	378	buf[3] = tm->time.tm_wday & 0x07;
	379
	380	err = pcf8563_write_block_data(client, PCF8563_REG_AMN, 4, buf);
	381	if (err)
	382	return err;
	383
	384	return pcf8563_set_alarm_mode(client, 1);
	385	}
	386
	387	static int pcf8563_irq_enable(struct device *dev, unsigned int enabled)
	388	{
a45d528a	389	dev_dbg(dev, "%s: en=%d\n", __func__, enabled);
ede3e9d4 VD	390	return pcf8563_set_alarm_mode(to_i2c_client(dev), !!enabled);
	391	}
	392
ff8371ac	393	static const struct rtc_class_ops pcf8563_rtc_ops = {
0f20b767	394	.ioctl = pcf8563_rtc_ioctl,
b5a82d62 AZ	395	.read_time = pcf8563_rtc_read_time,
b5a82d62 AZ	396	.set_time = pcf8563_rtc_set_time,
ede3e9d4 VD	397	.read_alarm = pcf8563_rtc_read_alarm,
	398	.set_alarm = pcf8563_rtc_set_alarm,
	399	.alarm_irq_enable = pcf8563_irq_enable,
b5a82d62 AZ	400	};
b5a82d62 AZ	401
d2653e92 JD	402	static int pcf8563_probe(struct i2c_client *client,
d2653e92 JD	403	const struct i2c_device_id *id)
b5a82d62	404	{
cbb94502	405	struct pcf8563 *pcf8563;
ede3e9d4	406	int err;
ff0bc501	407	unsigned char buf;
a45d528a	408	unsigned char alm_pending;
b5a82d62	409
e5fc9cc0	410	dev_dbg(&client->dev, "%s\n", __func__);
b5a82d62	411
e5fc9cc0 AZ	412	if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C))
e5fc9cc0 AZ	413	return -ENODEV;
b5a82d62	414
d6fbdc34 JH	415	pcf8563 = devm_kzalloc(&client->dev, sizeof(struct pcf8563),
d6fbdc34 JH	416	GFP_KERNEL);
e5fc9cc0 AZ	417	if (!pcf8563)
e5fc9cc0 AZ	418	return -ENOMEM;
b5a82d62	419
b5a82d62 AZ	420	dev_info(&client->dev, "chip found, driver version " DRV_VERSION "\n");
b5a82d62 AZ	421
b74d2caa	422	i2c_set_clientdata(client, pcf8563);
ede3e9d4 VD	423	pcf8563->client = client;
ede3e9d4 VD	424	device_set_wakeup_capable(&client->dev, 1);
b74d2caa	425
ff0bc501 JK	426	/* Set timer to lowest frequency to save power (ref Haoyu datasheet) */
	427	buf = PCF8563_TMRC_1_60;
	428	err = pcf8563_write_block_data(client, PCF8563_REG_TMRC, 1, &buf);
	429	if (err < 0) {
	430	dev_err(&client->dev, "%s: write error\n", __func__);
	431	return err;
	432	}
	433
a45d528a	434	err = pcf8563_get_alarm_mode(client, NULL, &alm_pending);
cd1420d3	435	if (err) {
a45d528a JK	436	dev_err(&client->dev, "%s: read error\n", __func__);
	437	return err;
	438	}
	439	if (alm_pending)
	440	pcf8563_set_alarm_mode(client, 0);
	441
d6fbdc34 JH	442	pcf8563->rtc = devm_rtc_device_register(&client->dev,
	443	pcf8563_driver.driver.name,
	444	&pcf8563_rtc_ops, THIS_MODULE);
b5a82d62	445
ede3e9d4 VD	446	if (IS_ERR(pcf8563->rtc))
	447	return PTR_ERR(pcf8563->rtc);
	448
	449	if (client->irq > 0) {
	450	err = devm_request_threaded_irq(&client->dev, client->irq,
	451	NULL, pcf8563_irq,
	452	IRQF_SHARED\|IRQF_ONESHOT\|IRQF_TRIGGER_FALLING,
	453	pcf8563->rtc->name, client);
	454	if (err) {
	455	dev_err(&client->dev, "unable to request IRQ %d\n",
	456	client->irq);
	457	return err;
	458	}
	459
	460	}
	461
599cda55 JK	462	/* the pcf8563 alarm only supports a minute accuracy */
	463	pcf8563->rtc->uie_unsupported = 1;
	464
ede3e9d4	465	return 0;
b5a82d62 AZ	466	}
b5a82d62 AZ	467
3760f736 JD	468	static const struct i2c_device_id pcf8563_id[] = {
3760f736 JD	469	{ "pcf8563", 0 },
8ea9212c	470	{ "rtc8564", 0 },
3760f736 JD	471	{ }
	472	};
	473	MODULE_DEVICE_TABLE(i2c, pcf8563_id);
	474
8dccaf06	475	#ifdef CONFIG_OF
5a167f45	476	static const struct of_device_id pcf8563_of_match[] = {
8dccaf06 NB	477	{ .compatible = "nxp,pcf8563" },
	478	{}
	479	};
	480	MODULE_DEVICE_TABLE(of, pcf8563_of_match);
	481	#endif
	482
e5fc9cc0 AZ	483	static struct i2c_driver pcf8563_driver = {
	484	.driver = {
	485	.name = "rtc-pcf8563",
8dccaf06	486	.of_match_table = of_match_ptr(pcf8563_of_match),
e5fc9cc0 AZ	487	},
e5fc9cc0 AZ	488	.probe = pcf8563_probe,
3760f736	489	.id_table = pcf8563_id,
e5fc9cc0 AZ	490	};
e5fc9cc0 AZ	491
0abc9201	492	module_i2c_driver(pcf8563_driver);
b5a82d62 AZ	493
	494	MODULE_AUTHOR("Alessandro Zummo <a.zummo@towertech.it>");
	495	MODULE_DESCRIPTION("Philips PCF8563/Epson RTC8564 RTC driver");
	496	MODULE_LICENSE("GPL");
	497	MODULE_VERSION(DRV_VERSION);