[linux-2.6-block.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/clk-provider.h>
#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 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_CLKO_FE		0x80 /* clock out enabled */
#define PCF8563_REG_CLKO_F_MASK		0x03 /* frequenc mask */
#define PCF8563_REG_CLKO_F_32768HZ	0x00
#define PCF8563_REG_CLKO_F_1024HZ	0x01
#define PCF8563_REG_CLKO_F_32HZ		0x02
#define PCF8563_REG_CLKO_F_1HZ		0x03

#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;
#ifdef CONFIG_COMMON_CLK
	struct clk_hw		clkout_hw;
#endif
};

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);
}

#ifdef CONFIG_COMMON_CLK
/*
 * Handling of the clkout
 */

#define clkout_hw_to_pcf8563(_hw) container_of(_hw, struct pcf8563, clkout_hw)

static int clkout_rates[] = {
	32768,
	1024,
	32,
	1,
};

static unsigned long pcf8563_clkout_recalc_rate(struct clk_hw *hw,
						unsigned long parent_rate)
{
	struct pcf8563 *pcf8563 = clkout_hw_to_pcf8563(hw);
	struct i2c_client *client = pcf8563->client;
	unsigned char buf;
	int ret = pcf8563_read_block_data(client, PCF8563_REG_CLKO, 1, &buf);

	if (ret < 0)
		return 0;

	buf &= PCF8563_REG_CLKO_F_MASK;
	return clkout_rates[ret];
}

static long pcf8563_clkout_round_rate(struct clk_hw *hw, unsigned long rate,
				      unsigned long *prate)
{
	int i;

	for (i = 0; i < ARRAY_SIZE(clkout_rates); i++)
		if (clkout_rates[i] <= rate)
			return clkout_rates[i];

	return 0;
}

static int pcf8563_clkout_set_rate(struct clk_hw *hw, unsigned long rate,
				   unsigned long parent_rate)
{
	struct pcf8563 *pcf8563 = clkout_hw_to_pcf8563(hw);
	struct i2c_client *client = pcf8563->client;
	unsigned char buf;
	int ret = pcf8563_read_block_data(client, PCF8563_REG_CLKO, 1, &buf);
	int i;

	if (ret < 0)
		return ret;

	for (i = 0; i < ARRAY_SIZE(clkout_rates); i++)
		if (clkout_rates[i] == rate) {
			buf &= ~PCF8563_REG_CLKO_F_MASK;
			buf |= i;
			ret = pcf8563_write_block_data(client,
						       PCF8563_REG_CLKO, 1,
						       &buf);
			return ret;
		}

	return -EINVAL;
}

static int pcf8563_clkout_control(struct clk_hw *hw, bool enable)
{
	struct pcf8563 *pcf8563 = clkout_hw_to_pcf8563(hw);
	struct i2c_client *client = pcf8563->client;
	unsigned char buf;
	int ret = pcf8563_read_block_data(client, PCF8563_REG_CLKO, 1, &buf);

	if (ret < 0)
		return ret;

	if (enable)
		buf |= PCF8563_REG_CLKO_FE;
	else
		buf &= ~PCF8563_REG_CLKO_FE;

	ret = pcf8563_write_block_data(client, PCF8563_REG_CLKO, 1, &buf);
	return ret;
}

static int pcf8563_clkout_prepare(struct clk_hw *hw)
{
	return pcf8563_clkout_control(hw, 1);
}

static void pcf8563_clkout_unprepare(struct clk_hw *hw)
{
	pcf8563_clkout_control(hw, 0);
}

static int pcf8563_clkout_is_prepared(struct clk_hw *hw)
{
	struct pcf8563 *pcf8563 = clkout_hw_to_pcf8563(hw);
	struct i2c_client *client = pcf8563->client;
	unsigned char buf;
	int ret = pcf8563_read_block_data(client, PCF8563_REG_CLKO, 1, &buf);

	if (ret < 0)
		return ret;

	return !!(buf & PCF8563_REG_CLKO_FE);
}

static const struct clk_ops pcf8563_clkout_ops = {
	.prepare = pcf8563_clkout_prepare,
	.unprepare = pcf8563_clkout_unprepare,
	.is_prepared = pcf8563_clkout_is_prepared,
	.recalc_rate = pcf8563_clkout_recalc_rate,
	.round_rate = pcf8563_clkout_round_rate,
	.set_rate = pcf8563_clkout_set_rate,
};

