samples: dect: add simple sample

Add simple dect sample.

Co-authored-by: divya pillai <[email protected]>
Signed-off-by: Eivind Jølsgard <[email protected]>

doc/nrf/links.txt

@@ -1275,6 +1275,8 @@
 .. _`3GPP TS 24.008 Ch. 10.5.7.3`: https://www.etsi.org/deliver/etsi_ts/124000_124099/124008/13.07.00_60/ts_124008v130700p.pdf#page=667
 .. _`3GPP TS 24.008 Ch. 10.5.7.4a`: https://www.etsi.org/deliver/etsi_ts/124000_124099/124008/13.07.00_60/ts_124008v130700p.pdf#page=668
 .. _`LTE Positioning Protocol (LPP)`: https://www.etsi.org/deliver/etsi_ts/136300_136399/136355/11.01.00_60/ts_136355v110100p.pdf#page=12
+.. _`ETSI TS 103 636-4`: https://www.etsi.org/deliver/etsi_ts/103600_103699/10363604/01.03.01_60/ts_10363604v010301p.pdf
+.. _`ETSI TS 103 636-2`: https://www.etsi.org/deliver/etsi_ts/103600_103699/10363602/01.03.01_60/ts_10363602v010301p.pdf
 
 .. ### Source: spdx.dev
 

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

@@ -463,6 +463,11 @@ Debug samples
 
 |no_changes_yet_note|
 
+DECT NR+ samples
+----------------
+
+* Added the :ref:`nrf_modem_dect_phy_hello` sample.
+
 Edge Impulse samples
 --------------------
 

doc/nrf/samples.rst

