Revert "drivers/misc/ti-st: remove gpio handling"
[linux-2.6-block.git] / drivers / rtc / class.c
CommitLineData
0c86edc0
AZ
1/*
2 * RTC subsystem, base class
3 *
4 * Copyright (C) 2005 Tower Technologies
5 * Author: Alessandro Zummo <a.zummo@towertech.it>
6 *
7 * class skeleton from drivers/hwmon/hwmon.c
8 *
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.
12*/
13
14#include <linux/module.h>
15#include <linux/rtc.h>
16#include <linux/kdev_t.h>
17#include <linux/idr.h>
5a0e3ad6 18#include <linux/slab.h>
6610e089 19#include <linux/workqueue.h>
0c86edc0 20
5726fb20
DB
21#include "rtc-core.h"
22
23
6d03d06d 24static DEFINE_IDA(rtc_ida);
0c86edc0
AZ
25struct class *rtc_class;
26
cd966209 27static void rtc_device_release(struct device *dev)
0c86edc0 28{
cd966209 29 struct rtc_device *rtc = to_rtc_device(dev);
6d03d06d 30 ida_simple_remove(&rtc_ida, rtc->id);
0c86edc0
AZ
31 kfree(rtc);
32}
33
4c24e29e
DF
34#ifdef CONFIG_RTC_HCTOSYS_DEVICE
35/* Result of the last RTC to system clock attempt. */
36int rtc_hctosys_ret = -ENODEV;
37#endif
7ca1d488 38
4c24e29e 39#if defined(CONFIG_PM) && defined(CONFIG_RTC_HCTOSYS_DEVICE)
7ca1d488
DB
40/*
41 * On suspend(), measure the delta between one RTC and the
42 * system's wall clock; restore it on resume().
43 */
44
3dcad5ff
JS
45static struct timespec old_rtc, old_system, old_delta;
46
7ca1d488
DB
47
48static int rtc_suspend(struct device *dev, pm_message_t mesg)
49{
50 struct rtc_device *rtc = to_rtc_device(dev);
51 struct rtc_time tm;
3dcad5ff 52 struct timespec delta, delta_delta;
d4afc76c 53 if (strcmp(dev_name(&rtc->dev), CONFIG_RTC_HCTOSYS_DEVICE) != 0)
7ca1d488
DB
54 return 0;
55
3dcad5ff 56 /* snapshot the current RTC and system time at suspend*/
7ca1d488 57 rtc_read_time(rtc, &tm);
3dcad5ff
JS
58 getnstimeofday(&old_system);
59 rtc_tm_to_time(&tm, &old_rtc.tv_sec);
60
61
62 /*
63 * To avoid drift caused by repeated suspend/resumes,
64 * which each can add ~1 second drift error,
65 * try to compensate so the difference in system time
66 * and rtc time stays close to constant.
67 */
68 delta = timespec_sub(old_system, old_rtc);
69 delta_delta = timespec_sub(delta, old_delta);
6a8943d9 70 if (delta_delta.tv_sec < -2 || delta_delta.tv_sec >= 2) {
3dcad5ff
JS
71 /*
72 * if delta_delta is too large, assume time correction
73 * has occured and set old_delta to the current delta.
74 */
75 old_delta = delta;
76 } else {
77 /* Otherwise try to adjust old_system to compensate */
78 old_system = timespec_sub(old_system, delta_delta);
79 }
7ca1d488 80
7ca1d488
DB
81 return 0;
82}
83
84static int rtc_resume(struct device *dev)
85{
86 struct rtc_device *rtc = to_rtc_device(dev);
87 struct rtc_time tm;
3dcad5ff
JS
88 struct timespec new_system, new_rtc;
89 struct timespec sleep_time;
7ca1d488 90
4c24e29e 91 rtc_hctosys_ret = -ENODEV;
d4afc76c 92 if (strcmp(dev_name(&rtc->dev), CONFIG_RTC_HCTOSYS_DEVICE) != 0)
7ca1d488
DB
93 return 0;
94
3dcad5ff
JS
95 /* snapshot the current rtc and system time at resume */
96 getnstimeofday(&new_system);
7ca1d488
DB
97 rtc_read_time(rtc, &tm);
98 if (rtc_valid_tm(&tm) != 0) {
d4afc76c 99 pr_debug("%s: bogus resume time\n", dev_name(&rtc->dev));
7ca1d488
DB
100 return 0;
101 }
3dcad5ff
JS
102 rtc_tm_to_time(&tm, &new_rtc.tv_sec);
103 new_rtc.tv_nsec = 0;
104
6a8943d9
AH
105 if (new_rtc.tv_sec < old_rtc.tv_sec) {
106 pr_debug("%s: time travel!\n", dev_name(&rtc->dev));
7ca1d488
DB
107 return 0;
108 }
109
3dcad5ff
JS
110 /* calculate the RTC time delta (sleep time)*/
111 sleep_time = timespec_sub(new_rtc, old_rtc);
112
113 /*
114 * Since these RTC suspend/resume handlers are not called
115 * at the very end of suspend or the start of resume,
116 * some run-time may pass on either sides of the sleep time
117 * so subtract kernel run-time between rtc_suspend to rtc_resume
118 * to keep things accurate.
119 */
120 sleep_time = timespec_sub(sleep_time,
121 timespec_sub(new_system, old_system));
7ca1d488 122
6a8943d9
AH
123 if (sleep_time.tv_sec >= 0)
124 timekeeping_inject_sleeptime(&sleep_time);
4c24e29e 125 rtc_hctosys_ret = 0;
7ca1d488
DB
126 return 0;
127}
128
129#else
130#define rtc_suspend NULL
131#define rtc_resume NULL
132#endif
133
134
0c86edc0
AZ
135/**
136 * rtc_device_register - register w/ RTC class
137 * @dev: the device to register
138 *
139 * rtc_device_unregister() must be called when the class device is no
140 * longer needed.
141 *
142 * Returns the pointer to the new struct class device.
143 */
144struct rtc_device *rtc_device_register(const char *name, struct device *dev,
ff8371ac 145 const struct rtc_class_ops *ops,
0c86edc0
AZ
146 struct module *owner)
147{
148 struct rtc_device *rtc;
f44f7f96 149 struct rtc_wkalrm alrm;
0c86edc0
AZ
150 int id, err;
151
6d03d06d
JC
152 id = ida_simple_get(&rtc_ida, 0, 0, GFP_KERNEL);
153 if (id < 0) {
154 err = id;
0c86edc0
AZ
155 goto exit;
156 }
157
0c86edc0
AZ
158 rtc = kzalloc(sizeof(struct rtc_device), GFP_KERNEL);
159 if (rtc == NULL) {
160 err = -ENOMEM;
6d03d06d 161 goto exit_ida;
0c86edc0
AZ
162 }
163
164 rtc->id = id;
165 rtc->ops = ops;
166 rtc->owner = owner;
83a06bf5 167 rtc->irq_freq = 1;
110d693d 168 rtc->max_user_freq = 64;
cd966209
DB
169 rtc->dev.parent = dev;
170 rtc->dev.class = rtc_class;
171 rtc->dev.release = rtc_device_release;
0c86edc0
AZ
172
173 mutex_init(&rtc->ops_lock);
174 spin_lock_init(&rtc->irq_lock);
175 spin_lock_init(&rtc->irq_task_lock);
d691eb90 176 init_waitqueue_head(&rtc->irq_queue);
0c86edc0 177
6610e089
JS
178 /* Init timerqueue */
179 timerqueue_init_head(&rtc->timerqueue);
96c8f06a 180 INIT_WORK(&rtc->irqwork, rtc_timer_do_work);
6610e089 181 /* Init aie timer */
96c8f06a 182 rtc_timer_init(&rtc->aie_timer, rtc_aie_update_irq, (void *)rtc);
6610e089 183 /* Init uie timer */
96c8f06a 184 rtc_timer_init(&rtc->uie_rtctimer, rtc_uie_update_irq, (void *)rtc);
6610e089
JS
185 /* Init pie timer */
186 hrtimer_init(&rtc->pie_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
187 rtc->pie_timer.function = rtc_pie_update_irq;
188 rtc->pie_enabled = 0;
189
f44f7f96
JS
190 /* Check to see if there is an ALARM already set in hw */
191 err = __rtc_read_alarm(rtc, &alrm);
192
193 if (!err && !rtc_valid_tm(&alrm.time))
f6d5b331 194 rtc_initialize_alarm(rtc, &alrm);
f44f7f96 195
0c86edc0 196 strlcpy(rtc->name, name, RTC_DEVICE_NAME_SIZE);
d4afc76c 197 dev_set_name(&rtc->dev, "rtc%d", id);
0c86edc0 198
cb3a58d2
DB
199 rtc_dev_prepare(rtc);
200
cd966209 201 err = device_register(&rtc->dev);
59cca865
VK
202 if (err) {
203 put_device(&rtc->dev);
0c86edc0 204 goto exit_kfree;
59cca865 205 }
0c86edc0 206
5726fb20 207 rtc_dev_add_device(rtc);
446ecbd9 208 rtc_sysfs_add_device(rtc);
7d9f99ec 209 rtc_proc_add_device(rtc);
5726fb20 210
0c86edc0 211 dev_info(dev, "rtc core: registered %s as %s\n",
d4afc76c 212 rtc->name, dev_name(&rtc->dev));
0c86edc0
AZ
213
214 return rtc;
215
216exit_kfree:
217 kfree(rtc);
218
6d03d06d
JC
219exit_ida:
220 ida_simple_remove(&rtc_ida, id);
0c86edc0
AZ
221
222exit:
d1d65b77
AZ
223 dev_err(dev, "rtc core: unable to register %s, err = %d\n",
224 name, err);
0c86edc0
AZ
225 return ERR_PTR(err);
226}
227EXPORT_SYMBOL_GPL(rtc_device_register);
228
229
230/**
231 * rtc_device_unregister - removes the previously registered RTC class device
232 *
233 * @rtc: the RTC class device to destroy
234 */
235void rtc_device_unregister(struct rtc_device *rtc)
236{
cd966209 237 if (get_device(&rtc->dev) != NULL) {
e109ebd1
DB
238 mutex_lock(&rtc->ops_lock);
239 /* remove innards of this RTC, then disable it, before
240 * letting any rtc_class_open() users access it again
241 */
446ecbd9 242 rtc_sysfs_del_device(rtc);
5726fb20 243 rtc_dev_del_device(rtc);
7d9f99ec 244 rtc_proc_del_device(rtc);
cd966209 245 device_unregister(&rtc->dev);
e109ebd1
DB
246 rtc->ops = NULL;
247 mutex_unlock(&rtc->ops_lock);
cd966209 248 put_device(&rtc->dev);
e109ebd1 249 }
0c86edc0
AZ
250}
251EXPORT_SYMBOL_GPL(rtc_device_unregister);
252
0c86edc0
AZ
253static int __init rtc_init(void)
254{
255 rtc_class = class_create(THIS_MODULE, "rtc");
256 if (IS_ERR(rtc_class)) {
257 printk(KERN_ERR "%s: couldn't create class\n", __FILE__);
258 return PTR_ERR(rtc_class);
259 }
7ca1d488
DB
260 rtc_class->suspend = rtc_suspend;
261 rtc_class->resume = rtc_resume;
5726fb20 262 rtc_dev_init();
446ecbd9 263 rtc_sysfs_init(rtc_class);
0c86edc0
AZ
264 return 0;
265}
266
267static void __exit rtc_exit(void)
268{
5726fb20 269 rtc_dev_exit();
0c86edc0 270 class_destroy(rtc_class);
6d03d06d 271 ida_destroy(&rtc_ida);
0c86edc0
AZ
272}
273
818a8674 274subsys_initcall(rtc_init);
0c86edc0
AZ
275module_exit(rtc_exit);
276
818a8674 277MODULE_AUTHOR("Alessandro Zummo <a.zummo@towertech.it>");
0c86edc0
AZ
278MODULE_DESCRIPTION("RTC class support");
279MODULE_LICENSE("GPL");