.. _http_full_modem_update_sample:

nRF9160: HTTP full modem update
###############################

.. contents::
   :local:
   :depth: 2

The HTTP full modem update sample shows how to perform a full firmware update of the modem.
The sample downloads the modem firmware signed by Nordic Semiconductor and updates the firmware.

Requirements
************

The sample supports the following development kit, version 0.14.0 or higher:

.. table-from-sample-yaml::

.. include:: /includes/tfm.txt

On the nRF9160 DK, set the control signal from the nRF52840 board controller MCU (**P0.19**) to *high* to let the nRF9160 communicate with the external flash memory.
Enable the ``external_flash_pins_routing`` node in devicetree.
See :ref:`zephyr:nrf9160dk_board_controller_firmware` for details on building the firmware for the nRF52840 board controller MCU.

Overview
********

An |external_flash_size| of free space is required to perform a full modem update.
Hence, only versions 0.14.0 and later of the nrf9160 DK support this sample as the earlier versions do not have any external flash memory.

The sample proceeds as follows:

1. It connects to a remote HTTP server to download a signed version of the modem firmware, using the :ref:`lib_fota_download` library.
#. It writes the modem firmware to the external flash memory.
#. It prevalidates the update if the firmware supports the prevalidation process.
#. It then programs the update to the modem, using the :ref:`lib_fmfu_fdev` library.

The current version of this sample downloads two different versions of the firmware, namely 1.3.0 and 1.3.1.
The sample then selects the version which is currently not installed.

Configuration
*************

|config|

Configuration options
=====================

You can customize the firmware files downloaded by the sample through the following Kconfig options in the :file:`prj.conf` file:

.. _CONFIG_DOWNLOAD_HOST:

CONFIG_DOWNLOAD_HOST
   Sets the hostname of the server where the updates are located.

.. _CONFIG_DOWNLOAD_MODEM_0_FILE:

CONFIG_DOWNLOAD_MODEM_0_FILE
   Sets the file name of the first firmware.
   It supports files encoded in the serialized :file:`.cbor` format.
   See :ref:`lib_fmfu_fdev_serialization` for additional information.

.. _CONFIG_DOWNLOAD_MODEM_0_VERSION:

CONFIG_DOWNLOAD_MODEM_0_VERSION
   Sets the version of the first firmware.

.. _CONFIG_DOWNLOAD_MODEM_1_FILE:

CONFIG_DOWNLOAD_MODEM_1_FILE
   Sets the file name of the second firmware.
   It supports files encoded in the serialized :file:`.cbor` format.
   See :ref:`lib_fmfu_fdev_serialization` for additional information.

Building and running
********************

.. |sample path| replace:: :file:`samples/nrf9160/http_update/full_modem_update`

.. include:: /includes/build_and_run_ns.txt

Testing
=======

|test_sample|

1. Start the application and wait for a prompt for pressing a button.
#. Press the button or type "download" in the terminal emulator to start the update procedure.
#. Once the download has completed, the modem update procedure begins automatically.
#. Press the **Reset** button or type "reset" in the terminal emulator to reset the development kit.
#. Observe that the LED pattern has changed.

Dependencies
************

This sample uses the following |NCS| libraries:

* :ref:`lib_fota_download`
* :ref:`lib_dfu_target`
* :ref:`lib_dfu_target_full_modem_update`
* :ref:`lib_fmfu_fdev`

It uses the following `sdk-nrfxlib`_ library:

* :ref:`nrfxlib:nrf_modem`

It also uses the following Zephyr libraries:

  * :ref:`zephyr:flash_api`
  * :ref:`zephyr:logging_api`
  * :ref:`zephyr:gpio_api`
  * :ref:`zephyr:shell_api`

In addition, it uses the following secure firmware component:

* :ref:`Trusted Firmware-M <ug_tfm>`