logger: add logging to a RAM buffer

antmak · antmak · commit 456586abb222 · 2025-04-27T10:46:53.000+07:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -10,6 +10,8 @@ if(NOT ESP_TARGET_LIB)
     set(ESP_TARGET_LIB ${ESP_TARGET})
 endif()
 
+set(STUB_LIB_SHORT_INC "${CMAKE_CURRENT_SOURCE_DIR}/include/esp-stub-lib")
+
 set(srcs
     src/log.c
     src/flash.c
@@ -18,8 +20,8 @@ set(srcs
 add_library(${ESP_STUB_LIB} STATIC ${srcs})
 
 target_include_directories(${ESP_STUB_LIB}
-    PUBLIC include
-    PRIVATE include/esp-stub-lib
+    INTERFACE include
+    PRIVATE ${STUB_LIB_SHORT_INC}
 )
 
 # STUB_COMPILE_DEFS is optional definitions coming from the parent CMakeLists.txt
diff --git a/example/CMakeLists.txt b/example/CMakeLists.txt
@@ -51,5 +51,6 @@ add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD
 )
 
 get_filename_component(PROJECT_ROOT ${CMAKE_CURRENT_LIST_DIR}/.. ABSOLUTE)
+set(STUB_COMPILE_DEFS "STUB_LOG_ENABLED;STUB_LIB_LOG_BUF;STUB_LIB_LOG_BUF_SIZE=2048")
 add_subdirectory(${PROJECT_ROOT} esp-stub-lib)
 target_link_libraries(${PROJECT_NAME} PRIVATE esp-stub-lib)
diff --git a/example/stub_main.c b/example/stub_main.c
@@ -22,14 +22,6 @@ struct stub_cmd_handler {
     int (*handler)(va_list ap);
 };
 
-#ifdef STUB_LOG_ENABLED
-#define STUB_LOG_INIT(uart_num, baudrate) stub_lib_log_init(uart_num, baudrate)
-#define STUB_LOG(fmt, ...) stub_lib_log_printf(fmt, ##__VA_ARGS__)
-#else
-#define STUB_LOG_INIT(uart_num, baudrate)
-#define STUB_LOG(fmt, ...)
-#endif
-
 static  __attribute__((unused)) int handle_test1(va_list ap)
 {
     (void)ap;
@@ -84,7 +76,7 @@ int stub_main(int cmd, ...)
 
     va_start(ap, cmd);
 
-    STUB_LOG_INIT(0, 115200);
+    STUB_LOG_INIT();
 
     stub_lib_flash_init(&flash_state);
 
diff --git a/include/esp-stub-lib/log.h b/include/esp-stub-lib/log.h
@@ -6,15 +6,42 @@
 
 #pragma once
 
+#if defined(STUB_LOG_ENABLED)
+
+#if !defined(STUB_LIB_LOG_BUF) && !defined(STUB_LIB_LOG_UART)
+#define STUB_LIB_LOG_BUF
+#endif
+
+#if defined(STUB_LIB_LOG_BUF)
 #include <stdint.h>
 
+#if !defined(STUB_LIB_LOG_BUF_SIZE)
+#define STUB_LIB_LOG_BUF_SIZE 4096
+#endif
+
+struct stub_lib_log_buf {
+    uint32_t count;
+    char buf[STUB_LIB_LOG_BUF_SIZE];
+};
+#endif // defined(STUB_LIB_LOG_BUF)
+
 #ifdef __cplusplus
 extern "C" {
 #endif // __cplusplus
 
-void stub_lib_log_init(uint8_t uart_num, uint32_t baudrate);
+void stub_lib_log_init();
 void stub_lib_log_printf(const char *fmt, ...);
 
 #ifdef __cplusplus
 }
 #endif // __cplusplus
+
+#define STUB_LOG_INIT() stub_lib_log_init()
+#define STUB_LOG(fmt, ...) stub_lib_log_printf(fmt, ##__VA_ARGS__)
+
+#else // defined(STUB_LOG_ENABLED)
+
+#define STUB_LOG_INIT()
+#define STUB_LOG(fmt, ...)
+
+#endif // defined(STUB_LOG_ENABLED)
diff --git a/src/esp32/CMakeLists.txt b/src/esp32/CMakeLists.txt
@@ -8,7 +8,7 @@ add_library(${ESP_TARGET_LIB} STATIC ${srcs})
 
 target_include_directories(${ESP_TARGET_LIB}
     PUBLIC include
-    PRIVATE include/target
+    PRIVATE include/target ${STUB_LIB_SHORT_INC}
 )
-
+target_compile_definitions(${ESP_TARGET_LIB} PRIVATE ${STUB_COMPILE_DEFS})
 target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32.rom.ld)
diff --git a/src/esp32c2/CMakeLists.txt b/src/esp32c2/CMakeLists.txt
@@ -7,7 +7,7 @@ add_library(${ESP_TARGET_LIB} STATIC ${srcs})
 
 target_include_directories(${ESP_TARGET_LIB}
     PUBLIC include
-    PRIVATE include/target
+    PRIVATE include/target ${STUB_LIB_SHORT_INC}
 )
-
+target_compile_definitions(${ESP_TARGET_LIB} PRIVATE ${STUB_COMPILE_DEFS})
 target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32c2.rom.ld)
