Refactor debug helpers for compile-time gating

Add a shared `debug_config.h` with a `kIsDebug` compile-time flag and update the dump/bit-print helpers to use `if constexpr` instead of `#ifdef NDEBUG`. This keeps the APIs available in all builds while still compiling debug output out of release builds, and also brings the debug header copyright text in line with the project license block.

Author: vanvught

common/include/firmware/debug/debug_config.h

@@ -0,0 +1,37 @@
+/**
+ * @file debug_config.h
+ *
+ */
+/* Copyright (C) 2026 by Arjan van Vught mailto:info@gd32-dmx.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef FIRMWARE_DEBUG_DEBUG_CONFIG_H_
+#define FIRMWARE_DEBUG_DEBUG_CONFIG_H_
+
+namespace debug {
+#ifdef NDEBUG
+constexpr bool kIsDebug = false;
+#else
+constexpr bool kIsDebug = true;
+#endif
+} // namespace debug
+
+#endif // FIRMWARE_DEBUG_DEBUG_CONFIG_H_

common/include/firmware/debug/debug_debug.h

@@ -2,7 +2,26 @@
  * @file debug_debug.h
  *
  */
-/* Copyright (C) 2018-2026 by Arjan van Vught mailto:info@gd32-dmx.org */
+/* Copyright (C) 2018-2026 by Arjan van Vught mailto:info@gd32-dmx.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
 
 #ifndef FIRMWARE_DEBUG_DEBUG_H_
 #define FIRMWARE_DEBUG_DEBUG_H_
@@ -23,9 +42,9 @@
         printf("<- %s(%u):%s\n", loc.file_name(), static_cast<unsigned>(loc.line()), loc.function_name()); \
     } while (0)
 
-#define DEBUG_PRINTF(fmt, ...)                                                                                                                   \
-    do {                                                                                                                                         \
-        const std::source_location loc = std::source_location::current();                                                                        \
+#define DEBUG_PRINTF(fmt, ...)                                                                                                                 \
+    do {                                                                                                                                       \
+        const std::source_location loc = std::source_location::current();                                                                      \
         printf("   %s(%u):%s: " fmt "\n", loc.file_name(), static_cast<unsigned>(loc.line()), loc.function_name() __VA_OPT__(, ) __VA_ARGS__); \
     } while (0)
 

common/include/firmware/debug/debug_dump.h

@@ -30,68 +30,68 @@
 #include <cstdio>
 #include <ctype.h>
 
+#include "firmware/debug/debug_config.h"
+
 namespace debug {
-#ifdef NDEBUG
-static inline void Dump([[maybe_unused]] const void* data, [[maybe_unused]] uint32_t size) {}
-#else
-inline void Dump(const void* data, uint32_t size) {
-    constexpr uint32_t kCharsPerLine = 16;
-    constexpr uint32_t kBytesPerGroup = 8; // Visual separator every 8 bytes
-    const auto* ptr = reinterpret_cast<const uint8_t*>(data);
-    uint32_t chars = 0;
-
-    printf("%p:%u\n", data, static_cast<unsigned>(size));
-
-    do {
-        printf("%04x ", static_cast<unsigned>(chars));
-
-        uint32_t chars_this_line = 0;
-        const auto* line_start_ptr = ptr;
-
-        while ((chars_this_line < kCharsPerLine) && (chars < size)) {
-            if (chars_this_line % kBytesPerGroup == 0) {
-                printf(" ");
-            }
+inline void Dump([[maybe_unused]] const void* data, [[maybe_unused]] uint32_t size) {
+    if constexpr (kIsDebug) {
+        constexpr uint32_t kCharsPerLine = 16;
+        constexpr uint32_t kBytesPerGroup = 8; // Visual separator every 8 bytes
+        const auto* ptr = reinterpret_cast<const uint8_t*>(data);
+        uint32_t chars = 0;
 
-            printf("%02x ", *ptr);
+        printf("%p:%u\n", data, static_cast<unsigned>(size));
 
-            chars_this_line++;
-            chars++;
-            ptr++;
-        }
+        do {
+            printf("%04x ", static_cast<unsigned>(chars));
 
-        auto chars_dot_line = chars_this_line;
+            uint32_t chars_this_line = 0;
+            const auto* line_start_ptr = ptr;
 
-        for (; chars_this_line < kCharsPerLine; chars_this_line++) {
-            if (chars_this_line % kBytesPerGroup == 0) {
-                printf(" ");
-            }
-            printf("   ");
-        }
+            while ((chars_this_line < kCharsPerLine) && (chars < size)) {
+                if (chars_this_line % kBytesPerGroup == 0) {
+                    printf(" ");
+                }
 
-        chars_this_line = 0;
+                printf("%02x ", *ptr);
 
-        while (chars_this_line < chars_dot_line) {
-            if (chars_this_line % kBytesPerGroup == 0) {
-                printf(" ");
+                chars_this_line++;
+                chars++;
+                ptr++;
             }
 
-            int character = *line_start_ptr;
-            if (0 != isprint(character)) {
-                printf("%c", character);
-            } else {
-                printf(".");
+            auto chars_dot_line = chars_this_line;
+
+            for (; chars_this_line < kCharsPerLine; chars_this_line++) {
+                if (chars_this_line % kBytesPerGroup == 0) {
+                    printf(" ");
+                }
+                printf("   ");
             }
 
-            chars_this_line++;
-            line_start_ptr++;
-        }
+            chars_this_line = 0;
+
+            while (chars_this_line < chars_dot_line) {
+                if (chars_this_line % kBytesPerGroup == 0) {
+                    printf(" ");
+                }
+
+                int character = *line_start_ptr;
+                if (0 != isprint(character)) {
+                    printf("%c", character);
+                } else {
+                    printf(".");
+                }
+
+                chars_this_line++;
+                line_start_ptr++;
+            }
 
-        puts("");
+            puts("");
 
-    } while (chars < size);
+        } while (chars < size);
+    }
 }
-#endif
 } // namespace debug
 
 #endif /* COMMON_DEBUG_DEBUG_DUMP_H_ */

common/include/firmware/debug/debug_printbits.h

@@ -27,27 +27,27 @@
 #define COMMON_DEBUG_DEBUG_PRINTBITS_H_
 
 #include <cstdint>
+#include <cstdio>
+
+#include "firmware/debug/debug_config.h"
 
 namespace debug {
-#ifdef NDEBUG
-inline void PrintBits([[maybe_unused]] uint32_t u) {}
-#else
-#include <cstdio>
-inline void PrintBits(uint32_t u) {
-    printf("%.8x ", static_cast<unsigned>(u));
-    uint32_t b = 1U << 31;
-
-    for (uint32_t i = 0; i < 32; i++) {
-        if ((b & u) == b) {
-            uint32_t bit_number = 31 - i;
-            printf("%-2u ", static_cast<unsigned>(bit_number));
+inline void PrintBits([[maybe_unused]] uint32_t u) {
+    if constexpr (kIsDebug) {
+        printf("%.8x ", static_cast<unsigned>(u));
+        uint32_t bit = 1U << 31;
+
+        for (uint32_t i = 0; i < 32; i++) {
+            if ((bit & u) == bit) {
+                uint32_t bit_number = 31 - i;
+                printf("%-2u ", static_cast<unsigned>(bit_number));
+            }
+            bit = bit >> 1;
         }
-        b = b >> 1;
-    }
 
-    puts("");
+        puts("");
+    }
 }
-#endif
 } // namespace debug
 
 #endif // COMMON_DEBUG_DEBUG_PRINTBITS_H_