@@ -32,6 +32,7 @@ If you want to list samples available for one or more specific boards, `use the
    samples/cellular
    samples/crypto
    samples/debug
+   samples/dect
    samples/edge
    samples/esb
    samples/gazell

doc/nrf/samples/dect.rst

@@ -0,0 +1,11 @@
+.. _dect_samples:
+
+DECT NR+ samples
+################
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Subpages
+   :glob:
+
+   ../../../samples/dect/*/*/README

samples/dect/dect_phy/hello_dect/CMakeLists.txt

@@ -0,0 +1,12 @@
+#
+# Copyright (c) 2024 Nordic Semiconductor
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+cmake_minimum_required(VERSION 3.20.0)
+
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+project(hello_dect)
+
+target_sources(app PRIVATE src/main.c)

samples/dect/dect_phy/hello_dect/Kconfig

@@ -0,0 +1,52 @@
+#
+# Copyright (c) 2024 Nordic Semiconductor
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+config CARRIER
+	int "Carrier to use"
+	default 0
+	help
+	   The availability of the channels and the exact regulation to use them varies in different countries.
+	   See ETSI TS 103 636-2 5.4.2 for the calculation.
+
+config NETWORK_ID
+	int "Network ID"
+	range 1 4294967295
+	default 91
+
+config MCS
+	int "MCS"
+	default 1
+	help
+	   The MCS impacts how much data can fit into each subslot.
+
+config TX_POWER
+	int "TX power"
+	range 0 11
+	default 11
+	help
+	   Transmission power, see table 6.2.1-3 of ETSI TS 103 636-4.
+
+config TX_TRANSMISSIONS
+	int "TX transmissions"
+	range 0 4294967295
+	default 30
+	help
+	   Transmissions before sample exits, use 0 to transmit forever.
+
+config RX_PERIOD_S
+	int "RX period"
+	default 5
+	help
+	   Receive window period.
+	   Time is given in seconds.
+
+module = DECT_PHY_HELLO
+module-str = DECT NR+ PHY Hello
+source "${ZEPHYR_BASE}/subsys/logging/Kconfig.template.log_config"
+
+menu "Zephyr Kernel"
+source "Kconfig.zephyr"
+endmenu

samples/dect/dect_phy/hello_dect/README.rst

@@ -0,0 +1,179 @@
+.. _nrf_modem_dect_phy_hello:
+
+nRF91x1: DECT NR+ PHY hello
+###########################
+
+.. contents::
+   :local:
+   :depth: 2
+
+The DECT NR+ physical layer (PHY) hello sample demonstrates how to set up a simple DECT NR+ application with the DECT PHY firmware.
+
+Requirements
+************
+
+The sample supports the following development kits, and requires at least two kits:
+
+.. table-from-sample-yaml::
+
+.. note::
+
+   The :ref:`nrf_modem_dect_phy_hello` sample requires the DECT NR+ PHY firmware to run on the nRF91x1 modem core.
+   For more information, contact the Nordic Semiconductor sales department.
+
+.. include:: /includes/tfm.txt
+
+Overview
+********
+
+The sample shows a simple broadcast and reception of DECT NR+ messages between devices on a hard-coded channel.
+
+After initialization, the devices run into a loop, transmitting a counter value before listening for incoming receptions.
+The time to listen is set by the :ref:`CONFIG_RX_PERIOD_S <CONFIG_RX_PERIOD_S>` Kconfig option.
+The loop is exited after a number of transmissions set by the :ref:`CONFIG_TX_TRANSMISSIONS <CONFIG_TX_TRANSMISSIONS>` Kconfig option, or it continues forever if the :ref:`CONFIG_TX_TRANSMISSIONS <CONFIG_TX_TRANSMISSIONS>` Kconfig option is set to ``0``.
+
+Each device can be reset to run the sample again.
+
+Configuration
+**************
+
+|config|
+
+Configuration options
+=====================
+
+Check and configure the following Kconfig options:
+
+.. _CONFIG_CARRIER:
+
+CONFIG_CARRIER
+   The sample configuration defines the carrier to use.
+   The availability of the channels and the exact regulations for using them vary in different countries.
+   See section 5.4.2 of `ETSI TS 103 636-2`_ for the calculation.
+
+.. _CONFIG_NETWORK_ID:
+
+CONFIG_NETWORK_ID
+   The configuration option specifies the network ID.
+   It ranges from ``1`` to ``4294967295`` with the default value set to ``91``.
+
+.. _CONFIG_MCS:
+
+CONFIG_MCS
+   The configuration option specifies the :term:`Modulation Coding Scheme (MCS)`.
+   The MCS impacts how much data can fit into each subslot.
+   The default value is set to ``1``.
+
+.. _CONFIG_TX_POWER:
+
+CONFIG_TX_POWER
+   The configuration option sets the transmission power.
+   See the table 6.2.1-3 of `ETSI TS 103 636-4`_ for more details.
+   It ranges from ``0`` to ``11`` with the default value set to ``11``.
+
+.. _CONFIG_TX_TRANSMISSIONS:
+
+CONFIG_TX_TRANSMISSIONS
+   The configuration option sets the number of transmissions before the sample exits.
+   It ranges from ``0`` to ``4294967295`` with the default value set to ``30``.
+
+.. _CONFIG_RX_PERIOD_S:
+
+CONFIG_RX_PERIOD_S
+   The sample configuration sets the receive window period.
+   The time is set in seconds.
+   The default value is set to 5 seconds.
+
+Building and running
+********************
+
+.. |sample path| replace:: :file:`samples/modem_trace_flash`
+
+.. include:: /includes/build_and_run_ns.txt
+
+.. important::
+
+   DECT NR+ operates on free but regulated radio channels.
+   The regulations and availability of the channels vary by country and region.
+   It is your responsibility to operate the devices according to local regulations, both at the development site and in the device operating regions.
+   If you are in the EU or US, you can use the ``overlay-eu.conf`` and ``overlay-us.conf`` Kconfig overlays, respectively.
+   Otherwise, set the carrier using the :ref:`CONFIG_CARRIER <CONFIG_CARRIER>` Kconfig option, and the transmission power using the :ref:`CONFIG_TX_POWER <CONFIG_TX_POWER>` Kconfig option.
+
+Testing
+=======
+
+|test_sample|
+
+#. |connect_kit|
+#. |connect_terminal|
+#. Observe that the devices transmit a counter value that is received by the other devices.
+#. After a given number of transmissions, observe that the devices shut down and exit the sample.
+
+Sample output
+=============
+
+The sample shows an output similar to the following:
+
+Device 1:
+
+.. code-block:: console
+
+   *** Booting nRF Connect SDK v3.5.99-ncs1 ***
+   [00:00:00.378,784] <inf> app: Dect NR+ PHY Hello sample started
+   [00:00:00.691,375] <inf> app: Dect NR+ PHY initialized, device ID: 12345
+   [00:00:00.691,406] <inf> app: Transmitting 0
+   [00:00:05.697,784] <inf> app: Transmitting 1
+   [00:00:10.704,193] <inf> app: Transmitting 2
+   [00:00:14.186,553] <inf> app: Received header from device ID 67890
+   [00:00:14.186,889] <inf> app: Received data (RSSI: -54.5): Hello DECT! 0
+   [00:00:15.710,571] <inf> app: Transmitting 3
+   [00:00:19.192,932] <inf> app: Received header from device ID 67890
+   [00:00:19.193,267] <inf> app: Received data (RSSI: -54.5): Hello DECT! 1
+   [00:00:20.716,949] <inf> app: Transmitting 4
+   ...
+   [00:02:24.352,661] <inf> app: Received header from device ID 67890
+   [00:02:24.352,996] <inf> app: Received data (RSSI: -54.5): Hello DECT! 26
+   [00:02:25.876,739] <inf> app: Transmitting 29
+   [00:02:25.876,831] <inf> app: Reached maximum number of transmissions (30)
+   [00:02:25.876,831] <inf> app: Shutting down
+   [00:02:25.893,554] <inf> app: Bye!
+
+Device 2:
+
+.. code-block:: console
+
+   *** Booting nRF Connect SDK v3.5.99-ncs1 ***
+   [00:00:00.407,287] <inf> app: Dect NR+ PHY Hello sample started
+   [00:00:00.719,238] <inf> app: Dect NR+ PHY initialized, device ID: 67890
+   [00:00:00.719,268] <inf> app: Transmitting 0
+   [00:00:02.254,211] <inf> app: Received header from device ID 12345
+   [00:00:02.254,547] <inf> app: Received data (RSSI: -54.5): Hello DECT! 3
+   [00:00:05.725,646] <inf> app: Transmitting 1
+   [00:00:07.260,620] <inf> app: Received header from device ID 12345
+   [00:00:07.260,955] <inf> app: Received data (RSSI: -54.5): Hello DECT! 4
+   ...
+   [00:02:10.885,284] <inf> app: Transmitting 26
+   [00:02:12.420,318] <inf> app: Received header from device ID 12345
+   [00:02:12.420,654] <inf> app: Received data (RSSI: -54.5): Hello DECT! 29
+   [00:02:15.891,693] <inf> app: Transmitting 27
+   [00:02:20.898,071] <inf> app: Transmitting 28
+   [00:02:25.904,449] <inf> app: Transmitting 29
+   [00:02:25.904,541] <inf> app: Reached maximum number of transmissions (30)
+   [00:02:25.904,571] <inf> app: Shutting down
+   [00:02:25.921,325] <inf> app: Bye!
+
+Dependencies
+************
+
+It uses the following `sdk-nrfxlib`_ library:
+
+* :ref:`nrfxlib:nrf_modem`
+
+It uses the following Zephyr library:
+
+* :ref:`zephyr:uart_api`
+
+
+In addition, it uses the following secure firmware component:
+
+* :ref:`Trusted Firmware-M <ug_tfm>`

samples/dect/dect_phy/hello_dect/overlay-eu.conf

@@ -0,0 +1 @@
+CONFIG_CARRIER=1677

samples/dect/dect_phy/hello_dect/overlay-us.conf

@@ -0,0 +1,2 @@
+CONFIG_CARRIER=1711
+CONFIG_TX_POWER=10

samples/dect/dect_phy/hello_dect/prj.conf

@@ -0,0 +1,8 @@
+CONFIG_NRF_MODEM_LIB=y
+
+CONFIG_MODEM_ANTENNA=n
+
+CONFIG_NRF_MODEM_LINK_BINARY_DECT_PHY=y
+CONFIG_HWINFO=y
+
+CONFIG_LOG=y

samples/dect/dect_phy/hello_dect/sample.yaml

@@ -0,0 +1,25 @@
+sample:
+  name: Dect NR+ PHY Hello
+tests:
+  sample.dect_phy.dect_hello.eu.sysbuild:
+    sysbuild: true
+    build_only: true
+    integration_platforms:
+      - nrf9151dk/nrf9151/ns
+      - nrf9161dk/nrf9161/ns
+    platform_allow:
+      - nrf9151dk/nrf9151/ns
+      - nrf9161dk/nrf9161/ns
+    extra_args: EXTRA_CONF_FILE="overlay-eu.conf"
+    tags: ci_build sysbuild
+  sample.dect_phy.dect_hello.us.sysbuild:
+    sysbuild: true
+    build_only: true
+    integration_platforms:
+      - nrf9151dk/nrf9151/ns
+      - nrf9161dk/nrf9161/ns
+    platform_allow:
+      - nrf9151dk/nrf9151/ns
+      - nrf9161dk/nrf9161/ns
+    extra_args: EXTRA_CONF_FILE="overlay-us.conf"
+    tags: ci_build sysbuild