Merge pull request #21684 from fabian18/pr/sx126x_dio2_dio3

fabian18 · web-flow · commit 3eee3687d80f · 2025-08-27T16:04:09.000Z
drivers/sx126x: add support for Dio2 and Dio3
diff --git a/drivers/include/sx126x.h b/drivers/include/sx126x.h
@@ -78,6 +78,33 @@ typedef enum {
     SX126X_TYPE_STM32WL,
 } sx126x_type_t;
 
+/**
+ * @brief   Dio2 pin mode
+ */
+typedef enum {
+    SX126X_DIO2_UNUSED,     /**< Not used */
+    SX126X_DIO2_IRQ,        /**< IRQ pin (ToDo) */
+    SX126X_DIO2_RF_SWITCH,  /**< RF switch control pin */
+} sx126x_dio2_mode_t;
+
+/**
+ * @brief   Dio3 pin mode
+ */
+typedef enum {
+    SX126X_DIO3_UNUSED,     /**< Not used */
+    SX126X_DIO3_IRQ,        /**< IRQ pin (ToDo) */
+    SX126X_DIO3_TCXO,       /**< TCXO control pin */
+} sx126x_dio3_mode_t;
+
+/**
+ * @brief   Mask of all available interrupts
+ */
+#define SX126X_IRQ_MASK_ALL     (SX126X_IRQ_TX_DONE | SX126X_IRQ_RX_DONE | \
+                                 SX126X_IRQ_PREAMBLE_DETECTED | SX126X_IRQ_SYNC_WORD_VALID | \
+                                 SX126X_IRQ_HEADER_VALID | SX126X_IRQ_HEADER_ERROR | \
+                                 SX126X_IRQ_CRC_ERROR | SX126X_IRQ_CAD_DONE | \
+                                 SX126X_IRQ_CAD_DETECTED | SX126X_IRQ_TIMEOUT)
+
 /**
  * @brief   Device initialization parameters
  */
