Skip to content

Commit 643712f

Browse files
dawidprzybylorlubos
authored andcommitted
KRKNWK-19540: Update childimage build documentation for fem and wifi_coex
Add sysbuild build system information Use ipc_radio child image as default configuration Signed-off-by: Dawid Przybylo <[email protected]>
1 parent a760be6 commit 643712f

File tree

4 files changed

+52
-31
lines changed

4 files changed

+52
-31
lines changed

doc/nrf/app_dev/device_guides/fem/21540ek_dev_guide.rst

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,14 +52,20 @@ For example:
5252
.. parsed-literal::
5353
:class: highlight
5454
55-
west build -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf21540ek_fwd -Dmultiprotocol_rpmsg_SHIELD=nrf21540ek
55+
west build -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf21540ek_fwd -Dipc_radio_SHIELD=nrf21540ek
5656
57-
In this command, the *childImageName_* parameter has the ``multiprotocol_rpmsg_`` value and builds a multiprotocol application with support for 802.15.4 and Bluetooth.
58-
The *childImageName_* parameter can take the following values:
57+
In this command, the *childImageName_* parameter has the ``ipc_radio_`` value as default and builds the application with support for the combination of 802.15.4 and Bluetooth.
58+
The ``ipc_radio`` has been used since the build system migration to sysbuild.
59+
See :ref:`Migrating to sysbuild <child_parent_to_sysbuild_migration>` page.
60+
Setting the correct sysbuild option enables support for 802.15.4 and Bluetooth :ref:`ipc_radio`.
61+
62+
``ipc_radio`` represents all applications with support for the combination of both 802.15.4 and Bluetooth.
63+
You can configure your application using the following sysbuild configurations:
64+
65+
* ``SB_CONFIG_NETCORE_IPC_RADIO=y`` for applications having support for 802.15.4, but not for Bluetooth.
66+
* ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC=y`` for application having support for Bluetooth, but not for 802.15.4.
67+
* ``SB_CONFIG_NETCORE_IPC_RADIO=y`` and ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC=y`` for multiprotocol applications having support for both 802.15.4 and Bluetooth.
5968

60-
* ``multiprotocol_rpmsg_`` for multiprotocol applications with support for 802.15.4 and Bluetooth
61-
* ``802154_rpmsg_`` for applications with support for 802.15.4, but without support for Bluetooth
62-
* ``hci_ipc_`` for application with support for Bluetooth, but without support for 802.15.4
6369

6470
.. note::
6571
On nRF53 devices, ``SPIM0`` and ``UARTE0`` are mutually exclusive AHB bus masters on the network core as described in the `Product Specification <nRF5340 Product Specification_>`_, Section 6.4.3.1, Table 22.

doc/nrf/app_dev/device_guides/fem/fem_nrf21540_gpio.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,18 @@ To use nRF21540 in GPIO mode, complete the following steps:
5151

5252
The state of the remaining control pins should be set in other ways and according to `nRF21540 Product Specification`_.
5353

54-
#. On nRF53 devices, you must also apply the same devicetree node mentioned in step 1 to the network core.
55-
To do so, apply the overlay to the correct network core child image by creating an overlay file named :file:`child_image/*childImageName*.overlay` in your application directory, for example :file:`child_image/multiprotocol_rpmsg.overlay`.
54+
#. On nRF53 devices, you must also apply the same devicetree node mentioned in **Step 1** to the network core using sysbuild.
55+
To apply the overlay to the correct network core child image, create an overlay file named :file:`sysbuild/*childImageName*/boards/nrf5340dk_nrf5340_cpunet.overlay` in your application directory, for example :file:`sysbuild/ipc_radio/boards/nrf5340dk_nrf5340_cpunet.overlay`.
56+
For more information, see the :ref:`Migrating to sysbuild <child_parent_to_sysbuild_migration>` page.
5657

57-
The ``*childImageName*`` string must be one of the following values:
58+
The *childImageName* default value is set to ``ipc_radio``:
5859

