Manuals+

Silicon Labs Bluetooth SDK 2.13.7.0 GA

Gecko SDK Suite 2.7

August 26, 2020

Silicon Labs is a leading vendor in Bluetooth hardware and software technologies, used in products such as sports and fitness, consumer electronics, beacons, and smart home applications. The core SDK is an advanced Bluetooth 5-compliant stack that provides all of the core functionality along with multiple APIs to simplify development. The core functionality offers both standalone mode allowing a developer to create and run their application directly on the SoC, or in NCP mode allowing for the use of an external host MCU.

Extensions to the SDK include Bluetooth Mesh and Apple® HomeKit® for customers seeking the additional capabilities.

Key Features

SDK Version(s) Covered

Compatibility and Use Notices

If you are new to the Silicon Labs Bluetooth SDK, see Using This Release.

Compatible Compilers:

Using wine to build with the IARBuild.exe command line utility or IAR Embedded Workbench GUI on macOS or Linux could result in incorrect files being used due to collisions in wine's hashing algorithm for generating short file names.

Customers on macOS or Linux are advised not to build with IAR outside of Simplicity Studio. Customers who do should carefully verify that the correct files are being used.

1 New Items

1.1 New Features

Added in release 2.13.6.0

Proprietary CTE solution: Silicon Labs' proprietary CTE solution for Angle of Arrival (AoA).

Added in release 2.13.4.0

Advertising channel index randomization: Randomly select advertising channel usage order.

Added in release 2.13.3.0

New Part Support: This release supports the new EFR32[B|M]G22 device family and Thunderboard EFR32BG22. Additionally, support for BRD4180B and BRD4181B radio boards is added.

Added in release 2.13.2.0

Advertiser Random Address: Applications can set an advertiser's random device address used in advertising packets.

Added in release 2.13.0.0

NVM3 support on EFR32[B|M]G1x devices: NVM3 is now supported on EFR32[B|M]G1x devices in addition to PS Store. These two data stores cannot be used simultaneously. The sample applications in the Bluetooth SDK continue to use PS Store by default. To replace PS Store with NVM3 please refer to AN1135: Using Third Generation Non-Volatile Memory (NVM3) Data Storage. Usage of NVM3 on EFR32[B|M]G1x devices is recommended only for new designs as there is no migration mechanism from PS to NVM3, when a new firmware is flashed via OTA or UART DFU. Doing DFU from PS to NVM3 will cause all PS data to be lost, which includes e.g., bonding information.

Sleep Timer: The sleep timer (sl_sleeptimer.h) is a platform component providing single-shot and periodic timer services. It also provides APIs for reading current tick count and conversions between ticks and milliseconds. A Bluetooth application must include sleep timer component because the Bluetooth stack initializes and uses it for deep sleep. For more details, please refer to a Bluetooth SDK example such as the soc-empty.

1.2 New APIs

For additional documentation and command descriptions please refer to the Bluetooth Software API Reference Manual.

Added in release 2.13.6.0

Added in release 2.13.4.0

Added in release 2.13.2.0

Added in release 2.13.1.0

Added in release 2.13.0.0

2 Improvements

2.1 Changed APIs

Changed in release 2.13.6.0

Renamed CTE APIs
Old Name New Name
cmd_cte_transmitter_enable_cte_response cmd_cte_transmitter_enable_connection_cte
cmd_cte_transmitter_disable_cte_response cmd_cte_transmitter_disable_connection_cte
cmd_cte_receiver_start_iq_sampling cmd_cte_receiver_enable_connection_cte
cmd_cte_receiver_stop_iq_sampling cmd_cte_receiver_disable_connection_cte
cmd_cte_receiver_start_connectionless_iq_sampling cmd_cte_receiver_enable_connectionless_cte
cmd_cte_receiver_stop_connectionless_iq_sampling cmd_cte_receiver_disable_connectionless_cte
evt_cte_receiver_iq_report evt_cte_receiver_connection_iq_report

Changed in release 2.13.2.0

Bluetooth Stack Initialization: A hardware error is returned if HFRCODPLL is not configured to 80 MHz and set as the system clock source on EFR32[B|M]G21x.

Changed in release 2.13.0.0

cmd_system_linklayer_configure: New configuration key system_linklayer_config_key_set_priority_table is added for changing task priorities at run time.

