1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
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
29#ifndef _SYS_DEVMAP_H_
30#define _SYS_DEVMAP_H_
31
32#ifndef _KERNEL
33#error "no user-serviceable parts inside"
34#endif
35
36#ifdef __HAVE_STATIC_DEVMAP
37/*
38 * This structure is used by MD code to describe static mappings of devices
39 * which are established as part of bringing up the MMU early in the boot.
40 */
41struct devmap_entry {
42 vm_offset_t pd_va; /* virtual address */
43 vm_paddr_t pd_pa; /* physical address */
44 vm_size_t pd_size; /* size of region */
45};
46
47/*
48 * Return the lowest KVA address used in any entry in the registered devmap
49 * table. This works with whatever table is registered, including the internal
50 * table used by devmap_add_entry() if that routine was used. Platforms can
51 * implement platform_lastaddr() by calling this if static device mappings are
52 * their only use of high KVA space.
53 */
54vm_offset_t devmap_lastaddr(void);
55
56/*
57 * Automatically allocate KVA (from the top of the address space downwards) and
58 * make static device mapping entries in an internal table. The internal table
59 * is automatically registered on the first call to this.
60 */
61void devmap_add_entry(vm_paddr_t pa, vm_size_t sz);
62
63/*
64 * Register a platform-local table to be bootstrapped by the generic
65 * platform-specific init function in <ARCH>/machdep.c. This is used by newer
66 * code that allocates and fills in its own local table but does not have its
67 * own platform-specific init routine.
68 */
69void devmap_register_table(const struct devmap_entry * _table);
70
71/*
72 * Establish mappings for all the entries in the table. This is called
73 * automatically from the common platform-specific init function in
74 * <ARCH>/machdep.c, and also from the custom platform-specific init routines
75 * in older code. This function only has an effect when a table was installed
76 * previously by devmap_register_table().
77 */
78void devmap_bootstrap(void);
79
80/* Print the static mapping table; used for bootverbose output. */
81void devmap_print_table(void);
82#endif
83
84#endif /* !_SYS_DEVMAP_H_ */