xref: /freebsd-12.1/sys/arm/include/physmem.h (revision 052d3c12)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2014 Ian Lepore <[email protected]>
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	_MACHINE_PHYSMEM_H_
32 #define	_MACHINE_PHYSMEM_H_
33 
34 /*
35  * The physical address at which the kernel was loaded.
36  */
37 extern vm_paddr_t arm_physmem_kernaddr;
38 
39 /*
40  * Routines to help configure physical ram.
41  *
42  * Multiple regions of contiguous physical ram can be added (in any order).
43  *
44  * Multiple regions of physical ram that should be excluded from crash dumps, or
45  * memory allocation, or both, can be added (in any order).
46  *
47  * After all early kernel init is done and it's time to configure all
48  * remainining non-excluded physical ram for use by other parts of the kernel,
49  * arm_physmem_init_kernel_globals() processes the hardware regions and
50  * exclusion regions to generate the global dump_avail and phys_avail arrays
51  * that communicate physical ram configuration to other parts of the kernel.
52  */
53 
54 #define	EXFLAG_NODUMP	0x01
55 #define	EXFLAG_NOALLOC	0x02
56 
57 void arm_physmem_hardware_region(uint64_t pa, uint64_t sz);
58 void arm_physmem_exclude_region(vm_paddr_t pa, vm_size_t sz, uint32_t flags);
59 void arm_physmem_init_kernel_globals(void);
60 void arm_physmem_print_tables(void);
61 
62 /*
63  * Convenience routines for FDT.
64  */
65 
66 #ifdef FDT
67 
68 #include <machine/ofw_machdep.h>
69 
70 static inline void
71 arm_physmem_hardware_regions(struct mem_region * mrptr, int mrcount)
72 {
73 	while (mrcount--) {
74 		arm_physmem_hardware_region(mrptr->mr_start, mrptr->mr_size);
75 		++mrptr;
76 	}
77 }
78 
79 static inline void
80 arm_physmem_exclude_regions(struct mem_region * mrptr, int mrcount,
81     uint32_t exflags)
82 {
83 	while (mrcount--) {
84 		arm_physmem_exclude_region(mrptr->mr_start, mrptr->mr_size,
85 		    exflags);
86 		++mrptr;
87 	}
88 }
89 
90 #endif /* FDT */
91 
92 #endif
93 
94