cmd_sm_store_bonding_configuration: The default maximum allowed bonding count is changed to 13.

3 Fixed Issues

Fixed in release 2.13.7.0

ID # Description
494793 Fix transmit power when operating with EFR32[B|M]G21 Medium Power PA.
495892 Fix an issue which causes stack to hang if there is an empty service in the GATT database.
521854 Fix a rare case where device would send advertisements on a wrong PHY.
622747 Bluetooth stack now returns connection-limit-exceeded error code when application starts a connectable advertising while maximum number of connections has already reached. Memory-capacity-exceeded error was returned prior this fix.

Fixed in release 2.13.6.0

ID # Description
480185 Added configuration option for setting RF path antenna selection for OTA mode. This option is only applicable to EFR32[B|M]G21.
481530 Fix populating the whitelist in Bluetooth security manager after device reset.
484822 Fix "SOC - Range Test RAIL-DMP BLE and IEEE802.15.4" application being stuck at start-up screen.
485074 The soc-empty project targeted at EFR32[B|M]G22 parts now correctly initializes DC-DC.

Fixed in release 2.13.4.0

ID # Description
467342 Fix OTA DFU update on BGM210P032.
469935 Fix the issue that the thermometer RTOS example does not enter to deep sleep. The root cause is that the application's idle hook uses OSIdleEnterHook(void), which is not called by the kernel if HW interrupt wakes up the device and no tasks are triggered by the interrupt. The fix is to use OSIdleContextHook(void). In this function, use a loop to set the stack to sleep, e.g.,
void SleepAndSyncProtimer();
void OSIdleContextHook(void) { while (1) { /* Put MCU in the lowest sleep mode available, usually EM2 */ SleepAndSyncProtimer(); } } See thermometer RTOS example from the Bluetooth SDK.
472920 Improve extended advertising packet reception during connections with very short intervals.
475785 Fix an issue in Bluetooth RTOS adaptation that may cause incorrect conversion from sleeptimer frequency to OS frequency.
477676 Improve the performance of Bluetooth connections using very short intervals on EFR32[B|M]G22.

Fixed in release 2.13.3.0

