Move print/debug files to quantum (qmk#12069)

* move print/debug files to quantum * Update comments
BorisTestov · Aug 3, 2021 · 33699b2 · 33699b2
1 parent ea327e1
commit 33699b2
Show file tree

Hide file tree

Showing 13 changed files with 25 additions and 44 deletions.
diff --git a/build_test.mk b/build_test.mk
@@ -63,7 +63,7 @@ endif
 $(TEST)_SRC += \
 	tests/test_common/main.c \
 	$(LIB_PATH)/printf/printf.c \
-	$(COMMON_DIR)/printf.c
+	$(QUANTUM_PATH)/logging/print.c
 
 $(TEST_OBJ)/$(TEST)_SRC := $($(TEST)_SRC)
 $(TEST_OBJ)/$(TEST)_INC := $($(TEST)_INC) $(VPATH) $(GTEST_INC)

diff --git a/common_features.mk b/common_features.mk
@@ -21,7 +21,15 @@ QUANTUM_SRC += \
     $(QUANTUM_DIR)/bitwise.c \
     $(QUANTUM_DIR)/led.c \
     $(QUANTUM_DIR)/keymap_common.c \
-    $(QUANTUM_DIR)/keycode_config.c
+    $(QUANTUM_DIR)/keycode_config.c \
+    $(QUANTUM_DIR)/logging/debug.c \
+    $(QUANTUM_DIR)/logging/sendchar.c \
+
+VPATH += $(QUANTUM_DIR)/logging
+# Fall back to lib/printf if there is no platform provided print
+ifeq ("$(wildcard $(TMK_PATH)/common/$(PLATFORM_KEY)/printf.mk)","")
+    include $(QUANTUM_PATH)/logging/print.mk
+endif
 
 ifeq ($(strip $(DEBUG_MATRIX_SCAN_RATE_ENABLE)), yes)
     OPT_DEFS += -DDEBUG_MATRIX_SCAN_RATE

diff --git a/tmk_core/common/debug.c → quantum/logging/debug.c b/tmk_core/common/debug.c → quantum/logging/debug.c
diff --git a/tmk_core/common/debug.h → quantum/logging/debug.h b/tmk_core/common/debug.h → quantum/logging/debug.h
@@ -67,7 +67,7 @@ extern debug_config_t debug_config;
         do {                                               \
             if (debug_enable) xprintf(fmt, ##__VA_ARGS__); \
         } while (0)
-#    define dmsg(s) dprintf("%s at %s: %S\n", __FILE__, __LINE__, PSTR(s))
+#    define dmsg(s) dprintf("%s at %d: %s\n", __FILE__, __LINE__, s)
 
 /* Deprecated. DO NOT USE these anymore, use dprintf instead. */
 #    define debug(s)                    \

diff --git a/tmk_core/common/nodebug.h → quantum/logging/nodebug.h b/tmk_core/common/nodebug.h → quantum/logging/nodebug.h
diff --git a/tmk_core/common/printf.c → quantum/logging/print.c b/tmk_core/common/printf.c → quantum/logging/print.c
diff --git a/tmk_core/common/print.h → quantum/logging/print.h b/tmk_core/common/print.h → quantum/logging/print.h
diff --git a/quantum/logging/print.mk b/quantum/logging/print.mk
@@ -0,0 +1,9 @@
+PRINTF_PATH = $(LIB_PATH)/printf
+
+VPATH += $(PRINTF_PATH)
+SRC += $(PRINTF_PATH)/printf.c
+QUANTUM_SRC +=$(QUANTUM_DIR)/logging/print.c
+OPT_DEFS += -DPRINTF_DISABLE_SUPPORT_FLOAT
+OPT_DEFS += -DPRINTF_DISABLE_SUPPORT_EXPONENTIAL
+OPT_DEFS += -DPRINTF_DISABLE_SUPPORT_LONG_LONG
+OPT_DEFS += -DPRINTF_DISABLE_SUPPORT_PTRDIFF_T
diff --git a/tmk_core/common/sendchar_null.c → quantum/logging/sendchar.c b/tmk_core/common/sendchar_null.c → quantum/logging/sendchar.c
@@ -16,4 +16,5 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 #include "sendchar.h"
 
+/* default noop "null" implementation */
 __attribute__((weak)) int8_t sendchar(uint8_t c) { return 0; }
diff --git a/tmk_core/common/sendchar.h → quantum/logging/sendchar.h b/tmk_core/common/sendchar.h → quantum/logging/sendchar.h
diff --git a/tmk_core/common.mk b/tmk_core/common.mk
@@ -8,22 +8,16 @@ TMK_COMMON_SRC +=	$(COMMON_DIR)/host.c \
 	$(COMMON_DIR)/action_macro.c \
 	$(COMMON_DIR)/action_layer.c \
 	$(COMMON_DIR)/action_util.c \
-	$(COMMON_DIR)/debug.c \
-	$(COMMON_DIR)/sendchar_null.c \
 	$(COMMON_DIR)/eeconfig.c \
 	$(COMMON_DIR)/report.c \
+	$(COMMON_DIR)/sync_timer.c \
 	$(COMMON_DIR)/usb_util.c \
 	$(PLATFORM_COMMON_DIR)/suspend.c \
 	$(PLATFORM_COMMON_DIR)/timer.c \
-	$(COMMON_DIR)/sync_timer.c \
 	$(PLATFORM_COMMON_DIR)/bootloader.c \
 
-# Use platform provided print - fall back to lib/printf
-ifneq ("$(wildcard $(TMK_PATH)/$(PLATFORM_COMMON_DIR)/printf.mk)","")
-    include $(TMK_PATH)/$(PLATFORM_COMMON_DIR)/printf.mk
-else
-    include $(TMK_PATH)/$(COMMON_DIR)/lib_printf.mk
-endif
+# Use platform provided print if it exists
+-include $(TMK_PATH)/$(PLATFORM_COMMON_DIR)/printf.mk
 
 SHARED_EP_ENABLE = no
 MOUSE_SHARED_EP ?= yes
@@ -55,6 +49,7 @@ endif
 ifeq ($(strip $(CONSOLE_ENABLE)), yes)
     TMK_COMMON_DEFS += -DCONSOLE_ENABLE
 else
+    # TODO: decouple this so other print backends can exist
     TMK_COMMON_DEFS += -DNO_PRINT
     TMK_COMMON_DEFS += -DNO_DEBUG
 endif

diff --git a/tmk_core/common/lib_printf.mk b/tmk_core/common/lib_printf.mk
diff --git a/tmk_core/common/sendchar_uart.c b/tmk_core/common/sendchar_uart.c