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