1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2014,2016 Svatopluk Kraus <onwahe@gmail.com>
5 * Copyright (c) 2014,2016 Michal Meloun <meloun@miracle.cz>
6 * Copyright (c) 1991 Regents of the University of California.
7 * All rights reserved.
8 *
9 * This code is derived from software contributed to Berkeley by
10 * the Systems Programming Group of the University of Utah Computer
11 * Science Department and William Jolitz of UUNET Technologies Inc.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * The ARM version of this file was more or less based on the i386 version,
35 * which has the following provenance...
36 *
37 * Derived from hp300 version by Mike Hibler, this version by William
38 * Jolitz uses a recursive map [a pde points to the page directory] to
39 * map the page tables using the pagetables themselves. This is done to
40 * reduce the impact on kernel virtual memory for lots of sparse address
41 * space, and to reduce the cost of memory to each process.
42 * from: FreeBSD: src/sys/i386/include/pmap.h,v 1.70 2000/11/30
43 */
44
45#ifndef _MACHINE_PMAP_H_
46#define _MACHINE_PMAP_H_
47
48#include <sys/systm.h>
49#include <sys/queue.h>
50#include <sys/_cpuset.h>
51#include <sys/_lock.h>
52#include <sys/_mutex.h>
53#include <sys/_pv_entry.h>
54
55typedef uint32_t pt1_entry_t; /* L1 table entry */
56typedef uint32_t pt2_entry_t; /* L2 table entry */
57typedef uint32_t ttb_entry_t; /* TTB entry */
58
59#ifdef _KERNEL
60
61#if 0
62#define PMAP_PTE_NOCACHE // Use uncached page tables
63#endif
64
65/*
66 * (1) During pmap bootstrap, physical pages for L2 page tables are
67 * allocated in advance which are used for KVA continuous mapping
68 * starting from KERNBASE. This makes things more simple.
69 * (2) During vm subsystem initialization, only vm subsystem itself can
70 * allocate physical memory safely. As pmap_map() is called during
71 * this initialization, we must be prepared for that and have some
72 * preallocated physical pages for L2 page tables.
73 *
74 * Note that some more pages for L2 page tables are preallocated too
75 * for mappings laying above VM_MAX_KERNEL_ADDRESS.
76 */
77#ifndef NKPT2PG
78/*
79 * The optimal way is to define this in board configuration as
80 * definition here must be safe enough. It means really big.
81 *
82 * 1 GB KVA <=> 256 kernel L2 page table pages
83 *
84 * From real platforms:
85 * 1 GB physical memory <=> 10 pages is enough
86 * 2 GB physical memory <=> 21 pages is enough
87 */
88#define NKPT2PG 32
89#endif
90#endif /* _KERNEL */
91
92/*
93 * Pmap stuff
94 */
95struct md_page {
96 TAILQ_HEAD(,pv_entry) pv_list;
97 uint16_t pt2_wirecount[4];
98 vm_memattr_t pat_mode;
99};
100
101struct pmap {
102 struct mtx pm_mtx;
103 pt1_entry_t *pm_pt1; /* KVA of pt1 */
104 pt2_entry_t *pm_pt2tab; /* KVA of pt2 pages table */
105 TAILQ_HEAD(,pv_chunk) pm_pvchunk; /* list of mappings in pmap */
106 cpuset_t pm_active; /* active on cpus */
107 struct pmap_statistics pm_stats; /* pmap statictics */
108 LIST_ENTRY(pmap) pm_list; /* List of all pmaps */
109};
110
111typedef struct pmap *pmap_t;
112
113#ifdef _KERNEL
114extern struct pmap kernel_pmap_store;
115#define kernel_pmap (&kernel_pmap_store)
116
117#define PMAP_LOCK(pmap) mtx_lock(&(pmap)->pm_mtx)
118#define PMAP_LOCK_ASSERT(pmap, type) \
119 mtx_assert(&(pmap)->pm_mtx, (type))
120#define PMAP_LOCK_DESTROY(pmap) mtx_destroy(&(pmap)->pm_mtx)
121#define PMAP_LOCK_INIT(pmap) mtx_init(&(pmap)->pm_mtx, "pmap", \
122 NULL, MTX_DEF | MTX_DUPOK)
123#define PMAP_LOCKED(pmap) mtx_owned(&(pmap)->pm_mtx)
124#define PMAP_MTX(pmap) (&(pmap)->pm_mtx)
125#define PMAP_TRYLOCK(pmap) mtx_trylock(&(pmap)->pm_mtx)
126#define PMAP_UNLOCK(pmap) mtx_unlock(&(pmap)->pm_mtx)
127
128extern ttb_entry_t pmap_kern_ttb; /* TTB for kernel pmap */
129
130#define pmap_page_get_memattr(m) ((m)->md.pat_mode)
131
132/*
133 * Only the following functions or macros may be used before pmap_bootstrap()
134 * is called: pmap_kenter(), pmap_kextract(), pmap_kremove(), vtophys(), and
135 * vtopte2().
136 */
137void pmap_bootstrap(vm_offset_t);
138void pmap_kenter(vm_offset_t, vm_size_t, vm_paddr_t, int);
139void pmap_kremove(vm_offset_t);
140bool pmap_page_is_mapped(vm_page_t);
141bool pmap_ps_enabled(pmap_t pmap);
142
143void pmap_tlb_flush(pmap_t, vm_offset_t);
144void pmap_tlb_flush_range(pmap_t, vm_offset_t, vm_size_t);
145
146vm_paddr_t pmap_dump_kextract(vm_offset_t, pt2_entry_t *);
147
148int pmap_fault(pmap_t, vm_offset_t, uint32_t, int, bool);
149
150void pmap_set_tex(void);
151
152/*
153 * Pre-bootstrap epoch functions set.
154 */
155void pmap_bootstrap_prepare(vm_paddr_t);
156vm_paddr_t pmap_preboot_get_pages(u_int);
157void pmap_preboot_map_pages(vm_paddr_t, vm_offset_t, u_int);
158vm_offset_t pmap_preboot_reserve_pages(u_int);
159vm_offset_t pmap_preboot_get_vpages(u_int);
160void pmap_preboot_map_attr(vm_paddr_t, vm_offset_t, vm_size_t, vm_prot_t,
161 vm_memattr_t);
162void pmap_remap_vm_attr(vm_memattr_t old_attr, vm_memattr_t new_attr);
163
164extern char *_tmppt; /* poor name! */
165
166extern vm_offset_t virtual_avail;
167extern vm_offset_t virtual_end;
168
169void *pmap_kenter_temporary(vm_paddr_t, int);
170#define pmap_page_is_write_mapped(m) (((m)->a.flags & PGA_WRITEABLE) != 0)
171void pmap_page_set_memattr(vm_page_t, vm_memattr_t);
172#define pmap_map_delete(pmap, sva, eva) pmap_remove(pmap, sva, eva)
173
174void *pmap_mapdev(vm_paddr_t, vm_size_t);
175void *pmap_mapdev_attr(vm_paddr_t, vm_size_t, vm_memattr_t);
176void pmap_unmapdev(void *, vm_size_t);
177
178struct pcb;
179void pmap_set_pcb_pagedir(pmap_t, struct pcb *);
180
181void pmap_kenter_device(vm_offset_t, vm_size_t, vm_paddr_t);
182void pmap_kremove_device(vm_offset_t, vm_size_t);
183
184vm_paddr_t pmap_kextract(vm_offset_t);
185#define vtophys(va) pmap_kextract((vm_offset_t)(va))
186
187static inline int
188pmap_vmspace_copy(pmap_t dst_pmap __unused, pmap_t src_pmap __unused)
189{
190
191 return (0);
192}
193
194#define PMAP_ENTER_QUICK_LOCKED 0x10000000
195
196#define pmap_vm_page_alloc_check(m)
197
198#endif /* _KERNEL */
199#endif /* !_MACHINE_PMAP_H_ */