static struct clk *pcf8563_clkout_register_clk(struct pcf8563 *pcf8563)
{
	struct i2c_client *client = pcf8563->client;
	struct device_node *node = client->dev.of_node;
	struct clk *clk;
	struct clk_init_data init;
	int ret;
	unsigned char buf;

	/* disable the clkout output */
	buf = 0;
	ret = pcf8563_write_block_data(client, PCF8563_REG_CLKO, 1, &buf);
	if (ret < 0)
		return ERR_PTR(ret);

	init.name = "pcf8563-clkout";
	init.ops = &pcf8563_clkout_ops;
	init.flags = 0;
	init.parent_names = NULL;
	init.num_parents = 0;
	pcf8563->clkout_hw.init = &init;

	/* optional override of the clockname */
	of_property_read_string(node, "clock-output-names", &init.name);

	/* register the clock */
	clk = devm_clk_register(&client->dev, &pcf8563->clkout_hw);

	if (!IS_ERR(clk))
		of_clk_add_provider(node, of_clk_src_simple_get, clk);

	return clk;
}
#endif

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;

	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;
		}

	}

#ifdef CONFIG_COMMON_CLK
	/* register clk in common clk framework */
	pcf8563_clkout_register_clk(pcf8563);
#endif

	/* 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");
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
a39a6405	17	#include <linux/clk-provider.h>
b5a82d62 AZ	18	#include <linux/i2c.h>
	19	#include <linux/bcd.h>
	20	#include <linux/rtc.h>
5a0e3ad6	21	#include <linux/slab.h>
2113852b	22	#include <linux/module.h>
8dccaf06	23	#include <linux/of.h>
23f809ee	24	#include <linux/err.h>
b5a82d62	25
b5a82d62 AZ	26	#define PCF8563_REG_ST1 0x00 /* status */
b5a82d62 AZ	27	#define PCF8563_REG_ST2 0x01
ede3e9d4 VD	28	#define PCF8563_BIT_AIE (1 << 1)
ede3e9d4 VD	29	#define PCF8563_BIT_AF (1 << 3)
45ef0458	30	#define PCF8563_BITS_ST2_N (7 << 5)
b5a82d62 AZ	31
	32	#define PCF8563_REG_SC 0x02 /* datetime */
	33	#define PCF8563_REG_MN 0x03
	34	#define PCF8563_REG_HR 0x04
	35	#define PCF8563_REG_DM 0x05
	36	#define PCF8563_REG_DW 0x06
	37	#define PCF8563_REG_MO 0x07
	38	#define PCF8563_REG_YR 0x08
	39
	40	#define PCF8563_REG_AMN 0x09 /* alarm */
b5a82d62	41
a39a6405 HS	42	#define PCF8563_REG_CLKO 0x0D /* clock out */
	43	#define PCF8563_REG_CLKO_FE 0x80 /* clock out enabled */
	44	#define PCF8563_REG_CLKO_F_MASK 0x03 /* frequenc mask */
	45	#define PCF8563_REG_CLKO_F_32768HZ 0x00
	46	#define PCF8563_REG_CLKO_F_1024HZ 0x01
	47	#define PCF8563_REG_CLKO_F_32HZ 0x02
	48	#define PCF8563_REG_CLKO_F_1HZ 0x03
	49
b5a82d62	50	#define PCF8563_REG_TMRC 0x0E /* timer control */
ff0bc501 JK	51	#define PCF8563_TMRC_ENABLE BIT(7)
	52	#define PCF8563_TMRC_4096 0
	53	#define PCF8563_TMRC_64 1
	54	#define PCF8563_TMRC_1 2
	55	#define PCF8563_TMRC_1_60 3
	56	#define PCF8563_TMRC_MASK 3
	57
b5a82d62 AZ	58	#define PCF8563_REG_TMR 0x0F /* timer */
	59
	60	#define PCF8563_SC_LV 0x80 /* low voltage */
	61	#define PCF8563_MO_C 0x80 /* century */
	62