59-
* ``multiprotocol_rpmsg`` for multiprotocol applications having support for both 802.15.4 and Bluetooth.
60-
* ``802154_rpmsg`` for applications having support for 802.15.4, but not for Bluetooth.
61-
* ``hci_ipc`` for application having support for Bluetooth, but not for 802.15.4.
60+
``ipc_radio`` represents all applications with support for the combination of both 802.15.4 and Bluetooth.
61+
You can configure your application using the following sysbuild configurations:
62+
63+
* ``SB_CONFIG_NETCORE_IPC_RADIO=y`` for applications having support for 802.15.4, but not for Bluetooth.
64+
* ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC=y`` for application having support for Bluetooth, but not for 802.15.4.
65+
* ``SB_CONFIG_NETCORE_IPC_RADIO=y`` and ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC=y`` for multiprotocol applications having support for both 802.15.4 and Bluetooth.SB_CONFIG_NETCORE_IPC_RADIO=y`` and ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC=y`` for multiprotocol applications having support for both 802.15.4 and Bluetooth.
6266

6367
.. note::
6468
This step is not needed when testing with :ref:`direct_test_mode` and :ref:`radio_test` on the nRF53 Series devices.

doc/nrf/app_dev/device_guides/fem/fem_simple_gpio.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,15 +50,19 @@ To use the Simple GPIO implementation of FEM with SKY66112-11, complete the foll
5050

5151
The state of the other control pins should be set according to the SKY66112-11 documentation.
5252
See the official `SKY66112-11 page`_ for more information.
53-
#. On nRF53 devices, you must also apply the same devicetree node to the network core.
5453

55-
Create a devicetree overlay file with the same information as you used in Steps 1 to 3.
56-
To apply the overlay to the correct network core child image, create the file in the :file:`child image` directory of your application directory, and name it :file:`*childImageName*.overlay`, for example :file:`child_image/multiprotocol_rpmsg.overlay`.
57-
The ``*childImageName*`` string must be one of the following values:
54+
#. On nRF53 devices, you must also apply the same devicetree node mentioned in **Step 1** to the network core using sysbuild.
55+
To apply the overlay to the correct network core child image, create an overlay file named :file:`sysbuild/*childImageName*/boards/nrf5340dk_nrf5340_cpunet.overlay` in your application directory, for example :file:`sysbuild/ipc_radio/boards/nrf5340dk_nrf5340_cpunet.overlay`.
56+
For more information, see the :ref:`Migrating to sysbuild <child_parent_to_sysbuild_migration>` page.
5857

59-
* ``multiprotocol_rpmsg`` for multiprotocol applications with support for 802.15.4 and Bluetooth.
60-
* ``802154_rpmsg`` for applications with support for 802.15.4, but without support for Bluetooth.
61-
* ``hci_ipc`` for applications with support for Bluetooth, but without support for 802.15.4.
58+
The *childImageName* default value is set to ``ipc_radio``:
59+
60+
``ipc_radio`` represents all applications with support for the combination of both 802.15.4 and Bluetooth.
61+
You can configure your application using the following sysbuild configurations:
62+
63+
* ``SB_CONFIG_NETCORE_IPC_RADIO=y`` for applications having support for 802.15.4, but not for Bluetooth.
64+
* ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC=y`` for application having support for Bluetooth, but not for 802.15.4.
65+
* ``SB_CONFIG_NETCORE_IPC_RADIO=y`` and ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC=y`` for multiprotocol applications having support for both 802.15.4 and Bluetooth.
6266

6367
.. note::
6468
This step is not needed when testing with the :ref:`direct_test_mode` or :ref:`radio_test` samples on nRF53 Series devices.

doc/nrf/app_dev/device_guides/wifi_coex.rst

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -128,14 +128,17 @@ To enable Wi-Fi coexistence on the nRF70 Series device, complete the following s
128128
The first element ``&gpio0`` indicates the GPIO port (``port 0`` has been selected in the example shown).
129129
The second element is the pin number on that port.
130130

