include/asm-arm26/pgtable.h

   1 /*
   2  *  linux/include/asm-arm26/pgtable.h
   3  *
   4  *  Copyright (C) 2000-2002 Russell King
   5  *  Copyright (C) 2003 Ian Molton
   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 #ifndef _ASMARM_PGTABLE_H
  12 #define _ASMARM_PGTABLE_H
  13
  14 #include <linux/config.h>
  15 #include <asm/memory.h>
  16
  17 /*
  18  * The table below defines the page protection levels that we insert into our
  19  * Linux page table version.  These get translated into the best that the
  20  * architecture can perform.  Note that on most ARM hardware:
  21  *  1) We cannot do execute protection
  22  *  2) If we could do execute protection, then read is implied
  23  *  3) write implies read permissions
  24  */
  25 #define __P000  PAGE_NONE
  26 #define __P001  PAGE_READONLY
  27 #define __P010  PAGE_COPY
  28 #define __P011  PAGE_COPY
  29 #define __P100  PAGE_READONLY
  30 #define __P101  PAGE_READONLY
  31 #define __P110  PAGE_COPY
  32 #define __P111  PAGE_COPY
  33
  34 #define __S000  PAGE_NONE
  35 #define __S001  PAGE_READONLY
  36 #define __S010  PAGE_SHARED
  37 #define __S011  PAGE_SHARED
  38 #define __S100  PAGE_READONLY
  39 #define __S101  PAGE_READONLY
  40 #define __S110  PAGE_SHARED
  41 #define __S111  PAGE_SHARED
  42
  43 /*
  44  * PMD_SHIFT determines the size of the area a second-level page table can map
  45  * PGDIR_SHIFT determines what a third-level page table entry can map
  46  */
  47 #define PGD_SHIFT               25
  48 #define PMD_SHIFT               20
  49
  50 #define PGD_SIZE                (1UL << PGD_SHIFT)
  51 #define PGD_MASK                (~(PGD_SIZE-1))
  52 #define PMD_SIZE                (1UL << PMD_SHIFT)
  53 #define PMD_MASK                (~(PMD_SIZE-1))
  54
  55 /* The kernel likes to use these names for the above (ick) */
  56 #define PGDIR_SIZE PGD_SIZE
  57 #define PGDIR_MASK PGD_MASK
  58
  59 #define PTRS_PER_PGD            32
  60 #define PTRS_PER_PMD            1
  61 #define PTRS_PER_PTE            32
  62
  63 #define FIRST_USER_PGD_NR       1
  64 #define USER_PTRS_PER_PGD       ((TASK_SIZE/PGD_SIZE) - FIRST_USER_PGD_NR)
  65
  66 // FIXME - WTF?
  67 #define LIBRARY_TEXT_START      0x0c000000
  68
  69
  70
  71 #ifndef __ASSEMBLY__
  72 extern void __pte_error(const char *file, int line, unsigned long val);
  73 extern void __pmd_error(const char *file, int line, unsigned long val);
  74 extern void __pgd_error(const char *file, int line, unsigned long val);
  75
  76 #define pte_ERROR(pte)          __pte_error(__FILE__, __LINE__, pte_val(pte))
  77 #define pmd_ERROR(pmd)          __pmd_error(__FILE__, __LINE__, pmd_val(pmd))
  78 #define pgd_ERROR(pgd)          __pgd_error(__FILE__, __LINE__, pgd_val(pgd))
  79
  80 /*
  81  * ZERO_PAGE is a global shared page that is always zero: used
  82  * for zero-mapped memory areas etc..
  83  */
  84 extern struct page *empty_zero_page;
  85 #define ZERO_PAGE(vaddr)        (empty_zero_page)
  86
  87 #define pte_pfn(pte)            (pte_val(pte) >> PAGE_SHIFT)
  88 #define pte_page(pte)           (pfn_to_page(pte_pfn(pte)))
  89 #define pfn_pte(pfn,prot)       (__pte(((pfn) << PAGE_SHIFT) | pgprot_val(prot)))
  90 #define pages_to_mb(x)          ((x) >> (20 - PAGE_SHIFT))
  91 #define mk_pte(page,prot)       pfn_pte(page_to_pfn(page),prot)
  92 #define page_pte_prot(page,prot)        mk_pte(page, prot)
  93 #define page_pte(page)          mk_pte(page, __pgprot(0))
  94
  95 /*
  96  * Terminology: PGD = Page Directory, PMD = Page Middle Directory,
  97  *              PTE = Page Table Entry
  98  *
  99  * on arm26 we have no 2nd level page table. we simulate this by removing the
 100  * PMD.
 101  *
 102  * pgd_none is 0 to prevernt pmd_alloc() calling __pmd_alloc(). This causes it
 103  * to return pmd_offset(pgd,addr) which is a pointer to the pgd (IOW, a no-op).
 104  *
 105  * however, to work this way, whilst we are allocating 32 pgds, containing 32
 106  * PTEs, the actual work is done on the PMDs, thus:
 107  *
 108  * instead of  mm->pgd->pmd->pte
 109  * we have     mm->pgdpmd->pte
 110  *
 111  * IOW, think of PGD operations and PMD ones as being the same thing, just
 112  * that PGD stuff deals with the mm_struct side of things, wheras PMD stuff
 113  * deals with the pte side of things.
 114  *
 115  * additionally, we store some bits in the PGD and PTE pointers:
 116  * PGDs:
 117  *   o The lowest (1) bit of the PGD is to determine if it is present or swap.
 118  *   o The 2nd bit of the PGD is unused and must be zero.
 119  *   o The top 6 bits of the PGD must be zero.
 120  * PTEs:
 121  *   o The lower 5 bits of a pte are flags. bit 1 is the 'present' flag. The
 122  *     others determine the pages attributes.
 123  *
 124  * the pgd_val, pmd_val, and pte_val macros seem to be private to our code.
 125  * They get the RAW value of the PGD/PMD/PTE entry, including our flags
 126  * encoded into the pointers.
 127  *
 128  * The pgd_offset, pmd_offset, and pte_offset macros are used by the kernel,
 129  * so they shouldnt have our flags attached.
 130  *
 131  * If you understood that, feel free to explain it to me...
 132  *
 133  */
 134
 135 #define _PMD_PRESENT     (0x01)
 136
 137 /* These definitions allow us to optimise out stuff like pmd_alloc() */
 138 #define pgd_none(pgd)           (0)
 139 #define pgd_bad(pgd)            (0)
 140 #define pgd_present(pgd)        (1)
 141 #define pgd_clear(pgdp)         do { } while (0)
 142
 143 /* Whilst these handle our actual 'page directory' (the agglomeration of pgd and pmd)
 144  */
 145 #define pmd_none(pmd)           (!pmd_val(pmd))
 146 #define pmd_bad(pmd)            ((pmd_val(pmd) & 0xfc000002))
 147 #define pmd_present(pmd)        (pmd_val(pmd) & _PMD_PRESENT)
 148 #define set_pmd(pmd_ptr, pmd)   ((*(pmd_ptr)) = (pmd))
 149 #define pmd_clear(pmdp)         set_pmd(pmdp, __pmd(0))
 150
 151 /* and these handle our pte tables */
 152 #define pte_none(pte)           (!pte_val(pte))
 153 #define pte_present(pte)        (pte_val(pte) & _PAGE_PRESENT)
 154 #define set_pte(pte_ptr, pte)   ((*(pte_ptr)) = (pte))
 155 #define pte_clear(ptep)         set_pte((ptep), __pte(0))
 156
 157 /* macros to ease the getting of pointers to stuff... */
 158 #define pgd_offset(mm, addr)    ((pgd_t *)(mm)->pgd        + __pgd_index(addr))
 159 #define pmd_offset(pgd, addr)   ((pmd_t *)(pgd))
 160 #define pte_offset(pmd, addr)   ((pte_t *)pmd_page(*(pmd)) + __pte_index(addr))
 161
 162 /* there is no __pmd_index as we dont use pmds */
 163 #define __pgd_index(addr)       ((addr) >> PGD_SHIFT)
 164 #define __pte_index(addr)       (((addr) >> PAGE_SHIFT) & (PTRS_PER_PTE - 1))
 165
 166
 167 /* Keep the kernel happy */
 168 #define pgd_index(addr)         __pgd_index(addr)
 169 #define pgd_offset_k(addr)      (pgd_offset(&init_mm, addr))
 170
 171 /*
 172  * The vmalloc() routines leaves a hole of 4kB between each vmalloced
 173  * area for the same reason. ;) FIXME: surely 1 page not 4k ?
 174  */
 175 #define VMALLOC_START     0x01a00000
 176 #define VMALLOC_END       0x01c00000
 177
 178 /* Is pmd_page supposed to return a pointer to a page in some arches? ours seems to
 179  * return a pointer to memory (no special alignment)
 180  */
 181 #define pmd_page(pmd)  ((struct page *)(pmd_val((pmd)) & ~_PMD_PRESENT))
 182 #define pmd_page_kernel(pmd) ((pte_t *)(pmd_val((pmd)) & ~_PMD_PRESENT))
 183
 184 #define pte_offset_kernel(dir,addr)     (pmd_page_kernel(*(dir)) + __pte_index(addr))
 185
 186 #define pte_offset_map(dir,addr)        (pmd_page_kernel(*(dir)) + __pte_index(addr))
 187 #define pte_offset_map_nested(dir,addr) (pmd_page_kernel(*(dir)) + __pte_index(addr))
 188 #define pte_unmap(pte)                  do { } while (0)
 189 #define pte_unmap_nested(pte)           do { } while (0)
 190
 191
 192 #define _PAGE_PRESENT   0x01
 193 #define _PAGE_READONLY  0x02
 194 #define _PAGE_NOT_USER  0x04
 195 #define _PAGE_OLD       0x08
 196 #define _PAGE_CLEAN     0x10
 197
 198 // an old page has never been read.
 199 // a clean page has never been written.
 200
 201 /*                               -- present --   -- !dirty --  --- !write ---   ---- !user --- */
 202 #define PAGE_NONE       __pgprot(_PAGE_PRESENT | _PAGE_CLEAN | _PAGE_READONLY | _PAGE_NOT_USER)
 203 #define PAGE_SHARED     __pgprot(_PAGE_PRESENT | _PAGE_CLEAN                                  )
 204 #define PAGE_COPY       __pgprot(_PAGE_PRESENT | _PAGE_CLEAN | _PAGE_READONLY                 )
 205 #define PAGE_READONLY   __pgprot(_PAGE_PRESENT | _PAGE_CLEAN | _PAGE_READONLY                 )
 206 #define PAGE_KERNEL     __pgprot(_PAGE_PRESENT                                | _PAGE_NOT_USER)
 207
 208 #define _PAGE_CHG_MASK  (PAGE_MASK | _PAGE_OLD | _PAGE_CLEAN)
 209
 210 /*
 211  * The following only work if pte_present() is true.
 212  * Undefined behaviour if not..
 213  */
 214 #define pte_read(pte)                   (!(pte_val(pte) & _PAGE_NOT_USER))
 215 #define pte_write(pte)                  (!(pte_val(pte) & _PAGE_READONLY))
 216 #define pte_exec(pte)                   (!(pte_val(pte) & _PAGE_NOT_USER))
 217 #define pte_dirty(pte)                  (!(pte_val(pte) & _PAGE_CLEAN))
 218 #define pte_young(pte)                  (!(pte_val(pte) & _PAGE_OLD))
 219 //ONLY when !pte_present() I think. nicked from arm32 (FIXME!)
 220 #define pte_file(pte)                   (!(pte_val(pte) & _PAGE_OLD))
 221
 222 #define PTE_BIT_FUNC(fn,op)                     \
 223 static inline pte_t pte_##fn(pte_t pte) { pte_val(pte) op; return pte; }
 224
 225 PTE_BIT_FUNC(wrprotect, |=  _PAGE_READONLY);
 226 PTE_BIT_FUNC(mkwrite,   &= ~_PAGE_READONLY);
 227 PTE_BIT_FUNC(exprotect, |=  _PAGE_NOT_USER);
 228 PTE_BIT_FUNC(mkexec,    &= ~_PAGE_NOT_USER);
 229 PTE_BIT_FUNC(mkclean,   |=  _PAGE_CLEAN);
 230 PTE_BIT_FUNC(mkdirty,   &= ~_PAGE_CLEAN);
 231 PTE_BIT_FUNC(mkold,     |=  _PAGE_OLD);
 232 PTE_BIT_FUNC(mkyoung,   &= ~_PAGE_OLD);
 233
 234 /*
 235  * We don't store cache state bits in the page table here. FIXME - or do we?
 236  */
 237 #define pgprot_noncached(prot)  (prot)
 238 #define pgprot_writecombine(prot) (prot) //FIXME - is a no-op?
 239
 240 extern void pgtable_cache_init(void);
 241
 242 //FIXME - nicked from arm32 and brutally hacked. probably wrong.
 243 #define pte_to_pgoff(x) (pte_val(x) >> 2)
 244 #define pgoff_to_pte(x) __pte(((x) << 2) & ~_PAGE_OLD)
 245
 246 //FIXME - next line borrowed from arm32. is it right?
 247 #define PTE_FILE_MAX_BITS       30
 248
 249
 250 static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
 251 {
 252         pte_val(pte) = (pte_val(pte) & _PAGE_CHG_MASK) | pgprot_val(newprot);
 253         return pte;
 254 }
 255
 256 extern pgd_t swapper_pg_dir[PTRS_PER_PGD];
 257
 258 /* Encode and decode a swap entry.
 259  *
 260  * We support up to 32GB of swap on 4k machines
 261  */
 262 #define __swp_type(x)           (((x).val >> 2) & 0x7f)
 263 #define __swp_offset(x)         ((x).val >> 9)
 264 #define __swp_entry(type,offset) ((swp_entry_t) { ((type) << 2) | ((offset) << 9) })
 265 #define __pte_to_swp_entry(pte) ((swp_entry_t) { pte_val(pte) })
 266 #define __swp_entry_to_pte(swp) ((pte_t) { (swp).val })
 267
 268 /* Needs to be defined here and not in linux/mm.h, as it is arch dependent */
 269 /* FIXME: this is not correct */
 270 #define kern_addr_valid(addr)   (1)
 271
 272 /*
 273  * Conversion functions: convert a page and protection to a page entry,
 274  * and a page entry and page directory to the page they refer to.
 275  */
 276 static inline pte_t mk_pte_phys(unsigned long physpage, pgprot_t pgprot)
 277 {
 278         pte_t pte;
 279         pte_val(pte) = physpage | pgprot_val(pgprot);
 280         return pte;
 281 }
 282
 283
 284 #include <asm-generic/pgtable.h>
 285
 286 /*
 287  * remap a physical address `phys' of size `size' with page protection `prot'
 288  * into virtual address `from'
 289  */
 290 #define io_remap_page_range(vma,from,phys,size,prot) \
 291                 remap_page_range(vma,from,phys,size,prot)
 292
 293 #endif /* !__ASSEMBLY__ */
 294
 295 #endif /* _ASMARM_PGTABLE_H */