Proprietary Flex SDK 3.1.2.0 GA
Gecko SDK Suite 3.1
April 7, 2021
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 sup por t both pro priet ary and standards based 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.1.2.0 released April 7, 2021
3.1.1.0 released January 27, 2021
3.1.0.0 released December 9, 2020
CONNECT APPS AND STACK KEY FEATURES
• EFR32xG21 and MGMx CONNECT GA
support
• FreeRTOS Support for CONNECT
• Long Range PHY Support for CONNECT
• New example: ECDH key exchange
• Example ported from Flex 2.7: DMP
Light/Switc
upport for the RAIL-embedded IEEE
• S
802.15.4 PHY
RAIL APPS AND LIBRARY KEY FEATURES
• EFR32xG21 Flex Support
• Wi-SUN Profile and PHYs in Radi
onfigurator
C
• New example: SimpleTRX Standards for
demonstrating 15.4/BLE usage
h
o
Compatibility and Use Notices
This Gecko SDK Suite release has a known security compatibility issue with one Gecko Platform component. For more infor-
mation about this, as well as other updates and notices, see the Security chapter of the Gecko Platform Release notes installed with
this SDK or on the Silicon Labs R elease N otes page
for up-to-date informati on. F or i nstructions, or if you are new to the Silicon Labs Flex SDK, see Using This Release.
Compatible Compilers:
Note: The supported compilers will be upgraded to ARM GCC-10-2020-q4-update and IAR 8.50.9 in the next major release.
IAR Embedded Workbench for ARM (IAR-EWARM) version 8.30.1
• Using wine to build with the IarBuild.exe command line utility or IAR Embedded Workbench GUI on macOS or Linux could result i
ncorrect files being used due to collisions in wine’s hashing algorithm for generating short file names.
i
• 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 7.2.1, provided with Simplicity Studio.
silabs.com | Buildin g a mor e co nnected w or l d. Proprietary Flex 3.1.2.0
. Silicon Labs also strongl y recommends that you subscribe to Security Advi sories
n
Contents
Contents
1 Connect Applications .................................................................................................................................................................. 1
1.1 New Items ........................................................................................................................................................................... 1
1.2 Improvements ..................................................................................................................................................................... 1
1.3 Fixed Issues ........................................................................................................................................................................ 1
1.4 Known Issues in the Current Release .................................................................................................................................. 1
1.5 Deprecated Items ................................................................................................................................................................ 2
1.6 Removed Items ................................................................................................................................................................... 2
2 Connect Stack ............................................................................................................................................................................ 3
2.1 New Items ........................................................................................................................................................................... 3
2.2 Improvements ..................................................................................................................................................................... 3
2.3 Fixed Issues ........................................................................................................................................................................ 3
2.4 Known Issues in the Current Release .................................................................................................................................. 3
2.5 Deprecated Items ................................................................................................................................................................ 3
2.6 Removed Items ................................................................................................................................................................... 3
3 RAIL Applications ....................................................................................................................................................................... 4
3.1 New Items ........................................................................................................................................................................... 4
3.2 Improvements ..................................................................................................................................................................... 4
3.3 Fixed Issues ........................................................................................................................................................................ 4
3.4 Known Issues in the Current Release .................................................................................................................................. 4
3.5 Deprecated Items ................................................................................................................................................................ 4
3.6 Removed Items ................................................................................................................................................................... 4
4 RAIL Library ............................................................................................................................................................................... 5
4.1 New Items ........................................................................................................................................................................... 5
4.2 Improvements ..................................................................................................................................................................... 5
4.3 Fixed Issues ........................................................................................................................................................................ 6
4.4 Known Issues in the Current Release .................................................................................................................................. 7
4.5 Deprecated Items ................................................................................................................................................................ 7
4.6 Removed Items ................................................................................................................................................................... 7
5 Using This Release .................................................................................................................................................................... 8
5.1 Installation and Use ............................................................................................................................................................. 8
5.2 Security Information ............................................................................................................................................................ 8
5.3 Support ............................................................................................................................................................................... 9
6 Legal ........................................................................................................................................................................................ 10
6.1 Disclaimer ......................................................................................................................................................................... 10
6.2 Trademark Information ...................................................................................................................................................... 10
silabs.com | Buildin g a mor e co nnected w or l d. Proprietary Flex 3.1.2.0 | 2
ID #
Description
Workaround
Connect Sensor/Sink does not work correctly if range
Connect NCP-Host applications are not supported.
Connect Applications
1 Connect Applications
1.1 New Items
Added in release 3.1.0.0
• New Applications
• Flex (Connect) - SoC ECDH Key Exchange
• Flex (Connect) - SoC Light Example DMP
• Flex (Connect) - SoC Switch Example
• Support for EFR32xG21 via Std IEEE 802.15.4 PHY – Each Application
• Support for MGMx modules via Std IEEE 802.15.4 PHY – Each Application
• FreeRTOS (besides baremetal and Micrium) support – Ea ch Appl ication
• Long Range PHY support – Each Application
1.2 Improvements
Changed in release 3.1.2.0
• BRD4183C support
Changed in release 3.1.0.0
• Application code structure is made simpler, app_callbacks.c is removed from each Application:
•
emberAfInitCallback() is moved to app_init.c
• the other application related callbacks are moved to app_process.c
• GBL generation support for each Application via script mechanism
• connect_create_gbl_image.bat
• connect_create_gbl_image.sh
• Remove unnecessary Zigbee-derived housekeeping at the following Applications:
• Flex (Connect) - SoC Sensor
• Flex (Connect) - SoC Sink
• Radio Configurator UI improvement: only the Application relevant Profiles are selectable
1.3 Fixed Issues
Fixed in release 3.1.2.0
678272
extender is involved
1.4 Known Issues in the Current Release
Issues in bold we re added since the p revious r el ease. If you have missed a releas e, re cent release notes are avail able on https://www.si-
labs.com/products/software.
ID # Description Workaround
silabs.com | Buildin g a mor e co nnected w or l d. Proprietary Flex 3.1.2.0 | 1
ID #
Description
Workaround
Connect Applications
652925
EFR32XG21 is not supported for “Flex (Connect) - SoC Light
Example DMP” and “Flex (Connect) - SoC Switch Example”
1.5 Deprecated Items
None
1.6 Removed Items
None
silabs.com | Buildin g a mor e co nnected w or l d. Proprietary Flex 3.1.2.0 | 2
ID #
Description
Workaround
Connect Stack
2 Connect Stack
2.1 New Items
Added in re leas e 3.1.0.0
• Added support for EFR32xG21.
• Added support for MGMx modules.
• Added a new Radio Stream plugin that exposes APIs emberStartTxStream() and emberStopTxStream() t o start and stop
radio streams. PN9 and CW modes are supported
• Added a new API emberApplyIrCalibration() that applies a previous calibration value.
• Added a new API emberTempCalibration() that performs a temperature calibration.
• Added a new API emberGetCalType() that indicates which calibration is needed. Should be called whenever emberAfRadi-
oNeedsCalibratingCallback() is fired prior to calling any calibration function
• Added a new API emberGetChildInfo() to ask a coordinator if an address exists in the network
• Added a new API emberSetRadioChannelExtended() that allows to set a channel without a flash write
2.2 Improvements
Changed in release 3.1.0.0
• Connect Stack IPC plugin now relies on CMSIS-RTOS API v2. Micrium Stack IPC plugin was renamed CMSIS Stack IPC. Stack
tasks priorities can now be configured from the Project Configuration UI.
• emberInit() i s no longer calibrating the radio. The i ma ge re jec tion cal ibra tion can now b e achieved by call i ng emberCalibrate-
CurrentChannel() whenever emberAfRadioNeedsCalibratingCallback() is fired. Note: The default callback ma kes a call
to emberCalibrateCurrentChannel().
• Improve API error values. A plugin API now returns EMBER_LIBRARY_NOT_PRESENT if the plugin is not installed.
2.3 Fixed Issues
None
2.4 Known Issues in the Current Release
Issues in bold we re added since the p revious r el ease. If you have missed a releas e, re cent release notes are avail able on https://www.si-
labs.com/products/software.
501561
In the Legacy HAL component, the PA configuration is hardcoded regardless of the user or board settings.
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.
2.5 Deprecated Items
None
2.6 Removed Items
None
silabs.com | Buildin g a mor e co nnected w or l d. Proprietary Flex 3.1.2.0 | 3
ID #
Description
RAIL Applications
3 RAIL Applications
3.1 New Items
Added in release 3.1.0.0
• New Applications:
• Flex (RAIL) - Simple TRX Standards
• Wi-Sun Profile support at Flex (RAIL) - Simple TRX
• Support for EFR32xG21 via Std IEEE 802.15. 4 PHY
• Flex (RAIL) - Simple TRX Standards
3.2 Improvements
Changed in release 3.1.2.0
• BRD4183C support
Changed in release 3.1.0.0
• Radio Configurator UI improvement: only the Application relevant Profiles are selectable
3.3 Fixed Issues
652925 Flex SDK 3.1 Rail Config files are not added to RAIL project for custom boards (EFR32FG14 is target)
3.4 Known Issues in the Current Release
None
3.5 Deprecated Items
None
3.6 Removed Items
None
silabs.com | Buildin g a mor e co nnected w or l d. Proprietary Flex 3.1.2.0 | 4
RAIL Library
4 RAIL Library
4.1 New Items
Added in release 3.1.1.0
• Added support on the EFR32xG22 parts for a new BLE PHY that can receive 1Mbps and LR Coded packets simultaneously. See
RAIL_BLE_ConfigPhySimulscan().
Added in release 3.1.0.0
• Added new API RAIL_GetRadioStateDetail() that provides more detailed radio state information than RAIL_GetRadioS ta te .
• Added RAIL_RxPacketInfo_t::filterMask field of type RAIL_AddrFilterMask_t, which is a bitmask representing which address filter(s)
the packet has passed.
• Added the ability for RAIL_GetRssi() to wait for a valid RSSI in radio states that are transitioning into RX. Additionally, a maximum
wait timeout for a valid RSSI can be configured using the new API RAIL_GetRssiAlt().
• Added a new RAIL_ZWAVE_ConfigRxChannelHopping() API to configure Z-Wave Rx channel hopping using the recommended
hopping parameters.
• Added a new RAIL_ZWAVE_GetRegion() API to determine the currently selected Z-Wave region.
• Added a new RAIL_S uppo rtsTxP owerModeAlt() API to g et th e minim um and maximum pow er lev el s for a specific power m ode if the
power mode is supported by the chip.
• Added a new API RAIL_SetAddressFilterAddressMask() that allows for setting a bit mask pattern for packet data in the address
filters.
• Added support for MGM210PB22JIA, MGM210PB32JIA, BGM210PB22JIA and BGM210PA32JIA modules.
• Added an event RAIL_EVENT_PA_PROTECTION to indicate the power protection circuit has kicked in.
• Created a “RAIL Utility, Callbacks” component for application-level callbacks.
4.2 Improvements
Changed in release 3.1.2.0
• If the selected RAIL_TxPower_t is not supported by the chip, then by default RAIL_TX_POWER_MODE_2P4_HIGHEST is chosen
as the power mode.
• A multiprotocol scheduled receive with a relative start time and an absolute end time now respects that end time regardless of when
the receive actually s tarts. Be fo re, the end time was made rel ative an d pushed out based on the actual start time to keep the rec ei ve
window the sa me w i dth i n duration. This is a backwards-inco m patible change, bu t should align better with what users expected whe n
specifying an absolute end time.
Changed in release 3.1.0.0
• Added support for reporting more detailed transmit errors on the Packet Trace Interface (PTI).
• Updated RAIL_ZWAVE_Recei veBeam() to automatically idle the radio when RAIL_ZWAVE_R eceiveBeam() finishes even when no
beam is detected.
• Added the ability to use the “RAIL Utility, Initialization” component multiple times when creating a multiprotocol application.
• Changed RAIL_PacketTimeStamp_t::totalPacketBytes from uint32_t to uint16_t to reduce RAM usage.
• The “RAIL Utility, Init ialization” component now defaults most options to a disabled state, instead of enabled. Now you have to opt-
in, instead of opt-out, of RAIL init functionality.
• The “RAIL Utility, PA” component now enables PA calibration by default to ensure that PA power remains consistent chip-to-chip.
• Add new RAIL_EVENT_RF_SENSED as an alternative to the current RAIL_StartRfSense() callback parameter.
• Added a new API R AIL _ConfigSl eepAlt() to allow con figuring the PRS channel , RTCC c hannel , and whether sleep is e nabled in one
call.
• Created a new “RAIL Utility, Protocol” component for setting up RAIL to use one of the standards based PHYs by default.
• In multiprotocol RAIL, when the supplied handle is not the active handle, RAIL_GetRadioState now returns RAIL_RF_STATE_RX
rather than RAIL_RF_STATE_IDLE if a background receive is currently scheduled.
• Antenna diversity settings for xGM210 modules are now split in a new config file: sl_rail_util_ant_div_config.h.
silabs.com | Buildin g a mor e co nnected w or l d. Proprietary Flex 3.1.2.0 | 5
The minimum and maximum power levels for BGM220P and BGM220SC modules are updated to be 0 and 15
652969
Restored automatic IR calibration on EFR32x G22 at RAIL_Ini t() time.
antenna selection to get stuck on antenna 2.
RAIL Library
4.3 Fixed Issues
Fixed in relea se 3.1.2.0
ID # Description
666275
666917
667555
669697
671817
672904
672909
684407
687455
Fixed potential delays when using RAIL's channel hopping or duty cycling features in EM1P mode on the
EFR32xG22 and newer parts.
Previously runtime-configuring the Zigbee coexistence PHY select timeout to 255ms would only guarantee 255ms
on the coexistence-optimized PHY. Now the coexistence-optimized PHY will be selected indefinitely after runtimeconfiguring the coexistence PHY select timeout to 255ms.
Fixed an issue with the “Radio Utility, FEM” component where it would generate an error if the Rx pin was not
required and turned off by the user.
Updated the configuration libraries on BGM210PB22JIA and BGM210PB32JIA modules to fix issues using these
parts in the field.
Fixed an issue when switching between certain radio configurations (e.g. Z-Wave) where use of
RAIL_TX_OPTION_REMOVE_CRC can become permanently stuck.
respectively.
Fixed an issue with PA auto mode where it might try to use a RAIL_TxPowerMode_t that is not valid for the current
part.
Fixed an issue where calling RAIL_ConfigAntenna() on EFR32xG22 and newer devices could fault if the GPIO
block clock was not explicitly enabled beforehand.
Fixed the conversion of power level to dBm to fetch correct values for BGM220P and BGM220S modules when
using the RAIL_TX_POWER_MODE_2P4GIG_HP power mode and power levels above the maximum.
Fixed in relea se 3.1.1.0
ID # Description
653955
654726
656175
663815
665161
Fixed in relea se 3.1.0.0
ID # Description
362133
Fixed an issue when using the “RAIL Ut ility, Coexistence” component where PWM was enabled if
SL_RAIL_UTIL_COEX_PWM_DEFAULT_ENABLED was set, even if
SL_RAIL_UTIL_COEX_PWM_REQ_ENABLED was disabled. Now
SL_RAIL_UTIL_COEX_PWM_DEFAULT_ENABLED is ignored when
SL_RAIL_UTIL_COEX_PWM_REQ_ENABLED is disabled.
Fixed an issue where antenna diversity was not being enabled on EFR32xG1x devices when configured through
the “RAIL Utility, Antenna Diversity Configuration” component.
Fixed an issue where any RAIL_ChannelConfigEntry_t in a RAIL_ChannelConfig_t with a maximum power less
than 0 dBm would be stuck at the maximum power no matter what power was requested.
Fixed an issue when using the “RAIL Utility, Antenna Div ers ity Co nfig uration” component where moving from TX
antenna mode HAL_ANTENNA_MODE_ENABLE2 to HAL_ANTENNA_MODE_DIVERSITY would cause the
Fixed an issue on EFR32xG22 and later PTI where the network analyzer could misrepresent the RSSI of incoming
packets.
The default RSSI offset on the EFR32xG1, EFR32xG12, EFR32xG13, EFR32xG14, and EFR32xG21 chips does
not compensate for a known internal hardware offset. This offset is chip specific and can be found using the new
“RAIL Utilit y, RSSI” c om po nent wh ic h will load the correct value for your chip by default when the plugin is enabled.
Since the hardware and antenna design can also impact this offset it is recommended that you measure this value
for your particular hardware for the best accuracy. This correction is not enabled by default on the chips listed
above to prevent changing radio behavior significantly without the user opting into this change. For the
EFR32xG22 and future chips the hardware offset is measured and included by default.
silabs.com | Buildin g a mor e co nnected w or l d. Proprietary Flex 3.1.2.0 | 6
ID #
Description
Fixed a DMP issue that poached transmit power when switching between protocols using the same channel
RAIL Library
471715
519195
630457 On custom boards, the “RAIL Utility, PTI“ component no longer reserves pins for use without being configured.
632723
638067
639833 Fixed a potential radio hang on a corrupted BLE packet when doing BLE AoX.
642893 Reduced RAIL library flash data alignment needs on the EFR32xG22.
645641 Fixed an EFR32xG22 issue whe re a state transition to receive after a transmit from E M2 sleep would drop packe ts.
Fixed an issue when using RAIL_ConfigAntenna() on the EFR32xG22 with an RF path other than 0 since these
parts do not have multiple RF paths.
The EFR32xG21 will now use RTCC channel 0, as opposed to the PRORTC, to perform sleep timer
synchroniz atio n . Th is will he lp lower the EM2 current consum ption for this chip.
The EFR32xG22 will limit going to EM1P sleep mode when an 80MHz HRFRCO PLL system clock is selected.
Going to EM1P sleep is not supported when using the DPLL on this hardware as it can cause clock drift which
would impact radio timing and tuning.
configuration and channel.
4.4 Known Issues in the Current Release
None
4.5 Deprecated Items
None
4.6 Removed Items
None
silabs.com | Buildin g a mor e co nnected w or l d. Proprietary Flex 3.1.2.0 | 7
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 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 St udio’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 ti me user, see QSG168: Proprietary Flex SDK v3.x Quick Start Guide.
5.1 Installation and Use
Stack installation instruction are covered in the Simplicity Studio 5 online User’s Guid e.
Use the Flex SDK v3.x with the Silicon L ab s Sim p lic ity Studio 5 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
article s (KB As). API references and other information about this and earlier releases is available on https://docs.silabs.com/.
knowledge base
5.2 Security Information
Secure Vault Integration
This version of the stack does not integrate Secure Vault Key Management.
.
silabs.com | Buildin g a mor e co nnected w or l d. Proprietary Flex 3.1.2.0 | 8
Using This Release
Security Advisories
To subscribe to Security Advisories, log in to the Silicon Labs customer portal, then select Accou nt Hom e. Click HOME to go t o 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.
5.3 Support
Development Kit customers a re eli gibl e for training and technical suppor t. Use the Silicon Labs Flex w eb page to obtain in fo r mation 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 | Buildin g a mor e co nnected w or l d. Proprietary Flex 3.1.2.0 | 9
Legal
6 Legal
6.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 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 firm war e du ri ng t he
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 conse nt of Silicon L abs. A “Life Support Sy ste m” is any pro duct or sys tem i ntended to support or sus tain 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 applica tions. Sili con Labs products shall under no cir cumstances be used i n weapons of mass dest ructi on 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. Note: This content may contain offensive terminology that is now obsolete. Silicon Labs is
replacing these terms with inclusive language wherever possible. For more information, visit
sive-lexicon-project
www.silabs.com/about-us/inclu-
6.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®, Gecko OS, Gecko OS Studio,
ISOmodem®, Precision32®, ProSLIC®, Simplicity Studio®, SiPHY®, 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 reg is t er e d
tr adem ark of t he Wi-Fi Alliance. All other products or brand names mentioned herein are trademarks of their respective holders.
silabs.com | Buildin g a mor e co nnected w or l d. Proprietary Flex 3.1.2.0 | 10
Loading...