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