Skip to content

Commit 88362b6

Browse files
trantanennordic-hani
trantanen
authored and
nordic-hani
committed
nrf_modem: doc: Add RS Capture API
Added API documentation for RS Capture API. Signed-off-by: Tommi Rantanen <[email protected]>
1 parent ca0134e commit 88362b6

File tree

4 files changed

+46
-29
lines changed

4 files changed

+46
-29
lines changed

‎nrf_modem/doc/CHANGELOG.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ Changelog
99

1010
All notable changes to this project are documented in this file.
1111

12+
nrf_modem
13+
*********
14+
15+
Core library
16+
============
17+
18+
* Added the :ref:`nrf_modem_rs_capture_api` to receive reference signal samples.
19+
1220
nrf_modem 3.1.0
1321
***************
1422

‎nrf_modem/doc/api.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,13 @@ SoftSIM API
258258

259259
.. doxygengroup:: nrf_modem_softsim
260260

261+
.. _nrf_modem_rs_capture_api:
262+
263+
RS Capture API
264+
**************
265+
266+
.. doxygengroup:: nrf_modem_rs_capture
267+
261268
OS specific definitions
262269
***********************
263270

‎nrf_modem/doc/variant_features.rst‎

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,31 +12,33 @@ The features of the nRF91 Series firmware that are common across firmware varian
1212

1313
The table below shows which feature and API is supported in which Modem library variant:
1414

15-
+------------------------------+--------------------------------+----------+--------------+
16-
| Feature | API header | Cellular | DECT NR+ PHY |
17-
+==============================+================================+==========+==============+
18-
| Modem SoC management | :file:`nrf_modem.h` | Yes | Yes |
19-
+------------------------------+--------------------------------+----------+--------------+
20-
| :ref:`nrf_modem_fault` | :file:`nrf_modem.h` | Yes | Yes |
21-
+------------------------------+--------------------------------+----------+--------------+
22-
| :ref:`nrf_modem_trace` | :file:`nrf_modem_trace.h` | Yes | Yes |
23-
+------------------------------+--------------------------------+----------+--------------+
24-
| :ref:`nrf_modem_bootloader` | :file:`nrf_modem_bootloader.h` | Yes | Yes |
25-
+------------------------------+--------------------------------+----------+--------------+
26-
| :ref:`nrf_modem_delta_dfu` | :file:`nrf_modem_delta_dfu.h` | Yes | Yes |
27-
+------------------------------+--------------------------------+----------+--------------+
28-
| :ref:`nrf_modem_log` | :file:`nrf_modem_os.h` | Yes | Yes |
29-
+------------------------------+--------------------------------+----------+--------------+
30-
| :ref:`nrf_modem_at` | :file:`nrf_modem_at.h` | Yes | Yes |
31-
+------------------------------+--------------------------------+----------+--------------+
32-
| :ref:`nrf_modem_dect_phy` | :file:`nrf_modem_dect_phy.h` | No | Yes |
33-
+------------------------------+--------------------------------+----------+--------------+
34-
| :ref:`nrf_sockets` | :file:`nrf_socket.h` | Yes | No |
35-
+------------------------------+--------------------------------+----------+--------------+
36-
| :ref:`nrf_modem_gnss` | :file:`nrf_modem_gnss.h` | Yes | No |
37-
+------------------------------+--------------------------------+----------+--------------+
38-
| :ref:`nrf_modem_softsim` | :file:`nrf_modem_softsim.h` | Yes | No |
39-
+------------------------------+--------------------------------+----------+--------------+
15+
+---------------------------------+--------------------------------+----------+--------------+
16+
| Feature | API header | Cellular | DECT NR+ PHY |
17+
+=================================+================================+==========+==============+
18+
| Modem SoC management | :file:`nrf_modem.h` | Yes | Yes |
19+
+---------------------------------+--------------------------------+----------+--------------+
20+
| :ref:`nrf_modem_fault` | :file:`nrf_modem.h` | Yes | Yes |
21+
+---------------------------------+--------------------------------+----------+--------------+
22+
| :ref:`nrf_modem_trace` | :file:`nrf_modem_trace.h` | Yes | Yes |
23+
+---------------------------------+--------------------------------+----------+--------------+
24+
| :ref:`nrf_modem_bootloader` | :file:`nrf_modem_bootloader.h` | Yes | Yes |
25+
+---------------------------------+--------------------------------+----------+--------------+
26+
| :ref:`nrf_modem_delta_dfu` | :file:`nrf_modem_delta_dfu.h` | Yes | Yes |
27+
+---------------------------------+--------------------------------+----------+--------------+
28+
| :ref:`nrf_modem_log` | :file:`nrf_modem_os.h` | Yes | Yes |
29+
+---------------------------------+--------------------------------+----------+--------------+
30+
| :ref:`nrf_modem_at` | :file:`nrf_modem_at.h` | Yes | Yes |
31+
+---------------------------------+--------------------------------+----------+--------------+
32+
| :ref:`nrf_modem_dect_phy` | :file:`nrf_modem_dect_phy.h` | No | Yes |
33+
+---------------------------------+--------------------------------+----------+--------------+
34+
| :ref:`nrf_sockets` | :file:`nrf_socket.h` | Yes | No |
35+
+---------------------------------+--------------------------------+----------+--------------+
36+
| :ref:`nrf_modem_gnss` | :file:`nrf_modem_gnss.h` | Yes | No |
37+
+---------------------------------+--------------------------------+----------+--------------+
38+
| :ref:`nrf_modem_softsim` | :file:`nrf_modem_softsim.h` | Yes | No |
39+
+---------------------------------+--------------------------------+----------+--------------+
40+
| :ref:`nrf_modem_rs_capture_api` | :file:`nrf_modem_rs_capture.h` | Yes | No |
41+
+---------------------------------+--------------------------------+----------+--------------+
4042

