xref: /rk3399_ARM-atf/common/aarch64/debug.S (revision 0a0a7a9ac82cb79af91f098cedc69cc67bca3978)
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 <arch.h>
8#include <asm_macros.S>
9#include <common/debug.h>
10
11	.globl	asm_print_str
12	.globl	asm_print_hex
13	.globl	asm_print_hex_bits
14	.globl	asm_print_newline
15	.globl	asm_assert
16	.globl	do_panic
17
18/* Since the max decimal input number is 65536 */
19#define MAX_DEC_DIVISOR		10000
20/* The offset to add to get ascii for numerals '0 - 9' */
21#define ASCII_OFFSET_NUM	0x30
22
23#if ENABLE_ASSERTIONS
24.section .rodata.assert_str, "aS"
25assert_msg1:
26	.asciz "ASSERT: File "
27assert_msg2:
28	.asciz " Line "
29
30	/*
31	 * This macro is intended to be used to print the
32	 * line number in decimal. Used by asm_assert macro.
33	 * The max number expected is 65536.
34	 * In: x4 = the decimal to print.
35	 * Clobber: x30, x0, x1, x2, x5, x6
36	 */
37	.macro asm_print_line_dec
38	mov	x6, #10		/* Divide by 10 after every loop iteration */
39	mov	x5, #MAX_DEC_DIVISOR
40dec_print_loop:
41	udiv	x0, x4, x5		/* Get the quotient */
42	msub	x4, x0, x5, x4		/* Find the remainder */
43	add	x0, x0, #ASCII_OFFSET_NUM		/* Convert to ascii */
44	bl	plat_crash_console_putc
45	udiv	x5, x5, x6		/* Reduce divisor */
46	cbnz	x5, dec_print_loop
47	.endm
48
49
50/* ---------------------------------------------------------------------------
51 * Assertion support in assembly.
52 * The below function helps to support assertions in assembly where we do not
53 * have a C runtime stack. Arguments to the function are :
54 * x0 - File name
55 * x1 - Line no
56 * Clobber list : x30, x0, x1, x2, x3, x4, x5, x6.
57 * ---------------------------------------------------------------------------
58 */
59func asm_assert
60#if LOG_LEVEL >= LOG_LEVEL_INFO
61	/*
62	 * Only print the output if LOG_LEVEL is higher or equal to
63	 * LOG_LEVEL_INFO, which is the default value for builds with DEBUG=1.
64	 */
65	mov	x5, x0
66	mov	x6, x1
67	/* Ensure the console is initialized */
68	bl	plat_crash_console_init
69	/* Check if the console is initialized */
70	cbz	x0, _assert_loop
71	/* The console is initialized */
72	adr	x4, assert_msg1
73	bl	asm_print_str
74	mov	x4, x5
75	bl	asm_print_str
76	adr	x4, assert_msg2
77	bl	asm_print_str
78	/* Check if line number higher than max permitted */
79	tst	x6, #~0xffff
80	b.ne	_assert_loop
81	mov	x4, x6
82	asm_print_line_dec
83	bl	plat_crash_console_flush
84_assert_loop:
85#endif /* LOG_LEVEL >= LOG_LEVEL_INFO */
86	no_ret	plat_panic_handler
87endfunc asm_assert
88#endif /* ENABLE_ASSERTIONS */
89
90/*
91 * This function prints a string from address in x4.
92 * In: x4 = pointer to string.
93 * Clobber: x30, x0, x1, x2, x3
94 */
95func asm_print_str
96	mov	x3, x30
971:
98	ldrb	w0, [x4], #0x1
99	cbz	x0, 2f
100	bl	plat_crash_console_putc
101	b	1b
1022:
103	ret	x3
104endfunc asm_print_str
105
106/*
107 * This function prints a hexadecimal number in x4.
108 * In: x4 = the hexadecimal to print.
109 * Clobber: x30, x0 - x3, x5
110 */
111func asm_print_hex
112	mov	x5, #64  /* No of bits to convert to ascii */
113
114	/* Convert to ascii number of bits in x5 */
115asm_print_hex_bits:
116	mov	x3, x30
1171:
118	sub	x5, x5, #4
119	lsrv	x0, x4, x5
120	and	x0, x0, #0xf
121	cmp	x0, #0xA
122	b.lo	2f
123	/* Add by 0x27 in addition to ASCII_OFFSET_NUM
124	 * to get ascii for characters 'a - f'.
125	 */
126	add	x0, x0, #0x27
1272:
128	add	x0, x0, #ASCII_OFFSET_NUM
129	bl	plat_crash_console_putc
130	cbnz	x5, 1b
131	ret	x3
132endfunc asm_print_hex
133
134/*
135 * Helper function to print newline to console
136 * Clobber: x0
137 */
138func asm_print_newline
139	mov	x0, '\n'
140	b	plat_crash_console_putc
141endfunc asm_print_newline
142
143	/***********************************************************
144	 * The common implementation of do_panic for all BL stages
145	 ***********************************************************/
146
147.section .rodata.panic_str, "aS"
148	panic_msg: .asciz "PANIC at PC : 0x"
149
150/* ---------------------------------------------------------------------------
151 * do_panic assumes that it is invoked from a C Runtime Environment ie a
152 * valid stack exists. This call will not return.
153 * Clobber list : if CRASH_REPORTING is not enabled then x30, x0 - x6
154 * ---------------------------------------------------------------------------
155 */
156
157/* This is for the non el3 BL stages to compile through */
158	.weak el3_panic
159	.weak elx_panic
160
161func do_panic
162#if CRASH_REPORTING
163	str	x0, [sp, #-0x10]!
164	mrs	x0, currentel
165	ubfx	x0, x0, #MODE_EL_SHIFT, #MODE_EL_WIDTH
166	cmp	x0, #MODE_EL3
167#if !HANDLE_EA_EL3_FIRST
168	ldr	x0, [sp], #0x10
169	b.eq	el3_panic
170#else
171	b.ne	to_panic_common
172
173	/* Check EL the exception taken from */
174	mrs	x0, spsr_el3
175	ubfx	x0, x0, #SPSR_EL_SHIFT, #SPSR_EL_WIDTH
176	cmp	x0, #MODE_EL3
177	b.ne	elx_panic
178	ldr	x0, [sp], #0x10
179	b	el3_panic
180
181to_panic_common:
182	ldr	x0, [sp], #0x10
183#endif /* HANDLE_EA_EL3_FIRST */
184#endif /* CRASH_REPORTING */
185
186panic_common:
187/*
188 * el3_panic will be redefined by the BL31
189 * crash reporting mechanism (if enabled)
190 */
191el3_panic:
192	mov	x6, x30
193	bl	plat_crash_console_init
194	/* Check if the console is initialized */
195	cbz	x0, _panic_handler
196	/* The console is initialized */
197	adr	x4, panic_msg
198	bl	asm_print_str
199	mov	x4, x6
200	/* The panic location is lr -4 */
201	sub	x4, x4, #4
202	bl	asm_print_hex
203
204	bl	plat_crash_console_flush
205
206_panic_handler:
207	/* Pass to plat_panic_handler the address from where el3_panic was
208	 * called, not the address of the call from el3_panic. */
209	mov	x30, x6
210	b	plat_panic_handler
211endfunc do_panic
212