better management of debugging #499

askuric · askuric · commit 246367bf2548 · 2025-12-18T20:22:41.000+01:00
diff --git a/src/current_sense/hardware_specific/esp32/esp32_mcu.h b/src/current_sense/hardware_specific/esp32/esp32_mcu.h
@@ -21,8 +21,11 @@ typedef struct ESP32CurrentSenseParams {
 
 // macros for debugging wuing the simplefoc debug system
 #define SIMPLEFOC_ESP32_CS_DEBUG(str)\
-   SimpleFOCDebug::println( "ESP32-CS: "+ String(str));\
-   
+#ifndef SIMPLEFOC_DISABLE_DEBUG  
+  SimpleFOCDebug::println( "ESP32-CS: "+ String(str));\
+#endif   
+
+  
 #define CHECK_CS_ERR(func_call, message) \
   if ((func_call) != ESP_OK) { \
     SIMPLEFOC_ESP32_CS_DEBUG("ERROR - " + String(message)); \
diff --git a/src/current_sense/hardware_specific/stm32/stm32_adc_utils.cpp b/src/current_sense/hardware_specific/stm32/stm32_adc_utils.cpp
@@ -145,13 +145,15 @@ ADC_TypeDef* _findBestADCForPins(int numPins, int pins[]) {
     }
   }
 
+#ifndef SIMPLEFOC_DISABLE_DEBUG
   for (int i = 0; i < ADC_COUNT; i++) {
     if(!pins_at_adc[i]) continue;
     SimpleFOCDebug::print("STM32-CS: ADC");
     SimpleFOCDebug::print(i+1);
     SimpleFOCDebug::print(" pins: ");
     SimpleFOCDebug::println(pins_at_adc[i]);
   }
+#endif
 
   // now take the first ADC that has all pins connected
   for (int i = 0; i < ADC_COUNT; i++) {
diff --git a/src/current_sense/hardware_specific/stm32/stm32f1/stm32f1_hal.cpp b/src/current_sense/hardware_specific/stm32/stm32f1/stm32f1_hal.cpp
@@ -131,7 +131,7 @@ int _adc_gpio_init(Stm32CurrentSenseParams* cs_params, const int pinA, const int
     if(_isset(pins[i])){
       // check if pin is an analog pin
       if(pinmap_peripheral(analogInputToPinName(pins[i]), PinMap_ADC) == NP){
-#ifdef SIMPLEFOC_STM32_DEBUG
+#if defined(SIMPLEFOC_STM32_DEBUG) && !defined(SIMPLEFOC_DISABLE_DEBUG)
         SimpleFOCDebug::print("STM32-CS: ERR: Pin ");
         SimpleFOCDebug::print(port_names[i]);
         SimpleFOCDebug::println(" does not belong to any ADC!");
diff --git a/src/current_sense/hardware_specific/stm32/stm32f4/stm32f4_hal.cpp b/src/current_sense/hardware_specific/stm32/stm32f4/stm32f4_hal.cpp
@@ -143,7 +143,7 @@ int _adc_gpio_init(Stm32CurrentSenseParams* cs_params, const int pinA, const int
     if(_isset(pins[i])){
       // check if pin is an analog pin
       if(pinmap_peripheral(analogInputToPinName(pins[i]), PinMap_ADC) == NP){
-#ifdef SIMPLEFOC_STM32_DEBUG
+#if defined(SIMPLEFOC_STM32_DEBUG) && !defined(SIMPLEFOC_DISABLE_DEBUG)
         SimpleFOCDebug::print("STM32-CS: ERR: Pin ");
         SimpleFOCDebug::print(i == 0 ? "A" : i == 1 ? "B" : "C");
         SimpleFOCDebug::println(" does not belong to any ADC!");
diff --git a/src/current_sense/hardware_specific/stm32/stm32f7/stm32f7_hal.cpp b/src/current_sense/hardware_specific/stm32/stm32f7/stm32f7_hal.cpp
@@ -154,7 +154,8 @@ int _adc_gpio_init(Stm32CurrentSenseParams* cs_params, const int pinA, const int
     if(_isset(pins[i])){
       // check if pin is an analog pin
       if(pinmap_peripheral(analogInputToPinName(pins[i]), PinMap_ADC) == NP){
-#ifdef SIMPLEFOC_STM32_DEBUG
+
+#if defined(SIMPLEFOC_STM32_DEBUG) && !defined(SIMPLEFOC_DISABLE_DEBUG)
         SimpleFOCDebug::print("STM32-CS: ERR: Pin ");
         SimpleFOCDebug::print(port_names[i]);
         SimpleFOCDebug::println(" does not belong to any ADC!");
diff --git a/src/current_sense/hardware_specific/stm32/stm32g4/stm32g4_hal.cpp b/src/current_sense/hardware_specific/stm32/stm32g4/stm32g4_hal.cpp
@@ -195,7 +195,8 @@ int _adc_gpio_init(Stm32CurrentSenseParams* cs_params, const int pinA, const int
     if(_isset(pins[i])){
       // check if pin is an analog pin
       if(pinmap_peripheral(analogInputToPinName(pins[i]), PinMap_ADC) == NP){
-#ifdef SIMPLEFOC_STM32_DEBUG
+
+#if defined(SIMPLEFOC_STM32_DEBUG) && !defined(SIMPLEFOC_DISABLE_DEBUG)
         SimpleFOCDebug::print("STM32-CS: ERR: Pin ");
         SimpleFOCDebug::print(port_names[i]);
         SimpleFOCDebug::println(" does not belong to any ADC!");
diff --git a/src/current_sense/hardware_specific/stm32/stm32h7/stm32h7_hal.cpp b/src/current_sense/hardware_specific/stm32/stm32h7/stm32h7_hal.cpp
@@ -175,7 +175,8 @@ int _adc_gpio_init(Stm32CurrentSenseParams* cs_params, const int pinA, const int
     if(_isset(pins[i])){
       // check if pin is an analog pin
       if(pinmap_peripheral(analogInputToPinName(pins[i]), PinMap_ADC) == NP){
-#ifdef SIMPLEFOC_STM32_DEBUG
+
+#if defined(SIMPLEFOC_STM32_DEBUG) && !defined(SIMPLEFOC_DISABLE_DEBUG)
         SimpleFOCDebug::print("STM32-CS: ERR: Pin ");
         SimpleFOCDebug::print(port_names[i]);
         SimpleFOCDebug::println(" does not belong to any ADC!");
diff --git a/src/current_sense/hardware_specific/stm32/stm32l4/stm32l4_hal.cpp b/src/current_sense/hardware_specific/stm32/stm32l4/stm32l4_hal.cpp
@@ -189,7 +189,8 @@ int _adc_gpio_init(Stm32CurrentSenseParams* cs_params, const int pinA, const int
     if(_isset(pins[i])){
       // check if pin is an analog pin
       if(pinmap_peripheral(analogInputToPinName(pins[i]), PinMap_ADC) == NP){
-#ifdef SIMPLEFOC_STM32_DEBUG
+
+#if defined(SIMPLEFOC_STM32_DEBUG) && !defined(SIMPLEFOC_DISABLE_DEBUG)
         SimpleFOCDebug::print("STM32-CS: ERR: Pin ");
         SimpleFOCDebug::print(port_names[i]);
         SimpleFOCDebug::println(" does not belong to any ADC!");
diff --git a/src/drivers/hardware_specific/esp32/esp32_driver_mcpwm.h b/src/drivers/hardware_specific/esp32/esp32_driver_mcpwm.h
@@ -33,7 +33,9 @@ typedef struct ESP32MCPWMDriverParams {
 
 
 #define SIMPLEFOC_ESP32_DEBUG(tag, str)\
+#ifndef SIMPLEFOC_DISABLE_DEBUG
     SimpleFOCDebug::println( "ESP32-"+String(tag)+ ": "+ String(str));
+#endif
 
 #define SIMPLEFOC_ESP32_DRV_DEBUG(str)\
    SIMPLEFOC_ESP32_DEBUG("DRV", str);\
diff --git a/src/drivers/hardware_specific/renesas/renesas.cpp b/src/drivers/hardware_specific/renesas/renesas.cpp
@@ -121,7 +121,9 @@ ClockDivAndRange getClockDivAndRange(uint32_t pwm_frequency, uint8_t timer_chann
       result.clk_div = TIMER_SOURCE_DIV_1024;
   }
   else {
+    #if !defined(SIMPLEFOC_DISABLE_DEBUG)
       SimpleFOCDebug::println("DRV: PWM frequency too low");
+    #endif
   }
   return result;
 };
@@ -181,7 +183,7 @@ bool configureTimerPin(RenesasHardwareDriverParams* params, uint8_t index, bool
 
   // configure timer channel - frequency / top value
   ClockDivAndRange timings = getClockDivAndRange(params->pwm_frequency, timer_channel);
-  #if defined(SIMPLEFOC_RENESAS_DEBUG)
+  #if defined(SIMPLEFOC_RENESAS_DEBUG)  && !defined(SIMPLEFOC_DISABLE_DEBUG)
   SimpleFOCDebug::println("---PWM Config---");
   SimpleFOCDebug::println("DRV: pwm pin: ", pin);
   if (complementary)
@@ -269,7 +271,9 @@ bool configureTimerPin(RenesasHardwareDriverParams* params, uint8_t index, bool
     return false;
   }
   if (err == FSP_ERR_ALREADY_OPEN) {
+    #if !defined(SIMPLEFOC_DISABLE_DEBUG)
     SimpleFOCDebug::println("DRV: timer already open");
+    #endif
     return false;
   }
 
@@ -306,12 +310,12 @@ bool startTimerChannels(RenesasHardwareDriverParams* params, int num_channels) {
     //   return false;
     // }
     mask |= (1 << params->channels[i]);
-#if defined(SIMPLEFOC_RENESAS_DEBUG)
+#if defined(SIMPLEFOC_RENESAS_DEBUG)  && !defined(SIMPLEFOC_DISABLE_DEBUG)
     SimpleFOCDebug::println("DRV: starting timer: ", params->channels[i]);
 #endif
   }
   params->timer_config[0]->ctrl.p_reg->GTSTR |= mask;
-  #if defined(SIMPLEFOC_RENESAS_DEBUG)
+  #if defined(SIMPLEFOC_RENESAS_DEBUG)  && !defined(SIMPLEFOC_DISABLE_DEBUG)
     SimpleFOCDebug::println("DRV: timers started");
   #endif
   return true;
diff --git a/src/drivers/hardware_specific/rp2040/rp2040_mcu.cpp b/src/drivers/hardware_specific/rp2040/rp2040_mcu.cpp
@@ -55,7 +55,7 @@ void setupPWM(int pin_nr, long pwm_frequency, bool invert, RP2040DriverParams* p
 	if (sysclock_hz % factor !=0) div+=1;
 	if (div < 16) div = 16;
 	uint32_t wrapvalue = (sysclock_hz * 8) / div / pwm_frequency - 1;
-#ifdef SIMPLEFOC_DEBUG_RP2040
+#if defined(SIMPLEFOC_DEBUG_RP2040) && !defined(SIMPLEFOC_DISABLE_DEBUG)
 	SimpleFOCDebug::print("Configuring pin ");
 	SimpleFOCDebug::print((int)pin);
 	SimpleFOCDebug::print(" slice ");
@@ -70,9 +70,9 @@ void setupPWM(int pin_nr, long pwm_frequency, bool invert, RP2040DriverParams* p
 	SimpleFOCDebug::print((int)(div&0xF));
 	SimpleFOCDebug::print(" top value ");
 	SimpleFOCDebug::println((int)wrapvalue);
-#endif
 	if (wrapvalue < 999)
 		SimpleFOCDebug::println("Warning: PWM resolution is low.");
+#endif
 	pwm_set_clkdiv_int_frac(slice, div>>4, div&0xF);
 	pwm_set_phase_correct(slice, true);
 	pwm_set_wrap(slice, wrapvalue);
diff --git a/src/drivers/hardware_specific/samd/samd_mcu.cpp b/src/drivers/hardware_specific/samd/samd_mcu.cpp
@@ -778,7 +778,7 @@ void _writeDutyCycle6PWM(float dc_a,  float dc_b, float dc_c, PhaseState *phase_
 
 
 
-#ifdef SIMPLEFOC_SAMD_DEBUG
+#if defined(SIMPLEFOC_SAMD_DEBUG) && !defined(SIMPLEFOC_DISABLE_DEBUG)
 
 /**
  * Prints a table of pin assignments for your SAMD MCU. Very useful since the

Original file line number	Diff line number	Diff line change
`@@ -145,13 +145,15 @@ ADC_TypeDef* _findBestADCForPins(int numPins, int pins[]) {`
`145`	`145`	`}`
`146`	`146`	`}`
`147`	`147`
	`148`	`+#ifndef SIMPLEFOC_DISABLE_DEBUG`
`148`	`149`	`for (int i = 0; i < ADC_COUNT; i++) {`
`149`	`150`	`if(!pins_at_adc[i]) continue;`
`150`	`151`	`SimpleFOCDebug::print("STM32-CS: ADC");`
`151`	`152`	`SimpleFOCDebug::print(i+1);`
`152`	`153`	`SimpleFOCDebug::print(" pins: ");`
`153`	`154`	`SimpleFOCDebug::println(pins_at_adc[i]);`
`154`	`155`	`}`
	`156`	`+#endif`
`155`	`157`
`156`	`158`	`// now take the first ADC that has all pins connected`
`157`	`159`	`for (int i = 0; i < ADC_COUNT; i++) {`