4143
.. note::
4244
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‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ struct nrf_modem_rs_capture_prs_config {
9999
* Offsets are relative to the normal LTE gain settings for the serving cell.
100100
*
101101
* This pattern is repeated one after the other in the RS capture procedure.
102-
* The table must be filled entirely but same value can be set into several indices.
102+
* The table must be filled entirely, but the same value can be set into several indices.
103103
* The first value is applied in the first PRS occasion after SFN0.
104104
*/
105105
int8_t gain_offset[16];
@@ -109,7 +109,7 @@ struct nrf_modem_rs_capture_prs_config {
109109
* Narrowband 0 is reserved for the central narrowband exactly in the middle of system BW.
110110
*
111111
* This pattern is repeated one after the other in the RS capture procedure.
112-
* The table must be filled entirely but same value can be set into several indices.
112+
* The table must be filled entirely, but the same value can be set into several indices.
113113
* The first value is applied in the first PRS occasion after SFN0.
114114
*/
115115
uint8_t nb_pattern[16];
@@ -144,7 +144,7 @@ struct nrf_modem_rs_capture_prs_sample {
144144
uint16_t mnc;
145145
/** Index of the configuration used to capture the sample. Range: 0 ... 255
146146
*
147-
* Index matches to the one given in @ref nrf_modem_rs_capture_prs_config.
147+
* Index matches the one given in @ref nrf_modem_rs_capture_prs_config.
148148
*/
149149
uint8_t index;
150150
/** Narrowband. Range: 0...16.
@@ -185,7 +185,7 @@ struct nrf_modem_rs_capture_prs_sample {
185185
* Only OFDM symbols containing PRS are stored except in 4 TX antenna configuration, where
186186
* every eight symbols is invalid.
187187
*
188-
* If present based on @ref num_samples variable, number of samples is
188+
* If present based on @ref num_samples variable, number of samples are
189189
* 2 (I+Q) * 8 PRS symbols * 8 PRBs * 12 subcarriers = 1536 samples.
190190
*
191191
* Centermost 6 PRB's (#1..#6, from #0..#7) within these 8 PRB's always correspond to

0 commit comments

Comments
 (0)