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