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 #define RX8035_BIT_HOUR_1224 BIT(7)
60 /* Clock precision adjustment */
61 #define RX8025_ADJ_RESOLUTION 3050 /* in ppb */
62 #define RX8025_ADJ_DATA_MAX 62
63 #define RX8025_ADJ_DATA_MIN -62
72 static const struct i2c_device_id rx8025_id[] = {
73 { "rx8025", model_rx_8025 },
74 { "rx8035", model_rx_8035 },
77 MODULE_DEVICE_TABLE(i2c, rx8025_id);
80 struct rtc_device *rtc;
86 static s32 rx8025_read_reg(const struct i2c_client *client, u8 number)
88 return i2c_smbus_read_byte_data(client, number << 4);
91 static int rx8025_read_regs(const struct i2c_client *client,
92 u8 number, u8 length, u8 *values)
94 int ret = i2c_smbus_read_i2c_block_data(client, number << 4, length,
97 return ret < 0 ? ret : -EIO;
102 static s32 rx8025_write_reg(const struct i2c_client *client, u8 number,
105 return i2c_smbus_write_byte_data(client, number << 4, value);
108 static s32 rx8025_write_regs(const struct i2c_client *client,
109 u8 number, u8 length, const u8 *values)
111 return i2c_smbus_write_i2c_block_data(client, number << 4,
115 static int rx8025_is_osc_stopped(enum rx_model model, int ctrl2)
117 int xstp = ctrl2 & RX8025_BIT_CTRL2_XST;
118 /* XSTP bit has different polarity on RX-8025 vs RX-8035.
119 * RX-8025: 0 == oscillator stopped
120 * RX-8035: 1 == oscillator stopped
123 if (model == model_rx_8025)
129 static int rx8025_check_validity(struct device *dev)
131 struct i2c_client *client = to_i2c_client(dev);
132 struct rx8025_data *drvdata = dev_get_drvdata(dev);
136 ctrl2 = rx8025_read_reg(client, RX8025_REG_CTRL2);
140 if (ctrl2 & RX8025_BIT_CTRL2_VDET)
141 dev_warn(dev, "power voltage drop detected\n");
143 if (ctrl2 & RX8025_BIT_CTRL2_PON) {
144 dev_warn(dev, "power-on reset detected, date is invalid\n");
148 xstp = rx8025_is_osc_stopped(drvdata->model, ctrl2);
150 dev_warn(dev, "crystal stopped, date is invalid\n");
157 static int rx8025_reset_validity(struct i2c_client *client)
159 struct rx8025_data *drvdata = i2c_get_clientdata(client);
160 int ctrl2 = rx8025_read_reg(client, RX8025_REG_CTRL2);
165 ctrl2 &= ~(RX8025_BIT_CTRL2_PON | RX8025_BIT_CTRL2_VDET);
167 if (drvdata->model == model_rx_8025)
168 ctrl2 |= RX8025_BIT_CTRL2_XST;
170 ctrl2 &= ~(RX8025_BIT_CTRL2_XST);
172 return rx8025_write_reg(client, RX8025_REG_CTRL2,
176 static irqreturn_t rx8025_handle_irq(int irq, void *dev_id)
178 struct i2c_client *client = dev_id;
179 struct rx8025_data *rx8025 = i2c_get_clientdata(client);
182 rtc_lock(rx8025->rtc);
183 status = rx8025_read_reg(client, RX8025_REG_CTRL2);
187 xstp = rx8025_is_osc_stopped(rx8025->model, status);
189 dev_warn(&client->dev, "Oscillation stop was detected,"
190 "you may have to readjust the clock\n");
192 if (status & RX8025_BIT_CTRL2_CTFG) {
194 status &= ~RX8025_BIT_CTRL2_CTFG;
195 rtc_update_irq(rx8025->rtc, 1, RTC_PF | RTC_IRQF);
198 if (status & RX8025_BIT_CTRL2_DAFG) {
200 status &= RX8025_BIT_CTRL2_DAFG;
201 if (rx8025_write_reg(client, RX8025_REG_CTRL1,
202 rx8025->ctrl1 & ~RX8025_BIT_CTRL1_DALE))
204 rtc_update_irq(rx8025->rtc, 1, RTC_AF | RTC_IRQF);
208 rtc_unlock(rx8025->rtc);
213 static int rx8025_get_time(struct device *dev, struct rtc_time *dt)
215 struct i2c_client *client = to_i2c_client(dev);
216 struct rx8025_data *rx8025 = dev_get_drvdata(dev);
220 err = rx8025_check_validity(dev);
224 err = rx8025_read_regs(client, RX8025_REG_SEC, 7, date);
228 dev_dbg(dev, "%s: read %7ph\n", __func__, date);
230 dt->tm_sec = bcd2bin(date[RX8025_REG_SEC] & 0x7f);
231 dt->tm_min = bcd2bin(date[RX8025_REG_MIN] & 0x7f);
233 dt->tm_hour = bcd2bin(date[RX8025_REG_HOUR] & 0x3f);
235 dt->tm_hour = bcd2bin(date[RX8025_REG_HOUR] & 0x1f) % 12
236 + (date[RX8025_REG_HOUR] & 0x20 ? 12 : 0);
238 dt->tm_mday = bcd2bin(date[RX8025_REG_MDAY] & 0x3f);
239 dt->tm_mon = bcd2bin(date[RX8025_REG_MONTH] & 0x1f) - 1;
240 dt->tm_year = bcd2bin(date[RX8025_REG_YEAR]) + 100;
242 dev_dbg(dev, "%s: date %ptRr\n", __func__, dt);
247 static int rx8025_set_time(struct device *dev, struct rtc_time *dt)
249 struct i2c_client *client = to_i2c_client(dev);
250 struct rx8025_data *rx8025 = dev_get_drvdata(dev);
254 if ((dt->tm_year < 100) || (dt->tm_year > 199))
258 * Here the read-only bits are written as "0". I'm not sure if that
261 date[RX8025_REG_SEC] = bin2bcd(dt->tm_sec);
262 date[RX8025_REG_MIN] = bin2bcd(dt->tm_min);
264 date[RX8025_REG_HOUR] = bin2bcd(dt->tm_hour);
266 date[RX8025_REG_HOUR] = (dt->tm_hour >= 12 ? 0x20 : 0)
267 | bin2bcd((dt->tm_hour + 11) % 12 + 1);
269 date[RX8025_REG_WDAY] = bin2bcd(dt->tm_wday);
270 date[RX8025_REG_MDAY] = bin2bcd(dt->tm_mday);
271 date[RX8025_REG_MONTH] = bin2bcd(dt->tm_mon + 1);
272 date[RX8025_REG_YEAR] = bin2bcd(dt->tm_year - 100);
274 dev_dbg(dev, "%s: write %7ph\n", __func__, date);
276 ret = rx8025_write_regs(client, RX8025_REG_SEC, 7, date);
280 return rx8025_reset_validity(client);
283 static int rx8025_init_client(struct i2c_client *client)
285 struct rx8025_data *rx8025 = i2c_get_clientdata(client);
291 err = rx8025_read_regs(client, RX8025_REG_CTRL1, 2, ctrl);
295 /* Keep test bit zero ! */
296 rx8025->ctrl1 = ctrl[0] & ~RX8025_BIT_CTRL1_TEST;
298 if (ctrl[1] & (RX8025_BIT_CTRL2_DAFG | RX8025_BIT_CTRL2_WAFG)) {
299 dev_warn(&client->dev, "Alarm was detected\n");
303 if (ctrl[1] & RX8025_BIT_CTRL2_CTFG)
308 ctrl2 &= ~(RX8025_BIT_CTRL2_CTFG | RX8025_BIT_CTRL2_WAFG |
309 RX8025_BIT_CTRL2_DAFG);
311 err = rx8025_write_reg(client, RX8025_REG_CTRL2, ctrl2);
314 if (rx8025->model == model_rx_8035) {
315 /* In RX-8035, 12/24 flag is in the hour register */
316 hour_reg = rx8025_read_reg(client, RX8025_REG_HOUR);
319 rx8025->is_24 = (hour_reg & RX8035_BIT_HOUR_1224);
321 rx8025->is_24 = (ctrl[1] & RX8025_BIT_CTRL1_1224);
328 static int rx8025_read_alarm(struct device *dev, struct rtc_wkalrm *t)
330 struct i2c_client *client = to_i2c_client(dev);
331 struct rx8025_data *rx8025 = dev_get_drvdata(dev);
335 if (client->irq <= 0)
338 err = rx8025_read_regs(client, RX8025_REG_ALDMIN, 2, ald);
342 ctrl2 = rx8025_read_reg(client, RX8025_REG_CTRL2);
346 dev_dbg(dev, "%s: read alarm 0x%02x 0x%02x ctrl2 %02x\n",
347 __func__, ald[0], ald[1], ctrl2);
349 /* Hardware alarms precision is 1 minute! */
351 t->time.tm_min = bcd2bin(ald[0] & 0x7f);
353 t->time.tm_hour = bcd2bin(ald[1] & 0x3f);
355 t->time.tm_hour = bcd2bin(ald[1] & 0x1f) % 12
356 + (ald[1] & 0x20 ? 12 : 0);
358 dev_dbg(dev, "%s: date: %ptRr\n", __func__, &t->time);
359 t->enabled = !!(rx8025->ctrl1 & RX8025_BIT_CTRL1_DALE);
360 t->pending = (ctrl2 & RX8025_BIT_CTRL2_DAFG) && t->enabled;
365 static int rx8025_set_alarm(struct device *dev, struct rtc_wkalrm *t)
367 struct i2c_client *client = to_i2c_client(dev);
368 struct rx8025_data *rx8025 = dev_get_drvdata(dev);
372 if (client->irq <= 0)
376 * Hardware alarm precision is 1 minute!
377 * round up to nearest minute
379 if (t->time.tm_sec) {
380 time64_t alarm_time = rtc_tm_to_time64(&t->time);
382 alarm_time += 60 - t->time.tm_sec;
383 rtc_time64_to_tm(alarm_time, &t->time);
386 ald[0] = bin2bcd(t->time.tm_min);
388 ald[1] = bin2bcd(t->time.tm_hour);
390 ald[1] = (t->time.tm_hour >= 12 ? 0x20 : 0)
391 | bin2bcd((t->time.tm_hour + 11) % 12 + 1);
393 dev_dbg(dev, "%s: write 0x%02x 0x%02x\n", __func__, ald[0], ald[1]);
395 if (rx8025->ctrl1 & RX8025_BIT_CTRL1_DALE) {
396 rx8025->ctrl1 &= ~RX8025_BIT_CTRL1_DALE;
397 err = rx8025_write_reg(client, RX8025_REG_CTRL1,
402 err = rx8025_write_regs(client, RX8025_REG_ALDMIN, 2, ald);
407 rx8025->ctrl1 |= RX8025_BIT_CTRL1_DALE;
408 err = rx8025_write_reg(client, RX8025_REG_CTRL1,
417 static int rx8025_alarm_irq_enable(struct device *dev, unsigned int enabled)
419 struct i2c_client *client = to_i2c_client(dev);
420 struct rx8025_data *rx8025 = dev_get_drvdata(dev);
424 ctrl1 = rx8025->ctrl1;
426 ctrl1 |= RX8025_BIT_CTRL1_DALE;
428 ctrl1 &= ~RX8025_BIT_CTRL1_DALE;
430 if (ctrl1 != rx8025->ctrl1) {
431 rx8025->ctrl1 = ctrl1;
432 err = rx8025_write_reg(client, RX8025_REG_CTRL1,
440 static const struct rtc_class_ops rx8025_rtc_ops = {
441 .read_time = rx8025_get_time,
442 .set_time = rx8025_set_time,
443 .read_alarm = rx8025_read_alarm,
444 .set_alarm = rx8025_set_alarm,
445 .alarm_irq_enable = rx8025_alarm_irq_enable,
449 * Clock precision adjustment support
451 * According to the RX8025 SA/NB application manual the frequency and
452 * temperature characteristics can be approximated using the following
455 * df = a * (ut - t)**2
457 * df: Frequency deviation in any temperature
458 * a : Coefficient = (-35 +-5) * 10**-9
459 * ut: Ultimate temperature in degree = +25 +-5 degree
460 * t : Any temperature in degree
462 * Note that the clock adjustment in ppb must be entered (which is
463 * the negative value of the deviation).
465 static int rx8025_get_clock_adjust(struct device *dev, int *adj)
467 struct i2c_client *client = to_i2c_client(dev);
470 digoff = rx8025_read_reg(client, RX8025_REG_DIGOFF);
474 *adj = digoff >= 64 ? digoff - 128 : digoff;
477 *adj *= -RX8025_ADJ_RESOLUTION;
482 static int rx8025_set_clock_adjust(struct device *dev, int adj)
484 struct i2c_client *client = to_i2c_client(dev);
488 adj /= -RX8025_ADJ_RESOLUTION;
489 if (adj > RX8025_ADJ_DATA_MAX)
490 adj = RX8025_ADJ_DATA_MAX;
491 else if (adj < RX8025_ADJ_DATA_MIN)
492 adj = RX8025_ADJ_DATA_MIN;
499 err = rx8025_write_reg(client, RX8025_REG_DIGOFF, digoff);
503 dev_dbg(dev, "%s: write 0x%02x\n", __func__, digoff);
508 static ssize_t rx8025_sysfs_show_clock_adjust(struct device *dev,
509 struct device_attribute *attr,
514 err = rx8025_get_clock_adjust(dev, &adj);
518 return sprintf(buf, "%d\n", adj);
521 static ssize_t rx8025_sysfs_store_clock_adjust(struct device *dev,
522 struct device_attribute *attr,
523 const char *buf, size_t count)
527 if (sscanf(buf, "%i", &adj) != 1)
530 err = rx8025_set_clock_adjust(dev, adj);
532 return err ? err : count;
535 static DEVICE_ATTR(clock_adjust_ppb, S_IRUGO | S_IWUSR,
536 rx8025_sysfs_show_clock_adjust,
537 rx8025_sysfs_store_clock_adjust);
539 static int rx8025_sysfs_register(struct device *dev)
541 return device_create_file(dev, &dev_attr_clock_adjust_ppb);
544 static void rx8025_sysfs_unregister(struct device *dev)
546 device_remove_file(dev, &dev_attr_clock_adjust_ppb);
549 static int rx8025_probe(struct i2c_client *client,
550 const struct i2c_device_id *id)
552 struct i2c_adapter *adapter = client->adapter;
553 struct rx8025_data *rx8025;
556 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA
557 | I2C_FUNC_SMBUS_I2C_BLOCK)) {
558 dev_err(&adapter->dev,
559 "doesn't support required functionality\n");
563 rx8025 = devm_kzalloc(&client->dev, sizeof(*rx8025), GFP_KERNEL);
567 i2c_set_clientdata(client, rx8025);
570 rx8025->model = id->driver_data;
572 err = rx8025_init_client(client);
576 rx8025->rtc = devm_rtc_device_register(&client->dev, client->name,
577 &rx8025_rtc_ops, THIS_MODULE);
578 if (IS_ERR(rx8025->rtc)) {
579 dev_err(&client->dev, "unable to register the class device\n");
580 return PTR_ERR(rx8025->rtc);
583 if (client->irq > 0) {
584 dev_info(&client->dev, "IRQ %d supplied\n", client->irq);
585 err = devm_request_threaded_irq(&client->dev, client->irq, NULL,
590 dev_err(&client->dev, "unable to request IRQ, alarms disabled\n");
595 rx8025->rtc->max_user_freq = 1;
597 /* the rx8025 alarm only supports a minute accuracy */
598 rx8025->rtc->uie_unsupported = 1;
600 err = rx8025_sysfs_register(&client->dev);
604 static int rx8025_remove(struct i2c_client *client)
606 rx8025_sysfs_unregister(&client->dev);
610 static struct i2c_driver rx8025_driver = {
612 .name = "rtc-rx8025",
614 .probe = rx8025_probe,
615 .remove = rx8025_remove,
616 .id_table = rx8025_id,
619 module_i2c_driver(rx8025_driver);
621 MODULE_AUTHOR("Wolfgang Grandegger <wg@grandegger.com>");
622 MODULE_DESCRIPTION("RX-8025 SA/NB RTC driver");
623 MODULE_LICENSE("GPL");