Add debug(const char *format, ...) function

This remove direct use of printf and allow to save
more than several Kb of memory.
By default, debug function does nothing.
If __DEBUG is enabled this will call printf.

Signed-off-by: Frederic.Pillon <frederic.pillon@st.com>

Author: fpistm

cores/arduino/debug.h

@@ -0,0 +1,33 @@
+#ifndef _DEBUG_H
+#ifdef __DEBUG
+#include <stdio.h>
+#include <stdarg.h>
+#endif /* __DEBUG */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/** Output a debug message
+ *
+ * @param format printf-style format string, followed by variables
+ * Note: By using the printf function of the library C this inflates the size of
+ * the code, use a lot of stack. An alternative, will be to implement a tiny
+ * and limited functionality implementation of printf.
+ */
+static inline void debug(const char *format, ...) {
+#ifdef __DEBUG
+  va_list args;
+  va_start(args, format);
+  vfprintf(stderr, format, args);
+  va_end(args);
+#else
+	(void)(format);
+#endif /* __DEBUG */
+}
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _DEBUG_H */

cores/arduino/stm32/spi_com.c

@@ -46,6 +46,7 @@
 /** @addtogroup STM32F4xx_System_Private_Includes
   * @{
   */
+#include "debug.h"
 #include "stm32_def.h"
 #include "spi_com.h"
 #include "PinAF_STM32F1.h"
@@ -149,7 +150,7 @@ uint32_t spi_getClkFreqInst(SPI_TypeDef * spi_inst)
         break;
 #endif
       default:
-        printf("CLK: SPI instance not set");
+        debug("CLK: SPI instance not set");
         break;
     }
   }
@@ -203,7 +204,7 @@ void spi_init(spi_t *obj, uint32_t speed, spi_mode_e mode, uint8_t msb)
 
   /* Pins MOSI/MISO/SCLK must not be NP. ssel can be NP. */
   if(spi_mosi == NP || spi_miso == NP || spi_sclk == NP) {
-    printf("ERROR: at least one SPI pin has no peripheral\n");
+    debug("ERROR: at least one SPI pin has no peripheral\n");
     return;
   }
 
@@ -214,7 +215,7 @@ void spi_init(spi_t *obj, uint32_t speed, spi_mode_e mode, uint8_t msb)
 
   // Are all pins connected to the same SPI instance?
   if(obj->spi == NP) {
-    printf("ERROR: SPI pins mismatch\n");
+    debug("ERROR: SPI pins mismatch\n");
     return;
   }
 

cores/arduino/stm32/stm32_def.c

@@ -1,4 +1,5 @@
 #include "stm32_def.h"
+#include "debug.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -9,18 +10,10 @@ extern "C" {
   * @param  None
   * @retval None
   */
-WEAK void _Error_Handler(const char * msg, int val)
-{
+WEAK void _Error_Handler(const char * msg, int val) {
   /* User can add his own implementation to report the HAL error return state */
-  /* By using the printf function of the library C this inflates the size of
-   * the code, use a lot of stack. An alternative, will be to implement a tiny
-   * and limited functionality implementation of printf.
-   */
-  UNUSED(msg);
-  UNUSED(val);
-  /*printf("Error: %s (%i)\n", msg, val);*/
-  while(1)
-  {
+  debug("Error: %s (%i)\n", msg, val);
+  while(1) {
   }
 }
 

cores/arduino/stm32/timer.c

@@ -46,6 +46,7 @@
 /** @addtogroup STM32F4xx_System_Private_Includes
   * @{
   */
+#include "debug.h"
 #include "timer.h"
 #include "board.h"
 
@@ -544,7 +545,7 @@ uint32_t getTimerIrq(TIM_TypeDef* tim)
 #endif
          break;
      default:
-        printf("TIM: Unknown timer IRQn");
+        debug("TIM: Unknown timer IRQn");
         break;
     }
   }
@@ -652,7 +653,7 @@ uint8_t getTimerClkSrc(TIM_TypeDef* tim)
          clkSrc = 2;
          break;
      default:
-        printf("TIM: Unknown timer instance");
+        debug("TIM: Unknown timer instance");
         break;
     }
   }
@@ -686,7 +687,7 @@ uint32_t getTimerClkFreq(TIM_TypeDef* tim)
 #endif
     default:
     case 0:
-      printf("TIM: Unknown clock source");
+      debug("TIM: Unknown clock source");
       break;
   }
 /* When TIMPRE bit of the RCC_DCKCFGR register is reset,

cores/arduino/stm32/twi.c

@@ -47,6 +47,7 @@
 /** @addtogroup STM32F4xx_System_Private_Includes
   * @{
   */
+#include "debug.h"
 #include "stm32_def.h"
 #include "twi.h"
 #include "PinAF_STM32F1.h"
@@ -166,14 +167,14 @@ void i2c_custom_init(i2c_t *obj, i2c_timing_e timing, uint32_t addressingMode, u
 
   //Pins SDA/SCL must not be NP
   if(i2c_sda == NP || i2c_scl == NP) {
-    printf("ERROR: at least one I2C pin has no peripheral\n");
+    debug("ERROR: at least one I2C pin has no peripheral\n");
     return;
   }
 
   obj->i2c = pinmap_merge_peripheral(i2c_sda, i2c_scl);
 
   if(obj->i2c == NP) {
-    printf("ERROR: I2C pins mismatch\n");
+    debug("ERROR: I2C pins mismatch\n");
     return;
   }
 
@@ -596,7 +597,7 @@ void HAL_I2C_SlaveRxCpltCallback(I2C_HandleTypeDef *hi2c)
   if(obj->slaveRxNbData < I2C_TXRX_BUFFER_SIZE) {
     obj->slaveRxNbData++;
   } else {
-    printf("ERROR: I2C Slave RX overflow\n");
+    debug("ERROR: I2C Slave RX overflow\n");
   }
   /* Restart interrupt mode for next Byte */
   if(obj->slaveMode == SLAVE_MODE_RECEIVE) {

cores/arduino/stm32/uart.c

@@ -33,6 +33,7 @@
   *
   ******************************************************************************
   */
+#include "debug.h"
 #include "uart.h"
 #include "Arduino.h"
 #include "PinAF_STM32F1.h"
@@ -101,7 +102,7 @@ void uart_init(serial_t *obj)
 
   /* Pins Rx/Tx must not be NP */
   if(uart_rx == NP || uart_tx == NP) {
-    printf("ERROR: at least one UART pin has no peripheral\n");
+    debug("ERROR: at least one UART pin has no peripheral\n");
     return;
   }
 
@@ -112,7 +113,7 @@ void uart_init(serial_t *obj)
   obj->uart = pinmap_merge_peripheral(uart_tx, uart_rx);
 
   if(obj->uart == NP) {
-    printf("ERROR: U(S)ART pins mismatch\n");
+    debug("ERROR: U(S)ART pins mismatch\n");
     return;
   }
 

cores/arduino/stm32/uart_emul.c

@@ -46,6 +46,7 @@
 /** @addtogroup STM32F4xx_System_Private_Includes
   * @{
   */
+#include "debug.h"
 #include "uart_emul.h"
 #include "digital_io.h"
 #include "interrupt.h"
@@ -402,7 +403,7 @@ void HAL_UART_Emul_RxCpltCallback(UART_Emul_HandleTypeDef *huart)
 
 /*void HAL_UART_Emul_ErrorCallback(UART_Emul_HandleTypeDef *huart)
 {
-  printf("UART EMUL RX ERROR\n");
+  debug("UART EMUL RX ERROR\n");
 }*/
 
 /**