blob: 761816ac74310795fa261711cd5fcf97012d1ea7 [file] [log] [blame]
Achin Gupta4f6ad662013-10-25 09:08:21 +01001/*
Masahiro Yamada269a8ad2019-07-23 12:32:58 +09002 * Copyright (c) 2013-2019, 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)
Andre Przywarac88f6562020-01-25 00:54:38 +000017#define CONSOLE_T_BASE (U(5) * REGSZ)
18#define CONSOLE_T_DRVDATA (U(6) * REGSZ)
Julius Werner94f89072017-07-31 18:15:11 -070019
Antonio Nino Diaz23ede6a2018-06-19 09:29:36 +010020#define CONSOLE_FLAG_BOOT (U(1) << 0)
21#define CONSOLE_FLAG_RUNTIME (U(1) << 1)
22#define CONSOLE_FLAG_CRASH (U(1) << 2)
Julius Werner94f89072017-07-31 18:15:11 -070023/* Bits 3 to 7 reserved for additional scopes in future expansion. */
24#define CONSOLE_FLAG_SCOPE_MASK ((U(1) << 8) - 1)
Masahiro Yamada269a8ad2019-07-23 12:32:58 +090025/* Bits 8 to 31 for non-scope use. */
26#define CONSOLE_FLAG_TRANSLATE_CRLF (U(1) << 8)
Julius Werner94f89072017-07-31 18:15:11 -070027
28/* Returned by getc callbacks when receive FIFO is empty. */
29#define ERROR_NO_PENDING_CHAR (-1)
30/* Returned by console_xxx() if no registered console implements xxx. */
31#define ERROR_NO_VALID_CONSOLE (-128)
32
Julius Werner53456fc2019-07-09 13:49:11 -070033#ifndef __ASSEMBLER__
Julius Werner94f89072017-07-31 18:15:11 -070034
Antonio Nino Diaz4b32e622018-08-16 16:52:57 +010035#include <stdint.h>
Julius Werner94f89072017-07-31 18:15:11 -070036
37typedef struct console {
38 struct console *next;
Daniel Boulby99e4a482018-05-16 16:04:35 +010039 /*
40 * Only the low 32 bits are used. The type is u_register_t to align the
41 * fields of the struct to 64 bits in AArch64 and 32 bits in AArch32
42 */
Julius Werner94f89072017-07-31 18:15:11 -070043 u_register_t flags;
Daniel Boulby9516df22018-06-07 14:15:15 +010044 int (*const putc)(int character, struct console *console);
45 int (*const getc)(struct console *console);
46 int (*const flush)(struct console *console);
Andre Przywarac88f6562020-01-25 00:54:38 +000047 uintptr_t base;
Julius Werner94f89072017-07-31 18:15:11 -070048 /* Additional private driver data may follow here. */
49} console_t;
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000050
51/* offset macro assertions for console_t */
52#include <drivers/console_assertions.h>
Julius Werner94f89072017-07-31 18:15:11 -070053
54/*
Ambroise Vincentb237bca2019-02-13 15:58:00 +000055 * Add a console_t instance to the console list. This should only be called by
56 * console drivers after they have initialized all fields in the console
57 * structure. Platforms seeking to register a new console need to call the
58 * respective console__register() function instead.
Julius Werner94f89072017-07-31 18:15:11 -070059 */
Ambroise Vincentb237bca2019-02-13 15:58:00 +000060int console_register(console_t *console);
Julius Werner514ae842018-12-03 17:01:30 -080061/* Remove a single console_t instance from the console list. Return a pointer to
62 * the console that was removed if it was found, or NULL if not. */
63console_t *console_unregister(console_t *console);
Antonio Nino Diaz4f31ad52018-04-30 20:14:07 +010064/* Returns 1 if this console is already registered, 0 if not */
65int console_is_registered(console_t *console);
66/*
67 * Set scope mask of a console that determines in what states it is active.
68 * By default they are registered with (CONSOLE_FLAG_BOOT|CONSOLE_FLAG_CRASH).
69 */
Julius Werner94f89072017-07-31 18:15:11 -070070void console_set_scope(console_t *console, unsigned int scope);
71
72/* Switch to a new global console state (CONSOLE_FLAG_BOOT/RUNTIME/CRASH). */
73void console_switch_state(unsigned int new_state);
74/* Output a character on all consoles registered for the current state. */
Achin Gupta4f6ad662013-10-25 09:08:21 +010075int console_putc(int c);
Julius Werner94f89072017-07-31 18:15:11 -070076/* Read a character (blocking) from any console registered for current state. */
Achin Gupta4f6ad662013-10-25 09:08:21 +010077int console_getc(void);
Julius Werner94f89072017-07-31 18:15:11 -070078/* Flush all consoles registered for the current state. */
Antonio Nino Diaz8377ae42017-02-06 16:03:41 +000079int console_flush(void);
Achin Gupta4f6ad662013-10-25 09:08:21 +010080
Julius Werner53456fc2019-07-09 13:49:11 -070081#endif /* __ASSEMBLER__ */
Julius Werner94f89072017-07-31 18:15:11 -070082
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +000083#endif /* CONSOLE_H */