SILICON LABS Proprietary Flex SDK Software User Guide

User Guide for SILICON LABS models including: Proprietary Flex SDK Software, Flex SDK Software, SDK Software, Software

Proprietary Flex Release Notes

Silicon Labs Silicon Labs

Version 3.8.2.0

Flex SDK - Connect Networking Stack - Silicon Labs

Proprietary Flex SDK 3.8.2.0 GA

18. 9. 2024 — Added a new API emberSetUnencryptedPacketsAcceptance()that can be called to enable the filtering of unencrypted ... x Quick Start Guide. 5.1 Installation and Use.

File Info : application/pdf, 12 Pages, 536.56KB

JavaScript is disabled. Open the PDF or Download.

flex-release-notes-3.8.2.0

Proprietary Flex SDK 3.8.2.0 GA
Simplicity SDK Suite 2024.6.2 September 18, 2024

The Proprietary Flex SDK is a complete software development suite for proprietary wireless applications. Per its namesake, Flex offers two implementation options.
The first uses Silicon Labs RAIL (Radio Abstraction Interface Layer), an intuitive and easily-customizable radio interface layer designed to support both proprietary and standardsbased wireless protocols.
The second uses Silicon Labs Connect, an IEEE 802.15.4-based networking stack designed for customizable broad-based proprietary wireless networking solutions that require low power consumption and operates in either the sub-GHz or 2.4 GHz frequency bands. The solution is targeted towards simple network topologies.
The Flex SDK is supplied with extensive documentation and sample applications. All examples are provided in source code within the Flex SDK sample applications.
These release notes cover SDK version(s):
3.8.2.0 GA released September 18, 2024. 3.8.1.0 GA released July 24, 2024. 3.8.0.0 GA released June 5, 2024.

RAIL APPS AND LIBRARY KEY FEATURES
· Flex-RAIL SDK support for EFR32xG22E Devices
· LCD Display usage in WM-BUS Meter Sample Application on DK2600
· Collision Detection support in RAIL Library in concurrent mode on FG25
· Added support for additional Coex TX and RX metrics events to RAIL coexistence utility
· Updated some RAIL APIs to better prepare for future API changes while retaining backwards compile-time compatibility
CONNECT APPS AND STACK KEY FEATURES
· Flex-Connect SDK support for EFR32xG22E Devices
· Removed support for Series 0/1

Compatibility and Use Notices
For information about security updates and notices, see the Security chapter of the Platform Release Notes installed with this SDK or on the TECH DOCS tab on https://www.silabs.com/developers/flex-sdk-connect-networking-stack. Silicon Labs also strongly recommends that you subscribe to Security Advisories for up-to-date information. For instructions, or if you are new to the Silicon Labs Flex SDK, see Using This Release.
Compatible Compilers:
IAR Embedded Workbench for ARM (IAR-EWARM) version 9.40.1 · 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.
GCC (The GNU Compiler Collection) version 12.2.1, provided with Simplicity Studio.

silabs.com | Building a more connected world.

Flex 3.8.2.0

Contents
Contents
1 Connect Applications.......................................................................................................................................................................... 3 1.1 New Items................................................................................................................................................................................... 3 1.2 Improvements............................................................................................................................................................................. 3 1.3 Fixed Issues ............................................................................................................................................................................... 3 1.4 Known Issues in the Current Release ........................................................................................................................................ 3 1.5 Deprecated Items ....................................................................................................................................................................... 3 1.6 Removed Items .......................................................................................................................................................................... 3
2 Connect Stack .................................................................................................................................................................................... 4 2.1 New Items................................................................................................................................................................................... 4 2.2 Improvements............................................................................................................................................................................. 4 2.3 Fixed Issues ............................................................................................................................................................................... 4 2.4 Known Issues in the Current Release ........................................................................................................................................ 4 2.5 Deprecated Items ....................................................................................................................................................................... 5 2.6 Removed Items .......................................................................................................................................................................... 5
3 RAIL Applications ............................................................................................................................................................................... 6 3.1 New Items................................................................................................................................................................................... 6 3.2 Improvements............................................................................................................................................................................. 6 3.3 Fixed Issues ............................................................................................................................................................................... 6 3.4 Known Issues in the Current Release ........................................................................................................................................ 6 3.5 Deprecated Items ....................................................................................................................................................................... 7 3.6 Removed Items .......................................................................................................................................................................... 7
4 RAIL Library ....................................................................................................................................................................................... 8 4.1 New Items................................................................................................................................................................................... 8 4.2 Improvements............................................................................................................................................................................. 8 4.3 Fixed Issues ............................................................................................................................................................................... 8 4.4 Known Issues in the Current Release ........................................................................................................................................ 9 4.5 Deprecated Items ....................................................................................................................................................................... 9 4.6 Removed Items .......................................................................................................................................................................... 9
5 Using This Release .......................................................................................................................................................................... 10 5.1 Installation and Use .................................................................................................................................................................. 10 5.2 Security Information.................................................................................................................................................................. 10 5.3 Support ..................................................................................................................................................................................... 11

