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
Update the documentation to indicate additional APIs for setting/getting
regulatory domain information in radio test mode.
Signed-off-by: Sachin D Kulkarni <Sachin.Kulkarni@nordicsemi.no>
Copy file name to clipboardexpand all lines: nrf70_bm_lib/docs/source/nrf70_bm_lib.rst
+15-4
Original file line number
Diff line number
Diff line change
@@ -29,8 +29,12 @@ The library exposes the following functionality to the user application
29
29
* nRF70 Series device initialization and de-initialization
30
30
* Wi-Fi scan, through a single-function API supporting a wide list of scan configuration parameters
31
31
* Obtaining statistics from the nRF70 Series device
32
+
* Wi-Fi radio test functionality
32
33
33
-
The library is described in a single public-API definition header file ``nrf70_bm_lib.h``.
34
+
The library is described in the following public-API definition header files:
35
+
36
+
* ``system/nrf70_bm_lib.h`` for the Wi-Fi scan functionality.
37
+
* ``radio_test/nrf70_bm_lib.h`` for the Wi-Fi radio test functionality.
34
38
35
39
Being fully RTOS-agnostic, the BM library is portable to any bare-metal or OS environment.
36
40
@@ -121,7 +125,7 @@ The library driver code execute in the following contexts:"
121
125
122
126
* *Tasklet context*: Tasklets perform the actual work of interacting with the nRF70, processing events coming from the device (offloaded tasks from ISRs)
123
127
Only event receive operations are performned in tasklets. Essentially, event receive tasklets read the event data coming from the nRF70 Series device and hand them over to the registered FMAC callbacks.
124
-
An example of such operation is the processing of incoming AP scan results after a scan command has been issued.
128
+
An example of such operation is the processing of incoming AP scan results after a scan command has been issued.
125
129
126
130
.. note::
127
131
In the reference implementation for Zephyr tasklet work is offloaded to Zephyr kernel workqueues.
@@ -193,5 +197,12 @@ The ``IEEE 802.11d`` beacon's regulatory region hint (if present) will be given
193
197
Run time
194
198
--------
195
199
196
-
You can also set the regulatory domain using an API call, the regulatory information can be passed using the ``nrf70_bm_init()`` API.
197
-
There is also an API to get the current regulatory domain set in the device, ``nrf70_bm_get_reg()``.
200
+
You can also set/get the regulatory domain using:
201
+
202
+
* ``nrf70_bm_sys_set_reg()`` and ``nrf70_bm_sys_get_reg()`` API in the **Scan-only** mode of operation.
203
+
* ``nrf70_bm_rt_set_reg()`` and ``nrf70_bm_rt_get_reg()`` API in the **Radio test** mode of operation.
204
+
205
+
The regulatory information can also be passed using the:
206
+
207
+
* ``nrf70_bm_sys_init()`` API in the **Scan-only** mode of operation.
208
+
* ``nrf70_bm_rt_init()`` API in the **Radio test** mode of operation.
Copy file name to clipboardexpand all lines: nrf70_bm_lib/docs/source/samples.rst
+7-1
Original file line number
Diff line number
Diff line change
@@ -24,4 +24,10 @@ For more information, see https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf
24
24
Scan and Radio test combo
25
25
+++++++++++++++++++++++++
26
26
27
-
The Scan and Radio test combo sample demonstrates how to switch between the Scan and Radio test operational modes at runtime.
27
+
The Scan and Radio test combo sample demonstrates how to switch between the Scan and Radio test operational modes, using different regulatory domains, at runtime.
28
+
It does the following:
29
+
30
+
* Uses the regulatory domain ``WIFI_REG_DOMAIN``
31
+
* Initializes radio test mode and does continuous TX for 5 seconds, followed by a display of the statistics.
32
+
* Switches to scan mode and scans for the access points.
33
+
* Changes the regulatory domain to ``WIFI_REG_DOMAIN_2`` and repeats the above steps.
0 commit comments