1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * arch/arm/include/asm/memory.h
4 *
5 * Copyright (C) 2000-2002 Russell King
6 * modification for nommu, Hyok S. Choi, 2004
7 *
8 * Note: this file should not be included by non-asm/.h files
9 */
10 #ifndef __ASM_ARM_MEMORY_H
11 #define __ASM_ARM_MEMORY_H
12
13 #include <linux/compiler.h>
14 #include <linux/const.h>
15 #include <linux/types.h>
16 #include <linux/sizes.h>
17
18 #ifdef CONFIG_NEED_MACH_MEMORY_H
19 #include <mach/memory.h>
20 #endif
21
22 /* PAGE_OFFSET - the virtual address of the start of the kernel image */
23 #define PAGE_OFFSET UL(CONFIG_PAGE_OFFSET)
24
25 #ifdef CONFIG_MMU
26
27 /*
28 * TASK_SIZE - the maximum size of a user space task.
29 * TASK_UNMAPPED_BASE - the lower boundary of the mmap VM area
30 */
31 #define TASK_SIZE (UL(CONFIG_PAGE_OFFSET) - UL(SZ_16M))
32 #define TASK_UNMAPPED_BASE ALIGN(TASK_SIZE / 3, SZ_16M)
33
34 /*
35 * The maximum size of a 26-bit user space task.
36 */
37 #define TASK_SIZE_26 (UL(1) << 26)
38
39 /*
40 * The module space lives between the addresses given by TASK_SIZE
41 * and PAGE_OFFSET - it must be within 32MB of the kernel text.
42 */
43 #ifndef CONFIG_THUMB2_KERNEL
44 #define MODULES_VADDR (PAGE_OFFSET - SZ_16M)
45 #else
46 /* smaller range for Thumb-2 symbols relocation (2^24)*/
47 #define MODULES_VADDR (PAGE_OFFSET - SZ_8M)
48 #endif
49
50 #if TASK_SIZE > MODULES_VADDR
51 #error Top of user space clashes with start of module space
52 #endif
53
54 /*
55 * The highmem pkmap virtual space shares the end of the module area.
56 */
57 #ifdef CONFIG_HIGHMEM
58 #define MODULES_END (PAGE_OFFSET - PMD_SIZE)
59 #else
60 #define MODULES_END (PAGE_OFFSET)
61 #endif
62
63 /*
64 * The XIP kernel gets mapped at the bottom of the module vm area.
65 * Since we use sections to map it, this macro replaces the physical address
66 * with its virtual address while keeping offset from the base section.
67 */
68 #define XIP_VIRT_ADDR(physaddr) (MODULES_VADDR + ((physaddr) & 0x000fffff))
69
70 #define FDT_FIXED_BASE UL(0xff800000)
71 #define FDT_FIXED_SIZE (2 * SECTION_SIZE)
72 #define FDT_VIRT_BASE(physbase) ((void *)(FDT_FIXED_BASE | (physbase) % SECTION_SIZE))
73
74 #if !defined(CONFIG_SMP) && !defined(CONFIG_ARM_LPAE)
75 /*
76 * Allow 16MB-aligned ioremap pages
77 */
78 #define IOREMAP_MAX_ORDER 24
79 #endif
80
81 #define VECTORS_BASE UL(0xffff0000)
82
83 #else /* CONFIG_MMU */
84
85 #ifndef __ASSEMBLY__
86 extern unsigned long setup_vectors_base(void);
87 extern unsigned long vectors_base;
88 #define VECTORS_BASE vectors_base
89 #endif
90
91 /*
92 * The limitation of user task size can grow up to the end of free ram region.
93 * It is difficult to define and perhaps will never meet the original meaning
94 * of this define that was meant to.
95 * Fortunately, there is no reference for this in noMMU mode, for now.
96 */
97 #define TASK_SIZE UL(0xffffffff)
98
99 #ifndef TASK_UNMAPPED_BASE
100 #define TASK_UNMAPPED_BASE UL(0x00000000)
101 #endif
102
103 #ifndef END_MEM
104 #define END_MEM (UL(CONFIG_DRAM_BASE) + CONFIG_DRAM_SIZE)
105 #endif
106
107 /*
108 * The module can be at any place in ram in nommu mode.
109 */
110 #define MODULES_END (END_MEM)
111 #define MODULES_VADDR PAGE_OFFSET
112
113 #define XIP_VIRT_ADDR(physaddr) (physaddr)
114 #define FDT_VIRT_BASE(physbase) ((void *)(physbase))
115
116 #endif /* !CONFIG_MMU */
117
118 #ifdef CONFIG_XIP_KERNEL
119 #define KERNEL_START _sdata
120 #else
121 #define KERNEL_START _stext
122 #endif
123 #define KERNEL_END _end
124
125 /*
126 * We fix the TCM memories max 32 KiB ITCM resp DTCM at these
127 * locations
128 */
129 #ifdef CONFIG_HAVE_TCM
130 #define ITCM_OFFSET UL(0xfffe0000)
131 #define DTCM_OFFSET UL(0xfffe8000)
132 #endif
133
134 /*
135 * Convert a page to/from a physical address
136 */
137 #define page_to_phys(page) (__pfn_to_phys(page_to_pfn(page)))
138 #define phys_to_page(phys) (pfn_to_page(__phys_to_pfn(phys)))
139
140 /*
141 * PLAT_PHYS_OFFSET is the offset (from zero) of the start of physical
142 * memory. This is used for XIP and NoMMU kernels, and on platforms that don't
143 * have CONFIG_ARM_PATCH_PHYS_VIRT. Assembly code must always use
144 * PLAT_PHYS_OFFSET and not PHYS_OFFSET.
145 */
146 #define PLAT_PHYS_OFFSET UL(CONFIG_PHYS_OFFSET)
147
148 #ifdef CONFIG_XIP_KERNEL
149 /*
150 * When referencing data in RAM from the XIP region in a relative manner
151 * with the MMU off, we need the relative offset between the two physical
152 * addresses. The macro below achieves this, which is:
153 * __pa(v_data) - __xip_pa(v_text)
154 */
155 #define PHYS_RELATIVE(v_data, v_text) \
156 (((v_data) - PAGE_OFFSET + PLAT_PHYS_OFFSET) - \
157 ((v_text) - XIP_VIRT_ADDR(CONFIG_XIP_PHYS_ADDR) + \
158 CONFIG_XIP_PHYS_ADDR))
159 #else
160 #define PHYS_RELATIVE(v_data, v_text) ((v_data) - (v_text))
161 #endif
162
163 #ifndef __ASSEMBLY__
164
165 /*
166 * Physical vs virtual RAM address space conversion. These are
167 * private definitions which should NOT be used outside memory.h
168 * files. Use virt_to_phys/phys_to_virt/__pa/__va instead.
169 *
170 * PFNs are used to describe any physical page; this means
171 * PFN 0 == physical address 0.
172 */
173
174 #if defined(CONFIG_ARM_PATCH_PHYS_VIRT)
175
176 /*
177 * Constants used to force the right instruction encodings and shifts
178 * so that all we need to do is modify the 8-bit constant field.
179 */
180 #define __PV_BITS_31_24 0x81000000
181 #define __PV_BITS_7_0 0x81
182
183 extern unsigned long __pv_phys_pfn_offset;
184 extern u64 __pv_offset;
185 extern void fixup_pv_table(const void *, unsigned long);
186 extern const void *__pv_table_begin, *__pv_table_end;
187
188 #define PHYS_OFFSET ((phys_addr_t)__pv_phys_pfn_offset << PAGE_SHIFT)
189 #define PHYS_PFN_OFFSET (__pv_phys_pfn_offset)
190
191 #define __pv_stub(from,to,instr,type) \
192 __asm__("@ __pv_stub\n" \
193 "1: " instr " %0, %1, %2\n" \
194 " .pushsection .pv_table,\"a\"\n" \
195 " .long 1b\n" \
196 " .popsection\n" \
197 : "=r" (to) \
198 : "r" (from), "I" (type))
199
200 #define __pv_stub_mov_hi(t) \
201 __asm__ volatile("@ __pv_stub_mov\n" \
202 "1: mov %R0, %1\n" \
203 " .pushsection .pv_table,\"a\"\n" \
204 " .long 1b\n" \
205 " .popsection\n" \
206 : "=r" (t) \
207 : "I" (__PV_BITS_7_0))
208
209 #define __pv_add_carry_stub(x, y) \
210 __asm__ volatile("@ __pv_add_carry_stub\n" \
211 "1: adds %Q0, %1, %2\n" \
212 " adc %R0, %R0, #0\n" \
213 " .pushsection .pv_table,\"a\"\n" \
214 " .long 1b\n" \
215 " .popsection\n" \
216 : "+r" (y) \
217 : "r" (x), "I" (__PV_BITS_31_24) \
218 : "cc")
219
__virt_to_phys_nodebug(unsigned long x)220 static inline phys_addr_t __virt_to_phys_nodebug(unsigned long x)
221 {
222 phys_addr_t t;
223
224 if (sizeof(phys_addr_t) == 4) {
225 __pv_stub(x, t, "add", __PV_BITS_31_24);
226 } else {
227 __pv_stub_mov_hi(t);
228 __pv_add_carry_stub(x, t);
229 }
230 return t;
231 }
232
__phys_to_virt(phys_addr_t x)233 static inline unsigned long __phys_to_virt(phys_addr_t x)
234 {
235 unsigned long t;
236
237 /*
238 * 'unsigned long' cast discard upper word when
239 * phys_addr_t is 64 bit, and makes sure that inline
240 * assembler expression receives 32 bit argument
241 * in place where 'r' 32 bit operand is expected.
242 */
243 __pv_stub((unsigned long) x, t, "sub", __PV_BITS_31_24);
244 return t;
245 }
246
247 #else
248
249 #define PHYS_OFFSET PLAT_PHYS_OFFSET
250 #define PHYS_PFN_OFFSET ((unsigned long)(PHYS_OFFSET >> PAGE_SHIFT))
251
__virt_to_phys_nodebug(unsigned long x)252 static inline phys_addr_t __virt_to_phys_nodebug(unsigned long x)
253 {
254 return (phys_addr_t)x - PAGE_OFFSET + PHYS_OFFSET;
255 }
256
__phys_to_virt(phys_addr_t x)257 static inline unsigned long __phys_to_virt(phys_addr_t x)
258 {
259 return x - PHYS_OFFSET + PAGE_OFFSET;
260 }
261
262 #endif
263
264 #define virt_to_pfn(kaddr) \
265 ((((unsigned long)(kaddr) - PAGE_OFFSET) >> PAGE_SHIFT) + \
266 PHYS_PFN_OFFSET)
267
268 #define __pa_symbol_nodebug(x) __virt_to_phys_nodebug((x))
269
270 #ifdef CONFIG_DEBUG_VIRTUAL
271 extern phys_addr_t __virt_to_phys(unsigned long x);
272 extern phys_addr_t __phys_addr_symbol(unsigned long x);
273 #else
274 #define __virt_to_phys(x) __virt_to_phys_nodebug(x)
275 #define __phys_addr_symbol(x) __pa_symbol_nodebug(x)
276 #endif
277
278 /*
279 * These are *only* valid on the kernel direct mapped RAM memory.
280 * Note: Drivers should NOT use these. They are the wrong
281 * translation for translating DMA addresses. Use the driver
282 * DMA support - see dma-mapping.h.
283 */
284 #define virt_to_phys virt_to_phys
virt_to_phys(const volatile void * x)285 static inline phys_addr_t virt_to_phys(const volatile void *x)
286 {
287 return __virt_to_phys((unsigned long)(x));
288 }
289
290 #define phys_to_virt phys_to_virt
phys_to_virt(phys_addr_t x)291 static inline void *phys_to_virt(phys_addr_t x)
292 {
293 return (void *)__phys_to_virt(x);
294 }
295
296 /*
297 * Drivers should NOT use these either.
298 */
299 #define __pa(x) __virt_to_phys((unsigned long)(x))
300 #define __pa_symbol(x) __phys_addr_symbol(RELOC_HIDE((unsigned long)(x), 0))
301 #define __va(x) ((void *)__phys_to_virt((phys_addr_t)(x)))
302 #define pfn_to_kaddr(pfn) __va((phys_addr_t)(pfn) << PAGE_SHIFT)
303
304 extern long long arch_phys_to_idmap_offset;
305
306 /*
307 * These are for systems that have a hardware interconnect supported alias
308 * of physical memory for idmap purposes. Most cases should leave these
309 * untouched. Note: this can only return addresses less than 4GiB.
310 */
arm_has_idmap_alias(void)311 static inline bool arm_has_idmap_alias(void)
312 {
313 return IS_ENABLED(CONFIG_MMU) && arch_phys_to_idmap_offset != 0;
314 }
315
316 #define IDMAP_INVALID_ADDR ((u32)~0)
317
phys_to_idmap(phys_addr_t addr)318 static inline unsigned long phys_to_idmap(phys_addr_t addr)
319 {
320 if (IS_ENABLED(CONFIG_MMU) && arch_phys_to_idmap_offset) {
321 addr += arch_phys_to_idmap_offset;
322 if (addr > (u32)~0)
323 addr = IDMAP_INVALID_ADDR;
324 }
325 return addr;
326 }
327
idmap_to_phys(unsigned long idmap)328 static inline phys_addr_t idmap_to_phys(unsigned long idmap)
329 {
330 phys_addr_t addr = idmap;
331
332 if (IS_ENABLED(CONFIG_MMU) && arch_phys_to_idmap_offset)
333 addr -= arch_phys_to_idmap_offset;
334
335 return addr;
336 }
337
__virt_to_idmap(unsigned long x)338 static inline unsigned long __virt_to_idmap(unsigned long x)
339 {
340 return phys_to_idmap(__virt_to_phys(x));
341 }
342
343 #define virt_to_idmap(x) __virt_to_idmap((unsigned long)(x))
344
345 /*
346 * Virtual <-> DMA view memory address translations
347 * Again, these are *only* valid on the kernel direct mapped RAM
348 * memory. Use of these is *deprecated* (and that doesn't mean
349 * use the __ prefixed forms instead.) See dma-mapping.h.
350 */
351 #ifndef __virt_to_bus
352 #define __virt_to_bus __virt_to_phys
353 #define __bus_to_virt __phys_to_virt
354 #define __pfn_to_bus(x) __pfn_to_phys(x)
355 #define __bus_to_pfn(x) __phys_to_pfn(x)
356 #endif
357
358 /*
359 * Conversion between a struct page and a physical address.
360 *
361 * page_to_pfn(page) convert a struct page * to a PFN number
362 * pfn_to_page(pfn) convert a _valid_ PFN number to struct page *
363 *
364 * virt_to_page(k) convert a _valid_ virtual address to struct page *
365 * virt_addr_valid(k) indicates whether a virtual address is valid
366 */
367 #define ARCH_PFN_OFFSET PHYS_PFN_OFFSET
368
369 #define virt_to_page(kaddr) pfn_to_page(virt_to_pfn(kaddr))
370 #define virt_addr_valid(kaddr) (((unsigned long)(kaddr) >= PAGE_OFFSET && (unsigned long)(kaddr) < (unsigned long)high_memory) \
371 && pfn_valid(virt_to_pfn(kaddr)))
372
373 #endif
374
375 #include <asm-generic/memory_model.h>
376
377 #endif
378