1 // SPDX-License-Identifier: GPL-2.0-only
3 * Driver for Epson's RTC module RX-8025 SA/NB
5 * Copyright (C) 2009 Wolfgang Grandegger <wg@grandegger.com>
7 * Copyright (C) 2005 by Digi International Inc.
10 * Modified by fengjh at rising.com.cn
11 * <lm-sensors@lm-sensors.org>
14 * Code cleanup by Sergei Poselenov, <sposelenov@emcraft.com>
15 * Converted to new style by Wolfgang Grandegger <wg@grandegger.com>
16 * Alarm and periodic interrupt added by Dmitry Rakhchev <rda@emcraft.com>
18 #include <linux/bcd.h>
19 #include <linux/bitops.h>
20 #include <linux/i2c.h>
21 #include <linux/kernel.h>
22 #include <linux/module.h>
23 #include <linux/rtc.h>
25 /* Register definitions */
26 #define RX8025_REG_SEC 0x00
27 #define RX8025_REG_MIN 0x01
28 #define RX8025_REG_HOUR 0x02
29 #define RX8025_REG_WDAY 0x03
30 #define RX8025_REG_MDAY 0x04
31 #define RX8025_REG_MONTH 0x05
32 #define RX8025_REG_YEAR 0x06
33 #define RX8025_REG_DIGOFF 0x07
34 #define RX8025_REG_ALWMIN 0x08
35 #define RX8025_REG_ALWHOUR 0x09
36 #define RX8025_REG_ALWWDAY 0x0a
37 #define RX8025_REG_ALDMIN 0x0b
38 #define RX8025_REG_ALDHOUR 0x0c
39 /* 0x0d is reserved */
40 #define RX8025_REG_CTRL1 0x0e
41 #define RX8025_REG_CTRL2 0x0f
43 #define RX8025_BIT_CTRL1_CT (7 << 0)
44 /* 1 Hz periodic level irq */
45 #define RX8025_BIT_CTRL1_CT_1HZ 4
46 #define RX8025_BIT_CTRL1_TEST BIT(3)
47 #define RX8025_BIT_CTRL1_1224 BIT(5)
48 #define RX8025_BIT_CTRL1_DALE BIT(6)
49 #define RX8025_BIT_CTRL1_WALE BIT(7)
51 #define RX8025_BIT_CTRL2_DAFG BIT(0)
52 #define RX8025_BIT_CTRL2_WAFG BIT(1)
53 #define RX8025_BIT_CTRL2_CTFG BIT(2)
54 #define RX8025_BIT_CTRL2_PON BIT(4)
55 #define RX8025_BIT_CTRL2_XST BIT(5)
56 #define RX8025_BIT_CTRL2_VDET BIT(6)
58 /* Clock precision adjustment */
59 #define RX8025_ADJ_RESOLUTION 3050 /* in ppb */
60 #define RX8025_ADJ_DATA_MAX 62
61 #define RX8025_ADJ_DATA_MIN -62
70 static const struct i2c_device_id rx8025_id[] = {
71 { "rx8025", model_rx_8025 },
72 { "rx8035", model_rx_8035 },
75 MODULE_DEVICE_TABLE(i2c, rx8025_id);
78 struct rtc_device *rtc;
83 static s32 rx8025_read_reg(const struct i2c_client *client, u8 number)
85 return i2c_smbus_read_byte_data(client, number << 4);
88 static int rx8025_read_regs(const struct i2c_client *client,
89 u8 number, u8 length, u8 *values)
91 int ret = i2c_smbus_read_i2c_block_data(client, number << 4, length,
94 return ret < 0 ? ret : -EIO;
99 static s32 rx8025_write_reg(const struct i2c_client *client, u8 number,
102 return i2c_smbus_write_byte_data(client, number << 4, value);
105 static s32 rx8025_write_regs(const struct i2c_client *client,
106 u8 number, u8 length, const u8 *values)
108 return i2c_smbus_write_i2c_block_data(client, number << 4,
112 static int rx8025_is_osc_stopped(enum rx_model model, int ctrl2)
114 int xstp = ctrl2 & RX8025_BIT_CTRL2_XST;
115 /* XSTP bit has different polarity on RX-8025 vs RX-8035.
116 * RX-8025: 0 == oscillator stopped
117 * RX-8035: 1 == oscillator stopped
120 if (model == model_rx_8025)
126 static int rx8025_check_validity(struct device *dev)
128 struct i2c_client *client = to_i2c_client(dev);
129 struct rx8025_data *drvdata = dev_get_drvdata(dev);
133 ctrl2 = rx8025_read_reg(client, RX8025_REG_CTRL2);
137 if (ctrl2 & RX8025_BIT_CTRL2_VDET)
138 dev_warn(dev, "power voltage drop detected\n");
140 if (ctrl2 & RX8025_BIT_CTRL2_PON) {
141 dev_warn(dev, "power-on reset detected, date is invalid\n");
145 xstp = rx8025_is_osc_stopped(drvdata->model, ctrl2);
147 dev_warn(dev, "crystal stopped, date is invalid\n");
154 static int rx8025_reset_validity(struct i2c_client *client)
156 struct rx8025_data *drvdata = i2c_get_clientdata(client);
157 int ctrl2 = rx8025_read_reg(client, RX8025_REG_CTRL2);
162 ctrl2 &= ~(RX8025_BIT_CTRL2_PON | RX8025_BIT_CTRL2_VDET);
164 if (drvdata->model == model_rx_8025)
165 ctrl2 |= RX8025_BIT_CTRL2_XST;
167 ctrl2 &= ~(RX8025_BIT_CTRL2_XST);
169 return rx8025_write_reg(client, RX8025_REG_CTRL2,
173 static irqreturn_t rx8025_handle_irq(int irq, void *dev_id)
175 struct i2c_client *client = dev_id;
176 struct rx8025_data *rx8025 = i2c_get_clientdata(client);
179 rtc_lock(rx8025->rtc);
180 status = rx8025_read_reg(client, RX8025_REG_CTRL2);
184 xstp = rx8025_is_osc_stopped(rx8025->model, status);
186 dev_warn(&client->dev, "Oscillation stop was detected,"
187 "you may have to readjust the clock\n");
189 if (status & RX8025_BIT_CTRL2_CTFG) {
191 status &= ~RX8025_BIT_CTRL2_CTFG;
192 rtc_update_irq(rx8025->rtc, 1, RTC_PF | RTC_IRQF);
195 if (status & RX8025_BIT_CTRL2_DAFG) {
197 status &= RX8025_BIT_CTRL2_DAFG;
198 if (rx8025_write_reg(client, RX8025_REG_CTRL1,
199 rx8025->ctrl1 & ~RX8025_BIT_CTRL1_DALE))
201 rtc_update_irq(rx8025->rtc, 1, RTC_AF | RTC_IRQF);
205 rtc_unlock(rx8025->rtc);
210 static int rx8025_get_time(struct device *dev, struct rtc_time *dt)
212 struct i2c_client *client = to_i2c_client(dev);
213 struct rx8025_data *rx8025 = dev_get_drvdata(dev);
217 err = rx8025_check_validity(dev);
221 err = rx8025_read_regs(client, RX8025_REG_SEC, 7, date);
225 dev_dbg(dev, "%s: read %7ph\n", __func__, date);
227 dt->tm_sec = bcd2bin(date[RX8025_REG_SEC] & 0x7f);
228 dt->tm_min = bcd2bin(date[RX8025_REG_MIN] & 0x7f);
229 if (rx8025->ctrl1 & RX8025_BIT_CTRL1_1224)
230 dt->tm_hour = bcd2bin(date[RX8025_REG_HOUR] & 0x3f);
232 dt->tm_hour = bcd2bin(date[RX8025_REG_HOUR] & 0x1f) % 12
233 + (date[RX8025_REG_HOUR] & 0x20 ? 12 : 0);
235 dt->tm_mday = bcd2bin(date[RX8025_REG_MDAY] & 0x3f);
236 dt->tm_mon = bcd2bin(date[RX8025_REG_MONTH] & 0x1f) - 1;
237 dt->tm_year = bcd2bin(date[RX8025_REG_YEAR]) + 100;
239 dev_dbg(dev, "%s: date %ptRr\n", __func__, dt);
244 static int rx8025_set_time(struct device *dev, struct rtc_time *dt)
246 struct i2c_client *client = to_i2c_client(dev);
247 struct rx8025_data *rx8025 = dev_get_drvdata(dev);
252 * Here the read-only bits are written as "0". I'm not sure if that
255 date[RX8025_REG_SEC] = bin2bcd(dt->tm_sec);
256 date[RX8025_REG_MIN] = bin2bcd(dt->tm_min);
257 if (rx8025->ctrl1 & RX8025_BIT_CTRL1_1224)
258 date[RX8025_REG_HOUR] = bin2bcd(dt->tm_hour);
260 date[RX8025_REG_HOUR] = (dt->tm_hour >= 12 ? 0x20 : 0)
261 | bin2bcd((dt->tm_hour + 11) % 12 + 1);
263 date[RX8025_REG_WDAY] = bin2bcd(dt->tm_wday);
264 date[RX8025_REG_MDAY] = bin2bcd(dt->tm_mday);
265 date[RX8025_REG_MONTH] = bin2bcd(dt->tm_mon + 1);
266 date[RX8025_REG_YEAR] = bin2bcd(dt->tm_year - 100);
268 dev_dbg(dev, "%s: write %7ph\n", __func__, date);
270 ret = rx8025_write_regs(client, RX8025_REG_SEC, 7, date);
274 return rx8025_reset_validity(client);
277 static int rx8025_init_client(struct i2c_client *client)
279 struct rx8025_data *rx8025 = i2c_get_clientdata(client);
284 err = rx8025_read_regs(client, RX8025_REG_CTRL1, 2, ctrl);
288 /* Keep test bit zero ! */
289 rx8025->ctrl1 = ctrl[0] & ~RX8025_BIT_CTRL1_TEST;
291 if (ctrl[1] & (RX8025_BIT_CTRL2_DAFG | RX8025_BIT_CTRL2_WAFG)) {
292 dev_warn(&client->dev, "Alarm was detected\n");
296 if (ctrl[1] & RX8025_BIT_CTRL2_CTFG)
301 ctrl2 &= ~(RX8025_BIT_CTRL2_CTFG | RX8025_BIT_CTRL2_WAFG |
302 RX8025_BIT_CTRL2_DAFG);
304 err = rx8025_write_reg(client, RX8025_REG_CTRL2, ctrl2);
311 static int rx8025_read_alarm(struct device *dev, struct rtc_wkalrm *t)
313 struct i2c_client *client = to_i2c_client(dev);
314 struct rx8025_data *rx8025 = dev_get_drvdata(dev);
318 err = rx8025_read_regs(client, RX8025_REG_ALDMIN, 2, ald);
322 ctrl2 = rx8025_read_reg(client, RX8025_REG_CTRL2);
326 dev_dbg(dev, "%s: read alarm 0x%02x 0x%02x ctrl2 %02x\n",
327 __func__, ald[0], ald[1], ctrl2);
329 /* Hardware alarms precision is 1 minute! */
331 t->time.tm_min = bcd2bin(ald[0] & 0x7f);
332 if (rx8025->ctrl1 & RX8025_BIT_CTRL1_1224)
333 t->time.tm_hour = bcd2bin(ald[1] & 0x3f);
335 t->time.tm_hour = bcd2bin(ald[1] & 0x1f) % 12
336 + (ald[1] & 0x20 ? 12 : 0);
338 dev_dbg(dev, "%s: date: %ptRr\n", __func__, &t->time);
339 t->enabled = !!(rx8025->ctrl1 & RX8025_BIT_CTRL1_DALE);
340 t->pending = (ctrl2 & RX8025_BIT_CTRL2_DAFG) && t->enabled;
345 static int rx8025_set_alarm(struct device *dev, struct rtc_wkalrm *t)
347 struct i2c_client *client = to_i2c_client(dev);
348 struct rx8025_data *rx8025 = dev_get_drvdata(dev);
352 ald[0] = bin2bcd(t->time.tm_min);
353 if (rx8025->ctrl1 & RX8025_BIT_CTRL1_1224)
354 ald[1] = bin2bcd(t->time.tm_hour);
356 ald[1] = (t->time.tm_hour >= 12 ? 0x20 : 0)
357 | bin2bcd((t->time.tm_hour + 11) % 12 + 1);
359 dev_dbg(dev, "%s: write 0x%02x 0x%02x\n", __func__, ald[0], ald[1]);
361 if (rx8025->ctrl1 & RX8025_BIT_CTRL1_DALE) {
362 rx8025->ctrl1 &= ~RX8025_BIT_CTRL1_DALE;
363 err = rx8025_write_reg(client, RX8025_REG_CTRL1,
368 err = rx8025_write_regs(client, RX8025_REG_ALDMIN, 2, ald);
373 rx8025->ctrl1 |= RX8025_BIT_CTRL1_DALE;
374 err = rx8025_write_reg(client, RX8025_REG_CTRL1,
383 static int rx8025_alarm_irq_enable(struct device *dev, unsigned int enabled)
385 struct i2c_client *client = to_i2c_client(dev);
386 struct rx8025_data *rx8025 = dev_get_drvdata(dev);
390 ctrl1 = rx8025->ctrl1;
392 ctrl1 |= RX8025_BIT_CTRL1_DALE;
394 ctrl1 &= ~RX8025_BIT_CTRL1_DALE;
396 if (ctrl1 != rx8025->ctrl1) {
397 rx8025->ctrl1 = ctrl1;
398 err = rx8025_write_reg(client, RX8025_REG_CTRL1,
406 static const struct rtc_class_ops rx8025_rtc_ops = {
407 .read_time = rx8025_get_time,
408 .set_time = rx8025_set_time,
409 .read_alarm = rx8025_read_alarm,
410 .set_alarm = rx8025_set_alarm,
411 .alarm_irq_enable = rx8025_alarm_irq_enable,
415 * Clock precision adjustment support
417 * According to the RX8025 SA/NB application manual the frequency and
418 * temperature characteristics can be approximated using the following
421 * df = a * (ut - t)**2
423 * df: Frequency deviation in any temperature
424 * a : Coefficient = (-35 +-5) * 10**-9
425 * ut: Ultimate temperature in degree = +25 +-5 degree
426 * t : Any temperature in degree
428 * Note that the clock adjustment in ppb must be entered (which is
429 * the negative value of the deviation).
431 static int rx8025_get_clock_adjust(struct device *dev, int *adj)
433 struct i2c_client *client = to_i2c_client(dev);
436 digoff = rx8025_read_reg(client, RX8025_REG_DIGOFF);
440 *adj = digoff >= 64 ? digoff - 128 : digoff;
443 *adj *= -RX8025_ADJ_RESOLUTION;
448 static int rx8025_set_clock_adjust(struct device *dev, int adj)
450 struct i2c_client *client = to_i2c_client(dev);
454 adj /= -RX8025_ADJ_RESOLUTION;
455 if (adj > RX8025_ADJ_DATA_MAX)
456 adj = RX8025_ADJ_DATA_MAX;
457 else if (adj < RX8025_ADJ_DATA_MIN)
458 adj = RX8025_ADJ_DATA_MIN;
465 err = rx8025_write_reg(client, RX8025_REG_DIGOFF, digoff);
469 dev_dbg(dev, "%s: write 0x%02x\n", __func__, digoff);
474 static ssize_t rx8025_sysfs_show_clock_adjust(struct device *dev,
475 struct device_attribute *attr,
480 err = rx8025_get_clock_adjust(dev, &adj);
484 return sprintf(buf, "%d\n", adj);
487 static ssize_t rx8025_sysfs_store_clock_adjust(struct device *dev,
488 struct device_attribute *attr,
489 const char *buf, size_t count)
493 if (sscanf(buf, "%i", &adj) != 1)
496 err = rx8025_set_clock_adjust(dev, adj);
498 return err ? err : count;
501 static DEVICE_ATTR(clock_adjust_ppb, S_IRUGO | S_IWUSR,
502 rx8025_sysfs_show_clock_adjust,
503 rx8025_sysfs_store_clock_adjust);
505 static struct attribute *rx8025_attrs[] = {
506 &dev_attr_clock_adjust_ppb.attr,
510 static const struct attribute_group rx8025_attr_group = {
511 .attrs = rx8025_attrs,
514 static int rx8025_probe(struct i2c_client *client,
515 const struct i2c_device_id *id)
517 struct i2c_adapter *adapter = client->adapter;
518 struct rx8025_data *rx8025;
521 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA
522 | I2C_FUNC_SMBUS_I2C_BLOCK)) {
523 dev_err(&adapter->dev,
524 "doesn't support required functionality\n");
528 rx8025 = devm_kzalloc(&client->dev, sizeof(*rx8025), GFP_KERNEL);
532 i2c_set_clientdata(client, rx8025);
535 rx8025->model = id->driver_data;
537 err = rx8025_init_client(client);
541 rx8025->rtc = devm_rtc_allocate_device(&client->dev);
542 if (IS_ERR(rx8025->rtc))
543 return PTR_ERR(rx8025->rtc);
545 rx8025->rtc->ops = &rx8025_rtc_ops;
546 rx8025->rtc->range_min = RTC_TIMESTAMP_BEGIN_1900;
547 rx8025->rtc->range_max = RTC_TIMESTAMP_END_2099;
549 if (client->irq > 0) {
550 dev_info(&client->dev, "IRQ %d supplied\n", client->irq);
551 err = devm_request_threaded_irq(&client->dev, client->irq, NULL,
556 clear_bit(RTC_FEATURE_ALARM, rx8025->rtc->features);
559 rx8025->rtc->max_user_freq = 1;
561 set_bit(RTC_FEATURE_ALARM_RES_MINUTE, rx8025->rtc->features);
562 clear_bit(RTC_FEATURE_UPDATE_INTERRUPT, rx8025->rtc->features);
564 err = rtc_add_group(rx8025->rtc, &rx8025_attr_group);
568 return devm_rtc_register_device(rx8025->rtc);
571 static struct i2c_driver rx8025_driver = {
573 .name = "rtc-rx8025",
575 .probe = rx8025_probe,
576 .id_table = rx8025_id,
579 module_i2c_driver(rx8025_driver);
581 MODULE_AUTHOR("Wolfgang Grandegger <wg@grandegger.com>");
582 MODULE_DESCRIPTION("RX-8025 SA/NB RTC driver");
583 MODULE_LICENSE("GPL");