xref: /netbsd-src/sys/arch/powerpc/include/cpu.h (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1 /*	$NetBSD: cpu.h,v 1.115 2020/07/15 08:58:51 rin Exp $	*/
2 
3 /*
4  * Copyright (C) 1999 Wolfgang Solfrank.
5  * Copyright (C) 1999 TooLs GmbH.
6  * Copyright (C) 1995-1997 Wolfgang Solfrank.
7  * Copyright (C) 1995-1997 TooLs GmbH.
8  * All rights reserved.
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 TooLs GmbH.
21  * 4. The name of TooLs GmbH may not be used to endorse or promote products
22  *    derived from this software without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
25  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
30  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
31  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
32  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
33  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  */
35 
36 #ifndef	_POWERPC_CPU_H_
37 #define	_POWERPC_CPU_H_
38 
39 struct cache_info {
40 	int dcache_size;
41 	int dcache_line_size;
42 	int icache_size;
43 	int icache_line_size;
44 };
45 
46 #if defined(_KERNEL) || defined(_KMEMUSER)
47 #if defined(_KERNEL_OPT)
48 #include "opt_modular.h"
49 #include "opt_multiprocessor.h"
50 #include "opt_ppcarch.h"
51 #endif
52 
53 #ifdef _KERNEL
54 #include <sys/intr.h>
55 #include <sys/device_if.h>
56 #include <sys/evcnt.h>
57 #include <sys/param.h>
58 #include <sys/kernel.h>
59 #endif
60 
61 #include <sys/cpu_data.h>
62 
63 struct cpu_info {
64 	struct cpu_data ci_data;	/* MI per-cpu data */
65 #ifdef _KERNEL
66 	device_t ci_dev;		/* device of corresponding cpu */
67 	struct cpu_softc *ci_softc;	/* private cpu info */
68 	struct lwp *ci_curlwp;		/* current owner of the processor */
69 	struct lwp *ci_onproc;		/* current user LWP / kthread */
70 	struct pcb *ci_curpcb;
71 	struct pmap *ci_curpm;
72 	struct lwp *ci_softlwps[SOFTINT_COUNT];
73 	int ci_cpuid;			/* from SPR_PIR */
74 
75 	int ci_want_resched;
76 	volatile uint64_t ci_lastintr;
77 	volatile u_long ci_lasttb;
78 	volatile int ci_tickspending;
79 	volatile int ci_cpl;
80 	volatile int ci_iactive;
81 	volatile int ci_idepth;
82 	union {
83 #if !defined(PPC_BOOKE) && !defined(_MODULE)
84 		volatile imask_t un1_ipending;
85 #define	ci_ipending	ci_un1.un1_ipending
86 #endif
87 		uint64_t un1_pad64;
88 	} ci_un1;
89 	volatile uint32_t ci_pending_ipis;
90 	int ci_mtx_oldspl;
91 	int ci_mtx_count;
92 #if defined(PPC_IBM4XX) || defined(MODULAR) || defined(_MODULE)
93 	char *ci_intstk;
94 #endif
95 #define	CI_SAVETEMP	(0*CPUSAVE_LEN)
96 #define	CI_SAVEDDB	(1*CPUSAVE_LEN)
97 #define	CI_SAVEIPKDB	(2*CPUSAVE_LEN)	/* obsolete */
98 #define	CI_SAVEMMU	(3*CPUSAVE_LEN)
99 #define	CI_SAVEMAX	(4*CPUSAVE_LEN)
100 #define	CPUSAVE_LEN	8
101 #if defined(PPC_BOOKE) && !defined(MODULAR) && !defined(_MODULE)
102 #define	CPUSAVE_SIZE	128
103 #else
104 #define	CPUSAVE_SIZE	(CI_SAVEMAX*CPUSAVE_LEN)
105 // XXX CTASSERT(CPUSAVE_SIZE >= 128);
106 #endif
107 #define	CPUSAVE_R28	0		/* where r28 gets saved */
108 #define	CPUSAVE_R29	1		/* where r29 gets saved */
109 #define	CPUSAVE_R30	2		/* where r30 gets saved */
110 #define	CPUSAVE_R31	3		/* where r31 gets saved */
111 #define	CPUSAVE_DEAR	4		/* where IBM4XX SPR_DEAR gets saved */
112 #define	CPUSAVE_DAR	4		/* where OEA SPR_DAR gets saved */
113 #define	CPUSAVE_ESR	5		/* where IBM4XX SPR_ESR gets saved */
114 #define	CPUSAVE_DSISR	5		/* where OEA SPR_DSISR gets saved */
115 #define	CPUSAVE_SRR0	6		/* where SRR0 gets saved */
116 #define	CPUSAVE_SRR1	7		/* where SRR1 gets saved */
117 	register_t ci_savearea[CPUSAVE_SIZE];
118 #if defined(PPC_BOOKE) || defined(MODULAR) || defined(_MODULE)
119 	uint32_t ci_pmap_asid_cur;
120 	union pmap_segtab *ci_pmap_segtabs[2];
121 #define	ci_pmap_kern_segtab	ci_pmap_segtabs[0]
122 #define	ci_pmap_user_segtab	ci_pmap_segtabs[1]
123 	struct pmap_tlb_info *ci_tlb_info;
124 #endif /* PPC_BOOKE || MODULAR || _MODULE */
125 	struct cache_info ci_ci;
126 	void *ci_sysmon_cookie;
127 	void (*ci_idlespin)(void);
128 	uint32_t ci_khz;
129 	struct evcnt ci_ev_clock;	/* clock intrs */
130 	struct evcnt ci_ev_statclock; 	/* stat clock */
131 	struct evcnt ci_ev_traps;	/* calls to trap() */
132 	struct evcnt ci_ev_kdsi;	/* kernel DSI traps */
133 	struct evcnt ci_ev_udsi;	/* user DSI traps */
134 	struct evcnt ci_ev_udsi_fatal;	/* user DSI trap failures */
135 	struct evcnt ci_ev_kisi;	/* kernel ISI traps */
136 	struct evcnt ci_ev_isi;		/* user ISI traps */
137 	struct evcnt ci_ev_isi_fatal;	/* user ISI trap failures */
138 	struct evcnt ci_ev_pgm;		/* user PGM traps */
139 	struct evcnt ci_ev_debug;	/* user debug traps */
140 	struct evcnt ci_ev_fpu;		/* FPU traps */
141 	struct evcnt ci_ev_fpusw;	/* FPU context switch */
142 	struct evcnt ci_ev_ali;		/* Alignment traps */
143 	struct evcnt ci_ev_ali_fatal;	/* Alignment fatal trap */
144 	struct evcnt ci_ev_scalls;	/* system call traps */
145 	struct evcnt ci_ev_vec;		/* Altivec traps */
146 	struct evcnt ci_ev_vecsw;	/* Altivec context switches */
147 	struct evcnt ci_ev_umchk;	/* user MCHK events */
148 	struct evcnt ci_ev_ipi;		/* IPIs received */
149 	struct evcnt ci_ev_tlbmiss_soft; /* tlb miss (no trap) */
150 	struct evcnt ci_ev_dtlbmiss_hard; /* data tlb miss (trap) */
151 	struct evcnt ci_ev_itlbmiss_hard; /* instruction tlb miss (trap) */
152 #endif /* _KERNEL */
153 };
154 #endif /* _KERNEL || _KMEMUSER */
155 
156 #ifdef _KERNEL
157 
158 #if defined(MULTIPROCESSOR) && !defined(_MODULE)
159 struct cpu_hatch_data {
160 	int hatch_running;
161 	device_t hatch_self;
162 	struct cpu_info *hatch_ci;
163 	uint32_t hatch_tbu;
164 	uint32_t hatch_tbl;
165 #if defined(PPC_OEA64_BRIDGE) || defined (_ARCH_PPC64)
166 	uint64_t hatch_hid0;
167 	uint64_t hatch_hid1;
168 	uint64_t hatch_hid4;
169 	uint64_t hatch_hid5;
170 #else
171 	uint32_t hatch_hid0;
172 #endif
173 	uint32_t hatch_pir;
174 #if defined(PPC_OEA) || defined(PPC_OEA64_BRIDGE)
175 	uintptr_t hatch_asr;
176 	uintptr_t hatch_sdr1;
177 	uint32_t hatch_sr[16];
178 	uintptr_t hatch_ibatu[8], hatch_ibatl[8];
179 	uintptr_t hatch_dbatu[8], hatch_dbatl[8];
180 #endif
181 #if defined(PPC_BOOKE)
182 	vaddr_t hatch_sp;
183 	u_int hatch_tlbidx;
184 #endif
185 };
186 
187 struct cpuset_info {
188 	kcpuset_t *cpus_running;
189 	kcpuset_t *cpus_hatched;
190 	kcpuset_t *cpus_paused;
191 	kcpuset_t *cpus_resumed;
192 	kcpuset_t *cpus_halted;
193 };
194 
195 extern struct cpuset_info cpuset_info;
196 #endif /* MULTIPROCESSOR && !_MODULE */
197 
198 #if defined(MULTIPROCESSOR) || defined(_MODULE)
199 #define	cpu_number()		(curcpu()->ci_index + 0)
200 
201 #define CPU_IS_PRIMARY(ci)	((ci)->ci_cpuid == 0)
202 #define CPU_INFO_ITERATOR	int
203 #define CPU_INFO_FOREACH(cii, ci)				\
204 	cii = 0, ci = &cpu_info[0]; cii < (ncpu ? ncpu : 1); cii++, ci++
205 
206 #else
207 #define cpu_number()		0
208 
209 #define CPU_IS_PRIMARY(ci)	true
210 #define CPU_INFO_ITERATOR	int
211 #define CPU_INFO_FOREACH(cii, ci)				\
212 	(void)cii, ci = curcpu(); ci != NULL; ci = NULL
213 
214 #endif /* MULTIPROCESSOR || _MODULE */
215 
216 extern struct cpu_info cpu_info[];
217 
218 static __inline struct cpu_info * curcpu(void) __pure;
219 static __inline struct cpu_info *
220 curcpu(void)
221 {
222 	struct cpu_info *ci;
223 
224 	__asm volatile ("mfsprg0 %0" : "=r"(ci));
225 	return ci;
226 }
227 
228 #ifdef __clang__
229 #define	curlwp			(curcpu()->ci_curlwp)
230 #else
231 register struct lwp *powerpc_curlwp __asm("r13");
232 #define	curlwp			powerpc_curlwp
233 #endif
234 #define curpcb			(curcpu()->ci_curpcb)
235 #define curpm			(curcpu()->ci_curpm)
236 
237 static __inline register_t
238 mfmsr(void)
239 {
240 	register_t msr;
241 
242 	__asm volatile ("mfmsr %0" : "=r"(msr));
243 	return msr;
244 }
245 
246 static __inline void
247 mtmsr(register_t msr)
248 {
249 	//KASSERT(msr & PSL_CE);
250 	//KASSERT(msr & PSL_DE);
251 	__asm volatile ("mtmsr %0" : : "r"(msr));
252 }
253 
254 #if !defined(_MODULE)
255 static __inline uint32_t
256 mftbl(void)
257 {
258 	uint32_t tbl;
259 
260 	__asm volatile (
261 #ifdef PPC_IBM403
262 	"	mftblo %[tbl]"		"\n"
263 #elif defined(PPC_BOOKE)
264 	"	mfspr %[tbl],268"	"\n"
265 #else
266 	"	mftbl %[tbl]"		"\n"
267 #endif
268 	: [tbl] "=r" (tbl));
269 
270 	return tbl;
271 }
272 
273 static __inline uint64_t
274 mftb(void)
275 {
276 	uint64_t tb;
277 
278 #ifdef _ARCH_PPC64
279 	__asm volatile ("mftb %0" : "=r"(tb));
280 #else
281 	int tmp;
282 
283 	__asm volatile (
284 #ifdef PPC_IBM403
285 	"1:	mftbhi %[tb]"		"\n"
286 	"	mftblo %L[tb]"		"\n"
287 	"	mftbhi %[tmp]"		"\n"
288 #elif defined(PPC_BOOKE)
289 	"1:	mfspr %[tb],269"	"\n"
290 	"	mfspr %L[tb],268"	"\n"
291 	"	mfspr %[tmp],269"	"\n"
292 #else
293 	"1:	mftbu %[tb]"		"\n"
294 	"	mftb %L[tb]"		"\n"
295 	"	mftbu %[tmp]"		"\n"
296 #endif
297 	"	cmplw %[tb],%[tmp]"	"\n"
298 	"	bne- 1b"		"\n"
299 	    : [tb] "=r" (tb), [tmp] "=r"(tmp)
300 	    :: "cr0");
301 #endif
302 
303 	return tb;
304 }
305 
306 static __inline uint32_t
307 mfrtcl(void)
308 {
309 	uint32_t rtcl;
310 
311 	__asm volatile ("mfrtcl %0" : "=r"(rtcl));
312 	return rtcl;
313 }
314 
315 static __inline void
316 mfrtc(uint32_t *rtcp)
317 {
318 	uint32_t tmp;
319 
320 	__asm volatile (
321 	"1:	mfrtcu	%[rtcu]"	"\n"
322 	"	mfrtcl	%[rtcl]"	"\n"
323 	"	mfrtcu	%[tmp]"		"\n"
324 	"	cmplw	%[rtcu],%[tmp]"	"\n"
325 	"	bne-	1b"
326 	    : [rtcu] "=r"(rtcp[0]), [rtcl] "=r"(rtcp[1]), [tmp] "=r"(tmp)
327 	    :: "cr0");
328 }
329 
330 static __inline uint64_t
331 rtc_nanosecs(void)
332 {
333     /*
334      * 601 RTC/DEC registers share clock of 7.8125 MHz, 128 ns per tick.
335      * DEC has max of 25 bits, FFFFFF => 2.14748352 seconds.
336      * RTCU is seconds, 32 bits.
337      * RTCL is nano-seconds, 23 bit counter from 0 - 999,999,872 (999,999,999 - 128 ns)
338      */
339     uint64_t cycles;
340     uint32_t tmp[2];
341 
342     mfrtc(tmp);
343 
344     cycles = tmp[0] * 1000000000;
345     cycles += (tmp[1] >> 7);
346 
347     return cycles;
348 }
349 #endif /* !_MODULE */
350 
351 static __inline uint32_t
352 mfpvr(void)
353 {
354 	uint32_t pvr;
355 
356 	__asm volatile ("mfpvr %0" : "=r"(pvr));
357 	return (pvr);
358 }
359 
360 #ifdef _MODULE
361 extern const char __CPU_MAXNUM;
362 /*
363  * Make with 0xffff to force a R_PPC_ADDR16_LO without the
364  * corresponding R_PPC_ADDR16_HI relocation.
365  */
366 #define	CPU_MAXNUM	(((uintptr_t)&__CPU_MAXNUM)&0xffff)
367 #endif /* _MODULE */
368 
369 #if !defined(_MODULE)
370 extern char *booted_kernel;
371 extern int powersave;
372 extern int cpu_timebase;
373 extern int cpu_printfataltraps;
374 
375 struct cpu_info *
376 	cpu_attach_common(device_t, int);
377 void	cpu_setup(device_t, struct cpu_info *);
378 void	cpu_identify(char *, size_t);
379 void	cpu_probe_cache(void);
380 
381 void	dcache_wb_page(vaddr_t);
382 void	dcache_wbinv_page(vaddr_t);
383 void	dcache_inv_page(vaddr_t);
384 void	dcache_zero_page(vaddr_t);
385 void	icache_inv_page(vaddr_t);
386 void	dcache_wb(vaddr_t, vsize_t);
387 void	dcache_wbinv(vaddr_t, vsize_t);
388 void	dcache_inv(vaddr_t, vsize_t);
389 void	icache_inv(vaddr_t, vsize_t);
390 
391 void *	mapiodev(paddr_t, psize_t, bool);
392 void	unmapiodev(vaddr_t, vsize_t);
393 
394 int	emulate_mxmsr(struct lwp *, struct trapframe *, uint32_t);
395 
396 #ifdef MULTIPROCESSOR
397 int	md_setup_trampoline(volatile struct cpu_hatch_data *,
398 	    struct cpu_info *);
399 void	md_presync_timebase(volatile struct cpu_hatch_data *);
400 void	md_start_timebase(volatile struct cpu_hatch_data *);
401 void	md_sync_timebase(volatile struct cpu_hatch_data *);
402 void	md_setup_interrupts(void);
403 int	cpu_spinup(device_t, struct cpu_info *);
404 register_t
405 	cpu_hatch(void);
406 void	cpu_spinup_trampoline(void);
407 void	cpu_boot_secondary_processors(void);
408 void	cpu_halt(void);
409 void	cpu_halt_others(void);
410 void	cpu_pause(struct trapframe *);
411 void	cpu_pause_others(void);
412 void	cpu_resume(cpuid_t);
413 void	cpu_resume_others(void);
414 int	cpu_is_paused(int);
415 void	cpu_debug_dump(void);
416 #endif /* MULTIPROCESSOR */
417 #endif /* !_MODULE */
418 
419 #define	cpu_proc_fork(p1, p2)
420 
421 #ifndef __HIDE_DELAY
422 #define	DELAY(n)		delay(n)
423 void	delay(unsigned int);
424 #endif /* __HIDE_DELAY */
425 
426 #define	CLKF_USERMODE(cf)	cpu_clkf_usermode(cf)
427 #define	CLKF_PC(cf)		cpu_clkf_pc(cf)
428 #define	CLKF_INTR(cf)		cpu_clkf_intr(cf)
429 
430 bool	cpu_clkf_usermode(const struct clockframe *);
431 vaddr_t	cpu_clkf_pc(const struct clockframe *);
432 bool	cpu_clkf_intr(const struct clockframe *);
433 
434 #define	LWP_PC(l)		cpu_lwp_pc(l)
435 
436 vaddr_t	cpu_lwp_pc(struct lwp *);
437 
438 void	cpu_ast(struct lwp *, struct cpu_info *);
439 void *	cpu_uarea_alloc(bool);
440 bool	cpu_uarea_free(void *);
441 void	cpu_signotify(struct lwp *);
442 void	cpu_need_proftick(struct lwp *);
443 
444 void	cpu_fixup_stubs(void);
445 
446 #if !defined(PPC_IBM4XX) && !defined(PPC_BOOKE) && !defined(_MODULE)
447 int	cpu_get_dfs(void);
448 void	cpu_set_dfs(int);
449 
450 void	oea_init(void (*)(void));
451 void	oea_startup(const char *);
452 void	oea_dumpsys(void);
453 void	oea_install_extint(void (*)(void));
454 paddr_t	kvtop(void *);
455 
456 extern paddr_t msgbuf_paddr;
457 extern int cpu_altivec;
458 #endif
459 
460 #endif /* _KERNEL */
461 
462 /* XXX The below breaks unified pmap on ppc32 */
463 
464 #if !defined(CACHELINESIZE) && !defined(_MODULE) \
465     && (defined(_KERNEL) || defined(_STANDALONE))
466 #if defined(PPC_IBM403)
467 #define	CACHELINESIZE		16
468 #define MAXCACHELINESIZE	16
469 #elif defined (PPC_OEA64_BRIDGE)
470 #define	CACHELINESIZE		128
471 #define MAXCACHELINESIZE	128
472 #else
473 #define	CACHELINESIZE		32
474 #define MAXCACHELINESIZE	32
475 #endif /* PPC_OEA64_BRIDGE */
476 #endif
477 
478 void	__syncicache(void *, size_t);
479 
480 /*
481  * CTL_MACHDEP definitions.
482  */
483 #define	CPU_CACHELINE		1
484 #define	CPU_TIMEBASE		2
485 #define	CPU_CPUTEMP		3
486 #define	CPU_PRINTFATALTRAPS	4
487 #define	CPU_CACHEINFO		5
488 #define	CPU_ALTIVEC		6
489 #define	CPU_MODEL		7
490 #define	CPU_POWERSAVE		8	/* int: use CPU powersave mode */
491 #define	CPU_BOOTED_DEVICE	9	/* string: device we booted from */
492 #define	CPU_BOOTED_KERNEL	10	/* string: kernel we booted */
493 #define	CPU_EXECPROT		11	/* bool: PROT_EXEC works */
494 #define	CPU_FPU			12
495 
496 #endif	/* _POWERPC_CPU_H_ */
497