cpu.h revision 1.142
1/* $OpenBSD: cpu.h,v 1.142 2023/07/25 18:16:20 cheloha 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 * Copyright (C) 1989 Digital Equipment Corporation. 35 * Permission to use, copy, modify, and distribute this software and 36 * its documentation for any purpose and without fee is hereby granted, 37 * provided that the above copyright notice appears in all copies. 38 * Digital Equipment Corporation makes no representations about the 39 * suitability of this software for any purpose. It is provided "as is" 40 * without express or implied warranty. 41 * 42 * from: @(#)cpu.h 8.4 (Berkeley) 1/4/94 43 */ 44 45#ifndef _MIPS64_CPU_H_ 46#define _MIPS64_CPU_H_ 47 48#ifndef _LOCORE 49 50/* 51 * MIPS32-style segment definitions. 52 * They only cover the first 512MB of physical addresses. 53 */ 54#define CKSEG0_BASE 0xffffffff80000000UL 55#define CKSEG1_BASE 0xffffffffa0000000UL 56#define CKSSEG_BASE 0xffffffffc0000000UL 57#define CKSEG3_BASE 0xffffffffe0000000UL 58#define CKSEG_SIZE 0x0000000020000000UL 59 60#define CKSEG0_TO_PHYS(x) ((u_long)(x) & (CKSEG_SIZE - 1)) 61#define CKSEG1_TO_PHYS(x) ((u_long)(x) & (CKSEG_SIZE - 1)) 62#define PHYS_TO_CKSEG0(x) ((u_long)(x) | CKSEG0_BASE) 63#define PHYS_TO_CKSEG1(x) ((u_long)(x) | CKSEG1_BASE) 64 65/* 66 * MIPS64-style segment definitions. 67 * These allow for 36 bits of addressable physical memory, thus 64GB. 68 */ 69 70/* 71 * Cache Coherency Attributes. 72 */ 73/* r8k only */ 74#define CCA_NC_COPROCESSOR 0UL /* uncached, coprocessor ordered */ 75/* common to r4, r5k, r8k and r1xk */ 76#define CCA_NC 2UL /* uncached, write-around */ 77#define CCA_NONCOHERENT 3UL /* cached, non-coherent, write-back */ 78/* r8k, r1xk only */ 79#define CCA_COHERENT_EXCL 4UL /* cached, coherent, exclusive */ 80#define CCA_COHERENT_EXCLWRITE 5UL /* cached, coherent, exclusive write */ 81/* r4k only */ 82#define CCA_COHERENT_UPDWRITE 6UL /* cached, coherent, update on write */ 83/* r1xk only */ 84#define CCA_NC_ACCELERATED 7UL /* uncached accelerated */ 85 86#ifdef TGT_COHERENT 87#define CCA_CACHED CCA_COHERENT_EXCLWRITE 88#else 89#define CCA_CACHED CCA_NONCOHERENT 90#endif 91 92#define XKSSSEG_BASE 0x4000000000000000UL 93#define XKPHYS_BASE 0x8000000000000000UL 94#define XKSSEG_BASE 0xc000000000000000UL 95 96#define XKPHYS_TO_PHYS(x) ((paddr_t)(x) & 0x0000000fffffffffUL) 97#define PHYS_TO_XKPHYS(x,c) ((paddr_t)(x) | XKPHYS_BASE | ((c) << 59)) 98#define IS_XKPHYS(va) (((va) >> 62) == 2) 99#define XKPHYS_TO_CCA(x) (((x) >> 59) & 0x07) 100 101#endif /* _LOCORE */ 102 103/* 104 * Exported definitions unique to mips cpu support. 105 */ 106 107#if defined(_KERNEL) && !defined(_LOCORE) 108 109#include <sys/clockintr.h> 110#include <sys/device.h> 111#include <machine/intr.h> 112#include <sys/sched.h> 113#include <sys/srp.h> 114 115struct cpu_hwinfo { 116 uint32_t c0prid; 117 uint32_t c1prid; 118 uint32_t clock; /* Hz */ 119 uint32_t tlbsize; 120 uint type; 121 uint32_t l2size; 122}; 123 124/* 125 * Cache memory configuration. One struct per cache. 126 */ 127struct cache_info { 128 uint size; /* total cache size */ 129 uint linesize; /* line size */ 130 uint setsize; /* set size */ 131 uint sets; /* number of sets */ 132}; 133 134struct cpu_info { 135 struct device *ci_dev; /* our device */ 136 struct cpu_info *ci_self; /* pointer to this structure */ 137 struct cpu_info *ci_next; /* next cpu */ 138 struct proc *ci_curproc; 139 struct user *ci_curprocpaddr; 140 struct proc *ci_fpuproc; /* pointer to last proc to use FP */ 141 uint32_t ci_delayconst; 142 struct cpu_hwinfo 143 ci_hw; 144 145#if defined(MULTIPROCESSOR) 146 struct srp_hazard ci_srp_hazards[SRP_HAZARD_NUM]; 147#endif 148 149 /* cache information and pending flush state */ 150 uint ci_cacheconfiguration; 151 uint64_t ci_cachepending_l1i; 152 struct cache_info 153 ci_l1inst, 154 ci_l1data, 155 ci_l2, 156 ci_l3; 157 158 /* function pointers for the cache handling routines */ 159 void (*ci_SyncCache)(struct cpu_info *); 160 void (*ci_InvalidateICache)(struct cpu_info *, vaddr_t, 161 size_t); 162 void (*ci_InvalidateICachePage)(struct cpu_info *, vaddr_t); 163 void (*ci_SyncICache)(struct cpu_info *); 164 void (*ci_SyncDCachePage)(struct cpu_info *, vaddr_t, 165 paddr_t); 166 void (*ci_HitSyncDCachePage)(struct cpu_info *, vaddr_t, 167 paddr_t); 168 void (*ci_HitSyncDCache)(struct cpu_info *, vaddr_t, size_t); 169 void (*ci_HitInvalidateDCache)(struct cpu_info *, vaddr_t, 170 size_t); 171 void (*ci_IOSyncDCache)(struct cpu_info *, vaddr_t, size_t, 172 int); 173 174 struct schedstate_percpu 175 ci_schedstate; 176 int ci_want_resched; /* need_resched() invoked */ 177 cpuid_t ci_cpuid; /* our CPU ID */ 178 uint32_t ci_randseed; /* per cpu random seed */ 179 volatile int ci_ipl; /* software IPL */ 180 uint32_t ci_softpending; /* pending soft interrupts */ 181 int ci_clock_started; 182 volatile int ci_clock_deferred; /* clock interrupt postponed */ 183 struct clockintr_queue 184 ci_queue; 185 186 struct pmap *ci_curpmap; 187 uint ci_intrdepth; /* interrupt depth */ 188#ifdef MULTIPROCESSOR 189 u_long ci_flags; /* flags; see below */ 190#endif 191 volatile int ci_ddb; 192#define CI_DDB_RUNNING 0 193#define CI_DDB_SHOULDSTOP 1 194#define CI_DDB_STOPPED 2 195#define CI_DDB_ENTERDDB 3 196#define CI_DDB_INDDB 4 197 198#ifdef DIAGNOSTIC 199 int ci_mutex_level; 200#endif 201#ifdef GPROF 202 struct gmonparam *ci_gmon; 203 struct clockintr *ci_gmonclock; 204#endif 205 char ci_panicbuf[512]; 206}; 207 208#define CPUF_PRIMARY 0x01 /* CPU is primary CPU */ 209#define CPUF_PRESENT 0x02 /* CPU is present */ 210#define CPUF_RUNNING 0x04 /* CPU is running */ 211 212extern struct cpu_info cpu_info_primary; 213extern struct cpu_info *cpu_info_list; 214#define CPU_INFO_ITERATOR int 215#define CPU_INFO_FOREACH(cii, ci) for (cii = 0, ci = cpu_info_list; \ 216 ci != NULL; ci = ci->ci_next) 217 218#define CPU_INFO_UNIT(ci) ((ci)->ci_dev ? (ci)->ci_dev->dv_unit : 0) 219 220extern void (*cpu_idle_cycle_func)(void); 221#define cpu_idle_cycle() (*cpu_idle_cycle_func)() 222 223#ifdef MULTIPROCESSOR 224#define getcurcpu() hw_getcurcpu() 225#define setcurcpu(ci) hw_setcurcpu(ci) 226extern struct cpu_info *get_cpu_info(int); 227#define curcpu() getcurcpu() 228#define CPU_IS_PRIMARY(ci) ((ci)->ci_flags & CPUF_PRIMARY) 229#define CPU_IS_RUNNING(ci) ((ci)->ci_flags & CPUF_RUNNING) 230#define cpu_number() (curcpu()->ci_cpuid) 231 232void cpu_unidle(struct cpu_info *); 233void cpu_boot_secondary_processors(void); 234#define cpu_boot_secondary(ci) hw_cpu_boot_secondary(ci) 235#define cpu_hatch(ci) hw_cpu_hatch(ci) 236 237vaddr_t alloc_contiguous_pages(size_t); 238 239#define MIPS64_IPI_NOP 0x00000001 240#define MIPS64_IPI_RENDEZVOUS 0x00000002 241#define MIPS64_IPI_DDB 0x00000004 242#define MIPS64_NIPIS 3 /* must not exceed 32 */ 243 244void mips64_ipi_init(void); 245void mips64_send_ipi(unsigned int, unsigned int); 246void smp_rendezvous_cpus(unsigned long, void (*)(void *), void *arg); 247 248#include <sys/mplock.h> 249#else 250#define MAXCPUS 1 251#define curcpu() (&cpu_info_primary) 252#define CPU_IS_PRIMARY(ci) 1 253#define CPU_IS_RUNNING(ci) 1 254#define cpu_number() 0UL 255#define cpu_unidle(ci) 256#define get_cpu_info(i) (&cpu_info_primary) 257#endif 258 259#define CPU_BUSY_CYCLE() do {} while (0) 260 261extern void (*md_startclock)(struct cpu_info *); 262extern void (*md_triggerclock)(void); 263void cp0_calibrate(struct cpu_info *); 264 265unsigned int cpu_rnd_messybits(void); 266 267#include <machine/frame.h> 268 269/* 270 * Arguments to hardclock encapsulate the previous machine state in 271 * an opaque clockframe. 272 */ 273#define clockframe trapframe /* Use normal trap frame */ 274 275#define SR_KSU_USER 0x00000010 276#define CLKF_USERMODE(framep) ((framep)->sr & SR_KSU_USER) 277#define CLKF_PC(framep) ((framep)->pc) 278#define CLKF_INTR(framep) (curcpu()->ci_intrdepth > 1) /* XXX */ 279 280/* 281 * This is used during profiling to integrate system time. 282 */ 283#define PROC_PC(p) ((p)->p_md.md_regs->pc) 284#define PROC_STACK(p) ((p)->p_md.md_regs->sp) 285 286/* 287 * Preempt the current process if in interrupt from user mode, 288 * or after the current trap/syscall if in system mode. 289 */ 290void need_resched(struct cpu_info *); 291#define clear_resched(ci) (ci)->ci_want_resched = 0 292 293/* 294 * Give a profiling tick to the current process when the user profiling 295 * buffer pages are invalid. On MIPS designs, request an ast to send us 296 * through trap, marking the proc as needing a profiling tick. 297 */ 298#define need_proftick(p) aston(p) 299 300/* 301 * Notify the current process (p) that it has a signal pending, 302 * process as soon as possible. 303 */ 304void signotify(struct proc *); 305 306#define aston(p) ((p)->p_md.md_astpending = 1) 307 308#define mips_sync() __asm__ volatile ("sync" ::: "memory") 309 310#endif /* _KERNEL && !_LOCORE */ 311 312#ifdef _KERNEL 313/* 314 * Values for the code field in a break instruction. 315 */ 316#define BREAK_INSTR 0x0000000d 317#define BREAK_VAL_MASK 0x03ff0000 318#define BREAK_VAL_SHIFT 16 319#define BREAK_KDB_VAL 512 320#define BREAK_SSTEP_VAL 513 321#define BREAK_BRKPT_VAL 514 322#define BREAK_SOVER_VAL 515 323#define BREAK_DDB_VAL 516 324#define BREAK_FPUEMUL_VAL 517 325#define BREAK_KDB (BREAK_INSTR | (BREAK_KDB_VAL << BREAK_VAL_SHIFT)) 326#define BREAK_SSTEP (BREAK_INSTR | (BREAK_SSTEP_VAL << BREAK_VAL_SHIFT)) 327#define BREAK_BRKPT (BREAK_INSTR | (BREAK_BRKPT_VAL << BREAK_VAL_SHIFT)) 328#define BREAK_SOVER (BREAK_INSTR | (BREAK_SOVER_VAL << BREAK_VAL_SHIFT)) 329#define BREAK_DDB (BREAK_INSTR | (BREAK_DDB_VAL << BREAK_VAL_SHIFT)) 330#define BREAK_FPUEMUL (BREAK_INSTR | (BREAK_FPUEMUL_VAL << BREAK_VAL_SHIFT)) 331 332#endif /* _KERNEL */ 333 334/* 335 * CTL_MACHDEP definitions. 336 */ 337#define CPU_ALLOWAPERTURE 1 /* allow mmap of /dev/xf86 */ 338 /* 2 formerly: keyboard reset */ 339 /* 3 formerly: CPU_LIDSUSPEND */ 340#define CPU_LIDACTION 4 /* action caused by lid close */ 341#define CPU_MAXID 5 /* number of valid machdep ids */ 342 343#define CTL_MACHDEP_NAMES { \ 344 { 0, 0 }, \ 345 { "allowaperture", CTLTYPE_INT }, \ 346 { 0, 0 }, \ 347 { 0, 0 }, \ 348 { "lidaction", CTLTYPE_INT }, \ 349} 350 351/* 352 * MIPS CPU types (cp_imp). 353 */ 354#define MIPS_R2000 0x01 /* MIPS R2000 CPU ISA I */ 355#define MIPS_R3000 0x02 /* MIPS R3000 CPU ISA I */ 356#define MIPS_R6000 0x03 /* MIPS R6000 CPU ISA II */ 357#define MIPS_R4000 0x04 /* MIPS R4000/4400 CPU ISA III */ 358#define MIPS_R3LSI 0x05 /* LSI Logic R3000 derivate ISA I */ 359#define MIPS_R6000A 0x06 /* MIPS R6000A CPU ISA II */ 360#define MIPS_CN50XX 0x06 /* Cavium OCTEON CN50xx MIPS64R2*/ 361#define MIPS_R3IDT 0x07 /* IDT R3000 derivate ISA I */ 362#define MIPS_R10000 0x09 /* MIPS R10000/T5 CPU ISA IV */ 363#define MIPS_R4200 0x0a /* MIPS R4200 CPU (ICE) ISA III */ 364#define MIPS_R4300 0x0b /* NEC VR4300 CPU ISA III */ 365#define MIPS_R4100 0x0c /* NEC VR41xx CPU MIPS-16 ISA III */ 366#define MIPS_R12000 0x0e /* MIPS R12000 ISA IV */ 367#define MIPS_R14000 0x0f /* MIPS R14000 ISA IV */ 368#define MIPS_R8000 0x10 /* MIPS R8000 Blackbird/TFP ISA IV */ 369#define MIPS_R4600 0x20 /* PMCS R4600 Orion ISA III */ 370#define MIPS_R4700 0x21 /* PMCS R4700 Orion ISA III */ 371#define MIPS_R3TOSH 0x22 /* Toshiba R3000 based CPU ISA I */ 372#define MIPS_R5000 0x23 /* MIPS R5000 CPU ISA IV */ 373#define MIPS_RM7000 0x27 /* PMCS RM7000 CPU ISA IV */ 374#define MIPS_RM52X0 0x28 /* PMCS RM52X0 CPU ISA IV */ 375#define MIPS_RM9000 0x34 /* PMCS RM9000 CPU ISA IV */ 376#define MIPS_LOONGSON 0x42 /* STC LoongSon CPU ISA III */ 377#define MIPS_VR5400 0x54 /* NEC Vr5400 CPU ISA IV+ */ 378#define MIPS_LOONGSON2 0x63 /* STC LoongSon2/3 CPU ISA III+ */ 379#define MIPS_CN63XX 0x90 /* Cavium OCTEON II CN6[23]xx MIPS64R2 */ 380#define MIPS_CN68XX 0x91 /* Cavium OCTEON II CN68xx MIPS64R2 */ 381#define MIPS_CN66XX 0x92 /* Cavium OCTEON II CN66xx MIPS64R2 */ 382#define MIPS_CN61XX 0x93 /* Cavium OCTEON II CN6[01]xx MIPS64R2 */ 383#define MIPS_CN78XX 0x95 /* Cavium OCTEON III CN7[678]xx MIPS64R2 */ 384#define MIPS_CN71XX 0x96 /* Cavium OCTEON III CN7[01]xx MIPS64R2 */ 385#define MIPS_CN73XX 0x97 /* Cavium OCTEON III CN7[23]xx MIPS64R2 */ 386 387/* 388 * MIPS FPU types. Only soft, rest is the same as cpu type. 389 */ 390#define MIPS_SOFT 0x00 /* Software emulation ISA I */ 391 392 393#if defined(_KERNEL) && !defined(_LOCORE) 394 395extern register_t protosr; 396extern int cpu_has_synced_cp0_count; 397extern int cpu_has_userlocal; 398 399#ifdef FPUEMUL 400#define CPU_HAS_FPU(ci) ((ci)->ci_hw.c1prid != 0) 401#else 402#define CPU_HAS_FPU(ci) 1 403#endif 404 405struct exec_package; 406struct user; 407 408void tlb_asid_wrap(struct cpu_info *); 409void tlb_flush(int); 410void tlb_flush_addr(vaddr_t); 411void tlb_init(unsigned int); 412void tlb_set_page_mask(uint32_t); 413void tlb_set_pid(u_int); 414void tlb_set_wired(uint32_t); 415int tlb_update(vaddr_t, register_t); 416 417void build_trampoline(vaddr_t, vaddr_t); 418void cpu_switchto_asm(struct proc *, struct proc *); 419int exec_md_map(struct proc *, struct exec_package *); 420void savectx(struct user *, int); 421 422int copyinsn(struct proc *, vaddr_t, uint32_t *); 423void enable_fpu(struct proc *); 424void save_fpu(void); 425int fpe_branch_emulate(struct proc *, struct trapframe *, uint32_t, 426 vaddr_t); 427void MipsSaveCurFPState(struct proc *); 428void MipsSaveCurFPState16(struct proc *); 429void MipsSwitchFPState(struct proc *, struct trapframe *); 430void MipsSwitchFPState16(struct proc *, struct trapframe *); 431 432void MipsFPTrap(struct trapframe *); 433register_t MipsEmulateBranch(struct trapframe *, vaddr_t, uint32_t, uint32_t); 434 435int classify_insn(uint32_t); 436#define INSNCLASS_NEUTRAL 0 437#define INSNCLASS_CALL 1 438#define INSNCLASS_BRANCH 2 439 440/* 441 * Low level access routines to CPU registers 442 */ 443 444void setsoftintr0(void); 445void clearsoftintr0(void); 446void setsoftintr1(void); 447void clearsoftintr1(void); 448register_t enableintr(void); 449register_t disableintr(void); 450register_t getsr(void); 451register_t setsr(register_t); 452 453uint32_t cp0_get_cause(void); 454u_int cp0_get_count(void); 455register_t cp0_get_config(void); 456uint32_t cp0_get_config_1(void); 457uint32_t cp0_get_config_2(void); 458uint32_t cp0_get_config_3(void); 459uint32_t cp0_get_config_4(void); 460uint32_t cp0_get_pagegrain(void); 461register_t cp0_get_prid(void); 462void cp0_reset_cause(register_t); 463void cp0_set_compare(u_int); 464void cp0_set_config(register_t); 465void cp0_set_pagegrain(uint32_t); 466void cp0_set_trapbase(register_t); 467u_int cp1_get_prid(void); 468 469static inline uint32_t 470cp0_get_hwrena(void) 471{ 472 uint32_t value; 473 __asm__ volatile ("mfc0 %0, $7" : "=r" (value)); 474 return value; 475} 476 477static inline void 478cp0_set_hwrena(uint32_t value) 479{ 480 __asm__ volatile ("mtc0 %0, $7" : : "r" (value)); 481} 482 483static inline void 484cp0_set_userlocal(void *value) 485{ 486 __asm__ volatile ( 487 " .set push\n" 488 " .set mips64r2\n" 489 " dmtc0 %0, $4, 2\n" 490 " .set pop\n" 491 : : "r" (value)); 492} 493 494static inline u_long 495intr_disable(void) 496{ 497 return disableintr(); 498} 499 500static inline void 501intr_restore(u_long sr) 502{ 503 setsr(sr); 504} 505 506/* 507 * Cache routines (may be overridden) 508 */ 509 510#ifndef Mips_SyncCache 511#define Mips_SyncCache(ci) \ 512 ((ci)->ci_SyncCache)(ci) 513#endif 514#ifndef Mips_InvalidateICache 515#define Mips_InvalidateICache(ci, va, l) \ 516 ((ci)->ci_InvalidateICache)(ci, va, l) 517#endif 518#ifndef Mips_InvalidateICachePage 519#define Mips_InvalidateICachePage(ci, va) \ 520 ((ci)->ci_InvalidateICachePage)(ci, va) 521#endif 522#ifndef Mips_SyncICache 523#define Mips_SyncICache(ci) \ 524 ((ci)->ci_SyncICache)(ci) 525#endif 526#ifndef Mips_SyncDCachePage 527#define Mips_SyncDCachePage(ci, va, pa) \ 528 ((ci)->ci_SyncDCachePage)(ci, va, pa) 529#endif 530#ifndef Mips_HitSyncDCachePage 531#define Mips_HitSyncDCachePage(ci, va, pa) \ 532 ((ci)->ci_HitSyncDCachePage)(ci, va, pa) 533#endif 534#ifndef Mips_HitSyncDCache 535#define Mips_HitSyncDCache(ci, va, l) \ 536 ((ci)->ci_HitSyncDCache)(ci, va, l) 537#endif 538#ifndef Mips_HitInvalidateDCache 539#define Mips_HitInvalidateDCache(ci, va, l) \ 540 ((ci)->ci_HitInvalidateDCache)(ci, va, l) 541#endif 542#ifndef Mips_IOSyncDCache 543#define Mips_IOSyncDCache(ci, va, l, h) \ 544 ((ci)->ci_IOSyncDCache)(ci, va, l, h) 545#endif 546 547#endif /* _KERNEL && !_LOCORE */ 548#endif /* !_MIPS64_CPU_H_ */ 549