x86: timer: Set up the timer in timer_early_get_count()
[oweals/u-boot.git] / drivers / timer / tsc_timer.c
index 6aa243723bec1a0116ac0ea182d2b34cc6a816d6..f19d2237e4f33818079592e1f27648aebd240b6e 100644 (file)
@@ -1,32 +1,88 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * Copyright (c) 2012 The Chromium OS Authors.
  *
  * TSC calibration codes are adapted from Linux kernel
  * arch/x86/kernel/tsc_msr.c and arch/x86/kernel/tsc.c
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #include <common.h>
 #include <dm.h>
 #include <malloc.h>
 #include <timer.h>
+#include <asm/cpu.h>
 #include <asm/io.h>
 #include <asm/i8254.h>
 #include <asm/ibmpc.h>
 #include <asm/msr.h>
 #include <asm/u-boot-x86.h>
 
-/* CPU reference clock frequency: in KHz */
-#define FREQ_83                83200
-#define FREQ_100       99840
-#define FREQ_133       133200
-#define FREQ_166       166400
+#define MAX_NUM_FREQS  9
 
-#define MAX_NUM_FREQS  8
+#define INTEL_FAM6_SKYLAKE_MOBILE      0x4E
+#define INTEL_FAM6_ATOM_GOLDMONT       0x5C /* Apollo Lake */
+#define INTEL_FAM6_SKYLAKE_DESKTOP     0x5E
+#define INTEL_FAM6_ATOM_GOLDMONT_X     0x5F /* Denverton */
+#define INTEL_FAM6_KABYLAKE_MOBILE     0x8E
+#define INTEL_FAM6_KABYLAKE_DESKTOP    0x9E
 
 DECLARE_GLOBAL_DATA_PTR;
 
+/*
+ * native_calibrate_tsc
+ * Determine TSC frequency via CPUID, else return 0.
+ */
+static unsigned long native_calibrate_tsc(void)
+{
+       struct cpuid_result tsc_info;
+       unsigned int crystal_freq;
+
+       if (gd->arch.x86_vendor != X86_VENDOR_INTEL)
+               return 0;
+
+       if (cpuid_eax(0) < 0x15)
+               return 0;
+
+       tsc_info = cpuid(0x15);
+
+       if (tsc_info.ebx == 0 || tsc_info.eax == 0)
+               return 0;
+
+       crystal_freq = tsc_info.ecx / 1000;
+
+       if (!crystal_freq) {
+               switch (gd->arch.x86_model) {
+               case INTEL_FAM6_SKYLAKE_MOBILE:
+               case INTEL_FAM6_SKYLAKE_DESKTOP:
+               case INTEL_FAM6_KABYLAKE_MOBILE:
+               case INTEL_FAM6_KABYLAKE_DESKTOP:
+                       crystal_freq = 24000;   /* 24.0 MHz */
+                       break;
+               case INTEL_FAM6_ATOM_GOLDMONT_X:
+                       crystal_freq = 25000;   /* 25.0 MHz */
+                       break;
+               case INTEL_FAM6_ATOM_GOLDMONT:
+                       crystal_freq = 19200;   /* 19.2 MHz */
+                       break;
+               default:
+                       return 0;
+               }
+       }
+
+       return (crystal_freq * tsc_info.ebx / tsc_info.eax) / 1000;
+}
+
+static unsigned long cpu_mhz_from_cpuid(void)
+{
+       if (gd->arch.x86_vendor != X86_VENDOR_INTEL)
+               return 0;
+
+       if (cpuid_eax(0) < 0x16)
+               return 0;
+
+       return cpuid_eax(0x16);
+}
+
 /*
  * According to Intel 64 and IA-32 System Programming Guide,
  * if MSR_PERF_STAT[31] is set, the maximum resolved bus ratio can be
@@ -45,17 +101,20 @@ struct freq_desc {
 
 static struct freq_desc freq_desc_tables[] = {
        /* PNW */
-       { 6, 0x27, 0, { 0, 0, 0, 0, 0, FREQ_100, 0, FREQ_83 } },
+       { 6, 0x27, 0, { 0, 0, 0, 0, 0, 99840, 0, 83200, 0 } },
        /* CLV+ */
