1.\" 2.\" Copyright (c) 2003 Bruce M Simpson <bms@spc.org> 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 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. 13.\" 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 24.\" SUCH DAMAGE. 25.\" 26.Dd July 21, 2003 27.Dt PMAP_MAP 9 28.Os 29.Sh NAME 30.Nm pmap_map 31.Nd map a physical memory range into kernel virtual address (KVA) space 32.Sh SYNOPSIS 33.In sys/param.h 34.In vm/vm.h 35.In vm/pmap.h 36.Ft vm_offset_t 37.Fo pmap_map 38.Fa "vm_offset_t *virt" "vm_paddr_t start" "vm_paddr_t end" "int prot" 39.Fc 40.Sh DESCRIPTION 41The 42.Fn pmap_map 43function maps a range of physical addresses into kernel virtual address (KVA) 44space, from 45.Fa start 46to 47.Fa end , 48with protection bits 49.Fa prot . 50.Pp 51The value passed in 52.Fa *virt 53is treated as a hint for the virtual address of the beginning of the mapping. 54.Sh IMPLEMENTATION NOTES 55The 56.Fa prot 57argument is currently ignored by machine-dependent implementations. 58.Pp 59Architectures which can support a direct mapped physical to virtual 60region can return the appropriate address within that region, leaving 61.Fa *virt 62unchanged. 63.Sh RETURN VALUES 64The 65.Fn pmap_map 66function returns the virtual address of the beginning of the mapping, if 67the mapping was successfully made; 68.Fa *virt 69will also be updated with the first usable address after the mapped region. 70.Pp 71If the function is unsuccessful, 72.Dv NULL 73is returned. 74.Sh SEE ALSO 75.Xr pmap 9 76.Sh AUTHORS 77This manual page was written by 78.An Bruce M Simpson Aq Mt bms@spc.org . 79