xref: /netbsd-src/sys/arch/mips/include/cpu.h (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1 /*	$NetBSD: cpu.h,v 1.131 2020/08/17 03:19:35 mrg 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 /*
41  * Exported definitions unique to NetBSD/mips cpu support.
42  */
43 
44 #ifdef _LOCORE
45 #error Use assym.h to get definitions from <mips/cpu.h>
46 #endif
47 
48 #if defined(_KERNEL) || defined(_KMEMUSER)
49 
50 #if defined(_KERNEL_OPT)
51 #include "opt_cputype.h"
52 #include "opt_lockdebug.h"
53 #include "opt_multiprocessor.h"
54 #endif
55 
56 #include <sys/cpu_data.h>
57 #include <sys/device_if.h>
58 #include <sys/evcnt.h>
59 #include <sys/kcpuset.h>
60 #include <sys/intr.h>
61 
62 typedef struct cpu_watchpoint {
63 	register_t	cw_addr;
64 	register_t	cw_mask;
65 	uint32_t	cw_asid;
66 	uint32_t	cw_mode;
67 } cpu_watchpoint_t;
68 
69 /* (abstract) mode bits */
70 #define	CPUWATCH_WRITE	__BIT(0)
71 #define	CPUWATCH_READ	__BIT(1)
72 #define	CPUWATCH_EXEC	__BIT(2)
73 #define	CPUWATCH_MASK	__BIT(3)
74 #define	CPUWATCH_ASID	__BIT(4)
75 #define	CPUWATCH_RWX	(CPUWATCH_EXEC|CPUWATCH_READ|CPUWATCH_WRITE)
76 
77 #define	CPUWATCH_MAX	8	/* max possible number of watchpoints */
78 
79 u_int		  cpuwatch_discover(void);
80 void		  cpuwatch_free(cpu_watchpoint_t *);
81 cpu_watchpoint_t *cpuwatch_alloc(void);
82 void		  cpuwatch_set_all(void);
83 void		  cpuwatch_clr_all(void);
84 void		  cpuwatch_set(cpu_watchpoint_t *);
85 void		  cpuwatch_clr(cpu_watchpoint_t *);
86 
87 struct cpu_info {
88 	struct cpu_data ci_data;	/* MI per-cpu data */
89 	void *ci_nmi_stack;		/* NMI exception stack */
90 	struct cpu_softc *ci_softc;	/* chip-dependent hook */
91 	device_t ci_dev;		/* owning device */
92 	cpuid_t ci_cpuid;		/* Machine-level identifier */
93 	u_long ci_cctr_freq;		/* cycle counter frequency */
94 	u_long ci_cpu_freq;		/* CPU frequency */
95 	u_long ci_cycles_per_hz;	/* CPU freq / hz */
96 	u_long ci_divisor_delay;	/* for delay/DELAY */
97 	u_long ci_divisor_recip;	/* unused, for obsolete microtime(9) */
98 	struct lwp *ci_curlwp;		/* currently running lwp */
99 	struct lwp *ci_onproc;		/* current user LWP / kthread */
100 	volatile int ci_want_resched;	/* user preemption pending */
101 	int ci_mtx_count;		/* negative count of held mutexes */
102 	int ci_mtx_oldspl;		/* saved SPL value */
103 	int ci_idepth;			/* hardware interrupt depth */
104 	int ci_cpl;			/* current [interrupt] priority level */
105 	uint32_t ci_next_cp0_clk_intr;	/* for hard clock intr scheduling */
106 	struct evcnt ci_ev_count_compare;		/* hard clock intr counter */
107 	struct evcnt ci_ev_count_compare_missed;	/* hard clock miss counter */
108 	struct lwp *ci_softlwps[SOFTINT_COUNT];
109 	volatile u_int ci_softints;
110 	struct evcnt ci_ev_fpu_loads;	/* fpu load counter */
111 	struct evcnt ci_ev_fpu_saves;	/* fpu save counter */
112 	struct evcnt ci_ev_dsp_loads;	/* dsp load counter */
113 	struct evcnt ci_ev_dsp_saves;	/* dsp save counter */
114 	struct evcnt ci_ev_tlbmisses;
115 
116 	/*
117 	 * Per-cpu pmap information
118 	 */
119 	int ci_tlb_slot;		/* reserved tlb entry for cpu_info */
120 	u_int ci_pmap_asid_cur;		/* current ASID */
121 	struct pmap_tlb_info *ci_tlb_info; /* tlb information for this cpu */
122 	union pmap_segtab *ci_pmap_segtabs[2];
123 #define	ci_pmap_user_segtab	ci_pmap_segtabs[0]
124 #define	ci_pmap_kern_segtab	ci_pmap_segtabs[1]
125 #ifdef _LP64
126 	union pmap_segtab *ci_pmap_seg0tabs[2];
127 #define	ci_pmap_user_seg0tab	ci_pmap_seg0tabs[0]
128 #define	ci_pmap_kern_seg0tab	ci_pmap_seg0tabs[1]
129 #endif
130 	vaddr_t ci_pmap_srcbase;	/* starting VA of ephemeral src space */
131 	vaddr_t ci_pmap_dstbase;	/* starting VA of ephemeral dst space */
132 
133 	u_int ci_cpuwatch_count;	/* number of watchpoints on this CPU */
134 	cpu_watchpoint_t ci_cpuwatch_tab[CPUWATCH_MAX];
135 
136 #ifdef MULTIPROCESSOR
137 	volatile u_long ci_flags;
138 	volatile uint64_t ci_request_ipis;
139 					/* bitmask of IPIs requested */
140 					/*  use on chips where hw cannot pass tag */
141 	uint64_t ci_active_ipis;	/* bitmask of IPIs being serviced */
142 	uint32_t ci_ksp_tlb_slot;	/* tlb entry for kernel stack */
143 	struct evcnt ci_evcnt_all_ipis;	/* aggregated IPI counter */
144 	struct evcnt ci_evcnt_per_ipi[NIPIS];	/* individual IPI counters*/
145 	struct evcnt ci_evcnt_synci_activate_rqst;
146 	struct evcnt ci_evcnt_synci_onproc_rqst;
147 	struct evcnt ci_evcnt_synci_deferred_rqst;
148 	struct evcnt ci_evcnt_synci_ipi_rqst;
149 
150 #define	CPUF_PRIMARY	0x01		/* CPU is primary CPU */
151 #define	CPUF_PRESENT	0x02		/* CPU is present */
152 #define	CPUF_RUNNING	0x04		/* CPU is running */
153 #define	CPUF_PAUSED	0x08		/* CPU is paused */
154 #define	CPUF_USERPMAP	0x20		/* CPU has a user pmap activated */
155 	kcpuset_t *ci_shootdowncpus;
156 	kcpuset_t *ci_multicastcpus;
157 	kcpuset_t *ci_watchcpus;
158 	kcpuset_t *ci_ddbcpus;
159 #endif
160 
161 };
162 #endif /* _KERNEL || _KMEMUSER */
163 
164 #ifdef _KERNEL
165 
166 #ifdef MULTIPROCESSOR
167 #define	CPU_INFO_ITERATOR		int
168 #define	CPU_INFO_FOREACH(cii, ci)	\
169     cii = 0, ci = &cpu_info_store; \
170     ci != NULL; \
171     cii++, \
172     ncpu ? (ci = cpu_infos[cii]) \
173          : (ci = NULL)
174 #else
175 #define	CPU_INFO_ITERATOR		int __unused
176 #define	CPU_INFO_FOREACH(cii, ci)	\
177     ci = &cpu_info_store; ci != NULL; ci = NULL
178 #endif
179 
180 /* Note: must be kept in sync with -ffixed-?? Makefile.mips. */
181 //	MIPS_CURLWP moved to <mips/regdef.h>
182 #define	MIPS_CURLWP_QUOTED	"$24"
183 #define	MIPS_CURLWP_LABEL	_L_T8
184 #define	MIPS_CURLWP_REG		_R_T8
185 
186 extern struct cpu_info cpu_info_store;
187 #ifdef MULTIPROCESSOR
188 extern struct cpu_info *cpuid_infos[];
189 #endif
190 register struct lwp *mips_curlwp asm(MIPS_CURLWP_QUOTED);
191 
192 #define	curlwp			mips_curlwp
193 #define	curcpu()		lwp_getcpu(curlwp)
194 #define	curpcb			((struct pcb *)lwp_getpcb(curlwp))
195 #ifdef MULTIPROCESSOR
196 #define	cpu_number()		(curcpu()->ci_index)
197 #define	CPU_IS_PRIMARY(ci)	((ci)->ci_flags & CPUF_PRIMARY)
198 #else
199 #define	cpu_number()		(0)
200 #define	CPU_IS_PRIMARY(ci)	(true)
201 #endif
202 
203 /*
204  * definitions of cpu-dependent requirements
205  * referenced in generic code
206  */
207 
208 /*
209  * Send an inter-processor interrupt to each other CPU (excludes curcpu())
210  */
211 void cpu_broadcast_ipi(int);
212 
213 /*
214  * Send an inter-processor interrupt to CPUs in kcpuset (excludes curcpu())
215  */
216 void cpu_multicast_ipi(const kcpuset_t *, int);
217 
218 /*
219  * Send an inter-processor interrupt to another CPU.
220  */
221 int cpu_send_ipi(struct cpu_info *, int);
222 
223 /*
224  * cpu_intr(ppl, pc, status);  (most state needed by clockframe)
225  */
226 void cpu_intr(int, vaddr_t, uint32_t);
227 
228 /*
229  * Arguments to hardclock and gatherstats encapsulate the previous
230  * machine state in an opaque clockframe.
231  */
232 struct clockframe {
233 	vaddr_t		pc;	/* program counter at time of interrupt */
234 	uint32_t	sr;	/* status register at time of interrupt */
235 	bool		intr;	/* interrupted a interrupt */
236 };
237 
238 /*
239  * A port must provde CLKF_USERMODE() for use in machine-independent code.
240  * These differ on r4000 and r3000 systems; provide them in the
241  * port-dependent file that includes this one, using the macros below.
242  */
243 uint32_t cpu_clkf_usermode_mask(void);
244 
245 #define	CLKF_USERMODE(framep)	((framep)->sr & cpu_clkf_usermode_mask())
246 #define	CLKF_PC(framep)		((framep)->pc + 0)
247 #define	CLKF_INTR(framep)	((framep)->intr + 0)
248 
249 /*
250  * Misc prototypes and variable declarations.
251  */
252 #define	LWP_PC(l)	cpu_lwp_pc(l)
253 
254 struct proc;
255 struct lwp;
256 struct pcb;
257 struct reg;
258 
259 /*
260  * Notify the current lwp (l) that it has a signal pending,
261  * process as soon as possible.
262  */
263 void	cpu_signotify(struct lwp *);
264 
265 /*
266  * Give a profiling tick to the current process when the user profiling
267  * buffer pages are invalid.  On the MIPS, request an ast to send us
268  * through trap, marking the proc as needing a profiling tick.
269  */
270 void	cpu_need_proftick(struct lwp *);
271 
272 /* VM related hooks */
273 void	cpu_boot_secondary_processors(void);
274 void *	cpu_uarea_alloc(bool);
275 bool	cpu_uarea_free(void *);
276 void	cpu_proc_fork(struct proc *, struct proc *);
277 vaddr_t	cpu_lwp_pc(struct lwp *);
278 #ifdef _LP64
279 void	cpu_vmspace_exec(struct lwp *, vaddr_t, vaddr_t);
280 #endif
281 
282 #endif /* _KERNEL */
283 
284 /*
285  * CTL_MACHDEP definitions.
286  */
287 #define	CPU_CONSDEV		1	/* dev_t: console terminal device */
288 #define	CPU_BOOTED_KERNEL	2	/* string: booted kernel name */
289 #define	CPU_ROOT_DEVICE		3	/* string: root device name */
290 #define	CPU_LLSC		4	/* OS/CPU supports LL/SC instruction */
291 #define	CPU_LMMI		5	/* Loongson multimedia instructions */
292 
293 #endif /* _CPU_H_ */
294