3 * Driver for Dallas Semiconductor DS1343 Low Current, SPI Compatible
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/interrupt.h>
18 #include <linux/device.h>
19 #include <linux/spi/spi.h>
20 #include <linux/regmap.h>
21 #include <linux/rtc.h>
22 #include <linux/bcd.h>
24 #include <linux/pm_wakeirq.h>
25 #include <linux/slab.h>
27 #define DALLAS_MAXIM_DS1343 0
28 #define DALLAS_MAXIM_DS1344 1
30 /* RTC DS1343 Registers */
31 #define DS1343_SECONDS_REG 0x00
32 #define DS1343_MINUTES_REG 0x01
33 #define DS1343_HOURS_REG 0x02
34 #define DS1343_DAY_REG 0x03
35 #define DS1343_DATE_REG 0x04
36 #define DS1343_MONTH_REG 0x05
37 #define DS1343_YEAR_REG 0x06
38 #define DS1343_ALM0_SEC_REG 0x07
39 #define DS1343_ALM0_MIN_REG 0x08
40 #define DS1343_ALM0_HOUR_REG 0x09
41 #define DS1343_ALM0_DAY_REG 0x0A
42 #define DS1343_ALM1_SEC_REG 0x0B
43 #define DS1343_ALM1_MIN_REG 0x0C
44 #define DS1343_ALM1_HOUR_REG 0x0D
45 #define DS1343_ALM1_DAY_REG 0x0E
46 #define DS1343_CONTROL_REG 0x0F
47 #define DS1343_STATUS_REG 0x10
48 #define DS1343_TRICKLE_REG 0x11
49 #define DS1343_NVRAM 0x20
51 #define DS1343_NVRAM_LEN 96
53 /* DS1343 Control Registers bits */
54 #define DS1343_EOSC 0x80
55 #define DS1343_DOSF 0x20
56 #define DS1343_EGFIL 0x10
57 #define DS1343_SQW 0x08
58 #define DS1343_INTCN 0x04
59 #define DS1343_A1IE 0x02
60 #define DS1343_A0IE 0x01
62 /* DS1343 Status Registers bits */
63 #define DS1343_OSF 0x80
64 #define DS1343_IRQF1 0x02
65 #define DS1343_IRQF0 0x01
67 /* DS1343 Trickle Charger Registers bits */
68 #define DS1343_TRICKLE_MAGIC 0xa0
69 #define DS1343_TRICKLE_DS1 0x08
70 #define DS1343_TRICKLE_1K 0x01
71 #define DS1343_TRICKLE_2K 0x02
72 #define DS1343_TRICKLE_4K 0x03
74 static const struct spi_device_id ds1343_id[] = {
75 { "ds1343", DALLAS_MAXIM_DS1343 },
76 { "ds1344", DALLAS_MAXIM_DS1344 },
79 MODULE_DEVICE_TABLE(spi, ds1343_id);
82 struct spi_device *spi;
83 struct rtc_device *rtc;
94 static int ds1343_ioctl(struct device *dev, unsigned int cmd, unsigned long arg)
102 if (copy_from_user(&val, (int __user *)arg, sizeof(int)))
105 return regmap_write(priv->map, DS1343_TRICKLE_REG, val);
114 static ssize_t ds1343_show_glitchfilter(struct device *dev,
115 struct device_attribute *attr, char *buf)
117 struct ds1343_priv *priv = dev_get_drvdata(dev);
118 int glitch_filt_status, data;
120 regmap_read(priv->map, DS1343_CONTROL_REG, &data);
122 glitch_filt_status = !!(data & DS1343_EGFIL);
124 if (glitch_filt_status)
125 return sprintf(buf, "enabled\n");
127 return sprintf(buf, "disabled\n");
130 static ssize_t ds1343_store_glitchfilter(struct device *dev,
131 struct device_attribute *attr,
132 const char *buf, size_t count)
134 struct ds1343_priv *priv = dev_get_drvdata(dev);
137 regmap_read(priv->map, DS1343_CONTROL_REG, &data);
139 if (strncmp(buf, "enabled", 7) == 0)
140 data |= DS1343_EGFIL;
142 else if (strncmp(buf, "disabled", 8) == 0)
143 data &= ~(DS1343_EGFIL);
148 regmap_write(priv->map, DS1343_CONTROL_REG, data);
153 static DEVICE_ATTR(glitch_filter, S_IRUGO | S_IWUSR, ds1343_show_glitchfilter,
154 ds1343_store_glitchfilter);
156 static ssize_t ds1343_nvram_write(struct file *filp, struct kobject *kobj,
157 struct bin_attribute *attr,
158 char *buf, loff_t off, size_t count)
161 unsigned char address;
162 struct device *dev = kobj_to_dev(kobj);
163 struct ds1343_priv *priv = dev_get_drvdata(dev);
165 address = DS1343_NVRAM + off;
167 ret = regmap_bulk_write(priv->map, address, buf, count);
169 dev_err(&priv->spi->dev, "Error in nvram write %d", ret);
171 return (ret < 0) ? ret : count;
175 static ssize_t ds1343_nvram_read(struct file *filp, struct kobject *kobj,
176 struct bin_attribute *attr,
177 char *buf, loff_t off, size_t count)
180 unsigned char address;
181 struct device *dev = kobj_to_dev(kobj);
182 struct ds1343_priv *priv = dev_get_drvdata(dev);
184 address = DS1343_NVRAM + off;
186 ret = regmap_bulk_read(priv->map, address, buf, count);
188 dev_err(&priv->spi->dev, "Error in nvram read %d\n", ret);
190 return (ret < 0) ? ret : count;
194 static struct bin_attribute nvram_attr = {
195 .attr.name = "nvram",
196 .attr.mode = S_IRUGO | S_IWUSR,
197 .read = ds1343_nvram_read,
198 .write = ds1343_nvram_write,
199 .size = DS1343_NVRAM_LEN,
202 static ssize_t ds1343_show_alarmstatus(struct device *dev,
203 struct device_attribute *attr, char *buf)
205 struct ds1343_priv *priv = dev_get_drvdata(dev);
206 int alarmstatus, data;
208 regmap_read(priv->map, DS1343_CONTROL_REG, &data);
210 alarmstatus = !!(data & DS1343_A0IE);
213 return sprintf(buf, "enabled\n");
215 return sprintf(buf, "disabled\n");
218 static DEVICE_ATTR(alarm_status, S_IRUGO, ds1343_show_alarmstatus, NULL);
220 static ssize_t ds1343_show_alarmmode(struct device *dev,
221 struct device_attribute *attr, char *buf)
223 struct ds1343_priv *priv = dev_get_drvdata(dev);
224 int alarm_mode, data;
227 regmap_read(priv->map, DS1343_ALM0_SEC_REG, &data);
228 alarm_mode = (data & 0x80) >> 4;
230 regmap_read(priv->map, DS1343_ALM0_MIN_REG, &data);
231 alarm_mode |= (data & 0x80) >> 5;
233 regmap_read(priv->map, DS1343_ALM0_HOUR_REG, &data);
234 alarm_mode |= (data & 0x80) >> 6;
236 regmap_read(priv->map, DS1343_ALM0_DAY_REG, &data);
237 alarm_mode |= (data & 0x80) >> 7;
239 switch (alarm_mode) {
241 alarm_str = "each second";
245 alarm_str = "seconds match";
249 alarm_str = "minutes and seconds match";
253 alarm_str = "hours, minutes and seconds match";
257 alarm_str = "day, hours, minutes and seconds match";
261 alarm_str = "invalid";
265 return sprintf(buf, "%s\n", alarm_str);
268 static DEVICE_ATTR(alarm_mode, S_IRUGO, ds1343_show_alarmmode, NULL);
270 static ssize_t ds1343_show_tricklecharger(struct device *dev,
271 struct device_attribute *attr, char *buf)
273 struct ds1343_priv *priv = dev_get_drvdata(dev);
275 char *diodes = "disabled", *resistors = " ";
277 regmap_read(priv->map, DS1343_TRICKLE_REG, &data);
279 if ((data & 0xf0) == DS1343_TRICKLE_MAGIC) {
280 switch (data & 0x0c) {
281 case DS1343_TRICKLE_DS1:
282 diodes = "one diode,";
286 diodes = "no diode,";
290 switch (data & 0x03) {
291 case DS1343_TRICKLE_1K:
292 resistors = "1k Ohm";
295 case DS1343_TRICKLE_2K:
296 resistors = "2k Ohm";
299 case DS1343_TRICKLE_4K:
300 resistors = "4k Ohm";
309 return sprintf(buf, "%s %s\n", diodes, resistors);
312 static DEVICE_ATTR(trickle_charger, S_IRUGO, ds1343_show_tricklecharger, NULL);
314 static int ds1343_sysfs_register(struct device *dev)
316 struct ds1343_priv *priv = dev_get_drvdata(dev);
319 err = device_create_file(dev, &dev_attr_glitch_filter);
323 err = device_create_file(dev, &dev_attr_trickle_charger);
327 err = device_create_bin_file(dev, &nvram_attr);
334 err = device_create_file(dev, &dev_attr_alarm_mode);
338 err = device_create_file(dev, &dev_attr_alarm_status);
342 device_remove_file(dev, &dev_attr_alarm_mode);
345 device_remove_bin_file(dev, &nvram_attr);
348 device_remove_file(dev, &dev_attr_trickle_charger);
351 device_remove_file(dev, &dev_attr_glitch_filter);
356 static void ds1343_sysfs_unregister(struct device *dev)
358 struct ds1343_priv *priv = dev_get_drvdata(dev);
360 device_remove_file(dev, &dev_attr_glitch_filter);
361 device_remove_file(dev, &dev_attr_trickle_charger);
362 device_remove_bin_file(dev, &nvram_attr);
367 device_remove_file(dev, &dev_attr_alarm_status);
368 device_remove_file(dev, &dev_attr_alarm_mode);
371 static int ds1343_read_time(struct device *dev, struct rtc_time *dt)
373 struct ds1343_priv *priv = dev_get_drvdata(dev);
374 unsigned char buf[7];
377 res = regmap_bulk_read(priv->map, DS1343_SECONDS_REG, buf, 7);
381 dt->tm_sec = bcd2bin(buf[0]);
382 dt->tm_min = bcd2bin(buf[1]);
383 dt->tm_hour = bcd2bin(buf[2] & 0x3F);
384 dt->tm_wday = bcd2bin(buf[3]) - 1;
385 dt->tm_mday = bcd2bin(buf[4]);
386 dt->tm_mon = bcd2bin(buf[5] & 0x1F) - 1;
387 dt->tm_year = bcd2bin(buf[6]) + 100; /* year offset from 1900 */
389 return rtc_valid_tm(dt);
392 static int ds1343_set_time(struct device *dev, struct rtc_time *dt)
394 struct ds1343_priv *priv = dev_get_drvdata(dev);
397 res = regmap_write(priv->map, DS1343_SECONDS_REG,
398 bin2bcd(dt->tm_sec));
402 res = regmap_write(priv->map, DS1343_MINUTES_REG,
403 bin2bcd(dt->tm_min));
407 res = regmap_write(priv->map, DS1343_HOURS_REG,
408 bin2bcd(dt->tm_hour) & 0x3F);
412 res = regmap_write(priv->map, DS1343_DAY_REG,
413 bin2bcd(dt->tm_wday + 1));
417 res = regmap_write(priv->map, DS1343_DATE_REG,
418 bin2bcd(dt->tm_mday));
422 res = regmap_write(priv->map, DS1343_MONTH_REG,
423 bin2bcd(dt->tm_mon + 1));
429 res = regmap_write(priv->map, DS1343_YEAR_REG,
430 bin2bcd(dt->tm_year));
437 static int ds1343_update_alarm(struct device *dev)
439 struct ds1343_priv *priv = dev_get_drvdata(dev);
440 unsigned int control, stat;
441 unsigned char buf[4];
444 res = regmap_read(priv->map, DS1343_CONTROL_REG, &control);
448 res = regmap_read(priv->map, DS1343_STATUS_REG, &stat);
452 control &= ~(DS1343_A0IE);
453 stat &= ~(DS1343_IRQF0);
455 res = regmap_write(priv->map, DS1343_CONTROL_REG, control);
459 res = regmap_write(priv->map, DS1343_STATUS_REG, stat);
463 buf[0] = priv->alarm_sec < 0 || (priv->irqen & RTC_UF) ?
464 0x80 : bin2bcd(priv->alarm_sec) & 0x7F;
465 buf[1] = priv->alarm_min < 0 || (priv->irqen & RTC_UF) ?
466 0x80 : bin2bcd(priv->alarm_min) & 0x7F;
467 buf[2] = priv->alarm_hour < 0 || (priv->irqen & RTC_UF) ?
468 0x80 : bin2bcd(priv->alarm_hour) & 0x3F;
469 buf[3] = priv->alarm_mday < 0 || (priv->irqen & RTC_UF) ?
470 0x80 : bin2bcd(priv->alarm_mday) & 0x7F;
472 res = regmap_bulk_write(priv->map, DS1343_ALM0_SEC_REG, buf, 4);
477 control |= DS1343_A0IE;
478 res = regmap_write(priv->map, DS1343_CONTROL_REG, control);
484 static int ds1343_read_alarm(struct device *dev, struct rtc_wkalrm *alarm)
486 struct ds1343_priv *priv = dev_get_drvdata(dev);
493 mutex_lock(&priv->mutex);
495 res = regmap_read(priv->map, DS1343_STATUS_REG, &stat);
499 alarm->enabled = !!(priv->irqen & RTC_AF);
500 alarm->pending = !!(stat & DS1343_IRQF0);
502 alarm->time.tm_sec = priv->alarm_sec < 0 ? 0 : priv->alarm_sec;
503 alarm->time.tm_min = priv->alarm_min < 0 ? 0 : priv->alarm_min;
504 alarm->time.tm_hour = priv->alarm_hour < 0 ? 0 : priv->alarm_hour;
505 alarm->time.tm_mday = priv->alarm_mday < 0 ? 0 : priv->alarm_mday;
508 mutex_unlock(&priv->mutex);
512 static int ds1343_set_alarm(struct device *dev, struct rtc_wkalrm *alarm)
514 struct ds1343_priv *priv = dev_get_drvdata(dev);
520 mutex_lock(&priv->mutex);
522 priv->alarm_sec = alarm->time.tm_sec;
523 priv->alarm_min = alarm->time.tm_min;
524 priv->alarm_hour = alarm->time.tm_hour;
525 priv->alarm_mday = alarm->time.tm_mday;
528 priv->irqen |= RTC_AF;
530 res = ds1343_update_alarm(dev);
532 mutex_unlock(&priv->mutex);
537 static int ds1343_alarm_irq_enable(struct device *dev, unsigned int enabled)
539 struct ds1343_priv *priv = dev_get_drvdata(dev);
545 mutex_lock(&priv->mutex);
548 priv->irqen |= RTC_AF;
550 priv->irqen &= ~RTC_AF;
552 res = ds1343_update_alarm(dev);
554 mutex_unlock(&priv->mutex);
559 static irqreturn_t ds1343_thread(int irq, void *dev_id)
561 struct ds1343_priv *priv = dev_id;
562 unsigned int stat, control;
565 mutex_lock(&priv->mutex);
567 res = regmap_read(priv->map, DS1343_STATUS_REG, &stat);
571 if (stat & DS1343_IRQF0) {
572 stat &= ~DS1343_IRQF0;
573 regmap_write(priv->map, DS1343_STATUS_REG, stat);
575 res = regmap_read(priv->map, DS1343_CONTROL_REG, &control);
579 control &= ~DS1343_A0IE;
580 regmap_write(priv->map, DS1343_CONTROL_REG, control);
582 rtc_update_irq(priv->rtc, 1, RTC_AF | RTC_IRQF);
586 mutex_unlock(&priv->mutex);
590 static const struct rtc_class_ops ds1343_rtc_ops = {
591 .ioctl = ds1343_ioctl,
592 .read_time = ds1343_read_time,
593 .set_time = ds1343_set_time,
594 .read_alarm = ds1343_read_alarm,
595 .set_alarm = ds1343_set_alarm,
596 .alarm_irq_enable = ds1343_alarm_irq_enable,
599 static int ds1343_probe(struct spi_device *spi)
601 struct ds1343_priv *priv;
602 struct regmap_config config;
606 memset(&config, 0, sizeof(config));
609 config.write_flag_mask = 0x80;
611 priv = devm_kzalloc(&spi->dev, sizeof(struct ds1343_priv), GFP_KERNEL);
616 mutex_init(&priv->mutex);
618 /* RTC DS1347 works in spi mode 3 and
619 * its chip select is active high
621 spi->mode = SPI_MODE_3 | SPI_CS_HIGH;
622 spi->bits_per_word = 8;
623 res = spi_setup(spi);
627 spi_set_drvdata(spi, priv);
629 priv->map = devm_regmap_init_spi(spi, &config);
631 if (IS_ERR(priv->map)) {
632 dev_err(&spi->dev, "spi regmap init failed for rtc ds1343\n");
633 return PTR_ERR(priv->map);
636 res = regmap_read(priv->map, DS1343_SECONDS_REG, &data);
640 regmap_read(priv->map, DS1343_CONTROL_REG, &data);
641 data |= DS1343_INTCN;
642 data &= ~(DS1343_EOSC | DS1343_A1IE | DS1343_A0IE);
643 regmap_write(priv->map, DS1343_CONTROL_REG, data);
645 regmap_read(priv->map, DS1343_STATUS_REG, &data);
646 data &= ~(DS1343_OSF | DS1343_IRQF1 | DS1343_IRQF0);
647 regmap_write(priv->map, DS1343_STATUS_REG, data);
649 priv->rtc = devm_rtc_device_register(&spi->dev, "ds1343",
650 &ds1343_rtc_ops, THIS_MODULE);
651 if (IS_ERR(priv->rtc)) {
652 dev_err(&spi->dev, "unable to register rtc ds1343\n");
653 return PTR_ERR(priv->rtc);
656 priv->irq = spi->irq;
658 if (priv->irq >= 0) {
659 res = devm_request_threaded_irq(&spi->dev, spi->irq, NULL,
660 ds1343_thread, IRQF_ONESHOT,
665 "unable to request irq for rtc ds1343\n");
667 device_init_wakeup(&spi->dev, true);
668 dev_pm_set_wake_irq(&spi->dev, spi->irq);
672 res = ds1343_sysfs_register(&spi->dev);
675 "unable to create sysfs entries for rtc ds1343\n");
680 static int ds1343_remove(struct spi_device *spi)
682 struct ds1343_priv *priv = spi_get_drvdata(spi);
685 mutex_lock(&priv->mutex);
686 priv->irqen &= ~RTC_AF;
687 mutex_unlock(&priv->mutex);
689 dev_pm_clear_wake_irq(&spi->dev);
690 device_init_wakeup(&spi->dev, false);
691 devm_free_irq(&spi->dev, spi->irq, priv);
694 spi_set_drvdata(spi, NULL);
696 ds1343_sysfs_unregister(&spi->dev);
701 #ifdef CONFIG_PM_SLEEP
703 static int ds1343_suspend(struct device *dev)
705 struct spi_device *spi = to_spi_device(dev);
707 if (spi->irq >= 0 && device_may_wakeup(dev))
708 enable_irq_wake(spi->irq);
713 static int ds1343_resume(struct device *dev)
715 struct spi_device *spi = to_spi_device(dev);
717 if (spi->irq >= 0 && device_may_wakeup(dev))
718 disable_irq_wake(spi->irq);
725 static SIMPLE_DEV_PM_OPS(ds1343_pm, ds1343_suspend, ds1343_resume);
727 static struct spi_driver ds1343_driver = {
732 .probe = ds1343_probe,
733 .remove = ds1343_remove,
734 .id_table = ds1343_id,
737 module_spi_driver(ds1343_driver);
739 MODULE_DESCRIPTION("DS1343 RTC SPI Driver");
742 MODULE_LICENSE("GPL v2");