110 lines
3.4 KiB
Groff
110 lines
3.4 KiB
Groff
.\" $NetBSD: i386_get_mtrr.2,v 1.2 2001/11/10 08:10:49 wiz Exp $
|
|
.\"
|
|
.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software contributed to The NetBSD Foundation
|
|
.\" by Gregory McGarry.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the NetBSD
|
|
.\" Foundation, Inc. and its contributors.
|
|
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
|
|
.\" contributors may be used to endorse or promote products derived
|
|
.\" from this software without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
|
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.Dd November 10, 2001
|
|
.Dt I386_GET_MTRR 3 i386
|
|
.Os
|
|
.Sh NAME
|
|
.Nm i386_get_mtrr ,
|
|
.Nm i386_set_mtrr
|
|
.Nd access MTRR registers
|
|
.Sh LIBRARY
|
|
.Lb libi386
|
|
.Sh SYNOPSIS
|
|
.Fd #include <sys/types.h>
|
|
.Fd #include <machine/sysarch.h>
|
|
.Fd #include <machine/mtrr.h>
|
|
.Ft int
|
|
.Fn i386_get_mtrr "struct mtrr *mtrrp" "int *n"
|
|
.Ft int
|
|
.Fn i386_set_mtrr "struct mtrr *mtrrp" "int *n"
|
|
.Sh DESCRIPTION
|
|
These functions provide an interface to the MTRR registers found on
|
|
686-class processors.
|
|
.Pp
|
|
The argument
|
|
.Fa mtrrp
|
|
has the following structure:
|
|
.Bd -literal
|
|
struct mtrr {
|
|
uint64_t base;
|
|
uint64_t len;
|
|
uint8_t type;
|
|
int flags;
|
|
pid_t owner;
|
|
};
|
|
.Ed
|
|
.Pp
|
|
The location of the mapping is described by its base address
|
|
.Em base
|
|
and length
|
|
.Em len .
|
|
Valid values for
|
|
.Em type
|
|
are:
|
|
.Pp
|
|
.Bl -tag -offset indent -width MTRR_TYPE_UNDEF1 -compact
|
|
.It MTRR_TYPE_UC
|
|
.It MTRR_TYPE_WC
|
|
.It MTRR_TYPE_UNDEF1
|
|
.It MTRR_TYPE_UNDEF2
|
|
.It MTRR_TYPE_WT
|
|
.It MTRR_TYPE_WP
|
|
.It MTRR_TYPE_WB
|
|
.El
|
|
.Pp
|
|
Valid values for
|
|
.Em flags
|
|
are:
|
|
.Pp
|
|
.Bl -tag -offset indent -width MTRR_PRIVATE -compact
|
|
.It MTRR_PRIVATE
|
|
own range, reset at exit
|
|
.It MTRR_FIXED
|
|
use fixed range MTRR
|
|
.It MTRR_VALID
|
|
entry is valid
|
|
.El
|
|
.Pp
|
|
The
|
|
.Em owner
|
|
member the PID of the user process which claims the mapping. It is
|
|
only valid if MTRR_PRIVATE is set in
|
|
.Em flags .
|
|
.Sh RETURN VALUES
|
|
Upon successful completion zero is returned, otherwise -1 is returned
|
|
on failure.
|