1 /* $NetBSD: armreg.h,v 1.38 2008/04/27 18:58:44 matt Exp $ */ 2 3 /* 4 * Copyright (c) 1998, 2001 Ben Harris 5 * Copyright (c) 1994-1996 Mark Brinicombe. 6 * Copyright (c) 1994 Brini. 7 * All rights reserved. 8 * 9 * This code is derived from software written for Brini by Mark Brinicombe 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. All advertising materials mentioning features or use of this software 20 * must display the following acknowledgement: 21 * This product includes software developed by Brini. 22 * 4. The name of the company nor the name of the author may be used to 23 * endorse or promote products derived from this software without specific 24 * prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY BRINI ``AS IS'' AND ANY EXPRESS OR IMPLIED 27 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 28 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 29 * IN NO EVENT SHALL BRINI OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 30 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 31 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 32 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 36 * SUCH DAMAGE. 37 */ 38 39 #ifndef _ARM_ARMREG_H 40 #define _ARM_ARMREG_H 41 42 /* 43 * ARM Process Status Register 44 * 45 * The picture in the ARM manuals looks like this: 46 * 3 3 2 2 2 2 47 * 1 0 9 8 7 6 8 7 6 5 4 0 48 * +-+-+-+-+-+-------------------------------------+-+-+-+---------+ 49 * |N|Z|C|V|Q| reserved |I|F|T|M M M M M| 50 * | | | | | | | | | |4 3 2 1 0| 51 * +-+-+-+-+-+-------------------------------------+-+-+-+---------+ 52 */ 53 54 #define PSR_FLAGS 0xf0000000 /* flags */ 55 #define PSR_N_bit (1 << 31) /* negative */ 56 #define PSR_Z_bit (1 << 30) /* zero */ 57 #define PSR_C_bit (1 << 29) /* carry */ 58 #define PSR_V_bit (1 << 28) /* overflow */ 59 60 #define PSR_Q_bit (1 << 27) /* saturation */ 61 62 #define I32_bit (1 << 7) /* IRQ disable */ 63 #define F32_bit (1 << 6) /* FIQ disable */ 64 65 #define PSR_T_bit (1 << 5) /* Thumb state */ 66 #define PSR_J_bit (1 << 24) /* Java mode */ 67 68 #define PSR_MODE 0x0000001f /* mode mask */ 69 #define PSR_USR26_MODE 0x00000000 70 #define PSR_FIQ26_MODE 0x00000001 71 #define PSR_IRQ26_MODE 0x00000002 72 #define PSR_SVC26_MODE 0x00000003 73 #define PSR_USR32_MODE 0x00000010 74 #define PSR_FIQ32_MODE 0x00000011 75 #define PSR_IRQ32_MODE 0x00000012 76 #define PSR_SVC32_MODE 0x00000013 77 #define PSR_ABT32_MODE 0x00000017 78 #define PSR_UND32_MODE 0x0000001b 79 #define PSR_SYS32_MODE 0x0000001f 80 #define PSR_32_MODE 0x00000010 81 82 #define PSR_IN_USR_MODE(psr) (!((psr) & 3)) /* XXX */ 83 #define PSR_IN_32_MODE(psr) ((psr) & PSR_32_MODE) 84 85 /* In 26-bit modes, the PSR is stuffed into R15 along with the PC. */ 86 87 #define R15_MODE 0x00000003 88 #define R15_MODE_USR 0x00000000 89 #define R15_MODE_FIQ 0x00000001 90 #define R15_MODE_IRQ 0x00000002 91 #define R15_MODE_SVC 0x00000003 92 93 #define R15_PC 0x03fffffc 94 95 #define R15_FIQ_DISABLE 0x04000000 96 #define R15_IRQ_DISABLE 0x08000000 97 98 #define R15_FLAGS 0xf0000000 99 #define R15_FLAG_N 0x80000000 100 #define R15_FLAG_Z 0x40000000 101 #define R15_FLAG_C 0x20000000 102 #define R15_FLAG_V 0x10000000 103 104 /* 105 * Co-processor 15: The system control co-processor. 106 */ 107 108 #define ARM_CP15_CPU_ID 0 109 110 /* 111 * The CPU ID register is theoretically structured, but the definitions of 112 * the fields keep changing. 113 */ 114 115 /* The high-order byte is always the implementor */ 116 #define CPU_ID_IMPLEMENTOR_MASK 0xff000000 117 #define CPU_ID_ARM_LTD 0x41000000 /* 'A' */ 118 #define CPU_ID_DEC 0x44000000 /* 'D' */ 119 #define CPU_ID_INTEL 0x69000000 /* 'i' */ 120 #define CPU_ID_TI 0x54000000 /* 'T' */ 121 #define CPU_ID_FARADAY 0x66000000 /* 'f' */ 122 123 /* How to decide what format the CPUID is in. */ 124 #define CPU_ID_ISOLD(x) (((x) & 0x0000f000) == 0x00000000) 125 #define CPU_ID_IS7(x) (((x) & 0x0000f000) == 0x00007000) 126 #define CPU_ID_ISNEW(x) (!CPU_ID_ISOLD(x) && !CPU_ID_IS7(x)) 127 128 /* On ARM3 and ARM6, this byte holds the foundry ID. */ 129 #define CPU_ID_FOUNDRY_MASK 0x00ff0000 130 #define CPU_ID_FOUNDRY_VLSI 0x00560000 131 132 /* On ARM7 it holds the architecture and variant (sub-model) */ 133 #define CPU_ID_7ARCH_MASK 0x00800000 134 #define CPU_ID_7ARCH_V3 0x00000000 135 #define CPU_ID_7ARCH_V4T 0x00800000 136 #define CPU_ID_7VARIANT_MASK 0x007f0000 137 138 /* On more recent ARMs, it does the same, but in a different format */ 139 #define CPU_ID_ARCH_MASK 0x000f0000 140 #define CPU_ID_ARCH_V3 0x00000000 141 #define CPU_ID_ARCH_V4 0x00010000 142 #define CPU_ID_ARCH_V4T 0x00020000 143 #define CPU_ID_ARCH_V5 0x00030000 144 #define CPU_ID_ARCH_V5T 0x00040000 145 #define CPU_ID_ARCH_V5TE 0x00050000 146 #define CPU_ID_ARCH_V5TEJ 0x00060000 147 #define CPU_ID_ARCH_V6 0x00070000 148 #define CPU_ID_VARIANT_MASK 0x00f00000 149 150 /* Next three nybbles are part number */ 151 #define CPU_ID_PARTNO_MASK 0x0000fff0 152 153 /* Intel XScale has sub fields in part number */ 154 #define CPU_ID_XSCALE_COREGEN_MASK 0x0000e000 /* core generation */ 155 #define CPU_ID_XSCALE_COREREV_MASK 0x00001c00 /* core revision */ 156 #define CPU_ID_XSCALE_PRODUCT_MASK 0x000003f0 /* product number */ 157 158 /* And finally, the revision number. */ 159 #define CPU_ID_REVISION_MASK 0x0000000f 160 161 /* Individual CPUs are probably best IDed by everything but the revision. */ 162 #define CPU_ID_CPU_MASK 0xfffffff0 163 164 /* Fake CPU IDs for ARMs without CP15 */ 165 #define CPU_ID_ARM2 0x41560200 166 #define CPU_ID_ARM250 0x41560250 167 168 /* Pre-ARM7 CPUs -- [15:12] == 0 */ 169 #define CPU_ID_ARM3 0x41560300 170 #define CPU_ID_ARM600 0x41560600 171 #define CPU_ID_ARM610 0x41560610 172 #define CPU_ID_ARM620 0x41560620 173 174 /* ARM7 CPUs -- [15:12] == 7 */ 175 #define CPU_ID_ARM700 0x41007000 /* XXX This is a guess. */ 176 #define CPU_ID_ARM710 0x41007100 177 #define CPU_ID_ARM7500 0x41027100 178 #define CPU_ID_ARM710A 0x41047100 /* inc ARM7100 */ 179 #define CPU_ID_ARM7500FE 0x41077100 180 #define CPU_ID_ARM710T 0x41807100 181 #define CPU_ID_ARM720T 0x41807200 182 #define CPU_ID_ARM740T8K 0x41807400 /* XXX no MMU, 8KB cache */ 183 #define CPU_ID_ARM740T4K 0x41817400 /* XXX no MMU, 4KB cache */ 184 185 /* Post-ARM7 CPUs */ 186 #define CPU_ID_ARM810 0x41018100 187 #define CPU_ID_ARM920T 0x41129200 188 #define CPU_ID_ARM922T 0x41029220 189 #define CPU_ID_ARM926EJS 0x41069260 190 #define CPU_ID_ARM940T 0x41029400 /* XXX no MMU */ 191 #define CPU_ID_ARM946ES 0x41049460 /* XXX no MMU */ 192 #define CPU_ID_ARM966ES 0x41049660 /* XXX no MMU */ 193 #define CPU_ID_ARM966ESR1 0x41059660 /* XXX no MMU */ 194 #define CPU_ID_ARM1020E 0x4115a200 /* (AKA arm10 rev 1) */ 195 #define CPU_ID_ARM1022ES 0x4105a220 196 #define CPU_ID_ARM1026EJS 0x4106a260 197 #define CPU_ID_ARM1136JS 0x4107b360 198 #define CPU_ID_ARM1136JSR1 0x4117b360 199 #define CPU_ID_ARM1176JS 0x410fb760 200 #define CPU_ID_CORTEXA8R1 0x411fc080 201 #define CPU_ID_CORTEXA8R2 0x412fc080 202 #define CPU_ID_SA110 0x4401a100 203 #define CPU_ID_SA1100 0x4401a110 204 #define CPU_ID_TI925T 0x54029250 205 #define CPU_ID_FA526 0x66015260 206 #define CPU_ID_SA1110 0x6901b110 207 #define CPU_ID_IXP1200 0x6901c120 208 #define CPU_ID_80200 0x69052000 209 #define CPU_ID_PXA250 0x69052100 /* sans core revision */ 210 #define CPU_ID_PXA210 0x69052120 211 #define CPU_ID_PXA250A 0x69052100 /* 1st version Core */ 212 #define CPU_ID_PXA210A 0x69052120 /* 1st version Core */ 213 #define CPU_ID_PXA250B 0x69052900 /* 3rd version Core */ 214 #define CPU_ID_PXA210B 0x69052920 /* 3rd version Core */ 215 #define CPU_ID_PXA250C 0x69052d00 /* 4th version Core */ 216 #define CPU_ID_PXA210C 0x69052d20 /* 4th version Core */ 217 #define CPU_ID_PXA27X 0x69054110 218 #define CPU_ID_80321_400 0x69052420 219 #define CPU_ID_80321_600 0x69052430 220 #define CPU_ID_80321_400_B0 0x69052c20 221 #define CPU_ID_80321_600_B0 0x69052c30 222 #define CPU_ID_80219_400 0x69052e20 223 #define CPU_ID_80219_600 0x69052e30 224 #define CPU_ID_IXP425_533 0x690541c0 225 #define CPU_ID_IXP425_400 0x690541d0 226 #define CPU_ID_IXP425_266 0x690541f0 227 228 /* ARM3-specific coprocessor 15 registers */ 229 #define ARM3_CP15_FLUSH 1 230 #define ARM3_CP15_CONTROL 2 231 #define ARM3_CP15_CACHEABLE 3 232 #define ARM3_CP15_UPDATEABLE 4 233 #define ARM3_CP15_DISRUPTIVE 5 234 235 /* ARM3 Control register bits */ 236 #define ARM3_CTL_CACHE_ON 0x00000001 237 #define ARM3_CTL_SHARED 0x00000002 238 #define ARM3_CTL_MONITOR 0x00000004 239 240 /* 241 * Post-ARM3 CP15 registers: 242 * 243 * 1 Control register 244 * 245 * 2 Translation Table Base 246 * 247 * 3 Domain Access Control 248 * 249 * 4 Reserved 250 * 251 * 5 Fault Status 252 * 253 * 6 Fault Address 254 * 255 * 7 Cache/write-buffer Control 256 * 257 * 8 TLB Control 258 * 259 * 9 Cache Lockdown 260 * 261 * 10 TLB Lockdown 262 * 263 * 11 Reserved 264 * 265 * 12 Reserved 266 * 267 * 13 Process ID (for FCSE) 268 * 269 * 14 Reserved 270 * 271 * 15 Implementation Dependent 272 */ 273 274 /* Some of the definitions below need cleaning up for V3/V4 architectures */ 275 276 /* CPU control register (CP15 register 1) */ 277 #define CPU_CONTROL_MMU_ENABLE 0x00000001 /* M: MMU/Protection unit enable */ 278 #define CPU_CONTROL_AFLT_ENABLE 0x00000002 /* A: Alignment fault enable */ 279 #define CPU_CONTROL_DC_ENABLE 0x00000004 /* C: IDC/DC enable */ 280 #define CPU_CONTROL_WBUF_ENABLE 0x00000008 /* W: Write buffer enable */ 281 #define CPU_CONTROL_32BP_ENABLE 0x00000010 /* P: 32-bit exception handlers */ 282 #define CPU_CONTROL_32BD_ENABLE 0x00000020 /* D: 32-bit addressing */ 283 #define CPU_CONTROL_LABT_ENABLE 0x00000040 /* L: Late abort enable */ 284 #define CPU_CONTROL_BEND_ENABLE 0x00000080 /* B: Big-endian mode */ 285 #define CPU_CONTROL_SYST_ENABLE 0x00000100 /* S: System protection bit */ 286 #define CPU_CONTROL_ROM_ENABLE 0x00000200 /* R: ROM protection bit */ 287 #define CPU_CONTROL_CPCLK 0x00000400 /* F: Implementation defined */ 288 #define CPU_CONTROL_BPRD_ENABLE 0x00000800 /* Z: Branch prediction enable */ 289 #define CPU_CONTROL_IC_ENABLE 0x00001000 /* I: IC enable */ 290 #define CPU_CONTROL_VECRELOC 0x00002000 /* V: Vector relocation */ 291 #define CPU_CONTROL_ROUNDROBIN 0x00004000 /* RR: Predictable replacement */ 292 #define CPU_CONTROL_V4COMPAT 0x00008000 /* L4: ARMv4 compat LDR R15 etc */ 293 #define CPU_CONTROL_UNAL_ENABLE 0x00040000 /* U: unaligned data access */ 294 #define CPU_CONTROL_XP_ENABLE 0x00080000 /* XP: extended page table */ 295 296 #define CPU_CONTROL_IDC_ENABLE CPU_CONTROL_DC_ENABLE 297 298 /* XScale Auxillary Control Register (CP15 register 1, opcode2 1) */ 299 #define XSCALE_AUXCTL_K 0x00000001 /* dis. write buffer coalescing */ 300 #define XSCALE_AUXCTL_P 0x00000002 /* ECC protect page table access */ 301 #define XSCALE_AUXCTL_MD_WB_RA 0x00000000 /* mini-D$ wb, read-allocate */ 302 #define XSCALE_AUXCTL_MD_WB_RWA 0x00000010 /* mini-D$ wb, read/write-allocate */ 303 #define XSCALE_AUXCTL_MD_WT 0x00000020 /* mini-D$ wt, read-allocate */ 304 #define XSCALE_AUXCTL_MD_MASK 0x00000030 305 306 /* Cache type register definitions */ 307 #define CPU_CT_ISIZE(x) ((x) & 0xfff) /* I$ info */ 308 #define CPU_CT_DSIZE(x) (((x) >> 12) & 0xfff) /* D$ info */ 309 #define CPU_CT_S (1U << 24) /* split cache */ 310 #define CPU_CT_CTYPE(x) (((x) >> 25) & 0xf) /* cache type */ 311 312 #define CPU_CT_CTYPE_WT 0 /* write-through */ 313 #define CPU_CT_CTYPE_WB1 1 /* write-back, clean w/ read */ 314 #define CPU_CT_CTYPE_WB2 2 /* w/b, clean w/ cp15,7 */ 315 #define CPU_CT_CTYPE_WB6 6 /* w/b, cp15,7, lockdown fmt A */ 316 #define CPU_CT_CTYPE_WB7 7 /* w/b, cp15,7, lockdown fmt B */ 317 318 #define CPU_CT_xSIZE_LEN(x) ((x) & 0x3) /* line size */ 319 #define CPU_CT_xSIZE_M (1U << 2) /* multiplier */ 320 #define CPU_CT_xSIZE_ASSOC(x) (((x) >> 3) & 0x7) /* associativity */ 321 #define CPU_CT_xSIZE_SIZE(x) (((x) >> 6) & 0x7) /* size */ 322 #define CPU_CT_xSIZE_P (1U << 11) /* need to page-color */ 323 324 /* Fault status register definitions */ 325 326 #define FAULT_TYPE_MASK 0x0f 327 #define FAULT_USER 0x10 328 329 #define FAULT_WRTBUF_0 0x00 /* Vector Exception */ 330 #define FAULT_WRTBUF_1 0x02 /* Terminal Exception */ 331 #define FAULT_BUSERR_0 0x04 /* External Abort on Linefetch -- Section */ 332 #define FAULT_BUSERR_1 0x06 /* External Abort on Linefetch -- Page */ 333 #define FAULT_BUSERR_2 0x08 /* External Abort on Non-linefetch -- Section */ 334 #define FAULT_BUSERR_3 0x0a /* External Abort on Non-linefetch -- Page */ 335 #define FAULT_BUSTRNL1 0x0c /* External abort on Translation -- Level 1 */ 336 #define FAULT_BUSTRNL2 0x0e /* External abort on Translation -- Level 2 */ 337 #define FAULT_ALIGN_0 0x01 /* Alignment */ 338 #define FAULT_ALIGN_1 0x03 /* Alignment */ 339 #define FAULT_TRANS_S 0x05 /* Translation -- Section */ 340 #define FAULT_TRANS_P 0x07 /* Translation -- Page */ 341 #define FAULT_DOMAIN_S 0x09 /* Domain -- Section */ 342 #define FAULT_DOMAIN_P 0x0b /* Domain -- Page */ 343 #define FAULT_PERM_S 0x0d /* Permission -- Section */ 344 #define FAULT_PERM_P 0x0f /* Permission -- Page */ 345 346 #define FAULT_IMPRECISE 0x400 /* Imprecise exception (XSCALE) */ 347 348 /* 349 * Address of the vector page, low and high versions. 350 */ 351 #define ARM_VECTORS_LOW 0x00000000U 352 #define ARM_VECTORS_HIGH 0xffff0000U 353 354 /* 355 * ARM Instructions 356 * 357 * 3 3 2 2 2 358 * 1 0 9 8 7 0 359 * +-------+-------------------------------------------------------+ 360 * | cond | instruction dependant | 361 * |c c c c| | 362 * +-------+-------------------------------------------------------+ 363 */ 364 365 #define INSN_SIZE 4 /* Always 4 bytes */ 366 #define INSN_COND_MASK 0xf0000000 /* Condition mask */ 367 #define INSN_COND_AL 0xe0000000 /* Always condition */ 368 369 #define THUMB_INSN_SIZE 2 /* Some are 4 bytes. */ 370 371 /* 372 * Defines and such for arm11 Performance Monitor Counters (p15, c15, c12, 0) 373 */ 374 #define ARM11_PMCCTL_E __BIT(0) /* enable all three counters */ 375 #define ARM11_PMCCTL_P __BIT(1) /* reset both Count Registers to zero */ 376 #define ARM11_PMCCTL_C __BIT(2) /* reset the Cycle Counter Register to zero */ 377 #define ARM11_PMCCTL_D __BIT(3) /* cycle count divide by 64 */ 378 #define ARM11_PMCCTL_EC0 __BIT(4) /* Enable Counter Register 0 interrupt */ 379 #define ARM11_PMCCTL_EC1 __BIT(5) /* Enable Counter Register 1 interrupt */ 380 #define ARM11_PMCCTL_ECC __BIT(6) /* Enable Cycle Counter interrupt */ 381 #define ARM11_PMCCTL_SBZa __BIT(7) /* UNP/SBZ */ 382 #define ARM11_PMCCTL_CR0 __BIT(8) /* Count Register 0 overflow flag */ 383 #define ARM11_PMCCTL_CR1 __BIT(9) /* Count Register 1 overflow flag */ 384 #define ARM11_PMCCTL_CCR __BIT(10) /* Cycle Count Register overflow flag */ 385 #define ARM11_PMCCTL_X __BIT(11) /* Enable Export of the events to the event bus */ 386 #define ARM11_PMCCTL_EVT1 __BITS(19,12) /* source of events for Count Register 1 */ 387 #define ARM11_PMCCTL_EVT0 __BITS(27,20) /* source of events for Count Register 0 */ 388 #define ARM11_PMCCTL_SBZb __BITS(31,28) /* UNP/SBZ */ 389 #define ARM11_PMCCTL_SBZ \ 390 (ARM11_PMCCTL_SBZa | ARM11_PMCCTL_SBZb) 391 392 #define ARM11_PMCEVT_ICACHE_MISS 0 /* Instruction Cache Miss */ 393 #define ARM11_PMCEVT_ISTREAM_STALL 1 /* Instruction Stream Stall */ 394 #define ARM11_PMCEVT_IUTLB_MISS 2 /* Instruction uTLB Miss */ 395 #define ARM11_PMCEVT_DUTLB_MISS 3 /* Data uTLB Miss */ 396 #define ARM11_PMCEVT_BRANCH 4 /* Branch Inst. Executed */ 397 #define ARM11_PMCEVT_BRANCH_MISS 6 /* Branch mispredicted */ 398 #define ARM11_PMCEVT_INST_EXEC 7 /* Instruction Executed */ 399 #define ARM11_PMCEVT_DCACHE_ACCESS0 9 /* Data Cache Access */ 400 #define ARM11_PMCEVT_DCACHE_ACCESS1 10 /* Data Cache Access */ 401 #define ARM11_PMCEVT_DCACHE_MISS 11 /* Data Cache Miss */ 402 #define ARM11_PMCEVT_DCACHE_WRITEBACK 12 /* Data Cache Writeback */ 403 #define ARM11_PMCEVT_PC_CHANGE 13 /* Software PC change */ 404 #define ARM11_PMCEVT_TLB_MISS 15 /* Main TLB Miss */ 405 #define ARM11_PMCEVT_DATA_ACCESS 16 /* non-cached data access */ 406 #define ARM11_PMCEVT_LSU_STALL 17 /* Load/Store Unit stall */ 407 #define ARM11_PMCEVT_WBUF_DRAIN 18 /* Write buffer drained */ 408 #define ARM11_PMCEVT_ETMEXTOUT0 32 /* ETMEXTOUT[0] asserted */ 409 #define ARM11_PMCEVT_ETMEXTOUT1 33 /* ETMEXTOUT[1] asserted */ 410 #define ARM11_PMCEVT_ETMEXTOUT 34 /* ETMEXTOUT[0 & 1] */ 411 #define ARM11_PMCEVT_CALL_EXEC 35 /* Procedure call executed */ 412 #define ARM11_PMCEVT_RETURN_EXEC 36 /* Return executed */ 413 #define ARM11_PMCEVT_RETURN_HIT 37 /* return address predicted */ 414 #define ARM11_PMCEVT_RETURN_MISS 38 /* return addr. mispredicted */ 415 #define ARM11_PMCEVT_CYCLE 255 /* Increment each cycle */ 416 417 #endif /* _ARM_ARMREG_H */ 418