clocksource.c 12.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
/*
 * linux/kernel/time/clocksource.c
 *
 * This file contains the functions which manage clocksource drivers.
 *
 * Copyright (C) 2004, 2005 IBM, John Stultz (johnstul@us.ibm.com)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * TODO WishList:
 *   o Allow clocksource drivers to be unregistered
 *   o get rid of clocksource_jiffies extern
 */

#include <linux/clocksource.h>
#include <linux/sysdev.h>
#include <linux/init.h>
#include <linux/module.h>
31
#include <linux/sched.h> /* for spin_unlock_irq() using preempt_count() m68k */
32
#include <linux/tick.h>
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

/* XXX - Would like a better way for initializing curr_clocksource */
extern struct clocksource clocksource_jiffies;

/*[Clocksource internal variables]---------
 * curr_clocksource:
 *	currently selected clocksource. Initialized to clocksource_jiffies.
 * next_clocksource:
 *	pending next selected clocksource.
 * clocksource_list:
 *	linked list with the registered clocksources
 * clocksource_lock:
 *	protects manipulations to curr_clocksource and next_clocksource
 *	and the clocksource_list
 * override_name:
 *	Name of the user-specified clocksource.
 */
static struct clocksource *curr_clocksource = &clocksource_jiffies;
static struct clocksource *next_clocksource;
52
static struct clocksource *clocksource_override;
53 54 55 56 57
static LIST_HEAD(clocksource_list);
static DEFINE_SPINLOCK(clocksource_lock);
static char override_name[32];
static int finished_booting;

58
/* clocksource_done_booting - Called near the end of core bootup
59
 *
60 61 62
 * Hack to avoid lots of clocksource churn at boot time.
 * We use fs_initcall because we want this to start before
 * device_initcall but after subsys_initcall.
63
 */
64
static int __init clocksource_done_booting(void)
65 66 67 68
{
	finished_booting = 1;
	return 0;
}
69
fs_initcall(clocksource_done_booting);
70

71 72 73 74 75 76
#ifdef CONFIG_CLOCKSOURCE_WATCHDOG
static LIST_HEAD(watchdog_list);
static struct clocksource *watchdog;
static struct timer_list watchdog_timer;
static DEFINE_SPINLOCK(watchdog_lock);
static cycle_t watchdog_last;
77
static unsigned long watchdog_resumed;
T
Thomas Gleixner 已提交
78

79
/*
80
 * Interval: 0.5sec Threshold: 0.0625s
81 82
 */
#define WATCHDOG_INTERVAL (HZ >> 1)
83
#define WATCHDOG_THRESHOLD (NSEC_PER_SEC >> 4)
84 85 86

static void clocksource_ratewd(struct clocksource *cs, int64_t delta)
{
87
	if (delta > -WATCHDOG_THRESHOLD && delta < WATCHDOG_THRESHOLD)
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
		return;

	printk(KERN_WARNING "Clocksource %s unstable (delta = %Ld ns)\n",
	       cs->name, delta);
	cs->flags &= ~(CLOCK_SOURCE_VALID_FOR_HRES | CLOCK_SOURCE_WATCHDOG);
	clocksource_change_rating(cs, 0);
	cs->flags &= ~CLOCK_SOURCE_WATCHDOG;
	list_del(&cs->wd_list);
}