e5fc9cc0 AZ	63	static struct i2c_driver pcf8563_driver;
e5fc9cc0 AZ	64
cbb94502	65	struct pcf8563 {
e5fc9cc0	66	struct rtc_device *rtc;
cbb94502 AN	67	/*
	68	* The meaning of MO_C bit varies by the chip type.
	69	* From PCF8563 datasheet: this bit is toggled when the years
	70	* register overflows from 99 to 00
	71	* 0 indicates the century is 20xx
	72	* 1 indicates the century is 19xx
	73	* From RTC8564 datasheet: this bit indicates change of
	74	* century. When the year digit data overflows from 99 to 00,
	75	* this bit is set. By presetting it to 0 while still in the
	76	* 20th century, it will be set in year 2000, ...
	77	* There seems no reliable way to know how the system use this
	78	* bit. So let's do it heuristically, assuming we are live in
	79	* 1970...2069.
	80	*/
	81	int c_polarity; /* 0: MO_C=1 means 19xx, otherwise MO_C=1 means 20xx */
0f20b767	82	int voltage_low; /* incicates if a low_voltage was detected */
ede3e9d4 VD	83
ede3e9d4 VD	84	struct i2c_client *client;
a39a6405 HS	85	#ifdef CONFIG_COMMON_CLK
	86	struct clk_hw clkout_hw;
	87	#endif
cbb94502 AN	88	};
cbb94502 AN	89
2784366c VD	90	static int pcf8563_read_block_data(struct i2c_client *client, unsigned char reg,
2784366c VD	91	unsigned char length, unsigned char *buf)
b5a82d62	92	{
b5a82d62	93	struct i2c_msg msgs[] = {
755e4a4b S	94	{/* setup read ptr */
	95	.addr = client->addr,
	96	.len = 1,
2784366c	97	.buf = &reg,
755e4a4b	98	},
2784366c	99	{
755e4a4b S	100	.addr = client->addr,
755e4a4b S	101	.flags = I2C_M_RD,
2784366c	102	.len = length,
755e4a4b S	103	.buf = buf
755e4a4b S	104	},
b5a82d62 AZ	105	};
b5a82d62 AZ	106
b5a82d62	107	if ((i2c_transfer(client->adapter, msgs, 2)) != 2) {
2a4e2b87	108	dev_err(&client->dev, "%s: read error\n", __func__);
b5a82d62 AZ	109	return -EIO;
	110	}
	111
2784366c VD	112	return 0;
	113	}
	114
	115	static int pcf8563_write_block_data(struct i2c_client *client,
	116	unsigned char reg, unsigned char length,
	117	unsigned char *buf)
	118	{
	119	int i, err;
	120
	121	for (i = 0; i < length; i++) {
	122	unsigned char data[2] = { reg + i, buf[i] };
	123
	124	err = i2c_master_send(client, data, sizeof(data));
	125	if (err != sizeof(data)) {
	126	dev_err(&client->dev,
	127	"%s: err=%d addr=%02x, data=%02x\n",
	128	__func__, err, data[0], data[1]);
	129	return -EIO;
	130	}
	131	}
	132
	133	return 0;
	134	}
	135
ede3e9d4 VD	136	static int pcf8563_set_alarm_mode(struct i2c_client *client, bool on)
ede3e9d4 VD	137	{
17a1e5e8	138	unsigned char buf;
ede3e9d4 VD	139	int err;
ede3e9d4 VD	140
17a1e5e8	141	err = pcf8563_read_block_data(client, PCF8563_REG_ST2, 1, &buf);
ede3e9d4 VD	142	if (err < 0)
	143	return err;
	144
	145	if (on)
17a1e5e8	146	buf \|= PCF8563_BIT_AIE;
ede3e9d4	147	else
17a1e5e8	148	buf &= ~PCF8563_BIT_AIE;
ede3e9d4	149
45ef0458	150	buf &= ~(PCF8563_BIT_AF \| PCF8563_BITS_ST2_N);
ede3e9d4	151
17a1e5e8	152	err = pcf8563_write_block_data(client, PCF8563_REG_ST2, 1, &buf);
ede3e9d4 VD	153	if (err < 0) {
	154	dev_err(&client->dev, "%s: write error\n", __func__);
	155	return -EIO;
	156	}
	157
	158	return 0;
	159	}
	160
	161	static int pcf8563_get_alarm_mode(struct i2c_client client, unsigned char en,
	162	unsigned char *pen)
	163	{
	164	unsigned char buf;
	165	int err;
	166
	167	err = pcf8563_read_block_data(client, PCF8563_REG_ST2, 1, &buf);
	168	if (err)
	169	return err;
	170
	171	if (en)
	172	*en = !!(buf & PCF8563_BIT_AIE);
	173	if (pen)
	174	*pen = !!(buf & PCF8563_BIT_AF);
	175
	176	return 0;
	177	}
	178
	179	static irqreturn_t pcf8563_irq(int irq, void *dev_id)
	180	{
	181	struct pcf8563 *pcf8563 = i2c_get_clientdata(dev_id);
	182	int err;
	183	char pending;
	184
	185	err = pcf8563_get_alarm_mode(pcf8563->client, NULL, &pending);
e698a512	186	if (err)
3ff38237	187	return IRQ_NONE;
ede3e9d4 VD	188
	189	if (pending) {
	190	rtc_update_irq(pcf8563->rtc, 1, RTC_IRQF \| RTC_AF);
	191	pcf8563_set_alarm_mode(pcf8563->client, 1);
	192	return IRQ_HANDLED;
	193	}
	194
	195	return IRQ_NONE;
	196	}
	197
