.. _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
.. include:: ../blocks/elxr_conversion_note.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 DevKit

      Developers can run ``sima-cli`` directly on the standalone DevKit to update the device. Ensure the DevKit has an active Internet connection, then execute:

      .. code-block:: console

         modalix:~$ sima-cli update

      On MLSoC running Yocto Linux, developers may also specify a full URL instead of a version string if they have previously downloaded and hosted the image themselves.

      .. code-block:: console

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

   .. tab:: From Host Machine

      .. note::

         This method is only supported on the MLSoC platform running Yocto. For Modalix devices running eLxr Linux, perform the update directly on the DevKit.

      Use this command from the host machine:

      .. code-block:: console

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

      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:: 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.