1 /* 2 * Copyright (c) 2013-2023, 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 <lib/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 #if ENABLE_CONSOLE_GETC 16 #define CONSOLE_T_GETC (U(3) * REGSZ) 17 #define CONSOLE_T_FLUSH (U(4) * REGSZ) 18 #define CONSOLE_T_BASE (U(5) * REGSZ) 19 #define CONSOLE_T_DRVDATA (U(6) * REGSZ) 20 #else 21 #define CONSOLE_T_FLUSH (U(3) * REGSZ) 22 #define CONSOLE_T_BASE (U(4) * REGSZ) 23 #define CONSOLE_T_DRVDATA (U(5) * REGSZ) 24 #endif 25 26 #define CONSOLE_FLAG_BOOT (U(1) << 0) 27 #define CONSOLE_FLAG_RUNTIME (U(1) << 1) 28 #define CONSOLE_FLAG_CRASH (U(1) << 2) 29 /* Bits 3 to 7 reserved for additional scopes in future expansion. */ 30 #define CONSOLE_FLAG_SCOPE_MASK ((U(1) << 8) - 1) 31 /* Bits 8 to 31 for non-scope use. */ 32 #define CONSOLE_FLAG_TRANSLATE_CRLF (U(1) << 8) 33 34 /* Returned by getc callbacks when receive FIFO is empty. */ 35 #define ERROR_NO_PENDING_CHAR (-1) 36 /* Returned by console_xxx() if no registered console implements xxx. */ 37 #define ERROR_NO_VALID_CONSOLE (-128) 38 39 #ifndef __ASSEMBLER__ 40 41 #include <stdint.h> 42 43 typedef struct console { 44 struct console *next; 45 /* 46 * Only the low 32 bits are used. The type is u_register_t to align the 47 * fields of the struct to 64 bits in AArch64 and 32 bits in AArch32 48 */ 49 u_register_t flags; 50 int (*const putc)(int character, struct console *console); 51 #if ENABLE_CONSOLE_GETC 52 int (*const getc)(struct console *console); 53 #endif 54 void (*const flush)(struct console *console); 55 uintptr_t base; 56 /* Additional private driver data may follow here. */ 57 } console_t; 58 59 extern console_t *console_list; 60 61 /* offset macro assertions for console_t */ 62 #include <drivers/console_assertions.h> 63 64 /* 65 * Add a console_t instance to the console list. This should only be called by 66 * console drivers after they have initialized all fields in the console 67 * structure. Platforms seeking to register a new console need to call the 68 * respective console__register() function instead. 69 */ 70 int console_register(console_t *console); 71 /* Remove a single console_t instance from the console list. Return a pointer to 72 * the console that was removed if it was found, or NULL if not. */ 73 console_t *console_unregister(console_t *console); 74 /* Returns 1 if this console is already registered, 0 if not */ 75 int console_is_registered(console_t *console); 76 /* 77 * Set scope mask of a console that determines in what states it is active. 78 * By default they are registered with (CONSOLE_FLAG_BOOT|CONSOLE_FLAG_CRASH). 79 */ 80 void console_set_scope(console_t *console, unsigned int scope); 81 82 /* Switch to a new global console state (CONSOLE_FLAG_BOOT/RUNTIME/CRASH). */ 83 void console_switch_state(unsigned int new_state); 84 /* Output a character on all consoles registered for the current state. */ 85 int console_putc(int c); 86 #if ENABLE_CONSOLE_GETC 87 /* Read a character (blocking) from any console registered for current state. */ 88 int console_getc(void); 89 #endif 90 /* Flush all consoles registered for the current state. */ 91 void console_flush(void); 92 93 #endif /* __ASSEMBLER__ */ 94 95 #endif /* CONSOLE_H */ 96
