Skip to content

Commit 5bbd793

Browse files
nordic-haninordic-hani
committed
doc: libmodem: clean up the variants and feature page
* 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. Signed-off-by: Håvard Vermeer <[email protected]>
1 parent db86ee8 commit 5bbd793

File tree

1 file changed

+56
-32
lines changed

1 file changed

+56
-32
lines changed

‎nrf_modem/doc/variant_features.rst‎

Lines changed: 56 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,42 +3,66 @@
33
Variants and features
44
#####################
55

6-
The Modem library comes in two variants, each with a specific feature set and support for a specific variant of the nRF91 Series firmware.
6+
The Modem library comes in two *variants*, each with a specific feature set and support for the equivalent *modem firmware product*.
77

8-
The cellular variant of the Modem library supports the nRF91 Series cellular firmware.
9-
The DECT PHY variant of the Modem library supports the nRF91 Series DECT NR+ PHY firmware.
8+
The cellular variant of the Modem library supports the following modem firmware products:
109

11-
The features of the nRF91 Series firmware that are common across firmware variants, are also common across Modem library variants, for example, SoC management, bootloader, AT commands, and others.
10+
* mfw_nrf9160
11+
* mfw_nrf91x1
12+
* mfw_nrf9151-ntn
1213

14+
The DECT NR+ variant of the Modem library supports the following modem firmware products:
15+
16+
* mfw-nr+_nrf91x1
17+
18+
Features that are common across *modem firmware products*, are also common across *Modem library variants*.
1319
The table below shows which feature and API is supported in which Modem library variant:
1420

15-
+---------------------------------+--------------------------------+----------+--------------+
16-
| Feature | API header | Cellular | DECT NR+ PHY |
17-
+=================================+================================+==========+==============+
18-
| Modem SoC management | :file:`nrf_modem.h` | Yes | Yes |
19-
+---------------------------------+--------------------------------+----------+--------------+
20-
| :ref:`nrf_modem_fault` | :file:`nrf_modem.h` | Yes | Yes |
21-
+---------------------------------+--------------------------------+----------+--------------+
22-
| :ref:`nrf_modem_trace` | :file:`nrf_modem_trace.h` | Yes | Yes |
23-
+---------------------------------+--------------------------------+----------+--------------+
24-
| :ref:`nrf_modem_bootloader` | :file:`nrf_modem_bootloader.h` | Yes | Yes |
25-
+---------------------------------+--------------------------------+----------+--------------+
26-
| :ref:`nrf_modem_delta_dfu` | :file:`nrf_modem_delta_dfu.h` | Yes | Yes |
27-
+---------------------------------+--------------------------------+----------+--------------+
28-
| :ref:`nrf_modem_log` | :file:`nrf_modem_os.h` | Yes | Yes |
29-
+---------------------------------+--------------------------------+----------+--------------+
30-
| :ref:`nrf_modem_at` | :file:`nrf_modem_at.h` | Yes | Yes |
31-
+---------------------------------+--------------------------------+----------+--------------+
32-
| :ref:`nrf_modem_dect_phy` | :file:`nrf_modem_dect_phy.h` | No | Yes |
33-
+---------------------------------+--------------------------------+----------+--------------+
34-
| :ref:`nrf_sockets` | :file:`nrf_socket.h` | Yes | No |
35-
+---------------------------------+--------------------------------+----------+--------------+
36-
| :ref:`nrf_modem_gnss` | :file:`nrf_modem_gnss.h` | Yes | No |
37-
+---------------------------------+--------------------------------+----------+--------------+
38-
| :ref:`nrf_modem_softsim` | :file:`nrf_modem_softsim.h` | Yes | No |
39-
+---------------------------------+--------------------------------+----------+--------------+
40-
| :ref:`nrf_modem_rs_capture_api` | :file:`nrf_modem_rs_capture.h` | Yes | No |
41-
+---------------------------------+--------------------------------+----------+--------------+
21+
.. table:: Supported features by Modem library variant and modem firmware product.
22+
23+
+---------------------------------+--------------------------------+---------------------------------------------+-----------------+
24+
| Feature | API header | Cellular | DECT NR+ |
25+
| | | | |
26+
| | | | |
27+
| | +-------------+-------------+-----------------+-----------------+
28+
| | | mfw_nrf9160 | mfw_nrf91x1 | mfw_nrf9151-ntn | mfw-nr+_nrf91x1 |
29+
+=================================+================================+=============+=============+=================+=================+
30+
| Modem SoC management | :file:`nrf_modem.h` | Yes | Yes |
31+
+---------------------------------+--------------------------------+---------------------------------------------+-----------------+
32+
| :ref:`nrf_modem_fault` | :file:`nrf_modem.h` | Yes | Yes |
33+
+---------------------------------+--------------------------------+---------------------------------------------+-----------------+
34+
| :ref:`nrf_modem_trace` | :file:`nrf_modem_trace.h` | Yes | Yes |
35+
+---------------------------------+--------------------------------+---------------------------------------------+-----------------+
36+
| :ref:`nrf_modem_bootloader` | :file:`nrf_modem_bootloader.h` | Yes | Yes |
37+
+---------------------------------+--------------------------------+---------------------------------------------+-----------------+
38+
| :ref:`nrf_modem_delta_dfu` | :file:`nrf_modem_delta_dfu.h` | Yes | Yes |
39+
+---------------------------------+--------------------------------+---------------------------------------------+-----------------+
40+
| :ref:`nrf_modem_log` | :file:`nrf_modem_os.h` | Yes | Yes |
41+
+---------------------------------+--------------------------------+---------------------------------------------+-----------------+
42+
| :ref:`nrf_modem_at` [#at-note]_ | :file:`nrf_modem_at.h` | Yes | Yes |
43+
+---------------------------------+--------------------------------+---------------------------------------------+-----------------+
44+
| :ref:`nrf_modem_dect_phy` | :file:`nrf_modem_dect_phy.h` | No | Yes |
45+
+---------------------------------+--------------------------------+---------------------------------------------+-----------------+
46+
| :ref:`nrf_sockets` | :file:`nrf_socket.h` | Yes | No |
47+
+---------------------------------+--------------------------------+---------------------------------------------+-----------------+
48+
| :ref:`nrf_modem_gnss` | :file:`nrf_modem_gnss.h` | Yes | No |
49+
+---------------------------------+--------------------------------+-------------+-------------+-----------------+-----------------+
50+
| :ref:`nrf_modem_softsim` | :file:`nrf_modem_softsim.h` | No | Yes | Yes | No |
51+
+---------------------------------+--------------------------------+-------------+-------------+-----------------+-----------------+
52+
| :ref:`nrf_modem_rs_capture_api` | :file:`nrf_modem_rs_capture.h` | No | Yes | Yes | No |
53+
+---------------------------------+--------------------------------+-------------+-------------+-----------------+-----------------+
54+
55+
.. [#at-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+ modem firmware products is different.
4256
4357
.. note::
44-
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.
58+
The different APIs may have certain subsets of functionality that are only supported by certain modem firmware products and versions.
59+
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.
60+
Exceptions like this are documented with notes like the one below:
61+
62+
.. code-block:: c
63+
64+
/**
65+
* @note This is only supported by the following modem firmware products:
66+
* - mfw_nrf91x1
67+
* - mfw_nrf9151-ntn
68+
*/

0 commit comments

Comments
 (0)