silabs.com | Building a more connected world.

Proprietary Flex 3.8.2.0 | 2

Connect Applications
1 Connect Applications
Simplicity SDK is an embedded software development platform for building IoT products based on our Series 2 and Series 3 wireless and MCU devices. It integrates wireless protocol stacks, middleware, peripheral drivers, a bootloader, and application examples a solid framework for building power-optimized and secure IoT devices.
The Simplicity SDK offers powerful features such as ultra-low power consumption, strong network reliability, support for a large number of nodes, and abstraction of complex requirements like multiprotocol and pre-certification. Additionally, Silicon Labs provides over-the-air (OTA) software and security updates to remotely update devices, minimize maintenance costs, and enhance the end-user product experience.
Simplicity SDK is a follow-on from our popular Gecko SDK, which will continue to be available providing long-term support for our Series 0 and Series 1 devices. For additional information on the Series 0 and Series 1 devices please reference: Series 0 and Series 1 EFM32/EZR32/EFR32 device (silabs.com).

1.1 New Items
Added in release 3.8.0.0 · Support for EFR32xG22E Devices

1.2 Improvements
Changed in release 3.8.0.0 None.

1.3 Fixed Issues
Fixed in release 3.8.0.0 None.

1.4 Known Issues in the Current Release
Issues in bold were added since the previous release. If you have missed a release, recent release notes are available on the TECH DOCS tab on https://www.silabs.com/developers/flex-sdk-connect-networking-stack.

ID # 652925
1139850

Description
EFR32XG21 is not supported for "Flex (Connect) - SoC Light Example DMP" and "Flex (Connect) - SoC Switch Example"
DMP instabilities with XG27

Workaround

1.5 Deprecated Items
Deprecated in release 3.8.0.0 Flex SDK Flex folder is deprecated and will be removed. It has been split into Rail folder for RAIL SDK and Connect folder for Connect SDK..
1.6 Removed Items
Removed in release 3.8.0.0 None.

silabs.com | Building a more connected world.

Proprietary Flex 3.8.2.0 | 3

2 Connect Stack

Connect Stack

2.1 New Items
Added in release 3.8.0.0 · Added a new API emberSetUnencryptedPacketsAcceptance()that can be called to enable the filtering of unencrypted data packets. If enabled, all unencrypted data will be ignored by the stack and won't be visible from the application layer.

2.2 Improvements
Changed in release 3.8.0.0 None.

2.3 Fixed Issues
Fixed in release 3.8.2.0

ID # 1334048

Description Fixed an NVM issue where the Child table information was not saved through reboots.

Fixed in release 3.8.1.0

ID # 1301334

Description
Fixed a memory leak when waking up from EM2. A buffer is allocated during the mac initialization and wakeup phases. It should only be allocated during initialization.

Fixed in release 3.8.0.0

ID # 1294620

Description
Called Silicon Labs thread-safe malloc wrapper instead of the standard malloc. Current dynamic memory allocation could cause memory corruption.

2.4 Known Issues in the Current Release
Issues in bold were added since the previous release. If you have missed a release, recent release notes are available on the TECH DOCS tab on https://www.silabs.com/developers/gecko-software-development-kit.

ID # 501561

Description
When running the RAIL Multiprotocol Library (used for example when running DMP Connect+BLE), IR Calibration is not performed because of a known issue in the RAIL Multiprotocol Library. As result, there is an RX sensitivity loss in the order of 3 or 4 dBm.
In the Legacy HAL component, the PA configuration is hardcoded regardless of the user or board settings.

