Linux-libre 4.19.123-gnu
[librecmc/linux-libre.git] / arch / arm64 / include / asm / memory.h
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/page-def.h>
29 #include <asm/sizes.h>
30
31 /*
32  * Size of the PCI I/O space. This must remain a power of two so that
33  * IO_SPACE_LIMIT acts as a mask for the low bits of I/O addresses.
34  */
35 #define PCI_IO_SIZE             SZ_16M
36
37 /*
38  * Log2 of the upper bound of the size of a struct page. Used for sizing
39  * the vmemmap region only, does not affect actual memory footprint.
40  * We don't use sizeof(struct page) directly since taking its size here
41  * requires its definition to be available at this point in the inclusion
42  * chain, and it may not be a power of 2 in the first place.
43  */
44 #define STRUCT_PAGE_MAX_SHIFT   6
45
46 /*
47  * VMEMMAP_SIZE - allows the whole linear region to be covered by
48  *                a struct page array
49  */
50 #define VMEMMAP_SIZE (UL(1) << (VA_BITS - PAGE_SHIFT - 1 + STRUCT_PAGE_MAX_SHIFT))
51
52 /*
53  * PAGE_OFFSET - the virtual address of the start of the linear map (top
54  *               (VA_BITS - 1))
55  * KIMAGE_VADDR - the virtual address of the start of the kernel image
56  * VA_BITS - the maximum number of bits for virtual addresses.
57  * VA_START - the first kernel virtual address.
58  */
59 #define VA_BITS                 (CONFIG_ARM64_VA_BITS)
60 #define VA_START                (UL(0xffffffffffffffff) - \
61         (UL(1) << VA_BITS) + 1)
62 #define PAGE_OFFSET             (UL(0xffffffffffffffff) - \
63         (UL(1) << (VA_BITS - 1)) + 1)
64 #define KIMAGE_VADDR            (MODULES_END)
65 #define MODULES_END             (MODULES_VADDR + MODULES_VSIZE)
66 #define MODULES_VADDR           (VA_START + KASAN_SHADOW_SIZE)
67 #define MODULES_VSIZE           (SZ_128M)
68 #define VMEMMAP_START           (PAGE_OFFSET - VMEMMAP_SIZE)
69 #define PCI_IO_END              (VMEMMAP_START - SZ_2M)
70 #define PCI_IO_START            (PCI_IO_END - PCI_IO_SIZE)
71 #define FIXADDR_TOP             (PCI_IO_START - SZ_2M)
72
73 #define KERNEL_START      _text
74 #define KERNEL_END        _end
75
76 /*
77  * KASAN requires 1/8th of the kernel virtual address space for the shadow
78  * region. KASAN can bloat the stack significantly, so double the (minimum)
79  * stack size when KASAN is in use, and then double it again if KASAN_EXTRA is
80  * on.
81  */
82 #ifdef CONFIG_KASAN
83 #define KASAN_SHADOW_SCALE_SHIFT 3
84 #define KASAN_SHADOW_SIZE       (UL(1) << (VA_BITS - KASAN_SHADOW_SCALE_SHIFT))
85 #ifdef CONFIG_KASAN_EXTRA
86 #define KASAN_THREAD_SHIFT      2
87 #else
88 #define KASAN_THREAD_SHIFT      1
89 #endif /* CONFIG_KASAN_EXTRA */
90 #else
91 #define KASAN_SHADOW_SIZE       (0)
92 #define KASAN_THREAD_SHIFT      0
93 #endif
94
95 #define MIN_THREAD_SHIFT        (14 + KASAN_THREAD_SHIFT)
96
97 /*
98  * VMAP'd stacks are allocated at page granularity, so we must ensure that such
99  * stacks are a multiple of page size.
100  */
101 #if defined(CONFIG_VMAP_STACK) && (MIN_THREAD_SHIFT < PAGE_SHIFT)
102 #define THREAD_SHIFT            PAGE_SHIFT
103 #else
104 #define THREAD_SHIFT            MIN_THREAD_SHIFT
105 #endif
106
107 #if THREAD_SHIFT >= PAGE_SHIFT
108 #define THREAD_SIZE_ORDER       (THREAD_SHIFT - PAGE_SHIFT)
109 #endif
110
111 #define THREAD_SIZE             (UL(1) << THREAD_SHIFT)
112
113 /*
114  * By aligning VMAP'd stacks to 2 * THREAD_SIZE, we can detect overflow by
115  * checking sp & (1 << THREAD_SHIFT), which we can do cheaply in the entry
116  * assembly.
117  */
118 #ifdef CONFIG_VMAP_STACK
119 #define THREAD_ALIGN            (2 * THREAD_SIZE)
120 #else
121 #define THREAD_ALIGN            THREAD_SIZE
122 #endif
123
124 #define IRQ_STACK_SIZE          THREAD_SIZE
125
126 #define OVERFLOW_STACK_SIZE     SZ_4K
127
128 /*
129  * Alignment of kernel segments (e.g. .text, .data).
130  */
131 #if defined(CONFIG_DEBUG_ALIGN_RODATA)
132 /*
133  *  4 KB granule:   1 level 2 entry
134  * 16 KB granule: 128 level 3 entries, with contiguous bit
135  * 64 KB granule:  32 level 3 entries, with contiguous bit
136  */
137 #define SEGMENT_ALIGN                   SZ_2M
138 #else
139 /*
140  *  4 KB granule:  16 level 3 entries, with contiguous bit
141  * 16 KB granule:   4 level 3 entries, without contiguous bit
142  * 64 KB granule:   1 level 3 entry
143  */
144 #define SEGMENT_ALIGN                   SZ_64K
145 #endif
146
147 /*
148  * Memory types available.
149  */
150 #define MT_DEVICE_nGnRnE        0
151 #define MT_DEVICE_nGnRE         1
152 #define MT_DEVICE_GRE           2
153 #define MT_NORMAL_NC            3
154 #define MT_NORMAL               4
155 #define MT_NORMAL_WT            5
156
157 /*
158  * Memory types for Stage-2 translation
159  */
160 #define MT_S2_NORMAL            0xf
161 #define MT_S2_DEVICE_nGnRE      0x1
162
163 /*
164  * Memory types for Stage-2 translation when ID_AA64MMFR2_EL1.FWB is 0001
165  * Stage-2 enforces Normal-WB and Device-nGnRE
166  */
167 #define MT_S2_FWB_NORMAL        6
168 #define MT_S2_FWB_DEVICE_nGnRE  1
169
170 #ifdef CONFIG_ARM64_4K_PAGES
171 #define IOREMAP_MAX_ORDER       (PUD_SHIFT)
172 #else
173 #define IOREMAP_MAX_ORDER       (PMD_SHIFT)
174 #endif
175
176 #ifdef CONFIG_BLK_DEV_INITRD
177 #define __early_init_dt_declare_initrd(__start, __end)                  \
178         do {                                                            \
179                 initrd_start = (__start);                               \
180                 initrd_end = (__end);                                   \
181         } while (0)
182 #endif
183
184 #ifndef __ASSEMBLY__
185
186 #include <linux/bitops.h>
187 #include <linux/mmdebug.h>
188
189 extern s64                      memstart_addr;
190 /* PHYS_OFFSET - the physical address of the start of memory. */
191 #define PHYS_OFFSET             ({ VM_BUG_ON(memstart_addr & 1); memstart_addr; })
192
193 /* the virtual base of the kernel image (minus TEXT_OFFSET) */
194 extern u64                      kimage_vaddr;
195
196 /* the offset between the kernel virtual and physical mappings */
197 extern u64                      kimage_voffset;
198
199 static inline unsigned long kaslr_offset(void)
200 {
201         return kimage_vaddr - KIMAGE_VADDR;
202 }
203
204 /*
205  * Allow all memory at the discovery stage. We will clip it later.
206  */
207 #define MIN_MEMBLOCK_ADDR       0
208 #define MAX_MEMBLOCK_ADDR       U64_MAX
209
210 /*
211  * PFNs are used to describe any physical page; this means
212  * PFN 0 == physical address 0.
213  *
214  * This is the PFN of the first RAM page in the kernel
215  * direct-mapped view.  We assume this is the first page
216  * of RAM in the mem_map as well.
217  */
218 #define PHYS_PFN_OFFSET (PHYS_OFFSET >> PAGE_SHIFT)
219
220 /*
221  * Physical vs virtual RAM address space conversion.  These are
222  * private definitions which should NOT be used outside memory.h
223  * files.  Use virt_to_phys/phys_to_virt/__pa/__va instead.
224  */
225
226
227 /*
228  * The linear kernel range starts in the middle of the virtual adddress
229  * space. Testing the top bit for the start of the region is a
230  * sufficient check.
231  */
232 #define __is_lm_address(addr)   (!!((addr) & BIT(VA_BITS - 1)))
233
234 #define __lm_to_phys(addr)      (((addr) & ~PAGE_OFFSET) + PHYS_OFFSET)
235 #define __kimg_to_phys(addr)    ((addr) - kimage_voffset)
236
237 #define __virt_to_phys_nodebug(x) ({                                    \
238         phys_addr_t __x = (phys_addr_t)(x);                             \
239         __is_lm_address(__x) ? __lm_to_phys(__x) :                      \
240                                __kimg_to_phys(__x);                     \
241 })
242
243 #define __pa_symbol_nodebug(x)  __kimg_to_phys((phys_addr_t)(x))
244
245 #ifdef CONFIG_DEBUG_VIRTUAL
246 extern phys_addr_t __virt_to_phys(unsigned long x);
247 extern phys_addr_t __phys_addr_symbol(unsigned long x);
248 #else
249 #define __virt_to_phys(x)       __virt_to_phys_nodebug(x)
250 #define __phys_addr_symbol(x)   __pa_symbol_nodebug(x)
251 #endif
252
253 #define __phys_to_virt(x)       ((unsigned long)((x) - PHYS_OFFSET) | PAGE_OFFSET)
254 #define __phys_to_kimg(x)       ((unsigned long)((x) + kimage_voffset))
255
256 /*
257  * Convert a page to/from a physical address
258  */
259 #define page_to_phys(page)      (__pfn_to_phys(page_to_pfn(page)))
260 #define phys_to_page(phys)      (pfn_to_page(__phys_to_pfn(phys)))
261
262 /*
263  * Note: Drivers should NOT use these.  They are the wrong
264  * translation for translating DMA addresses.  Use the driver
265  * DMA support - see dma-mapping.h.
266  */
267 #define virt_to_phys virt_to_phys
268 static inline phys_addr_t virt_to_phys(const volatile void *x)
269 {
270         return __virt_to_phys((unsigned long)(x));
271 }
272
273 #define phys_to_virt phys_to_virt
274 static inline void *phys_to_virt(phys_addr_t x)
275 {
276         return (void *)(__phys_to_virt(x));
277 }
278
279 /*
280  * Drivers should NOT use these either.
281  */
282 #define __pa(x)                 __virt_to_phys((unsigned long)(x))
283 #define __pa_symbol(x)          __phys_addr_symbol(RELOC_HIDE((unsigned long)(x), 0))
284 #define __pa_nodebug(x)         __virt_to_phys_nodebug((unsigned long)(x))
285 #define __va(x)                 ((void *)__phys_to_virt((phys_addr_t)(x)))
286 #define pfn_to_kaddr(pfn)       __va((pfn) << PAGE_SHIFT)
287 #define virt_to_pfn(x)      __phys_to_pfn(__virt_to_phys((unsigned long)(x)))
288 #define sym_to_pfn(x)       __phys_to_pfn(__pa_symbol(x))
289
290 /*
291  *  virt_to_page(k)     convert a _valid_ virtual address to struct page *
292  *  virt_addr_valid(k)  indicates whether a virtual address is valid
293  */
294 #define ARCH_PFN_OFFSET         ((unsigned long)PHYS_PFN_OFFSET)
295
296 #ifndef CONFIG_SPARSEMEM_VMEMMAP
297 #define virt_to_page(kaddr)     pfn_to_page(__pa(kaddr) >> PAGE_SHIFT)
298 #define _virt_addr_valid(kaddr) pfn_valid(__pa(kaddr) >> PAGE_SHIFT)
299 #else
300 #define __virt_to_pgoff(kaddr)  (((u64)(kaddr) & ~PAGE_OFFSET) / PAGE_SIZE * sizeof(struct page))
301 #define __page_to_voff(kaddr)   (((u64)(kaddr) & ~VMEMMAP_START) * PAGE_SIZE / sizeof(struct page))
302
303 #define page_to_virt(page)      ((void *)((__page_to_voff(page)) | PAGE_OFFSET))
304 #define virt_to_page(vaddr)     ((struct page *)((__virt_to_pgoff(vaddr)) | VMEMMAP_START))
305
306 #define _virt_addr_valid(kaddr) pfn_valid((((u64)(kaddr) & ~PAGE_OFFSET) \
307                                            + PHYS_OFFSET) >> PAGE_SHIFT)
308 #endif
309 #endif
310
311 #define _virt_addr_is_linear(kaddr)     (((u64)(kaddr)) >= PAGE_OFFSET)
312 #define virt_addr_valid(kaddr)          (_virt_addr_is_linear(kaddr) && \
313                                          _virt_addr_valid(kaddr))
314
315 #include <asm-generic/memory_model.h>
316
317 #endif