Skip to content

Commit

Permalink
samples: nrf5340: remove deprecated multiprotocol_rpmsg
Browse files Browse the repository at this point in the history
The `multiprotocol_rpmsg` sample for the nrf5340 is removed.
The functionality is taken over by the `ipc_radio` application.

Signed-off-by: Andrzej Kuros <[email protected]>
  • Loading branch information
ankuns committed Dec 10, 2024
1 parent c5d87ce commit a2c51d5
Show file tree
Hide file tree
Showing 20 changed files with 13 additions and 477 deletions.
8 changes: 4 additions & 4 deletions .github/test-spec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@
- "subsys/bluetooth/services/nus.c"
- "drivers/mpsl/**/*"
- "dts/bindings/radio_fem/**/*"
- "samples/nrf5340/multiprotocol_rpmsg/**/*"
- "applications/ipc_radio/**/*"
- "modules/nrfxlib/nrf_802154/**/*"
- "modules/mcuboot/**/*"
- "applications/zigbee_weather_station/**/*"
Expand Down Expand Up @@ -313,7 +313,7 @@
- "subsys/nrf_rpc/**/*"
- "drivers/mpsl/**/*"
- "dts/bindings/radio_fem/**/*"
- "samples/nrf5340/multiprotocol_rpmsg/**/*"
- "applications/ipc_radio/**/*"
- "modules/nrfxlib/nrf_802154/**/*"
- "samples/CMakeLists.txt"

Expand All @@ -326,7 +326,7 @@
- "drivers/mpsl/**/*"
- "boards/shields/**/*"
- "dts/bindings/radio_fem/**/*"
- "samples/nrf5340/multiprotocol_rpmsg/**/*"
- "applications/ipc_radio/**/*"
- "modules/nrfxlib/nrf_802154/**/*"
- "samples/CMakeLists.txt"

Expand Down Expand Up @@ -374,7 +374,7 @@
- "samples/matter/**/*"
- "applications/matter_bridge/**/*"
- "applications/matter_weather_station/**/*"
- "samples/nrf5340/multiprotocol_rpmsg/**/*"
- "applications/ipc_radio/**/*"

