nrf_modem: doc: Add RS Capture API

Added API documentation for RS Capture API.

Signed-off-by: Tommi Rantanen <[email protected]>

Author: trantanen

nrf_modem/doc/CHANGELOG.rst

@@ -9,6 +9,14 @@ Changelog
 
 All notable changes to this project are documented in this file.
 
+nrf_modem
+*********
+
+Core library
+============
+
+* Added the :ref:`nrf_modem_rs_capture_api` to receive reference signal samples.
+
 nrf_modem 3.1.0
 ***************
 

nrf_modem/doc/api.rst

@@ -258,6 +258,13 @@ SoftSIM API
 
 .. doxygengroup:: nrf_modem_softsim
 
+.. _nrf_modem_rs_capture_api:
+
+RS Capture API
+**************
+
+.. doxygengroup:: nrf_modem_rs_capture
+
 OS specific definitions
 ***********************
 

nrf_modem/doc/variant_features.rst

@@ -12,31 +12,33 @@ The features of the nRF91 Series firmware that are common across firmware varian
 
 The table below shows which feature and API is supported in which Modem library variant:
 
-+------------------------------+--------------------------------+----------+--------------+
-| Feature                      | API header                     | Cellular | DECT NR+ PHY |
-+==============================+================================+==========+==============+
-| Modem SoC management         | :file:`nrf_modem.h`            | Yes      | Yes          |
-+------------------------------+--------------------------------+----------+--------------+
-| :ref:`nrf_modem_fault`       | :file:`nrf_modem.h`            | Yes      | Yes          |
-+------------------------------+--------------------------------+----------+--------------+
-| :ref:`nrf_modem_trace`       | :file:`nrf_modem_trace.h`      | Yes      | Yes          |
-+------------------------------+--------------------------------+----------+--------------+
-| :ref:`nrf_modem_bootloader`  | :file:`nrf_modem_bootloader.h` | Yes      | Yes          |
-+------------------------------+--------------------------------+----------+--------------+
-| :ref:`nrf_modem_delta_dfu`   | :file:`nrf_modem_delta_dfu.h`  | Yes      | Yes          |
-+------------------------------+--------------------------------+----------+--------------+
-| :ref:`nrf_modem_log`         | :file:`nrf_modem_os.h`         | Yes      | Yes          |
-+------------------------------+--------------------------------+----------+--------------+
-| :ref:`nrf_modem_at`          | :file:`nrf_modem_at.h`         | Yes      | Yes          |
-+------------------------------+--------------------------------+----------+--------------+
-| :ref:`nrf_modem_dect_phy`    | :file:`nrf_modem_dect_phy.h`   | No       | Yes          |
-+------------------------------+--------------------------------+----------+--------------+
-| :ref:`nrf_sockets`           | :file:`nrf_socket.h`           | Yes      | No           |
-+------------------------------+--------------------------------+----------+--------------+
-| :ref:`nrf_modem_gnss`        | :file:`nrf_modem_gnss.h`       | Yes      | No           |
-+------------------------------+--------------------------------+----------+--------------+
-| :ref:`nrf_modem_softsim`     | :file:`nrf_modem_softsim.h`    | Yes      | No           |
-+------------------------------+--------------------------------+----------+--------------+
++---------------------------------+--------------------------------+----------+--------------+
+| Feature                         | API header                     | Cellular | DECT NR+ PHY |
++=================================+================================+==========+==============+
+| Modem SoC management            | :file:`nrf_modem.h`            | Yes      | Yes          |
++---------------------------------+--------------------------------+----------+--------------+
+| :ref:`nrf_modem_fault`          | :file:`nrf_modem.h`            | Yes      | Yes          |
++---------------------------------+--------------------------------+----------+--------------+
+| :ref:`nrf_modem_trace`          | :file:`nrf_modem_trace.h`      | Yes      | Yes          |
++---------------------------------+--------------------------------+----------+--------------+
+| :ref:`nrf_modem_bootloader`     | :file:`nrf_modem_bootloader.h` | Yes      | Yes          |
++---------------------------------+--------------------------------+----------+--------------+
+| :ref:`nrf_modem_delta_dfu`      | :file:`nrf_modem_delta_dfu.h`  | Yes      | Yes          |
++---------------------------------+--------------------------------+----------+--------------+
+| :ref:`nrf_modem_log`            | :file:`nrf_modem_os.h`         | Yes      | Yes          |
++---------------------------------+--------------------------------+----------+--------------+
+| :ref:`nrf_modem_at`             | :file:`nrf_modem_at.h`         | Yes      | Yes          |
++---------------------------------+--------------------------------+----------+--------------+
+| :ref:`nrf_modem_dect_phy`       | :file:`nrf_modem_dect_phy.h`   | No       | Yes          |
++---------------------------------+--------------------------------+----------+--------------+
+| :ref:`nrf_sockets`              | :file:`nrf_socket.h`           | Yes      | No           |
++---------------------------------+--------------------------------+----------+--------------+
+| :ref:`nrf_modem_gnss`           | :file:`nrf_modem_gnss.h`       | Yes      | No           |
++---------------------------------+--------------------------------+----------+--------------+
+| :ref:`nrf_modem_softsim`        | :file:`nrf_modem_softsim.h`    | Yes      | No           |
++---------------------------------+--------------------------------+----------+--------------+
+| :ref:`nrf_modem_rs_capture_api` | :file:`nrf_modem_rs_capture.h` | Yes      | No           |
++---------------------------------+--------------------------------+----------+--------------+
 
 .. note::
    Although the Modem library AT interface is fully supported by both Modem library variants, the AT command set supported by the cellular and DECT NR+ PHY firmware is different.