-       { 6, 0x35, 0, { 0, FREQ_133, 0, 0, 0, FREQ_100, 0, FREQ_83 } },
-       /* TNG */
-       { 6, 0x4a, 1, { 0, FREQ_100, FREQ_133, 0, 0, 0, 0, 0 } },
-       /* VLV2 */
-       { 6, 0x37, 1, { FREQ_83, FREQ_100, FREQ_133, FREQ_166, 0, 0, 0, 0 } },
+       { 6, 0x35, 0, { 0, 133200, 0, 0, 0, 99840, 0, 83200, 0 } },
+       /* TNG - Intel Atom processor Z3400 series */
+       { 6, 0x4a, 1, { 0, 100000, 133300, 0, 0, 0, 0, 0, 0 } },
+       /* VLV2 - Intel Atom processor E3000, Z3600, Z3700 series */
+       { 6, 0x37, 1, { 83300, 100000, 133300, 116700, 80000, 0, 0, 0, 0 } },
+       /* ANN - Intel Atom processor Z3500 series */
+       { 6, 0x5a, 1, { 83300, 100000, 133300, 100000, 0, 0, 0, 0, 0 } },
+       /* AMT - Intel Atom processor X7-Z8000 and X5-Z8000 series */
+       { 6, 0x4c, 1, { 83300, 100000, 133300, 116700,
+                       80000, 93300, 90000, 88900, 87500 } },
        /* Ivybridge */
-       { 6, 0x3a, 2, { 0, 0, 0, 0, 0, 0, 0, 0 } },
-       /* ANN */
-       { 6, 0x5a, 1, { FREQ_83, FREQ_100, FREQ_133, FREQ_100, 0, 0, 0, 0 } },
+       { 6, 0x3a, 2, { 0, 0, 0, 0, 0, 0, 0, 0, 0 } },
 };
 
 static int match_cpu(u8 family, u8 model)
@@ -76,35 +135,40 @@ static int match_cpu(u8 family, u8 model)
        (freq_desc_tables[cpu_index].freqs[freq_id])
 
 /*
- * Do MSR calibration only for known/supported CPUs.
+ * TSC on Intel Atom SoCs capable of determining TSC frequency by MSR is
+ * reliable and the frequency is known (provided by HW).
+ *
+ * On these platforms PIT/HPET is generally not available so calibration won't
+ * work at all and there is no other clocksource to act as a watchdog for the
+ * TSC, so we have no other choice than to trust it.
  *
- * Returns the calibration value or 0 if MSR calibration failed.
+ * Returns the TSC frequency in MHz or 0 if HW does not provide it.
  */
-static unsigned long __maybe_unused try_msr_calibrate_tsc(void)
+static unsigned long __maybe_unused cpu_mhz_from_msr(void)
 {
        u32 lo, hi, ratio, freq_id, freq;
        unsigned long res;
        int cpu_index;
 
+       if (gd->arch.x86_vendor != X86_VENDOR_INTEL)
+               return 0;
+
        cpu_index = match_cpu(gd->arch.x86, gd->arch.x86_model);
        if (cpu_index < 0)
                return 0;
 
        if (freq_desc_tables[cpu_index].msr_plat) {
                rdmsr(MSR_PLATFORM_INFO, lo, hi);
-               ratio = (lo >> 8) & 0x1f;
+               ratio = (lo >> 8) & 0xff;
        } else {
                rdmsr(MSR_IA32_PERF_STATUS, lo, hi);
                ratio = (hi >> 8) & 0x1f;
        }
        debug("Maximum core-clock to bus-clock ratio: 0x%x\n", ratio);
 
-       if (!ratio)
-               goto fail;
-
        if (freq_desc_tables[cpu_index].msr_plat == 2) {
                /* TODO: Figure out how best to deal with this */
-               freq = FREQ_100;
+               freq = 100000;
                debug("Using frequency: %u KHz\n", freq);
        } else {
                /* Get FSB FREQ ID */
@@ -114,18 +178,12 @@ static unsigned long __maybe_unused try_msr_calibrate_tsc(void)
                debug("Resolved frequency ID: %u, frequency: %u KHz\n",
                      freq_id, freq);
        }
-       if (!freq)
-               goto fail;
 
        /* TSC frequency = maximum resolved freq * maximum resolved bus ratio */
        res = freq * ratio / 1000;
        debug("TSC runs at %lu MHz\n", res);
 
        return res;
-
-fail:
-       debug("Fast TSC calibration using MSR failed\n");
-       return 0;
 }
 
 /*
@@ -325,49 +383,87 @@ void __udelay(unsigned long usec)
 #endif
 }
 
-int timer_init(void)
+static int tsc_timer_get_count(struct udevice *dev, u64 *count)
 {
-#ifdef CONFIG_I8254_TIMER
-       /* Set up the i8254 timer if required */
-       i8254_init();
-#endif
+       u64 now_tick = rdtsc();
+
+       *count = now_tick - gd->arch.tsc_base;
 
        return 0;
 }
 
