You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
doc: shields: nrf21540ek: no more explicit pin-forwarder shield
Update documentation regarding -DSHIELD=nrf21540ek.
This change is due to deprecation of explicit pin-forwarding
"pseudo shield".
Updated also the chapter "Enabling GPIO mode support for nRF21540"
to recommend uage of gpio forwarder.
Signed-off-by: Andrzej Kuros <[email protected]>
Copy file name to clipboardExpand all lines: doc/nrf/app_dev/device_guides/fem/21540ek_dev_guide.rst
+20-8Lines changed: 20 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -44,17 +44,29 @@ Alternatively, add the shield in the project's :file:`CMakeLists.txt` file:
44
44
Building for a multicore board
45
45
==============================
46
46
47
-
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.
48
-
In this case, the application core is only responsible for forwarding to the network core the pins needed to control the nRF21540 EK.
49
-
The application core can be set up to forward the needed pins using the ``-DSHIELD=nrf21540ek`` setting.
50
-
For example:
47
+
When building for a board with an additional network core, like the nRF5340, add the ``-DSHIELD`` parameter to the command line:
51
48
52
-
.. parsed-literal::
53
-
:class: highlight
49
+
.. code-block:: console
50
+
51
+
west build -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf21540ek
52
+
53
+
In this case, the sysbuild will pass the *SHIELD=nrf21540ek* variable to all images that are built by the command.
54
+
The build system will pick automatically appropriate overlay and configuration files for images for each core.
55
+
Please note that the files are different for each of the cores.
56
+
For the application core the overlay containing forwarding the FEM pins to the network core will be used.
57
+
For the network core the overlay enabling nRF21540 FEM on the network core will be used.
58
+
In case the application contains additional images for which the *SHIELD* variable should not be passed, you must pass manually the *SHIELD* variable to each relevant image build separately.
59
+
60
+
.. code-block:: console
61
+
62
+
west build -b nrf5340dk/nrf5340/cpuapp -- -D<app_name_image>_SHIELD=nrf21540ek -Dipc_radio_SHIELD=nrf21540ek
54
63
55
-
west build -b nrf5340dk/nrf5340/cpuapp -- -DSHIELD=nrf21540ek -Dipc_radio_SHIELD=nrf21540ek
64
+
In this case the *SHIELD=nrf21540ek* will be passed to the build of the *app_image_name* image for the application core.
65
+
The build system will pick automatically an overlay file containing forwarding the FEM pins to the network core.
66
+
The *SHIELD=nrf21540ek* variable will be passed to the build of the ``ipc_radio`` image for the network core.
67
+
The build system will pick automatically an overlay file enabling nRF21540 FEM on the network core.
56
68
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.
69
+
In this command, the ``ipc_radio`` image us used as default and builds the network core image with support for the combination of 802.15.4 and Bluetooth.
58
70
The ``ipc_radio`` has been used since the build system migration to sysbuild.
59
71
See :ref:`Migrating to sysbuild <child_parent_to_sysbuild_migration>` page.
60
72
Setting the correct sysbuild option enables support for 802.15.4 and Bluetooth :ref:`ipc_radio`.
Copy file name to clipboardExpand all lines: doc/nrf/app_dev/device_guides/fem/fem_nrf21540_gpio.rst
+11-12Lines changed: 11 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,18 +51,17 @@ To use nRF21540 in GPIO mode, complete the following steps:
51
51
52
52
The state of the remaining control pins should be set in other ways and according to `nRF21540 Product Specification`_.
53
53
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.
54
+
#. On nRF53 devices, the devicetree nodes described above must be added to the network core.
55
+
For the application core, you must also add a GPIO forwarder node to its devicetree file:
57
56
58
-
The *childImageName* default value is set to ``ipc_radio``:
57
+
.. code-block:: devicetree
59
58
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.
59
+
&gpio_fwd {
60
+
nrf21540-gpio-if {
61
+
gpios = <&gpio0 13 0>, /* tx-en-gpios */
62
+
<&gpio0 14 0>, /* rx-en-gpios */
63
+
<&gpio0 15 0>; /* pdn-gpios */
64
+
};
65
+
};
66
66
67
-
.. note::
68
-
This step is not needed when testing with :ref:`direct_test_mode` and :ref:`radio_test` on the nRF53 Series devices.
67
+
The pins defined in the GPIO forwarder node in the application core's devicetree file must match the pins defined in the FEM nodes in the network core's devicetree file.
0 commit comments