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