1/*
2 * Copyright (c) 2017-2019, ARM Limited and Contributors. All rights reserved.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6#ifndef CONSOLE_MACROS_S
7#define CONSOLE_MACROS_S
8
9#include <drivers/console.h>
10
11/*
12 * This macro encapsulates the common setup that has to be done at the end of
13 * a console driver's register function. It will register all of the driver's
14 * callbacks in the console_t structure and initialize the flags field (by
15 * default consoles are enabled for the "boot" and "crash" states, this can be
16 * changed after registration with the console_set_scope() function). It ends
17 * with a tail call that will include return to the caller.
18 * REQUIRES console_t pointer in x0 and a valid return address in x30.
19 */
20	.macro	finish_console_register _driver, putc=0, getc=0, flush=0
21	/*
22	 * If any of the callback is not specified or set as 0, then the
23	 * corresponding callback entry in console_t is set to 0.
24	 */
25	.ifne \putc
26	  adrp	x1, console_\_driver\()_putc
27	  add	x1, x1, :lo12:console_\_driver\()_putc
28	  str	x1, [x0, #CONSOLE_T_PUTC]
29	.else
30	  str	xzr, [x0, #CONSOLE_T_PUTC]
31	.endif
32
33	.ifne \getc
34	  adrp	x1, console_\_driver\()_getc
35	  add	x1, x1, :lo12:console_\_driver\()_getc
36	  str	x1, [x0, #CONSOLE_T_GETC]
37	.else
38	  str	xzr, [x0, #CONSOLE_T_GETC]
39	.endif
40
41	.ifne \flush
42	  adrp	x1, console_\_driver\()_flush
43	  add	x1, x1, :lo12:console_\_driver\()_flush
44	  str	x1, [x0, #CONSOLE_T_FLUSH]
45	.else
46	  str	xzr, [x0, #CONSOLE_T_FLUSH]
47	.endif
48
49	mov	x1, #(CONSOLE_FLAG_BOOT | CONSOLE_FLAG_CRASH)
50	str	x1, [x0, #CONSOLE_T_FLAGS]
51	b	console_register
52	.endm
53
54#endif /* CONSOLE_MACROS_S */
55