Improve assertions, update copyrights & formatting

vanvught · vanvught · commit 90a45cdfc5c2 · 2026-02-05T16:20:08.000+01:00
Replace bare assert(0) usages with assert(false &amp;&amp; "&lt;message&gt;") or assert(false) to provide clearer diagnostics and mark unreachable cases. Update copyright years to include 2026 across several GD32/HAL files. Apply minor whitespace, include ordering and formatting fixes, adjust NDEBUG handling in pixel DMX JSON code, and small API/indentation cleanups. Affected files include artnet, e131, gd32, hal and pixeldmx source/header files.
diff --git a/lib-artnet/src/controller/artnetcontroller.cpp b/lib-artnet/src/controller/artnetcontroller.cpp
@@ -534,7 +534,7 @@ void ArtNetController::ActiveUniversesAdd(uint16_t universe)
 
     if (m_nActiveUniverses == (sizeof(s_active_universes) / sizeof(s_active_universes[0])))
     {
-        assert(0);
+        assert(false);
         return;
     }
 
diff --git a/lib-artnet/src/node/artnetnode.cpp b/lib-artnet/src/node/artnetnode.cpp
@@ -2,7 +2,6 @@
  * @file artnetnode.cpp
  *
  */
-
 /* Copyright (C) 2016-2026 by Arjan van Vught mailto:info@gd32-dmx.org
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -557,13 +556,13 @@ void ArtNetNode::SetFailSafe(artnet::FailSafe fail_safe)
 
         case artnet::FailSafe::kRecord:
 #if defined(ARTNET_HAVE_FAILSAFE_RECORD)
-            assert(0);
+            assert(false && "case artnet::FailSafe::kRecord");
             __builtin_unreachable();
 #endif
             break;
 
         default:
-            [[unlikely]] assert(0);
+            [[unlikely]] assert(false && "Invalid fail_safe");
             __builtin_unreachable();
             break;
     }
@@ -672,7 +671,7 @@ void ArtNetNode::SetNetworkDataLossCondition()
 #endif
             break;
         default:
-            assert(0);
+            assert(false && "Invalid kNetworkloss");
             break;
     }
 
diff --git a/lib-e131/src/node/e131bridge.cpp b/lib-e131/src/node/e131bridge.cpp
@@ -49,7 +49,7 @@
 #include "hal_panelled.h"
 #include "hal_statusled.h"
 #include "hal.h"
- #include "firmware/debug/debug_debug.h"
+#include "firmware/debug/debug_debug.h"
 
 E131Bridge::E131Bridge()
 {
@@ -79,7 +79,7 @@ E131Bridge::E131Bridge()
 #if defined(E131_HAVE_DMXIN) || defined(NODE_SHOWFILE)
     char source_name[e131::kSourceNameLength];
     uint8_t length;
-    snprintf(source_name, e131::kSourceNameLength, "%.48s %s",  network::iface::HostName(), hal::BoardName(length));
+    snprintf(source_name, e131::kSourceNameLength, "%.48s %s", network::iface::HostName(), hal::BoardName(length));
     SetSourceName(source_name);
 
     hal::UuidCopy(cid_);
@@ -348,12 +348,12 @@ void E131Bridge::SetUniverse(uint32_t port_index, uint16_t universe)
 
     assert(port_index < dmxnode::kMaxPorts);
     assert((universe >= e131::universe::kDefault) && (universe <= e131::universe::kMax));
-    
+
     if (bridge_.port[port_index].universe == universe)
     {
-		DEBUG_EXIT();
-		return;
-	}
+        DEBUG_EXIT();
+        return;
+    }
 
     if (bridge_.port[port_index].direction == dmxnode::PortDirection::kOutput)
     {
@@ -363,14 +363,14 @@ void E131Bridge::SetUniverse(uint32_t port_index, uint16_t universe)
 
     bridge_.port[port_index].universe = universe;
     input_port_[port_index].multicast_ip = e131::UniverseToMulticastIp(universe);
-    
-#if defined(E131_HAVE_DMXIN)    
+
+#if defined(E131_HAVE_DMXIN)
     if (state_.status == e131bridge::Status::kOn)
     {
-		SetLocalMerging();
-	}
-#endif	
-    
+        SetLocalMerging();
+    }
+#endif
+
     DEBUG_EXIT();
 }
 
@@ -440,13 +440,13 @@ void E131Bridge::SetDirection(uint32_t port_index, dmxnode::PortDirection port_d
 
         bridge_.port[port_index].direction = dmxnode::PortDirection::kOutput;
     }
-    
-#if defined(E131_HAVE_DMXIN)    
+
+#if defined(E131_HAVE_DMXIN)
     if (state_.status == e131bridge::Status::kOn)
     {
-		SetLocalMerging();
-	}
-#endif	    
+        SetLocalMerging();
+    }
+#endif
 }
 
 #if defined(E131_HAVE_DMXIN)
@@ -1066,7 +1066,7 @@ void E131Bridge::SetNetworkDataLossCondition(bool source_a, bool source_b)
                 break;
             default:
                 DEBUG_PRINTF("state_.failsafe=%u", static_cast<uint32_t>(state_.failsafe));
-                assert(0);
+                assert(false && "Invalid state_.failsafe");
                 break;
         }
     }
diff --git a/lib-gd32/include/gd32_dma.h b/lib-gd32/include/gd32_dma.h
@@ -2,7 +2,7 @@
  * @file gd32_dma.h
  *
  */