131-
#. On the nRF5340, apply the same devicetree node mentioned in Step 1 to the network core.
132-
Apply the overlay to the correct network-core child image by creating an overlay file named :file:`child_image/*childImageName*.overlay` in your application directory, for example :file:`child_image/multiprotocol_rpmsg.overlay`.
131+
#. On the nRF5340, you must also apply the same devicetree node mentioned in step 1 to the network core using sysbuild build system. For more information, see the :ref:`Migrating to sysbuild <child_parent_to_sysbuild_migration>` page.
132+
To do so, apply the overlay to the correct network core child image by creating an overlay file named :file:`sysbuild/*childImageName*/boards/nrf5340dk_nrf5340_cpunet.overlay.overlay` in your application directory, for example :file:`sysbuild/ipc_radio/boards/nrf5340dk_nrf5340_cpunet.overlay`.
133133

134-
The ``*childImageName*`` string must assume one of the following values:
134+
The ``*childImageName*`` default value is set to ``ipc_radio`` :ref:`ipc_radio`.
135135

136-
* ``multiprotocol_rpmsg`` for multiprotocol applications having support for both 802.15.4 and Bluetooth.
137-
* ``802154_rpmsg`` for applications having support for 802.15.4, but not for Bluetooth.
138-
* ``hci_ipc`` for application having support for Bluetooth, but not for 802.15.4.
136+
``ipc_radio`` represents all applications with support for the combination of both 802.15.4 and Bluetooth.
137+
You can configure your application using the following sysbuild configurations:
138+
139+
* ``SB_CONFIG_NETCORE_IPC_RADIO=y`` for applications having support for 802.15.4, but not for Bluetooth.
140+
* ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC=y`` for application having support for Bluetooth, but not for 802.15.4.
141+
* ``SB_CONFIG_NETCORE_IPC_RADIO=y`` and ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC=y`` for multiprotocol applications having support for both 802.15.4 and Bluetooth.
139142

140143
#. Enable the following Kconfig options:
141144

@@ -206,14 +209,18 @@ To enable the generic three-wire coexistence, do the following:
206209
The first element ``&gpio0`` indicates the GPIO port (``port 0`` has been selected in the example shown).
207210
The second element is the pin number on that port.
208211

209-
#. On the nRF5340, apply the same devicetree node mentioned in Step 1 to the network core.
210-
Apply the overlay to the correct network-core child image by creating an overlay file named :file:`child_image/*childImageName*.overlay` in your application directory, for example :file:`child_image/multiprotocol_rpmsg.overlay`.
212+
#. On nRF53 devices, you must also apply the same devicetree node mentioned in **Step 1** to the network core using sysbuild.
213+
To apply the overlay to the correct network core child image, create an overlay file named :file:`sysbuild/*childImageName*/boards/nrf5340dk_nrf5340_cpunet.overlay` in your application directory, for example :file:`sysbuild/ipc_radio/boards/nrf5340dk_nrf5340_cpunet.overlay`.
214+
For more information, see the :ref:`Migrating to sysbuild <child_parent_to_sysbuild_migration>` page.
215+
216+
The *childImageName* default value is set to ``ipc_radio``:
211217

212-
The ``*childImageName*`` string must assume one of the following values:
218+
``ipc_radio`` represents all applications with support for the combination of both 802.15.4 and Bluetooth.
219+
You can configure your application using the following sysbuild configurations:
213220

214-
* ``multiprotocol_rpmsg`` for multiprotocol applications having support for both 802.15.4 and Bluetooth.
215-
* ``802154_rpmsg`` for applications having support for 802.15.4, but not for Bluetooth.
216-
* ``hci_ipc`` for application having support for Bluetooth, but not for 802.15.4.
221+
* ``SB_CONFIG_NETCORE_IPC_RADIO=y`` for applications having support for 802.15.4, but not for Bluetooth.
222+
* ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC=y`` for application having support for Bluetooth, but not for 802.15.4.
223+
* ``SB_CONFIG_NETCORE_IPC_RADIO=y`` and ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC=y`` for multiprotocol applications having support for both 802.15.4 and Bluetooth.
217224

218225
#. Enable the following Kconfig options:
219226

0 commit comments

Comments
 (0)