LIB: Add logging libraries
Add tfm_log, tfm_log_unpriv and their underlying implementation,
tfm_vprintf. This adds three separate libraries. The intended use case
is:
- tfm_log: General logging in bootloaders and SPM. Calls directly into
stdio_output_string so requires the correct privileges to access the
UART.
- tfm_log_unpriv: A separate API for logging from unprivileged
components (such as SPs). This calls into tfm_hal_output_sp_log to
output the string (which does an SVC).
- tfm_vprintf: Common code used by both libraries which is shared.
Change-Id: Ib75cc241d4d16252e5ea6fedc3a2c2bc206c5a87
Signed-off-by: Jackson Cooper-Driver <jackson.cooper-driver@arm.com>
diff --git a/lib/tfm_vprintf/CMakeLists.txt b/lib/tfm_vprintf/CMakeLists.txt
new file mode 100644
index 0000000..eff7337
--- /dev/null
+++ b/lib/tfm_vprintf/CMakeLists.txt
@@ -0,0 +1,26 @@
+#-------------------------------------------------------------------------------
+# Copyright (c) 2024, Arm Limited. All rights reserved.
+#
+# SPDX-License-Identifier: BSD-3-Clause
+#
+#-------------------------------------------------------------------------------
+
+cmake_minimum_required(VERSION 3.21)
+
+add_library(tfm_vprintf_headers INTERFACE)
+add_library(tfm_vprintf STATIC)
+
+target_sources(tfm_vprintf
+ PRIVATE
+ src/tfm_vprintf.c
+)
+
+target_include_directories(tfm_vprintf_headers
+ INTERFACE
+ $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/inc>
+)
+
+target_link_libraries(tfm_vprintf
+ PUBLIC
+ tfm_vprintf_headers
+)
diff --git a/lib/tfm_vprintf/inc/tfm_vprintf.h b/lib/tfm_vprintf/inc/tfm_vprintf.h
new file mode 100644
index 0000000..0678b10
--- /dev/null
+++ b/lib/tfm_vprintf/inc/tfm_vprintf.h
@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2013-2024, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+/*
+ * Based on TF-A include/common/debug.h
+ */
+
+#ifndef __TF_M_VPRINTF_H__
+#define __TF_M_VPRINTF_H__
+
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdarg.h>
+
+/*
+ * The log output macros print output to the console. These macros produce
+ * compiled log output only if the LOG_LEVEL defined in the CMake (or the
+ * make command line) is greater or equal than the level required for that
+ * type of log output.
+ *
+ * The format expected is the same as for printf(). For example:
+ * INFO("Info %s.\n", "message") -> '[INF]: Info message.'
+ * WARN("Warning %s.\n", "message") ->'[WAR]: Warning message.'
+ */
+#define LOG_LEVEL_NONE UINT8_C(0)
+#define LOG_LEVEL_ERROR UINT8_C(10)
+#define LOG_LEVEL_NOTICE UINT8_C(20)
+#define LOG_LEVEL_WARNING UINT8_C(30)
+#define LOG_LEVEL_INFO UINT8_C(40)
+#define LOG_LEVEL_VERBOSE UINT8_C(50)
+
+/*
+ * Define Log Markers corresponding to each log level which will
+ * be embedded in the format string and is expected by tfm_vprintf() to determine
+ * the log level.
+ */
+#define LOG_MARKER_ERROR "\xa" /* 10 */
+#define LOG_MARKER_NOTICE "\x14" /* 20 */
+#define LOG_MARKER_WARNING "\x1e" /* 30 */
+#define LOG_MARKER_INFO "\x28" /* 40 */
+#define LOG_MARKER_VERBOSE "\x32" /* 50 */
+
+/* Function called to output a string to the terminal */
+typedef void (*tfm_log_output_str)(void *priv, const unsigned char *str, uint32_t len);
+
+/* Function to generate formatted string and pass to output_func */
+void tfm_vprintf(tfm_log_output_str output_func, void *priv, const char *fmt, va_list args);
+
+#endif /* __TF_M_VPRINTF_H__ */
diff --git a/lib/tfm_vprintf/src/tfm_vprintf.c b/lib/tfm_vprintf/src/tfm_vprintf.c
new file mode 100644
index 0000000..4120f10
--- /dev/null
+++ b/lib/tfm_vprintf/src/tfm_vprintf.c
@@ -0,0 +1,172 @@
+/*
+ * Copyright (c) 2017-2024, Arm Limited. All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ */
+/*
+ * Based on TF-A common/tf_log.c
+ */
+
+#include <assert.h>
+#include <stdarg.h>
+#include <stdint.h>
+#include <stddef.h>
+
+#include "tfm_vprintf.h"
+
+static inline const char *get_log_prefix(uint8_t log_level)
+{
+ switch(log_level) {
+ case LOG_LEVEL_ERROR:
+ return "[ERR]";
+ case LOG_LEVEL_NOTICE:
+ return "[NOT]";
+ case LOG_LEVEL_WARNING:
+ return "[WAR]";
+ case LOG_LEVEL_INFO:
+ return "[INF]";
+ case LOG_LEVEL_VERBOSE:
+ return "[VER]";
+ default:
+ /* String must start with LOG_MARKER_* */
+ assert(0);
+ }
+}
+
+static void output_char(tfm_log_output_str output_func, void *priv, char c)
+{
+ output_func(priv, (const unsigned char *)&c, 1);
+}
+
+static void output_str(tfm_log_output_str output_func, void *priv, const char *str)
+{
+ uint32_t len = 0;
+ const char *str_ptr = str;
+
+ while (*str_ptr++ != '\0') {
+ len++;
+ }
+
+ output_func(priv, (const unsigned char *)str, len);
+}
+
+static void output_val(tfm_log_output_str output_func, void *priv, uint32_t val,
+ uint16_t num_padding, bool zero_padding)
+{
+ uint8_t digit, chars_to_print;
+ uint16_t i;
+ char buf[9];
+ char *const buf_end = &buf[sizeof(buf) - 1];
+ char *buf_ptr = buf_end;
+ const char pad_char = zero_padding ? '0' : ' ';
+
+ /* Ensure buffer ends with NULL character */
+ *buf_ptr-- = '\0';
+
+ do {
+ digit = val & 0xf;
+
+ if (digit < 10) {
+ *buf_ptr-- = '0' + digit;
+ } else {
+ *buf_ptr-- = 'a' + digit - 10;
+ }
+
+ val >>= 4;
+ } while (val);
+
+ chars_to_print = (buf_end - 1) - buf_ptr;
+ if (num_padding > chars_to_print) {
+ num_padding -= chars_to_print;
+ } else {
+ num_padding = 0;
+ }
+
+ for (i = 0; i < num_padding; i++) {
+ output_char(output_func, priv, pad_char);
+ }
+
+ output_str(output_func, priv, buf_ptr + 1);
+}
+
+/* Basic vprintf, understands:
+ * %s: output string
+ * %x: output uint32_t in hex
+ */
+static void tfm_vprintf_internal(tfm_log_output_str output_func,
+ void *priv, const char *fmt, va_list args)
+{
+ char c;
+ bool formatting = false;
+ uint16_t num_padding = 0;
+ bool zero_padding = false;
+
+ while ((c = *fmt++) != '\0') {
+ if (c == '%') {
+ zero_padding = false;
+ num_padding = 0;
+ formatting = true;
+ continue;
+ }
+
+ if (!formatting) {
+ if (c == '\n') {
+ output_char(output_func, priv, '\r');
+ }
+ output_char(output_func, priv, c);
+ continue;
+ }
+
+ switch (c) {
+ case 'l':
+ continue;
+ case 'x':
+ output_val(output_func, priv, va_arg(args, uint32_t), num_padding, zero_padding);
+ break;
+ case 's':
+ output_str(output_func, priv, va_arg(args, char *));
+ break;
+ case '0':
+ if (num_padding == 0) {
+ zero_padding = true;
+ continue;
+ }
+ /* fallthrough */
+ case '1':
+ case '2':
+ case '3':
+ case '4':
+ case '5':
+ case '6':
+ case '7':
+ case '8':
+ case '9':
+ num_padding *= 10;
+ num_padding += c - '0';
+ continue;
+ case '%':
+ output_char(output_func, priv, '%');
+ break;
+ default:
+ output_str(output_func, priv, "[Unsupported]");
+ }
+
+ formatting = false;
+ }
+}
+
+void tfm_vprintf(tfm_log_output_str output_func, void *priv, const char *fmt, va_list args)
+{
+ uint8_t log_level;
+ const char spacer = ' ';
+
+ /* We expect the LOG_MARKER_* macro as the first character */
+ log_level = fmt[0];
+ fmt++;
+
+ output_str(output_func, priv, get_log_prefix(log_level));
+ output_char(output_func, priv, spacer);
+
+ tfm_vprintf_internal(output_func, priv, fmt, args);
+}