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_IDR(rtc_idr);
  25 static DEFINE_MUTEX(idr_lock);
  26 struct class *rtc_class;
  27
  28 static void rtc_device_release(struct device *dev)
  29 {
  30         struct rtc_device *rtc = to_rtc_device(dev);
  31         mutex_lock(&idr_lock);
  32         idr_remove(&rtc_idr, rtc->id);
  33         mutex_unlock(&idr_lock);
  34         kfree(rtc);
  35 }
  36
  37 #if defined(CONFIG_PM) && defined(CONFIG_RTC_HCTOSYS_DEVICE)
  38
  39 /*
  40  * On suspend(), measure the delta between one RTC and the
  41  * system's wall clock; restore it on resume().
  42  */
  43
  44 static struct timespec  delta;
  45 static time_t           oldtime;
  46
  47 static int rtc_suspend(struct device *dev, pm_message_t mesg)
  48 {
  49         struct rtc_device       *rtc = to_rtc_device(dev);
  50         struct rtc_time         tm;
  51         struct timespec         ts = current_kernel_time();
  52
  53         if (strcmp(dev_name(&rtc->dev), CONFIG_RTC_HCTOSYS_DEVICE) != 0)
  54                 return 0;
  55
  56         rtc_read_time(rtc, &tm);
  57         rtc_tm_to_time(&tm, &oldtime);
  58
  59         /* RTC precision is 1 second; adjust delta for avg 1/2 sec err */
  60         set_normalized_timespec(&delta,
  61                                 ts.tv_sec - oldtime,
  62                                 ts.tv_nsec - (NSEC_PER_SEC >> 1));
  63
  64         return 0;
  65 }
  66
  67 static int rtc_resume(struct device *dev)
  68 {
  69         struct rtc_device       *rtc = to_rtc_device(dev);
  70         struct rtc_time         tm;
  71         time_t                  newtime;
  72         struct timespec         time;
  73
  74         if (strcmp(dev_name(&rtc->dev), CONFIG_RTC_HCTOSYS_DEVICE) != 0)
  75                 return 0;
  76
  77         rtc_read_time(rtc, &tm);
  78         if (rtc_valid_tm(&tm) != 0) {
  79                 pr_debug("%s:  bogus resume time\n", dev_name(&rtc->dev));
  80                 return 0;
  81         }
  82         rtc_tm_to_time(&tm, &newtime);
  83         if (newtime <= oldtime) {
  84                 if (newtime < oldtime)
  85                         pr_debug("%s:  time travel!\n", dev_name(&rtc->dev));
  86                 return 0;
  87         }
  88
  89         /* restore wall clock using delta against this RTC;
  90          * adjust again for avg 1/2 second RTC sampling error
  91          */
  92         set_normalized_timespec(&time,
  93                                 newtime + delta.tv_sec,
  94                                 (NSEC_PER_SEC >> 1) + delta.tv_nsec);
  95         do_settimeofday(&time);
  96
  97         return 0;
  98 }
  99
 100 #else
 101 #define rtc_suspend     NULL
 102 #define rtc_resume      NULL
 103 #endif
 104
 105
 106 /**
 107  * rtc_device_register - register w/ RTC class
 108  * @dev: the device to register
 109  *
 110  * rtc_device_unregister() must be called when the class device is no
 111  * longer needed.
 112  *
 113  * Returns the pointer to the new struct class device.
 114  */
 115 struct rtc_device *rtc_device_register(const char *name, struct device *dev,
 116                                         const struct rtc_class_ops *ops,
 117                                         struct module *owner)
 118 {
 119         struct rtc_device *rtc;
 120         struct rtc_wkalrm alrm;
 121         int id, err;
 122
 123         if (idr_pre_get(&rtc_idr, GFP_KERNEL) == 0) {
 124                 err = -ENOMEM;
 125                 goto exit;
 126         }
 127
 128
 129         mutex_lock(&idr_lock);
 130         err = idr_get_new(&rtc_idr, NULL, &id);
 131         mutex_unlock(&idr_lock);
 132
 133         if (err < 0)
 134                 goto exit;
 135
 136         id = id & MAX_ID_MASK;
 137
 138         rtc = kzalloc(sizeof(struct rtc_device), GFP_KERNEL);
 139         if (rtc == NULL) {
 140                 err = -ENOMEM;
 141                 goto exit_idr;
 142         }
 143
 144         rtc->id = id;
 145         rtc->ops = ops;
 146         rtc->owner = owner;
 147         rtc->irq_freq = 1;
 148         rtc->max_user_freq = 64;
 149         rtc->dev.parent = dev;
 150         rtc->dev.class = rtc_class;
 151         rtc->dev.release = rtc_device_release;
 152
 153         mutex_init(&rtc->ops_lock);
 154         spin_lock_init(&rtc->irq_lock);
 155         spin_lock_init(&rtc->irq_task_lock);
 156         init_waitqueue_head(&rtc->irq_queue);
 157
 158         /* Init timerqueue */
 159         timerqueue_init_head(&rtc->timerqueue);
 160         INIT_WORK(&rtc->irqwork, rtc_timer_do_work);
 161         /* Init aie timer */
 162         rtc_timer_init(&rtc->aie_timer, rtc_aie_update_irq, (void *)rtc);
 163         /* Init uie timer */
 164         rtc_timer_init(&rtc->uie_rtctimer, rtc_uie_update_irq, (void *)rtc);
 165         /* Init pie timer */
 166         hrtimer_init(&rtc->pie_timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
 167         rtc->pie_timer.function = rtc_pie_update_irq;
 168         rtc->pie_enabled = 0;
 169
 170         /* Check to see if there is an ALARM already set in hw */
 171         err = __rtc_read_alarm(rtc, &alrm);
 172
 173         if (!err && !rtc_valid_tm(&alrm.time))
 174                 rtc_initialize_alarm(rtc, &alrm);
 175
 176         strlcpy(rtc->name, name, RTC_DEVICE_NAME_SIZE);
 177         dev_set_name(&rtc->dev, "rtc%d", id);
 178
 179         rtc_dev_prepare(rtc);
 180
 181         err = device_register(&rtc->dev);
 182         if (err) {
 183                 put_device(&rtc->dev);
 184                 goto exit_kfree;
 185         }
 186
 187         rtc_dev_add_device(rtc);
 188         rtc_sysfs_add_device(rtc);
 189         rtc_proc_add_device(rtc);
 190
 191         dev_info(dev, "rtc core: registered %s as %s\n",
 192                         rtc->name, dev_name(&rtc->dev));
 193
 194         return rtc;
 195
 196 exit_kfree:
 197         kfree(rtc);
 198
 199 exit_idr:
 200         mutex_lock(&idr_lock);
 201         idr_remove(&rtc_idr, id);
 202         mutex_unlock(&idr_lock);
 203
 204 exit:
 205         dev_err(dev, "rtc core: unable to register %s, err = %d\n",
 206                         name, err);
 207         return ERR_PTR(err);
 208 }
 209 EXPORT_SYMBOL_GPL(rtc_device_register);
 210
 211
 212 /**
 213  * rtc_device_unregister - removes the previously registered RTC class device
 214  *
 215  * @rtc: the RTC class device to destroy
 216  */
 217 void rtc_device_unregister(struct rtc_device *rtc)
 218 {
 219         if (get_device(&rtc->dev) != NULL) {
 220                 mutex_lock(&rtc->ops_lock);
 221                 /* remove innards of this RTC, then disable it, before
 222                  * letting any rtc_class_open() users access it again
 223                  */
 224                 rtc_sysfs_del_device(rtc);
 225                 rtc_dev_del_device(rtc);
 226                 rtc_proc_del_device(rtc);
 227                 device_unregister(&rtc->dev);
 228                 rtc->ops = NULL;
 229                 mutex_unlock(&rtc->ops_lock);
 230                 put_device(&rtc->dev);
 231         }
 232 }
 233 EXPORT_SYMBOL_GPL(rtc_device_unregister);
 234
 235 static int __init rtc_init(void)
 236 {
 237         rtc_class = class_create(THIS_MODULE, "rtc");
 238         if (IS_ERR(rtc_class)) {
 239                 printk(KERN_ERR "%s: couldn't create class\n", __FILE__);
 240                 return PTR_ERR(rtc_class);
 241         }
 242         rtc_class->suspend = rtc_suspend;
 243         rtc_class->resume = rtc_resume;
 244         rtc_dev_init();
 245         rtc_sysfs_init(rtc_class);
 246         return 0;
 247 }
 248
 249 static void __exit rtc_exit(void)
 250 {
 251         rtc_dev_exit();
 252         class_destroy(rtc_class);
 253         idr_destroy(&rtc_idr);
 254 }
 255
 256 subsys_initcall(rtc_init);
 257 module_exit(rtc_exit);
 258
 259 MODULE_AUTHOR("Alessandro Zummo <a.zummo@towertech.it>");
 260 MODULE_DESCRIPTION("RTC class support");
 261 MODULE_LICENSE("GPL");