Release v2.7.0

Author: smtc-bot

CHANGELOG.md

@@ -4,7 +4,38 @@ All notable changes to this project will be documented in this file.
 
 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).
 
-## [v2.5.2] - v2.5.2
+## [v2.7.0] - 2025-04-14
+
+### Added
+
+- CMake support
+- GFSK workarounds for specific modulation configurations:
+  - `lr11xx_workaround_gfsk_1_2_kbps`
+  - `lr11xx_workaround_gfsk_0_6_kbps_sub_ghz`
+  - `lr11xx_workaround_gfsk_0_6_kbps_ghz`
+  - `lr11xx_workaround_gfsk_reset`
+
+### Changed
+
+- `lr11xx_crypto_process_join_accept` returns an error if the data is longer than the maximum of 32 bytes
+- `lr11xx_crypto_process_join_accept` now returns an error if the provided *lorawan_version* is invalid
+
+### Fixed
+
+- Fixed incorrect pointer conversion that may generate incorrect results on `lr11xx_hal_read` calls
+- Compile warnings in `lr11xx_workaround_gfsk_reset` and `lr11xx_workaround_gfsk_1_2_kbps`
+
+## [v2.6.0] - 2025-01-28
+
+### Added
+
+- `lr11xx_bootloader_get_hash` to get the flash code hash value
+
+### Fixed
+
+- Fix Wi-Fi MAC address endianness parsing when reading country code results
+
+## [v2.5.2] - 2024-11-19
 
 ### Fixed
 

src/lr11xx_driver_module.cmake CMakeLists.txtsrc/lr11xx_driver_module.cmake renamed to CMakeLists.txt

@@ -1,6 +1,6 @@
-# @file lr11xx_driver_module.cmake
+# @file
 #
-# @brief Defines CMake source files and include directories for this module
+# @brief CMake library project
 #
 # --- The Clear BSD License ---
 # Copyright Semtech Corporation 2021. All rights reserved.
@@ -30,20 +30,22 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-set(LR11XX_DRIVER_MODULE_C_SOURCES
-  ${CMAKE_CURRENT_LIST_DIR}/lr11xx_bootloader.c
-  ${CMAKE_CURRENT_LIST_DIR}/lr11xx_crypto_engine.c
-  ${CMAKE_CURRENT_LIST_DIR}/lr11xx_driver_version.c
-  ${CMAKE_CURRENT_LIST_DIR}/lr11xx_gnss.c
-  ${CMAKE_CURRENT_LIST_DIR}/lr11xx_lr_fhss.c
-  ${CMAKE_CURRENT_LIST_DIR}/lr11xx_radio.c
-  ${CMAKE_CURRENT_LIST_DIR}/lr11xx_radio_timings.c
-  ${CMAKE_CURRENT_LIST_DIR}/lr11xx_rttof.c
-  ${CMAKE_CURRENT_LIST_DIR}/lr11xx_regmem.c
-  ${CMAKE_CURRENT_LIST_DIR}/lr11xx_system.c
-  ${CMAKE_CURRENT_LIST_DIR}/lr11xx_wifi.c
-  )
+cmake_minimum_required(VERSION 3.25)
 
-set(LR11XX_DRIVER_MODULE_C_INCLUDES
-  ${CMAKE_CURRENT_LIST_DIR}/.
-  )
+project(
+    lr11xx_driver
+    DESCRIPTION "LR11xx driver library"
+    LANGUAGES C
+)
+
+option(LR11XX_DRIVER_GEOLOCATION "Provide LR11xx geolocation APIs for LR1110 and LR1120" ON)
+
+add_subdirectory(src)
+
+install(EXPORT Lr11xxDriverTargets
+    FILE Lr11xxDriverConfig.cmake
+    NAMESPACE lr11xx_driver::
+    DESTINATION lib/cmake/MyLib
+)
+
+export(TARGETS lr11xx_driver NAMESPACE lr11xx_driver:: FILE Lr11xxDriverTargets.cmake)

src/CMakeLists.txt

@@ -30,14 +30,36 @@
 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 # POSSIBILITY OF SUCH DAMAGE.
 
