nrf_modem: doc: updates for nRF9161

Add support for nRF9161 to documentation. Co-authored-by: divya pillai <[email protected]> Signed-off-by: Eivind Jølsgard <[email protected]>
nrfconnect · Oct 11, 2023 · 2f1103b · 2f1103b
1 parent 15307eb
commit 2f1103b
Show file tree

Hide file tree

Showing 13 changed files with 137 additions and 138 deletions.
diff --git a/doc/links.txt b/doc/links.txt
@@ -15,6 +15,8 @@
 
 .. _`nRF9160 AT Commands Reference Guide`: https://infocenter.nordicsemi.com/topic/ref_at_commands/REF/at_commands/intro.html
 
+.. _`nRF91x1 AT Commands Reference Guide`: https://www.nordicsemi.com/-/media/Software-and-other-downloads/SiP/nRF91x1-SiP/v0.8-nRF91x1_CIoT_and_Positioning-AT-Commands-reference-guide.pdf
+
 .. _`Selecting UICC slot %CSUS`: https://infocenter.nordicsemi.com/index.jsp?topic=%2Fref_at_commands%2FREF%2Fat_commands%2Faccess_uicc%2Fcsus.html
 
 .. _`Credential storage management %CMNG`: https://infocenter.nordicsemi.com/topic/ref_at_commands/REF/at_commands/mob_termination_ctrl_status/cmng.html
@@ -38,9 +40,9 @@
 .. _`Zigbee CIDs for nRF52840`: https://infocenter.nordicsemi.com/topic/comp_matrix_nrf52840/COMP/nrf52840/nrf52840_zigbee_cids.html
 .. _`Zigbee CIDs for nRF52833`: https://infocenter.nordicsemi.com/topic/comp_matrix_nrf52833/COMP/nrf52833/nrf52833_zigbee_cids.html
 
-.. _`nRF9160 modem Packet Domain AT commands`: https://infocenter.nordicsemi.com/topic/ref_at_commands/REF/at_commands/packet_domain/packet_domain.html
+.. _`Packet domain commands`: https://infocenter.nordicsemi.com/topic/ref_at_commands/REF/at_commands/packet_domain/packet_domain.html
 
-.. _`%XMODEMTRACE AT command documentation`: https://infocenter.nordicsemi.com/topic/ref_at_commands/REF/at_commands/mob_termination_ctrl_status/xmodemtrace.html
+.. _`Modem trace activation %XMODEMTRACE`: https://infocenter.nordicsemi.com/topic/ref_at_commands/REF/at_commands/mob_termination_ctrl_status/xmodemtrace.html
 
 .. _`nRF Connect Serial Terminal`: https://infocenter.nordicsemi.com/topic/ug_serial_terminal/UG/serial_terminal/intro.html
 
@@ -50,8 +52,12 @@
 
 .. _`nRF9160 modem firmware zip file`: https://www.nordicsemi.com/Products/Low-power-cellular-IoT/nRF9160/Download#0B34B59935AF4AFCB7AB93E9646C1F53
 
+.. _`nRF91x1 LTE firmware zip file`: https://www.nordicsemi.com/Products/nRF9161/Download#636701B052474E5A8EB903C56678D26E
+
 .. _`nRF9160 modem TLS cipher suites`: https://www.nordicsemi.com/Products/Low-power-cellular-IoT/nRF9160/Download#infotabs
 
+.. _`nRF91x1 modem TLS cipher suites`: https://www.nordicsemi.com/Products/nRF9161/Download?lang=en#infotabs
+
 .. ### Source: wikipedia
 
 .. _`Global navigation satellite system (GNSS)`: https://en.wikipedia.org/wiki/Satellite_navigation

diff --git a/nrf_modem/README.rst b/nrf_modem/README.rst
@@ -3,7 +3,7 @@
 Modem library
 #############
 
-The Modem library is the primary interface for operating the nRF9160 modem, establishing the LTE-M and NB-IoT connections, and receiving the position data (GPS).
+The Modem library is the primary interface for operating the cellular modem, establishing the LTE-M and NB-IoT connections, and receiving the position data (GPS).
 The library aims to be compatible with the POSIX socket APIs to simplify writing and porting of existing networking applications.
 
 To get started with socket programming, you can check out some introductions and tutorials, such as `Beej's Guide to Network Programming`_.

diff --git a/nrf_modem/doc/architecture.rst b/nrf_modem/doc/architecture.rst
@@ -7,7 +7,7 @@ Library architecture
    :local:
    :depth: 2
 
-The library implements a communication interface between the Application and Modem cores on the nRF9160 through the RPC protocol, using the Inter Processor Communication (IPC) peripheral and a shared region of RAM.
+The library implements a communication interface between the application and modem cores on the nRF91 Series through the RPC protocol, using the Inter Processor Communication (IPC) peripheral and a shared region of RAM.
 
 The following figure shows a simplified Modem library architecture:
 

