xref: /netbsd-src/sys/arch/mips/include/cpuregs.h (revision d710132b4b8ce7f7cccaaf660cb16aa16b4077a0)
1 /*	$NetBSD: cpuregs.h,v 1.61 2003/06/10 06:42:06 simonb Exp $	*/
2 
3 /*
4  * Copyright (c) 1992, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Ralph Campbell and Rick Macklem.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *	This product includes software developed by the University of
21  *	California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  *	@(#)machConst.h 8.1 (Berkeley) 6/10/93
39  *
40  * machConst.h --
41  *
42  *	Machine dependent constants.
43  *
44  *	Copyright (C) 1989 Digital Equipment Corporation.
45  *	Permission to use, copy, modify, and distribute this software and
46  *	its documentation for any purpose and without fee is hereby granted,
47  *	provided that the above copyright notice appears in all copies.
48  *	Digital Equipment Corporation makes no representations about the
49  *	suitability of this software for any purpose.  It is provided "as is"
50  *	without express or implied warranty.
51  *
52  * from: Header: /sprite/src/kernel/mach/ds3100.md/RCS/machConst.h,
53  *	v 9.2 89/10/21 15:55:22 jhh Exp	 SPRITE (DECWRL)
54  * from: Header: /sprite/src/kernel/mach/ds3100.md/RCS/machAddrs.h,
55  *	v 1.2 89/08/15 18:28:21 rab Exp	 SPRITE (DECWRL)
56  * from: Header: /sprite/src/kernel/vm/ds3100.md/RCS/vmPmaxConst.h,
57  *	v 9.1 89/09/18 17:33:00 shirriff Exp  SPRITE (DECWRL)
58  */
59 
60 #ifndef _MIPS_CPUREGS_H_
61 #define	_MIPS_CPUREGS_H_
62 
63 #include <sys/cdefs.h>		/* For __CONCAT() */
64 
65 #if defined(_KERNEL_OPT)
66 #include "opt_cputype.h"
67 #endif
68 
69 /*
70  * Address space.
71  * 32-bit mips CPUS partition their 32-bit address space into four segments:
72  *
73  * kuseg   0x00000000 - 0x7fffffff  User virtual mem,  mapped
74  * kseg0   0x80000000 - 0x9fffffff  Physical memory, cached, unmapped
75  * kseg1   0xa0000000 - 0xbfffffff  Physical memory, uncached, unmapped
76  * kseg2   0xc0000000 - 0xffffffff  kernel-virtual,  mapped
77  *
78  * mips1 physical memory is limited to 512Mbytes, which is
79  * doubly mapped in kseg0 (cached) and kseg1 (uncached.)
80  * Caching of mapped addresses is controlled by bits in the TLB entry.
81  */
82 
83 #define	MIPS_KUSEG_START		0x0
84 #define	MIPS_KSEG0_START		0x80000000
85 #define	MIPS_KSEG1_START		0xa0000000
86 #define	MIPS_KSEG2_START		0xc0000000
87 #define	MIPS_MAX_MEM_ADDR		0xbe000000
88 #define	MIPS_RESERVED_ADDR		0xbfc80000
89 
90 #define	MIPS_PHYS_MASK			0x1fffffff
91 
92 #define	MIPS_KSEG0_TO_PHYS(x)	((unsigned)(x) & MIPS_PHYS_MASK)
93 #define	MIPS_PHYS_TO_KSEG0(x)	((unsigned)(x) | MIPS_KSEG0_START)
94 #define	MIPS_KSEG1_TO_PHYS(x)	((unsigned)(x) & MIPS_PHYS_MASK)
95 #define	MIPS_PHYS_TO_KSEG1(x)	((unsigned)(x) | MIPS_KSEG1_START)
96 
97 /* Map virtual address to index in mips3 r4k virtually-indexed cache */
98 #define	MIPS3_VA_TO_CINDEX(x) \
99 		((unsigned)(x) & 0xffffff | MIPS_KSEG0_START)
100 
101 #define	MIPS_PHYS_TO_XKPHYS(cca,x) \
102 	((0x2ULL << 62) | ((unsigned long long)(cca) << 59) | (x))
103 #define	MIPS_XKPHYS_TO_PHYS(x)	((x) & 0x0effffffffffffffULL)
104 
105 /* CPU dependent mtc0 hazard hook */
106 #define	COP0_SYNC		/* nothing */
107 #define	COP0_HAZARD_FPUENABLE	nop; nop; nop; nop;
108 
109 /*
110  * The bits in the cause register.
111  *
112  * Bits common to r3000 and r4000:
113  *
114  *	MIPS_CR_BR_DELAY	Exception happened in branch delay slot.
115  *	MIPS_CR_COP_ERR		Coprocessor error.
116  *	MIPS_CR_IP		Interrupt pending bits defined below.
117  *				(same meaning as in CAUSE register).
118  *	MIPS_CR_EXC_CODE	The exception type (see exception codes below).
119  *
120  * Differences:
121  *  r3k has 4 bits of execption type, r4k has 5 bits.
122  */
123 #define	MIPS_CR_BR_DELAY	0x80000000
124 #define	MIPS_CR_COP_ERR		0x30000000
125 #define	MIPS1_CR_EXC_CODE	0x0000003C	/* four bits */
126 #define	MIPS3_CR_EXC_CODE	0x0000007C	/* five bits */
127 #define	MIPS_CR_IP		0x0000FF00
128 #define	MIPS_CR_EXC_CODE_SHIFT	2
129 
130 /*
131  * The bits in the status register.  All bits are active when set to 1.
132  *
133  *	R3000 status register fields:
134  *	MIPS_SR_COP_USABILITY	Control the usability of the four coprocessors.
135  *	MIPS_SR_TS		TLB shutdown.
136  *
137  *	MIPS_SR_INT_IE		Master (current) interrupt enable bit.
138  *
139  * Differences:
140  *	r3k has cache control is via frobbing SR register bits, whereas the
141  *	r4k cache control is via explicit instructions.
142  *	r3k has a 3-entry stack of kernel/user bits, whereas the
143  *	r4k has kernel/supervisor/user.
144  */
145 #define	MIPS_SR_COP_USABILITY	0xf0000000
146 #define	MIPS_SR_COP_0_BIT	0x10000000
147 #define	MIPS_SR_COP_1_BIT	0x20000000
148 
149 	/* r4k and r3k differences, see below */
150 
151 #define	MIPS_SR_MX		0x01000000	/* MIPS64 */
152 #define	MIPS_SR_PX		0x00800000	/* MIPS64 */
153 #define	MIPS_SR_BEV		0x00400000	/* Use boot exception vector */
154 #define	MIPS_SR_TS		0x00200000
155 
156 	/* r4k and r3k differences, see below */
157 
158 #define	MIPS_SR_INT_IE		0x00000001
159 /*#define MIPS_SR_MBZ		0x0f8000c0*/	/* Never used, true for r3k */
160 /*#define MIPS_SR_INT_MASK	0x0000ff00*/
161 
162 
163 /*
164  * The R2000/R3000-specific status register bit definitions.
165  * all bits are active when set to 1.
166  *
167  *	MIPS_SR_PARITY_ERR	Parity error.
168  *	MIPS_SR_CACHE_MISS	Most recent D-cache load resulted in a miss.
169  *	MIPS_SR_PARITY_ZERO	Zero replaces outgoing parity bits.
170  *	MIPS_SR_SWAP_CACHES	Swap I-cache and D-cache.
171  *	MIPS_SR_ISOL_CACHES	Isolate D-cache from main memory.
172  *				Interrupt enable bits defined below.
173  *	MIPS_SR_KU_OLD		Old kernel/user mode bit. 1 => user mode.
174  *	MIPS_SR_INT_ENA_OLD	Old interrupt enable bit.
175  *	MIPS_SR_KU_PREV		Previous kernel/user mode bit. 1 => user mode.
176  *	MIPS_SR_INT_ENA_PREV	Previous interrupt enable bit.
177  *	MIPS_SR_KU_CUR		Current kernel/user mode bit. 1 => user mode.
178  */
179 
180 #define	MIPS1_PARITY_ERR	0x00100000
181 #define	MIPS1_CACHE_MISS	0x00080000
182 #define	MIPS1_PARITY_ZERO	0x00040000
183 #define	MIPS1_SWAP_CACHES	0x00020000
184 #define	MIPS1_ISOL_CACHES	0x00010000
185 
186 #define	MIPS1_SR_KU_OLD		0x00000020	/* 2nd stacked KU/IE*/
187 #define	MIPS1_SR_INT_ENA_OLD	0x00000010	/* 2nd stacked KU/IE*/
188 #define	MIPS1_SR_KU_PREV	0x00000008	/* 1st stacked KU/IE*/
189 #define	MIPS1_SR_INT_ENA_PREV	0x00000004	/* 1st stacked KU/IE*/
190 #define	MIPS1_SR_KU_CUR		0x00000002	/* current KU */
191 
192 /* backwards compatibility */
193 #define	MIPS_SR_PARITY_ERR	MIPS1_PARITY_ERR
194 #define	MIPS_SR_CACHE_MISS	MIPS1_CACHE_MISS
195 #define	MIPS_SR_PARITY_ZERO	MIPS1_PARITY_ZERO
196 #define	MIPS_SR_SWAP_CACHES	MIPS1_SWAP_CACHES
197 #define	MIPS_SR_ISOL_CACHES	MIPS1_ISOL_CACHES
198 
199 #define	MIPS_SR_KU_OLD		MIPS1_SR_KU_OLD
200 #define	MIPS_SR_INT_ENA_OLD	MIPS1_SR_INT_ENA_OLD
201 #define	MIPS_SR_KU_PREV		MIPS1_SR_KU_PREV
202 #define	MIPS_SR_KU_CUR		MIPS1_SR_KU_CUR
203 #define	MIPS_SR_INT_ENA_PREV	MIPS1_SR_INT_ENA_PREV
204 
205 /*
206  * R4000 status register bit definitons,
207  * where different from r2000/r3000.
208  */
209 #define	MIPS3_SR_XX		0x80000000
210 #define	MIPS3_SR_RP		0x08000000
211 #define	MIPS3_SR_FR		0x04000000
212 #define	MIPS3_SR_RE		0x02000000
213 
214 #define	MIPS3_SR_DIAG_DL	0x01000000		/* QED 52xx */
215 #define	MIPS3_SR_DIAG_IL	0x00800000		/* QED 52xx */
216 #define	MIPS3_SR_SR		0x00100000
217 #define	MIPS3_SR_EIE		0x00100000		/* TX79/R5900 */
218 #define	MIPS3_SR_NMI		0x00080000		/* MIPS32/64 */
219 #define	MIPS3_SR_DIAG_CH	0x00040000
220 #define	MIPS3_SR_DIAG_CE	0x00020000
221 #define	MIPS3_SR_DIAG_PE	0x00010000
222 #define	MIPS3_SR_KX		0x00000080
223 #define	MIPS3_SR_SX		0x00000040
224 #define	MIPS3_SR_UX		0x00000020
225 #define	MIPS3_SR_KSU_MASK	0x00000018
226 #define	MIPS3_SR_KSU_USER	0x00000010
227 #define	MIPS3_SR_KSU_SUPER	0x00000008
228 #define	MIPS3_SR_KSU_KERNEL	0x00000000
229 #define	MIPS3_SR_ERL		0x00000004
230 #define	MIPS3_SR_EXL		0x00000002
231 
232 #ifdef MIPS3_5900
233 #undef MIPS_SR_INT_IE
234 #define	MIPS_SR_INT_IE		0x00010001		/* XXX */
235 #endif
236 
237 #define	MIPS_SR_SOFT_RESET	MIPS3_SR_SOFT_RESET
238 #define	MIPS_SR_DIAG_CH		MIPS3_SR_DIAG_CH
239 #define	MIPS_SR_DIAG_CE		MIPS3_SR_DIAG_CE
240 #define	MIPS_SR_DIAG_PE		MIPS3_SR_DIAG_PE
241 #define	MIPS_SR_KX		MIPS3_SR_KX
242 #define	MIPS_SR_SX		MIPS3_SR_SX
243 #define	MIPS_SR_UX		MIPS3_SR_UX
244 
245 #define	MIPS_SR_KSU_MASK	MIPS3_SR_KSU_MASK
246 #define	MIPS_SR_KSU_USER	MIPS3_SR_KSU_USER
247 #define	MIPS_SR_KSU_SUPER	MIPS3_SR_KSU_SUPER
248 #define	MIPS_SR_KSU_KERNEL	MIPS3_SR_KSU_KERNEL
249 #define	MIPS_SR_ERL		MIPS3_SR_ERL
250 #define	MIPS_SR_EXL		MIPS3_SR_EXL
251 
252 
253 /*
254  * The interrupt masks.
255  * If a bit in the mask is 1 then the interrupt is enabled (or pending).
256  */
257 #define	MIPS_INT_MASK		0xff00
258 #define	MIPS_INT_MASK_5		0x8000
259 #define	MIPS_INT_MASK_4		0x4000
260 #define	MIPS_INT_MASK_3		0x2000
261 #define	MIPS_INT_MASK_2		0x1000
262 #define	MIPS_INT_MASK_1		0x0800
263 #define	MIPS_INT_MASK_0		0x0400
264 #define	MIPS_HARD_INT_MASK	0xfc00
265 #define	MIPS_SOFT_INT_MASK_1	0x0200
266 #define	MIPS_SOFT_INT_MASK_0	0x0100
267 
268 /*
269  * mips3 CPUs have on-chip timer at INT_MASK_5.  Each platform can
270  * choose to enable this interrupt.
271  */
272 #if defined(MIPS3_ENABLE_CLOCK_INTR)
273 #define	MIPS3_INT_MASK			MIPS_INT_MASK
274 #define	MIPS3_HARD_INT_MASK		MIPS_HARD_INT_MASK
275 #else
276 #define	MIPS3_INT_MASK			(MIPS_INT_MASK &  ~MIPS_INT_MASK_5)
277 #define	MIPS3_HARD_INT_MASK		(MIPS_HARD_INT_MASK & ~MIPS_INT_MASK_5)
278 #endif
279 
280 /*
281  * The bits in the context register.
282  */
283 #define	MIPS1_CNTXT_PTE_BASE	0xFFE00000
284 #define	MIPS1_CNTXT_BAD_VPN	0x001FFFFC
285 
286 #define	MIPS3_CNTXT_PTE_BASE	0xFF800000
287 #define	MIPS3_CNTXT_BAD_VPN2	0x007FFFF0
288 
289 /*
290  * The bits in the MIPS3 config register.
291  *
292  *	bit 0..5: R/W, Bit 6..31: R/O
293  */
294 
295 /* kseg0 coherency algorithm - see MIPS3_TLB_ATTR values */
296 #define	MIPS3_CONFIG_K0_MASK	0x00000007
297 
298 /*
299  * R/W Update on Store Conditional
300  *	0: Store Conditional uses coherency algorithm specified by TLB
301  *	1: Store Conditional uses cacheable coherent update on write
302  */
303 #define	MIPS3_CONFIG_CU		0x00000008
304 
305 #define	MIPS3_CONFIG_DB		0x00000010	/* Primary D-cache line size */
306 #define	MIPS3_CONFIG_IB		0x00000020	/* Primary I-cache line size */
307 #define	MIPS3_CONFIG_CACHE_L1_LSIZE(config, bit) \
308 	(((config) & (bit)) ? 32 : 16)
309 
310 #define	MIPS3_CONFIG_DC_MASK	0x000001c0	/* Primary D-cache size */
311 #define	MIPS3_CONFIG_DC_SHIFT	6
312 #define	MIPS3_CONFIG_IC_MASK	0x00000e00	/* Primary I-cache size */
313 #define	MIPS3_CONFIG_IC_SHIFT	9
314 #define	MIPS3_CONFIG_C_DEFBASE	0x1000		/* default base 2^12 */
315 #ifdef MIPS3_4100				/* VR4100 core */
316 /* XXXCDC: THIS MIPS3_4100 SPECIAL CASE SHOULD GO AWAY */
317 #define	MIPS3_CONFIG_CS		0x00001000	/* cache size mode indication*/
318 #define	MIPS3_CONFIG_CACHE_SIZE(config, mask, dummy, shift) \
319 	((((config)&MIPS3_CONFIG_CS)?0x400:0x1000) << (((config) & (mask)) >> (shift)))
320 #else
321 #define	MIPS3_CONFIG_CACHE_SIZE(config, mask, base, shift) \
322 	((base) << (((config) & (mask)) >> (shift)))
323 #endif
324 
325 /* External cache enable: Controls L2 for R5000/Rm527x and L3 for Rm7000 */
326 #define	MIPS3_CONFIG_SE		0x00001000
327 
328 /* Block ordering: 0: sequential, 1: sub-block */
329 #define	MIPS3_CONFIG_EB		0x00002000
330 
331 /* ECC mode - 0: ECC mode, 1: parity mode */
332 #define	MIPS3_CONFIG_EM		0x00004000
333 
334 /* BigEndianMem - 0: kernel and memory are little endian, 1: big endian */
335 #define	MIPS3_CONFIG_BE		0x00008000
336 
337 /* Dirty Shared coherency state - 0: enabled, 1: disabled */
338 #define	MIPS3_CONFIG_SM		0x00010000
339 
340 /* Secondary Cache - 0: present, 1: not present */
341 #define	MIPS3_CONFIG_SC		0x00020000
342 
343 /* System Port width - 0: 64-bit, 1: 32-bit (QED RM523x), 2,3: reserved */
344 #define	MIPS3_CONFIG_EW_MASK	0x000c0000
345 #define	MIPS3_CONFIG_EW_SHIFT	18
346 
347 /* Secondary Cache port width - 0: 128-bit data path to S-cache, 1: reserved */
348 #define	MIPS3_CONFIG_SW		0x00100000
349 
350 /* Split Secondary Cache Mode - 0: I/D mixed, 1: I/D separated by SCAddr(17) */
351 #define	MIPS3_CONFIG_SS		0x00200000
352 
353 /* Secondary Cache line size */
354 #define	MIPS3_CONFIG_SB_MASK	0x00c00000
355 #define	MIPS3_CONFIG_SB_SHIFT	22
356 #define	MIPS3_CONFIG_CACHE_L2_LSIZE(config) \
357 	(0x10 << (((config) & MIPS3_CONFIG_SB_MASK) >> MIPS3_CONFIG_SB_SHIFT))
358 
359 /* Write back data rate */
360 #define	MIPS3_CONFIG_EP_MASK	0x0f000000
361 #define	MIPS3_CONFIG_EP_SHIFT	24
362 
363 /* System clock ratio - this value is CPU dependent */
364 #define	MIPS3_CONFIG_EC_MASK	0x70000000
365 #define	MIPS3_CONFIG_EC_SHIFT	28
366 
367 /* Master-Checker Mode - 1: enabled */
368 #define	MIPS3_CONFIG_CM		0x80000000
369 
370 /*
371  * Location of exception vectors.
372  *
373  * Common vectors:  reset and UTLB miss.
374  */
375 #define	MIPS_RESET_EXC_VEC	0xBFC00000
376 #define	MIPS_UTLB_MISS_EXC_VEC	0x80000000
377 
378 /*
379  * MIPS-1 general exception vector (everything else)
380  */
381 #define	MIPS1_GEN_EXC_VEC	0x80000080
382 
383 /*
384  * MIPS-III exception vectors
385  */
386 #define	MIPS3_XTLB_MISS_EXC_VEC 0x80000080
387 #define	MIPS3_CACHE_ERR_EXC_VEC 0x80000100
388 #define	MIPS3_GEN_EXC_VEC	0x80000180
389 
390 /*
391  * TX79 (R5900) exception vectors
392  */
393 #define MIPS_R5900_COUNTER_EXC_VEC		0x80000080
394 #define MIPS_R5900_DEBUG_EXC_VEC		0x80000100
395 
396 /*
397  * MIPS32/MIPS64 (and some MIPS3) dedicated interrupt vector.
398  */
399 #define	MIPS3_INTR_EXC_VEC	0x80000200
400 
401 /*
402  * Coprocessor 0 registers:
403  *
404  *				v--- width for mips I,III,32,64
405  *				     (3=32bit, 6=64bit, i=impl dep)
406  *  0	MIPS_COP_0_TLB_INDEX	3333 TLB Index.
407  *  1	MIPS_COP_0_TLB_RANDOM	3333 TLB Random.
408  *  2	MIPS_COP_0_TLB_LOW	3... r3k TLB entry low.
409  *  2	MIPS_COP_0_TLB_LO0	.636 r4k TLB entry low.
410  *  3	MIPS_COP_0_TLB_LO1	.636 r4k TLB entry low, extended.
411  *  4	MIPS_COP_0_TLB_CONTEXT	3636 TLB Context.
412  *  5	MIPS_COP_0_TLB_PG_MASK	.333 TLB Page Mask register.
413  *  6	MIPS_COP_0_TLB_WIRED	.333 Wired TLB number.
414  *  8	MIPS_COP_0_BAD_VADDR	3636 Bad virtual address.
415  *  9	MIPS_COP_0_COUNT	.333 Count register.
416  * 10	MIPS_COP_0_TLB_HI	3636 TLB entry high.
417  * 11	MIPS_COP_0_COMPARE	.333 Compare (against Count).
418  * 12	MIPS_COP_0_STATUS	3333 Status register.
419  * 13	MIPS_COP_0_CAUSE	3333 Exception cause register.
420  * 14	MIPS_COP_0_EXC_PC	3636 Exception PC.
421  * 15	MIPS_COP_0_PRID		3333 Processor revision identifier.
422  * 16	MIPS_COP_0_CONFIG	3333 Configuration register.
423  * 16/1	MIPS_COP_0_CONFIG1	..33 Configuration register 1.
424  * 16/2	MIPS_COP_0_CONFIG2	..33 Configuration register 2.
425  * 16/3	MIPS_COP_0_CONFIG3	..33 Configuration register 3.
426  * 17	MIPS_COP_0_LLADDR	.336 Load Linked Address.
427  * 18	MIPS_COP_0_WATCH_LO	.336 WatchLo register.
428  * 19	MIPS_COP_0_WATCH_HI	.333 WatchHi register.
429  * 20	MIPS_COP_0_TLB_XCONTEXT .6.6 TLB XContext register.
430  * 23	MIPS_COP_0_DEBUG	.... Debug JTAG register.
431  * 24	MIPS_COP_0_DEPC		.... DEPC JTAG register.
432  * 25	MIPS_COP_0_PERFCNT	..36 Performance Counter register.
433  * 26	MIPS_COP_0_ECC		.3ii ECC / Error Control register.
434  * 27	MIPS_COP_0_CACHE_ERR	.3ii Cache Error register.
435  * 28/0	MIPS_COP_0_TAG_LO	.3ii Cache TagLo register (instr).
436  * 28/1	MIPS_COP_0_DATA_LO	..ii Cache DataLo register (instr).
437  * 28/2	MIPS_COP_0_TAG_LO	..ii Cache TagLo register (data).
438  * 28/3	MIPS_COP_0_DATA_LO	..ii Cache DataLo register (data).
439  * 29/0	MIPS_COP_0_TAG_HI	.3ii Cache TagHi register (instr).
440  * 29/1	MIPS_COP_0_DATA_HI	..ii Cache DataHi register (instr).
441  * 29/2	MIPS_COP_0_TAG_HI	..ii Cache TagHi register (data).
442  * 29/3	MIPS_COP_0_DATA_HI	..ii Cache DataHi register (data).
443  * 30	MIPS_COP_0_ERROR_PC	.636 Error EPC register.
444  * 31	MIPS_COP_0_DESAVE	.... DESAVE JTAG register.
445  */
446 #ifdef _LOCORE
447 #define	_(n)	__CONCAT($,n)
448 #else
449 #define	_(n)	n
450 #endif
451 #define	MIPS_COP_0_TLB_INDEX	_(0)
452 #define	MIPS_COP_0_TLB_RANDOM	_(1)
453 	/* Name and meaning of	TLB bits for $2 differ on r3k and r4k. */
454 
455 #define	MIPS_COP_0_TLB_CONTEXT	_(4)
456 					/* $5 and $6 new with MIPS-III */
457 #define	MIPS_COP_0_BAD_VADDR	_(8)
458 #define	MIPS_COP_0_TLB_HI	_(10)
459 #define	MIPS_COP_0_STATUS	_(12)
460 #define	MIPS_COP_0_CAUSE	_(13)
461 #define	MIPS_COP_0_EXC_PC	_(14)
462 #define	MIPS_COP_0_PRID		_(15)
463 
464 
465 /* MIPS-I */
466 #define	MIPS_COP_0_TLB_LOW	_(2)
467 
468 /* MIPS-III */
469 #define	MIPS_COP_0_TLB_LO0	_(2)
470 #define	MIPS_COP_0_TLB_LO1	_(3)
471 
472 #define	MIPS_COP_0_TLB_PG_MASK	_(5)
473 #define	MIPS_COP_0_TLB_WIRED	_(6)
474 
475 #define	MIPS_COP_0_COUNT	_(9)
476 #define	MIPS_COP_0_COMPARE	_(11)
477 
478 #define	MIPS_COP_0_CONFIG	_(16)
479 #define	MIPS_COP_0_LLADDR	_(17)
480 #define	MIPS_COP_0_WATCH_LO	_(18)
481 #define	MIPS_COP_0_WATCH_HI	_(19)
482 #define	MIPS_COP_0_TLB_XCONTEXT _(20)
483 #define	MIPS_COP_0_ECC		_(26)
484 #define	MIPS_COP_0_CACHE_ERR	_(27)
485 #define	MIPS_COP_0_TAG_LO	_(28)
486 #define	MIPS_COP_0_TAG_HI	_(29)
487 #define	MIPS_COP_0_ERROR_PC	_(30)
488 
489 /* MIPS32/64 */
490 #define	MIPS_COP_0_DEBUG	_(23)
491 #define	MIPS_COP_0_DEPC		_(24)
492 #define	MIPS_COP_0_PERFCNT	_(25)
493 #define	MIPS_COP_0_DATA_LO	_(28)
494 #define	MIPS_COP_0_DATA_HI	_(29)
495 #define	MIPS_COP_0_DESAVE	_(31)
496 
497 /*
498  * Values for the code field in a break instruction.
499  */
500 #define	MIPS_BREAK_INSTR	0x0000000d
501 #define	MIPS_BREAK_VAL_MASK	0x03ff0000
502 #define	MIPS_BREAK_VAL_SHIFT	16
503 #define	MIPS_BREAK_KDB_VAL	512
504 #define	MIPS_BREAK_SSTEP_VAL	513
505 #define	MIPS_BREAK_BRKPT_VAL	514
506 #define	MIPS_BREAK_SOVER_VAL	515
507 #define	MIPS_BREAK_KDB		(MIPS_BREAK_INSTR | \
508 				(MIPS_BREAK_KDB_VAL << MIPS_BREAK_VAL_SHIFT))
509 #define	MIPS_BREAK_SSTEP	(MIPS_BREAK_INSTR | \
510 				(MIPS_BREAK_SSTEP_VAL << MIPS_BREAK_VAL_SHIFT))
511 #define	MIPS_BREAK_BRKPT	(MIPS_BREAK_INSTR | \
512 				(MIPS_BREAK_BRKPT_VAL << MIPS_BREAK_VAL_SHIFT))
513 #define	MIPS_BREAK_SOVER	(MIPS_BREAK_INSTR | \
514 				(MIPS_BREAK_SOVER_VAL << MIPS_BREAK_VAL_SHIFT))
515 
516 /*
517  * Mininum and maximum cache sizes.
518  */
519 #define	MIPS_MIN_CACHE_SIZE	(16 * 1024)
520 #define	MIPS_MAX_CACHE_SIZE	(256 * 1024)
521 #define	MIPS3_MAX_PCACHE_SIZE	(32 * 1024)	/* max. primary cache size */
522 
523 /*
524  * The floating point version and status registers.
525  */
526 #define	MIPS_FPU_ID	$0
527 #define	MIPS_FPU_CSR	$31
528 
529 /*
530  * The floating point coprocessor status register bits.
531  */
532 #define	MIPS_FPU_ROUNDING_BITS		0x00000003
533 #define	MIPS_FPU_ROUND_RN		0x00000000
534 #define	MIPS_FPU_ROUND_RZ		0x00000001
535 #define	MIPS_FPU_ROUND_RP		0x00000002
536 #define	MIPS_FPU_ROUND_RM		0x00000003
537 #define	MIPS_FPU_STICKY_BITS		0x0000007c
538 #define	MIPS_FPU_STICKY_INEXACT		0x00000004
539 #define	MIPS_FPU_STICKY_UNDERFLOW	0x00000008
540 #define	MIPS_FPU_STICKY_OVERFLOW	0x00000010
541 #define	MIPS_FPU_STICKY_DIV0		0x00000020
542 #define	MIPS_FPU_STICKY_INVALID		0x00000040
543 #define	MIPS_FPU_ENABLE_BITS		0x00000f80
544 #define	MIPS_FPU_ENABLE_INEXACT		0x00000080
545 #define	MIPS_FPU_ENABLE_UNDERFLOW	0x00000100
546 #define	MIPS_FPU_ENABLE_OVERFLOW	0x00000200
547 #define	MIPS_FPU_ENABLE_DIV0		0x00000400
548 #define	MIPS_FPU_ENABLE_INVALID		0x00000800
549 #define	MIPS_FPU_EXCEPTION_BITS		0x0003f000
550 #define	MIPS_FPU_EXCEPTION_INEXACT	0x00001000
551 #define	MIPS_FPU_EXCEPTION_UNDERFLOW	0x00002000
552 #define	MIPS_FPU_EXCEPTION_OVERFLOW	0x00004000
553 #define	MIPS_FPU_EXCEPTION_DIV0		0x00008000
554 #define	MIPS_FPU_EXCEPTION_INVALID	0x00010000
555 #define	MIPS_FPU_EXCEPTION_UNIMPL	0x00020000
556 #define	MIPS_FPU_COND_BIT		0x00800000
557 #define	MIPS_FPU_FLUSH_BIT		0x01000000	/* r4k,	 MBZ on r3k */
558 #define	MIPS1_FPC_MBZ_BITS		0xff7c0000
559 #define	MIPS3_FPC_MBZ_BITS		0xfe7c0000
560 
561 
562 /*
563  * Constants to determine if have a floating point instruction.
564  */
565 #define	MIPS_OPCODE_SHIFT	26
566 #define	MIPS_OPCODE_C1		0x11
567 
568 
569 /*
570  * The low part of the TLB entry.
571  */
572 #define	MIPS1_TLB_PFN			0xfffff000
573 #define	MIPS1_TLB_NON_CACHEABLE_BIT	0x00000800
574 #define	MIPS1_TLB_DIRTY_BIT		0x00000400
575 #define	MIPS1_TLB_VALID_BIT		0x00000200
576 #define	MIPS1_TLB_GLOBAL_BIT		0x00000100
577 
578 #define	MIPS3_TLB_PFN			0x3fffffc0
579 #define	MIPS3_TLB_ATTR_MASK		0x00000038
580 #define	MIPS3_TLB_ATTR_SHIFT		3
581 #define	MIPS3_TLB_DIRTY_BIT		0x00000004
582 #define	MIPS3_TLB_VALID_BIT		0x00000002
583 #define	MIPS3_TLB_GLOBAL_BIT		0x00000001
584 
585 #define	MIPS1_TLB_PHYS_PAGE_SHIFT	12
586 #define	MIPS3_TLB_PHYS_PAGE_SHIFT	6
587 #define	MIPS1_TLB_PF_NUM		MIPS1_TLB_PFN
588 #define	MIPS3_TLB_PF_NUM		MIPS3_TLB_PFN
589 #define	MIPS1_TLB_MOD_BIT		MIPS1_TLB_DIRTY_BIT
590 #define	MIPS3_TLB_MOD_BIT		MIPS3_TLB_DIRTY_BIT
591 
592 /*
593  * MIPS3_TLB_ATTR values - coherency algorithm:
594  * 0: cacheable, noncoherent, write-through, no write allocate
595  * 1: cacheable, noncoherent, write-through, write allocate
596  * 2: uncached
597  * 3: cacheable, noncoherent, write-back (noncoherent)
598  * 4: cacheable, coherent, write-back, exclusive (exclusive)
599  * 5: cacheable, coherent, write-back, exclusive on write (sharable)
600  * 6: cacheable, coherent, write-back, update on write (update)
601  * 7: uncached, accelerated (gather STORE operations)
602  */
603 #define	MIPS3_TLB_ATTR_WT		0 /* IDT */
604 #define	MIPS3_TLB_ATTR_WT_WRITEALLOCATE 1 /* IDT */
605 #define	MIPS3_TLB_ATTR_UNCACHED		2 /* R4000/R4400, IDT */
606 #define	MIPS3_TLB_ATTR_WB_NONCOHERENT	3 /* R4000/R4400, IDT */
607 #define	MIPS3_TLB_ATTR_WB_EXCLUSIVE	4 /* R4000/R4400 */
608 #define	MIPS3_TLB_ATTR_WB_SHARABLE	5 /* R4000/R4400 */
609 #define	MIPS3_TLB_ATTR_WB_UPDATE	6 /* R4000/R4400 */
610 #define	MIPS4_TLB_ATTR_UNCACHED_ACCELERATED 7 /* R10000 */
611 
612 
613 /*
614  * The high part of the TLB entry.
615  */
616 #define	MIPS1_TLB_VPN			0xfffff000
617 #define	MIPS1_TLB_PID			0x00000fc0
618 #define	MIPS1_TLB_PID_SHIFT		6
619 
620 #define	MIPS3_TLB_VPN2			0xffffe000
621 #define	MIPS3_TLB_ASID			0x000000ff
622 
623 #define	MIPS1_TLB_VIRT_PAGE_NUM		MIPS1_TLB_VPN
624 #define	MIPS3_TLB_VIRT_PAGE_NUM		MIPS3_TLB_VPN2
625 #define	MIPS3_TLB_PID			MIPS3_TLB_ASID
626 #define	MIPS_TLB_VIRT_PAGE_SHIFT	12
627 
628 /*
629  * r3000: shift count to put the index in the right spot.
630  */
631 #define	MIPS1_TLB_INDEX_SHIFT		8
632 
633 /*
634  * The first TLB that write random hits.
635  */
636 #define	MIPS1_TLB_FIRST_RAND_ENTRY	8
637 #define	MIPS3_TLB_WIRED_UPAGES		1
638 
639 /*
640  * The number of process id entries.
641  */
642 #define	MIPS1_TLB_NUM_PIDS		64
643 #define	MIPS3_TLB_NUM_ASIDS		256
644 
645 /*
646  * Patch codes to hide CPU design differences between MIPS1 and MIPS3.
647  */
648 
649 /* XXX simonb: this is before MIPS3_PLUS is defined (and is ugly!) */
650 
651 #if !(defined(MIPS3) || defined(MIPS4) || defined(MIPS32) || defined(MIPS64)) \
652     && defined(MIPS1)				/* XXX simonb must be neater! */
653 #define	MIPS_TLB_PID_SHIFT		MIPS1_TLB_PID_SHIFT
654 #define	MIPS_TLB_NUM_PIDS		MIPS1_TLB_NUM_PIDS
655 #endif
656 
657 #if (defined(MIPS3) || defined(MIPS4) || defined(MIPS32) || defined(MIPS64)) \
658     && !defined(MIPS1)				/* XXX simonb must be neater! */
659 #define	MIPS_TLB_PID_SHIFT		0
660 #define	MIPS_TLB_NUM_PIDS		MIPS3_TLB_NUM_ASIDS
661 #endif
662 
663 
664 #if !defined(MIPS_TLB_PID_SHIFT)
665 #define	MIPS_TLB_PID_SHIFT \
666     ((MIPS_HAS_R4K_MMU) ? 0 : MIPS1_TLB_PID_SHIFT)
667 
668 #define	MIPS_TLB_NUM_PIDS \
669     ((MIPS_HAS_R4K_MMU) ? MIPS3_TLB_NUM_ASIDS : MIPS1_TLB_NUM_PIDS)
670 #endif
671 
672 /*
673  * CPU processor revision IDs for company ID == 0 (non mips32/64 chips)
674  */
675 #define	MIPS_R2000	0x01	/* MIPS R2000 			ISA I	*/
676 #define	MIPS_R3000	0x02	/* MIPS R3000 			ISA I	*/
677 #define	MIPS_R6000	0x03	/* MIPS R6000 			ISA II	*/
678 #define	MIPS_R4000	0x04	/* MIPS R4000/R4400 		ISA III */
679 #define	MIPS_R3LSI	0x05	/* LSI Logic R3000 derivative	ISA I	*/
680 #define	MIPS_R6000A	0x06	/* MIPS R6000A 			ISA II	*/
681 #define	MIPS_R3IDT	0x07	/* IDT R3041 or RC36100 	ISA I	*/
682 #define	MIPS_R10000	0x09	/* MIPS R10000			ISA IV	*/
683 #define	MIPS_R4200	0x0a	/* NEC VR4200 			ISA III */
684 #define	MIPS_R4300	0x0b	/* NEC VR4300 			ISA III */
685 #define	MIPS_R4100	0x0c	/* NEC VR4100 			ISA III */
686 #define	MIPS_R12000	0x0e	/* MIPS R12000			ISA IV	*/
687 #define	MIPS_R14000	0x0f	/* MIPS R14000			ISA IV	*/
688 #define	MIPS_R8000	0x10	/* MIPS R8000 Blackbird/TFP	ISA IV	*/
689 #define	MIPS_RC32300	0x18	/* IDT RC32334,332,355		ISA 32  */
690 #define	MIPS_R4600	0x20	/* QED R4600 Orion		ISA III */
691 #define	MIPS_R4700	0x21	/* QED R4700 Orion		ISA III */
692 #define	MIPS_R3SONY	0x21	/* Sony R3000 based 		ISA I	*/
693 #define	MIPS_R4650	0x22	/* QED R4650 			ISA III */
694 #define	MIPS_TX3900	0x22	/* Toshiba TX39 family		ISA I	*/
695 #define	MIPS_R5000	0x23	/* MIPS R5000 			ISA IV	*/
696 #define	MIPS_R3NKK	0x23	/* NKK R3000 based 		ISA I	*/
697 #define	MIPS_RC32364	0x26	/* IDT RC32364 			ISA 32	*/
698 #define	MIPS_RM7000	0x27	/* QED RM7000			ISA IV  */
699 #define	MIPS_RM5200	0x28	/* QED RM5200s 			ISA IV	*/
700 #define	MIPS_TX4900	0x2d	/* Toshiba TX49 family		ISA III */
701 #define	MIPS_R5900	0x2e	/* Toshiba R5900 (EECore)	ISA --- */
702 #define	MIPS_RC64470	0x30	/* IDT RC64474/RC64475 		ISA III */
703 #define	MIPS_TX7900	0x38	/* Toshiba TX79			ISA III+*/
704 #define	MIPS_R5400	0x54	/* NEC VR5400 			ISA IV	*/
705 #define	MIPS_R5500	0x55	/* NEC VR5500 			ISA IV	*/
706 
707 /*
708  * CPU revision IDs for some prehistoric processors.
709  */
710 
711 /* For MIPS_R3000 */
712 #define	MIPS_REV_R3000		0x20
713 #define	MIPS_REV_R3000A		0x30
714 
715 /* For MIPS_TX3900 */
716 #define	MIPS_REV_TX3912		0x10
717 #define	MIPS_REV_TX3922		0x30
718 #define	MIPS_REV_TX3927		0x40
719 
720 /* For MIPS_R4000 */
721 #define	MIPS_REV_R4000_A	0x00
722 #define	MIPS_REV_R4000_B	0x30
723 #define	MIPS_REV_R4400_A	0x40
724 #define	MIPS_REV_R4400_B	0x50
725 #define	MIPS_REV_R4400_C	0x60
726 
727 /* For MIPS_TX4900 */
728 #define	MIPS_REV_TX4927		0x22
729 
730 /*
731  * CPU processor revision IDs for company ID == 1 (MIPS)
732  */
733 #define	MIPS_4Kc	0x80	/* MIPS 4Kc			ISA 32  */
734 #define	MIPS_5Kc	0x81	/* MIPS 5Kc			ISA 64  */
735 #define	MIPS_20Kc	0x82	/* MIPS 20Kc			ISA 64  */
736 #define	MIPS_4KEc	0x84	/* MIPS 4KEc			ISA 32  */
737 #define	MIPS_4KSc	0x86	/* MIPS 4KSc			ISA 32  */
738 
739 /*
740  * Alchemy (company ID 3) use the processor ID field to donote the CPU core
741  * revision and the company options field do donate the SOC chip type.
742  */
743 /* CPU processor revision IDs */
744 #define	MIPS_AU_REV1	0x01	/* Alchemy Au1000 (Rev 1)	ISA 32  */
745 #define	MIPS_AU_REV2	0x02	/* Alchemy Au1000 (Rev 2)	ISA 32  */
746 /* CPU company options IDs */
747 #define	MIPS_AU1000	0x00
748 #define	MIPS_AU1500	0x01
749 #define	MIPS_AU1100	0x02
750 
751 /*
752  * CPU processor revision IDs for company ID == 4 (SiByte)
753  */
754 #define	MIPS_SB1	0x01	/* SiByte SB1	 		ISA 64  */
755 
756 /*
757  * CPU processor revision IDs for company ID == 5 (SandCraft)
758  */
759 #define	MIPS_SR7100	0x04	/* SandCraft SR7100 		ISA 64  */
760 
761 /*
762  * FPU processor revision ID
763  */
764 #define	MIPS_SOFT	0x00	/* Software emulation		ISA I	*/
765 #define	MIPS_R2360	0x01	/* MIPS R2360 FPC		ISA I	*/
766 #define	MIPS_R2010	0x02	/* MIPS R2010 FPC		ISA I	*/
767 #define	MIPS_R3010	0x03	/* MIPS R3010 FPC		ISA I	*/
768 #define	MIPS_R6010	0x04	/* MIPS R6010 FPC		ISA II	*/
769 #define	MIPS_R4010	0x05	/* MIPS R4010 FPC		ISA II	*/
770 #define	MIPS_R31LSI	0x06	/* LSI Logic derivate		ISA I	*/
771 #define	MIPS_R3TOSH	0x22	/* Toshiba R3000 based FPU	ISA I	*/
772 
773 #ifdef ENABLE_MIPS_TX3900
774 #include <mips/r3900regs.h>
775 #endif
776 #ifdef MIPS3_5900
777 #include <mips/r5900regs.h>
778 #endif
779 #ifdef MIPS64_SB1
780 #include <mips/sb1regs.h>
781 #endif
782 
783 #endif /* _MIPS_CPUREGS_H_ */
784