Skip to content

Commit

Permalink
doc: thread: update certification information
Browse files Browse the repository at this point in the history
Update the information about OpenThread prebuild libraries and
replace the list of certified libraries with links to the
compatibility matrices.

Signed-off-by: Ruth Fuchss <[email protected]>
  • Loading branch information
Ruth Fuchss authored and carlescufi committed May 4, 2021
1 parent 15b1b4c commit a001cde
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 40 deletions.
4 changes: 4 additions & 0 deletions doc/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@

.. _`Infocenter`: https://infocenter.nordicsemi.com/index.jsp

.. _`Thread CIDs for nRF5340`: https://infocenter.nordicsemi.com/topic/comp_matrix_nrf5340/COMP/nrf5340/nrf5340_thread_cids.html
.. _`Thread CIDs for nRF52840`: https://infocenter.nordicsemi.com/topic/comp_matrix_nrf52840/COMP/nrf52840/nrf52840_thread_cids.html
.. _`Thread CIDs for nRF52833`: https://infocenter.nordicsemi.com/topic/comp_matrix_nrf52833/COMP/nrf52833/nrf52833_thread_cids.html

.. ### Links to Nordic pages

.. _`nRF9160 modem firmware zip file`: https://www.nordicsemi.com/Products/Low-power-cellular-IoT/nRF9160/Download#0B34B59935AF4AFCB7AB93E9646C1F53
Expand Down
60 changes: 20 additions & 40 deletions openthread/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,45 +7,25 @@ OpenThread pre-built libraries
:local:
:depth: 2

The |NCS| allows for using certified OpenThread libraries for Nordic devices.
The |NCS| provides pre-built OpenThread libraries.
Some of these are certified by the Thread Group for use with Nordic Semiconductor devices.
This simplifies the OpenThread certification process of the final product.
See :ref:`ug_thread_cert` for more information.

The libraries vary depending on stack configuration and hardware cryptography capabilities.
You can choose the stack configuration from one of the predefined set of values, also called feature sets.
For more information about OpenThread feature sets and how to select them in |NCS|, see :ref:`nrf:thread_ug_feature_sets`.

The cryptography variant is selected automatically based on the microcontroller capabilities.

Thread certified library variants
*********************************

The following table describes the available Thread certified libraries for all |NCS| releases.

.. list-table::
:header-rows: 1

* - SoC
- |NCS| tag
- Thread version
- Crypto backend
- OpenThread commit
- GNU Arm Embedded Toolchain
- Feature set
* - nRF52840
- v1.4.0
- :option:`CONFIG_OPENTHREAD_THREAD_VERSION_1_1`
- CC310
- ``07f430dac6c400abdd358ba1173c0f94b94a5a80``
- ``9-2019-q4-major``
- :option:`CONFIG_OPENTHREAD_NORDIC_LIBRARY_MASTER`
* - nRF52833
- v1.4.0
- :option:`CONFIG_OPENTHREAD_THREAD_VERSION_1_1`
- nrf_oberon
- ``07f430dac6c400abdd358ba1173c0f94b94a5a80``
- ``9-2019-q4-major``
- :option:`CONFIG_OPENTHREAD_NORDIC_LIBRARY_MASTER`

For a comprehensive list of the used Kconfig options, check the :file:`openthread_lib_configuration.txt` file within each library folder.

.. note:: Only library variants shown in the table have been certified.
The pre-built libraries vary depending on stack configuration and hardware cryptography capabilities:

* The stack configuration depends on the feature set that you use.
A feature set is a predefined set of configuration options.
For more information about selecting a feature set and customizing the configuration of the pre-built libraries, see :ref:`nrf:thread_ug_prebuilt`.
* The cryptography variant is selected automatically based on the microcontroller capabilities.

For the full list of configuration options that were used during compilation of the libraries, including the default values, see the :file:`openthread_lib_configuration.txt` file within each library folder.

Certified libraries
*******************

Check the compatibility matrices in the `Infocenter`_ for information about which library variants and versions are certified for a specific device:

* `Thread CIDs for nRF5340`_
* `Thread CIDs for nRF52840`_
* `Thread CIDs for nRF52833`_

0 comments on commit a001cde

Please sign in to comment.