shields: nrf21540ek: no more explicit pin-forwarder shield

ankuns · nordicjm · commit 20f055c7d81e · 2024-11-28T09:40:16.000Z
The nrf21540ek_fwd is no more necessary and deprecated. Build system
picks appropriate overlay (being either a pin-forwarder or the main
fem overlay) based on content of `boards` directory.
User does not need to pass different values for `-DSHIELD` for every
core on the SoC. It is handled on the shield level and passing just
`-DSHIELD=nrf21540ek` for all cores is enough.

Signed-off-by: Andrzej Kuros &lt;andrzej.kuros@nordicsemi.no&gt;
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -57,6 +57,7 @@
 /boards/shields/coverage_support/         @nrfconnect/ncs-low-level-test
 /boards/shields/nrf2220ek/                @nrfconnect/ncs-radio-sw
 /boards/shields/nrf2240ek/                @nrfconnect/ncs-radio-sw
+/boards/shields/nrf21540ek/               @nrfconnect/ncs-radio-sw
 /boards/shields/pca63566/doc/*.rst        @nrfconnect/ncs-doc-leads
 
 # SUIT configuration files
diff --git a/applications/nrf5340_audio/doc/configuration.rst b/applications/nrf5340_audio/doc/configuration.rst
@@ -88,12 +88,12 @@ Adding FEM support happens when :ref:`nrf53_audio_app_building`.
 You can use one of the following options, depending on how you decide to build the application:
 
 * If you opt for :ref:`nrf53_audio_app_building_script`, add the ``--nrf21540`` to the script's building command.
-* If you opt for :ref:`nrf53_audio_app_building_standard`, add the ``-Dnrf5340_audio_SHIELD=nrf21540ek_fwd -Dipc_radio_SHIELD=nrf21540ek`` to the ``west build`` command.
+* If you opt for :ref:`nrf53_audio_app_building_standard`, add the ``-Dnrf5340_audio_SHIELD=nrf21540ek -Dipc_radio_SHIELD=nrf21540ek`` to the ``west build`` command.
   For example:
 
   .. code-block:: console
 
-     west build -b nrf5340_audio_dk/nrf5340/cpuapp --pristine -- -DCONFIG_AUDIO_DEV=1 -Dnrf5340_audio_SHIELD=nrf21540ek_fwd -Dipc_radio_SHIELD=nrf21540ek
+     west build -b nrf5340_audio_dk/nrf5340/cpuapp --pristine -- -DCONFIG_AUDIO_DEV=1 -Dnrf5340_audio_SHIELD=nrf21540ek -Dipc_radio_SHIELD=nrf21540ek
 
 To set the TX power output, use the ``CONFIG_BT_CTLR_TX_PWR_ANTENNA`` and ``CONFIG_MPSL_FEM_NRF21540_TX_GAIN_DB`` Kconfig options in :file:`applications/nrf5340_audio/sysbuild/ipc_radio/prj.conf`.
 
diff --git a/applications/nrf5340_audio/src/bluetooth/bt_management/controller_config/Kconfig b/applications/nrf5340_audio/src/bluetooth/bt_management/controller_config/Kconfig
@@ -10,7 +10,7 @@ menu "Controller config"
 menu "nRF21540"
 
 config NRF_21540_ACTIVE
-	def_bool $(shields_list_contains,nrf21540ek_fwd)
+	def_bool $(shields_list_contains,nrf21540ek)
 	select EXPERIMENTAL
 	help
 	  The front end module can help boost the TX power as high as 20 dBm.
diff --git a/applications/nrf5340_audio/tools/buildprog/buildprog.py b/applications/nrf5340_audio/tools/buildprog/buildprog.py
@@ -112,7 +112,7 @@ def __build_cmd_get(core: Core, device: AudioDevice, build: BuildType,
             device_flag += " -DCONFIG_NCS_INCLUDE_RPMSG_CHILD_IMAGE=n"
 
         if options.nrf21540:
-            device_flag += " -Dnrf5340_audio_SHIELD=nrf21540ek_fwd"
+            device_flag += " -Dnrf5340_audio_SHIELD=nrf21540ek"
             device_flag += " -Dipc_radio_SHIELD=nrf21540ek"
 
         if options.custom_bt_name is not None and options.user_bt_name:
diff --git a/applications/nrf_desktop/nRF21540ek_support.rst b/applications/nrf_desktop/nRF21540ek_support.rst
@@ -35,6 +35,6 @@ The command for ``nrf5340dk/nrf5340/cpuapp`` with ``nrf21540ek`` shield would lo
 
 .. code-block:: console
 
-   west build -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf21540ek_fwd -Dipc_radio_SHIELD=nrf21540ek -DCONFIG_CAF_BLE_USE_LLPM=n
+   west build -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf21540ek -Dipc_radio_SHIELD=nrf21540ek -DCONFIG_CAF_BLE_USE_LLPM=n
 
 For detailed information about building an application using the nRF21540 EK, see the :ref:`ug_radio_fem_nrf21540ek_programming` section in the Working with RF Front-end modules documentation.
diff --git a/applications/nrf_desktop/sample.yaml b/applications/nrf_desktop/sample.yaml
@@ -137,7 +137,7 @@ tests:
     platform_allow: nrf5340dk/nrf5340/cpuapp
     integration_platforms:
       - nrf5340dk/nrf5340/cpuapp
-    extra_args: SHIELD=nrf21540ek_fwd
+    extra_args: SHIELD=nrf21540ek
                 ipc_radio_SHIELD=nrf21540ek
     extra_configs:
       - CONFIG_CAF_BLE_USE_LLPM=n
diff --git a/boards/shields/nrf21540ek/boards/nrf52833dk_nrf52833.overlay b/boards/shields/nrf21540ek/boards/nrf52833dk_nrf52833.overlay
@@ -0,0 +1,6 @@
+/* Copyright (c) 2024 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#include "../common/arduino_compatible.overlay"
diff --git a/boards/shields/nrf21540ek/boards/nrf52840dk_nrf52840.overlay b/boards/shields/nrf21540ek/boards/nrf52840dk_nrf52840.overlay
@@ -0,0 +1,6 @@
+/* Copyright (c) 2024 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#include "../common/arduino_compatible.overlay"
diff --git a/boards/shields/nrf21540ek/boards/nrf5340_audio_dk_nrf5340_cpuapp.overlay b/boards/shields/nrf21540ek/boards/nrf5340_audio_dk_nrf5340_cpuapp.overlay
@@ -0,0 +1,6 @@
+/* Copyright (c) 2024 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#include "../common/arduino_compatible_fwd.overlay"
diff --git a/boards/shields/nrf21540ek/boards/nrf5340_audio_dk_nrf5340_cpunet.overlay b/boards/shields/nrf21540ek/boards/nrf5340_audio_dk_nrf5340_cpunet.overlay
@@ -0,0 +1,6 @@
+/* Copyright (c) 2024 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#include "../common/arduino_compatible.overlay"
diff --git a/boards/shields/nrf21540ek/boards/nrf5340dk_nrf5340_cpuapp.overlay b/boards/shields/nrf21540ek/boards/nrf5340dk_nrf5340_cpuapp.overlay
@@ -0,0 +1,6 @@
+/* Copyright (c) 2024 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#include "../common/arduino_compatible_fwd.overlay"
diff --git a/boards/shields/nrf21540ek/boards/nrf5340dk_nrf5340_cpunet.overlay b/boards/shields/nrf21540ek/boards/nrf5340dk_nrf5340_cpunet.overlay
@@ -0,0 +1,6 @@
+/* Copyright (c) 2024 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#include "../common/arduino_compatible.overlay"
diff --git a/boards/shields/nrf21540ek/common/arduino_compatible.overlay b/boards/shields/nrf21540ek/common/arduino_compatible.overlay
@@ -0,0 +1,29 @@
+/* Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+/ {
+	nrf_radio_fem: nrf21540_fem {
+		compatible = "nordic,nrf21540-fem";
+		tx-en-gpios = <&arduino_header 11 GPIO_ACTIVE_HIGH>;   /* D5 */
+		rx-en-gpios = <&arduino_header 9 GPIO_ACTIVE_HIGH>;    /* D3 */
+		pdn-gpios = <&arduino_header 15 GPIO_ACTIVE_HIGH>;     /* D9 */
+		ant-sel-gpios = <&arduino_header 10 GPIO_ACTIVE_HIGH>; /* D4 */
+		mode-gpios = <&arduino_header 8 GPIO_ACTIVE_HIGH>;     /* D2 */
+		spi-if = <&nrf_radio_fem_spi>;
+		supply-voltage-mv = <3000>;
+	};
+};
+
+fem_spi: &arduino_spi {
+	status = "okay";
+	cs-gpios = <&arduino_header 16 GPIO_ACTIVE_LOW>; /* D10 */
+
+	nrf_radio_fem_spi: nrf21540_fem_spi@0 {
+		compatible = "nordic,nrf21540-fem-spi";
+		status = "okay";
+		reg = <0>;
+		spi-max-frequency = <8000000>;
+	};
+};
diff --git a/boards/shields/nrf21540ek/common/arduino_compatible_fwd.overlay b/boards/shields/nrf21540ek/common/arduino_compatible_fwd.overlay
@@ -0,0 +1,20 @@
+/* Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+&gpio_fwd {
+	nrf21540-gpio-if {
+		gpios = <&arduino_header 11 0>,		/* tx-en-gpios */
+			<&arduino_header 9 0>,		/* rx-en-gpios */
+			<&arduino_header 15 0>,		/* pdn-gpios */
+			<&arduino_header 10 0>,		/* ant-sel-gpios */
+			<&arduino_header 8 0>;		/* mode-gpios */
+	};
+	nrf21540-spi-if {
+		gpios = <&arduino_header 16 0>,		/* cs-gpios */
+			<&gpio1 15 0>,			/* SPIM_SCK */
+			<&gpio1 14 0>,			/* SPIM_MISO */
+			<&gpio1 13 0>;			/* SPIM_MOSI */
+	};
+};
diff --git a/boards/shields/nrf21540ek/nrf21540ek.overlay b/boards/shields/nrf21540ek/nrf21540ek.overlay
@@ -3,27 +3,8 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
  */
 
