.. _palette_assisted:

Update with Palette
--------------------

The **Palette-assisted Update** method allows you to update the DevKit (MLSoC device) firmware using the :ref:`MPK Tool`, which is included in the :ref:`Palette SDK <Palette installation>`.

In this method the system automatically updates the firmware, if needed, once you connect to the device. Before proceeding with the update, the system prompts the user for consent. This method of firmware update is supported in standalone mode and partially in PCIe mode.

Before updating, check if your DevKit is already running using the latest firmware:

        .. code-block:: console

            sima-user@sima-user-machine:~$ ssh sima@<BOARD_IP_ADDRESS> "cat /etc/build"|grep SIMA_BUILD_VERSION
            sima@<BOARD_IP_ADDRESS>'s password: 
    

        ``SIMA_BUILD_VERSION`` should be |var_palette_reqs_mlsoc_fw_version|

If you have this version you can skip the firmware update process.

.. warning::

    - The Palette-assisted update method does not update the tRoot image. Please refer to the :ref:`Direct File Copy <direct_file_copy>` method for updating the tRoot image before proceeding.


.. tabs::

   .. tab:: Standalone Mode Update


        In standalone mode, connect to the DevKit from the MPK tool using its IP address and allow the system to automatically upgrade firmware, if needed. 

        .. code-block:: console 

            sima-user@docker-image-id:/home# mpk device connect -t <BOARD_IP_ADDRESS> -u <USER> -d my_device


   .. tab:: PCIe Mode Update

        .. note::

           - For a PCIe system, you need to first update the DevKit to the desired firmware version before updating the :ref:`Palette SDK <Palette installation>` and `Host Driver <../setup_pcie_mode.html#driver-installation>`_. 
           - Automatic firmware update is not supported in PCIe mode. However, you are able to update the firmware manually with a ``simaai-image-palette-upgrade-davinci.swu`` file.           

        .. include:: ../blocks/download_mlsoc_firmware.rst

        Download the firmware package and extract the ``simaai-image-palette-upgrade-davinci.swu`` file. Move it to the workspace of the Palette SDK. Then, connect to the DevKit in PCIe mode from the MPK tool using the slot number (e.g. ``0``) and execute the firmware upgrade.

        .. code-block:: console 

            sima-user@docker-image-id:/home# mpk device connect -s 0
            sima-user@docker-image-id:/home# mpk firmware-upgrade -f /home/docker/sima-cli/simaai-image-palette-upgrade-davinci.swu -d my_device

    For additional details, refer to the :ref:`mpk firmware-upgrade` command.