.. _sima_cli_update:

Update with sima-cli
---------------------

This method allows developers to update the firmware on a SiMa.ai MLSoC DevKit using the ``sima-cli`` tool. This approach downloads the firmware image to the host machine and transfers it to the DevKit for update.

.. include:: ../blocks/install_sima_cli.rst

Before proceeding, ensure the host machine can reach the DevKit over the network. Refer to:

- :ref:`Standalone Mode Network Setup <setup_standalone_network_cfg>`
- `PCIe Mode Virtual Network Setup <../setup_pcie_mode.html#virtual-network>`_

.. tabs::

   .. tab:: From Host Machine

      Use this command from the host machine:

      .. code-block:: console

         sima-user@sima-user-machine:~$ sima-cli update --ip {ip_address_of_the_devkit} 1.7.0

      This command also installs the appropriate Linux driver version on the host, if applicable.

      If you have downloaded the firmware and hosted somewhere on your network, you can provide the URL to avoid repeatedly downloading from the Internet.

      .. code-block:: console

         sima-user@sima-user-machine:~$ sima-cli update --ip {ip_address_of_the_devkit} http://your-server/image.tar.gz


   .. tab:: From DevKit

      Alternatively, developers can run ``sima-cli`` directly on the standalone DevKit. Ensure the DevKit has an active Internet connection, then execute:

      .. code-block:: console

         davinci:~$ sima-cli update 1.7.0

      Similar to the host update procedure, developers can specify a full URL to replace the version string.

      .. code-block:: console

         davinci:~$ sima-cli update http://your-server/image.tar.gz

   .. tab:: Full vs. Headless

      The Modalix DevKit supports the :ref:`Full <firmware_update>` image flavor. To update the device with the Full image, use the following command:

      .. code-block:: console

         sima-user@sima-user-machine:~$ sima-cli update --ip {ip_address_of_the_devkit} 1.7.0 --flavor full

      If the ``--flavor`` argument is omitted, the update defaults to the **Headless** image. The user can also explicitly specify headless image.

      .. code-block:: console

         sima-user@sima-user-machine:~$ sima-cli update --ip {ip_address_of_the_devkit} 1.7.0 --flavor headless

   .. tab:: Download only

      .. include:: ../blocks/download_mlsoc_firmware_using_simacli.rst

.. note::

   **For PCIe system update:**

   - Starting with firmware version ``1.5``, a virtual Ethernet interface can be used in PCIe mode, eliminating the need for physical cabling to the DevKit. This enables seamless updates over an existing PCIe connection.
   - For firmware version ``1.4`` or earlier, a direct network connection must be established with the DevKit. In this case, connect the DevKit in standalone mode or use the :ref:`Palette-Assisted Update <palette_assisted>` method instead.