xref: /openbmc/linux/arch/arm64/include/asm/memory.h (revision dea54fba)
1 /*
2  * Based on arch/arm/include/asm/memory.h
3  *
4  * Copyright (C) 2000-2002 Russell King
5  * Copyright (C) 2012 ARM Ltd.
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  *
19  * Note: this file should not be included by non-asm/.h files
20  */
21 #ifndef __ASM_MEMORY_H
22 #define __ASM_MEMORY_H
23 
24 #include <linux/compiler.h>
25 #include <linux/const.h>
26 #include <linux/types.h>
27 #include <asm/bug.h>
28 #include <asm/sizes.h>
29 
30 /*
31  * Allow for constants defined here to be used from assembly code
32  * by prepending the UL suffix only with actual C code compilation.
33  */
34 #define UL(x) _AC(x, UL)
35 
36 /*
37  * Size of the PCI I/O space. This must remain a power of two so that
38  * IO_SPACE_LIMIT acts as a mask for the low bits of I/O addresses.
39  */
40 #define PCI_IO_SIZE		SZ_16M
41 
42 /*
43  * Log2 of the upper bound of the size of a struct page. Used for sizing
44  * the vmemmap region only, does not affect actual memory footprint.
45  * We don't use sizeof(struct page) directly since taking its size here
46  * requires its definition to be available at this point in the inclusion
47  * chain, and it may not be a power of 2 in the first place.
48  */
49 #define STRUCT_PAGE_MAX_SHIFT	6
50 
51 /*
52  * VMEMMAP_SIZE - allows the whole linear region to be covered by
53  *                a struct page array
54  */
55 #define VMEMMAP_SIZE (UL(1) << (VA_BITS - PAGE_SHIFT - 1 + STRUCT_PAGE_MAX_SHIFT))
56 
57 /*
58  * PAGE_OFFSET - the virtual address of the start of the linear map (top
59  *		 (VA_BITS - 1))
60  * KIMAGE_VADDR - the virtual address of the start of the kernel image
61  * VA_BITS - the maximum number of bits for virtual addresses.
62  * VA_START - the first kernel virtual address.
63  * TASK_SIZE - the maximum size of a user space task.
64  * TASK_UNMAPPED_BASE - the lower boundary of the mmap VM area.
65  */
66 #define VA_BITS			(CONFIG_ARM64_VA_BITS)
67 #define VA_START		(UL(0xffffffffffffffff) - \
68 	(UL(1) << VA_BITS) + 1)
69 #define PAGE_OFFSET		(UL(0xffffffffffffffff) - \
70 	(UL(1) << (VA_BITS - 1)) + 1)
71 #define KIMAGE_VADDR		(MODULES_END)
72 #define MODULES_END		(MODULES_VADDR + MODULES_VSIZE)
73 #define MODULES_VADDR		(VA_START + KASAN_SHADOW_SIZE)
74 #define MODULES_VSIZE		(SZ_128M)
75 #define VMEMMAP_START		(PAGE_OFFSET - VMEMMAP_SIZE)
76 #define PCI_IO_END		(VMEMMAP_START - SZ_2M)
77 #define PCI_IO_START		(PCI_IO_END - PCI_IO_SIZE)
78 #define FIXADDR_TOP		(PCI_IO_START - SZ_2M)
79 #define TASK_SIZE_64		(UL(1) << VA_BITS)
80 
81 #ifdef CONFIG_COMPAT
82 #define TASK_SIZE_32		UL(0x100000000)
83 #define TASK_SIZE		(test_thread_flag(TIF_32BIT) ? \
84 				TASK_SIZE_32 : TASK_SIZE_64)
85 #define TASK_SIZE_OF(tsk)	(test_tsk_thread_flag(tsk, TIF_32BIT) ? \
86 				TASK_SIZE_32 : TASK_SIZE_64)
87 #else
88 #define TASK_SIZE		TASK_SIZE_64
89 #endif /* CONFIG_COMPAT */
90 
91 #define TASK_UNMAPPED_BASE	(PAGE_ALIGN(TASK_SIZE / 4))
92 
93 #define KERNEL_START      _text
94 #define KERNEL_END        _end
95 
96 /*
97  * The size of the KASAN shadow region. This should be 1/8th of the
98  * size of the entire kernel virtual address space.
99  */
100 #ifdef CONFIG_KASAN
101 #define KASAN_SHADOW_SIZE	(UL(1) << (VA_BITS - 3))
102 #else
103 #define KASAN_SHADOW_SIZE	(0)
104 #endif
105 
106 /*
107  * Memory types available.
108  */
109 #define MT_DEVICE_nGnRnE	0
110 #define MT_DEVICE_nGnRE		1
111 #define MT_DEVICE_GRE		2
112 #define MT_NORMAL_NC		3
113 #define MT_NORMAL		4
114 #define MT_NORMAL_WT		5
115 
116 /*
117  * Memory types for Stage-2 translation
118  */
119 #define MT_S2_NORMAL		0xf
120 #define MT_S2_DEVICE_nGnRE	0x1
121 
122 #ifdef CONFIG_ARM64_4K_PAGES
123 #define IOREMAP_MAX_ORDER	(PUD_SHIFT)
124 #else
125 #define IOREMAP_MAX_ORDER	(PMD_SHIFT)
126 #endif
127 
128 #ifdef CONFIG_BLK_DEV_INITRD
129 #define __early_init_dt_declare_initrd(__start, __end)			\
130 	do {								\
131 		initrd_start = (__start);				\
132 		initrd_end = (__end);					\
133 	} while (0)
134 #endif
135 
136 #ifndef __ASSEMBLY__
137 
138 #include <linux/bitops.h>
139 #include <linux/mmdebug.h>
140 
141 extern s64			memstart_addr;
142 /* PHYS_OFFSET - the physical address of the start of memory. */
143 #define PHYS_OFFSET		({ VM_BUG_ON(memstart_addr & 1); memstart_addr; })
144 
145 /* the virtual base of the kernel image (minus TEXT_OFFSET) */
146 extern u64			kimage_vaddr;
147 
148 /* the offset between the kernel virtual and physical mappings */
149 extern u64			kimage_voffset;
150 
151 static inline unsigned long kaslr_offset(void)
152 {
153 	return kimage_vaddr - KIMAGE_VADDR;
154 }
155 
156 /*
157  * Allow all memory at the discovery stage. We will clip it later.
158  */
159 #define MIN_MEMBLOCK_ADDR	0
160 #define MAX_MEMBLOCK_ADDR	U64_MAX
161 
162 /*
163  * PFNs are used to describe any physical page; this means
164  * PFN 0 == physical address 0.
165  *
166  * This is the PFN of the first RAM page in the kernel
167  * direct-mapped view.  We assume this is the first page
168  * of RAM in the mem_map as well.
169  */
170 #define PHYS_PFN_OFFSET	(PHYS_OFFSET >> PAGE_SHIFT)
171 
172 /*
173  * Physical vs virtual RAM address space conversion.  These are
174  * private definitions which should NOT be used outside memory.h
175  * files.  Use virt_to_phys/phys_to_virt/__pa/__va instead.
176  */
177 
178 
179 /*
180  * The linear kernel range starts in the middle of the virtual adddress
181  * space. Testing the top bit for the start of the region is a
182  * sufficient check.
183  */
184 #define __is_lm_address(addr)	(!!((addr) & BIT(VA_BITS - 1)))
185 
186 #define __lm_to_phys(addr)	(((addr) & ~PAGE_OFFSET) + PHYS_OFFSET)
187 #define __kimg_to_phys(addr)	((addr) - kimage_voffset)
188 
189 #define __virt_to_phys_nodebug(x) ({					\
190 	phys_addr_t __x = (phys_addr_t)(x);				\
191 	__is_lm_address(__x) ? __lm_to_phys(__x) :			\
192 			       __kimg_to_phys(__x);			\
193 })
194 
195 #define __pa_symbol_nodebug(x)	__kimg_to_phys((phys_addr_t)(x))
196 
197 #ifdef CONFIG_DEBUG_VIRTUAL
198 extern phys_addr_t __virt_to_phys(unsigned long x);
199 extern phys_addr_t __phys_addr_symbol(unsigned long x);
200 #else
201 #define __virt_to_phys(x)	__virt_to_phys_nodebug(x)
202 #define __phys_addr_symbol(x)	__pa_symbol_nodebug(x)
203 #endif
204 
205 #define __phys_to_virt(x)	((unsigned long)((x) - PHYS_OFFSET) | PAGE_OFFSET)
206 #define __phys_to_kimg(x)	((unsigned long)((x) + kimage_voffset))
207 
208 /*
209  * Convert a page to/from a physical address
210  */
211 #define page_to_phys(page)	(__pfn_to_phys(page_to_pfn(page)))
212 #define phys_to_page(phys)	(pfn_to_page(__phys_to_pfn(phys)))
213 
214 /*
215  * Note: Drivers should NOT use these.  They are the wrong
216  * translation for translating DMA addresses.  Use the driver
217  * DMA support - see dma-mapping.h.
218  */
219 #define virt_to_phys virt_to_phys
220 static inline phys_addr_t virt_to_phys(const volatile void *x)
221 {
222 	return __virt_to_phys((unsigned long)(x));
223 }
224 
225 #define phys_to_virt phys_to_virt
226 static inline void *phys_to_virt(phys_addr_t x)
227 {
228 	return (void *)(__phys_to_virt(x));
229 }
230 
231 /*
232  * Drivers should NOT use these either.
233  */
234 #define __pa(x)			__virt_to_phys((unsigned long)(x))
235 #define __pa_symbol(x)		__phys_addr_symbol(RELOC_HIDE((unsigned long)(x), 0))
236 #define __pa_nodebug(x)		__virt_to_phys_nodebug((unsigned long)(x))
237 #define __va(x)			((void *)__phys_to_virt((phys_addr_t)(x)))
238 #define pfn_to_kaddr(pfn)	__va((pfn) << PAGE_SHIFT)
239 #define virt_to_pfn(x)      __phys_to_pfn(__virt_to_phys((unsigned long)(x)))
240 #define sym_to_pfn(x)	    __phys_to_pfn(__pa_symbol(x))
241 
242 /*
243  *  virt_to_page(k)	convert a _valid_ virtual address to struct page *
244  *  virt_addr_valid(k)	indicates whether a virtual address is valid
245  */
246 #define ARCH_PFN_OFFSET		((unsigned long)PHYS_PFN_OFFSET)
247 
248 #ifndef CONFIG_SPARSEMEM_VMEMMAP
249 #define virt_to_page(kaddr)	pfn_to_page(__pa(kaddr) >> PAGE_SHIFT)
250 #define _virt_addr_valid(kaddr)	pfn_valid(__pa(kaddr) >> PAGE_SHIFT)
251 #else
252 #define __virt_to_pgoff(kaddr)	(((u64)(kaddr) & ~PAGE_OFFSET) / PAGE_SIZE * sizeof(struct page))
253 #define __page_to_voff(kaddr)	(((u64)(kaddr) & ~VMEMMAP_START) * PAGE_SIZE / sizeof(struct page))
254 
255 #define page_to_virt(page)	((void *)((__page_to_voff(page)) | PAGE_OFFSET))
256 #define virt_to_page(vaddr)	((struct page *)((__virt_to_pgoff(vaddr)) | VMEMMAP_START))
257 
258 #define _virt_addr_valid(kaddr)	pfn_valid((((u64)(kaddr) & ~PAGE_OFFSET) \
259 					   + PHYS_OFFSET) >> PAGE_SHIFT)
260 #endif
261 #endif
262 
263 #define _virt_addr_is_linear(kaddr)	(((u64)(kaddr)) >= PAGE_OFFSET)
264 #define virt_addr_valid(kaddr)		(_virt_addr_is_linear(kaddr) && \
265 					 _virt_addr_valid(kaddr))
266 
267 #include <asm-generic/memory_model.h>
268 
269 #endif
270