Skip to content

Commit 0155da3

Browse files
author
smtc-bot
committed
Release v2.5.0
1 parent e0fa771 commit 0155da3

7 files changed

+639
-33
lines changed

‎CHANGELOG.md

+38-32
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## [v2.5.0] 2024-07-24
8+
9+
### Added
10+
11+
- [radio] `lr11xx_radio_set_lna_mode` function to configure usage of antenna for LNA and corresponding helper functions `lr11xx_radio_set_rx_and_lna_mode` and `lr11xx_radio_set_rx_with_timeout_in_rtc_step_and_lna_mode`
12+
713
## [v2.4.1] 2023-11-16
814

915
### Changed
@@ -70,56 +76,56 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
7076

7177
### Added
7278

73-
* [radio] `lr11xx_radio_set_lora_sync_timeout_with_mantissa_exponent()` function
74-
* [radio] `LR11XX_RADIO_PKT_TYPE_BPSK` packet type, with `lr11xx_radio_set_bpsk_pkt_params` and `lr11xx_radio_set_bpsk_mod_params` functions
75-
* [GNSS] `lr11xx_gnss_apply_mixer_cfg_workaround()` function
76-
* [GNSS] Add function `lr11xx_gnss_read_gnss_rssi_test` to read RSSI on GNSS path
77-
* [GNSS] Add function `lr11xx_gnss_read_freq_search_space`
78-
* [GNSS] Add function `lr11xx_gnss_set_freq_search_space`
79-
* [GNSS] Add function `lr11xx_gnss_get_nb_visible_satellites`
80-
* [GNSS] Add function `lr11xx_gnss_get_visible_satellites`
81-
* [GNSS] add structure `lr11xx_gnss_visible_satellite_t` to support `lr11xx_gnss_get_visible_satellites` function
82-
* [lr-fhss] Add function `lr11xx_lr_fhss_get_bit_delay_in_us` to compute the delay between the last LR-FHSS bit sent and the TX done interrupt
83-
* [radio] Add function `lr11xx_radio_set_lr_fhss_sync_word` to configure the LR-FHSS syncword
84-
* [radio] Add function `lr11xx_radio_set_lr_fhss_mod_params` to configure the LR-FHSS modulation parameters
85-
* [radio] Add helper function `lr11xx_radio_convert_nb_symb_to_mant_exp` to convert a number of symbols into mantissa/exponent representation
86-
* [crypto] Add functions `lr11xx_crypto_check_encrypted_firmware_image` and `lr11xx_crypto_get_check_encrypted_firmware_image_result`; and helper function `lr11xx_crypto_check_encrypted_firmware_image_full` to check suitability of encrypted firmware image prior to actual flashing
87-
* [ranging] Add `lr11xx_ranging_*` functions as part of new ranging component `lr11xx_ranging`
79+
- [radio] `lr11xx_radio_set_lora_sync_timeout_with_mantissa_exponent()` function
80+
- [radio] `LR11XX_RADIO_PKT_TYPE_BPSK` packet type, with `lr11xx_radio_set_bpsk_pkt_params` and `lr11xx_radio_set_bpsk_mod_params` functions
81+
- [GNSS] `lr11xx_gnss_apply_mixer_cfg_workaround()` function
82+
- [GNSS] Add function `lr11xx_gnss_read_gnss_rssi_test` to read RSSI on GNSS path
83+
- [GNSS] Add function `lr11xx_gnss_read_freq_search_space`
84+
- [GNSS] Add function `lr11xx_gnss_set_freq_search_space`
85+
- [GNSS] Add function `lr11xx_gnss_get_nb_visible_satellites`
86+
- [GNSS] Add function `lr11xx_gnss_get_visible_satellites`
87+
- [GNSS] add structure `lr11xx_gnss_visible_satellite_t` to support `lr11xx_gnss_get_visible_satellites` function
88+
- [lr-fhss] Add function `lr11xx_lr_fhss_get_bit_delay_in_us` to compute the delay between the last LR-FHSS bit sent and the TX done interrupt
89+
- [radio] Add function `lr11xx_radio_set_lr_fhss_sync_word` to configure the LR-FHSS syncword
90+
- [radio] Add function `lr11xx_radio_set_lr_fhss_mod_params` to configure the LR-FHSS modulation parameters
91+
- [radio] Add helper function `lr11xx_radio_convert_nb_symb_to_mant_exp` to convert a number of symbols into mantissa/exponent representation
92+
- [crypto] Add functions `lr11xx_crypto_check_encrypted_firmware_image` and `lr11xx_crypto_get_check_encrypted_firmware_image_result`; and helper function `lr11xx_crypto_check_encrypted_firmware_image_full` to check suitability of encrypted firmware image prior to actual flashing
93+
- [ranging] Add `lr11xx_ranging_*` functions as part of new ranging component `lr11xx_ranging`
8894

