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/slab.h>
26 #define DS1343_DRV_VERSION "01.00"
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 if (unlikely(!count))
168 if ((count + off) > DS1343_NVRAM_LEN)
169 count = DS1343_NVRAM_LEN - off;
171 address = DS1343_NVRAM + off;
173 ret = regmap_bulk_write(priv->map, address, buf, count);
175 dev_err(&priv->spi->dev, "Error in nvram write %d", ret);
177 return (ret < 0) ? ret : count;
181 static ssize_t ds1343_nvram_read(struct file *filp, struct kobject *kobj,
182 struct bin_attribute *attr,
183 char *buf, loff_t off, size_t count)
186 unsigned char address;
187 struct device *dev = kobj_to_dev(kobj);
188 struct ds1343_priv *priv = dev_get_drvdata(dev);
190 if (unlikely(!count))
193 if ((count + off) > DS1343_NVRAM_LEN)
194 count = DS1343_NVRAM_LEN - off;
196 address = DS1343_NVRAM + off;
198 ret = regmap_bulk_read(priv->map, address, buf, count);
200 dev_err(&priv->spi->dev, "Error in nvram read %d\n", ret);
202 return (ret < 0) ? ret : count;
206 static struct bin_attribute nvram_attr = {
207 .attr.name = "nvram",
208 .attr.mode = S_IRUGO | S_IWUSR,
209 .read = ds1343_nvram_read,
210 .write = ds1343_nvram_write,
211 .size = DS1343_NVRAM_LEN,
214 static ssize_t ds1343_show_alarmstatus(struct device *dev,
215 struct device_attribute *attr, char *buf)
217 struct ds1343_priv *priv = dev_get_drvdata(dev);
218 int alarmstatus, data;
220 regmap_read(priv->map, DS1343_CONTROL_REG, &data);
222 alarmstatus = !!(data & DS1343_A0IE);
225 return sprintf(buf, "enabled\n");
227 return sprintf(buf, "disabled\n");
230 static DEVICE_ATTR(alarm_status, S_IRUGO, ds1343_show_alarmstatus, NULL);
232 static ssize_t ds1343_show_alarmmode(struct device *dev,
233 struct device_attribute *attr, char *buf)
235 struct ds1343_priv *priv = dev_get_drvdata(dev);
236 int alarm_mode, data;
239 regmap_read(priv->map, DS1343_ALM0_SEC_REG, &data);
240 alarm_mode = (data & 0x80) >> 4;
242 regmap_read(priv->map, DS1343_ALM0_MIN_REG, &data);
243 alarm_mode |= (data & 0x80) >> 5;
245 regmap_read(priv->map, DS1343_ALM0_HOUR_REG, &data);
246 alarm_mode |= (data & 0x80) >> 6;
248 regmap_read(priv->map, DS1343_ALM0_DAY_REG, &data);
249 alarm_mode |= (data & 0x80) >> 7;
251 switch (alarm_mode) {
253 alarm_str = "each second";
257 alarm_str = "seconds match";
261 alarm_str = "minutes and seconds match";
265 alarm_str = "hours, minutes and seconds match";
269 alarm_str = "day, hours, minutes and seconds match";
273 alarm_str = "invalid";
277 return sprintf(buf, "%s\n", alarm_str);
280 static DEVICE_ATTR(alarm_mode, S_IRUGO, ds1343_show_alarmmode, NULL);
282 static ssize_t ds1343_show_tricklecharger(struct device *dev,
283 struct device_attribute *attr, char *buf)
285 struct ds1343_priv *priv = dev_get_drvdata(dev);
287 char *diodes = "disabled", *resistors = " ";
289 regmap_read(priv->map, DS1343_TRICKLE_REG, &data);
291 if ((data & 0xf0) == DS1343_TRICKLE_MAGIC) {
292 switch (data & 0x0c) {
293 case DS1343_TRICKLE_DS1:
294 diodes = "one diode,";
298 diodes = "no diode,";
302 switch (data & 0x03) {
303 case DS1343_TRICKLE_1K:
304 resistors = "1k Ohm";
307 case DS1343_TRICKLE_2K:
308 resistors = "2k Ohm";
311 case DS1343_TRICKLE_4K:
312 resistors = "4k Ohm";
321 return sprintf(buf, "%s %s\n", diodes, resistors);
324 static DEVICE_ATTR(trickle_charger, S_IRUGO, ds1343_show_tricklecharger, NULL);
326 static int ds1343_sysfs_register(struct device *dev)
328 struct ds1343_priv *priv = dev_get_drvdata(dev);
331 err = device_create_file(dev, &dev_attr_glitch_filter);
335 err = device_create_file(dev, &dev_attr_trickle_charger);
339 err = device_create_bin_file(dev, &nvram_attr);
346 err = device_create_file(dev, &dev_attr_alarm_mode);
350 err = device_create_file(dev, &dev_attr_alarm_status);
354 device_remove_file(dev, &dev_attr_alarm_mode);
357 device_remove_bin_file(dev, &nvram_attr);
360 device_remove_file(dev, &dev_attr_trickle_charger);
363 device_remove_file(dev, &dev_attr_glitch_filter);
368 static void ds1343_sysfs_unregister(struct device *dev)
370 struct ds1343_priv *priv = dev_get_drvdata(dev);
372 device_remove_file(dev, &dev_attr_glitch_filter);
373 device_remove_file(dev, &dev_attr_trickle_charger);
374 device_remove_bin_file(dev, &nvram_attr);
379 device_remove_file(dev, &dev_attr_alarm_status);
380 device_remove_file(dev, &dev_attr_alarm_mode);
383 static int ds1343_read_time(struct device *dev, struct rtc_time *dt)
385 struct ds1343_priv *priv = dev_get_drvdata(dev);
386 unsigned char buf[7];
389 res = regmap_bulk_read(priv->map, DS1343_SECONDS_REG, buf, 7);
393 dt->tm_sec = bcd2bin(buf[0]);
394 dt->tm_min = bcd2bin(buf[1]);
395 dt->tm_hour = bcd2bin(buf[2] & 0x3F);
396 dt->tm_wday = bcd2bin(buf[3]) - 1;
397 dt->tm_mday = bcd2bin(buf[4]);
398 dt->tm_mon = bcd2bin(buf[5] & 0x1F) - 1;
399 dt->tm_year = bcd2bin(buf[6]) + 100; /* year offset from 1900 */
401 return rtc_valid_tm(dt);
404 static int ds1343_set_time(struct device *dev, struct rtc_time *dt)
406 struct ds1343_priv *priv = dev_get_drvdata(dev);
409 res = regmap_write(priv->map, DS1343_SECONDS_REG,
410 bin2bcd(dt->tm_sec));
414 res = regmap_write(priv->map, DS1343_MINUTES_REG,
415 bin2bcd(dt->tm_min));
419 res = regmap_write(priv->map, DS1343_HOURS_REG,
420 bin2bcd(dt->tm_hour) & 0x3F);
424 res = regmap_write(priv->map, DS1343_DAY_REG,
425 bin2bcd(dt->tm_wday + 1));
429 res = regmap_write(priv->map, DS1343_DATE_REG,
430 bin2bcd(dt->tm_mday));
434 res = regmap_write(priv->map, DS1343_MONTH_REG,
435 bin2bcd(dt->tm_mon + 1));
441 res = regmap_write(priv->map, DS1343_YEAR_REG,
442 bin2bcd(dt->tm_year));
449 static int ds1343_update_alarm(struct device *dev)
451 struct ds1343_priv *priv = dev_get_drvdata(dev);
452 unsigned int control, stat;
453 unsigned char buf[4];
456 res = regmap_read(priv->map, DS1343_CONTROL_REG, &control);
460 res = regmap_read(priv->map, DS1343_STATUS_REG, &stat);
464 control &= ~(DS1343_A0IE);
465 stat &= ~(DS1343_IRQF0);
467 res = regmap_write(priv->map, DS1343_CONTROL_REG, control);
471 res = regmap_write(priv->map, DS1343_STATUS_REG, stat);
475 buf[0] = priv->alarm_sec < 0 || (priv->irqen & RTC_UF) ?
476 0x80 : bin2bcd(priv->alarm_sec) & 0x7F;
477 buf[1] = priv->alarm_min < 0 || (priv->irqen & RTC_UF) ?
478 0x80 : bin2bcd(priv->alarm_min) & 0x7F;
479 buf[2] = priv->alarm_hour < 0 || (priv->irqen & RTC_UF) ?
480 0x80 : bin2bcd(priv->alarm_hour) & 0x3F;
481 buf[3] = priv->alarm_mday < 0 || (priv->irqen & RTC_UF) ?
482 0x80 : bin2bcd(priv->alarm_mday) & 0x7F;
484 res = regmap_bulk_write(priv->map, DS1343_ALM0_SEC_REG, buf, 4);
489 control |= DS1343_A0IE;
490 res = regmap_write(priv->map, DS1343_CONTROL_REG, control);
496 static int ds1343_read_alarm(struct device *dev, struct rtc_wkalrm *alarm)
498 struct ds1343_priv *priv = dev_get_drvdata(dev);
505 mutex_lock(&priv->mutex);
507 res = regmap_read(priv->map, DS1343_STATUS_REG, &stat);
511 alarm->enabled = !!(priv->irqen & RTC_AF);
512 alarm->pending = !!(stat & DS1343_IRQF0);
514 alarm->time.tm_sec = priv->alarm_sec < 0 ? 0 : priv->alarm_sec;
515 alarm->time.tm_min = priv->alarm_min < 0 ? 0 : priv->alarm_min;
516 alarm->time.tm_hour = priv->alarm_hour < 0 ? 0 : priv->alarm_hour;
517 alarm->time.tm_mday = priv->alarm_mday < 0 ? 0 : priv->alarm_mday;
519 alarm->time.tm_mon = -1;
520 alarm->time.tm_year = -1;
521 alarm->time.tm_wday = -1;
522 alarm->time.tm_yday = -1;
523 alarm->time.tm_isdst = -1;
526 mutex_unlock(&priv->mutex);
530 static int ds1343_set_alarm(struct device *dev, struct rtc_wkalrm *alarm)
532 struct ds1343_priv *priv = dev_get_drvdata(dev);
538 mutex_lock(&priv->mutex);
540 priv->alarm_sec = alarm->time.tm_sec;
541 priv->alarm_min = alarm->time.tm_min;
542 priv->alarm_hour = alarm->time.tm_hour;
543 priv->alarm_mday = alarm->time.tm_mday;
546 priv->irqen |= RTC_AF;
548 res = ds1343_update_alarm(dev);
550 mutex_unlock(&priv->mutex);
555 static int ds1343_alarm_irq_enable(struct device *dev, unsigned int enabled)
557 struct ds1343_priv *priv = dev_get_drvdata(dev);
563 mutex_lock(&priv->mutex);
566 priv->irqen |= RTC_AF;
568 priv->irqen &= ~RTC_AF;
570 res = ds1343_update_alarm(dev);
572 mutex_unlock(&priv->mutex);
577 static irqreturn_t ds1343_thread(int irq, void *dev_id)
579 struct ds1343_priv *priv = dev_id;
580 unsigned int stat, control;
583 mutex_lock(&priv->mutex);
585 res = regmap_read(priv->map, DS1343_STATUS_REG, &stat);
589 if (stat & DS1343_IRQF0) {
590 stat &= ~DS1343_IRQF0;
591 regmap_write(priv->map, DS1343_STATUS_REG, stat);
593 res = regmap_read(priv->map, DS1343_CONTROL_REG, &control);
597 control &= ~DS1343_A0IE;
598 regmap_write(priv->map, DS1343_CONTROL_REG, control);
600 rtc_update_irq(priv->rtc, 1, RTC_AF | RTC_IRQF);
604 mutex_unlock(&priv->mutex);
608 static const struct rtc_class_ops ds1343_rtc_ops = {
609 .ioctl = ds1343_ioctl,
610 .read_time = ds1343_read_time,
611 .set_time = ds1343_set_time,
612 .read_alarm = ds1343_read_alarm,
613 .set_alarm = ds1343_set_alarm,
614 .alarm_irq_enable = ds1343_alarm_irq_enable,
617 static int ds1343_probe(struct spi_device *spi)
619 struct ds1343_priv *priv;
620 struct regmap_config config;
624 memset(&config, 0, sizeof(config));
627 config.write_flag_mask = 0x80;
629 priv = devm_kzalloc(&spi->dev, sizeof(struct ds1343_priv), GFP_KERNEL);
634 mutex_init(&priv->mutex);
636 /* RTC DS1347 works in spi mode 3 and
637 * its chip select is active high
639 spi->mode = SPI_MODE_3 | SPI_CS_HIGH;
640 spi->bits_per_word = 8;
641 res = spi_setup(spi);
645 spi_set_drvdata(spi, priv);
647 priv->map = devm_regmap_init_spi(spi, &config);
649 if (IS_ERR(priv->map)) {
650 dev_err(&spi->dev, "spi regmap init failed for rtc ds1343\n");
651 return PTR_ERR(priv->map);
654 res = regmap_read(priv->map, DS1343_SECONDS_REG, &data);
658 regmap_read(priv->map, DS1343_CONTROL_REG, &data);
659 data |= DS1343_INTCN;
660 data &= ~(DS1343_EOSC | DS1343_A1IE | DS1343_A0IE);
661 regmap_write(priv->map, DS1343_CONTROL_REG, data);
663 regmap_read(priv->map, DS1343_STATUS_REG, &data);
664 data &= ~(DS1343_OSF | DS1343_IRQF1 | DS1343_IRQF0);
665 regmap_write(priv->map, DS1343_STATUS_REG, data);
667 priv->rtc = devm_rtc_device_register(&spi->dev, "ds1343",
668 &ds1343_rtc_ops, THIS_MODULE);
669 if (IS_ERR(priv->rtc)) {
670 dev_err(&spi->dev, "unable to register rtc ds1343\n");
671 return PTR_ERR(priv->rtc);
674 priv->irq = spi->irq;
676 if (priv->irq >= 0) {
677 res = devm_request_threaded_irq(&spi->dev, spi->irq, NULL,
679 IRQF_NO_SUSPEND | IRQF_ONESHOT,
684 "unable to request irq for rtc ds1343\n");
686 device_set_wakeup_capable(&spi->dev, 1);
690 res = ds1343_sysfs_register(&spi->dev);
693 "unable to create sysfs entries for rtc ds1343\n");
698 static int ds1343_remove(struct spi_device *spi)
700 struct ds1343_priv *priv = spi_get_drvdata(spi);
703 mutex_lock(&priv->mutex);
704 priv->irqen &= ~RTC_AF;
705 mutex_unlock(&priv->mutex);
707 devm_free_irq(&spi->dev, spi->irq, priv);
710 spi_set_drvdata(spi, NULL);
712 ds1343_sysfs_unregister(&spi->dev);
717 #ifdef CONFIG_PM_SLEEP
719 static int ds1343_suspend(struct device *dev)
721 struct spi_device *spi = to_spi_device(dev);
723 if (spi->irq >= 0 && device_may_wakeup(dev))
724 enable_irq_wake(spi->irq);
729 static int ds1343_resume(struct device *dev)
731 struct spi_device *spi = to_spi_device(dev);
733 if (spi->irq >= 0 && device_may_wakeup(dev))
734 disable_irq_wake(spi->irq);
741 static SIMPLE_DEV_PM_OPS(ds1343_pm, ds1343_suspend, ds1343_resume);
743 static struct spi_driver ds1343_driver = {
746 .owner = THIS_MODULE,
749 .probe = ds1343_probe,
750 .remove = ds1343_remove,
751 .id_table = ds1343_id,
754 module_spi_driver(ds1343_driver);
756 MODULE_DESCRIPTION("DS1343 RTC SPI Driver");
759 MODULE_LICENSE("GPL v2");
760 MODULE_VERSION(DS1343_DRV_VERSION);