Home | History | Annotate | Line # | Download | only in include
locore.h revision 1.107
      1 /* $NetBSD: locore.h,v 1.107 2020/06/14 06:50:31 simonb Exp $ */
      2 
      3 /*
      4  * This file should not be included by MI code!!!
      5  */
      6 
      7 /*
      8  * Copyright 1996 The Board of Trustees of The Leland Stanford
      9  * Junior University. All Rights Reserved.
     10  *
     11  * Permission to use, copy, modify, and distribute this
     12  * software and its documentation for any purpose and without
     13  * fee is hereby granted, provided that the above copyright
     14  * notice appear in all copies.  Stanford University
     15  * makes no representations about the suitability of this
     16  * software for any purpose.  It is provided "as is" without
     17  * express or implied warranty.
     18  */
     19 
     20 /*
     21  * Jump table for MIPS CPU locore functions that are implemented
     22  * differently on different generations, or instruction-level
     23  * architecture (ISA) level, the Mips family.
     24  *
     25  * We currently provide support for MIPS I and MIPS III.
     26  */
     27 
     28 #ifndef _MIPS_LOCORE_H
     29 #define _MIPS_LOCORE_H
     30 
     31 #if !defined(_LKM) && defined(_KERNEL_OPT)
     32 #include "opt_cputype.h"
     33 #endif
     34 
     35 #ifndef __ASSEMBLER__
     36 
     37 #include <sys/cpu.h>
     38 
     39 #include <mips/mutex.h>
     40 #include <mips/cpuregs.h>
     41 #include <mips/reg.h>
     42 
     43 #ifndef __BSD_PTENTRY_T__
     44 #define __BSD_PTENTRY_T__
     45 typedef uint32_t pt_entry_t;
     46 #define PRIxPTE		PRIx32
     47 #endif
     48 
     49 #include <uvm/pmap/tlb.h>
     50 #endif /* !__ASSEMBLER__ */
     51 
     52 #ifdef _KERNEL
     53 
     54 #if defined(_MODULAR) || defined(_LKM) || defined(_STANDALONE)
     55 /* Assume all CPU architectures are valid for LKM's and standlone progs */
     56 #if !defined(__mips_n32) && !defined(__mips_n64)
     57 #define	MIPS1		1
     58 #endif
     59 #define	MIPS3		1
     60 #define	MIPS4		1
     61 #if !defined(__mips_n32) && !defined(__mips_n64)
     62 #define	MIPS32		1
     63 #define	MIPS32R2	1
     64 #endif
     65 #define	MIPS64		1
     66 #define	MIPS64R2	1
     67 #endif /* _MODULAR || _LKM || _STANDALONE */
     68 
     69 #if (MIPS1 + MIPS3 + MIPS4 + MIPS32 + MIPS32R2 + MIPS64 + MIPS64R2) == 0
     70 #error at least one of MIPS1, MIPS3, MIPS4, MIPS32, MIPS32R2, MIPS64, or MIPS64R2 must be specified
     71 #endif
     72 
     73 /* Shortcut for MIPS3 or above defined */
     74 #if defined(MIPS3) || defined(MIPS4) \
     75     || defined(MIPS32) || defined(MIPS32R2) \
     76     || defined(MIPS64) || defined(MIPS64R2)
     77 
     78 #define	MIPS3_PLUS	1
     79 #if !defined(MIPS32) && !defined(MIPS32R2)
     80 #define MIPS3_64BIT	1
     81 #endif
     82 #if !defined(MIPS3) && !defined(MIPS4)
     83 #define MIPSNN		1
     84 #endif
     85 #if defined(MIPS32R2) || defined(MIPS64R2)
     86 #define MIPSNNR2	1
     87 #endif
     88 #else
     89 #undef MIPS3_PLUS
     90 #endif
     91 
     92 #if !defined(MIPS3_PLUS) && (ENABLE_MIPS_8KB_PAGE + ENABLE_MIPS_16KB_PAGE) > 0
     93 #error MIPS1 does not support non-4KB page sizes.
     94 #endif
     95 
     96 /* XXX some .S files look for MIPS3_PLUS */
     97 #ifndef __ASSEMBLER__
     98 
     99 /* XXX simonb
    100  * Should the following be in a cpu_info type structure?
    101  * And how many of these are per-cpu vs. per-system?  (Ie,
    102  * we can assume that all cpus have the same mmu-type, but
    103  * maybe not that all cpus run at the same clock speed.
    104  * Some SGI's apparently support R12k and R14k in the same
    105  * box.)
    106  */
    107 struct mips_options {
    108 	const struct pridtab *mips_cpu;
    109 
    110 	u_int mips_cpu_arch;
    111 	u_int mips_cpu_mhz; /* CPU speed in MHz, estimated by mc_cpuspeed(). */
    112 	u_int mips_cpu_flags;
    113 	u_int mips_num_tlb_entries;
    114 	mips_prid_t mips_cpu_id;
    115 	mips_prid_t mips_fpu_id;
    116 	bool mips_has_r4k_mmu;
    117 	bool mips_has_llsc;
    118 	u_int mips3_pg_shift;
    119 	u_int mips3_pg_cached;
    120 	u_int mips3_cca_devmem;
    121 #ifdef MIPS3_PLUS
    122 #ifndef __mips_o32
    123 	uint64_t mips3_xkphys_cached;
    124 #endif
    125 	uint64_t mips3_tlb_vpn_mask;
    126 	uint64_t mips3_tlb_pfn_mask;
    127 	uint32_t mips3_tlb_pg_mask;
    128 #endif
    129 };
    130 
    131 #endif /* !__ASSEMBLER__ */
    132 
    133 /*
    134  * Macros to find the CPU architecture we're on at run-time,
    135  * or if possible, at compile-time.
    136  */
    137 
    138 #define	CPU_ARCH_MIPSx		0		/* XXX unknown */
    139 #define	CPU_ARCH_MIPS1		(1 << 0)
    140 #define	CPU_ARCH_MIPS2		(1 << 1)
    141 #define	CPU_ARCH_MIPS3		(1 << 2)
    142 #define	CPU_ARCH_MIPS4		(1 << 3)
    143 #define	CPU_ARCH_MIPS5		(1 << 4)
    144 #define	CPU_ARCH_MIPS32		(1 << 5)
    145 #define	CPU_ARCH_MIPS64		(1 << 6)
    146 #define	CPU_ARCH_MIPS32R2	(1 << 7)
    147 #define	CPU_ARCH_MIPS64R2	(1 << 8)
    148 
    149 #define	CPU_MIPS_R4K_MMU		0x00001
    150 #define	CPU_MIPS_NO_LLSC		0x00002
    151 #define	CPU_MIPS_CAUSE_IV		0x00004
    152 #define	CPU_MIPS_HAVE_SPECIAL_CCA	0x00008	/* Defaults to '3' if not set. */
    153 #define	CPU_MIPS_CACHED_CCA_MASK	0x00070
    154 #define	CPU_MIPS_CACHED_CCA_SHIFT	 4
    155 #define	CPU_MIPS_DOUBLE_COUNT		0x00080	/* 1 cp0 count == 2 clock cycles */
    156 #define	CPU_MIPS_USE_WAIT		0x00100	/* Use "wait"-based cpu_idle() */
    157 #define	CPU_MIPS_NO_WAIT		0x00200	/* Inverse of previous, for mips32/64 */
    158 #define	CPU_MIPS_D_CACHE_COHERENT	0x00400	/* D-cache is fully coherent */
    159 #define	CPU_MIPS_I_D_CACHE_COHERENT	0x00800	/* I-cache funcs don't need to flush the D-cache */
    160 #define	CPU_MIPS_NO_LLADDR		0x01000
    161 #define	CPU_MIPS_HAVE_MxCR		0x02000	/* have mfcr, mtcr insns */
    162 #define	CPU_MIPS_LOONGSON2		0x04000
    163 #define	MIPS_NOT_SUPP			0x08000
    164 #define	CPU_MIPS_HAVE_DSP		0x10000
    165 #define	CPU_MIPS_HAVE_USERLOCAL		0x20000
    166 
    167 #endif	/* !_LOCORE */
    168 
    169 #if ((MIPS1 + MIPS3 + MIPS4 + MIPS32 + MIPS32R2 + MIPS64 + MIPS64R2) == 1) || defined(_LOCORE)
    170 
    171 #if defined(MIPS1)
    172 
    173 # define CPUISMIPS3		0
    174 # define CPUIS64BITS		0
    175 # define CPUISMIPS32		0
    176 # define CPUISMIPS32R2		0
    177 # define CPUISMIPS64		0
    178 # define CPUISMIPS64R2		0
    179 # define CPUISMIPSNN		0
    180 # define CPUISMIPSNNR2		0
    181 # define MIPS_HAS_R4K_MMU	0
    182 # define MIPS_HAS_CLOCK		0
    183 # define MIPS_HAS_LLSC		0
    184 # define MIPS_HAS_LLADDR	0
    185 # define MIPS_HAS_LMMI		0
    186 # define MIPS_HAS_DSP		0
    187 # define MIPS_HAS_USERLOCAL	0
    188 
    189 #elif defined(MIPS3) || defined(MIPS4)
    190 
    191 # define CPUISMIPS3		1
    192 # define CPUIS64BITS		1
    193 # define CPUISMIPS32		0
    194 # define CPUISMIPS32R2		0
    195 # define CPUISMIPS64		0
    196 # define CPUISMIPS64R2		0
    197 # define CPUISMIPSNN		0
    198 # define CPUISMIPSNNR2		0
    199 # define MIPS_HAS_R4K_MMU	1
    200 # define MIPS_HAS_CLOCK		1
    201 # if defined(_LOCORE)
    202 #  if !defined(MIPS3_4100)
    203 #   define MIPS_HAS_LLSC	1
    204 #  else
    205 #   define MIPS_HAS_LLSC	0
    206 #  endif
    207 # else	/* _LOCORE */
    208 #  define MIPS_HAS_LLSC		(mips_options.mips_has_llsc)
    209 # endif	/* _LOCORE */
    210 # define MIPS_HAS_LLADDR	((mips_options.mips_cpu_flags & CPU_MIPS_NO_LLADDR) == 0)
    211 # if defined(MIPS3_LOONGSON2)
    212 #  define MIPS_HAS_LMMI		((mips_options.mips_cpu_flags & CPU_MIPS_LOONGSON2) != 0)
    213 # else
    214 #  define MIPS_HAS_LMMI		0
    215 # endif
    216 # define MIPS_HAS_DSP		0
    217 # define MIPS_HAS_USERLOCAL	0
    218 
    219 #elif defined(MIPS32)
    220 
    221 # define CPUISMIPS3		1
    222 # define CPUIS64BITS		0
    223 # define CPUISMIPS32		1
    224 # define CPUISMIPS32R2		0
    225 # define CPUISMIPS64		0
    226 # define CPUISMIPS64R2		0
    227 # define CPUISMIPSNN		1
    228 # define CPUISMIPSNNR2		0
    229 # define MIPS_HAS_R4K_MMU	1
    230 # define MIPS_HAS_CLOCK		1
    231 # define MIPS_HAS_LLSC		1
    232 # define MIPS_HAS_LLADDR	((mips_options.mips_cpu_flags & CPU_MIPS_NO_LLADDR) == 0)
    233 # define MIPS_HAS_LMMI		0
    234 # define MIPS_HAS_DSP		0
    235 # define MIPS_HAS_USERLOCAL	0
    236 
    237 #elif defined(MIPS32R2)
    238 
    239 # define CPUISMIPS3		1
    240 # define CPUIS64BITS		0
    241 # define CPUISMIPS32		0
    242 # define CPUISMIPS32R2		1
    243 # define CPUISMIPS64		0
    244 # define CPUISMIPS64R2		0
    245 # define CPUISMIPSNN		1
    246 # define CPUISMIPSNNR2		1
    247 # define MIPS_HAS_R4K_MMU	1
    248 # define MIPS_HAS_CLOCK		1
    249 # define MIPS_HAS_LLSC		1
    250 # define MIPS_HAS_LLADDR	((mips_options.mips_cpu_flags & CPU_MIPS_NO_LLADDR) == 0)
    251 # define MIPS_HAS_LMMI		0
    252 # define MIPS_HAS_DSP		(mips_options.mips_cpu_flags & CPU_MIPS_HAVE_DSP)
    253 # define MIPS_HAS_USERLOCAL	(mips_options.mips_cpu_flags & CPU_MIPS_HAVE_USERLOCAL)
    254 
    255 #elif defined(MIPS64)
    256 
    257 # define CPUISMIPS3		1
    258 # define CPUIS64BITS		1
    259 # define CPUISMIPS32		0
    260 # define CPUISMIPS32R2		0
    261 # define CPUISMIPS64		1
    262 # define CPUISMIPS64R2		0
    263 # define CPUISMIPSNN		1
    264 # define CPUISMIPSNNR2		0
    265 # define MIPS_HAS_R4K_MMU	1
    266 # define MIPS_HAS_CLOCK		1
    267 # define MIPS_HAS_LLSC		1
    268 # define MIPS_HAS_LLADDR	((mips_options.mips_cpu_flags & CPU_MIPS_NO_LLADDR) == 0)
    269 # define MIPS_HAS_LMMI		0
    270 # define MIPS_HAS_DSP		0
    271 # define MIPS_HAS_USERLOCAL	0
    272 
    273 #elif defined(MIPS64R2)
    274 
    275 # define CPUISMIPS3		1
    276 # define CPUIS64BITS		1
    277 # define CPUISMIPS32		0
    278 # define CPUISMIPS32R2		0
    279 # define CPUISMIPS64		0
    280 # define CPUISMIPS64R2		1
    281 # define CPUISMIPSNN		1
    282 # define CPUISMIPSNNR2		1
    283 # define MIPS_HAS_R4K_MMU	1
    284 # define MIPS_HAS_CLOCK		1
    285 # define MIPS_HAS_LLSC		1
    286 # define MIPS_HAS_LLADDR	((mips_options.mips_cpu_flags & CPU_MIPS_NO_LLADDR) == 0)
    287 # define MIPS_HAS_LMMI		0
    288 # define MIPS_HAS_DSP		(mips_options.mips_cpu_flags & CPU_MIPS_HAVE_DSP)
    289 # define MIPS_HAS_USERLOCAL	(mips_options.mips_cpu_flags & CPU_MIPS_HAVE_USERLOCAL)
    290 
    291 #endif
    292 
    293 #else /* run-time test */
    294 
    295 #ifdef MIPS1
    296 #define	MIPS_HAS_R4K_MMU	(mips_options.mips_has_r4k_mmu)
    297 #define	MIPS_HAS_LLSC		(mips_options.mips_has_llsc)
    298 #else
    299 #define	MIPS_HAS_R4K_MMU	1
    300 #if !defined(MIPS3_4100)
    301 #define MIPS_HAS_LLSC		1
    302 #else
    303 #define MIPS_HAS_LLSC		(mips_options.mips_has_llsc)
    304 #endif
    305 #endif
    306 #define	MIPS_HAS_LLADDR		((mips_options.mips_cpu_flags & CPU_MIPS_NO_LLADDR) == 0)
    307 #define MIPS_HAS_DSP		(mips_options.mips_cpu_flags & CPU_MIPS_HAVE_DSP)
    308 # define MIPS_HAS_USERLOCAL	(mips_options.mips_cpu_flags & CPU_MIPS_HAVE_USERLOCAL)
    309 
    310 /* This test is ... rather bogus */
    311 #define	CPUISMIPS3	((mips_options.mips_cpu_arch & \
    312 	(CPU_ARCH_MIPS3 | CPU_ARCH_MIPS4 | CPU_ARCH_MIPS32 | CPU_ARCH_MIPS64)) != 0)
    313 
    314 /* And these aren't much better while the previous test exists as is... */
    315 #define	CPUISMIPS4	((mips_options.mips_cpu_arch & CPU_ARCH_MIPS4) != 0)
    316 #define	CPUISMIPS5	((mips_options.mips_cpu_arch & CPU_ARCH_MIPS5) != 0)
    317 #define	CPUISMIPS32	((mips_options.mips_cpu_arch & CPU_ARCH_MIPS32) != 0)
    318 #define	CPUISMIPS32R2	((mips_options.mips_cpu_arch & CPU_ARCH_MIPS32R2) != 0)
    319 #define	CPUISMIPS64	((mips_options.mips_cpu_arch & CPU_ARCH_MIPS64) != 0)
    320 #define	CPUISMIPS64R2	((mips_options.mips_cpu_arch & CPU_ARCH_MIPS64R2) != 0)
    321 #define	CPUISMIPSNN	((mips_options.mips_cpu_arch & \
    322 	(CPU_ARCH_MIPS32 | CPU_ARCH_MIPS32R2 | CPU_ARCH_MIPS64 | CPU_ARCH_MIPS64R2)) != 0)
    323 #define	CPUISMIPSNNR2	((mips_options.mips_cpu_arch & \
    324 	(CPU_ARCH_MIPS32R2 | CPU_ARCH_MIPS64R2)) != 0)
    325 #define	CPUIS64BITS	((mips_options.mips_cpu_arch & \
    326 	(CPU_ARCH_MIPS3 | CPU_ARCH_MIPS4 | CPU_ARCH_MIPS64 | CPU_ARCH_MIPS64R2)) != 0)
    327 
    328 #define	MIPS_HAS_CLOCK	(mips_options.mips_cpu_arch >= CPU_ARCH_MIPS3)
    329 
    330 #endif /* run-time test */
    331 
    332 #ifndef __ASSEMBLER__
    333 
    334 struct tlbmask;
    335 struct trapframe;
    336 
    337 void	trap(uint32_t, uint32_t, vaddr_t, vaddr_t, struct trapframe *);
    338 void	ast(void);
    339 
    340 void	mips_fpu_trap(vaddr_t, struct trapframe *);
    341 void	mips_fpu_intr(vaddr_t, struct trapframe *);
    342 
    343 vaddr_t mips_emul_branch(struct trapframe *, vaddr_t, uint32_t, bool);
    344 void	mips_emul_inst(uint32_t, uint32_t, vaddr_t, struct trapframe *);
    345 
    346 void	mips_emul_fp(uint32_t, struct trapframe *, uint32_t);
    347 void	mips_emul_branchdelayslot(uint32_t, struct trapframe *, uint32_t);
    348 
    349 void	mips_emul_lwc0(uint32_t, struct trapframe *, uint32_t);
    350 void	mips_emul_swc0(uint32_t, struct trapframe *, uint32_t);
    351 void	mips_emul_special(uint32_t, struct trapframe *, uint32_t);
    352 void	mips_emul_special3(uint32_t, struct trapframe *, uint32_t);
    353 
    354 void	mips_emul_lwc1(uint32_t, struct trapframe *, uint32_t);
    355 void	mips_emul_swc1(uint32_t, struct trapframe *, uint32_t);
    356 void	mips_emul_ldc1(uint32_t, struct trapframe *, uint32_t);
    357 void	mips_emul_sdc1(uint32_t, struct trapframe *, uint32_t);
    358 
    359 void	mips_emul_lb(uint32_t, struct trapframe *, uint32_t);
    360 void	mips_emul_lbu(uint32_t, struct trapframe *, uint32_t);
    361 void	mips_emul_lh(uint32_t, struct trapframe *, uint32_t);
    362 void	mips_emul_lhu(uint32_t, struct trapframe *, uint32_t);
    363 void	mips_emul_lw(uint32_t, struct trapframe *, uint32_t);
    364 void	mips_emul_lwl(uint32_t, struct trapframe *, uint32_t);
    365 void	mips_emul_lwr(uint32_t, struct trapframe *, uint32_t);
    366 #if defined(__mips_n32) || defined(__mips_n64) || defined(__mips_o64)
    367 void	mips_emul_lwu(uint32_t, struct trapframe *, uint32_t);
    368 void	mips_emul_ld(uint32_t, struct trapframe *, uint32_t);
    369 void	mips_emul_ldl(uint32_t, struct trapframe *, uint32_t);
    370 void	mips_emul_ldr(uint32_t, struct trapframe *, uint32_t);
    371 #endif
    372 void	mips_emul_sb(uint32_t, struct trapframe *, uint32_t);
    373 void	mips_emul_sh(uint32_t, struct trapframe *, uint32_t);
    374 void	mips_emul_sw(uint32_t, struct trapframe *, uint32_t);
    375 void	mips_emul_swl(uint32_t, struct trapframe *, uint32_t);
    376 void	mips_emul_swr(uint32_t, struct trapframe *, uint32_t);
    377 #if defined(__mips_n32) || defined(__mips_n64) || defined(__mips_o64)
    378 void	mips_emul_sd(uint32_t, struct trapframe *, uint32_t);
    379 void	mips_emul_sdl(uint32_t, struct trapframe *, uint32_t);
    380 void	mips_emul_sdr(uint32_t, struct trapframe *, uint32_t);
    381 #endif
    382 
    383 uint32_t mips_cp0_cause_read(void);
    384 void	mips_cp0_cause_write(uint32_t);
    385 uint32_t mips_cp0_status_read(void);
    386 void	mips_cp0_status_write(uint32_t);
    387 
    388 void	softint_process(uint32_t);
    389 void	softint_fast_dispatch(struct lwp *, int);
    390 
    391 /*
    392  * Convert an address to an offset used in a MIPS jump instruction.  The offset
    393  * contains the low 28 bits (allowing a jump to anywhere within the same 256MB
    394  * segment of address space) of the address but since mips instructions are
    395  * always on a 4 byte boundary the low 2 bits are always zero so the 28 bits
    396  * get shifted right by 2 bits leaving us with a 26 bit result.  To make the
    397  * offset, we shift left to clear the upper four bits and then right by 6.
    398  */
    399 #define	fixup_addr2offset(x)	((((uint32_t)(uintptr_t)(x)) << 4) >> 6)
    400 typedef bool (*mips_fixup_callback_t)(int32_t, uint32_t [2], void *);
    401 struct mips_jump_fixup_info {
    402 	uint32_t jfi_stub;
    403 	uint32_t jfi_real;
    404 };
    405 
    406 void	fixup_splcalls(void);				/* splstubs.c */
    407 bool	mips_fixup_exceptions(mips_fixup_callback_t, void *);
    408 bool	mips_fixup_zero_relative(int32_t, uint32_t [2], void *);
    409 intptr_t
    410 	mips_fixup_addr(const uint32_t *);
    411 void	mips_fixup_stubs(uint32_t *, uint32_t *);
    412 
    413 /*
    414  * Define these stubs...
    415  */
    416 void	mips_cpu_switch_resume(struct lwp *);
    417 void	wbflush(void);
    418 
    419 #ifdef MIPS1
    420 void	mips1_tlb_invalidate_all(void);
    421 
    422 uint32_t tx3900_cp0_config_read(void);
    423 #endif
    424 
    425 #ifdef MIPS3_PLUS
    426 uint32_t mips3_cp0_compare_read(void);
    427 void	mips3_cp0_compare_write(uint32_t);
    428 
    429 uint32_t mips3_cp0_config_read(void);
    430 void	mips3_cp0_config_write(uint32_t);
    431 
    432 #ifdef MIPSNN
    433 uint32_t mipsNN_cp0_config1_read(void);
    434 void	mipsNN_cp0_config1_write(uint32_t);
    435 uint32_t mipsNN_cp0_config2_read(void);
    436 uint32_t mipsNN_cp0_config3_read(void);
    437 uint32_t mipsNN_cp0_config4_read(void);
    438 uint32_t mipsNN_cp0_config5_read(void);
    439 uint32_t mipsNN_cp0_config6_read(void);
    440 uint32_t mipsNN_cp0_config7_read(void);
    441 
    442 intptr_t mipsNN_cp0_watchlo_read(u_int);
    443 void	mipsNN_cp0_watchlo_write(u_int, intptr_t);
    444 uint32_t mipsNN_cp0_watchhi_read(u_int);
    445 void	mipsNN_cp0_watchhi_write(u_int, uint32_t);
    446 
    447 int32_t mipsNN_cp0_ebase_read(void);
    448 void	mipsNN_cp0_ebase_write(int32_t);
    449 
    450 uint32_t mipsNN_cp0_rdhwr_cpunum(void);
    451 
    452 #ifdef MIPSNNR2
    453 void	mipsNN_cp0_hwrena_write(uint32_t);
    454 void	mipsNN_cp0_userlocal_write(void *);
    455 #endif
    456 #endif /* MIPSNN */
    457 
    458 uint32_t mips3_cp0_count_read(void);
    459 void	mips3_cp0_count_write(uint32_t);
    460 
    461 uint32_t mips3_cp0_wired_read(void);
    462 void	mips3_cp0_wired_write(uint32_t);
    463 void	mips3_cp0_pg_mask_write(uint32_t);
    464 
    465 #endif	/* MIPS3_PLUS */
    466 
    467 /* 64-bit address space accessor for n32, n64 ABI */
    468 /* 32-bit address space accessor for o32 ABI */
    469 static inline uint8_t	mips_lbu(register_t addr) __unused;
    470 static inline void	mips_sb(register_t addr, uint8_t val) __unused;
    471 static inline uint16_t	mips_lhu(register_t addr) __unused;
    472 static inline void	mips_sh(register_t addr, uint16_t val) __unused;
    473 static inline uint32_t	mips_lwu(register_t addr) __unused;
    474 static inline void	mips_sw(register_t addr, uint32_t val) __unused;
    475 #ifdef MIPS3_64BIT
    476 #if defined(__mips_o32)
    477 uint64_t		mips3_ld(register_t addr);
    478 void			mips3_sd(register_t addr, uint64_t val);
    479 #else
    480 static inline uint64_t	mips3_ld(register_t addr) __unused;
    481 static inline void	mips3_sd(register_t addr, uint64_t val) __unused;
    482 #endif
    483 #endif
    484 
    485 static inline uint8_t
    486 mips_lbu(register_t addr)
    487 {
    488 	uint8_t rv;
    489 #if defined(__mips_n32)
    490 	__asm volatile("lbu\t%0, 0(%1)" : "=r"(rv) : "d"(addr));
    491 #else
    492 	rv = *(const volatile uint8_t *)addr;
    493 #endif
    494 	return rv;
    495 }
    496 
    497 static inline uint16_t
    498 mips_lhu(register_t addr)
    499 {
    500 	uint16_t rv;
    501 #if defined(__mips_n32)
    502 	__asm volatile("lhu\t%0, 0(%1)" : "=r"(rv) : "d"(addr));
    503 #else
    504 	rv = *(const volatile uint16_t *)addr;
    505 #endif
    506 	return rv;
    507 }
    508 
    509 static inline uint32_t
    510 mips_lwu(register_t addr)
    511 {
    512 	uint32_t rv;
    513 #if defined(__mips_n32)
    514 	__asm volatile("lwu\t%0, 0(%1)" : "=r"(rv) : "d"(addr));
    515 #else
    516 	rv = *(const volatile uint32_t *)addr;
    517 #endif
    518 	return (rv);
    519 }
    520 
    521 #if defined(MIPS3_64BIT) && !defined(__mips_o32)
    522 static inline uint64_t
    523 mips3_ld(register_t addr)
    524 {
    525 	uint64_t rv;
    526 #if defined(__mips_n32)
    527 	__asm volatile("ld\t%0, 0(%1)" : "=r"(rv) : "d"(addr));
    528 #elif defined(_LP64)
    529 	rv = *(const volatile uint64_t *)addr;
    530 #else
    531 #error unknown ABI
    532 #endif
    533 	return (rv);
    534 }
    535 #endif	/* MIPS3_64BIT && !__mips_o32 */
    536 
    537 static inline void
    538 mips_sb(register_t addr, uint8_t val)
    539 {
    540 #if defined(__mips_n32)
    541 	__asm volatile("sb\t%1, 0(%0)" :: "d"(addr), "r"(val));
    542 #else
    543 	*(volatile uint8_t *)addr = val;
    544 #endif
    545 }
    546 
    547 static inline void
    548 mips_sh(register_t addr, uint16_t val)
    549 {
    550 #if defined(__mips_n32)
    551 	__asm volatile("sh\t%1, 0(%0)" :: "d"(addr), "r"(val));
    552 #else
    553 	*(volatile uint16_t *)addr = val;
    554 #endif
    555 }
    556 
    557 static inline void
    558 mips_sw(register_t addr, uint32_t val)
    559 {
    560 #if defined(__mips_n32)
    561 	__asm volatile("sw\t%1, 0(%0)" :: "d"(addr), "r"(val));
    562 #else
    563 	*(volatile uint32_t *)addr = val;
    564 #endif
    565 }
    566 
    567 #if defined(MIPS3_64BIT) && !defined(__mips_o32)
    568 static inline void
    569 mips3_sd(register_t addr, uint64_t val)
    570 {
    571 #if defined(__mips_n32)
    572 	__asm volatile("sd\t%1, 0(%0)" :: "d"(addr), "r"(val));
    573 #else
    574 	*(volatile uint64_t *)addr = val;
    575 #endif
    576 }
    577 #endif	/* MIPS3_64BIT && !__mips_o32 */
    578 
    579 /*
    580  * A vector with an entry for each mips-ISA-level dependent
    581  * locore function, and macros which jump through it.
    582  */
    583 typedef struct  {
    584 	void	(*ljv_cpu_switch_resume)(struct lwp *);
    585 	intptr_t ljv_lwp_trampoline;
    586 	void	(*ljv_wbflush)(void);
    587 	tlb_asid_t (*ljv_tlb_get_asid)(void);
    588 	void	(*ljv_tlb_set_asid)(tlb_asid_t pid);
    589 	void	(*ljv_tlb_invalidate_asids)(tlb_asid_t, tlb_asid_t);
    590 	void	(*ljv_tlb_invalidate_addr)(vaddr_t, tlb_asid_t);
    591 	void	(*ljv_tlb_invalidate_globals)(void);
    592 	void	(*ljv_tlb_invalidate_all)(void);
    593 	u_int	(*ljv_tlb_record_asids)(u_long *, tlb_asid_t);
    594 	int	(*ljv_tlb_update_addr)(vaddr_t, tlb_asid_t, pt_entry_t, bool);
    595 	void	(*ljv_tlb_read_entry)(size_t, struct tlbmask *);
    596 	void	(*ljv_tlb_write_entry)(size_t, const struct tlbmask *);
    597 } mips_locore_jumpvec_t;
    598 
    599 typedef struct {
    600 	u_int	(*lav_atomic_cas_uint)(volatile u_int *, u_int, u_int);
    601 	u_long	(*lav_atomic_cas_ulong)(volatile u_long *, u_long, u_long);
    602 	int	(*lav_ucas_32)(volatile uint32_t *, uint32_t, uint32_t,
    603 			       uint32_t *);
    604 	int	(*lav_ucas_64)(volatile uint64_t *, uint64_t, uint64_t,
    605 			       uint64_t *);
    606 	void	(*lav_mutex_enter)(kmutex_t *);
    607 	void	(*lav_mutex_exit)(kmutex_t *);
    608 	void	(*lav_mutex_spin_enter)(kmutex_t *);
    609 	void	(*lav_mutex_spin_exit)(kmutex_t *);
    610 } mips_locore_atomicvec_t;
    611 
    612 void	mips_set_wbflush(void (*)(void));
    613 void	mips_wait_idle(void);
    614 
    615 void	stacktrace(void);
    616 void	logstacktrace(void);
    617 
    618 struct cpu_info;
    619 struct splsw;
    620 
    621 struct locoresw {
    622 	void		(*lsw_wbflush)(void);
    623 	void		(*lsw_cpu_idle)(void);
    624 	int		(*lsw_send_ipi)(struct cpu_info *, int);
    625 	void		(*lsw_cpu_offline_md)(void);
    626 	void		(*lsw_cpu_init)(struct cpu_info *);
    627 	void		(*lsw_cpu_run)(struct cpu_info *);
    628 	int		(*lsw_bus_error)(unsigned int);
    629 };
    630 
    631 struct mips_vmfreelist {
    632 	paddr_t fl_start;
    633 	paddr_t fl_end;
    634 	int fl_freelist;
    635 };
    636 
    637 struct cpu_info *
    638 	cpu_info_alloc(struct pmap_tlb_info *, cpuid_t, cpuid_t, cpuid_t,
    639 	    cpuid_t);
    640 void	cpu_attach_common(device_t, struct cpu_info *);
    641 void	cpu_startup_common(void);
    642 
    643 #ifdef MULTIPROCESSOR
    644 void	cpu_hatch(struct cpu_info *ci);
    645 void	cpu_trampoline(void);
    646 void	cpu_halt(void);
    647 void	cpu_halt_others(void);
    648 void	cpu_pause(struct reg *);
    649 void	cpu_pause_others(void);
    650 void	cpu_resume(cpuid_t);
    651 void	cpu_resume_others(void);
    652 bool	cpu_is_paused(cpuid_t);
    653 void	cpu_debug_dump(void);
    654 
    655 extern kcpuset_t *cpus_running;
    656 extern kcpuset_t *cpus_hatched;
    657 extern kcpuset_t *cpus_paused;
    658 extern kcpuset_t *cpus_resumed;
    659 extern kcpuset_t *cpus_halted;
    660 #endif
    661 
    662 /* copy.S */
    663 uint32_t mips_ufetch32(const void *);
    664 int	mips_ustore32_isync(void *, uint32_t);
    665 
    666 int32_t kfetch_32(volatile uint32_t *, uint32_t);
    667 
    668 /* trap.c */
    669 void	netintr(void);
    670 bool	kdbpeek(vaddr_t, int *);
    671 
    672 /* mips_dsp.c */
    673 void	dsp_init(void);
    674 void	dsp_discard(lwp_t *);
    675 void	dsp_load(void);
    676 void	dsp_save(lwp_t *);
    677 bool	dsp_used_p(const lwp_t *);
    678 extern const pcu_ops_t mips_dsp_ops;
    679 
    680 /* mips_fpu.c */
    681 void	fpu_init(void);
    682 void	fpu_discard(lwp_t *);
    683 void	fpu_load(void);
    684 void	fpu_save(lwp_t *);
    685 bool	fpu_used_p(const lwp_t *);
    686 extern const pcu_ops_t mips_fpu_ops;
    687 
    688 /* mips_machdep.c */
    689 void	dumpsys(void);
    690 int	savectx(struct pcb *);
    691 void	cpu_identify(device_t);
    692 
    693 /* locore*.S */
    694 int	badaddr(void *, size_t);
    695 int	badaddr64(uint64_t, size_t);
    696 
    697 /* vm_machdep.c */
    698 int	ioaccess(vaddr_t, paddr_t, vsize_t);
    699 int	iounaccess(vaddr_t, vsize_t);
    700 
    701 /*
    702  * The "active" locore-function vector, and
    703  */
    704 extern const mips_locore_atomicvec_t mips_llsc_locore_atomicvec;
    705 
    706 extern mips_locore_atomicvec_t mips_locore_atomicvec;
    707 extern mips_locore_jumpvec_t mips_locore_jumpvec;
    708 extern struct locoresw mips_locoresw;
    709 
    710 extern int mips_poolpage_vmfreelist;	/* freelist to allocate poolpages */
    711 extern struct mips_options mips_options;
    712 
    713 struct splsw;
    714 struct mips_vmfreelist;
    715 struct phys_ram_seg;
    716 
    717 void	mips64r2_vector_init(const struct splsw *);
    718 void	mips_vector_init(const struct splsw *, bool);
    719 void	mips_init_msgbuf(void);
    720 void	mips_init_lwp0_uarea(void);
    721 void	mips_page_physload(vaddr_t, vaddr_t,
    722 	    const struct phys_ram_seg *, size_t,
    723 	    const struct mips_vmfreelist *, size_t);
    724 
    725 
    726 /*
    727  * CPU identification, from PRID register.
    728  */
    729 #define MIPS_PRID_REV(x)	(((x) >>  0) & 0x00ff)
    730 #define MIPS_PRID_IMPL(x)	(((x) >>  8) & 0x00ff)
    731 
    732 /* pre-MIPS32/64 */
    733 #define MIPS_PRID_RSVD(x)	(((x) >> 16) & 0xffff)
    734 #define MIPS_PRID_REV_MIN(x)	((MIPS_PRID_REV(x) >> 0) & 0x0f)
    735 #define MIPS_PRID_REV_MAJ(x)	((MIPS_PRID_REV(x) >> 4) & 0x0f)
    736 
    737 /* MIPS32/64 */
    738 #define MIPS_PRID_CID(x)	(((x) >> 16) & 0x00ff)	/* Company ID */
    739 #define     MIPS_PRID_CID_PREHISTORIC	0x00	/* Not MIPS32/64 */
    740 #define     MIPS_PRID_CID_MTI		0x01	/* MIPS Technologies, Inc. */
    741 #define     MIPS_PRID_CID_BROADCOM	0x02	/* Broadcom */
    742 #define     MIPS_PRID_CID_ALCHEMY	0x03	/* Alchemy Semiconductor */
    743 #define     MIPS_PRID_CID_SIBYTE	0x04	/* SiByte */
    744 #define     MIPS_PRID_CID_SANDCRAFT	0x05	/* SandCraft */
    745 #define     MIPS_PRID_CID_PHILIPS	0x06	/* Philips */
    746 #define     MIPS_PRID_CID_TOSHIBA	0x07	/* Toshiba */
    747 #define     MIPS_PRID_CID_MICROSOFT	0x07	/* Microsoft also, sigh */
    748 #define     MIPS_PRID_CID_LSI		0x08	/* LSI */
    749 				/*	0x09	unannounced */
    750 				/*	0x0a	unannounced */
    751 #define     MIPS_PRID_CID_LEXRA		0x0b	/* Lexra */
    752 #define     MIPS_PRID_CID_RMI		0x0c	/* RMI / NetLogic */
    753 #define     MIPS_PRID_CID_CAVIUM	0x0d	/* Cavium */
    754 #define     MIPS_PRID_CID_INGENIC	0xe1
    755 #define MIPS_PRID_COPTS(x)	(((x) >> 24) & 0x00ff)	/* Company Options */
    756 
    757 #ifdef _KERNEL
    758 /*
    759  * Global variables used to communicate CPU type, and parameters
    760  * such as cache size, from locore to higher-level code (e.g., pmap).
    761  */
    762 void mips_pagecopy(register_t dst, register_t src);
    763 void mips_pagezero(register_t dst);
    764 
    765 #ifdef __HAVE_MIPS_MACHDEP_CACHE_CONFIG
    766 void mips_machdep_cache_config(void);
    767 #endif
    768 
    769 /*
    770  * trapframe argument passed to trap()
    771  */
    772 
    773 #if 0
    774 #define TF_AST		0		/* really zero */
    775 #define TF_V0		_R_V0
    776 #define TF_V1		_R_V1
    777 #define TF_A0		_R_A0
    778 #define TF_A1		_R_A1
    779 #define TF_A2		_R_A2
    780 #define TF_A3		_R_A3
    781 #define TF_T0		_R_T0
    782 #define TF_T1		_R_T1
    783 #define TF_T2		_R_T2
    784 #define TF_T3		_R_T3
    785 
    786 #if defined(__mips_n32) || defined(__mips_n64)
    787 #define TF_A4		_R_A4
    788 #define TF_A5		_R_A5
    789 #define TF_A6		_R_A6
    790 #define TF_A7		_R_A7
    791 #else
    792 #define TF_T4		_R_T4
    793 #define TF_T5		_R_T5
    794 #define TF_T6		_R_T6
    795 #define TF_T7		_R_T7
    796 #endif /* __mips_n32 || __mips_n64 */
    797 
    798 #define TF_TA0		_R_TA0
    799 #define TF_TA1		_R_TA1
    800 #define TF_TA2		_R_TA2
    801 #define TF_TA3		_R_TA3
    802 
    803 #define TF_T8		_R_T8
    804 #define TF_T9		_R_T9
    805 
    806 #define TF_RA		_R_RA
    807 #define TF_SR		_R_SR
    808 #define TF_MULLO	_R_MULLO
    809 #define TF_MULHI	_R_MULLO
    810 #define TF_EPC		_R_PC		/* may be changed by trap() call */
    811 
    812 #define	TF_NREGS	(sizeof(struct reg) / sizeof(mips_reg_t))
    813 #endif
    814 
    815 struct trapframe {
    816 	struct reg tf_registers;
    817 #define	tf_regs	tf_registers.r_regs
    818 	uint32_t   tf_ppl;		/* previous priority level */
    819 	mips_reg_t tf_pad;		/* for 8 byte aligned */
    820 };
    821 
    822 CTASSERT(sizeof(struct trapframe) % (4*sizeof(mips_reg_t)) == 0);
    823 
    824 /*
    825  * Stack frame for kernel traps. four args passed in registers.
    826  * A trapframe is pointed to by the 5th arg, and a dummy sixth argument
    827  * is used to avoid alignment problems
    828  */
    829 
    830 struct kernframe {
    831 #if defined(__mips_o32) || defined(__mips_o64)
    832 	register_t cf_args[4 + 1];
    833 #if defined(__mips_o32)
    834 	register_t cf_pad;		/* (for 8 byte alignment) */
    835 #endif
    836 #endif
    837 #if defined(__mips_n32) || defined(__mips_n64)
    838 	register_t cf_pad[2];		/* for 16 byte alignment */
    839 #endif
    840 	register_t cf_sp;
    841 	register_t cf_ra;
    842 	struct trapframe cf_frame;
    843 };
    844 
    845 CTASSERT(sizeof(struct kernframe) % (2*sizeof(mips_reg_t)) == 0);
    846 
    847 /*
    848  * PRocessor IDentity TABle
    849  */
    850 
    851 struct pridtab {
    852 	int	cpu_cid;
    853 	int	cpu_pid;
    854 	int	cpu_rev;	/* -1 == wildcard */
    855 	int	cpu_copts;	/* -1 == wildcard */
    856 	int	cpu_isa;	/* -1 == probed (mips32/mips64) */
    857 	int	cpu_ntlb;	/* -1 == unknown, 0 == probed */
    858 	int	cpu_flags;
    859 	u_int	cpu_cp0flags;	/* presence of some cp0 regs */
    860 	u_int	cpu_cidflags;	/* company-specific flags */
    861 	const char	*cpu_name;
    862 };
    863 
    864 /*
    865  * bitfield defines for cpu_cp0flags
    866  */
    867 #define  MIPS_CP0FL_USE		__BIT(0)	/* use these flags */
    868 #define  MIPS_CP0FL_ECC		__BIT(1)
    869 #define  MIPS_CP0FL_CACHE_ERR	__BIT(2)
    870 #define  MIPS_CP0FL_EIRR	__BIT(3)
    871 #define  MIPS_CP0FL_EIMR	__BIT(4)
    872 #define  MIPS_CP0FL_EBASE	__BIT(5)  /* XXX probeable - shouldn't be hard coded */
    873 #define  MIPS_CP0FL_CONFIG	__BIT(6)  /* XXX defined - doesn't need to be hard coded */
    874 #define  MIPS_CP0FL_CONFIG1	__BIT(7)  /* XXX probeable - shouldn't be hard coded */
    875 #define  MIPS_CP0FL_CONFIG2	__BIT(8)  /* XXX probeable - shouldn't be hard coded */
    876 #define  MIPS_CP0FL_CONFIG3	__BIT(9)  /* XXX probeable - shouldn't be hard coded */
    877 #define  MIPS_CP0FL_CONFIG4	__BIT(10) /* XXX probeable - shouldn't be hard coded */
    878 #define  MIPS_CP0FL_CONFIG5	__BIT(11) /* XXX probeable - shouldn't be hard coded */
    879 #define  MIPS_CP0FL_CONFIG6	__BIT(12) /* XXX probeable - shouldn't be hard coded */
    880 #define  MIPS_CP0FL_CONFIG7	__BIT(13) /* XXX probeable - shouldn't be hard coded */
    881 
    882 /*
    883  * cpu_cidflags defines, by company
    884  */
    885 /*
    886  * RMI company-specific cpu_cidflags
    887  */
    888 #define MIPS_CIDFL_RMI_TYPE		__BITS(2,0)
    889 # define  CIDFL_RMI_TYPE_XLR		0
    890 # define  CIDFL_RMI_TYPE_XLS		1
    891 # define  CIDFL_RMI_TYPE_XLP		2
    892 #define MIPS_CIDFL_RMI_THREADS_MASK	__BITS(6,3)
    893 # define MIPS_CIDFL_RMI_THREADS_SHIFT	3
    894 #define MIPS_CIDFL_RMI_CORES_MASK	__BITS(10,7)
    895 # define MIPS_CIDFL_RMI_CORES_SHIFT	7
    896 # define LOG2_1	0
    897 # define LOG2_2	1
    898 # define LOG2_4	2
    899 # define LOG2_8	3
    900 # define MIPS_CIDFL_RMI_CPUS(ncores, nthreads)				\
    901 		((LOG2_ ## ncores << MIPS_CIDFL_RMI_CORES_SHIFT)	\
    902 		|(LOG2_ ## nthreads << MIPS_CIDFL_RMI_THREADS_SHIFT))
    903 # define MIPS_CIDFL_RMI_NTHREADS(cidfl)					\
    904 		(1 << (((cidfl) & MIPS_CIDFL_RMI_THREADS_MASK)		\
    905 			>> MIPS_CIDFL_RMI_THREADS_SHIFT))
    906 # define MIPS_CIDFL_RMI_NCORES(cidfl)					\
    907 		(1 << (((cidfl) & MIPS_CIDFL_RMI_CORES_MASK)		\
    908 			>> MIPS_CIDFL_RMI_CORES_SHIFT))
    909 #define MIPS_CIDFL_RMI_L2SZ_MASK	__BITS(14,11)
    910 # define MIPS_CIDFL_RMI_L2SZ_SHIFT	11
    911 # define RMI_L2SZ_256KB	 0
    912 # define RMI_L2SZ_512KB  1
    913 # define RMI_L2SZ_1MB    2
    914 # define RMI_L2SZ_2MB    3
    915 # define RMI_L2SZ_4MB    4
    916 # define MIPS_CIDFL_RMI_L2(l2sz)					\
    917 		(RMI_L2SZ_ ## l2sz << MIPS_CIDFL_RMI_L2SZ_SHIFT)
    918 # define MIPS_CIDFL_RMI_L2SZ(cidfl)					\
    919 		((256*1024) << (((cidfl) & MIPS_CIDFL_RMI_L2SZ_MASK)	\
    920 			>> MIPS_CIDFL_RMI_L2SZ_SHIFT))
    921 #endif /* !__ASSEMBLER__ */
    922 #endif	/* _KERNEL */
    923 
    924 #endif	/* _MIPS_LOCORE_H */
    925