xref: /freebsd/sys/sys/physmem.h (revision 315ee00f)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2014 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_PHYSMEM_H_
30 #define	_SYS_PHYSMEM_H_
31 
32 #ifndef _KERNEL
33 #include <stdbool.h>
34 #endif
35 
36 /*
37  * Routines to help configure physical ram.
38  *
39  * Multiple regions of contiguous physical ram can be added (in any order).
40  *
41  * Multiple regions of physical ram that should be excluded from crash dumps, or
42  * memory allocation, or both, can be added (in any order).
43  *
44  * After all early kernel init is done and it's time to configure all
45  * remainining non-excluded physical ram for use by other parts of the kernel,
46  * physmem_init_kernel_globals() processes the hardware regions and
47  * exclusion regions to generate the global dump_avail and phys_avail arrays
48  * that communicate physical ram configuration to other parts of the kernel.
49  */
50 
51 #define	EXFLAG_NODUMP	0x01
52 #define	EXFLAG_NOALLOC	0x02
53 
54 void physmem_hardware_region(uint64_t pa, uint64_t sz);
55 void physmem_exclude_region(vm_paddr_t pa, vm_size_t sz, uint32_t flags);
56 size_t physmem_avail(vm_paddr_t *avail, size_t maxavail);
57 void physmem_init_kernel_globals(void);
58 void physmem_print_tables(void);
59 bool physmem_excluded(vm_paddr_t pa, vm_size_t sz);
60 
61 /*
62  * Convenience routines for FDT.
63  */
64 
65 #ifdef FDT
66 
67 #include <machine/ofw_machdep.h>
68 
69 static inline void
70 physmem_hardware_regions(struct mem_region * mrptr, int mrcount)
71 {
72 	while (mrcount--) {
73 		physmem_hardware_region(mrptr->mr_start, mrptr->mr_size);
74 		++mrptr;
75 	}
76 }
77 
78 static inline void
79 physmem_exclude_regions(struct mem_region * mrptr, int mrcount,
80     uint32_t exflags)
81 {
82 	while (mrcount--) {
83 		physmem_exclude_region(mrptr->mr_start, mrptr->mr_size,
84 		    exflags);
85 		++mrptr;
86 	}
87 }
88 
89 #endif /* FDT */
90 
91 #endif /* !_SYS_PHYSMEM_H_ */
92