Sil ic on La bs O penTh re ad SDK 1.1.2.0 GA
Gecko SDK Suite 3.1
April 7, 2021
Thread is a secure, reliable, scalable, and upgradeable wireless IPv6 mesh networking
protocol. It provides low-cost bridging to o ther IP netwo rks whi le o pti mized for low-power /
battery-backed operation . The Th read s tack is designed spe cifi cally for Conne cted Ho me
applications where IP-based ne tworking is de sired and a va riety o f appli cation laye rs may
be required.
KEY FEATURES
OpenThread released by Google is an open-source implementation of Thread. Google
has released OpenThread in order to accelerate the development of products for the
connected home and commercial buildi ngs. Wit h a narrow pla tfor m ab st rac tion lay er and
a small memory footprint, OpenThread is highly portable. It supports system-on-chip
(SoC), network co-processor (NCP), and radio co-processor (RCP) designs.
Silicon Labs has developed an OpenThread-based SDK tailored to work with Sil icon Labs
hardware. The Silicon Labs OpenThread SDK is a fully tested snapshot of the GitHub
source. It supports a br oader range of hardware than does the GitHub version, and includes documentation and example applications not available on Git Hub.
These release notes cover SDK version(s):
1.1.2.0 released on Apr il 7, 2021
1.1.1.0 released on J anuary 27, 2021
1.1.0.0 released on Dec ember 9, 2020
Compatibility and Use Notices
• Alpha support for IEEE 802.15.4 managed coexistence with Wi-Fi
• Antenna Diversity
• Border router sample application
• F re eR TO S int egr ation w ith sam pl e appli-
cations
• MGM210L module support
This Gecko SDK Suite release has a know n security compatibility issue with one Gecko Platform component. For more information about this, as well as other updates and not ices, see the Security chapter of the Gecko Platform Release notes installed with this
SDK or on the Silicon Labs Release Notes page
up-to-date information. For instructions, or if you are new to the Silicon Labs OpenThread SDK, see Using This Release.
Compatible Compilers:
Note: The supported compiler will be upgraded to ARM GCC-10-2020-q4-update in the next major release.
GCC (The GNU Compiler Collection) version 7.2.x, provided with Simplicity Studio.
silabs.com | Buildin g a mor e co nnected w or l d. OpenTh re ad 1.1.2.0
. Silicon Labs also strongly recommends that you subscribe to Secur ity Advisories for
Contents
New Items .................................................................................................................................................................................. 1
1
1.1 New Features from OpenThread GitHub Repo ..................................................................................................................... 1
1.2 New Features from OpenThread Border Router GitHub Repo ............................................................................................... 1
1.3 New Components ................................................................................................................................................................ 1
1.4 New Features...................................................................................................................................................................... 1
2 Improvements ............................................................................................................................................................................. 3
2.1 Component Changes........................................................................................................................................................... 3
3 Fixed Issues ............................................................................................................................................................................... 4
4 Known Issues in the Current Release .......................................................................................................................................... 6
5 Deprecated Items ....................................................................................................................................................................... 7
6 Removed Items .......................................................................................................................................................................... 8
7 Using This Release .................................................................................................................................................................... 9
7.1 Installation and Use ............................................................................................................................................................. 9
7.2 Enabling Thread 1.2 ............................................................................................................................................................ 9
7.3 Using t he Border R outer ...................................................................................................................................................... 9
7.4 NCP/RCP Support............................................................................................................................................................... 9
7.5 Security Information .......................................................................................................................................................... 10
7.6 Support ............................................................................................................................................................................. 10
8 Legal ........................................................................................................................................................................................ 11
8.1 Disclaimer ......................................................................................................................................................................... 11
8.2 Trademark Information ...................................................................................................................................................... 11
silabs.com | Buildin g a mor e co nnected w or l d. OpenTh re ad 1.1.2.0 | 2
New Items
1 New Items
1.1 New Features from OpenThread GitHub Repo
Added in release 1.1.0.0
The Silicon Labs OpenThread SDK includes all changes from the OpenThread GitHub repo (https://github.com/openthread/openthread)
up to and including commit 5c2ad91cf. Any features introduced between commits f411a412bee and 5c2ad91cf can be considered new
items with the Silicon Labs OpenThread 1.1 SDK. A copy of the OpenThread repo can be f ound in the following Simplicity Studio 5
location:
Simplicity Stu d io\developer\sdks\gecko_sdk_suite\<version>\util\third_party\openthread
1.2 New Features from OpenThread Border Router GitHub Repo
Added in release 1.1.0.0
The Silicon Labs OpenThread SDK includes all changes from the OpenThread border router GitHub repo
(https://github.com/openthread/ot-br-posix
f93719a08c9 and a37e299ff can be considered new items wit h the S il icon Labs OpenThread 1.1 SDK. A copy of the OpenThread border
router repo can be f ound in the following Simplicity Studio 5 location:
) up to and including commit a37e299ff. Any features introduced between commits
Simplicity Stu d io\developer\sdks\gecko_sdk_suite\<version>\util\third_party\ot-br-posix
Refer to section 7.3 for info r mati on on using the border router.
1.3 New Components
Added in release 1.1.0.0
ot_debug_channel
This component provides a set of API s for printing to t he debug channel. Information printed to the debug channel can be viewed using
Simplicity Stu d io’s Net work Analy z er .
1.4 New Features
Added in release 1.1.0.0
Ant enna D iversity
Antenna Diversity support has been added. Refer to AN1294: Configuring Antenna Diversity for OpenThread for details on configuration
and use.
Wi-Fi Coexistence
Wi-Fi Coexistence support has been added. Refer to UG103.17: Wi-Fi Coexistence Fundamentals and AN1017: Zigbee and Thread
Coexistence with Wi-Fi for details on configuration and use.
OpenThrea d Bor der Router
The OpenThread border router has been integrated into the Silicon Labs OpenThread SDK. Refer to
RCP with the O penThread Border Router for det ails on configuration and use
silabs.com | Buildin g a mor e co nnected w or l d. OpenTh re ad 1.1.2.0 | 1
AN1256: Using t he Silicon Labs
New Items
Thread 1.2
Alpha support for Thread 1.2 has been added. Ref er to AN1295: Developing with Thread 1. 2 for details on configuration and use.
FreeRTOS integration with sample applications
FreeRTOS support has been added to all O penThread sam ple applications. Ref er to AN1264: Using OpenThread with Free RTOS for
configuration and use.
silabs.com | Buildin g a mor e co nnected w or l d. OpenTh re ad 1.1.2.0 | 2
Improvements
2 Improvements
2.1 Component Changes
Changed in release 1.1.0.0
ot_cli
The ot_cli component has been enhanced to provide CLI support f or Wi-Fi coexistence and antenna diversity.
ot_platform_abstraction
The ot_platform_abstraction component has been enhance d to supp ort CMS IS-RTOS2 abstraction layer, Wi-Fi coexistence, and an tenna
diversity.
ot_thirdparty
The ot_thirdparty component has been updated to use mbedTLS 2.24.0.
silabs.com | Buildin g a mor e co nnected w or l d. OpenTh re ad 1.1.2.0 | 3
ID #
Description
Fixed issues with logic in the platform abstraction layer responsible for passing mAckedWithFramePending to the
is used to keep track of the radio power level. But this variable can easily get out of sync because the call
otPlatEntropyGet should directly call mbedtls_hardware_poll and avoid dropping 3 bytes of entropy by using all 4 bytes of
Fixed Issues
3 Fixed Issues
Fixed in release 1.1.2.0
653058 Coexistence Component: "TX fails to abort on Grant abort when set to do so."
Fixed in release 1.1.1.0
ID # Description
605107
649169
651053
651489
653069
653385
We no longer allow OpenThr ead samples to be selected in Simplicity Studio with boards where t he app would fail to build
due to limited flash/RAM.
In the platform abstr action layer we now populate the RSSI, LQI and timestamp values (aka RX info) for the received ACK
frames before passing to the OpenThread core. Previously, this info was only populated for non-ACK packets. The problem
was that when a SED polled i ts paren t, the ACK fr ame was pas sed up to th e OpenThread core, but the RX info was
incorrect (it was actually the RX inf o for the last received non-ack packet).
Fixed an issue with the ot-ble-dmp sample app where, if you open a BLE connection and then s end a lot of OpenThread
traffic, it was possible to run out of OpenThread buffers.
The sleepy-demo-ftd and sleepy-demo-mtd sample apps were only initializing 12 of the 16 bytes of the predefined master
key. Now all 16 bytes are initialized. The previous code did not cause a problem with the execution of the sample apps but
did cause confusion to readers of the code.
Fixed an issue with the Coexistence Component where "TX Priority Escalation when CCA Fail" was not working due to a
header misconfiguration.
Fixed issues with the coexistence get-pta-options and set -pta-options CLI co m mands . The output displayed for the g et -ptaoptions command missed line spaces and used incorrect format specifiers. The set-pta-options command read the i npu t in
decimal format instead of hexadecimal.
653466
654789
655515
OpenThread core.
Fixed an issue where GPIO initialization w as not occur rin g, preventing antenna diversity from working correctly.
The txpower CLI com mand now displays the correct dBm value.
Fixed in release 1.1.0.0
ID # Description
In both the ot PlatRadioSetTransmitPower and otPlatRadioGet TransmitPower implementations a variable sTxPowerDbm
630624
635190
643623 Removed an extra call to sl_uartdrv_init_instances that was causing excess DMA channels t o be allocated.
642953 Fixed an issue where radio.c can assert with very heavy traffic and very heavy M CU load.
RAIL_SetTxPowerDbm silently truncates any p ower l evel to the nearest power level available for the radio. Fix is to remove
this ext ra state variable and use RAI L_GetTxPowerDbm (divided by 10) to report the actual, set power level for the radio.
Fixes for the following energy scan issues:
• When performing an Energy scan on a node running the ot-cli-ftd app, with large scan dur ation, the energy scan expectedly fails. However, every subsequent energy scan returns a channel busy message.
• Similar to the previous cas e, when performing an Energy scan on a node running the ot-ble-dm p app , w ith la r ge sc a n
durations, the ene rgy s can expectedly fails. However , i n this case, the node b ecomes unresponsive on the network and
every subsequent ener gy scan returns a channel busy message.
629088
silabs.com | Buildin g a mor e co nnected w or l d. OpenTh re ad 1.1.2.0 | 4
gathered entropy.
Fixed Issues
ID # Description
642968
642965
In otPlatGetResetReason, the return value previously implied that the last reset was caused by an assert, when actually it
was a brownout or an EM4 reset. It now reports OT_PLAT_RESET_REASON_OTHER.
Ensure that OPENTHREAD_CONFIG_MAC_SOFTWARE_CSMA_BACKOFF_ENABLE and
OPENTHREAD_CONFIG_MAC_SOFTWARE_ENERGY_SCAN_ENABLE are defined to 0 to avoid CMSA being
performed twice.
silabs.com | Buildin g a mor e co nnected w or l d. OpenTh re ad 1.1.2.0 | 5
Coexistence Component: "PWM on Request" not currently
650113
Thread Test Harness Leader Test 9.2.5 fails
No known workaround
Known Issues in the Current Releas e
4 Known Issues in the Current Release
Issues in bold we re added since the previous release. If you have missed a release, recent release notes are avai labl e on https://www.si-
labs.com/products/software.
ID # Description Workaround
482915
495241
653068
653070
653076
A known limitatio n with the UART driver can cause characters
to be lost on CLI input or output. This can happen during
particularly long critical sections that may disable interrupts, so
it can be alleviated by repeating t he CLI or waiting long enough
for state changes.
Coexistence Component: "Sync MAC to Grant" is not working.
Grant doesn't abort even when the tx a bor t grant abort i s enabled
in component and pta master is configured.
working. Request, Grant, and Priority are held high.
Coexistence Component: "Shared Mode Request back off not
working" is currently not working. Simulating regular request and
not asserting priority.
No known workaround
No known workaround
No known workaround
No known workaround
silabs.com | Buildin g a mor e co nnected w or l d. OpenTh re ad 1.1.2.0 | 6
Deprecated Item s
5 Deprecated Items
None
silabs.com | Buildin g a mor e co nnected w or l d. OpenTh re ad 1.1.2.0 | 7
Removed Items
6 Removed Items
None
silabs.com | Buildin g a mor e co nnected w or l d. OpenTh re ad 1.1.2.0 | 8
Using This Release
7 Using This Release
This release contains the following
• Silicon Labs OpenThread stack
• Silicon Labs OpenThread sample applications
• Silicon Labs OpenThread border router
For more information about the OpenThread SD K se e QSG170: Silicon Labs OpenThread QuickStart Guide
see UG103.11: Thread Fundamentals.
. If you ar e ne w to Thread
7.1 Installation and Use
A registered account at Silicon Labs is r equired in order to download the Silicon Labs OpenThread SDK. Y o u ca n re g ist er at https://sili-
conlabs.force.com/apex/SL_CommunitiesSelfReg?form=short.
Stack installation instruction are covered in the Simplicity Studio 5 online User’s Guid e.
Use the OpenThread SDK v1.x with the Silicon Labs Simplicit y Studio 5 development platform only. The SDK is not compatible with
Simplicity Stu d io 4.
Documentation specific to the SDK ver sion is ins talled with t he SD K. API references and other in formation a bout thi s release are available
on https://docs.silabs.com/openthread/1.1/
.
7.2 Enabling T hr ead 1.2
Thread 1.2 support is included in the Silicon Labs OpenThread SDK but is not enabled by def ault. It can be enabled by following the
instructions in AN1295: Developing with Thread 1.2. Thread 1.2 suppo rt is alpha quality and is not fully tested as the specification is yet
to be certified and some features are un stable. We have included a subset of features: Domain U nique Address (DUA), Multicast Listener
Registration (MLR) and Backbone Router support. Low power f eatures such as Enhanced Frame Pending are currently disabled by
default, and CSL s upport is not included.
7.3 Using the Border Router
For ease of use, Silicon Labs r ecommends the use of a Docker container for your OpenThread border router. Please refer to AN1256:
Using the Silicon Labs RCP with the OpenThread Border Router for details on how to set up the correct version of OpenThread border
router Docker container. It is available at https://hub.docker.com/r/siliconlabsinc/openthread-border-router.
The Silicon Labs OpenThread RCP is meant f or use with the OpenThr ead border router built usi ng the ot-br-posix repository (git commit
a37e299ff). Our copy of the OpenThread stack (git commit 5c2ad91cf) should be symbolically linked under " third_par ty \openthread\repo"
in the ot-br-posix repository.
For your convenience we have included copies of these repositories in the GSDK, located here:
Simplicity Stu d io\developer\sdks\gecko_sdk_suite\<version>\util\third_party\ot-br-posix
Simplicity Stu d io\developer\sdks\gecko_sdk_suite\<version>\util\third_party\openthread
If you are manually i nstalling a border router, using the copies provided above is rec om men ded. R efer to
RCP with the O penThread Border Router for more details.
Although updating the border router environment to a later GitHub version is supported on the OpenThread website, it may make the
border router incompatible with the O penThread RCP stack in t he SDK.
AN1256: Using the Silicon Labs
7.4 NCP/RCP Support
The OpenThread NCP support is included with OpenThread SDK but any use of this support should be considered experimental. The
OpenThread RCP is fully implemented and supported.
silabs.com | Buildin g a mor e co nnected w or l d. OpenTh re ad 1.1.2.0 | 9
Using This Release
7.5 Security Information
Secure Vault Integration
This version of the stack does not integrate Secure Vault Key M anagement.
Security Advisories
To subscribe to Secur ity Advisories, log in to the Silicon Labs cust omer portal, then select Account Home. Click HOME to g o to t he
portal home page and then click the M anage Notifications tile. Make sure that ‘Software/Security Advisory Notices & Product Change
Notices (PCNs)’ is checked, and that you ar e subscribed at minimum for your platform and protocol. Click Save to save any changes.
7.6 Support
Development Kit customers are eligible for training and technical support. Use the Silicon Laboratories Thread web page to obtain infor-
mation about all Silicon Labs OpenThread 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. OpenTh re ad 1.1.2.0 | 10
Legal
8 Legal
8.1 Disclaimer
Silicon Labs intends to provide customers with t he 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 pr oducts. Characterization data, available modules and
peripherals, memory sizes and m emory addresses refer to each specific device, and “Typical” parameters provided can and do var y in
different applications. Applicat ion examples described herein are for illustrative purposes only. Silicon Labs r eserves the r ight to make
changes without further notice to the product information, specifications, and descript ions herein, and does not give warranties as to the
accuracy or com pleteness 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 spec ifications 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 gr ant any license to design or fabr icate any integrated circuits. The pr oducts 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 Labs. A “Lif e S upport System” is any product or system i ntended 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 applica tions. Sili con Labs products shall under no cir cumstances be used i n weapon s of mass de struct ion 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 obsol ete. Silicon Labs is
replacing these terms with inclusive language wherever possible. For more information, visit
sive-lexicon-project
www.silabs.com/about-us/inclu-
8.2 Trademark Information
Silicon Laboratories Inc.®, Silicon Laboratories®, Silicon Labs®, SiLabs® and the Silicon Labs logo®, Bluegiga®, Bluegiga Logo®,
ClockBuilder®, CMEM S®, DSPLL®, EFM®, EFM32®, EFR, Ember®, Energy M icro, 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 St udio®, 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 r egistered trademarks of ARM Holdings. Keil is a registered trademark of ARM Limited. Wi-Fi is a r eg 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. OpenTh re ad 1.1.2.0 | 11
Loading...