rtc-pcf85063.c 5.71 KB
Newer Older
Søren Andersen's avatar
Søren Andersen committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*
 * An I2C driver for the PCF85063 RTC
 * Copyright 2014 Rose Technology
 *
 * Author: Søren Andersen <san@rosetechnology.dk>
 * Maintainers: http://www.nslu2-linux.org/
 *
 * based on the other drivers in this same directory.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */
#include <linux/i2c.h>
#include <linux/bcd.h>
#include <linux/rtc.h>
#include <linux/module.h>

19 20 21 22 23 24 25 26 27 28
/*
 * Information for this driver was pulled from the following datasheets.
 *
 *  http://www.nxp.com/documents/data_sheet/PCF85063A.pdf
 *  http://www.nxp.com/documents/data_sheet/PCF85063TP.pdf
 *
 *  PCF85063A -- Rev. 6 — 18 November 2015
 *  PCF85063TP -- Rev. 4 — 6 May 2015
*/

Søren Andersen's avatar
Søren Andersen committed
29
#define PCF85063_REG_CTRL1		0x00 /* status */
30
#define PCF85063_REG_CTRL1_STOP		BIT(5)
Søren Andersen's avatar
Søren Andersen committed
31 32 33
#define PCF85063_REG_CTRL2		0x01

#define PCF85063_REG_SC			0x04 /* datetime */
34
#define PCF85063_REG_SC_OS		0x80
Søren Andersen's avatar
Søren Andersen committed
35 36 37 38 39 40 41 42 43
#define PCF85063_REG_MN			0x05
#define PCF85063_REG_HR			0x06
#define PCF85063_REG_DM			0x07
#define PCF85063_REG_DW			0x08
#define PCF85063_REG_MO			0x09
#define PCF85063_REG_YR			0x0A

static struct i2c_driver pcf85063_driver;

44 45
static int pcf85063_stop_clock(struct i2c_client *client, u8 *ctrl1)
{
46 47
	int rc;
	u8 reg;
48

49 50
	rc = i2c_smbus_read_byte_data(client, PCF85063_REG_CTRL1);
	if (rc < 0) {
51 52 53 54 55
		dev_err(&client->dev, "Failing to stop the clock\n");
		return -EIO;
	}

	/* stop the clock */
56
	reg = rc | PCF85063_REG_CTRL1_STOP;
57

58 59
	rc = i2c_smbus_write_byte_data(client, PCF85063_REG_CTRL1, reg);
	if (rc < 0) {
60 61 62 63
		dev_err(&client->dev, "Failing to stop the clock\n");
		return -EIO;
	}

64
	*ctrl1 = reg;
65 66 67 68

	return 0;
}

69 70
static int pcf85063_start_clock(struct i2c_client *client, u8 ctrl1)
{
71
	int rc;
72 73

	/* start the clock */
74
	ctrl1 &= ~PCF85063_REG_CTRL1_STOP;
75

76 77
	rc = i2c_smbus_write_byte_data(client, PCF85063_REG_CTRL1, ctrl1);
	if (rc < 0) {
78 79 80 81 82 83 84
		dev_err(&client->dev, "Failing to start the clock\n");
		return -EIO;
	}

	return 0;
}

85
static int pcf85063_rtc_read_time(struct device *dev, struct rtc_time *tm)
Søren Andersen's avatar
Søren Andersen committed
86
{
87
	struct i2c_client *client = to_i2c_client(dev);
88 89 90 91 92 93 94 95 96 97 98 99 100
	int rc;
	u8 regs[7];

	/*
	 * while reading, the time/date registers are blocked and not updated
	 * anymore until the access is finished. To not lose a second
	 * event, the access must be finished within one second. So, read all
	 * time/date registers in one turn.
	 */
	rc = i2c_smbus_read_i2c_block_data(client, PCF85063_REG_SC,
					   sizeof(regs), regs);
	if (rc != sizeof(regs)) {
		dev_err(&client->dev, "date/time register read error\n");
Søren Andersen's avatar
Søren Andersen committed
101 102 103
		return -EIO;
	}

104 105 106 107 108 109
	/* if the clock has lost its power it makes no sense to use its time */
	if (regs[0] & PCF85063_REG_SC_OS) {
		dev_warn(&client->dev, "Power loss detected, invalid time\n");
		return -EINVAL;
	}

110 111 112 113 114 115 116
	tm->tm_sec = bcd2bin(regs[0] & 0x7F);
	tm->tm_min = bcd2bin(regs[1] & 0x7F);
	tm->tm_hour = bcd2bin(regs[2] & 0x3F); /* rtc hr 0-23 */
	tm->tm_mday = bcd2bin(regs[3] & 0x3F);
	tm->tm_wday = regs[4] & 0x07;
	tm->tm_mon = bcd2bin(regs[5] & 0x1F) - 1; /* rtc mn 1-12 */
	tm->tm_year = bcd2bin(regs[6]);
117
	tm->tm_year += 100;
Søren Andersen's avatar
Søren Andersen committed
118

119
	return 0;
Søren Andersen's avatar
Søren Andersen committed
120 121
}

