Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
4 changes: 2 additions & 2 deletions doc/nrf/app_dev/device_guides/nrf91/nrf91_building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ To perform a FOTA update, complete the following steps:
In its default configuration, the DFU target library is set to support all the types of FOTA updates except full modem firmware updates, but you can freely enable or disable the support for specific targets.
In addition, the following requirements apply:

* To upgrade the application, you must use :doc:`mcuboot:index-ncs` as the upgradable bootloader (:kconfig:option:`CONFIG_BOOTLOADER_MCUBOOT` must be enabled).
* If you want to upgrade the upgradable bootloader, you must use the :ref:`bootloader` (:kconfig:option:`CONFIG_SECURE_BOOT` must be enabled).
* To upgrade the application, you must use :doc:`mcuboot:index-ncs` as the upgradable bootloader (:kconfig:option:`SB_CONFIG_BOOTLOADER_MCUBOOT` must be enabled).
* If you want to upgrade the upgradable bootloader, you must use the :ref:`bootloader` (:kconfig:option:`SB_CONFIG_SECURE_BOOT_APPCORE` must be enabled).
* If you want to update the modem firmware through modem delta updates, you do not need to use MCUboot or the immutable bootloader, because the modem firmware update is handled by the modem itself.
* If you want to perform a full modem firmware update, an |external_flash_size| is required.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,214 +9,4 @@ Updating the DK firmware using Programmer
:depth: 2

Updating the firmware for nRF91 Series devices involves several key steps to ensure the device operates with the latest features, improvements, and security updates.
Before you begin to update the firmware, download and extract the latest application and modem firmware from the `nRF9151 DK Downloads`_, `nRF9161 DK Downloads`_, or `nRF9160 DK Downloads`_ page, depending on the DK you are using.

The downloaded ZIP archive contains the following firmware:

Application firmware
The :file:`img_app_bl` folder contains full firmware images for different applications.
The guides in this section use the image for the :ref:`nrf_cloud_multi_service` sample as an example.
The nRF Cloud multi-service sample simulates sensor data and transmits it to Nordic Semiconductor's cloud solution, `nRF Cloud`_.

The data is transmitted using either LTE-M or NB-IoT.
The nRF Cloud multi-service sample first attempts to use LTE-M, then NB-IoT.
Check with your SIM card provider for the mode they support at your location.

.. tabs::

.. group-tab:: nRF9151 DK

* For the Onomondo SIM card, check the `Onomondo LTE-M coverage`_ and `Onomondo NB-IoT coverage`_ to see if your country is supported.

* For the Wireless Logic SIM card, check the `Wireless Logic LTE-M/NB-IoT network coverage`_ to see if your country is supported.

.. group-tab:: nRF9161 DK

For the Onomondo SIM card, check the `Onomondo LTE-M coverage`_ and `Onomondo NB-IoT coverage`_ to see the network coverage for different countries.

.. group-tab:: nRF9160 DK

For the iBasis SIM card provided with the nRF9160 DK, see `iBasis IoT network coverage`_.

Application firmware for Device Firmware Update (DFU)
The images in the :file:`img_fota_dfu_bin` and :file:`img_fota_dfu_hex` folders contain firmware images for DFU.
These images are not used in the guides in this section.

Modem firmware
The modem firmware is in a ZIP archive instead of a folder.
The archive is named :file:`mfw_nrf9160_` or :file:`mfw_nrf91x1_`, followed by the firmware version number.
Do not unzip this file.

The :file:`CONTENTS.txt` file in the extracted folder contains the location and names of the different firmware images.

Complete the steps in the following sections to program applications using the `Programmer app`_ from `nRF Connect for Desktop`_.
The nRF Connect for Desktop requires `SEGGER J-Link`_ |jlink_ver|.

* On Windows, the driver comes bundled with nRF Connect for Desktop.
* On macOS and Linux, you must install the driver manually.

See the `nRF Connect for Desktop's additional requirements`_ section for more details on the SEGGER J-Link driver.

You will also need the following USB cables:

* nRF91x1 DK - USB-C cable
* nRF9160 DK - micro-USB cable

