arch/arc/include/asm/pgtable.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (C) 2004, 2007-2010, 2011-2012 Synopsys, Inc. (www.synopsys.com)
   4  *
   5  * vineetg: May 2011
   6  *  -Folded PAGE_PRESENT (used by VM) and PAGE_VALID (used by MMU) into 1.
   7  *     They are semantically the same although in different contexts
   8  *     VALID marks a TLB entry exists and it will only happen if PRESENT
   9  *  - Utilise some unused free bits to confine PTE flags to 12 bits
  10  *     This is a must for 4k pg-sz
  11  *
  12  * vineetg: Mar 2011 - changes to accommodate MMU TLB Page Descriptor mods
  13  *  -TLB Locking never really existed, except for initial specs
  14  *  -SILENT_xxx not needed for our port
  15  *  -Per my request, MMU V3 changes the layout of some of the bits
  16  *     to avoid a few shifts in TLB Miss handlers.
  17  *
  18  * vineetg: April 2010
  19  *  -PGD entry no longer contains any flags. If empty it is 0, otherwise has
  20  *   Pg-Tbl ptr. Thus pmd_present(), pmd_valid(), pmd_set( ) become simpler
  21  *
  22  * vineetg: April 2010
  23  *  -Switched form 8:11:13 split for page table lookup to 11:8:13
  24  *  -this speeds up page table allocation itself as we now have to memset 1K
  25  *    instead of 8k per page table.
  26  * -TODO: Right now page table alloc is 8K and rest 7K is unused
  27  *    need to optimise it
  28  *
  29  * Amit Bhor, Sameer Dhavale: Codito Technologies 2004
  30  */
  31
  32 #ifndef _ASM_ARC_PGTABLE_H
  33 #define _ASM_ARC_PGTABLE_H
  34
  35 #include <linux/bits.h>
  36 #define __ARCH_USE_5LEVEL_HACK
  37 #include <asm-generic/pgtable-nopmd.h>
  38 #include <asm/page.h>
  39 #include <asm/mmu.h>    /* to propagate CONFIG_ARC_MMU_VER <n> */
  40
  41 /**************************************************************************
  42  * Page Table Flags
  43  *
  44  * ARC700 MMU only deals with softare managed TLB entries.
  45  * Page Tables are purely for Linux VM's consumption and the bits below are
  46  * suited to that (uniqueness). Hence some are not implemented in the TLB and
  47  * some have different value in TLB.
  48  * e.g. MMU v2: K_READ bit is 8 and so is GLOBAL (possible because they live in
  49  *      seperate PD0 and PD1, which combined forms a translation entry)
  50  *      while for PTE perspective, they are 8 and 9 respectively
  51  * with MMU v3: Most bits (except SHARED) represent the exact hardware pos
  52  *      (saves some bit shift ops in TLB Miss hdlrs)
  53  */
  54
  55 #if (CONFIG_ARC_MMU_VER <= 2)
  56
  57 #define _PAGE_ACCESSED      (1<<1)      /* Page is accessed (S) */
  58 #define _PAGE_CACHEABLE     (1<<2)      /* Page is cached (H) */
  59 #define _PAGE_EXECUTE       (1<<3)      /* Page has user execute perm (H) */
  60 #define _PAGE_WRITE         (1<<4)      /* Page has user write perm (H) */
  61 #define _PAGE_READ          (1<<5)      /* Page has user read perm (H) */
  62 #define _PAGE_DIRTY         (1<<6)      /* Page modified (dirty) (S) */
  63 #define _PAGE_SPECIAL       (1<<7)
  64 #define _PAGE_GLOBAL        (1<<8)      /* Page is global (H) */
  65 #define _PAGE_PRESENT       (1<<10)     /* TLB entry is valid (H) */
  66
  67 #else   /* MMU v3 onwards */
  68
  69 #define _PAGE_CACHEABLE     (1<<0)      /* Page is cached (H) */
  70 #define _PAGE_EXECUTE       (1<<1)      /* Page has user execute perm (H) */
  71 #define _PAGE_WRITE         (1<<2)      /* Page has user write perm (H) */
  72 #define _PAGE_READ          (1<<3)      /* Page has user read perm (H) */
  73 #define _PAGE_ACCESSED      (1<<4)      /* Page is accessed (S) */
  74 #define _PAGE_DIRTY         (1<<5)      /* Page modified (dirty) (S) */
  75 #define _PAGE_SPECIAL       (1<<6)
  76
  77 #if (CONFIG_ARC_MMU_VER >= 4)
  78 #define _PAGE_WTHRU         (1<<7)      /* Page cache mode write-thru (H) */
  79 #endif
  80
  81 #define _PAGE_GLOBAL        (1<<8)      /* Page is global (H) */
  82 #define _PAGE_PRESENT       (1<<9)      /* TLB entry is valid (H) */
  83
  84 #if (CONFIG_ARC_MMU_VER >= 4)
  85 #define _PAGE_HW_SZ         (1<<10)     /* Page Size indicator (H): 0 normal, 1 super */
  86 #endif
  87
  88 #define _PAGE_SHARED_CODE   (1<<11)     /* Shared Code page with cmn vaddr
  89                                            usable for shared TLB entries (H) */
  90
  91 #define _PAGE_UNUSED_BIT    (1<<12)
  92 #endif
  93
  94 /* vmalloc permissions */
  95 #define _K_PAGE_PERMS  (_PAGE_EXECUTE | _PAGE_WRITE | _PAGE_READ | \
  96                         _PAGE_GLOBAL | _PAGE_PRESENT)
  97
  98 #ifndef CONFIG_ARC_CACHE_PAGES
  99 #undef _PAGE_CACHEABLE
 100 #define _PAGE_CACHEABLE 0
 101 #endif
 102
 103 #ifndef _PAGE_HW_SZ
 104 #define _PAGE_HW_SZ     0
 105 #endif
 106
 107 /* Defaults for every user page */
 108 #define ___DEF (_PAGE_PRESENT | _PAGE_CACHEABLE)
 109
 110 /* Set of bits not changed in pte_modify */
 111 #define _PAGE_CHG_MASK  (PAGE_MASK_PHYS | _PAGE_ACCESSED | _PAGE_DIRTY | \
 112                                                            _PAGE_SPECIAL)
 113 /* More Abbrevaited helpers */
 114 #define PAGE_U_NONE     __pgprot(___DEF)
 115 #define PAGE_U_R        __pgprot(___DEF | _PAGE_READ)
 116 #define PAGE_U_W_R      __pgprot(___DEF | _PAGE_READ | _PAGE_WRITE)
 117 #define PAGE_U_X_R      __pgprot(___DEF | _PAGE_READ | _PAGE_EXECUTE)
 118 #define PAGE_U_X_W_R    __pgprot(___DEF | _PAGE_READ | _PAGE_WRITE | \
 119                                                        _PAGE_EXECUTE)
 120
 121 #define PAGE_SHARED     PAGE_U_W_R
 122
 123 /* While kernel runs out of unstranslated space, vmalloc/modules use a chunk of
 124  * user vaddr space - visible in all addr spaces, but kernel mode only
 125  * Thus Global, all-kernel-access, no-user-access, cached
 126  */
 127 #define PAGE_KERNEL          __pgprot(_K_PAGE_PERMS | _PAGE_CACHEABLE)
 128
 129 /* ioremap */
 130 #define PAGE_KERNEL_NO_CACHE __pgprot(_K_PAGE_PERMS)
 131
 132 /* Masks for actual TLB "PD"s */
 133 #define PTE_BITS_IN_PD0         (_PAGE_GLOBAL | _PAGE_PRESENT | _PAGE_HW_SZ)
 134 #define PTE_BITS_RWX            (_PAGE_EXECUTE | _PAGE_WRITE | _PAGE_READ)
 135
 136 #define PTE_BITS_NON_RWX_IN_PD1 (PAGE_MASK_PHYS | _PAGE_CACHEABLE)
 137
 138 /**************************************************************************
 139  * Mapping of vm_flags (Generic VM) to PTE flags (arch specific)
 140  *
 141  * Certain cases have 1:1 mapping
 142  *  e.g. __P101 means VM_READ, VM_EXEC and !VM_SHARED
 143  *       which directly corresponds to  PAGE_U_X_R
 144  *
 145  * Other rules which cause the divergence from 1:1 mapping
 146  *
 147  *  1. Although ARC700 can do exclusive execute/write protection (meaning R
 148  *     can be tracked independet of X/W unlike some other CPUs), still to
 149  *     keep things consistent with other archs:
 150  *      -Write implies Read:   W => R
 151  *      -Execute implies Read: X => R
 152  *
 153  *  2. Pvt Writable doesn't have Write Enabled initially: Pvt-W => !W
 154  *     This is to enable COW mechanism
 155  */
 156         /* xwr */
 157 #define __P000  PAGE_U_NONE
 158 #define __P001  PAGE_U_R
 159 #define __P010  PAGE_U_R        /* Pvt-W => !W */
 160 #define __P011  PAGE_U_R        /* Pvt-W => !W */
 161 #define __P100  PAGE_U_X_R      /* X => R */
 162 #define __P101  PAGE_U_X_R
 163 #define __P110  PAGE_U_X_R      /* Pvt-W => !W and X => R */
 164 #define __P111  PAGE_U_X_R      /* Pvt-W => !W */
 165
 166 #define __S000  PAGE_U_NONE
 167 #define __S001  PAGE_U_R
 168 #define __S010  PAGE_U_W_R      /* W => R */
 169 #define __S011  PAGE_U_W_R
 170 #define __S100  PAGE_U_X_R      /* X => R */
 171 #define __S101  PAGE_U_X_R
 172 #define __S110  PAGE_U_X_W_R    /* X => R */
 173 #define __S111  PAGE_U_X_W_R
 174
 175 /****************************************************************
 176  * 2 tier (PGD:PTE) software page walker
 177  *
 178  * [31]             32 bit virtual address              [0]
 179  * -------------------------------------------------------
 180  * |               | <------------ PGDIR_SHIFT ----------> |
 181  * |               |                                     |
 182  * | BITS_FOR_PGD  |  BITS_FOR_PTE  | <-- PAGE_SHIFT --> |
 183  * -------------------------------------------------------
 184  *       |                  |                |
 185  *       |                  |                --> off in page frame
 186  *       |                  ---> index into Page Table
 187  *       ----> index into Page Directory
 188  *
 189  * In a single page size configuration, only PAGE_SHIFT is fixed
 190  * So both PGD and PTE sizing can be tweaked
 191  *  e.g. 8K page (PAGE_SHIFT 13) can have
 192  *  - PGDIR_SHIFT 21  -> 11:8:13 address split
 193  *  - PGDIR_SHIFT 24  -> 8:11:13 address split
 194  *
 195  * If Super Page is configured, PGDIR_SHIFT becomes fixed too,
 196  * so the sizing flexibility is gone.
 197  */
 198
 199 #if defined(CONFIG_ARC_HUGEPAGE_16M)
 200 #define PGDIR_SHIFT     24
 201 #elif defined(CONFIG_ARC_HUGEPAGE_2M)
 202 #define PGDIR_SHIFT     21
 203 #else
 204 /*
 205  * Only Normal page support so "hackable" (see comment above)
 206  * Default value provides 11:8:13 (8K), 11:9:12 (4K)
 207  */
 208 #define PGDIR_SHIFT     21
 209 #endif
 210
 211 #define BITS_FOR_PTE    (PGDIR_SHIFT - PAGE_SHIFT)
 212 #define BITS_FOR_PGD    (32 - PGDIR_SHIFT)
 213
 214 #define PGDIR_SIZE      BIT(PGDIR_SHIFT)        /* vaddr span, not PDG sz */
 215 #define PGDIR_MASK      (~(PGDIR_SIZE-1))
 216
 217 #define PTRS_PER_PTE    BIT(BITS_FOR_PTE)
 218 #define PTRS_PER_PGD    BIT(BITS_FOR_PGD)
 219
 220 /*
 221  * Number of entries a user land program use.
 222  * TASK_SIZE is the maximum vaddr that can be used by a userland program.
 223  */
 224 #define USER_PTRS_PER_PGD       (TASK_SIZE / PGDIR_SIZE)
 225
 226 /*
 227  * No special requirements for lowest virtual address we permit any user space
 228  * mapping to be mapped at.
 229  */
 230 #define FIRST_USER_ADDRESS      0UL
 231
 232
 233 /****************************************************************
 234  * Bucket load of VM Helpers
 235  */
 236
 237 #ifndef __ASSEMBLY__
 238
 239 #define pte_ERROR(e) \
 240         pr_crit("%s:%d: bad pte %08lx.\n", __FILE__, __LINE__, pte_val(e))
 241 #define pgd_ERROR(e) \
 242         pr_crit("%s:%d: bad pgd %08lx.\n", __FILE__, __LINE__, pgd_val(e))
 243
 244 /* the zero page used for uninitialized and anonymous pages */
 245 extern char empty_zero_page[PAGE_SIZE];
 246 #define ZERO_PAGE(vaddr)        (virt_to_page(empty_zero_page))
 247
 248 #define pte_unmap(pte)          do { } while (0)
 249 #define pte_unmap_nested(pte)           do { } while (0)
 250
 251 #define set_pte(pteptr, pteval) ((*(pteptr)) = (pteval))
 252 #define set_pmd(pmdptr, pmdval) (*(pmdptr) = pmdval)
 253
 254 /* find the page descriptor of the Page Tbl ref by PMD entry */
 255 #define pmd_page(pmd)           virt_to_page(pmd_val(pmd) & PAGE_MASK)
 256
 257 /* find the logical addr (phy for ARC) of the Page Tbl ref by PMD entry */
 258 #define pmd_page_vaddr(pmd)     (pmd_val(pmd) & PAGE_MASK)
 259
 260 /* In a 2 level sys, setup the PGD entry with PTE value */
 261 static inline void pmd_set(pmd_t *pmdp, pte_t *ptep)
 262 {
 263         pmd_val(*pmdp) = (unsigned long)ptep;
 264 }
 265
 266 #define pte_none(x)                     (!pte_val(x))
 267 #define pte_present(x)                  (pte_val(x) & _PAGE_PRESENT)
 268 #define pte_clear(mm, addr, ptep)       set_pte_at(mm, addr, ptep, __pte(0))
 269
 270 #define pmd_none(x)                     (!pmd_val(x))
 271 #define pmd_bad(x)                      ((pmd_val(x) & ~PAGE_MASK))
 272 #define pmd_present(x)                  (pmd_val(x))
 273 #define pmd_clear(xp)                   do { pmd_val(*(xp)) = 0; } while (0)
 274
 275 #define pte_page(pte)           pfn_to_page(pte_pfn(pte))
 276 #define mk_pte(page, prot)      pfn_pte(page_to_pfn(page), prot)
 277 #define pfn_pte(pfn, prot)      __pte(__pfn_to_phys(pfn) | pgprot_val(prot))
 278
 279 /* Don't use virt_to_pfn for macros below: could cause truncations for PAE40*/
 280 #define pte_pfn(pte)            (pte_val(pte) >> PAGE_SHIFT)
 281 #define __pte_index(addr)       (((addr) >> PAGE_SHIFT) & (PTRS_PER_PTE - 1))
 282
 283 /*
 284  * pte_offset gets a @ptr to PMD entry (PGD in our 2-tier paging system)
 285  * and returns ptr to PTE entry corresponding to @addr
 286  */
 287 #define pte_offset(dir, addr) ((pte_t *)(pmd_page_vaddr(*dir)) +\
 288                                          __pte_index(addr))
 289
 290 /* No mapping of Page Tables in high mem etc, so following same as above */
 291 #define pte_offset_kernel(dir, addr)            pte_offset(dir, addr)
 292 #define pte_offset_map(dir, addr)               pte_offset(dir, addr)
 293
 294 /* Zoo of pte_xxx function */
 295 #define pte_read(pte)           (pte_val(pte) & _PAGE_READ)
 296 #define pte_write(pte)          (pte_val(pte) & _PAGE_WRITE)
 297 #define pte_dirty(pte)          (pte_val(pte) & _PAGE_DIRTY)
 298 #define pte_young(pte)          (pte_val(pte) & _PAGE_ACCESSED)
 299 #define pte_special(pte)        (pte_val(pte) & _PAGE_SPECIAL)
 300
 301 #define PTE_BIT_FUNC(fn, op) \
 302         static inline pte_t pte_##fn(pte_t pte) { pte_val(pte) op; return pte; }
 303
 304 PTE_BIT_FUNC(mknotpresent,      &= ~(_PAGE_PRESENT));
 305 PTE_BIT_FUNC(wrprotect, &= ~(_PAGE_WRITE));
 306 PTE_BIT_FUNC(mkwrite,   |= (_PAGE_WRITE));
 307 PTE_BIT_FUNC(mkclean,   &= ~(_PAGE_DIRTY));
 308 PTE_BIT_FUNC(mkdirty,   |= (_PAGE_DIRTY));
 309 PTE_BIT_FUNC(mkold,     &= ~(_PAGE_ACCESSED));
 310 PTE_BIT_FUNC(mkyoung,   |= (_PAGE_ACCESSED));
 311 PTE_BIT_FUNC(exprotect, &= ~(_PAGE_EXECUTE));
 312 PTE_BIT_FUNC(mkexec,    |= (_PAGE_EXECUTE));
 313 PTE_BIT_FUNC(mkspecial, |= (_PAGE_SPECIAL));
 314 PTE_BIT_FUNC(mkhuge,    |= (_PAGE_HW_SZ));
 315
 316 static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
 317 {
 318         return __pte((pte_val(pte) & _PAGE_CHG_MASK) | pgprot_val(newprot));
 319 }
 320
 321 /* Macro to mark a page protection as uncacheable */
 322 #define pgprot_noncached(prot)  (__pgprot(pgprot_val(prot) & ~_PAGE_CACHEABLE))
 323
 324 static inline void set_pte_at(struct mm_struct *mm, unsigned long addr,
 325                               pte_t *ptep, pte_t pteval)
 326 {
 327         set_pte(ptep, pteval);
 328 }
 329
 330 /*
 331  * All kernel related VM pages are in init's mm.
 332  */
 333 #define pgd_offset_k(address)   pgd_offset(&init_mm, address)
 334 #define pgd_index(addr)         ((addr) >> PGDIR_SHIFT)
 335 #define pgd_offset(mm, addr)    (((mm)->pgd)+pgd_index(addr))
 336
 337 /*
 338  * Macro to quickly access the PGD entry, utlising the fact that some
 339  * arch may cache the pointer to Page Directory of "current" task
 340  * in a MMU register
 341  *
 342  * Thus task->mm->pgd (3 pointer dereferences, cache misses etc simply
 343  * becomes read a register
 344  *
 345  * ********CAUTION*******:
 346  * Kernel code might be dealing with some mm_struct of NON "current"
 347  * Thus use this macro only when you are certain that "current" is current
 348  * e.g. when dealing with signal frame setup code etc
 349  */
 350 #ifndef CONFIG_SMP
 351 #define pgd_offset_fast(mm, addr)       \
 352 ({                                      \
 353         pgd_t *pgd_base = (pgd_t *) read_aux_reg(ARC_REG_SCRATCH_DATA0);  \
 354         pgd_base + pgd_index(addr);     \
 355 })
 356 #else
 357 #define pgd_offset_fast(mm, addr)       pgd_offset(mm, addr)
 358 #endif
 359
 360 extern pgd_t swapper_pg_dir[] __aligned(PAGE_SIZE);
 361 void update_mmu_cache(struct vm_area_struct *vma, unsigned long address,
 362                       pte_t *ptep);
 363
 364 /* Encode swap {type,off} tuple into PTE
 365  * We reserve 13 bits for 5-bit @type, keeping bits 12-5 zero, ensuring that
 366  * PAGE_PRESENT is zero in a PTE holding swap "identifier"
 367  */
 368 #define __swp_entry(type, off)  ((swp_entry_t) { \
 369                                         ((type) & 0x1f) | ((off) << 13) })
 370
 371 /* Decode a PTE containing swap "identifier "into constituents */
 372 #define __swp_type(pte_lookalike)       (((pte_lookalike).val) & 0x1f)
 373 #define __swp_offset(pte_lookalike)     ((pte_lookalike).val >> 13)
 374
 375 /* NOPs, to keep generic kernel happy */
 376 #define __pte_to_swp_entry(pte) ((swp_entry_t) { pte_val(pte) })
 377 #define __swp_entry_to_pte(x)   ((pte_t) { (x).val })
 378
 379 #define kern_addr_valid(addr)   (1)
 380
 381 /*
 382  * remap a physical page `pfn' of size `size' with page protection `prot'
 383  * into virtual address `from'
 384  */
 385 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 386 #include <asm/hugepage.h>
 387 #endif
 388
 389 #include <asm-generic/pgtable.h>
 390
 391 /* to cope with aliasing VIPT cache */
 392 #define HAVE_ARCH_UNMAPPED_AREA
 393
 394 #endif /* __ASSEMBLY__ */
 395
 396 #endif