Workaround
Until this is changed to properly pull from the configuration header, the file ember-phy.c in the user's project will need to be modified by hand to reflect the desired PA mode, voltage, and ramp time.

silabs.com | Building a more connected world.

Proprietary Flex 3.8.2.0 | 4

ID # 711804

Description
Connecting multiple devices simultaneously may fail with a timeout error.

Workaround

2.5 Deprecated Items
Deprecated in release 3.8.0.0 None
2.6 Removed Items
Removed in release 3.8.0.0 None

Connect Stack

silabs.com | Building a more connected world.

Proprietary Flex 3.8.2.0 | 5

3 RAIL Applications

RAIL Applications

3.1 New Items
Added in release 3.8.0.0 · Support for EFR32xG22E Devices · RAIL - SoC Wireless M-bus Meter: o CLI support o Three different sensors can be used: Wireless M-bus virtual water meter sensor Wireless M-bus thermo meter sensor Wireless M-bus button pulse counter o DK2600 7-segment LCD support

3.2 Improvements
Changed in release 3.8.0.0 · RAIL - SoC Range Test BLE and IEEE802.15.4: Channels number can be set real-time both for the BLE and the 15.4 PHYs according to standard. · RAIL - SoC Mode Switch: Mode switch can be triggered by BTN1. · RAIL - SoC Wireless M-bus Meter improved timing accuracy

3.3 Fixed Issues
Fixed in release 3.8.2.0

ID # 1336210
1334642 1332679 1322792

Description Fixed a condition that made the RAIL - SoC Range Test BLE and IEEE802.15.4 start at a wrong channel when selecting the IEEE standard phy. Fixed a run time assert, when default channel setting wasn't in the correct range. Fixed Flex - RAIL PRS Support component to be able to add to every RAIL SDK sample application Added back the Flex - RAIL Power Manager Sleep component for better sleep timing values.

3.4 Known Issues in the Current Release

ID # 1268208 1268301

Description
The power consumption of DK2600 can't be optimized if configuration time for EM2 if UART is being used, as the value of SL_IOSTREAM_USART_{instance}_BAUDRATE doesn't take effect. The default value used instead is 115200 bps. Typical use case is RAIL - SoC Wireless Mbus Meter with DK2600 board.

Workaround
Update UART baud rate to 9600 bps at Simplicity Studio Admin Console. This is necessary for EM2.

silabs.com | Building a more connected world.

Proprietary Flex 3.8.2.0 | 6

RAIL Applications
3.5 Deprecated Items
Deprecated in release 3.8.0.0 Flex SDK Flex folder is deprecated and will be removed. It has been split into Rail folder for RAIL SDK and Connect folder for Connect SDK..
3.6 Removed Items
Removed in release 3.8.0.0 None.

silabs.com | Building a more connected world.

Proprietary Flex 3.8.2.0 | 7

4 RAIL Library

RAIL Library

4.1 New Items
Added in release 3.8.2.0 None. Added in release 3.8.1.0
· Added support of automatic LNA bypass on the EFR32xG25 parts. Added in release 3.8.0.0
· Added support of collision detection for concurrent PHYs on the EFR32xG25 parts. · Added support for additional Coex TX and RX metrics events to the "RAIL Utility, Coexistence" component.

4.2 Improvements
Changed in release 3.8.2.0 · Reduced the delay between TX completion and the start of PA ramp down on the EFR32xG24.
Changed in release 3.8.1.0
None.
Changed in release 3.8.0.0
· Updated a few APIs to return RAIL_Status_t which were previously returning void. · Updated RAIL_IEEE802154_WriteEnhAck and RAIL_WriteAutoAckFifo() which formerly took uint8_t ackDataLen parameter
now take uint16_t ackDataLen parameter.
· Added missing runtime equivalent API RAIL_SupportsPathDiversity() of RAIL_SUPPORTS_PATH_DIVERSITY.

4.3 Fixed Issues
Fixed in release 3.8.2.0

ID # 1276280
1306597

Description
Fixed a DMP scheduling issue where tasks were scheduled to run with inadequate time to complete before another pending task.
Fixed a CCA issue on EFR32xG28 where, in some cases, the channel could be reported as busy even though it was free.

Fixed in release 3.8.1.0

