xref: /rk3399_ARM-atf/bl31/aarch64/crash_reporting.S (revision e21a788ee197ec66f6b8552e2274297bf4a095a8)
1/*
2 * Copyright (c) 2014-2020, ARM Limited and Contributors. All rights reserved.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#include <plat_macros.S>
8#include <platform_def.h>
9
10#include <arch.h>
11#include <asm_macros.S>
12#include <context.h>
13#include <lib/el3_runtime/cpu_data.h>
14#include <lib/utils_def.h>
15
16	.globl	report_unhandled_exception
17	.globl	report_unhandled_interrupt
18	.globl	el3_panic
19
20#if CRASH_REPORTING
21
22	/* ------------------------------------------------------
23	 * The below section deals with dumping the system state
24	 * when an unhandled exception is taken in EL3.
25	 * The layout and the names of the registers which will
26	 * be dumped during a unhandled exception is given below.
27	 * ------------------------------------------------------
28	 */
29.section .rodata.crash_prints, "aS"
30print_spacer:
31	.asciz	"             = 0x"
32
33gp_regs:
34	.asciz	"x0", "x1", "x2", "x3", "x4", "x5", "x6", "x7",\
35		"x8", "x9", "x10", "x11", "x12", "x13", "x14", "x15",\
36		"x16", "x17", "x18", "x19", "x20", "x21", "x22",\
37		"x23", "x24", "x25", "x26", "x27", "x28", "x29", ""
38el3_sys_regs:
39	.asciz	"scr_el3", "sctlr_el3", "cptr_el3", "tcr_el3",\
40		"daif", "mair_el3", "spsr_el3", "elr_el3", "ttbr0_el3",\
41		"esr_el3", "far_el3", ""
42
43non_el3_sys_regs:
44	.asciz	"spsr_el1", "elr_el1", "spsr_abt", "spsr_und",\
45		"spsr_irq", "spsr_fiq", "sctlr_el1", "actlr_el1", "cpacr_el1",\
46		"csselr_el1", "sp_el1", "esr_el1", "ttbr0_el1", "ttbr1_el1",\
47		"mair_el1", "amair_el1", "tcr_el1", "tpidr_el1", "tpidr_el0",\
48		"tpidrro_el0",  "par_el1", "mpidr_el1", "afsr0_el1", "afsr1_el1",\
49		"contextidr_el1", "vbar_el1", "cntp_ctl_el0", "cntp_cval_el0",\
50		"cntv_ctl_el0", "cntv_cval_el0", "cntkctl_el1", "sp_el0", "isr_el1", ""
51
52#if CTX_INCLUDE_AARCH32_REGS
53aarch32_regs:
54	.asciz	"dacr32_el2", "ifsr32_el2", ""
55#endif /* CTX_INCLUDE_AARCH32_REGS */
56
57panic_msg:
58	.asciz "PANIC in EL3.\nx30"
59excpt_msg:
60	.asciz "Unhandled Exception in EL3.\nx30"
61intr_excpt_msg:
62	.asciz "Unhandled Interrupt Exception in EL3.\nx30"
63
64	/*
65	 * Helper function to print from crash buf.
66	 * The print loop is controlled by the buf size and
67	 * ascii reg name list which is passed in x6. The
68	 * function returns the crash buf address in x0.
69	 * Clobbers : x0 - x7, sp
70	 */
71func size_controlled_print
72	/* Save the lr */
73	mov	sp, x30
74	/* load the crash buf address */
75	mrs	x7, tpidr_el3
76test_size_list:
77	/* Calculate x5 always as it will be clobbered by asm_print_hex */
78	mrs	x5, tpidr_el3
79	add	x5, x5, #CPU_DATA_CRASH_BUF_SIZE
80	/* Test whether we have reached end of crash buf */
81	cmp	x7, x5
82	b.eq	exit_size_print
83	ldrb	w4, [x6]
84	/* Test whether we are at end of list */
85	cbz	w4, exit_size_print
86	mov	x4, x6
87	/* asm_print_str updates x4 to point to next entry in list */
88	bl	asm_print_str
89	/* x0 = number of symbols printed + 1 */
90	sub	x0, x4, x6
91	/* update x6 with the updated list pointer */
92	mov	x6, x4
93	bl	print_alignment
94	ldr	x4, [x7], #REGSZ
95	bl	asm_print_hex
96	bl	asm_print_newline
97	b	test_size_list
98exit_size_print:
99	mov	x30, sp
100	ret
101endfunc size_controlled_print
102
103	/* -----------------------------------------------------
104	 * This function calculates and prints required number
105	 * of space characters followed by "= 0x", based on the
106	 * length of ascii register name.
107 	 * x0: length of ascii register name + 1
108	 * ------------------------------------------------------
109 	 */
110func print_alignment
111	/* The minimum ascii length is 3, e.g. for "x0" */
112	adr	x4, print_spacer - 3
113	add	x4, x4, x0
114	b	asm_print_str
115endfunc print_alignment
116
117	/*
118	 * Helper function to store x8 - x15 registers to
119	 * the crash buf. The system registers values are
120	 * copied to x8 to x15 by the caller which are then
121	 * copied to the crash buf by this function.
122	 * x0 points to the crash buf. It then calls
123	 * size_controlled_print to print to console.
124	 * Clobbers : x0 - x7, sp
125	 */
126func str_in_crash_buf_print
127	/* restore the crash buf address in x0 */
128	mrs	x0, tpidr_el3
129	stp	x8, x9, [x0]
130	stp	x10, x11, [x0, #REGSZ * 2]
131	stp	x12, x13, [x0, #REGSZ * 4]
132	stp	x14, x15, [x0, #REGSZ * 6]
133	b	size_controlled_print
134endfunc str_in_crash_buf_print
135
136	/* ------------------------------------------------------
137	 * This macro calculates the offset to crash buf from
138	 * cpu_data and stores it in tpidr_el3. It also saves x0
139	 * and x1 in the crash buf by using sp as a temporary
140	 * register.
141	 * ------------------------------------------------------
142	 */
143	.macro prepare_crash_buf_save_x0_x1
144	/* we can corrupt this reg to free up x0 */
145	mov	sp, x0
146	/* tpidr_el3 contains the address to cpu_data structure */
147	mrs	x0, tpidr_el3
148	/* Calculate the Crash buffer offset in cpu_data */
149	add	x0, x0, #CPU_DATA_CRASH_BUF_OFFSET
150	/* Store crash buffer address in tpidr_el3 */
151	msr	tpidr_el3, x0
152	str	x1, [x0, #REGSZ]
153	mov	x1, sp
154	str	x1, [x0]
155	.endm
156
157	/* -----------------------------------------------------
158	 * This function allows to report a crash (if crash
159	 * reporting is enabled) when an unhandled exception
160	 * occurs. It prints the CPU state via the crash console
161	 * making use of the crash buf. This function will
162	 * not return.
163	 * -----------------------------------------------------
164	 */
165func report_unhandled_exception
166	prepare_crash_buf_save_x0_x1
167	adr	x0, excpt_msg
168	mov	sp, x0
169	/* This call will not return */
170	b	do_crash_reporting
171endfunc report_unhandled_exception
172
173
174	/* -----------------------------------------------------
175	 * This function allows to report a crash (if crash
176	 * reporting is enabled) when an unhandled interrupt
177	 * occurs. It prints the CPU state via the crash console
178	 * making use of the crash buf. This function will
179	 * not return.
180	 * -----------------------------------------------------
181	 */
182func report_unhandled_interrupt
183	prepare_crash_buf_save_x0_x1
184	adr	x0, intr_excpt_msg
185	mov	sp, x0
186	/* This call will not return */
187	b	do_crash_reporting
188endfunc report_unhandled_interrupt
189
190	/* -----------------------------------------------------
191	 * This function allows to report a crash (if crash
192	 * reporting is enabled) when panic() is invoked from
193	 * C Runtime. It prints the CPU state via the crash
194	 * console making use of the crash buf. This function
195	 * will not return.
196	 * -----------------------------------------------------
197	 */
198func el3_panic
199	msr	spsel, #MODE_SP_ELX
200	prepare_crash_buf_save_x0_x1
201	adr	x0, panic_msg
202	mov	sp, x0
203	/* This call will not return */
204	b	do_crash_reporting
205endfunc el3_panic
206
207	/* ------------------------------------------------------------
208	 * The common crash reporting functionality. It requires x0
209	 * and x1 has already been stored in crash buf, sp points to
210	 * crash message and tpidr_el3 contains the crash buf address.
211	 * The function does the following:
212	 *   - Retrieve the crash buffer from tpidr_el3
213	 *   - Store x2 to x6 in the crash buffer
214	 *   - Initialise the crash console.
215	 *   - Print the crash message by using the address in sp.
216	 *   - Print x30 value to the crash console.
217	 *   - Print x0 - x7 from the crash buf to the crash console.
218	 *   - Print x8 - x29 (in groups of 8 registers) using the
219	 *     crash buf to the crash console.
220	 *   - Print el3 sys regs (in groups of 8 registers) using the
221	 *     crash buf to the crash console.
222	 *   - Print non el3 sys regs (in groups of 8 registers) using
223	 *     the crash buf to the crash console.
224	 * ------------------------------------------------------------
225	 */
226func do_crash_reporting
227	/* Retrieve the crash buf from tpidr_el3 */
228	mrs	x0, tpidr_el3
229	/* Store x2 - x6, x30 in the crash buffer */
230	stp	x2, x3, [x0, #REGSZ * 2]
231	stp	x4, x5, [x0, #REGSZ * 4]
232	stp	x6, x30, [x0, #REGSZ * 6]
233	/* Initialize the crash console */
234	bl	plat_crash_console_init
235	/* Verify the console is initialized */
236	cbz	x0, crash_panic
237	/* Print the crash message. sp points to the crash message */
238	mov	x4, sp
239	bl	asm_print_str
240	/* Print spaces to align "x30" string */
241	mov	x0, #4
242	bl	print_alignment
243	/* load the crash buf address */
244	mrs	x0, tpidr_el3
245	/* report x30 first from the crash buf */
246	ldr	x4, [x0, #REGSZ * 7]
247
248#if ENABLE_PAUTH
249	/* Demangle address */
250	xpaci	x4
251#endif
252	bl	asm_print_hex
253	bl	asm_print_newline
254	/* Load the crash buf address */
255	mrs	x0, tpidr_el3
256	/* Now mov x7 into crash buf */
257	str	x7, [x0, #REGSZ * 7]
258
259	/* Report x0 - x29 values stored in crash buf*/
260	/* Store the ascii list pointer in x6 */
261	adr	x6, gp_regs
262	/* Print x0 to x7 from the crash buf */
263	bl	size_controlled_print
264	/* Store x8 - x15 in crash buf and print */
265	bl	str_in_crash_buf_print
266	/* Load the crash buf address */
267	mrs	x0, tpidr_el3
268	/* Store the rest of gp regs and print */
269	stp	x16, x17, [x0]
270	stp	x18, x19, [x0, #REGSZ * 2]
271	stp	x20, x21, [x0, #REGSZ * 4]
272	stp	x22, x23, [x0, #REGSZ * 6]
273	bl	size_controlled_print
274	/* Load the crash buf address */
275	mrs	x0, tpidr_el3
276	stp	x24, x25, [x0]
277	stp	x26, x27, [x0, #REGSZ * 2]
278	stp	x28, x29, [x0, #REGSZ * 4]
279	bl	size_controlled_print
280
281	/* Print the el3 sys registers */
282	adr	x6, el3_sys_regs
283	mrs	x8, scr_el3
284	mrs	x9, sctlr_el3
285	mrs	x10, cptr_el3
286	mrs	x11, tcr_el3
287	mrs	x12, daif
288	mrs	x13, mair_el3
289	mrs	x14, spsr_el3
290	mrs	x15, elr_el3
291	bl	str_in_crash_buf_print
292	mrs	x8, ttbr0_el3
293	mrs	x9, esr_el3
294	mrs	x10, far_el3
295	bl	str_in_crash_buf_print
296
297	/* Print the non el3 sys registers */
298	adr	x6, non_el3_sys_regs
299	mrs	x8, spsr_el1
300	mrs	x9, elr_el1
301	mrs	x10, spsr_abt
302	mrs	x11, spsr_und
303	mrs	x12, spsr_irq
304	mrs	x13, spsr_fiq
305	mrs	x14, sctlr_el1
306	mrs	x15, actlr_el1
307	bl	str_in_crash_buf_print
308	mrs	x8, cpacr_el1
309	mrs	x9, csselr_el1
310	mrs	x10, sp_el1
311	mrs	x11, esr_el1
312	mrs	x12, ttbr0_el1
313	mrs	x13, ttbr1_el1
314	mrs	x14, mair_el1
315	mrs	x15, amair_el1
316	bl	str_in_crash_buf_print
317	mrs	x8, tcr_el1
318	mrs	x9, tpidr_el1
319	mrs	x10, tpidr_el0
320	mrs	x11, tpidrro_el0
321	mrs	x12, par_el1
322	mrs	x13, mpidr_el1
323	mrs	x14, afsr0_el1
324	mrs	x15, afsr1_el1
325	bl	str_in_crash_buf_print
326	mrs	x8, contextidr_el1
327	mrs	x9, vbar_el1
328	mrs	x10, cntp_ctl_el0
329	mrs	x11, cntp_cval_el0
330	mrs	x12, cntv_ctl_el0
331	mrs	x13, cntv_cval_el0
332	mrs	x14, cntkctl_el1
333	mrs	x15, sp_el0
334	bl	str_in_crash_buf_print
335	mrs	x8, isr_el1
336	bl	str_in_crash_buf_print
337
338#if CTX_INCLUDE_AARCH32_REGS
339	/* Print the AArch32 registers */
340	adr	x6, aarch32_regs
341	mrs	x8, dacr32_el2
342	mrs	x9, ifsr32_el2
343	bl	str_in_crash_buf_print
344#endif /* CTX_INCLUDE_AARCH32_REGS */
345
346	/* Get the cpu specific registers to report */
347	bl	do_cpu_reg_dump
348	bl	str_in_crash_buf_print
349
350	/* Print some platform registers */
351	plat_crash_print_regs
352
353	bl	plat_crash_console_flush
354
355	/* Done reporting */
356	no_ret	plat_panic_handler
357endfunc do_crash_reporting
358
359#else	/* CRASH_REPORTING */
360func report_unhandled_exception
361report_unhandled_interrupt:
362	no_ret	plat_panic_handler
363endfunc report_unhandled_exception
364#endif	/* CRASH_REPORTING */
365
366
367func crash_panic
368	no_ret	plat_panic_handler
369endfunc crash_panic
370