1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (C) 2010 Nathan Whitehorn
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 AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * $FreeBSD$
28 */
29
30#ifndef _POWERPC_AIM_MMU_OEA64_H
31#define _POWERPC_AIM_MMU_OEA64_H
32
33#include "opt_pmap.h"
34
35#include <vm/vm_extern.h>
36#include <machine/mmuvar.h>
37
38struct dump_context {
39	u_long ptex;
40	u_long ptex_end;
41	size_t blksz;
42};
43
44extern const struct mmu_kobj oea64_mmu;
45
46/*
47 * Helper routines
48 */
49
50/* Allocate physical memory for use in moea64_bootstrap. */
51vm_offset_t	moea64_bootstrap_alloc(vm_size_t size, vm_size_t align);
52/* Set an LPTE structure to match the contents of a PVO */
53void	moea64_pte_from_pvo(const struct pvo_entry *pvo, struct lpte *lpte);
54
55/*
56 * Flags
57 */
58
59#define MOEA64_PTE_PROT_UPDATE	1
60#define MOEA64_PTE_INVALIDATE	2
61
62/*
63 * Bootstrap subroutines
64 *
65 * An MMU_BOOTSTRAP() implementation looks like this:
66 *   moea64_early_bootstrap();
67 *   Allocate Page Table
68 *   moea64_mid_bootstrap();
69 *   Add mappings for MMU resources
70 *   moea64_late_bootstrap();
71 */
72
73void		moea64_early_bootstrap(vm_offset_t kernelstart,
74		    vm_offset_t kernelend);
75void		moea64_mid_bootstrap(vm_offset_t kernelstart,
76		    vm_offset_t kernelend);
77void		moea64_late_bootstrap(vm_offset_t kernelstart,
78		    vm_offset_t kernelend);
79
80int64_t		moea64_pte_replace(struct pvo_entry *, int);
81int64_t		moea64_pte_insert(struct pvo_entry *);
82int64_t		moea64_pte_unset(struct pvo_entry *);
83int64_t		moea64_pte_clear(struct pvo_entry *, uint64_t);
84int64_t		moea64_pte_synch(struct pvo_entry *);
85int64_t		moea64_pte_insert_sp(struct pvo_entry *);
86int64_t		moea64_pte_unset_sp(struct pvo_entry *);
87int64_t		moea64_pte_replace_sp(struct pvo_entry *);
88
89typedef int64_t	(*moea64_pte_replace_t)(struct pvo_entry *, int);
90typedef int64_t	(*moea64_pte_insert_t)(struct pvo_entry *);
91typedef int64_t	(*moea64_pte_unset_t)(struct pvo_entry *);
92typedef int64_t	(*moea64_pte_clear_t)(struct pvo_entry *, uint64_t);
93typedef int64_t	(*moea64_pte_synch_t)(struct pvo_entry *);
94typedef int64_t	(*moea64_pte_insert_sp_t)(struct pvo_entry *);
95typedef int64_t	(*moea64_pte_unset_sp_t)(struct pvo_entry *);
96typedef int64_t	(*moea64_pte_replace_sp_t)(struct pvo_entry *);
97
98struct moea64_funcs {
99	moea64_pte_replace_t	pte_replace;
100	moea64_pte_insert_t	pte_insert;
101	moea64_pte_unset_t	pte_unset;
102	moea64_pte_clear_t	pte_clear;
103	moea64_pte_synch_t	pte_synch;
104	moea64_pte_insert_sp_t	pte_insert_sp;
105	moea64_pte_unset_sp_t	pte_unset_sp;
106	moea64_pte_replace_sp_t	pte_replace_sp;
107};
108
109extern struct moea64_funcs *moea64_ops;
110
111static inline uint64_t
112moea64_pte_vpn_from_pvo_vpn(const struct pvo_entry *pvo)
113{
114	return ((pvo->pvo_vpn >> (ADDR_API_SHFT64 - ADDR_PIDX_SHFT)) &
115	    LPTE_AVPN_MASK);
116}
117
118/*
119 * Statistics
120 */
121
122#ifdef MOEA64_STATS
123extern u_int	moea64_pte_valid;
124extern u_int	moea64_pte_overflow;
125#define STAT_MOEA64(x)	x
126#else
127#define	STAT_MOEA64(x) ((void)0)
128#endif
129
130/*
131 * State variables
132 */
133
134extern int		moea64_large_page_shift;
135extern uint64_t		moea64_large_page_size;
136extern uint64_t		moea64_large_page_mask;
137extern u_long		moea64_pteg_count;
138extern u_long		moea64_pteg_mask;
139extern int		n_slbs;
140extern bool		moea64_has_lp_4k_16m;
141
142#endif /* _POWERPC_AIM_MMU_OEA64_H */
143