2 * Copyright (c) 2013 Ian Lepore <ian@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
29 #ifndef _SYS_DEVMAP_H_
30 #define _SYS_DEVMAP_H_
33 #error "no user-serviceable parts inside"
37 * This structure is used by MD code to describe static mappings of devices
38 * which are established as part of bringing up the MMU early in the boot.
41 vm_offset_t pd_va; /* virtual address */
42 vm_paddr_t pd_pa; /* physical address */
43 vm_size_t pd_size; /* size of region */
47 * Return the lowest KVA address used in any entry in the registered devmap
48 * table. This works with whatever table is registered, including the internal
49 * table used by devmap_add_entry() if that routine was used. Platforms can
50 * implement platform_lastaddr() by calling this if static device mappings are
51 * their only use of high KVA space.
53 vm_offset_t devmap_lastaddr(void);
56 * Automatically allocate KVA (from the top of the address space downwards) and
57 * make static device mapping entries in an internal table. The internal table
58 * is automatically registered on the first call to this.
60 void devmap_add_entry(vm_paddr_t pa, vm_size_t sz);
63 * Register a platform-local table to be bootstrapped by the generic
64 * initarm() in arm/machdep.c. This is used by newer code that allocates and
65 * fills in its own local table but does not have its own initarm() routine.
67 void devmap_register_table(const struct devmap_entry * _table);
70 * Establish mappings for all the entries in the table. This is called
71 * automatically from the common initarm() in arm/machdep.c, and also from the
72 * custom initarm() routines in older code. If the table pointer is NULL, this
73 * will use the table installed previously by devmap_register_table().
75 void devmap_bootstrap(vm_offset_t _l1pt,
76 const struct devmap_entry *_table);
79 * Translate between virtual and physical addresses within a region that is
80 * static-mapped by the devmap code. If the given address range isn't
81 * static-mapped, then ptov returns NULL and vtop returns DEVMAP_PADDR_NOTFOUND.
82 * The latter implies that you can't vtop just the last byte of physical address
83 * space. This is not as limiting as it might sound, because even if a device
84 * occupies the end of the physical address space, you're only prevented from
85 * doing vtop for that single byte. If you vtop a size bigger than 1 it works.
87 #define DEVMAP_PADDR_NOTFOUND ((vm_paddr_t)(-1))
89 void * devmap_ptov(vm_paddr_t _pa, vm_size_t _sz);
90 vm_paddr_t devmap_vtop(void * _va, vm_size_t _sz);
92 /* Print the static mapping table; used for bootverbose output. */
93 void devmap_print_table(void);
95 #endif /* !_SYS_DEVMAP_H_ */