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