Skip to content

Commit 956a1bf

Browse files
Documentation update
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>
1 parent 758d296 commit 956a1bf

File tree

3 files changed

+25
-5
lines changed

3 files changed

+25
-5
lines changed

nrf70_bm_lib/docs/source/nrf70_bm_lib.rst

+15-4
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,12 @@ The library exposes the following functionality to the user application
2929
* nRF70 Series device initialization and de-initialization
3030
* Wi-Fi scan, through a single-function API supporting a wide list of scan configuration parameters
3131
* Obtaining statistics from the nRF70 Series device
32+
* Wi-Fi radio test functionality
3233

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.
3438

3539
Being fully RTOS-agnostic, the BM library is portable to any bare-metal or OS environment.
3640

@@ -121,7 +125,7 @@ The library driver code execute in the following contexts:"
121125

122126
* *Tasklet context*: Tasklets perform the actual work of interacting with the nRF70, processing events coming from the device (offloaded tasks from ISRs)
123127
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.
125129

126130
.. note::
127131
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
193197
Run time
194198
--------
195199

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.

nrf70_bm_lib/docs/source/nrf70_bm_lib_migration_guide.rst

+3
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,13 @@ API changes
2626
* ``nrf70_bm_sys_get_reg()``
2727
* ``nrf70_bm_rt_init()``
2828
* ``nrf70_bm_rt_deinit()``
29+
* ``nrf70_bm_rt_set_reg()``
30+
* ``nrf70_bm_rt_get_reg()``
2931

3032
* The following APIs were modified in the library:
3133

3234
* ``nrf70_bm_init()`` is now renamed to ``nrf70_bm_sys_init()``.
35+
3336
- added a new parameter ``mac_addr`` to allow the user to set the MAC address of the device.
3437
- added a new parameter ``reg_info`` to allow the user to set the regulatory information of the device.
3538
* ``nrf70_bm_deinit()`` is now renamed to ``nrf70_bm_sys_deinit()``.

nrf70_bm_lib/docs/source/samples.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,10 @@ For more information, see https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf
2424
Scan and Radio test combo
2525
+++++++++++++++++++++++++
2626

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

Comments
 (0)