Skip to content

Commit

Permalink
doc: wifi: minor doc fixes
Browse files Browse the repository at this point in the history
Minor fixes to various wi-fi documents.

Signed-off-by: Richa Pandey <[email protected]>
  • Loading branch information
richabp authored and cvinayak committed Feb 7, 2024
1 parent 5458ab1 commit 20e8583
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ The nRF70 Series driver provides the following software configurations to fine-t
- Purpose
* - :kconfig:option:`CONFIG_WPA_SUPP`
- ``y`` or ``n``
- Enable or disable Wi-Fi Protected Access (WPA) supplicant
- Enable or disable Wi-Fi Protected Access (WPA) supplicant
- Memory savings
- This specifies the inclusion of the WPA supplicant module.
Disabling this flag restricts the nRF70 Series driver's functionality to STA scan only.
Expand All @@ -114,7 +114,7 @@ The nRF70 Series driver provides the following software configurations to fine-t
* - :kconfig:option:`CONFIG_NRF700X_MAX_TX_TOKENS`
- ``5``, ``10``, ``11``, ``12``
- Maximum number of TX tokens.
These are distributed across all WMM access categories (including a pool for all).
These are distributed across all WMM® access categories (including a pool for all).
- Performance tuning and Memory savings
- This specifies the maximum number of TX tokens that can be used in the token bucket algorithm.
More tokens imply more concurrent transmit opportunities for RPU but can lead to poor aggregation performance
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This guide explains the available options for having the nRF70 Series firmware p
Overview
********

By default the nRF70 Series firmware patches are built as part of the nRF Wi-Fi host driver code, residing in on-chip memory.
By default the nRF70 Series firmware patches are built as part of the nRF Wi-Fi® host driver code, residing in on-chip memory.
The firmware patches include code that is executed on the nRF70 Series device.
The size of the firmware patches may be considerably large, which limits the amount of on-chip code memory available for the user application.
In order to increase the amount of on-chip memory available for user applications, the nRF70 Series Wi-Fi driver supports the option of using external memory, if that is available.
Expand Down Expand Up @@ -48,10 +48,10 @@ Available options

There are two supported options for offloading the firmware patches in the external memory feature:

* using XIP access
* using QSPI transfers to RAM
* Using XIP access
* Using QSPI transfers to RAM

using XIP access
Using XIP access
================

If the application supports XIP from external memory, then the firmware patches can be loaded as part of the nRF Wi-Fi driver code (RODATA) and then relocated to the external memory.
Expand All @@ -71,7 +71,7 @@ A sample memory regions summary is shown below:
RAM: 170636 B 448 KB 37.20%
IDT_LIST: 0 GB 2 KB 0.00%
using QSPI transfers to RAM
Using QSPI transfers to RAM
===========================

The nRF Wi-Fi driver supports the option for offloading the nRF70 firmware patch to external non-XIP memory.
Expand All @@ -80,7 +80,7 @@ In this case the upload of the firmware patch from the external memory to the nR
* first the firmware patch is loaded from the external memory onto internal RAM and
* then it is uploaded to the nRF70 device.

This feature can be enabled using DTS or :ref::`snippets` feature or by using :ref::`partition_manager`.
This feature can be enabled using DTS or :ref:`snippets` feature or by using :ref:`partition_manager`.

Configuration
-------------
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/device_guides/working_with_nrf/nrf70/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,6 @@ Currently, the nRF70 Series devices support the following modes:
The nRF70 Series devices also support the functionality of :ref:`ug_nrf70_developing_raw_ieee_80211_packet_transmission`.
This allows the injection of raw 802.11 frames in any of the above modes.

Peer-to-peer support in the form of Wi-Fi Direct will be available in the future.
Peer-to-peer support in the form of Wi-Fi Direct® will be available in the future.

See the :ref:`ug_wifi` documentation for more information related to Wi-Fi modes of operation.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Getting started with nRF7002 EB

This section gets you started with your nRF7002 :term:`Expansion Board (EB)` using the |NCS|.

The nRF7002 EB can be used to provide Wi-Fi connectivity to compatible development or evaluation boards through the nRF7002 Wi-Fi 6 companion IC.
The nRF7002 EB can be used to provide Wi-Fi® connectivity to compatible development or evaluation boards through the nRF7002 Wi-Fi 6 companion IC.

The nRF7002 EB has a :term:`Printed Circuit Board (PCB)` edge connector that can be used with a compatible development board such as the Nordic Thingy:53, an IoT prototyping platform from Nordic Semiconductor.
There are also castellated holes on the side of the board that allow the EB to be used as a breakout board that can be soldered to other PCB assemblies.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Getting started with nRF7002 EK
This section gets you started with your nRF7002 :term:`Evaluation Kit (EK)` using the |NCS|.

