Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation update #44

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions nrf70_bm_lib/docs/source/nrf70_bm_lib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,12 @@ The library exposes the following functionality to the user application
* nRF70 Series device initialization and de-initialization
* Wi-Fi scan, through a single-function API supporting a wide list of scan configuration parameters
* Obtaining statistics from the nRF70 Series device
* Wi-Fi radio test functionality

The library is described in a single public-API definition header file ``nrf70_bm_lib.h``.
The library is described in the following public-API definition header files:

* ``system/nrf70_bm_lib.h`` for the Wi-Fi scan functionality.
* ``radio_test/nrf70_bm_lib.h`` for the Wi-Fi radio test functionality.

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

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

* *Tasklet context*: Tasklets perform the actual work of interacting with the nRF70, processing events coming from the device (offloaded tasks from ISRs)
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.
An example of such operation is the processing of incoming AP scan results after a scan command has been issued.
An example of such operation is the processing of incoming AP scan results after a scan command has been issued.

.. note::
In the reference implementation for Zephyr tasklet work is offloaded to Zephyr kernel workqueues.
Expand Down Expand Up @@ -193,5 +197,12 @@ The ``IEEE 802.11d`` beacon's regulatory region hint (if present) will be given
Run time
--------

You can also set the regulatory domain using an API call, the regulatory information can be passed using the ``nrf70_bm_init()`` API.
There is also an API to get the current regulatory domain set in the device, ``nrf70_bm_get_reg()``.
You can also set/get the regulatory domain using:

* ``nrf70_bm_sys_set_reg()`` and ``nrf70_bm_sys_get_reg()`` API in the **Scan-only** mode of operation.
* ``nrf70_bm_rt_set_reg()`` and ``nrf70_bm_rt_get_reg()`` API in the **Radio test** mode of operation.

The regulatory information can also be passed using the:

* ``nrf70_bm_sys_init()`` API in the **Scan-only** mode of operation.
* ``nrf70_bm_rt_init()`` API in the **Radio test** mode of operation.
3 changes: 3 additions & 0 deletions nrf70_bm_lib/docs/source/nrf70_bm_lib_migration_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,13 @@ API changes
* ``nrf70_bm_sys_get_reg()``
* ``nrf70_bm_rt_init()``
* ``nrf70_bm_rt_deinit()``
* ``nrf70_bm_rt_set_reg()``
* ``nrf70_bm_rt_get_reg()``

* The following APIs were modified in the library:

* ``nrf70_bm_init()`` is now renamed to ``nrf70_bm_sys_init()``.

- added a new parameter ``mac_addr`` to allow the user to set the MAC address of the device.
- added a new parameter ``reg_info`` to allow the user to set the regulatory information of the device.
* ``nrf70_bm_deinit()`` is now renamed to ``nrf70_bm_sys_deinit()``.
Expand Down
8 changes: 7 additions & 1 deletion nrf70_bm_lib/docs/source/samples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,10 @@ For more information, see https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf
Scan and Radio test combo
+++++++++++++++++++++++++

The Scan and Radio test combo sample demonstrates how to switch between the Scan and Radio test operational modes at runtime.
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.
It does the following:

* Uses the regulatory domain ``WIFI_REG_DOMAIN``
* Initializes radio test mode and does continuous TX for 5 seconds, followed by a display of the statistics.
* Switches to scan mode and scans for the access points.
* Changes the regulatory domain to ``WIFI_REG_DOMAIN_2`` and repeats the above steps.