From owner-freebsd-doc@FreeBSD.ORG  Mon Jul 21 01:47:26 2003
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 51F0437B404
	for <freebsd-doc@FreeBSD.org>; Mon, 21 Jul 2003 01:47:26 -0700 (PDT)
Received: from hysteria.spc.org (hysteria.spc.org [195.206.69.234])
	by mx1.FreeBSD.org (Postfix) with SMTP id C7D9743F93
	for <freebsd-doc@FreeBSD.org>; Mon, 21 Jul 2003 01:47:24 -0700 (PDT)
	(envelope-from bms@hysteria.spc.org)
Received: (qmail 6662 invoked by uid 5013); 21 Jul 2003 08:45:10 -0000
Date: Mon, 21 Jul 2003 09:45:10 +0100
From: Bruce M Simpson <bms@spc.org>
To: FreeBSD-gnats-submit@FreeBSD.org, freebsd-doc@FreeBSD.org
Message-ID: <20030721084510.GR12995@spc.org>
References: <20030721083930.CF1B85CB@saboteur.dek.spc.org>
	<200307210840.h6L8eJiO049528@freefall.freebsd.org>
Mime-Version: 1.0
Content-Type: multipart/mixed; boundary="tvOENZuN7d6HfOWU"
Content-Disposition: inline
In-Reply-To: <200307210840.h6L8eJiO049528@freefall.freebsd.org>
User-Agent: Mutt/1.4.1i
Organization: SPC
Subject: Re: docs/54691: [PATCH] provide man pages for the kernel MI pmap
	subsystem
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.1
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Mon, 21 Jul 2003 08:47:26 -0000


--tvOENZuN7d6HfOWU
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline

Here's an additional last minute diff to clarify exactly
which APIs the MD pmap subsystems are expected to implement.

juli mallett also suggested implementing a 'C' arch framework
containing stubs and basic state to illustrate how a new arch might
be ported, but this is a bit far off right now. 

BMS

--tvOENZuN7d6HfOWU
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="add-api-info.diff"

--- pmap.9.orig	Mon Jul 21 08:55:35 2003
+++ pmap.9	Mon Jul 21 09:00:17 2003
@@ -48,6 +48,42 @@
 .Nm
 is responsible for managing hardware-dependent objects such as page tables,
 address maps, TLBs, et cetera.
+.Sh INTERFACE
+Machine-dependent code must implement the following APIs:
+.Pp
+.Fn pmap_activate ,
+.Fn pmap_addr_hint ,
+.Fn pmap_change_wiring ,
+.Fn pmap_clear_modify ,
+.Fn pmap_clear_reference ,
+.Fn pmap_copy ,
+.Fn pmap_copy_page ,
+.Fn pmap_enter ,
+.Fn pmap_extract ,
+.Fn pmap_growkernel ,
+.Fn pmap_init ,
+.Fn pmap_init2 ,
+.Fn pmap_is_modified ,
+.Fn pmap_map ,
+.Fn pmap_mincore ,
+.Fn pmap_object_init_pt ,
+.Fn pmap_page_exists_quick ,
+.Fn pmap_page_protect ,
+.Fn pmap_pinit ,
+.Fn pmap_pinit0 ,
+.Fn pmap_pinit2 ,
+.Fn pmap_prefault ,
+.Fn pmap_protect ,
+.Fn pmap_qenter ,
+.Fn pmap_qremove ,
+.Fn pmap_release ,
+.Fn pmap_remove ,
+.Fn pmap_remove_all ,
+.Fn pmap_remove_pages ,
+.Fn pmap_ts_modified ,
+.Fn pmap_zero_area ,
+.Fn pmap_zero_page ,
+.Fn pmap_zero_idle .
 .Pp
 Machine-dependent code must provide the header file
 .Em <machine/pmap.h> .

--tvOENZuN7d6HfOWU--