22113f7fc83cd27ee0ae5120fb48137c0d07eb26
[~shefty/rdma-dev.git] / arch / sh / include / asm / pgtable_64.h
1 #ifndef __ASM_SH_PGTABLE_64_H
2 #define __ASM_SH_PGTABLE_64_H
3
4 /*
5  * include/asm-sh/pgtable_64.h
6  *
7  * This file contains the functions and defines necessary to modify and use
8  * the SuperH page table tree.
9  *
10  * Copyright (C) 2000, 2001  Paolo Alberelli
11  * Copyright (C) 2003, 2004  Paul Mundt
12  * Copyright (C) 2003, 2004  Richard Curnow
13  *
14  * This file is subject to the terms and conditions of the GNU General Public
15  * License.  See the file "COPYING" in the main directory of this archive
16  * for more details.
17  */
18 #include <linux/threads.h>
19 #include <asm/processor.h>
20 #include <asm/page.h>
21
22 /*
23  * Error outputs.
24  */
25 #define pte_ERROR(e) \
26         printk("%s:%d: bad pte %016Lx.\n", __FILE__, __LINE__, pte_val(e))
27 #define pgd_ERROR(e) \
28         printk("%s:%d: bad pgd %08lx.\n", __FILE__, __LINE__, pgd_val(e))
29
30 /*
31  * Table setting routines. Used within arch/mm only.
32  */
33 #define set_pmd(pmdptr, pmdval) (*(pmdptr) = pmdval)
34
35 static __inline__ void set_pte(pte_t *pteptr, pte_t pteval)
36 {
37         unsigned long long x = ((unsigned long long) pteval.pte_low);
38         unsigned long long *xp = (unsigned long long *) pteptr;
39         /*
40          * Sign-extend based on NPHYS.
41          */
42         *(xp) = (x & NPHYS_SIGN) ? (x | NPHYS_MASK) : x;
43 }
44 #define set_pte_at(mm,addr,ptep,pteval) set_pte(ptep,pteval)
45
46 /*
47  * PGD defines. Top level.
48  */
49
50 /* To find an entry in a generic PGD. */
51 #define pgd_index(address) (((address) >> PGDIR_SHIFT) & (PTRS_PER_PGD-1))
52 #define __pgd_offset(address) pgd_index(address)
53 #define pgd_offset(mm, address) ((mm)->pgd+pgd_index(address))
54
55 /* To find an entry in a kernel PGD. */
56 #define pgd_offset_k(address) pgd_offset(&init_mm, address)
57
58 #define __pud_offset(address)   (((address) >> PUD_SHIFT) & (PTRS_PER_PUD-1))
59 #define __pmd_offset(address)   (((address) >> PMD_SHIFT) & (PTRS_PER_PMD-1))
60
61 /*
62  * PMD level access routines. Same notes as above.
63  */
64 #define _PMD_EMPTY              0x0
65 /* Either the PMD is empty or present, it's not paged out */
66 #define pmd_present(pmd_entry)  (pmd_val(pmd_entry) & _PAGE_PRESENT)
67 #define pmd_clear(pmd_entry_p)  (set_pmd((pmd_entry_p), __pmd(_PMD_EMPTY)))
68 #define pmd_none(pmd_entry)     (pmd_val((pmd_entry)) == _PMD_EMPTY)
69 #define pmd_bad(pmd_entry)      ((pmd_val(pmd_entry) & (~PAGE_MASK & ~_PAGE_USER)) != _KERNPG_TABLE)
70
71 #define pmd_page_vaddr(pmd_entry) \
72         ((unsigned long) __va(pmd_val(pmd_entry) & PAGE_MASK))
73
74 #define pmd_page(pmd) \
75         (virt_to_page(pmd_val(pmd)))
76
77 /* PMD to PTE dereferencing */
78 #define pte_index(address) \
79                 ((address >> PAGE_SHIFT) & (PTRS_PER_PTE - 1))
80
81 #define __pte_offset(address)   pte_index(address)
82
83 #define pte_offset_kernel(dir, addr) \
84                 ((pte_t *) ((pmd_val(*(dir))) & PAGE_MASK) + pte_index((addr)))
85
86 #define pte_offset_map(dir,addr)        pte_offset_kernel(dir, addr)
87 #define pte_offset_map_nested(dir,addr) pte_offset_kernel(dir, addr)
88 #define pte_unmap(pte)          do { } while (0)
89 #define pte_unmap_nested(pte)   do { } while (0)
90
91 #ifndef __ASSEMBLY__
92 #define IOBASE_VADDR    0xff000000
93 #define IOBASE_END      0xffffffff
94
95 /*
96  * PTEL coherent flags.
97  * See Chapter 17 ST50 CPU Core Volume 1, Architecture.
98  */
99 /* The bits that are required in the SH-5 TLB are placed in the h/w-defined
100    positions, to avoid expensive bit shuffling on every refill.  The remaining
101    bits are used for s/w purposes and masked out on each refill.
102
103    Note, the PTE slots are used to hold data of type swp_entry_t when a page is
104    swapped out.  Only the _PAGE_PRESENT flag is significant when the page is
105    swapped out, and it must be placed so that it doesn't overlap either the
106    type or offset fields of swp_entry_t.  For x86, offset is at [31:8] and type
107    at [6:1], with _PAGE_PRESENT at bit 0 for both pte_t and swp_entry_t.  This
108    scheme doesn't map to SH-5 because bit [0] controls cacheability.  So bit
109    [2] is used for _PAGE_PRESENT and the type field of swp_entry_t is split
110    into 2 pieces.  That is handled by SWP_ENTRY and SWP_TYPE below. */
111 #define _PAGE_WT        0x001  /* CB0: if cacheable, 1->write-thru, 0->write-back */
112 #define _PAGE_DEVICE    0x001  /* CB0: if uncacheable, 1->device (i.e. no write-combining or reordering at bus level) */
113 #define _PAGE_CACHABLE  0x002  /* CB1: uncachable/cachable */
114 #define _PAGE_PRESENT   0x004  /* software: page referenced */
115 #define _PAGE_FILE      0x004  /* software: only when !present */
116 #define _PAGE_SIZE0     0x008  /* SZ0-bit : size of page */
117 #define _PAGE_SIZE1     0x010  /* SZ1-bit : size of page */
118 #define _PAGE_SHARED    0x020  /* software: reflects PTEH's SH */
119 #define _PAGE_READ      0x040  /* PR0-bit : read access allowed */
120 #define _PAGE_EXECUTE   0x080  /* PR1-bit : execute access allowed */
121 #define _PAGE_WRITE     0x100  /* PR2-bit : write access allowed */
122 #define _PAGE_USER      0x200  /* PR3-bit : user space access allowed */
123 #define _PAGE_DIRTY     0x400  /* software: page accessed in write */
124 #define _PAGE_ACCESSED  0x800  /* software: page referenced */
125
126 /* Wrapper for extended mode pgprot twiddling */
127 #define _PAGE_EXT(x)            ((unsigned long long)(x) << 32)
128
129 /*
130  * We can use the sign-extended bits in the PTEL to get 32 bits of
131  * software flags. This works for now because no implementations uses
132  * anything above the PPN field.
133  */
134 #define _PAGE_WIRED     _PAGE_EXT(0x001) /* software: wire the tlb entry */
135 #define _PAGE_SPECIAL   _PAGE_EXT(0x002)
136
137 #define _PAGE_CLEAR_FLAGS       (_PAGE_PRESENT | _PAGE_FILE | _PAGE_SHARED | \
138                                  _PAGE_DIRTY | _PAGE_ACCESSED | _PAGE_WIRED)
139
140 /* Mask which drops software flags */
141 #define _PAGE_FLAGS_HARDWARE_MASK       (NEFF_MASK & ~(_PAGE_CLEAR_FLAGS))
142
143 /*
144  * HugeTLB support
145  */
146 #if defined(CONFIG_HUGETLB_PAGE_SIZE_64K)
147 #define _PAGE_SZHUGE    (_PAGE_SIZE0)
148 #elif defined(CONFIG_HUGETLB_PAGE_SIZE_1MB)
149 #define _PAGE_SZHUGE    (_PAGE_SIZE1)
150 #elif defined(CONFIG_HUGETLB_PAGE_SIZE_512MB)
151 #define _PAGE_SZHUGE    (_PAGE_SIZE0 | _PAGE_SIZE1)
152 #endif
153
154 /*
155  * Stub out _PAGE_SZHUGE if we don't have a good definition for it,
156  * to make pte_mkhuge() happy.
157  */
158 #ifndef _PAGE_SZHUGE
159 # define _PAGE_SZHUGE   (0)
160 #endif
161
162 /*
163  * Default flags for a Kernel page.
164  * This is fundametally also SHARED because the main use of this define
165  * (other than for PGD/PMD entries) is for the VMALLOC pool which is
166  * contextless.
167  *
168  * _PAGE_EXECUTE is required for modules
169  *
170  */
171 #define _KERNPG_TABLE   (_PAGE_PRESENT | _PAGE_READ | _PAGE_WRITE | \
172                          _PAGE_EXECUTE | \
173                          _PAGE_CACHABLE | _PAGE_ACCESSED | _PAGE_DIRTY | \
174                          _PAGE_SHARED)
175
176 /* Default flags for a User page */
177 #define _PAGE_TABLE     (_KERNPG_TABLE | _PAGE_USER)
178
179 #define _PAGE_CHG_MASK  (PTE_MASK | _PAGE_ACCESSED | _PAGE_DIRTY | \
180                          _PAGE_SPECIAL)
181
182 /*
183  * We have full permissions (Read/Write/Execute/Shared).
184  */
185 #define _PAGE_COMMON    (_PAGE_PRESENT | _PAGE_USER | \
186                          _PAGE_CACHABLE | _PAGE_ACCESSED)
187
188 #define PAGE_NONE       __pgprot(_PAGE_CACHABLE | _PAGE_ACCESSED)
189 #define PAGE_SHARED     __pgprot(_PAGE_COMMON | _PAGE_READ | _PAGE_WRITE | \
190                                  _PAGE_SHARED)
191 #define PAGE_EXECREAD   __pgprot(_PAGE_COMMON | _PAGE_READ | _PAGE_EXECUTE)
192
193 /*
194  * We need to include PAGE_EXECUTE in PAGE_COPY because it is the default
195  * protection mode for the stack.
196  */
197 #define PAGE_COPY       PAGE_EXECREAD
198
199 #define PAGE_READONLY   __pgprot(_PAGE_COMMON | _PAGE_READ)
200 #define PAGE_WRITEONLY  __pgprot(_PAGE_COMMON | _PAGE_WRITE)
201 #define PAGE_RWX        __pgprot(_PAGE_COMMON | _PAGE_READ | \
202                                  _PAGE_WRITE | _PAGE_EXECUTE)
203 #define PAGE_KERNEL     __pgprot(_KERNPG_TABLE)
204
205 #define PAGE_KERNEL_NOCACHE \
206                         __pgprot(_PAGE_PRESENT | _PAGE_READ | _PAGE_WRITE | \
207                                  _PAGE_EXECUTE | _PAGE_ACCESSED | \
208                                  _PAGE_DIRTY | _PAGE_SHARED)
209
210 /* Make it a device mapping for maximum safety (e.g. for mapping device
211    registers into user-space via /dev/map).  */
212 #define pgprot_noncached(x) __pgprot(((x).pgprot & ~(_PAGE_CACHABLE)) | _PAGE_DEVICE)
213 #define pgprot_writecombine(prot) __pgprot(pgprot_val(prot) & ~_PAGE_CACHABLE)
214
215 /*
216  * PTE level access routines.
217  *
218  * Note1:
219  * It's the tree walk leaf. This is physical address to be stored.
220  *
221  * Note 2:
222  * Regarding the choice of _PTE_EMPTY:
223
224    We must choose a bit pattern that cannot be valid, whether or not the page
225    is present.  bit[2]==1 => present, bit[2]==0 => swapped out.  If swapped
226    out, bits [31:8], [6:3], [1:0] are under swapper control, so only bit[7] is
227    left for us to select.  If we force bit[7]==0 when swapped out, we could use
228    the combination bit[7,2]=2'b10 to indicate an empty PTE.  Alternatively, if
229    we force bit[7]==1 when swapped out, we can use all zeroes to indicate
230    empty.  This is convenient, because the page tables get cleared to zero
231    when they are allocated.
232
233  */
234 #define _PTE_EMPTY      0x0
235 #define pte_present(x)  (pte_val(x) & _PAGE_PRESENT)
236 #define pte_clear(mm,addr,xp)   (set_pte_at(mm, addr, xp, __pte(_PTE_EMPTY)))
237 #define pte_none(x)     (pte_val(x) == _PTE_EMPTY)
238
239 /*
240  * Some definitions to translate between mem_map, PTEs, and page
241  * addresses:
242  */
243
244 /*
245  * Given a PTE, return the index of the mem_map[] entry corresponding
246  * to the page frame the PTE. Get the absolute physical address, make
247  * a relative physical address and translate it to an index.
248  */
249 #define pte_pagenr(x)           (((unsigned long) (pte_val(x)) - \
250                                  __MEMORY_START) >> PAGE_SHIFT)
251
252 /*
253  * Given a PTE, return the "struct page *".
254  */
255 #define pte_page(x)             (mem_map + pte_pagenr(x))
256
257 /*
258  * Return number of (down rounded) MB corresponding to x pages.
259  */
260 #define pages_to_mb(x) ((x) >> (20-PAGE_SHIFT))
261
262
263 /*
264  * The following have defined behavior only work if pte_present() is true.
265  */
266 static inline int pte_dirty(pte_t pte)  { return pte_val(pte) & _PAGE_DIRTY; }
267 static inline int pte_young(pte_t pte)  { return pte_val(pte) & _PAGE_ACCESSED; }
268 static inline int pte_file(pte_t pte)   { return pte_val(pte) & _PAGE_FILE; }
269 static inline int pte_write(pte_t pte)  { return pte_val(pte) & _PAGE_WRITE; }
270 static inline int pte_special(pte_t pte){ return pte_val(pte) & _PAGE_SPECIAL; }
271
272 static inline pte_t pte_wrprotect(pte_t pte)    { set_pte(&pte, __pte(pte_val(pte) & ~_PAGE_WRITE)); return pte; }
273 static inline pte_t pte_mkclean(pte_t pte)      { set_pte(&pte, __pte(pte_val(pte) & ~_PAGE_DIRTY)); return pte; }
274 static inline pte_t pte_mkold(pte_t pte)        { set_pte(&pte, __pte(pte_val(pte) & ~_PAGE_ACCESSED)); return pte; }
275 static inline pte_t pte_mkwrite(pte_t pte)      { set_pte(&pte, __pte(pte_val(pte) | _PAGE_WRITE)); return pte; }
276 static inline pte_t pte_mkdirty(pte_t pte)      { set_pte(&pte, __pte(pte_val(pte) | _PAGE_DIRTY)); return pte; }
277 static inline pte_t pte_mkyoung(pte_t pte)      { set_pte(&pte, __pte(pte_val(pte) | _PAGE_ACCESSED)); return pte; }
278 static inline pte_t pte_mkhuge(pte_t pte)       { set_pte(&pte, __pte(pte_val(pte) | _PAGE_SZHUGE)); return pte; }
279 static inline pte_t pte_mkspecial(pte_t pte)    { set_pte(&pte, __pte(pte_val(pte) | _PAGE_SPECIAL)); return pte; }
280
281 /*
282  * Conversion functions: convert a page and protection to a page entry.
283  *
284  * extern pte_t mk_pte(struct page *page, pgprot_t pgprot)
285  */
286 #define mk_pte(page,pgprot)                                                     \
287 ({                                                                              \
288         pte_t __pte;                                                            \
289                                                                                 \
290         set_pte(&__pte, __pte((((page)-mem_map) << PAGE_SHIFT) |                \
291                 __MEMORY_START | pgprot_val((pgprot))));                        \
292         __pte;                                                                  \
293 })
294
295 /*
296  * This takes a (absolute) physical page address that is used
297  * by the remapping functions
298  */
299 #define mk_pte_phys(physpage, pgprot) \
300 ({ pte_t __pte; set_pte(&__pte, __pte(physpage | pgprot_val(pgprot))); __pte; })
301
302 static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
303 { set_pte(&pte, __pte((pte_val(pte) & _PAGE_CHG_MASK) | pgprot_val(newprot))); return pte; }
304
305 /* Encode and decode a swap entry */
306 #define __swp_type(x)                   (((x).val & 3) + (((x).val >> 1) & 0x3c))
307 #define __swp_offset(x)                 ((x).val >> 8)
308 #define __swp_entry(type, offset)       ((swp_entry_t) { ((offset << 8) + ((type & 0x3c) << 1) + (type & 3)) })
309 #define __pte_to_swp_entry(pte)         ((swp_entry_t) { pte_val(pte) })
310 #define __swp_entry_to_pte(x)           ((pte_t) { (x).val })
311
312 /* Encode and decode a nonlinear file mapping entry */
313 #define PTE_FILE_MAX_BITS               29
314 #define pte_to_pgoff(pte)               (pte_val(pte))
315 #define pgoff_to_pte(off)               ((pte_t) { (off) | _PAGE_FILE })
316
317 #endif /* !__ASSEMBLY__ */
318
319 #define pfn_pte(pfn, prot)      __pte(((pfn) << PAGE_SHIFT) | pgprot_val(prot))
320 #define pfn_pmd(pfn, prot)      __pmd(((pfn) << PAGE_SHIFT) | pgprot_val(prot))
321
322 #endif /* __ASM_SH_PGTABLE_64_H */