ID # 1271542

Description
Fixed an issue on EFR32xG21 where an innopportunely-timed RAIL_StopTx() using RAIL_STOP_MODE_ACTIVE can hang a subsequent CSMA/LBT transmit during its clear-channel assessment (CCA).

Fixed in release 3.8.0.0

ID # 1242662

Description
Fixed incorrect default values for SL_RAIL_UTIL_PA_CALIBRATION_ENABLE on the EFR32xG24 and EFR32xG25 parts, along with an issue where Power Amplifier calibrations were not properly disabled when SL_RAIL_UTIL_PA_CALIBRATION_ENABLE was disabled.

silabs.com | Building a more connected world.

Proprietary Flex 3.8.2.0 | 8

ID # 1255524
1256045 1265376
1266003

RAIL Library
Description
Fixed a dynamic multiprotocol issue where RAIL_BLE_Init() was called (which implicitly establishes the BLE 1Mbps PHY), but after a protocol switch returns to BLE, its RAIL_BLE_ConfigChannelRadioParams() settings were not being properly reapplied.
Fixed an issue where Signal Identifier options were being errantly displayed in Simplicity Studio for the "RAIL Utility, Coexistence" component on platforms that don't support the Signal Identifier feature.
Fixed an issue in the UC components where the RAIL power manager support could be initialized after the radio was started in certain example applications. This would lead to radio state and power mode requirements being improperly tracked, as you must initialize power manager support before any radio operations.
Fixed an issue where RAIL_BLE_ConfigChannelRadioParams() was improperly overriding the BLE Quuppa PHY whitening configuration.

4.4 Known Issues in the Current Release

Issues in bold were added since the previous release.

ID #

Description

Using direct mode (or IQ) functionality on EFR32xG23 requires a specifically set radio configuration that is not yet supported by the radio configurator. For these requirements, reach out to technical support who could provide that configuration based on your specification

641705

Infinite receive operations where the frame's fixed length is set to 0 are not working correctly on the EFR32xG23 series chips.

732659

On EFR32xG23:
Wi-SUN FSK mode 1a exhibits a PER floor with frequency offsets around ± 8 to 10 KHz
Wi-SUN FSK mode 1b exhibits a PER floor with frequency offsets around ± 18 to 20 KHz

Workaround

4.5 Deprecated Items · The RAIL 2.x API is planned for deprecation in the 24Q4-GA release (December 2024). At that time, the new RAIL 3.0 API will
be released for all supported chips along with a RAIL 2.x compatibility layer and migration guide.
o The goal of this new API is to get rid of some unused features, add better support for concurrent listening use cas-es,
and to simplify channel and PA configurations. o The migration is intended to be straight forward and simple for the majority of customers. However, in some cases
manual help might be required to ease this transition.
4.6 Removed Items
None.

silabs.com | Building a more connected world.

Proprietary Flex 3.8.2.0 | 9

Using This Release
5 Using This Release
This release contains the following: · Radio Abstraction Interface Layer (RAIL) stack library · Connect Stack Library · RAIL and Connect Sample Applications · RAIL and Connect Components and Application Framework
This SDK depends on the Simplicity Platform. The Simplicity 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. Simplicity Platform components include EMLIB, EMDRV, RAIL Library, NVM3, and mbedTLS. Simplicity Platform release notes are available through Simplicity Studio's Documentation tab.
For more information about the Flex SDK v3.x see UG103.13: RAIL Fundamentals and UG103.12: Silicon Labs Connect Fundamentals. If you are a first time user, see QSG168: Proprietary Flex SDK v3.x Quick Start Guide.

5.1 Installation and Use
The Proprietary Flex SDK is provided as part of the Simplicity SDK, the suite of Silicon Labs SDKs. To quickly get started with the Simplicity SDK, install Simplicity Studio 5, which will set up your development environment and walk you through Simplicity SDK installation. Simplicity Studio 5 includes everything needed for IoT product development with Silicon Labs devices, including a resource and project launcher, software configuration tools, full IDE with GNU toolchain, and analysis tools. Installation instructions are provided in the online Simplicity Studio 5 User's Guide.
Alternatively, Simplicity SDK may be installed manually by downloading or cloning the latest from GitHub. See https://github.com/SiliconLabs/simplicity_sdk for more information.
Simplicity Studio installs the GSDK by default in: · (Windows): C:\Users\<NAME>\SimplicityStudio\SDKs\simplicity_sdk · (MacOS): /Users/<NAME>/SimplicityStudio/SDKs/simplicity_sdk
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/.

