Home | History | Annotate | Line # | Download | only in arm32
pmap.h revision 1.10
      1 /*	$NetBSD: pmap.h,v 1.10 2001/06/22 09:12:11 chris 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 	vaddr_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 	paddr_t			pm_pptpt;	/* PA of pt's page table */
     64 	vaddr_t			pm_vptpt;	/* VA of pt's page table */
     65 	short			pm_count;	/* pmap reference count */
     66 	struct simplelock	pm_lock;	/* lock on pmap */
     67 	struct pmap_statistics	pm_stats;	/* pmap statistics */
     68 };
     69 
     70 typedef struct pmap *pmap_t;
     71 
     72 /*
     73  * For each struct vm_page, there is a list of all currently valid virtual
     74  * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
     75  */
     76 typedef struct pv_entry {
     77 	struct pv_entry *pv_next;       /* next pv_entry */
     78 	pmap_t          pv_pmap;        /* pmap where mapping lies */
     79 	vaddr_t         pv_va;          /* virtual address for mapping */
     80 	int             pv_flags;       /* flags */
     81 } *pv_entry_t;
     82 
     83 /*
     84  * A pv_page_info struture looks like this. It is used to contain status
     85  * information for pv_entry freelists.
     86  */
     87 struct pv_page;
     88 
     89 struct pv_page_info {
     90 	TAILQ_ENTRY(pv_page) pgi_list;
     91 	struct pv_entry *pgi_freelist;
     92 	int pgi_nfree;
     93 };
     94 
     95 /*
     96  * A pv_page itself looks like this. pv_entries are requested from the VM a
     97  * pv_page at a time.
     98  *
     99  * We also define a macro that states the number of pv_entries per page
    100  * allocated.
    101  */
    102 #define NPVPPG	((NBPG - sizeof(struct pv_page_info)) / sizeof(struct pv_entry))
    103 
    104 struct pv_page {
    105 	struct pv_page_info pvp_pgi;
    106 	struct pv_entry pvp_pv[NPVPPG];
    107 };
    108 
    109 /*
    110  * Page hooks. I'll eliminate these sometime soon :-)
    111  *
    112  * For speed we store the both the virtual address and the page table
    113  * entry address for each page hook.
    114  */
    115 typedef struct {
    116         vaddr_t va;
    117         pt_entry_t *pte;
    118 } pagehook_t;
    119 
    120 /*
    121  * Physical / virtual address structure. In a number of places (particularly
    122  * during bootstrapping) we need to keep track of the physical and virtual
    123  * addresses of various pages
    124  */
    125 typedef struct {
    126 	paddr_t pv_pa;
    127 	vaddr_t pv_va;
    128 } pv_addr_t;
    129 
    130 /*
    131  * _KERNEL specific macros, functions and prototypes
    132  */
    133 
    134 #ifdef  _KERNEL
    135 
    136 /*
    137  * Commonly referenced structures
    138  */
    139 extern pv_entry_t	pv_table;	/* Phys to virt mappings, per page. */
    140 extern pmap_t		kernel_pmap;	/* pmap pointer used for the kernel */
    141 extern struct pmap	kernel_pmap_store;  /* kernel_pmap points to this */
    142 extern int		pmap_debug_level; /* Only exists if PMAP_DEBUG */
    143 
    144 /*
    145  * Macros that we need to export
    146  */
    147 #define pmap_kernel()			(&kernel_pmap_store)
    148 #define pmap_update()			/* nothing (yet) */
    149 #define	pmap_resident_count(pmap)	((pmap)->pm_stats.resident_count)
    150 #define	pmap_wired_count(pmap)		((pmap)->pm_stats.wired_count)
    151 
    152 #define pmap_phys_address(ppn)		(arm_page_to_byte((ppn)))
    153 
    154 /*
    155  * Functions that we need to export
    156  */
    157 extern boolean_t pmap_testbit __P((paddr_t, int));
    158 extern void pmap_changebit __P((paddr_t, int, int));
    159 extern vaddr_t pmap_map __P((vaddr_t, vaddr_t, vaddr_t, int));
    160 extern void pmap_procwr __P((struct proc *, vaddr_t, int));
    161 #define	PMAP_NEED_PROCWR
    162 
    163 /*
    164  * Functions we use internally
    165  */
    166 extern void pmap_bootstrap __P((pd_entry_t *, pv_addr_t));
    167 extern void pmap_debug	__P((int));
    168 extern int pmap_handled_emulation __P((pmap_t, vaddr_t));
    169 extern int pmap_modified_emulation __P((pmap_t, vaddr_t));
    170 extern void pmap_postinit __P((void));
    171 extern pt_entry_t *pmap_pte __P((pmap_t, vaddr_t));
    172 
    173 #endif	/* _KERNEL */
    174 
    175 /*
    176  * Useful macros and constants
    177  */
    178 
    179 /* Virtual address to page table entry */
    180 #define vtopte(va) \
    181 	((pt_entry_t *)(PROCESS_PAGE_TBLS_BASE + \
    182 	(arm_byte_to_page((unsigned int)(va)) << 2)))
    183 
    184 /* Virtual address to physical address */
    185 #define vtophys(va) \
    186 	((*vtopte(va) & PG_FRAME) | ((unsigned int)(va) & ~PG_FRAME))
    187 
    188 /* L1 and L2 page table macros */
    189 #define pmap_pde(m, v) (&((m)->pm_pdir[((vaddr_t)(v) >> PDSHIFT)&4095]))
    190 #define pmap_pte_pa(pte)	(*(pte) & PG_FRAME)
    191 #define pmap_pde_v(pde)		(*(pde) != 0)
    192 #define pmap_pte_v(pte)		(*(pte) != 0)
    193 
    194 /* Size of the kernel part of the L1 page table */
    195 #define KERNEL_PD_SIZE	\
    196 	(PD_SIZE - (KERNEL_SPACE_START >> PDSHIFT) * sizeof(pd_entry_t))
    197 
    198 #endif	/* _ARM32_PMAP_H_ */
    199