diff --git a/share/man/man9/pmap_kextract.9 b/share/man/man9/pmap_kextract.9 index dd73446648f2..40008a1bc96c 100644 --- a/share/man/man9/pmap_kextract.9 +++ b/share/man/man9/pmap_kextract.9 @@ -1,65 +1,65 @@ .\" .\" SPDX-License-Identifier: BSD-2-Clause .\" .\" Copyright (c) 2023 The FreeBSD Foundation .\" .\" This manual page was written by Mina Galić under .\" sponsorship from the FreeBSD Foundation. .\" -.Dd August 24, 2023 +.Dd October 16, 2023 .Dt PMAP_KEXTRACT 9 .Os .Sh NAME .Nm pmap_kextract , .Nm vtophys .Nd extract a physical address from the kernel page table .Sh SYNOPSIS .In sys/param.h .In vm/vm.h .In vm/pmap.h .Ft vm_paddr_t .Fo pmap_kextract .Fa "vm_offset_t va" .Fc .Ft vm_paddr_t .Fo vtophys .Fa "vm_offset_t va" .Fc .Sh DESCRIPTION The .Fn pmap_kextract -function retrieves the underlying physical memory address corresponding to the given kernel virtual address +function retrieves the underlying physical memory address corresponding to the +given kernel virtual address .Fa va . The value of .Fa va -must correlate to an active mapping in the kernel address space. +must belong to a valid mapping in the kernel address space. .Pp .Fn vtophys is an alias for .Fn pmap_kextract and behaves identically. .Sh RETURN VALUES The .Fn pmap_kextract -function will return the physical address -.Pq Vt vm_paddr_t -associated with the kernel virtual address +function returns the address of physical memory mapped at the kernel +virtual address .Fa va . .Pp .Fn pmap_kextract generally does not fail. However, if supplied with an illegitimate value for .Fa va , the function may return zero, an invalid non-zero value, or call .Xr panic 9 . .Sh SEE ALSO .Xr pmap 9 , .Xr pmap_extract 9 .Sh AUTHORS .An -nosplit This manual page was written by .An Mina Galić Aq Mt FreeBSD@igalic.co , based on the .Xr pmap_extract 9 page written by .An Bruce M Simpson Aq Mt bms@spc.org .