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  * PLAT_PHYS_OFFSET is the offset (from zero) of the start of physical
 152  * memory.  This is used for XIP and NoMMU kernels, and on platforms that don't
 153  * have CONFIG_ARM_PATCH_PHYS_VIRT. Assembly code must always use
 154  * PLAT_PHYS_OFFSET and not PHYS_OFFSET.
 155  */
 156 #define PLAT_PHYS_OFFSET        UL(CONFIG_PHYS_OFFSET)
 157
 158 #ifndef __ASSEMBLY__
 159
 160 /*
 161  * Physical start and end address of the kernel sections. These addresses are
 162  * 2MB-aligned to match the section mappings placed over the kernel. We use
 163  * u64 so that LPAE mappings beyond the 32bit limit will work out as well.
 164  */
 165 extern u64 kernel_sec_start;
 166 extern u64 kernel_sec_end;
 167
 168 /*
 169  * Physical vs virtual RAM address space conversion.  These are
 170  * private definitions which should NOT be used outside memory.h
 171  * files.  Use virt_to_phys/phys_to_virt/__pa/__va instead.
 172  *
 173  * PFNs are used to describe any physical page; this means
 174  * PFN 0 == physical address 0.
 175  */
 176
 177 #if defined(CONFIG_ARM_PATCH_PHYS_VIRT)
 178
 179 /*
 180  * Constants used to force the right instruction encodings and shifts
 181  * so that all we need to do is modify the 8-bit constant field.
 182  */
 183 #define __PV_BITS_31_24 0x81000000
 184 #define __PV_BITS_23_16 0x810000
 185 #define __PV_BITS_7_0   0x81
 186
 187 extern unsigned long __pv_phys_pfn_offset;
 188 extern u64 __pv_offset;
 189 extern void fixup_pv_table(const void *, unsigned long);
 190 extern const void *__pv_table_begin, *__pv_table_end;
 191
 192 #define PHYS_OFFSET     ((phys_addr_t)__pv_phys_pfn_offset << PAGE_SHIFT)
 193 #define PHYS_PFN_OFFSET (__pv_phys_pfn_offset)
 194
 195 #ifndef CONFIG_THUMB2_KERNEL
 196 #define __pv_stub(from,to,instr)                        \
 197         __asm__("@ __pv_stub\n"                         \
 198         "1:     " instr "       %0, %1, %2\n"           \
 199         "2:     " instr "       %0, %0, %3\n"           \
 200         "       .pushsection .pv_table,\"a\"\n"         \
 201         "       .long   1b - ., 2b - .\n"               \
 202         "       .popsection\n"                          \
 203         : "=r" (to)                                     \
 204         : "r" (from), "I" (__PV_BITS_31_24),            \
 205           "I"(__PV_BITS_23_16))
 206
 207 #define __pv_add_carry_stub(x, y)                       \
 208         __asm__("@ __pv_add_carry_stub\n"               \
 209         "0:     movw    %R0, #0\n"                      \
 210         "       adds    %Q0, %1, %R0, lsl #20\n"        \
 211         "1:     mov     %R0, %2\n"                      \
 212         "       adc     %R0, %R0, #0\n"                 \
 213         "       .pushsection .pv_table,\"a\"\n"         \
 214         "       .long   0b - ., 1b - .\n"               \
 215         "       .popsection\n"                          \
 216         : "=&r" (y)                                     \
 217         : "r" (x), "I" (__PV_BITS_7_0)                  \
 218         : "cc")
 219
 220 #else
 221 #define __pv_stub(from,to,instr)                        \
 222         __asm__("@ __pv_stub\n"                         \
 223         "0:     movw    %0, #0\n"                       \
 224         "       lsl     %0, #21\n"                      \
 225         "       " instr " %0, %1, %0\n"                 \
 226         "       .pushsection .pv_table,\"a\"\n"         \
 227         "       .long   0b - .\n"                       \
 228         "       .popsection\n"                          \
 229         : "=&r" (to)                                    \
 230         : "r" (from))
 231
 232 #define __pv_add_carry_stub(x, y)                       \
 233         __asm__("@ __pv_add_carry_stub\n"               \
 234         "0:     movw    %R0, #0\n"                      \
 235         "       lsls    %R0, #21\n"                     \
 236         "       adds    %Q0, %1, %R0\n"                 \
 237         "1:     mvn     %R0, #0\n"                      \
 238         "       adc     %R0, %R0, #0\n"                 \
 239         "       .pushsection .pv_table,\"a\"\n"         \
 240         "       .long   0b - ., 1b - .\n"               \
 241         "       .popsection\n"                          \
 242         : "=&r" (y)                                     \
 243         : "r" (x)                                       \
 244         : "cc")
 245 #endif
 246
 247 static inline phys_addr_t __virt_to_phys_nodebug(unsigned long x)
 248 {
 249         phys_addr_t t;
 250
 251         if (sizeof(phys_addr_t) == 4) {
 252                 __pv_stub(x, t, "add");
 253         } else {
 254                 __pv_add_carry_stub(x, t);
 255         }
 256         return t;
 257 }
 258
 259 static inline unsigned long __phys_to_virt(phys_addr_t x)
 260 {
 261         unsigned long t;
 262
 263         /*
 264          * 'unsigned long' cast discard upper word when
 265          * phys_addr_t is 64 bit, and makes sure that inline
 266          * assembler expression receives 32 bit argument
 267          * in place where 'r' 32 bit operand is expected.
 268          */
 269         __pv_stub((unsigned long) x, t, "sub");
 270         return t;
 271 }
 272
 273 #else
 274
 275 #define PHYS_OFFSET     PLAT_PHYS_OFFSET
 276 #define PHYS_PFN_OFFSET ((unsigned long)(PHYS_OFFSET >> PAGE_SHIFT))
 277
 278 static inline phys_addr_t __virt_to_phys_nodebug(unsigned long x)
 279 {
 280         return (phys_addr_t)x - PAGE_OFFSET + PHYS_OFFSET;
 281 }
 282
 283 static inline unsigned long __phys_to_virt(phys_addr_t x)
 284 {
 285         return x - PHYS_OFFSET + PAGE_OFFSET;
 286 }
 287
 288 #endif
 289
 290 static inline unsigned long virt_to_pfn(const void *p)
 291 {
 292         unsigned long kaddr = (unsigned long)p;
 293         return (((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  * Conversion between a struct page and a physical address.
 375  *
 376  *  page_to_pfn(page)   convert a struct page * to a PFN number
 377  *  pfn_to_page(pfn)    convert a _valid_ PFN number to struct page *
 378  *
 379  *  virt_to_page(k)     convert a _valid_ virtual address to struct page *
 380  *  virt_addr_valid(k)  indicates whether a virtual address is valid
 381  */
 382 #define ARCH_PFN_OFFSET         PHYS_PFN_OFFSET
 383
 384 #define virt_to_page(kaddr)     pfn_to_page(virt_to_pfn(kaddr))
 385 #define virt_addr_valid(kaddr)  (((unsigned long)(kaddr) >= PAGE_OFFSET && (unsigned long)(kaddr) < (unsigned long)high_memory) \
 386                                         && pfn_valid(virt_to_pfn(kaddr)))
 387
 388 #endif
 389
 390 #endif