rtc: Update suspend/resume timing to use 64bit time
[deliverable/linux.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
c100a5e0
JH
14#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15
0c86edc0 16#include <linux/module.h>
9d2b7e53 17#include <linux/of.h>
0c86edc0
AZ
18#include <linux/rtc.h>
19#include <linux/kdev_t.h>
20#include <linux/idr.h>
5a0e3ad6 21#include <linux/slab.h>
6610e089 22#include <linux/workqueue.h>
0c86edc0 23
5726fb20
DB
24#include "rtc-core.h"
25
26
6d03d06d 27static DEFINE_IDA(rtc_ida);
0c86edc0
AZ
28struct class *rtc_class;
29
cd966209 30static void rtc_device_release(struct device *dev)
0c86edc0 31{
cd966209 32 struct rtc_device *rtc = to_rtc_device(dev);
6d03d06d 33 ida_simple_remove(&rtc_ida, rtc->id);
0c86edc0
AZ
34 kfree(rtc);
35}
36
4c24e29e
DF
37#ifdef CONFIG_RTC_HCTOSYS_DEVICE
38/* Result of the last RTC to system clock attempt. */
39int rtc_hctosys_ret = -ENODEV;
40#endif
7ca1d488 41
92e7f04a 42#if defined(CONFIG_PM_SLEEP) && defined(CONFIG_RTC_HCTOSYS_DEVICE)
7ca1d488
DB
43/*
44 * On suspend(), measure the delta between one RTC and the
45 * system's wall clock; restore it on resume().
46 */
47
d4bda8f8 48static struct timespec64 old_rtc, old_system, old_delta;
3dcad5ff 49
7ca1d488 50
92e7f04a 51static int rtc_suspend(struct device *dev)
7ca1d488
DB
52{
53 struct rtc_device *rtc = to_rtc_device(dev);
54 struct rtc_time tm;
d4bda8f8 55 struct timespec64 delta, delta_delta;
e1d60093 56 int err;
9ecf37eb
FT
57
58 if (has_persistent_clock())
59 return 0;
60
d4afc76c 61 if (strcmp(dev_name(&rtc->dev), CONFIG_RTC_HCTOSYS_DEVICE) != 0)
7ca1d488
DB
62 return 0;
63
3dcad5ff 64 /* snapshot the current RTC and system time at suspend*/
e1d60093
HG
65 err = rtc_read_time(rtc, &tm);
66 if (err < 0) {
67 pr_debug("%s: fail to read rtc time\n", dev_name(&rtc->dev));
68 return 0;
69 }
70
d4bda8f8
JS
71 getnstimeofday64(&old_system);
72 old_rtc.tv_sec = rtc_tm_to_time64(&tm);
3dcad5ff
JS
73
74
75 /*
76 * To avoid drift caused by repeated suspend/resumes,
77 * which each can add ~1 second drift error,
78 * try to compensate so the difference in system time
79 * and rtc time stays close to constant.
80 */
d4bda8f8
JS
81 delta = timespec64_sub(old_system, old_rtc);
82 delta_delta = timespec64_sub(delta, old_delta);
6a8943d9 83 if (delta_delta.tv_sec < -2 || delta_delta.tv_sec >= 2) {
3dcad5ff
JS
84 /*
85 * if delta_delta is too large, assume time correction
86 * has occured and set old_delta to the current delta.
87 */
88 old_delta = delta;
89 } else {
90 /* Otherwise try to adjust old_system to compensate */
d4bda8f8 91 old_system = timespec64_sub(old_system, delta_delta);
3dcad5ff 92 }
7ca1d488 93
7ca1d488
DB
94 return 0;
95}
96
97static int rtc_resume(struct device *dev)
98{
99 struct rtc_device *rtc = to_rtc_device(dev);
100 struct rtc_time tm;
d4bda8f8
JS
101 struct timespec64 new_system, new_rtc;
102 struct timespec64 sleep_time;
e1d60093 103 int err;
7ca1d488 104
9ecf37eb
FT
105 if (has_persistent_clock())
106 return 0;
107
4c24e29e 108 rtc_hctosys_ret = -ENODEV;
d4afc76c 109 if (strcmp(dev_name(&rtc->dev), CONFIG_RTC_HCTOSYS_DEVICE) != 0)
7ca1d488
DB
110 return 0;
111
3dcad5ff 112 /* snapshot the current rtc and system time at resume */
d4bda8f8 113 getnstimeofday64(&new_system);
e1d60093
HG
114 err = rtc_read_time(rtc, &tm);
115 if (err < 0) {
116 pr_debug("%s: fail to read rtc time\n", dev_name(&rtc->dev));
117 return 0;
118 }
119
7ca1d488 120 if (rtc_valid_tm(&tm) != 0) {
d4afc76c 121 pr_debug("%s: bogus resume time\n", dev_name(&rtc->dev));
7ca1d488
DB
122 return 0;
123 }
d4bda8f8 124 new_rtc.tv_sec = rtc_tm_to_time64(&tm);
3dcad5ff
JS
125 new_rtc.tv_nsec = 0;
126
6a8943d9
AH
127 if (new_rtc.tv_sec < old_rtc.tv_sec) {
128 pr_debug("%s: time travel!\n", dev_name(&rtc->dev));
7ca1d488
DB
129 return 0;
130 }
131
3dcad5ff 132 /* calculate the RTC time delta (sleep time)*/
d4bda8f8 133 sleep_time = timespec64_sub(new_rtc, old_rtc);
3dcad5ff
JS
134
135 /*
136 * Since these RTC suspend/resume handlers are not called
137 * at the very end of suspend or the start of resume,
138 * some run-time may pass on either sides of the sleep time
139 * so subtract kernel run-time between rtc_suspend to rtc_resume
140 * to keep things accurate.
141 */
d4bda8f8
JS
142 sleep_time = timespec64_sub(sleep_time,
143 timespec64_sub(new_system, old_system));
7ca1d488 144
6a8943d9 145 if (sleep_time.tv_sec >= 0)
d4bda8f8 146 timekeeping_inject_sleeptime64(&sleep_time);
4c24e29e 147 rtc_hctosys_ret = 0;
7ca1d488
DB
148 return 0;
149}
150
92e7f04a
SK
151static SIMPLE_DEV_PM_OPS(rtc_class_dev_pm_ops, rtc_suspend, rtc_resume);
152#define RTC_CLASS_DEV_PM_OPS (&rtc_class_dev_pm_ops)
7ca1d488 153#else
92e7f04a 154#define RTC_CLASS_DEV_PM_OPS NULL
7ca1d488
DB
155#endif
156
157
0c86edc0
AZ
158/**
159 * rtc_device_register - register w/ RTC class
160 * @dev: the device to register
161 *
162 * rtc_device_unregister() must be called when the class device is no
163 * longer needed.
164 *
165 * Returns the pointer to the new struct class device.
166 */
167struct rtc_device *rtc_device_register(const char *name, struct device *dev,
ff8371ac 168 const struct rtc_class_ops *ops,
0c86edc0
AZ
169 struct module *owner)
170{
171 struct rtc_device *rtc;
f44f7f96 172 struct rtc_wkalrm alrm;
9d2b7e53
SW
173 int of_id = -1, id = -1, err;
174
175 if (dev->of_node)
176 of_id = of_alias_get_id(dev->of_node, "rtc");
177 else if (dev->parent && dev->parent->of_node)
178 of_id = of_alias_get_id(dev->parent->of_node, "rtc");
179
180 if (of_id >= 0) {
181 id = ida_simple_get(&rtc_ida, of_id, of_id + 1,
182 GFP_KERNEL);
183 if (id < 0)
184 dev_warn(dev, "/aliases ID %d not available\n",
185 of_id);
186 }
0c86edc0 187
6d03d06d 188 if (id < 0) {
9d2b7e53
SW
189 id = ida_simple_get(&rtc_ida, 0, 0, GFP_KERNEL);
190 if (id < 0) {
191 err = id;
192 goto exit;
193 }
0c86edc0
AZ
194 }
195
0c86edc0
AZ
196 rtc = kzalloc(sizeof(struct rtc_device), GFP_KERNEL);
197 if (rtc == NULL) {
198 err = -ENOMEM;
6d03d06d 199 goto exit_ida;
0c86edc0
AZ
200 }
201
202 rtc->id = id;
203 rtc->ops = ops;
204 rtc->owner = owner;
83a06bf5 205 rtc->irq_freq = 1;
110d693d 206 rtc->max_user_freq = 64;
cd966209
DB
207 rtc->dev.parent = dev;
208 rtc->dev.class = rtc_class;
209 rtc->dev.release = rtc_device_release;
0c86edc0
AZ
210
211 mutex_init(&rtc->ops_lock);
212 spin_lock_init(&rtc->irq_lock);
213 spin_lock_init(&rtc->irq_task_lock);
d691eb90 214 init_waitqueue_head(&rtc->irq_queue);
0c86edc0 215
6610e089
JS
216 /* Init timerqueue */
217 timerqueue_init_head(&rtc->timerqueue);
96c8f06a 218 INIT_WORK(&rtc->irqwork, rtc_timer_do_work);
6610e089 219 /* Init aie timer */
96c8f06a 220 rtc_timer_init(&rtc->aie_timer, rtc_aie_update_irq, (void *)rtc);
6610e089 221 /* Init uie timer */
96c8f06a 222 rtc_timer_init(&rtc->uie_rtctimer, rtc_uie_update_irq, (void *)rtc);
6610e089
JS
223 /* Init pie timer */
224 hrtimer_init(&rtc->pie_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
225 rtc->pie_timer.function = rtc_pie_update_irq;
226 rtc->pie_enabled = 0;
227
f44f7f96
JS
228 /* Check to see if there is an ALARM already set in hw */
229 err = __rtc_read_alarm(rtc, &alrm);
230
231 if (!err && !rtc_valid_tm(&alrm.time))
f6d5b331 232 rtc_initialize_alarm(rtc, &alrm);
f44f7f96 233
0c86edc0 234 strlcpy(rtc->name, name, RTC_DEVICE_NAME_SIZE);
d4afc76c 235 dev_set_name(&rtc->dev, "rtc%d", id);
0c86edc0 236
cb3a58d2
DB
237 rtc_dev_prepare(rtc);
238
cd966209 239 err = device_register(&rtc->dev);
59cca865
VK
240 if (err) {
241 put_device(&rtc->dev);
0c86edc0 242 goto exit_kfree;
59cca865 243 }
0c86edc0 244
5726fb20 245 rtc_dev_add_device(rtc);
446ecbd9 246 rtc_sysfs_add_device(rtc);
7d9f99ec 247 rtc_proc_add_device(rtc);
5726fb20 248
0c86edc0 249 dev_info(dev, "rtc core: registered %s as %s\n",
d4afc76c 250 rtc->name, dev_name(&rtc->dev));
0c86edc0
AZ
251
252 return rtc;
253
254exit_kfree:
255 kfree(rtc);
256
6d03d06d
JC
257exit_ida:
258 ida_simple_remove(&rtc_ida, id);
0c86edc0
AZ
259
260exit:
d1d65b77
AZ
261 dev_err(dev, "rtc core: unable to register %s, err = %d\n",
262 name, err);
0c86edc0
AZ
263 return ERR_PTR(err);
264}
265EXPORT_SYMBOL_GPL(rtc_device_register);
266
267
268/**
269 * rtc_device_unregister - removes the previously registered RTC class device
270 *
271 * @rtc: the RTC class device to destroy
272 */
273void rtc_device_unregister(struct rtc_device *rtc)
274{
cd966209 275 if (get_device(&rtc->dev) != NULL) {
e109ebd1
DB
276 mutex_lock(&rtc->ops_lock);
277 /* remove innards of this RTC, then disable it, before
278 * letting any rtc_class_open() users access it again
279 */
446ecbd9 280 rtc_sysfs_del_device(rtc);
5726fb20 281 rtc_dev_del_device(rtc);
7d9f99ec 282 rtc_proc_del_device(rtc);
cd966209 283 device_unregister(&rtc->dev);
e109ebd1
DB
284 rtc->ops = NULL;
285 mutex_unlock(&rtc->ops_lock);
cd966209 286 put_device(&rtc->dev);
e109ebd1 287 }
0c86edc0
AZ
288}
289EXPORT_SYMBOL_GPL(rtc_device_unregister);
290
3e217b66
JH
291static void devm_rtc_device_release(struct device *dev, void *res)
292{
293 struct rtc_device *rtc = *(struct rtc_device **)res;
294
295 rtc_device_unregister(rtc);
296}
297
298static int devm_rtc_device_match(struct device *dev, void *res, void *data)
299{
300 struct rtc **r = res;
301
302 return *r == data;
303}
304
305/**
306 * devm_rtc_device_register - resource managed rtc_device_register()
3e217b66 307 * @dev: the device to register
6636a994 308 * @name: the name of the device
3e217b66
JH
309 * @ops: the rtc operations structure
310 * @owner: the module owner
311 *
312 * @return a struct rtc on success, or an ERR_PTR on error
313 *
314 * Managed rtc_device_register(). The rtc_device returned from this function
315 * are automatically freed on driver detach. See rtc_device_register()
316 * for more information.
317 */
318
6636a994
JH
319struct rtc_device *devm_rtc_device_register(struct device *dev,
320 const char *name,
3e217b66
JH
321 const struct rtc_class_ops *ops,
322 struct module *owner)
323{
324 struct rtc_device **ptr, *rtc;
325
326 ptr = devres_alloc(devm_rtc_device_release, sizeof(*ptr), GFP_KERNEL);
327 if (!ptr)
328 return ERR_PTR(-ENOMEM);
329
330 rtc = rtc_device_register(name, dev, ops, owner);
331 if (!IS_ERR(rtc)) {
332 *ptr = rtc;
333 devres_add(dev, ptr);
334 } else {
335 devres_free(ptr);
336 }
337
338 return rtc;
339}
340EXPORT_SYMBOL_GPL(devm_rtc_device_register);
341
342/**
343 * devm_rtc_device_unregister - resource managed devm_rtc_device_unregister()
344 * @dev: the device to unregister
345 * @rtc: the RTC class device to unregister
346 *
347 * Deallocated a rtc allocated with devm_rtc_device_register(). Normally this
348 * function will not need to be called and the resource management code will
349 * ensure that the resource is freed.
350 */
351void devm_rtc_device_unregister(struct device *dev, struct rtc_device *rtc)
352{
353 int rc;
354
355 rc = devres_release(dev, devm_rtc_device_release,
356 devm_rtc_device_match, rtc);
357 WARN_ON(rc);
358}
359EXPORT_SYMBOL_GPL(devm_rtc_device_unregister);
360
0c86edc0
AZ
361static int __init rtc_init(void)
362{
363 rtc_class = class_create(THIS_MODULE, "rtc");
364 if (IS_ERR(rtc_class)) {
c100a5e0 365 pr_err("couldn't create class\n");
0c86edc0
AZ
366 return PTR_ERR(rtc_class);
367 }
92e7f04a 368 rtc_class->pm = RTC_CLASS_DEV_PM_OPS;
5726fb20 369 rtc_dev_init();
446ecbd9 370 rtc_sysfs_init(rtc_class);
0c86edc0
AZ
371 return 0;
372}
373
374static void __exit rtc_exit(void)
375{
5726fb20 376 rtc_dev_exit();
0c86edc0 377 class_destroy(rtc_class);
6d03d06d 378 ida_destroy(&rtc_ida);
0c86edc0
AZ
379}
380
818a8674 381subsys_initcall(rtc_init);
0c86edc0
AZ
382module_exit(rtc_exit);
383
818a8674 384MODULE_AUTHOR("Alessandro Zummo <a.zummo@towertech.it>");
0c86edc0
AZ
385MODULE_DESCRIPTION("RTC class support");
386MODULE_LICENSE("GPL");
This page took 0.787809 seconds and 5 git commands to generate.