Add an option to keep the ROM cached after romstage
[coreboot.git] / src / cpu / x86 / mtrr / mtrr.c
index 59f9ca1e9161c19306e76db27e36d0ec391a37ec..9015ad4d97c9dd96a99333b784e6bbea71a58593 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * intel_mtrr.c: setting MTRR to decent values for cache initialization on P6
+ * mtrr.c: setting MTRR to decent values for cache initialization on P6
  *
  * Derived from intel_set_mtrr in intel_subr.c and mtrr.c in linux kernel
  *
  *
  * Reference: Intel Architecture Software Developer's Manual, Volume 3: System Programming
  */
+
 /*
-       2005.1 yhlu add NC support to spare mtrrs for 64G memory stored
+        2005.1 yhlu add NC support to spare mtrrs for 64G memory above installed
+       2005.6 Eric add address bit in x86_setup_mtrrs
+       2005.6 yhlu split x86_setup_var_mtrrs and x86_setup_fixed_mtrrs,
+               for AMD, it will not use x86_setup_fixed_mtrrs
 */
+
 #include <stddef.h>
 #include <console/console.h>
 #include <device/device.h>
 #include <cpu/x86/msr.h>
 #include <cpu/x86/mtrr.h>
 #include <cpu/x86/cache.h>
+#include <cpu/x86/lapic.h>
+#include <arch/cpu.h>
+#include <arch/acpi.h>
 
-#warning "FIXME I do not properly handle address more than 36 physical address bits"
-
-//#define k8 0
-#define k8 1
-
-#if k8
-# define ADDRESS_BITS 40
-#else
-# define ADDRESS_BITS 36
+#if CONFIG_GFXUMA
+extern uint64_t uma_memory_base, uma_memory_size;
 #endif
-#define ADDRESS_BITS_HIGH (ADDRESS_BITS - 32)
-#define ADDRESS_MASK_HIGH ((1u << ADDRESS_BITS_HIGH) - 1)
 
 static unsigned int mtrr_msr[] = {
        MTRRfix64K_00000_MSR, MTRRfix16K_80000_MSR, MTRRfix16K_A0000_MSR,
@@ -51,8 +50,7 @@ static unsigned int mtrr_msr[] = {
        MTRRfix4K_E0000_MSR, MTRRfix4K_E8000_MSR, MTRRfix4K_F0000_MSR, MTRRfix4K_F8000_MSR,
 };
 
-
-static void enable_fixed_mtrr(void)
+void enable_fixed_mtrr(void)
 {
        msr_t msr;
 
@@ -66,48 +64,63 @@ static void enable_var_mtrr(void)
        msr_t msr;
 
        msr = rdmsr(MTRRdefType_MSR);
-       msr.lo |= 0x800;
+       msr.lo |= MTRRdefTypeEn;
        wrmsr(MTRRdefType_MSR, msr);
 }
 
 /* setting variable mtrr, comes from linux kernel source */
-static void set_var_mtrr(unsigned int reg, unsigned long basek, unsigned long sizek, unsigned char type)
+static void set_var_mtrr(
+       unsigned int reg, unsigned long basek, unsigned long sizek,
+       unsigned char type, unsigned address_bits)
 {
        msr_t base, mask;
+       unsigned address_mask_high;
+
+        if (reg >= 8)
+                return;
+
+        // it is recommended that we disable and enable cache when we
+        // do this.
+        if (sizek == 0) {
+               disable_cache();
+
+                msr_t zero;
+                zero.lo = zero.hi = 0;
+                /* The invalid bit is kept in the mask, so we simply clear the
+                   relevant mask register to disable a range. */
+                wrmsr (MTRRphysMask_MSR(reg), zero);
+
+               enable_cache();
+               return;
+        }
+
+
+       address_mask_high = ((1u << (address_bits - 32u)) - 1u);
 
        base.hi = basek >> 22;
        base.lo  = basek << 10;
 
-       //printk_debug("ADDRESS_MASK_HIGH=%#x\n", ADDRESS_MASK_HIGH);
+       printk(BIOS_SPEW, "ADDRESS_MASK_HIGH=%#x\n", address_mask_high);
 
        if (sizek < 4*1024*1024) {
-               mask.hi = ADDRESS_MASK_HIGH;
+               mask.hi = address_mask_high;
                mask.lo = ~((sizek << 10) -1);
        }
        else {
-               mask.hi = ADDRESS_MASK_HIGH & (~((sizek >> 22) -1));
+               mask.hi = address_mask_high & (~((sizek >> 22) -1));
                mask.lo = 0;
        }
 
-       if (reg >= 8)
-               return;
-
-       // it is recommended that we disable and enable cache when we 
-       // do this. 
+       // it is recommended that we disable and enable cache when we
+       // do this.
        disable_cache();
-       if (sizek == 0) {
-               msr_t zero;
-               zero.lo = zero.hi = 0;
-               /* The invalid bit is kept in the mask, so we simply clear the
-                  relevant mask register to disable a range. */
-               wrmsr (MTRRphysMask_MSR(reg), zero);
-       } else {
-               /* Bit 32-35 of MTRRphysMask should be set to 1 */
-               base.lo |= type;
-               mask.lo |= 0x800;
-               wrmsr (MTRRphysBase_MSR(reg), base);
-               wrmsr (MTRRphysMask_MSR(reg), mask);
-       }
+
+       /* Bit 32-35 of MTRRphysMask should be set to 1 */
+       base.lo |= type;
+       mask.lo |= MTRRphysMaskValid;
+       wrmsr (MTRRphysBase_MSR(reg), base);
+       wrmsr (MTRRphysMask_MSR(reg), mask);
+
        enable_cache();
 }
 
@@ -123,7 +136,7 @@ static inline unsigned int fms(unsigned int x)
        return r;
 }
 
-/* fms: find least sigificant bit set */
+/* fls: find least sigificant bit set */
 static inline unsigned int fls(unsigned int x)
 {
        int r;
@@ -157,7 +170,7 @@ static inline unsigned int fls(unsigned int x)
  *     ramsize = 156MB == 128MB WB (at 0MB) + 32MB WB (at 128MB) + 4MB UC (at 156MB)
  */
 /* 2 MTRRS are reserved for the operating system */
-#if 0
+#if 1
 #define BIOS_MTRRS 6
 #define OS_MTRRS   2
 #else
@@ -217,38 +230,59 @@ static unsigned fixed_mtrr_index(unsigned long addrk)
        return index;
 }
 
-static unsigned int range_to_mtrr(unsigned int reg, 
+static unsigned int range_to_mtrr(unsigned int reg,
        unsigned long range_startk, unsigned long range_sizek,
-       unsigned long next_range_startk, unsigned char type)
+       unsigned long next_range_startk, unsigned char type,
+       unsigned int address_bits, unsigned int above4gb)
 {
-       if (!range_sizek || (reg >= BIOS_MTRRS)) {
+       if (!range_sizek) {
+               /* If there's no MTRR hole, this function will bail out
+                * here when called for the hole.
+                */
+               printk(BIOS_SPEW, "Zero-sized MTRR range @%ldKB\n", range_startk);
+               return reg;
+       }
+
+       if (reg >= BIOS_MTRRS) {
+               printk(BIOS_ERR, "Warning: Out of MTRRs for base: %4ldMB, range: %ldMB, type %s\n",
+                               range_startk >>10, range_sizek >> 10,
+                               (type==MTRR_TYPE_UNCACHEABLE)?"UC":
+                                  ((type==MTRR_TYPE_WRBACK)?"WB":"Other") );
                return reg;
        }
+
        while(range_sizek) {
                unsigned long max_align, align;
                unsigned long sizek;
                /* Compute the maximum size I can make a range */
                max_align = fls(range_startk);
-               align = fms(range_sizek); 
+               align = fms(range_sizek);
                if (align > max_align) {
                        align = max_align;
                }
                sizek = 1 << align;
-               printk_debug("Setting variable MTRR %d, base: %4dMB, range: %4dMB, type %s\n",
-                       reg, range_startk >>10, sizek >> 10, 
-                       (type==MTRR_TYPE_UNCACHEABLE) ? "NC" :
-                           ((type==MTRR_TYPE_WRBACK) ? "WB" : "Other")
+               printk(BIOS_DEBUG, "Setting variable MTRR %d, base: %4ldMB, range: %4ldMB, type %s\n",
+                       reg, range_startk >>10, sizek >> 10,
+                       (type==MTRR_TYPE_UNCACHEABLE)?"UC":
+                           ((type==MTRR_TYPE_WRBACK)?"WB":"Other")
                        );
-               set_var_mtrr(reg++, range_startk, sizek, type);
+
+               /* if range is above 4GB, MTRR is needed
+                * only if above4gb flag is set
+                */
+               if (range_startk < 0x100000000ull / 1024 || above4gb)
+                       set_var_mtrr(reg++, range_startk, sizek, type, address_bits);
                range_startk += sizek;
                range_sizek -= sizek;
-               if (reg >= BIOS_MTRRS)
+               if (reg >= BIOS_MTRRS) {
+                       printk(BIOS_ERR, "Running out of variable MTRRs!\n");
                        break;
+               }
        }
        return reg;
 }
 
-static unsigned long resk(uint64_t value) 
+static unsigned long resk(uint64_t value)
 {
        unsigned long resultk;
        if (value < (1ULL << 42)) {
@@ -269,16 +303,22 @@ static void set_fixed_mtrr_resource(void *gp, struct device *dev, struct resourc
        if (start_mtrr >= NUM_FIXED_RANGES) {
                return;
        }
-       printk_debug("Setting fixed MTRRs(%d-%d) Type: WB\n",
+       printk(BIOS_DEBUG, "Setting fixed MTRRs(%d-%d) Type: WB\n",
                start_mtrr, last_mtrr);
        set_fixed_mtrrs(start_mtrr, last_mtrr, MTRR_TYPE_WRBACK);
-       
+
 }
 
+#ifndef CONFIG_VAR_MTRR_HOLE
+#define CONFIG_VAR_MTRR_HOLE 1
+#endif
+
 struct var_mtrr_state {
        unsigned long range_startk, range_sizek;
        unsigned int reg;
        unsigned long hole_startk, hole_sizek;
+       unsigned int address_bits;
+       unsigned int above4gb; /* Set if MTRRs are needed for DRAM above 4GB */
 };
 
 void set_var_mtrr_resource(void *gp, struct device *dev, struct resource *res)
@@ -300,50 +340,80 @@ void set_var_mtrr_resource(void *gp, struct device *dev, struct resource *res)
        }
        /* Write the range mtrrs */
        if (state->range_sizek != 0) {
-               if(state->hole_sizek == 0) {
-                       // we need to put that on to hole.
-                       unsigned long endk = basek + sizek;
+#if CONFIG_VAR_MTRR_HOLE
+               if (state->hole_sizek == 0) {
+                       /* We need to put that on to hole */
+                       unsigned long endk = basek + sizek;
                        state->hole_startk = state->range_startk + state->range_sizek;
-                       state->hole_sizek = basek - state->hole_startk;
-                       state->range_sizek = endk - state->range_startk;
+                       state->hole_sizek  = basek - state->hole_startk;
+                       state->range_sizek = endk - state->range_startk;
                        return;
                }
-               state->reg = range_to_mtrr(state->reg, state->range_startk, state->range_sizek, basek, MTRR_TYPE_WRBACK);
-               state->reg = range_to_mtrr(state->reg, state->hole_startk, state->hole_sizek, basek, MTRR_TYPE_UNCACHEABLE);
+#endif
+               state->reg = range_to_mtrr(state->reg, state->range_startk,
+                       state->range_sizek, basek, MTRR_TYPE_WRBACK,
+                       state->address_bits, state->above4gb);
+#if CONFIG_VAR_MTRR_HOLE
+               state->reg = range_to_mtrr(state->reg, state->hole_startk,
+                       state->hole_sizek, basek, MTRR_TYPE_UNCACHEABLE,
+                       state->address_bits, state->above4gb);
+#endif
                state->range_startk = 0;
                state->range_sizek = 0;
-                state->hole_startk = 0;
-                state->hole_sizek = 0;
+               state->hole_startk = 0;
+               state->hole_sizek = 0;
        }
        /* Allocate an msr */
+       printk(BIOS_SPEW, " Allocate an msr - basek = %08lx, sizek = %08lx,\n", basek, sizek);
        state->range_startk = basek;
        state->range_sizek  = sizek;
 }
 
-void x86_setup_mtrrs(void)
+void x86_setup_fixed_mtrrs(void)
+{
+        /* Try this the simple way of incrementally adding together
+         * mtrrs.  If this doesn't work out we can get smart again
+         * and clear out the mtrrs.
+         */
+
+        printk(BIOS_DEBUG, "\n");
+        /* Initialized the fixed_mtrrs to uncached */
+        printk(BIOS_DEBUG, "Setting fixed MTRRs(%d-%d) Type: UC\n",
+               0, NUM_FIXED_RANGES);
+        set_fixed_mtrrs(0, NUM_FIXED_RANGES, MTRR_TYPE_UNCACHEABLE);
+
+        /* Now see which of the fixed mtrrs cover ram.
+                 */
+        search_global_resources(
+               IORESOURCE_MEM | IORESOURCE_CACHEABLE, IORESOURCE_MEM | IORESOURCE_CACHEABLE,
+               set_fixed_mtrr_resource, NULL);
+        printk(BIOS_DEBUG, "DONE fixed MTRRs\n");
+
+        /* enable fixed MTRR */
+        printk(BIOS_SPEW, "call enable_fixed_mtrr()\n");
+        enable_fixed_mtrr();
+
+}
+
+void x86_setup_var_mtrrs(unsigned int address_bits, unsigned int above4gb)
+/* this routine needs to know how many address bits a given processor
+ * supports.  CPUs get grumpy when you set too many bits in
+ * their mtrr registers :(  I would generically call cpuid here
+ * and find out how many physically supported but some cpus are
+ * buggy, and report more bits then they actually support.
+ * If above4gb flag is set, variable MTRR ranges must be used to
+ * set cacheability of DRAM above 4GB. If above4gb flag is clear,
+ * some other mechanism is controlling cacheability of DRAM above 4GB.
+ */
 {
        /* Try this the simple way of incrementally adding together
-        * mtrrs.  If this doesn't work out we can get smart again 
+        * mtrrs.  If this doesn't work out we can get smart again
         * and clear out the mtrrs.
         */
        struct var_mtrr_state var_state;
-#if !k8
-       printk_debug("\n");
-       /* Initialized the fixed_mtrrs to uncached */
-       printk_debug("Setting fixed MTRRs(%d-%d) type: UC\n", 
-               0, NUM_FIXED_RANGES);
-       set_fixed_mtrrs(0, NUM_FIXED_RANGES, MTRR_TYPE_UNCACHEABLE);
-
-       /* Now see which of the fixed mtrrs cover ram.
-        */
-       search_global_resources(
-               IORESOURCE_MEM | IORESOURCE_CACHEABLE, IORESOURCE_MEM | IORESOURCE_CACHEABLE,
-               set_fixed_mtrr_resource, NULL);
-       printk_debug("DONE fixed MTRRs\n");
-#endif
 
        /* Cache as many memory areas as possible */
-       /* FIXME is there an algorithm for computing the optimal set of mtrrs? 
+       /* FIXME is there an algorithm for computing the optimal set of mtrrs?
         * In some cases it is definitely possible to do better.
         */
        var_state.range_startk = 0;
@@ -351,50 +421,92 @@ void x86_setup_mtrrs(void)
        var_state.hole_startk = 0;
        var_state.hole_sizek = 0;
        var_state.reg = 0;
+       var_state.address_bits = address_bits;
+       var_state.above4gb = above4gb;
+
        search_global_resources(
                IORESOURCE_MEM | IORESOURCE_CACHEABLE, IORESOURCE_MEM | IORESOURCE_CACHEABLE,
                set_var_mtrr_resource, &var_state);
 
+#if (CONFIG_GFXUMA == 1) /* UMA or SP. */
+       /* For now we assume the UMA space is at the end of memory below 4GB */
+       if (var_state.hole_startk || var_state.hole_sizek) {
+               printk(BIOS_DEBUG, "Warning: Can't set up MTRR hole for UMA due to pre-existing MTRR hole.\n");
+       } else {
+#if CONFIG_VAR_MTRR_HOLE
+               // Increase the base range and set up UMA as an UC hole instead
+               var_state.range_sizek += (uma_memory_size >> 10);
+
+               var_state.hole_startk = (uma_memory_base >> 10);
+               var_state.hole_sizek = (uma_memory_size >> 10);
+#endif
+       }
+#endif
        /* Write the last range */
-       var_state.reg = range_to_mtrr(var_state.reg, var_state.range_startk, var_state.range_sizek, 0, MTRR_TYPE_WRBACK);
-       var_state.reg = range_to_mtrr(var_state.reg, var_state.hole_startk, var_state.hole_sizek, 0, MTRR_TYPE_UNCACHEABLE);
-       printk_debug("DONE variable MTRRs\n");
-       printk_debug("Clear out the extra MTRR's\n");
+       var_state.reg = range_to_mtrr(var_state.reg, var_state.range_startk,
+               var_state.range_sizek, 0, MTRR_TYPE_WRBACK,
+               var_state.address_bits, var_state.above4gb);
+#if CONFIG_VAR_MTRR_HOLE
+       var_state.reg = range_to_mtrr(var_state.reg, var_state.hole_startk,
+               var_state.hole_sizek, 0, MTRR_TYPE_UNCACHEABLE,
+               var_state.address_bits, var_state.above4gb);
+#endif
+       printk(BIOS_DEBUG, "DONE variable MTRRs\n");
+       printk(BIOS_DEBUG, "Clear out the extra MTRR's\n");
        /* Clear out the extra MTRR's */
        while(var_state.reg < MTRRS) {
-               set_var_mtrr(var_state.reg++, 0, 0, 0);
+               set_var_mtrr(var_state.reg++, 0, 0, 0, var_state.address_bits);
        }
-       /* enable fixed MTRR */
-       printk_spew("call enable_fixed_mtrr()\n");
-       enable_fixed_mtrr();
-       printk_spew("call enable_var_mtrr()\n");
+
+#if CONFIG_CACHE_ROM
+       /* Enable Caching and speculative Reads for the
+        * complete ROM now that we actually have RAM.
+        */
+       if (boot_cpu() && (acpi_slp_type != 3)) {
+               set_var_mtrr(7, (4096-4)*1024, 4*1024,
+                       MTRR_TYPE_WRPROT, address_bits);
+       }
+#endif
+
+       printk(BIOS_SPEW, "call enable_var_mtrr()\n");
        enable_var_mtrr();
-       printk_spew("Leave %s\n", __FUNCTION__);
+       printk(BIOS_SPEW, "Leave %s\n", __func__);
        post_code(0x6A);
 }
 
+
+void x86_setup_mtrrs(void)
+{
+       int address_size;
+       x86_setup_fixed_mtrrs();
+       address_size = cpu_phys_address_size();
+       printk(BIOS_DEBUG, "CPU physical address size: %d bits\n", address_size);
+       x86_setup_var_mtrrs(address_size, 1);
+}
+
+
 int x86_mtrr_check(void)
 {
        /* Only Pentium Pro and later have MTRR */
        msr_t msr;
-       printk_debug("\nMTRR check\n");
+       printk(BIOS_DEBUG, "\nMTRR check\n");
 
        msr = rdmsr(0x2ff);
        msr.lo >>= 10;
 
-       printk_debug("Fixed MTRRs   : ");
+       printk(BIOS_DEBUG, "Fixed MTRRs   : ");
        if (msr.lo & 0x01)
-               printk_debug("Enabled\n");
+               printk(BIOS_DEBUG, "Enabled\n");
        else
-               printk_debug("Disabled\n");
+               printk(BIOS_DEBUG, "Disabled\n");
 
-       printk_debug("Variable MTRRs: ");
+       printk(BIOS_DEBUG, "Variable MTRRs: ");
        if (msr.lo & 0x02)
-               printk_debug("Enabled\n");
+               printk(BIOS_DEBUG, "Enabled\n");
        else
-               printk_debug("Disabled\n");
+               printk(BIOS_DEBUG, "Disabled\n");
 
-       printk_debug("\n");
+       printk(BIOS_DEBUG, "\n");
 
        post_code(0x93);
        return ((int) msr.lo);