From 35ed685c8a78188006e40939980620236c0c921b Mon Sep 17 00:00:00 2001
From: Andrew Moroz <andrew@cashortrade.org>
Date: Mon, 16 Jan 2023 00:14:54 -0500
Subject: [PATCH] andrew-moroz/sx126x-rx-boosted-gain: Add method to support
 SX126x Rx Boosted Gain mode

---
 keywords.txt                  |  1 +
 src/modules/SX126x/SX126x.cpp | 20 ++++++++++++++++++++
 src/modules/SX126x/SX126x.h   |  9 +++++++++
 3 files changed, 30 insertions(+)

diff --git a/keywords.txt b/keywords.txt
index 550790d2..c13d0ff6 100644
--- a/keywords.txt
+++ b/keywords.txt
@@ -194,6 +194,7 @@ setRegulatorDCDC	KEYWORD2
 getCurrentLimit	KEYWORD2
 getIrqStatus	KEYWORD2
 getLastError	KEYWORD2
+setRxBoostedGainMode	KEYWORD2
 
 # nRF24
 setIrqAction	KEYWORD2
diff --git a/src/modules/SX126x/SX126x.cpp b/src/modules/SX126x/SX126x.cpp
index 2e95d778..1e23dda2 100644
--- a/src/modules/SX126x/SX126x.cpp
+++ b/src/modules/SX126x/SX126x.cpp
@@ -870,6 +870,26 @@ int16_t SX126x::setRxBandwidth(float rxBw) {
   return(setModulationParamsFSK(_br, _pulseShape, _rxBw, _freqDev));
 }
 
+int16_t SX126x::setRxBoostedGainMode(bool rxbgm) {
+  // read the current register value
+  uint8_t rxGain = 0;
+  int16_t state = readRegister(RADIOLIB_SX126X_REG_RX_GAIN, &rxGain, 1);
+  RADIOLIB_ASSERT(state);
+
+  // gain mode register value (SX1261/2 datasheet v2.1 section 9.6)
+  if(rxbgm) {
+    rxGain = 0x96; // Rx Boosted Gain
+  } else {
+    rxGain = 0x94; // Rx Power Saving Gain
+  }
+
+  // update RX gain setting register
+  state = writeRegister(RADIOLIB_SX126X_REG_RX_GAIN, &rxGain, 1);
+  RADIOLIB_ASSERT(state);
+
+  return(state);
+}
+
 int16_t SX126x::setDataShaping(uint8_t sh) {
   // check active modem
   if(getPacketType() != RADIOLIB_SX126X_PACKET_TYPE_GFSK) {
diff --git a/src/modules/SX126x/SX126x.h b/src/modules/SX126x/SX126x.h
index 97cb77e1..12a737f9 100644
--- a/src/modules/SX126x/SX126x.h
+++ b/src/modules/SX126x/SX126x.h
@@ -708,6 +708,15 @@ class SX126x: public PhysicalLayer {
     */
     int16_t setRxBandwidth(float rxBw);
 
+    /*!
+      \brief Enables or disables Rx Boosted Gain mode as described in SX126x datasheet section 9.6 (SX1261/2 v2.1, SX1268 v1.1)
+
+      \param rxbgm True for Rx Boosted Gain, false for Rx Power Saving Gain
+
+      \returns \ref status_codes
+    */
+    int16_t setRxBoostedGainMode(bool rxbgm);
+
     /*!
       \brief Sets time-bandwidth product of Gaussian filter applied for shaping.
       Allowed values are RADIOLIB_SHAPING_0_3, RADIOLIB_SHAPING_0_5, RADIOLIB_SHAPING_0_7 or RADIOLIB_SHAPING_1_0.