5.2 Security Information
Secure Vault Integration
When deployed to Secure Vault High devices, sensitive keys are protected using the Secure Vault Key Management functionality. The following table shows the protected keys and their storage protection characteristics.

Wrapped Key Thread Master Key PSKc Key Encryption Key MLE Key Temporary MLE Key MAC Previous Key MAC Current Key MAC Next Key

Exportable / Non-Exportable Exportable Exportable Exportable Non-Exportable Non-Exportable Non-Exportable Non-Exportable Non-Exportable

Notes Must be exportable to form the TLVs Must be exportable to form the TLVs Must be exportable to form the TLVs

Wrapped keys that are marked as "Non-Exportable" can be used but cannot be viewed or shared at runtime.

Wrapped keys that are marked as "Exportable" can be used or shared at runtime but remain encrypted while stored in flash. For more information on Secure Vault Key Management functionality, see AN1271: Secure Key Storage.

silabs.com | Building a more connected world.

Proprietary Flex 3.8.2.0 | 10

Using This Release
Security Advisories
To subscribe to Security Advisories, log in to the Silicon Labs customer portal, then select Account Home. Click HOME to go to the portal home page and then click the Manage Notifications tile. Make sure that `Software/Security Advisory Notices & Product Change Notices (PCNs)' is checked, and that you are subscribed at minimum for your platform and protocol. Click Save to save any changes.
The following figure is an example:

5.3 Support
Development Kit customers are eligible for training and technical support. Use the Silicon Labs Flex web page to obtain information about all Silicon Labs Thread products and services, and to sign up for product support.
You can contact Silicon Laboratories support at http://www.silabs.com/support.

silabs.com | Building a more connected world.

Proprietary Flex 3.8.2.0 | 11

Simplicity Studio
One-click access to MCU and wireless tools, documentation, software, source code libraries & more. Available for Windows, Mac and Linux!

IoT Portfolio
www.silabs.com/IoT

SW/HW
www.silabs.com/simplicity

Quality
www.silabs.com/quality

Support & Community
www.silabs.com/community

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 to the product information, specifications, and descriptions herein, and does not give warranties as to the accuracy or completeness of the included information. Without prior notification, Silicon Labs may update product firmware during the manufacturing process for security or reliability reasons. Such changes will not alter the specifications or the performance of the product. Silicon Labs shall have no liability for the consequences of use of the information supplied in this document. This document does not imply or expressly grant any license to design or fabricate any integrated circuits. The products are not designed or authorized to be used within any FDA Class III devices, applications for which FDA premarket approval is required or Life Support Systems without the specific written consent of Silicon Labs. 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. Silicon Labs disclaims all express and implied warranties and shall not be responsible or liable for any injuries or damages related to use of a Silicon Labs product in such unauthorized applications.
Trademark Information Silicon Laboratories Inc.®, Silicon Laboratories®, Silicon Labs®, SiLabs® and the Silicon Labs logo®, Bluegiga®, Bluegiga Logo®, EFM®, EFM32®, EFR, Ember®, Energy Micro, Energy Micro logo and combinations thereof, "the world's most energy friendly microcontrollers", Redpine Signals®, WiSeConnect , n-Link, EZLink®, EZRadio®, EZRadioPRO®, Gecko®, Gecko OS, Gecko OS Studio, Precision32®, Simplicity Studio®, Telegesis, the Telegesis Logo®, USBXpress® , Zentri, the Zentri logo and Zentri DMS, Z-Wave®, and others are trademarks or registered trademarks of Silicon Labs. ARM, CORTEX, Cortex-M3 and THUMB are trademarks or registered trademarks of ARM Holdings. Keil is a registered trademark of ARM Limited. Wi-Fi is a registered trademark of the Wi-Fi Alliance. All other products or brand names mentioned herein are trademarks of their respective holders.
Silicon Laboratories Inc. 400 West Cesar Chavez Austin, TX 78701 USA
www.silabs.com

References

Silicon Labs Adobe PDF Library 24.3.86