diff --git a/src/esp32c3/CMakeLists.txt b/src/esp32c3/CMakeLists.txt
@@ -7,7 +7,7 @@ add_library(${ESP_TARGET_LIB} STATIC ${srcs})
 
 target_include_directories(${ESP_TARGET_LIB}
     PUBLIC include
-    PRIVATE include/target
+    PRIVATE include/target ${STUB_LIB_SHORT_INC}
 )
-
+target_compile_definitions(${ESP_TARGET_LIB} PRIVATE ${STUB_COMPILE_DEFS})
 target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32c3.rom.ld)
diff --git a/src/esp32c5/CMakeLists.txt b/src/esp32c5/CMakeLists.txt
@@ -7,7 +7,7 @@ add_library(${ESP_TARGET_LIB} STATIC ${srcs})
 
 target_include_directories(${ESP_TARGET_LIB}
     PUBLIC include
-    PRIVATE include/target
+    PRIVATE include/target ${STUB_LIB_SHORT_INC}
 )
-
+target_compile_definitions(${ESP_TARGET_LIB} PRIVATE ${STUB_COMPILE_DEFS})
 target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32c5.rom.ld)
diff --git a/src/esp32c6/CMakeLists.txt b/src/esp32c6/CMakeLists.txt
@@ -7,7 +7,7 @@ add_library(${ESP_TARGET_LIB} STATIC ${srcs})
 
 target_include_directories(${ESP_TARGET_LIB}
     PUBLIC include
-    PRIVATE include/target
+    PRIVATE include/target ${STUB_LIB_SHORT_INC}
 )
-
+target_compile_definitions(${ESP_TARGET_LIB} PRIVATE ${STUB_COMPILE_DEFS})
 target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32c6.rom.ld)
diff --git a/src/esp32c61/CMakeLists.txt b/src/esp32c61/CMakeLists.txt
@@ -7,7 +7,7 @@ add_library(${ESP_TARGET_LIB} STATIC ${srcs})
 
 target_include_directories(${ESP_TARGET_LIB}
     PUBLIC include
-    PRIVATE include/target
+    PRIVATE include/target ${STUB_LIB_SHORT_INC}
 )
-
+target_compile_definitions(${ESP_TARGET_LIB} PRIVATE ${STUB_COMPILE_DEFS})
 target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32c61.rom.ld)
diff --git a/src/esp32h2/CMakeLists.txt b/src/esp32h2/CMakeLists.txt
@@ -7,7 +7,7 @@ add_library(${ESP_TARGET_LIB} STATIC ${srcs})
 
 target_include_directories(${ESP_TARGET_LIB}
     PUBLIC include
-    PRIVATE include/target
+    PRIVATE include/target ${STUB_LIB_SHORT_INC}
 )
-
+target_compile_definitions(${ESP_TARGET_LIB} PRIVATE ${STUB_COMPILE_DEFS})
 target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32h2.rom.ld)
diff --git a/src/esp32p4/CMakeLists.txt b/src/esp32p4/CMakeLists.txt
@@ -7,7 +7,7 @@ add_library(${ESP_TARGET_LIB} STATIC ${srcs})
 
 target_include_directories(${ESP_TARGET_LIB}
     PUBLIC include
-    PRIVATE include/target
+    PRIVATE include/target ${STUB_LIB_SHORT_INC}
 )
-
+target_compile_definitions(${ESP_TARGET_LIB} PRIVATE ${STUB_COMPILE_DEFS})
 target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32p4.rom.ld)
diff --git a/src/esp32s2/CMakeLists.txt b/src/esp32s2/CMakeLists.txt
@@ -8,7 +8,7 @@ add_library(${ESP_TARGET_LIB} STATIC ${srcs})
 
 target_include_directories(${ESP_TARGET_LIB}
     PUBLIC include
-    PRIVATE include/target
+    PRIVATE include/target ${STUB_LIB_SHORT_INC}
 )
-
+target_compile_definitions(${ESP_TARGET_LIB} PRIVATE ${STUB_COMPILE_DEFS})
 target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32s2.rom.ld)
diff --git a/src/esp32s3/CMakeLists.txt b/src/esp32s3/CMakeLists.txt
@@ -7,7 +7,7 @@ add_library(${ESP_TARGET_LIB} STATIC ${srcs})
 
 target_include_directories(${ESP_TARGET_LIB}
     PUBLIC include
-    PRIVATE include/target
+    PRIVATE include/target ${STUB_LIB_SHORT_INC}
 )