.. _nrf9161_updating_fw_modem:
.. _nrf9160_updating_fw_modem:
.. _nrf9160_gs_updating_fw_modem:

Updating the modem firmware
***************************

To update the modem firmware, complete the following steps.

.. tip::
If you experience any problems during the process, press ``Ctrl+R`` (``command+R`` on macOS) to restart the Programmer app and try again.

1. Open the Programmer app.
#. For the nRF9160 DK only: Make sure the **PROG/DEBUG SW10** switch on the nRF9160 DK is set to **nRF91**.
On DK v0.9.0 and earlier, this is the **SW5** switch.
#. Connect the DK to the computer with a USB cable, and then turn the DK on.
#. Click :guilabel:`SELECT DEVICE` and select the DK from the drop-down list.

.. tabs::

.. group-tab:: nRF91x1 DK

.. figure:: images/programmer_select_device_nrf9151.png
:alt: Programmer - Select device (nRF9151 DK shown)

Programmer - Select device (nRF9151 DK shown)

.. group-tab:: nRF9160 DK

.. figure:: images/programmer_selectdevice_nrf9160.png
:alt: Programmer - Select device

Programmer - Select device

The drop-down text changes to the type of the selected device, with its SEGGER ID below the name.
The **Device memory layout** section also changes its name to the device name, and indicates that the device is connected.
If the :guilabel:`Auto read memory` option is selected in the **J-LINK SETTINGS** section of the side panel, the memory layout will update.
If it is not selected and you wish to see the memory layout, click :guilabel:`Read` in the **DEVICE** section of the side panel.

#. Click :guilabel:`Add file` in the **FILE** section, and select :guilabel:`Browse`.
#. Navigate to where you extracted the firmware, and select the file for your DK:

* nRF9160 DK - :file:`mfw_nrf9160_<version-number>.zip`
* nRF91x1 DK - :file:`mfw_nrf91x1_<version-number>.zip`

#. Click :guilabel:`Write` in the **DEVICE** section of the side panel.

.. tabs::

.. group-tab:: nRF91x1 DK

.. figure:: images/programmer_hex_write_nrf9151.png
:alt: Programmer - Write (nRF9151 DK shown)

Programmer - Write (nRF9151 DK shown)

.. group-tab:: nRF9160 DK

.. figure:: images/programmer_write_nrf9160dk.png
:alt: Programmer - Write

Programmer - Write

The **Modem DFU** window appears.

.. tabs::

.. group-tab:: nRF91x1 DK

.. figure:: images/programmerapp_modemdfu_nrf9151.png
:alt: Modem DFU window (nRF9151 DK shown)

The Modem DFU window (nRF9151 DK shown)

.. group-tab:: nRF9160 DK

.. figure:: images/programmerapp_modemdfu.png
:alt: Modem DFU window

The Modem DFU window

#. Ignore the warning message and click the :guilabel:`Write` button in the **Modem DFU** window to update the firmware.
Do not unplug or turn off the device during this process.

When the update is complete, you see a success message.
If you update the application firmware now, you can skip the initial steps about connecting and selecting the device in :ref:`nrf9160_updating_fw_application`.

.. note::

If you experience problems updating the modem firmware, click :guilabel:`Erase all` in the **DEVICE** section of the side panel and try updating again.

.. _nrf9161_updating_fw_application:
.. _nrf9160_updating_fw_application:
.. _nrf9160_gs_updating_fw_application:

Updating the application firmware
*********************************

To update the application firmware using the Programmer app, complete the following steps.

.. tip::
If you experience any problems during the process, press ``Ctrl+R`` (``command+R`` on macOS) to restart the Programmer app and try again.

1. Open the Programmer app.
#. For the nRF9160 DK only: Make sure the **PROG/DEBUG SW10** switch (**SW5** on DK v0.9.0 and earlier) on the nRF9160 DK is set to **nRF91** or **nRF52** as appropriate for the application or sample you are programming.
See the `Device programming section in the nRF9160 DK User Guide`_ for more information.

For the :ref:`nrf_cloud_multi_service` sample, the switch must be set to **nRF91**.

