devmap.h revision 259365
1201468Srpaulo/*- 2201468Srpaulo * Copyright (c) 2013 Ian Lepore <ian@freebsd.org> 3201468Srpaulo * All rights reserved. 4201468Srpaulo * 5201468Srpaulo * Redistribution and use in source and binary forms, with or without 6201468Srpaulo * modification, are permitted provided that the following conditions 7201468Srpaulo * are met: 8201468Srpaulo * 1. Redistributions of source code must retain the above copyright 9201468Srpaulo * notice, this list of conditions and the following disclaimer. 10201468Srpaulo * 2. Redistributions in binary form must reproduce the above copyright 11201468Srpaulo * notice, this list of conditions and the following disclaimer in the 12201468Srpaulo * documentation and/or other materials provided with the distribution. 13201468Srpaulo * 14201468Srpaulo * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15201468Srpaulo * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16201468Srpaulo * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17201468Srpaulo * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18201468Srpaulo * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19201468Srpaulo * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20201468Srpaulo * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21201468Srpaulo * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22201468Srpaulo * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23201468Srpaulo * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24201468Srpaulo * SUCH DAMAGE. 25201468Srpaulo * 26201468Srpaulo * $FreeBSD: stable/10/sys/arm/include/devmap.h 259365 2013-12-14 00:16:08Z ian $ 27201468Srpaulo */ 28201468Srpaulo 29201468Srpaulo#ifndef _MACHINE_DEVMAP_H_ 30201468Srpaulo#define _MACHINE_DEVMAP_H_ 31201468Srpaulo 32201468Srpaulo/* 33201468Srpaulo * This structure is used by MD code to describe static mappings of devices 34201468Srpaulo * which are established as part of bringing up the MMU early in the boot. 35201468Srpaulo */ 36201468Srpaulostruct arm_devmap_entry { 37201468Srpaulo vm_offset_t pd_va; /* virtual address */ 38201468Srpaulo vm_paddr_t pd_pa; /* physical address */ 39201468Srpaulo vm_size_t pd_size; /* size of region */ 40201468Srpaulo vm_prot_t pd_prot; /* protection code */ 41201468Srpaulo int pd_cache; /* cache attributes */ 42201468Srpaulo}; 43201468Srpaulo 44201468Srpaulo/* 45201468Srpaulo * Return the lowest KVA address used in any entry in the registered devmap 46264219Srpaulo * table. This works with whatever table is registered, including the internal 47264219Srpaulo * table used by arm_devmap_add_entry() if that routine was used. Platforms can 48201468Srpaulo * implement initarm_lastaddr() by calling this if static device mappings are 49201468Srpaulo * their only use of high KVA space. 50201468Srpaulo */ 51201468Srpaulovm_offset_t arm_devmap_lastaddr(void); 52201468Srpaulo 53201468Srpaulo/* 54201468Srpaulo * Automatically allocate KVA (from the top of the address space downwards) and 55201468Srpaulo * make static device mapping entries in an internal table. The internal table 56201468Srpaulo * is automatically registered on the first call to this. 57201468Srpaulo */ 58201468Srpaulovoid arm_devmap_add_entry(vm_paddr_t pa, vm_size_t sz); 59201468Srpaulo 60201468Srpaulo/* 61201468Srpaulo * Register a platform-local table to be bootstrapped by the generic 62201468Srpaulo * initarm() in arm/machdep.c. This is used by newer code that allocates and 63201468Srpaulo * fills in its own local table but does not have its own initarm() routine. 64201468Srpaulo */ 65201468Srpaulovoid arm_devmap_register_table(const struct arm_devmap_entry * _table); 66201468Srpaulo 67201468Srpaulo/* 68201468Srpaulo * Establish mappings for all the entries in the table. This is called 69201468Srpaulo * automatically from the common initarm() in arm/machdep.c, and also from the 70201468Srpaulo * custom initarm() routines in older code. If the table pointer is NULL, this 71201468Srpaulo * will use the table installed previously by arm_devmap_register_table(). 72201468Srpaulo */ 73201468Srpaulovoid arm_devmap_bootstrap(vm_offset_t _l1pt, 74201468Srpaulo const struct arm_devmap_entry *_table); 75201468Srpaulo 76201468Srpaulo/* 77201468Srpaulo * Translate between virtual and physical addresses within a region that is 78201468Srpaulo * static-mapped by the devmap code. If the given address range isn't 79201468Srpaulo * static-mapped, then ptov returns NULL and vtop returns DEVMAP_PADDR_NOTFOUND. 80201468Srpaulo * The latter implies that you can't vtop just the last byte of physical address 81201468Srpaulo * space. This is not as limiting as it might sound, because even if a device 82201468Srpaulo * occupies the end of the physical address space, you're only prevented from 83201468Srpaulo * doing vtop for that single byte. If you vtop a size bigger than 1 it works. 84201468Srpaulo */ 85#define DEVMAP_PADDR_NOTFOUND ((vm_paddr_t)(-1)) 86 87void * arm_devmap_ptov(vm_paddr_t _pa, vm_size_t _sz); 88vm_paddr_t arm_devmap_vtop(void * _va, vm_size_t _sz); 89 90#endif 91