From 4aea8963abcf72ab67386fc82cf876986f378c94 Mon Sep 17 00:00:00 2001 From: Chaitanya Tata Date: Fri, 27 Sep 2024 12:39:03 +0200 Subject: [PATCH 1/3] Fix heading Signed-off-by: Chaitanya Tata --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 4bde691..3cf204e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ -========================= nRF70 BM Driver README -========================= +====================== Setup Instructions ================== From 45657510a9e7c8beadc3fdcd53f442856ca552fb Mon Sep 17 00:00:00 2001 From: Chaitanya Tata Date: Fri, 27 Sep 2024 14:02:22 +0200 Subject: [PATCH 2/3] Add missing README for scan sample Signed-off-by: Chaitanya Tata --- samples/scan_bm/README.rst | 228 +++++++++++++++++++++++++++++++++++++ 1 file changed, 228 insertions(+) create mode 100644 samples/scan_bm/README.rst diff --git a/samples/scan_bm/README.rst b/samples/scan_bm/README.rst new file mode 100644 index 0000000..d2b7f25 --- /dev/null +++ b/samples/scan_bm/README.rst @@ -0,0 +1,228 @@ +.. _wifi_scan_sample: + +Wi-Fi: Scan +############ + +.. contents:: + :local: + :depth: 2 + +The Scan sample demonstrates how to use the Nordic Semiconductor's Wi-Fi® chipset to scan for the access points without using the wpa_supplicant. + +Requirements +************ + +The sample supports the following development kits: + +.. table-from-sample-yaml:: + +Overview +******** + +The sample demonstrates Wi-Fi scan operations in the 2.4 GHz and 5 GHz bands. +The sample allows you to perform scan based on below profiles. + +* Default scan +* Active scan +* Passive scan +* 2.4 GHz Active scan +* 2.4 GHz Passive scan +* 5 GHz Active scan +* 5 GHz Passive scan +* Scan only non-overlapping channels in the 2.4 GHz band +* Scan only non-DFS channels in the 5 GHz band +* Scan only non-overlapping channels in the 2.4 GHz and non-DFS channels in the 5 GHz band + +Using this sample, the development kit can scan for available access points in :abbr:`STA (Station)` mode. + +Configuration +************* + +|config| + +Configuration options +===================== + +The following sample-specific Kconfig options are used in this sample (located in :file:`samples/wifi/scan/Kconfig`) : + +.. options-from-kconfig:: + :show-type: + +Building and running +******************** + +.. |sample path| replace:: :file:`samples/wifi/scan` + +.. include:: /includes/build_and_run_ns.txt + +To build for the nRF7002 DK, use the ``nrf7002dk/nrf5340/cpuapp`` board target. +The following are examples of the CLI commands: + +* Build to fetch only Device scan results + + .. code-block:: console + + west build -b nrf7002dk/nrf5340/cpuapp + +* Build to fetch only Raw scan results + + .. code-block:: console + + west build -b nrf7002dk/nrf5340/cpuapp -- -DCONFIG_WIFI_MGMT_RAW_SCAN_RESULTS=y -DCONFIG_WIFI_MGMT_RAW_SCAN_RESULTS_ONLY=y + +* Build to fetch both Raw and Device scan results + + .. code-block:: console + + west build -b nrf7002dk/nrf5340/cpuapp -- -DCONFIG_WIFI_MGMT_RAW_SCAN_RESULTS=y + +Testing +======= + +|test_sample| + +#. |connect_kit| +#. |connect_terminal| + + The sample shows the following output: + + * Device scan only results: + + .. code-block:: console + + Scan requested + Num | SSID (len) | Chan | RSSI | Security | BSSID + 1 | abcdef 6 | 1 | -37 | WPA/WPA2 | aa:aa:aa:aa:aa:aa + 2 | pqrst 5 | 1 | -65 | WPA/WPA2 | xx:xx:xx:xx:xx:xx + 3 | AZBYCXD 7 | 1 | -41 | WPA/WPA2 | yy:yy:yy:yy:yy:yy + Scan request done + + * Raw scan only results: + + .. code-block:: console + + Scan requested + Num | len | Frequency | RSSI | RAW_DATA(32 bytes) + 1 | 299 | 2412 | -44 | 50 00 3A 01 F4 CE 36 00 10 CE D4 BD 4F E1 F5 33 D4 BD 4F E1 F5 33 A0 7F 0B 05 75 7F D8 00 00 00 + 2 | 430 | 2412 | -37 | 50 00 3A 01 F4 CE 36 00 10 CE 3C 7C 3F DA DF 38 3C 7C 3F DA DF 38 90 11 69 36 EC 8A 02 00 00 00 + 3 | 284 | 2412 | -45 | 50 00 3A 01 F4 CE 36 00 10 CE D4 BD 4F 21 F5 38 D4 BD 4F 21 F5 38 20 CF 7B 20 75 7F D8 00 00 00 + 4 | 299 | 2412 | -43 | 50 00 3A 01 F4 CE 36 00 10 CE D4 BD 4F E1 F5 33 D4 BD 4F E1 F5 33 B0 7F EC 2B 75 7F D8 00 00 00 + 5 | 409 | 2412 | -38 | 50 00 3A 01 F4 CE 36 00 10 CE A0 36 BC 56 41 E0 A0 36 BC 56 41 E0 60 E2 C7 A5 0F 90 0D 00 00 00 + Scan request done + + * Raw scan and Device scan results: + + .. code-block:: console + + Scan requested + Num | len | Frequency | RSSI | RAW_DATA(32 bytes) + 1 | 299 | 2412 | -44 | 50 00 3A 01 F4 CE 36 00 10 CE D4 BD 4F E1 F5 33 D4 BD 4F E1 F5 33 A0 7F 0B 05 75 7F D8 00 00 00 + 2 | 430 | 2412 | -37 | 50 00 3A 01 F4 CE 36 00 10 CE 3C 7C 3F DA DF 38 3C 7C 3F DA DF 38 90 11 69 36 EC 8A 02 00 00 00 + 3 | 284 | 2412 | -45 | 50 00 3A 01 F4 CE 36 00 10 CE D4 BD 4F 21 F5 38 D4 BD 4F 21 F5 38 20 CF 7B 20 75 7F D8 00 00 00 + 4 | abcdef 6 | 1 | -37 | WPA/WPA2 | aa:aa:aa:aa:aa:aa + 5 | pqrst 5 | 1 | -65 | WPA/WPA2 | xx:xx:xx:xx:xx:xx + 6 | AZBYCXD 7 | 1 | -41 | WPA/WPA2 | yy:yy:yy:yy:yy:yy + Scan request done + + * Default scan results: + + .. code-block:: console + + Scan requested + Num | SSID (len) | Chan | RSSI | Security | BSSID + 1 | 0 | 11 | -39 | Open | C2:A5:11:A2:B1:E2 + 2 | abcdefg 7 | 11 | -39 | Open | BC:A5:11:A2:B1:E2 + 3 | hijklmno 8 | 48 | -43 | Open | 00:22:CF:E6:AE:99 + Scan request done + + * Active scan results: + + .. code-block:: console + + Scan requested + Num | SSID (len) | Chan | RSSI | Security | BSSID + 1 | 0 | 11 | -39 | Open | C2:A5:11:A2:B1:E2 + 2 | abcdefg 7 | 11 | -39 | Open | BC:A5:11:A2:B1:E2 + 3 | hijklmno 8 | 48 | -43 | Open | 00:22:CF:E6:AE:99 + Scan request done + + * Passive scan results: + + .. code-block:: console + + Scan requested + Num | SSID (len) | Chan | RSSI | Security | BSSID + 1 | 0 | 11 | -39 | Open | C2:A5:11:A2:B1:E2 + 2 | abcdefg 7 | 11 | -39 | Open | BC:A5:11:A2:B1:E2 + 3 | hijklmno 8 | 48 | -43 | Open | 00:22:CF:E6:AE:99 + Scan request done + + * 2.4 GHz Active scan results: + + .. code-block:: console + + Scan requested + Num | SSID (len) | Chan | RSSI | Security | BSSID + 1 | abcdefg 7 | 11 | -39 | Open | BC:A5:11:A2:B1:E2 + Scan request done + + * 2.4 GHz Passive scan results: + + .. code-block:: console + + Scan requested + Num | SSID (len) | Chan | RSSI | Security | BSSID + 1 | abcdefg 7 | 11 | -39 | Open | BC:A5:11:A2:B1:E2 + Scan request done + + * 5 GHz Active scan results: + + .. code-block:: console + + Scan requested + Num | SSID (len) | Chan | RSSI | Security | BSSID + 1 | pqrst 5 | 48 | -43 | Open | 00:22:CF:E6:AE:99 + Scan request done + + * 5 GHz Passive scan results: + + .. code-block:: console + + Scan requested + Num | SSID (len) | Chan | RSSI | Security | BSSID + 1 | pqrst 5 | 48 | -43 | Open | 00:22:CF:E6:AE:99 + Scan request done + + * 2.4 GHz non-overlapping channels based scan results: + + .. code-block:: console + + Scan requested + Num | SSID (len) | Chan | RSSI | Security | BSSID + 1 | abcdefg 7 | 11 | -39 | Open | BC:A5:11:A2:B1:E2 + 2 | mnopq 5 | 6 | -75 | Open | F0:1D:2D:73:C4:C1 + 3 | pqrst 5 | 1 | -77 | Open | DC:33:3D:AB:D1:A8 + Scan request done + + * 5 GHz non-DFS channels based scan results: + + .. code-block:: console + + Scan requested + Num | SSID (len) | Chan | RSSI | Security | BSSID + 1 | ABCDEFG 7 | 36 | -70 | Open | 48:5D:35:9C:4A:0B + 2 | PQRST 5 | 161 | -78 | Open | 50:EB:F6:08:E1:6C + 3 | abcd 4 | 165 | -78 | WPA/WPA2 | 08:86:3B:8B:52:9E + 4 | KLMNO 5 | 40 | -90 | Open | E8:94:F6:C7:D8:8E + Scan request done + + * 2.4 GHz non-overlapping and 5 GHz non-DFS channels based scan results: + + .. code-block:: console + + Scan requested + Num | SSID (len) | Chan | RSSI | Security | BSSID + 1 | pqrst 5 | 48 | -43 | Open | 00:22:CF:E6:AE:99 + 2 | abcdefg 7 | 11 | -39 | Open | BC:A5:11:A2:B1:E2 + 3 | ABCDE 5 | 40 | -90 | Open | E8:94:F6:C7:D8:8E + Scan request done From 246d8de53844b8126270914e5102a5caf91b94a6 Mon Sep 17 00:00:00 2001 From: Chaitanya Tata Date: Fri, 27 Sep 2024 16:16:50 +0200 Subject: [PATCH 3/3] Link OSAL docs These docs including doxygen API docs are already present, link them to the main docs. Signed-off-by: Chaitanya Tata --- nrf70_bm_lib/docs/Doxyfile | 5 ++++- nrf70_bm_lib/docs/source/conf.py | 9 ++++++--- nrf70_bm_lib/docs/source/nrf70_bm_porting_guide.rst | 13 +++++++++++++ nrf70_bm_lib/docs/source/nrf70_osal_doc.rst | 3 +++ 4 files changed, 26 insertions(+), 4 deletions(-) create mode 100644 nrf70_bm_lib/docs/source/nrf70_osal_doc.rst diff --git a/nrf70_bm_lib/docs/Doxyfile b/nrf70_bm_lib/docs/Doxyfile index 87d5ca2..910fc78 100644 --- a/nrf70_bm_lib/docs/Doxyfile +++ b/nrf70_bm_lib/docs/Doxyfile @@ -864,7 +864,10 @@ 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 +INPUT = ../include/nrf70_bm_lib.h \ + ../../../nrfxlib/nrf_wifi/fw_if/umac_if/inc \ + ../../../nrfxlib/nrf_wifi/fw_if/umac_if/inc/radio_test \ + ../../../nrfxlib/nrf_wifi/fw_if/umac_if/inc/default # 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 diff --git a/nrf70_bm_lib/docs/source/conf.py b/nrf70_bm_lib/docs/source/conf.py index 7c43086..fdd3de5 100644 --- a/nrf70_bm_lib/docs/source/conf.py +++ b/nrf70_bm_lib/docs/source/conf.py @@ -8,7 +8,7 @@ project = 'nRF70 bare metal library' copyright = "2024, Nordic Semiconductor" -author = "Nordic Semiconductor" +author = "Nordic Semiconductor ASA" release = '1.0.0' # -- General configuration --------------------------------------------------- @@ -19,7 +19,8 @@ ] breathe_projects = { - 'nrf70_bm_lib': '../xml' + 'nrf70_bm_lib': '../xml', + 'nrfxlib': '../xml' } breathe_default_project = 'nrf70_bm_lib' breathe_domain_by_extension = {"h": "c", "c": "c"} @@ -28,7 +29,9 @@ templates_path = ['_templates'] exclude_patterns = [] - +# Ensure the master doc is set correctly +master_doc = 'index' +source_suffix = '.rst' # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output diff --git a/nrf70_bm_lib/docs/source/nrf70_bm_porting_guide.rst b/nrf70_bm_lib/docs/source/nrf70_bm_porting_guide.rst index bebd264..7aed898 100644 --- a/nrf70_bm_lib/docs/source/nrf70_bm_porting_guide.rst +++ b/nrf70_bm_lib/docs/source/nrf70_bm_porting_guide.rst @@ -89,6 +89,19 @@ For more information, visit the `nRF Connect SDK nrfxlib repository