Skip to content

Commit 3d96c5d

Browse files
nordicjmanangl
nordicjm
authored and
anangl
committed
doc: nrf: config: Add sysbuild forced options page
Adds a page documenting Kconfig options that sysbuild controls Signed-off-by: Jamie McCrae <[email protected]>
1 parent 922d673 commit 3d96c5d

File tree

2 files changed

+107
-0
lines changed

2 files changed

+107
-0
lines changed

‎doc/nrf/config_and_build/configuring_app/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,5 +78,6 @@ Just as for creating the application, you can build the application using either
7878
output_build_files
7979
sysbuild_images
8080
zephyr_samples_sysbuild
81+
sysbuild_forced_options
8182

8283
.. |output_files_note| replace:: For more information about files generated as output of the build process, see :ref:`app_build_output_files`.

‎doc/nrf/config_and_build/configuring_app/sysbuild_forced_options.rst‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
.. _sysbuild_forced_options:
2+
3+
Sysbuild forced options
4+
#######################
5+
6+
Sysbuild controls some Kconfig options in images that are part of a project, this means that these Kconfig options can only be changed from within sysbuild itself and cannot be changed directly in an image (doing so will result in the new value being overwritten with the sysbuild value).
7+
8+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+----------------------+
9+
| Kconfig | Sysbuild Kconfig | Image(s) |
10+
+=========================================================================+===========================================================================+======================+
11+
| :kconfig:option:`CONFIG_PARTITION_MANAGER_ENABLED` + :kconfig:option:`SB_CONFIG_PARTITION_MANAGER` | All |
12+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
13+
| :kconfig:option:`CONFIG_BUILD_OUTPUT_BIN` + :kconfig:option:`SB_CONFIG_BUILD_OUTPUT_BIN` | |
14+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
15+
| :kconfig:option:`CONFIG_BUILD_OUTPUT_HEX` + :kconfig:option:`SB_CONFIG_BUILD_OUTPUT_HEX` | |
16+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+----------------------+
17+
| :kconfig:option:`CONFIG_BT_FAST_PAIR` + :kconfig:option:`SB_CONFIG_BT_FAST_PAIR` | Main application |
18+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
19+
| :kconfig:option:`CONFIG_WIFI_NRF700X` + :kconfig:option:`SB_CONFIG_WIFI_NRF700X` | |
20+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
21+
| :kconfig:option:`CONFIG_NRF_WIFI_PATCHES_EXT_FLASH_DISABLED` + :kconfig:option:`SB_CONFIG_WIFI_PATCHES_EXT_FLASH_DISABLED` | |
22+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
23+
| :kconfig:option:`CONFIG_NRF_WIFI_PATCHES_EXT_FLASH_XIP` + :kconfig:option:`SB_CONFIG_WIFI_PATCHES_EXT_FLASH_XIP` | |
24+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
25+
| :kconfig:option:`CONFIG_NRF_WIFI_PATCHES_EXT_FLASH_STORE` + :kconfig:option:`SB_CONFIG_WIFI_PATCHES_EXT_FLASH_STORE` | |
26+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
27+
| :kconfig:option:`CONFIG_NRF700X_SYSTEM_MODE` + :kconfig:option:`SB_CONFIG_WIFI_NRF700X_SYSTEM_MODE` | |
28+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
29+
| :kconfig:option:`CONFIG_NRF700X_SCAN_ONLY` + :kconfig:option:`SB_CONFIG_WIFI_NRF700X_SCAN_ONLY` | |
30+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
31+
| :kconfig:option:`CONFIG_NRF700X_RADIO_TEST` + :kconfig:option:`SB_CONFIG_WIFI_NRF700X_RADIO_TEST` | |
32+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
33+
| :kconfig:option:`CONFIG_NRF700X_SYSTEM_WITH_RAW_MODES` + :kconfig:option:`SB_CONFIG_WIFI_NRF700X_SYSTEM_WITH_RAW_MODES` | |
34+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
35+
| :kconfig:option:`CONFIG_NRF_WIFI_FW_PATCH_DFU` + :kconfig:option:`SB_CONFIG_DFU_MULTI_IMAGE_PACKAGE_WIFI_FW_PATCH` | |
36+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
37+
| :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_SINGLE_APP` + :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_SINGLE_APP` | |
38+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
39+
| :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_SWAP_WITHOUT_SCRATCH` + :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_SWAP_WITHOUT_SCRATCH` | |
40+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
41+
| :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_SWAP_SCRATCH` + :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_SWAP_SCRATCH` | |
42+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
43+
| :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_OVERWRITE_ONLY` + :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_OVERWRITE_ONLY` | |
44+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
45+
| :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP` + :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP` | |
46+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
47+
| :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_DIRECT_XIP_WITH_REVERT` + :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP_WITH_REVERT` | |
48+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
49+
| :kconfig:option:`CONFIG_MCUBOOT_BOOTLOADER_MODE_FIRMWARE_UPDATER` + :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_FIRMWARE_UPDATER` | |
50+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
51+
| :kconfig:option:`CONFIG_MCUBOOT_HARDWARE_DOWNGRADE_PREVENTION` + :kconfig:option:`SB_CONFIG_MCUBOOT_HARDWARE_DOWNGRADE_PREVENTION` | |
52+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
53+
| :kconfig:option:`CONFIG_MCUBOOT_HW_DOWNGRADE_PREVENTION_COUNTER_SLOTS` + :kconfig:option:`SB_CONFIG_MCUBOOT_HW_DOWNGRADE_PREVENTION_COUNTER_SLOTS` | |
54+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
55+
| :kconfig:option:`CONFIG_MCUBOOT_HW_DOWNGRADE_PREVENTION_COUNTER_VALUE` + :kconfig:option:`SB_CONFIG_MCUBOOT_HW_DOWNGRADE_PREVENTION_COUNTER_VALUE` | |
56+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
57+
| :kconfig:option:`CONFIG_UPDATEABLE_IMAGE_NUMBER` + :kconfig:option:`SB_CONFIG_SB_CONFIG_MCUBOOT_UPDATEABLE_IMAGES` if | |
58+
| + :kconfig:option:`SB_CONFIG_MCUBOOT_APP_SYNC_UPDATEABLE_IMAGES` is enabled | |
59+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
60+
| :kconfig:option:`CONFIG_CHIP` + :kconfig:option:`SB_CONFIG_MATTER` | |
61+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
62+
| :kconfig:option:`CONFIG_CHIP_OTA_REQUESTOR` + :kconfig:option:`SB_CONFIG_MATTER_OTA` | |
63+
+-------------------------------------------------------------------------+ | |
64+
| :kconfig:option:`CONFIG_CHIP_OTA_IMAGE_BUILD` + | |
65+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
66+
| :kconfig:option:`CONFIG_SUIT_MPI_APP_RECOVERY` + :kconfig:option:`SB_CONFIG_SUIT_BUILD_RECOVERY` | |
67+
+-------------------------------------------------------------------------+ | |
68+
| :kconfig:option:`CONFIG_SUIT_MPI_RAD_RECOVERY` + | |
69+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+----------------------+
70+
| :kconfig:option:`CONFIG_SINGLE_APPLICATION_SLOT` + :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_SINGLE_APP` | MCUboot |
71+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
72+
| :kconfig:option:`CONFIG_BOOT_SWAP_USING_MOVE` + :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_SWAP_WITHOUT_SCRATCH` | |
73+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
74+
| :kconfig:option:`CONFIG_BOOT_SWAP_USING_SCRATCH` + :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_SWAP_SCRATCH` | |
75+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
76+
| :kconfig:option:`CONFIG_BOOT_UPGRADE_ONLY` + :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_OVERWRITE_ONLY` | |
77+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
78+
| :kconfig:option:`CONFIG_BOOT_DIRECT_XIP` + :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP` | |
79+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
80+
| :kconfig:option:`CONFIG_BOOT_DIRECT_XIP_REVERT` + :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_DIRECT_XIP_WITH_REVERT` | |
81+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
82+
| :kconfig:option:`CONFIG_BOOT_FIRMWARE_LOADER` + :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_FIRMWARE_UPDATER` | |
83+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
84+
| :kconfig:option:`CONFIG_PCD_APP` + :kconfig:option:`SB_CONFIG_NETCORE_APP_UPDATE` | |
85+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
86+
| :kconfig:option:`CONFIG_UPDATEABLE_IMAGE_NUMBER` + :kconfig:option:`SB_CONFIG_SB_CONFIG_MCUBOOT_UPDATEABLE_IMAGES` | |
87+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+----------------------+
88+
| :kconfig:option:`CONFIG_MCUBOOT_HW_DOWNGRADE_PREVENTION` + :kconfig:option:`SB_CONFIG_MCUBOOT_HARDWARE_DOWNGRADE_PREVENTION` | |
89+
+-------------------------------------------------------------------------+ | |
90+
| :kconfig:option:`CONFIG_SECURE_BOOT_STORAGE` + | |
91+
+-------------------------------------------------------------------------+ | |
92+
| :kconfig:option:`CONFIG_SECURE_BOOT_CRYPTO` + | |
93+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
94+
| :kconfig:option:`CONFIG_PM_EXTERNAL_FLASH_MCUBOOT_SECONDARY` + :kconfig:option:`SB_CONFIG_PM_EXTERNAL_FLASH_MCUBOOT_SECONDARY` | Main application, |
95+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ MCUboot |
96+
| :kconfig:option:`CONFIG_PM_OVERRIDE_EXTERNAL_DRIVER_CHECK` + :kconfig:option:`SB_CONFIG_PM_OVERRIDE_EXTERNAL_DRIVER_CHECK` | |
97+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+ |
98+
| :kconfig:option:`CONFIG_FW_INFO` + :kconfig:option:`SB_CONFIG_SECURE_BOOT_APPCORE` | |
99+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+----------------------+
100+
| :kconfig:option:`CONFIG_NCS_MCUBOOT_IN_BUILD` + :kconfig:option:`SB_CONFIG_BOOTLOADER_MCUBOOT` | b0, |
101+
| + | b0n |
102+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+----------------------+
103+
| :kconfig:option:`CONFIG_SECURE_BOOT` + :kconfig:option:`SB_CONFIG_SECURE_BOOT_APPCORE` or | Main application, |
104+
| + :kconfig:option:`SB_CONFIG_SECURE_BOOT_NETCORE` | Net core main image, |
105+
| + | MCUboot |
106+
+-------------------------------------------------------------------------+---------------------------------------------------------------------------+----------------------+

0 commit comments

Comments
 (0)