xref: /freebsd/sys/powerpc/include/tlb.h (revision 3fc36ee018bb836bd1796067cf4ef8683f166ebc)
1 /*-
2  * Copyright (C) 2006-2012 Semihalf.
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  * 3. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
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.  IN
19  * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
21  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 
30 #ifndef	_MACHINE_TLB_H_
31 #define	_MACHINE_TLB_H_
32 
33 #if defined(BOOKE_E500)
34 
35 /*  PowerPC E500 MAS registers */
36 #define MAS0_TLBSEL(x)		((x << 28) & 0x10000000)
37 #define MAS0_ESEL(x)		((x << 16) & 0x003F0000)
38 
39 #define MAS0_TLBSEL1		0x10000000
40 #define MAS0_TLBSEL0		0x00000000
41 #define MAS0_ESEL_TLB1MASK	0x000F0000
42 #define MAS0_ESEL_TLB0MASK	0x00030000
43 #define MAS0_ESEL_SHIFT		16
44 #define MAS0_NV_MASK		0x00000003
45 #define MAS0_NV_SHIFT		0
46 
47 #define MAS1_VALID		0x80000000
48 #define MAS1_IPROT		0x40000000
49 #define MAS1_TID_MASK		0x00FF0000
50 #define MAS1_TID_SHIFT		16
51 #define MAS1_TS_MASK		0x00001000
52 #define MAS1_TS_SHIFT		12
53 #define MAS1_TSIZE_MASK		0x00000F00
54 #define MAS1_TSIZE_SHIFT	8
55 
56 #define	TLB_SIZE_4K		1
57 #define	TLB_SIZE_16K		2
58 #define	TLB_SIZE_64K		3
59 #define	TLB_SIZE_256K		4
60 #define	TLB_SIZE_1M		5
61 #define	TLB_SIZE_4M		6
62 #define	TLB_SIZE_16M		7
63 #define	TLB_SIZE_64M		8
64 #define	TLB_SIZE_256M		9
65 #define	TLB_SIZE_1G		10
66 #define	TLB_SIZE_4G		11
67 
68 #define	MAS2_EPN_MASK		0xFFFFF000
69 #define	MAS2_EPN_SHIFT		12
70 #define	MAS2_X0			0x00000040
71 #define	MAS2_X1			0x00000020
72 #define	MAS2_W			0x00000010
73 #define	MAS2_I			0x00000008
74 #define	MAS2_M			0x00000004
75 #define	MAS2_G			0x00000002
76 #define	MAS2_E			0x00000001
77 #define	MAS2_WIMGE_MASK		0x0000007F
78 
79 #define	MAS3_RPN		0xFFFFF000
80 #define	MAS3_RPN_SHIFT		12
81 #define	MAS3_U0			0x00000200
82 #define	MAS3_U1			0x00000100
83 #define	MAS3_U2			0x00000080
84 #define	MAS3_U3			0x00000040
85 #define	MAS3_UX			0x00000020
86 #define	MAS3_SX			0x00000010
87 #define	MAS3_UW			0x00000008
88 #define	MAS3_SW			0x00000004
89 #define	MAS3_UR			0x00000002
90 #define	MAS3_SR			0x00000001
91 
92 #define MAS4_TLBSELD1		0x10000000
93 #define MAS4_TLBSELD0		0x00000000
94 #define MAS4_TIDSELD_MASK	0x00030000
95 #define MAS4_TIDSELD_SHIFT	16
96 #define MAS4_TSIZED_MASK	0x00000F00
97 #define MAS4_TSIZED_SHIFT	8
98 #define MAS4_X0D		0x00000040
99 #define MAS4_X1D		0x00000020
100 #define MAS4_WD			0x00000010
101 #define MAS4_ID			0x00000008
102 #define MAS4_MD			0x00000004
103 #define MAS4_GD			0x00000002
104 #define MAS4_ED			0x00000001
105 
106 #define MAS6_SPID0_MASK		0x00FF0000
107 #define MAS6_SPID0_SHIFT	16
108 #define MAS6_SAS		0x00000001
109 
110 #define MAS7_RPN		0x0000000F
111 
112 #define MAS1_GETTID(mas1)	(((mas1) & MAS1_TID_MASK) >> MAS1_TID_SHIFT)
113 
114 #define MAS2_TLB0_ENTRY_IDX_MASK	0x0007f000
115 #define MAS2_TLB0_ENTRY_IDX_SHIFT	12
116 
117 /*
118  * Maximum number of TLB1 entries used for a permanent mapping of kernel
119  * region (kernel image plus statically allocated data).
120  */
121 #define KERNEL_REGION_MAX_TLB_ENTRIES   4
122 
123 /*
124  * Use MAS2_X0 to mark entries which will be copied
125  * to AP CPUs during SMP bootstrap. As result entries
126  * marked with _TLB_ENTRY_SHARED will be shared by all CPUs.
127  */
128 #define _TLB_ENTRY_SHARED	(MAS2_X0)	/* XXX under SMP? */
129 #define _TLB_ENTRY_IO	(MAS2_I | MAS2_G)
130 #define _TLB_ENTRY_MEM	(MAS2_M)
131 
132 #define TLB1_MAX_ENTRIES	64
133 
134 #if !defined(LOCORE)
135 typedef struct tlb_entry {
136 	vm_paddr_t phys;
137 	vm_offset_t virt;
138 	vm_size_t size;
139 	uint32_t mas1;
140 	uint32_t mas2;
141 	uint32_t mas3;
142 	uint32_t mas7;
143 } tlb_entry_t;
144 
145 void tlb0_print_tlbentries(void);
146 
147 void tlb1_inval_entry(unsigned int);
148 void tlb1_init(void);
149 void tlb1_print_entries(void);
150 void tlb1_print_tlbentries(void);
151 #endif /* !LOCORE */
152 
153 #elif defined(BOOKE_PPC4XX)
154 
155 /* TLB Words */
156 #define	TLB_PAGEID		0
157 #define	TLB_XLAT		1
158 #define	TLB_ATTRIB		2
159 
160 /* Page identification fields */
161 #define	TLB_EPN_MASK		(0xFFFFFC00 >> 0)
162 #define	TLB_VALID		(0x80000000 >> 22)
163 #define	TLB_TS			(0x80000000 >> 23)
164 #define	TLB_SIZE_1K		(0x00000000 >> 24)
165 #define	TLB_SIZE_MASK		(0xF0000000 >> 24)
166 
167 /* Translation fields */
168 #define	TLB_RPN_MASK		(0xFFFFFC00 >> 0)
169 #define	TLB_ERPN_MASK		(0xF0000000 >> 28)
170 
171 /* Storage attribute and access control fields */
172 #define	TLB_WL1			(0x80000000 >> 11)
173 #define	TLB_IL1I		(0x80000000 >> 12)
174 #define	TLB_IL1D		(0x80000000 >> 13)
175 #define	TLB_IL2I		(0x80000000 >> 14)
176 #define	TLB_IL2D		(0x80000000 >> 15)
177 #define	TLB_U0			(0x80000000 >> 16)
178 #define	TLB_U1			(0x80000000 >> 17)
179 #define	TLB_U2			(0x80000000 >> 18)
180 #define	TLB_U3			(0x80000000 >> 19)
181 #define	TLB_W			(0x80000000 >> 20)
182 #define	TLB_I			(0x80000000 >> 21)
183 #define	TLB_M			(0x80000000 >> 22)
184 #define	TLB_G			(0x80000000 >> 23)
185 #define	TLB_E			(0x80000000 >> 24)
186 #define	TLB_UX			(0x80000000 >> 26)
187 #define	TLB_UW			(0x80000000 >> 27)
188 #define	TLB_UR			(0x80000000 >> 28)
189 #define	TLB_SX			(0x80000000 >> 29)
190 #define	TLB_SW			(0x80000000 >> 30)
191 #define	TLB_SR			(0x80000000 >> 31)
192 #define	TLB_SIZE		64
193 
194 #define	TLB_SIZE_4K		(0x10000000 >> 24)
195 #define	TLB_SIZE_16K		(0x20000000 >> 24)
196 #define	TLB_SIZE_64K		(0x30000000 >> 24)
197 #define	TLB_SIZE_256K		(0x40000000 >> 24)
198 #define	TLB_SIZE_1M		(0x50000000 >> 24)
199 #define	TLB_SIZE_16M		(0x70000000 >> 24)
200 #define	TLB_SIZE_256M		(0x90000000 >> 24)
201 #define	TLB_SIZE_1G		(0xA0000000 >> 24)
202 
203 #endif /* BOOKE_E500 */
204 
205 #define TID_KERNEL	0	/* TLB TID to use for kernel (shared) translations */
206 #define TID_KRESERVED	1	/* Number of TIDs reserved for kernel */
207 #define TID_URESERVED	0	/* Number of TIDs reserved for user */
208 #define TID_MIN		(TID_KRESERVED + TID_URESERVED)
209 #define TID_MAX		255
210 #define TID_NONE	-1
211 
212 #define TLB_UNLOCKED	0
213 
214 #if !defined(LOCORE)
215 
216 typedef int tlbtid_t;
217 
218 struct pmap;
219 
220 void tlb_lock(uint32_t *);
221 void tlb_unlock(uint32_t *);
222 void tlb1_ap_prep(void);
223 int  tlb1_set_entry(vm_offset_t, vm_paddr_t, vm_size_t, uint32_t);
224 
225 #endif /* !LOCORE */
226 
227 #endif	/* _MACHINE_TLB_H_ */
228