The nRF7002 EK is a versatile evaluation kit in the form of an Arduino shield.
The kit can be used to provide Wi-Fi connectivity and Wi-Fi-based locationing to compatible development or evaluation boards through the nRF7002 Wi-Fi 6 companion IC.
The kit can be used to provide Wi-Fi® connectivity and Wi-Fi-based locationing to compatible development or evaluation boards through the nRF7002 Wi-Fi 6 companion IC.

The nRF7002 EK features the nRF7002 companion IC.
In addition, the shield may be used to emulate the nRF7001 and nRF7000 companion IC variants.
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/protocols/wifi/raw_tx_operation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To use the raw packet transmit feature in your applications, you must enable the
TX injection mode
*****************

The nRF70 Series device supports raw 802.11 packet transmission when TX injection mode is enabled in the nRF Wi-Fi driver.
The nRF70 Series device supports raw 802.11 packet transmission when TX injection mode is enabled in the nRF Wi-Fi® driver.
To enable the TX injection mode of operation, you can use the ``NET_REQUEST_WIFI_MODE`` network management runtime API.
This API can be used to disable TX injection mode in the driver when raw 802.11 packet transmission is not required by the application.

Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/protocols/wifi/regulatory_support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ You can get the configured regulatory domain using either an API or a shell comm
Wi-Fi regulatory channel rules
******************************

The following tables indicate the Wi-Fi regulatory channel rules for different countries.
The following tables indicate the Wi-Fi® regulatory channel rules for different countries.

The values in the tables show the maximum allowed transmit power (in dBm) for each country.

Expand Down
6 changes: 2 additions & 4 deletions doc/nrf/protocols/wifi/sap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ SoftAP mode
:depth: 2

The nRF70 Series device supports :term:`Software-enabled Access Point (SoftAP or SAP)` mode.
This mode allows a device to operate as a virtual router or temporary access point (AP) and accept connections from other Wi-Fi station devices.
This mode allows a device to operate as a virtual router or temporary access point (AP) and accept connections from other Wi-Fi® station devices.
SoftAP mode is typically used in scenarios where a Wi-Fi device wishes to share its internet connection with nearby station devices.
For instance, smartphone Wi-Fi hotspots utilize SoftAP mode.
The smartphone acts as a virtual router, allowing other station devices to connect to the internet through it.
Expand All @@ -24,9 +24,7 @@ The SAP mode in the nRF70 Series devices provides SoftAP support with the follow
* A network interface can operate in either SAP mode or Station mode, but not in both modes simultaneously.
* SAP mode only supports the Wi-Fi 4 (IEEE 802.11n) mode of operation.
* The SAP mode currently supports a single station device connection.

However, the implementation provides an :ref:`experimental <software_maturity>` support for up to eight station connections.

However, the implementation provides an :ref:`experimental <software_maturity>` support for up to eight station connections.
* Only Wi-Fi personal security (WPA2-PSK) is supported.

Enabling the SAP mode
Expand Down
4 changes: 2 additions & 2 deletions doc/nrf/protocols/wifi/wifi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Two network modes, infrastructure and peer-to-peer, are supported.
The infrastructure mode is by far the most common mode, where multiple stations (STAs) communicate with an access point (AP), identified through its service set identifier (SSID).
In addition, multiple APs can be used to service a SSID in order to improve coverage, but any individual STA will only be connected to a single AP at any time.
In the infrastructure mode, the AP is the network coordinator, using regular transmission of beacon packets for the purpose of coordinating all connected STAs.
The most common variant of peer-to-peer mode used is Wi-Fi Direct.
The most common variant of peer-to-peer mode used is Wi-Fi Direct®.

Wi-Fi is an Internet Protocol (IP) based network, with every device (AP or STA) having a unique 48-bit MAC address.
Since the radio frequency (RF) communication channel is unreliable, a number of mechanisms are used in an attempt to achieve reliability not typically present in wired networks.
Expand All @@ -27,7 +27,7 @@ Acknowledgements (ACKs) are used for unicast packet transmissions, with every su

The RF medium also necessitates security to achieve privacy of the over-the-air packet transmissions.
Again, multiple schemes are available depending on the version of the standard in use, though over time the older schemes tend to be deprecated as vulnerabilities emerge.
The schemes are referred to as Wi-Fi Protected Access (WPA), with WPA3 being the latest version (mandated for all new Wi-Fi Alliance certifications).
The schemes are referred to as Wi-Fi Protected Access (WPA), with WPA3 being the latest version (mandated for all new Wi-Fi Alliance® certifications).

.. _ug_wifi_stack:

Expand Down

0 comments on commit 20e8583

Please sign in to comment.