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