.. _atmosic_sysbuild_options:

Atmosic Sysbuild Options
########################

Options of Atmosic Sysbuild is used to simply build options that requires when west build for application or for all images or interactive with Atmosic tools

Options for SPE image
*********************

``SB_CONFIG_SPE`` : To support sysbuild to build with spe image and append ``CONFIG_SPE_PATH`` to options when sysbuild with application automatically.


Options for west atm_arch
*************************

To support generate .atm file automatically.

``SB_CONFIG_ATM_ARCH``: To enable to generate .atm file with all the built images by sysbuild
``SB_CONFIG_ATM_ARCH_ERASE_ALL``: Add erase whole flash and rram command to .atm file
``SB_CONFIG_ATM_ARCH_ERASE_FLASH_ALL``: Add erase whole flash command to .atm file
``SB_CONFIG_ATM_ARCH_ERASE_RRAM_ALL``: Add erase whole rram command to atm isp file

.. note::
   all the options disabled by default. Before enable, to make sure the development environment has satisfied west atm_arch requirements (:ref:`Python Requirements of Atmosic Archive Tool <west_atm_arch-tool>`)


Options for BLE Stack
*********************

To supports options to build images corresponding options of BLE Stack (:ref:`Atmosic BLE Stack <atmosic_ble_stack>`) and checking dependency to append ``-DFIXED_ATMWSTK=<ATMWSTK>`` flags to ``DTS_EXTRA_CPPFLAGS`` automatically.

``SB_CONFIG_ATMWSTK_PD50``: PD50 link controller, corresponding to CONFIG_ATMWSTK_PD50 .
``SB_CONFIG_ATMWSTK_FULL``: Full link controller, corresponding to CONFIG_ATMWSTK_FULL.
``SB_CONFIG_ATMWSTK_CPD200``: CPD200 link controller, corresponding to CONFIG_ATMWSTK_CPD200.


Options for DTS_EXTRA_CPPFLAGS
******************************

The options in ``DTS_EXTRA_CPPFLAGS`` can be passed to sysbuild via ``SB_ATM_DTS_EXTRA_CPPFLAGS``, and all images will have the passed options.


For example:

When using west build for mcuboot, spe, and application, ``DTS_EXTRA_CPPFLAGS="-DATM_STORAGE_SIZE=0x1000;-DDFU_IN_FHASH"`` has to be specified, as below:

.. code-block:: bash

   west build -p -s <MCUBOOT> -b <BOARD>@mcuboot_bl -d build/<BOARD>/<MCUBOOT> -- -DDTS_EXTRA_CPPFLAGS="-DATM_STORAGE_SIZE=0x1000;-DDFU_IN_FLASH"
   west build -p -s <SPE> -b <BOARD>@mcuboot -d build/<BOARD>/<SPE> -- -DCONFIG_BOOTLOADER_MCUBOOT=y -DCONFIG_MCUBOOT_GENERATE_UNSIGNED_IMAGE=n -DDTS_EXTRA_CPPFLAGS="-DATM_STORAGE_SIZE=0x1000;-DDFU_IN_FLASH"
   west build -p -s <APP> -b <BOARD>@mcuboot//ns -d build/<BOARD>_ns/<APP> -- -DCONFIG_BOOTLOADER_MCUBOOT=y -DCONFIG_MCUBOOT_SIGNATURE_KEY_FILE=\"bootloader/mcuboot/root-ec-p256.pem\" -DCONFIG_SPE_PATH=\"<WEST_TOPDIR>/build/<BOARD>/<SPE>\" -DDTS_EXTRA_CPPFLAGS="-DATM_STORAGE_SIZE=0x1000;-DDFU_IN_FLASH"

When using sysbuild, the command could be as below:

Without test item
=================

All related configs appended to build command.

.. code-block:: bash

   west build -p always -b <BOARD>@mcuboot//ns <APP> --sysbuild -- -DSB_CONFIG_BOOTLOADER_MCUBOOT=y -DSB_CONFIG_BOOT_SIGNATURE_TYPE_ECDSA_P256=y -DSB_CONFIG_MCUBOOT_MODE_SWAP_SCRATCH=y \
     -DSB_CONFIG_SPE=y -DSB_ATM_DTS_EXTRA_CPPFLAGS="-DATM_STORAGE_SIZE=0x1000;-DDFU_IN_FLASH" -DCONFIG_MCUBOOT_SIGNATURE_KEY_FILE=\"bootloader/mcuboot/root-ec-p256.pem\"

With test item
==============

The test item of sample.yaml that the application supports, all the related configs will be involved.

.. code-block:: bash

   west build -p always -b <BOARD>@mcuboot//ns <APP> --sysbuild -T <test item of mcuboot>