2784366c VD	198	/*
	199	* In the routines that deal directly with the pcf8563 hardware, we use
	200	* rtc_time -- month 0-11, hour 0-23, yr = calendar year-epoch.
	201	*/
	202	static int pcf8563_get_datetime(struct i2c_client client, struct rtc_time tm)
	203	{
	204	struct pcf8563 *pcf8563 = i2c_get_clientdata(client);
	205	unsigned char buf[9];
	206	int err;
	207
	208	err = pcf8563_read_block_data(client, PCF8563_REG_ST1, 9, buf);
	209	if (err)
	210	return err;
	211
0f20b767 AS	212	if (buf[PCF8563_REG_SC] & PCF8563_SC_LV) {
0f20b767 AS	213	pcf8563->voltage_low = 1;
538330cc	214	dev_err(&client->dev,
b5a82d62	215	"low voltage detected, date/time is not reliable.\n");
538330cc	216	return -EINVAL;
0f20b767	217	}
b5a82d62 AZ	218
	219	dev_dbg(&client->dev,
	220	"%s: raw data is st1=%02x, st2=%02x, sec=%02x, min=%02x, hr=%02x, "
	221	"mday=%02x, wday=%02x, mon=%02x, year=%02x\n",
2a4e2b87	222	__func__,
b5a82d62 AZ	223	buf[0], buf[1], buf[2], buf[3],
	224	buf[4], buf[5], buf[6], buf[7],
	225	buf[8]);
	226
	227
fe20ba70 AB	228	tm->tm_sec = bcd2bin(buf[PCF8563_REG_SC] & 0x7F);
	229	tm->tm_min = bcd2bin(buf[PCF8563_REG_MN] & 0x7F);
	230	tm->tm_hour = bcd2bin(buf[PCF8563_REG_HR] & 0x3F); /* rtc hr 0-23 */
	231	tm->tm_mday = bcd2bin(buf[PCF8563_REG_DM] & 0x3F);
b5a82d62	232	tm->tm_wday = buf[PCF8563_REG_DW] & 0x07;
fe20ba70 AB	233	tm->tm_mon = bcd2bin(buf[PCF8563_REG_MO] & 0x1F) - 1; /* rtc mn 1-12 */
fe20ba70 AB	234	tm->tm_year = bcd2bin(buf[PCF8563_REG_YR]);
cbb94502 AN	235	if (tm->tm_year < 70)
	236	tm->tm_year += 100; /* assume we are in 1970...2069 */
	237	/* detect the polarity heuristically. see note above. */
	238	pcf8563->c_polarity = (buf[PCF8563_REG_MO] & PCF8563_MO_C) ?
	239	(tm->tm_year >= 100) : (tm->tm_year < 100);
b5a82d62 AZ	240
	241	dev_dbg(&client->dev, "%s: tm is secs=%d, mins=%d, hours=%d, "
	242	"mday=%d, mon=%d, year=%d, wday=%d\n",
2a4e2b87	243	__func__,
b5a82d62 AZ	244	tm->tm_sec, tm->tm_min, tm->tm_hour,
	245	tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
	246
b5a82d62 AZ	247	return 0;
	248	}
	249
	250	static int pcf8563_set_datetime(struct i2c_client client, struct rtc_time tm)
	251	{
e5fc9cc0	252	struct pcf8563 *pcf8563 = i2c_get_clientdata(client);
b5a82d62 AZ	253	unsigned char buf[9];
	254
	255	dev_dbg(&client->dev, "%s: secs=%d, mins=%d, hours=%d, "
	256	"mday=%d, mon=%d, year=%d, wday=%d\n",
2a4e2b87	257	__func__,
b5a82d62 AZ	258	tm->tm_sec, tm->tm_min, tm->tm_hour,
	259	tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
	260
	261	/* hours, minutes and seconds */
fe20ba70 AB	262	buf[PCF8563_REG_SC] = bin2bcd(tm->tm_sec);
	263	buf[PCF8563_REG_MN] = bin2bcd(tm->tm_min);
	264	buf[PCF8563_REG_HR] = bin2bcd(tm->tm_hour);
b5a82d62	265
fe20ba70	266	buf[PCF8563_REG_DM] = bin2bcd(tm->tm_mday);
b5a82d62 AZ	267
b5a82d62 AZ	268	/* month, 1 - 12 */
fe20ba70	269	buf[PCF8563_REG_MO] = bin2bcd(tm->tm_mon + 1);
b5a82d62 AZ	270
b5a82d62 AZ	271	/* year and century */
fe20ba70	272	buf[PCF8563_REG_YR] = bin2bcd(tm->tm_year % 100);
cbb94502	273	if (pcf8563->c_polarity ? (tm->tm_year >= 100) : (tm->tm_year < 100))
b5a82d62 AZ	274	buf[PCF8563_REG_MO] \|= PCF8563_MO_C;
	275
	276	buf[PCF8563_REG_DW] = tm->tm_wday & 0x07;
	277
b0c57b59	278	return pcf8563_write_block_data(client, PCF8563_REG_SC,
2784366c	279	9 - PCF8563_REG_SC, buf + PCF8563_REG_SC);
b5a82d62 AZ	280	}
b5a82d62 AZ	281
0f20b767 AS	282	#ifdef CONFIG_RTC_INTF_DEV
	283	static int pcf8563_rtc_ioctl(struct device *dev, unsigned int cmd, unsigned long arg)
	284	{
	285	struct pcf8563 *pcf8563 = i2c_get_clientdata(to_i2c_client(dev));
	286	struct rtc_time tm;
	287
	288	switch (cmd) {
	289	case RTC_VL_READ:
	290	if (pcf8563->voltage_low)
	291	dev_info(dev, "low voltage detected, date/time is not reliable.\n");
	292
	293	if (copy_to_user((void __user *)arg, &pcf8563->voltage_low,
	294	sizeof(int)))
	295	return -EFAULT;
	296	return 0;
	297	case RTC_VL_CLR:
	298	/*
	299	* Clear the VL bit in the seconds register in case
	300	* the time has not been set already (which would
	301	* have cleared it). This does not really matter
	302	* because of the cached voltage_low value but do it
	303	* anyway for consistency.
	304	*/
	305	if (pcf8563_get_datetime(to_i2c_client(dev), &tm))
	306	pcf8563_set_datetime(to_i2c_client(dev), &tm);
	307
	308	/* Clear the cached value. */
	309	pcf8563->voltage_low = 0;
	310
	311	return 0;
	312	default:
	313	return -ENOIOCTLCMD;
	314	}
	315	}
	316	#else
	317	#define pcf8563_rtc_ioctl NULL
	318	#endif
	319
b5a82d62 AZ	320	static int pcf8563_rtc_read_time(struct device dev, struct rtc_time tm)
	321	{
	322	return pcf8563_get_datetime(to_i2c_client(dev), tm);
	323	}
	324
	325	static int pcf8563_rtc_set_time(struct device dev, struct rtc_time tm)
	326	{
	327	return pcf8563_set_datetime(to_i2c_client(dev), tm);
	328	}
	329
ede3e9d4 VD	330	static int pcf8563_rtc_read_alarm(struct device dev, struct rtc_wkalrm tm)
	331	{
	332	struct i2c_client *client = to_i2c_client(dev);
	333	unsigned char buf[4];
	334	int err;
	335
	336	err = pcf8563_read_block_data(client, PCF8563_REG_AMN, 4, buf);
	337	if (err)
	338	return err;
	339
	340	dev_dbg(&client->dev,
	341	"%s: raw data is min=%02x, hr=%02x, mday=%02x, wday=%02x\n",
	342	__func__, buf[0], buf[1], buf[2], buf[3]);
	343
	344	tm->time.tm_min = bcd2bin(buf[0] & 0x7F);
c7aef4f8 JK	345	tm->time.tm_hour = bcd2bin(buf[1] & 0x3F);
c7aef4f8 JK	346	tm->time.tm_mday = bcd2bin(buf[2] & 0x3F);
ede3e9d4 VD	347	tm->time.tm_wday = bcd2bin(buf[3] & 0x7);
	348	tm->time.tm_mon = -1;
	349	tm->time.tm_year = -1;
	350	tm->time.tm_yday = -1;
	351	tm->time.tm_isdst = -1;
	352
	353	err = pcf8563_get_alarm_mode(client, &tm->enabled, &tm->pending);
	354	if (err < 0)
	355	return err;
	356
	357	dev_dbg(&client->dev, "%s: tm is mins=%d, hours=%d, mday=%d, wday=%d,"
	358	" enabled=%d, pending=%d\n", __func__, tm->time.tm_min,
	359	tm->time.tm_hour, tm->time.tm_mday, tm->time.tm_wday,
	360	tm->enabled, tm->pending);
	361
	362	return 0;
	363	}
	364
	365	static int pcf8563_rtc_set_alarm(struct device dev, struct rtc_wkalrm tm)
	366	{
	367	struct i2c_client *client = to_i2c_client(dev);
	368	unsigned char buf[4];
	369	int err;
599cda55 JK	370
	371	/* The alarm has no seconds, round up to nearest minute */
	372	if (tm->time.tm_sec) {
626fea04 XP	373	time64_t alarm_time = rtc_tm_to_time64(&tm->time);
	374
	375	alarm_time += 60 - tm->time.tm_sec;
	376	rtc_time64_to_tm(alarm_time, &tm->time);
599cda55	377	}
ede3e9d4 VD	378
	379	dev_dbg(dev, "%s, min=%d hour=%d wday=%d mday=%d "
	380	"enabled=%d pending=%d\n", __func__,
	381	tm->time.tm_min, tm->time.tm_hour, tm->time.tm_wday,
	382	tm->time.tm_mday, tm->enabled, tm->pending);
	383
	384	buf[0] = bin2bcd(tm->time.tm_min);
	385	buf[1] = bin2bcd(tm->time.tm_hour);
	386	buf[2] = bin2bcd(tm->time.tm_mday);
	387	buf[3] = tm->time.tm_wday & 0x07;
	388
	389	err = pcf8563_write_block_data(client, PCF8563_REG_AMN, 4, buf);
	390	if (err)
	391	return err;
	392
	393	return pcf8563_set_alarm_mode(client, 1);
	394	}
	395
	396	static int pcf8563_irq_enable(struct device *dev, unsigned int enabled)
	397	{
a45d528a	398	dev_dbg(dev, "%s: en=%d\n", __func__, enabled);
ede3e9d4 VD	399	return pcf8563_set_alarm_mode(to_i2c_client(dev), !!enabled);
	400	}
	401
a39a6405 HS	402	#ifdef CONFIG_COMMON_CLK
	403	/*
	404	* Handling of the clkout
	405	*/
	406
	407	#define clkout_hw_to_pcf8563(_hw) container_of(_hw, struct pcf8563, clkout_hw)
	408
	409	static int clkout_rates[] = {
	410	32768,
	411	1024,
	412	32,
	413	1,
	414	};
	415
	416	static unsigned long pcf8563_clkout_recalc_rate(struct clk_hw *hw,
	417	unsigned long parent_rate)
	418	{
	419	struct pcf8563 *pcf8563 = clkout_hw_to_pcf8563(hw);
	420	struct i2c_client *client = pcf8563->client;
	421	unsigned char buf;
	422	int ret = pcf8563_read_block_data(client, PCF8563_REG_CLKO, 1, &buf);
	423
	424	if (ret < 0)
	425	return 0;
	426
	427	buf &= PCF8563_REG_CLKO_F_MASK;
	428	return clkout_rates[ret];
	429	}
	430
	431	static long pcf8563_clkout_round_rate(struct clk_hw *hw, unsigned long rate,
	432	unsigned long *prate)
	433	{
	434	int i;
	435
	436	for (i = 0; i < ARRAY_SIZE(clkout_rates); i++)
	437	if (clkout_rates[i] <= rate)
	438	return clkout_rates[i];
	439
	440	return 0;
	441	}
	442
	443	static int pcf8563_clkout_set_rate(struct clk_hw *hw, unsigned long rate,
	444	unsigned long parent_rate)
	445	{
	446	struct pcf8563 *pcf8563 = clkout_hw_to_pcf8563(hw);
	447	struct i2c_client *client = pcf8563->client;
	448	unsigned char buf;
	449	int ret = pcf8563_read_block_data(client, PCF8563_REG_CLKO, 1, &buf);
	450	int i;
	451
	452	if (ret < 0)
	453	return ret;
	454
	455	for (i = 0; i < ARRAY_SIZE(clkout_rates); i++)
	456	if (clkout_rates[i] == rate) {
	457	buf &= ~PCF8563_REG_CLKO_F_MASK;
	458	buf \|= i;
	459	ret = pcf8563_write_block_data(client,
	460	PCF8563_REG_CLKO, 1,
	461	&buf);
	462	return ret;
	463	}
	464
	465	return -EINVAL;
466	}
467
468	static int pcf8563_clkout_control(struct clk_hw *hw, bool enable)
469	{
470	struct pcf8563 *pcf8563 = clkout_hw_to_pcf8563(hw);
471	struct i2c_client *client = pcf8563->client;
472	unsigned char buf;
473	int ret = pcf8563_read_block_data(client, PCF8563_REG_CLKO, 1, &buf);
474
475	if (ret < 0)
476	return ret;
477
478	if (enable)
479	buf \|= PCF8563_REG_CLKO_FE;
480	else
481	buf &= ~PCF8563_REG_CLKO_FE;
482
483	ret = pcf8563_write_block_data(client, PCF8563_REG_CLKO, 1, &buf);
484	return ret;
485	}
486
487	static int pcf8563_clkout_prepare(struct clk_hw *hw)
488	{
489	return pcf8563_clkout_control(hw, 1);
490	}
491
492	static void pcf8563_clkout_unprepare(struct clk_hw *hw)
493	{
494	pcf8563_clkout_control(hw, 0);
495	}
496
497	static int pcf8563_clkout_is_prepared(struct clk_hw *hw)
498	{
499	struct pcf8563 *pcf8563 = clkout_hw_to_pcf8563(hw);
500	struct i2c_client *client = pcf8563->client;
501	unsigned char buf;
502	int ret = pcf8563_read_block_data(client, PCF8563_REG_CLKO, 1, &buf);
503
504	if (ret < 0)
505	return ret;
506
507	return !!(buf & PCF8563_REG_CLKO_FE);
508	}
509
510	static const struct clk_ops pcf8563_clkout_ops = {
511	.prepare = pcf8563_clkout_prepare,
512	.unprepare = pcf8563_clkout_unprepare,
513	.is_prepared = pcf8563_clkout_is_prepared,
514	.recalc_rate = pcf8563_clkout_recalc_rate,
515	.round_rate = pcf8563_clkout_round_rate,
516	.set_rate = pcf8563_clkout_set_rate,
517	};
518
519	static struct clk pcf8563_clkout_register_clk(struct pcf8563 pcf8563)
520	{
521	struct i2c_client *client = pcf8563->client;
522	struct device_node *node = client->dev.of_node;
523	struct clk *clk;
524	struct clk_init_data init;
525	int ret;
526	unsigned char buf;
527
528	/* disable the clkout output */
529	buf = 0;
530	ret = pcf8563_write_block_data(client, PCF8563_REG_CLKO, 1, &buf);
531	if (ret < 0)
532	return ERR_PTR(ret);
533
534	init.name = "pcf8563-clkout";
535	init.ops = &pcf8563_clkout_ops;
74e1af32	536	init.flags = 0;
a39a6405 HS	537	init.parent_names = NULL;
	538	init.num_parents = 0;
	539	pcf8563->clkout_hw.init = &init;
	540
	541	/* optional override of the clockname */
	542	of_property_read_string(node, "clock-output-names", &init.name);
	543
	544	/* register the clock */
	545	clk = devm_clk_register(&client->dev, &pcf8563->clkout_hw);
	546
	547	if (!IS_ERR(clk))
	548	of_clk_add_provider(node, of_clk_src_simple_get, clk);
	549
	550	return clk;
	551	}
	552	#endif
	553
ff8371ac	554	static const struct rtc_class_ops pcf8563_rtc_ops = {
0f20b767	555	.ioctl = pcf8563_rtc_ioctl,
b5a82d62 AZ	556	.read_time = pcf8563_rtc_read_time,
b5a82d62 AZ	557	.set_time = pcf8563_rtc_set_time,
ede3e9d4 VD	558	.read_alarm = pcf8563_rtc_read_alarm,
	559	.set_alarm = pcf8563_rtc_set_alarm,
	560	.alarm_irq_enable = pcf8563_irq_enable,
b5a82d62 AZ	561	};
b5a82d62 AZ	562
d2653e92 JD	563	static int pcf8563_probe(struct i2c_client *client,
d2653e92 JD	564	const struct i2c_device_id *id)
b5a82d62	565	{
cbb94502	566	struct pcf8563 *pcf8563;
ede3e9d4	567	int err;
ff0bc501	568	unsigned char buf;
a45d528a	569	unsigned char alm_pending;
b5a82d62	570
e5fc9cc0	571	dev_dbg(&client->dev, "%s\n", __func__);
b5a82d62	572
e5fc9cc0 AZ	573	if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C))
e5fc9cc0 AZ	574	return -ENODEV;
b5a82d62	575
d6fbdc34 JH	576	pcf8563 = devm_kzalloc(&client->dev, sizeof(struct pcf8563),
d6fbdc34 JH	577	GFP_KERNEL);
e5fc9cc0 AZ	578	if (!pcf8563)
e5fc9cc0 AZ	579	return -ENOMEM;
b5a82d62	580
b74d2caa	581	i2c_set_clientdata(client, pcf8563);
ede3e9d4 VD	582	pcf8563->client = client;
ede3e9d4 VD	583	device_set_wakeup_capable(&client->dev, 1);
b74d2caa	584
ff0bc501 JK	585	/* Set timer to lowest frequency to save power (ref Haoyu datasheet) */
	586	buf = PCF8563_TMRC_1_60;
	587	err = pcf8563_write_block_data(client, PCF8563_REG_TMRC, 1, &buf);
	588	if (err < 0) {
	589	dev_err(&client->dev, "%s: write error\n", __func__);
	590	return err;
	591	}
	592
a45d528a	593	err = pcf8563_get_alarm_mode(client, NULL, &alm_pending);
cd1420d3	594	if (err) {
a45d528a JK	595	dev_err(&client->dev, "%s: read error\n", __func__);
	596	return err;
	597	}
	598	if (alm_pending)
	599	pcf8563_set_alarm_mode(client, 0);
	600
d6fbdc34 JH	601	pcf8563->rtc = devm_rtc_device_register(&client->dev,
	602	pcf8563_driver.driver.name,
	603	&pcf8563_rtc_ops, THIS_MODULE);
b5a82d62	604
ede3e9d4 VD	605	if (IS_ERR(pcf8563->rtc))
	606	return PTR_ERR(pcf8563->rtc);
	607
	608	if (client->irq > 0) {
	609	err = devm_request_threaded_irq(&client->dev, client->irq,
	610	NULL, pcf8563_irq,
	611	IRQF_SHARED\|IRQF_ONESHOT\|IRQF_TRIGGER_FALLING,
	612	pcf8563->rtc->name, client);
	613	if (err) {
	614	dev_err(&client->dev, "unable to request IRQ %d\n",
	615	client->irq);
	616	return err;
	617	}
	618
	619	}
	620
a39a6405 HS	621	#ifdef CONFIG_COMMON_CLK
	622	/* register clk in common clk framework */
	623	pcf8563_clkout_register_clk(pcf8563);
	624	#endif
	625
599cda55 JK	626	/* the pcf8563 alarm only supports a minute accuracy */
	627	pcf8563->rtc->uie_unsupported = 1;
	628
ede3e9d4	629	return 0;
b5a82d62 AZ	630	}
b5a82d62 AZ	631
3760f736 JD	632	static const struct i2c_device_id pcf8563_id[] = {
3760f736 JD	633	{ "pcf8563", 0 },
8ea9212c	634	{ "rtc8564", 0 },
3760f736 JD	635	{ }
	636	};
	637	MODULE_DEVICE_TABLE(i2c, pcf8563_id);
	638
8dccaf06	639	#ifdef CONFIG_OF
5a167f45	640	static const struct of_device_id pcf8563_of_match[] = {
8dccaf06 NB	641	{ .compatible = "nxp,pcf8563" },
	642	{}
	643	};
	644	MODULE_DEVICE_TABLE(of, pcf8563_of_match);
	645	#endif
	646
e5fc9cc0 AZ	647	static struct i2c_driver pcf8563_driver = {
	648	.driver = {
	649	.name = "rtc-pcf8563",
8dccaf06	650	.of_match_table = of_match_ptr(pcf8563_of_match),
e5fc9cc0 AZ	651	},
e5fc9cc0 AZ	652	.probe = pcf8563_probe,
3760f736	653	.id_table = pcf8563_id,
e5fc9cc0 AZ	654	};
e5fc9cc0 AZ	655
0abc9201	656	module_i2c_driver(pcf8563_driver);
b5a82d62 AZ	657
	658	MODULE_AUTHOR("Alessandro Zummo <a.zummo@towertech.it>");
	659	MODULE_DESCRIPTION("Philips PCF8563/Epson RTC8564 RTC driver");
	660	MODULE_LICENSE("GPL");