Documentation changes for combo mode

Documentation changes for scan and radio test combo mode
operation.

Signed-off-by: Sachin D Kulkarni <[email protected]>

README.md

@@ -130,7 +130,7 @@ To build the documentation in a Linux environment, follow the below steps:
     Build the documentation using the following command:
 
     ```sh
-    ./build_docs.sh
+    ./build-docs.sh
     ```
 
     The generated HTML files will be available in `nrf70_bm_lib/docs/build/html`.
@@ -141,11 +141,13 @@ To build the documentation in a Linux environment, follow the below steps:
 Example code
 ============
 
-The repository includes two sample applications for testing and evaluation of the nRF70 Bare Metal library:
+The repository includes the below sample applications for the testing and the evaluation of the nRF70 Bare Metal library:
 
 1. `BM radio test` sample to perform basic RF testing of the nRF70 Series device, as well as
     Factory Information Configuration Registers (FICR) programming.
 
 2. `BM scan` sample to test Wi-Fi SSID scanning with the nRF70 Series devices.
 
-Both samples can be found under the ``samples/`` directory. The samples can be built using `west`, as explained above.
+3. `BM scan and radio test combo` sample to demonstrate runtime switching capability between scan and radio test operational modes for the BM library
+
+The samples can be found under the ``samples/`` directory. The samples can be built using `west`, as explained above.

nrf70_bm_lib/docs/Doxyfile

@@ -864,11 +864,13 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../include/nrf70_bm_lib.h \
-                         ../include/nrf70_tx_pwr_ceil_dk.h \
-                         ../../../modules/lib//nrf_wifi/fw_if/umac_if/inc \
-                         ../../../modules/lib//nrf_wifi/fw_if/umac_if/inc/radio_test \
-                         ../../../modules/lib//nrf_wifi/fw_if/umac_if/inc/default
+INPUT                  = ../include/common/nrf70_bm_lib.h \
+                         ../include/system/nrf70_bm_lib.h \
+                         ../include/radio_test/nrf70_bm_lib.h \
+                         ../include/common/nrf70_bm_tx_pwr_ceil_dk.h \
+                         ../../../modules/lib/nrf_wifi/fw_if/umac_if/inc/common \
+                         ../../../modules/lib/nrf_wifi/fw_if/umac_if/inc/radio_test \
+                         ../../../modules/lib/nrf_wifi/fw_if/umac_if/inc/system
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

nrf70_bm_lib/docs/source/nrf70_bm_api.rst

@@ -3,5 +3,5 @@
 API documentation
 =================
 
-.. doxygenfile:: nrf70_bm_lib.h
+.. doxygenfile:: common/nrf70_bm_lib.h radio_test/nrf70_bm_lib.h system/nrf70_bm_lib.h
    :project: nrf70_bm_lib

nrf70_bm_lib/docs/source/nrf70_bm_lib_migration_guide.rst

@@ -23,17 +23,27 @@ API changes
 
 * The following APIs were added to the library:
 
-  * ``nrf70_bm_get_reg()``
+  * ``nrf70_bm_sys_get_reg()``
+  * ``nrf70_bm_rt_init()``
+  * ``nrf70_bm_rt_deinit()``
 
 * The following APIs were modified in the library:
 
-  * ``nrf70_bm_init()``
+  * ``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()``.
+  * ``nrf70_bm_scan_start()`` is now renamed to ``nrf70_bm_sys_scan_start()``.
+  * ``nrf70_bm_set_reg()`` is now renamed to ``nrf70_bm_sys_set_reg()``.
+  * ``nrf70_bm_mac_txt()`` is now renamed to ``nrf70_bm_sys_mac_txt``.
+  * ``nrf70_bm_dump_stats()`` is now renamed to ``nrf70_bm_sys_dump_stats()``.
 
 Configuration changes
 =====================
 
 * The following configuration options were added to the library:
 
   * ``CONFIG_NRF70_REG_DOMAIN``
+
+Build system changes
+====================

nrf70_bm_lib/docs/source/nrf70_bm_porting_guide.rst

@@ -117,9 +117,9 @@ The reference header files are located in the `nrf70_bm_lib/include` directory.
 
 The following files are used to configure the TX power ceilings for the official Nordic development and evaluation boards:
 
-- `nrf70_tx_pwr_ceil_dk.h`: Contains the TX power configuration for the nRF7002 Development Kit (DK).
+- `nrf70_bm_tx_pwr_ceil_dk.h`: Contains the TX power configuration for the nRF7002 Development Kit (DK).
 
-- `nrf70_tx_pwr_ceil_ek.h`: Contains the TX power configuration for the nRF7002 Evaluation Kit (EK).
+- `nrf70_bm_tx_pwr_ceil_ek.h`: Contains the TX power configuration for the nRF7002 Evaluation Kit (EK).
 
 For a new nRF70-based PCB design, the developer may create a new header file with the same structure as the reference files and replace the values with the appropriate values for the designed PCB.
 The appropriate TX power ceiling values may be derived by running the radio test sample on the board and using a spectrum/vector signal analyzer to measure the output power, spectral mask, EVM and other parameters and then adjusting the TX power ceiling values to meet the requirements.
@@ -131,7 +131,7 @@ For more information on TX power calculation, refer to the section `nRF70 TX pow
 Reference header file structure
 -------------------------------
 
-.. doxygenfile:: nrf70_tx_pwr_ceil_dk.h
+.. doxygenfile:: nrf70_bm_tx_pwr_ceil_dk.h
 
 
 nRF70 OS agnostic layers API documentation

nrf70_bm_lib/docs/source/samples.rst

@@ -20,3 +20,8 @@ Radio test
 
 The Radio test sample demonstrates how to use the Nordic Semiconductor's Wi-Fi® chipset to test the radio functionality.
 For more information, see https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/samples/wifi/radio_test/README.html
+
+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.