-/* Copyright (C) 2024-2025 by Arjan van Vught mailto:info@gd32-dmx.org
+/* Copyright (C) 2024-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
@@ -63,7 +63,7 @@ template <uint32_t dma_periph, dma_channel_enum channelx, uint32_t flag> inline
             interrupt_enable = DMA_CHCTL(dma_periph, channelx) & DMA_CHXCTL_ERRIE;
             break;
         default:
-            [[unlikely]] assert(0);
+            [[unlikely]] assert(false && "Invalid flag");
     }
 
     return interrupt_flag && interrupt_enable;
@@ -97,7 +97,7 @@ template <uint32_t dma_periph, dma_channel_enum channelx, uint32_t flag> inline
             interrupt_enable = DMA_CHCTL(dma_periph, channelx) & gif_enable;
             break;
         default:
-            [[unlikely]] assert(0);
+            [[unlikely]] assert(false && "Invalid flag");
     }
 
     return (interrupt_flag && interrupt_enable);
@@ -132,7 +132,7 @@ template <uint32_t dma_periph, dma_channel_enum channelx, uint32_t flag> inline
                 interrupt_enable = (DMA_CHCTL(dma_periph, channelx) & DMA_CHXCTL_FTFIE);
                 break;
             default:
-                [[unlikely]] assert(0);
+                [[unlikely]] assert(false && "Invalid flag");
                 break;
         }
     }
@@ -162,13 +162,13 @@ template <uint32_t dma_periph, dma_channel_enum channelx, uint32_t flag> inline
                 interrupt_enable = DMA_CHCTL(dma_periph, channelx) & DMA_CHXCTL_FTFIE;
                 break;
             default:
-                [[unlikely]] assert(0);
+                [[unlikely]] assert(false && "Invalid flag");
                 break;
         }
     }
     else
     {
-        [[unlikely]] assert(0);
+        [[unlikely]] assert(false && "Invalid channelx");
     }
 
     return (interrupt_flag && interrupt_enable);
diff --git a/lib-gd32/include/gd32_gpio.h b/lib-gd32/include/gd32_gpio.h
@@ -196,7 +196,7 @@ inline uint32_t Gd32GpioToPeriph(uint32_t gpio)
             break;
 #endif
         default:
-            assert(0);
+            assert(false && "Invalid gpio");
             return 0;
             break;
     }
diff --git a/lib-gd32/src/f/gd32_i2c.cpp b/lib-gd32/src/f/gd32_i2c.cpp
@@ -2,7 +2,7 @@
  * @file gd32_i2c.cpp
  *
  */
-/* Copyright (C) 2021-2025 by Arjan van Vught mailto:info@gd32-dmx.org
+/* Copyright (C) 2021-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
@@ -345,7 +345,7 @@ static void GpioConfigI2c()
     }
     else
     {
-        assert(0);
+        assert(false && "Invalid I2C_REMAP");
     }
 #endif
 #else
@@ -380,7 +380,7 @@ static void GpioConfigI2c1()
     }
     else
     {
-        assert(0);
+        assert(false && "Invalid I2C1_REMAP");
     }
 #endif
 #else
diff --git a/lib-gd32/src/gd32_bkp.cpp b/lib-gd32/src/gd32_bkp.cpp
@@ -2,7 +2,7 @@
  * @file gd32_bkp.cpp
  *
  */
