Release v2.5.0

Author: smtc-bot

CHANGELOG.md

@@ -4,14 +4,58 @@ 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).
 
+## [2.5.0] - 2025-06-16
+
+### Fixed
+
+- Make `llcc68_tx_modulation_workaround` public
+
+### Changed
+
+- Modify in-code version to only keep `LLCC68_DRIVER_VERSION` macro and `llcc68_driver_version_get_version_string` function
+
+## [2.4.1] - 2025-04-14
+
+### Fixed
+
+- Compilation warning due to implicit cast
+
+## [2.4.0] - 2025-04-14
+
+### Added
+
+- cmake support
+- GFSK workarounds for specific modulation configurations:
+  - `llcc68_workaround_gfsk_1_2_kbps`
+  - `llcc68_workaround_gfsk_0_6_kbps`
+  - `llcc68_workaround_gfsk_reset`
+
+### Changed
+
+- Extract BPSK driver code in specific compile unit
+
+### Fixed
+
+- Fixed bad pointer conversion in `llcc68_hal_read` calls that may result in incorrect value
+- `llcc68_add_registers_to_retention_list` function - Prevent out of bound array access in case of erroneous value read from chip
+- Typos in documentation
+
+### Removed
+
+- LLCC68 only: BPSK commands are removed
+
 ## [2.3.2] - 2023-12-15
 
 ### Changed
+
 - `llcc68_set_gfsk_sync_word()` function - Remove memcpy usage
 
+## [2.3.1] - 2023-11-8
+
 ## [2.3.0] - 2023-10-10
 
 ### Added
+
 - `llcc68_set_bpsk_mod_params()` function - Set the modulation parameters for BPSK packets
 - `llcc68_set_bpsk_pkt_params()` function - Set the packet parameters for BPSK packets
 
@@ -26,7 +70,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Added
 
-- `llcc68_set_gfsk_pkt_address()` function - configure both GFSK node and brodcast filtering addresses
+- `llcc68_set_gfsk_pkt_address()` function - configure both GFSK node and broadcast filtering addresses
 - `llcc68_handle_rx_done()` function - perform all requested actions when the chip leaves the Rx mode
 
 ## [2.0.1] - 2021-11-23

README.md

@@ -20,3 +20,27 @@ The HAL (Hardware Abstraction Layer) is a collection of functions the user shall
 - llcc68_hal_wakeup
 - llcc68_hal_write
 - llcc68_hal_read
+
+## Cmake usage
+
+This driver exposes a cmake configuration allowing to integrate the driver in a cmake ready application.
+
+### Integration
+
+If the driver code resides in a directory of the application using it, it can be integrated by adding the subdirectory to the configuration as follows:
+
+```cmake
+add_subdirectory(llcc68_driver) # where llcc68_driver is the name of the folder containing the driver code
+```
+
+Alternatively, if the driver code is available through a code archive, it can be included directly by
+
+```cmake
+include(FetchContent)
+FetchContent_Declare(
+    llcc68_driver
+    URL "path_to_archive" # Where path_to_archive is to be replaced by the path to the archive driver
+)
+FetchContent_MakeAvailable(llcc68_driver)
+```
+

src/CMakeLists.txt

@@ -0,0 +1,56 @@
+# @file
+#
+# @brief Sets CMake target_sources and target_include_directories
+#
+# --- The Clear BSD License ---
+# Copyright Semtech Corporation 2025. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted (subject to the limitations in the disclaimer
+# below) provided that the following conditions are met:
+#     * Redistributions of source code must retain the above copyright
+#       notice, this list of conditions and the following disclaimer.
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#     * Neither the name of the Semtech corporation nor the
+#       names of its contributors may be used to endorse or promote products
+#       derived from this software without specific prior written permission.
+#
+# NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY
+# THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+# CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
+# NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+# PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SEMTECH CORPORATION BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+
+
+set(LIBRARY_SOURCES)
+list(APPEND LIBRARY_SOURCES
+    llcc68_driver_version.c
+    llcc68.c
+)
+
+add_library(llcc68_driver STATIC ${LIBRARY_SOURCES})
+
+add_library(llcc68_driver::llcc68_driver ALIAS llcc68_driver)
+
+target_include_directories(llcc68_driver PUBLIC
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>
+    $<INSTALL_INTERFACE:>
+)
+
+install(TARGETS llcc68_driver
+    EXPORT Llcc68DriverTargets
+    LIBRARY DESTINATION lib
+    ARCHIVE DESTINATION lib
+    RUNTIME DESTINATION bin
+    INCLUDES DESTINATION include
+)