3 * Driver for Dallas Semiconductor DS1343 Low Current, SPI Compatible
6 * Author : Raghavendra Chandra Ganiga <ravi23ganiga@gmail.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
14 #include <linux/init.h>
15 #include <linux/module.h>
16 #include <linux/interrupt.h>
17 #include <linux/device.h>
18 #include <linux/spi/spi.h>
19 #include <linux/regmap.h>
20 #include <linux/rtc.h>
21 #include <linux/bcd.h>
23 #include <linux/slab.h>
25 #define DS1343_DRV_VERSION "01.00"
26 #define DALLAS_MAXIM_DS1343 0
27 #define DALLAS_MAXIM_DS1344 1
29 /* RTC DS1343 Registers */
30 #define DS1343_SECONDS_REG 0x00
31 #define DS1343_MINUTES_REG 0x01
32 #define DS1343_HOURS_REG 0x02
33 #define DS1343_DAY_REG 0x03
34 #define DS1343_DATE_REG 0x04
35 #define DS1343_MONTH_REG 0x05
36 #define DS1343_YEAR_REG 0x06
37 #define DS1343_ALM0_SEC_REG 0x07
38 #define DS1343_ALM0_MIN_REG 0x08
39 #define DS1343_ALM0_HOUR_REG 0x09
40 #define DS1343_ALM0_DAY_REG 0x0A
41 #define DS1343_ALM1_SEC_REG 0x0B
42 #define DS1343_ALM1_MIN_REG 0x0C
43 #define DS1343_ALM1_HOUR_REG 0x0D
44 #define DS1343_ALM1_DAY_REG 0x0E
45 #define DS1343_CONTROL_REG 0x0F
46 #define DS1343_STATUS_REG 0x10
47 #define DS1343_TRICKLE_REG 0x11
49 /* DS1343 Control Registers bits */
50 #define DS1343_EOSC 0x80
51 #define DS1343_DOSF 0x20
52 #define DS1343_EGFIL 0x10
53 #define DS1343_SQW 0x08
54 #define DS1343_INTCN 0x04
55 #define DS1343_A1IE 0x02
56 #define DS1343_A0IE 0x01
58 /* DS1343 Status Registers bits */
59 #define DS1343_OSF 0x80
60 #define DS1343_IRQF1 0x02
61 #define DS1343_IRQF0 0x01
63 /* DS1343 Trickle Charger Registers bits */
64 #define DS1343_TRICKLE_MAGIC 0xa0
65 #define DS1343_TRICKLE_DS1 0x08
66 #define DS1343_TRICKLE_1K 0x01
67 #define DS1343_TRICKLE_2K 0x02
68 #define DS1343_TRICKLE_4K 0x03
70 static const struct spi_device_id ds1343_id[] = {
71 { "ds1343", DALLAS_MAXIM_DS1343 },
72 { "ds1344", DALLAS_MAXIM_DS1344 },
75 MODULE_DEVICE_TABLE(spi, ds1343_id);
78 struct spi_device *spi;
79 struct rtc_device *rtc;
89 static int ds1343_ioctl(struct device *dev, unsigned int cmd, unsigned long arg)
97 if (copy_from_user(&val, (int __user *)arg, sizeof(int)))
100 return regmap_write(priv->map, DS1343_TRICKLE_REG, val);
109 static ssize_t ds1343_show_glitchfilter(struct device *dev,
110 struct device_attribute *attr, char *buf)
112 struct ds1343_priv *priv = dev_get_drvdata(dev);
113 int glitch_filt_status, data;
115 regmap_read(priv->map, DS1343_CONTROL_REG, &data);
117 glitch_filt_status = !!(data & DS1343_EGFIL);
119 if (glitch_filt_status)
120 return sprintf(buf, "enabled\n");
122 return sprintf(buf, "disabled\n");
125 static ssize_t ds1343_store_glitchfilter(struct device *dev,
126 struct device_attribute *attr,
127 const char *buf, size_t count)
129 struct ds1343_priv *priv = dev_get_drvdata(dev);
132 regmap_read(priv->map, DS1343_CONTROL_REG, &data);
134 if (strncmp(buf, "enabled", 7) == 0)
135 data |= DS1343_EGFIL;
137 else if (strncmp(buf, "disabled", 8) == 0)
138 data &= ~(DS1343_EGFIL);
143 regmap_write(priv->map, DS1343_CONTROL_REG, data);
148 static DEVICE_ATTR(glitch_filter, S_IRUGO | S_IWUSR, ds1343_show_glitchfilter,
149 ds1343_store_glitchfilter);
151 static ssize_t ds1343_show_alarmstatus(struct device *dev,
152 struct device_attribute *attr, char *buf)
154 struct ds1343_priv *priv = dev_get_drvdata(dev);
155 int alarmstatus, data;
157 regmap_read(priv->map, DS1343_CONTROL_REG, &data);
159 alarmstatus = !!(data & DS1343_A0IE);
162 return sprintf(buf, "enabled\n");
164 return sprintf(buf, "disabled\n");
167 static DEVICE_ATTR(alarm_status, S_IRUGO, ds1343_show_alarmstatus, NULL);
169 static ssize_t ds1343_show_alarmmode(struct device *dev,
170 struct device_attribute *attr, char *buf)
172 struct ds1343_priv *priv = dev_get_drvdata(dev);
173 int alarm_mode, data;
176 regmap_read(priv->map, DS1343_ALM0_SEC_REG, &data);
177 alarm_mode = (data & 0x80) >> 4;
179 regmap_read(priv->map, DS1343_ALM0_MIN_REG, &data);
180 alarm_mode |= (data & 0x80) >> 5;
182 regmap_read(priv->map, DS1343_ALM0_HOUR_REG, &data);
183 alarm_mode |= (data & 0x80) >> 6;
185 regmap_read(priv->map, DS1343_ALM0_DAY_REG, &data);
186 alarm_mode |= (data & 0x80) >> 7;
188 switch (alarm_mode) {
190 alarm_str = "each second";
194 alarm_str = "seconds match";
198 alarm_str = "minutes and seconds match";
202 alarm_str = "hours, minutes and seconds match";
206 alarm_str = "day, hours, minutes and seconds match";
210 alarm_str = "invalid";
214 return sprintf(buf, "%s\n", alarm_str);
217 static DEVICE_ATTR(alarm_mode, S_IRUGO, ds1343_show_alarmmode, NULL);
219 static ssize_t ds1343_show_tricklecharger(struct device *dev,
220 struct device_attribute *attr, char *buf)
222 struct ds1343_priv *priv = dev_get_drvdata(dev);
224 char *diodes = "disabled", *resistors = " ";
226 regmap_read(priv->map, DS1343_TRICKLE_REG, &data);
228 if ((data & 0xf0) == DS1343_TRICKLE_MAGIC) {
229 switch (data & 0x0c) {
230 case DS1343_TRICKLE_DS1:
231 diodes = "one diode,";
235 diodes = "no diode,";
239 switch (data & 0x03) {
240 case DS1343_TRICKLE_1K:
241 resistors = "1k Ohm";
244 case DS1343_TRICKLE_2K:
245 resistors = "2k Ohm";
248 case DS1343_TRICKLE_4K:
249 resistors = "4k Ohm";
258 return sprintf(buf, "%s %s\n", diodes, resistors);
261 static DEVICE_ATTR(trickle_charger, S_IRUGO, ds1343_show_tricklecharger, NULL);
263 static int ds1343_sysfs_register(struct device *dev)
267 err = device_create_file(dev, &dev_attr_glitch_filter);
271 err = device_create_file(dev, &dev_attr_alarm_status);
275 err = device_create_file(dev, &dev_attr_alarm_mode);
279 err = device_create_file(dev, &dev_attr_trickle_charger);
283 device_remove_file(dev, &dev_attr_alarm_mode);
286 device_remove_file(dev, &dev_attr_alarm_status);
289 device_remove_file(dev, &dev_attr_glitch_filter);
294 static void ds1343_sysfs_unregister(struct device *dev)
296 device_remove_file(dev, &dev_attr_glitch_filter);
297 device_remove_file(dev, &dev_attr_alarm_status);
298 device_remove_file(dev, &dev_attr_alarm_mode);
299 device_remove_file(dev, &dev_attr_trickle_charger);
302 static int ds1343_read_time(struct device *dev, struct rtc_time *dt)
304 struct ds1343_priv *priv = dev_get_drvdata(dev);
305 unsigned char buf[7];
308 res = regmap_bulk_read(priv->map, DS1343_SECONDS_REG, buf, 7);
312 dt->tm_sec = bcd2bin(buf[0]);
313 dt->tm_min = bcd2bin(buf[1]);
314 dt->tm_hour = bcd2bin(buf[2] & 0x3F);
315 dt->tm_wday = bcd2bin(buf[3]) - 1;
316 dt->tm_mday = bcd2bin(buf[4]);
317 dt->tm_mon = bcd2bin(buf[5] & 0x1F) - 1;
318 dt->tm_year = bcd2bin(buf[6]) + 100; /* year offset from 1900 */
320 return rtc_valid_tm(dt);
323 static int ds1343_set_time(struct device *dev, struct rtc_time *dt)
325 struct ds1343_priv *priv = dev_get_drvdata(dev);
328 res = regmap_write(priv->map, DS1343_SECONDS_REG,
329 bin2bcd(dt->tm_sec));
333 res = regmap_write(priv->map, DS1343_MINUTES_REG,
334 bin2bcd(dt->tm_min));
338 res = regmap_write(priv->map, DS1343_HOURS_REG,
339 bin2bcd(dt->tm_hour) & 0x3F);
343 res = regmap_write(priv->map, DS1343_DAY_REG,
344 bin2bcd(dt->tm_wday + 1));
348 res = regmap_write(priv->map, DS1343_DATE_REG,
349 bin2bcd(dt->tm_mday));
353 res = regmap_write(priv->map, DS1343_MONTH_REG,
354 bin2bcd(dt->tm_mon + 1));
360 res = regmap_write(priv->map, DS1343_YEAR_REG,
361 bin2bcd(dt->tm_year));
368 static int ds1343_update_alarm(struct device *dev)
370 struct ds1343_priv *priv = dev_get_drvdata(dev);
371 unsigned int control, stat;
372 unsigned char buf[4];
375 res = regmap_read(priv->map, DS1343_CONTROL_REG, &control);
379 res = regmap_read(priv->map, DS1343_STATUS_REG, &stat);
383 control &= ~(DS1343_A0IE);
384 stat &= ~(DS1343_IRQF0);
386 res = regmap_write(priv->map, DS1343_CONTROL_REG, control);
390 res = regmap_write(priv->map, DS1343_STATUS_REG, stat);
394 buf[0] = priv->alarm_sec < 0 || (priv->irqen & RTC_UF) ?
395 0x80 : bin2bcd(priv->alarm_sec) & 0x7F;
396 buf[1] = priv->alarm_min < 0 || (priv->irqen & RTC_UF) ?
397 0x80 : bin2bcd(priv->alarm_min) & 0x7F;
398 buf[2] = priv->alarm_hour < 0 || (priv->irqen & RTC_UF) ?
399 0x80 : bin2bcd(priv->alarm_hour) & 0x3F;
400 buf[3] = priv->alarm_mday < 0 || (priv->irqen & RTC_UF) ?
401 0x80 : bin2bcd(priv->alarm_mday) & 0x7F;
403 res = regmap_bulk_write(priv->map, DS1343_ALM0_SEC_REG, buf, 4);
408 control |= DS1343_A0IE;
409 res = regmap_write(priv->map, DS1343_CONTROL_REG, control);
415 static int ds1343_read_alarm(struct device *dev, struct rtc_wkalrm *alarm)
417 struct ds1343_priv *priv = dev_get_drvdata(dev);
418 struct spi_device *spi = priv->spi;
425 mutex_lock(&priv->mutex);
427 res = regmap_read(priv->map, DS1343_STATUS_REG, &stat);
431 alarm->enabled = !!(priv->irqen & RTC_AF);
432 alarm->pending = !!(stat & DS1343_IRQF0);
434 alarm->time.tm_sec = priv->alarm_sec < 0 ? 0 : priv->alarm_sec;
435 alarm->time.tm_min = priv->alarm_min < 0 ? 0 : priv->alarm_min;
436 alarm->time.tm_hour = priv->alarm_hour < 0 ? 0 : priv->alarm_hour;
437 alarm->time.tm_mday = priv->alarm_mday < 0 ? 0 : priv->alarm_mday;
439 alarm->time.tm_mon = -1;
440 alarm->time.tm_year = -1;
441 alarm->time.tm_wday = -1;
442 alarm->time.tm_yday = -1;
443 alarm->time.tm_isdst = -1;
446 mutex_unlock(&priv->mutex);
450 static int ds1343_set_alarm(struct device *dev, struct rtc_wkalrm *alarm)
452 struct ds1343_priv *priv = dev_get_drvdata(dev);
453 struct spi_device *spi = priv->spi;
459 mutex_lock(&priv->mutex);
461 priv->alarm_sec = alarm->time.tm_sec;
462 priv->alarm_min = alarm->time.tm_min;
463 priv->alarm_hour = alarm->time.tm_hour;
464 priv->alarm_mday = alarm->time.tm_mday;
467 priv->irqen |= RTC_AF;
469 res = ds1343_update_alarm(dev);
471 mutex_unlock(&priv->mutex);
476 static int ds1343_alarm_irq_enable(struct device *dev, unsigned int enabled)
478 struct ds1343_priv *priv = dev_get_drvdata(dev);
479 struct spi_device *spi = priv->spi;
485 mutex_lock(&priv->mutex);
488 priv->irqen |= RTC_AF;
490 priv->irqen &= ~RTC_AF;
492 res = ds1343_update_alarm(dev);
494 mutex_unlock(&priv->mutex);
499 static irqreturn_t ds1343_thread(int irq, void *dev_id)
501 struct ds1343_priv *priv = dev_id;
502 unsigned int stat, control;
505 mutex_lock(&priv->mutex);
507 res = regmap_read(priv->map, DS1343_STATUS_REG, &stat);
511 if (stat & DS1343_IRQF0) {
512 stat &= ~DS1343_IRQF0;
513 regmap_write(priv->map, DS1343_STATUS_REG, stat);
515 res = regmap_read(priv->map, DS1343_CONTROL_REG, &control);
519 control &= ~DS1343_A0IE;
520 regmap_write(priv->map, DS1343_CONTROL_REG, control);
522 rtc_update_irq(priv->rtc, 1, RTC_AF | RTC_IRQF);
526 mutex_unlock(&priv->mutex);
530 static const struct rtc_class_ops ds1343_rtc_ops = {
531 .ioctl = ds1343_ioctl,
532 .read_time = ds1343_read_time,
533 .set_time = ds1343_set_time,
534 .read_alarm = ds1343_read_alarm,
535 .set_alarm = ds1343_set_alarm,
536 .alarm_irq_enable = ds1343_alarm_irq_enable,
539 static int ds1343_probe(struct spi_device *spi)
541 struct ds1343_priv *priv;
542 struct regmap_config config;
546 memset(&config, 0, sizeof(config));
549 config.write_flag_mask = 0x80;
551 priv = devm_kzalloc(&spi->dev, sizeof(struct ds1343_priv), GFP_KERNEL);
556 mutex_init(&priv->mutex);
558 /* RTC DS1347 works in spi mode 3 and
559 * its chip select is active high
561 spi->mode = SPI_MODE_3 | SPI_CS_HIGH;
562 spi->bits_per_word = 8;
563 res = spi_setup(spi);
567 spi_set_drvdata(spi, priv);
569 priv->map = devm_regmap_init_spi(spi, &config);
571 if (IS_ERR(priv->map)) {
572 dev_err(&spi->dev, "spi regmap init failed for rtc ds1343\n");
573 return PTR_ERR(priv->map);
576 res = regmap_read(priv->map, DS1343_SECONDS_REG, &data);
580 regmap_read(priv->map, DS1343_CONTROL_REG, &data);
581 data |= DS1343_INTCN;
582 data &= ~(DS1343_EOSC | DS1343_A1IE | DS1343_A0IE);
583 regmap_write(priv->map, DS1343_CONTROL_REG, data);
585 regmap_read(priv->map, DS1343_STATUS_REG, &data);
586 data &= ~(DS1343_OSF | DS1343_IRQF1 | DS1343_IRQF0);
587 regmap_write(priv->map, DS1343_STATUS_REG, data);
589 priv->rtc = devm_rtc_device_register(&spi->dev, "ds1343",
590 &ds1343_rtc_ops, THIS_MODULE);
591 if (IS_ERR(priv->rtc)) {
592 dev_err(&spi->dev, "unable to register rtc ds1343\n");
593 return PTR_ERR(priv->rtc);
597 res = devm_request_threaded_irq(&spi->dev, spi->irq, NULL,
599 IRQF_NO_SUSPEND | IRQF_ONESHOT,
603 "unable to request irq for rtc ds1343\n");
607 device_set_wakeup_capable(&spi->dev, 1);
610 res = ds1343_sysfs_register(&spi->dev);
613 "unable to create sysfs entries for rtc ds1343\n");
618 static int ds1343_remove(struct spi_device *spi)
620 struct ds1343_priv *priv = spi_get_drvdata(spi);
623 mutex_lock(&priv->mutex);
624 priv->irqen &= ~RTC_AF;
625 mutex_unlock(&priv->mutex);
627 devm_free_irq(&spi->dev, spi->irq, priv);
630 spi_set_drvdata(spi, NULL);
632 ds1343_sysfs_unregister(&spi->dev);
637 #ifdef CONFIG_PM_SLEEP
639 static int ds1343_suspend(struct device *dev)
641 struct spi_device *spi = to_spi_device(dev);
643 if (spi->irq >= 0 && device_may_wakeup(dev))
644 enable_irq_wake(spi->irq);
649 static int ds1343_resume(struct device *dev)
651 struct spi_device *spi = to_spi_device(dev);
653 if (spi->irq >= 0 && device_may_wakeup(dev))
654 disable_irq_wake(spi->irq);
661 static SIMPLE_DEV_PM_OPS(ds1343_pm, ds1343_suspend, ds1343_resume);
663 static struct spi_driver ds1343_driver = {
666 .owner = THIS_MODULE,
669 .probe = ds1343_probe,
670 .remove = ds1343_remove,
671 .id_table = ds1343_id,
674 module_spi_driver(ds1343_driver);
676 MODULE_DESCRIPTION("DS1343 RTC SPI Driver");
677 MODULE_AUTHOR("Raghavendra Chandra Ganiga <ravi23ganiga@gmail.com>");
678 MODULE_LICENSE("GPL v2");
679 MODULE_VERSION(DS1343_DRV_VERSION);