This commit was manufactured by cvs2svn to create tag
[linux-2.6.git] / include / asm-sparc64 / pgtable.h
1 /* $Id: pgtable.h,v 1.156 2002/02/09 19:49:31 davem Exp $
2  * pgtable.h: SpitFire page table operations.
3  *
4  * Copyright 1996,1997 David S. Miller (davem@caip.rutgers.edu)
5  * Copyright 1997,1998 Jakub Jelinek (jj@sunsite.mff.cuni.cz)
6  */
7
8 #ifndef _SPARC64_PGTABLE_H
9 #define _SPARC64_PGTABLE_H
10
11 /* This file contains the functions and defines necessary to modify and use
12  * the SpitFire page tables.
13  */
14
15 #include <linux/config.h>
16 #include <asm/spitfire.h>
17 #include <asm/asi.h>
18 #include <asm/system.h>
19 #include <asm/page.h>
20 #include <asm/processor.h>
21 #include <asm/const.h>
22
23 /* The kernel image occupies 0x4000000 to 0x1000000 (4MB --> 16MB).
24  * The page copy blockops use 0x1000000 to 0x18000000 (16MB --> 24MB).
25  * The PROM resides in an area spanning 0xf0000000 to 0x100000000.
26  * The vmalloc area spans 0x140000000 to 0x200000000.
27  * There is a single static kernel PMD which maps from 0x0 to address
28  * 0x400000000.
29  */
30 #define TLBTEMP_BASE            _AC(0x0000000001000000,UL)
31 #define MODULES_VADDR           _AC(0x0000000002000000,UL)
32 #define MODULES_LEN             _AC(0x000000007e000000,UL)
33 #define MODULES_END             _AC(0x0000000080000000,UL)
34 #define VMALLOC_START           _AC(0x0000000140000000,UL)
35 #define VMALLOC_END             _AC(0x0000000200000000,UL)
36 #define LOW_OBP_ADDRESS         _AC(0x00000000f0000000,UL)
37 #define HI_OBP_ADDRESS          _AC(0x0000000100000000,UL)
38
39 /* XXX All of this needs to be rethought so we can take advantage
40  * XXX cheetah's full 64-bit virtual address space, ie. no more hole
41  * XXX in the middle like on spitfire. -DaveM
42  */
43 /*
44  * Given a virtual address, the lowest PAGE_SHIFT bits determine offset
45  * into the page; the next higher PAGE_SHIFT-3 bits determine the pte#
46  * in the proper pagetable (the -3 is from the 8 byte ptes, and each page
47  * table is a single page long). The next higher PMD_BITS determine pmd# 
48  * in the proper pmdtable (where we must have PMD_BITS <= (PAGE_SHIFT-2) 
49  * since the pmd entries are 4 bytes, and each pmd page is a single page 
50  * long). Finally, the higher few bits determine pgde#.
51  */
52
53 /* PMD_SHIFT determines the size of the area a second-level page
54  * table can map
55  */
56 #define PMD_SHIFT       (PAGE_SHIFT + (PAGE_SHIFT-3))
57 #define PMD_SIZE        (1UL << PMD_SHIFT)
58 #define PMD_MASK        (~(PMD_SIZE-1))
59 #define PMD_BITS        11
60
61 /* PGDIR_SHIFT determines what a third-level page table entry can map */
62 #define PGDIR_SHIFT     (PAGE_SHIFT + (PAGE_SHIFT-3) + PMD_BITS)
63 #define PGDIR_SIZE      (1UL << PGDIR_SHIFT)
64 #define PGDIR_MASK      (~(PGDIR_SIZE-1))
65
66 #ifndef __ASSEMBLY__
67
68 #include <linux/sched.h>
69
70 /* Certain architectures need to do special things when pte's
71  * within a page table are directly modified.  Thus, the following
72  * hook is made available.
73  */
74 #define set_pte(pteptr, pteval) ((*(pteptr)) = (pteval))
75
76 /* Entries per page directory level. */
77 #define PTRS_PER_PTE            (1UL << (PAGE_SHIFT-3))
78
79 /* We the first one in this file, what we export to the kernel
80  * is different so we can optimize correctly for 32-bit tasks.
81  */
82 #define REAL_PTRS_PER_PMD       (1UL << PMD_BITS)
83 #define PTRS_PER_PMD            ((const int)(test_thread_flag(TIF_32BIT) ? \
84                                  (1UL << (32 - (PAGE_SHIFT-3) - PAGE_SHIFT)) : \
85                                  (REAL_PTRS_PER_PMD)))
86
87 /*
88  * We cannot use the top address range because VPTE table lives there. This
89  * formula finds the total legal virtual space in the processor, subtracts the
90  * vpte size, then aligns it to the number of bytes mapped by one pgde, and
91  * thus calculates the number of pgdes needed.
92  */
93 #define PTRS_PER_PGD (((1UL << VA_BITS) - VPTE_SIZE + (1UL << (PAGE_SHIFT + \
94                       (PAGE_SHIFT-3) + PMD_BITS)) - 1) / (1UL << (PAGE_SHIFT + \
95                       (PAGE_SHIFT-3) + PMD_BITS)))
96
97 /* Kernel has a separate 44bit address space. */
98 #define USER_PTRS_PER_PGD       ((const int)(test_thread_flag(TIF_32BIT)) ? \
99                                  (1) : (PTRS_PER_PGD))
100 #define FIRST_USER_PGD_NR       0
101
102 #define pte_ERROR(e)    __builtin_trap()
103 #define pmd_ERROR(e)    __builtin_trap()
104 #define pgd_ERROR(e)    __builtin_trap()
105
106 #endif /* !(__ASSEMBLY__) */
107
108 /* Spitfire/Cheetah TTE bits. */
109 #define _PAGE_VALID     _AC(0x8000000000000000,UL) /* Valid TTE              */
110 #define _PAGE_R         _AC(0x8000000000000000,UL) /* Keep ref bit up to date*/
111 #define _PAGE_SZ4MB     _AC(0x6000000000000000,UL) /* 4MB Page               */
112 #define _PAGE_SZ512K    _AC(0x4000000000000000,UL) /* 512K Page              */
113 #define _PAGE_SZ64K     _AC(0x2000000000000000,UL) /* 64K Page               */
114 #define _PAGE_SZ8K      _AC(0x0000000000000000,UL) /* 8K Page                */
115 #define _PAGE_NFO       _AC(0x1000000000000000,UL) /* No Fault Only          */
116 #define _PAGE_IE        _AC(0x0800000000000000,UL) /* Invert Endianness      */
117 #define _PAGE_SOFT2     _AC(0x07FC000000000000,UL) /* Software bits, set 2   */
118 #define _PAGE_RES1      _AC(0x0003000000000000,UL) /* Reserved               */
119 #define _PAGE_SN        _AC(0x0000800000000000,UL) /* (Cheetah) Snoop        */
120 #define _PAGE_RES2      _AC(0x0000780000000000,UL) /* Reserved               */
121 #define _PAGE_PADDR_SF  _AC(0x000001FFFFFFE000,UL) /* (Spitfire) paddr[40:13]*/
122 #define _PAGE_PADDR     _AC(0x000007FFFFFFE000,UL) /* (Cheetah) paddr[42:13] */
123 #define _PAGE_SOFT      _AC(0x0000000000001F80,UL) /* Software bits          */
124 #define _PAGE_L         _AC(0x0000000000000040,UL) /* Locked TTE             */
125 #define _PAGE_CP        _AC(0x0000000000000020,UL) /* Cacheable in P-Cache   */
126 #define _PAGE_CV        _AC(0x0000000000000010,UL) /* Cacheable in V-Cache   */
127 #define _PAGE_E         _AC(0x0000000000000008,UL) /* side-Effect            */
128 #define _PAGE_P         _AC(0x0000000000000004,UL) /* Privileged Page        */
129 #define _PAGE_W         _AC(0x0000000000000002,UL) /* Writable               */
130 #define _PAGE_G         _AC(0x0000000000000001,UL) /* Global                 */
131
132 /* Here are the SpitFire software bits we use in the TTE's.
133  *
134  * WARNING: If you are going to try and start using some
135  *          of the soft2 bits, you will need to make
136  *          modifications to the swap entry implementation.
137  *          For example, one thing that could happen is that
138  *          swp_entry_to_pte() would BUG_ON() if you tried
139  *          to use one of the soft2 bits for _PAGE_FILE.
140  *
141  * Like other architectures, I have aliased _PAGE_FILE with
142  * _PAGE_MODIFIED.  This works because _PAGE_FILE is never
143  * interpreted that way unless _PAGE_PRESENT is clear.
144  */
145 #define _PAGE_EXEC      _AC(0x0000000000001000,UL)      /* Executable SW bit */
146 #define _PAGE_MODIFIED  _AC(0x0000000000000800,UL)      /* Modified (dirty)  */
147 #define _PAGE_FILE      _AC(0x0000000000000800,UL)      /* Pagecache page    */
148 #define _PAGE_ACCESSED  _AC(0x0000000000000400,UL)      /* Accessed (ref'd)  */
149 #define _PAGE_READ      _AC(0x0000000000000200,UL)      /* Readable SW Bit   */
150 #define _PAGE_WRITE     _AC(0x0000000000000100,UL)      /* Writable SW Bit   */
151 #define _PAGE_PRESENT   _AC(0x0000000000000080,UL)      /* Present           */
152
153 #if PAGE_SHIFT == 13
154 #define _PAGE_SZBITS    _PAGE_SZ8K
155 #elif PAGE_SHIFT == 16
156 #define _PAGE_SZBITS    _PAGE_SZ64K
157 #elif PAGE_SHIFT == 19
158 #define _PAGE_SZBITS    _PAGE_SZ512K
159 #elif PAGE_SHIFT == 22
160 #define _PAGE_SZBITS    _PAGE_SZ4MB
161 #else
162 #error Wrong PAGE_SHIFT specified
163 #endif
164
165 #if defined(CONFIG_HUGETLB_PAGE_SIZE_4MB)
166 #define _PAGE_SZHUGE    _PAGE_SZ4MB
167 #elif defined(CONFIG_HUGETLB_PAGE_SIZE_512K)
168 #define _PAGE_SZHUGE    _PAGE_SZ512K
169 #elif defined(CONFIG_HUGETLB_PAGE_SIZE_64K)
170 #define _PAGE_SZHUGE    _PAGE_SZ64K
171 #endif
172
173 #define _PAGE_CACHE     (_PAGE_CP | _PAGE_CV)
174
175 #define __DIRTY_BITS    (_PAGE_MODIFIED | _PAGE_WRITE | _PAGE_W)
176 #define __ACCESS_BITS   (_PAGE_ACCESSED | _PAGE_READ | _PAGE_R)
177 #define __PRIV_BITS     _PAGE_P
178
179 #define PAGE_NONE       __pgprot (_PAGE_PRESENT | _PAGE_ACCESSED | _PAGE_CACHE)
180
181 /* Don't set the TTE _PAGE_W bit here, else the dirty bit never gets set. */
182 #define PAGE_SHARED     __pgprot (_PAGE_PRESENT | _PAGE_VALID | _PAGE_CACHE | \
183                                   __ACCESS_BITS | _PAGE_WRITE | _PAGE_EXEC)
184
185 #define PAGE_COPY       __pgprot (_PAGE_PRESENT | _PAGE_VALID | _PAGE_CACHE | \
186                                   __ACCESS_BITS | _PAGE_EXEC)
187
188 #define PAGE_READONLY   __pgprot (_PAGE_PRESENT | _PAGE_VALID | _PAGE_CACHE | \
189                                   __ACCESS_BITS | _PAGE_EXEC)
190
191 #define PAGE_KERNEL     __pgprot (_PAGE_PRESENT | _PAGE_VALID | _PAGE_CACHE | \
192                                   __PRIV_BITS | \
193                                   __ACCESS_BITS | __DIRTY_BITS | _PAGE_EXEC)
194
195 #define PAGE_SHARED_NOEXEC      __pgprot (_PAGE_PRESENT | _PAGE_VALID | \
196                                           _PAGE_CACHE | \
197                                           __ACCESS_BITS | _PAGE_WRITE)
198
199 #define PAGE_COPY_NOEXEC        __pgprot (_PAGE_PRESENT | _PAGE_VALID | \
200                                           _PAGE_CACHE | __ACCESS_BITS)
201
202 #define PAGE_READONLY_NOEXEC    __pgprot (_PAGE_PRESENT | _PAGE_VALID | \
203                                           _PAGE_CACHE | __ACCESS_BITS)
204
205 #define _PFN_MASK       _PAGE_PADDR
206
207 #define pg_iobits (_PAGE_VALID | _PAGE_PRESENT | __DIRTY_BITS | \
208                    __ACCESS_BITS | _PAGE_E)
209
210 #define __P000  PAGE_NONE
211 #define __P001  PAGE_READONLY_NOEXEC
212 #define __P010  PAGE_COPY_NOEXEC
213 #define __P011  PAGE_COPY_NOEXEC
214 #define __P100  PAGE_READONLY
215 #define __P101  PAGE_READONLY
216 #define __P110  PAGE_COPY
217 #define __P111  PAGE_COPY
218
219 #define __S000  PAGE_NONE
220 #define __S001  PAGE_READONLY_NOEXEC
221 #define __S010  PAGE_SHARED_NOEXEC
222 #define __S011  PAGE_SHARED_NOEXEC
223 #define __S100  PAGE_READONLY
224 #define __S101  PAGE_READONLY
225 #define __S110  PAGE_SHARED
226 #define __S111  PAGE_SHARED
227
228 #ifndef __ASSEMBLY__
229
230 extern unsigned long phys_base;
231 extern unsigned long pfn_base;
232
233 extern struct page *mem_map_zero;
234 #define ZERO_PAGE(vaddr)        (mem_map_zero)
235
236 /* PFNs are real physical page numbers.  However, mem_map only begins to record
237  * per-page information starting at pfn_base.  This is to handle systems where
238  * the first physical page in the machine is at some huge physical address, such
239  * as 4GB.   This is common on a partitioned E10000, for example.
240  */
241
242 #define pfn_pte(pfn, prot)      \
243         __pte(((pfn) << PAGE_SHIFT) | pgprot_val(prot) | _PAGE_SZBITS)
244 #define mk_pte(page, pgprot)    pfn_pte(page_to_pfn(page), (pgprot))
245
246 #define pte_pfn(x)              ((pte_val(x) & _PAGE_PADDR)>>PAGE_SHIFT)
247 #define pte_page(x)             pfn_to_page(pte_pfn(x))
248
249 #define page_pte_prot(page, prot)       mk_pte(page, prot)
250 #define page_pte(page)                  page_pte_prot(page, __pgprot(0))
251
252 static inline pte_t pte_modify(pte_t orig_pte, pgprot_t new_prot)
253 {
254         pte_t __pte;
255         const unsigned long preserve_mask = (_PFN_MASK |
256                                              _PAGE_MODIFIED | _PAGE_ACCESSED |
257                                              _PAGE_CACHE | _PAGE_E |
258                                              _PAGE_PRESENT | _PAGE_SZBITS);
259
260         pte_val(__pte) = (pte_val(orig_pte) & preserve_mask) |
261                 (pgprot_val(new_prot) & ~preserve_mask);
262
263         return __pte;
264 }
265 #define pmd_set(pmdp, ptep)     \
266         (pmd_val(*(pmdp)) = (__pa((unsigned long) (ptep)) >> 11UL))
267 #define pgd_set(pgdp, pmdp)     \
268         (pgd_val(*(pgdp)) = (__pa((unsigned long) (pmdp)) >> 11UL))
269 #define __pmd_page(pmd)         \
270         ((unsigned long) __va((((unsigned long)pmd_val(pmd))<<11UL)))
271 #define pmd_page(pmd)                   virt_to_page((void *)__pmd_page(pmd))
272 #define pgd_page(pgd)           \
273         ((unsigned long) __va((((unsigned long)pgd_val(pgd))<<11UL)))
274 #define pte_none(pte)                   (!pte_val(pte))
275 #define pte_present(pte)                (pte_val(pte) & _PAGE_PRESENT)
276 #define pte_clear(pte)                  (pte_val(*(pte)) = 0UL)
277 #define pmd_none(pmd)                   (!pmd_val(pmd))
278 #define pmd_bad(pmd)                    (0)
279 #define pmd_present(pmd)                (pmd_val(pmd) != 0U)
280 #define pmd_clear(pmdp)                 (pmd_val(*(pmdp)) = 0U)
281 #define pgd_none(pgd)                   (!pgd_val(pgd))
282 #define pgd_bad(pgd)                    (0)
283 #define pgd_present(pgd)                (pgd_val(pgd) != 0U)
284 #define pgd_clear(pgdp)                 (pgd_val(*(pgdp)) = 0U)
285
286 /* The following only work if pte_present() is true.
287  * Undefined behaviour if not..
288  */
289 #define pte_read(pte)           (pte_val(pte) & _PAGE_READ)
290 #define pte_exec(pte)           pte_read(pte)
291 #define pte_write(pte)          (pte_val(pte) & _PAGE_WRITE)
292 #define pte_dirty(pte)          (pte_val(pte) & _PAGE_MODIFIED)
293 #define pte_young(pte)          (pte_val(pte) & _PAGE_ACCESSED)
294 #define pte_wrprotect(pte)      (__pte(pte_val(pte) & ~(_PAGE_WRITE|_PAGE_W)))
295 #define pte_rdprotect(pte)      \
296         (__pte(((pte_val(pte)<<1UL)>>1UL) & ~_PAGE_READ))
297 #define pte_mkclean(pte)        \
298         (__pte(pte_val(pte) & ~(_PAGE_MODIFIED|_PAGE_W)))
299 #define pte_mkold(pte)          \
300         (__pte(((pte_val(pte)<<1UL)>>1UL) & ~_PAGE_ACCESSED))
301
302 /* Permanent address of a page. */
303 #define __page_address(page)    page_address(page)
304
305 /* Be very careful when you change these three, they are delicate. */
306 #define pte_mkyoung(pte)        (__pte(pte_val(pte) | _PAGE_ACCESSED | _PAGE_R))
307 #define pte_mkwrite(pte)        (__pte(pte_val(pte) | _PAGE_WRITE))
308 #define pte_mkdirty(pte)        (__pte(pte_val(pte) | _PAGE_MODIFIED | _PAGE_W))
309
310 /* to find an entry in a page-table-directory. */
311 #define pgd_index(address)      (((address) >> PGDIR_SHIFT) & (PTRS_PER_PGD))
312 #define pgd_offset(mm, address) ((mm)->pgd + pgd_index(address))
313
314 /* to find an entry in a kernel page-table-directory */
315 #define pgd_offset_k(address) pgd_offset(&init_mm, address)
316
317 /* Find an entry in the second-level page table.. */
318 #define pmd_offset(dir, address)        \
319         ((pmd_t *) pgd_page(*(dir)) + \
320          ((address >> PMD_SHIFT) & (REAL_PTRS_PER_PMD-1)))
321
322 /* Find an entry in the third-level page table.. */
323 #define pte_index(dir, address) \
324         ((pte_t *) __pmd_page(*(dir)) + \
325          ((address >> PAGE_SHIFT) & (PTRS_PER_PTE - 1)))
326 #define pte_offset_kernel               pte_index
327 #define pte_offset_map                  pte_index
328 #define pte_offset_map_nested           pte_index
329 #define pte_unmap(pte)                  do { } while (0)
330 #define pte_unmap_nested(pte)           do { } while (0)
331
332 extern pgd_t swapper_pg_dir[1];
333
334 /* These do nothing with the way I have things setup. */
335 #define mmu_lockarea(vaddr, len)                (vaddr)
336 #define mmu_unlockarea(vaddr, len)              do { } while(0)
337
338 struct vm_area_struct;
339 extern void update_mmu_cache(struct vm_area_struct *, unsigned long, pte_t);
340
341 /* Make a non-present pseudo-TTE. */
342 static inline pte_t mk_pte_io(unsigned long page, pgprot_t prot, int space)
343 {
344         pte_t pte;
345         pte_val(pte) = (((page) | pgprot_val(prot) | _PAGE_E) &
346                         ~(unsigned long)_PAGE_CACHE);
347         pte_val(pte) |= (((unsigned long)space) << 32);
348         return pte;
349 }
350
351 /* Encode and de-code a swap entry */
352 #define __swp_type(entry)       (((entry).val >> PAGE_SHIFT) & 0xffUL)
353 #define __swp_offset(entry)     ((entry).val >> (PAGE_SHIFT + 8UL))
354 #define __swp_entry(type, offset)       \
355         ( (swp_entry_t) \
356           { \
357                 (((long)(type) << PAGE_SHIFT) | \
358                  ((long)(offset) << (PAGE_SHIFT + 8UL))) \
359           } )
360 #define __pte_to_swp_entry(pte)         ((swp_entry_t) { pte_val(pte) })
361 #define __swp_entry_to_pte(x)           ((pte_t) { (x).val })
362
363 /* File offset in PTE support. */
364 #define pte_file(pte)           (pte_val(pte) & _PAGE_FILE)
365 #define pte_to_pgoff(pte)       (pte_val(pte) >> PAGE_SHIFT)
366 #define pgoff_to_pte(off)       (__pte(((off) << PAGE_SHIFT) | _PAGE_FILE))
367 #define PTE_FILE_MAX_BITS       (64UL - PAGE_SHIFT - 1UL)
368
369 extern unsigned long prom_virt_to_phys(unsigned long, int *);
370
371 static __inline__ unsigned long
372 sun4u_get_pte (unsigned long addr)
373 {
374         pgd_t *pgdp;
375         pmd_t *pmdp;
376         pte_t *ptep;
377
378         if (addr >= PAGE_OFFSET)
379                 return addr & _PAGE_PADDR;
380         if ((addr >= LOW_OBP_ADDRESS) && (addr < HI_OBP_ADDRESS))
381                 return prom_virt_to_phys(addr, NULL);
382         pgdp = pgd_offset_k(addr);
383         pmdp = pmd_offset(pgdp, addr);
384         ptep = pte_offset_kernel(pmdp, addr);
385         return pte_val(*ptep) & _PAGE_PADDR;
386 }
387
388 static __inline__ unsigned long
389 __get_phys (unsigned long addr)
390 {
391         return sun4u_get_pte (addr);
392 }
393
394 static __inline__ int
395 __get_iospace (unsigned long addr)
396 {
397         return ((sun4u_get_pte (addr) & 0xf0000000) >> 28);
398 }
399
400 extern unsigned long *sparc64_valid_addr_bitmap;
401
402 /* Needs to be defined here and not in linux/mm.h, as it is arch dependent */
403 #define kern_addr_valid(addr)   \
404         (test_bit(__pa((unsigned long)(addr))>>22, sparc64_valid_addr_bitmap))
405
406 extern int io_remap_page_range(struct vm_area_struct *vma, unsigned long from,
407                                unsigned long offset,
408                                unsigned long size, pgprot_t prot, int space);
409
410 #include <asm-generic/pgtable.h>
411
412 /* We provide our own get_unmapped_area to cope with VA holes for userland */
413 #define HAVE_ARCH_UNMAPPED_AREA
414
415 /* We provide a special get_unmapped_area for framebuffer mmaps to try and use
416  * the largest alignment possible such that larget PTEs can be used.
417  */
418 extern unsigned long get_fb_unmapped_area(struct file *filp, unsigned long,
419                                           unsigned long, unsigned long,
420                                           unsigned long);
421 #define HAVE_ARCH_FB_UNMAPPED_AREA
422
423 /*
424  * No page table caches to initialise
425  */
426 #define pgtable_cache_init()    do { } while (0)
427
428 extern void check_pgt_cache(void);
429
430 #endif /* !(__ASSEMBLY__) */
431
432 #endif /* !(_SPARC64_PGTABLE_H) */