rtc-ds1742.c 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * An rtc driver for the Dallas DS1742
  4. *
  5. * Copyright (C) 2006 Atsushi Nemoto <[email protected]>
  6. *
  7. * Copyright (C) 2006 Torsten Ertbjerg Rasmussen <[email protected]>
  8. * - nvram size determined from resource
  9. * - this ds1742 driver now supports ds1743.
  10. */
  11. #include <linux/bcd.h>
  12. #include <linux/kernel.h>
  13. #include <linux/gfp.h>
  14. #include <linux/delay.h>
  15. #include <linux/jiffies.h>
  16. #include <linux/rtc.h>
  17. #include <linux/of.h>
  18. #include <linux/of_device.h>
  19. #include <linux/platform_device.h>
  20. #include <linux/io.h>
  21. #include <linux/module.h>
  22. #define RTC_SIZE 8
  23. #define RTC_CONTROL 0
  24. #define RTC_CENTURY 0
  25. #define RTC_SECONDS 1
  26. #define RTC_MINUTES 2
  27. #define RTC_HOURS 3
  28. #define RTC_DAY 4
  29. #define RTC_DATE 5
  30. #define RTC_MONTH 6
  31. #define RTC_YEAR 7
  32. #define RTC_CENTURY_MASK 0x3f
  33. #define RTC_SECONDS_MASK 0x7f
  34. #define RTC_DAY_MASK 0x07
  35. /* Bits in the Control/Century register */
  36. #define RTC_WRITE 0x80
  37. #define RTC_READ 0x40
  38. /* Bits in the Seconds register */
  39. #define RTC_STOP 0x80
  40. /* Bits in the Day register */
  41. #define RTC_BATT_FLAG 0x80
  42. struct rtc_plat_data {
  43. void __iomem *ioaddr_nvram;
  44. void __iomem *ioaddr_rtc;
  45. unsigned long last_jiffies;
  46. };
  47. static int ds1742_rtc_set_time(struct device *dev, struct rtc_time *tm)
  48. {
  49. struct rtc_plat_data *pdata = dev_get_drvdata(dev);
  50. void __iomem *ioaddr = pdata->ioaddr_rtc;
  51. u8 century;
  52. century = bin2bcd((tm->tm_year + 1900) / 100);
  53. writeb(RTC_WRITE, ioaddr + RTC_CONTROL);
  54. writeb(bin2bcd(tm->tm_year % 100), ioaddr + RTC_YEAR);
  55. writeb(bin2bcd(tm->tm_mon + 1), ioaddr + RTC_MONTH);
  56. writeb(bin2bcd(tm->tm_wday) & RTC_DAY_MASK, ioaddr + RTC_DAY);
  57. writeb(bin2bcd(tm->tm_mday), ioaddr + RTC_DATE);
  58. writeb(bin2bcd(tm->tm_hour), ioaddr + RTC_HOURS);
  59. writeb(bin2bcd(tm->tm_min), ioaddr + RTC_MINUTES);
  60. writeb(bin2bcd(tm->tm_sec) & RTC_SECONDS_MASK, ioaddr + RTC_SECONDS);
  61. /* RTC_CENTURY and RTC_CONTROL share same register */
  62. writeb(RTC_WRITE | (century & RTC_CENTURY_MASK), ioaddr + RTC_CENTURY);
  63. writeb(century & RTC_CENTURY_MASK, ioaddr + RTC_CONTROL);
  64. return 0;
  65. }
  66. static int ds1742_rtc_read_time(struct device *dev, struct rtc_time *tm)
  67. {
  68. struct rtc_plat_data *pdata = dev_get_drvdata(dev);
  69. void __iomem *ioaddr = pdata->ioaddr_rtc;
  70. unsigned int year, month, day, hour, minute, second, week;
  71. unsigned int century;
  72. /* give enough time to update RTC in case of continuous read */
  73. if (pdata->last_jiffies == jiffies)
  74. msleep(1);
  75. pdata->last_jiffies = jiffies;
  76. writeb(RTC_READ, ioaddr + RTC_CONTROL);
  77. second = readb(ioaddr + RTC_SECONDS) & RTC_SECONDS_MASK;
  78. minute = readb(ioaddr + RTC_MINUTES);
  79. hour = readb(ioaddr + RTC_HOURS);
  80. day = readb(ioaddr + RTC_DATE);
  81. week = readb(ioaddr + RTC_DAY) & RTC_DAY_MASK;
  82. month = readb(ioaddr + RTC_MONTH);
  83. year = readb(ioaddr + RTC_YEAR);
  84. century = readb(ioaddr + RTC_CENTURY) & RTC_CENTURY_MASK;
  85. writeb(0, ioaddr + RTC_CONTROL);
  86. tm->tm_sec = bcd2bin(second);
  87. tm->tm_min = bcd2bin(minute);
  88. tm->tm_hour = bcd2bin(hour);
  89. tm->tm_mday = bcd2bin(day);
  90. tm->tm_wday = bcd2bin(week);
  91. tm->tm_mon = bcd2bin(month) - 1;
  92. /* year is 1900 + tm->tm_year */
  93. tm->tm_year = bcd2bin(year) + bcd2bin(century) * 100 - 1900;
  94. return 0;
  95. }
  96. static const struct rtc_class_ops ds1742_rtc_ops = {
  97. .read_time = ds1742_rtc_read_time,
  98. .set_time = ds1742_rtc_set_time,
  99. };
  100. static int ds1742_nvram_read(void *priv, unsigned int pos, void *val,
  101. size_t bytes)
  102. {
  103. struct rtc_plat_data *pdata = priv;
  104. void __iomem *ioaddr = pdata->ioaddr_nvram;
  105. u8 *buf = val;
  106. for (; bytes; bytes--)
  107. *buf++ = readb(ioaddr + pos++);
  108. return 0;
  109. }
  110. static int ds1742_nvram_write(void *priv, unsigned int pos, void *val,
  111. size_t bytes)
  112. {
  113. struct rtc_plat_data *pdata = priv;
  114. void __iomem *ioaddr = pdata->ioaddr_nvram;
  115. u8 *buf = val;
  116. for (; bytes; bytes--)
  117. writeb(*buf++, ioaddr + pos++);
  118. return 0;
  119. }
  120. static int ds1742_rtc_probe(struct platform_device *pdev)
  121. {
  122. struct rtc_device *rtc;
  123. struct resource *res;
  124. unsigned int cen, sec;
  125. struct rtc_plat_data *pdata;
  126. void __iomem *ioaddr;
  127. int ret = 0;
  128. struct nvmem_config nvmem_cfg = {
  129. .name = "ds1742_nvram",
  130. .reg_read = ds1742_nvram_read,
  131. .reg_write = ds1742_nvram_write,
  132. };
  133. pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
  134. if (!pdata)
  135. return -ENOMEM;
  136. res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
  137. ioaddr = devm_ioremap_resource(&pdev->dev, res);
  138. if (IS_ERR(ioaddr))
  139. return PTR_ERR(ioaddr);
  140. pdata->ioaddr_nvram = ioaddr;
  141. pdata->ioaddr_rtc = ioaddr + resource_size(res) - RTC_SIZE;
  142. nvmem_cfg.size = resource_size(res) - RTC_SIZE;
  143. nvmem_cfg.priv = pdata;
  144. /* turn RTC on if it was not on */
  145. ioaddr = pdata->ioaddr_rtc;
  146. sec = readb(ioaddr + RTC_SECONDS);
  147. if (sec & RTC_STOP) {
  148. sec &= RTC_SECONDS_MASK;
  149. cen = readb(ioaddr + RTC_CENTURY) & RTC_CENTURY_MASK;
  150. writeb(RTC_WRITE, ioaddr + RTC_CONTROL);
  151. writeb(sec, ioaddr + RTC_SECONDS);
  152. writeb(cen & RTC_CENTURY_MASK, ioaddr + RTC_CONTROL);
  153. }
  154. if (!(readb(ioaddr + RTC_DAY) & RTC_BATT_FLAG))
  155. dev_warn(&pdev->dev, "voltage-low detected.\n");
  156. pdata->last_jiffies = jiffies;
  157. platform_set_drvdata(pdev, pdata);
  158. rtc = devm_rtc_allocate_device(&pdev->dev);
  159. if (IS_ERR(rtc))
  160. return PTR_ERR(rtc);
  161. rtc->ops = &ds1742_rtc_ops;
  162. ret = devm_rtc_register_device(rtc);
  163. if (ret)
  164. return ret;
  165. devm_rtc_nvmem_register(rtc, &nvmem_cfg);
  166. return 0;
  167. }
  168. static const struct of_device_id __maybe_unused ds1742_rtc_of_match[] = {
  169. { .compatible = "maxim,ds1742", },
  170. { }
  171. };
  172. MODULE_DEVICE_TABLE(of, ds1742_rtc_of_match);
  173. static struct platform_driver ds1742_rtc_driver = {
  174. .probe = ds1742_rtc_probe,
  175. .driver = {
  176. .name = "rtc-ds1742",
  177. .of_match_table = of_match_ptr(ds1742_rtc_of_match),
  178. },
  179. };
  180. module_platform_driver(ds1742_rtc_driver);
  181. MODULE_AUTHOR("Atsushi Nemoto <[email protected]>");
  182. MODULE_DESCRIPTION("Dallas DS1742 RTC driver");
  183. MODULE_LICENSE("GPL");
  184. MODULE_ALIAS("platform:rtc-ds1742");