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