#. Connect the DK to the computer with a USB cable, and then turn the DK on.
#. Click :guilabel:`SELECT DEVICE` and select the DK from the drop-down list.

.. tabs::

.. group-tab:: nRF91x1 DK

.. figure:: images/programmer_select_device_nrf9151.png
:alt: Programmer - Select device (nRF9151 DK shown)

Programmer - Select device (nRF9151 DK shown)

.. group-tab:: nRF9160 DK

.. figure:: images/programmer_selectdevice_nrf9160.png
:alt: Programmer - Select device

Programmer - Select device

The drop-down text changes to the type of the selected device, with its SEGGER ID below the name.
The **Device memory layout** section also changes its name to the device name, and indicates that the device is connected.
If the :guilabel:`Auto read memory` option is selected in the **J-LINK SETTINGS** section, the memory layout will update.
If it is not selected and you wish to see the memory layout, click :guilabel:`Read` in the **DEVICE** section.

#. Click :guilabel:`Add file` in the **FILE** section, and select :guilabel:`Browse`.
#. Navigate to where you extracted the firmware, and then to the :file:`img_app_bl` folder there.
#. Select the :file:`.hex` file for your DK for the application you are programming:

* nRF9160 DK - :file:`nrf9160dk_nrfcloud_multi_service_coap_<version-number>.hex`
* nRF91x1 DK - :file:`nrf9151dk_nrfcloud_multi_service_coap_<version-number>.hex` or :file:`nrf9161dk_nrfcloud_multi_service_coap_<version-number>.hex`

#. Click the :guilabel:`Erase & write` button in the **DEVICE** section to program the DK.
Do not unplug or turn off the DK during this process.

.. tabs::

.. group-tab:: nRF91x1 DK

.. figure:: images/programmer_erasewrite_nrf9151dk.png
:alt: Programmer - Erase & write (nRF9151 DK shown)

Programmer - Erase & write (nRF9151 DK shown)

.. group-tab:: nRF9160 DK

.. figure:: images/programmer_erasewrite_nrf9160dk.png
:alt: Programmer - Erase & write

Programmer - Erase & write
To update the firmware on an mRF91 Series DK using the `Programmer app`_ in nRF Connect for Desktop, complete the steps listed on the `Programming nRF91 Series DK firmware`_ page in the tool documentation.
2 changes: 1 addition & 1 deletion doc/nrf/app_dev/device_guides/nrf91/nrf91_features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Full update
Both methods use the :term:`Serial Wire Debug (SWD)` interface to update the firmware.

You can use the Programmer app to perform the update, regardless of the images that are part of the existing firmware of the device.
For example, you can update the modem on an nRF9160 DK using the instructions provided in the :ref:`nrf9160_updating_fw_modem` section.
For example, you can update the modem on an nRF9160 DK using the instructions provided in the `Programming nRF91 Series DK firmware`_ page.

* When using a wireless connection, the update is applied over-the-air (OTA).
See :ref:`nrf91_fota` for more information.
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/app_dev/device_guides/nrf91/nrf91_testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can use it to troubleshoot and debug any connection problems.

Complete the following steps to test the cellular connection using the AT Client sample:

1. Follow the steps in :ref:`nrf9160_gs_updating_fw_application` to program the sample to the DK.
1. Follow the steps in the Updating the application firmware tab in the `Programming nRF91 Series DK firmware`_ page to program the sample to the DK.
When selecting the HEX file, select the following file instead of the one for :ref:`nrf_cloud_multi_service`:

* nRF9151 DK - :file:`nrf9151dk_at_client_<version-number>.hex`
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/includes/cert-flashing.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
To provision the certificates and the private key to the nRF91 Series modem, complete the following steps:

1. `Download nRF Connect for Desktop`_.
#. Update the modem firmware on the onboard modem of the nRF91 Series device to the latest version by following the steps in :ref:`nrf9160_gs_updating_fw_modem`.
#. Update the modem firmware on the onboard modem of the nRF91 Series device to the latest version by following the steps in the `Programming nRF91 Series DK firmware`_ page.
#. Build and program the :ref:`at_client_sample` sample to the nRF91 Series device as explained in :ref:`building` and :ref:`programming`.
#. Launch the `Cellular Monitor app`_ in `nRF Connect for Desktop`_.
#. Click :guilabel:`CERTIFICATE MANAGER` located at the upper right corner.
Expand Down
6 changes: 3 additions & 3 deletions doc/nrf/includes/nrf_cloud_rest_sample_requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ For an nRF91x1 DK, modem version v2.0.0 or later is required.