static void clocksource_watchdog(unsigned long data)
{
	struct clocksource *cs, *tmp;
	cycle_t csnow, wdnow;
	int64_t wd_nsec, cs_nsec;
T
Thomas Gleixner 已提交
103
	int resumed;
104 105 106

	spin_lock(&watchdog_lock);

107
	resumed = test_and_clear_bit(0, &watchdog_resumed);
T
Thomas Gleixner 已提交
108

109 110 111 112 113 114
	wdnow = watchdog->read();
	wd_nsec = cyc2ns(watchdog, (wdnow - watchdog_last) & watchdog->mask);
	watchdog_last = wdnow;

	list_for_each_entry_safe(cs, tmp, &watchdog_list, wd_list) {
		csnow = cs->read();
T
Thomas Gleixner 已提交
115 116 117 118 119 120

		if (unlikely(resumed)) {
			cs->wd_last = csnow;
			continue;
		}

121 122 123 124 125
		/* Initialized ? */
		if (!(cs->flags & CLOCK_SOURCE_WATCHDOG)) {
			if ((cs->flags & CLOCK_SOURCE_IS_CONTINUOUS) &&
			    (watchdog->flags & CLOCK_SOURCE_IS_CONTINUOUS)) {
				cs->flags |= CLOCK_SOURCE_VALID_FOR_HRES;
126 127 128 129 130 131 132
				/*
				 * We just marked the clocksource as
				 * highres-capable, notify the rest of the
				 * system as well so that we transition
				 * into high-res mode:
				 */
				tick_clock_notify();
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
			}
			cs->flags |= CLOCK_SOURCE_WATCHDOG;
			cs->wd_last = csnow;
		} else {
			cs_nsec = cyc2ns(cs, (csnow - cs->wd_last) & cs->mask);
			cs->wd_last = csnow;
			/* Check the delta. Might remove from the list ! */
			clocksource_ratewd(cs, cs_nsec - wd_nsec);
		}
	}

	if (!list_empty(&watchdog_list)) {
		__mod_timer(&watchdog_timer,
			    watchdog_timer.expires + WATCHDOG_INTERVAL);
	}
	spin_unlock(&watchdog_lock);
}
T
Thomas Gleixner 已提交
150 151
static void clocksource_resume_watchdog(void)
{
152
	set_bit(0, &watchdog_resumed);
T
Thomas Gleixner 已提交
153 154
}

155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
static void clocksource_check_watchdog(struct clocksource *cs)
{
	struct clocksource *cse;
	unsigned long flags;

	spin_lock_irqsave(&watchdog_lock, flags);
	if (cs->flags & CLOCK_SOURCE_MUST_VERIFY) {
		int started = !list_empty(&watchdog_list);

		list_add(&cs->wd_list, &watchdog_list);
		if (!started && watchdog) {
			watchdog_last = watchdog->read();
			watchdog_timer.expires = jiffies + WATCHDOG_INTERVAL;
			add_timer(&watchdog_timer);
		}
170 171
	} else {
		if (cs->flags & CLOCK_SOURCE_IS_CONTINUOUS)
172 173 174 175 176 177
			cs->flags |= CLOCK_SOURCE_VALID_FOR_HRES;

		if (!watchdog || cs->rating > watchdog->rating) {
			if (watchdog)
				del_timer(&watchdog_timer);
			watchdog = cs;
178
			init_timer_deferrable(&watchdog_timer);
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
			watchdog_timer.function = clocksource_watchdog;

			/* Reset watchdog cycles */
			list_for_each_entry(cse, &watchdog_list, wd_list)
				cse->flags &= ~CLOCK_SOURCE_WATCHDOG;
			/* Start if list is not empty */
			if (!list_empty(&watchdog_list)) {
				watchdog_last = watchdog->read();
				watchdog_timer.expires =
					jiffies + WATCHDOG_INTERVAL;
				add_timer(&watchdog_timer);
			}
		}
	}
	spin_unlock_irqrestore(&watchdog_lock, flags);
}
#else
static void clocksource_check_watchdog(struct clocksource *cs)
{
	if (cs->flags & CLOCK_SOURCE_IS_CONTINUOUS)
		cs->flags |= CLOCK_SOURCE_VALID_FOR_HRES;
}
T
Thomas Gleixner 已提交
201 202

static inline void clocksource_resume_watchdog(void) { }
203 204
#endif

T
Thomas Gleixner 已提交
205 206 207 208 209
/**
 * clocksource_resume - resume the clocksource(s)
 */
void clocksource_resume(void)
{
210
	struct clocksource *cs;
T
Thomas Gleixner 已提交
211 212 213 214
	unsigned long flags;

	spin_lock_irqsave(&clocksource_lock, flags);

215
	list_for_each_entry(cs, &clocksource_list, list) {
T
Thomas Gleixner 已提交
216 217 218 219 220 221 222 223 224
		if (cs->resume)
			cs->resume();
	}

	clocksource_resume_watchdog();

	spin_unlock_irqrestore(&clocksource_lock, flags);
}

225
/**
226
 * clocksource_get_next - Returns the selected clocksource
227 228
 *
 */
