Home | History | Annotate | Line # | Download | only in include
pmap.h revision 1.1
      1 /*	$NetBSD: pmap.h,v 1.1 2001/02/23 03:48:18 ichiro Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1994,1995 Mark Brinicombe.
      5  * All rights reserved.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. All advertising materials mentioning features or use of this software
     16  *    must display the following acknowledgement:
     17  *	This product includes software developed by Mark Brinicombe
     18  * 4. The name of the author may not be used to endorse or promote products
     19  *    derived from this software without specific prior written permission.
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     31  */
     32 
     33 #ifndef	_ARM32_PMAP_H_
     34 #define	_ARM32_PMAP_H_
     35 
     36 #include <machine/cpufunc.h>
     37 #include <machine/pte.h>
     38 
     39 /*
     40  * Data structures used by pmap
     41  */
     42 
     43 /*
     44  * Structure that describes a Level 1 page table and the flags
     45  * associated with it.
     46  */
     47 struct l1pt {
     48 	SIMPLEQ_ENTRY(l1pt)	pt_queue;	/* Queue pointers */
     49 	struct pglist		pt_plist;	/* Allocated page list */
     50 	vm_offset_t		pt_va;		/* Allocated virtual address */
     51 	int	                pt_flags;	/* Flags */
     52 };
     53 #define	PTFLAG_STATIC		1		/* Statically allocated */
     54 #define PTFLAG_KPT		2		/* Kernel pt's are mapped */
     55 #define PTFLAG_CLEAN		4		/* L1 is clean */
     56 
     57 /*
     58  * The pmap structure itself.
     59  */
     60 struct pmap {
     61 	pd_entry_t		*pm_pdir;	/* KVA of page directory */
     62 	struct l1pt		*pm_l1pt;	/* L1 descriptor */
     63 	void			*pm_unused1;	/* Reserved for l2 map */
     64 	vm_offset_t		pm_pptpt;	/* PA of pt's page table */
     65 	vm_offset_t		pm_vptpt;	/* VA of pt's page table */
     66 	short			pm_dref;	/* page directory ref count */
     67 	short			pm_count;	/* pmap reference count */
     68 	simple_lock_data_t	pm_lock;	/* lock on pmap */
     69 	struct pmap_statistics	pm_stats;	/* pmap statistics */
     70 };
     71 
     72 typedef struct pmap *pmap_t;
     73 
     74 /*
     75  * For each vm_page_t, there is a list of all currently valid virtual
     76  * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
     77  */
     78 typedef struct pv_entry {
     79 	struct pv_entry *pv_next;       /* next pv_entry */
     80 	pmap_t          pv_pmap;        /* pmap where mapping lies */
     81 	vm_offset_t     pv_va;          /* virtual address for mapping */
     82 	int             pv_flags;       /* flags */
     83 } *pv_entry_t;
     84 
     85 /*
     86  * A pv_page_info struture looks like this. It is used to contain status
     87  * information for pv_entry freelists.
     88  */
     89 struct pv_page;
     90 
     91 struct pv_page_info {
     92 	TAILQ_ENTRY(pv_page) pgi_list;
     93 	struct pv_entry *pgi_freelist;
     94 	int pgi_nfree;
     95 };
     96 
     97 /*
     98  * A pv_page itself looks like this. pv_entries are requested from the VM a
     99  * pv_page at a time.
    100  *
    101  * We also define a macro that states the number of pv_entries per page
    102  * allocated.
    103  */
    104 #define NPVPPG	((NBPG - sizeof(struct pv_page_info)) / sizeof(struct pv_entry))
    105 
    106 struct pv_page {
    107 	struct pv_page_info pvp_pgi;
    108 	struct pv_entry pvp_pv[NPVPPG];
    109 };
    110 
    111 /*
    112  * Page hooks. I'll eliminate these sometime soon :-)
    113  *
    114  * For speed we store the both the virtual address and the page table
    115  * entry address for each page hook.
    116  */
    117 typedef struct {
    118         vm_offset_t va;
    119         pt_entry_t *pte;
    120 } pagehook_t;
    121 
    122 /*
    123  * Physical / virtual address structure. In a number of places (particularly
    124  * during bootstrapping) we need to keep track of the physical and virtual
    125  * addresses of various pages
    126  */
    127 typedef struct {
    128 	vm_offset_t pv_pa;
    129 	vm_offset_t pv_va;
    130 } pv_addr_t;
    131 
    132 /*
    133  * _KERNEL specific macros, functions and prototypes
    134  */
    135 
    136 #ifdef  _KERNEL
    137 
    138 /*
    139  * Commonly referenced structures
    140  */
    141 extern pv_entry_t	pv_table;	/* Phys to virt mappings, per page. */
    142 extern pmap_t		kernel_pmap;	/* pmap pointer used for the kernel */
    143 extern struct pmap	kernel_pmap_store;  /* kernel_pmap points to this */
    144 
    145 /*
    146  * Macros that we need to export
    147  */
    148 #define pmap_kernel()			(&kernel_pmap_store)
    149 #define pmap_update()			/*cpu_tlb_flushID()*/
    150 #define	pmap_resident_count(pmap)	((pmap)->pm_stats.resident_count)
    151 #define	pmap_wired_count(pmap)		((pmap)->pm_stats.wired_count)
    152 
    153 #define pmap_phys_address(ppn)		(arm_page_to_byte((ppn)))
    154 
    155 /*
    156  * Functions that we need to export
    157  */
    158 extern boolean_t pmap_testbit __P((vm_offset_t, int));
    159 extern void pmap_changebit __P((vm_offset_t, int, int));
    160 extern vm_offset_t pmap_map __P((vm_offset_t, vm_offset_t, vm_offset_t, int));
    161 void	pmap_procwr __P((struct proc *, vm_offset_t, u_long));
    162 #define	PMAP_NEED_PROCWR
    163 
    164 #endif	/* _KERNEL */
    165 
    166 /*
    167  * Useful macros and constants
    168  */
    169 
    170 /* Virtual address to page table entry */
    171 #define vtopte(va) \
    172 	((pt_entry_t *)(PROCESS_PAGE_TBLS_BASE + \
    173 	(arm_byte_to_page((unsigned int)(va)) << 2)))
    174 
    175 /* Virtual address to physical address */
    176 #define vtophys(va) \
    177 	((*vtopte(va) & PG_FRAME) | ((unsigned int)(va) & ~PG_FRAME))
    178 
    179 /* L1 and L2 page table macros */
    180 #define pmap_pde(m, v) (&((m)->pm_pdir[((vm_offset_t)(v) >> PDSHIFT)&4095]))
    181 #define pmap_pte_pa(pte)	(*(pte) & PG_FRAME)
    182 #define pmap_pde_v(pde)		(*(pde) != 0)
    183 #define pmap_pte_v(pte)		(*(pte) != 0)
    184 
    185 /* Size of the kernel part of the L1 page table */
    186 #define KERNEL_PD_SIZE	\
    187 	(PD_SIZE - (KERNEL_SPACE_START >> PDSHIFT) * sizeof(pd_entry_t))
    188 
    189 #endif	/* _ARM32_PMAP_H_ */
    190