wip add compile time BUF/UART dispatching for logger

Author: antmak

CMakeLists.txt

@@ -22,7 +22,6 @@ target_include_directories(${ESP_STUB_LIB}
     PRIVATE include/esp-stub-lib
 )
 
-message("DBG ESP_STUB_LIB: ${ESP_STUB_LIB}, STUB_COMPILE_DEFS: ${STUB_COMPILE_DEFS}")
 # STUB_COMPILE_DEFS is optional definitions coming from the parent CMakeLists.txt
 target_compile_definitions(${ESP_STUB_LIB} PRIVATE ${STUB_COMPILE_DEFS})
 

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")
 add_subdirectory(${PROJECT_ROOT} esp-stub-lib)
 target_link_libraries(${PROJECT_NAME} PRIVATE esp-stub-lib)

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() stub_lib_log_init(STUB_LIB_LOG_DEST_UART)
-#define STUB_LOG(fmt, ...) stub_lib_log_printf(fmt, ##__VA_ARGS__)
-#else
-#define STUB_LOG_INIT()
-#define STUB_LOG(fmt, ...)
-#endif
-
 static  __attribute__((unused)) int handle_test1(va_list ap)
 {
     (void)ap;

include/esp-stub-lib/log.h

@@ -6,20 +6,32 @@
 
 #pragma once
 
-#include <stdint.h>
+#if defined(STUB_LOG_ENABLED)
 
-enum stub_lib_log_destination {
-	STUB_LIB_LOG_DEST_NONE,
-	STUB_LIB_LOG_DEST_UART, /* using default UART configuration */
-	STUB_LIB_LOG_DEST_BUF, /* using a SRAM buffer for logging, that passed back via g_stub_lib_log_buf */
-};
+#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>
 
 /* should be power of 2 */
 #define STUB_LIB_LOG_BUF_SIZE 4096
 struct stub_lib_log_buf {
-	uint32_t count;
-	char buf[STUB_LIB_LOG_BUF_SIZE];
+    uint32_t count;
+    char buf[STUB_LIB_LOG_BUF_SIZE];
 };
+#endif // defined(STUB_LIB_LOG_BUF)
 
-void stub_lib_log_init(enum stub_lib_log_destination dest);
+void stub_lib_log_init();
 void stub_lib_log_printf(const char *fmt, ...);
+
+#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)

src/log.c

@@ -5,6 +5,8 @@
  */
 #include <log.h>
 
+#if defined(STUB_LOG_ENABLED)
+
 #include <stdint.h>
 #include <stdarg.h>
 #include <stddef.h>
@@ -18,30 +20,27 @@ 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));
 
-static enum stub_lib_log_destination s_log_dest = STUB_LIB_LOG_DEST_BUF;
-
-static struct stub_lib_log_buf g_stub_lib_log_buf;
-
-static void log_buf_write(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 - 1);
 }
+#endif // defined(STUB_LIB_LOG_BUF)
 
-void stub_lib_log_init(enum stub_lib_log_destination dest)
+void stub_lib_log_init()
 {
-    if (dest == STUB_LIB_LOG_DEST_UART) {
-        stub_target_uart_init(0, 115200);
-        //fixme: call ets_install_putc1(0)/putc2(0) here?
-        ets_install_uart_printf();
-        s_log_dest = STUB_LIB_LOG_DEST_UART;
-    } else if (dest == STUB_LIB_LOG_DEST_BUF) {
-        ets_install_putc1(log_buf_write);
-        ets_install_putc2(NULL);
-        s_log_dest = STUB_LIB_LOG_DEST_BUF;
-    } else {
-        s_log_dest = STUB_LIB_LOG_DEST_NONE;
-    }
+#if defined(STUB_LIB_LOG_UART)
+    stub_target_uart_init(0, 115200);
+    //fixme: call ets_install_putc1(0)/putc2(0) here?
+    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.
@@ -99,3 +98,5 @@ void stub_lib_log_printf(const char *fmt, ...)
     }
     va_end(args);
 }
+
+#endif // defined(STUB_LOG_ENABLED)