122
static int pcf85063_rtc_set_time(struct device *dev, struct rtc_time *tm)
Søren Andersen's avatar
Søren Andersen committed
123
{
124
	struct i2c_client *client = to_i2c_client(dev);
125
	int rc;
126 127
	u8 regs[7];
	u8 ctrl1;
Søren Andersen's avatar
Søren Andersen committed
128

129 130 131
	if ((tm->tm_year < 100) || (tm->tm_year > 199))
		return -EINVAL;

132 133 134 135
	/*
	 * to accurately set the time, reset the divider chain and keep it in
	 * reset state until all time/date registers are written
	 */
136
	rc = pcf85063_stop_clock(client, &ctrl1);
137 138
	if (rc != 0)
		return rc;
Søren Andersen's avatar
Søren Andersen committed
139 140

	/* hours, minutes and seconds */
141
	regs[0] = bin2bcd(tm->tm_sec) & 0x7F; /* clear OS flag */
Søren Andersen's avatar
Søren Andersen committed
142

143 144
	regs[1] = bin2bcd(tm->tm_min);
	regs[2] = bin2bcd(tm->tm_hour);
Søren Andersen's avatar
Søren Andersen committed
145 146

	/* Day of month, 1 - 31 */
147
	regs[3] = bin2bcd(tm->tm_mday);
Søren Andersen's avatar
Søren Andersen committed
148 149

	/* Day, 0 - 6 */
150
	regs[4] = tm->tm_wday & 0x07;
Søren Andersen's avatar
Søren Andersen committed
151 152

	/* month, 1 - 12 */
153
	regs[5] = bin2bcd(tm->tm_mon + 1);
Søren Andersen's avatar
Søren Andersen committed
154 155

	/* year and century */
156
	regs[6] = bin2bcd(tm->tm_year - 100);
157 158 159 160 161 162 163

	/* write all registers at once */
	rc = i2c_smbus_write_i2c_block_data(client, PCF85063_REG_SC,
					    sizeof(regs), regs);
	if (rc < 0) {
		dev_err(&client->dev, "date/time register write error\n");
		return rc;
Søren Andersen's avatar
Søren Andersen committed
164 165
	}

166 167 168 169 170 171 172 173 174
	/*
	 * Write the control register as a separate action since the size of
	 * the register space is different between the PCF85063TP and
	 * PCF85063A devices.  The rollover point can not be used.
	 */
	rc = pcf85063_start_clock(client, ctrl1);
	if (rc != 0)
		return rc;

Søren Andersen's avatar
Søren Andersen committed
175 176 177 178 179 180 181 182 183 184 185
	return 0;
}

static const struct rtc_class_ops pcf85063_rtc_ops = {
	.read_time	= pcf85063_rtc_read_time,
	.set_time	= pcf85063_rtc_set_time
};

static int pcf85063_probe(struct i2c_client *client,
				const struct i2c_device_id *id)
{
186
	struct rtc_device *rtc;
187
	int err;
Søren Andersen's avatar
Søren Andersen committed
188 189 190 191 192 193

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

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

194 195 196 197 198 199
	err = i2c_smbus_read_byte_data(client, PCF85063_REG_CTRL1);
	if (err < 0) {
		dev_err(&client->dev, "RTC chip is not present\n");
		return err;
	}

200 201 202
	rtc = devm_rtc_device_register(&client->dev,
				       pcf85063_driver.driver.name,
				       &pcf85063_rtc_ops, THIS_MODULE);
Søren Andersen's avatar
Søren Andersen committed
203

204
	return PTR_ERR_OR_ZERO(rtc);
Søren Andersen's avatar
Søren Andersen committed
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
}

static const struct i2c_device_id pcf85063_id[] = {
	{ "pcf85063", 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, pcf85063_id);

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

static struct i2c_driver pcf85063_driver = {
	.driver		= {
		.name	= "rtc-pcf85063",
		.of_match_table = of_match_ptr(pcf85063_of_match),
	},
	.probe		= pcf85063_probe,
	.id_table	= pcf85063_id,
};

module_i2c_driver(pcf85063_driver);

MODULE_AUTHOR("Søren Andersen <san@rosetechnology.dk>");
MODULE_DESCRIPTION("PCF85063 RTC driver");
MODULE_LICENSE("GPL");