Unknown | 80 lines | 80 code | 0 blank | 0 comment | 0 complexity | b5d3d48dbc884002a7ef4c36a980ac25 MD5 | raw file
1.\" 2.\" Copyright (c) 2003 Bruce M Simpson <firstname.lastname@example.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.\" $FreeBSD$ 27.\" 28.Dd July 21, 2003 29.Dt PMAP_MAP 9 30.Os 31.Sh NAME 32.Nm pmap_map 33.Nd map a physical memory range into kernel virtual address (KVA) space 34.Sh SYNOPSIS 35.In sys/param.h 36.In vm/vm.h 37.In vm/pmap.h 38.Ft vm_offset_t 39.Fo pmap_map 40.Fa "vm_offset_t *virt" "vm_paddr_t start" "vm_paddr_t end" "int prot" 41.Fc 42.Sh DESCRIPTION 43The 44.Fn pmap_map 45function maps a range of physical addresses into kernel virtual address (KVA) 46space, from 47.Fa start 48to 49.Fa end , 50with protection bits 51.Fa prot . 52.Pp 53The value passed in 54.Fa *virt 55is treated as a hint for the virtual address of the beginning of the mapping. 56.Sh IMPLEMENTATION NOTES 57The 58.Fa prot 59argument is currently ignored by machine-dependent implementations. 60.Pp 61Architectures which can support a direct mapped physical to virtual 62region can return the appropriate address within that region, leaving 63.Fa *virt 64unchanged. 65.Sh RETURN VALUES 66The 67.Fn pmap_map 68function returns the virtual address of the beginning of the mapping, if 69the mapping was successfully made; 70.Fa *virt 71will also be updated with the first usable address after the mapped region. 72.Pp 73If the function is unsuccessful, 74.Dv NULL 75is returned. 76.Sh SEE ALSO 77.Xr pmap 9 78.Sh AUTHORS 79This manual page was written by 80.An Bruce M Simpson Aq email@example.com .