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