Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

samples: nrf5340: remove deprecated multiprotocol_rpmsg #19372

Merged
merged 4 commits into from
Dec 20, 2024
Merged

samples: nrf5340: remove deprecated multiprotocol_rpmsg #19372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9a8b430
samples: nrf5340: remove deprecated multiprotocol_rpmsg
ankuns Dec 10, 2024
240ec0b
samples: nrf5340: changelog for multiprotocol_rpmsg removal
ankuns Dec 10, 2024
5ec5c94
doc: Updated hw_requirements for Matter
kkasperczyk-no Dec 11, 2024
340f827
doc: remove references to removed sample `nRF5340: Multiprotocol RPMsg`
ankuns Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/test-spec.yml
View file
Open in desktop
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
View file
Open in desktop
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,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 @@ -624,7 +623,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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,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
4 changes: 1 addition & 3 deletions doc/nrf/app_dev/config_and_build/sysbuild/zephyr_samples_sysbuild.rst
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,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 @@ -227,10 +227,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
View file
Open in desktop
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
8 changes: 4 additions & 4 deletions doc/nrf/protocols/matter/getting_started/hw_requirements.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ For more information about configuration of memory layouts in Matter, see :ref:`
| | | +---------------------+-------------------+-------------------+
| | | | provision | 33.375kB (0x8580) | 640B (0x280) |
+---------------------------------------------------------+---------------------+-------------------+---------------------+-------------------+-------------------+
| Network application (app) | 34kB (0x8800) | 222kB (0x37800) | multiprotocol_rpmsg | 34kB (0x8800) | 222kB (0x37800) |
| Network application (app) | 34kB (0x8800) | 222kB (0x37800) | ipc_radio | 34kB (0x8800) | 222kB (0x37800) |
+---------------------------------------------------------+---------------------+-------------------+---------------------+-------------------+-------------------+

Network core SRAM (size: 0x10000 = 64kB)
Expand Down Expand Up @@ -469,7 +469,7 @@ For more information about configuration of memory layouts in Matter, see :ref:`
| | | +---------------------+------------------+-------------------+
| | | | provision | 33.375kB (0x8580)| 640B (0x280) |
+---------------------------------------------------------+---------------------+-------------------+---------------------+------------------+-------------------+
| Network application (app) | 34kB (0x8800) | 222kB (0x37800) | multiprotocol_rpmsg | 34kB (0x8800) | 222kB (0x37800) |
| Network application (app) | 34kB (0x8800) | 222kB (0x37800) | ipc_radio | 34kB (0x8800) | 222kB (0x37800) |
+---------------------------------------------------------+---------------------+-------------------+---------------------+------------------+-------------------+

Network core SRAM flash (size: 0x10000 = 64kB)
Expand Down Expand Up @@ -544,7 +544,7 @@ For more information about configuration of memory layouts in Matter, see :ref:`
| | | +---------------------+------------------+-------------------+
| | | | provision | 33.375kB (0x8580)| 640B (0x280) |
+---------------------------------------------------------+---------------------+-------------------+---------------------+------------------+-------------------+
| Network application (app) | 34kB (0x8800) | 222kB (0x37800) | multiprotocol_rpmsg | 34kB (0x8800) | 222kB (0x37800) |
| Network application (app) | 34kB (0x8800) | 222kB (0x37800) | ipc_radio | 34kB (0x8800) | 222kB (0x37800) |
+---------------------------------------------------------+---------------------+-------------------+---------------------+------------------+-------------------+

Network core SRAM flash (size: 0x10000 = 64kB)
Expand Down Expand Up @@ -618,7 +618,7 @@ For more information about configuration of memory layouts in Matter, see :ref:`
| | | +---------------------+------------------+-------------------+
| | | | provision | 33.375kB (0x8580)| 640B (0x280) |
+---------------------------------------------------------+---------------------+-------------------+---------------------+------------------+-------------------+
| Network application (app) | 34kB (0x8800) | 222kB (0x37800) | hci_ipc | 34kB (0x8800) | 222kB (0x37800) |
| Network application (app) | 34kB (0x8800) | 222kB (0x37800) | ipc_radio | 34kB (0x8800) | 222kB (0x37800) |
+---------------------------------------------------------+---------------------+-------------------+---------------------+------------------+-------------------+

Network core SRAM flash (size: 0x10000 = 64kB)
Expand Down
4 changes: 2 additions & 2 deletions doc/nrf/protocols/matter/getting_started/transmission_power.rst
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion doc/nrf/releases_and_maturity/migration/migration_guide_2.7.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Samples and applications using short-range radio

All samples and applications built for multi-core SoCs were migrated to use :ref:`ipc_radio` as the default image for the network core (on nRF5340) or the radio core (on nRF54H20).

The samples previously built for those cores are no longer used in the default builds: :zephyr:code-sample:`bluetooth_hci_ipc`, :zephyr:code-sample:`nrf_ieee802154_rpmsg`, :ref:`multiprotocol-rpmsg-sample`, and :ref:`ble_rpc_host`.
The samples previously built for those cores are no longer used in the default builds: :zephyr:code-sample:`bluetooth_hci_ipc`, :zephyr:code-sample:`nrf_ieee802154_rpmsg`, ``nRF5340: Multiprotocol RPMsg``, and :ref:`ble_rpc_host`.

.. _nrf5340_audio_migration_notes_2.7:

Expand Down
2 changes: 0 additions & 2 deletions doc/nrf/releases_and_maturity/migration/migration_sysbuild.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,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
2 changes: 1 addition & 1 deletion doc/nrf/releases_and_maturity/releases/release-notes-1.5.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ nRF5340 SoC

* Added:

* :ref:`multiprotocol-rpmsg-sample` sample for network core, which enables support for multiprotocol, IEEE 802.15.4, and Bluetooth LE applications.
* ``nRF5340: Multiprotocol RPMsg`` sample for network core, which enables support for multiprotocol, IEEE 802.15.4, and Bluetooth LE applications.

* Updated:

Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/releases_and_maturity/releases/release-notes-2.2.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,7 @@ Matter samples
nRF5340 samples
---------------

* :ref:`multiprotocol-rpmsg-sample` sample:
* ``nRF5340: Multiprotocol RPMsg`` sample:

* Updated by decreasing the maximum supported number of concurrent Bluetooth LE connections to four.

Expand Down
Loading
Loading