[mirror_ubuntu-jammy-kernel.git] / drivers / rtc / rtc-pcf8563.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * 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
 */

#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_rtc_read_time(struct device *dev, struct rtc_time *tm)
{
	struct i2c_client *client = to_i2c_client(dev);
	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_rtc_set_time(struct device *dev, struct rtc_time *tm)
{
	struct i2c_client *client = to_i2c_client(dev);
	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_rtc_read_time(dev, &tm))
			pcf8563_rtc_set_time(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_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_sec = 0;
	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);

	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, !!tm->enabled);
}

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[buf];
}

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;

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

	/* Clear flags and disable interrupts */
	buf = 0;
	err = pcf8563_write_block_data(client, PCF8563_REG_ST2, 1, &buf);
	if (err < 0) {
		dev_err(&client->dev, "%s: write error\n", __func__);
		return err;
	}

	pcf8563->rtc = devm_rtc_allocate_device(&client->dev);
	if (IS_ERR(pcf8563->rtc))
		return PTR_ERR(pcf8563->rtc);

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

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

	err = rtc_register_device(pcf8563->rtc);
	if (err)
		return err;

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

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