For instructions on updating your device's modem firmware, see the following documents:

* :ref:`Updating modem firmware on nRF91x1 DK <nrf9161_updating_fw_modem>`
* :ref:`Updating modem firmware on nRF9160 DK <nrf9160_gs_updating_fw_modem>`
* :ref:`Updating modem firmware on Thingy:91 <programming_thingy>`
* `Updating modem firmware on nRF91x1 DK <Programming nRF91 Series DK firmware_>`_
* `Updating modem firmware on nRF9160 DK <Programming nRF91 Series DK firmware_>`_
* `Updating modem firmware on Thingy:91 <Programming Nordic Thingy prototyping platforms_>`_

.. requirement_cert_provision_start

Expand Down
4 changes: 1 addition & 3 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -452,8 +452,6 @@

.. _`Nordic Semiconductor TechDocs`: https://docs.nordicsemi.com

.. _`nRF Connect for Desktop's additional requirements`: https://docs.nordicsemi.com/bundle/nrf-connect-desktop/page/download_cfd.html#additional-requirements

.. _`nRF Connect SDK v1.4.0 documentation`: https://docs.nordicsemi.com/bundle/ncs-1.4.0/page/nrf/index.html
.. _`nRF Connect SDK v1.3.0 documentation`: https://docs.nordicsemi.com/bundle/ncs-1.3.0/page/nrf/index.html
.. _`nRF Connect SDK v1.2.1 documentation`: https://docs.nordicsemi.com/bundle/ncs-1.2.1/page/nrf/index.html
Expand Down Expand Up @@ -744,6 +742,7 @@
.. _`Programming a Development Kit`: https://docs.nordicsemi.com/bundle/nrf-connect-programmer/page/programming_dk.html
.. _`Programming Nordic Thingy53`:
.. _`Programming Nordic Thingy prototyping platforms`: https://docs.nordicsemi.com/bundle/nrf-connect-programmer/page/programming_thingy.html
.. _`Programming nRF91 Series DK firmware`: https://docs.nordicsemi.com/bundle/nrf-connect-programmer/page/programming_91dk.html

.. _`Serial Terminal app`: https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/index.html
.. _`Connecting using the Serial Terminal app`: https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/connecting.html
Expand Down Expand Up @@ -779,7 +778,6 @@
.. _`nRF9160 DK board control section in the nRF9160 DK User Guide`: https://docs.nordicsemi.com/bundle/ug_nrf9160_dk/page/UG/nrf91_DK/hw_description/nrf9160_board_controller.html
.. _`Measuring current on nRF9160 DK`: https://docs.nordicsemi.com/bundle/ug_nrf9160_dk/page/UG/nrf91_DK/measuring_current/hw_measure_current.html
.. _`External memory section in the nRF9160 DK User Guide`: https://docs.nordicsemi.com/bundle/ug_nrf9160_dk/page/UG/nrf91_DK/hw_description/external_memory.html
.. _`Device programming section in the nRF9160 DK User Guide`: https://docs.nordicsemi.com/bundle/ug_nrf9160_dk/page/UG/nrf91_DK/operating_modes/mcu_device_programming.html
.. _`VDD supply rail section in the nRF9160 DK User Guide`: https://docs.nordicsemi.com/bundle/ug_nrf9160_dk/page/UG/nrf91_DK/hw_description/power_sources_vdd.html
.. _`nRF9160 RESETREAS`: https://docs.nordicsemi.com/bundle/ps_nrf9160/page/power.html#ariaid-title16

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Supported modem firmware
* mfw_nrf9160_1.1.0

Use the nRF Programmer app of `nRF Connect for Desktop`_ to update the modem firmware.
See :ref:`nrf9160_gs_updating_fw_modem` for instructions.
See the `Programming nRF91 Series DK firmware` page for instructions.


