1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2005 Peter Grehan 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 AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef _MACHINE_MMUVAR_H_ 32 #define _MACHINE_MMUVAR_H_ 33 34 /* 35 * A PowerPC MMU implementation is declared with a kernel object and 36 * an associated method table. The MMU_DEF macro is used to declare 37 * the class, and also links it to the global MMU class list. 38 * 39 * e.g. 40 * 41 * static mmu_method_t ppc8xx_methods[] = { 42 * MMUMETHOD(mmu_change_wiring, ppc8xx_mmu_change_wiring), 43 * MMUMETHOD(mmu_clear_modify, ppc8xx_mmu_clear_modify), 44 * MMUMETHOD(mmu_clear_reference, ppc8xx_mmu_clear_reference), 45 * ... 46 * MMUMETHOD(mmu_dev_direct_mapped, ppc8xx_mmu_dev_direct_mapped), 47 * { 0, 0 } 48 * }; 49 * 50 * MMU_DEF(ppc8xx, MMU_TYPE_8xx, ppc8xx_methods, sizeof(ppc8xx_mmu_softc)); 51 * 52 * A single level of inheritance is supported in a similar fashion to 53 * kobj inheritance e.g. 54 * 55 * MMU_DEF_1(ppc860c, MMU_TYPE_860c, ppc860c_methods, 0, ppc8xx); 56 */ 57 58 #include <sys/kobj.h> 59 60 struct mmu_kobj { 61 /* 62 * An MMU instance is a kernel object 63 */ 64 KOBJ_FIELDS; 65 66 /* 67 * Utility elements that an instance may use 68 */ 69 struct mtx mmu_mtx; /* available for instance use */ 70 void *mmu_iptr; /* instance data pointer */ 71 72 /* 73 * Opaque data that can be overlaid with an instance-private 74 * structure. MMU code can test that this is large enough at 75 * compile time with a sizeof() test againt it's softc. There 76 * is also a run-time test when the MMU kernel object is 77 * registered. 78 */ 79 #define MMU_OPAQUESZ 64 80 u_int mmu_opaque[MMU_OPAQUESZ]; 81 }; 82 83 typedef struct mmu_kobj *mmu_t; 84 typedef struct kobj_class mmu_def_t; 85 #define mmu_method_t kobj_method_t 86 87 #define MMUMETHOD KOBJMETHOD 88 89 #define MMU_DEF(name, ident, methods, size) \ 90 \ 91 mmu_def_t name = { \ 92 ident, methods, size, NULL \ 93 }; \ 94 DATA_SET(mmu_set, name) 95 96 #define MMU_DEF_INHERIT(name, ident, methods, size, base1) \ 97 \ 98 static kobj_class_t name ## _baseclasses[] = \ 99 { &base1, NULL }; \ 100 mmu_def_t name = { \ 101 ident, methods, size, name ## _baseclasses \ 102 }; \ 103 DATA_SET(mmu_set, name) 104 105 106 #if 0 107 mmu_def_t name = { \ 108 ident, methods, size, name ## _baseclasses \ 109 }; 110 DATA_SET(mmu_set, name) 111 #endif 112 113 /* 114 * Known MMU names 115 */ 116 #define MMU_TYPE_BOOKE "mmu_booke" /* Book-E MMU specification */ 117 #define MMU_TYPE_OEA "mmu_oea" /* 32-bit OEA */ 118 #define MMU_TYPE_G5 "mmu_g5" /* 64-bit bridge (ibm 970) */ 119 #define MMU_TYPE_8xx "mmu_8xx" /* 8xx quicc TLB */ 120 121 #endif /* _MACHINE_MMUVAR_H_ */ 122