-/ {
-	nrf_radio_fem: nrf21540_fem {
-		compatible = "nordic,nrf21540-fem";
-		tx-en-gpios = <&arduino_header 11 GPIO_ACTIVE_HIGH>;   /* D5 */
-		rx-en-gpios = <&arduino_header 9 GPIO_ACTIVE_HIGH>;    /* D3 */
-		pdn-gpios = <&arduino_header 15 GPIO_ACTIVE_HIGH>;     /* D9 */
-		ant-sel-gpios = <&arduino_header 10 GPIO_ACTIVE_HIGH>; /* D4 */
-		mode-gpios = <&arduino_header 8 GPIO_ACTIVE_HIGH>;     /* D2 */
-		spi-if = <&nrf_radio_fem_spi>;
-		supply-voltage-mv = <3000>;
-	};
-};
-
-fem_spi: &arduino_spi {
-	status = "okay";
-	cs-gpios = <&arduino_header 16 GPIO_ACTIVE_LOW>; /* D10 */
-
-	nrf_radio_fem_spi: nrf21540_fem_spi@0 {
-		compatible = "nordic,nrf21540-fem-spi";
-		status = "okay";
-		reg = <0>;
-		spi-max-frequency = <8000000>;
-	};
-};
+/* Integration of this shield differs depending on board. The proper overlay file
+ * is provided through one of suitable overlays in the 'boards' directory.
+ * However the file here must exist here to satisfy the way the Zephyr finds
+ * a shield support.
+ */
diff --git a/boards/shields/nrf21540ek/nrf21540ek_fwd.overlay b/boards/shields/nrf21540ek/nrf21540ek_fwd.overlay
@@ -4,27 +4,8 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
  */
 
