2 * Copyright (c) 1999 Michael Smith <msmith@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/kernel.h>
32 #include <sys/systm.h>
33 #include <sys/malloc.h>
34 #include <sys/memrange.h>
36 #include <sys/sysctl.h>
39 #include <vm/vm_param.h>
42 #include <machine/cputypes.h>
43 #include <machine/md_var.h>
44 #include <machine/specialreg.h>
47 * amd64 memory range operations
49 * This code will probably be impenetrable without reference to the
50 * Intel Pentium Pro documentation or x86-64 programmers manual vol 2.
53 static char *mem_owner_bios = "BIOS";
55 #define MR686_FIXMTRR (1<<0)
57 #define mrwithin(mr, a) \
58 (((a) >= (mr)->mr_base) && ((a) < ((mr)->mr_base + (mr)->mr_len)))
59 #define mroverlap(mra, mrb) \
60 (mrwithin(mra, mrb->mr_base) || mrwithin(mrb, mra->mr_base))
62 #define mrvalid(base, len) \
63 ((!(base & ((1 << 12) - 1))) && /* base is multiple of 4k */ \
64 ((len) >= (1 << 12)) && /* length is >= 4k */ \
65 powerof2((len)) && /* ... and power of two */ \
66 !((base) & ((len) - 1))) /* range is not discontiuous */
68 #define mrcopyflags(curr, new) \
69 (((curr) & ~MDF_ATTRMASK) | ((new) & MDF_ATTRMASK))
71 static int mtrrs_disabled;
72 TUNABLE_INT("machdep.disable_mtrrs", &mtrrs_disabled);
73 SYSCTL_INT(_machdep, OID_AUTO, disable_mtrrs, CTLFLAG_RDTUN,
74 &mtrrs_disabled, 0, "Disable amd64 MTRRs.");
76 static void amd64_mrinit(struct mem_range_softc *sc);
77 static int amd64_mrset(struct mem_range_softc *sc,
78 struct mem_range_desc *mrd, int *arg);
79 static void amd64_mrAPinit(struct mem_range_softc *sc);
80 static void amd64_mrreinit(struct mem_range_softc *sc);
82 static struct mem_range_ops amd64_mrops = {
89 /* XXX for AP startup hook */
90 static u_int64_t mtrrcap, mtrrdef;
92 /* The bitmask for the PhysBase and PhysMask fields of the variable MTRRs. */
93 static u_int64_t mtrr_physmask;
95 static struct mem_range_desc *mem_range_match(struct mem_range_softc *sc,
96 struct mem_range_desc *mrd);
97 static void amd64_mrfetch(struct mem_range_softc *sc);
98 static int amd64_mtrrtype(int flags);
99 static int amd64_mrt2mtrr(int flags, int oldval);
100 static int amd64_mtrrconflict(int flag1, int flag2);
101 static void amd64_mrstore(struct mem_range_softc *sc);
102 static void amd64_mrstoreone(void *arg);
103 static struct mem_range_desc *amd64_mtrrfixsearch(struct mem_range_softc *sc,
105 static int amd64_mrsetlow(struct mem_range_softc *sc,
106 struct mem_range_desc *mrd, int *arg);
107 static int amd64_mrsetvariable(struct mem_range_softc *sc,
108 struct mem_range_desc *mrd, int *arg);
110 /* amd64 MTRR type to memory range type conversion */
111 static int amd64_mtrrtomrt[] = {
121 #define MTRRTOMRTLEN (sizeof(amd64_mtrrtomrt) / sizeof(amd64_mtrrtomrt[0]))
124 amd64_mtrr2mrt(int val)
127 if (val < 0 || val >= MTRRTOMRTLEN)
128 return (MDF_UNKNOWN);
129 return (amd64_mtrrtomrt[val]);
133 * amd64 MTRR conflicts. Writeback and uncachable may overlap.
136 amd64_mtrrconflict(int flag1, int flag2)
139 flag1 &= MDF_ATTRMASK;
140 flag2 &= MDF_ATTRMASK;
141 if ((flag1 & MDF_UNKNOWN) || (flag2 & MDF_UNKNOWN))
143 if (flag1 == flag2 ||
144 (flag1 == MDF_WRITEBACK && flag2 == MDF_UNCACHEABLE) ||
145 (flag2 == MDF_WRITEBACK && flag1 == MDF_UNCACHEABLE))
151 * Look for an exactly-matching range.
153 static struct mem_range_desc *
154 mem_range_match(struct mem_range_softc *sc, struct mem_range_desc *mrd)
156 struct mem_range_desc *cand;
159 for (i = 0, cand = sc->mr_desc; i < sc->mr_ndesc; i++, cand++)
160 if ((cand->mr_base == mrd->mr_base) &&
161 (cand->mr_len == mrd->mr_len))
167 * Fetch the current mtrr settings from the current CPU (assumed to
168 * all be in sync in the SMP case). Note that if we are here, we
169 * assume that MTRRs are enabled, and we may or may not have fixed
173 amd64_mrfetch(struct mem_range_softc *sc)
175 struct mem_range_desc *mrd;
181 /* Get fixed-range MTRRs. */
182 if (sc->mr_cap & MR686_FIXMTRR) {
183 msr = MSR_MTRR64kBase;
184 for (i = 0; i < (MTRR_N64K / 8); i++, msr++) {
186 for (j = 0; j < 8; j++, mrd++) {
188 (mrd->mr_flags & ~MDF_ATTRMASK) |
189 amd64_mtrr2mrt(msrv & 0xff) | MDF_ACTIVE;
190 if (mrd->mr_owner[0] == 0)
191 strcpy(mrd->mr_owner, mem_owner_bios);
195 msr = MSR_MTRR16kBase;
196 for (i = 0; i < (MTRR_N16K / 8); i++, msr++) {
198 for (j = 0; j < 8; j++, mrd++) {
200 (mrd->mr_flags & ~MDF_ATTRMASK) |
201 amd64_mtrr2mrt(msrv & 0xff) | MDF_ACTIVE;
202 if (mrd->mr_owner[0] == 0)
203 strcpy(mrd->mr_owner, mem_owner_bios);
207 msr = MSR_MTRR4kBase;
208 for (i = 0; i < (MTRR_N4K / 8); i++, msr++) {
210 for (j = 0; j < 8; j++, mrd++) {
212 (mrd->mr_flags & ~MDF_ATTRMASK) |
213 amd64_mtrr2mrt(msrv & 0xff) | MDF_ACTIVE;
214 if (mrd->mr_owner[0] == 0)
215 strcpy(mrd->mr_owner, mem_owner_bios);
221 /* Get remainder which must be variable MTRRs. */
222 msr = MSR_MTRRVarBase;
223 for (; (mrd - sc->mr_desc) < sc->mr_ndesc; msr += 2, mrd++) {
225 mrd->mr_flags = (mrd->mr_flags & ~MDF_ATTRMASK) |
226 amd64_mtrr2mrt(msrv & MTRR_PHYSBASE_TYPE);
227 mrd->mr_base = msrv & mtrr_physmask;
228 msrv = rdmsr(msr + 1);
229 mrd->mr_flags = (msrv & MTRR_PHYSMASK_VALID) ?
230 (mrd->mr_flags | MDF_ACTIVE) :
231 (mrd->mr_flags & ~MDF_ACTIVE);
233 /* Compute the range from the mask. Ick. */
234 mrd->mr_len = (~(msrv & mtrr_physmask) &
235 (mtrr_physmask | 0xfffL)) + 1;
236 if (!mrvalid(mrd->mr_base, mrd->mr_len))
237 mrd->mr_flags |= MDF_BOGUS;
239 /* If unclaimed and active, must be the BIOS. */
240 if ((mrd->mr_flags & MDF_ACTIVE) && (mrd->mr_owner[0] == 0))
241 strcpy(mrd->mr_owner, mem_owner_bios);
246 * Return the MTRR memory type matching a region's flags
249 amd64_mtrrtype(int flags)
253 flags &= MDF_ATTRMASK;
255 for (i = 0; i < MTRRTOMRTLEN; i++) {
256 if (amd64_mtrrtomrt[i] == MDF_UNKNOWN)
258 if (flags == amd64_mtrrtomrt[i])
265 amd64_mrt2mtrr(int flags, int oldval)
269 if ((val = amd64_mtrrtype(flags)) == -1)
270 return (oldval & 0xff);
275 * Update running CPU(s) MTRRs to match the ranges in the descriptor
278 * XXX Must be called with interrupts enabled.
281 amd64_mrstore(struct mem_range_softc *sc)
285 * We should use ipi_all_but_self() to call other CPUs into a
286 * locking gate, then call a target function to do this work.
287 * The "proper" solution involves a generalised locking gate
288 * implementation, not ready yet.
290 smp_rendezvous(NULL, amd64_mrstoreone, NULL, sc);
292 disable_intr(); /* disable interrupts */
293 amd64_mrstoreone(sc);
299 * Update the current CPU's MTRRs with those represented in the
300 * descriptor list. Note that we do this wholesale rather than just
301 * stuffing one entry; this is simpler (but slower, of course).
304 amd64_mrstoreone(void *arg)
306 struct mem_range_softc *sc = arg;
307 struct mem_range_desc *mrd;
308 u_int64_t omsrv, msrv;
318 load_cr4(cr4 & ~CR4_PGE);
320 /* Disable caches (CD = 1, NW = 0). */
322 load_cr0((cr0 & ~CR0_NW) | CR0_CD);
324 /* Flushes caches and TLBs. */
328 /* Disable MTRRs (E = 0). */
329 wrmsr(MSR_MTRRdefType, rdmsr(MSR_MTRRdefType) & ~MTRR_DEF_ENABLE);
331 /* Set fixed-range MTRRs. */
332 if (sc->mr_cap & MR686_FIXMTRR) {
333 msr = MSR_MTRR64kBase;
334 for (i = 0; i < (MTRR_N64K / 8); i++, msr++) {
337 for (j = 7; j >= 0; j--) {
339 msrv |= amd64_mrt2mtrr((mrd + j)->mr_flags,
345 msr = MSR_MTRR16kBase;
346 for (i = 0; i < (MTRR_N16K / 8); i++, msr++) {
349 for (j = 7; j >= 0; j--) {
351 msrv |= amd64_mrt2mtrr((mrd + j)->mr_flags,
357 msr = MSR_MTRR4kBase;
358 for (i = 0; i < (MTRR_N4K / 8); i++, msr++) {
361 for (j = 7; j >= 0; j--) {
363 msrv |= amd64_mrt2mtrr((mrd + j)->mr_flags,
371 /* Set remainder which must be variable MTRRs. */
372 msr = MSR_MTRRVarBase;
373 for (; (mrd - sc->mr_desc) < sc->mr_ndesc; msr += 2, mrd++) {
374 /* base/type register */
376 if (mrd->mr_flags & MDF_ACTIVE) {
377 msrv = mrd->mr_base & mtrr_physmask;
378 msrv |= amd64_mrt2mtrr(mrd->mr_flags, omsrv);
384 /* mask/active register */
385 if (mrd->mr_flags & MDF_ACTIVE) {
386 msrv = MTRR_PHYSMASK_VALID |
387 (~(mrd->mr_len - 1) & mtrr_physmask);
391 wrmsr(msr + 1, msrv);
394 /* Flush caches and TLBs. */
399 wrmsr(MSR_MTRRdefType, rdmsr(MSR_MTRRdefType) | MTRR_DEF_ENABLE);
401 /* Restore caches and PGE. */
409 * Hunt for the fixed MTRR referencing (addr)
411 static struct mem_range_desc *
412 amd64_mtrrfixsearch(struct mem_range_softc *sc, u_int64_t addr)
414 struct mem_range_desc *mrd;
417 for (i = 0, mrd = sc->mr_desc; i < (MTRR_N64K + MTRR_N16K + MTRR_N4K);
419 if ((addr >= mrd->mr_base) &&
420 (addr < (mrd->mr_base + mrd->mr_len)))
426 * Try to satisfy the given range request by manipulating the fixed
427 * MTRRs that cover low memory.
429 * Note that we try to be generous here; we'll bloat the range out to
430 * the next higher/lower boundary to avoid the consumer having to know
431 * too much about the mechanisms here.
433 * XXX note that this will have to be updated when we start supporting
437 amd64_mrsetlow(struct mem_range_softc *sc, struct mem_range_desc *mrd, int *arg)
439 struct mem_range_desc *first_md, *last_md, *curr_md;
442 if (((first_md = amd64_mtrrfixsearch(sc, mrd->mr_base)) == NULL) ||
443 ((last_md = amd64_mtrrfixsearch(sc, mrd->mr_base + mrd->mr_len - 1)) == NULL))
446 /* Check that we aren't doing something risky. */
447 if (!(mrd->mr_flags & MDF_FORCE))
448 for (curr_md = first_md; curr_md <= last_md; curr_md++) {
449 if ((curr_md->mr_flags & MDF_ATTRMASK) == MDF_UNKNOWN)
453 /* Set flags, clear set-by-firmware flag. */
454 for (curr_md = first_md; curr_md <= last_md; curr_md++) {
455 curr_md->mr_flags = mrcopyflags(curr_md->mr_flags &
456 ~MDF_FIRMWARE, mrd->mr_flags);
457 bcopy(mrd->mr_owner, curr_md->mr_owner, sizeof(mrd->mr_owner));
464 * Modify/add a variable MTRR to satisfy the request.
466 * XXX needs to be updated to properly support "busy" ranges.
469 amd64_mrsetvariable(struct mem_range_softc *sc, struct mem_range_desc *mrd,
472 struct mem_range_desc *curr_md, *free_md;
476 * Scan the currently active variable descriptors, look for
477 * one we exactly match (straight takeover) and for possible
478 * accidental overlaps.
480 * Keep track of the first empty variable descriptor in case
481 * we can't perform a takeover.
483 i = (sc->mr_cap & MR686_FIXMTRR) ? MTRR_N64K + MTRR_N16K + MTRR_N4K : 0;
484 curr_md = sc->mr_desc + i;
486 for (; i < sc->mr_ndesc; i++, curr_md++) {
487 if (curr_md->mr_flags & MDF_ACTIVE) {
489 if ((curr_md->mr_base == mrd->mr_base) &&
490 (curr_md->mr_len == mrd->mr_len)) {
492 /* Whoops, owned by someone. */
493 if (curr_md->mr_flags & MDF_BUSY)
496 /* Check that we aren't doing something risky */
497 if (!(mrd->mr_flags & MDF_FORCE) &&
498 ((curr_md->mr_flags & MDF_ATTRMASK) ==
502 /* Ok, just hijack this entry. */
507 /* Non-exact overlap? */
508 if (mroverlap(curr_md, mrd)) {
509 /* Between conflicting region types? */
510 if (amd64_mtrrconflict(curr_md->mr_flags,
514 } else if (free_md == NULL) {
519 /* Got somewhere to put it? */
523 /* Set up new descriptor. */
524 free_md->mr_base = mrd->mr_base;
525 free_md->mr_len = mrd->mr_len;
526 free_md->mr_flags = mrcopyflags(MDF_ACTIVE, mrd->mr_flags);
527 bcopy(mrd->mr_owner, free_md->mr_owner, sizeof(mrd->mr_owner));
532 * Handle requests to set memory range attributes by manipulating MTRRs.
535 amd64_mrset(struct mem_range_softc *sc, struct mem_range_desc *mrd, int *arg)
537 struct mem_range_desc *targ;
541 case MEMRANGE_SET_UPDATE:
543 * Make sure that what's being asked for is even
546 if (!mrvalid(mrd->mr_base, mrd->mr_len) ||
547 amd64_mtrrtype(mrd->mr_flags) == -1)
550 #define FIXTOP ((MTRR_N64K * 0x10000) + (MTRR_N16K * 0x4000) + (MTRR_N4K * 0x1000))
552 /* Are the "low memory" conditions applicable? */
553 if ((sc->mr_cap & MR686_FIXMTRR) &&
554 ((mrd->mr_base + mrd->mr_len) <= FIXTOP)) {
555 if ((error = amd64_mrsetlow(sc, mrd, arg)) != 0)
558 /* It's time to play with variable MTRRs. */
559 if ((error = amd64_mrsetvariable(sc, mrd, arg)) != 0)
564 case MEMRANGE_SET_REMOVE:
565 if ((targ = mem_range_match(sc, mrd)) == NULL)
567 if (targ->mr_flags & MDF_FIXACTIVE)
569 if (targ->mr_flags & MDF_BUSY)
571 targ->mr_flags &= ~MDF_ACTIVE;
572 targ->mr_owner[0] = 0;
580 * Ensure that the direct map region does not contain any mappings
581 * that span MTRRs of different types. However, the fixed MTRRs can
582 * be ignored, because a large page mapping the first 1 MB of physical
583 * memory is a special case that the processor handles. The entire
584 * TLB will be invalidated by amd64_mrstore(), so pmap_demote_DMAP()
587 i = (sc->mr_cap & MR686_FIXMTRR) ? MTRR_N64K + MTRR_N16K + MTRR_N4K : 0;
588 mrd = sc->mr_desc + i;
589 for (; i < sc->mr_ndesc; i++, mrd++) {
590 if ((mrd->mr_flags & (MDF_ACTIVE | MDF_BOGUS)) == MDF_ACTIVE)
591 pmap_demote_DMAP(mrd->mr_base, mrd->mr_len, FALSE);
594 /* Update the hardware. */
597 /* Refetch to see where we're at. */
603 * Work out how many ranges we support, initialise storage for them,
604 * and fetch the initial settings.
607 amd64_mrinit(struct mem_range_softc *sc)
609 struct mem_range_desc *mrd;
611 int i, nmdesc = 0, pabits;
613 mtrrcap = rdmsr(MSR_MTRRcap);
614 mtrrdef = rdmsr(MSR_MTRRdefType);
616 /* For now, bail out if MTRRs are not enabled. */
617 if (!(mtrrdef & MTRR_DEF_ENABLE)) {
619 printf("CPU supports MTRRs but not enabled\n");
622 nmdesc = mtrrcap & MTRR_CAP_VCNT;
625 * Determine the size of the PhysMask and PhysBase fields in
626 * the variable range MTRRs. If the extended CPUID 0x80000008
627 * is present, use that to figure out how many physical
628 * address bits the CPU supports. Otherwise, default to 36
631 if (cpu_exthigh >= 0x80000008) {
632 do_cpuid(0x80000008, regs);
633 pabits = regs[0] & 0xff;
636 mtrr_physmask = ((1UL << pabits) - 1) & ~0xfffUL;
638 /* If fixed MTRRs supported and enabled. */
639 if ((mtrrcap & MTRR_CAP_FIXED) && (mtrrdef & MTRR_DEF_FIXED_ENABLE)) {
640 sc->mr_cap = MR686_FIXMTRR;
641 nmdesc += MTRR_N64K + MTRR_N16K + MTRR_N4K;
644 sc->mr_desc = malloc(nmdesc * sizeof(struct mem_range_desc), M_MEMDESC,
646 sc->mr_ndesc = nmdesc;
650 /* Populate the fixed MTRR entries' base/length. */
651 if (sc->mr_cap & MR686_FIXMTRR) {
652 for (i = 0; i < MTRR_N64K; i++, mrd++) {
653 mrd->mr_base = i * 0x10000;
654 mrd->mr_len = 0x10000;
655 mrd->mr_flags = MDF_FIXBASE | MDF_FIXLEN |
658 for (i = 0; i < MTRR_N16K; i++, mrd++) {
659 mrd->mr_base = i * 0x4000 + 0x80000;
660 mrd->mr_len = 0x4000;
661 mrd->mr_flags = MDF_FIXBASE | MDF_FIXLEN |
664 for (i = 0; i < MTRR_N4K; i++, mrd++) {
665 mrd->mr_base = i * 0x1000 + 0xc0000;
666 mrd->mr_len = 0x1000;
667 mrd->mr_flags = MDF_FIXBASE | MDF_FIXLEN |
673 * Get current settings, anything set now is considered to
674 * have been set by the firmware. (XXX has something already
679 for (i = 0; i < sc->mr_ndesc; i++, mrd++) {
680 if (mrd->mr_flags & MDF_ACTIVE)
681 mrd->mr_flags |= MDF_FIRMWARE;
685 * Ensure that the direct map region does not contain any mappings
686 * that span MTRRs of different types. However, the fixed MTRRs can
687 * be ignored, because a large page mapping the first 1 MB of physical
688 * memory is a special case that the processor handles. Invalidate
689 * any old TLB entries that might hold inconsistent memory type
692 i = (sc->mr_cap & MR686_FIXMTRR) ? MTRR_N64K + MTRR_N16K + MTRR_N4K : 0;
693 mrd = sc->mr_desc + i;
694 for (; i < sc->mr_ndesc; i++, mrd++) {
695 if ((mrd->mr_flags & (MDF_ACTIVE | MDF_BOGUS)) == MDF_ACTIVE)
696 pmap_demote_DMAP(mrd->mr_base, mrd->mr_len, TRUE);
701 * Initialise MTRRs on an AP after the BSP has run the init code.
704 amd64_mrAPinit(struct mem_range_softc *sc)
707 amd64_mrstoreone(sc);
708 wrmsr(MSR_MTRRdefType, mtrrdef);
712 * Re-initialise running CPU(s) MTRRs to match the ranges in the descriptor
715 * XXX Must be called with interrupts enabled.
718 amd64_mrreinit(struct mem_range_softc *sc)
722 * We should use ipi_all_but_self() to call other CPUs into a
723 * locking gate, then call a target function to do this work.
724 * The "proper" solution involves a generalised locking gate
725 * implementation, not ready yet.
727 smp_rendezvous(NULL, (void *)amd64_mrAPinit, NULL, sc);
729 disable_intr(); /* disable interrupts */
736 amd64_mem_drvinit(void *unused)
741 if (!(cpu_feature & CPUID_MTRR))
743 if ((cpu_id & 0xf00) != 0x600 && (cpu_id & 0xf00) != 0xf00)
745 switch (cpu_vendor_id) {
746 case CPU_VENDOR_INTEL:
748 case CPU_VENDOR_CENTAUR:
753 mem_range_softc.mr_op = &amd64_mrops;
755 SYSINIT(amd64memdev, SI_SUB_DRIVERS, SI_ORDER_FIRST, amd64_mem_drvinit, NULL);