"CI-find-my-test":
- "CMakeLists.txt"
Expand Down
2 changes: 0 additions & 2 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -497,7 +497,6 @@
/samples/net/ @nrfconnect/ncs-cia @nrfconnect/ncs-modem
/samples/nfc/ @nrfconnect/ncs-si-muffin
/samples/nrf5340/netboot/ @nrfconnect/ncs-pluto
/samples/nrf5340/multiprotocol_rpmsg/ @hubertmis
/samples/nrf_rpc/ @nrfconnect/ncs-si-muffin
/samples/sensor/bh1749/ @nrfconnect/ncs-cia
/samples/sensor/bme68x_iaq/ @nrfconnect/ncs-cia
Expand Down Expand Up @@ -622,7 +621,6 @@
/samples/nrf5340/empty_app_core/*.rst @nrfconnect/ncs-si-muffin-doc
/samples/nrf5340/empty_net_core/*.rst @nrfconnect/ncs-si-bluebagel-doc
/samples/nrf5340/extxip_smp_svr/*.rst @nrfconnect/ncs-pluto-doc
/samples/nrf5340/multiprotocol_rpmsg/*.rst @nrfconnect/ncs-doc-leads
/samples/nrf5340/netboot/*.rst @nrfconnect/ncs-pluto-doc
/samples/nrf5340/remote_shell/*.rst @nrfconnect/ncs-si-muffin-doc
/samples/nrf_compress/mcuboot_update/*.rst @nrfconnect/ncs-vestavind-doc
Expand Down
2 changes: 0 additions & 2 deletions doc/nrf/app_dev/config_and_build/sysbuild/sysbuild_images.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ These options determine whether the secure boot image is included on the network
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| ``SB_CONFIG_NETCORE_802154_RPMSG`` | Zephyr 802.15.4 image :zephyr:code-sample:`nrf_ieee802154_rpmsg`. |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| ``SB_CONFIG_NETCORE_MULTIPROTOCOL_RPMSG`` | |NCS| multiprotocol_rpmsg Bluetooth and 802.15.4 image :ref:`multiprotocol-rpmsg-sample`. |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| ``SB_CONFIG_NETCORE_IPC_RADIO`` | |NCS| ipc_radio image :ref:`ipc_radio`. |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| ``SB_CONFIG_NETCORE_NONE`` | No network core image. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ For applications and samples in the |NCS| repository, this is handled automatica
+---------------------------------------------------------+--------------------------------------------+-----------+----------+-----------------------------------------------------------------------------------------------------------------------+
| ``SB_CONFIG_NETCORE_802154_RPMSG`` | :zephyr:code-sample:`nrf_ieee802154_rpmsg` ||| |
+---------------------------------------------------------+--------------------------------------------+-----------+----------+-----------------------------------------------------------------------------------------------------------------------+
| ``SB_CONFIG_NETCORE_MULTIPROTOCOL_RPMSG`` | :ref:`multiprotocol-rpmsg-sample` ||| |
+---------------------------------------------------------+--------------------------------------------+-----------+----------+-----------------------------------------------------------------------------------------------------------------------+
| ``SB_CONFIG_NETCORE_IPC_RADIO`` | :ref:`ipc_radio` ||| Requires additional configuration. The following Kconfig options provide predefined configurations: |
| | | | | ``SB_CONFIG_NETCORE_IPC_RADIO_BT_HCI_IPC`` enables HCI serialization |
| | | | | for Bluetooth, ``SB_CONFIG_NETCORE_IPC_RADIO_BT_RPC`` enables nRF RPC serialization for Bluetooth, or |
Expand All @@ -34,7 +32,7 @@ The default for Thingy:53 is the :ref:`nrf5340_empty_net_core` sample applicatio
The default for other nRF53 devices is having no image added to the build.

When configuring an application, such as :zephyr:code-sample:`ble_peripheral_hr`, you must configure it with a supported network core image to ensure proper functionality.
For basic Bluetooth samples, you can use :zephyr:code-sample:`bluetooth_hci_ipc`, :ref:`multiprotocol-rpmsg-sample`, or :ref:`ipc_radio` (one of the :ref:`companion components <companion_components>`).
For basic Bluetooth samples, you can use :zephyr:code-sample:`bluetooth_hci_ipc`, or :ref:`ipc_radio` (one of the :ref:`companion components <companion_components>`).
Use one of the following command patterns to build a sample with the :zephyr:code-sample:`bluetooth_hci_ipc` network image selected (with the relevant *board_target*, path to your application *app_dir*, and path to Zephyr's shared sysbuild directory *<path_to_zephyr>/share/sysbuild*):

.. tabs::
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/app_dev/device_guides/nrf53/building_nrf53.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ To program the nRF5340 DK from the command line, use either west (which uses nrf
* :file:`rpc_host`
* :file:`hci_rpsmg`
* :file:`802154_rpmsg`
* :file:`multiprotocol_rpmsg`
* :file:`ipc_radio`

#. Navigate to the build folder of the application sample and run the following command to erase the flash memory of the application core and program the application sample:

Expand Down
8 changes: 3 additions & 5 deletions doc/nrf/app_dev/device_guides/nrf53/features_nrf53.rst
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,7 @@ Multiprotocol support for the nRF5340 DK

* - Network core
- Application core
* - :ref:`multiprotocol-rpmsg-sample`
* - :ref:`ipc_radio`
- | :ref:`Thread samples <openthread_samples>`
| :ref:`Zigbee samples <zigbee_samples>`
Expand All @@ -229,10 +229,8 @@ When using Thread or Zigbee in parallel with Bluetooth LE, run the low-level rad

Bluetooth LE and IEEE 802.15.4 multiprotocol architecture in multicore SoC

For the network core, the |NCS| provides the :ref:`multiprotocol-rpmsg-sample` sample.
It is a combination of the :zephyr:code-sample:`bluetooth_hci_ipc` sample (for Bluetooth LE) and the :zephyr:code-sample:`nrf_ieee802154_rpmsg` sample (for IEEE 802.15.4).
This means that it enables both the Bluetooth LE Controller and the nRF IEEE 802.15.4 radio driver and simultaneously exposes the functionality of both stacks to the application core using the `RPMsg Messaging Protocol`_.
Separate RPMsg endpoints are used to obtain independent inter-core connections for each stack.
For the network core, the |NCS| provides the :ref:`ipc_radio`.
The :ref:`ipc_radio` enables both the Bluetooth LE Controller and the nRF IEEE 802.15.4 radio driver and simultaneously exposes the functionality of both stacks to the application.

For the application core, the |NCS| provides a series of samples for the :ref:`Thread <ug_thread>` and :ref:`Zigbee <ug_zigbee>` protocols.
|multi_image|
Expand Down
3 changes: 0 additions & 3 deletions doc/nrf/app_dev/device_guides/nrf53/multi_image_nrf5340.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,6 @@ The combination of these options determines which (if any) sample is included in
* - :kconfig:option:`CONFIG_NRF_802154_SER_HOST`
- :zephyr:code-sample:`nrf_ieee802154_rpmsg`
- ---
* - :kconfig:option:`CONFIG_BT_HCI_IPC` and :kconfig:option:`CONFIG_NRF_802154_SER_HOST`
- :ref:`multiprotocol-rpmsg-sample`
- ---
* - :kconfig:option:`CONFIG_NCS_SAMPLE_EMPTY_APP_CORE_CHILD_IMAGE`
- ---
- :ref:`nrf5340_empty_app_core`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ You can do this by either editing the :file:`prj.conf` file or building the samp
The parameter name varies depending on the devices you are building for.
For example:

* If you want to build for Thread devices for the ``nrf5340dk/nrf5340/cpuapp`` board target with a Bluetooth LE TX power equal to 3 dBm, add ``-Dmultiprotocol_rpmsg_CONFIG_BT_CTLR_TX_PWR_PLUS_3=y`` as the CMake argument.
* If you want to build for Thread devices for the ``nrf5340dk/nrf5340/cpuapp`` board target with a Bluetooth LE TX power equal to 3 dBm, add ``-Dipc_radio_CONFIG_BT_CTLR_TX_PWR_PLUS_3=y`` as the CMake argument.
* If you want to build for Wi-Fi® devices for the ``nrf7002dk/nrf5340/cpuapp`` board target with a Bluetooth LE TX power equal to 3 dBm, add ``-Dhci_ipc_CONFIG_BT_CTLR_TX_PWR_PLUS_3=y`` as the CMake argument.

See `nRF Connect for VS Code extension pack <How to work with build configurations_>`_ documentation for more information.
Expand All @@ -174,7 +174,7 @@ You can do this by either editing the :file:`prj.conf` file or building the samp

.. code-block:: console
west build -b nrf5340dk/nrf5340/cpuapp -- -Dmultiprotocol_rpmsg_CONFIG_BT_CTLR_TX_PWR_PLUS_3=y
west build -b nrf5340dk/nrf5340/cpuapp -- -Dipc_radio_CONFIG_BT_CTLR_TX_PWR_PLUS_3=y
* If you want to build for Wi-Fi® devices for the ``nrf7002dk/nrf5340/cpuapp`` board target with a Bluetooth LE TX power equal to 3 dBm, run the following command:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,6 @@ The following Kconfig options are available to include the desired image in the
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| ``SB_CONFIG_NETCORE_802154_RPMSG`` | Zephyr 802.15.4 image: :zephyr:code-sample:`nrf_ieee802154_rpmsg` |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| ``SB_CONFIG_NETCORE_MULTIPROTOCOL_RPMSG`` | |NCS| multiprotocol_rpmsg Bluetooth and 802.15.4 image: :ref:`multiprotocol-rpmsg-sample` |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| ``SB_CONFIG_NETCORE_IPC_RADIO`` | |NCS| ipc_radio image: :ref:`ipc_radio` |
+---------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
| ``SB_CONFIG_NETCORE_NONE`` | No network core image |
Expand Down
6 changes: 1 addition & 5 deletions samples/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,6 @@ if (CONFIG_NCS_INCLUDE_RPMSG_CHILD_IMAGE OR CONFIG_NCS_SAMPLE_EMPTY_NET_CORE_CHI
set(CHILD_IMAGE_NAME "empty_net_core")
set(CHILD_IMAGE_PATH "${ZEPHYR_NRF_MODULE_DIR}/samples/nrf5340/empty_net_core")

elseif (CONFIG_NCS_SAMPLE_MULTIPROTOCOL_RPMSG_CHILD_IMAGE)
set(CHILD_IMAGE_NAME "multiprotocol_rpmsg")
set(CHILD_IMAGE_PATH "${ZEPHYR_NRF_MODULE_DIR}/samples/nrf5340/multiprotocol_rpmsg")

elseif (CONFIG_NCS_SAMPLE_HCI_IPC_CHILD_IMAGE)
set(CHILD_IMAGE_NAME "hci_ipc")
set(CHILD_IMAGE_PATH "${ZEPHYR_BASE}/samples/bluetooth/hci_ipc")
Expand All @@ -105,7 +101,7 @@ if (CONFIG_NCS_INCLUDE_RPMSG_CHILD_IMAGE OR CONFIG_NCS_SAMPLE_EMPTY_NET_CORE_CHI
if (CONFIG_NCS_SAMPLE_MCUMGR_BT_OTA_DFU_SPEEDUP)
# By passing this value we don't require the user to pass any overlay files to the
# network core child image. Bluetooth buffer sizes are aligned automatically.
if (CONFIG_NCS_SAMPLE_HCI_IPC_CHILD_IMAGE OR CONFIG_NCS_SAMPLE_MULTIPROTOCOL_RPMSG_CHILD_IMAGE)
if (CONFIG_NCS_SAMPLE_HCI_IPC_CHILD_IMAGE)
add_overlay_config(
${CHILD_IMAGE_NAME}
${CMAKE_CURRENT_LIST_DIR}/common/mcumgr_bt_ota_dfu/rpmsg_child_image_overlay.conf
Expand Down
7 changes: 0 additions & 7 deletions samples/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,6 @@ config NCS_SAMPLE_DTM_REMOTE_HCI_CHILD_IMAGE

if NCS_INCLUDE_RPMSG_CHILD_IMAGE

config NCS_SAMPLE_MULTIPROTOCOL_RPMSG_CHILD_IMAGE
bool
depends on BT_HCI_IPC && NRF_802154_SER_HOST && !BT_RPC && !NRF70_RADIO_TEST_COMBO
default y
help
multiprotocol_rpmsg sample as a child image (network core).

config NCS_SAMPLE_HCI_IPC_CHILD_IMAGE
bool
depends on BT_HCI_IPC && !NRF_802154_SER_HOST && !BT_RPC && !NRF70_RADIO_TEST_COMBO
Expand Down
2 changes: 1 addition & 1 deletion samples/matter/light_bulb/sample.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ tests:
sample.matter.light_bulb.debug.nrf21540ek_fwd:
sysbuild: true
build_only: true
extra_args: light_bulb_SHIELD=nrf21540ek multiprotocol_rpmsg_SHIELD=nrf21540ek
extra_args: light_bulb_SHIELD=nrf21540ek ipc_radio_SHIELD=nrf21540ek
integration_platforms:
- nrf5340dk/nrf5340/cpuapp
platform_allow: nrf5340dk/nrf5340/cpuapp
Expand Down
10 changes: 0 additions & 10 deletions samples/nrf5340/multiprotocol_rpmsg/CMakeLists.txt

This file was deleted.

87 changes: 0 additions & 87 deletions samples/nrf5340/multiprotocol_rpmsg/README.rst

This file was deleted.

26 changes: 0 additions & 26 deletions samples/nrf5340/multiprotocol_rpmsg/prj.conf

This file was deleted.

12 changes: 0 additions & 12 deletions samples/nrf5340/multiprotocol_rpmsg/sample.yaml

This file was deleted.

Loading

0 comments on commit a2c51d5

Please sign in to comment.