-include(lr11xx_driver_module.cmake)
+add_library(lr11xx_driver STATIC
+    lr11xx_bootloader.c
+    lr11xx_crypto_engine.c
+    lr11xx_driver_version.c
+    lr11xx_lr_fhss.c
+    lr11xx_radio_timings.c
+    lr11xx_radio.c
+    lr11xx_regmem.c
+    lr11xx_rttof.c
+    lr11xx_system.c
+)
+
+if(LR11XX_DRIVER_GEOLOCATION)
+    target_sources(lr11xx_driver PRIVATE
+        lr11xx_gnss.c
+        lr11xx_wifi.c
+    )
+endif()
 
-target_sources(${LR11XX_DRIVER_MODULE_TARGET}
-  PRIVATE
-  ${LR11XX_DRIVER_MODULE_C_SOURCES}
+add_library(lr11xx_driver::lr11xx_driver ALIAS lr11xx_driver)
+    
+target_include_directories(lr11xx_driver PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
+    $<INSTALL_INTERFACE:>
 )
 
-target_include_directories(${LR11XX_DRIVER_MODULE_TARGET}
-  PUBLIC
-  ${LR11XX_DRIVER_MODULE_C_INCLUDES}
+install(TARGETS lr11xx_driver
+    EXPORT Lr11xxDriverTargets
+    LIBRARY DESTINATION lib
+    ARCHIVE DESTINATION lib
+    RUNTIME DESTINATION bin
+    INCLUDES DESTINATION include
 )

src/lr11xx_bootloader.c

@@ -54,6 +54,7 @@
 #define LR11XX_FLASH_DATA_MAX_LENGTH_UINT8 ( LR11XX_FLASH_DATA_MAX_LENGTH_UINT32 * 4 )
 
 #define LR11XX_BL_CMD_NO_PARAM_LENGTH ( 2 )
+#define LR11XX_BL_GET_HASH_CMD_LENGTH ( LR11XX_BL_CMD_NO_PARAM_LENGTH )
 #define LR11XX_BL_GET_STATUS_CMD_LENGTH ( 2 + 4 )
 #define LR11XX_BL_VERSION_CMD_LENGTH LR11XX_BL_CMD_NO_PARAM_LENGTH
 #define LR11XX_BL_ERASE_FLASH_CMD_LENGTH LR11XX_BL_CMD_NO_PARAM_LENGTH
@@ -77,6 +78,7 @@ enum
     LR11XX_BL_GET_VERSION_OC           = 0x0101,
     LR11XX_BL_ERASE_FLASH_OC           = 0x8000,
     LR11XX_BL_WRITE_FLASH_ENCRYPTED_OC = 0x8003,
+    LR11XX_BL_GET_HASH_OC              = 0x8004,
     LR11XX_BL_REBOOT_OC                = 0x8005,
     LR11XX_BL_GET_PIN_OC               = 0x800B,
     LR11XX_BL_READ_CHIP_EUI_OC         = 0x800C,
@@ -107,6 +109,17 @@ static uint8_t lr11xx_bootloader_get_min_from_operand_and_max_block_size( uint32
  * --- PUBLIC FUNCTIONS DEFINITION ---------------------------------------------
  */
 
+lr11xx_status_t lr11xx_bootloader_get_hash( const void* context, lr11xx_bootloader_hash_t hash )
+{
+    uint8_t cbuffer[LR11XX_BL_GET_HASH_CMD_LENGTH];
+
+    cbuffer[0] = ( uint8_t ) ( LR11XX_BL_GET_HASH_OC >> 8 );
+    cbuffer[1] = ( uint8_t ) ( LR11XX_BL_GET_HASH_OC >> 0 );
+
+    return ( lr11xx_status_t ) lr11xx_hal_read( context, cbuffer, LR11XX_BL_GET_HASH_CMD_LENGTH, hash,
+                                                LR11XX_BL_HASH_LENGTH );
+}
+
 lr11xx_status_t lr11xx_bootloader_get_status( const void* context, lr11xx_bootloader_stat1_t* stat1,
                                               lr11xx_bootloader_stat2_t*    stat2,
                                               lr11xx_bootloader_irq_mask_t* irq_status )

src/lr11xx_bootloader.h

@@ -69,6 +69,17 @@ typedef uint32_t lr11xx_bootloader_irq_mask_t;
  * --- PUBLIC FUNCTIONS PROTOTYPES ---------------------------------------------
  */
 
+/*!
+ * @brief Get calculated hash of flash content.
+ *
+ * This method should be used to get the hash of flash content.
+ *
+ * @param [in] context Chip implementation context
+ *
+ * @param [out] hash Pointer to the hash array to be populated with hash value
+ */
+lr11xx_status_t lr11xx_bootloader_get_hash( const void* context, lr11xx_bootloader_hash_t hash );
+
 /*!
  * @brief Return the status registers and interrupt flags
  *

src/lr11xx_bootloader_types.h

@@ -57,6 +57,11 @@ extern "C" {
  * --- PUBLIC CONSTANTS --------------------------------------------------------
  */
 
+/*!
+ * @brief Length in bytes of a hash value
+ */
+#define LR11XX_BL_HASH_LENGTH 0x10
+
 /*!
  * @brief Length in byte of the LR11XX version blob
  */
@@ -82,6 +87,11 @@ extern "C" {
  * --- PUBLIC TYPES ------------------------------------------------------------
  */
 
+/*!
+ * @brief Fixed-length array to store hash value
+ */
+typedef uint8_t lr11xx_bootloader_hash_t[LR11XX_BL_HASH_LENGTH];
+
 /*!
  * @brief Fixed-length array to store a PIN
  */

src/lr11xx_crypto_engine.c

@@ -52,11 +52,12 @@
 
 #define LR11XX_CRYPTO_FW_IMAGE_DATA_MAX_LENGTH_UINT32 ( 64 )
 #define LR11XX_CRYPTO_FW_IMAGE_DATA_MAX_LENGTH_UINT8 ( LR11XX_CRYPTO_FW_IMAGE_DATA_MAX_LENGTH_UINT32 * 4 )
+#define LR11XX_CRYPTO_MAX_JOIN_ACCEPT_DATA_SIZE ( 32 )
 
 #define LR11XX_CRYPTO_SELECT_CMD_LENGTH ( 2 + 1 )
 #define LR11XX_CRYPTO_SET_KEY_CMD_LENGTH ( 2 + 17 )
 #define LR11XX_CRYPTO_DERIVE_KEY_CMD_LENGTH ( 2 + 18 )
-#define LR11XX_CRYPTO_PROCESS_JOIN_ACCEPT_CMD_LENGTH ( 2 + 3 + 12 + 32 )
+#define LR11XX_CRYPTO_PROCESS_JOIN_ACCEPT_CMD_LENGTH ( 2 + 3 + 12 + LR11XX_CRYPTO_MAX_JOIN_ACCEPT_DATA_SIZE )
 #define LR11XX_CRYPTO_COMPUTE_AES_CMAC_CMD_LENGTH ( 2 + 1 + 272 )
 #define LR11XX_CRYPTO_VERIFY_AES_CMAC_CMD_LENGTH ( 2 + 1 + 4 + 256 )
 #define LR11XX_CRYPTO_AES_ENCRYPT_CMD_LENGTH ( 2 + 1 + 256 )
@@ -209,7 +210,24 @@ lr11xx_status_t lr11xx_crypto_process_join_accept( const void* context, lr11xx_c
 {
     uint8_t cbuffer[LR11XX_CRYPTO_PROCESS_JOIN_ACCEPT_CMD_LENGTH] = { 0x00 };
     uint8_t rbuffer[LR11XX_CRYPTO_STATUS_LENGTH + 32]             = { 0x00 };
-    uint8_t header_length                                         = ( lorawan_version == 0 ) ? 1 : 12;
+    uint8_t header_length;
+
+    switch( lorawan_version )
+    {
+    case LR11XX_CRYPTO_LORAWAN_VERSION_1_0_X:
+        header_length = 1;
+        break;
+    case LR11XX_CRYPTO_LORAWAN_VERSION_1_1_X:
+        header_length = 12;
+        break;
+    default:
+        return LR11XX_STATUS_ERROR;
+    }
+
+    if( length > LR11XX_CRYPTO_MAX_JOIN_ACCEPT_DATA_SIZE )
+    {
+        return LR11XX_STATUS_ERROR;
+    }
 
     cbuffer[0] = ( uint8_t ) ( LR11XX_CRYPTO_PROCESS_JOIN_ACCEPT_OC >> 8 );
     cbuffer[1] = ( uint8_t ) ( LR11XX_CRYPTO_PROCESS_JOIN_ACCEPT_OC >> 0 );
@@ -550,9 +568,16 @@ lr11xx_status_t lr11xx_crypto_get_check_encrypted_firmware_image_result( const v
         ( uint8_t ) ( LR11XX_CRYPTO_GET_CHECK_ENCRYPTED_FW_IMAGE_RESULT_OC >> 0 ),
     };
 
-    return ( lr11xx_status_t ) lr11xx_hal_read( context, cbuffer,
-                                                LR11XX_CRYPTO_GET_CHECK_ENCRYPTED_FW_IMAGE_RESULT_CMD_LENGTH,
-                                                ( uint8_t* ) is_encrypted_fw_image_ok, 1 );
+    uint8_t               is_encrypted_fw_image_ok_raw = 0;
+    const lr11xx_status_t status                       = ( lr11xx_status_t ) lr11xx_hal_read(
+                              context, cbuffer, LR11XX_CRYPTO_GET_CHECK_ENCRYPTED_FW_IMAGE_RESULT_CMD_LENGTH, &is_encrypted_fw_image_ok_raw,
+                              1 );
+
+    if( status == LR11XX_STATUS_OK )
+    {
+        *is_encrypted_fw_image_ok = ( bool ) is_encrypted_fw_image_ok_raw;
+    }
+    return status;
 }
 
 /*

src/lr11xx_crypto_engine.h

@@ -123,7 +123,7 @@ lr11xx_status_t lr11xx_crypto_derive_key( const void* context, lr11xx_crypto_sta
  * @param [in] lorawan_version LoRaWAN version to know the size of the header
  * @param [in] header The header to compute (length linked to lorawan_version)
  * @param [in] data The data to compute
- * @param [in] length The length in bytes of the data to compute
+ * @param [in] length The length in bytes of the data to compute, must be less than 32 bytes
  * @param [out] data_out Placeholder for the decrypted data
  *
  * @returns Operation status

src/lr11xx_driver_version.h

@@ -54,7 +54,7 @@ extern "C" {
  * --- PUBLIC CONSTANTS --------------------------------------------------------
  */
 
-#define LR11XX_DRIVER_VERSION "v2.5.2"
+#define LR11XX_DRIVER_VERSION "v2.7.0"
 
 /*
  * -----------------------------------------------------------------------------

src/lr11xx_gnss.c

@@ -474,8 +474,14 @@ lr11xx_status_t lr11xx_gnss_read_freq_search_space( const void*
         ( uint8_t )( LR11XX_GNSS_READ_FREQ_SEARCH_SPACE_OC >> 0 ),
     };
 
-    return ( lr11xx_status_t ) lr11xx_hal_read( radio, cbuffer, LR11XX_GNSS_READ_FREQ_SEARCH_SPACE_CMD_LENGTH,
-                                                ( uint8_t* ) freq_search_space, sizeof( uint8_t ) );
+    uint8_t               freq_search_space_raw = 0;
+    const lr11xx_status_t status                = ( lr11xx_status_t ) lr11xx_hal_read(
+                       radio, cbuffer, LR11XX_GNSS_READ_FREQ_SEARCH_SPACE_CMD_LENGTH, &freq_search_space_raw, 1 );
+    if( status == LR11XX_STATUS_OK )
+    {
+        *freq_search_space = ( lr11xx_gnss_freq_search_space_t ) freq_search_space_raw;
+    }
+    return status;
 }
 
 lr11xx_status_t lr11xx_gnss_read_firmware_version( const void* context, lr11xx_gnss_version_t* version )