[LR11X0] Add support for specifying PA ramp time

Author: Dazza0

src/modules/LR11x0/LR1110.cpp

@@ -52,7 +52,7 @@ int16_t LR1110::setFrequency(float freq) {
 
 int16_t LR1110::setFrequency(float freq, bool skipCalibration, float band) {
   RADIOLIB_CHECK_RANGE(freq, 150.0f, 960.0f, RADIOLIB_ERR_INVALID_FREQUENCY);
-  
+
   // check if we need to recalibrate image
   int16_t state;
   if(!skipCalibration && (fabsf(freq - this->freqMHz) >= RADIOLIB_LR11X0_CAL_IMG_FREQ_TRIG_MHZ)) {
@@ -71,22 +71,22 @@ int16_t LR1110::setOutputPower(int8_t power) {
   return(this->setOutputPower(power, false));
 }
 
-int16_t LR1110::setOutputPower(int8_t power, bool forceHighPower) {
+int16_t LR1110::setOutputPower(int8_t power, bool forceHighPower, uint32_t rampTimeUs) {
   // check if power value is configurable
   int16_t state = this->checkOutputPower(power, NULL, forceHighPower);
   RADIOLIB_ASSERT(state);
 
   // determine whether to use HP or LP PA and check range accordingly
   bool useHp = forceHighPower || (power > 14);
-  
+
   // TODO how and when to configure OCP?
 
   // update PA config - always use VBAT for high-power PA
   state = setPaConfig((uint8_t)useHp, (uint8_t)useHp, 0x04, 0x07);
   RADIOLIB_ASSERT(state);
 
   // set output power
-  state = setTxParams(power, RADIOLIB_LR11X0_PA_RAMP_48U);
+  state = setTxParams(power, roundRampTime(rampTimeUs));
   return(state);
 }
 
@@ -100,13 +100,13 @@ int16_t LR1110::checkOutputPower(int8_t power, int8_t* clipped, bool forceHighPo
       *clipped = RADIOLIB_MAX(-9, RADIOLIB_MIN(22, power));
     }
     RADIOLIB_CHECK_RANGE(power, -9, 22, RADIOLIB_ERR_INVALID_OUTPUT_POWER);
-  
+
   } else {
     if(clipped) {
       *clipped = RADIOLIB_MAX(-17, RADIOLIB_MIN(14, power));
     }
     RADIOLIB_CHECK_RANGE(power, -17, 14, RADIOLIB_ERR_INVALID_OUTPUT_POWER);
-  
+
   }
   return(RADIOLIB_ERR_NONE);
 }

src/modules/LR11x0/LR1110.h

@@ -52,7 +52,7 @@ class LR1110: public LR11x0 {
       \returns \ref status_codes
     */
     int16_t beginGFSK(float freq = 434.0, float br = 4.8, float freqDev = 5.0, float rxBw = 156.2, int8_t power = 10, uint16_t preambleLength = 16, float tcxoVoltage = 1.6);
-    
+
     /*!
       \brief Initialization method for LR-FHSS modem.
       \param freq Carrier frequency in MHz. Defaults to 434.0 MHz.
@@ -90,7 +90,7 @@ class LR1110: public LR11x0 {
       \returns \ref status_codes
     */
     int16_t setFrequency(float freq, bool skipCalibration, float band = 4);
-    
+
     /*!
       \brief Sets output power. Allowed values are in range from -9 to 22 dBm (high-power PA) or -17 to 14 dBm (low-power PA).
       \param power Output power to be set in dBm, output PA is determined automatically preferring the low-power PA.
@@ -103,9 +103,11 @@ class LR1110: public LR11x0 {
       \param power Output power to be set in dBm.
       \param forceHighPower Force using the high-power PA. If set to false, PA will be determined automatically
       based on configured output power, preferring the low-power PA. If set to true, only high-power PA will be used.
+      \param rampTimeUs PA power ramping time in microseconds. Provided value is rounded up to the
+      nearest discrete ramp time supported by the PA. Defaults to 48 us.
       \returns \ref status_codes
     */
-    int16_t setOutputPower(int8_t power, bool forceHighPower);
+    int16_t setOutputPower(int8_t power, bool forceHighPower, uint32_t rampTimeUs = 48);
 
     /*!
       \brief Check if output power is configurable.

src/modules/LR11x0/LR1120.cpp

@@ -78,7 +78,7 @@ int16_t LR1120::setOutputPower(int8_t power) {
   return(this->setOutputPower(power, false));
 }
 
-int16_t LR1120::setOutputPower(int8_t power, bool forceHighPower) {
+int16_t LR1120::setOutputPower(int8_t power, bool forceHighPower, uint32_t rampTimeUs) {
   // check if power value is configurable
   int16_t state = this->checkOutputPower(power, NULL, forceHighPower);
   RADIOLIB_ASSERT(state);
@@ -92,15 +92,15 @@ int16_t LR1120::setOutputPower(int8_t power, bool forceHighPower) {
     paSel = 1;
     paSupply = 1;
   }
-  
+
   // TODO how and when to configure OCP?
 
   // update PA config - always use VBAT for high-power PA
   state = setPaConfig(paSel, paSupply, 0x04, 0x07);
   RADIOLIB_ASSERT(state);
 
   // set output power
-  state = setTxParams(power, RADIOLIB_LR11X0_PA_RAMP_48U);
+  state = setTxParams(power, roundRampTime(rampTimeUs));
   return(state);
 }
 
@@ -122,13 +122,13 @@ int16_t LR1120::checkOutputPower(int8_t power, int8_t* clipped, bool forceHighPo
       *clipped = RADIOLIB_MAX(-9, RADIOLIB_MIN(22, power));
     }
     RADIOLIB_CHECK_RANGE(power, -9, 22, RADIOLIB_ERR_INVALID_OUTPUT_POWER);
-  
+
   } else {
     if(clipped) {
       *clipped = RADIOLIB_MAX(-17, RADIOLIB_MIN(14, power));
     }
     RADIOLIB_CHECK_RANGE(power, -17, 14, RADIOLIB_ERR_INVALID_OUTPUT_POWER);
-  
+
   }
   return(RADIOLIB_ERR_NONE);
 }

src/modules/LR11x0/LR1120.h

@@ -52,7 +52,7 @@ class LR1120: public LR11x0 {
       \returns \ref status_codes
     */
     int16_t beginGFSK(float freq = 434.0, float br = 4.8, float freqDev = 5.0, float rxBw = 156.2, int8_t power = 10, uint16_t preambleLength = 16, float tcxoVoltage = 1.6);
-    
+
     /*!
       \brief Initialization method for LR-FHSS modem.
       \param freq Carrier frequency in MHz. Defaults to 434.0 MHz.
@@ -112,9 +112,11 @@ class LR1120: public LR11x0 {
       If set to false, PA will be determined automatically based on configured output power and frequency,
       preferring the low-power PA but always using high-frequency PA in 2.4 GHz band.
       Ignored when operating in 2.4 GHz band.
+      \param rampTimeUs PA power ramping time in microseconds. Provided value is rounded up to the
+      nearest discrete ramp time supported by the PA. Defaults to 48 us.
       \returns \ref status_codes
     */
-    int16_t setOutputPower(int8_t power, bool forceHighPower);
+    int16_t setOutputPower(int8_t power, bool forceHighPower, uint32_t rampTimeUs = 48);
 
     /*!
       \brief Check if output power is configurable.

src/modules/LR11x0/LR11x0.h

@@ -264,7 +264,7 @@
 #define RADIOLIB_LR11X0_IRQ_PREAMBLE_DETECTED                   (0x01UL << 4)   //  31    0                preamble detected
 #define RADIOLIB_LR11X0_IRQ_SYNC_WORD_HEADER_VALID              (0x01UL << 5)   //  31    0                sync word or LoRa header valid
 #define RADIOLIB_LR11X0_IRQ_HEADER_ERR                          (0x01UL << 6)   //  31    0                LoRa header CRC error
-#define RADIOLIB_LR11X0_IRQ_CRC_ERR                             (0x01UL << 7)   //  31    0                packet CRC error 
+#define RADIOLIB_LR11X0_IRQ_CRC_ERR                             (0x01UL << 7)   //  31    0                packet CRC error
 #define RADIOLIB_LR11X0_IRQ_CAD_DONE                            (0x01UL << 8)   //  31    0                CAD completed
 #define RADIOLIB_LR11X0_IRQ_CAD_DETECTED                        (0x01UL << 9)   //  31    0                CAD detected
 #define RADIOLIB_LR11X0_IRQ_TIMEOUT                             (0x01UL << 10)  //  31    0                Rx or Tx timeout
@@ -443,7 +443,22 @@
 #define RADIOLIB_LR11X0_GFSK_WHITENING_ENABLED                  (0x01UL << 0)   //  7     0                enabled
 
 // RADIOLIB_LR11X0_CMD_SET_TX_PARAMS
-#define RADIOLIB_LR11X0_PA_RAMP_48U                             (0x02UL << 0)   //  7     0     PA ramp time: 48 us
+#define RADIOLIB_LR11X0_PA_RAMP_16U                             (0x00UL << 0)   //  7     0     PA ramp time: 16 us
+#define RADIOLIB_LR11X0_PA_RAMP_32U                             (0x01UL << 0)   //  7     0                   32 us
+#define RADIOLIB_LR11X0_PA_RAMP_48U                             (0x02UL << 0)   //  7     0                   48 us
+#define RADIOLIB_LR11X0_PA_RAMP_64U                             (0x03UL << 0)   //  7     0                   64 us
+#define RADIOLIB_LR11X0_PA_RAMP_80U                             (0x04UL << 0)   //  7     0                   80 us
+#define RADIOLIB_LR11X0_PA_RAMP_96U                             (0x05UL << 0)   //  7     0                   96 us
+#define RADIOLIB_LR11X0_PA_RAMP_112U                            (0x06UL << 0)   //  7     0                   112 us
+#define RADIOLIB_LR11X0_PA_RAMP_128U                            (0x07UL << 0)   //  7     0                   128 us
+#define RADIOLIB_LR11X0_PA_RAMP_144U                            (0x08UL << 0)   //  7     0                   144 us
+#define RADIOLIB_LR11X0_PA_RAMP_160U                            (0x09UL << 0)   //  7     0                   160 us
+#define RADIOLIB_LR11X0_PA_RAMP_176U                            (0x0AUL << 0)   //  7     0                   176 us
+#define RADIOLIB_LR11X0_PA_RAMP_192U                            (0x0BUL << 0)   //  7     0                   192 us
+#define RADIOLIB_LR11X0_PA_RAMP_208U                            (0x0CUL << 0)   //  7     0                   208 us
+#define RADIOLIB_LR11X0_PA_RAMP_240U                            (0x0DUL << 0)   //  7     0                   240 us
+#define RADIOLIB_LR11X0_PA_RAMP_272U                            (0x0EUL << 0)   //  7     0                   272 us
+#define RADIOLIB_LR11X0_PA_RAMP_304U                            (0x0FUL << 0)   //  7     0                   304 us
 
 // RADIOLIB_LR11X0_CMD_SET_RX_TX_FALLBACK_MODE
 #define RADIOLIB_LR11X0_FALLBACK_MODE_STBY_RC                   (0x01UL << 0)   //  1     0     fallback mode after Rx/Tx: standby with RC
@@ -760,22 +775,22 @@ struct LR11x0VersionInfo_t {
 
   /*! \brief Which device this is - one of RADIOLIB_LR11X0_DEVICE_* macros. */
   uint8_t device;
-  
+
   /*! \brief Major revision of the base firmware. */
   uint8_t fwMajor;
-  
+
   /*! \brief Minor revision of the base firmware. */
   uint8_t fwMinor;
 
   /*! \brief Major revision of the WiFi firmware. */
   uint8_t fwMajorWiFi;
-  
+
   /*! \brief Minor revision of the WiFi firmware. */
   uint8_t fwMinorWiFi;
 
   /*! \brief Revision of the GNSS firmware. */
   uint8_t fwGNSS;
-  
+
   /*! \brief Almanac revision of the GNSS firmware. */
   uint8_t almanacGNSS;
 };
@@ -787,7 +802,7 @@ struct LR11x0VersionInfo_t {
 struct LR11x0GnssResult_t {
   /*! \brief Demodulator status. One of RADIOLIB_LR11X0_GNSS_DEMOD_STATUS_* */
   int8_t demodStat;
-  
+
   /*! \brief Number of satellites detected during the scan. */
   uint8_t numSatsDet;
 
@@ -913,7 +928,7 @@ class LR11x0: public PhysicalLayer {
       \brief Whether the module has an XTAL (true) or TCXO (false). Defaults to false.
     */
     bool XTAL;
-    
+
     /*!
       \brief Initialization method for LoRa modem.
       \param bw LoRa bandwidth in kHz.
@@ -1038,7 +1053,7 @@ class LR11x0: public PhysicalLayer {
       \returns \ref status_codes
     */
     int16_t sleep(bool retainConfig, uint32_t sleepTime);
-    
+
     // interrupt methods
 
     /*!
@@ -1103,7 +1118,7 @@ class LR11x0: public PhysicalLayer {
       \returns \ref status_codes
     */
     int16_t readData(uint8_t* data, size_t len) override;
-    
+
     /*!
       \brief Interrupt-driven channel activity detection method. IRQ1 will be activated
       when LoRa preamble is detected, or upon timeout. Defaults to CAD parameter values recommended by AN1200.48.
@@ -1180,7 +1195,7 @@ class LR11x0: public PhysicalLayer {
       \returns \ref status_codes
     */
     int16_t setRxBandwidth(float rxBw);
-    
+
     /*!
       \brief Sets GFSK sync word in the form of array of up to 8 bytes.
       \param syncWord GFSK sync word to be set.
@@ -1443,7 +1458,7 @@ class LR11x0: public PhysicalLayer {
       \returns \ref status_codes
     */
     int16_t setLrFhssConfig(uint8_t bw, uint8_t cr, uint8_t hdrCount = 3, uint16_t hopSeed = 0x13A);
-    
+
     /*!
       \brief Start passive WiFi scan. BUSY pin will be de-activated when the scan is finished.
       \param wifiType Type of WiFi (802.11) signals to scan, 'b', 'n', 'g' or '*' for all signals.
@@ -1488,7 +1503,7 @@ class LR11x0: public PhysicalLayer {
       \returns \ref status_codes
     */
     int16_t getWifiScanResult(LR11x0WifiResult_t* result, uint8_t index, bool brief = false);
-    
+
     /*!
       \brief Blocking WiFi scan method. Performs a full passive WiFi scan.
       This method may block for several seconds!
@@ -1506,14 +1521,14 @@ class LR11x0: public PhysicalLayer {
       \returns \ref status_codes
     */
     int16_t wifiScan(uint8_t wifiType, uint8_t* count, uint8_t mode = RADIOLIB_LR11X0_WIFI_ACQ_MODE_FULL_BEACON, uint16_t chanMask = RADIOLIB_LR11X0_WIFI_ALL_CHANNELS, uint8_t numScans = 16, uint16_t timeout = 100);
-   
+
     /*!
       \brief Retrieve LR11x0 hardware, device and firmware version information.
       \param info Pointer to LR11x0VersionInfo_t structure to populate.
       \returns \ref status_codes
     */
     int16_t getVersionInfo(LR11x0VersionInfo_t* info);
-    
+
     /*!
       \brief Method to upload new firmware image to the device.
       The device will be automatically erased, a new firmware will be uploaded,
@@ -1525,7 +1540,7 @@ class LR11x0: public PhysicalLayer {
       \returns \ref status_codes
     */
     int16_t updateFirmware(const uint32_t* image, size_t size, bool nonvolatile = true);
-    
+
     /*!
       \brief Method to check whether the device is capable of performing a GNSS scan.
       \returns \ref status_codes
@@ -1566,7 +1581,7 @@ class LR11x0: public PhysicalLayer {
       \returns \ref status_codes
     */
     int16_t updateGnssAlmanac(uint8_t constellation);
-    
+
     /*!
       \brief Get GNSS position. Called after gnssScan to retrieve the position calculated by the internal solver.
       \param pos Pointer to LR11x0GnssPosition_t structure to populate.
@@ -1598,18 +1613,26 @@ class LR11x0: public PhysicalLayer {
       \returns \ref status_codes
     */
     int16_t calibrateImageRejection(float freqMin, float freqMax);
-    
+
     /*! \copydoc PhysicalLayer::stageMode */
     int16_t stageMode(RadioModeType_t mode, RadioModeConfig_t* cfg) override;
 
     /*! \copydoc PhysicalLayer::launchMode */
     int16_t launchMode() override;
-    
+
 #if !RADIOLIB_GODMODE && !RADIOLIB_LOW_LEVEL
   protected:
 #endif
     Module* getMod() override;
 
+    // LR11x0 command helpers
+    /*!
+      \brief Round up a PA power ramp time to register value
+      \param rampTimeUs Ramp time in microseconds
+      \returns Register value of rounded ramp time
+    */
+    uint8_t roundRampTime(uint32_t rampTimeUs);
+
     // LR11x0 SPI command implementations
     int16_t writeRegMem32(uint32_t addr, const uint32_t* data, size_t len);
     int16_t readRegMem32(uint32_t addr, uint32_t* data, size_t len);
@@ -1777,9 +1800,9 @@ class LR11x0: public PhysicalLayer {
     int16_t bootGetPin(uint8_t* pin);
     int16_t bootGetChipEui(uint8_t* eui);
     int16_t bootGetJoinEui(uint8_t* eui);
-    
+
     int16_t SPIcommand(uint16_t cmd, bool write, uint8_t* data, size_t len, const uint8_t* out = NULL, size_t outLen = 0);
-    
+
 #if !RADIOLIB_GODMODE
   protected:
 #endif