pmap_map (9)

Leading comments

Copyright (c) 2003 Bruce M Simpson <bms@spc.org>
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
   documenta...

(The comments found at the beginning of the groff file "man9/pmap_map.9freebsd".)

NAME

pmap_map - map a physical memory range into kernel virtual address (KVA) space

SYNOPSIS

In sys/param.h In vm/vm.h In vm/pmap.h Ft vm_offset_t Fo pmap_map Fa vm_offset_t *virt vm_paddr_t start vm_paddr_t end int prot Fc

DESCRIPTION

The Fn pmap_map function maps a range of physical addresses into kernel virtual address (KVA) space, from Fa start to Fa end , with protection bits Fa prot .

The value passed in Fa *virt is treated as a hint for the virtual address of the beginning of the mapping.

IMPLEMENTATION NOTES

The Fa prot argument is currently ignored by machine-dependent implementations.

Architectures which can support a direct mapped physical to virtual region can return the appropriate address within that region, leaving Fa *virt unchanged.

RETURN VALUES

The Fn pmap_map function returns the virtual address of the beginning of the mapping, if the mapping was successfully made; Fa *virt will also be updated with the first usable address after the mapped region.

If the function is unsuccessful, NULL is returned.

SEE ALSO

pmap(9)

AUTHORS

This manual page was written by An Bruce M Simpson Aq bms@spc.org .