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