/*	$NetBSD: pmap.h,v 1.17 2000/03/30 16:18:24 jdolecek Exp $	*/

/*-
 * Copyright (C) 1995, 1996 Wolfgang Solfrank.
 * Copyright (C) 1995, 1996 TooLs GmbH.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by TooLs GmbH.
 * 4. The name of TooLs GmbH may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef	_MACHINE_PMAP_H_
#define	_MACHINE_PMAP_H_

#include <machine/pte.h>

/*
 * Segment registers
 */
#ifndef	LOCORE
typedef u_int sr_t;
#endif	/* LOCORE */
#define	SR_TYPE		0x80000000
#define	SR_SUKEY	0x40000000
#define	SR_PRKEY	0x20000000
#define	SR_VSID		0x00ffffff

#ifndef LOCORE

struct pv_entry;

struct md_page {
	int	pv_list_count;
	int	pv_flags;
	TAILQ_HEAD(,pv_entry)	pv_list;
};

/*
 * Pmap stuff
 */
struct pmap {
	sr_t pm_sr[16];		/* segments used in this pmap */
	int pm_refs;		/* ref count */
	struct pmap_statistics pm_stats;	/* pmap statistics */
};

typedef	struct pmap *pmap_t;

typedef struct pv_entry {
	pmap_t		pv_pmap;
	vm_offset_t	pv_va;
	TAILQ_ENTRY(pv_entry)	pv_list;
	TAILQ_ENTRY(pv_entry)	pv_plist;
	vm_page_t	pv_ptem;
	int		pv_idx;
	struct pv_entry_t	*pv_next;
} *pv_entry_t;

#ifdef	_KERNEL

#define pmap_clear_modify(pg)		(ptemodify((pg), PTE_CHG, 0))
#define	pmap_clear_reference(pg)	(ptemodify((pg), PTE_REF, 0))
#define	pmap_is_modified(pg)		(ptebits((pg), PTE_CHG))
#define	pmap_is_referenced(pg)		(ptebits((pg), PTE_REF))
#define	pmap_unwire(pm, va)

#define	pmap_phys_address(x)		(x)

#define	pmap_resident_count(pmap)	((pmap)->pm_stats.resident_count)

extern pmap_t		kernel_pmap;

extern vm_offset_t	avail_end;
extern vm_offset_t	avail_start;
extern vm_offset_t	phys_avail[];
extern vm_offset_t	virtual_avail;
extern vm_offset_t	virtual_end;

void pmap_bootstrap __P((u_int kernelstart, u_int kernelend));
boolean_t ptemodify __P((struct vm_page *, u_int, u_int));
int ptebits __P((struct vm_page *, int));

#if 0
#define PMAP_NEED_PROCWR
void pmap_procwr __P((struct proc *, vaddr_t, size_t));
#endif

/*
 * Alternate mapping hooks for pool pages.  Avoids thrashing the TLB.
 *
 * Note: This won't work if we have more memory than can be direct-mapped
 * VA==PA all at once.  But pmap_copy_page() and pmap_zero_page() will have
 * this problem, too.
 */
#define	PMAP_MAP_POOLPAGE(pa)	(pa)
#define	PMAP_UNMAP_POOLPAGE(pa)	(pa)

#define	vtophys(va)	pmap_kextract(((vm_offset_t) (va)))

extern	pte_t	PTmap[];

#define	vtopte(x)	(PTmap + powerpc_btop(x))

static __inline vm_offset_t
pmap_kextract(vm_offset_t va)
{
	/* XXX: coming soon... */
	return (0);
}

#endif	/* _KERNEL */
#endif	/* LOCORE */

#endif	/* _MACHINE_PMAP_H_ */