bootimg
=======

Documentation for the ``bootimg`` command and its subcommands.


.. raw:: html

    <!-- spacer -->

.. dropdown:: ``bootimg`` — Prepare a bootable image for the SiMa DevKit.
    :animate: fade-in
    :color: secondary
    :open:

    **Full Help:**

    .. code-block:: text

        Usage:  [OPTIONS]
        
          Prepare a bootable image for the SiMa DevKit.
        
          This command downloads the specified firmware version and prepares a
          removable boot medium (SD card or USB) or configures a TFTP-based network
          boot environment. It supports both MLSoC- and Modalix-based DevKits, as well
          as Yocto and eLxr firmware types.
        
          Operations Performed:
        
            • Download the correct firmware bundle for the selected version
        
            • Build a bootable disk image (SD/USB) OR configure TFTP netboot
        
            • (Optional) Boot the DevKit over the network and flash internal eMMC
            storage (use `f` command)
        
            • Support for internal/testing rootfs overrides (`--rootfs`)
        
          Typical Use Cases:
        
              • Flashing a new firmware version to an SD card
        
              • Setting up a fast development loop using TFTP netboot
        
              • Preparing an eLxr-based bring-up image for Modalix DevKits
        
              • Automating eMMC flashing over the network
        
          Examples:
        
              # Write an SD card image for an MLSoC DevKit
        
              sima-cli bootimg -v 1.6.0 --boardtype mlsoc
        
              # Set up netboot for a Modalix DevKit
        
              sima-cli bootimg -v 1.6.0 --boardtype modalix --netboot
        
              # Prepare an eLxr netboot image for Modalix
        
              sima-cli bootimg -v 2.0.0 --boardtype modalix --fwtype elxr --netboot
        
        Options:
          -v, --version TEXT              Firmware version to download and write
                                          (e.g., 1.6.0)  [required]
          -b, --boardtype [modalix|mlsoc]
                                          Target board type.  [default: mlsoc]
          -t, --fwtype [yocto|elxr]       Target firmware type.  [default: yocto]
          -n, --netboot                   Prepare image for network boot and launch
                                          TFTP server.
          -r, --rootfs TEXT               Custom root fs folders (internal use only)
          -a, --autoflash                 Net boot the DevKit and automatically flash
                                          the internal storage - TBD
          --help                          Show this message and exit.

    **Usage:**

    .. code-block:: bash

        Usage:  [OPTIONS]


Options
-------

.. list-table::
   :widths: 30 70
   :header-rows: 1

   * - **Option**
     - **Description**
   * - ``-v, --version``
     - Firmware version to download and write (e.g., 1.6.0) (required)
   * - ``-b, --boardtype``
     - Target board type. [default: mlsoc]
   * - ``-t, --fwtype``
     - Target firmware type. [default: yocto]
   * - ``-n, --netboot``
     - Prepare image for network boot and launch TFTP server.
   * - ``-r, --rootfs``
     - Custom root fs folders (internal use only)
   * - ``-a, --autoflash``
     - Net boot the DevKit and automatically flash the internal storage - TBD