1 /* $NetBSD: cpufunc.h,v 1.29 2003/09/06 09:08:35 rearnsha Exp $ */ 2 3 /*- 4 * Copyright (c) 1997 Mark Brinicombe. 5 * Copyright (c) 1997 Causality Limited 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by Causality Limited. 19 * 4. The name of Causality Limited may not be used to endorse or promote 20 * products derived from this software without specific prior written 21 * permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY CAUSALITY LIMITED ``AS IS'' AND ANY EXPRESS 24 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 26 * DISCLAIMED. IN NO EVENT SHALL CAUSALITY LIMITED BE LIABLE FOR ANY DIRECT, 27 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 29 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 33 * SUCH DAMAGE. 34 * 35 * RiscBSD kernel project 36 * 37 * cpufunc.h 38 * 39 * Prototypes for cpu, mmu and tlb related functions. 40 * 41 * $FreeBSD$ 42 */ 43 44 #ifndef _MACHINE_CPUFUNC_H_ 45 #define _MACHINE_CPUFUNC_H_ 46 47 #ifdef _KERNEL 48 49 #include <sys/types.h> 50 #include <machine/armreg.h> 51 #include <machine/cpuconf.h> 52 53 static __inline void 54 breakpoint(void) 55 { 56 __asm(".word 0xe7ffffff"); 57 } 58 59 struct cpu_functions { 60 61 /* CPU functions */ 62 #if __ARM_ARCH < 6 63 void (*cf_cpwait) (void); 64 65 /* MMU functions */ 66 67 u_int (*cf_control) (u_int bic, u_int eor); 68 void (*cf_setttb) (u_int ttb); 69 70 /* TLB functions */ 71 72 void (*cf_tlb_flushID) (void); 73 void (*cf_tlb_flushID_SE) (u_int va); 74 void (*cf_tlb_flushD) (void); 75 void (*cf_tlb_flushD_SE) (u_int va); 76 77 /* 78 * Cache operations: 79 * 80 * We define the following primitives: 81 * 82 * icache_sync_range Synchronize I-cache range 83 * 84 * dcache_wbinv_all Write-back and Invalidate D-cache 85 * dcache_wbinv_range Write-back and Invalidate D-cache range 86 * dcache_inv_range Invalidate D-cache range 87 * dcache_wb_range Write-back D-cache range 88 * 89 * idcache_wbinv_all Write-back and Invalidate D-cache, 90 * Invalidate I-cache 91 * idcache_wbinv_range Write-back and Invalidate D-cache, 92 * Invalidate I-cache range 93 * 94 * Note that the ARM term for "write-back" is "clean". We use 95 * the term "write-back" since it's a more common way to describe 96 * the operation. 97 * 98 * There are some rules that must be followed: 99 * 100 * ID-cache Invalidate All: 101 * Unlike other functions, this one must never write back. 102 * It is used to intialize the MMU when it is in an unknown 103 * state (such as when it may have lines tagged as valid 104 * that belong to a previous set of mappings). 105 * 106 * I-cache Sync range: 107 * The goal is to synchronize the instruction stream, 108 * so you may beed to write-back dirty D-cache blocks 109 * first. If a range is requested, and you can't 110 * synchronize just a range, you have to hit the whole 111 * thing. 112 * 113 * D-cache Write-Back and Invalidate range: 114 * If you can't WB-Inv a range, you must WB-Inv the 115 * entire D-cache. 116 * 117 * D-cache Invalidate: 118 * If you can't Inv the D-cache, you must Write-Back 119 * and Invalidate. Code that uses this operation 120 * MUST NOT assume that the D-cache will not be written 121 * back to memory. 122 * 123 * D-cache Write-Back: 124 * If you can't Write-back without doing an Inv, 125 * that's fine. Then treat this as a WB-Inv. 126 * Skipping the invalidate is merely an optimization. 127 * 128 * All operations: 129 * Valid virtual addresses must be passed to each 130 * cache operation. 131 */ 132 void (*cf_icache_sync_range) (vm_offset_t, vm_size_t); 133 134 void (*cf_dcache_wbinv_all) (void); 135 void (*cf_dcache_wbinv_range) (vm_offset_t, vm_size_t); 136 void (*cf_dcache_inv_range) (vm_offset_t, vm_size_t); 137 void (*cf_dcache_wb_range) (vm_offset_t, vm_size_t); 138 139 void (*cf_idcache_inv_all) (void); 140 void (*cf_idcache_wbinv_all) (void); 141 void (*cf_idcache_wbinv_range) (vm_offset_t, vm_size_t); 142 #endif 143 void (*cf_l2cache_wbinv_all) (void); 144 void (*cf_l2cache_wbinv_range) (vm_offset_t, vm_size_t); 145 void (*cf_l2cache_inv_range) (vm_offset_t, vm_size_t); 146 void (*cf_l2cache_wb_range) (vm_offset_t, vm_size_t); 147 void (*cf_l2cache_drain_writebuf) (void); 148 149 /* Other functions */ 150 151 #if __ARM_ARCH < 6 152 void (*cf_drain_writebuf) (void); 153 #endif 154 155 void (*cf_sleep) (int mode); 156 157 #if __ARM_ARCH < 6 158 /* Soft functions */ 159 160 void (*cf_context_switch) (void); 161 #endif 162 163 void (*cf_setup) (void); 164 }; 165 166 extern struct cpu_functions cpufuncs; 167 extern u_int cputype; 168 169 #if __ARM_ARCH < 6 170 #define cpu_cpwait() cpufuncs.cf_cpwait() 171 172 #define cpu_control(c, e) cpufuncs.cf_control(c, e) 173 #define cpu_setttb(t) cpufuncs.cf_setttb(t) 174 175 #define cpu_tlb_flushID() cpufuncs.cf_tlb_flushID() 176 #define cpu_tlb_flushID_SE(e) cpufuncs.cf_tlb_flushID_SE(e) 177 #define cpu_tlb_flushD() cpufuncs.cf_tlb_flushD() 178 #define cpu_tlb_flushD_SE(e) cpufuncs.cf_tlb_flushD_SE(e) 179 180 #define cpu_icache_sync_range(a, s) cpufuncs.cf_icache_sync_range((a), (s)) 181 182 #define cpu_dcache_wbinv_all() cpufuncs.cf_dcache_wbinv_all() 183 #define cpu_dcache_wbinv_range(a, s) cpufuncs.cf_dcache_wbinv_range((a), (s)) 184 #define cpu_dcache_inv_range(a, s) cpufuncs.cf_dcache_inv_range((a), (s)) 185 #define cpu_dcache_wb_range(a, s) cpufuncs.cf_dcache_wb_range((a), (s)) 186 187 #define cpu_idcache_inv_all() cpufuncs.cf_idcache_inv_all() 188 #define cpu_idcache_wbinv_all() cpufuncs.cf_idcache_wbinv_all() 189 #define cpu_idcache_wbinv_range(a, s) cpufuncs.cf_idcache_wbinv_range((a), (s)) 190 #endif 191 192 #define cpu_l2cache_wbinv_all() cpufuncs.cf_l2cache_wbinv_all() 193 #define cpu_l2cache_wb_range(a, s) cpufuncs.cf_l2cache_wb_range((a), (s)) 194 #define cpu_l2cache_inv_range(a, s) cpufuncs.cf_l2cache_inv_range((a), (s)) 195 #define cpu_l2cache_wbinv_range(a, s) cpufuncs.cf_l2cache_wbinv_range((a), (s)) 196 #define cpu_l2cache_drain_writebuf() cpufuncs.cf_l2cache_drain_writebuf() 197 198 #if __ARM_ARCH < 6 199 #define cpu_drain_writebuf() cpufuncs.cf_drain_writebuf() 200 #endif 201 #define cpu_sleep(m) cpufuncs.cf_sleep(m) 202 203 #define cpu_setup() cpufuncs.cf_setup() 204 205 int set_cpufuncs (void); 206 #define ARCHITECTURE_NOT_PRESENT 1 /* known but not configured */ 207 #define ARCHITECTURE_NOT_SUPPORTED 2 /* not known */ 208 209 void cpufunc_nullop (void); 210 u_int cpu_ident (void); 211 u_int cpufunc_control (u_int clear, u_int bic); 212 void cpu_domains (u_int domains); 213 u_int cpu_faultstatus (void); 214 u_int cpu_faultaddress (void); 215 u_int cpu_get_control (void); 216 u_int cpu_pfr (int); 217 218 #if defined(CPU_FA526) 219 void fa526_setup (void); 220 void fa526_setttb (u_int ttb); 221 void fa526_context_switch (void); 222 void fa526_cpu_sleep (int); 223 void fa526_tlb_flushID_SE (u_int); 224 225 void fa526_icache_sync_range(vm_offset_t start, vm_size_t end); 226 void fa526_dcache_wbinv_all (void); 227 void fa526_dcache_wbinv_range(vm_offset_t start, vm_size_t end); 228 void fa526_dcache_inv_range (vm_offset_t start, vm_size_t end); 229 void fa526_dcache_wb_range (vm_offset_t start, vm_size_t end); 230 void fa526_idcache_wbinv_all(void); 231 void fa526_idcache_wbinv_range(vm_offset_t start, vm_size_t end); 232 #endif 233 234 235 #if defined(CPU_ARM9) || defined(CPU_ARM9E) 236 void arm9_setttb (u_int); 237 void arm9_tlb_flushID_SE (u_int va); 238 void arm9_context_switch (void); 239 #endif 240 241 #if defined(CPU_ARM9) 242 void arm9_icache_sync_range (vm_offset_t, vm_size_t); 243 244 void arm9_dcache_wbinv_all (void); 245 void arm9_dcache_wbinv_range (vm_offset_t, vm_size_t); 246 void arm9_dcache_inv_range (vm_offset_t, vm_size_t); 247 void arm9_dcache_wb_range (vm_offset_t, vm_size_t); 248 249 void arm9_idcache_wbinv_all (void); 250 void arm9_idcache_wbinv_range (vm_offset_t, vm_size_t); 251 252 void arm9_setup (void); 253 254 extern unsigned arm9_dcache_sets_max; 255 extern unsigned arm9_dcache_sets_inc; 256 extern unsigned arm9_dcache_index_max; 257 extern unsigned arm9_dcache_index_inc; 258 #endif 259 260 #if defined(CPU_ARM9E) 261 void arm10_setup (void); 262 263 u_int sheeva_control_ext (u_int, u_int); 264 void sheeva_cpu_sleep (int); 265 void sheeva_setttb (u_int); 266 void sheeva_dcache_wbinv_range (vm_offset_t, vm_size_t); 267 void sheeva_dcache_inv_range (vm_offset_t, vm_size_t); 268 void sheeva_dcache_wb_range (vm_offset_t, vm_size_t); 269 void sheeva_idcache_wbinv_range (vm_offset_t, vm_size_t); 270 271 void sheeva_l2cache_wbinv_range (vm_offset_t, vm_size_t); 272 void sheeva_l2cache_inv_range (vm_offset_t, vm_size_t); 273 void sheeva_l2cache_wb_range (vm_offset_t, vm_size_t); 274 void sheeva_l2cache_wbinv_all (void); 275 #endif 276 277 #if defined(CPU_MV_PJ4B) 278 void armv6_idcache_wbinv_all (void); 279 #endif 280 #if defined(CPU_CORTEXA8) || defined(CPU_CORTEXA_MP) || \ 281 defined(CPU_MV_PJ4B) || defined(CPU_KRAIT) 282 void armv7_setttb (u_int); 283 void armv7_idcache_wbinv_all (void); 284 void armv7_cpu_sleep (int); 285 void armv7_setup (void); 286 void armv7_drain_writebuf (void); 287 288 void armadaxp_idcache_wbinv_all (void); 289 290 void cortexa_setup (void); 291 #endif 292 #if defined(CPU_MV_PJ4B) 293 void pj4b_config (void); 294 void pj4bv7_setup (void); 295 #endif 296 297 #if defined(CPU_ARM1176) 298 void arm11_drain_writebuf (void); 299 300 void arm11x6_setttb (u_int); 301 void arm11x6_setup (void); 302 void arm11x6_sleep (int); /* no ref. for errata */ 303 #endif 304 305 #if defined(CPU_ARM9E) 306 void armv5_ec_setttb(u_int); 307 308 void armv5_ec_icache_sync_range(vm_offset_t, vm_size_t); 309 310 void armv5_ec_dcache_wbinv_all(void); 311 void armv5_ec_dcache_wbinv_range(vm_offset_t, vm_size_t); 312 void armv5_ec_dcache_inv_range(vm_offset_t, vm_size_t); 313 void armv5_ec_dcache_wb_range(vm_offset_t, vm_size_t); 314 315 void armv5_ec_idcache_wbinv_all(void); 316 void armv5_ec_idcache_wbinv_range(vm_offset_t, vm_size_t); 317 #endif 318 319 #if defined(CPU_ARM9) || defined(CPU_ARM9E) || \ 320 defined(CPU_FA526) || \ 321 defined(CPU_XSCALE_PXA2X0) || defined(CPU_XSCALE_IXP425) || \ 322 defined(CPU_XSCALE_81342) 323 324 void armv4_tlb_flushID (void); 325 void armv4_tlb_flushD (void); 326 void armv4_tlb_flushD_SE (u_int va); 327 328 void armv4_drain_writebuf (void); 329 void armv4_idcache_inv_all (void); 330 #endif 331 332 #if defined(CPU_XSCALE_PXA2X0) || defined(CPU_XSCALE_IXP425) || \ 333 defined(CPU_XSCALE_81342) 334 void xscale_cpwait (void); 335 336 void xscale_cpu_sleep (int mode); 337 338 u_int xscale_control (u_int clear, u_int bic); 339 340 void xscale_setttb (u_int ttb); 341 342 void xscale_tlb_flushID_SE (u_int va); 343 344 void xscale_cache_flushID (void); 345 void xscale_cache_flushI (void); 346 void xscale_cache_flushD (void); 347 void xscale_cache_flushD_SE (u_int entry); 348 349 void xscale_cache_cleanID (void); 350 void xscale_cache_cleanD (void); 351 void xscale_cache_cleanD_E (u_int entry); 352 353 void xscale_cache_clean_minidata (void); 354 355 void xscale_cache_purgeID (void); 356 void xscale_cache_purgeID_E (u_int entry); 357 void xscale_cache_purgeD (void); 358 void xscale_cache_purgeD_E (u_int entry); 359 360 void xscale_cache_syncI (void); 361 void xscale_cache_cleanID_rng (vm_offset_t start, vm_size_t end); 362 void xscale_cache_cleanD_rng (vm_offset_t start, vm_size_t end); 363 void xscale_cache_purgeID_rng (vm_offset_t start, vm_size_t end); 364 void xscale_cache_purgeD_rng (vm_offset_t start, vm_size_t end); 365 void xscale_cache_syncI_rng (vm_offset_t start, vm_size_t end); 366 void xscale_cache_flushD_rng (vm_offset_t start, vm_size_t end); 367 368 void xscale_context_switch (void); 369 370 void xscale_setup (void); 371 #endif /* CPU_XSCALE_PXA2X0 || CPU_XSCALE_IXP425 */ 372 373 #ifdef CPU_XSCALE_81342 374 375 void xscalec3_l2cache_purge (void); 376 void xscalec3_cache_purgeID (void); 377 void xscalec3_cache_purgeD (void); 378 void xscalec3_cache_cleanID (void); 379 void xscalec3_cache_cleanD (void); 380 void xscalec3_cache_syncI (void); 381 382 void xscalec3_cache_purgeID_rng (vm_offset_t start, vm_size_t end); 383 void xscalec3_cache_purgeD_rng (vm_offset_t start, vm_size_t end); 384 void xscalec3_cache_cleanID_rng (vm_offset_t start, vm_size_t end); 385 void xscalec3_cache_cleanD_rng (vm_offset_t start, vm_size_t end); 386 void xscalec3_cache_syncI_rng (vm_offset_t start, vm_size_t end); 387 388 void xscalec3_l2cache_flush_rng (vm_offset_t, vm_size_t); 389 void xscalec3_l2cache_clean_rng (vm_offset_t start, vm_size_t end); 390 void xscalec3_l2cache_purge_rng (vm_offset_t start, vm_size_t end); 391 392 393 void xscalec3_setttb (u_int ttb); 394 void xscalec3_context_switch (void); 395 396 #endif /* CPU_XSCALE_81342 */ 397 398 /* 399 * Macros for manipulating CPU interrupts 400 */ 401 #if __ARM_ARCH < 6 402 #define __ARM_INTR_BITS (PSR_I | PSR_F) 403 #else 404 #define __ARM_INTR_BITS (PSR_I | PSR_F | PSR_A) 405 #endif 406 407 static __inline uint32_t 408 __set_cpsr(uint32_t bic, uint32_t eor) 409 { 410 uint32_t tmp, ret; 411 412 __asm __volatile( 413 "mrs %0, cpsr\n" /* Get the CPSR */ 414 "bic %1, %0, %2\n" /* Clear bits */ 415 "eor %1, %1, %3\n" /* XOR bits */ 416 "msr cpsr_xc, %1\n" /* Set the CPSR */ 417 : "=&r" (ret), "=&r" (tmp) 418 : "r" (bic), "r" (eor) : "memory"); 419 420 return ret; 421 } 422 423 static __inline uint32_t 424 disable_interrupts(uint32_t mask) 425 { 426 427 return (__set_cpsr(mask & __ARM_INTR_BITS, mask & __ARM_INTR_BITS)); 428 } 429 430 static __inline uint32_t 431 enable_interrupts(uint32_t mask) 432 { 433 434 return (__set_cpsr(mask & __ARM_INTR_BITS, 0)); 435 } 436 437 static __inline uint32_t 438 restore_interrupts(uint32_t old_cpsr) 439 { 440 441 return (__set_cpsr(__ARM_INTR_BITS, old_cpsr & __ARM_INTR_BITS)); 442 } 443 444 static __inline register_t 445 intr_disable(void) 446 { 447 448 return (disable_interrupts(PSR_I | PSR_F)); 449 } 450 451 static __inline void 452 intr_restore(register_t s) 453 { 454 455 restore_interrupts(s); 456 } 457 #undef __ARM_INTR_BITS 458 459 /* 460 * Functions to manipulate cpu r13 461 * (in arm/arm32/setstack.S) 462 */ 463 464 void set_stackptr (u_int mode, u_int address); 465 u_int get_stackptr (u_int mode); 466 467 /* 468 * Miscellany 469 */ 470 471 int get_pc_str_offset (void); 472 473 /* 474 * CPU functions from locore.S 475 */ 476 477 void cpu_reset (void) __attribute__((__noreturn__)); 478 479 /* 480 * Cache info variables. 481 */ 482 483 /* PRIMARY CACHE VARIABLES */ 484 extern int arm_picache_size; 485 extern int arm_picache_line_size; 486 extern int arm_picache_ways; 487 488 extern int arm_pdcache_size; /* and unified */ 489 extern int arm_pdcache_line_size; 490 extern int arm_pdcache_ways; 491 492 extern int arm_pcache_type; 493 extern int arm_pcache_unified; 494 495 extern int arm_dcache_align; 496 extern int arm_dcache_align_mask; 497 498 extern u_int arm_cache_level; 499 extern u_int arm_cache_loc; 500 extern u_int arm_cache_type[14]; 501 502 #endif /* _KERNEL */ 503 #endif /* _MACHINE_CPUFUNC_H_ */ 504 505 /* End of cpufunc.h */ 506