arch/arm/include/asm/memory.h

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