1 /* 2 * Copyright (c) 2013-2018, ARM Limited and Contributors. All rights reserved. 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 */ 6 7 #ifndef __CONSOLE_H__ 8 #define __CONSOLE_H__ 9 10 #include <utils_def.h> 11 12 #define CONSOLE_T_NEXT (U(0) * REGSZ) 13 #define CONSOLE_T_FLAGS (U(1) * REGSZ) 14 #define CONSOLE_T_PUTC (U(2) * REGSZ) 15 #define CONSOLE_T_GETC (U(3) * REGSZ) 16 #define CONSOLE_T_FLUSH (U(4) * REGSZ) 17 #define CONSOLE_T_DRVDATA (U(5) * REGSZ) 18 19 #define CONSOLE_FLAG_BOOT BIT(0) 20 #define CONSOLE_FLAG_RUNTIME BIT(1) 21 #define CONSOLE_FLAG_CRASH BIT(2) 22 /* Bits 3 to 7 reserved for additional scopes in future expansion. */ 23 #define CONSOLE_FLAG_SCOPE_MASK ((U(1) << 8) - 1) 24 /* Bits 8 to 31 reserved for non-scope use in future expansion. */ 25 26 /* Returned by getc callbacks when receive FIFO is empty. */ 27 #define ERROR_NO_PENDING_CHAR (-1) 28 /* Returned by console_xxx() if no registered console implements xxx. */ 29 #define ERROR_NO_VALID_CONSOLE (-128) 30 31 #ifndef __ASSEMBLY__ 32 33 #include <types.h> 34 35 typedef struct console { 36 struct console *next; 37 u_register_t flags; 38 int (*putc)(int character, struct console *console); 39 int (*getc)(struct console *console); 40 int (*flush)(struct console *console); 41 /* Additional private driver data may follow here. */ 42 } console_t; 43 #include <console_assertions.h> /* offset macro assertions for console_t */ 44 45 /* 46 * NOTE: There is no publicly accessible console_register() function. Consoles 47 * are registered by directly calling the register function of a specific 48 * implementation, e.g. console_16550_register() from <uart_16550.h>. Consoles 49 * registered that way can be unregistered/reconfigured with below functions. 50 */ 51 /* Remove a single console_t instance from the console list. */ 52 int console_unregister(console_t *console); 53 /* Set scope mask of a console that determines in what states it is active. */ 54 void console_set_scope(console_t *console, unsigned int scope); 55 56 /* Switch to a new global console state (CONSOLE_FLAG_BOOT/RUNTIME/CRASH). */ 57 void console_switch_state(unsigned int new_state); 58 /* Output a character on all consoles registered for the current state. */ 59 int console_putc(int c); 60 /* Read a character (blocking) from any console registered for current state. */ 61 int console_getc(void); 62 /* Flush all consoles registered for the current state. */ 63 int console_flush(void); 64 65 #if !MULTI_CONSOLE_API 66 /* REMOVED on AArch64 -- use console_<driver>_register() instead! */ 67 int console_init(uintptr_t base_addr, 68 unsigned int uart_clk, unsigned int baud_rate); 69 void console_uninit(void); 70 #endif 71 72 #endif /* __ASSEMBLY__ */ 73 74 #endif /* __CONSOLE_H__ */ 75 76