From cc2bf0ba27f34abe6eeb3a6d47eb797fb507415c Mon Sep 17 00:00:00 2001
From: Alexandre Abadie <alexandre.abadie@inria.fr>
Date: Wed, 11 Apr 2018 17:52:03 +0200
Subject: [PATCH] drivers/sx127x: improve debug messages

---
 drivers/sx127x/sx127x.c          | 26 +++++++-----
 drivers/sx127x/sx127x_getset.c   | 71 ++++++++++++++++----------------
 drivers/sx127x/sx127x_internal.c |  8 ++--
 drivers/sx127x/sx127x_netdev.c   | 22 ++++++----
 4 files changed, 68 insertions(+), 59 deletions(-)

diff --git a/drivers/sx127x/sx127x.c b/drivers/sx127x/sx127x.c
index c6b72cbf07..ca52462a25 100644
--- a/drivers/sx127x/sx127x.c
+++ b/drivers/sx127x/sx127x.c
@@ -96,7 +96,7 @@ int sx127x_init(sx127x_t *dev)
 
     /* Check presence of SX127X */
     if (!sx127x_test(dev)) {
-        DEBUG("[Error] init : sx127x test failed\n");
+        DEBUG("[sx127x] init: sx127x test failed\n");
         return -SX127X_ERR_TEST_FAILED;
     }
 