-
+target_compile_definitions(${ESP_TARGET_LIB} PRIVATE ${STUB_COMPILE_DEFS})
 target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32s3.rom.ld)
diff --git a/src/esp8266/CMakeLists.txt b/src/esp8266/CMakeLists.txt
@@ -7,7 +7,7 @@ add_library(${ESP_TARGET_LIB} STATIC ${srcs})
 
 target_include_directories(${ESP_TARGET_LIB}
     PUBLIC include
-    PRIVATE include/target
+    PRIVATE include/target ${STUB_LIB_SHORT_INC}
 )
-
+target_compile_definitions(${ESP_TARGET_LIB} PRIVATE ${STUB_COMPILE_DEFS})
 target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp8266.rom.ld)
diff --git a/src/log.c b/src/log.c
@@ -3,20 +3,43 @@
  *
  * SPDX-License-Identifier: Apache-2.0 OR MIT
  */
+#include <log.h>
+
+#if defined(STUB_LOG_ENABLED)
+
 #include <stdint.h>
 #include <stdarg.h>
+#include <stddef.h>
 
 #include <target/esp_rom_caps.h>
 #include <target/uart.h>
 
 // These functions are defined in the ROM
 extern void ets_install_uart_printf(void);
 extern void ets_printf(const char *fmt, ...);
+extern void ets_install_putc1(void (*p)(char c));
+extern void ets_install_putc2(void (*p)(char c));
+
+#if defined(STUB_LIB_LOG_BUF)
+struct stub_lib_log_buf g_stub_lib_log_buf;
+static void stub_lib_log_buf_write_internal(char c)
+{
+    g_stub_lib_log_buf.buf[g_stub_lib_log_buf.count] = c;
+    g_stub_lib_log_buf.count = (g_stub_lib_log_buf.count + 1) % STUB_LIB_LOG_BUF_SIZE;
+}
+#endif // defined(STUB_LIB_LOG_BUF)
 
-void stub_lib_log_init(uint8_t uart_num, uint32_t baudrate)
+void stub_lib_log_init()
 {
-    stub_target_uart_init(uart_num, baudrate);
+#if defined(STUB_LIB_LOG_UART)
+    stub_target_uart_init(0, 115200);
     ets_install_uart_printf();
+#elif defined(STUB_LIB_LOG_BUF)
+    ets_install_putc1(stub_lib_log_buf_write_internal);
+    ets_install_putc2(NULL);
+#else
+#error "STUB_LIB_LOG_X destination should be defined"
+#endif
 }
 
 // This function is designed to avoid implementing vprintf() to reduce code size.
@@ -74,3 +97,5 @@ void stub_lib_log_printf(const char *fmt, ...)
     }
     va_end(args);
 }
+
+#endif // defined(STUB_LOG_ENABLED)

Original file line number	Diff line number	Diff line change
`@@ -51,5 +51,6 @@ add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD`
`51`	`51`	`)`
`52`	`52`
`53`	`53`	`get_filename_component(PROJECT_ROOT ${CMAKE_CURRENT_LIST_DIR}/.. ABSOLUTE)`
	`54`	`+set(STUB_COMPILE_DEFS "STUB_LOG_ENABLED;STUB_LIB_LOG_BUF;STUB_LIB_LOG_BUF_SIZE=2048")`
`54`	`55`	`add_subdirectory(${PROJECT_ROOT} esp-stub-lib)`
`55`	`56`	`target_link_libraries(${PROJECT_NAME} PRIVATE esp-stub-lib)`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ add_library(${ESP_TARGET_LIB} STATIC ${srcs})`
`8`	`8`
`9`	`9`	`target_include_directories(${ESP_TARGET_LIB}`
`10`	`10`	`PUBLIC include`
`11`		`- PRIVATE include/target`
	`11`	`+ PRIVATE include/target ${STUB_LIB_SHORT_INC}`
`12`	`12`	`)`
`13`		`-`
	`13`	`+target_compile_definitions(${ESP_TARGET_LIB} PRIVATE ${STUB_COMPILE_DEFS})`
`14`	`14`	`target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32.rom.ld)`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ add_library(${ESP_TARGET_LIB} STATIC ${srcs})`
`7`	`7`
`8`	`8`	`target_include_directories(${ESP_TARGET_LIB}`
`9`	`9`	`PUBLIC include`
`10`		`- PRIVATE include/target`
	`10`	`+ PRIVATE include/target ${STUB_LIB_SHORT_INC}`
`11`	`11`	`)`
`12`		`-`
	`12`	`+target_compile_definitions(${ESP_TARGET_LIB} PRIVATE ${STUB_COMPILE_DEFS})`
`13`	`13`	`target_link_options(${ESP_TARGET_LIB} PUBLIC -T${CMAKE_CURRENT_LIST_DIR}/ld/esp32c2.rom.ld)`