Supported boards
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This version of the |NCS| supports the following modem firmware for cellular IoT
* mfw_nrf9160_1.1.1

Use the nRF Programmer app of `nRF Connect for Desktop`_ to update the modem firmware.
See :ref:`nrf9160_gs_updating_fw_modem` for instructions.
See the `Programming nRF91 Series DK firmware` page for instructions.

Tested boards
*************
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ This version of the |NCS| supports the following modem firmware for cellular IoT
* mfw_nrf9160_1.1.2

Use the nRF Programmer app of `nRF Connect for Desktop`_ to update the modem firmware.
See :ref:`nrf9160_gs_updating_fw_modem` for instructions.
See the `Programming nRF91 Series DK firmware` page for instructions.

Tested boards
*************
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ This version of the |NCS| has been tested with the following modem firmware for
* mfw_nrf9160_1.2.0

Use the latest version of the nRF Programmer app of `nRF Connect for Desktop`_ to update the modem firmware.
See :ref:`nrf9160_gs_updating_fw_modem` for instructions.
See the `Programming nRF91 Series DK firmware` page for instructions.

Changelog
*********
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ This version of the |NCS| has been tested with the following modem firmware for
* mfw_nrf9160_1.2.1

Use the latest version of the nRF Programmer app of `nRF Connect for Desktop`_ to update the modem firmware.
See :ref:`nrf9160_gs_updating_fw_modem` for instructions.
See the `Programming nRF91 Series DK firmware` page for instructions.

Changelog
*********
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ This version of the |NCS| has been tested with the following modem firmware for
* mfw_nrf9160_1.2.1

Use the latest version of the nRF Programmer app of `nRF Connect for Desktop`_ to update the modem firmware.
See :ref:`nrf9160_gs_updating_fw_modem` for instructions.
See the `Programming nRF91 Series DK firmware` page for instructions.

Changelog
*********
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ This version of the |NCS| has been tested with the following modem firmware for
* mfw_nrf9160_1.2.2

Use the latest version of the nRF Programmer app of `nRF Connect for Desktop`_ to update the modem firmware.
See :ref:`nrf9160_gs_updating_fw_modem` for instructions.
See the `Programming nRF91 Series DK firmware` page for instructions.

Changelog
*********
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ This version of the |NCS| has been tested with the following modem firmware for
* mfw_nrf9160_1.2.2

Use the latest version of the nRF Programmer app of `nRF Connect for Desktop`_ to update the modem firmware.
See :ref:`nrf9160_gs_updating_fw_modem` for instructions.
See the `Programming nRF91 Series DK firmware` page for instructions.

Changelog
*********
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ This version of the |NCS| has been tested with the following modem firmware for
* mfw_nrf9160_1.2.3

Use the latest version of the nRF Programmer app of `nRF Connect for Desktop`_ to update the modem firmware.
See :ref:`nrf9160_gs_updating_fw_modem` for instructions.
See the `Programming nRF91 Series DK firmware` page for instructions.

Changelog
*********
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ This version of the |NCS| has been tested with the following modem firmware for


Use the latest version of the nRF Programmer app of `nRF Connect for Desktop`_ to update the modem firmware.
See :ref:`nrf9160_gs_updating_fw_modem` for instructions.
See the `Programming nRF91 Series DK firmware` page for instructions.

Changelog
*********
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ This version of the |NCS| has been tested with the following modem firmware for


Use the latest version of the nRF Programmer app of `nRF Connect for Desktop`_ to update the modem firmware.
See :ref:`nrf9160_gs_updating_fw_modem` for instructions.
See the `Programming nRF91 Series DK firmware` page for instructions.

Changelog
*********
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ This version of the |NCS| has been tested with the following modem firmware for
* mfw_nrf9160_1.1.4

Use the latest version of the nRF Programmer app of `nRF Connect for Desktop`_ to update the modem firmware.
See :ref:`nrf9160_gs_updating_fw_modem` for instructions.
See the `Programming nRF91 Series DK firmware` page for instructions.

Changelog
*********
Expand Down
Loading
Loading