xref: /netbsd-src/sys/arch/mips/include/cpu.h (revision aaf4ece63a859a04e37cf3a7229b5fab0157cc06)
1 /*	$NetBSD: cpu.h,v 1.76 2005/12/24 22:50:08 perry 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. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)cpu.h	8.4 (Berkeley) 1/4/94
35  */
36 
37 #ifndef _CPU_H_
38 #define _CPU_H_
39 
40 #include <mips/cpuregs.h>
41 
42 /*
43  * Exported definitions unique to NetBSD/mips cpu support.
44  */
45 
46 #ifdef _KERNEL
47 #ifndef _LOCORE
48 #include <sys/cpu_data.h>
49 
50 #if defined(_KERNEL_OPT)
51 #include "opt_lockdebug.h"
52 #endif
53 
54 struct cpu_info {
55 	struct cpu_data ci_data;	/* MI per-cpu data */
56 	u_long ci_cpu_freq;		/* CPU frequency */
57 	u_long ci_cycles_per_hz;	/* CPU freq / hz */
58 	u_long ci_divisor_delay;	/* for delay/DELAY */
59 	u_long ci_divisor_recip;	/* scaled reciprocal of previous;
60 					   see below */
61 };
62 
63 /*
64  * To implement a more accurate microtime using the CP0 COUNT register
65  * we need to divide that register by the number of cycles per MHz.
66  * But...
67  *
68  * DIV and DIVU are expensive on MIPS (eg 75 clocks on the R4000).  MULT
69  * and MULTU are only 12 clocks on the same CPU.
70  *
71  * The strategy we use is to calculate the reciprical of cycles per MHz,
72  * scaled by 1<<32.  Then we can simply issue a MULTU and pluck of the
73  * HI register and have the results of the division.
74  */
75 #define	MIPS_SET_CI_RECIPRICAL(cpu)					\
76 do {									\
77 	KASSERT((cpu)->ci_divisor_delay != 0);				\
78 	(cpu)->ci_divisor_recip = 0x100000000ULL / (cpu)->ci_divisor_delay; \
79 } while (0)
80 
81 #define	MIPS_COUNT_TO_MHZ(cpu, count, res)				\
82 	__asm volatile("multu %1,%2 ; mfhi %0"				\
83 	    : "=r"((res)) : "r"((count)), "r"((cpu)->ci_divisor_recip))
84 
85 #endif /* !_LOCORE */
86 #endif /* _KERNEL */
87 
88 /*
89  * CTL_MACHDEP definitions.
90  */
91 #define CPU_CONSDEV		1	/* dev_t: console terminal device */
92 #define CPU_BOOTED_KERNEL	2	/* string: booted kernel name */
93 #define CPU_ROOT_DEVICE		3	/* string: root device name */
94 #define CPU_LLSC		4	/* OS/CPU supports LL/SC instruction */
95 
96 /*
97  * Platform can override, but note this breaks userland compatibility
98  * with other mips platforms.
99  */
100 #ifndef CPU_MAXID
101 #define CPU_MAXID		5	/* number of valid machdep ids */
102 
103 #define CTL_MACHDEP_NAMES { \
104 	{ 0, 0 }, \
105 	{ "console_device", CTLTYPE_STRUCT }, \
106 	{ "booted_kernel", CTLTYPE_STRING }, \
107 	{ "root_device", CTLTYPE_STRING }, \
108 	{ "llsc", CTLTYPE_INT }, \
109 }
110 #endif
111 
112 #ifdef _KERNEL
113 #ifndef _LOCORE
114 extern struct cpu_info cpu_info_store;
115 
116 #define	curcpu()	(&cpu_info_store)
117 #define	cpu_number()	(0)
118 #define	cpu_proc_fork(p1, p2)
119 #endif /* !_LOCORE */
120 
121 /*
122  * Macros to find the CPU architecture we're on at run-time,
123  * or if possible, at compile-time.
124  */
125 
126 #define	CPU_ARCH_MIPSx	0		/* XXX unknown */
127 #define	CPU_ARCH_MIPS1	(1 << 0)
128 #define	CPU_ARCH_MIPS2	(1 << 1)
129 #define	CPU_ARCH_MIPS3	(1 << 2)
130 #define	CPU_ARCH_MIPS4	(1 << 3)
131 #define	CPU_ARCH_MIPS5	(1 << 4)
132 #define	CPU_ARCH_MIPS32	(1 << 5)
133 #define	CPU_ARCH_MIPS64	(1 << 6)
134 
135 #ifndef _LOCORE
136 /* XXX simonb
137  * Should the following be in a cpu_info type structure?
138  * And how many of these are per-cpu vs. per-system?  (Ie,
139  * we can assume that all cpus have the same mmu-type, but
140  * maybe not that all cpus run at the same clock speed.
141  * Some SGI's apparently support R12k and R14k in the same
142  * box.)
143  */
144 extern int cpu_arch;
145 extern int mips_cpu_flags;
146 extern int mips_has_r4k_mmu;
147 extern int mips_has_llsc;
148 extern int mips3_pg_cached;
149 extern u_int mips3_pg_shift;
150 
151 #define	CPU_MIPS_R4K_MMU		0x0001
152 #define	CPU_MIPS_NO_LLSC		0x0002
153 #define	CPU_MIPS_CAUSE_IV		0x0004
154 #define	CPU_MIPS_HAVE_SPECIAL_CCA	0x0008	/* Defaults to '3' if not set. */
155 #define	CPU_MIPS_CACHED_CCA_MASK	0x0070
156 #define	CPU_MIPS_CACHED_CCA_SHIFT	 4
157 #define	CPU_MIPS_DOUBLE_COUNT		0x0080	/* 1 cp0 count == 2 clock cycles */
158 #define	CPU_MIPS_USE_WAIT		0x0100	/* Use "wait"-based cpu_idle() */
159 #define	CPU_MIPS_NO_WAIT		0x0200	/* Inverse of previous, for mips32/64 */
160 #define	CPU_MIPS_D_CACHE_COHERENT	0x0400	/* D-cache is fully coherent */
161 #define	CPU_MIPS_I_D_CACHE_COHERENT	0x0800	/* I-cache funcs don't need to flush the D-cache */
162 #define	MIPS_NOT_SUPP			0x8000
163 
164 #ifdef _LKM
165 /* Assume all CPU architectures are valid for LKM's */
166 #define	MIPS1	1
167 #define	MIPS3	1
168 #define	MIPS4	1
169 #define	MIPS32	1
170 #define	MIPS64	1
171 #endif
172 
173 #if (MIPS1 + MIPS3 + MIPS4 + MIPS32 + MIPS64) == 0
174 #error at least one of MIPS1, MIPS3, MIPS4, MIPS32 or MIPS64 must be specified
175 #endif
176 
177 #if (MIPS1 + MIPS3 + MIPS4 + MIPS32 + MIPS64) == 1
178 #ifdef MIPS1
179 # define CPUISMIPS3		0
180 # define CPUIS64BITS		0
181 # define CPUISMIPS32		0
182 # define CPUISMIPS64		0
183 # define CPUISMIPSNN		0
184 # define MIPS_HAS_R4K_MMU	0
185 # define MIPS_HAS_CLOCK		0
186 # define MIPS_HAS_LLSC		0
187 #endif /* MIPS1 */
188 
189 #if defined(MIPS3) || defined(MIPS4)
190 # define CPUISMIPS3		1
191 # define CPUIS64BITS		1
192 # define CPUISMIPS32		0
193 # define CPUISMIPS64		0
194 # define CPUISMIPSNN		0
195 # define MIPS_HAS_R4K_MMU	1
196 # define MIPS_HAS_CLOCK		1
197 # define MIPS_HAS_LLSC		(mips_has_llsc)
198 #endif /* MIPS3 || MIPS4 */
199 
200 #ifdef MIPS32
201 # define CPUISMIPS3		1
202 # define CPUIS64BITS		0
203 # define CPUISMIPS32		1
204 # define CPUISMIPS64		0
205 # define CPUISMIPSNN		1
206 # define MIPS_HAS_R4K_MMU	1
207 # define MIPS_HAS_CLOCK		1
208 # define MIPS_HAS_LLSC		1
209 #endif /* MIPS32 */
210 
211 #ifdef MIPS64
212 # define CPUISMIPS3		1
213 # define CPUIS64BITS		1
214 # define CPUISMIPS32		0
215 # define CPUISMIPS64		1
216 # define CPUISMIPSNN		1
217 # define MIPS_HAS_R4K_MMU	1
218 # define MIPS_HAS_CLOCK		1
219 # define MIPS_HAS_LLSC		1
220 #endif /* MIPS64 */
221 
222 #else /* run-time test */
223 
224 #define	MIPS_HAS_R4K_MMU	(mips_has_r4k_mmu)
225 #define	MIPS_HAS_LLSC		(mips_has_llsc)
226 
227 /* This test is ... rather bogus */
228 #define	CPUISMIPS3	((cpu_arch & \
229 	(CPU_ARCH_MIPS3 | CPU_ARCH_MIPS4 | CPU_ARCH_MIPS32 | CPU_ARCH_MIPS64)) != 0)
230 
231 /* And these aren't much better while the previous test exists as is... */
232 #define	CPUISMIPS32	((cpu_arch & CPU_ARCH_MIPS32) != 0)
233 #define	CPUISMIPS64	((cpu_arch & CPU_ARCH_MIPS64) != 0)
234 #define	CPUISMIPSNN	((cpu_arch & (CPU_ARCH_MIPS32 | CPU_ARCH_MIPS64)) != 0)
235 #define	CPUIS64BITS	((cpu_arch & \
236 	(CPU_ARCH_MIPS3 | CPU_ARCH_MIPS4 | CPU_ARCH_MIPS64)) != 0)
237 
238 #define	MIPS_HAS_CLOCK	(cpu_arch >= CPU_ARCH_MIPS3)
239 #endif /* run-time test */
240 
241 /* Shortcut for MIPS3 or above defined */
242 #if defined(MIPS3) || defined(MIPS4) || defined(MIPS32) || defined(MIPS64)
243 #define	MIPS3_PLUS	1
244 #else
245 #undef MIPS3_PLUS
246 #endif
247 
248 
249 /*
250  * definitions of cpu-dependent requirements
251  * referenced in generic code
252  */
253 #define	cpu_swapout(p)			panic("cpu_swapout: can't get here");
254 
255 void cpu_intr(u_int32_t, u_int32_t, u_int32_t, u_int32_t);
256 
257 /*
258  * Arguments to hardclock and gatherstats encapsulate the previous
259  * machine state in an opaque clockframe.
260  */
261 struct clockframe {
262 	int	pc;	/* program counter at time of interrupt */
263 	int	sr;	/* status register at time of interrupt */
264 	int	ppl;	/* previous priority level at time of interrupt */
265 };
266 
267 /*
268  * A port must provde CLKF_USERMODE() and CLKF_BASEPRI() for use
269  * in machine-independent code. These differ on r4000 and r3000 systems;
270  * provide them in the port-dependent file that includes this one, using
271  * the macros below.
272  */
273 
274 /* mips1 versions */
275 #define	MIPS1_CLKF_USERMODE(framep)	((framep)->sr & MIPS_SR_KU_PREV)
276 #define	MIPS1_CLKF_BASEPRI(framep)	\
277 	((~(framep)->sr & (MIPS_INT_MASK | MIPS_SR_INT_ENA_PREV)) == 0)
278 
279 /* mips3 versions */
280 #define	MIPS3_CLKF_USERMODE(framep)	((framep)->sr & MIPS_SR_KSU_USER)
281 #define	MIPS3_CLKF_BASEPRI(framep)	\
282 	((~(framep)->sr & (MIPS_INT_MASK | MIPS_SR_INT_IE)) == 0)
283 
284 #ifdef IPL_ICU_MASK
285 #define ICU_CLKF_BASEPRI(framep)	((framep)->ppl == 0)
286 #endif
287 
288 #define	CLKF_PC(framep)		((framep)->pc)
289 #define	CLKF_INTR(framep)	(0)
290 
291 #if defined(MIPS3_PLUS) && !defined(MIPS1)		/* XXX bogus! */
292 #define	CLKF_USERMODE(framep)	MIPS3_CLKF_USERMODE(framep)
293 #define	CLKF_BASEPRI(framep)	MIPS3_CLKF_BASEPRI(framep)
294 #endif
295 
296 #if !defined(MIPS3_PLUS) && defined(MIPS1)		/* XXX bogus! */
297 #define	CLKF_USERMODE(framep)	MIPS1_CLKF_USERMODE(framep)
298 #define	CLKF_BASEPRI(framep)	MIPS1_CLKF_BASEPRI(framep)
299 #endif
300 
301 #ifdef IPL_ICU_MASK
302 #undef CLKF_BASEPRI
303 #define CLKF_BASEPRI(framep)	ICU_CLKF_BASEPRI(framep)
304 #endif
305 
306 #if defined(MIPS3_PLUS) && defined(MIPS1)		/* XXX bogus! */
307 #define CLKF_USERMODE(framep) \
308     ((CPUISMIPS3) ? MIPS3_CLKF_USERMODE(framep):  MIPS1_CLKF_USERMODE(framep))
309 #define CLKF_BASEPRI(framep) \
310     ((CPUISMIPS3) ? MIPS3_CLKF_BASEPRI(framep):  MIPS1_CLKF_BASEPRI(framep))
311 #endif
312 
313 /*
314  * This is used during profiling to integrate system time.  It can safely
315  * assume that the process is resident.
316  */
317 #define	PROC_PC(p)							\
318 	(((struct frame *)(p)->p_md.md_regs)->f_regs[37])	/* XXX PC */
319 
320 /*
321  * Preempt the current process if in interrupt from user mode,
322  * or after the current trap/syscall if in system mode.
323  */
324 #define	need_resched(ci)						\
325 do {									\
326 	want_resched = 1;						\
327 	if (curproc != NULL)						\
328 		aston(curproc);						\
329 } while (/*CONSTCOND*/0)
330 
331 /*
332  * Give a profiling tick to the current process when the user profiling
333  * buffer pages are invalid.  On the MIPS, request an ast to send us
334  * through trap, marking the proc as needing a profiling tick.
335  */
336 #define	need_proftick(p)						\
337 do {									\
338 	(p)->p_flag |= P_OWEUPC;					\
339 	aston(p);							\
340 } while (/*CONSTCOND*/0)
341 
342 /*
343  * Notify the current process (p) that it has a signal pending,
344  * process as soon as possible.
345  */
346 #define	signotify(p)	aston(p)
347 
348 #define aston(p)	((p)->p_md.md_astpending = 1)
349 
350 extern int want_resched;		/* resched() was called */
351 
352 /*
353  * Misc prototypes and variable declarations.
354  */
355 struct lwp;
356 struct user;
357 
358 extern struct lwp *fpcurlwp;	/* the current FPU owner */
359 extern struct pcb *curpcb;	/* the current running pcb */
360 extern struct segtab *segbase;	/* current segtab base */
361 
362 /* trap.c */
363 void	netintr(void);
364 int	kdbpeek(vaddr_t);
365 
366 /* mips_machdep.c */
367 void	dumpsys(void);
368 int	savectx(struct user *);
369 void	mips_init_msgbuf(void);
370 void	savefpregs(struct lwp *);
371 void	loadfpregs(struct lwp *);
372 
373 /* locore*.S */
374 int	badaddr(void *, size_t);
375 int	badaddr64(uint64_t, size_t);
376 
377 /* mips_machdep.c */
378 void	cpu_identify(void);
379 void	mips_vector_init(void);
380 
381 #endif /* ! _LOCORE */
382 #endif /* _KERNEL */
383 #endif /* _CPU_H_ */
384