doc: nrf_modem: clean up the variants and feature page #1935
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
nordic-hani
commented
Nov 26, 2025
nordic-hani
commented
- Clean up the page to use the concept of "modem firmware products".
- The cellular variant of libmodem actually supports three different modem firmware products.
- Added example of exceptions from the table.
- Altered the existing note to become a footnote for the "AT" entry.
github-actions
bot
added
the
doc-required
nordic-hani
force-pushed
the
doc_variants_features
branch
from
5bbd793 to
887051c
Compare
nordic-hani
changed the title
NordicBuilder
added a commit
to NordicBuilder/sdk-nrf
that referenced
this pull request
Nov 26, 2025
Automatically created by action-manifest-pr GH action from PR: nrfconnect/sdk-nrfxlib#1935 Signed-off-by: Nordic Builder <pylon@nordicsemi.no>
* Clean up the page to use wording "modem firmware". * The cellular variant of libmodem actually supports three different modem firmware products. * Added example of exceptions from the table. * Altered the existing note to become a footnote for the "AT" entry. Signed-off-by: Håvard Vermeer <havard.vermeer@nordicsemi.no>
nordic-hani
force-pushed
the
doc_variants_features
branch
from
887051c to
8e0a699
Compare
|
NordicBuilder
added a commit
to NordicBuilder/sdk-nrf
that referenced
this pull request
Dec 11, 2025
Automatically created by action-manifest-pr GH action from PR: nrfconnect/sdk-nrfxlib#1935 Signed-off-by: Nordic Builder <pylon@nordicsemi.no>
rlubos
approved these changes
Dec 11, 2025
divipillai
reviewed
Dec 19, 2025
| ##################### | ||
|
|
||
| The Modem library comes in two variants, each with a specific feature set and support for a specific variant of the nRF91 Series firmware. | ||
| The Modem library comes in two *variants*, each with a specific feature set and support for the equivalent *modem firmware*. |
Contributor
There was a problem hiding this comment.
Suggested change
| The Modem library comes in two *variants*, each with a specific feature set and support for the equivalent *modem firmware*. | |
| The Modem library comes in two variants, each with a specific feature set and support for the equivalent modem firmware. |
I think these need not be in italics as these are normal terms used in the docs.
|
|
||
| * mfw-nr+_nrf91x1 | ||
|
|
||
| Features that are common across *modem firmware*, are also common across *Modem library variants*. |
Contributor
There was a problem hiding this comment.
Suggested change
| Features that are common across *modem firmware*, are also common across *Modem library variants*. | |
| Features that are common across modem firmware are also common across Modem library variants. |
| | :ref:`nrf_modem_rs_capture_api` | :file:`nrf_modem_rs_capture.h` | No | Yes | Yes | No | | ||
| +---------------------------------+--------------------------------+-------------+-------------+-----------------+-----------------+ | ||
|
|
||
| .. [#at-note] Although the Modem library AT interface is fully supported by both Modem library variants, the AT command set supported by the cellular modem firmware and the DECT NR+ modem firmware is different. |
Contributor
There was a problem hiding this comment.
Could remove the footnote as it is not used in the table.
| .. note:: | ||
| Although the Modem library AT interface is fully supported by both Modem library variants, the AT command set supported by the cellular and DECT NR+ PHY firmware is different. | ||
| The different APIs may have certain subsets of functionality that are only supported by certain modem firmware and modem firmware versions. |
Contributor
There was a problem hiding this comment.
Suggested change
| The different APIs may have certain subsets of functionality that are only supported by certain modem firmware and modem firmware versions. | |
| The different APIs might have certain subsets of functionality that are only supported by certain modem firmware and modem firmware versions. |
| .. note:: | ||
| Although the Modem library AT interface is fully supported by both Modem library variants, the AT command set supported by the cellular and DECT NR+ PHY firmware is different. | ||
| The different APIs may have certain subsets of functionality that are only supported by certain modem firmware and modem firmware versions. | ||
| For example, :ref:`nrf_sockets` is supported for all cellular firmware products (and Modem library variants), but the socket option ``NRF_SO_SEC_CIPHERSUITE_USED`` is not suported by mfw_nrf9160. |
Contributor
There was a problem hiding this comment.
Suggested change
| For example, :ref:`nrf_sockets` is supported for all cellular firmware products (and Modem library variants), but the socket option ``NRF_SO_SEC_CIPHERSUITE_USED`` is not suported by mfw_nrf9160. | |
| For example, :ref:`nrf_sockets` is supported for all cellular firmware (and Modem library variants), but the socket option ``NRF_SO_SEC_CIPHERSUITE_USED`` is not supported by mfw_nrf9160. |
Comment on lines
+60
to
+65
| Exceptions like this are documented with notes like the one below: | ||
|
|
||
| .. code-block:: c | ||
| /** | ||
| * @note This is only supported by the following modem firmware products: |
Contributor
There was a problem hiding this comment.
Suggested change
| Exceptions like this are documented with notes like the one below: | |
| .. code-block:: c | |
| /** | |
| * @note This is only supported by the following modem firmware products: | |
| Exceptions like this are documented with notes like the following in the header files: | |
| .. code-block:: c | |
| /** | |
| * @note This is only supported by the following modem firmware: |
Maybe we could mention that it is documented in the header file?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.