mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-08-17 09:57:01 +02:00
09d40e0e08
Enforce full include path for includes. Deprecate old paths.
The following folders inside include/lib have been left unchanged:
- include/lib/cpus/${ARCH}
- include/lib/el3_runtime/${ARCH}
The reason for this change is that having a global namespace for
includes isn't a good idea. It defeats one of the advantages of having
folders and it introduces problems that are sometimes subtle (because
you may not know the header you are actually including if there are two
of them).
For example, this patch had to be created because two headers were
called the same way: e0ea0928d5 ("Fix gpio includes of mt8173 platform
to avoid collision."). More recently, this patch has had similar
problems: 46f9b2c3a2 ("drivers: add tzc380 support").
This problem was introduced in commit 4ecca33988 ("Move include and
source files to logical locations"). At that time, there weren't too
many headers so it wasn't a real issue. However, time has shown that
this creates problems.
Platforms that want to preserve the way they include headers may add the
removed paths to PLAT_INCLUDES, but this is discouraged.
Change-Id: I39dc53ed98f9e297a5966e723d1936d6ccf2fc8f
Signed-off-by: Antonio Nino Diaz <antonio.ninodiaz@arm.com>
87 lines
3.0 KiB
C
87 lines
3.0 KiB
C
/*
|
|
* Copyright (c) 2013-2018, ARM Limited and Contributors. All rights reserved.
|
|
*
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*/
|
|
|
|
#ifndef CONSOLE_H
|
|
#define CONSOLE_H
|
|
|
|
#include <lib/utils_def.h>
|
|
|
|
#define CONSOLE_T_NEXT (U(0) * REGSZ)
|
|
#define CONSOLE_T_FLAGS (U(1) * REGSZ)
|
|
#define CONSOLE_T_PUTC (U(2) * REGSZ)
|
|
#define CONSOLE_T_GETC (U(3) * REGSZ)
|
|
#define CONSOLE_T_FLUSH (U(4) * REGSZ)
|
|
#define CONSOLE_T_DRVDATA (U(5) * REGSZ)
|
|
|
|
#define CONSOLE_FLAG_BOOT (U(1) << 0)
|
|
#define CONSOLE_FLAG_RUNTIME (U(1) << 1)
|
|
#define CONSOLE_FLAG_CRASH (U(1) << 2)
|
|
/* Bits 3 to 7 reserved for additional scopes in future expansion. */
|
|
#define CONSOLE_FLAG_SCOPE_MASK ((U(1) << 8) - 1)
|
|
/* Bits 8 to 31 reserved for non-scope use in future expansion. */
|
|
|
|
/* Returned by getc callbacks when receive FIFO is empty. */
|
|
#define ERROR_NO_PENDING_CHAR (-1)
|
|
/* Returned by console_xxx() if no registered console implements xxx. */
|
|
#define ERROR_NO_VALID_CONSOLE (-128)
|
|
|
|
#ifndef __ASSEMBLY__
|
|
|
|
#include <stdint.h>
|
|
|
|
typedef struct console {
|
|
struct console *next;
|
|
/*
|
|
* Only the low 32 bits are used. The type is u_register_t to align the
|
|
* fields of the struct to 64 bits in AArch64 and 32 bits in AArch32
|
|
*/
|
|
u_register_t flags;
|
|
int (*const putc)(int character, struct console *console);
|
|
int (*const getc)(struct console *console);
|
|
int (*const flush)(struct console *console);
|
|
/* Additional private driver data may follow here. */
|
|
} console_t;
|
|
|
|
/* offset macro assertions for console_t */
|
|
#include <drivers/console_assertions.h>
|
|
|
|
/*
|
|
* NOTE: There is no publicly accessible console_register() function. Consoles
|
|
* are registered by directly calling the register function of a specific
|
|
* implementation, e.g. console_16550_register() from <uart_16550.h>. Consoles
|
|
* registered that way can be unregistered/reconfigured with below functions.
|
|
*/
|
|
/* Remove a single console_t instance from the console list. Return a pointer to
|
|
* the console that was removed if it was found, or NULL if not. */
|
|
console_t *console_unregister(console_t *console);
|
|
/* Returns 1 if this console is already registered, 0 if not */
|
|
int console_is_registered(console_t *console);
|
|
/*
|
|
* Set scope mask of a console that determines in what states it is active.
|
|
* By default they are registered with (CONSOLE_FLAG_BOOT|CONSOLE_FLAG_CRASH).
|
|
*/
|
|
void console_set_scope(console_t *console, unsigned int scope);
|
|
|
|
/* Switch to a new global console state (CONSOLE_FLAG_BOOT/RUNTIME/CRASH). */
|
|
void console_switch_state(unsigned int new_state);
|
|
/* Output a character on all consoles registered for the current state. */
|
|
int console_putc(int c);
|
|
/* Read a character (blocking) from any console registered for current state. */
|
|
int console_getc(void);
|
|
/* Flush all consoles registered for the current state. */
|
|
int console_flush(void);
|
|
|
|
#if !MULTI_CONSOLE_API
|
|
/* REMOVED on AArch64 -- use console_<driver>_register() instead! */
|
|
int console_init(uintptr_t base_addr,
|
|
unsigned int uart_clk, unsigned int baud_rate);
|
|
void console_uninit(void);
|
|
#endif
|
|
|
|
#endif /* __ASSEMBLY__ */
|
|
|
|
#endif /* CONSOLE_H */
|