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