blob: 042630c90dd34e7c8232a3ddde5b14809bf0176e [file] [log] [blame]
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -07001/*
2 * An rtc driver for the Dallas DS1742
3 *
4 * Copyright (C) 2006 Atsushi Nemoto <anemo@mba.ocn.ne.jp>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
Torsten Ertbjerg Rasmussenf9231a02006-12-06 20:39:41 -08009 *
10 * Copyright (C) 2006 Torsten Ertbjerg Rasmussen <tr@newtec.dk>
11 * - nvram size determined from resource
12 * - this ds1742 driver now supports ds1743.
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -070013 */
14
15#include <linux/bcd.h>
16#include <linux/init.h>
17#include <linux/kernel.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090018#include <linux/gfp.h>
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -070019#include <linux/delay.h>
20#include <linux/jiffies.h>
21#include <linux/rtc.h>
22#include <linux/platform_device.h>
23#include <linux/io.h>
24
Atsushi Nemotoac18eb62009-12-15 16:46:02 -080025#define DRV_VERSION "0.4"
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -070026
Torsten Ertbjerg Rasmussenf9231a02006-12-06 20:39:41 -080027#define RTC_SIZE 8
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -070028
Torsten Ertbjerg Rasmussenf9231a02006-12-06 20:39:41 -080029#define RTC_CONTROL 0
30#define RTC_CENTURY 0
31#define RTC_SECONDS 1
32#define RTC_MINUTES 2
33#define RTC_HOURS 3
34#define RTC_DAY 4
35#define RTC_DATE 5
36#define RTC_MONTH 6
37#define RTC_YEAR 7
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -070038
39#define RTC_CENTURY_MASK 0x3f
40#define RTC_SECONDS_MASK 0x7f
41#define RTC_DAY_MASK 0x07
42
43/* Bits in the Control/Century register */
44#define RTC_WRITE 0x80
45#define RTC_READ 0x40
46
47/* Bits in the Seconds register */
48#define RTC_STOP 0x80
49
50/* Bits in the Day register */
51#define RTC_BATT_FLAG 0x80
52
53struct rtc_plat_data {
54 struct rtc_device *rtc;
Torsten Ertbjerg Rasmussenf9231a02006-12-06 20:39:41 -080055 void __iomem *ioaddr_nvram;
56 void __iomem *ioaddr_rtc;
57 size_t size_nvram;
58 size_t size;
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -070059 unsigned long last_jiffies;
Torsten Ertbjerg Rasmussen3a729702009-06-17 16:26:07 -070060 struct bin_attribute nvram_attr;
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -070061};
62
63static int ds1742_rtc_set_time(struct device *dev, struct rtc_time *tm)
64{
65 struct platform_device *pdev = to_platform_device(dev);
66 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
Torsten Ertbjerg Rasmussenf9231a02006-12-06 20:39:41 -080067 void __iomem *ioaddr = pdata->ioaddr_rtc;
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -070068 u8 century;
69
Adrian Bunkfe20ba72008-10-18 20:28:41 -070070 century = bin2bcd((tm->tm_year + 1900) / 100);
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -070071
72 writeb(RTC_WRITE, ioaddr + RTC_CONTROL);
73
Adrian Bunkfe20ba72008-10-18 20:28:41 -070074 writeb(bin2bcd(tm->tm_year % 100), ioaddr + RTC_YEAR);
75 writeb(bin2bcd(tm->tm_mon + 1), ioaddr + RTC_MONTH);
76 writeb(bin2bcd(tm->tm_wday) & RTC_DAY_MASK, ioaddr + RTC_DAY);
77 writeb(bin2bcd(tm->tm_mday), ioaddr + RTC_DATE);
78 writeb(bin2bcd(tm->tm_hour), ioaddr + RTC_HOURS);
79 writeb(bin2bcd(tm->tm_min), ioaddr + RTC_MINUTES);
80 writeb(bin2bcd(tm->tm_sec) & RTC_SECONDS_MASK, ioaddr + RTC_SECONDS);
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -070081
82 /* RTC_CENTURY and RTC_CONTROL share same register */
83 writeb(RTC_WRITE | (century & RTC_CENTURY_MASK), ioaddr + RTC_CENTURY);
84 writeb(century & RTC_CENTURY_MASK, ioaddr + RTC_CONTROL);
85 return 0;
86}
87
88static int ds1742_rtc_read_time(struct device *dev, struct rtc_time *tm)
89{
90 struct platform_device *pdev = to_platform_device(dev);
91 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
Torsten Ertbjerg Rasmussenf9231a02006-12-06 20:39:41 -080092 void __iomem *ioaddr = pdata->ioaddr_rtc;
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -070093 unsigned int year, month, day, hour, minute, second, week;
94 unsigned int century;
95
96 /* give enough time to update RTC in case of continuous read */
97 if (pdata->last_jiffies == jiffies)
98 msleep(1);
99 pdata->last_jiffies = jiffies;
100 writeb(RTC_READ, ioaddr + RTC_CONTROL);
101 second = readb(ioaddr + RTC_SECONDS) & RTC_SECONDS_MASK;
102 minute = readb(ioaddr + RTC_MINUTES);
103 hour = readb(ioaddr + RTC_HOURS);
104 day = readb(ioaddr + RTC_DATE);
105 week = readb(ioaddr + RTC_DAY) & RTC_DAY_MASK;
106 month = readb(ioaddr + RTC_MONTH);
107 year = readb(ioaddr + RTC_YEAR);
108 century = readb(ioaddr + RTC_CENTURY) & RTC_CENTURY_MASK;
109 writeb(0, ioaddr + RTC_CONTROL);
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700110 tm->tm_sec = bcd2bin(second);
111 tm->tm_min = bcd2bin(minute);
112 tm->tm_hour = bcd2bin(hour);
113 tm->tm_mday = bcd2bin(day);
114 tm->tm_wday = bcd2bin(week);
115 tm->tm_mon = bcd2bin(month) - 1;
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700116 /* year is 1900 + tm->tm_year */
Adrian Bunkfe20ba72008-10-18 20:28:41 -0700117 tm->tm_year = bcd2bin(year) + bcd2bin(century) * 100 - 1900;
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700118
119 if (rtc_valid_tm(tm) < 0) {
120 dev_err(dev, "retrieved date/time is not valid.\n");
121 rtc_time_to_tm(0, tm);
122 }
123 return 0;
124}
125
David Brownellff8371a2006-09-30 23:28:17 -0700126static const struct rtc_class_ops ds1742_rtc_ops = {
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700127 .read_time = ds1742_rtc_read_time,
128 .set_time = ds1742_rtc_set_time,
129};
130
Chris Wright2c3c8be2010-05-12 18:28:57 -0700131static ssize_t ds1742_nvram_read(struct file *filp, struct kobject *kobj,
Zhang Rui91a69022007-06-09 13:57:22 +0800132 struct bin_attribute *bin_attr,
133 char *buf, loff_t pos, size_t size)
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700134{
Atsushi Nemoto50e49be2009-12-15 16:46:04 -0800135 struct device *dev = container_of(kobj, struct device, kobj);
136 struct platform_device *pdev = to_platform_device(dev);
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700137 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
Torsten Ertbjerg Rasmussenf9231a02006-12-06 20:39:41 -0800138 void __iomem *ioaddr = pdata->ioaddr_nvram;
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700139 ssize_t count;
140
Torsten Ertbjerg Rasmussenf9231a02006-12-06 20:39:41 -0800141 for (count = 0; size > 0 && pos < pdata->size_nvram; count++, size--)
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700142 *buf++ = readb(ioaddr + pos++);
143 return count;
144}
145
Chris Wright2c3c8be2010-05-12 18:28:57 -0700146static ssize_t ds1742_nvram_write(struct file *filp, struct kobject *kobj,
Zhang Rui91a69022007-06-09 13:57:22 +0800147 struct bin_attribute *bin_attr,
148 char *buf, loff_t pos, size_t size)
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700149{
Atsushi Nemoto50e49be2009-12-15 16:46:04 -0800150 struct device *dev = container_of(kobj, struct device, kobj);
151 struct platform_device *pdev = to_platform_device(dev);
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700152 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
Torsten Ertbjerg Rasmussenf9231a02006-12-06 20:39:41 -0800153 void __iomem *ioaddr = pdata->ioaddr_nvram;
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700154 ssize_t count;
155
Torsten Ertbjerg Rasmussenf9231a02006-12-06 20:39:41 -0800156 for (count = 0; size > 0 && pos < pdata->size_nvram; count++, size--)
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700157 writeb(*buf++, ioaddr + pos++);
158 return count;
159}
160
Prarit Bhargavac2391222007-02-12 00:52:29 -0800161static int __devinit ds1742_rtc_probe(struct platform_device *pdev)
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700162{
163 struct rtc_device *rtc;
164 struct resource *res;
165 unsigned int cen, sec;
Atsushi Nemotoac18eb62009-12-15 16:46:02 -0800166 struct rtc_plat_data *pdata;
167 void __iomem *ioaddr;
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700168 int ret = 0;
169
170 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
171 if (!res)
172 return -ENODEV;
Atsushi Nemotoac18eb62009-12-15 16:46:02 -0800173 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700174 if (!pdata)
175 return -ENOMEM;
Torsten Ertbjerg Rasmussenf9231a02006-12-06 20:39:41 -0800176 pdata->size = res->end - res->start + 1;
Atsushi Nemotoac18eb62009-12-15 16:46:02 -0800177 if (!devm_request_mem_region(&pdev->dev, res->start, pdata->size,
178 pdev->name))
179 return -EBUSY;
180 ioaddr = devm_ioremap(&pdev->dev, res->start, pdata->size);
181 if (!ioaddr)
182 return -ENOMEM;
183
Torsten Ertbjerg Rasmussenf9231a02006-12-06 20:39:41 -0800184 pdata->ioaddr_nvram = ioaddr;
185 pdata->size_nvram = pdata->size - RTC_SIZE;
186 pdata->ioaddr_rtc = ioaddr + pdata->size_nvram;
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700187
Wolfram Sangf9373312010-03-15 01:29:41 +0100188 sysfs_bin_attr_init(&pdata->nvram_attr);
Torsten Ertbjerg Rasmussen3a729702009-06-17 16:26:07 -0700189 pdata->nvram_attr.attr.name = "nvram";
190 pdata->nvram_attr.attr.mode = S_IRUGO | S_IWUSR;
191 pdata->nvram_attr.read = ds1742_nvram_read;
192 pdata->nvram_attr.write = ds1742_nvram_write;
193 pdata->nvram_attr.size = pdata->size_nvram;
194
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700195 /* turn RTC on if it was not on */
Torsten Ertbjerg Rasmussenf9231a02006-12-06 20:39:41 -0800196 ioaddr = pdata->ioaddr_rtc;
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700197 sec = readb(ioaddr + RTC_SECONDS);
198 if (sec & RTC_STOP) {
199 sec &= RTC_SECONDS_MASK;
200 cen = readb(ioaddr + RTC_CENTURY) & RTC_CENTURY_MASK;
201 writeb(RTC_WRITE, ioaddr + RTC_CONTROL);
202 writeb(sec, ioaddr + RTC_SECONDS);
203 writeb(cen & RTC_CENTURY_MASK, ioaddr + RTC_CONTROL);
204 }
Atsushi Nemoto391b1fe2006-09-30 23:28:18 -0700205 if (!(readb(ioaddr + RTC_DAY) & RTC_BATT_FLAG))
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700206 dev_warn(&pdev->dev, "voltage-low detected.\n");
207
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700208 pdata->last_jiffies = jiffies;
209 platform_set_drvdata(pdev, pdata);
Atsushi Nemotoac18eb62009-12-15 16:46:02 -0800210 rtc = rtc_device_register(pdev->name, &pdev->dev,
211 &ds1742_rtc_ops, THIS_MODULE);
212 if (IS_ERR(rtc))
213 return PTR_ERR(rtc);
214 pdata->rtc = rtc;
Torsten Ertbjerg Rasmussen3a729702009-06-17 16:26:07 -0700215
216 ret = sysfs_create_bin_file(&pdev->dev.kobj, &pdata->nvram_attr);
217 if (ret) {
218 dev_err(&pdev->dev, "creating nvram file in sysfs failed\n");
Atsushi Nemotoac18eb62009-12-15 16:46:02 -0800219 rtc_device_unregister(rtc);
Torsten Ertbjerg Rasmussen3a729702009-06-17 16:26:07 -0700220 }
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700221 return ret;
222}
223
224static int __devexit ds1742_rtc_remove(struct platform_device *pdev)
225{
226 struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
227
Torsten Ertbjerg Rasmussen3a729702009-06-17 16:26:07 -0700228 sysfs_remove_bin_file(&pdev->dev.kobj, &pdata->nvram_attr);
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700229 rtc_device_unregister(pdata->rtc);
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700230 return 0;
231}
232
233static struct platform_driver ds1742_rtc_driver = {
234 .probe = ds1742_rtc_probe,
235 .remove = __devexit_p(ds1742_rtc_remove),
236 .driver = {
Atsushi Nemotoa95e23a2007-10-16 01:28:18 -0700237 .name = "rtc-ds1742",
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700238 .owner = THIS_MODULE,
239 },
240};
241
242static __init int ds1742_init(void)
243{
244 return platform_driver_register(&ds1742_rtc_driver);
245}
246
247static __exit void ds1742_exit(void)
248{
Atsushi Nemotoef154ec2007-07-21 04:37:55 -0700249 platform_driver_unregister(&ds1742_rtc_driver);
Atsushi Nemoto5ec3e4b2006-06-25 05:48:29 -0700250}
251
252module_init(ds1742_init);
253module_exit(ds1742_exit);
254
255MODULE_AUTHOR("Atsushi Nemoto <anemo@mba.ocn.ne.jp>");
256MODULE_DESCRIPTION("Dallas DS1742 RTC driver");
257MODULE_LICENSE("GPL");
258MODULE_VERSION(DRV_VERSION);
Kay Sieversad28a072008-04-10 21:29:25 -0700259MODULE_ALIAS("platform:rtc-ds1742");