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> 21d316c57fSThomas Gleixner 22d316c57fSThomas Gleixner /* The registered clock event devices */ 23d316c57fSThomas Gleixner static LIST_HEAD(clockevent_devices); 24d316c57fSThomas Gleixner static LIST_HEAD(clockevents_released); 25d316c57fSThomas Gleixner 26d316c57fSThomas Gleixner /* Notification for clock events */ 27d316c57fSThomas Gleixner static RAW_NOTIFIER_HEAD(clockevents_chain); 28d316c57fSThomas Gleixner 29d316c57fSThomas Gleixner /* Protection for the above */ 30d316c57fSThomas Gleixner static DEFINE_SPINLOCK(clockevents_lock); 31d316c57fSThomas Gleixner 32d316c57fSThomas Gleixner /** 33d316c57fSThomas Gleixner * clockevents_delta2ns - Convert a latch value (device ticks) to nanoseconds 34d316c57fSThomas Gleixner * @latch: value to convert 35d316c57fSThomas Gleixner * @evt: pointer to clock event device descriptor 36d316c57fSThomas Gleixner * 37d316c57fSThomas Gleixner * Math helper, returns latch value converted to nanoseconds (bound checked) 38d316c57fSThomas Gleixner */ 39d316c57fSThomas Gleixner unsigned long clockevent_delta2ns(unsigned long latch, 40d316c57fSThomas Gleixner struct clock_event_device *evt) 41d316c57fSThomas Gleixner { 42d316c57fSThomas Gleixner u64 clc = ((u64) latch << evt->shift); 43d316c57fSThomas Gleixner 4445fe4fe1SIngo Molnar if (unlikely(!evt->mult)) { 4545fe4fe1SIngo Molnar evt->mult = 1; 4645fe4fe1SIngo Molnar WARN_ON(1); 4745fe4fe1SIngo Molnar } 4845fe4fe1SIngo Molnar 49d316c57fSThomas Gleixner do_div(clc, evt->mult); 50d316c57fSThomas Gleixner if (clc < 1000) 51d316c57fSThomas Gleixner clc = 1000; 52d316c57fSThomas Gleixner if (clc > LONG_MAX) 53d316c57fSThomas Gleixner clc = LONG_MAX; 54d316c57fSThomas Gleixner 55d316c57fSThomas Gleixner return (unsigned long) clc; 56d316c57fSThomas Gleixner } 57d316c57fSThomas Gleixner 58d316c57fSThomas Gleixner /** 59d316c57fSThomas Gleixner * clockevents_set_mode - set the operating mode of a clock event device 60d316c57fSThomas Gleixner * @dev: device to modify 61d316c57fSThomas Gleixner * @mode: new mode 62d316c57fSThomas Gleixner * 63d316c57fSThomas Gleixner * Must be called with interrupts disabled ! 64d316c57fSThomas Gleixner */ 65d316c57fSThomas Gleixner void clockevents_set_mode(struct clock_event_device *dev, 66d316c57fSThomas Gleixner enum clock_event_mode mode) 67d316c57fSThomas Gleixner { 68d316c57fSThomas Gleixner if (dev->mode != mode) { 69d316c57fSThomas Gleixner dev->set_mode(mode, dev); 70d316c57fSThomas Gleixner dev->mode = mode; 71d316c57fSThomas Gleixner } 72d316c57fSThomas Gleixner } 73d316c57fSThomas Gleixner 74d316c57fSThomas Gleixner /** 752344abbcSThomas Gleixner * clockevents_shutdown - shutdown the device and clear next_event 762344abbcSThomas Gleixner * @dev: device to shutdown 772344abbcSThomas Gleixner */ 782344abbcSThomas Gleixner void clockevents_shutdown(struct clock_event_device *dev) 792344abbcSThomas Gleixner { 802344abbcSThomas Gleixner clockevents_set_mode(dev, CLOCK_EVT_MODE_SHUTDOWN); 812344abbcSThomas Gleixner dev->next_event.tv64 = KTIME_MAX; 822344abbcSThomas Gleixner } 832344abbcSThomas Gleixner 842344abbcSThomas Gleixner /** 85d316c57fSThomas Gleixner * clockevents_program_event - Reprogram the clock event device. 86d316c57fSThomas Gleixner * @expires: absolute expiry time (monotonic clock) 87d316c57fSThomas Gleixner * 88d316c57fSThomas Gleixner * Returns 0 on success, -ETIME when the event is in the past. 89d316c57fSThomas Gleixner */ 90d316c57fSThomas Gleixner int clockevents_program_event(struct clock_event_device *dev, ktime_t expires, 91d316c57fSThomas Gleixner ktime_t now) 92d316c57fSThomas Gleixner { 93d316c57fSThomas Gleixner unsigned long long clc; 94d316c57fSThomas Gleixner int64_t delta; 95d316c57fSThomas Gleixner 96167b1de3SThomas Gleixner if (unlikely(expires.tv64 < 0)) { 97167b1de3SThomas Gleixner WARN_ON_ONCE(1); 98167b1de3SThomas Gleixner return -ETIME; 99167b1de3SThomas Gleixner } 100167b1de3SThomas Gleixner 101d316c57fSThomas Gleixner delta = ktime_to_ns(ktime_sub(expires, now)); 102d316c57fSThomas Gleixner 103d316c57fSThomas Gleixner if (delta <= 0) 104d316c57fSThomas Gleixner return -ETIME; 105d316c57fSThomas Gleixner 106d316c57fSThomas Gleixner dev->next_event = expires; 107d316c57fSThomas Gleixner 108d316c57fSThomas Gleixner if (dev->mode == CLOCK_EVT_MODE_SHUTDOWN) 109d316c57fSThomas Gleixner return 0; 110d316c57fSThomas Gleixner 111d316c57fSThomas Gleixner if (delta > dev->max_delta_ns) 112d316c57fSThomas Gleixner delta = dev->max_delta_ns; 113d316c57fSThomas Gleixner if (delta < dev->min_delta_ns) 114d316c57fSThomas Gleixner delta = dev->min_delta_ns; 115d316c57fSThomas Gleixner 116d316c57fSThomas Gleixner clc = delta * dev->mult; 117d316c57fSThomas Gleixner clc >>= dev->shift; 118d316c57fSThomas Gleixner 119d316c57fSThomas Gleixner return dev->set_next_event((unsigned long) clc, dev); 120d316c57fSThomas Gleixner } 121d316c57fSThomas Gleixner 122d316c57fSThomas Gleixner /** 123d316c57fSThomas Gleixner * clockevents_register_notifier - register a clock events change listener 124d316c57fSThomas Gleixner */ 125d316c57fSThomas Gleixner int clockevents_register_notifier(struct notifier_block *nb) 126d316c57fSThomas Gleixner { 127d316c57fSThomas Gleixner int ret; 128d316c57fSThomas Gleixner 129d316c57fSThomas Gleixner spin_lock(&clockevents_lock); 130d316c57fSThomas Gleixner ret = raw_notifier_chain_register(&clockevents_chain, nb); 131d316c57fSThomas Gleixner spin_unlock(&clockevents_lock); 132d316c57fSThomas Gleixner 133d316c57fSThomas Gleixner return ret; 134d316c57fSThomas Gleixner } 135d316c57fSThomas Gleixner 136d316c57fSThomas Gleixner /* 137d316c57fSThomas Gleixner * Notify about a clock event change. Called with clockevents_lock 138d316c57fSThomas Gleixner * held. 139d316c57fSThomas Gleixner */ 140d316c57fSThomas Gleixner static void clockevents_do_notify(unsigned long reason, void *dev) 141d316c57fSThomas Gleixner { 142d316c57fSThomas Gleixner raw_notifier_call_chain(&clockevents_chain, reason, dev); 143d316c57fSThomas Gleixner } 144d316c57fSThomas Gleixner 145d316c57fSThomas Gleixner /* 1463eb05676SLi Zefan * Called after a notify add to make devices available which were 147d316c57fSThomas Gleixner * released from the notifier call. 148d316c57fSThomas Gleixner */ 149d316c57fSThomas Gleixner static void clockevents_notify_released(void) 150d316c57fSThomas Gleixner { 151d316c57fSThomas Gleixner struct clock_event_device *dev; 152d316c57fSThomas Gleixner 153d316c57fSThomas Gleixner while (!list_empty(&clockevents_released)) { 154d316c57fSThomas Gleixner dev = list_entry(clockevents_released.next, 155d316c57fSThomas Gleixner struct clock_event_device, list); 156d316c57fSThomas Gleixner list_del(&dev->list); 157d316c57fSThomas Gleixner list_add(&dev->list, &clockevent_devices); 158d316c57fSThomas Gleixner clockevents_do_notify(CLOCK_EVT_NOTIFY_ADD, dev); 159d316c57fSThomas Gleixner } 160d316c57fSThomas Gleixner } 161d316c57fSThomas Gleixner 162d316c57fSThomas Gleixner /** 163d316c57fSThomas Gleixner * clockevents_register_device - register a clock event device 164d316c57fSThomas Gleixner * @dev: device to register 165d316c57fSThomas Gleixner */ 166d316c57fSThomas Gleixner void clockevents_register_device(struct clock_event_device *dev) 167d316c57fSThomas Gleixner { 168d316c57fSThomas Gleixner BUG_ON(dev->mode != CLOCK_EVT_MODE_UNUSED); 169320ab2b0SRusty Russell BUG_ON(!dev->cpumask); 170320ab2b0SRusty Russell 17145fe4fe1SIngo Molnar /* 17245fe4fe1SIngo Molnar * A nsec2cyc multiplicator of 0 is invalid and we'd crash 17345fe4fe1SIngo Molnar * on it, so fix it up and emit a warning: 17445fe4fe1SIngo Molnar */ 17545fe4fe1SIngo Molnar if (unlikely(!dev->mult)) { 17645fe4fe1SIngo Molnar dev->mult = 1; 17745fe4fe1SIngo Molnar WARN_ON(1); 17845fe4fe1SIngo Molnar } 179d316c57fSThomas Gleixner 180d316c57fSThomas Gleixner spin_lock(&clockevents_lock); 181d316c57fSThomas Gleixner 182d316c57fSThomas Gleixner list_add(&dev->list, &clockevent_devices); 183d316c57fSThomas Gleixner clockevents_do_notify(CLOCK_EVT_NOTIFY_ADD, dev); 184d316c57fSThomas Gleixner clockevents_notify_released(); 185d316c57fSThomas Gleixner 186d316c57fSThomas Gleixner spin_unlock(&clockevents_lock); 187d316c57fSThomas Gleixner } 188d316c57fSThomas Gleixner 189d316c57fSThomas Gleixner /* 190d316c57fSThomas Gleixner * Noop handler when we shut down an event device 191d316c57fSThomas Gleixner */ 1927c1e7689SVenkatesh Pallipadi void clockevents_handle_noop(struct clock_event_device *dev) 193d316c57fSThomas Gleixner { 194d316c57fSThomas Gleixner } 195d316c57fSThomas Gleixner 196d316c57fSThomas Gleixner /** 197d316c57fSThomas Gleixner * clockevents_exchange_device - release and request clock devices 198d316c57fSThomas Gleixner * @old: device to release (can be NULL) 199d316c57fSThomas Gleixner * @new: device to request (can be NULL) 200d316c57fSThomas Gleixner * 201d316c57fSThomas Gleixner * Called from the notifier chain. clockevents_lock is held already 202d316c57fSThomas Gleixner */ 203d316c57fSThomas Gleixner void clockevents_exchange_device(struct clock_event_device *old, 204d316c57fSThomas Gleixner struct clock_event_device *new) 205d316c57fSThomas Gleixner { 206d316c57fSThomas Gleixner unsigned long flags; 207d316c57fSThomas Gleixner 208d316c57fSThomas Gleixner local_irq_save(flags); 209d316c57fSThomas Gleixner /* 210d316c57fSThomas Gleixner * Caller releases a clock event device. We queue it into the 211d316c57fSThomas Gleixner * released list and do a notify add later. 212d316c57fSThomas Gleixner */ 213d316c57fSThomas Gleixner if (old) { 214d316c57fSThomas Gleixner clockevents_set_mode(old, CLOCK_EVT_MODE_UNUSED); 215d316c57fSThomas Gleixner list_del(&old->list); 216d316c57fSThomas Gleixner list_add(&old->list, &clockevents_released); 217d316c57fSThomas Gleixner } 218d316c57fSThomas Gleixner 219d316c57fSThomas Gleixner if (new) { 220d316c57fSThomas Gleixner BUG_ON(new->mode != CLOCK_EVT_MODE_UNUSED); 2212344abbcSThomas Gleixner clockevents_shutdown(new); 222d316c57fSThomas Gleixner } 223d316c57fSThomas Gleixner local_irq_restore(flags); 224d316c57fSThomas Gleixner } 225d316c57fSThomas Gleixner 226de68d9b1SThomas Gleixner #ifdef CONFIG_GENERIC_CLOCKEVENTS 227d316c57fSThomas Gleixner /** 228d316c57fSThomas Gleixner * clockevents_notify - notification about relevant events 229d316c57fSThomas Gleixner */ 230d316c57fSThomas Gleixner void clockevents_notify(unsigned long reason, void *arg) 231d316c57fSThomas Gleixner { 2320b858e6fSLi Zefan struct list_head *node, *tmp; 2330b858e6fSLi Zefan 234d316c57fSThomas Gleixner spin_lock(&clockevents_lock); 235d316c57fSThomas Gleixner clockevents_do_notify(reason, arg); 236d316c57fSThomas Gleixner 237d316c57fSThomas Gleixner switch (reason) { 238d316c57fSThomas Gleixner case CLOCK_EVT_NOTIFY_CPU_DEAD: 239d316c57fSThomas Gleixner /* 240d316c57fSThomas Gleixner * Unregister the clock event devices which were 241d316c57fSThomas Gleixner * released from the users in the notify chain. 242d316c57fSThomas Gleixner */ 2430b858e6fSLi Zefan list_for_each_safe(node, tmp, &clockevents_released) 2440b858e6fSLi Zefan list_del(node); 245d316c57fSThomas Gleixner break; 246d316c57fSThomas Gleixner default: 247d316c57fSThomas Gleixner break; 248d316c57fSThomas Gleixner } 249d316c57fSThomas Gleixner spin_unlock(&clockevents_lock); 250d316c57fSThomas Gleixner } 251d316c57fSThomas Gleixner EXPORT_SYMBOL_GPL(clockevents_notify); 252de68d9b1SThomas Gleixner #endif 253