rtc: make rtc-ds1553 driver hotplug-aware
[linux-3.10.git] / drivers / rtc / rtc-ds1742.c
1 /*
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.
9  *
10  * Copyright (C) 2006 Torsten Ertbjerg Rasmussen <tr@newtec.dk>
11  *  - nvram size determined from resource
12  *  - this ds1742 driver now supports ds1743.
13  */
14
15 #include <linux/bcd.h>
16 #include <linux/init.h>
17 #include <linux/kernel.h>
18 #include <linux/delay.h>
19 #include <linux/jiffies.h>
20 #include <linux/rtc.h>
21 #include <linux/platform_device.h>
22 #include <linux/io.h>
23
24 #define DRV_VERSION "0.3"
25
26 #define RTC_SIZE                8
27
28 #define RTC_CONTROL             0
29 #define RTC_CENTURY             0
30 #define RTC_SECONDS             1
31 #define RTC_MINUTES             2
32 #define RTC_HOURS               3
33 #define RTC_DAY                 4
34 #define RTC_DATE                5
35 #define RTC_MONTH               6
36 #define RTC_YEAR                7
37
38 #define RTC_CENTURY_MASK        0x3f
39 #define RTC_SECONDS_MASK        0x7f
40 #define RTC_DAY_MASK            0x07
41
42 /* Bits in the Control/Century register */
43 #define RTC_WRITE               0x80
44 #define RTC_READ                0x40
45
46 /* Bits in the Seconds register */
47 #define RTC_STOP                0x80
48
49 /* Bits in the Day register */
50 #define RTC_BATT_FLAG           0x80
51
52 struct rtc_plat_data {
53         struct rtc_device *rtc;
54         void __iomem *ioaddr_nvram;
55         void __iomem *ioaddr_rtc;
56         size_t size_nvram;
57         size_t size;
58         resource_size_t baseaddr;
59         unsigned long last_jiffies;
60 };
61
62 static int ds1742_rtc_set_time(struct device *dev, struct rtc_time *tm)
63 {
64         struct platform_device *pdev = to_platform_device(dev);
65         struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
66         void __iomem *ioaddr = pdata->ioaddr_rtc;
67         u8 century;
68
69         century = BIN2BCD((tm->tm_year + 1900) / 100);
70
71         writeb(RTC_WRITE, ioaddr + RTC_CONTROL);
72
73         writeb(BIN2BCD(tm->tm_year % 100), ioaddr + RTC_YEAR);
74         writeb(BIN2BCD(tm->tm_mon + 1), ioaddr + RTC_MONTH);
75         writeb(BIN2BCD(tm->tm_wday) & RTC_DAY_MASK, ioaddr + RTC_DAY);
76         writeb(BIN2BCD(tm->tm_mday), ioaddr + RTC_DATE);
77         writeb(BIN2BCD(tm->tm_hour), ioaddr + RTC_HOURS);
78         writeb(BIN2BCD(tm->tm_min), ioaddr + RTC_MINUTES);
79         writeb(BIN2BCD(tm->tm_sec) & RTC_SECONDS_MASK, ioaddr + RTC_SECONDS);
80
81         /* RTC_CENTURY and RTC_CONTROL share same register */
82         writeb(RTC_WRITE | (century & RTC_CENTURY_MASK), ioaddr + RTC_CENTURY);
83         writeb(century & RTC_CENTURY_MASK, ioaddr + RTC_CONTROL);
84         return 0;
85 }
86
87 static int ds1742_rtc_read_time(struct device *dev, struct rtc_time *tm)
88 {
89         struct platform_device *pdev = to_platform_device(dev);
90         struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
91         void __iomem *ioaddr = pdata->ioaddr_rtc;
92         unsigned int year, month, day, hour, minute, second, week;
93         unsigned int century;
94
95         /* give enough time to update RTC in case of continuous read */
96         if (pdata->last_jiffies == jiffies)
97                 msleep(1);
98         pdata->last_jiffies = jiffies;
99         writeb(RTC_READ, ioaddr + RTC_CONTROL);
100         second = readb(ioaddr + RTC_SECONDS) & RTC_SECONDS_MASK;
101         minute = readb(ioaddr + RTC_MINUTES);
102         hour = readb(ioaddr + RTC_HOURS);
103         day = readb(ioaddr + RTC_DATE);
104         week = readb(ioaddr + RTC_DAY) & RTC_DAY_MASK;
105         month = readb(ioaddr + RTC_MONTH);
106         year = readb(ioaddr + RTC_YEAR);
107         century = readb(ioaddr + RTC_CENTURY) & RTC_CENTURY_MASK;
108         writeb(0, ioaddr + RTC_CONTROL);
109         tm->tm_sec = BCD2BIN(second);
110         tm->tm_min = BCD2BIN(minute);
111         tm->tm_hour = BCD2BIN(hour);
112         tm->tm_mday = BCD2BIN(day);
113         tm->tm_wday = BCD2BIN(week);
114         tm->tm_mon = BCD2BIN(month) - 1;
115         /* year is 1900 + tm->tm_year */
116         tm->tm_year = BCD2BIN(year) + BCD2BIN(century) * 100 - 1900;
117
118         if (rtc_valid_tm(tm) < 0) {
119                 dev_err(dev, "retrieved date/time is not valid.\n");
120                 rtc_time_to_tm(0, tm);
121         }
122         return 0;
123 }
124
125 static const struct rtc_class_ops ds1742_rtc_ops = {
126         .read_time      = ds1742_rtc_read_time,
127         .set_time       = ds1742_rtc_set_time,
128 };
129
130 static ssize_t ds1742_nvram_read(struct kobject *kobj,
131                                  struct bin_attribute *bin_attr,
132                                  char *buf, loff_t pos, size_t size)
133 {
134         struct platform_device *pdev =
135                 to_platform_device(container_of(kobj, struct device, kobj));
136         struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
137         void __iomem *ioaddr = pdata->ioaddr_nvram;
138         ssize_t count;
139
140         for (count = 0; size > 0 && pos < pdata->size_nvram; count++, size--)
141                 *buf++ = readb(ioaddr + pos++);
142         return count;
143 }
144
145 static ssize_t ds1742_nvram_write(struct kobject *kobj,
146                                   struct bin_attribute *bin_attr,
147                                   char *buf, loff_t pos, size_t size)
148 {
149         struct platform_device *pdev =
150                 to_platform_device(container_of(kobj, struct device, kobj));
151         struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
152         void __iomem *ioaddr = pdata->ioaddr_nvram;
153         ssize_t count;
154
155         for (count = 0; size > 0 && pos < pdata->size_nvram; count++, size--)
156                 writeb(*buf++, ioaddr + pos++);
157         return count;
158 }
159
160 static struct bin_attribute ds1742_nvram_attr = {
161         .attr = {
162                 .name = "nvram",
163                 .mode = S_IRUGO | S_IWUGO,
164         },
165         .read = ds1742_nvram_read,
166         .write = ds1742_nvram_write,
167 };
168
169 static int __devinit ds1742_rtc_probe(struct platform_device *pdev)
170 {
171         struct rtc_device *rtc;
172         struct resource *res;
173         unsigned int cen, sec;
174         struct rtc_plat_data *pdata = NULL;
175         void __iomem *ioaddr = NULL;
176         int ret = 0;
177
178         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
179         if (!res)
180                 return -ENODEV;
181         pdata = kzalloc(sizeof(*pdata), GFP_KERNEL);
182         if (!pdata)
183                 return -ENOMEM;
184         pdata->size = res->end - res->start + 1;
185         if (!request_mem_region(res->start, pdata->size, pdev->name)) {
186                 ret = -EBUSY;
187                 goto out;
188         }
189         pdata->baseaddr = res->start;
190         ioaddr = ioremap(pdata->baseaddr, pdata->size);
191         if (!ioaddr) {
192                 ret = -ENOMEM;
193                 goto out;
194         }
195         pdata->ioaddr_nvram = ioaddr;
196         pdata->size_nvram = pdata->size - RTC_SIZE;
197         pdata->ioaddr_rtc = ioaddr + pdata->size_nvram;
198
199         /* turn RTC on if it was not on */
200         ioaddr = pdata->ioaddr_rtc;
201         sec = readb(ioaddr + RTC_SECONDS);
202         if (sec & RTC_STOP) {
203                 sec &= RTC_SECONDS_MASK;
204                 cen = readb(ioaddr + RTC_CENTURY) & RTC_CENTURY_MASK;
205                 writeb(RTC_WRITE, ioaddr + RTC_CONTROL);
206                 writeb(sec, ioaddr + RTC_SECONDS);
207                 writeb(cen & RTC_CENTURY_MASK, ioaddr + RTC_CONTROL);
208         }
209         if (!(readb(ioaddr + RTC_DAY) & RTC_BATT_FLAG))
210                 dev_warn(&pdev->dev, "voltage-low detected.\n");
211
212         rtc = rtc_device_register(pdev->name, &pdev->dev,
213                                   &ds1742_rtc_ops, THIS_MODULE);
214         if (IS_ERR(rtc)) {
215                 ret = PTR_ERR(rtc);
216                 goto out;
217         }
218         pdata->rtc = rtc;
219         pdata->last_jiffies = jiffies;
220         platform_set_drvdata(pdev, pdata);
221         ds1742_nvram_attr.size = max(ds1742_nvram_attr.size,
222                                      pdata->size_nvram);
223         ret = sysfs_create_bin_file(&pdev->dev.kobj, &ds1742_nvram_attr);
224         if (ret)
225                 goto out;
226         return 0;
227  out:
228         if (pdata->rtc)
229                 rtc_device_unregister(pdata->rtc);
230         if (pdata->ioaddr_nvram)
231                 iounmap(pdata->ioaddr_nvram);
232         if (pdata->baseaddr)
233                 release_mem_region(pdata->baseaddr, pdata->size);
234         kfree(pdata);
235         return ret;
236 }
237
238 static int __devexit ds1742_rtc_remove(struct platform_device *pdev)
239 {
240         struct rtc_plat_data *pdata = platform_get_drvdata(pdev);
241
242         sysfs_remove_bin_file(&pdev->dev.kobj, &ds1742_nvram_attr);
243         rtc_device_unregister(pdata->rtc);
244         iounmap(pdata->ioaddr_nvram);
245         release_mem_region(pdata->baseaddr, pdata->size);
246         kfree(pdata);
247         return 0;
248 }
249
250 static struct platform_driver ds1742_rtc_driver = {
251         .probe          = ds1742_rtc_probe,
252         .remove         = __devexit_p(ds1742_rtc_remove),
253         .driver         = {
254                 .name   = "ds1742",
255                 .owner  = THIS_MODULE,
256         },
257 };
258
259 static __init int ds1742_init(void)
260 {
261         return platform_driver_register(&ds1742_rtc_driver);
262 }
263
264 static __exit void ds1742_exit(void)
265 {
266         platform_driver_unregister(&ds1742_rtc_driver);
267 }
268
269 module_init(ds1742_init);
270 module_exit(ds1742_exit);
271
272 MODULE_AUTHOR("Atsushi Nemoto <anemo@mba.ocn.ne.jp>");
273 MODULE_DESCRIPTION("Dallas DS1742 RTC driver");
274 MODULE_LICENSE("GPL");
275 MODULE_VERSION(DRV_VERSION);