-/* This file matches the contents of nrf21540ek.overlay and is intended to be applied to nRF5340
- * application core when nrf21540ek shield is provided to the network core's image build.
- *
- * For instance, consider an application targeted for nRF5340 application core that specifies
- * a child image targeted for nRF5340 network core, which drives the nRF21540 Front-End Module.
- * The shield overlays could be provided to the build using the following command:
- *
- * west build -p -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf21540ek_fwd -D<child_image>_SHIELD=nrf21540ek
+/* The direct use of SHIELD=nrf21540ek_fwd is no more necessary and deprecated.
+ * Please use just -DSHIELD=nrf21540ek or -D<app_image>_SHIELD=nrf21540ek.
+ * For multi-core devices appropriate overlay for the shield will be picked
+ * by the build system automatically.
  */
-&gpio_fwd {
-	nrf21540-gpio-if {
-		gpios = <&arduino_header 11 0>,		/* tx-en-gpios */
-			<&arduino_header 9 0>,		/* rx-en-gpios */
-			<&arduino_header 15 0>,		/* pdn-gpios */
-			<&arduino_header 10 0>,		/* ant-sel-gpios */
-			<&arduino_header 8 0>;		/* mode-gpios */
-	};
-	nrf21540-spi-if {
-		gpios = <&arduino_header 16 0>,		/* cs-gpios */
-			<&gpio1 15 0>,			/* SPIM_SCK */
-			<&gpio1 14 0>,			/* SPIM_MISO */
-			<&gpio1 13 0>;			/* SPIM_MOSI */
-	};
-};
diff --git a/doc/nrf/app_dev/device_guides/fem/21540ek_dev_guide.rst b/doc/nrf/app_dev/device_guides/fem/21540ek_dev_guide.rst
@@ -46,13 +46,13 @@ Building for a multicore board
 
 When building for a board with an additional network core, like the nRF5340, add the ``-DSHIELD`` variable with the *childImageName_* parameter between ``-D`` and ``SHIELD`` to build for the network core.
 In this case, the application core is only responsible for forwarding to the network core the pins needed to control the nRF21540 EK.
