1/*	$NetBSD: pmap.h,v 1.23 2009/12/11 18:31:27 tsutsui Exp $	*/
2
3/*-
4 * Copyright (c) 1998 The NetBSD Foundation, Inc.
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 *
16 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
17 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef	_MACHINE_PMAP_H
30#define	_MACHINE_PMAP_H
31
32#ifdef _KERNEL
33/*
34 * Physical map structures exported to the VM code.
35 */
36
37struct pmap {
38	unsigned char   	*pm_segmap; 	/* soft copy of segmap */
39	int             	pm_ctxnum;	/* MMU context number */
40	u_int             	pm_refcount;	/* reference count */
41	int             	pm_version;
42};
43
44/*
45 * We give the pmap code a chance to resolve faults by
46 * reloading translations that it was forced to unload.
47 * This function does that, and calls vm_fault if it
48 * could not resolve the fault by reloading the MMU.
49 */
50int _pmap_fault(struct vm_map *, vaddr_t, vm_prot_t);
51
52/* This lets us have some say in choosing VA locations. */
53extern void pmap_prefer(vaddr_t, vaddr_t *);
54#define PMAP_PREFER(fo, ap, sz, td) pmap_prefer((fo), (ap))
55
56/* This needs to be a macro for kern_sysctl.c */
57extern segsz_t pmap_resident_pages(pmap_t);
58#define	pmap_resident_count(pmap)	(pmap_resident_pages(pmap))
59
60/* This needs to be a macro for vm_mmap.c */
61extern segsz_t pmap_wired_pages(pmap_t);
62#define	pmap_wired_count(pmap)	(pmap_wired_pages(pmap))
63
64/* We use the PA plus some low bits for device mmap. */
65#define pmap_phys_address(addr) 	(addr)
66
67#define	pmap_update(pmap)		/* nothing (yet) */
68
69/* Map a given physical region to a virtual region */
70extern vaddr_t pmap_map(vaddr_t, paddr_t, paddr_t, int);
71
72/* Extract the PMEG for a given physical address. */
73extern int _pmap_extract_pmeg(pmap_t, vaddr_t);
74
75static __inline void
76pmap_remove_all(struct pmap *pmap)
77{
78	/* Nothing. */
79}
80
81/*
82 * Since PTEs also contain type bits, we have to have some way
83 * to tell pmap_enter `this is an IO page' or `this is not to
84 * be cached'.  Since physical addresses are always aligned, we
85 * can do this with the low order bits.
86 *
87 * The values below must agree with pte.h such that:
88 *	(PMAP_OBIO << PG_MOD_SHIFT) == PGT_OBIO
89 */
90#define	PMAP_OBMEM	0x00
91#define	PMAP_OBIO	0x04	/* tells pmap_enter to use PG_OBIO */
92#define	PMAP_MBMEM	0x08	/* etc (sun-2/120) */
93#define	PMAP_MBIO	0x0C	/* etc (sun-2/120) */
94#define	PMAP_VME0	0x08	/* etc (sun-2/50) */
95#define	PMAP_VME8	0x0C	/* etc (sun-2/50) */
96#define	PMAP_NC		0x00	/* tells pmap_enter to set PG_NC */
97#define	PMAP_SPEC	0x0C	/* mask to get all above. */
98
99void pmap_procwr(struct proc *, vaddr_t, size_t);
100
101#endif	/* _KERNEL */
102
103/* MMU specific segment value */
104#define	SEGSHIFT	15	        /* LOG2(NBSG) */
105#define	NBSG		(1 << SEGSHIFT)	/* bytes/segment */
106#define	SEGOFSET	(NBSG - 1)	/* byte offset into segment */
107
108#define	sun2_round_seg(x)	((((vaddr_t)(x)) + SEGOFSET) & ~SEGOFSET)
109#define	sun2_trunc_seg(x)	((vaddr_t)(x) & ~SEGOFSET)
110#define	sun2_seg_offset(x)	((vaddr_t)(x) & SEGOFSET)
111
112#endif	/* _MACHINE_PMAP_H */
113