xref: /openbsd/sys/arch/sh/include/mmu.h (revision bff2ef4d)
1 /*	$OpenBSD: mmu.h,v 1.3 2022/02/21 12:16:55 jsg Exp $	*/
2 /*	$NetBSD: mmu.h,v 1.9 2006/03/04 01:55:03 uwe Exp $	*/
3 
4 /*-
5  * Copyright (c) 2002 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by UCHIYAMA Yasushi.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef _SH_MMU_H_
34 #define	_SH_MMU_H_
35 
36 /*
37  * Initialize routines.
38  *	sh_mmu_init		Assign function vector. Don't access hardware.
39  *				Call as early as possible.
40  *	sh_mmu_start		Reset TLB entry, set default ASID, and start to
41  *				translate addresses.
42  *				Call after exception vector was installed.
43  *
44  * TLB access ops.
45  *	sh_tlb_invalidate_addr	invalidate TLB entries for given
46  *				virtual addr with ASID.
47  *	sh_tlb_invalidate_asid	invalidate TLB entries for given ASID.
48  *	sh_tlb_invalidate_all	invalidate all non-wired TLB entries.
49  *	sh_tlb_set_asid		set ASID.
50  *	sh_tlb_update		load new PTE to TLB.
51  *
52  */
53 
54 void sh_mmu_init(void);
55 void sh_mmu_information(void);
56 void sh_tlb_set_asid(int);
57 
58 #ifdef SH3
59 void sh3_mmu_start(void);
60 void sh3_tlb_invalidate_addr(int, vaddr_t);
61 void sh3_tlb_invalidate_asid(int);
62 void sh3_tlb_invalidate_all(void);
63 void sh3_tlb_update(int, vaddr_t, uint32_t);
64 #endif
65 
66 #ifdef SH4
67 void sh4_mmu_start(void);
68 void sh4_tlb_invalidate_addr(int, vaddr_t);
69 void sh4_tlb_invalidate_asid(int);
70 void sh4_tlb_invalidate_all(void);
71 void sh4_tlb_update(int, vaddr_t, uint32_t);
72 #endif
73 
74 
75 #if defined(SH3) && defined(SH4)
76 extern uint32_t __sh_PTEH;
77 
78 extern void (*__sh_mmu_start)(void);
79 extern void (*__sh_tlb_invalidate_addr)(int, vaddr_t);
80 extern void (*__sh_tlb_invalidate_asid)(int);
81 extern void (*__sh_tlb_invalidate_all)(void);
82 extern void (*__sh_tlb_update)(int, vaddr_t, uint32_t);
83 
84 #define	sh_mmu_start()			(*__sh_mmu_start)()
85 #define	sh_tlb_invalidate_addr(a, va)	(*__sh_tlb_invalidate_addr)(a, va)
86 #define	sh_tlb_invalidate_asid(a)	(*__sh_tlb_invalidate_asid)(a)
87 #define	sh_tlb_invalidate_all()		(*__sh_tlb_invalidate_all)()
88 #define	sh_tlb_update(a, va, pte)	(*__sh_tlb_update)(a, va, pte)
89 
90 #elif defined(SH3)
91 
92 #define	sh_mmu_start()			sh3_mmu_start()
93 #define	sh_tlb_invalidate_addr(a, va)	sh3_tlb_invalidate_addr(a, va)
94 #define	sh_tlb_invalidate_asid(a)	sh3_tlb_invalidate_asid(a)
95 #define	sh_tlb_invalidate_all()		sh3_tlb_invalidate_all()
96 #define	sh_tlb_update(a, va, pte)	sh3_tlb_update(a, va, pte)
97 
98 #elif defined(SH4)
99 
100 #define	sh_mmu_start()			sh4_mmu_start()
101 #define	sh_tlb_invalidate_addr(a, va)	sh4_tlb_invalidate_addr(a, va)
102 #define	sh_tlb_invalidate_asid(a)	sh4_tlb_invalidate_asid(a)
103 #define	sh_tlb_invalidate_all()		sh4_tlb_invalidate_all()
104 #define	sh_tlb_update(a, va, pte)	sh4_tlb_update(a, va, pte)
105 
106 #endif
107 
108 #endif /* !_SH_MMU_H_ */
109