Add and activate the man page for memcontrol(8).
Reviewed by: msmith
This commit is contained in:
parent
4a4463eee1
commit
4bac1949f4
@ -1,4 +1,6 @@
|
||||
# $FreeBSD$
|
||||
|
||||
PROG= memcontrol
|
||||
NOMAN= yes
|
||||
MAN8= memcontrol.8
|
||||
|
||||
.include <bsd.prog.mk>
|
||||
|
113
usr.sbin/memcontrol/memcontrol.8
Normal file
113
usr.sbin/memcontrol/memcontrol.8
Normal file
@ -0,0 +1,113 @@
|
||||
.\" Copyright (c) 1999 Chris Costello
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" 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.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd September 28, 1999
|
||||
.Dt MEMCONTROL 8
|
||||
.Os FreeBSD
|
||||
.Sh NAME
|
||||
.Nm memcontrol
|
||||
.Nd "Control system cache behaviour with respect to memory"
|
||||
.Sh SYNOPSIS
|
||||
.Nm
|
||||
.Ar list
|
||||
.Op Fl a
|
||||
.Pp
|
||||
.Nm
|
||||
.Ar set
|
||||
.Fl b Ar base
|
||||
.Fl l Ar length
|
||||
.Fl o Ar owner
|
||||
.Ar attribute
|
||||
.Pp
|
||||
.Nm
|
||||
.Ar clear
|
||||
.Fl o Ar owner
|
||||
.Pp
|
||||
.Nm
|
||||
.Ar clear
|
||||
.Fl b Ar base
|
||||
.Fl l Ar length
|
||||
.Sh DESCRIPTION
|
||||
A number of supported system architectures allow the behaviour of the CPU
|
||||
cache to be programmed to behave differently depending on the region being
|
||||
written.
|
||||
.Pp
|
||||
.Nm Memcontrol
|
||||
provides an interface to this facility, allowing CPU cache behavior to
|
||||
be altered for ranges of system physical memory.
|
||||
.Pp
|
||||
These ranges are typically power-of-2 aligned and sized, however the specific
|
||||
rules governing their layout vary between architectures. The
|
||||
.Nm memcontrol
|
||||
program does not attempt to enforce these rules, however the system will
|
||||
reject any attempt to set an illegal combination.
|
||||
.Bl -tag -width clear
|
||||
.It Ar list
|
||||
List range slots.
|
||||
.Bl -tag -width xxxxxx
|
||||
.It Op Fl a
|
||||
List all range slots, even those that are inactive
|
||||
.El
|
||||
.It Ar set
|
||||
Set memory range attributes.
|
||||
.Bl -tag -width xxxxxx
|
||||
.It Fl b Ar base
|
||||
Memory range base address
|
||||
.It Fl l Ar length
|
||||
Length of memory range in bytes, power of 2
|
||||
.It Fl o Ar owner
|
||||
Text identifier for this setting (7 char max)
|
||||
.It Ar attribute
|
||||
Attributes applied to this range; one of
|
||||
.Ar uncacheable ,
|
||||
.Ar write-combine ,
|
||||
.Ar write-through ,
|
||||
.Ar write-back ,
|
||||
.Ar write-protect
|
||||
.El
|
||||
.It Ar clear
|
||||
Clear memory range attributes. Ranges may be cleared by owner or by
|
||||
base/length combination.
|
||||
.Pp
|
||||
To clear based on ownership:
|
||||
.Bl -tag -width xxxxxx
|
||||
.It Fl o Ar owner
|
||||
All ranges with this owner will be cleared
|
||||
.El
|
||||
.Pp
|
||||
To clear based on the base/length combination:
|
||||
.Bl -tag -width xxxxxx
|
||||
.It Fl b Ar base
|
||||
Memory range base address
|
||||
.It Fl l Ar length
|
||||
Length of memory range in bytes, power of 2
|
||||
.El
|
||||
.Pp
|
||||
Base and length must exactly match an existing range.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr ioctl 2 ,
|
||||
.Xr mem 4
|
Loading…
Reference in New Issue
Block a user