1 // SPDX-License-Identifier: GPL-2.0-only
3 * rtc-fm3130.c - RTC driver for Ramtron FM3130 I2C chip.
5 * Copyright (C) 2008 Sergey Lapin
6 * Based on ds1307 driver by James Chapman and David Brownell
9 #include <linux/module.h>
10 #include <linux/i2c.h>
11 #include <linux/rtc.h>
12 #include <linux/bcd.h>
13 #include <linux/slab.h>
15 #define FM3130_RTC_CONTROL (0x0)
16 #define FM3130_CAL_CONTROL (0x1)
17 #define FM3130_RTC_SECONDS (0x2)
18 #define FM3130_RTC_MINUTES (0x3)
19 #define FM3130_RTC_HOURS (0x4)
20 #define FM3130_RTC_DAY (0x5)
21 #define FM3130_RTC_DATE (0x6)
22 #define FM3130_RTC_MONTHS (0x7)
23 #define FM3130_RTC_YEARS (0x8)
25 #define FM3130_ALARM_SECONDS (0x9)
26 #define FM3130_ALARM_MINUTES (0xa)
27 #define FM3130_ALARM_HOURS (0xb)
28 #define FM3130_ALARM_DATE (0xc)
29 #define FM3130_ALARM_MONTHS (0xd)
30 #define FM3130_ALARM_WP_CONTROL (0xe)
32 #define FM3130_CAL_CONTROL_BIT_nOSCEN (1 << 7) /* Osciallator enabled */
33 #define FM3130_RTC_CONTROL_BIT_LB (1 << 7) /* Low battery */
34 #define FM3130_RTC_CONTROL_BIT_AF (1 << 6) /* Alarm flag */
35 #define FM3130_RTC_CONTROL_BIT_CF (1 << 5) /* Century overflow */
36 #define FM3130_RTC_CONTROL_BIT_POR (1 << 4) /* Power on reset */
37 #define FM3130_RTC_CONTROL_BIT_AEN (1 << 3) /* Alarm enable */
38 #define FM3130_RTC_CONTROL_BIT_CAL (1 << 2) /* Calibration mode */
39 #define FM3130_RTC_CONTROL_BIT_WRITE (1 << 1) /* W=1 -> write mode W=0 normal */
40 #define FM3130_RTC_CONTROL_BIT_READ (1 << 0) /* R=1 -> read mode R=0 normal */
42 #define FM3130_CLOCK_REGS 7
43 #define FM3130_ALARM_REGS 5
49 struct i2c_msg msg[4];
50 struct i2c_client *client;
51 struct rtc_device *rtc;
55 static const struct i2c_device_id fm3130_id[] = {
59 MODULE_DEVICE_TABLE(i2c, fm3130_id);
61 #define FM3130_MODE_NORMAL 0
62 #define FM3130_MODE_WRITE 1
63 #define FM3130_MODE_READ 2
65 static void fm3130_rtc_mode(struct device *dev, int mode)
67 struct fm3130 *fm3130 = dev_get_drvdata(dev);
69 fm3130->regs[FM3130_RTC_CONTROL] =
70 i2c_smbus_read_byte_data(fm3130->client, FM3130_RTC_CONTROL);
72 case FM3130_MODE_NORMAL:
73 fm3130->regs[FM3130_RTC_CONTROL] &=
74 ~(FM3130_RTC_CONTROL_BIT_WRITE |
75 FM3130_RTC_CONTROL_BIT_READ);
77 case FM3130_MODE_WRITE:
78 fm3130->regs[FM3130_RTC_CONTROL] |= FM3130_RTC_CONTROL_BIT_WRITE;
80 case FM3130_MODE_READ:
81 fm3130->regs[FM3130_RTC_CONTROL] |= FM3130_RTC_CONTROL_BIT_READ;
84 dev_dbg(dev, "invalid mode %d\n", mode);
88 i2c_smbus_write_byte_data(fm3130->client,
89 FM3130_RTC_CONTROL, fm3130->regs[FM3130_RTC_CONTROL]);
92 static int fm3130_get_time(struct device *dev, struct rtc_time *t)
94 struct fm3130 *fm3130 = dev_get_drvdata(dev);
97 if (!fm3130->data_valid) {
98 /* We have invalid data in RTC, probably due
99 to battery faults or other problems. Return EIO
100 for now, it will allow us to set data later instead
101 of error during probing which disables device */
104 fm3130_rtc_mode(dev, FM3130_MODE_READ);
106 /* read the RTC date and time registers all at once */
107 tmp = i2c_transfer(fm3130->client->adapter, fm3130->msg, 2);
109 dev_err(dev, "%s error %d\n", "read", tmp);
113 fm3130_rtc_mode(dev, FM3130_MODE_NORMAL);
115 dev_dbg(dev, "%s: %15ph\n", "read", fm3130->regs);
117 t->tm_sec = bcd2bin(fm3130->regs[FM3130_RTC_SECONDS] & 0x7f);
118 t->tm_min = bcd2bin(fm3130->regs[FM3130_RTC_MINUTES] & 0x7f);
119 tmp = fm3130->regs[FM3130_RTC_HOURS] & 0x3f;
120 t->tm_hour = bcd2bin(tmp);
121 t->tm_wday = bcd2bin(fm3130->regs[FM3130_RTC_DAY] & 0x07) - 1;
122 t->tm_mday = bcd2bin(fm3130->regs[FM3130_RTC_DATE] & 0x3f);
123 tmp = fm3130->regs[FM3130_RTC_MONTHS] & 0x1f;
124 t->tm_mon = bcd2bin(tmp) - 1;
126 /* assume 20YY not 19YY, and ignore CF bit */
127 t->tm_year = bcd2bin(fm3130->regs[FM3130_RTC_YEARS]) + 100;
129 dev_dbg(dev, "%s secs=%d, mins=%d, "
130 "hours=%d, mday=%d, mon=%d, year=%d, wday=%d\n",
131 "read", t->tm_sec, t->tm_min,
132 t->tm_hour, t->tm_mday,
133 t->tm_mon, t->tm_year, t->tm_wday);
139 static int fm3130_set_time(struct device *dev, struct rtc_time *t)
141 struct fm3130 *fm3130 = dev_get_drvdata(dev);
143 u8 *buf = fm3130->regs;
145 dev_dbg(dev, "%s secs=%d, mins=%d, "
146 "hours=%d, mday=%d, mon=%d, year=%d, wday=%d\n",
147 "write", t->tm_sec, t->tm_min,
148 t->tm_hour, t->tm_mday,
149 t->tm_mon, t->tm_year, t->tm_wday);
151 /* first register addr */
152 buf[FM3130_RTC_SECONDS] = bin2bcd(t->tm_sec);
153 buf[FM3130_RTC_MINUTES] = bin2bcd(t->tm_min);
154 buf[FM3130_RTC_HOURS] = bin2bcd(t->tm_hour);
155 buf[FM3130_RTC_DAY] = bin2bcd(t->tm_wday + 1);
156 buf[FM3130_RTC_DATE] = bin2bcd(t->tm_mday);
157 buf[FM3130_RTC_MONTHS] = bin2bcd(t->tm_mon + 1);
159 /* assume 20YY not 19YY */
160 tmp = t->tm_year - 100;
161 buf[FM3130_RTC_YEARS] = bin2bcd(tmp);
163 dev_dbg(dev, "%s: %15ph\n", "write", buf);
165 fm3130_rtc_mode(dev, FM3130_MODE_WRITE);
167 /* Writing time registers, we don't support multibyte transfers */
168 for (i = 0; i < FM3130_CLOCK_REGS; i++) {
169 i2c_smbus_write_byte_data(fm3130->client,
170 FM3130_RTC_SECONDS + i,
171 fm3130->regs[FM3130_RTC_SECONDS + i]);
174 fm3130_rtc_mode(dev, FM3130_MODE_NORMAL);
176 /* We assume here that data are valid once written */
177 if (!fm3130->data_valid)
178 fm3130->data_valid = 1;
182 static int fm3130_read_alarm(struct device *dev, struct rtc_wkalrm *alrm)
184 struct fm3130 *fm3130 = dev_get_drvdata(dev);
186 struct rtc_time *tm = &alrm->time;
188 if (!fm3130->alarm_valid) {
190 * We have invalid alarm in RTC, probably due to battery faults
191 * or other problems. Return EIO for now, it will allow us to
192 * set alarm value later instead of error during probing which
198 /* read the RTC alarm registers all at once */
199 tmp = i2c_transfer(fm3130->client->adapter, &fm3130->msg[2], 2);
201 dev_err(dev, "%s error %d\n", "read", tmp);
204 dev_dbg(dev, "alarm read %02x %02x %02x %02x %02x\n",
205 fm3130->regs[FM3130_ALARM_SECONDS],
206 fm3130->regs[FM3130_ALARM_MINUTES],
207 fm3130->regs[FM3130_ALARM_HOURS],
208 fm3130->regs[FM3130_ALARM_DATE],
209 fm3130->regs[FM3130_ALARM_MONTHS]);
211 tm->tm_sec = bcd2bin(fm3130->regs[FM3130_ALARM_SECONDS] & 0x7F);
212 tm->tm_min = bcd2bin(fm3130->regs[FM3130_ALARM_MINUTES] & 0x7F);
213 tm->tm_hour = bcd2bin(fm3130->regs[FM3130_ALARM_HOURS] & 0x3F);
214 tm->tm_mday = bcd2bin(fm3130->regs[FM3130_ALARM_DATE] & 0x3F);
215 tm->tm_mon = bcd2bin(fm3130->regs[FM3130_ALARM_MONTHS] & 0x1F);
218 tm->tm_mon -= 1; /* RTC is 1-12, tm_mon is 0-11 */
220 dev_dbg(dev, "%s secs=%d, mins=%d, "
221 "hours=%d, mday=%d, mon=%d, year=%d, wday=%d\n",
222 "read alarm", tm->tm_sec, tm->tm_min,
223 tm->tm_hour, tm->tm_mday,
224 tm->tm_mon, tm->tm_year, tm->tm_wday);
226 /* check if alarm enabled */
227 fm3130->regs[FM3130_RTC_CONTROL] =
228 i2c_smbus_read_byte_data(fm3130->client, FM3130_RTC_CONTROL);
230 if ((fm3130->regs[FM3130_RTC_CONTROL] & FM3130_RTC_CONTROL_BIT_AEN) &&
231 (~fm3130->regs[FM3130_RTC_CONTROL] &
232 FM3130_RTC_CONTROL_BIT_CAL)) {
239 static int fm3130_set_alarm(struct device *dev, struct rtc_wkalrm *alrm)
241 struct fm3130 *fm3130 = dev_get_drvdata(dev);
242 struct rtc_time *tm = &alrm->time;
245 dev_dbg(dev, "%s secs=%d, mins=%d, "
246 "hours=%d, mday=%d, mon=%d, year=%d, wday=%d\n",
247 "write alarm", tm->tm_sec, tm->tm_min,
248 tm->tm_hour, tm->tm_mday,
249 tm->tm_mon, tm->tm_year, tm->tm_wday);
251 fm3130->regs[FM3130_ALARM_SECONDS] =
252 (tm->tm_sec != -1) ? bin2bcd(tm->tm_sec) : 0x80;
254 fm3130->regs[FM3130_ALARM_MINUTES] =
255 (tm->tm_min != -1) ? bin2bcd(tm->tm_min) : 0x80;
257 fm3130->regs[FM3130_ALARM_HOURS] =
258 (tm->tm_hour != -1) ? bin2bcd(tm->tm_hour) : 0x80;
260 fm3130->regs[FM3130_ALARM_DATE] =
261 (tm->tm_mday != -1) ? bin2bcd(tm->tm_mday) : 0x80;
263 fm3130->regs[FM3130_ALARM_MONTHS] =
264 (tm->tm_mon != -1) ? bin2bcd(tm->tm_mon + 1) : 0x80;
266 dev_dbg(dev, "alarm write %02x %02x %02x %02x %02x\n",
267 fm3130->regs[FM3130_ALARM_SECONDS],
268 fm3130->regs[FM3130_ALARM_MINUTES],
269 fm3130->regs[FM3130_ALARM_HOURS],
270 fm3130->regs[FM3130_ALARM_DATE],
271 fm3130->regs[FM3130_ALARM_MONTHS]);
272 /* Writing time registers, we don't support multibyte transfers */
273 for (i = 0; i < FM3130_ALARM_REGS; i++) {
274 i2c_smbus_write_byte_data(fm3130->client,
275 FM3130_ALARM_SECONDS + i,
276 fm3130->regs[FM3130_ALARM_SECONDS + i]);
278 fm3130->regs[FM3130_RTC_CONTROL] =
279 i2c_smbus_read_byte_data(fm3130->client, FM3130_RTC_CONTROL);
281 /* enable or disable alarm */
283 i2c_smbus_write_byte_data(fm3130->client, FM3130_RTC_CONTROL,
284 (fm3130->regs[FM3130_RTC_CONTROL] &
285 ~(FM3130_RTC_CONTROL_BIT_CAL)) |
286 FM3130_RTC_CONTROL_BIT_AEN);
288 i2c_smbus_write_byte_data(fm3130->client, FM3130_RTC_CONTROL,
289 fm3130->regs[FM3130_RTC_CONTROL] &
290 ~(FM3130_RTC_CONTROL_BIT_CAL) &
291 ~(FM3130_RTC_CONTROL_BIT_AEN));
294 /* We assume here that data is valid once written */
295 if (!fm3130->alarm_valid)
296 fm3130->alarm_valid = 1;
301 static int fm3130_alarm_irq_enable(struct device *dev, unsigned int enabled)
303 struct fm3130 *fm3130 = dev_get_drvdata(dev);
306 fm3130->regs[FM3130_RTC_CONTROL] =
307 i2c_smbus_read_byte_data(fm3130->client, FM3130_RTC_CONTROL);
309 dev_dbg(dev, "alarm_irq_enable: enable=%d, FM3130_RTC_CONTROL=%02x\n",
310 enabled, fm3130->regs[FM3130_RTC_CONTROL]);
313 case 0: /* alarm off */
314 ret = i2c_smbus_write_byte_data(fm3130->client,
315 FM3130_RTC_CONTROL, fm3130->regs[FM3130_RTC_CONTROL] &
316 ~(FM3130_RTC_CONTROL_BIT_CAL) &
317 ~(FM3130_RTC_CONTROL_BIT_AEN));
319 case 1: /* alarm on */
320 ret = i2c_smbus_write_byte_data(fm3130->client,
321 FM3130_RTC_CONTROL, (fm3130->regs[FM3130_RTC_CONTROL] &
322 ~(FM3130_RTC_CONTROL_BIT_CAL)) |
323 FM3130_RTC_CONTROL_BIT_AEN);
333 static const struct rtc_class_ops fm3130_rtc_ops = {
334 .read_time = fm3130_get_time,
335 .set_time = fm3130_set_time,
336 .read_alarm = fm3130_read_alarm,
337 .set_alarm = fm3130_set_alarm,
338 .alarm_irq_enable = fm3130_alarm_irq_enable,
341 static struct i2c_driver fm3130_driver;
343 static int fm3130_probe(struct i2c_client *client)
345 struct fm3130 *fm3130;
348 struct i2c_adapter *adapter = client->adapter;
350 if (!i2c_check_functionality(adapter,
351 I2C_FUNC_I2C | I2C_FUNC_SMBUS_WRITE_BYTE_DATA))
354 fm3130 = devm_kzalloc(&client->dev, sizeof(struct fm3130), GFP_KERNEL);
359 fm3130->client = client;
360 i2c_set_clientdata(client, fm3130);
361 fm3130->reg_addr_time = FM3130_RTC_SECONDS;
362 fm3130->reg_addr_alarm = FM3130_ALARM_SECONDS;
364 /* Messages to read time */
365 fm3130->msg[0].addr = client->addr;
366 fm3130->msg[0].flags = 0;
367 fm3130->msg[0].len = 1;
368 fm3130->msg[0].buf = &fm3130->reg_addr_time;
370 fm3130->msg[1].addr = client->addr;
371 fm3130->msg[1].flags = I2C_M_RD;
372 fm3130->msg[1].len = FM3130_CLOCK_REGS;
373 fm3130->msg[1].buf = &fm3130->regs[FM3130_RTC_SECONDS];
375 /* Messages to read alarm */
376 fm3130->msg[2].addr = client->addr;
377 fm3130->msg[2].flags = 0;
378 fm3130->msg[2].len = 1;
379 fm3130->msg[2].buf = &fm3130->reg_addr_alarm;
381 fm3130->msg[3].addr = client->addr;
382 fm3130->msg[3].flags = I2C_M_RD;
383 fm3130->msg[3].len = FM3130_ALARM_REGS;
384 fm3130->msg[3].buf = &fm3130->regs[FM3130_ALARM_SECONDS];
386 fm3130->alarm_valid = 0;
387 fm3130->data_valid = 0;
389 tmp = i2c_transfer(adapter, fm3130->msg, 4);
391 dev_dbg(&client->dev, "read error %d\n", tmp);
396 fm3130->regs[FM3130_RTC_CONTROL] =
397 i2c_smbus_read_byte_data(client, FM3130_RTC_CONTROL);
398 fm3130->regs[FM3130_CAL_CONTROL] =
399 i2c_smbus_read_byte_data(client, FM3130_CAL_CONTROL);
401 /* Disabling calibration mode */
402 if (fm3130->regs[FM3130_RTC_CONTROL] & FM3130_RTC_CONTROL_BIT_CAL) {
403 i2c_smbus_write_byte_data(client, FM3130_RTC_CONTROL,
404 fm3130->regs[FM3130_RTC_CONTROL] &
405 ~(FM3130_RTC_CONTROL_BIT_CAL));
406 dev_warn(&client->dev, "Disabling calibration mode!\n");
409 /* Disabling read and write modes */
410 if (fm3130->regs[FM3130_RTC_CONTROL] & FM3130_RTC_CONTROL_BIT_WRITE ||
411 fm3130->regs[FM3130_RTC_CONTROL] & FM3130_RTC_CONTROL_BIT_READ) {
412 i2c_smbus_write_byte_data(client, FM3130_RTC_CONTROL,
413 fm3130->regs[FM3130_RTC_CONTROL] &
414 ~(FM3130_RTC_CONTROL_BIT_READ |
415 FM3130_RTC_CONTROL_BIT_WRITE));
416 dev_warn(&client->dev, "Disabling READ or WRITE mode!\n");
419 /* oscillator off? turn it on, so clock can tick. */
420 if (fm3130->regs[FM3130_CAL_CONTROL] & FM3130_CAL_CONTROL_BIT_nOSCEN)
421 i2c_smbus_write_byte_data(client, FM3130_CAL_CONTROL,
422 fm3130->regs[FM3130_CAL_CONTROL] &
423 ~(FM3130_CAL_CONTROL_BIT_nOSCEN));
425 /* low battery? clear flag, and warn */
426 if (fm3130->regs[FM3130_RTC_CONTROL] & FM3130_RTC_CONTROL_BIT_LB) {
427 i2c_smbus_write_byte_data(client, FM3130_RTC_CONTROL,
428 fm3130->regs[FM3130_RTC_CONTROL] &
429 ~(FM3130_RTC_CONTROL_BIT_LB));
430 dev_warn(&client->dev, "Low battery!\n");
433 /* check if Power On Reset bit is set */
434 if (fm3130->regs[FM3130_RTC_CONTROL] & FM3130_RTC_CONTROL_BIT_POR) {
435 i2c_smbus_write_byte_data(client, FM3130_RTC_CONTROL,
436 fm3130->regs[FM3130_RTC_CONTROL] &
437 ~FM3130_RTC_CONTROL_BIT_POR);
438 dev_dbg(&client->dev, "POR bit is set\n");
440 /* ACS is controlled by alarm */
441 i2c_smbus_write_byte_data(client, FM3130_ALARM_WP_CONTROL, 0x80);
443 /* alarm registers sanity check */
444 tmp = bcd2bin(fm3130->regs[FM3130_RTC_SECONDS] & 0x7f);
448 tmp = bcd2bin(fm3130->regs[FM3130_RTC_MINUTES] & 0x7f);
452 tmp = bcd2bin(fm3130->regs[FM3130_RTC_HOURS] & 0x3f);
456 tmp = bcd2bin(fm3130->regs[FM3130_RTC_DATE] & 0x3f);
457 if (tmp == 0 || tmp > 31)
460 tmp = bcd2bin(fm3130->regs[FM3130_RTC_MONTHS] & 0x1f);
461 if (tmp == 0 || tmp > 12)
464 fm3130->alarm_valid = 1;
468 /* clock registers sanity chek */
469 tmp = bcd2bin(fm3130->regs[FM3130_RTC_SECONDS] & 0x7f);
473 tmp = bcd2bin(fm3130->regs[FM3130_RTC_MINUTES] & 0x7f);
477 tmp = bcd2bin(fm3130->regs[FM3130_RTC_HOURS] & 0x3f);
481 tmp = bcd2bin(fm3130->regs[FM3130_RTC_DAY] & 0x7);
482 if (tmp == 0 || tmp > 7)
485 tmp = bcd2bin(fm3130->regs[FM3130_RTC_DATE] & 0x3f);
486 if (tmp == 0 || tmp > 31)
489 tmp = bcd2bin(fm3130->regs[FM3130_RTC_MONTHS] & 0x1f);
490 if (tmp == 0 || tmp > 12)
493 fm3130->data_valid = 1;
497 if (!fm3130->data_valid || !fm3130->alarm_valid)
498 dev_dbg(&client->dev, "%s: %15ph\n", "bogus registers",
501 /* We won't bail out here because we just got invalid data.
502 Time setting from u-boot doesn't work anyway */
503 fm3130->rtc = devm_rtc_device_register(&client->dev, client->name,
504 &fm3130_rtc_ops, THIS_MODULE);
505 if (IS_ERR(fm3130->rtc)) {
506 err = PTR_ERR(fm3130->rtc);
507 dev_err(&client->dev,
508 "unable to register the class device\n");
516 static struct i2c_driver fm3130_driver = {
518 .name = "rtc-fm3130",
520 .probe_new = fm3130_probe,
521 .id_table = fm3130_id,
524 module_i2c_driver(fm3130_driver);
526 MODULE_DESCRIPTION("RTC driver for FM3130");
527 MODULE_AUTHOR("Sergey Lapin <slapin@ossfans.org>");
528 MODULE_LICENSE("GPL");