8995
### Changed
9096

91-
* [GNSS] Call to `lr11xx_gnss_apply_mixer_cfg_workaround()` in `lr11xx_gnss_scan_autonomous()` and `lr11xx_gnss_scan_assisted()` (can be removed by defining `LR11XX_DISABLE_MIXER_CFG_WORKAROUND`)
92-
* [system] Field `type` of `lr11xx_system_version_t` is now an enumerated type named `lr11xx_system_version_type_t`
93-
* [system] Add IRQ raised on LoRa symbol received over-the-air
94-
* [radio] `lr11xx_radio_set_lora_sync_timeout` takes argument `nb_symbol` as `uint16_t`
95-
* [regmem] `lr11xx_regmem_write_regmem32` and `lr11xx_regmem_read_regmem32` test the number of words to write/read before actually requesting the chip, and raise an error status if it is higher than 64
97+
- [GNSS] Call to `lr11xx_gnss_apply_mixer_cfg_workaround()` in `lr11xx_gnss_scan_autonomous()` and `lr11xx_gnss_scan_assisted()` (can be removed by defining `LR11XX_DISABLE_MIXER_CFG_WORKAROUND`)
98+
- [system] Field `type` of `lr11xx_system_version_t` is now an enumerated type named `lr11xx_system_version_type_t`
99+
- [system] Add IRQ raised on LoRa symbol received over-the-air
100+
- [radio] `lr11xx_radio_set_lora_sync_timeout` takes argument `nb_symbol` as `uint16_t`
101+
- [regmem] `lr11xx_regmem_write_regmem32` and `lr11xx_regmem_read_regmem32` test the number of words to write/read before actually requesting the chip, and raise an error status if it is higher than 64
96102

97103
## [v2.1.1] 2022-04-06
98104

99105
### Fixed
100106

101-
* [radio] Order of the parameters in `lr11xx_radio_set_rssi_calibration()` function
107+
- [radio] Order of the parameters in `lr11xx_radio_set_rssi_calibration()` function
102108

103109
## [v2.1.0] 2022-03-28
104110

105111
### Added
106112

107-
* [radio] `lr11xx_radio_apply_high_acp_workaround()` function
108-
* [radio] `lr11xx_radio_set_rssi_calibration()` function
109-
* [radio] `LR11XX_RADIO_LORA_BW_200`, `LR11XX_RADIO_LORA_BW_400` and `LR11XX_RADIO_LORA_BW_800` entries to `lr11xx_radio_lora_bw_t`
110-
* [radio] `LR11XX_RADIO_GFSK_PKT_VAR_LEN_SX128X_COMP` entry in `lr11xx_radio_gfsk_pkt_len_modes_t` to support compatibility with SX128x
111-
* [radio] `LR11XX_RADIO_GFSK_DC_FREE_WHITENING_SX128X_COMP` entry in `lr11xx_radio_gfsk_dc_free_t` to support compatibility with SX128x
112-
* [GNSS] `lr11xx_gnss_get_consumption` function
113-
* [Wi-Fi] `lr11xx_wifi_get_consumption` function
114-
* [Wi-Fi] `lr11xx_wifi_are_scan_mode_result_format_compatible` function
113+
- [radio] `lr11xx_radio_apply_high_acp_workaround()` function
114+
- [radio] `lr11xx_radio_set_rssi_calibration()` function
115+
- [radio] `LR11XX_RADIO_LORA_BW_200`, `LR11XX_RADIO_LORA_BW_400` and `LR11XX_RADIO_LORA_BW_800` entries to `lr11xx_radio_lora_bw_t`
116+
- [radio] `LR11XX_RADIO_GFSK_PKT_VAR_LEN_SX128X_COMP` entry in `lr11xx_radio_gfsk_pkt_len_modes_t` to support compatibility with SX128x
117+
- [radio] `LR11XX_RADIO_GFSK_DC_FREE_WHITENING_SX128X_COMP` entry in `lr11xx_radio_gfsk_dc_free_t` to support compatibility with SX128x
118+
- [GNSS] `lr11xx_gnss_get_consumption` function
119+
- [Wi-Fi] `lr11xx_wifi_get_consumption` function
120+
- [Wi-Fi] `lr11xx_wifi_are_scan_mode_result_format_compatible` function
115121

