1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2013 Ian Lepore <ian@freebsd.org> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef _SYS_DEVMAP_H_ 32 #define _SYS_DEVMAP_H_ 33 34 #ifndef _KERNEL 35 #error "no user-serviceable parts inside" 36 #endif 37 38 /* 39 * This structure is used by MD code to describe static mappings of devices 40 * which are established as part of bringing up the MMU early in the boot. 41 */ 42 struct devmap_entry { 43 vm_offset_t pd_va; /* virtual address */ 44 vm_paddr_t pd_pa; /* physical address */ 45 vm_size_t pd_size; /* size of region */ 46 }; 47 48 /* 49 * Return the lowest KVA address used in any entry in the registered devmap 50 * table. This works with whatever table is registered, including the internal 51 * table used by devmap_add_entry() if that routine was used. Platforms can 52 * implement platform_lastaddr() by calling this if static device mappings are 53 * their only use of high KVA space. 54 */ 55 vm_offset_t devmap_lastaddr(void); 56 57 /* 58 * Automatically allocate KVA (from the top of the address space downwards) and 59 * make static device mapping entries in an internal table. The internal table 60 * is automatically registered on the first call to this. 61 */ 62 void devmap_add_entry(vm_paddr_t pa, vm_size_t sz); 63 64 /* 65 * Register a platform-local table to be bootstrapped by the generic 66 * platform-specific init function in <ARCH>/machdep.c. This is used by newer 67 * code that allocates and fills in its own local table but does not have its 68 * own platform-specific init routine. 69 */ 70 void devmap_register_table(const struct devmap_entry * _table); 71 72 /* 73 * Establish mappings for all the entries in the table. This is called 74 * automatically from the common platform-specific init function in 75 * <ARCH>/machdep.c, and also from the custom platform-specific init routines 76 * in older code. If the table pointer is NULL, this will use the table 77 * installed previously by devmap_register_table(). 78 */ 79 void devmap_bootstrap(vm_offset_t _l1pt, 80 const struct devmap_entry *_table); 81 82 /* 83 * Translate between virtual and physical addresses within a region that is 84 * static-mapped by the devmap code. If the given address range isn't 85 * static-mapped, then ptov returns NULL and vtop returns DEVMAP_PADDR_NOTFOUND. 86 * The latter implies that you can't vtop just the last byte of physical address 87 * space. This is not as limiting as it might sound, because even if a device 88 * occupies the end of the physical address space, you're only prevented from 89 * doing vtop for that single byte. If you vtop a size bigger than 1 it works. 90 */ 91 #define DEVMAP_PADDR_NOTFOUND ((vm_paddr_t)(-1)) 92 93 void * devmap_ptov(vm_paddr_t _pa, vm_size_t _sz); 94 vm_paddr_t devmap_vtop(void * _va, vm_size_t _sz); 95 96 /* Print the static mapping table; used for bootverbose output. */ 97 void devmap_print_table(void); 98 99 #endif /* !_SYS_DEVMAP_H_ */ 100