xref: /freebsd/sys/arm64/include/armreg.h (revision 98e0ffaefb0f241cda3a72395d3be04192ae0d47)
1 /*-
2  * Copyright (c) 2013, 2014 Andrew Turner
3  * Copyright (c) 2015 The FreeBSD Foundation
4  * All rights reserved.
5  *
6  * This software was developed by Andrew Turner under
7  * sponsorship from the FreeBSD Foundation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * $FreeBSD$
31  */
32 
33 #ifndef _MACHINE_ARMREG_H_
34 #define	_MACHINE_ARMREG_H_
35 
36 #define	READ_SPECIALREG(reg)						\
37 ({	uint64_t val;							\
38 	__asm __volatile("mrs	%0, " __STRING(reg) : "=&r" (val));	\
39 	val;								\
40 })
41 #define	WRITE_SPECIALREG(reg, val)					\
42 	__asm __volatile("msr	" __STRING(reg) ", %0" : : "r"((uint64_t)val))
43 
44 /* CPACR_EL1 */
45 #define	CPACR_FPEN_MASK		(0x3 << 20)
46 #define	 CPACR_FPEN_TRAP_ALL1	(0x0 << 20) /* Traps from EL0 and EL1 */
47 #define	 CPACR_FPEN_TRAP_EL0	(0x1 << 20) /* Traps from EL0 */
48 #define	 CPACR_FPEN_TRAP_ALL2	(0x2 << 20) /* Traps from EL0 and EL1 */
49 #define	 CPACR_FPEN_TRAP_NONE	(0x3 << 20) /* No traps */
50 #define	CPACR_TTA		(0x1 << 28)
51 
52 /* CTR_EL0 - Cache Type Register */
53 #define	CTR_DLINE_SHIFT		16
54 #define	CTR_DLINE_MASK		(0xf << CTR_DLINE_SHIFT)
55 #define	CTR_DLINE_SIZE(reg)	(((reg) & CTR_DLINE_MASK) >> CTR_DLINE_SHIFT)
56 #define	CTR_ILINE_SHIFT		0
57 #define	CTR_ILINE_MASK		(0xf << CTR_ILINE_SHIFT)
58 #define	CTR_ILINE_SIZE(reg)	(((reg) & CTR_ILINE_MASK) >> CTR_ILINE_SHIFT)
59 
60 /* ESR_ELx */
61 #define	ESR_ELx_ISS_MASK	0x00ffffff
62 #define	 ISS_INSN_FnV		(0x01 << 10)
63 #define	 ISS_INSN_EA		(0x01 << 9)
64 #define	 ISS_INSN_S1PTW		(0x01 << 7)
65 #define	 ISS_INSN_IFSC_MASK	(0x1f << 0)
66 #define	 ISS_DATA_ISV		(0x01 << 24)
67 #define	 ISS_DATA_SAS_MASK	(0x03 << 22)
68 #define	 ISS_DATA_SSE		(0x01 << 21)
69 #define	 ISS_DATA_SRT_MASK	(0x1f << 16)
70 #define	 ISS_DATA_SF		(0x01 << 15)
71 #define	 ISS_DATA_AR		(0x01 << 14)
72 #define	 ISS_DATA_FnV		(0x01 << 10)
73 #define	 ISS_DATa_EA		(0x01 << 9)
74 #define	 ISS_DATa_CM		(0x01 << 8)
75 #define	 ISS_INSN_S1PTW		(0x01 << 7)
76 #define	 ISS_DATa_WnR		(0x01 << 6)
77 #define	 ISS_DATA_DFSC_MASK	(0x1f << 0)
78 #define	ESR_ELx_IL		(0x01 << 25)
79 #define	ESR_ELx_EC_SHIFT	26
80 #define	ESR_ELx_EC_MASK		(0x3f << 26)
81 #define	ESR_ELx_EXCEPTION(esr)	(((esr) & ESR_ELx_EC_MASK) >> ESR_ELx_EC_SHIFT)
82 #define	 EXCP_UNKNOWN		0x00	/* Unkwn exception */
83 #define	 EXCP_FP_SIMD		0x07	/* VFP/SIMD trap */
84 #define	 EXCP_ILL_STATE		0x0e	/* Illegal execution state */
85 #define	 EXCP_SVC		0x15	/* SVC trap */
86 #define	 EXCP_MSR		0x18	/* MSR/MRS trap */
87 #define	 EXCP_INSN_ABORT_L	0x20	/* Instruction abort, from lower EL */
88 #define	 EXCP_INSN_ABORT	0x21	/* Instruction abort, from same EL */
89 #define	 EXCP_PC_ALIGN		0x22	/* PC alignment fault */
90 #define	 EXCP_DATA_ABORT_L	0x24	/* Data abort, from lower EL */
91 #define	 EXCP_DATA_ABORT	0x25	/* Data abort, from same EL */
92 #define	 EXCP_SP_ALIGN		0x26	/* SP slignment fault */
93 #define	 EXCP_TRAP_FP		0x2c	/* Trapped FP exception */
94 #define	 EXCP_SERROR		0x2f	/* SError interrupt */
95 #define	 EXCP_SOFTSTP_EL1	0x33	/* Software Step, from same EL */
96 #define	 EXCP_WATCHPT_EL1	0x35	/* Watchpoint, from same EL */
97 #define	 EXCP_BRK		0x3c	/* Breakpoint */
98 
99 /* ICC_CTLR_EL1 */
100 #define	ICC_CTLR_EL1_EOIMODE	(1U << 1)
101 
102 /* ICC_IAR1_EL1 */
103 #define	ICC_IAR1_EL1_SPUR	(0x03ff)
104 
105 /* ICC_IGRPEN0_EL1 */
106 #define	ICC_IGRPEN0_EL1_EN	(1U << 0)
107 
108 /* ICC_PMR_EL1 */
109 #define	ICC_PMR_EL1_PRIO_MASK	(0xFFUL)
110 
111 /* ICC_SRE_EL1 */
112 #define	ICC_SRE_EL1_SRE		(1U << 0)
113 
114 /* ICC_SRE_EL2 */
115 #define	ICC_SRE_EL2_EN		(1U << 3)
116 
117 /* ID_AA64PFR0_EL1 */
118 #define	ID_AA64PFR0_EL0_MASK	(0xf << 0)
119 #define	ID_AA64PFR0_EL1_MASK	(0xf << 4)
120 #define	ID_AA64PFR0_EL2_MASK	(0xf << 8)
121 #define	ID_AA64PFR0_EL3_MASK	(0xf << 12)
122 #define	ID_AA64PFR0_FP_MASK	(0xf << 16)
123 #define	 ID_AA64PFR0_FP_IMPL	(0x0 << 16) /* Floating-point implemented */
124 #define	 ID_AA64PFR0_FP_NONE	(0xf << 16) /* Floating-point not implemented */
125 #define	ID_AA64PFR0_ADV_SIMD_MASK (0xf << 20)
126 #define	ID_AA64PFR0_GIC_SHIFT	(24)
127 #define	ID_AA64PFR0_GIC_BITS	(0x4) /* Number of bits in GIC field */
128 #define	ID_AA64PFR0_GIC_MASK	(0xf << ID_AA64PFR0_GIC_SHIFT)
129 #define	 ID_AA64PFR0_GIC_CPUIF_EN (0x1 << ID_AA64PFR0_GIC_SHIFT)
130 
131 /* MAIR_EL1 - Memory Attribute Indirection Register */
132 #define	MAIR_ATTR_MASK(idx)	(0xff << ((n)* 8))
133 #define	MAIR_ATTR(attr, idx) ((attr) << ((idx) * 8))
134 
135 /* SCTLR_EL1 - System Control Register */
136 #define	SCTLR_RES0	0xc8222400	/* Reserved, write 0 */
137 #define	SCTLR_RES1	0x30d00800	/* Reserved, write 1 */
138 
139 #define	SCTLR_M		0x00000001
140 #define	SCTLR_A		0x00000002
141 #define	SCTLR_C		0x00000004
142 #define	SCTLR_SA	0x00000008
143 #define	SCTLR_SA0	0x00000010
144 #define	SCTLR_CP15BEN	0x00000020
145 #define	SCTLR_THEE	0x00000040
146 #define	SCTLR_ITD	0x00000080
147 #define	SCTLR_SED	0x00000100
148 #define	SCTLR_UMA	0x00000200
149 #define	SCTLR_I		0x00001000
150 #define	SCTLR_DZE	0x00004000
151 #define	SCTLR_UCT	0x00008000
152 #define	SCTLR_nTWI	0x00010000
153 #define	SCTLR_nTWE	0x00040000
154 #define	SCTLR_WXN	0x00080000
155 #define	SCTLR_EOE	0x01000000
156 #define	SCTLR_EE	0x02000000
157 #define	SCTLR_UCI	0x04000000
158 
159 /* SPSR_EL1 */
160 /*
161  * When the exception is taken in AArch64:
162  * M[4]   is 0 for AArch64 mode
163  * M[3:2] is the exception level
164  * M[1]   is unused
165  * M[0]   is the SP select:
166  *         0: always SP0
167  *         1: current ELs SP
168  */
169 #define	PSR_M_EL0t	0x00000000
170 #define	PSR_M_EL1t	0x00000004
171 #define	PSR_M_EL1h	0x00000005
172 #define	PSR_M_EL2t	0x00000008
173 #define	PSR_M_EL2h	0x00000009
174 #define	PSR_M_MASK	0x0000001f
175 
176 #define	PSR_F		0x00000040
177 #define	PSR_I		0x00000080
178 #define	PSR_A		0x00000100
179 #define	PSR_D		0x00000200
180 #define	PSR_IL		0x00100000
181 #define	PSR_SS		0x00200000
182 #define	PSR_V		0x10000000
183 #define	PSR_C		0x20000000
184 #define	PSR_Z		0x40000000
185 #define	PSR_N		0x80000000
186 
187 /* TCR_EL1 - Translation Control Register */
188 #define	TCR_ASID_16	(1 << 36)
189 
190 #define	TCR_IPS_SHIFT	32
191 #define	TCR_IPS_32BIT	(0 << TCR_IPS_SHIFT)
192 #define	TCR_IPS_36BIT	(1 << TCR_IPS_SHIFT)
193 #define	TCR_IPS_40BIT	(2 << TCR_IPS_SHIFT)
194 #define	TCR_IPS_42BIT	(3 << TCR_IPS_SHIFT)
195 #define	TCR_IPS_44BIT	(4 << TCR_IPS_SHIFT)
196 #define	TCR_IPS_48BIT	(5 << TCR_IPS_SHIFT)
197 
198 #define	TCR_TG1_SHIFT	30
199 #define	TCR_TG1_16K	(1 << TCR_TG1_SHIFT)
200 #define	TCR_TG1_4K	(2 << TCR_TG1_SHIFT)
201 #define	TCR_TG1_64K	(3 << TCR_TG1_SHIFT)
202 
203 #define	TCR_T1SZ_SHIFT	16
204 #define	TCR_T0SZ_SHIFT	0
205 #define	TCR_TxSZ(x)	(((x) << TCR_T1SZ_SHIFT) | ((x) << TCR_T0SZ_SHIFT))
206 
207 /* Saved Program Status Register */
208 #define	DBG_SPSR_SS	(0x1 << 21)
209 
210 /* Monitor Debug System Control Register */
211 #define	DBG_MDSCR_SS	(0x1 << 0)
212 #define	DBG_MDSCR_KDE	(0x1 << 13)
213 #define	DBG_MDSCR_MDE	(0x1 << 15)
214 
215 /* Perfomance Monitoring Counters */
216 #define	PMCR_E		(1 << 0) /* Enable all counters */
217 #define	PMCR_P		(1 << 1) /* Reset all counters */
218 #define	PMCR_C		(1 << 2) /* Clock counter reset */
219 #define	PMCR_D		(1 << 3) /* CNTR counts every 64 clk cycles */
220 #define	PMCR_X		(1 << 4) /* Export to ext. monitoring (ETM) */
221 #define	PMCR_DP		(1 << 5) /* Disable CCNT if non-invasive debug*/
222 #define	PMCR_LC		(1 << 6) /* Long cycle count enable */
223 #define	PMCR_IMP_SHIFT	24 /* Implementer code */
224 #define	PMCR_IMP_MASK	(0xff << PMCR_IMP_SHIFT)
225 #define	PMCR_IDCODE_SHIFT	16 /* Identification code */
226 #define	PMCR_IDCODE_MASK	(0xff << PMCR_IDCODE_SHIFT)
227 #define	 PMCR_IDCODE_CORTEX_A57	0x01
228 #define	 PMCR_IDCODE_CORTEX_A72	0x02
229 #define	 PMCR_IDCODE_CORTEX_A53	0x03
230 #define	PMCR_N_SHIFT	11       /* Number of counters implemented */
231 #define	PMCR_N_MASK	(0x1f << PMCR_N_SHIFT)
232 
233 #endif /* !_MACHINE_ARMREG_H_ */
234