@@ -205,20 +205,24 @@ static void sx127x_on_dio3_isr(void *arg)
 /* Internal event handlers */
 static void _init_isrs(sx127x_t *dev)
 {
-    if (gpio_init_int(dev->params.dio0_pin, GPIO_IN, GPIO_RISING, sx127x_on_dio0_isr, dev) < 0) {
-        DEBUG("Error: cannot initialize DIO0 pin\n");
+    if (gpio_init_int(dev->params.dio0_pin, GPIO_IN, GPIO_RISING,
+                      sx127x_on_dio0_isr, dev) < 0) {
+        DEBUG("[sx127x] error: cannot initialize DIO0 pin\n");
     }
 
-    if (gpio_init_int(dev->params.dio1_pin, GPIO_IN, GPIO_RISING, sx127x_on_dio1_isr, dev) < 0) {
-        DEBUG("Error: cannot initialize DIO1 pin\n");
+    if (gpio_init_int(dev->params.dio1_pin, GPIO_IN, GPIO_RISING,
+                      sx127x_on_dio1_isr, dev) < 0) {
+        DEBUG("[sx127x] error: cannot initialize DIO1 pin\n");
     }
 
-    if (gpio_init_int(dev->params.dio2_pin, GPIO_IN, GPIO_RISING, sx127x_on_dio2_isr, dev) < 0) {
-        DEBUG("Error: cannot initialize DIO2 pin\n");
+    if (gpio_init_int(dev->params.dio2_pin, GPIO_IN, GPIO_RISING,
+                      sx127x_on_dio2_isr, dev) < 0) {
+        DEBUG("[sx127x] error: cannot initialize DIO2 pin\n");
     }
 
-    if (gpio_init_int(dev->params.dio3_pin, GPIO_IN, GPIO_RISING, sx127x_on_dio3_isr, dev) < 0) {
-        DEBUG("Error: cannot initialize DIO3 pin\n");
+    if (gpio_init_int(dev->params.dio3_pin, GPIO_IN, GPIO_RISING,
+                      sx127x_on_dio3_isr, dev) < 0) {
+        DEBUG("[sx127x] error: cannot initialize DIO3 pin\n");
     }
 }
 
@@ -253,11 +257,11 @@ static int _init_peripherals(sx127x_t *dev)
     res = spi_init_cs(dev->params.spi, dev->params.nss_pin);
 
     if (res != SPI_OK) {
-        DEBUG("sx127x: error initializing SPI_%i device (code %i)\n",
+        DEBUG("[sx127x] error initializing SPI_%i device (code %i)\n",
                   dev->params.spi, res);
         return 0;
     }
 
-    DEBUG("sx127x: peripherals initialized with success\n");
+    DEBUG("[sx127x] peripherals initialized with success\n");
     return 1;
 }
diff --git a/drivers/sx127x/sx127x_getset.c b/drivers/sx127x/sx127x_getset.c
index 6887631daf..5744aaf778 100644
--- a/drivers/sx127x/sx127x_getset.c
+++ b/drivers/sx127x/sx127x_getset.c
@@ -46,16 +46,16 @@ void sx127x_set_state(sx127x_t *dev, uint8_t state)
 #if ENABLE_DEBUG
     switch (state) {
     case SX127X_RF_IDLE:
-        DEBUG("[DEBUG] Change state: IDLE\n");
+        DEBUG("[sx127x] Change state: IDLE\n");
         break;
     case SX127X_RF_RX_RUNNING:
-        DEBUG("[DEBUG] Change state: RX\n");
+        DEBUG("[sx127x] Change state: RX\n");
         break;
     case SX127X_RF_TX_RUNNING:
-        DEBUG("[DEBUG] Change state: TX\n");
+        DEBUG("[sx127x] Change state: TX\n");
         break;
     default:
-        DEBUG("[DEBUG] Change state: UNKNOWN\n");
+        DEBUG("[sx127x] Change state: UNKNOWN\n");
         break;
     }
 #endif
@@ -65,6 +65,8 @@ void sx127x_set_state(sx127x_t *dev, uint8_t state)
 
 void sx127x_set_modem(sx127x_t *dev, uint8_t modem)
 {
+    DEBUG("[sx127x] set modem: %d\n", modem);
+
     if ((sx127x_reg_read(dev, SX127X_REG_OPMODE) & SX127X_RF_LORA_OPMODE_LONGRANGEMODE_ON) != 0) {
         dev->settings.modem = SX127X_MODEM_LORA;
     }
@@ -75,12 +77,10 @@ void sx127x_set_modem(sx127x_t *dev, uint8_t modem)
     /* Skip if unchanged to avoid resetting the transceiver below (may end up
      * in crashes) */
     if (dev->settings.modem == modem) {
-        DEBUG("[DEBUG] already using modem: %d\n", modem);
+        DEBUG("[sx127x] already using modem: %d\n", modem);
         return;
     }
 
-    DEBUG("[DEBUG] set modem: %d\n", modem);
-
     dev->settings.modem = modem;
 
     switch (dev->settings.modem) {
@@ -109,7 +109,7 @@ uint8_t sx127x_get_syncword(const sx127x_t *dev)
 
 void sx127x_set_syncword(sx127x_t *dev, uint8_t syncword)
 {
-    DEBUG("[DEBUG] Set syncword: %02x\n", syncword);
+    DEBUG("[sx127x] Set syncword: %02x\n", syncword);
 
     sx127x_reg_write(dev, SX127X_REG_LR_SYNCWORD, syncword);
 }
@@ -123,7 +123,7 @@ uint32_t sx127x_get_channel(const sx127x_t *dev)
 
 void sx127x_set_channel(sx127x_t *dev, uint32_t channel)
 {
-    DEBUG("[DEBUG] Set channel: %lu\n", channel);
+    DEBUG("[sx127x] Set channel: %lu\n", channel);
 
     /* Save current operating mode */
     dev->settings.channel = channel;
@@ -198,7 +198,7 @@ uint32_t sx127x_get_time_on_air(const sx127x_t *dev, uint8_t pkt_len)
 
 void sx127x_set_sleep(sx127x_t *dev)
 {
-    DEBUG("[DEBUG] Set sleep\n");
+    DEBUG("[sx127x] Set sleep\n");
 
     /* Disable running timers */
     xtimer_remove(&dev->_internal.tx_timeout_timer);
@@ -211,7 +211,7 @@ void sx127x_set_sleep(sx127x_t *dev)
 
 void sx127x_set_standby(sx127x_t *dev)
 {
-    DEBUG("[DEBUG] Set standby\n");
+    DEBUG("[sx127x] Set standby\n");
 
     /* Disable running timers */
     xtimer_remove(&dev->_internal.tx_timeout_timer);
@@ -223,7 +223,7 @@ void sx127x_set_standby(sx127x_t *dev)
 
 void sx127x_set_rx(sx127x_t *dev)
 {
-    DEBUG("[DEBUG] Set RX\n");
+    DEBUG("[sx127x] Set RX\n");
 
     switch (dev->settings.modem) {
         case SX127X_MODEM_FSK:
@@ -393,7 +393,7 @@ uint8_t sx127x_get_max_payload_len(const sx127x_t *dev)
 
 void sx127x_set_max_payload_len(const sx127x_t *dev, uint8_t maxlen)
 {
-    DEBUG("[DEBUG] Set max payload len: %d\n", maxlen);
+    DEBUG("[sx127x] Set max payload len: %d\n", maxlen);
 
     switch (dev->settings.modem) {
         case SX127X_MODEM_FSK:
@@ -416,22 +416,22 @@ void sx127x_set_op_mode(const sx127x_t *dev, uint8_t op_mode)
 #if ENABLE_DEBUG
     switch(op_mode) {
     case SX127X_RF_OPMODE_SLEEP:
-        DEBUG("[DEBUG] Set op mode: SLEEP\n");
+        DEBUG("[sx127x] Set op mode: SLEEP\n");
         break;
     case SX127X_RF_OPMODE_STANDBY:
-        DEBUG("[DEBUG] Set op mode: STANDBY\n");
+        DEBUG("[sx127x] Set op mode: STANDBY\n");
         break;
     case SX127X_RF_OPMODE_RECEIVER_SINGLE:
-        DEBUG("[DEBUG] Set op mode: RECEIVER SINGLE\n");
+        DEBUG("[sx127x] Set op mode: RECEIVER SINGLE\n");
         break;
     case SX127X_RF_OPMODE_RECEIVER:
-        DEBUG("[DEBUG] Set op mode: RECEIVER\n");
+        DEBUG("[sx127x] Set op mode: RECEIVER\n");
         break;
     case SX127X_RF_OPMODE_TRANSMITTER:
-        DEBUG("[DEBUG] Set op mode: TRANSMITTER\n");
+        DEBUG("[sx127x] Set op mode: TRANSMITTER\n");
         break;
     default:
-        DEBUG("[DEBUG] Set op mode: UNKNOWN (%d)\n", op_mode);
+        DEBUG("[sx127x] Set op mode: UNKNOWN (%d)\n", op_mode);
         break;
     }
 #endif
@@ -503,7 +503,8 @@ static void _update_bandwidth(const sx127x_t *dev)
         config1_reg |=  SX1276_RF_LORA_MODEMCONFIG1_BW_500_KHZ;
         break;
     default:
-        DEBUG("Unsupported bandwidth, %d", dev->settings.lora.bandwidth);
+        DEBUG("[sx127x] Unsupported bandwidth, %d\n",
+              dev->settings.lora.bandwidth);
         break;
     }
 #endif
@@ -512,7 +513,7 @@ static void _update_bandwidth(const sx127x_t *dev)
 
 void sx127x_set_bandwidth(sx127x_t *dev, uint8_t bandwidth)
 {
-    DEBUG("[DEBUG] Set bandwidth: %d\n", bandwidth);
+    DEBUG("[sx127x] Set bandwidth: %d\n", bandwidth);
 
     dev->settings.lora.bandwidth = bandwidth;
 
@@ -545,7 +546,7 @@ uint8_t sx127x_get_spreading_factor(const sx127x_t *dev)
 
 void sx127x_set_spreading_factor(sx127x_t *dev, uint8_t datarate)
 {
-    DEBUG("[DEBUG] Set spreading factor: %d\n", datarate);
+    DEBUG("[sx127x] Set spreading factor: %d\n", datarate);
 
     if (datarate == LORA_SF6 &&
         !(dev->settings.lora.flags & SX127X_ENABLE_FIXED_HEADER_LENGTH_FLAG)) {
@@ -588,7 +589,7 @@ uint8_t sx127x_get_coding_rate(const sx127x_t *dev)
 
 void sx127x_set_coding_rate(sx127x_t *dev, uint8_t coderate)
 {
-    DEBUG("[DEBUG] Set coding rate: %d\n", coderate);
+    DEBUG("[sx127x] Set coding rate: %d\n", coderate);
 
     dev->settings.lora.coderate = coderate;
     uint8_t config1_reg = sx127x_reg_read(dev, SX127X_REG_LR_MODEMCONFIG1);
@@ -621,7 +622,7 @@ bool sx127x_get_rx_single(const sx127x_t *dev)
 
 void sx127x_set_rx_single(sx127x_t *dev, bool single)
 {
-    DEBUG("[DEBUG] Set RX single: %d\n", single);
+    DEBUG("[sx127x] Set RX single: %d\n", single);
     _set_flag(dev, SX127X_RX_CONTINUOUS_FLAG, !single);
 }
 
@@ -638,7 +639,7 @@ bool sx127x_get_crc(const sx127x_t *dev)
 
 void sx127x_set_crc(sx127x_t *dev, bool crc)
 {
-    DEBUG("[DEBUG] Set CRC: %d\n", crc);
+    DEBUG("[sx127x] Set CRC: %d\n", crc);
     _set_flag(dev, SX127X_ENABLE_CRC_FLAG, crc);
 
 #if defined(MODULE_SX1272)
@@ -661,7 +662,7 @@ uint8_t sx127x_get_hop_period(const sx127x_t *dev)
 
 void sx127x_set_hop_period(sx127x_t *dev, uint8_t hop_period)
 {
-    DEBUG("[DEBUG] Set Hop period: %d\n", hop_period);
+    DEBUG("[sx127x] Set Hop period: %d\n", hop_period);
 
     dev->settings.lora.freq_hop_period = hop_period;
 
@@ -680,7 +681,7 @@ bool  sx127x_get_fixed_header_len_mode(const sx127x_t *dev)
 
 void sx127x_set_fixed_header_len_mode(sx127x_t *dev, bool fixed_len)
 {
-    DEBUG("[DEBUG] Set fixed header length: %d\n", fixed_len);
+    DEBUG("[sx127x] Set fixed header length: %d\n", fixed_len);
 
     _set_flag(dev, SX127X_ENABLE_FIXED_HEADER_LENGTH_FLAG, fixed_len);
 
@@ -702,7 +703,7 @@ uint8_t sx127x_get_payload_length(const sx127x_t *dev)
 
 void sx127x_set_payload_length(sx127x_t *dev, uint8_t len)
 {
-    DEBUG("[DEBUG] Set payload len: %d\n", len);
+    DEBUG("[sx127x] Set payload len: %d\n", len);
 
     sx127x_reg_write(dev, SX127X_REG_LR_PAYLOADLENGTH, len);
 }
@@ -723,7 +724,7 @@ uint8_t sx127x_get_tx_power(const sx127x_t *dev)
 
 void sx127x_set_tx_power(sx127x_t *dev, int8_t power)
 {
-    DEBUG("[DEBUG] Set power: %d\n", power);
+    DEBUG("[sx127x] Set power: %d\n", power);
 
     dev->settings.lora.power = power;
 
@@ -801,7 +802,7 @@ uint16_t sx127x_get_preamble_length(const sx127x_t *dev)
 
 void sx127x_set_preamble_length(sx127x_t *dev, uint16_t preamble)
 {
-    DEBUG("[DEBUG] Set preamble length: %d\n", preamble);
+    DEBUG("[sx127x] Set preamble length: %d\n", preamble);
 
     dev->settings.lora.preamble_len = preamble;
 
@@ -813,21 +814,21 @@ void sx127x_set_preamble_length(sx127x_t *dev, uint16_t preamble)
 
 void sx127x_set_rx_timeout(sx127x_t *dev, uint32_t timeout)
 {
-    DEBUG("[DEBUG] Set RX timeout: %lu\n", timeout);
+    DEBUG("[sx127x] Set RX timeout: %lu\n", timeout);
 
     dev->settings.lora.rx_timeout = timeout;
 }
 
 void sx127x_set_tx_timeout(sx127x_t *dev, uint32_t timeout)
 {
-    DEBUG("[DEBUG] Set TX timeout: %lu\n", timeout);
+    DEBUG("[sx127x] Set TX timeout: %lu\n", timeout);
 
     dev->settings.lora.tx_timeout = timeout;
 }
 
 void sx127x_set_symbol_timeout(sx127x_t *dev, uint16_t timeout)
 {
-    DEBUG("[DEBUG] Set symbol timeout: %d\n", timeout);
+    DEBUG("[sx127x] Set symbol timeout: %d\n", timeout);
 
     dev->settings.lora.rx_timeout = timeout;
 
@@ -845,7 +846,7 @@ bool sx127x_get_iq_invert(const sx127x_t *dev)
 
 void sx127x_set_iq_invert(sx127x_t *dev, bool iq_invert)
 {
-    DEBUG("[DEBUG] Set IQ invert: %d\n", iq_invert);
+    DEBUG("[sx127x] Set IQ invert: %d\n", iq_invert);
 
     _set_flag(dev, SX127X_IQ_INVERTED_FLAG, iq_invert);
 
@@ -862,7 +863,7 @@ void sx127x_set_iq_invert(sx127x_t *dev, bool iq_invert)
 
 void sx127x_set_freq_hop(sx127x_t *dev, bool freq_hop_on)
 {
-    DEBUG("[DEBUG] Set freq hop: %d\n", freq_hop_on);
+    DEBUG("[sx127x] Set freq hop: %d\n", freq_hop_on);
 
      _set_flag(dev, SX127X_CHANNEL_HOPPING_FLAG, freq_hop_on);
 }
diff --git a/drivers/sx127x/sx127x_internal.c b/drivers/sx127x/sx127x_internal.c
index 97fb8eee8c..6756cb1e3a 100644
--- a/drivers/sx127x/sx127x_internal.c
+++ b/drivers/sx127x/sx127x_internal.c
@@ -49,18 +49,18 @@ bool sx127x_test(const sx127x_t *dev)
 
 #if defined(MODULE_SX1272)
     if (version != VERSION_SX1272) {
-        DEBUG("[Error] sx1272 test failed, invalid version number: %d\n",
+        DEBUG("[sx127x] sx1272 test failed, invalid version number: %d\n",
               version);
         return false;
     }
-    DEBUG("SX1272 transceiver detected.\n");
+    DEBUG("[sx127x] SX1272 transceiver detected.\n");
 #else /* MODULE_SX1276) */
     if (version != VERSION_SX1276) {
-        DEBUG("[Error] sx1276 test failed, invalid version number: %d\n",
+        DEBUG("[sx127x] sx1276 test failed, invalid version number: %d\n",
               version);
         return false;
     }
-    DEBUG("SX1276 transceiver detected.\n");
+    DEBUG("[sx127x] SX1276 transceiver detected.\n");
 #endif
 
     return true;
diff --git a/drivers/sx127x/sx127x_netdev.c b/drivers/sx127x/sx127x_netdev.c
index 6072357311..f7e535aa7d 100644
--- a/drivers/sx127x/sx127x_netdev.c
+++ b/drivers/sx127x/sx127x_netdev.c
@@ -46,7 +46,7 @@ static int _send(netdev_t *netdev, const iolist_t *iolist)
     sx127x_t *dev = (sx127x_t*) netdev;
 
     if (sx127x_get_state(dev) == SX127X_RF_TX_RUNNING) {
-        DEBUG("[WARNING] Cannot send packet: radio already in transmitting "
+        DEBUG("[sx127x] Cannot send packet: radio already in transmitting "
               "state.\n");
         return -ENOTSUP;
     }
@@ -220,14 +220,17 @@ static int _init(netdev_t *netdev)
     sx127x->settings = settings;
 
     /* Launch initialization of driver and device */
-    DEBUG("init_radio: initializing driver...\n");
-    sx127x_init(sx127x);
+    DEBUG("[sx127x] netdev: initializing driver...\n");
+    if (sx127x_init(sx127x) != SX127X_INIT_OK) {
+        DEBUG("[sx127x] netdev: initialization failed\n");
+        return -1;
+    }
 
     sx127x_init_radio_settings(sx127x);
     /* Put chip into sleep */
     sx127x_set_sleep(sx127x);
 
-    DEBUG("init_radio: sx127x initialization done\n");
+    DEBUG("[sx127x] netdev: initialization done\n");
 
     return 0;
 }
@@ -561,10 +564,11 @@ void _on_dio0_irq(void *arg)
             }
             break;
         case SX127X_RF_IDLE:
-            printf("sx127x_on_dio0: IDLE state\n");
+            DEBUG("[sx127x] netdev: sx127x_on_dio0: IDLE state\n");
             break;
         default:
-            printf("sx127x_on_dio0: Unknown state [%d]\n", dev->settings.state);
+            DEBUG("[sx127x] netdev: sx127x_on_dio0: unknown state [%d]\n",
+                  dev->settings.state);
             break;
     }
 }
@@ -604,7 +608,7 @@ void _on_dio1_irq(void *arg)
             }
             break;
         default:
-            puts("sx127x_on_dio1: Unknown state");
+            puts("[sx127x] netdev: sx127x_on_dio1: unknown state");
             break;
     }
 }
@@ -657,7 +661,7 @@ void _on_dio2_irq(void *arg)
             }
             break;
         default:
-            puts("sx127x_on_dio2: Unknown state");
+            puts("[sx127x] netdev: sx127x_on_dio2: unknown state");
             break;
     }
 }
@@ -684,7 +688,7 @@ void _on_dio3_irq(void *arg)
             netdev->event_callback(netdev, NETDEV_EVENT_CAD_DONE);
             break;
         default:
-            puts("sx127x_on_dio3: Unknown modem");
+            puts("[sx127x] netdev: sx127x_on_dio3: unknown modem");
             break;
     }
 }
-- 
GitLab