2 * RTC client/driver for the Maxim/Dallas DS3232/DS3234 Real-Time Clock
4 * Copyright (C) 2009-2011 Freescale Semiconductor.
6 * Copyright (C) 2008 MIMOMax Wireless Ltd.
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/interrupt.h>
19 #include <linux/i2c.h>
20 #include <linux/spi/spi.h>
21 #include <linux/rtc.h>
22 #include <linux/bcd.h>
23 #include <linux/slab.h>
24 #include <linux/regmap.h>
25 #include <linux/hwmon.h>
27 #define DS3232_REG_SECONDS 0x00
28 #define DS3232_REG_MINUTES 0x01
29 #define DS3232_REG_HOURS 0x02
30 #define DS3232_REG_AMPM 0x02
31 #define DS3232_REG_DAY 0x03
32 #define DS3232_REG_DATE 0x04
33 #define DS3232_REG_MONTH 0x05
34 #define DS3232_REG_CENTURY 0x05
35 #define DS3232_REG_YEAR 0x06
36 #define DS3232_REG_ALARM1 0x07 /* Alarm 1 BASE */
37 #define DS3232_REG_ALARM2 0x0B /* Alarm 2 BASE */
38 #define DS3232_REG_CR 0x0E /* Control register */
39 # define DS3232_REG_CR_nEOSC 0x80
40 # define DS3232_REG_CR_INTCN 0x04
41 # define DS3232_REG_CR_A2IE 0x02
42 # define DS3232_REG_CR_A1IE 0x01
44 #define DS3232_REG_SR 0x0F /* control/status register */
45 # define DS3232_REG_SR_OSF 0x80
46 # define DS3232_REG_SR_BSY 0x04
47 # define DS3232_REG_SR_A2F 0x02
48 # define DS3232_REG_SR_A1F 0x01
50 #define DS3232_REG_TEMPERATURE 0x11
51 #define DS3232_REG_SRAM_START 0x14
52 #define DS3232_REG_SRAM_END 0xFF
54 #define DS3232_REG_SRAM_SIZE 236
58 struct regmap *regmap;
60 struct rtc_device *rtc;
65 static int ds3232_check_rtc_status(struct device *dev)
67 struct ds3232 *ds3232 = dev_get_drvdata(dev);
71 ret = regmap_read(ds3232->regmap, DS3232_REG_SR, &stat);
75 if (stat & DS3232_REG_SR_OSF)
77 "oscillator discontinuity flagged, "
80 stat &= ~(DS3232_REG_SR_OSF | DS3232_REG_SR_A1F | DS3232_REG_SR_A2F);
82 ret = regmap_write(ds3232->regmap, DS3232_REG_SR, stat);
86 /* If the alarm is pending, clear it before requesting
87 * the interrupt, so an interrupt event isn't reported
88 * before everything is initialized.
91 ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
95 control &= ~(DS3232_REG_CR_A1IE | DS3232_REG_CR_A2IE);
96 control |= DS3232_REG_CR_INTCN;
98 return regmap_write(ds3232->regmap, DS3232_REG_CR, control);
101 static int ds3232_read_time(struct device *dev, struct rtc_time *time)
103 struct ds3232 *ds3232 = dev_get_drvdata(dev);
106 unsigned int year, month, day, hour, minute, second;
107 unsigned int week, twelve_hr, am_pm;
108 unsigned int century, add_century = 0;
110 ret = regmap_bulk_read(ds3232->regmap, DS3232_REG_SECONDS, buf, 7);
122 /* Extract additional information for AM/PM and century */
124 twelve_hr = hour & 0x40;
126 century = month & 0x80;
128 /* Write to rtc_time structure */
130 time->tm_sec = bcd2bin(second);
131 time->tm_min = bcd2bin(minute);
133 /* Convert to 24 hr */
135 time->tm_hour = bcd2bin(hour & 0x1F) + 12;
137 time->tm_hour = bcd2bin(hour & 0x1F);
139 time->tm_hour = bcd2bin(hour);
142 /* Day of the week in linux range is 0~6 while 1~7 in RTC chip */
143 time->tm_wday = bcd2bin(week) - 1;
144 time->tm_mday = bcd2bin(day);
145 /* linux tm_mon range:0~11, while month range is 1~12 in RTC chip */
146 time->tm_mon = bcd2bin(month & 0x7F) - 1;
150 time->tm_year = bcd2bin(year) + add_century;
155 static int ds3232_set_time(struct device *dev, struct rtc_time *time)
157 struct ds3232 *ds3232 = dev_get_drvdata(dev);
160 /* Extract time from rtc_time and load into ds3232*/
162 buf[0] = bin2bcd(time->tm_sec);
163 buf[1] = bin2bcd(time->tm_min);
164 buf[2] = bin2bcd(time->tm_hour);
165 /* Day of the week in linux range is 0~6 while 1~7 in RTC chip */
166 buf[3] = bin2bcd(time->tm_wday + 1);
167 buf[4] = bin2bcd(time->tm_mday); /* Date */
168 /* linux tm_mon range:0~11, while month range is 1~12 in RTC chip */
169 buf[5] = bin2bcd(time->tm_mon + 1);
170 if (time->tm_year >= 100) {
172 buf[6] = bin2bcd(time->tm_year - 100);
174 buf[6] = bin2bcd(time->tm_year);
177 return regmap_bulk_write(ds3232->regmap, DS3232_REG_SECONDS, buf, 7);
181 * DS3232 has two alarm, we only use alarm1
182 * According to linux specification, only support one-shot alarm
183 * no periodic alarm mode
185 static int ds3232_read_alarm(struct device *dev, struct rtc_wkalrm *alarm)
187 struct ds3232 *ds3232 = dev_get_drvdata(dev);
192 ret = regmap_read(ds3232->regmap, DS3232_REG_SR, &stat);
195 ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
198 ret = regmap_bulk_read(ds3232->regmap, DS3232_REG_ALARM1, buf, 4);
202 alarm->time.tm_sec = bcd2bin(buf[0] & 0x7F);
203 alarm->time.tm_min = bcd2bin(buf[1] & 0x7F);
204 alarm->time.tm_hour = bcd2bin(buf[2] & 0x7F);
205 alarm->time.tm_mday = bcd2bin(buf[3] & 0x7F);
207 alarm->enabled = !!(control & DS3232_REG_CR_A1IE);
208 alarm->pending = !!(stat & DS3232_REG_SR_A1F);
216 * linux rtc-module does not support wday alarm
217 * and only 24h time mode supported indeed
219 static int ds3232_set_alarm(struct device *dev, struct rtc_wkalrm *alarm)
221 struct ds3232 *ds3232 = dev_get_drvdata(dev);
226 if (ds3232->irq <= 0)
229 buf[0] = bin2bcd(alarm->time.tm_sec);
230 buf[1] = bin2bcd(alarm->time.tm_min);
231 buf[2] = bin2bcd(alarm->time.tm_hour);
232 buf[3] = bin2bcd(alarm->time.tm_mday);
234 /* clear alarm interrupt enable bit */
235 ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
238 control &= ~(DS3232_REG_CR_A1IE | DS3232_REG_CR_A2IE);
239 ret = regmap_write(ds3232->regmap, DS3232_REG_CR, control);
243 /* clear any pending alarm flag */
244 ret = regmap_read(ds3232->regmap, DS3232_REG_SR, &stat);
247 stat &= ~(DS3232_REG_SR_A1F | DS3232_REG_SR_A2F);
248 ret = regmap_write(ds3232->regmap, DS3232_REG_SR, stat);
252 ret = regmap_bulk_write(ds3232->regmap, DS3232_REG_ALARM1, buf, 4);
256 if (alarm->enabled) {
257 control |= DS3232_REG_CR_A1IE;
258 ret = regmap_write(ds3232->regmap, DS3232_REG_CR, control);
264 static int ds3232_update_alarm(struct device *dev, unsigned int enabled)
266 struct ds3232 *ds3232 = dev_get_drvdata(dev);
270 ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
275 /* enable alarm1 interrupt */
276 control |= DS3232_REG_CR_A1IE;
278 /* disable alarm1 interrupt */
279 control &= ~(DS3232_REG_CR_A1IE);
280 ret = regmap_write(ds3232->regmap, DS3232_REG_CR, control);
286 * Temperature sensor support for ds3232/ds3234 devices.
287 * A user-initiated temperature conversion is not started by this function,
288 * so the temperature is updated once every 64 seconds.
290 static int ds3232_hwmon_read_temp(struct device *dev, long int *mC)
292 struct ds3232 *ds3232 = dev_get_drvdata(dev);
297 ret = regmap_bulk_read(ds3232->regmap, DS3232_REG_TEMPERATURE, temp_buf,
303 * Temperature is represented as a 10-bit code with a resolution of
304 * 0.25 degree celsius and encoded in two's complement format.
306 temp = (temp_buf[0] << 8) | temp_buf[1];
313 static umode_t ds3232_hwmon_is_visible(const void *data,
314 enum hwmon_sensor_types type,
315 u32 attr, int channel)
317 if (type != hwmon_temp)
321 case hwmon_temp_input:
328 static int ds3232_hwmon_read(struct device *dev,
329 enum hwmon_sensor_types type,
330 u32 attr, int channel, long *temp)
335 case hwmon_temp_input:
336 err = ds3232_hwmon_read_temp(dev, temp);
346 static u32 ds3232_hwmon_chip_config[] = {
351 static const struct hwmon_channel_info ds3232_hwmon_chip = {
353 .config = ds3232_hwmon_chip_config,
356 static u32 ds3232_hwmon_temp_config[] = {
361 static const struct hwmon_channel_info ds3232_hwmon_temp = {
363 .config = ds3232_hwmon_temp_config,
366 static const struct hwmon_channel_info *ds3232_hwmon_info[] = {
372 static const struct hwmon_ops ds3232_hwmon_hwmon_ops = {
373 .is_visible = ds3232_hwmon_is_visible,
374 .read = ds3232_hwmon_read,
377 static const struct hwmon_chip_info ds3232_hwmon_chip_info = {
378 .ops = &ds3232_hwmon_hwmon_ops,
379 .info = ds3232_hwmon_info,
382 static void ds3232_hwmon_register(struct device *dev, const char *name)
384 struct ds3232 *ds3232 = dev_get_drvdata(dev);
385 struct device *hwmon_dev;
387 if (!IS_ENABLED(CONFIG_RTC_DRV_DS3232_HWMON))
390 hwmon_dev = devm_hwmon_device_register_with_info(dev, name, ds3232,
391 &ds3232_hwmon_chip_info,
393 if (IS_ERR(hwmon_dev)) {
394 dev_err(dev, "unable to register hwmon device %ld\n",
399 static int ds3232_alarm_irq_enable(struct device *dev, unsigned int enabled)
401 struct ds3232 *ds3232 = dev_get_drvdata(dev);
403 if (ds3232->irq <= 0)
406 return ds3232_update_alarm(dev, enabled);
409 static irqreturn_t ds3232_irq(int irq, void *dev_id)
411 struct device *dev = dev_id;
412 struct ds3232 *ds3232 = dev_get_drvdata(dev);
413 struct mutex *lock = &ds3232->rtc->ops_lock;
419 ret = regmap_read(ds3232->regmap, DS3232_REG_SR, &stat);
423 if (stat & DS3232_REG_SR_A1F) {
424 ret = regmap_read(ds3232->regmap, DS3232_REG_CR, &control);
426 dev_warn(ds3232->dev,
427 "Read Control Register error %d\n", ret);
429 /* disable alarm1 interrupt */
430 control &= ~(DS3232_REG_CR_A1IE);
431 ret = regmap_write(ds3232->regmap, DS3232_REG_CR,
434 dev_warn(ds3232->dev,
435 "Write Control Register error %d\n",
440 /* clear the alarm pend flag */
441 stat &= ~DS3232_REG_SR_A1F;
442 ret = regmap_write(ds3232->regmap, DS3232_REG_SR, stat);
444 dev_warn(ds3232->dev,
445 "Write Status Register error %d\n",
450 rtc_update_irq(ds3232->rtc, 1, RTC_AF | RTC_IRQF);
460 static const struct rtc_class_ops ds3232_rtc_ops = {
461 .read_time = ds3232_read_time,
462 .set_time = ds3232_set_time,
463 .read_alarm = ds3232_read_alarm,
464 .set_alarm = ds3232_set_alarm,
465 .alarm_irq_enable = ds3232_alarm_irq_enable,
468 static int ds3232_nvmem_read(void *priv, unsigned int offset, void *val,
471 struct regmap *ds3232_regmap = (struct regmap *)priv;
473 return regmap_bulk_read(ds3232_regmap, DS3232_REG_SRAM_START + offset,
477 static int ds3232_nvmem_write(void *priv, unsigned int offset, void *val,
480 struct regmap *ds3232_regmap = (struct regmap *)priv;
482 return regmap_bulk_write(ds3232_regmap, DS3232_REG_SRAM_START + offset,
486 static int ds3232_probe(struct device *dev, struct regmap *regmap, int irq,
489 struct ds3232 *ds3232;
491 struct nvmem_config nvmem_cfg = {
492 .name = "ds3232_sram",
494 .size = DS3232_REG_SRAM_SIZE,
496 .reg_read = ds3232_nvmem_read,
497 .reg_write = ds3232_nvmem_write,
499 .type = NVMEM_TYPE_BATTERY_BACKED
502 ds3232 = devm_kzalloc(dev, sizeof(*ds3232), GFP_KERNEL);
506 ds3232->regmap = regmap;
509 dev_set_drvdata(dev, ds3232);
511 ret = ds3232_check_rtc_status(dev);
516 device_init_wakeup(dev, 1);
518 ds3232_hwmon_register(dev, name);
520 ds3232->rtc = devm_rtc_device_register(dev, name, &ds3232_rtc_ops,
522 if (IS_ERR(ds3232->rtc))
523 return PTR_ERR(ds3232->rtc);
525 ret = rtc_nvmem_register(ds3232->rtc, &nvmem_cfg);
529 if (ds3232->irq > 0) {
530 ret = devm_request_threaded_irq(dev, ds3232->irq, NULL,
532 IRQF_SHARED | IRQF_ONESHOT,
535 device_set_wakeup_capable(dev, 0);
537 dev_err(dev, "unable to request IRQ\n");
544 #ifdef CONFIG_PM_SLEEP
545 static int ds3232_suspend(struct device *dev)
547 struct ds3232 *ds3232 = dev_get_drvdata(dev);
549 if (device_may_wakeup(dev)) {
550 if (enable_irq_wake(ds3232->irq))
551 dev_warn_once(dev, "Cannot set wakeup source\n");
557 static int ds3232_resume(struct device *dev)
559 struct ds3232 *ds3232 = dev_get_drvdata(dev);
561 if (device_may_wakeup(dev))
562 disable_irq_wake(ds3232->irq);
568 static const struct dev_pm_ops ds3232_pm_ops = {
569 SET_SYSTEM_SLEEP_PM_OPS(ds3232_suspend, ds3232_resume)
572 #if IS_ENABLED(CONFIG_I2C)
574 static int ds3232_i2c_probe(struct i2c_client *client,
575 const struct i2c_device_id *id)
577 struct regmap *regmap;
578 static const struct regmap_config config = {
581 .max_register = DS3232_REG_SRAM_END,
584 regmap = devm_regmap_init_i2c(client, &config);
585 if (IS_ERR(regmap)) {
586 dev_err(&client->dev, "%s: regmap allocation failed: %ld\n",
587 __func__, PTR_ERR(regmap));
588 return PTR_ERR(regmap);
591 return ds3232_probe(&client->dev, regmap, client->irq, client->name);
594 static const struct i2c_device_id ds3232_id[] = {
598 MODULE_DEVICE_TABLE(i2c, ds3232_id);
600 static const struct of_device_id ds3232_of_match[] = {
601 { .compatible = "dallas,ds3232" },
604 MODULE_DEVICE_TABLE(of, ds3232_of_match);
606 static struct i2c_driver ds3232_driver = {
608 .name = "rtc-ds3232",
609 .of_match_table = of_match_ptr(ds3232_of_match),
610 .pm = &ds3232_pm_ops,
612 .probe = ds3232_i2c_probe,
613 .id_table = ds3232_id,
616 static int ds3232_register_driver(void)
618 return i2c_add_driver(&ds3232_driver);
621 static void ds3232_unregister_driver(void)
623 i2c_del_driver(&ds3232_driver);
628 static int ds3232_register_driver(void)
633 static void ds3232_unregister_driver(void)
639 #if IS_ENABLED(CONFIG_SPI_MASTER)
641 static int ds3234_probe(struct spi_device *spi)
645 static const struct regmap_config config = {
648 .max_register = DS3232_REG_SRAM_END,
649 .write_flag_mask = 0x80,
651 struct regmap *regmap;
653 regmap = devm_regmap_init_spi(spi, &config);
654 if (IS_ERR(regmap)) {
655 dev_err(&spi->dev, "%s: regmap allocation failed: %ld\n",
656 __func__, PTR_ERR(regmap));
657 return PTR_ERR(regmap);
660 spi->mode = SPI_MODE_3;
661 spi->bits_per_word = 8;
664 res = regmap_read(regmap, DS3232_REG_SECONDS, &tmp);
671 * BIT 7 6 5 4 3 2 1 0
672 * EOSC BBSQW CONV RS2 RS1 INTCN A2IE A1IE
677 * BIT 7 6 5 4 3 2 1 0
678 * OSF BB32kHz CRATE1 CRATE0 EN32kHz BSY A2F A1F
682 res = regmap_read(regmap, DS3232_REG_CR, &tmp);
685 res = regmap_write(regmap, DS3232_REG_CR, tmp & 0x1c);
689 res = regmap_read(regmap, DS3232_REG_SR, &tmp);
692 res = regmap_write(regmap, DS3232_REG_SR, tmp & 0x88);
696 /* Print our settings */
697 res = regmap_read(regmap, DS3232_REG_CR, &tmp);
700 dev_info(&spi->dev, "Control Reg: 0x%02x\n", tmp);
702 res = regmap_read(regmap, DS3232_REG_SR, &tmp);
705 dev_info(&spi->dev, "Ctrl/Stat Reg: 0x%02x\n", tmp);
707 return ds3232_probe(&spi->dev, regmap, spi->irq, "ds3234");
710 static struct spi_driver ds3234_driver = {
714 .probe = ds3234_probe,
717 static int ds3234_register_driver(void)
719 return spi_register_driver(&ds3234_driver);
722 static void ds3234_unregister_driver(void)
724 spi_unregister_driver(&ds3234_driver);
729 static int ds3234_register_driver(void)
734 static void ds3234_unregister_driver(void)
740 static int __init ds323x_init(void)
744 ret = ds3232_register_driver();
746 pr_err("Failed to register ds3232 driver: %d\n", ret);
750 ret = ds3234_register_driver();
752 pr_err("Failed to register ds3234 driver: %d\n", ret);
753 ds3232_unregister_driver();
758 module_init(ds323x_init)
760 static void __exit ds323x_exit(void)
762 ds3234_unregister_driver();
763 ds3232_unregister_driver();
765 module_exit(ds323x_exit)
769 MODULE_DESCRIPTION("Maxim/Dallas DS3232/DS3234 RTC Driver");
770 MODULE_LICENSE("GPL");
771 MODULE_ALIAS("spi:ds3234");