/*      $NetBSD: pmap3x.h,v 1.36 2026/07/06 16:08:13 thorpej Exp $      */

/*-
 * Copyright (c) 1997 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Jeremy Cooper.
 *
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``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 THE FOUNDATION OR CONTRIBUTORS
 * 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 _SUN3_PMAP3X_H_
#define _SUN3_PMAP3X_H_ 

#if defined(_KERNEL)

#if !defined(_MODULE)

/*
 * Physical map structures exported to the VM code.
 */

struct pmap {
        struct a_tmgr_struct    *pm_a_tmgr;     /* Level-A table manager */
        paddr_t                 pm_a_phys;      /* MMU level-A phys addr */
        u_int                   pm_refcount;    /* reference count */
        int                     pm_version;
};

/* Common function for pmap_resident_count(), pmap_wired_count() */
segsz_t pmap_count(pmap_t, int);

/* This needs to be a macro for kern_sysctl.c */
#define pmap_resident_count(pmap)       (pmap_count((pmap), 0))

/* This needs to be a macro for vm_mmap.c */
#define pmap_wired_count(pmap)          (pmap_count((pmap), 1))

/* Map a given physical region to a virtual region */
vaddr_t pmap_map(vaddr_t, paddr_t, paddr_t, int);

static __inline bool
pmap_remove_all(struct pmap *pmap)
{
        /* Nothing. */
        return false;
}

/*
 * pmap hook for trap()'s page fault handler.  We don't need to
 * do anything special, so it just goes to uvm_fault().
 */
#define pmap_fault(m, v, t)     uvm_fault((m), (v), (t))

/*
 * Flags to tell pmap_enter `this is not to be cached', etc.
 * Since physical addresses are always aligned, we can use
 * the low order bits for this.
 */
#define PMAP_OBMEM      0x00    /* unused */
#define PMAP_OBIO       0x00    /* unused */
#define PMAP_VME16      0x10    /* pmap will add the necessary offset */
#define PMAP_VME32      0x20    /* etc. */
#define PMAP_NC         0x40    /* tells pmap_enter to set PTE_CI */
#define PMAP_SPEC       0xFF    /* mask to get all above. */

/* Kernel debugger support functions. */
struct pmap_db_write_text_context {
        vaddr_t         pgva;
        int             opte;
};
bool    pmap_db_write_text_enter(vaddr_t, struct pmap_db_write_text_context *);
void    pmap_db_write_text_exit(struct pmap_db_write_text_context *);

#endif /* ! _MODULE */

#endif /* _KERNEL */

#if (defined(_KERNEL) && !defined(_MODULE)) || defined(_STANDALONE)
/* MMU specific segment size */
#define SEGSHIFT        19              /* LOG2(NBSG) */
#define NBSG            (1 << SEGSHIFT) /* bytes/segment */
#define SEGOFSET        (NBSG - 1)      /* byte offset into segment */

#define sun3x_round_seg(x)      ((((vaddr_t)(x)) + SEGOFSET) & ~SEGOFSET)
#define sun3x_trunc_seg(x)      ((vaddr_t)(x) & ~SEGOFSET)
#define sun3x_seg_offset(x)     ((vaddr_t)(x) & SEGOFSET)
#endif /* (_KERNEL && !_MODULE) || _STANDALONE */

#endif /* _SUN3_PMAP3X_H_ */