[CONNECTOR]: Update documentation to match reality.
[linux-2.6/verdex.git] / include / asm-sparc / pgtable.h
bloba14e9867750047ded9a76449f5a21c7f0b0e5d1d
1 /* $Id: pgtable.h,v 1.110 2001/12/21 04:56:17 davem Exp $ */
2 #ifndef _SPARC_PGTABLE_H
3 #define _SPARC_PGTABLE_H
5 /* asm-sparc/pgtable.h: Defines and functions used to work
6 * with Sparc page tables.
8 * Copyright (C) 1995 David S. Miller (davem@caip.rutgers.edu)
9 * Copyright (C) 1998 Jakub Jelinek (jj@sunsite.mff.cuni.cz)
12 #include <asm-generic/4level-fixup.h>
14 #include <linux/config.h>
15 #include <linux/spinlock.h>
16 #include <linux/swap.h>
17 #include <asm/types.h>
18 #ifdef CONFIG_SUN4
19 #include <asm/pgtsun4.h>
20 #else
21 #include <asm/pgtsun4c.h>
22 #endif
23 #include <asm/pgtsrmmu.h>
24 #include <asm/vac-ops.h>
25 #include <asm/oplib.h>
26 #include <asm/btfixup.h>
27 #include <asm/system.h>
29 #ifndef __ASSEMBLY__
31 struct vm_area_struct;
32 struct page;
34 extern void load_mmu(void);
35 extern unsigned long calc_highpages(void);
37 BTFIXUPDEF_SIMM13(pgdir_shift)
38 BTFIXUPDEF_SETHI(pgdir_size)
39 BTFIXUPDEF_SETHI(pgdir_mask)
41 BTFIXUPDEF_SIMM13(ptrs_per_pmd)
42 BTFIXUPDEF_SIMM13(ptrs_per_pgd)
43 BTFIXUPDEF_SIMM13(user_ptrs_per_pgd)
45 #define pte_ERROR(e) __builtin_trap()
46 #define pmd_ERROR(e) __builtin_trap()
47 #define pgd_ERROR(e) __builtin_trap()
49 BTFIXUPDEF_INT(page_none)
50 BTFIXUPDEF_INT(page_shared)
51 BTFIXUPDEF_INT(page_copy)
52 BTFIXUPDEF_INT(page_readonly)
53 BTFIXUPDEF_INT(page_kernel)
55 #define PMD_SHIFT SUN4C_PMD_SHIFT
56 #define PMD_SIZE (1UL << PMD_SHIFT)
57 #define PMD_MASK (~(PMD_SIZE-1))
58 #define PMD_ALIGN(__addr) (((__addr) + ~PMD_MASK) & PMD_MASK)
59 #define PGDIR_SHIFT BTFIXUP_SIMM13(pgdir_shift)
60 #define PGDIR_SIZE BTFIXUP_SETHI(pgdir_size)
61 #define PGDIR_MASK BTFIXUP_SETHI(pgdir_mask)
62 #define PTRS_PER_PTE 1024
63 #define PTRS_PER_PMD BTFIXUP_SIMM13(ptrs_per_pmd)
64 #define PTRS_PER_PGD BTFIXUP_SIMM13(ptrs_per_pgd)
65 #define USER_PTRS_PER_PGD BTFIXUP_SIMM13(user_ptrs_per_pgd)
66 #define FIRST_USER_ADDRESS 0
67 #define PTE_SIZE (PTRS_PER_PTE*4)
69 #define PAGE_NONE __pgprot(BTFIXUP_INT(page_none))
70 #define PAGE_SHARED __pgprot(BTFIXUP_INT(page_shared))
71 #define PAGE_COPY __pgprot(BTFIXUP_INT(page_copy))
72 #define PAGE_READONLY __pgprot(BTFIXUP_INT(page_readonly))
74 extern unsigned long page_kernel;
76 #ifdef MODULE
77 #define PAGE_KERNEL page_kernel
78 #else
79 #define PAGE_KERNEL __pgprot(BTFIXUP_INT(page_kernel))
80 #endif
82 /* Top-level page directory */
83 extern pgd_t swapper_pg_dir[1024];
85 extern void paging_init(void);
87 /* Page table for 0-4MB for everybody, on the Sparc this
88 * holds the same as on the i386.
90 extern pte_t pg0[1024];
91 extern pte_t pg1[1024];
92 extern pte_t pg2[1024];
93 extern pte_t pg3[1024];
95 extern unsigned long ptr_in_current_pgd;
97 /* Here is a trick, since mmap.c need the initializer elements for
98 * protection_map[] to be constant at compile time, I set the following
99 * to all zeros. I set it to the real values after I link in the
100 * appropriate MMU page table routines at boot time.
102 #define __P000 __pgprot(0)
103 #define __P001 __pgprot(0)
104 #define __P010 __pgprot(0)
105 #define __P011 __pgprot(0)
106 #define __P100 __pgprot(0)
107 #define __P101 __pgprot(0)
108 #define __P110 __pgprot(0)
109 #define __P111 __pgprot(0)
111 #define __S000 __pgprot(0)
112 #define __S001 __pgprot(0)
113 #define __S010 __pgprot(0)
114 #define __S011 __pgprot(0)
115 #define __S100 __pgprot(0)
116 #define __S101 __pgprot(0)
117 #define __S110 __pgprot(0)
118 #define __S111 __pgprot(0)
120 extern int num_contexts;
122 /* First physical page can be anywhere, the following is needed so that
123 * va-->pa and vice versa conversions work properly without performance
124 * hit for all __pa()/__va() operations.
126 extern unsigned long phys_base;
127 extern unsigned long pfn_base;
130 * BAD_PAGETABLE is used when we need a bogus page-table, while
131 * BAD_PAGE is used for a bogus page.
133 * ZERO_PAGE is a global shared page that is always zero: used
134 * for zero-mapped memory areas etc..
136 extern pte_t * __bad_pagetable(void);
137 extern pte_t __bad_page(void);
138 extern unsigned long empty_zero_page;
140 #define BAD_PAGETABLE __bad_pagetable()
141 #define BAD_PAGE __bad_page()
142 #define ZERO_PAGE(vaddr) (virt_to_page(&empty_zero_page))
146 BTFIXUPDEF_CALL_CONST(struct page *, pmd_page, pmd_t)
147 BTFIXUPDEF_CALL_CONST(unsigned long, pgd_page, pgd_t)
149 #define pmd_page(pmd) BTFIXUP_CALL(pmd_page)(pmd)
150 #define pgd_page(pgd) BTFIXUP_CALL(pgd_page)(pgd)
152 BTFIXUPDEF_SETHI(none_mask)
153 BTFIXUPDEF_CALL_CONST(int, pte_present, pte_t)
154 BTFIXUPDEF_CALL(void, pte_clear, pte_t *)
155 BTFIXUPDEF_CALL(int, pte_read, pte_t)
157 static inline int pte_none(pte_t pte)
159 return !(pte_val(pte) & ~BTFIXUP_SETHI(none_mask));
162 #define pte_present(pte) BTFIXUP_CALL(pte_present)(pte)
163 #define pte_clear(mm,addr,pte) BTFIXUP_CALL(pte_clear)(pte)
164 #define pte_read(pte) BTFIXUP_CALL(pte_read)(pte)
166 BTFIXUPDEF_CALL_CONST(int, pmd_bad, pmd_t)
167 BTFIXUPDEF_CALL_CONST(int, pmd_present, pmd_t)
168 BTFIXUPDEF_CALL(void, pmd_clear, pmd_t *)
170 static inline int pmd_none(pmd_t pmd)
172 return !(pmd_val(pmd) & ~BTFIXUP_SETHI(none_mask));
175 #define pmd_bad(pmd) BTFIXUP_CALL(pmd_bad)(pmd)
176 #define pmd_present(pmd) BTFIXUP_CALL(pmd_present)(pmd)
177 #define pmd_clear(pmd) BTFIXUP_CALL(pmd_clear)(pmd)
179 BTFIXUPDEF_CALL_CONST(int, pgd_none, pgd_t)
180 BTFIXUPDEF_CALL_CONST(int, pgd_bad, pgd_t)
181 BTFIXUPDEF_CALL_CONST(int, pgd_present, pgd_t)
182 BTFIXUPDEF_CALL(void, pgd_clear, pgd_t *)
184 #define pgd_none(pgd) BTFIXUP_CALL(pgd_none)(pgd)
185 #define pgd_bad(pgd) BTFIXUP_CALL(pgd_bad)(pgd)
186 #define pgd_present(pgd) BTFIXUP_CALL(pgd_present)(pgd)
187 #define pgd_clear(pgd) BTFIXUP_CALL(pgd_clear)(pgd)
190 * The following only work if pte_present() is true.
191 * Undefined behaviour if not..
193 BTFIXUPDEF_HALF(pte_writei)
194 BTFIXUPDEF_HALF(pte_dirtyi)
195 BTFIXUPDEF_HALF(pte_youngi)
197 static int pte_write(pte_t pte) __attribute_const__;
198 static inline int pte_write(pte_t pte)
200 return pte_val(pte) & BTFIXUP_HALF(pte_writei);
203 static int pte_dirty(pte_t pte) __attribute_const__;
204 static inline int pte_dirty(pte_t pte)
206 return pte_val(pte) & BTFIXUP_HALF(pte_dirtyi);
209 static int pte_young(pte_t pte) __attribute_const__;
210 static inline int pte_young(pte_t pte)
212 return pte_val(pte) & BTFIXUP_HALF(pte_youngi);
216 * The following only work if pte_present() is not true.
218 BTFIXUPDEF_HALF(pte_filei)
220 static int pte_file(pte_t pte) __attribute_const__;
221 static inline int pte_file(pte_t pte)
223 return pte_val(pte) & BTFIXUP_HALF(pte_filei);
228 BTFIXUPDEF_HALF(pte_wrprotecti)
229 BTFIXUPDEF_HALF(pte_mkcleani)
230 BTFIXUPDEF_HALF(pte_mkoldi)
232 static pte_t pte_wrprotect(pte_t pte) __attribute_const__;
233 static inline pte_t pte_wrprotect(pte_t pte)
235 return __pte(pte_val(pte) & ~BTFIXUP_HALF(pte_wrprotecti));
238 static pte_t pte_mkclean(pte_t pte) __attribute_const__;
239 static inline pte_t pte_mkclean(pte_t pte)
241 return __pte(pte_val(pte) & ~BTFIXUP_HALF(pte_mkcleani));
244 static pte_t pte_mkold(pte_t pte) __attribute_const__;
245 static inline pte_t pte_mkold(pte_t pte)
247 return __pte(pte_val(pte) & ~BTFIXUP_HALF(pte_mkoldi));
250 BTFIXUPDEF_CALL_CONST(pte_t, pte_mkwrite, pte_t)
251 BTFIXUPDEF_CALL_CONST(pte_t, pte_mkdirty, pte_t)
252 BTFIXUPDEF_CALL_CONST(pte_t, pte_mkyoung, pte_t)
254 #define pte_mkwrite(pte) BTFIXUP_CALL(pte_mkwrite)(pte)
255 #define pte_mkdirty(pte) BTFIXUP_CALL(pte_mkdirty)(pte)
256 #define pte_mkyoung(pte) BTFIXUP_CALL(pte_mkyoung)(pte)
258 #define page_pte_prot(page, prot) mk_pte(page, prot)
259 #define page_pte(page) mk_pte(page, __pgprot(0))
260 #define pfn_pte(pfn, prot) mk_pte(pfn_to_page(pfn), prot)
262 BTFIXUPDEF_CALL(unsigned long, pte_pfn, pte_t)
263 #define pte_pfn(pte) BTFIXUP_CALL(pte_pfn)(pte)
264 #define pte_page(pte) pfn_to_page(pte_pfn(pte))
267 * Conversion functions: convert a page and protection to a page entry,
268 * and a page entry and page directory to the page they refer to.
270 BTFIXUPDEF_CALL_CONST(pte_t, mk_pte, struct page *, pgprot_t)
272 BTFIXUPDEF_CALL_CONST(pte_t, mk_pte_phys, unsigned long, pgprot_t)
273 BTFIXUPDEF_CALL_CONST(pte_t, mk_pte_io, unsigned long, pgprot_t, int)
275 #define mk_pte(page,pgprot) BTFIXUP_CALL(mk_pte)(page,pgprot)
276 #define mk_pte_phys(page,pgprot) BTFIXUP_CALL(mk_pte_phys)(page,pgprot)
277 #define mk_pte_io(page,pgprot,space) BTFIXUP_CALL(mk_pte_io)(page,pgprot,space)
279 BTFIXUPDEF_INT(pte_modify_mask)
281 static pte_t pte_modify(pte_t pte, pgprot_t newprot) __attribute_const__;
282 static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
284 return __pte((pte_val(pte) & BTFIXUP_INT(pte_modify_mask)) |
285 pgprot_val(newprot));
288 #define pgd_index(address) ((address) >> PGDIR_SHIFT)
290 /* to find an entry in a page-table-directory */
291 #define pgd_offset(mm, address) ((mm)->pgd + pgd_index(address))
293 /* to find an entry in a kernel page-table-directory */
294 #define pgd_offset_k(address) pgd_offset(&init_mm, address)
296 /* Find an entry in the second-level page table.. */
297 BTFIXUPDEF_CALL(pmd_t *, pmd_offset, pgd_t *, unsigned long)
298 #define pmd_offset(dir,addr) BTFIXUP_CALL(pmd_offset)(dir,addr)
300 /* Find an entry in the third-level page table.. */
301 BTFIXUPDEF_CALL(pte_t *, pte_offset_kernel, pmd_t *, unsigned long)
302 #define pte_offset_kernel(dir,addr) BTFIXUP_CALL(pte_offset_kernel)(dir,addr)
305 * This shortcut works on sun4m (and sun4d) because the nocache area is static,
306 * and sun4c is guaranteed to have no highmem anyway.
308 #define pte_offset_map(d, a) pte_offset_kernel(d,a)
309 #define pte_offset_map_nested(d, a) pte_offset_kernel(d,a)
311 #define pte_unmap(pte) do{}while(0)
312 #define pte_unmap_nested(pte) do{}while(0)
314 /* The permissions for pgprot_val to make a page mapped on the obio space */
315 extern unsigned int pg_iobits;
317 /* Certain architectures need to do special things when pte's
318 * within a page table are directly modified. Thus, the following
319 * hook is made available.
322 BTFIXUPDEF_CALL(void, set_pte, pte_t *, pte_t)
324 #define set_pte(ptep,pteval) BTFIXUP_CALL(set_pte)(ptep,pteval)
325 #define set_pte_at(mm,addr,ptep,pteval) set_pte(ptep,pteval)
327 struct seq_file;
328 BTFIXUPDEF_CALL(void, mmu_info, struct seq_file *)
330 #define mmu_info(p) BTFIXUP_CALL(mmu_info)(p)
332 /* Fault handler stuff... */
333 #define FAULT_CODE_PROT 0x1
334 #define FAULT_CODE_WRITE 0x2
335 #define FAULT_CODE_USER 0x4
337 BTFIXUPDEF_CALL(void, update_mmu_cache, struct vm_area_struct *, unsigned long, pte_t)
339 #define update_mmu_cache(vma,addr,pte) BTFIXUP_CALL(update_mmu_cache)(vma,addr,pte)
341 BTFIXUPDEF_CALL(void, sparc_mapiorange, unsigned int, unsigned long,
342 unsigned long, unsigned int)
343 BTFIXUPDEF_CALL(void, sparc_unmapiorange, unsigned long, unsigned int)
344 #define sparc_mapiorange(bus,pa,va,len) BTFIXUP_CALL(sparc_mapiorange)(bus,pa,va,len)
345 #define sparc_unmapiorange(va,len) BTFIXUP_CALL(sparc_unmapiorange)(va,len)
347 extern int invalid_segment;
349 /* Encode and de-code a swap entry */
350 BTFIXUPDEF_CALL(unsigned long, __swp_type, swp_entry_t)
351 BTFIXUPDEF_CALL(unsigned long, __swp_offset, swp_entry_t)
352 BTFIXUPDEF_CALL(swp_entry_t, __swp_entry, unsigned long, unsigned long)
354 #define __swp_type(__x) BTFIXUP_CALL(__swp_type)(__x)
355 #define __swp_offset(__x) BTFIXUP_CALL(__swp_offset)(__x)
356 #define __swp_entry(__type,__off) BTFIXUP_CALL(__swp_entry)(__type,__off)
358 #define __pte_to_swp_entry(pte) ((swp_entry_t) { pte_val(pte) })
359 #define __swp_entry_to_pte(x) ((pte_t) { (x).val })
361 /* file-offset-in-pte helpers */
362 BTFIXUPDEF_CALL(unsigned long, pte_to_pgoff, pte_t pte);
363 BTFIXUPDEF_CALL(pte_t, pgoff_to_pte, unsigned long pgoff);
365 #define pte_to_pgoff(pte) BTFIXUP_CALL(pte_to_pgoff)(pte)
366 #define pgoff_to_pte(off) BTFIXUP_CALL(pgoff_to_pte)(off)
369 * This is made a constant because mm/fremap.c required a constant.
370 * Note that layout of these bits is different between sun4c.c and srmmu.c.
372 #define PTE_FILE_MAX_BITS 24
376 struct ctx_list {
377 struct ctx_list *next;
378 struct ctx_list *prev;
379 unsigned int ctx_number;
380 struct mm_struct *ctx_mm;
383 extern struct ctx_list *ctx_list_pool; /* Dynamically allocated */
384 extern struct ctx_list ctx_free; /* Head of free list */
385 extern struct ctx_list ctx_used; /* Head of used contexts list */
387 #define NO_CONTEXT -1
389 static inline void remove_from_ctx_list(struct ctx_list *entry)
391 entry->next->prev = entry->prev;
392 entry->prev->next = entry->next;
395 static inline void add_to_ctx_list(struct ctx_list *head, struct ctx_list *entry)
397 entry->next = head;
398 (entry->prev = head->prev)->next = entry;
399 head->prev = entry;
401 #define add_to_free_ctxlist(entry) add_to_ctx_list(&ctx_free, entry)
402 #define add_to_used_ctxlist(entry) add_to_ctx_list(&ctx_used, entry)
404 static inline unsigned long
405 __get_phys (unsigned long addr)
407 switch (sparc_cpu_model){
408 case sun4:
409 case sun4c:
410 return sun4c_get_pte (addr) << PAGE_SHIFT;
411 case sun4m:
412 case sun4d:
413 return ((srmmu_get_pte (addr) & 0xffffff00) << 4);
414 default:
415 return 0;
419 static inline int
420 __get_iospace (unsigned long addr)
422 switch (sparc_cpu_model){
423 case sun4:
424 case sun4c:
425 return -1; /* Don't check iospace on sun4c */
426 case sun4m:
427 case sun4d:
428 return (srmmu_get_pte (addr) >> 28);
429 default:
430 return -1;
434 extern unsigned long *sparc_valid_addr_bitmap;
436 /* Needs to be defined here and not in linux/mm.h, as it is arch dependent */
437 #define kern_addr_valid(addr) \
438 (test_bit(__pa((unsigned long)(addr))>>20, sparc_valid_addr_bitmap))
440 extern int io_remap_pfn_range(struct vm_area_struct *vma,
441 unsigned long from, unsigned long pfn,
442 unsigned long size, pgprot_t prot);
445 * For sparc32&64, the pfn in io_remap_pfn_range() carries <iospace> in
446 * its high 4 bits. These macros/functions put it there or get it from there.
448 #define MK_IOSPACE_PFN(space, pfn) (pfn | (space << (BITS_PER_LONG - 4)))
449 #define GET_IOSPACE(pfn) (pfn >> (BITS_PER_LONG - 4))
450 #define GET_PFN(pfn) (pfn & 0x0fffffffUL)
452 #include <asm-generic/pgtable.h>
454 #endif /* !(__ASSEMBLY__) */
456 /* We provide our own get_unmapped_area to cope with VA holes for userland */
457 #define HAVE_ARCH_UNMAPPED_AREA
460 * No page table caches to initialise
462 #define pgtable_cache_init() do { } while (0)
464 #endif /* !(_SPARC_PGTABLE_H) */