229
struct clocksource *clocksource_get_next(void)
230 231 232 233 234 235 236 237 238 239 240 241 242 243
{
	unsigned long flags;

	spin_lock_irqsave(&clocksource_lock, flags);
	if (next_clocksource && finished_booting) {
		curr_clocksource = next_clocksource;
		next_clocksource = NULL;
	}
	spin_unlock_irqrestore(&clocksource_lock, flags);

	return curr_clocksource;
}

/**
244
 * select_clocksource - Selects the best registered clocksource.
245 246 247
 *
 * Private function. Must hold clocksource_lock when called.
 *
248 249
 * Select the clocksource with the best rating, or the clocksource,
 * which is selected by userspace override.
250 251 252
 */
static struct clocksource *select_clocksource(void)
{
253 254
	struct clocksource *next;

255 256
	if (list_empty(&clocksource_list))
		return NULL;
257

258
	if (clocksource_override)
259 260 261 262
		next = clocksource_override;
	else
		next = list_entry(clocksource_list.next, struct clocksource,
				  list);
263

264 265 266 267
	if (next == curr_clocksource)
		return NULL;

	return next;
268 269
}

270 271
/*
 * Enqueue the clocksource sorted by rating
272
 */
273
static int clocksource_enqueue(struct clocksource *c)
274
{
275
	struct list_head *tmp, *entry = &clocksource_list;
276 277

	list_for_each(tmp, &clocksource_list) {
278 279 280 281 282 283 284 285
		struct clocksource *cs;

		cs = list_entry(tmp, struct clocksource, list);
		if (cs == c)
			return -EBUSY;
		/* Keep track of the place, where to insert */
		if (cs->rating >= c->rating)
			entry = tmp;
286
	}
287 288 289 290 291
	list_add(&c->list, entry);

	if (strlen(c->name) == strlen(override_name) &&
	    !strcmp(c->name, override_name))
		clocksource_override = c;
292 293 294 295 296

	return 0;
}

/**
297
 * clocksource_register - Used to install new clocksources
298 299 300 301
 * @t:		clocksource to be registered
 *
 * Returns -EBUSY if registration fails, zero otherwise.
 */
302
int clocksource_register(struct clocksource *c)
303 304
{
	unsigned long flags;
305
	int ret;
306 307

	spin_lock_irqsave(&clocksource_lock, flags);
308 309
	ret = clocksource_enqueue(c);
	if (!ret)
310 311
		next_clocksource = select_clocksource();
	spin_unlock_irqrestore(&clocksource_lock, flags);
312 313
	if (!ret)
		clocksource_check_watchdog(c);
314 315
	return ret;
}
316
EXPORT_SYMBOL(clocksource_register);
317 318

/**
319
 * clocksource_change_rating - Change the rating of a registered clocksource
320 321
 *
 */
322
void clocksource_change_rating(struct clocksource *cs, int rating)
323 324 325 326
{
	unsigned long flags;

	spin_lock_irqsave(&clocksource_lock, flags);
327
	list_del(&cs->list);
328
	cs->rating = rating;
329
	clocksource_enqueue(cs);
330 331 332 333
	next_clocksource = select_clocksource();
	spin_unlock_irqrestore(&clocksource_lock, flags);
}

334
#ifdef CONFIG_SYSFS
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
/**
 * sysfs_show_current_clocksources - sysfs interface for current clocksource
 * @dev:	unused
 * @buf:	char buffer to be filled with clocksource list
 *
 * Provides sysfs interface for listing current clocksource.
 */
static ssize_t
sysfs_show_current_clocksources(struct sys_device *dev, char *buf)
{
	char *curr = buf;

	spin_lock_irq(&clocksource_lock);
	curr += sprintf(curr, "%s ", curr_clocksource->name);
	spin_unlock_irq(&clocksource_lock);

	curr += sprintf(curr, "\n");

	return curr - buf;
}

/**
 * sysfs_override_clocksource - interface for manually overriding clocksource
 * @dev:	unused
 * @buf:	name of override clocksource
 * @count:	length of buffer
 *
 * Takes input from sysfs interface for manually overriding the default
 * clocksource selction.
 */
