1/*
2 * Copyright (c) 2018-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 r0 and a valid return address in lr.
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	  ldr	r1, =console_\_driver\()_putc
27	.else
28	  mov	r1, #0
29	.endif
30	str	r1, [r0, #CONSOLE_T_PUTC]
31
32	/*
33	 * If ENABLE_CONSOLE_GETC support is disabled, but a getc callback is
34	 * specified nonetheless, the assembler will abort on encountering the
35	 * CONSOLE_T_GETC macro, which is undefined.
36	 */
37	.ifne \getc
38	  ldr	r1, =console_\_driver\()_getc
39	  str	r1, [r0, #CONSOLE_T_GETC]
40	.else
41#if ENABLE_CONSOLE_GETC
42	  mov	r1, #0
43	  str	r1, [r0, #CONSOLE_T_GETC]
44#endif
45	.endif
46
47	.ifne \flush
48	  ldr	r1, =console_\_driver\()_flush
49	.else
50	  mov	r1, #0
51	.endif
52	str	r1, [r0, #CONSOLE_T_FLUSH]
53
54	mov	r1, #(CONSOLE_FLAG_BOOT | CONSOLE_FLAG_CRASH)
55	str	r1, [r0, #CONSOLE_T_FLAGS]
56	b	console_register
57	.endm
58
59#endif /* CONSOLE_MACROS_S */
60