Skip to content

Commit 5a04025

Browse files
kkasperczyk-noArekBalysNordic
authored andcommitted
doc: Fixed SB configs references in Matter documents
Fixed few references in Matter docs to SB configs that were incorrect. Signed-off-by: Kamil Kasperczyk <[email protected]>
1 parent 3247bd2 commit 5a04025

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

applications/matter_weather_station/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ To build this application to work with the nRF7002 Wi-Fi expansion board:
228228
Generating factory data
229229
=======================
230230

231-
To enable factory data support, you need to select the ``overlay-factory_data`` configuration overlay from the available application :ref:`build configuration overlays <matter_weather_station_app_build_configuration_overlays>`, set the ``SB_CONFIG_MATTER_FACTORY_DATA_GENERATE`` Kconfig option to ``y``, and use the ``factory_data`` file suffix.
231+
To enable factory data support, you need to select the ``overlay-factory_data`` configuration overlay from the available application :ref:`build configuration overlays <matter_weather_station_app_build_configuration_overlays>`, set the :kconfig:option:`SB_CONFIG_MATTER_FACTORY_DATA_GENERATE` Kconfig option to ``y``, and use the ``factory_data`` file suffix.
232232
You can generate new factory data set when building for the given board target by invoking the following command:
233233

234234
.. code-block:: console

doc/nrf/protocols/matter/end_product/bootloader.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ MCUboot uses asymmetric cryptography to validate the authenticity of firmware.
115115
The public key embedded in the bootloader image is used to validate the signature of a firmware image that is about to be booted.
116116
If the signature check fails, MCUboot rejects the image and either:
117117

118-
* rolls back to the last valid firmware image if the fallback recovery has not been disabled using the MCUboot's ``SB_CONFIG_MCUBOOT_MODE_OVERWRITE_ONLY`` Kconfig option.
118+
* rolls back to the last valid firmware image if the fallback recovery has not been disabled using the MCUboot's :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_OVERWRITE_ONLY` Kconfig option.
119119
* fails to boot.
120120

121121
.. note::
@@ -130,7 +130,7 @@ Downgrade protection
130130

131131
The :ref:`downgrade protection <ug_fw_update_image_versions_mcuboot_downgrade>` mechanism makes it impossible for an attacker to trick a user to install a firmware image older than the currently installed one.
132132
The attacker might want to do this to reintroduce old security vulnerabilities that have already been fixed in newer firmware revisions.
133-
You should enable the downgrade protection mechanism if you choose to enable MCUboot's ``SB_CONFIG_MCUBOOT_MODE_OVERWRITE_ONLY`` Kconfig option, which disables the fallback recovery in case of a faulty upgrade.
133+
You should enable the downgrade protection mechanism if you choose to enable MCUboot's :kconfig:option:`SB_CONFIG_MCUBOOT_MODE_OVERWRITE_ONLY` Kconfig option, which disables the fallback recovery in case of a faulty upgrade.
134134

135135
.. _ug_matter_device_bootloader_image_compression:
136136

doc/nrf/protocols/matter/end_product/test_event_triggers.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ The following table lists the available triggers and their activation codes:
100100
- ``0xFFFFFFFF60000000``
101101
- No additional value supported.
102102
* - OTA query
103-
- :kconfig:option:`CONFIG_CHIP_OTA_REQUESTOR` = ``y``, and ``SB_CONFIG_MATTER_OTA`` = ``y``.
103+
- :kconfig:option:`CONFIG_CHIP_OTA_REQUESTOR` = ``y``, and :kconfig:option:`SB_CONFIG_MATTER_OTA` = ``y``.
104104
- Trigger an OTA firmware update.
105105
- ``0x002a000000000100`` - ``0x01000000000001FF``
106106
- The range of ``0x00`` - ``0xFF`` is the fabric index value.
@@ -187,10 +187,10 @@ You cannot set the enable key to a specific value using factory data unless the
187187
If it is not set, the default value ``00112233445566778899AABBCCDDEEFF`` will be used.
188188
For secure operation, you need to ensure that the enable key is unique for all of your devices.
189189

190-
To specify the enable key through the build system, enable the ``SB_CONFIG_MATTER_FACTORY_DATA_GENERATE`` Kconfig option by setting it to ``y``.
190+
To specify the enable key through the build system, enable the :kconfig:option:`SB_CONFIG_MATTER_FACTORY_DATA_GENERATE` Kconfig option by setting it to ``y``.
191191
Then, set the :kconfig:option:`CONFIG_CHIP_DEVICE_ENABLE_KEY` Kconfig option to a 32-byte hexadecimal string value.
192192

193-
If ``SB_CONFIG_MATTER_FACTORY_DATA_GENERATE`` is set to ``n``, you can follow the :doc:`matter:nrfconnect_factory_data_configuration` guide in the Matter documentation to generate the factory data set with the specific enable key value.
193+
If :kconfig:option:`SB_CONFIG_MATTER_FACTORY_DATA_GENERATE` is set to ``n``, you can follow the :doc:`matter:nrfconnect_factory_data_configuration` guide in the Matter documentation to generate the factory data set with the specific enable key value.
194194

195195
If you do not use the |NCS| Matter common module, you need to read the enable key value manually from the factory data set and provide it to the ``TestEventTrigger`` class.
196196

samples/matter/lock/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ You can program a portion of the application code related to the nRF70 Series' W
128128
This option is available only when building for the nRF5340 DK with the nRF7002 EK shield attached.
129129
To prepare an application to use this feature, you need to create additional MCUboot partitions.
130130
To learn how to configure MCUboot partitions, see the :ref:`nrf70_fw_patch_update_adding_partitions` guide.
131-
To enable this feature for Matter, set the ``SB_CONFIG_WIFI_PATCHES_EXT_FLASH_STORE``, ``SB_CONFIG_DFU_MULTI_IMAGE_PACKAGE_WIFI_FW_PATCH`` Kconfig options to ``y``, and set the ``SB_CONFIG_MCUBOOT_UPDATEABLE_IMAGES`` Kconfig option to ``3``.
131+
To enable this feature for Matter, set the :kconfig:option:`SB_CONFIG_WIFI_PATCHES_EXT_FLASH_STORE`, :kconfig:option:`SB_CONFIG_DFU_MULTI_IMAGE_PACKAGE_WIFI_FW_PATCH` Kconfig options to ``y``, and set the :kconfig:option:`SB_CONFIG_MCUBOOT_UPDATEABLE_IMAGES` Kconfig option to ``3``.
132132

133133
.. matter_door_lock_sample_nrf70_firmware_patch_end
134134
@@ -348,7 +348,7 @@ Factory data support
348348
To disable factory data support, set the following Kconfig options to ``n``:
349349

350350
* :kconfig:option:`CONFIG_CHIP_FACTORY_DATA`
351-
* ``SB_CONFIG_MATTER_FACTORY_DATA_GENERATE``
351+
* :kconfig:option:`SB_CONFIG_MATTER_FACTORY_DATA_GENERATE`
352352

353353
To learn more about factory data, read the :doc:`matter:nrfconnect_factory_data_configuration` page in the Matter documentation.
354354

0 commit comments

Comments
 (0)