-/* Copyright (C) 2022-2025 by Arjan van Vught mailto:info@gd32-dmx.org
+/* Copyright (C) 2022-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
@@ -38,7 +38,7 @@ void bkp_data_write(bkp_data_register_enum register_number, uint16_t data)
             RTC_BKP1 = static_cast<uint32_t>(data);
             break;
         default:
-            assert(0);
+            assert(false && "Invalid register_number");
             break;
     }
 }
@@ -54,11 +54,10 @@ uint16_t bkp_data_read(bkp_data_register_enum register_number)
             return RTC_BKP1;
             break;
         default:
-            assert(0);
+            assert(false && "Invalid register_number");
             break;
     }
 
-    assert(0);
     return 0;
 }
 #endif
diff --git a/lib-gd32/src/gd32_uart.cpp b/lib-gd32/src/gd32_uart.cpp
@@ -2,7 +2,7 @@
  * @file gd32_uart.cpp
  *
  */
-/* Copyright (C) 2021-2025 by Arjan van Vught mailto:info@gd32-dmx.org
+/* Copyright (C) 2021-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
@@ -100,7 +100,7 @@ static void RcuConfig(uint32_t usart_periph)
             break;
 #endif
         default:
-            assert(0);
+            assert(false && "Invalid usart_periph");
             __builtin_unreachable();
             break;
     }
@@ -175,7 +175,7 @@ static void GpioConfig(uint32_t usart_periph)
             break;
 #endif
         default:
-            assert(0);
+            assert(false && "Invalid usart_periph");
             __builtin_unreachable();
             break;
     }
@@ -257,7 +257,7 @@ static void GpioConfig(uint32_t usart_periph)
             break;
 #endif
         default:
-            assert(0);
+            assert(false && "Invalid usart_periph");
             __builtin_unreachable();
             break;
     }
diff --git a/lib-hal/src/hal_statusled.cpp b/lib-hal/src/hal_statusled.cpp
@@ -1,7 +1,7 @@
 /*
  * hal_statusled.cpp
  */
-/* Copyright (C) 2025 by Arjan van Vught mailto:infogd32-dmx.org
+/* Copyright (C) 2025-2026 by Arjan van Vught mailto:infogd32-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
@@ -29,8 +29,7 @@
 #include <cstdint>
 
 #include "hal_statusled.h"
-
- #include "firmware/debug/debug_debug.h"
+#include "firmware/debug/debug_debug.h"
 
 namespace hal::statusled
 {
diff --git a/lib-hal/superloop/softwaretimers.cpp b/lib-hal/superloop/softwaretimers.cpp
@@ -1,7 +1,7 @@
 /**
  * @file softwaretimers.cpp
  */
-/* Copyright (C) 2024-2025 by Arjan van Vught mailto:info@gd32-dmx.org
+/* Copyright (C) 2024-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
@@ -39,7 +39,7 @@
 
 #include "softwaretimers.h"
 #include "hal_millis.h"
- #include "firmware/debug/debug_debug.h"
+#include "firmware/debug/debug_debug.h"
 
 namespace console
 {
@@ -55,9 +55,9 @@ struct Timer
 };
 
 static Timer s_timers[hal::kSoftwareTimersMax]; ///< Timer storage pool.
-static uint32_t s_timers_count = 0;              ///< Number of active timers (0..hal::SOFTWARE_TIMERS_MAX).
-static int32_t s_next_id = 0;                    ///< Monotonically increasing ID source (may wrap, see notes).
-static uint32_t s_timer_current = 0;             ///< bRound-robin cursor for SoftwareTimerRun().
+static uint32_t s_timers_count = 0;             ///< Number of active timers (0..hal::SOFTWARE_TIMERS_MAX).
+static int32_t s_next_id = 0;                   ///< Monotonically increasing ID source (may wrap, see notes).
+static uint32_t s_timer_current = 0;            ///< bRound-robin cursor for SoftwareTimerRun().
 
 /**
  * @brief Create and start a periodic (or one-shot) software timer.
diff --git a/lib-pixeldmx/src/json/pixeldmxparams.cpp b/lib-pixeldmx/src/json/pixeldmxparams.cpp
@@ -23,6 +23,8 @@
  * THE SOFTWARE.
  */
  
