drivers/rtc/class.c

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