static ssize_t sysfs_override_clocksource(struct sys_device *dev,
					  const char *buf, size_t count)
{
368
	struct clocksource *ovr = NULL;
369
	size_t ret = count;
370 371
	int len;

372 373 374 375 376 377 378 379 380 381
	/* strings from sysfs write are not 0 terminated! */
	if (count >= sizeof(override_name))
		return -EINVAL;

	/* strip of \n: */
	if (buf[count-1] == '\n')
		count--;

	spin_lock_irq(&clocksource_lock);

382 383
	if (count > 0)
		memcpy(override_name, buf, count);
384 385
	override_name[count] = 0;

386 387
	len = strlen(override_name);
	if (len) {
388 389
		struct clocksource *cs;

390 391
		ovr = clocksource_override;
		/* try to select it: */
392
		list_for_each_entry(cs, &clocksource_list, list) {
393 394 395 396 397 398 399 400 401 402 403
			if (strlen(cs->name) == len &&
			    !strcmp(cs->name, override_name))
				ovr = cs;
		}
	}

	/* Reselect, when the override name has changed */
	if (ovr != clocksource_override) {
		clocksource_override = ovr;
		next_clocksource = select_clocksource();
	}
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419

	spin_unlock_irq(&clocksource_lock);

	return ret;
}

/**
 * sysfs_show_available_clocksources - sysfs interface for listing clocksource
 * @dev:	unused
 * @buf:	char buffer to be filled with clocksource list
 *
 * Provides sysfs interface for listing registered clocksources
 */
static ssize_t
sysfs_show_available_clocksources(struct sys_device *dev, char *buf)
{
420
	struct clocksource *src;
421 422 423
	char *curr = buf;

	spin_lock_irq(&clocksource_lock);
424
	list_for_each_entry(src, &clocksource_list, list) {
425 426 427 428 429 430 431 432 433 434 435 436 437
		curr += sprintf(curr, "%s ", src->name);
	}
	spin_unlock_irq(&clocksource_lock);

	curr += sprintf(curr, "\n");

	return curr - buf;
}

/*
 * Sysfs setup bits:
 */
static SYSDEV_ATTR(current_clocksource, 0600, sysfs_show_current_clocksources,
D
Daniel Walker 已提交
438
		   sysfs_override_clocksource);
439 440

static SYSDEV_ATTR(available_clocksource, 0600,
D
Daniel Walker 已提交
441
		   sysfs_show_available_clocksources, NULL);
442 443

static struct sysdev_class clocksource_sysclass = {
444
	.name = "clocksource",
445 446 447 448 449 450 451
};

static struct sys_device device_clocksource = {
	.id	= 0,
	.cls	= &clocksource_sysclass,
};

452
static int __init init_clocksource_sysfs(void)
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
{
	int error = sysdev_class_register(&clocksource_sysclass);

	if (!error)
		error = sysdev_register(&device_clocksource);
	if (!error)
		error = sysdev_create_file(
				&device_clocksource,
				&attr_current_clocksource);
	if (!error)
		error = sysdev_create_file(
				&device_clocksource,
				&attr_available_clocksource);
	return error;
}

device_initcall(init_clocksource_sysfs);
470
#endif /* CONFIG_SYSFS */
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499

/**
 * boot_override_clocksource - boot clock override
 * @str:	override name
 *
 * Takes a clocksource= boot argument and uses it
 * as the clocksource override name.
 */
static int __init boot_override_clocksource(char* str)
{
	unsigned long flags;
	spin_lock_irqsave(&clocksource_lock, flags);
	if (str)
		strlcpy(override_name, str, sizeof(override_name));
	spin_unlock_irqrestore(&clocksource_lock, flags);
	return 1;
}

__setup("clocksource=", boot_override_clocksource);

/**
 * boot_override_clock - Compatibility layer for deprecated boot option
 * @str:	override name
 *
 * DEPRECATED! Takes a clock= boot argument and uses it
 * as the clocksource override name
 */
static int __init boot_override_clock(char* str)
{
500 501 502 503 504 505 506
	if (!strcmp(str, "pmtmr")) {
		printk("Warning: clock=pmtmr is deprecated. "
			"Use clocksource=acpi_pm.\n");
		return boot_override_clocksource("acpi_pm");
	}
	printk("Warning! clock= boot option is deprecated. "
		"Use clocksource=xyz\n");
507 508 509 510
	return boot_override_clocksource(str);
}

__setup("clock=", boot_override_clock);