diff --git a/nrf_modem/doc/at_interface.rst b/nrf_modem/doc/at_interface.rst
@@ -13,7 +13,7 @@ AT commands
 ***********
 
 AT commands are essentially a set of modem instructions that are used to configure the modem, establish a network connection (or in general, execute operations), and retrieve modem and connection status information.
-For the full set of supported AT commands, see the `nRF9160 AT Commands Reference Guide`_.
+For the full set of supported AT commands, see the `nRF91x1 AT Commands Reference Guide`_  or `nRF9160 AT Commands Reference Guide`_ depending on the SiP you are using.
 
 Initialization
 **************

diff --git a/nrf_modem/doc/delta_dfu.rst b/nrf_modem/doc/delta_dfu.rst
@@ -22,7 +22,7 @@ Delta update packages
 
 A delta update is a binary file, with a :file:`.bin` extension.
 The update file is named in such a way that both the source and destination firmware versions can be identified, for example, :file:`mfw_nrf9160_update_from_1.2.2_to_1.2.3`.
-Modem delta update files are part of the official modem releases and can be found in the `nRF9160 modem firmware zip file`_.
+Modem delta update files are part of the official modem releases and can be found in the `nRF9160 modem firmware zip file`_ or `nRF91x1 LTE firmware zip file`_ depending on the SiP you are using.
 
 .. note::
    Delta update files might not be available for any two of the modem firmware versions but only for specific versions, as applicable.
@@ -35,13 +35,13 @@ The size of the scratch area can be retrieved with the :c:func:`nrf_modem_delta_
 A limitation of delta updates is that the size of the update must not exceed the area of flash memory that a given modem firmware version has dedicated for this operation.
 The size of this area varies for any given modem firmware version and it can be retrieved with the Modem library's :c:func:`nrf_modem_delta_dfu_area` function.
 In general, this function can be useful when the size of the largest delta update that can be received needs to be reported to an external service, for example an LwM2M server.
-In practice, the application does not use this function in the normal update process, since all delta update files that are part of the `nRF9160 modem firmware zip file`_ are guaranteed to fit in the scratch area of the modem firmware version that they apply to.
+In practice, the application does not use this function in the normal update process, since all delta update files that are part of the `nRF9160 modem firmware zip file`_ or `nRF91x1 LTE firmware zip file`_ are guaranteed to fit in the scratch area of the modem firmware version that they apply to.
 
 Reading the modem firmware UUID
 *******************************
 
 A modem firmware UUID is a unique identifier for a modem firmware version build.
-The modem firmware UUID for given firmware version is found in the :file:`README.txt` file of the `nRF9160 modem firmware zip file`_, and can also be retrieved by using the :c:func:`nrf_modem_delta_dfu_uuid` function.
+The modem firmware UUID for given firmware version is found in the :file:`README.txt` file of the `nRF9160 modem firmware zip file`_ or `nRF91x1 LTE firmware zip file`_ depending on the SiP you are using, and can also be retrieved by using the :c:func:`nrf_modem_delta_dfu_uuid` function.
 
 Features
 ********
@@ -51,7 +51,7 @@ Following are the features of modem firmware delta updates.
 Security
 ========
 
-Modem firmware delta updates implement security features to ensure that only firmware updates from `nRF9160 modem firmware zip file`_ are ever programmed to the modem.
+Modem firmware delta updates implement security features to ensure that only firmware updates from the `nRF9160 modem firmware zip file`_ or `nRF91x1 LTE firmware zip file`_ are ever programmed to the modem.
 Delta update files are encrypted and signed.
 The modem takes care of verifying the signature and decrypting the content as necessary.
 

diff --git a/nrf_modem/doc/fault_handling.rst b/nrf_modem/doc/fault_handling.rst
@@ -7,8 +7,8 @@ Modem fault handling
    :local:
    :depth: 2
 
-The application core and the modem core are separate cores on the nRF9160 SiP.
-When the modem core on the nRF9160 SiP crashes, it sends a fault signal to the application core.
+The application core and the modem core are separate cores on the nRF91 Series SiPs.
+When the modem core on an nRF91 Series SiP crashes, it sends a fault signal to the application core.
 
 Detecting a fault
 *****************

diff --git a/nrf_modem/doc/gnss_interface.rst b/nrf_modem/doc/gnss_interface.rst
@@ -478,7 +478,7 @@ A-GNSS data
 ***********
 
 You can use GNSS assistance data to shorten TTFF and decrease GNSS power consumption.
-See :ref:`lib_nrf_cloud_agps` and :ref:`lib_nrf_cloud_pgps` for information how to obtain assistance data from :ref:`lib_nrf_cloud` to be used with the nRF9160 SiP.
+See :ref:`lib_nrf_cloud_agps` and :ref:`lib_nrf_cloud_pgps` for information how to obtain assistance data from :ref:`lib_nrf_cloud` to be used with the nRF91 Series SiPs.
 
 .. _gnss_int_assistance_need: