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
26 * $FreeBSD: src/sys/i386/i386/i686_mem.c,v 1.8.2.4 2002/09/24 08:12:51 mdodd Exp $
29 #include <sys/param.h>
30 #include <sys/kernel.h>
31 #include <sys/systm.h>
32 #include <sys/malloc.h>
33 #include <sys/memrange.h>
35 #include <machine/md_var.h>
36 #include <machine/specialreg.h>
39 #include <machine/smp.h>
43 * i686 memory range operations
45 * This code will probably be impenetrable without reference to the
46 * Intel Pentium Pro documentation.
49 static char *mem_owner_bios = "BIOS";
51 #define MR686_FIXMTRR (1<<0)
53 #define mrwithin(mr, a) \
54 (((a) >= (mr)->mr_base) && ((a) < ((mr)->mr_base + (mr)->mr_len)))
55 #define mroverlap(mra, mrb) \
56 (mrwithin(mra, mrb->mr_base) || mrwithin(mrb, mra->mr_base))
58 #define mrvalid(base, len) \
59 ((!(base & ((1 << 12) - 1))) && /* base is multiple of 4k */ \
60 ((len) >= (1 << 12)) && /* length is >= 4k */ \
61 powerof2((len)) && /* ... and power of two */ \
62 !((base) & ((len) - 1))) /* range is not discontiuous */
64 #define mrcopyflags(curr, new) (((curr) & ~MDF_ATTRMASK) | ((new) & MDF_ATTRMASK))
66 static void i686_mrinit(struct mem_range_softc *sc);
67 static int i686_mrset(struct mem_range_softc *sc,
68 struct mem_range_desc *mrd,
70 static void i686_mrAPinit(struct mem_range_softc *sc);
72 static struct mem_range_ops i686_mrops = {
78 /* XXX for AP startup hook */
79 static u_int64_t mtrrcap, mtrrdef;
81 static struct mem_range_desc *mem_range_match(struct mem_range_softc *sc,
82 struct mem_range_desc *mrd);
83 static void i686_mrfetch(struct mem_range_softc *sc);
84 static int i686_mtrrtype(int flags);
85 static int i686_mrt2mtrr(int flags, int oldval);
86 static int i686_mtrrconflict(int flag1, int flag2);
87 static void i686_mrstore(struct mem_range_softc *sc);
88 static void i686_mrstoreone(void *arg);
89 static struct mem_range_desc *i686_mtrrfixsearch(struct mem_range_softc *sc,
91 static int i686_mrsetlow(struct mem_range_softc *sc,
92 struct mem_range_desc *mrd,
94 static int i686_mrsetvariable(struct mem_range_softc *sc,
95 struct mem_range_desc *mrd,
98 /* i686 MTRR type to memory range type conversion */
99 static int i686_mtrrtomrt[] = {
109 #define MTRRTOMRTLEN (sizeof(i686_mtrrtomrt) / sizeof(i686_mtrrtomrt[0]))
112 i686_mtrr2mrt(int val) {
113 if (val < 0 || val >= MTRRTOMRTLEN)
115 return i686_mtrrtomrt[val];
119 * i686 MTRR conflicts. Writeback and uncachable may overlap.
122 i686_mtrrconflict(int flag1, int flag2) {
123 flag1 &= MDF_ATTRMASK;
124 flag2 &= MDF_ATTRMASK;
125 if (flag1 == flag2 ||
126 (flag1 == MDF_WRITEBACK && flag2 == MDF_UNCACHEABLE) ||
127 (flag2 == MDF_WRITEBACK && flag1 == MDF_UNCACHEABLE))
133 * Look for an exactly-matching range.
135 static struct mem_range_desc *
136 mem_range_match(struct mem_range_softc *sc, struct mem_range_desc *mrd)
138 struct mem_range_desc *cand;
141 for (i = 0, cand = sc->mr_desc; i < sc->mr_ndesc; i++, cand++)
142 if ((cand->mr_base == mrd->mr_base) &&
143 (cand->mr_len == mrd->mr_len))
149 * Fetch the current mtrr settings from the current CPU (assumed to all
150 * be in sync in the SMP case). Note that if we are here, we assume
151 * that MTRRs are enabled, and we may or may not have fixed MTRRs.
154 i686_mrfetch(struct mem_range_softc *sc)
156 struct mem_range_desc *mrd;
162 /* Get fixed-range MTRRs */
163 if (sc->mr_cap & MR686_FIXMTRR) {
164 msr = MSR_MTRR64kBase;
165 for (i = 0; i < (MTRR_N64K / 8); i++, msr++) {
167 for (j = 0; j < 8; j++, mrd++) {
168 mrd->mr_flags = (mrd->mr_flags & ~MDF_ATTRMASK) |
169 i686_mtrr2mrt(msrv & 0xff) |
171 if (mrd->mr_owner[0] == 0)
172 strcpy(mrd->mr_owner, mem_owner_bios);
176 msr = MSR_MTRR16kBase;
177 for (i = 0; i < (MTRR_N16K / 8); i++, msr++) {
179 for (j = 0; j < 8; j++, mrd++) {
180 mrd->mr_flags = (mrd->mr_flags & ~MDF_ATTRMASK) |
181 i686_mtrr2mrt(msrv & 0xff) |
183 if (mrd->mr_owner[0] == 0)
184 strcpy(mrd->mr_owner, mem_owner_bios);
188 msr = MSR_MTRR4kBase;
189 for (i = 0; i < (MTRR_N4K / 8); i++, msr++) {
191 for (j = 0; j < 8; j++, mrd++) {
192 mrd->mr_flags = (mrd->mr_flags & ~MDF_ATTRMASK) |
193 i686_mtrr2mrt(msrv & 0xff) |
195 if (mrd->mr_owner[0] == 0)
196 strcpy(mrd->mr_owner, mem_owner_bios);
202 /* Get remainder which must be variable MTRRs */
203 msr = MSR_MTRRVarBase;
204 for (; (mrd - sc->mr_desc) < sc->mr_ndesc; msr += 2, mrd++) {
206 mrd->mr_flags = (mrd->mr_flags & ~MDF_ATTRMASK) |
207 i686_mtrr2mrt(msrv & 0xff);
208 mrd->mr_base = msrv & 0x0000000ffffff000LL;
209 msrv = rdmsr(msr + 1);
210 mrd->mr_flags = (msrv & 0x800) ?
211 (mrd->mr_flags | MDF_ACTIVE) :
212 (mrd->mr_flags & ~MDF_ACTIVE);
213 /* Compute the range from the mask. Ick. */
214 mrd->mr_len = (~(msrv & 0x0000000ffffff000LL) & 0x0000000fffffffffLL) + 1;
215 if (!mrvalid(mrd->mr_base, mrd->mr_len))
216 mrd->mr_flags |= MDF_BOGUS;
217 /* If unclaimed and active, must be the BIOS */
218 if ((mrd->mr_flags & MDF_ACTIVE) && (mrd->mr_owner[0] == 0))
219 strcpy(mrd->mr_owner, mem_owner_bios);
224 * Return the MTRR memory type matching a region's flags
227 i686_mtrrtype(int flags)
231 flags &= MDF_ATTRMASK;
233 for (i = 0; i < MTRRTOMRTLEN; i++) {
234 if (i686_mtrrtomrt[i] == MDF_UNKNOWN)
236 if (flags == i686_mtrrtomrt[i])
243 i686_mrt2mtrr(int flags, int oldval)
247 if ((val = i686_mtrrtype(flags)) == -1)
248 return oldval & 0xff;
253 * Update running CPU(s) MTRRs to match the ranges in the descriptor
256 * XXX Must be called with interrupts enabled.
259 i686_mrstore(struct mem_range_softc *sc)
263 * We should use all_but_self_ipi() to call other CPUs into a
264 * locking gate, then call a target function to do this work.
265 * The "proper" solution involves a generalised locking gate
266 * implementation, not ready yet.
268 smp_rendezvous(NULL, i686_mrstoreone, NULL, (void *)sc);
270 disable_intr(); /* disable interrupts */
271 i686_mrstoreone((void *)sc);
277 * Update the current CPU's MTRRs with those represented in the
278 * descriptor list. Note that we do this wholesale rather than
279 * just stuffing one entry; this is simpler (but slower, of course).
282 i686_mrstoreone(void *arg)
284 struct mem_range_softc *sc = (struct mem_range_softc *)arg;
285 struct mem_range_desc *mrd;
286 u_int64_t omsrv, msrv;
292 cr4save = rcr4(); /* save cr4 */
293 if (cr4save & CR4_PGE)
294 load_cr4(cr4save & ~CR4_PGE);
295 load_cr0((rcr0() & ~CR0_NW) | CR0_CD); /* disable caches (CD = 1, NW = 0) */
296 wbinvd(); /* flush caches, TLBs */
297 wrmsr(MSR_MTRRdefType, rdmsr(MSR_MTRRdefType) & ~0x800); /* disable MTRRs (E = 0) */
299 /* Set fixed-range MTRRs */
300 if (sc->mr_cap & MR686_FIXMTRR) {
301 msr = MSR_MTRR64kBase;
302 for (i = 0; i < (MTRR_N64K / 8); i++, msr++) {
305 for (j = 7; j >= 0; j--) {
307 msrv |= i686_mrt2mtrr((mrd + j)->mr_flags, omsrv >> (j*8));
312 msr = MSR_MTRR16kBase;
313 for (i = 0; i < (MTRR_N16K / 8); i++, msr++) {
316 for (j = 7; j >= 0; j--) {
318 msrv |= i686_mrt2mtrr((mrd + j)->mr_flags, omsrv >> (j*8));
323 msr = MSR_MTRR4kBase;
324 for (i = 0; i < (MTRR_N4K / 8); i++, msr++) {
327 for (j = 7; j >= 0; j--) {
329 msrv |= i686_mrt2mtrr((mrd + j)->mr_flags, omsrv >> (j*8));
336 /* Set remainder which must be variable MTRRs */
337 msr = MSR_MTRRVarBase;
338 for (; (mrd - sc->mr_desc) < sc->mr_ndesc; msr += 2, mrd++) {
339 /* base/type register */
341 if (mrd->mr_flags & MDF_ACTIVE) {
342 msrv = mrd->mr_base & 0x0000000ffffff000LL;
343 msrv |= i686_mrt2mtrr(mrd->mr_flags, omsrv);
349 /* mask/active register */
350 if (mrd->mr_flags & MDF_ACTIVE) {
351 msrv = 0x800 | (~(mrd->mr_len - 1) & 0x0000000ffffff000LL);
355 wrmsr(msr + 1, msrv);
357 wbinvd(); /* flush caches, TLBs */
358 wrmsr(MSR_MTRRdefType, rdmsr(MSR_MTRRdefType) | 0x800); /* restore MTRR state */
359 load_cr0(rcr0() & ~(CR0_CD | CR0_NW)); /* enable caches CD = 0 and NW = 0 */
360 load_cr4(cr4save); /* restore cr4 */
364 * Hunt for the fixed MTRR referencing (addr)
366 static struct mem_range_desc *
367 i686_mtrrfixsearch(struct mem_range_softc *sc, u_int64_t addr)
369 struct mem_range_desc *mrd;
372 for (i = 0, mrd = sc->mr_desc; i < (MTRR_N64K + MTRR_N16K + MTRR_N4K); i++, mrd++)
373 if ((addr >= mrd->mr_base) && (addr < (mrd->mr_base + mrd->mr_len)))
379 * Try to satisfy the given range request by manipulating the fixed MTRRs that
382 * Note that we try to be generous here; we'll bloat the range out to the
383 * next higher/lower boundary to avoid the consumer having to know too much
384 * about the mechanisms here.
386 * XXX note that this will have to be updated when we start supporting "busy" ranges.
389 i686_mrsetlow(struct mem_range_softc *sc, struct mem_range_desc *mrd, int *arg)
391 struct mem_range_desc *first_md, *last_md, *curr_md;
394 if (((first_md = i686_mtrrfixsearch(sc, mrd->mr_base)) == NULL) ||
395 ((last_md = i686_mtrrfixsearch(sc, mrd->mr_base + mrd->mr_len - 1)) == NULL))
398 /* check we aren't doing something risky */
399 if (!(mrd->mr_flags & MDF_FORCE))
400 for (curr_md = first_md; curr_md <= last_md; curr_md++) {
401 if ((curr_md->mr_flags & MDF_ATTRMASK) == MDF_UNKNOWN)
405 /* set flags, clear set-by-firmware flag */
406 for (curr_md = first_md; curr_md <= last_md; curr_md++) {
407 curr_md->mr_flags = mrcopyflags(curr_md->mr_flags & ~MDF_FIRMWARE, mrd->mr_flags);
408 bcopy(mrd->mr_owner, curr_md->mr_owner, sizeof(mrd->mr_owner));
416 * Modify/add a variable MTRR to satisfy the request.
418 * XXX needs to be updated to properly support "busy" ranges.
421 i686_mrsetvariable(struct mem_range_softc *sc, struct mem_range_desc *mrd, int *arg)
423 struct mem_range_desc *curr_md, *free_md;
427 * Scan the currently active variable descriptors, look for
428 * one we exactly match (straight takeover) and for possible
429 * accidental overlaps.
430 * Keep track of the first empty variable descriptor in case we
431 * can't perform a takeover.
433 i = (sc->mr_cap & MR686_FIXMTRR) ? MTRR_N64K + MTRR_N16K + MTRR_N4K : 0;
434 curr_md = sc->mr_desc + i;
436 for (; i < sc->mr_ndesc; i++, curr_md++) {
437 if (curr_md->mr_flags & MDF_ACTIVE) {
439 if ((curr_md->mr_base == mrd->mr_base) &&
440 (curr_md->mr_len == mrd->mr_len)) {
441 /* whoops, owned by someone */
442 if (curr_md->mr_flags & MDF_BUSY)
444 /* check we aren't doing something risky */
445 if (!(mrd->mr_flags & MDF_FORCE) &&
446 ((curr_md->mr_flags & MDF_ATTRMASK) == MDF_UNKNOWN))
448 /* Ok, just hijack this entry */
452 /* non-exact overlap ? */
453 if (mroverlap(curr_md, mrd)) {
454 /* between conflicting region types? */
455 if (i686_mtrrconflict(curr_md->mr_flags, mrd->mr_flags))
458 } else if (free_md == NULL) {
462 /* got somewhere to put it? */
466 /* Set up new descriptor */
467 free_md->mr_base = mrd->mr_base;
468 free_md->mr_len = mrd->mr_len;
469 free_md->mr_flags = mrcopyflags(MDF_ACTIVE, mrd->mr_flags);
470 bcopy(mrd->mr_owner, free_md->mr_owner, sizeof(mrd->mr_owner));
475 * Handle requests to set memory range attributes by manipulating MTRRs.
479 i686_mrset(struct mem_range_softc *sc, struct mem_range_desc *mrd, int *arg)
481 struct mem_range_desc *targ;
485 case MEMRANGE_SET_UPDATE:
486 /* make sure that what's being asked for is even possible at all */
487 if (!mrvalid(mrd->mr_base, mrd->mr_len) ||
488 i686_mtrrtype(mrd->mr_flags) == -1)
491 #define FIXTOP ((MTRR_N64K * 0x10000) + (MTRR_N16K * 0x4000) + (MTRR_N4K * 0x1000))
493 /* are the "low memory" conditions applicable? */
494 if ((sc->mr_cap & MR686_FIXMTRR) &&
495 ((mrd->mr_base + mrd->mr_len) <= FIXTOP)) {
496 if ((error = i686_mrsetlow(sc, mrd, arg)) != 0)
499 /* it's time to play with variable MTRRs */
500 if ((error = i686_mrsetvariable(sc, mrd, arg)) != 0)
505 case MEMRANGE_SET_REMOVE:
506 if ((targ = mem_range_match(sc, mrd)) == NULL)
508 if (targ->mr_flags & MDF_FIXACTIVE)
510 if (targ->mr_flags & MDF_BUSY)
512 targ->mr_flags &= ~MDF_ACTIVE;
513 targ->mr_owner[0] = 0;
520 /* update the hardware */
522 i686_mrfetch(sc); /* refetch to see where we're at */
527 * Work out how many ranges we support, initialise storage for them,
528 * fetch the initial settings.
531 i686_mrinit(struct mem_range_softc *sc)
533 struct mem_range_desc *mrd;
537 mtrrcap = rdmsr(MSR_MTRRcap);
538 mtrrdef = rdmsr(MSR_MTRRdefType);
540 /* For now, bail out if MTRRs are not enabled */
541 if (!(mtrrdef & 0x800)) {
543 printf("CPU supports MTRRs but not enabled\n");
546 nmdesc = mtrrcap & 0xff;
547 printf("Pentium Pro MTRR support enabled\n");
549 /* If fixed MTRRs supported and enabled */
550 if ((mtrrcap & 0x100) && (mtrrdef & 0x400)) {
551 sc->mr_cap = MR686_FIXMTRR;
552 nmdesc += MTRR_N64K + MTRR_N16K + MTRR_N4K;
556 (struct mem_range_desc *)malloc(nmdesc * sizeof(struct mem_range_desc),
557 M_MEMDESC, M_WAITOK);
558 bzero(sc->mr_desc, nmdesc * sizeof(struct mem_range_desc));
559 sc->mr_ndesc = nmdesc;
563 /* Populate the fixed MTRR entries' base/length */
564 if (sc->mr_cap & MR686_FIXMTRR) {
565 for (i = 0; i < MTRR_N64K; i++, mrd++) {
566 mrd->mr_base = i * 0x10000;
567 mrd->mr_len = 0x10000;
568 mrd->mr_flags = MDF_FIXBASE | MDF_FIXLEN | MDF_FIXACTIVE;
570 for (i = 0; i < MTRR_N16K; i++, mrd++) {
571 mrd->mr_base = i * 0x4000 + 0x80000;
572 mrd->mr_len = 0x4000;
573 mrd->mr_flags = MDF_FIXBASE | MDF_FIXLEN | MDF_FIXACTIVE;
575 for (i = 0; i < MTRR_N4K; i++, mrd++) {
576 mrd->mr_base = i * 0x1000 + 0xc0000;
577 mrd->mr_len = 0x1000;
578 mrd->mr_flags = MDF_FIXBASE | MDF_FIXLEN | MDF_FIXACTIVE;
583 * Get current settings, anything set now is considered to have
584 * been set by the firmware. (XXX has something already played here?)
588 for (i = 0; i < sc->mr_ndesc; i++, mrd++) {
589 if (mrd->mr_flags & MDF_ACTIVE)
590 mrd->mr_flags |= MDF_FIRMWARE;
595 * Initialise MTRRs on an AP after the BSP has run the init code.
598 i686_mrAPinit(struct mem_range_softc *sc)
600 i686_mrstoreone((void *)sc); /* set MTRRs to match BSP */
601 wrmsr(MSR_MTRRdefType, mtrrdef); /* set MTRR behaviour to match BSP */
605 i686_mem_drvinit(void *unused)
607 /* Try for i686 MTRRs */
608 if ((cpu_feature & CPUID_MTRR) &&
609 ((cpu_id & 0xf00) == 0x600 || (cpu_id & 0xf00) == 0xf00) &&
610 ((strcmp(cpu_vendor, "GenuineIntel") == 0) ||
611 (strcmp(cpu_vendor, "AuthenticAMD") == 0))) {
612 mem_range_softc.mr_op = &i686_mrops;
616 SYSINIT(i686memdev,SI_SUB_DRIVERS,SI_ORDER_FIRST,i686_mem_drvinit,NULL)