2 * arch/s390/kernel/time.c
3 * Time of day based timer functions.
6 * Copyright (C) 1999 IBM Deutschland Entwicklung GmbH, IBM Corporation
7 * Author(s): Hartmut Penner (hp@de.ibm.com),
8 * Martin Schwidefsky (schwidefsky@de.ibm.com),
9 * Denis Joseph Barrow (djbarrow@de.ibm.com,barrow_dj@yahoo.com)
11 * Derived from "arch/i386/kernel/time.c"
12 * Copyright (C) 1991, 1992, 1995 Linus Torvalds
15 #include <linux/errno.h>
16 #include <linux/module.h>
17 #include <linux/sched.h>
18 #include <linux/kernel.h>
19 #include <linux/param.h>
20 #include <linux/string.h>
22 #include <linux/interrupt.h>
23 #include <linux/time.h>
24 #include <linux/sysdev.h>
25 #include <linux/delay.h>
26 #include <linux/init.h>
27 #include <linux/smp.h>
28 #include <linux/types.h>
29 #include <linux/profile.h>
30 #include <linux/timex.h>
31 #include <linux/notifier.h>
32 #include <linux/clocksource.h>
34 #include <asm/uaccess.h>
35 #include <asm/delay.h>
36 #include <asm/s390_ext.h>
37 #include <asm/div64.h>
39 #include <asm/irq_regs.h>
40 #include <asm/timer.h>
43 /* change this if you have some constant time drift */
44 #define USECS_PER_JIFFY ((unsigned long) 1000000/HZ)
45 #define CLK_TICKS_PER_JIFFY ((unsigned long) USECS_PER_JIFFY << 12)
47 /* The value of the TOD clock for 1.1.1970. */
48 #define TOD_UNIX_EPOCH 0x7d91048bca000000ULL
51 * Create a small time difference between the timer interrupts
52 * on the different cpus to avoid lock contention.
54 #define CPU_DEVIATION (smp_processor_id() << 12)
56 #define TICK_SIZE tick
58 static ext_int_info_t ext_int_info_cc;
59 static ext_int_info_t ext_int_etr_cc;
60 static u64 init_timer_cc;
61 static u64 jiffies_timer_cc;
65 * Scheduler clock - returns current time in nanosec units.
67 unsigned long long sched_clock(void)
69 return ((get_clock() - jiffies_timer_cc) * 125) >> 9;
73 * Monotonic_clock - returns # of nanoseconds passed since time_init()
75 unsigned long long monotonic_clock(void)
79 EXPORT_SYMBOL(monotonic_clock);
81 void tod_to_timeval(__u64 todval, struct timespec *xtime)
83 unsigned long long sec;
88 todval -= (sec * 1000000) << 12;
89 xtime->tv_nsec = ((todval * 1000) >> 12);
92 #ifdef CONFIG_PROFILING
93 #define s390_do_profile() profile_tick(CPU_PROFILING)
95 #define s390_do_profile() do { ; } while(0)
96 #endif /* CONFIG_PROFILING */
99 * Advance the per cpu tick counter up to the time given with the
100 * "time" argument. The per cpu update consists of accounting
101 * the virtual cpu time, calling update_process_times and calling
102 * the profiling hook. If xtime is before time it is advanced as well.
104 void account_ticks(u64 time)
109 /* Calculate how many ticks have passed. */
110 if (time < S390_lowcore.jiffy_timer)
112 tmp = time - S390_lowcore.jiffy_timer;
113 if (tmp >= 2*CLK_TICKS_PER_JIFFY) { /* more than two ticks ? */
114 ticks = __div(tmp, CLK_TICKS_PER_JIFFY) + 1;
115 S390_lowcore.jiffy_timer +=
116 CLK_TICKS_PER_JIFFY * (__u64) ticks;
117 } else if (tmp >= CLK_TICKS_PER_JIFFY) {
119 S390_lowcore.jiffy_timer += 2*CLK_TICKS_PER_JIFFY;
122 S390_lowcore.jiffy_timer += CLK_TICKS_PER_JIFFY;
127 * Do not rely on the boot cpu to do the calls to do_timer.
128 * Spread it over all cpus instead.
130 write_seqlock(&xtime_lock);
131 if (S390_lowcore.jiffy_timer > xtime_cc) {
133 tmp = S390_lowcore.jiffy_timer - xtime_cc;
134 if (tmp >= 2*CLK_TICKS_PER_JIFFY) {
135 xticks = __div(tmp, CLK_TICKS_PER_JIFFY);
136 xtime_cc += (__u64) xticks * CLK_TICKS_PER_JIFFY;
139 xtime_cc += CLK_TICKS_PER_JIFFY;
143 write_sequnlock(&xtime_lock);
149 update_process_times(user_mode(get_irq_regs()));
154 #ifdef CONFIG_NO_IDLE_HZ
156 #ifdef CONFIG_NO_IDLE_HZ_INIT
157 int sysctl_hz_timer = 0;
159 int sysctl_hz_timer = 1;
163 * Stop the HZ tick on the current CPU.
164 * Only cpu_idle may call this function.
166 static void stop_hz_timer(void)
169 unsigned long seq, next;
171 int cpu = smp_processor_id();
173 if (sysctl_hz_timer != 0)
176 cpu_set(cpu, nohz_cpu_mask);
179 * Leave the clock comparator set up for the next timer
180 * tick if either rcu or a softirq is pending.
182 if (rcu_needs_cpu(cpu) || local_softirq_pending()) {
183 cpu_clear(cpu, nohz_cpu_mask);
188 * This cpu is going really idle. Set up the clock comparator
189 * for the next event.
191 next = next_timer_interrupt();
193 seq = read_seqbegin_irqsave(&xtime_lock, flags);
194 timer = ((__u64) next) - ((__u64) jiffies) + jiffies_64;
195 } while (read_seqretry_irqrestore(&xtime_lock, seq, flags));
197 /* Be careful about overflows. */
198 if (timer < (-1ULL / CLK_TICKS_PER_JIFFY)) {
199 timer = jiffies_timer_cc + timer * CLK_TICKS_PER_JIFFY;
200 if (timer >= jiffies_timer_cc)
203 set_clock_comparator(todval);
207 * Start the HZ tick on the current CPU.
208 * Only cpu_idle may call this function.
210 static void start_hz_timer(void)
212 BUG_ON(!in_interrupt());
214 if (!cpu_isset(smp_processor_id(), nohz_cpu_mask))
216 account_ticks(get_clock());
217 set_clock_comparator(S390_lowcore.jiffy_timer + CPU_DEVIATION);
218 cpu_clear(smp_processor_id(), nohz_cpu_mask);
221 static int nohz_idle_notify(struct notifier_block *self,
222 unsigned long action, void *hcpu)
228 case S390_CPU_NOT_IDLE:
235 static struct notifier_block nohz_idle_nb = {
236 .notifier_call = nohz_idle_notify,
239 static void __init nohz_init(void)
241 if (register_idle_notifier(&nohz_idle_nb))
242 panic("Couldn't register idle notifier");
248 * Set up per cpu jiffy timer and set the clock comparator.
250 static void setup_jiffy_timer(void)
252 /* Set up clock comparator to next jiffy. */
253 S390_lowcore.jiffy_timer =
254 jiffies_timer_cc + (jiffies_64 + 1) * CLK_TICKS_PER_JIFFY;
255 set_clock_comparator(S390_lowcore.jiffy_timer + CPU_DEVIATION);
259 * Set up lowcore and control register of the current cpu to
260 * enable TOD clock and clock comparator interrupts.
262 void init_cpu_timer(void)
266 /* Enable clock comparator timer interrupt. */
269 /* Always allow ETR external interrupts, even without an ETR. */
273 static void clock_comparator_interrupt(__u16 code)
275 /* set clock comparator for next tick */
276 set_clock_comparator(S390_lowcore.jiffy_timer + CPU_DEVIATION);
279 static void etr_reset(void);
280 static void etr_ext_handler(__u16);
283 * Get the TOD clock running.
285 static u64 __init reset_tod_clock(void)
290 if (store_clock(&time) == 0)
292 /* TOD clock not running. Set the clock to Unix Epoch. */
293 if (set_clock(TOD_UNIX_EPOCH) != 0 || store_clock(&time) != 0)
294 panic("TOD clock not operational.");
296 return TOD_UNIX_EPOCH;
299 static cycle_t read_tod_clock(void)
304 static struct clocksource clocksource_tod = {
307 .read = read_tod_clock,
311 .flags = CLOCK_SOURCE_IS_CONTINUOUS,
316 * Initialize the TOD clock and the CPU timer of
319 void __init time_init(void)
321 init_timer_cc = reset_tod_clock();
322 xtime_cc = init_timer_cc + CLK_TICKS_PER_JIFFY;
323 jiffies_timer_cc = init_timer_cc - jiffies_64 * CLK_TICKS_PER_JIFFY;
326 tod_to_timeval(init_timer_cc - TOD_UNIX_EPOCH, &xtime);
327 set_normalized_timespec(&wall_to_monotonic,
328 -xtime.tv_sec, -xtime.tv_nsec);
330 /* request the clock comparator external interrupt */
331 if (register_early_external_interrupt(0x1004,
332 clock_comparator_interrupt,
333 &ext_int_info_cc) != 0)
334 panic("Couldn't request external interrupt 0x1004");
336 if (clocksource_register(&clocksource_tod) != 0)
337 panic("Could not register TOD clock source");
339 /* request the etr external interrupt */
340 if (register_early_external_interrupt(0x1406, etr_ext_handler,
341 &ext_int_etr_cc) != 0)
342 panic("Couldn't request external interrupt 0x1406");
344 /* Enable TOD clock interrupts on the boot cpu. */
347 #ifdef CONFIG_NO_IDLE_HZ
351 #ifdef CONFIG_VIRT_TIMER
357 * External Time Reference (ETR) code.
359 static int etr_port0_online;
360 static int etr_port1_online;
362 static int __init early_parse_etr(char *p)
364 if (strncmp(p, "off", 3) == 0)
365 etr_port0_online = etr_port1_online = 0;
366 else if (strncmp(p, "port0", 5) == 0)
367 etr_port0_online = 1;
368 else if (strncmp(p, "port1", 5) == 0)
369 etr_port1_online = 1;
370 else if (strncmp(p, "on", 2) == 0)
371 etr_port0_online = etr_port1_online = 1;
374 early_param("etr", early_parse_etr);
377 ETR_EVENT_PORT0_CHANGE,
378 ETR_EVENT_PORT1_CHANGE,
379 ETR_EVENT_PORT_ALERT,
380 ETR_EVENT_SYNC_CHECK,
381 ETR_EVENT_SWITCH_LOCAL,
392 * Valid bit combinations of the eacr register are (x = don't care):
393 * e0 e1 dp p0 p1 ea es sl
394 * 0 0 x 0 0 0 0 0 initial, disabled state
395 * 0 0 x 0 1 1 0 0 port 1 online
396 * 0 0 x 1 0 1 0 0 port 0 online
397 * 0 0 x 1 1 1 0 0 both ports online
398 * 0 1 x 0 1 1 0 0 port 1 online and usable, ETR or PPS mode
399 * 0 1 x 0 1 1 0 1 port 1 online, usable and ETR mode
400 * 0 1 x 0 1 1 1 0 port 1 online, usable, PPS mode, in-sync
401 * 0 1 x 0 1 1 1 1 port 1 online, usable, ETR mode, in-sync
402 * 0 1 x 1 1 1 0 0 both ports online, port 1 usable
403 * 0 1 x 1 1 1 1 0 both ports online, port 1 usable, PPS mode, in-sync
404 * 0 1 x 1 1 1 1 1 both ports online, port 1 usable, ETR mode, in-sync
405 * 1 0 x 1 0 1 0 0 port 0 online and usable, ETR or PPS mode
406 * 1 0 x 1 0 1 0 1 port 0 online, usable and ETR mode
407 * 1 0 x 1 0 1 1 0 port 0 online, usable, PPS mode, in-sync
408 * 1 0 x 1 0 1 1 1 port 0 online, usable, ETR mode, in-sync
409 * 1 0 x 1 1 1 0 0 both ports online, port 0 usable
410 * 1 0 x 1 1 1 1 0 both ports online, port 0 usable, PPS mode, in-sync
411 * 1 0 x 1 1 1 1 1 both ports online, port 0 usable, ETR mode, in-sync
412 * 1 1 x 1 1 1 1 0 both ports online & usable, ETR, in-sync
413 * 1 1 x 1 1 1 1 1 both ports online & usable, ETR, in-sync
415 static struct etr_eacr etr_eacr;
416 static u64 etr_tolec; /* time of last eacr update */
417 static unsigned long etr_flags;
418 static struct etr_aib etr_port0;
419 static int etr_port0_uptodate;
420 static struct etr_aib etr_port1;
421 static int etr_port1_uptodate;
422 static unsigned long etr_events;
423 static struct timer_list etr_timer;
424 static DEFINE_PER_CPU(atomic_t, etr_sync_word);
426 static void etr_timeout(unsigned long dummy);
427 static void etr_work_fn(struct work_struct *work);
428 static DECLARE_WORK(etr_work, etr_work_fn);
431 * The etr get_clock function. It will write the current clock value
432 * to the clock pointer and return 0 if the clock is in sync with the
433 * external time source. If the clock mode is local it will return
434 * -ENOSYS and -EAGAIN if the clock is not in sync with the external
435 * reference. This function is what ETR is all about..
437 int get_sync_clock(unsigned long long *clock)
440 unsigned int sw0, sw1;
442 sw_ptr = &get_cpu_var(etr_sync_word);
443 sw0 = atomic_read(sw_ptr);
444 *clock = get_clock();
445 sw1 = atomic_read(sw_ptr);
446 put_cpu_var(etr_sync_sync);
447 if (sw0 == sw1 && (sw0 & 0x80000000U))
448 /* Success: time is in sync. */
450 if (test_bit(ETR_FLAG_ENOSYS, &etr_flags))
452 if (test_bit(ETR_FLAG_EACCES, &etr_flags))
456 EXPORT_SYMBOL(get_sync_clock);
459 * Make get_sync_clock return -EAGAIN.
461 static void etr_disable_sync_clock(void *dummy)
463 atomic_t *sw_ptr = &__get_cpu_var(etr_sync_word);
465 * Clear the in-sync bit 2^31. All get_sync_clock calls will
466 * fail until the sync bit is turned back on. In addition
467 * increase the "sequence" counter to avoid the race of an
468 * etr event and the complete recovery against get_sync_clock.
470 atomic_clear_mask(0x80000000, sw_ptr);
475 * Make get_sync_clock return 0 again.
476 * Needs to be called from a context disabled for preemption.
478 static void etr_enable_sync_clock(void)
480 atomic_t *sw_ptr = &__get_cpu_var(etr_sync_word);
481 atomic_set_mask(0x80000000, sw_ptr);
485 * Reset ETR attachment.
487 static void etr_reset(void)
489 etr_eacr = (struct etr_eacr) {
490 .e0 = 0, .e1 = 0, ._pad0 = 4, .dp = 0,
491 .p0 = 0, .p1 = 0, ._pad1 = 0, .ea = 0,
493 if (etr_setr(&etr_eacr) == 0)
494 etr_tolec = get_clock();
496 set_bit(ETR_FLAG_ENOSYS, &etr_flags);
497 if (etr_port0_online || etr_port1_online) {
498 printk(KERN_WARNING "Running on non ETR capable "
499 "machine, only local mode available.\n");
500 etr_port0_online = etr_port1_online = 0;
505 static int __init etr_init(void)
509 if (test_bit(ETR_FLAG_ENOSYS, &etr_flags))
511 /* Check if this machine has the steai instruction. */
512 if (etr_steai(&aib, ETR_STEAI_STEPPING_PORT) == 0)
513 set_bit(ETR_FLAG_STEAI, &etr_flags);
514 setup_timer(&etr_timer, etr_timeout, 0UL);
515 if (!etr_port0_online && !etr_port1_online)
516 set_bit(ETR_FLAG_EACCES, &etr_flags);
517 if (etr_port0_online) {
518 set_bit(ETR_EVENT_PORT0_CHANGE, &etr_events);
519 schedule_work(&etr_work);
521 if (etr_port1_online) {
522 set_bit(ETR_EVENT_PORT1_CHANGE, &etr_events);
523 schedule_work(&etr_work);
528 arch_initcall(etr_init);
531 * Two sorts of ETR machine checks. The architecture reads:
532 * "When a machine-check niterruption occurs and if a switch-to-local or
533 * ETR-sync-check interrupt request is pending but disabled, this pending
534 * disabled interruption request is indicated and is cleared".
535 * Which means that we can get etr_switch_to_local events from the machine
536 * check handler although the interruption condition is disabled. Lovely..
540 * Switch to local machine check. This is called when the last usable
541 * ETR port goes inactive. After switch to local the clock is not in sync.
543 void etr_switch_to_local(void)
547 etr_disable_sync_clock(NULL);
548 set_bit(ETR_EVENT_SWITCH_LOCAL, &etr_events);
549 schedule_work(&etr_work);
553 * ETR sync check machine check. This is called when the ETR OTE and the
554 * local clock OTE are farther apart than the ETR sync check tolerance.
555 * After a ETR sync check the clock is not in sync. The machine check
556 * is broadcasted to all cpus at the same time.
558 void etr_sync_check(void)
562 etr_disable_sync_clock(NULL);
563 set_bit(ETR_EVENT_SYNC_CHECK, &etr_events);
564 schedule_work(&etr_work);
568 * ETR external interrupt. There are two causes:
569 * 1) port state change, check the usability of the port
570 * 2) port alert, one of the ETR-data-validity bits (v1-v2 bits of the
571 * sldr-status word) or ETR-data word 1 (edf1) or ETR-data word 3 (edf3)
572 * or ETR-data word 4 (edf4) has changed.
574 static void etr_ext_handler(__u16 code)
576 struct etr_interruption_parameter *intparm =
577 (struct etr_interruption_parameter *) &S390_lowcore.ext_params;
580 /* ETR port 0 state change. */
581 set_bit(ETR_EVENT_PORT0_CHANGE, &etr_events);
583 /* ETR port 1 state change. */
584 set_bit(ETR_EVENT_PORT1_CHANGE, &etr_events);
587 * ETR port alert on either port 0, 1 or both.
588 * Both ports are not up-to-date now.
590 set_bit(ETR_EVENT_PORT_ALERT, &etr_events);
591 schedule_work(&etr_work);
594 static void etr_timeout(unsigned long dummy)
596 set_bit(ETR_EVENT_UPDATE, &etr_events);
597 schedule_work(&etr_work);
601 * Check if the etr mode is pss.
603 static inline int etr_mode_is_pps(struct etr_eacr eacr)
605 return eacr.es && !eacr.sl;
609 * Check if the etr mode is etr.
611 static inline int etr_mode_is_etr(struct etr_eacr eacr)
613 return eacr.es && eacr.sl;
617 * Check if the port can be used for TOD synchronization.
618 * For PPS mode the port has to receive OTEs. For ETR mode
619 * the port has to receive OTEs, the ETR stepping bit has to
620 * be zero and the validity bits for data frame 1, 2, and 3
623 static int etr_port_valid(struct etr_aib *aib, int port)
627 /* Check that this port is receiving OTEs. */
631 psc = port ? aib->esw.psc1 : aib->esw.psc0;
632 if (psc == etr_lpsc_pps_mode)
634 if (psc == etr_lpsc_operational_step)
635 return !aib->esw.y && aib->slsw.v1 &&
636 aib->slsw.v2 && aib->slsw.v3;
641 * Check if two ports are on the same network.
643 static int etr_compare_network(struct etr_aib *aib1, struct etr_aib *aib2)
645 // FIXME: any other fields we have to compare?
646 return aib1->edf1.net_id == aib2->edf1.net_id;
650 * Wrapper for etr_stei that converts physical port states
651 * to logical port states to be consistent with the output
652 * of stetr (see etr_psc vs. etr_lpsc).
654 static void etr_steai_cv(struct etr_aib *aib, unsigned int func)
656 BUG_ON(etr_steai(aib, func) != 0);
657 /* Convert port state to logical port state. */
658 if (aib->esw.psc0 == 1)
660 else if (aib->esw.psc0 == 0 && aib->esw.p == 0)
662 if (aib->esw.psc1 == 1)
664 else if (aib->esw.psc1 == 0 && aib->esw.p == 1)
669 * Check if the aib a2 is still connected to the same attachment as
670 * aib a1, the etv values differ by one and a2 is valid.
672 static int etr_aib_follows(struct etr_aib *a1, struct etr_aib *a2, int p)
674 int state_a1, state_a2;
676 /* Paranoia check: e0/e1 should better be the same. */
677 if (a1->esw.eacr.e0 != a2->esw.eacr.e0 ||
678 a1->esw.eacr.e1 != a2->esw.eacr.e1)
681 /* Still connected to the same etr ? */
682 state_a1 = p ? a1->esw.psc1 : a1->esw.psc0;
683 state_a2 = p ? a2->esw.psc1 : a2->esw.psc0;
684 if (state_a1 == etr_lpsc_operational_step) {
685 if (state_a2 != etr_lpsc_operational_step ||
686 a1->edf1.net_id != a2->edf1.net_id ||
687 a1->edf1.etr_id != a2->edf1.etr_id ||
688 a1->edf1.etr_pn != a2->edf1.etr_pn)
690 } else if (state_a2 != etr_lpsc_pps_mode)
693 /* The ETV value of a2 needs to be ETV of a1 + 1. */
694 if (a1->edf2.etv + 1 != a2->edf2.etv)
697 if (!etr_port_valid(a2, p))
704 * The time is "clock". xtime is what we think the time is.
705 * Adjust the value by a multiple of jiffies and add the delta to ntp.
706 * "delay" is an approximation how long the synchronization took. If
707 * the time correction is positive, then "delay" is subtracted from
708 * the time difference and only the remaining part is passed to ntp.
710 static void etr_adjust_time(unsigned long long clock, unsigned long long delay)
712 unsigned long long delta, ticks;
716 * We don't have to take the xtime lock because the cpu
717 * executing etr_adjust_time is running disabled in
718 * tasklet context and all other cpus are looping in
719 * etr_sync_cpu_start.
721 if (clock > xtime_cc) {
722 /* It is later than we thought. */
723 delta = ticks = clock - xtime_cc;
724 delta = ticks = (delta < delay) ? 0 : delta - delay;
725 delta -= do_div(ticks, CLK_TICKS_PER_JIFFY);
726 init_timer_cc = init_timer_cc + delta;
727 jiffies_timer_cc = jiffies_timer_cc + delta;
728 xtime_cc = xtime_cc + delta;
729 adjust.offset = ticks * (1000000 / HZ);
731 /* It is earlier than we thought. */
732 delta = ticks = xtime_cc - clock;
733 delta -= do_div(ticks, CLK_TICKS_PER_JIFFY);
734 init_timer_cc = init_timer_cc - delta;
735 jiffies_timer_cc = jiffies_timer_cc - delta;
736 xtime_cc = xtime_cc - delta;
737 adjust.offset = -ticks * (1000000 / HZ);
739 if (adjust.offset != 0) {
740 printk(KERN_NOTICE "etr: time adjusted by %li micro-seconds\n",
742 adjust.modes = ADJ_OFFSET_SINGLESHOT;
743 do_adjtimex(&adjust);
747 static void etr_sync_cpu_start(void *dummy)
749 int *in_sync = dummy;
751 etr_enable_sync_clock();
753 * This looks like a busy wait loop but it isn't. etr_sync_cpus
754 * is called on all other cpus while the TOD clocks is stopped.
755 * __udelay will stop the cpu on an enabled wait psw until the
756 * TOD is running again.
758 while (*in_sync == 0) {
761 * A different cpu changes *in_sync. Therefore use
762 * barrier() to force memory access.
767 /* Didn't work. Clear per-cpu in sync bit again. */
768 etr_disable_sync_clock(NULL);
770 * This round of TOD syncing is done. Set the clock comparator
771 * to the next tick and let the processor continue.
776 static void etr_sync_cpu_end(void *dummy)
781 * Sync the TOD clock using the port refered to by aibp. This port
782 * has to be enabled and the other port has to be disabled. The
783 * last eacr update has to be more than 1.6 seconds in the past.
785 static int etr_sync_clock(struct etr_aib *aib, int port)
787 struct etr_aib *sync_port;
788 unsigned long long clock, delay;
789 int in_sync, follows;
792 /* Check if the current aib is adjacent to the sync port aib. */
793 sync_port = (port == 0) ? &etr_port0 : &etr_port1;
794 follows = etr_aib_follows(sync_port, aib, port);
795 memcpy(sync_port, aib, sizeof(*aib));
800 * Catch all other cpus and make them wait until we have
801 * successfully synced the clock. smp_call_function will
802 * return after all other cpus are in etr_sync_cpu_start.
806 smp_call_function(etr_sync_cpu_start,&in_sync,0,0);
808 etr_enable_sync_clock();
810 /* Set clock to next OTE. */
811 __ctl_set_bit(14, 21);
812 __ctl_set_bit(0, 29);
813 clock = ((unsigned long long) (aib->edf2.etv + 1)) << 32;
814 if (set_clock(clock) == 0) {
815 __udelay(1); /* Wait for the clock to start. */
816 __ctl_clear_bit(0, 29);
817 __ctl_clear_bit(14, 21);
819 /* Adjust Linux timing variables. */
820 delay = (unsigned long long)
821 (aib->edf2.etv - sync_port->edf2.etv) << 32;
822 etr_adjust_time(clock, delay);
824 /* Verify that the clock is properly set. */
825 if (!etr_aib_follows(sync_port, aib, port)) {
827 etr_disable_sync_clock(NULL);
835 /* Could not set the clock ?!? */
836 __ctl_clear_bit(0, 29);
837 __ctl_clear_bit(14, 21);
838 etr_disable_sync_clock(NULL);
843 smp_call_function(etr_sync_cpu_end,NULL,0,0);
849 * Handle the immediate effects of the different events.
850 * The port change event is used for online/offline changes.
852 static struct etr_eacr etr_handle_events(struct etr_eacr eacr)
854 if (test_and_clear_bit(ETR_EVENT_SYNC_CHECK, &etr_events))
856 if (test_and_clear_bit(ETR_EVENT_SWITCH_LOCAL, &etr_events))
857 eacr.es = eacr.sl = 0;
858 if (test_and_clear_bit(ETR_EVENT_PORT_ALERT, &etr_events))
859 etr_port0_uptodate = etr_port1_uptodate = 0;
861 if (test_and_clear_bit(ETR_EVENT_PORT0_CHANGE, &etr_events)) {
864 * Port change of an enabled port. We have to
865 * assume that this can have caused an stepping
868 etr_tolec = get_clock();
869 eacr.p0 = etr_port0_online;
872 etr_port0_uptodate = 0;
874 if (test_and_clear_bit(ETR_EVENT_PORT1_CHANGE, &etr_events)) {
877 * Port change of an enabled port. We have to
878 * assume that this can have caused an stepping
881 etr_tolec = get_clock();
882 eacr.p1 = etr_port1_online;
885 etr_port1_uptodate = 0;
887 clear_bit(ETR_EVENT_UPDATE, &etr_events);
892 * Set up a timer that expires after the etr_tolec + 1.6 seconds if
893 * one of the ports needs an update.
895 static void etr_set_tolec_timeout(unsigned long long now)
897 unsigned long micros;
899 if ((!etr_eacr.p0 || etr_port0_uptodate) &&
900 (!etr_eacr.p1 || etr_port1_uptodate))
902 micros = (now > etr_tolec) ? ((now - etr_tolec) >> 12) : 0;
903 micros = (micros > 1600000) ? 0 : 1600000 - micros;
904 mod_timer(&etr_timer, jiffies + (micros * HZ) / 1000000 + 1);
908 * Set up a time that expires after 1/2 second.
910 static void etr_set_sync_timeout(void)
912 mod_timer(&etr_timer, jiffies + HZ/2);
916 * Update the aib information for one or both ports.
918 static struct etr_eacr etr_handle_update(struct etr_aib *aib,
919 struct etr_eacr eacr)
921 /* With both ports disabled the aib information is useless. */
922 if (!eacr.e0 && !eacr.e1)
925 /* Update port0 or port1 with aib stored in etr_work_fn. */
926 if (aib->esw.q == 0) {
927 /* Information for port 0 stored. */
928 if (eacr.p0 && !etr_port0_uptodate) {
930 if (etr_port0_online)
931 etr_port0_uptodate = 1;
934 /* Information for port 1 stored. */
935 if (eacr.p1 && !etr_port1_uptodate) {
937 if (etr_port0_online)
938 etr_port1_uptodate = 1;
943 * Do not try to get the alternate port aib if the clock
944 * is not in sync yet.
950 * If steai is available we can get the information about
951 * the other port immediately. If only stetr is available the
952 * data-port bit toggle has to be used.
954 if (test_bit(ETR_FLAG_STEAI, &etr_flags)) {
955 if (eacr.p0 && !etr_port0_uptodate) {
956 etr_steai_cv(&etr_port0, ETR_STEAI_PORT_0);
957 etr_port0_uptodate = 1;
959 if (eacr.p1 && !etr_port1_uptodate) {
960 etr_steai_cv(&etr_port1, ETR_STEAI_PORT_1);
961 etr_port1_uptodate = 1;
965 * One port was updated above, if the other
966 * port is not uptodate toggle dp bit.
968 if ((eacr.p0 && !etr_port0_uptodate) ||
969 (eacr.p1 && !etr_port1_uptodate))
978 * Write new etr control register if it differs from the current one.
979 * Return 1 if etr_tolec has been updated as well.
981 static void etr_update_eacr(struct etr_eacr eacr)
985 if (memcmp(&etr_eacr, &eacr, sizeof(eacr)) == 0)
986 /* No change, return. */
989 * The disable of an active port of the change of the data port
990 * bit can/will cause a change in the data port.
992 dp_changed = etr_eacr.e0 > eacr.e0 || etr_eacr.e1 > eacr.e1 ||
993 (etr_eacr.dp ^ eacr.dp) != 0;
997 etr_tolec = get_clock();
1001 * ETR tasklet. In this function you'll find the main logic. In
1002 * particular this is the only function that calls etr_update_eacr(),
1003 * it "controls" the etr control register.
1005 static void etr_work_fn(struct work_struct *work)
1007 unsigned long long now;
1008 struct etr_eacr eacr;
1012 /* Create working copy of etr_eacr. */
1015 /* Check for the different events and their immediate effects. */
1016 eacr = etr_handle_events(eacr);
1018 /* Check if ETR is supposed to be active. */
1019 eacr.ea = eacr.p0 || eacr.p1;
1021 /* Both ports offline. Reset everything. */
1022 eacr.dp = eacr.es = eacr.sl = 0;
1023 on_each_cpu(etr_disable_sync_clock, NULL, 0, 1);
1024 del_timer_sync(&etr_timer);
1025 etr_update_eacr(eacr);
1026 set_bit(ETR_FLAG_EACCES, &etr_flags);
1030 /* Store aib to get the current ETR status word. */
1031 BUG_ON(etr_stetr(&aib) != 0);
1032 etr_port0.esw = etr_port1.esw = aib.esw; /* Copy status word. */
1036 * Update the port information if the last stepping port change
1037 * or data port change is older than 1.6 seconds.
1039 if (now >= etr_tolec + (1600000 << 12))
1040 eacr = etr_handle_update(&aib, eacr);
1043 * Select ports to enable. The prefered synchronization mode is PPS.
1044 * If a port can be enabled depends on a number of things:
1045 * 1) The port needs to be online and uptodate. A port is not
1046 * disabled just because it is not uptodate, but it is only
1047 * enabled if it is uptodate.
1048 * 2) The port needs to have the same mode (pps / etr).
1049 * 3) The port needs to be usable -> etr_port_valid() == 1
1050 * 4) To enable the second port the clock needs to be in sync.
1051 * 5) If both ports are useable and are ETR ports, the network id
1052 * has to be the same.
1053 * The eacr.sl bit is used to indicate etr mode vs. pps mode.
1055 if (eacr.p0 && aib.esw.psc0 == etr_lpsc_pps_mode) {
1058 if (!etr_mode_is_pps(etr_eacr))
1060 if (!eacr.es || !eacr.p1 || aib.esw.psc1 != etr_lpsc_pps_mode)
1062 // FIXME: uptodate checks ?
1063 else if (etr_port0_uptodate && etr_port1_uptodate)
1065 sync_port = (etr_port0_uptodate &&
1066 etr_port_valid(&etr_port0, 0)) ? 0 : -1;
1067 clear_bit(ETR_FLAG_EACCES, &etr_flags);
1068 } else if (eacr.p1 && aib.esw.psc1 == etr_lpsc_pps_mode) {
1072 if (!etr_mode_is_pps(etr_eacr))
1074 sync_port = (etr_port1_uptodate &&
1075 etr_port_valid(&etr_port1, 1)) ? 1 : -1;
1076 clear_bit(ETR_FLAG_EACCES, &etr_flags);
1077 } else if (eacr.p0 && aib.esw.psc0 == etr_lpsc_operational_step) {
1080 if (!etr_mode_is_etr(etr_eacr))
1082 if (!eacr.es || !eacr.p1 ||
1083 aib.esw.psc1 != etr_lpsc_operational_alt)
1085 else if (etr_port0_uptodate && etr_port1_uptodate &&
1086 etr_compare_network(&etr_port0, &etr_port1))
1088 sync_port = (etr_port0_uptodate &&
1089 etr_port_valid(&etr_port0, 0)) ? 0 : -1;
1090 clear_bit(ETR_FLAG_EACCES, &etr_flags);
1091 } else if (eacr.p1 && aib.esw.psc1 == etr_lpsc_operational_step) {
1095 if (!etr_mode_is_etr(etr_eacr))
1097 sync_port = (etr_port1_uptodate &&
1098 etr_port_valid(&etr_port1, 1)) ? 1 : -1;
1099 clear_bit(ETR_FLAG_EACCES, &etr_flags);
1101 /* Both ports not usable. */
1102 eacr.es = eacr.sl = 0;
1104 set_bit(ETR_FLAG_EACCES, &etr_flags);
1108 * If the clock is in sync just update the eacr and return.
1109 * If there is no valid sync port wait for a port update.
1111 if (eacr.es || sync_port < 0) {
1112 etr_update_eacr(eacr);
1113 etr_set_tolec_timeout(now);
1118 * Prepare control register for clock syncing
1119 * (reset data port bit, set sync check control.
1125 * Update eacr and try to synchronize the clock. If the update
1126 * of eacr caused a stepping port switch (or if we have to
1127 * assume that a stepping port switch has occured) or the
1128 * clock syncing failed, reset the sync check control bit
1129 * and set up a timer to try again after 0.5 seconds
1131 etr_update_eacr(eacr);
1132 if (now < etr_tolec + (1600000 << 12) ||
1133 etr_sync_clock(&aib, sync_port) != 0) {
1134 /* Sync failed. Try again in 1/2 second. */
1136 etr_update_eacr(eacr);
1137 etr_set_sync_timeout();
1139 etr_set_tolec_timeout(now);
1143 * Sysfs interface functions
1145 static struct sysdev_class etr_sysclass = {
1149 static struct sys_device etr_port0_dev = {
1151 .cls = &etr_sysclass,
1154 static struct sys_device etr_port1_dev = {
1156 .cls = &etr_sysclass,
1160 * ETR class attributes
1162 static ssize_t etr_stepping_port_show(struct sysdev_class *class, char *buf)
1164 return sprintf(buf, "%i\n", etr_port0.esw.p);
1167 static SYSDEV_CLASS_ATTR(stepping_port, 0400, etr_stepping_port_show, NULL);
1169 static ssize_t etr_stepping_mode_show(struct sysdev_class *class, char *buf)
1173 if (etr_mode_is_pps(etr_eacr))
1175 else if (etr_mode_is_etr(etr_eacr))
1179 return sprintf(buf, "%s\n", mode_str);
1182 static SYSDEV_CLASS_ATTR(stepping_mode, 0400, etr_stepping_mode_show, NULL);
1185 * ETR port attributes
1187 static inline struct etr_aib *etr_aib_from_dev(struct sys_device *dev)
1189 if (dev == &etr_port0_dev)
1190 return etr_port0_online ? &etr_port0 : NULL;
1192 return etr_port1_online ? &etr_port1 : NULL;
1195 static ssize_t etr_online_show(struct sys_device *dev, char *buf)
1197 unsigned int online;
1199 online = (dev == &etr_port0_dev) ? etr_port0_online : etr_port1_online;
1200 return sprintf(buf, "%i\n", online);
1203 static ssize_t etr_online_store(struct sys_device *dev,
1204 const char *buf, size_t count)
1208 value = simple_strtoul(buf, NULL, 0);
1209 if (value != 0 && value != 1)
1211 if (test_bit(ETR_FLAG_ENOSYS, &etr_flags))
1213 if (dev == &etr_port0_dev) {
1214 if (etr_port0_online == value)
1215 return count; /* Nothing to do. */
1216 etr_port0_online = value;
1217 set_bit(ETR_EVENT_PORT0_CHANGE, &etr_events);
1218 schedule_work(&etr_work);
1220 if (etr_port1_online == value)
1221 return count; /* Nothing to do. */
1222 etr_port1_online = value;
1223 set_bit(ETR_EVENT_PORT1_CHANGE, &etr_events);
1224 schedule_work(&etr_work);
1229 static SYSDEV_ATTR(online, 0600, etr_online_show, etr_online_store);
1231 static ssize_t etr_stepping_control_show(struct sys_device *dev, char *buf)
1233 return sprintf(buf, "%i\n", (dev == &etr_port0_dev) ?
1234 etr_eacr.e0 : etr_eacr.e1);
1237 static SYSDEV_ATTR(stepping_control, 0400, etr_stepping_control_show, NULL);
1239 static ssize_t etr_mode_code_show(struct sys_device *dev, char *buf)
1241 if (!etr_port0_online && !etr_port1_online)
1242 /* Status word is not uptodate if both ports are offline. */
1244 return sprintf(buf, "%i\n", (dev == &etr_port0_dev) ?
1245 etr_port0.esw.psc0 : etr_port0.esw.psc1);
1248 static SYSDEV_ATTR(state_code, 0400, etr_mode_code_show, NULL);
1250 static ssize_t etr_untuned_show(struct sys_device *dev, char *buf)
1252 struct etr_aib *aib = etr_aib_from_dev(dev);
1254 if (!aib || !aib->slsw.v1)
1256 return sprintf(buf, "%i\n", aib->edf1.u);
1259 static SYSDEV_ATTR(untuned, 0400, etr_untuned_show, NULL);
1261 static ssize_t etr_network_id_show(struct sys_device *dev, char *buf)
1263 struct etr_aib *aib = etr_aib_from_dev(dev);
1265 if (!aib || !aib->slsw.v1)
1267 return sprintf(buf, "%i\n", aib->edf1.net_id);
1270 static SYSDEV_ATTR(network, 0400, etr_network_id_show, NULL);
1272 static ssize_t etr_id_show(struct sys_device *dev, char *buf)
1274 struct etr_aib *aib = etr_aib_from_dev(dev);
1276 if (!aib || !aib->slsw.v1)
1278 return sprintf(buf, "%i\n", aib->edf1.etr_id);
1281 static SYSDEV_ATTR(id, 0400, etr_id_show, NULL);
1283 static ssize_t etr_port_number_show(struct sys_device *dev, char *buf)
1285 struct etr_aib *aib = etr_aib_from_dev(dev);
1287 if (!aib || !aib->slsw.v1)
1289 return sprintf(buf, "%i\n", aib->edf1.etr_pn);
1292 static SYSDEV_ATTR(port, 0400, etr_port_number_show, NULL);
1294 static ssize_t etr_coupled_show(struct sys_device *dev, char *buf)
1296 struct etr_aib *aib = etr_aib_from_dev(dev);
1298 if (!aib || !aib->slsw.v3)
1300 return sprintf(buf, "%i\n", aib->edf3.c);
1303 static SYSDEV_ATTR(coupled, 0400, etr_coupled_show, NULL);
1305 static ssize_t etr_local_time_show(struct sys_device *dev, char *buf)
1307 struct etr_aib *aib = etr_aib_from_dev(dev);
1309 if (!aib || !aib->slsw.v3)
1311 return sprintf(buf, "%i\n", aib->edf3.blto);
1314 static SYSDEV_ATTR(local_time, 0400, etr_local_time_show, NULL);
1316 static ssize_t etr_utc_offset_show(struct sys_device *dev, char *buf)
1318 struct etr_aib *aib = etr_aib_from_dev(dev);
1320 if (!aib || !aib->slsw.v3)
1322 return sprintf(buf, "%i\n", aib->edf3.buo);
1325 static SYSDEV_ATTR(utc_offset, 0400, etr_utc_offset_show, NULL);
1327 static struct sysdev_attribute *etr_port_attributes[] = {
1329 &attr_stepping_control,
1341 static int __init etr_register_port(struct sys_device *dev)
1343 struct sysdev_attribute **attr;
1346 rc = sysdev_register(dev);
1349 for (attr = etr_port_attributes; *attr; attr++) {
1350 rc = sysdev_create_file(dev, *attr);
1356 for (; attr >= etr_port_attributes; attr--)
1357 sysdev_remove_file(dev, *attr);
1358 sysdev_unregister(dev);
1363 static void __init etr_unregister_port(struct sys_device *dev)
1365 struct sysdev_attribute **attr;
1367 for (attr = etr_port_attributes; *attr; attr++)
1368 sysdev_remove_file(dev, *attr);
1369 sysdev_unregister(dev);
1372 static int __init etr_init_sysfs(void)
1376 rc = sysdev_class_register(&etr_sysclass);
1379 rc = sysdev_class_create_file(&etr_sysclass, &attr_stepping_port);
1381 goto out_unreg_class;
1382 rc = sysdev_class_create_file(&etr_sysclass, &attr_stepping_mode);
1384 goto out_remove_stepping_port;
1385 rc = etr_register_port(&etr_port0_dev);
1387 goto out_remove_stepping_mode;
1388 rc = etr_register_port(&etr_port1_dev);
1390 goto out_remove_port0;
1394 etr_unregister_port(&etr_port0_dev);
1395 out_remove_stepping_mode:
1396 sysdev_class_remove_file(&etr_sysclass, &attr_stepping_mode);
1397 out_remove_stepping_port:
1398 sysdev_class_remove_file(&etr_sysclass, &attr_stepping_port);
1400 sysdev_class_unregister(&etr_sysclass);
1405 device_initcall(etr_init_sysfs);