-The application core can be set up to forward the needed pins using the ``-DSHIELD=nrf21540ek_fwd`` setting.
+The application core can be set up to forward the needed pins using the ``-DSHIELD=nrf21540ek`` setting.
 For example:
 
 .. parsed-literal::
    :class: highlight
 
-   west build -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf21540ek_fwd -Dipc_radio_SHIELD=nrf21540ek
+   west build -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf21540ek -Dipc_radio_SHIELD=nrf21540ek
 
 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.
 The ``ipc_radio`` has been used since the build system migration to sysbuild.
diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
@@ -84,7 +84,8 @@ Developing with nRF52 Series
 Developing with Front-End Modules
 =================================
 
-|no_changes_yet_note|
+* Deprecated the explicit use of ``-DSHIELD=nrf21540ek_fwd`` for boards with ``nrf5340/cpuapp`` qualifiers when the nRF21540 EK shield is used.
+  The build system uses an appropriate overlay file for each core, relying only on the ``-DSHIELD=nrf21540ek`` parameter.
 
 Developing with PMICs
 =====================
diff --git a/samples/matter/light_bulb/sample.yaml b/samples/matter/light_bulb/sample.yaml
@@ -64,7 +64,7 @@ tests:
   sample.matter.light_bulb.debug.nrf21540ek_fwd:
     sysbuild: true
     build_only: true
-    extra_args: light_bulb_SHIELD=nrf21540ek_fwd multiprotocol_rpmsg_SHIELD=nrf21540ek
+    extra_args: light_bulb_SHIELD=nrf21540ek multiprotocol_rpmsg_SHIELD=nrf21540ek
     integration_platforms:
       - nrf5340dk/nrf5340/cpuapp
     platform_allow: nrf5340dk/nrf5340/cpuapp