ID # Description
457174 Bluetooth applications are able to use RTCC on EFR32[B|M]G13 and EFR32[B|M]G21 again. To use RTCC, configure sleep timer to use PRORTC (#define SL_SLEEPTIMER_PERIPHERAL SL_SLEEPTIMER_PERIPHERAL_PRORTC).
466477 Improve scanning robustness.
463724 Network Analyzer now correctly decodes a connection request packet opened on the LE Coded PHY.
464918 Fix a performance issue which may cause advertising to fail if the application is compiled without optimization (-00).
467371 Fix an issue that may cause the stack to use an invalid Bluetooth device address stored in PS key after the application is migrated from an old version of the SDK. This fix checks if an address is stored in PS, and removes the PS key if the address is invalid.

Fixed in release 2.13.2.0

ID # Description
467479 Prevent from erasing the next flash page after storage slot in OTA if the upgrade firmware is too big to fit storage slot.
468416 Function gecko_sleep_for_ms() now returns the sleep time in milliseconds. Previously a tick count value is returned.

Fixed in release 2.13.1.0

ID # Description
431452 TX power is now set to correct values corelating to the requests. Previously, when the requested TX Power was above 0 dBm, the actual transmit power may have deviated randomly.
444469 Fix an issue that may cause the application to be unable to disconnect a Bluetooth connection when writing large amounts of data to characteristic values using the write-without-response command.
446074 Fixed an issue that causes the stack to be unable to establish new connections after multiple connection drops.
453828 Fix an issue that causes the application to be unable to confirm a characteristic indication in a low memory situation when writing large amounts of data to characteristic values using the write-without-response command.
454960 Fix the tick rate RTOS_TICK_HZ in rtos_bluetooth.c to the correct value (1000).
458216 Fix an issue in gecko_sleep_for_ms() which limits the sleep time to no more than 131 seconds.
461654 BGAPI soft timers now work correctly regardless of the value SL_SLEEPTIMER_FREQ_DIVIDER is configured to in sleep timer.

Fixed in release 2.13.0.0

ID # Description
448020 In system_set_tx_power command, the stack now sets and returns the nearest possible value if the requested value is out of range.
450903 Fix the issue when application compiles mbedTLS into source that uses AES with padding, mdebTLS context objects in Bluetooth stack may be corrupted and cause hard faults.
450922 Use of GPCRC in Bluetooth stack is now thread safe.
452831 Fix an issue in Apploader that causes application OTA update to fail if the data length in the first data packet is not multiple of four.
455666 Fix a compatibility issue in Apploader with bootloader v1.10 on EFR32[B|M]G21. This issue causes OTA update to fail and the device to stay in OTA mode indefinitely.
234520 In cmd_gatt_read_characteristic_value_by_uuid command, if multiple characteristic values are received, an evt_gatt_characteristic_value event is generated for each value. Previously only one event is generated for this case.
281984 First advertisement packet is now sent with the right timing in dynamic multi-protocol use cases.
335894 Documentation fix to the lolen field in a BGAPI command header binary. The field specifies the minimal number of bytes the parameters take. It does not include the array data length if the command has an array type parameter.
347844 Event evt_user_message_to_host can now be sent during user command handling in NCP target application.
358171 Fix a random advertising hang issue which was observed when the application optimization build option was disabled or the device was exposed to low temperature.
408097 Extended advertising now works in dynamic multi-protocol use cases.
415583 The stack now returns out of memory error if the application sends a characteristic notification to all connections in low memory situation. Previously wrong state error was returned.
420866 Improves robustness when streaming large data packets to and from a device which does not support data length extension.
421731 When sending a characteristic value notification to all connections using cmd_gatt_server_send_characteristic_notification command, the stack now returns success if devices are connected but none has enabled the notification. Previously wrong state error was returned.
425187 SL_BT_ prefix is added into the include guard in bg_version.h.
425532 Fix whitelisting when an extended advertising packet does not contain an auxiliary pointer.
430225 Fix CTUNE control using PS key on EFR32[B|M]G2x devices.
430752 Fix an issue that the stack may lose a periodic advertising synchronization because the scanner uses highest priority for secondary tasks. This was solved by lowering the priority.
434406 Remove the use of variable length array in the stack.
436243 Fix a HW initialization issue in the soc-dtm example that causes incorrect timeout for incoming data.
441445 Fix an advertisement data update race condition which causes no advertisement is sent out.
445627 Repeated bonding attempts handling is now connection specific. After first failed attempt there is cool down period of 1 s. After second attempt this is doubled to 2 s then to 4 s etc. The maximum wait time is 64 s.
450515 Fix an issue that causes BGTool does not run on Linux.

4 Known Issues in the Current Release

Issues in bold were added since the previous release.

ID # Description Workaround
243009 With certain events, GCC breakpoints cannot be set. Change optimization level to none in project settings
337467 MGM12P has poor signal strength when doing OTA with Apploader. None
360313 Default RAIL assertion (RAILCb_AssertFailed) enters an infinite loop causing the stack not responsive. Override RAIL assertion function in application space following these instructions.
361592 The sync_data event does not report TX power. None
368798 Example soc-thunderboard_sense_2 does not print float values correctly in GCC project. In project C/C++ settings, enable the printf float option.
396308 In NCP, BGAPI may be out of sync between the host and target when the target is reset in the middle of sending a BGAPI message to host. The out of sync issue could cause the host unable to communicate with the target. In NCP target, add a delay to flush NCP Tx queue after a system reset command is received.
456701 Before gecko_init() is called, enabling busfaults generation on access to peripherals with clocks disabled causes a crash. Enable busfaults generation after gecko_init().
470424 Connection drop may happen in rare cases if multiple simultaneous connections use the same connection interval. Try to use different connection intervals in different connections to improve the robustness.

5 Deprecated Items

Deprecated in release 2.13.6.0

Important Notice

Starting with the next major GSDK release, the Bluetooth SDK version will be incremented to version 3.x, which is not backwards compatible with version 2.x. This means that an application written with the v2.x SDK will not work without modifications with the new v3.x SDK.

NOTE: Customers who cannot immediately move to Bluetooth SDK v3.0 are reminded that 'maintenance' support for Bluetooth SDK v2.x will be provided in accordance to the "Software Longevity Commitment" statement found at https://www.silabs.com/products/software/longevity-commitment.

As part of Bluetooth SDK v3.x, the Bluetooth stack API will be modified. The changes will streamline functionality across a smaller set of APIs, which will further enhance usability, improve development experience, and simplify application development. These modifications also align with API conventions across other Silicon Labs software components, including not only wireless stacks but also lower level platform components such as RAIL, emlib, and emdrv.

While many of the new API commands/events have familiar naming to ensure a smooth migration, the structure and overall interface will have slight changes:

SDK 2.x Function

struct gecko_msg_gatt_server_read_attribute_value_rsp_t *gecko_cmd_gatt_server_read_attribute_value (uint16 attribute, uint16 offset);
/* Response structure */
struct gecko_msg_gatt_server_read_attribute_value_rsp_t {
  uint16 result,
  uint8array value
}

SDK 3.x Function

sl_status ssl_bt_gatt_server_read_attribute_value (uint16 attribute, uint16 offset, size_t max_value_size, size_t *value_len, void *value);

The new API uses unified SL_STATUS error codes that consists of common codes for platform and technology stacks as well as codes assigned in dedicated code spaces for a specific technology. Existing error codes are mapped to corresponding sl_status values, so no change is required if the existing application is using the error code enums currently defined in bg_errorcodes.h.

A full and comprehensive migration guide is available that explains all the details related to migration of applications into Silicon Labs Bluetooth SDK v3.0. See https://www.silabs.com/documents/public/application-notes/an1255-transitioning-from-bluetooth-sdk-v2-to-v3.pdf.

Deprecated in release 2.13.4.0

Thunderboard Sense (SLTB001) and Thunderboard React (RD-0057-0201): Support for Thunderboard Sense (SLTB001) and Thunderboard React (RD-0057-0201) is now deprecated and will be removed in the next major SDK release.

6 Removed Items

None

7 Using This Release

This release contains the following:

This SDK depends on Gecko Platform. The Gecko Platform code provides functionality that supports protocol plugins and APIs in the form of drivers and other lower layer features that interact directly with Silicon Labs chips and modules. Gecko Platform components include EMLIB, EMDRV, RAIL Library, NVM3, and mbedTLS. Gecko Platform release notes are available through Simplicity Studio's Launcher Perspective, under this SDK's Release Notes doc header.

For more information about the Bluetooth SDK see QSG139: Getting Started with Bluetooth® Software Development. If you are new to Bluetooth see UG103.14: Bluetooth LE Fundamentals.

7.1 Installation and Use

A registered account at Silicon Labs is required in order to download the Silicon Labs Bluetooth SDK. You can register at https://silabs.force.com/apex/SL_CommunitiesSelfReg?form=short.

Stack installation instruction are covered in QSG139: Getting Started with Bluetooth® Software Development.

Use the Bluetooth SDK with the Silicon Labs Simplicity Studio V4 development platform. Simplicity Studio ensures that most software and tool compatibilities are managed correctly. Install software and board firmware updates promptly when you are notified.

Documentation specific to the SDK version is installed with the SDK. Additional information can often be found in the knowledge base articles (KBAs). API references and other information about this and earlier releases is available on https://docs.silabs.com/.

7.2 Support

Development Kit customers are eligible for training and technical support. You can use the Silicon Labs Bluetooth LE web page to obtain information about all Silicon Labs Bluetooth products and services, and to sign up for product support.

You can contact Silicon Laboratories support at http://www.silabs.com/support.

8 Legal

8.1 Disclaimer

Silicon Labs intends to provide customers with the latest, accurate, and in-depth documentation of all peripherals and modules available for system and software implementers using or intending to use the Silicon Labs products. Characterization data, available modules and peripherals, memory sizes and memory addresses refer to each specific device, and "Typical" parameters provided can and do vary in different applications.

Application examples described herein are for illustrative purposes only.

Silicon Labs reserves the right to make changes without further notice and limitation to product information, specifications, and descriptions herein, and does not give warranties as to the accuracy or completeness of the included information. Silicon Labs shall have no liability for the consequences of use of the information supplied herein. This document does not imply or express copyright licenses granted hereunder to design or fabricate any integrated circuits. The products are not designed or authorized to be used within any Life Support System. A "Life Support System" is any product or system intended to support or sustain life and/or health, which, if it fails, can be reasonably expected to result in significant personal injury or death. Silicon Labs products are not designed or authorized for military applications. Silicon Labs products shall under no circumstances be used in weapons of mass destruction including (but not limited to) nuclear, biological or chemical weapons, or missiles capable of delivering such weapons.

8.2 Trademark Information

Silicon Laboratories Inc.®, Silicon Laboratories®, Silicon Labs®, SiLabs® and the Silicon Labs logo®, Bluegiga®, Bluegiga Logo®, Clockbuilder®, CMEMS®, DSPLL®, EFM®, EFM32®, EFR, Ember®, Energy Micro, Energy Micro logo and combinations thereof, "the world's most energy friendly microcontrollers", Ember®, EZLink®, EZRadio®, EZRadioPRO®, Gecko®, ISOmodem®, Micrium, Precision32®, ProSLIC®, Simplicity Studio®, SiPHY®, Telegesis, the Telegesis Logo®, USBXpress®, Zentri, Z-Wave and others are trademarks or registered trademarks of Silicon Labs.

ARM, CORTEX, Cortex-M0+, Cortex-M3, Cortex-M33, Cortex-M4, TrustZone, Keil and Thumb are trademarks or registered trademarks of ARM Holdings.

Zigbee® and the Zigbee logo® are registered trademarks of the Zigbee Alliance.

Bluetooth® and the Bluetooth logo® are registered trademarks of Bluetooth SIG Inc.

Apple and HomeKit are registered trademarks of Apple Inc.

All other products or brand names mentioned herein are trademarks of their respective holders.

PDF preview unavailable. Download the PDF instead.

bt-software-release-notes-2.13.7.0 Adobe PDF Library 20.12.75 Silicon Labs

Related Documents

Preview Silicon Labs Bluetooth® LE SDK 7.3.0.0 GA and Gecko SDK Suite 4.4 Release Notes
Release notes for Silicon Labs' Bluetooth® LE SDK 7.3.0.0 GA and Gecko SDK Suite 4.4, detailing new features, improvements, fixed issues, known issues, deprecated, and removed items for developers.
Preview Silicon Labs Bluetooth Mesh SDK 7.0.3.0 GA Release Notes
Release notes for Silicon Labs Bluetooth Mesh SDK version 7.0.3.0 GA, detailing new features, improvements, fixed issues, known issues, deprecated items, and removed items for the Simplicity SDK Suite 2024.6.3.
Preview Silicon Labs Bluetooth Mesh SDK 5.0.3.0 GA Release Notes
Official release notes for Silicon Labs Bluetooth Mesh SDK version 5.0.3.0 GA, detailing new features, improvements, fixed issues, and known issues for the Gecko SDK Suite 4.3.
Preview Silicon Labs 32-bit MCU SDK 6.4.7.0 GA Release Notes
Official release notes for Silicon Labs' 32-bit MCU SDK version 6.4.7.0 GA, part of Gecko SDK Suite 4.2. Details SDK versions, new features, compatibility, and support for EFM32 and EZR32 development kits.
Preview Silicon Labs Bluetooth LE SDK 9.1.1.0 GA and Simplicity SDK Suite 2024.12.3 Release Notes
This document provides release notes for Silicon Labs Bluetooth LE SDK version 9.1.1.0 GA and Simplicity SDK Suite 2024.12.3, detailing new features, improvements, fixed issues, known issues, deprecated items, and removed items.
Preview Zigbee EmberZNet SDK 7.0.2.0 GA Release Notes
Detailed release notes for the Zigbee EmberZNet SDK 7.0.2.0 GA, including new features, improvements, fixed issues, and known issues. Covers Gecko SDK Suite 4.0.
Preview Proprietary Flex SDK 3.8.1.0 GA & Simplicity SDK Suite 2024.6.1 Release Notes | Silicon Labs
Official release notes for Silicon Labs Proprietary Flex SDK version 3.8.1.0 GA and Simplicity SDK Suite 2024.6.1, detailing new features, improvements, fixed issues, and known issues for wireless development.
Preview Connect SDK 4.0.0.0 GA Release Notes - Silicon Labs
Comprehensive release notes for Silicon Labs Connect SDK version 4.0.0.0 GA, detailing new features, improvements, fixed issues, known issues, and compatibility information for proprietary wireless applications using IEEE 802.15.4.