1 // SPDX-License-Identifier: GPL-2.0-only
3 * An I2C driver for the Intersil ISL 12022
5 * Author: Roman Fietze <roman.fietze@telemotive.de>
7 * Based on the Philips PCF8563 RTC
8 * by Alessandro Zummo <a.zummo@towertech.it>.
11 #include <linux/i2c.h>
12 #include <linux/bcd.h>
13 #include <linux/rtc.h>
14 #include <linux/slab.h>
15 #include <linux/module.h>
16 #include <linux/err.h>
18 #include <linux/of_device.h>
20 /* ISL register offsets */
21 #define ISL12022_REG_SC 0x00
22 #define ISL12022_REG_MN 0x01
23 #define ISL12022_REG_HR 0x02
24 #define ISL12022_REG_DT 0x03
25 #define ISL12022_REG_MO 0x04
26 #define ISL12022_REG_YR 0x05
27 #define ISL12022_REG_DW 0x06
29 #define ISL12022_REG_SR 0x07
30 #define ISL12022_REG_INT 0x08
32 /* ISL register bits */
33 #define ISL12022_HR_MIL (1 << 7) /* military or 24 hour time */
35 #define ISL12022_SR_LBAT85 (1 << 2)
36 #define ISL12022_SR_LBAT75 (1 << 1)
38 #define ISL12022_INT_WRTC (1 << 6)
41 static struct i2c_driver isl12022_driver;
44 struct rtc_device *rtc;
46 bool write_enabled; /* true if write enable is set */
50 static int isl12022_read_regs(struct i2c_client *client, uint8_t reg,
51 uint8_t *data, size_t n)
53 struct i2c_msg msgs[] = {
59 }, /* setup read ptr */
71 ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
72 if (ret != ARRAY_SIZE(msgs)) {
73 dev_err(&client->dev, "%s: read error, ret=%d\n",
82 static int isl12022_write_reg(struct i2c_client *client,
83 uint8_t reg, uint8_t val)
85 uint8_t data[2] = { reg, val };
88 err = i2c_master_send(client, data, sizeof(data));
89 if (err != sizeof(data)) {
91 "%s: err=%d addr=%02x, data=%02x\n",
92 __func__, err, data[0], data[1]);
101 * In the routines that deal directly with the isl12022 hardware, we use
102 * rtc_time -- month 0-11, hour 0-23, yr = calendar year-epoch.
104 static int isl12022_rtc_read_time(struct device *dev, struct rtc_time *tm)
106 struct i2c_client *client = to_i2c_client(dev);
107 uint8_t buf[ISL12022_REG_INT + 1];
110 ret = isl12022_read_regs(client, ISL12022_REG_SC, buf, sizeof(buf));
114 if (buf[ISL12022_REG_SR] & (ISL12022_SR_LBAT85 | ISL12022_SR_LBAT75)) {
116 "voltage dropped below %u%%, "
117 "date and time is not reliable.\n",
118 buf[ISL12022_REG_SR] & ISL12022_SR_LBAT85 ? 85 : 75);
122 "%s: raw data is sec=%02x, min=%02x, hr=%02x, "
123 "mday=%02x, mon=%02x, year=%02x, wday=%02x, "
126 buf[ISL12022_REG_SC],
127 buf[ISL12022_REG_MN],
128 buf[ISL12022_REG_HR],
129 buf[ISL12022_REG_DT],
130 buf[ISL12022_REG_MO],
131 buf[ISL12022_REG_YR],
132 buf[ISL12022_REG_DW],
133 buf[ISL12022_REG_SR],
134 buf[ISL12022_REG_INT]);
136 tm->tm_sec = bcd2bin(buf[ISL12022_REG_SC] & 0x7F);
137 tm->tm_min = bcd2bin(buf[ISL12022_REG_MN] & 0x7F);
138 tm->tm_hour = bcd2bin(buf[ISL12022_REG_HR] & 0x3F);
139 tm->tm_mday = bcd2bin(buf[ISL12022_REG_DT] & 0x3F);
140 tm->tm_wday = buf[ISL12022_REG_DW] & 0x07;
141 tm->tm_mon = bcd2bin(buf[ISL12022_REG_MO] & 0x1F) - 1;
142 tm->tm_year = bcd2bin(buf[ISL12022_REG_YR]) + 100;
144 dev_dbg(dev, "%s: secs=%d, mins=%d, hours=%d, "
145 "mday=%d, mon=%d, year=%d, wday=%d\n",
147 tm->tm_sec, tm->tm_min, tm->tm_hour,
148 tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
153 static int isl12022_rtc_set_time(struct device *dev, struct rtc_time *tm)
155 struct i2c_client *client = to_i2c_client(dev);
156 struct isl12022 *isl12022 = i2c_get_clientdata(client);
159 uint8_t buf[ISL12022_REG_DW + 1];
161 dev_dbg(dev, "%s: secs=%d, mins=%d, hours=%d, "
162 "mday=%d, mon=%d, year=%d, wday=%d\n",
164 tm->tm_sec, tm->tm_min, tm->tm_hour,
165 tm->tm_mday, tm->tm_mon, tm->tm_year, tm->tm_wday);
167 if (!isl12022->write_enabled) {
169 ret = isl12022_read_regs(client, ISL12022_REG_INT, buf, 1);
173 /* Check if WRTC (write rtc enable) is set factory default is
175 if (!(buf[0] & ISL12022_INT_WRTC)) {
176 /* Set the write enable bit. */
177 ret = isl12022_write_reg(client,
179 buf[0] | ISL12022_INT_WRTC);
183 /* Write to any RTC register to start RTC, we use the
184 * HR register, setting the MIL bit to use the 24 hour
186 ret = isl12022_read_regs(client, ISL12022_REG_HR,
191 ret = isl12022_write_reg(client,
193 buf[0] | ISL12022_HR_MIL);
198 isl12022->write_enabled = true;
201 /* hours, minutes and seconds */
202 buf[ISL12022_REG_SC] = bin2bcd(tm->tm_sec);
203 buf[ISL12022_REG_MN] = bin2bcd(tm->tm_min);
204 buf[ISL12022_REG_HR] = bin2bcd(tm->tm_hour) | ISL12022_HR_MIL;
206 buf[ISL12022_REG_DT] = bin2bcd(tm->tm_mday);
209 buf[ISL12022_REG_MO] = bin2bcd(tm->tm_mon + 1);
211 /* year and century */
212 buf[ISL12022_REG_YR] = bin2bcd(tm->tm_year % 100);
214 buf[ISL12022_REG_DW] = tm->tm_wday & 0x07;
216 /* write register's data */
217 for (i = 0; i < ARRAY_SIZE(buf); i++) {
218 ret = isl12022_write_reg(client, ISL12022_REG_SC + i,
219 buf[ISL12022_REG_SC + i]);
227 static const struct rtc_class_ops isl12022_rtc_ops = {
228 .read_time = isl12022_rtc_read_time,
229 .set_time = isl12022_rtc_set_time,
232 static int isl12022_probe(struct i2c_client *client)
234 struct isl12022 *isl12022;
236 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C))
239 isl12022 = devm_kzalloc(&client->dev, sizeof(struct isl12022),
244 i2c_set_clientdata(client, isl12022);
246 isl12022->rtc = devm_rtc_allocate_device(&client->dev);
247 if (IS_ERR(isl12022->rtc))
248 return PTR_ERR(isl12022->rtc);
250 isl12022->rtc->ops = &isl12022_rtc_ops;
251 isl12022->rtc->range_min = RTC_TIMESTAMP_BEGIN_2000;
252 isl12022->rtc->range_max = RTC_TIMESTAMP_END_2099;
254 return devm_rtc_register_device(isl12022->rtc);
258 static const struct of_device_id isl12022_dt_match[] = {
259 { .compatible = "isl,isl12022" }, /* for backward compat., don't use */
260 { .compatible = "isil,isl12022" },
263 MODULE_DEVICE_TABLE(of, isl12022_dt_match);
266 static const struct i2c_device_id isl12022_id[] = {
270 MODULE_DEVICE_TABLE(i2c, isl12022_id);
272 static struct i2c_driver isl12022_driver = {
274 .name = "rtc-isl12022",
276 .of_match_table = of_match_ptr(isl12022_dt_match),
279 .probe_new = isl12022_probe,
280 .id_table = isl12022_id,
283 module_i2c_driver(isl12022_driver);
285 MODULE_AUTHOR("roman.fietze@telemotive.de");
286 MODULE_DESCRIPTION("ISL 12022 RTC driver");
287 MODULE_LICENSE("GPL");