blob: 4f26ccef21757a4c53271f9a10026886d0f871ed [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Dan Handley6fa89a22018-02-27 16:03:58 +00002 * Copyright (c) 2013-2018, ARM Limited and Contributors. All rights reserved.
Achin Gupta4f6ad662013-10-25 09:08:21 +01003 *
dp-armfa3cf0b2017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Achin Gupta4f6ad662013-10-25 09:08:21 +01005 */
6
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +00007#ifndef CONSOLE_H
8#define CONSOLE_H
Achin Gupta4f6ad662013-10-25 09:08:21 +01009
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000010#include <lib/utils_def.h>
Juan Castillo7f1f0622014-09-09 09:49:23 +010011
Julius Werner94f89072017-07-31 18:15:11 -070012#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
Antonio Nino Diaz23ede6a2018-06-19 09:29:36 +010019#define CONSOLE_FLAG_BOOT (U(1) << 0)
20#define CONSOLE_FLAG_RUNTIME (U(1) << 1)
21#define CONSOLE_FLAG_CRASH (U(1) << 2)
Julius Werner94f89072017-07-31 18:15:11 -070022/* 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
Antonio Nino Diaz4b32e622018-08-16 16:52:57 +010033#include <stdint.h>
Julius Werner94f89072017-07-31 18:15:11 -070034
35typedef struct console {
36 struct console *next;
Daniel Boulby99e4a482018-05-16 16:04:35 +010037 /*
38 * Only the low 32 bits are used. The type is u_register_t to align the
39 * fields of the struct to 64 bits in AArch64 and 32 bits in AArch32
40 */
Julius Werner94f89072017-07-31 18:15:11 -070041 u_register_t flags;
Daniel Boulby9516df22018-06-07 14:15:15 +010042 int (*const putc)(int character, struct console *console);
43 int (*const getc)(struct console *console);
44 int (*const flush)(struct console *console);
Julius Werner94f89072017-07-31 18:15:11 -070045 /* Additional private driver data may follow here. */
46} console_t;
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000047
48/* offset macro assertions for console_t */
49#include <drivers/console_assertions.h>
Julius Werner94f89072017-07-31 18:15:11 -070050
51/*
Ambroise Vincentb237bca2019-02-13 15:58:00 +000052 * Add a console_t instance to the console list. This should only be called by
53 * console drivers after they have initialized all fields in the console
54 * structure. Platforms seeking to register a new console need to call the
55 * respective console__register() function instead.
Julius Werner94f89072017-07-31 18:15:11 -070056 */
Ambroise Vincentb237bca2019-02-13 15:58:00 +000057int console_register(console_t *console);
Julius Werner514ae842018-12-03 17:01:30 -080058/* Remove a single console_t instance from the console list. Return a pointer to
59 * the console that was removed if it was found, or NULL if not. */
60console_t *console_unregister(console_t *console);
Antonio Nino Diaz4f31ad52018-04-30 20:14:07 +010061/* Returns 1 if this console is already registered, 0 if not */
62int console_is_registered(console_t *console);
63/*
64 * Set scope mask of a console that determines in what states it is active.
65 * By default they are registered with (CONSOLE_FLAG_BOOT|CONSOLE_FLAG_CRASH).
66 */
Julius Werner94f89072017-07-31 18:15:11 -070067void console_set_scope(console_t *console, unsigned int scope);
68
69/* Switch to a new global console state (CONSOLE_FLAG_BOOT/RUNTIME/CRASH). */
70void console_switch_state(unsigned int new_state);
71/* Output a character on all consoles registered for the current state. */
Achin Gupta4f6ad662013-10-25 09:08:21 +010072int console_putc(int c);
Julius Werner94f89072017-07-31 18:15:11 -070073/* Read a character (blocking) from any console registered for current state. */
Achin Gupta4f6ad662013-10-25 09:08:21 +010074int console_getc(void);
Julius Werner94f89072017-07-31 18:15:11 -070075/* Flush all consoles registered for the current state. */
Antonio Nino Diaz8377ae42017-02-06 16:03:41 +000076int console_flush(void);
Achin Gupta4f6ad662013-10-25 09:08:21 +010077
Julius Werner94f89072017-07-31 18:15:11 -070078#if !MULTI_CONSOLE_API
Dan Handley6fa89a22018-02-27 16:03:58 +000079/* REMOVED on AArch64 -- use console_<driver>_register() instead! */
Julius Werner94f89072017-07-31 18:15:11 -070080int console_init(uintptr_t base_addr,
Dan Handley6fa89a22018-02-27 16:03:58 +000081 unsigned int uart_clk, unsigned int baud_rate);
82void console_uninit(void);
Julius Werner94f89072017-07-31 18:15:11 -070083#endif
84
85#endif /* __ASSEMBLY__ */
86
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +000087#endif /* CONSOLE_H */