1d316c57fSThomas Gleixner /* 2d316c57fSThomas Gleixner * linux/kernel/time/clockevents.c 3d316c57fSThomas Gleixner * 4d316c57fSThomas Gleixner * This file contains functions which manage clock event devices. 5d316c57fSThomas Gleixner * 6d316c57fSThomas Gleixner * Copyright(C) 2005-2006, Thomas Gleixner <tglx@linutronix.de> 7d316c57fSThomas Gleixner * Copyright(C) 2005-2007, Red Hat, Inc., Ingo Molnar 8d316c57fSThomas Gleixner * Copyright(C) 2006-2007, Timesys Corp., Thomas Gleixner 9d316c57fSThomas Gleixner * 10d316c57fSThomas Gleixner * This code is licenced under the GPL version 2. For details see 11d316c57fSThomas Gleixner * kernel-base/COPYING. 12d316c57fSThomas Gleixner */ 13d316c57fSThomas Gleixner 14d316c57fSThomas Gleixner #include <linux/clockchips.h> 15d316c57fSThomas Gleixner #include <linux/hrtimer.h> 16d316c57fSThomas Gleixner #include <linux/init.h> 17d316c57fSThomas Gleixner #include <linux/module.h> 18d316c57fSThomas Gleixner #include <linux/notifier.h> 19d316c57fSThomas Gleixner #include <linux/smp.h> 20d316c57fSThomas Gleixner #include <linux/sysdev.h> 21eea08f32SArun R Bharadwaj #include <linux/tick.h> 22d316c57fSThomas Gleixner 23d316c57fSThomas Gleixner /* The registered clock event devices */ 24d316c57fSThomas Gleixner static LIST_HEAD(clockevent_devices); 25d316c57fSThomas Gleixner static LIST_HEAD(clockevents_released); 26d316c57fSThomas Gleixner 27d316c57fSThomas Gleixner /* Notification for clock events */ 28d316c57fSThomas Gleixner static RAW_NOTIFIER_HEAD(clockevents_chain); 29d316c57fSThomas Gleixner 30d316c57fSThomas Gleixner /* Protection for the above */ 31d316c57fSThomas Gleixner static DEFINE_SPINLOCK(clockevents_lock); 32d316c57fSThomas Gleixner 33d316c57fSThomas Gleixner /** 34d316c57fSThomas Gleixner * clockevents_delta2ns - Convert a latch value (device ticks) to nanoseconds 35d316c57fSThomas Gleixner * @latch: value to convert 36d316c57fSThomas Gleixner * @evt: pointer to clock event device descriptor 37d316c57fSThomas Gleixner * 38d316c57fSThomas Gleixner * Math helper, returns latch value converted to nanoseconds (bound checked) 39d316c57fSThomas Gleixner */ 40d316c57fSThomas Gleixner unsigned long clockevent_delta2ns(unsigned long latch, 41d316c57fSThomas Gleixner struct clock_event_device *evt) 42d316c57fSThomas Gleixner { 43d316c57fSThomas Gleixner u64 clc = ((u64) latch << evt->shift); 44d316c57fSThomas Gleixner 4545fe4fe1SIngo Molnar if (unlikely(!evt->mult)) { 4645fe4fe1SIngo Molnar evt->mult = 1; 4745fe4fe1SIngo Molnar WARN_ON(1); 4845fe4fe1SIngo Molnar } 4945fe4fe1SIngo Molnar 50d316c57fSThomas Gleixner do_div(clc, evt->mult); 51d316c57fSThomas Gleixner if (clc < 1000) 52d316c57fSThomas Gleixner clc = 1000; 53d316c57fSThomas Gleixner if (clc > LONG_MAX) 54d316c57fSThomas Gleixner clc = LONG_MAX; 55d316c57fSThomas Gleixner 56d316c57fSThomas Gleixner return (unsigned long) clc; 57d316c57fSThomas Gleixner } 58d316c57fSThomas Gleixner 59d316c57fSThomas Gleixner /** 60d316c57fSThomas Gleixner * clockevents_set_mode - set the operating mode of a clock event device 61d316c57fSThomas Gleixner * @dev: device to modify 62d316c57fSThomas Gleixner * @mode: new mode 63d316c57fSThomas Gleixner * 64d316c57fSThomas Gleixner * Must be called with interrupts disabled ! 65d316c57fSThomas Gleixner */ 66d316c57fSThomas Gleixner void clockevents_set_mode(struct clock_event_device *dev, 67d316c57fSThomas Gleixner enum clock_event_mode mode) 68d316c57fSThomas Gleixner { 69d316c57fSThomas Gleixner if (dev->mode != mode) { 70d316c57fSThomas Gleixner dev->set_mode(mode, dev); 71d316c57fSThomas Gleixner dev->mode = mode; 722d68259dSMagnus Damm 732d68259dSMagnus Damm /* 742d68259dSMagnus Damm * A nsec2cyc multiplicator of 0 is invalid and we'd crash 752d68259dSMagnus Damm * on it, so fix it up and emit a warning: 762d68259dSMagnus Damm */ 772d68259dSMagnus Damm if (mode == CLOCK_EVT_MODE_ONESHOT) { 782d68259dSMagnus Damm if (unlikely(!dev->mult)) { 792d68259dSMagnus Damm dev->mult = 1; 802d68259dSMagnus Damm WARN_ON(1); 812d68259dSMagnus Damm } 822d68259dSMagnus Damm } 83d316c57fSThomas Gleixner } 84d316c57fSThomas Gleixner } 85d316c57fSThomas Gleixner 86d316c57fSThomas Gleixner /** 872344abbcSThomas Gleixner * clockevents_shutdown - shutdown the device and clear next_event 882344abbcSThomas Gleixner * @dev: device to shutdown 892344abbcSThomas Gleixner */ 902344abbcSThomas Gleixner void clockevents_shutdown(struct clock_event_device *dev) 912344abbcSThomas Gleixner { 922344abbcSThomas Gleixner clockevents_set_mode(dev, CLOCK_EVT_MODE_SHUTDOWN); 932344abbcSThomas Gleixner dev->next_event.tv64 = KTIME_MAX; 942344abbcSThomas Gleixner } 952344abbcSThomas Gleixner 962344abbcSThomas Gleixner /** 97d316c57fSThomas Gleixner * clockevents_program_event - Reprogram the clock event device. 98d316c57fSThomas Gleixner * @expires: absolute expiry time (monotonic clock) 99d316c57fSThomas Gleixner * 100d316c57fSThomas Gleixner * Returns 0 on success, -ETIME when the event is in the past. 101d316c57fSThomas Gleixner */ 102d316c57fSThomas Gleixner int clockevents_program_event(struct clock_event_device *dev, ktime_t expires, 103d316c57fSThomas Gleixner ktime_t now) 104d316c57fSThomas Gleixner { 105d316c57fSThomas Gleixner unsigned long long clc; 106d316c57fSThomas Gleixner int64_t delta; 107d316c57fSThomas Gleixner 108167b1de3SThomas Gleixner if (unlikely(expires.tv64 < 0)) { 109167b1de3SThomas Gleixner WARN_ON_ONCE(1); 110167b1de3SThomas Gleixner return -ETIME; 111167b1de3SThomas Gleixner } 112167b1de3SThomas Gleixner 113d316c57fSThomas Gleixner delta = ktime_to_ns(ktime_sub(expires, now)); 114d316c57fSThomas Gleixner 115d316c57fSThomas Gleixner if (delta <= 0) 116d316c57fSThomas Gleixner return -ETIME; 117d316c57fSThomas Gleixner 118d316c57fSThomas Gleixner dev->next_event = expires; 119d316c57fSThomas Gleixner 120d316c57fSThomas Gleixner if (dev->mode == CLOCK_EVT_MODE_SHUTDOWN) 121d316c57fSThomas Gleixner return 0; 122d316c57fSThomas Gleixner 123d316c57fSThomas Gleixner if (delta > dev->max_delta_ns) 124d316c57fSThomas Gleixner delta = dev->max_delta_ns; 125d316c57fSThomas Gleixner if (delta < dev->min_delta_ns) 126d316c57fSThomas Gleixner delta = dev->min_delta_ns; 127d316c57fSThomas Gleixner 128d316c57fSThomas Gleixner clc = delta * dev->mult; 129d316c57fSThomas Gleixner clc >>= dev->shift; 130d316c57fSThomas Gleixner 131d316c57fSThomas Gleixner return dev->set_next_event((unsigned long) clc, dev); 132d316c57fSThomas Gleixner } 133d316c57fSThomas Gleixner 134d316c57fSThomas Gleixner /** 135d316c57fSThomas Gleixner * clockevents_register_notifier - register a clock events change listener 136d316c57fSThomas Gleixner */ 137d316c57fSThomas Gleixner int clockevents_register_notifier(struct notifier_block *nb) 138d316c57fSThomas Gleixner { 139d316c57fSThomas Gleixner int ret; 140d316c57fSThomas Gleixner 141d316c57fSThomas Gleixner spin_lock(&clockevents_lock); 142d316c57fSThomas Gleixner ret = raw_notifier_chain_register(&clockevents_chain, nb); 143d316c57fSThomas Gleixner spin_unlock(&clockevents_lock); 144d316c57fSThomas Gleixner 145d316c57fSThomas Gleixner return ret; 146d316c57fSThomas Gleixner } 147d316c57fSThomas Gleixner 148d316c57fSThomas Gleixner /* 149d316c57fSThomas Gleixner * Notify about a clock event change. Called with clockevents_lock 150d316c57fSThomas Gleixner * held. 151d316c57fSThomas Gleixner */ 152d316c57fSThomas Gleixner static void clockevents_do_notify(unsigned long reason, void *dev) 153d316c57fSThomas Gleixner { 154d316c57fSThomas Gleixner raw_notifier_call_chain(&clockevents_chain, reason, dev); 155d316c57fSThomas Gleixner } 156d316c57fSThomas Gleixner 157d316c57fSThomas Gleixner /* 1583eb05676SLi Zefan * Called after a notify add to make devices available which were 159d316c57fSThomas Gleixner * released from the notifier call. 160d316c57fSThomas Gleixner */ 161d316c57fSThomas Gleixner static void clockevents_notify_released(void) 162d316c57fSThomas Gleixner { 163d316c57fSThomas Gleixner struct clock_event_device *dev; 164d316c57fSThomas Gleixner 165d316c57fSThomas Gleixner while (!list_empty(&clockevents_released)) { 166d316c57fSThomas Gleixner dev = list_entry(clockevents_released.next, 167d316c57fSThomas Gleixner struct clock_event_device, list); 168d316c57fSThomas Gleixner list_del(&dev->list); 169d316c57fSThomas Gleixner list_add(&dev->list, &clockevent_devices); 170d316c57fSThomas Gleixner clockevents_do_notify(CLOCK_EVT_NOTIFY_ADD, dev); 171d316c57fSThomas Gleixner } 172d316c57fSThomas Gleixner } 173d316c57fSThomas Gleixner 174d316c57fSThomas Gleixner /** 175d316c57fSThomas Gleixner * clockevents_register_device - register a clock event device 176d316c57fSThomas Gleixner * @dev: device to register 177d316c57fSThomas Gleixner */ 178d316c57fSThomas Gleixner void clockevents_register_device(struct clock_event_device *dev) 179d316c57fSThomas Gleixner { 180d316c57fSThomas Gleixner BUG_ON(dev->mode != CLOCK_EVT_MODE_UNUSED); 181320ab2b0SRusty Russell BUG_ON(!dev->cpumask); 182320ab2b0SRusty Russell 183d316c57fSThomas Gleixner spin_lock(&clockevents_lock); 184d316c57fSThomas Gleixner 185d316c57fSThomas Gleixner list_add(&dev->list, &clockevent_devices); 186d316c57fSThomas Gleixner clockevents_do_notify(CLOCK_EVT_NOTIFY_ADD, dev); 187d316c57fSThomas Gleixner clockevents_notify_released(); 188d316c57fSThomas Gleixner 189d316c57fSThomas Gleixner spin_unlock(&clockevents_lock); 190d316c57fSThomas Gleixner } 191d316c57fSThomas Gleixner 192d316c57fSThomas Gleixner /* 193d316c57fSThomas Gleixner * Noop handler when we shut down an event device 194d316c57fSThomas Gleixner */ 1957c1e7689SVenkatesh Pallipadi void clockevents_handle_noop(struct clock_event_device *dev) 196d316c57fSThomas Gleixner { 197d316c57fSThomas Gleixner } 198d316c57fSThomas Gleixner 199d316c57fSThomas Gleixner /** 200d316c57fSThomas Gleixner * clockevents_exchange_device - release and request clock devices 201d316c57fSThomas Gleixner * @old: device to release (can be NULL) 202d316c57fSThomas Gleixner * @new: device to request (can be NULL) 203d316c57fSThomas Gleixner * 204d316c57fSThomas Gleixner * Called from the notifier chain. clockevents_lock is held already 205d316c57fSThomas Gleixner */ 206d316c57fSThomas Gleixner void clockevents_exchange_device(struct clock_event_device *old, 207d316c57fSThomas Gleixner struct clock_event_device *new) 208d316c57fSThomas Gleixner { 209d316c57fSThomas Gleixner unsigned long flags; 210d316c57fSThomas Gleixner 211d316c57fSThomas Gleixner local_irq_save(flags); 212d316c57fSThomas Gleixner /* 213d316c57fSThomas Gleixner * Caller releases a clock event device. We queue it into the 214d316c57fSThomas Gleixner * released list and do a notify add later. 215d316c57fSThomas Gleixner */ 216d316c57fSThomas Gleixner if (old) { 217d316c57fSThomas Gleixner clockevents_set_mode(old, CLOCK_EVT_MODE_UNUSED); 218d316c57fSThomas Gleixner list_del(&old->list); 219d316c57fSThomas Gleixner list_add(&old->list, &clockevents_released); 220d316c57fSThomas Gleixner } 221d316c57fSThomas Gleixner 222d316c57fSThomas Gleixner if (new) { 223d316c57fSThomas Gleixner BUG_ON(new->mode != CLOCK_EVT_MODE_UNUSED); 2242344abbcSThomas Gleixner clockevents_shutdown(new); 225d316c57fSThomas Gleixner } 226d316c57fSThomas Gleixner local_irq_restore(flags); 227d316c57fSThomas Gleixner } 228d316c57fSThomas Gleixner 229de68d9b1SThomas Gleixner #ifdef CONFIG_GENERIC_CLOCKEVENTS 230d316c57fSThomas Gleixner /** 231d316c57fSThomas Gleixner * clockevents_notify - notification about relevant events 232d316c57fSThomas Gleixner */ 233d316c57fSThomas Gleixner void clockevents_notify(unsigned long reason, void *arg) 234d316c57fSThomas Gleixner { 2350b858e6fSLi Zefan struct list_head *node, *tmp; 2360b858e6fSLi Zefan 237d316c57fSThomas Gleixner spin_lock(&clockevents_lock); 238d316c57fSThomas Gleixner clockevents_do_notify(reason, arg); 239d316c57fSThomas Gleixner 240d316c57fSThomas Gleixner switch (reason) { 241d316c57fSThomas Gleixner case CLOCK_EVT_NOTIFY_CPU_DEAD: 242d316c57fSThomas Gleixner /* 243d316c57fSThomas Gleixner * Unregister the clock event devices which were 244d316c57fSThomas Gleixner * released from the users in the notify chain. 245d316c57fSThomas Gleixner */ 2460b858e6fSLi Zefan list_for_each_safe(node, tmp, &clockevents_released) 2470b858e6fSLi Zefan list_del(node); 248d316c57fSThomas Gleixner break; 249d316c57fSThomas Gleixner default: 250d316c57fSThomas Gleixner break; 251d316c57fSThomas Gleixner } 252d316c57fSThomas Gleixner spin_unlock(&clockevents_lock); 253d316c57fSThomas Gleixner } 254d316c57fSThomas Gleixner EXPORT_SYMBOL_GPL(clockevents_notify); 255eea08f32SArun R Bharadwaj 256eea08f32SArun R Bharadwaj ktime_t clockevents_get_next_event(int cpu) 257eea08f32SArun R Bharadwaj { 258eea08f32SArun R Bharadwaj struct tick_device *td; 259eea08f32SArun R Bharadwaj struct clock_event_device *dev; 260eea08f32SArun R Bharadwaj 261eea08f32SArun R Bharadwaj td = &per_cpu(tick_cpu_device, cpu); 262eea08f32SArun R Bharadwaj dev = td->evtdev; 263eea08f32SArun R Bharadwaj 264eea08f32SArun R Bharadwaj return dev->next_event; 265eea08f32SArun R Bharadwaj } 266de68d9b1SThomas Gleixner #endif 267