nrf_modem/include/nrf_modem_rs_capture.h

@@ -99,7 +99,7 @@ struct nrf_modem_rs_capture_prs_config {
 	 * Offsets are relative to the normal LTE gain settings for the serving cell.
 	 *
 	 * This pattern is repeated one after the other in the RS capture procedure.
-	 * The table must be filled entirely but same value can be set into several indices.
+	 * The table must be filled entirely, but the same value can be set into several indices.
 	 * The first value is applied in the first PRS occasion after SFN0.
 	 */
 	int8_t gain_offset[16];
@@ -109,7 +109,7 @@ struct nrf_modem_rs_capture_prs_config {
 	 * Narrowband 0 is reserved for the central narrowband exactly in the middle of system BW.
 	 *
 	 * This pattern is repeated one after the other in the RS capture procedure.
-	 * The table must be filled entirely but same value can be set into several indices.
+	 * The table must be filled entirely, but the same value can be set into several indices.
 	 * The first value is applied in the first PRS occasion after SFN0.
 	 */
 	uint8_t nb_pattern[16];
@@ -144,7 +144,7 @@ struct nrf_modem_rs_capture_prs_sample {
 	uint16_t mnc;
 	/** Index of the configuration used to capture the sample. Range: 0 ... 255
 	 *
-	 * Index matches to the one given in @ref nrf_modem_rs_capture_prs_config.
+	 * Index matches the one given in @ref nrf_modem_rs_capture_prs_config.
 	 */
 	uint8_t index;
 	/** Narrowband. Range: 0...16.
@@ -185,7 +185,7 @@ struct nrf_modem_rs_capture_prs_sample {
 	 * Only OFDM symbols containing PRS are stored except in 4 TX antenna configuration, where
 	 * every eight symbols is invalid.
 	 *
-	 * If present based on @ref num_samples variable, number of samples is
+	 * If present based on @ref num_samples variable, number of samples are
 	 * 2 (I+Q) * 8 PRS symbols * 8 PRBs * 12 subcarriers = 1536 samples.
 	 *
 	 * Centermost 6 PRB's (#1..#6, from #0..#7) within these 8 PRB's always correspond to