Skip to content

Commit dcc174f

Browse files
committed
doc: miscellaneous fixes
Add missing nRF5340 related info and other minor fixes. Signed-off-by: Eduardo Montoya <eduardo.montoya@nordicsemi.no>
1 parent 11a8e8f commit dcc174f

5 files changed

Lines changed: 30 additions & 6 deletions

File tree

docs/architectures.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ This is the design most commonly used for End Devices and Routers.
4545

4646
Zigbee-only architecture on nRF54L Series and nRF52840 devices
4747

48+
.. figure:: images/zigbee_platform_design_nRF53.svg
49+
:alt: Zigbee-only architecture (nRF53 Series devices)
50+
51+
Zigbee-only architecture on nRF53 Series devices
52+
4853
This platform design is suitable for the following development kits:
4954

5055
.. include:: /includes/device_table_single_multi.txt
@@ -67,9 +72,14 @@ It also has the following disadvantages:
6772

6873
Multiprotocol Zigbee and Bluetooth LE architecture on nRF54L Series and nRF52840 devices
6974

75+
.. figure:: images/zigbee_platform_design_nRF5340_multi.svg
76+
:alt: Multiprotocol Zigbee and Bluetooth LE architecture (nRF53 Series devices)
77+
78+
Multiprotocol Zigbee and Bluetooth LE architecture on nRF53 Series devices
79+
7080
For more information, see `Multiprotocol support`_ in the |NCS| documentation and :ref:`zigbee_light_switch_sample_nus`.
7181

72-
This platform design is suitable for the following development kit:
82+
This platform design is suitable for the following development kits:
7383

7484
.. include:: /includes/device_table_single_multi.txt
7585

@@ -91,7 +101,7 @@ Network Co-Processor (NCP)
91101

92102
In this design, the host processor runs the Zigbee application layer (ZCL) and the Zigbee commissioning logic.
93103
The connectivity device (nRF SoC) runs the :ref:`NCP application <zigbee_ncp_sample>` that contains lower parts of the Zigbee stack (802.15.4 PHY/MAC and the Zigbee PRO network layer), as well as provides commands to execute BDB commissioning primitives.
94-
The host processor communicates with the NCP through a serial interface (UART).
104+
The host processor communicates with the NCP through a serial interface (USB or UART).
95105

96106
The NCP design has the following advantages:
97107

docs/lib/zigbee_fota.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,20 @@ The Zigbee FOTA library has the following limitations:
9595
* The Zigbee FOTA upgrades are currently supported on the nRF52840 DK (PCA10056), nRF5340 DK (PCA10095) and nRF54L15 DK (PCA10156).
9696
* The Zigbee FOTA library does not currently support bootloader upgrades.
9797

98+
Additionally, the following limitations apply on the nRF5340 SoCs:
99+
100+
* It is required to use external flash to enable the Zigbee FOTA library.
101+
* By default, only the full upgrades (to both application and network core) are allowed.
102+
Disable the ``CONFIG_NRF53_ENFORCE_IMAGE_VERSION_EQUALITY`` Kconfig option to build update images without inter-dependencies so that they can be applied independently.
103+
* It is not possible to modify the value of the ``SB_CONFIG_MCUBOOT_MODE_SWAP_WITHOUT_SCRATCH`` Kconfig option.
104+
As a result, the fallback recovery is not available and any valid upgrade will overwrite the previous image.
105+
The call to the :c:func:`boot_write_img_confirmed` will have no effect.
106+
* The current DFU limitations and dependencies are enforced by the ``CONFIG_NRF53_MULTI_IMAGE_UPDATE`` Kconfig option.
107+
* The version of the network core image is always set to the same value as the application core image.
108+
Its value can be configured using the ``CONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION`` Kconfig option.
109+
* The MCUboot header is not stored inside the network core flash memory.
110+
As a result, it is not possible to read the version of the currently running network core image.
111+
98112
API documentation
99113
*****************
100114

docs/links.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,10 @@
7777
.. _`Pulse Width Modulation (PWM)`: https://docs.nordicsemi.com/bundle/ncs-2.9.2/page/zephyr/hardware/peripherals/pwm.html
7878
.. _`UART API`: https://docs.nordicsemi.com/bundle/ncs-2.9.2/page/zephyr/hardware/peripherals/uart.html
7979
.. _`Shields`: https://docs.nordicsemi.com/bundle/ncs-2.9.2/page/zephyr/hardware/porting/shields.html
80-
.. _`Board support`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/board_names.html#programming-board-names
80+
.. _`Board support`: https://docs.nordicsemi.com/bundle/ncs-2.9.2//page/nrf/app_dev/board_names.html#programming-board-names
8181

8282
.. _`nrf52840dk`: https://docs.nordicsemi.com/bundle/ncs-2.9.2/page/zephyr/boards/nordic/nrf52840dk/doc/index.html
83-
.. _`nrf52840dongle`: https://docs.nordicsemi.com/bundle/ncs-latest/page/zephyr/boards/nordic/nrf52840dongle/doc/index.html#nrf52840dongle-nrf52840
83+
.. _`nrf52840dongle`: https://docs.nordicsemi.com/bundle/ncs-2.9.2//page/zephyr/boards/nordic/nrf52840dongle/doc/index.html#nrf52840dongle-nrf52840
8484
.. _`nrf52833dk`: https://docs.nordicsemi.com/bundle/ncs-2.9.2/page/zephyr/boards/nordic/nrf52833dk/doc/index.html
8585
.. _`nrf5340dk`: https://docs.nordicsemi.com/bundle/ncs-2.9.2/page/zephyr/boards/nordic/nrf5340dk/doc/index.html
8686
.. _`nrf54l15dk`: https://docs.nordicsemi.com/bundle/ncs-2.9.2/page/zephyr/boards/nordic/nrf54l15dk/doc/index.html

docs/migration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _migration:
22

3-
Migration guide for R22 to R23 Add-on
3+
Migration guide for R22 to R23 add-on
44
#####################################
55

66
.. contents::

docs/shortcuts.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
See :ref:`ug_zigbee_configuring` for more information.
4141
.. |zigbee_library| replace:: This is a Zigbee library.
4242
See :ref:`ug_zigbee_configuring_libraries` for information about how to configure it for you Zigbee application.
43-
.. |zigbee_ncp_package| replace:: It contains the full development-ready source code for host and evaluation-ready firmware for the nRF54L15 DK, nRF52840 DK, nRF52833 DK, and the nRF52840 Dongle.
43+
.. |zigbee_ncp_package| replace:: It contains the full development-ready source code for host and evaluation-ready firmware.
4444
The package comes with prebuilt libraries compatible with 64-bit Ubuntu |ubuntu_version| Linux.
4545
.. |zigbee_ncp_package_more_info| replace:: For information about how to recompile the package libraries for a different host architecture or operating system, see the `NCP Host documentation`_.
4646
For information about how to use NCP Host with the |addon| for the |NCS| or build the firmware using the NCP sample, see the :ref:`NCP sample <zigbee_ncp_sample>`.

0 commit comments

Comments
 (0)