-static int tsc_timer_get_count(struct udevice *dev, u64 *count)
+static void tsc_timer_ensure_setup(bool early)
 {
-       u64 now_tick = rdtsc();
+       if (gd->arch.tsc_base)
+               return;
+       gd->arch.tsc_base = rdtsc();
 
-       *count = now_tick - gd->arch.tsc_base;
+       if (!gd->arch.clock_rate) {
+               unsigned long fast_calibrate;
 
-       return 0;
+               fast_calibrate = native_calibrate_tsc();
+               if (fast_calibrate)
+                       goto done;
+
+               fast_calibrate = cpu_mhz_from_cpuid();
+               if (fast_calibrate)
+                       goto done;
+
+               fast_calibrate = cpu_mhz_from_msr();
+               if (fast_calibrate)
+                       goto done;
+
+               fast_calibrate = quick_pit_calibrate();
+               if (fast_calibrate)
+                       goto done;
+
+               if (early)
+                       fast_calibrate = CONFIG_X86_TSC_TIMER_EARLY_FREQ;
+               else
+                       return;
+
+done:
+               gd->arch.clock_rate = fast_calibrate * 1000000;
+       }
 }
 
 static int tsc_timer_probe(struct udevice *dev)
 {
        struct timer_dev_priv *uc_priv = dev_get_uclass_priv(dev);
 
-       gd->arch.tsc_base = rdtsc();
+       /* Try hardware calibration first */
+       tsc_timer_ensure_setup(false);
+       if (!gd->arch.clock_rate) {
+               /*
+                * Use the clock frequency specified in the
+                * device tree as last resort
+                */
+               if (!uc_priv->clock_rate)
+                       panic("TSC frequency is ZERO");
+       } else {
+               uc_priv->clock_rate = gd->arch.clock_rate;
+       }
+
+       return 0;
+}
 
+unsigned long notrace timer_early_get_rate(void)
+{
        /*
-        * If there is no clock frequency specified in the device tree,
-        * calibrate it by ourselves.
+        * When TSC timer is used as the early timer, be warned that the timer
+        * clock rate can only be calibrated via some hardware ways. Specifying
+        * it in the device tree won't work for the early timer.
         */
-       if (!uc_priv->clock_rate) {
-               unsigned long fast_calibrate;
+       tsc_timer_ensure_setup(true);
 
-               fast_calibrate = try_msr_calibrate_tsc();
-               if (!fast_calibrate) {
-                       fast_calibrate = quick_pit_calibrate();
-                       if (!fast_calibrate)
-                               panic("TSC frequency is ZERO");
-               }
+       return gd->arch.clock_rate;
+}
 
-               uc_priv->clock_rate = fast_calibrate * 1000000;
-       }
+u64 notrace timer_early_get_count(void)
+{
+       tsc_timer_ensure_setup(true);
 
-       return 0;
+       return rdtsc() - gd->arch.tsc_base;
 }
 
 static const struct timer_ops tsc_timer_ops = {
@@ -385,5 +481,4 @@ U_BOOT_DRIVER(tsc_timer) = {
        .of_match = tsc_timer_ids,
        .probe = tsc_timer_probe,
        .ops    = &tsc_timer_ops,
-       .flags = DM_FLAG_PRE_RELOC,
 };