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