You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: applications/nrf_desktop/doc/ble_qos.rst
+1-1
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ Enable the module using the :ref:`CONFIG_DESKTOP_BLE_QOS_ENABLE <config_desktop_
33
33
The option selects :kconfig:option:`CONFIG_BT_HCI_VS_EVT_USER`, because the module uses vendor-specific HCI events.
34
34
35
35
You can use the :ref:`CONFIG_DESKTOP_BLE_QOS_STATS_PRINTOUT_ENABLE <config_desktop_app_options>` option to enable real-time QoS information printouts through a UART (e.g. a virtual COM port).
36
-
The chosen UART needs to be specified in Devicetree using ``ncs,ble-qos-uart``.
36
+
The chosen UART needs to be specified in devicetree using ``ncs,ble-qos-uart``.
37
37
This option also enables and configures the COM port (USB CDC ACM).
38
38
For this reason, the :kconfig:option:`CONFIG_USB_DEVICE_STACK` must be enabled.
Copy file name to clipboardexpand all lines: applications/nrf_desktop/doc/fast_pair_app.rst
+1-1
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ The option is enabled by default if :kconfig:option:`CONFIG_CAF_BLE_STATE_MAX_LO
46
46
.. note::
47
47
If :kconfig:option:`CONFIG_CAF_BLE_STATE_MAX_LOCAL_ID_BONDS` Kconfig option value is equal to one:
48
48
49
-
* Displaying UI indication during the Fast Pair not discoverable advertising (:kconfig:option:`CONFIG_BT_ADV_PROV_FAST_PAIR_SHOW_UI_PAIRING`) is disabled by default in the nRF Desktop advertising data configuration defined in :file:`src/util/Kconfg` file.
49
+
* Displaying UI indication during the Fast Pair not discoverable advertising (:kconfig:option:`CONFIG_BT_ADV_PROV_FAST_PAIR_SHOW_UI_PAIRING`) is disabled by default in the nRF Desktop advertising data configuration defined in :file:`src/util/Kconfig` file.
50
50
* :ref:`nrf_desktop_ble_state` automatically disconnects new peers right after Bluetooth connection is established if the used Bluetooth local identity is already bonded with another peer.
51
51
52
52
The :ref:`CONFIG_DESKTOP_FAST_PAIR_LIMIT_NORMAL_PAIRING <config_desktop_app_options>` can be used to allow normal Bluetooth pairing only in the pairing mode.
Copy file name to clipboardexpand all lines: doc/nrf/config_and_build/bootloaders/bootloader_config.rst
+1-1
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ However, there are other ways to customize your application using Kconfig option
20
20
Using custom project configurations
21
21
***********************************
22
22
23
-
You can use custom project configuration options for the associated image, specifying them at build time using :ref:`ug_multi_image_variables`, either temporarily until you clean the build pristinely or permamently.
23
+
You can use custom project configuration options for the associated image, specifying them at build time using :ref:`ug_multi_image_variables`, either temporarily until you clean the build pristinely or permanently.
24
24
25
25
For example, you can temporarily assign custom project configurations for both the bootloaders and a sample application as follows:
Copy file name to clipboardexpand all lines: doc/nrf/config_and_build/bootloaders/bootloader_signature_keys.rst
+1-1
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Dedicated host tools like :doc:`mcuboot:imgtool` can be used to sign application
14
14
When you use |NSIB|, a private/public key pair is by default generated during the build when you are :ref:`ug_bootloader_adding_immutable_keys`.
15
15
You can use the methods described in the following sections to explicitly define how the key pair is to be generated.
16
16
17
-
When you use MCUboot or you are :ref:`ug_bootloader_adding_upgradable_mcuboot`, MCUBoot uses keys that were generated once and are stored in the public MCUboot Git repository be default.
17
+
When you use MCUboot or you are :ref:`ug_bootloader_adding_upgradable_mcuboot`, MCUboot uses keys that were generated once and are stored in the public MCUboot Git repository by default.
18
18
19
19
.. note::
20
20
These key pairs should only be used during development.
Copy file name to clipboardexpand all lines: doc/nrf/device_guides/working_with_nrf/nrf53/nrf5340.rst
+3-3
Original file line number
Diff line number
Diff line change
@@ -598,9 +598,9 @@ If not changed, then the default child image prefix for MCUboot is ``mcuboot_``
598
598
599
599
.. note::
600
600
601
-
The application core can be reverted, but doing so bricks the network core upon revertion, as the reversion process fills the network core with the content currently in the RAM that pcd uses.
602
-
To enable this, define the ``USE_NRF53_MULTI_IMAGE_WITHOUT_UPGRADE_ONLY`` Kconfig option in the project-level Kconfig file.
603
-
When this is option is defined, you can enable it by setting :kconfig:option`CONFIG_USE_NRF53_MULTI_IMAGE_WITHOUT_UPGRADE_ONLY`.
601
+
The application core can be reverted, but doing so breaks the network core upon reversal, as the reversion process fills the network core with the content currently in the RAM that PCD uses.
602
+
To enable this, define the :kconfig:option:`CONFIG_USE_NRF53_MULTI_IMAGE_WITHOUT_UPGRADE_ONLY` Kconfig option in the project-level Kconfig file.
603
+
When this option is defined, you can enable it by setting :kconfig:option:`CONFIG_USE_NRF53_MULTI_IMAGE_WITHOUT_UPGRADE_ONLY`.
604
604
605
605
The :kconfig:option:`CONFIG_NRF53_MULTI_IMAGE_UPDATE` option selects this feature by default if these options and all its other dependencies are asserted.
Copy file name to clipboardexpand all lines: doc/nrf/device_guides/working_with_nrf/nrf70/developing/fw_patches_ext_flash.rst
+16-16
Original file line number
Diff line number
Diff line change
@@ -10,14 +10,14 @@ Firmware patches in the external memory
10
10
This guide explains the available options for having the nRF70 Series firmware patches reside in the external memory.
11
11
12
12
.. note::
13
-
External memory refers to the memory that is outside the SoC, for example, an external flash memory chip, or external non-volatile memory (NVM) chip etc.
13
+
External memory refers to the memory that is outside the SoC, for example, an external flash memory chip, or external non-volatile memory (NVM) chip.
14
14
15
15
Overview
16
16
********
17
17
18
-
By default the nRF70 Series firmware patches are built as part of the nRF Wi-Fi driver code, residing in on-chip memory.
18
+
By default, the nRF70 Series firmware patches are built as part of the nRF Wi-Fi driver code, residing in on-chip memory.
19
19
The firmware patches include code that is executed on the nRF70 Series device.
20
-
The size of the firmware patches may be considerably large, which limits the amount of on-chip code memory available for the user application.
20
+
The size of the firmware patches might be considerably large, which limits the amount of on-chip code memory available for the user application.
21
21
In order to increase the amount of on-chip memory available for user applications, the nRF Wi-Fi driver supports the option of using external memory, if that is available.
22
22
23
23
Prerequisites
@@ -30,7 +30,7 @@ Before using this feature, make sure that the following prerequisites are comple
30
30
The maximum size of all the firmware patches combined is 128 KB.
31
31
32
32
.. note::
33
-
Currently, in Nordic Semiconductor SoCs, access to external memory and the Execute in Place (XIP) feature are available through the QSPI interface only.
33
+
Currently, in Nordic Semiconductor SoCs, access to external memory and the Execute in Place (XIP) feature are available through the QSPI interface only.
34
34
35
35
Supported platforms
36
36
===================
@@ -41,7 +41,7 @@ The following platforms are supported:
41
41
* nRF52840 DK with nRF7002 EK as a shield
42
42
43
43
.. note::
44
-
Due to limitations mentioned above, the nRF7002 DK is not supported as it needs access to external memory through the SPI interface.
44
+
Due to limitations mentioned above, the nRF7002 DK is not supported as it needs access to external memory through the SPI interface.
45
45
46
46
Available options
47
47
*****************
@@ -56,12 +56,12 @@ Using XIP access
56
56
57
57
If the application supports XIP from external memory, then the firmware patches can be loaded as part of the nRF Wi-Fi driver code (RODATA) and then relocated to the external memory.
58
58
The nRF Wi-Fi driver accesses the firmware patches using XIP feature and downloads the firmware patches to the nRF70 device.
59
-
To enable this feature, set the :kconfig:option:`CONFIG_NRF_WIFI_PATCHES_EXT_FLASH_XIP` kconfig option to ``y``.
59
+
To enable this feature, set the :kconfig:option:`CONFIG_NRF_WIFI_PATCHES_EXT_FLASH_XIP` Kconfig option to ``y``.
60
60
Once the build is complete, the feature can be verified by checking the memory regions summary in the build output.
61
61
A new memory region called ``EXTFLASH`` is added to the memory regions summary, and the firmware patches are placed in this region.
62
62
The size of the ``FLASH`` used is reduced by the size of the firmware patches.
63
63
64
-
A sample memory regions summary is shown below:
64
+
Following is a sample summary of the memory regions:
65
65
66
66
.. code-block:: console
67
67
@@ -77,8 +77,8 @@ Using QSPI transfers to RAM
77
77
The nRF Wi-Fi driver supports the option for offloading the nRF70 firmware patch to external non-XIP memory.
78
78
In this case the upload of the firmware patch from the external memory to the nRF70 device happens in two stages:
79
79
80
-
* first the firmware patch is loaded from the external memory onto internal RAM and
81
-
* then it is uploaded to the nRF70 device.
80
+
1. The firmware patch is loaded from the external memory onto internal RAM.
81
+
#. The firmware patch is uploaded to the nRF70 device.
82
82
83
83
This feature can be enabled using DTS or :ref:`snippets` feature or by using :ref:`partition_manager`.
84
84
@@ -87,13 +87,13 @@ Configuration
87
87
88
88
The following configuration options are available:
89
89
90
-
* :kconfig:option:`CONFIG_NRF_WIFI_PATCHES_EXT_FLASH_STORE`: Enables the option to store the firmware patch in external non-XIP memory.
91
-
* :kconfig:option:`CONFIG_NRF_WIFI_FW_FLASH_CHUNK_SIZE`: Defines the size of the chunks used to read the firmware patches from the external non-XIP memory.
90
+
* :kconfig:option:`CONFIG_NRF_WIFI_PATCHES_EXT_FLASH_STORE` - Enables the option to store the firmware patch in external non-XIP memory.
91
+
* :kconfig:option:`CONFIG_NRF_WIFI_FW_FLASH_CHUNK_SIZE` - Defines the size of the chunks used to read the firmware patches from the external non-XIP memory.
92
92
The default value is 8192 bytes.
93
93
94
94
The external memory partition name must be defined in the devicetree or in the partition manager configuration file.
95
95
96
-
* ``nrf70_fw_partition``: Defines the name of the external memory partition that stores the firmware patches.
96
+
* ``nrf70_fw_partition`` - Defines the name of the external memory partition that stores the firmware patches.
97
97
This must be defined in the devicetree, for example:
98
98
99
99
.. code-block:: dts
@@ -110,7 +110,7 @@ The external memory partition name must be defined in the devicetree or in the p
110
110
};
111
111
};
112
112
113
-
* ``nrf70_wifi_fw`` : Defines the name of the external memory partition that stores the firmware patches.
113
+
* ``nrf70_wifi_fw`` - Defines the name of the external memory partition that stores the firmware patches.
114
114
This must be defined in the partition manager configuration file, for example:
115
115
116
116
.. code-block:: console
@@ -128,7 +128,7 @@ See :ref:`nrf7002dk_nrf5340` for general instructions on building.
128
128
129
129
Additionally, you must enable either the `nrf70-fw-patch-ext-flash` snippet or the :kconfig:option:`CONFIG_PARTITION_MANAGER_ENABLED` option.
130
130
131
-
For example, to build the :ref:`wifi_shell_sample` sample for the nRF5340 DK with the ``nrf70-fw-patch-ext-flash`` snippet enabled, run the following commands:
131
+
For example, to build the :ref:`wifi_shell_sample` sample for the nRF5340 DK with the ``nrf70-fw-patch-ext-flash`` snippet enabled, run the following commands.
132
132
133
133
With west
134
134
^^^^^^^^^
@@ -165,7 +165,7 @@ With CMake
165
165
Programming
166
166
-----------
167
167
168
-
To program the firmware image with the firmware patches stored in the external memory, use the following commands:
168
+
To program the firmware image with the firmware patches stored in the external memory, use the following commands.
Copy file name to clipboardexpand all lines: doc/nrf/device_guides/working_with_nrf/nrf70/nrf7002eb_gs.rst
+1-1
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ The nRF7002 EB can be used to provide Wi-Fi® connectivity to compatible develop
14
14
The nRF7002 EB has a :term:`Printed Circuit Board (PCB)` edge connector that can be used with a compatible development board such as the Nordic Thingy:53, an IoT prototyping platform from Nordic Semiconductor.
15
15
There are also castellated holes on the side of the board that allow the EB to be used as a breakout board that can be soldered to other PCB assemblies.
16
16
17
-
If this is your first time developing with a Nordic DK, read the appropriate getting started tutorial first:
17
+
If this is your first time developing with a Nordic Semiconductor DK, read the appropriate getting started tutorial first:
Copy file name to clipboardexpand all lines: doc/nrf/device_guides/working_with_nrf/nrf91/nrf91_features.rst
+7-6
Original file line number
Diff line number
Diff line change
@@ -258,12 +258,13 @@ You can hardcode the information in the application, or you can use a functional
258
258
Samples and applications implementing FOTA
259
259
==========================================
260
260
261
-
* :ref:`http_modem_full_update_sample` sample - performs a full firmware OTA update of the modem.
262
-
* :ref:`http_modem_delta_update_sample` sample - performs a delta OTA update of the modem firmware.
263
-
* :ref:`http_application_update_sample` sample - performs a basic application FOTA update.
264
-
* :ref:`aws_iot` sample - performs a FOTA update using MQTT and HTTP, where the firmware download is triggered through an AWS IoT job.
265
-
* :ref:`azure_iot_hub` sample - performs a FOTA update from the Azure IoT Hub.
266
-
* :ref:`asset_tracker_v2` application - performs FOTA updates of the application, modem (delta), and boot (if enabled). It also supports nRF Cloud FOTA as well as AWS or Azure FOTA. Only one must be configured at a time.
261
+
* :ref:`http_modem_full_update_sample` sample - Performs a full firmware OTA update of the modem.
262
+
* :ref:`http_modem_delta_update_sample` sample - Performs a delta OTA update of the modem firmware.
263
+
* :ref:`http_application_update_sample` sample - Performs a basic application FOTA update.
264
+
* :ref:`aws_iot` sample - Performs a FOTA update using MQTT and HTTP, where the firmware download is triggered through an AWS IoT job.
265
+
* :ref:`azure_iot_hub` sample - Performs a FOTA update from the Azure IoT Hub.
266
+
* :ref:`asset_tracker_v2` application - Performs FOTA updates of the application, modem (delta), and boot (if enabled).
267
+
It also supports nRF Cloud FOTA as well as AWS or Azure FOTA. Only one must be configured at a time.
0 commit comments