@@ -87,6 +114,17 @@ typedef struct {
     gpio_t reset_pin;                   /**< Reset pin */
     gpio_t busy_pin;                    /**< Busy pin */
     gpio_t dio1_pin;                    /**< Dio1 pin */
+#if IS_USED(MODULE_SX126X_DIO2)
+    sx126x_dio2_mode_t dio2_mode;       /**< Dio2 mode */
+#endif
+#if IS_USED(MODULE_SX126X_DIO3)
+    sx126x_dio3_mode_t dio3_mode;       /**< Dio3 mode */
+    struct {
+        unsigned tcxo_volt    :8;   /**< TCXO voltage (see sx126x_tcxo_ctrl_voltages_t)*/
+        unsigned tcxo_timeout :24;  /**< TCXO timeout to wait for 32MHz coming from TXC0,
+                                         Delay duration = Delay(23:0) * 15.625 μs */
+    } dio3_arg;
+#endif
     sx126x_reg_mod_t regulator;         /**< Power regulator mode */
     sx126x_type_t type;                 /**< Variant of sx126x */
 #if IS_USED(MODULE_SX126X_RF_SWITCH)
diff --git a/drivers/sx126x/Makefile.include b/drivers/sx126x/Makefile.include
@@ -7,6 +7,8 @@ PSEUDOMODULES += sx126x_stm32wl
 
 # include RF switch implemented in the board for use with sx126x
 PSEUDOMODULES += sx126x_rf_switch
+PSEUDOMODULES += sx126x_dio2
+PSEUDOMODULES += sx126x_dio3
 
 USEMODULE_INCLUDES_sx126x := $(LAST_MAKEFILEDIR)/include
 USEMODULE_INCLUDES += $(USEMODULE_INCLUDES_sx126x)
diff --git a/drivers/sx126x/include/sx126x_params.h b/drivers/sx126x/include/sx126x_params.h
@@ -63,7 +63,11 @@ extern "C" {
 #  define SX126X_PARAM_DIO1                 GPIO_PIN(1, 4)  /* D5 */
 #endif
 
-#ifndef SX126X_PARAM_REGULATOR
+#if !defined(SX126X_PARAM_REGULATOR) || defined(DOXYGEN)
+/**
+ * @brief   Regulator type which can be
+ *          SX126X_REG_MODE_LDO or SX126X_REG_MODE_DCDC
+ */
 #  define SX126X_PARAM_REGULATOR            SX126X_REG_MODE_DCDC
 #endif
 
@@ -75,6 +79,48 @@ extern "C" {
 #  define SX126X_PARAM_TX_PA_MODE           SX126X_RF_MODE_TX_LPA
 #endif
 
+#if !defined(SX126X_PARAM_DIO2_MODE) || defined(DOXYGEN)
+/**
+ * @brief   DIO2 pin mode which can be
+ *          SX126X_DIO2_UNUSED, SX126X_DIO2_IRQ or SX126X_DIO2_RF_SWITCH
+ */
+#  define SX126X_PARAM_DIO2_MODE            SX126X_DIO2_UNUSED
+#endif
+
+#if !defined(SX126X_PARAM_DIO3_MODE) || defined(DOXYGEN)
+/**
+ * @brief   DIO3 pin mode which can be
+ *          SX126X_DIO3_UNUSED, SX126X_DIO3_IRQ or SX126X_DIO3_TCXO
+ */
+#  define SX126X_PARAM_DIO3_MODE            SX126X_DIO3_UNUSED
+#endif
+
+#if !defined(SX126X_PARAM_TCXO_VOLTAGE) || defined(DOXYGEN)
+/**
+ * @brief   TCXO voltage is configured to be 200 mV below the supply voltage.
+ *
+ * This means that even if tcxoVoltage is configured above the supply voltage,
+ * the supply voltage will be limited by: VDDop > VTCXO + 200 mV
+ */
+#  define SX126X_PARAM_TCXO_VOLTAGE         SX126X_TCXO_CTRL_3_0V
+#endif
+
+#if !defined(SX126X_PARAM_TCXO_TIMEOUT) || defined(DOXYGEN)
+/**
+ * @brief   Timeout for tcxo stabilization in 15.625 µs steps
+ *          The default value is 256 (4ms).
+ */
+#  define SX126X_PARAM_TCXO_TIMEOUT         256
+#endif
+
+#if !defined(SX126X_PARAM_DIO3_ARG) || defined(DOXYGEN)
+/**
+ * @brief   DIO3 argument if mode is SX126X_DIO3_TCXO
+ */
+#  define SX126X_PARAM_DIO3_ARG             { .tcxo_volt = SX126X_PARAM_TCXO_VOLTAGE, \
+                                              .tcxo_timeout = SX126X_PARAM_TCXO_TIMEOUT }
+#endif
+
 #ifndef SX126X_PARAM_TYPE
 #  if IS_USED(MODULE_SX1261)
 #    define SX126X_PARAM_TYPE SX126X_TYPE_SX1261
@@ -93,22 +139,49 @@ extern "C" {
 
 #if IS_USED(MODULE_SX126X_RF_SWITCH)
 #  define SX126X_SET_RF_MODE  .set_rf_mode = SX126X_PARAM_SET_RF_MODE_CB,
-#  define SX126X_TX_PA_MODE   .tx_pa_mode = SX126X_PARAM_TX_PA_MODE
+#  define SX126X_TX_PA_MODE   .tx_pa_mode = SX126X_PARAM_TX_PA_MODE,
 #else
 #  define SX126X_SET_RF_MODE
 #  define SX126X_TX_PA_MODE
 #endif
 
+#if IS_USED(MODULE_SX126X_DIO2) || defined(DOXYGEN)
+/**
+ * @brief   DIO2 pin mode
+ */
+#  define SX126X_DIO2_MODE      .dio2_mode = SX126X_PARAM_DIO2_MODE,
+#else
+#  define SX126X_DIO2_MODE
+#endif
+
+#if IS_USED(MODULE_SX126X_DIO3) || defined(DOXYGEN)
+/**
+ * @brief   DIO3 pin mode
+ */
+#  define SX126X_DIO3_MODE      .dio3_mode = SX126X_PARAM_DIO3_MODE,
+/**
+ * @brief   DIO3 pin argument
+ */
+#  define SX126X_DIO3_ARG       .dio3_arg = SX126X_PARAM_DIO3_ARG,
+#else
+#  define SX126X_DIO3_MODE
+#  define SX126X_DIO3_ARG
+#endif
+
 #ifndef SX126X_PARAMS
-#  define SX126X_PARAMS           { .spi = SX126X_PARAM_SPI,            \
-                                    .nss_pin = SX126X_PARAM_SPI_NSS,    \
-                                    .reset_pin = SX126X_PARAM_RESET,    \
-                                    .busy_pin = SX126X_PARAM_BUSY,      \
-                                    .dio1_pin = SX126X_PARAM_DIO1,      \
-                                    .type     = SX126X_PARAM_TYPE,      \
-                                    .regulator = SX126X_PARAM_REGULATOR, \
-                                    SX126X_SET_RF_MODE \
-                                    SX126X_TX_PA_MODE}
+#  define SX126X_PARAMS           { .spi = SX126X_PARAM_SPI,                      \
+                                    .nss_pin = SX126X_PARAM_SPI_NSS,              \
+                                    .reset_pin = SX126X_PARAM_RESET,              \
+                                    .busy_pin = SX126X_PARAM_BUSY,                \
+                                    .dio1_pin = SX126X_PARAM_DIO1,                \
+                                    .type     = SX126X_PARAM_TYPE,                \
+                                    .regulator = SX126X_PARAM_REGULATOR,          \
+                                    SX126X_SET_RF_MODE                            \
+                                    SX126X_TX_PA_MODE                             \
+                                    SX126X_DIO2_MODE                              \
+                                    SX126X_DIO3_MODE                              \
+                                    SX126X_DIO3_ARG                               \
+                                   }
 #endif
 
 /**@}*/
diff --git a/drivers/sx126x/sx126x.c b/drivers/sx126x/sx126x.c
@@ -26,6 +26,7 @@
 #include "periph/spi.h"
 
 #include "sx126x.h"
+#include "sx126x_regs.h"
 #include "sx126x_params.h"
 #include "sx126x_internal.h"
 
@@ -189,21 +190,50 @@ int sx126x_init(sx126x_t *dev)
     /* Initialize radio with the default parameters */
     sx126x_init_default_config(dev);
 
-    /* Configure available IRQs */
-    const uint16_t irq_mask = (
-        SX126X_IRQ_TX_DONE |
-        SX126X_IRQ_RX_DONE |
-        SX126X_IRQ_PREAMBLE_DETECTED |
-        SX126X_IRQ_SYNC_WORD_VALID |
-        SX126X_IRQ_HEADER_VALID |
-        SX126X_IRQ_HEADER_ERROR |
-        SX126X_IRQ_CRC_ERROR |
-        SX126X_IRQ_CAD_DONE |
-        SX126X_IRQ_CAD_DETECTED |
-        SX126X_IRQ_TIMEOUT
-        );
+#if IS_USED(MODULE_SX126X_DIO2)
+    if (dev->params->dio2_mode == SX126X_DIO2_RF_SWITCH) {
+        sx126x_set_dio2_as_rf_sw_ctrl(dev, true);
+    }
+#endif
+#if IS_USED(MODULE_SX126X_DIO3)
+     if (dev->params->dio3_mode == SX126X_DIO3_TCXO) {
+        sx126x_set_dio3_as_tcxo_ctrl(dev, dev->params->u_dio3_arg.tcxo_volt,
+                                     dev->params->u_dio3_arg.tcx0_timeout);
+
+        /* Once the command SetDIO3AsTCXOCtrl(...) is sent to the device,
+           the register controlling the internal cap on XTA will be automatically
+           changed to 0x2F (33.4 pF) to filter any spurious injection which could occur
+           and be propagated to the PLL.- Verify that. */
+        uint8_t trimming_capacitor_values[2] = { 0 };
+        sx126x_read_register(dev, SX126X_REG_XTATRIM,
+                             trimming_capacitor_values,
+                             sizeof(trimming_capacitor_values));
+        /* 11.3 pF + x * 0.47pF  = 33.4pF | x = 0x2f*/
+        if (trimming_capacitor_values[0] != 0x2f) {
+            DEBUG("[sx126x] warning: failed to set TCXO control: SX126X_REG_XTATRIM=%02x\n",
+                  trimming_capacitor_values[0]);
+        }
+        DEBUG("[sx126x] XTA capacitor ~ %upF\n",
+              (unsigned)(0.5f + (11.3f + trimming_capacitor_values[0] * 0.47f)));
+        DEBUG("[sx126x] XTB capacitor ~ %upF\n",
+              (unsigned)(0.5f + (11.3f + trimming_capacitor_values[1] * 0.47f)));
+
+        /* When the 32 MHz clock is coming from a TCXO, the calibration will fail
+           and the user should request a complete calibration after calling the function
+           SetDIO3AsTcxoCtrl(...). */
+        sx126x_cal(dev, SX126X_CAL_ALL);
+    }
+#endif
+    /* The user can specify the use of DC-DC by using the command SetRegulatorMode(...).
+       This operation must be carried out in STDBY_RC mode only.*/
+    sx126x_set_reg_mode(dev, dev->params->regulator);
+
+    /* Initialize radio with the default parameters */
+    sx126x_init_default_config(dev);
+
+    sx126x_set_standby(dev, SX126X_STANDBY_CFG_XOSC);
 
-    sx126x_set_dio_irq_params(dev, irq_mask, irq_mask, 0, 0);
+    sx126x_set_dio_irq_params(dev, SX126X_IRQ_MASK_ALL, SX126X_IRQ_MASK_ALL, 0, 0);
 
     if (IS_ACTIVE(ENABLE_DEBUG)) {
         sx126x_pkt_type_t pkt_type;