116122
### Changed
117123

118-
* [radio] Call to `lr11xx_radio_apply_high_acp_workaround()` in `lr11xx_radio_set_tx_with_timeout_in_rtc_step()`, `lr11xx_radio_set_rx_with_timeout_in_rtc_step()`, `lr11xx_radio_set_cad()` and `lr11xx_radio_set_tx_infinite_preamble()` (can be removed by defining `LR11XX_DISABLE_HIGH_ACP_WORKAROUND`)
119-
* [Wi-Fi] Define type `lr11xx_wifi_country_code_str_t` for Wi-Fi country code data and update `lr11xx_wifi_extended_full_result_t` and `lr11xx_wifi_country_code_t` to use it.
124+
- [radio] Call to `lr11xx_radio_apply_high_acp_workaround()` in `lr11xx_radio_set_tx_with_timeout_in_rtc_step()`, `lr11xx_radio_set_rx_with_timeout_in_rtc_step()`, `lr11xx_radio_set_cad()` and `lr11xx_radio_set_tx_infinite_preamble()` (can be removed by defining `LR11XX_DISABLE_HIGH_ACP_WORKAROUND`)
125+
- [Wi-Fi] Define type `lr11xx_wifi_country_code_str_t` for Wi-Fi country code data and update `lr11xx_wifi_extended_full_result_t` and `lr11xx_wifi_country_code_t` to use it.
120126

121127
## [v1.0.0] Unreleased
122128

123129
### Added
124130

125-
* [all] Initial version - based on LR1110 driver v7.0.0
131+
- [all] Initial version - based on LR1110 driver v7.0.0

‎src/lr11xx_radio.c

+31-1
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,22 @@ lr11xx_status_t lr11xx_radio_set_rx( const void* context, const uint32_t timeout
409409
return lr11xx_radio_set_rx_with_timeout_in_rtc_step( context, timeout_in_rtc_step );
410410
}
411411