+ #undef NDEBUG
+
 #include <cstdint>
 #include <algorithm>
 
diff --git a/lib-pixeldmx/src/pixeldmxparams/pixeldmxparamsrdm.cpp b/lib-pixeldmx/src/pixeldmxparams/pixeldmxparamsrdm.cpp
@@ -2,7 +2,7 @@
  * @file pixeldmxparamsrdm.cpp
  *
  */
-/* Copyright (C) 2021-2025 by Arjan van Vught mailto:info@gd32-dmx.org
+/* Copyright (C) 2021-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
@@ -23,9 +23,6 @@
  * THE SOFTWARE.
  */
 
-
-#undef NDEBUG
-
 #if defined(DEBUG_PIXELDMX)
 #undef NDEBUG
 #endif
@@ -39,7 +36,7 @@
 #include "common/utils/utils_enum.h"
 #include "pixeldmxconfiguration.h"
 #include "rdmdeviceresponder.h"
- #include "firmware/debug/debug_debug.h"
+#include "firmware/debug/debug_debug.h"
 
 void PixelDmxParamsRdm::SetDataImpl([[maybe_unused]] uint32_t port_index, const uint8_t* data, uint32_t length, [[maybe_unused]] bool do_update)
 {
@@ -92,7 +89,7 @@ void PixelDmxParamsRdm::SetDataImpl([[maybe_unused]] uint32_t port_index, const
             configuration.Validate(1);
 
             char description[rdm::personality::DESCRIPTION_MAX_LENGTH];
-			pixeldmx::paramsdmx::SetPersonalityDescription(description);
+            pixeldmx::paramsdmx::SetPersonalityDescription(description);
             auto* personality = RDMDeviceResponder::Get()->GetPersonality(RDM_ROOT_DEVICE, 1);
             personality->SetDescription(description);
 

Original file line number	Diff line number	Diff line change
`@@ -534,7 +534,7 @@ void ArtNetController::ActiveUniversesAdd(uint16_t universe)`
`534`	`534`
`535`	`535`	`if (m_nActiveUniverses == (sizeof(s_active_universes) / sizeof(s_active_universes[0])))`
`536`	`536`	`{`
`537`		`- assert(0);`
	`537`	`+ assert(false);`
`538`	`538`	`return;`
`539`	`539`	`}`
`540`	`540`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`* @file gd32_dma.h`
`3`	`3`	`*`
`4`	`4`	`*/`
`5`		`-/* Copyright (C) 2024-2025 by Arjan van Vught mailto:info@gd32-dmx.org`
	`5`	`+/* Copyright (C) 2024-2026 by Arjan van Vught mailto:info@gd32-dmx.org`
`6`	`6`	`*`
`7`	`7`	`* Permission is hereby granted, free of charge, to any person obtaining a copy`
`8`	`8`	`* of this software and associated documentation files (the "Software"), to deal`
`@@ -63,7 +63,7 @@ template <uint32_t dma_periph, dma_channel_enum channelx, uint32_t flag> inline`
`63`	`63`	`interrupt_enable = DMA_CHCTL(dma_periph, channelx) & DMA_CHXCTL_ERRIE;`
`64`	`64`	`break;`
`65`	`65`	`default:`
`66`		`- [[unlikely]] assert(0);`
	`66`	`+ [[unlikely]] assert(false && "Invalid flag");`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`return interrupt_flag && interrupt_enable;`
`@@ -97,7 +97,7 @@ template <uint32_t dma_periph, dma_channel_enum channelx, uint32_t flag> inline`
`97`	`97`	`interrupt_enable = DMA_CHCTL(dma_periph, channelx) & gif_enable;`
`98`	`98`	`break;`
`99`	`99`	`default:`
`100`		`- [[unlikely]] assert(0);`
	`100`	`+ [[unlikely]] assert(false && "Invalid flag");`
`101`	`101`	`}`
`102`	`102`
`103`	`103`	`return (interrupt_flag && interrupt_enable);`
`@@ -132,7 +132,7 @@ template <uint32_t dma_periph, dma_channel_enum channelx, uint32_t flag> inline`
`132`	`132`	`interrupt_enable = (DMA_CHCTL(dma_periph, channelx) & DMA_CHXCTL_FTFIE);`
`133`	`133`	`break;`
`134`	`134`	`default:`
`135`		`- [[unlikely]] assert(0);`
	`135`	`+ [[unlikely]] assert(false && "Invalid flag");`
`136`	`136`	`break;`
`137`	`137`	`}`
`138`	`138`	`}`
`@@ -162,13 +162,13 @@ template <uint32_t dma_periph, dma_channel_enum channelx, uint32_t flag> inline`
`162`	`162`	`interrupt_enable = DMA_CHCTL(dma_periph, channelx) & DMA_CHXCTL_FTFIE;`
`163`	`163`	`break;`
`164`	`164`	`default:`
`165`		`- [[unlikely]] assert(0);`
	`165`	`+ [[unlikely]] assert(false && "Invalid flag");`
`166`	`166`	`break;`
`167`	`167`	`}`
`168`	`168`	`}`
`169`	`169`	`else`
`170`	`170`	`{`
`171`		`- [[unlikely]] assert(0);`
	`171`	`+ [[unlikely]] assert(false && "Invalid channelx");`
`172`	`172`	`}`
`173`	`173`
`174`	`174`	`return (interrupt_flag && interrupt_enable);`
Original file line number	Diff line number	Diff line change
`@@ -196,7 +196,7 @@ inline uint32_t Gd32GpioToPeriph(uint32_t gpio)`
`196`	`196`	`break;`
`197`	`197`	`#endif`
`198`	`198`	`default:`
`199`		`- assert(0);`
	`199`	`+ assert(false && "Invalid gpio");`
`200`	`200`	`return 0;`
`201`	`201`	`break;`
`202`	`202`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`* @file gd32_i2c.cpp`
`3`	`3`	`*`
`4`	`4`	`*/`
`5`		`-/* Copyright (C) 2021-2025 by Arjan van Vught mailto:info@gd32-dmx.org`
	`5`	`+/* Copyright (C) 2021-2026 by Arjan van Vught mailto:info@gd32-dmx.org`
`6`	`6`	`*`
`7`	`7`	`* Permission is hereby granted, free of charge, to any person obtaining a copy`
`8`	`8`	`* of this software and associated documentation files (the "Software"), to deal`
`@@ -345,7 +345,7 @@ static void GpioConfigI2c()`
`345`	`345`	`}`
`346`	`346`	`else`
`347`	`347`	`{`
`348`		`- assert(0);`
	`348`	`+ assert(false && "Invalid I2C_REMAP");`
`349`	`349`	`}`
`350`	`350`	`#endif`
`351`	`351`	`#else`
`@@ -380,7 +380,7 @@ static void GpioConfigI2c1()`
`380`	`380`	`}`
`381`	`381`	`else`
`382`	`382`	`{`
`383`		`- assert(0);`
	`383`	`+ assert(false && "Invalid I2C1_REMAP");`
`384`	`384`	`}`
`385`	`385`	`#endif`
`386`	`386`	`#else`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`* @file gd32_bkp.cpp`
`3`	`3`	`*`
`4`	`4`	`*/`
`5`		`-/* Copyright (C) 2022-2025 by Arjan van Vught mailto:info@gd32-dmx.org`
	`5`	`+/* Copyright (C) 2022-2026 by Arjan van Vught mailto:info@gd32-dmx.org`
`6`	`6`	`*`
`7`	`7`	`* Permission is hereby granted, free of charge, to any person obtaining a copy`
`8`	`8`	`* of this software and associated documentation files (the "Software"), to deal`
`@@ -38,7 +38,7 @@ void bkp_data_write(bkp_data_register_enum register_number, uint16_t data)`
`38`	`38`	`RTC_BKP1 = static_cast<uint32_t>(data);`
`39`	`39`	`break;`
`40`	`40`	`default:`
`41`		`- assert(0);`
	`41`	`+ assert(false && "Invalid register_number");`
`42`	`42`	`break;`
`43`	`43`	`}`
`44`	`44`	`}`
`@@ -54,11 +54,10 @@ uint16_t bkp_data_read(bkp_data_register_enum register_number)`
`54`	`54`	`return RTC_BKP1;`
`55`	`55`	`break;`
`56`	`56`	`default:`
`57`		`- assert(0);`
	`57`	`+ assert(false && "Invalid register_number");`
`58`	`58`	`break;`
`59`	`59`	`}`
`60`	`60`
`61`		`- assert(0);`
`62`	`61`	`return 0;`
`63`	`62`	`}`
`64`	`63`	`#endif`