kernel/time/clocksource.c

   1 /*
   2  * linux/kernel/time/clocksource.c
   3  *
   4  * This file contains the functions which manage clocksource drivers.
   5  *
   6  * Copyright (C) 2004, 2005 IBM, John Stultz (johnstul@us.ibm.com)
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  *
  22  * TODO WishList:
  23  *   o Allow clocksource drivers to be unregistered
  24  */
  25
  26 #include <linux/device.h>
  27 #include <linux/clocksource.h>
  28 #include <linux/init.h>
  29 #include <linux/module.h>
  30 #include <linux/sched.h> /* for spin_unlock_irq() using preempt_count() m68k */
  31 #include <linux/tick.h>
  32 #include <linux/kthread.h>
  33
  34 #include "tick-internal.h"
  35
  36 void timecounter_init(struct timecounter *tc,
  37                       const struct cyclecounter *cc,
  38                       u64 start_tstamp)
  39 {
  40         tc->cc = cc;
  41         tc->cycle_last = cc->read(cc);
  42         tc->nsec = start_tstamp;
  43 }
  44 EXPORT_SYMBOL_GPL(timecounter_init);
  45
  46 /**
  47  * timecounter_read_delta - get nanoseconds since last call of this function
  48  * @tc:         Pointer to time counter
  49  *
  50  * When the underlying cycle counter runs over, this will be handled
  51  * correctly as long as it does not run over more than once between
  52  * calls.
  53  *
  54  * The first call to this function for a new time counter initializes
  55  * the time tracking and returns an undefined result.
  56  */
  57 static u64 timecounter_read_delta(struct timecounter *tc)
  58 {
  59         cycle_t cycle_now, cycle_delta;
  60         u64 ns_offset;
  61
  62         /* read cycle counter: */
  63         cycle_now = tc->cc->read(tc->cc);
  64
  65         /* calculate the delta since the last timecounter_read_delta(): */
  66         cycle_delta = (cycle_now - tc->cycle_last) & tc->cc->mask;
  67
  68         /* convert to nanoseconds: */
  69         ns_offset = cyclecounter_cyc2ns(tc->cc, cycle_delta);
  70
  71         /* update time stamp of timecounter_read_delta() call: */
  72         tc->cycle_last = cycle_now;
  73
  74         return ns_offset;
  75 }
  76
  77 u64 timecounter_read(struct timecounter *tc)
  78 {
  79         u64 nsec;
  80
  81         /* increment time by nanoseconds since last call */
  82         nsec = timecounter_read_delta(tc);
  83         nsec += tc->nsec;
  84         tc->nsec = nsec;
  85
  86         return nsec;
  87 }
  88 EXPORT_SYMBOL_GPL(timecounter_read);
  89
  90 u64 timecounter_cyc2time(struct timecounter *tc,
  91                          cycle_t cycle_tstamp)
  92 {
  93         u64 cycle_delta = (cycle_tstamp - tc->cycle_last) & tc->cc->mask;
  94         u64 nsec;
  95
  96         /*
  97          * Instead of always treating cycle_tstamp as more recent
  98          * than tc->cycle_last, detect when it is too far in the
  99          * future and treat it as old time stamp instead.
 100          */
 101         if (cycle_delta > tc->cc->mask / 2) {
 102                 cycle_delta = (tc->cycle_last - cycle_tstamp) & tc->cc->mask;
 103                 nsec = tc->nsec - cyclecounter_cyc2ns(tc->cc, cycle_delta);
 104         } else {
 105                 nsec = cyclecounter_cyc2ns(tc->cc, cycle_delta) + tc->nsec;
 106         }
 107
 108         return nsec;
 109 }
 110 EXPORT_SYMBOL_GPL(timecounter_cyc2time);
 111
 112 /**
 113  * clocks_calc_mult_shift - calculate mult/shift factors for scaled math of clocks
 114  * @mult:       pointer to mult variable
 115  * @shift:      pointer to shift variable
 116  * @from:       frequency to convert from
 117  * @to:         frequency to convert to
 118  * @maxsec:     guaranteed runtime conversion range in seconds
 119  *
 120  * The function evaluates the shift/mult pair for the scaled math
 121  * operations of clocksources and clockevents.
 122  *
 123  * @to and @from are frequency values in HZ. For clock sources @to is
 124  * NSEC_PER_SEC == 1GHz and @from is the counter frequency. For clock
 125  * event @to is the counter frequency and @from is NSEC_PER_SEC.
 126  *
 127  * The @maxsec conversion range argument controls the time frame in
 128  * seconds which must be covered by the runtime conversion with the
 129  * calculated mult and shift factors. This guarantees that no 64bit
 130  * overflow happens when the input value of the conversion is
 131  * multiplied with the calculated mult factor. Larger ranges may
 132  * reduce the conversion accuracy by chosing smaller mult and shift
 133  * factors.
 134  */
 135 void
 136 clocks_calc_mult_shift(u32 *mult, u32 *shift, u32 from, u32 to, u32 maxsec)
 137 {
 138         u64 tmp;
 139         u32 sft, sftacc= 32;
 140
 141         /*
 142          * Calculate the shift factor which is limiting the conversion
 143          * range:
 144          */
 145         tmp = ((u64)maxsec * from) >> 32;
 146         while (tmp) {
 147                 tmp >>=1;
 148                 sftacc--;
 149         }
 150
 151         /*
 152          * Find the conversion shift/mult pair which has the best
 153          * accuracy and fits the maxsec conversion range:
 154          */
 155         for (sft = 32; sft > 0; sft--) {
 156                 tmp = (u64) to << sft;
 157                 tmp += from / 2;
 158                 do_div(tmp, from);
 159                 if ((tmp >> sftacc) == 0)
 160                         break;
 161         }
 162         *mult = tmp;
 163         *shift = sft;
 164 }
 165
 166 /*[Clocksource internal variables]---------
 167  * curr_clocksource:
 168  *      currently selected clocksource.
 169  * clocksource_list:
 170  *      linked list with the registered clocksources
 171  * clocksource_mutex:
 172  *      protects manipulations to curr_clocksource and the clocksource_list
 173  * override_name:
 174  *      Name of the user-specified clocksource.
 175  */
 176 static struct clocksource *curr_clocksource;
 177 static LIST_HEAD(clocksource_list);
 178 static DEFINE_MUTEX(clocksource_mutex);
 179 static char override_name[CS_NAME_LEN];
 180 static int finished_booting;
 181
 182 #ifdef CONFIG_CLOCKSOURCE_WATCHDOG
 183 static void clocksource_watchdog_work(struct work_struct *work);
 184
 185 static LIST_HEAD(watchdog_list);
 186 static struct clocksource *watchdog;
 187 static struct timer_list watchdog_timer;
 188 static DECLARE_WORK(watchdog_work, clocksource_watchdog_work);
 189 static DEFINE_SPINLOCK(watchdog_lock);
 190 static int watchdog_running;
 191 static atomic_t watchdog_reset_pending;
 192
 193 static int clocksource_watchdog_kthread(void *data);
 194 static void __clocksource_change_rating(struct clocksource *cs, int rating);
 195
 196 /*
 197  * Interval: 0.5sec Threshold: 0.0625s
 198  */
 199 #define WATCHDOG_INTERVAL (HZ >> 1)
 200 #define WATCHDOG_THRESHOLD (NSEC_PER_SEC >> 4)
 201
 202 static void clocksource_watchdog_work(struct work_struct *work)
 203 {
 204         /*
 205          * If kthread_run fails the next watchdog scan over the
 206          * watchdog_list will find the unstable clock again.
 207          */
 208         kthread_run(clocksource_watchdog_kthread, NULL, "kwatchdog");
 209 }
 210
 211 static void __clocksource_unstable(struct clocksource *cs)
 212 {
 213         cs->flags &= ~(CLOCK_SOURCE_VALID_FOR_HRES | CLOCK_SOURCE_WATCHDOG);
 214         cs->flags |= CLOCK_SOURCE_UNSTABLE;
 215         if (finished_booting)
 216                 schedule_work(&watchdog_work);
 217 }
 218
 219 static void clocksource_unstable(struct clocksource *cs, int64_t delta)
 220 {
 221         printk(KERN_WARNING "Clocksource %s unstable (delta = %Ld ns)\n",
 222                cs->name, delta);
 223         __clocksource_unstable(cs);
 224 }
 225
 226 /**
 227  * clocksource_mark_unstable - mark clocksource unstable via watchdog
 228  * @cs:         clocksource to be marked unstable
 229  *
 230  * This function is called instead of clocksource_change_rating from
 231  * cpu hotplug code to avoid a deadlock between the clocksource mutex
 232  * and the cpu hotplug mutex. It defers the update of the clocksource
 233  * to the watchdog thread.
 234  */
 235 void clocksource_mark_unstable(struct clocksource *cs)
 236 {
 237         unsigned long flags;
 238
 239         spin_lock_irqsave(&watchdog_lock, flags);
 240         if (!(cs->flags & CLOCK_SOURCE_UNSTABLE)) {
 241                 if (list_empty(&cs->wd_list))
 242                         list_add(&cs->wd_list, &watchdog_list);
 243                 __clocksource_unstable(cs);
 244         }
 245         spin_unlock_irqrestore(&watchdog_lock, flags);
 246 }
 247
 248 static void clocksource_watchdog(unsigned long data)
 249 {
 250         struct clocksource *cs;
 251         cycle_t csnow, wdnow;
 252         int64_t wd_nsec, cs_nsec;
 253         int next_cpu, reset_pending;
 254
 255         spin_lock(&watchdog_lock);
 256         if (!watchdog_running)
 257                 goto out;
 258
 259         reset_pending = atomic_read(&watchdog_reset_pending);
 260
 261         list_for_each_entry(cs, &watchdog_list, wd_list) {
 262
 263                 /* Clocksource already marked unstable? */
 264                 if (cs->flags & CLOCK_SOURCE_UNSTABLE) {
 265                         if (finished_booting)
 266                                 schedule_work(&watchdog_work);
 267                         continue;
 268                 }
 269
 270                 local_irq_disable();
 271                 csnow = cs->read(cs);
 272                 wdnow = watchdog->read(watchdog);
 273                 local_irq_enable();
 274
 275                 /* Clocksource initialized ? */
 276                 if (!(cs->flags & CLOCK_SOURCE_WATCHDOG) ||
 277                     atomic_read(&watchdog_reset_pending)) {
 278                         cs->flags |= CLOCK_SOURCE_WATCHDOG;
 279                         cs->wd_last = wdnow;
 280                         cs->cs_last = csnow;
 281                         continue;
 282                 }
 283
 284                 wd_nsec = clocksource_cyc2ns((wdnow - cs->wd_last) & watchdog->mask,
 285                                              watchdog->mult, watchdog->shift);
 286
 287                 cs_nsec = clocksource_cyc2ns((csnow - cs->cs_last) &
 288                                              cs->mask, cs->mult, cs->shift);
 289                 cs->cs_last = csnow;
 290                 cs->wd_last = wdnow;
 291
 292                 if (atomic_read(&watchdog_reset_pending))
 293                         continue;
 294
 295                 /* Check the deviation from the watchdog clocksource. */
 296                 if ((abs(cs_nsec - wd_nsec) > WATCHDOG_THRESHOLD)) {
 297                         clocksource_unstable(cs, cs_nsec - wd_nsec);
 298                         continue;
 299                 }
 300
 301                 if (!(cs->flags & CLOCK_SOURCE_VALID_FOR_HRES) &&
 302                     (cs->flags & CLOCK_SOURCE_IS_CONTINUOUS) &&
 303                     (watchdog->flags & CLOCK_SOURCE_IS_CONTINUOUS)) {
 304                         cs->flags |= CLOCK_SOURCE_VALID_FOR_HRES;
 305                         /*
 306                          * We just marked the clocksource as highres-capable,
 307                          * notify the rest of the system as well so that we
 308                          * transition into high-res mode:
 309                          */
 310                         tick_clock_notify();
 311                 }
 312         }
 313
 314         /*
 315          * We only clear the watchdog_reset_pending, when we did a
 316          * full cycle through all clocksources.
 317          */
 318         if (reset_pending)
 319                 atomic_dec(&watchdog_reset_pending);
 320
 321         /*
 322          * Cycle through CPUs to check if the CPUs stay synchronized
 323          * to each other.
 324          */
 325         next_cpu = cpumask_next(raw_smp_processor_id(), cpu_online_mask);
 326         if (next_cpu >= nr_cpu_ids)
 327                 next_cpu = cpumask_first(cpu_online_mask);
 328         watchdog_timer.expires += WATCHDOG_INTERVAL;
 329         add_timer_on(&watchdog_timer, next_cpu);
 330 out:
 331         spin_unlock(&watchdog_lock);
 332 }
 333
 334 static inline void clocksource_start_watchdog(void)
 335 {
 336         if (watchdog_running || !watchdog || list_empty(&watchdog_list))
 337                 return;
 338         init_timer(&watchdog_timer);
 339         watchdog_timer.function = clocksource_watchdog;
 340         watchdog_timer.expires = jiffies + WATCHDOG_INTERVAL;
 341         add_timer_on(&watchdog_timer, cpumask_first(cpu_online_mask));
 342         watchdog_running = 1;
 343 }
 344
 345 static inline void clocksource_stop_watchdog(void)
 346 {
 347         if (!watchdog_running || (watchdog && !list_empty(&watchdog_list)))
 348                 return;
 349         del_timer(&watchdog_timer);
 350         watchdog_running = 0;
 351 }
 352
 353 static inline void clocksource_reset_watchdog(void)
 354 {
 355         struct clocksource *cs;
 356
 357         list_for_each_entry(cs, &watchdog_list, wd_list)
 358                 cs->flags &= ~CLOCK_SOURCE_WATCHDOG;
 359 }
 360
 361 static void clocksource_resume_watchdog(void)
 362 {
 363         atomic_inc(&watchdog_reset_pending);
 364 }
 365
 366 static void clocksource_enqueue_watchdog(struct clocksource *cs)
 367 {
 368         unsigned long flags;
 369
 370         spin_lock_irqsave(&watchdog_lock, flags);
 371         if (cs->flags & CLOCK_SOURCE_MUST_VERIFY) {
 372                 /* cs is a clocksource to be watched. */
 373                 list_add(&cs->wd_list, &watchdog_list);
 374                 cs->flags &= ~CLOCK_SOURCE_WATCHDOG;
 375         } else {
 376                 /* cs is a watchdog. */
 377                 if (cs->flags & CLOCK_SOURCE_IS_CONTINUOUS)
 378                         cs->flags |= CLOCK_SOURCE_VALID_FOR_HRES;
 379                 /* Pick the best watchdog. */
 380                 if (!watchdog || cs->rating > watchdog->rating) {
 381                         watchdog = cs;
 382                         /* Reset watchdog cycles */
 383                         clocksource_reset_watchdog();
 384                 }
 385         }
 386         /* Check if the watchdog timer needs to be started. */
 387         clocksource_start_watchdog();
 388         spin_unlock_irqrestore(&watchdog_lock, flags);
 389 }
 390
 391 static void clocksource_dequeue_watchdog(struct clocksource *cs)
 392 {
 393         unsigned long flags;
 394
 395         spin_lock_irqsave(&watchdog_lock, flags);
 396         if (cs != watchdog) {
 397                 if (cs->flags & CLOCK_SOURCE_MUST_VERIFY) {
 398                         /* cs is a watched clocksource. */
 399                         list_del_init(&cs->wd_list);
 400                         /* Check if the watchdog timer needs to be stopped. */
 401                         clocksource_stop_watchdog();
 402                 }
 403         }
 404         spin_unlock_irqrestore(&watchdog_lock, flags);
 405 }
 406
 407 static int clocksource_watchdog_kthread(void *data)
 408 {
 409         struct clocksource *cs, *tmp;
 410         unsigned long flags;
 411         LIST_HEAD(unstable);
 412
 413         mutex_lock(&clocksource_mutex);
 414         spin_lock_irqsave(&watchdog_lock, flags);
 415         list_for_each_entry_safe(cs, tmp, &watchdog_list, wd_list)
 416                 if (cs->flags & CLOCK_SOURCE_UNSTABLE) {
 417                         list_del_init(&cs->wd_list);
 418                         list_add(&cs->wd_list, &unstable);
 419                 }
 420         /* Check if the watchdog timer needs to be stopped. */
 421         clocksource_stop_watchdog();
 422         spin_unlock_irqrestore(&watchdog_lock, flags);
 423
 424         /* Needs to be done outside of watchdog lock */
 425         list_for_each_entry_safe(cs, tmp, &unstable, wd_list) {
 426                 list_del_init(&cs->wd_list);
 427                 __clocksource_change_rating(cs, 0);
 428         }
 429         mutex_unlock(&clocksource_mutex);
 430         return 0;
 431 }
 432
 433 static bool clocksource_is_watchdog(struct clocksource *cs)
 434 {
 435         return cs == watchdog;
 436 }
 437
 438 #else /* CONFIG_CLOCKSOURCE_WATCHDOG */
 439
 440 static void clocksource_enqueue_watchdog(struct clocksource *cs)
 441 {
 442         if (cs->flags & CLOCK_SOURCE_IS_CONTINUOUS)
 443                 cs->flags |= CLOCK_SOURCE_VALID_FOR_HRES;
 444 }
 445
 446 static inline void clocksource_dequeue_watchdog(struct clocksource *cs) { }
 447 static inline void clocksource_resume_watchdog(void) { }
 448 static inline int clocksource_watchdog_kthread(void *data) { return 0; }
 449 static bool clocksource_is_watchdog(struct clocksource *cs) { return false; }
 450
 451 #endif /* CONFIG_CLOCKSOURCE_WATCHDOG */
 452
 453 /**
 454  * clocksource_suspend - suspend the clocksource(s)
 455  */
 456 void clocksource_suspend(void)
 457 {
 458         struct clocksource *cs;
 459
 460         list_for_each_entry_reverse(cs, &clocksource_list, list)
 461                 if (cs->suspend)
 462                         cs->suspend(cs);
 463 }
 464
 465 /**
 466  * clocksource_resume - resume the clocksource(s)
 467  */
 468 void clocksource_resume(void)
 469 {
 470         struct clocksource *cs;
 471
 472         list_for_each_entry(cs, &clocksource_list, list)
 473                 if (cs->resume)
 474                         cs->resume(cs);
 475
 476         clocksource_resume_watchdog();
 477 }
 478
 479 /**
 480  * clocksource_touch_watchdog - Update watchdog
 481  *
 482  * Update the watchdog after exception contexts such as kgdb so as not
 483  * to incorrectly trip the watchdog. This might fail when the kernel
 484  * was stopped in code which holds watchdog_lock.
 485  */
 486 void clocksource_touch_watchdog(void)
 487 {
 488         clocksource_resume_watchdog();
 489 }
 490
 491 /**
 492  * clocksource_max_adjustment- Returns max adjustment amount
 493  * @cs:         Pointer to clocksource
 494  *
 495  */
 496 static u32 clocksource_max_adjustment(struct clocksource *cs)
 497 {
 498         u64 ret;
 499         /*
 500          * We won't try to correct for more than 11% adjustments (110,000 ppm),
 501          */
 502         ret = (u64)cs->mult * 11;
 503         do_div(ret,100);
 504         return (u32)ret;
 505 }
 506
 507 /**
 508  * clocksource_max_deferment - Returns max time the clocksource can be deferred
 509  * @cs:         Pointer to clocksource
 510  *
 511  */
 512 static u64 clocksource_max_deferment(struct clocksource *cs)
 513 {
 514         u64 max_nsecs, max_cycles;
 515
 516         /*
 517          * Calculate the maximum number of cycles that we can pass to the
 518          * cyc2ns function without overflowing a 64-bit signed result. The
 519          * maximum number of cycles is equal to ULLONG_MAX/(cs->mult+cs->maxadj)
 520          * which is equivalent to the below.
 521          * max_cycles < (2^63)/(cs->mult + cs->maxadj)
 522          * max_cycles < 2^(log2((2^63)/(cs->mult + cs->maxadj)))
 523          * max_cycles < 2^(log2(2^63) - log2(cs->mult + cs->maxadj))
 524          * max_cycles < 2^(63 - log2(cs->mult + cs->maxadj))
 525          * max_cycles < 1 << (63 - log2(cs->mult + cs->maxadj))
 526          * Please note that we add 1 to the result of the log2 to account for
 527          * any rounding errors, ensure the above inequality is satisfied and
 528          * no overflow will occur.
 529          */
 530         max_cycles = 1ULL << (63 - (ilog2(cs->mult + cs->maxadj) + 1));
 531
 532         /*
 533          * The actual maximum number of cycles we can defer the clocksource is
 534          * determined by the minimum of max_cycles and cs->mask.
 535          * Note: Here we subtract the maxadj to make sure we don't sleep for
 536          * too long if there's a large negative adjustment.
 537          */
 538         max_cycles = min_t(u64, max_cycles, (u64) cs->mask);
 539         max_nsecs = clocksource_cyc2ns(max_cycles, cs->mult - cs->maxadj,
 540                                         cs->shift);
 541
 542         /*
 543          * To ensure that the clocksource does not wrap whilst we are idle,
 544          * limit the time the clocksource can be deferred by 12.5%. Please
 545          * note a margin of 12.5% is used because this can be computed with
 546          * a shift, versus say 10% which would require division.
 547          */
 548         return max_nsecs - (max_nsecs >> 3);
 549 }
 550
 551 #ifndef CONFIG_ARCH_USES_GETTIMEOFFSET
 552
 553 static struct clocksource *clocksource_find_best(bool oneshot, bool skipcur)
 554 {
 555         struct clocksource *cs;
 556
 557         if (!finished_booting || list_empty(&clocksource_list))
 558                 return NULL;
 559
 560         /*
 561          * We pick the clocksource with the highest rating. If oneshot
 562          * mode is active, we pick the highres valid clocksource with
 563          * the best rating.
 564          */
 565         list_for_each_entry(cs, &clocksource_list, list) {
 566                 if (skipcur && cs == curr_clocksource)
 567                         continue;
 568                 if (oneshot && !(cs->flags & CLOCK_SOURCE_VALID_FOR_HRES))
 569                         continue;
 570                 return cs;
 571         }
 572         return NULL;
 573 }
 574
 575 static void __clocksource_select(bool skipcur)
 576 {
 577         bool oneshot = tick_oneshot_mode_active();
 578         struct clocksource *best, *cs;
 579
 580         /* Find the best suitable clocksource */
 581         best = clocksource_find_best(oneshot, skipcur);
 582         if (!best)
 583                 return;
 584
 585         /* Check for the override clocksource. */
 586         list_for_each_entry(cs, &clocksource_list, list) {
 587                 if (skipcur && cs == curr_clocksource)
 588                         continue;
 589                 if (strcmp(cs->name, override_name) != 0)
 590                         continue;
 591                 /*
 592                  * Check to make sure we don't switch to a non-highres
 593                  * capable clocksource if the tick code is in oneshot
 594                  * mode (highres or nohz)
 595                  */
 596                 if (!(cs->flags & CLOCK_SOURCE_VALID_FOR_HRES) && oneshot) {
 597                         /* Override clocksource cannot be used. */
 598                         printk(KERN_WARNING "Override clocksource %s is not "
 599                                "HRT compatible. Cannot switch while in "
 600                                "HRT/NOHZ mode\n", cs->name);
 601                         override_name[0] = 0;
 602                 } else
 603                         /* Override clocksource can be used. */
 604                         best = cs;
 605                 break;
 606         }
 607
 608         if (curr_clocksource != best && !timekeeping_notify(best)) {
 609                 pr_info("Switched to clocksource %s\n", best->name);
 610                 curr_clocksource = best;
 611         }
 612 }
 613
 614 /**
 615  * clocksource_select - Select the best clocksource available
 616  *
 617  * Private function. Must hold clocksource_mutex when called.
 618  *
 619  * Select the clocksource with the best rating, or the clocksource,
 620  * which is selected by userspace override.
 621  */
 622 static void clocksource_select(void)
 623 {
 624         return __clocksource_select(false);
 625 }
 626
 627 static void clocksource_select_fallback(void)
 628 {
 629         return __clocksource_select(true);
 630 }
 631
 632 #else /* !CONFIG_ARCH_USES_GETTIMEOFFSET */
 633
 634 static inline void clocksource_select(void) { }
 635 static inline void clocksource_select_fallback(void) { }
 636
 637 #endif
 638
 639 /*
 640  * clocksource_done_booting - Called near the end of core bootup
 641  *
 642  * Hack to avoid lots of clocksource churn at boot time.
 643  * We use fs_initcall because we want this to start before
 644  * device_initcall but after subsys_initcall.
 645  */
 646 static int __init clocksource_done_booting(void)
 647 {
 648         mutex_lock(&clocksource_mutex);
 649         curr_clocksource = clocksource_default_clock();
 650         mutex_unlock(&clocksource_mutex);
 651
 652         finished_booting = 1;
 653
 654         /*
 655          * Run the watchdog first to eliminate unstable clock sources
 656          */
 657         clocksource_watchdog_kthread(NULL);
 658
 659         mutex_lock(&clocksource_mutex);
 660         clocksource_select();
 661         mutex_unlock(&clocksource_mutex);
 662         return 0;
 663 }
 664 fs_initcall(clocksource_done_booting);
 665
 666 /*
 667  * Enqueue the clocksource sorted by rating
 668  */
 669 static void clocksource_enqueue(struct clocksource *cs)
 670 {
 671         struct list_head *entry = &clocksource_list;
 672         struct clocksource *tmp;
 673
 674         list_for_each_entry(tmp, &clocksource_list, list)
 675                 /* Keep track of the place, where to insert */
 676                 if (tmp->rating >= cs->rating)
 677                         entry = &tmp->list;
 678         list_add(&cs->list, entry);
 679 }
 680
 681 /**
 682  * __clocksource_updatefreq_scale - Used update clocksource with new freq
 683  * @cs:         clocksource to be registered
 684  * @scale:      Scale factor multiplied against freq to get clocksource hz
 685  * @freq:       clocksource frequency (cycles per second) divided by scale
 686  *
 687  * This should only be called from the clocksource->enable() method.
 688  *
 689  * This *SHOULD NOT* be called directly! Please use the
 690  * clocksource_updatefreq_hz() or clocksource_updatefreq_khz helper functions.
 691  */
 692 void __clocksource_updatefreq_scale(struct clocksource *cs, u32 scale, u32 freq)
 693 {
 694         u64 sec;
 695         /*
 696          * Calc the maximum number of seconds which we can run before
 697          * wrapping around. For clocksources which have a mask > 32bit
 698          * we need to limit the max sleep time to have a good
 699          * conversion precision. 10 minutes is still a reasonable
 700          * amount. That results in a shift value of 24 for a
 701          * clocksource with mask >= 40bit and f >= 4GHz. That maps to
 702          * ~ 0.06ppm granularity for NTP. We apply the same 12.5%
 703          * margin as we do in clocksource_max_deferment()
 704          */
 705         sec = (cs->mask - (cs->mask >> 3));
 706         do_div(sec, freq);
 707         do_div(sec, scale);
 708         if (!sec)
 709                 sec = 1;
 710         else if (sec > 600 && cs->mask > UINT_MAX)
 711                 sec = 600;
 712
 713         clocks_calc_mult_shift(&cs->mult, &cs->shift, freq,
 714                                NSEC_PER_SEC / scale, sec * scale);
 715
 716         /*
 717          * for clocksources that have large mults, to avoid overflow.
 718          * Since mult may be adjusted by ntp, add an safety extra margin
 719          *
 720          */
 721         cs->maxadj = clocksource_max_adjustment(cs);
 722         while ((cs->mult + cs->maxadj < cs->mult)
 723                 || (cs->mult - cs->maxadj > cs->mult)) {
 724                 cs->mult >>= 1;
 725                 cs->shift--;
 726                 cs->maxadj = clocksource_max_adjustment(cs);
 727         }
 728
 729         cs->max_idle_ns = clocksource_max_deferment(cs);
 730 }
 731 EXPORT_SYMBOL_GPL(__clocksource_updatefreq_scale);
 732
 733 /**
 734  * __clocksource_register_scale - Used to install new clocksources
 735  * @cs:         clocksource to be registered
 736  * @scale:      Scale factor multiplied against freq to get clocksource hz
 737  * @freq:       clocksource frequency (cycles per second) divided by scale
 738  *
 739  * Returns -EBUSY if registration fails, zero otherwise.
 740  *
 741  * This *SHOULD NOT* be called directly! Please use the
 742  * clocksource_register_hz() or clocksource_register_khz helper functions.
 743  */
 744 int __clocksource_register_scale(struct clocksource *cs, u32 scale, u32 freq)
 745 {
 746
 747         /* Initialize mult/shift and max_idle_ns */
 748         __clocksource_updatefreq_scale(cs, scale, freq);
 749
 750         /* Add clocksource to the clcoksource list */
 751         mutex_lock(&clocksource_mutex);
 752         clocksource_enqueue(cs);
 753         clocksource_enqueue_watchdog(cs);
 754         clocksource_select();
 755         mutex_unlock(&clocksource_mutex);
 756         return 0;
 757 }
 758 EXPORT_SYMBOL_GPL(__clocksource_register_scale);
 759
 760
 761 /**
 762  * clocksource_register - Used to install new clocksources
 763  * @cs:         clocksource to be registered
 764  *
 765  * Returns -EBUSY if registration fails, zero otherwise.
 766  */
 767 int clocksource_register(struct clocksource *cs)
 768 {
 769         /* calculate max adjustment for given mult/shift */
 770         cs->maxadj = clocksource_max_adjustment(cs);
 771         WARN_ONCE(cs->mult + cs->maxadj < cs->mult,
 772                 "Clocksource %s might overflow on 11%% adjustment\n",
 773                 cs->name);
 774
 775         /* calculate max idle time permitted for this clocksource */
 776         cs->max_idle_ns = clocksource_max_deferment(cs);
 777
 778         mutex_lock(&clocksource_mutex);
 779         clocksource_enqueue(cs);
 780         clocksource_enqueue_watchdog(cs);
 781         clocksource_select();
 782         mutex_unlock(&clocksource_mutex);
 783         return 0;
 784 }
 785 EXPORT_SYMBOL(clocksource_register);
 786
 787 static void __clocksource_change_rating(struct clocksource *cs, int rating)
 788 {
 789         list_del(&cs->list);
 790         cs->rating = rating;
 791         clocksource_enqueue(cs);
 792         clocksource_select();
 793 }
 794
 795 /**
 796  * clocksource_change_rating - Change the rating of a registered clocksource
 797  * @cs:         clocksource to be changed
 798  * @rating:     new rating
 799  */
 800 void clocksource_change_rating(struct clocksource *cs, int rating)
 801 {
 802         mutex_lock(&clocksource_mutex);
 803         __clocksource_change_rating(cs, rating);
 804         mutex_unlock(&clocksource_mutex);
 805 }
 806 EXPORT_SYMBOL(clocksource_change_rating);
 807
 808 /*
 809  * Unbind clocksource @cs. Called with clocksource_mutex held
 810  */
 811 static int clocksource_unbind(struct clocksource *cs)
 812 {
 813         /*
 814          * I really can't convince myself to support this on hardware
 815          * designed by lobotomized monkeys.
 816          */
 817         if (clocksource_is_watchdog(cs))
 818                 return -EBUSY;
 819
 820         if (cs == curr_clocksource) {
 821                 /* Select and try to install a replacement clock source */
 822                 clocksource_select_fallback();
 823                 if (curr_clocksource == cs)
 824                         return -EBUSY;
 825         }
 826         clocksource_dequeue_watchdog(cs);
 827         list_del_init(&cs->list);
 828         return 0;
 829 }
 830
 831 /**
 832  * clocksource_unregister - remove a registered clocksource
 833  * @cs: clocksource to be unregistered
 834  */
 835 int clocksource_unregister(struct clocksource *cs)
 836 {
 837         int ret = 0;
 838
 839         mutex_lock(&clocksource_mutex);
 840         if (!list_empty(&cs->list))
 841                 ret = clocksource_unbind(cs);
 842         mutex_unlock(&clocksource_mutex);
 843         return ret;
 844 }
 845 EXPORT_SYMBOL(clocksource_unregister);
 846
 847 #ifdef CONFIG_SYSFS
 848 /**
 849  * sysfs_show_current_clocksources - sysfs interface for current clocksource
 850  * @dev:        unused
 851  * @attr:       unused
 852  * @buf:        char buffer to be filled with clocksource list
 853  *
 854  * Provides sysfs interface for listing current clocksource.
 855  */
 856 static ssize_t
 857 sysfs_show_current_clocksources(struct device *dev,
 858                                 struct device_attribute *attr, char *buf)
 859 {
 860         ssize_t count = 0;
 861
 862         mutex_lock(&clocksource_mutex);
 863         count = snprintf(buf, PAGE_SIZE, "%s\n", curr_clocksource->name);
 864         mutex_unlock(&clocksource_mutex);
 865
 866         return count;
 867 }
 868
 869 size_t sysfs_get_uname(const char *buf, char *dst, size_t cnt)
 870 {
 871         size_t ret = cnt;
 872
 873         /* strings from sysfs write are not 0 terminated! */
 874         if (!cnt || cnt >= CS_NAME_LEN)
 875                 return -EINVAL;
 876
 877         /* strip of \n: */
 878         if (buf[cnt-1] == '\n')
 879                 cnt--;
 880         if (cnt > 0)
 881                 memcpy(dst, buf, cnt);
 882         dst[cnt] = 0;
 883         return ret;
 884 }
 885
 886 /**
 887  * sysfs_override_clocksource - interface for manually overriding clocksource
 888  * @dev:        unused
 889  * @attr:       unused
 890  * @buf:        name of override clocksource
 891  * @count:      length of buffer
 892  *
 893  * Takes input from sysfs interface for manually overriding the default
 894  * clocksource selection.
 895  */
 896 static ssize_t sysfs_override_clocksource(struct device *dev,
 897                                           struct device_attribute *attr,
 898                                           const char *buf, size_t count)
 899 {
 900         size_t ret;
 901
 902         mutex_lock(&clocksource_mutex);
 903
 904         ret = sysfs_get_uname(buf, override_name, count);
 905         if (ret >= 0)
 906                 clocksource_select();
 907
 908         mutex_unlock(&clocksource_mutex);
 909
 910         return ret;
 911 }
 912
 913 /**
 914  * sysfs_unbind_current_clocksource - interface for manually unbinding clocksource
 915  * @dev:        unused
 916  * @attr:       unused
 917  * @buf:        unused
 918  * @count:      length of buffer
 919  *
 920  * Takes input from sysfs interface for manually unbinding a clocksource.
 921  */
 922 static ssize_t sysfs_unbind_clocksource(struct device *dev,
 923                                         struct device_attribute *attr,
 924                                         const char *buf, size_t count)
 925 {
 926         struct clocksource *cs;
 927         char name[CS_NAME_LEN];
 928         size_t ret;
 929
 930         ret = sysfs_get_uname(buf, name, count);
 931         if (ret < 0)
 932                 return ret;
 933
 934         ret = -ENODEV;
 935         mutex_lock(&clocksource_mutex);
 936         list_for_each_entry(cs, &clocksource_list, list) {
 937                 if (strcmp(cs->name, name))
 938                         continue;
 939                 ret = clocksource_unbind(cs);
 940                 break;
 941         }
 942         mutex_unlock(&clocksource_mutex);
 943
 944         return ret ? ret : count;
 945 }
 946
 947 /**
 948  * sysfs_show_available_clocksources - sysfs interface for listing clocksource
 949  * @dev:        unused
 950  * @attr:       unused
 951  * @buf:        char buffer to be filled with clocksource list
 952  *
 953  * Provides sysfs interface for listing registered clocksources
 954  */
 955 static ssize_t
 956 sysfs_show_available_clocksources(struct device *dev,
 957                                   struct device_attribute *attr,
 958                                   char *buf)
 959 {
 960         struct clocksource *src;
 961         ssize_t count = 0;
 962
 963         mutex_lock(&clocksource_mutex);
 964         list_for_each_entry(src, &clocksource_list, list) {
 965                 /*
 966                  * Don't show non-HRES clocksource if the tick code is
 967                  * in one shot mode (highres=on or nohz=on)
 968                  */
 969                 if (!tick_oneshot_mode_active() ||
 970                     (src->flags & CLOCK_SOURCE_VALID_FOR_HRES))
 971                         count += snprintf(buf + count,
 972                                   max((ssize_t)PAGE_SIZE - count, (ssize_t)0),
 973                                   "%s ", src->name);
 974         }
 975         mutex_unlock(&clocksource_mutex);
 976
 977         count += snprintf(buf + count,
 978                           max((ssize_t)PAGE_SIZE - count, (ssize_t)0), "\n");
 979
 980         return count;
 981 }
 982
 983 /*
 984  * Sysfs setup bits:
 985  */
 986 static DEVICE_ATTR(current_clocksource, 0644, sysfs_show_current_clocksources,
 987                    sysfs_override_clocksource);
 988
 989 static DEVICE_ATTR(unbind_clocksource, 0200, NULL, sysfs_unbind_clocksource);
 990
 991 static DEVICE_ATTR(available_clocksource, 0444,
 992                    sysfs_show_available_clocksources, NULL);
 993
 994 static struct bus_type clocksource_subsys = {
 995         .name = "clocksource",
 996         .dev_name = "clocksource",
 997 };
 998
 999 static struct device device_clocksource = {
1000         .id     = 0,
1001         .bus    = &clocksource_subsys,
1002 };
1003
1004 static int __init init_clocksource_sysfs(void)
1005 {
1006         int error = subsys_system_register(&clocksource_subsys, NULL);
1007
1008         if (!error)
1009                 error = device_register(&device_clocksource);
1010         if (!error)
1011                 error = device_create_file(
1012                                 &device_clocksource,
1013                                 &dev_attr_current_clocksource);
1014         if (!error)
1015                 error = device_create_file(&device_clocksource,
1016                                            &dev_attr_unbind_clocksource);
1017         if (!error)
1018                 error = device_create_file(
1019                                 &device_clocksource,
1020                                 &dev_attr_available_clocksource);
1021         return error;
1022 }
1023
1024 device_initcall(init_clocksource_sysfs);
1025 #endif /* CONFIG_SYSFS */
1026
1027 /**
1028  * boot_override_clocksource - boot clock override
1029  * @str:        override name
1030  *
1031  * Takes a clocksource= boot argument and uses it
1032  * as the clocksource override name.
1033  */
1034 static int __init boot_override_clocksource(char* str)
1035 {
1036         mutex_lock(&clocksource_mutex);
1037         if (str)
1038                 strlcpy(override_name, str, sizeof(override_name));
1039         mutex_unlock(&clocksource_mutex);
1040         return 1;
1041 }
1042
1043 __setup("clocksource=", boot_override_clocksource);
1044
1045 /**
1046  * boot_override_clock - Compatibility layer for deprecated boot option
1047  * @str:        override name
1048  *
1049  * DEPRECATED! Takes a clock= boot argument and uses it
1050  * as the clocksource override name
1051  */
1052 static int __init boot_override_clock(char* str)
1053 {
1054         if (!strcmp(str, "pmtmr")) {
1055                 printk("Warning: clock=pmtmr is deprecated. "
1056                         "Use clocksource=acpi_pm.\n");
1057                 return boot_override_clocksource("acpi_pm");
1058         }
1059         printk("Warning! clock= boot option is deprecated. "
1060                 "Use clocksource=xyz\n");
1061         return boot_override_clocksource(str);
1062 }
1063
1064 __setup("clock=", boot_override_clock);