412-
lr11xx_status_t lr11xx_radio_set_rx_with_timeout_in_rtc_step( const void* context, const uint32_t timeout )
412+
lr11xx_status_t lr11xx_radio_set_rx_and_lna_mode( const void* context, const uint32_t timeout_in_ms,
413+
lr11xx_radio_lna_mode_t lna_mode )
414+
{
415+
const uint32_t timeout_in_rtc_step = lr11xx_radio_convert_time_in_ms_to_rtc_step( timeout_in_ms );
416+
417+
return lr11xx_radio_set_rx_with_timeout_in_rtc_step_and_lna_mode( context, timeout_in_rtc_step, lna_mode );
418+
}
419+
420+
lr11xx_status_t lr11xx_radio_set_rx_with_timeout_in_rtc_step( const void* context, const uint32_t timeout_in_ms )
421+
{
422+
return lr11xx_radio_set_rx_with_timeout_in_rtc_step_and_lna_mode( context, timeout_in_ms,
423+
LR11XX_RADIO_LNA_MODE_DIFFERENTIAL_LF0 );
424+
}
425+
426+
lr11xx_status_t lr11xx_radio_set_rx_with_timeout_in_rtc_step_and_lna_mode( const void* context, const uint32_t timeout,
427+
lr11xx_radio_lna_mode_t lna_mode )
413428
{
414429
lr11xx_status_t status = LR11XX_STATUS_ERROR;
415430
const uint8_t cbuffer[LR11XX_RADIO_SET_RX_CMD_LENGTH] = {
@@ -433,6 +448,17 @@ lr11xx_status_t lr11xx_radio_set_rx_with_timeout_in_rtc_step( const void* contex
433448
{
434449
break;
435450
}
451+
452+
if( ( lna_mode == LR11XX_RADIO_LNA_MODE_SINGLE_RFI_P_LF0 ) ||
453+
( lna_mode == LR11XX_RADIO_LNA_MODE_SINGLE_RFI_N_LF0 ) )
454+
{
455+
status = lr11xx_radio_set_lna_mode( context, lna_mode );
456+
if( status != LR11XX_STATUS_OK )
457+
{
458+
break;
459+
}
460+
}
461+
436462
} while( 0 );
437463

438464
return status;
@@ -1292,6 +1318,10 @@ uint16_t lr11xx_radio_convert_nb_symb_to_mant_exp( const uint16_t nb_symbol, uin
12921318
return mant_loc << ( 2 * exp_loc + 1 );
12931319
}
12941320

1321+
lr11xx_status_t lr11xx_radio_set_lna_mode( const void* context, lr11xx_radio_lna_mode_t lna_config )
1322+
{
1323+
return lr11xx_regmem_write_regmem32_mask( context, 0x00F3008C, 0xF0, lna_config << 4 );
1324+
}
12951325
/*
12961326
* -----------------------------------------------------------------------------
12971327
* --- PRIVATE FUNCTIONS DEFINITION --------------------------------------------

‎src/lr11xx_radio.h

+81
Original file line numberDiff line numberDiff line change
@@ -285,6 +285,33 @@ lr11xx_status_t lr11xx_radio_set_lora_public_network( const void*
285285
*/
286286
lr11xx_status_t lr11xx_radio_set_rx( const void* context, const uint32_t timeout_in_ms );
287287

288+
/*!
289+
* @brief Start RX operations with a timeout in millisecond and configure the LNA LF0 mode
290+
*
291+
* This command sets the LR11XX to RX mode and configures the LNA LF0 mode. The radio must have been configured before
292+
* using this command with @ref lr11xx_radio_set_pkt_type
293+
*
294+
* This command must be issued only for sub-GHz RX operations as it configures the LNA LF0, which is only used for
295+
* sub-GHz Rx operations.
296+
*
297+
* By default, the timeout parameter allows to return automatically to standby RC mode if no packets have been received
298+
* after a certain amount of time. This behavior can be altered by @ref lr11xx_radio_set_rx_tx_fallback_mode and @ref
299+
* lr11xx_radio_auto_tx_rx.
300+
*
301+
* @remark To set the radio in Rx continuous mode, the function @ref lr11xx_radio_set_rx_with_timeout_in_rtc_step has to
302+
* be called with \p timeout_in_rtc_step set to 0xFFFFFF
303+
*
304+
* @param [in] context Chip implementation context
305+
* @param [in] timeout_in_ms The timeout configuration for RX operation
306+
* @param [in] lna_mode Path to use for reception
307+
*
308+
* @returns Operation status
309+
*
310+
* @see lr11xx_radio_set_pkt_type, lr11xx_radio_set_rx_tx_fallback_mode, lr11xx_radio_set_lna_mode
311+
*/
312+
lr11xx_status_t lr11xx_radio_set_rx_and_lna_mode( const void* context, const uint32_t timeout_in_ms,
313+
lr11xx_radio_lna_mode_t lna_mode );
314+
288315
/*!
289316
* @brief Start RX operations with a timeout in RTC step
290317
*
@@ -318,6 +345,44 @@ lr11xx_status_t lr11xx_radio_set_rx( const void* context, const uint32_t timeout
318345
*/
319346
lr11xx_status_t lr11xx_radio_set_rx_with_timeout_in_rtc_step( const void* context, const uint32_t timeout_in_rtc_step );
320347

348+
/*!
349+
* @brief Start RX operations with a timeout in RTC step and configure the LNA LF0 mode
350+
*
351+
* This command sets the LR11XX to RX mode and configures the LNA LF0 mode. The radio must have been configured before
352+
* using this command with @ref lr11xx_radio_set_pkt_type It internally calls lr11xx_radio_set_lna_mode. This command
353+
* must be issued only for sub-GHz RX operations as it configures the LNA LF0, which is only used for sub-GHz Rx
354+
* operations.
355+
*
356+
* By default, the timeout parameter allows to return automatically to standby RC mode if no packets have been received
357+
* after a certain amount of time. This behavior can be altered by @ref lr11xx_radio_set_rx_tx_fallback_mode and @ref
358+
* lr11xx_radio_auto_tx_rx.
359+
*
360+
* The timeout duration is obtained by:
361+
* \f$ timeout\_duration\_ms = timeout \times \frac{1}{32.768} \f$
362+
*
363+
* Maximal timeout value is 0xFFFFFF, which gives a maximal timeout of 511 seconds.
364+
*
365+
* The timeout argument can also have the following special values:
366+
* <table>
367+
* <tr><th> Special values </th><th> Meaning </th>
368+
* <tr><td> 0x000000 </td><td> RX single: LR11XX stays in RX mode until a
369+
* packet is received, then switch to standby RC mode <tr><td> 0xFFFFFF
370+
* </td><td> RX continuous: LR11XX stays in RX mode even after reception of a
371+
* packet
372+
* </table>
373+
*
374+
* @param [in] context Chip implementation context
375+
* @param [in] timeout_in_rtc_step The timeout configuration for RX operation
376+
* @param [in] lna_mode Path to use for reception
377+
*
378+
* @returns Operation status
379+
*
380+
* @see lr11xx_radio_set_pkt_type, lr11xx_radio_set_rx_tx_fallback_mode
381+
*/
382+
lr11xx_status_t lr11xx_radio_set_rx_with_timeout_in_rtc_step_and_lna_mode( const void* context,
383+
const uint32_t timeout_in_rtc_step,
384+
lr11xx_radio_lna_mode_t lna_mode );
385+
321386
/*!
322387
* @brief Start TX operations
323388
*
@@ -954,6 +1019,22 @@ lr11xx_status_t lr11xx_radio_apply_high_acp_workaround( const void* context );
9541019
*/
9551020
uint16_t lr11xx_radio_convert_nb_symb_to_mant_exp( const uint16_t nb_symbol, uint8_t* mant, uint8_t* exp );
9561021

1022+
/**
1023+
* @brief Configure LNA LF0 mode
1024+
*
1025+
* @remark This function shall be called after each call to lr11xx_radio_set_rx or
1026+
* lr11xx_radio_set_rx_with_timeout_in_rtc_step to be taken into account. Helper functions
1027+
* lr11xx_radio_set_rx_on_lna_path or lr11xx_radio_set_rx_with_timeout_in_rtc_step_on_lna_path can be used instead.
1028+
*
1029+
* @param [in] context Chip implementation context
1030+
* @param [in] lna_mode Value to put in the register, enum type
1031+
*
1032+
* @returns Operation status
1033+
*
1034+
* @see lr11xx_radio_set_rx_on_lna_path, lr11xx_radio_set_rx_with_timeout_in_rtc_step_on_lna_path
1035+
*/
1036+
lr11xx_status_t lr11xx_radio_set_lna_mode( const void* context, lr11xx_radio_lna_mode_t lna_mode );
1037+
9571038
#ifdef __cplusplus
9581039
}
9591040
#endif

‎src/lr11xx_radio_types.h

+12
Original file line numberDiff line numberDiff line change
@@ -628,6 +628,18 @@ typedef struct lr11xx_radio_rssi_calibration_table_s
628628
int16_t gain_offset; //!< Used to set gain offset value for RSSI calibration
629629
} lr11xx_radio_rssi_calibration_table_t;
630630

631+
/*!
632+
* @brief Values to use to setup LNA LF0 configuration
633+
*
634+
* LNA can be configured in either of the 3 modes: Single N, Single P or differential (which is default)
635+
*
636+
*/
637+
typedef enum
638+
{
639+
LR11XX_RADIO_LNA_MODE_SINGLE_RFI_N_LF0 = 1, //!< Use only RFI_N_LF0 antenna
640+
LR11XX_RADIO_LNA_MODE_SINGLE_RFI_P_LF0 = 2, //!< Use only RFI_P_LF0 antenna
641+
LR11XX_RADIO_LNA_MODE_DIFFERENTIAL_LF0 = 3 //!< Configure LNA LF0 in differential mode (default)
642+
} lr11xx_radio_lna_mode_t;
631643
/*
632644
* -----------------------------------------------------------------------------
633645
* --- PUBLIC FUNCTIONS PROTOTYPES ---------------------------------------------

0 commit comments

Comments
 (0)