[nrf fromtree] drivers: nrfwifi: Fixes from doc review

Help text fixes from doc-team.

Signed-off-by: Richa Pandey <[email protected]>
Signed-off-by: Chaitanya Tata <[email protected]>
(cherry picked from commit 580707e)
(cherry picked from commit 7d6d734)

Author: krish2718

drivers/wifi/nrfwifi/Kconfig.nrfwifi

@@ -69,15 +69,14 @@ config NRF70_RADIO_TEST
 	bool "Radio test mode of the nRF70 driver"
 
 config NRF70_OFFLOADED_RAW_TX
-	bool "Offloaded raw Tx mode of the nRF70 driver"
+	bool "Offloaded raw TX mode of the nRF70 driver"
 
 config NRF70_SYSTEM_WITH_RAW_MODES
 	bool "nRF70 system mode with raw modes"
 	depends on WIFI_NRF7002 || WIFI_NRF7001
 	select WIFI_NM_WPA_SUPPLICANT
 	help
-	  Select this option to enable system mode of the nRF70 driver with raw modes
-
+	  Select this option to enable system mode of the nRF70 driver with raw modes.
 endchoice
 
 config NRF70_SYSTEM_MODE_COMMON
@@ -88,7 +87,7 @@ config NET_L2_ETHERNET
 	default y if (!NRF70_RADIO_TEST && !NRF70_OFFLOADED_RAW_TX)
 
 config HEAP_MEM_POOL_ADD_SIZE_NRF70
-	# Use a maximum that works for typical usecases and boards, each sample/app can override
+	# Use a maximum that works for typical use cases and boards, each sample/app can override
 	# this value if needed by using CONFIG_HEAP_MEM_POOL_IGNORE_MIN
 	def_int 25000 if NRF70_SCAN_ONLY
 	def_int 150000
@@ -98,7 +97,7 @@ config NRF70_STA_MODE
 	bool "nRF70 STA mode"
 	default y
 	help
-	  Select this option to enable STA mode of the nRF70 driver
+	  Select this option to enable STA mode of the nRF70 driver.
 
 config NRF70_AP_MODE
 	bool "Access point mode"
@@ -117,7 +116,7 @@ config NRF70_RAW_DATA_RX
 	select EXPERIMENTAL
 
 config NRF70_PROMISC_DATA_RX
-	bool "promiscuous RX sniffer operation in the driver"
+	bool "Promiscuous RX sniffer operation in the driver"
 	select WIFI_NM_WPA_SUPPLICANT
 	select EXPERIMENTAL
 	select NET_PROMISCUOUS_MODE
@@ -154,7 +153,7 @@ config NRF_WIFI_PATCHES_EXTERNAL
 endchoice
 
 config NRF_WIFI_LOW_POWER
-	bool "low power mode in nRF Wi-Fi chipsets"
+	bool "Low power mode in nRF Wi-Fi chipsets"
 	default y
 
 config NRF70_TCP_IP_CHECKSUM_OFFLOAD
@@ -235,7 +234,7 @@ config NRF70_PCB_LOSS_2G
 	range 0 4
 	help
 	  Specifies PCB loss from the antenna connector to the RF pin.
-	  The values are in dB scale in steps of 1dB and range of 0-4dB.
+	  The values are in dB scale in steps of 1 dB and range of 0-4 dB.
 	  The loss is considered in the RX path only.
 
 config NRF70_PCB_LOSS_5G_BAND1
@@ -244,7 +243,7 @@ config NRF70_PCB_LOSS_5G_BAND1
 	range 0 4
 	help
 	  Specifies PCB loss from the antenna connector to the RF pin.
-	  The values are in dB scale in steps of 1dB and range of 0-4dB.
+	  The values are in dB scale in steps of 1 dB and range of 0-4 dB.
 	  The loss is considered in the RX path only.
 
 config NRF70_PCB_LOSS_5G_BAND2
@@ -253,7 +252,7 @@ config NRF70_PCB_LOSS_5G_BAND2
 	range 0 4
 	help
 	  Specifies PCB loss from the antenna connector to the RF pin.
-	  The values are in dB scale in steps of 1dB and range of 0-4dB.
+	  The values are in dB scale in steps of 1 dB and range of 0-4 dB.
 	  The loss is considered in the RX path only.
 
 config NRF70_PCB_LOSS_5G_BAND3
@@ -262,7 +261,7 @@ config NRF70_PCB_LOSS_5G_BAND3
 	range 0 4
 	help
 	  Specifies PCB loss from the antenna connector to the RF pin.
-	  The values are in dB scale in steps of 1dB and range of 0-4dB.
+	  The values are in dB scale in steps of 1 dB and range of 0-4 dB.
 	  The loss is considered in the RX path only.
 
 config NRF70_ANT_GAIN_2G
@@ -491,25 +490,23 @@ config NRF70_RPU_PS_IDLE_TIMEOUT_MS
 config NRF70_RPU_EXTEND_TWT_SP
 	bool "extending TWT service period"
 	help
-	  In case frames accepted before beginning of SP are not
-	  transmitted before the SP completes then typically they are
-	  dropped to conform to SP window as per specification i.e., no
+	  In case frames accepted before the beginning of SP are not
+	  transmitted before the SP completes, then typically they are
+	  dropped to conform to the SP window as per the specification that is, no
 	  transmission outside SP window.
-
-	  This feature mitigates the frame loss by transmitting even after SP
-	  completion by using standard contention mechanism which is allowed
+	  This feature mitigates frame loss by transmitting even after SP
+	  completion by using a standard contention mechanism, which is allowed
 	  in specification but not recommended. As the device is actively transmitting
 	  beyond SP, the power consumption increases depending on the amount
-	  of traffic available at the start of SP.
-
-	  Please note that if a frame is sent after SP starts it will be queued and this
+	  of traffic available at the start of the SP.
+	  Note that if a frame is sent after the SP starts, it will be queued, and this
 	  mechanism is not used.
 endif # NRF_WIFI_LOW_POWER
 
 config WIFI_FIXED_MAC_ADDRESS
-	string "WiFi Fixed MAC address in format XX:XX:XX:XX:XX:XX"
+	string "Wi-Fi Fixed MAC address in format XX:XX:XX:XX:XX:XX"
 	help
-	  This overrides the MAC address read from OTP. Strictly for testing purposes only.
+	  This option overrides the MAC address read from OTP. It is strictly for testing purposes only.
 
 choice
 	prompt "Wi-Fi MAC address type"
@@ -529,7 +526,7 @@ config WIFI_FIXED_MAC_ADDRESS_ENABLED
 	  Enable fixed MAC address
 
 config WIFI_RANDOM_MAC_ADDRESS
-	bool "random MAC address generation at runtime"
+	bool "Random MAC address generation at runtime"
 	depends on ENTROPY_GENERATOR
 	help
 	  This option enables random MAC address generation at runtime.
@@ -541,17 +538,17 @@ config NRF70_RSSI_STALE_TIMEOUT_MS
 	int "RSSI stale timeout in milliseconds"
 	default 1000
 	help
-	  RSSI stale timeout is the period after which driver queries
-	  RPU to get the RSSI the value.
-	  If data is active (e.g. ping), driver stores the RSSI value from
+	  RSSI stale timeout is the period after which the driver queries
+	  RPU to get the RSSI value.
+	  If data is active (for example, ping), the driver stores the RSSI value from
 	  the received frames and provides this stored information
-	  to wpa_supplicant. In this case a higher value will be suitable
-	  as stored RSSI value at driver will be updated regularly.
+	  to wpa_supplicant. In this case, a higher value will be suitable
+	  as the stored RSSI value at the driver will be updated regularly.
 	  If data is not active or after the stale timeout duration,
-	  driver queries the RPU to get the RSSI value
-	  and provides it to wpa_supplicant. The value should be set to lower
-	  value as driver does not store it and requires RPU to provide the
-	  info.
+	  the driver queries the RPU to get the RSSI value
+	  and provides it to wpa_supplicant. The value should be set to a lower
+	  value as the driver does not store it and requires RPU to provide the
+	  information.
 
 if NETWORKING
 # Finetune defaults for certain system components used by the driver
@@ -581,7 +578,7 @@ config MAIN_STACK_SIZE
 config SHELL_STACK_SIZE
 	default 4096
 
-# Override the Wi-Fi subsytems WIFI_MGMT_SCAN_SSID_FILT_MAX parameter,
+# Override the Wi-Fi subsystems WIFI_MGMT_SCAN_SSID_FILT_MAX parameter,
 # since we support a maximum of 2 SSIDs for scan result filtering.
 config WIFI_MGMT_SCAN_SSID_FILT_MAX
 	default 2
@@ -594,7 +591,7 @@ config NRF_WIFI_SCAN_MAX_BSS_CNT
 	  Maximum number of scan results to return. 0 represents unlimited number of BSSes.
 
 config NRF_WIFI_BEAMFORMING
-	bool "Wi-Fi beamforming. Enabling beamforming can provide slight improvement in performance where as disabling it can provide better power saving in low network activity applications"
+	bool "Wi-Fi beamforming. Enabling beamforming can provide a slight improvement in performance, whereas disabling it can provide better power savings in low network activity applications"
 	default y
 
 config WIFI_NRF70_SCAN_TIMEOUT_S
@@ -631,19 +628,18 @@ config NRF_WIFI_IFACE_MTU
 	default 1500
 
 config WIFI_NRF70_SKIP_LOCAL_ADMIN_MAC
-	bool "Suppress networks with non-individual MAC address as BSSID in the scan results"
+	bool "Suppress networks with non-individual MAC addresses as BSSID in the scan results"
 	help
-	  Wi-Fi access points use locally administered MAC address to manage
-	  multiple virtual interfaces, for geo-location usecase these networks
-	  from the virtual interfaces do not help in anyway as they are co-located with the primary interface
-	  that has globally unique MAC address.
-
+	  Wi-Fi access points use locally administered MAC addresses to manage
+	  multiple virtual interfaces. For geo-location use cases, these networks
+	  from the virtual interfaces do not help in any way as they are co-located with the primary interface
+	  that has a globally unique MAC address.
 	  So, to save resources, this option drops such networks from the scan results.
 
 config WIFI_NRF70_SCAN_DISABLE_DFS_CHANNELS
 	bool "Disables DFS channels in scan operation"
 	help
-	  This option disables inclusion of DFS channels in scan operation.
+	  This option disables inclusion of the DFS channels in the scan operation.
 	  This is useful to reduce the scan time, as DFS channels are seldom used.
 
 config NET_INTERFACE_NAME_LEN
@@ -655,30 +651,29 @@ config NRF_WIFI_AP_DEAD_DETECT_TIMEOUT
 	range 1 30
 	default 20
 	help
-		The number of seconds after which AP is declared dead if no beacons
-		are received from the AP. Used to detect AP silently going down e.g., power off.
+		The number of seconds after which the AP is declared dead if no beacons
+		are received from the AP. This is used to detect AP silently going down, for example, due to power off.
 
 config NRF_WIFI_RPU_RECOVERY
 	bool "RPU recovery mechanism"
 	depends on NRF_WIFI_LOW_POWER
 	default y
 	select EXPERIMENTAL
 	help
-		Enable RPU recovery mechanism to recover from RPU (nRF70) hang.
-		This feature performs an interface reset (down and up) which triggers
-		a RPU coldboot. Application's network connection will be lost during
-		the recovery process and it is application's responsibility to
+		Enable the RPU recovery mechanism to recover from an RPU (nRF70) hang.
+		This feature performs an interface reset (down and up), which triggers
+		a RPU cold boot. The application's network connection will be lost during
+		the recovery process, and it is the application's responsibility to
 		re-establish the network connection.
 
 if NRF_WIFI_RPU_RECOVERY
-
 config NRF_WIFI_RPU_RECOVERY_PROPAGATION_DELAY_MS
 	int "RPU recovery propagation delay in milliseconds"
 	default 2000
 	help
 		Propagation delay in milliseconds to wait after RPU is powered down
 		before powering it up. This delay is required to ensure that the recovery
-		is propagted to all the applications and stack and have enough time to
+		is propagated to all the applications and stack and have enough time to
 		clean up the resources.
 
 config NET_MGMT_EVENT_QUEUE_SIZE
@@ -689,16 +684,16 @@ config NRF_WIFI_RPU_RECOVERY_PROPAGATION_DELAY_MS
 	int "RPU recovery propagation delay in milliseconds"
 	default 10
 	help
-	  Propagation delay in milliseconds to wait after RPU is powered down
+	  Propagation delay in milliseconds to wait after the RPU is powered down
 	  before powering it up. This delay is required to ensure that the recovery
-	  is propagated to all the applications and stack and have enough time to
+	  is propagated to all the applications and stack, and has enough time to
 	  clean up the resources.
 
 config NRF_WIFI_RPU_RECOVERY_PS_ACTIVE_TIMEOUT_MS
 	int "RPU recovery power save active timeout in milliseconds"
 	default 50000
 	help
-	  Power save active timeout in milliseconds after which RPU recovery
+	  Power save active timeout in milliseconds, after which the RPU recovery
 	  mechanism will be triggered. This timeout is used to ensure that the
 	  RPU attempts to enter power save mode in case of inactivity.
 
@@ -713,7 +708,7 @@ config NRF_WIFI_RPU_MIN_TIME_TO_ENTER_SLEEP_MS
 config NRF_WIFI_RPU_RECOVERY_DEBUG
 	bool "RPU recovery debug logs"
 	help
-		Enable RPU recovery debug logs to help debug RPU recovery mechanism.
+		Enable RPU recovery debug logs to help debug the RPU recovery mechanism.
 
 config NRF_WIFI_RPU_RECOVERY_QUIET_PERIOD_MS
 	int "RPU recovery quiet period in milliseconds"
@@ -727,7 +722,7 @@ config NRF_WIFI_RPU_RECOVERY_MAX_RETRIES
 	default 0
 	help
 	  Maximum number of consecutive RPU recovery retries before giving up
-	  and resetting the system. Set to 0 to keep retrying indefinitely.
+	  and resetting the system. Set it to 0 to keep retrying indefinitely.
 
 config NRF_WIFI_RPU_RECOVERY_RETRY_WINDOW_S
 	int "RPU recovery retry window in seconds"
@@ -741,16 +736,14 @@ config NRF_WIFI_RPU_RECOVERY_RETRY_WINDOW_S
 config NRF_WIFI_RPU_RECOVERY_PS_STATE_DEBUG
 	bool "RPU recovery power save state debug logs"
 	help
-	  Enable RPU recovery power save state debug logs to help debug RPU recovery mechanism.
-
-
+	  Enable RPU recovery power save state debug logs to help debug the RPU recovery mechanism.
 endif # NRF_WIFI_RPU_RECOVERY
 
 config NRF_WIFI_FEAT_WMM
 	bool "WMM/QoS support"
 	default y
 	help
-	  This option controls disable/enable of the WMM(Wireless Multi-Media) feature.
+	  This option controls disable/enable of the WMM (Wireless Multi-Media) feature.
 
 choice NRF_WIFI_PS_DATA_RETRIEVAL_MECHANISM
 	prompt "Power save data retrieval mechanism"
@@ -759,37 +752,36 @@ choice NRF_WIFI_PS_DATA_RETRIEVAL_MECHANISM
 	  Select the mechanism to retrieve buffered data from AP.
 
 config NRF_WIFI_PS_POLL_BASED_RETRIEVAL
-	bool "PS-Poll frame based mechanism to retrieve buffered data from AP"
+	bool "PS-Poll frame-based mechanism to retrieve buffered data from AP"
 	help
-	  When AP notifies about availability of buffered data, the STA stays in power save
-	  and retrieves the frames one-by-one, this conserved more power but adds latency
-	  to the traffic. Ideal for minimum number of frames.
+	  When the AP notifies about the availability of buffered data, the STA stays in power save
+	  and retrieves the frames one-by-one. This conserves more power but adds latency
+	  to the traffic. It is ideal for minimum number of frames.
 
 config NRF_WIFI_QOS_NULL_BASED_RETRIEVAL
-	bool "QoS null frame based mechanism to retrieve buffered data from AP"
+	bool "QoS null frame-based mechanism to retrieve buffered data from AP"
 	help
-	  When AP notifies about availability of buffered data, the STA comes out of
-	  power save and then AP can deliver all buffered frames without any additional
+	  When the AP notifies about the availability of buffered data, the STA comes out of
+	  power save, and then AP can deliver all buffered frames without any additional
 	  overhead or latency, but STA enters power save after a delay costing more power
-	  depending on the delay. Ideal for heavy buffered traffic.
-
+	  depending on the delay. It is ideal for heavy buffered traffic.
 endchoice
 
 config NRF_WIFI_MGMT_BUFF_OFFLOAD
-	bool "management buffer offload"
+	bool "Management buffer offload"
 	default y
 	help
-	  This option offloads the refilling of management buffers to UMAC, saves host
-	  having to exchange commands and events for every management packet even if it is
+	  This option offloads the refilling of management buffers to the UMAC, saving the host
+	  from having to exchange commands and events for every management packet even if it is
 	  consumed by UMAC.
 
 config NRF_WIFI_FEAT_KEEPALIVE
 	bool "Wi-Fi keepalive feature for connection maintenance"
 	depends on NRF70_STA_MODE
 	help
-	  Enable Wi-Fi keepalive feature to keep the connection alive by sending
-	  keepalive packets to the AP. Primarily intended to interoperate with APs
-	  that disconnect idle clients without any explicit checks. Slightly increases
+	  Enable the Wi-Fi keepalive feature to keep the connection alive by sending
+	  keepalive packets to the AP. This feature is primarily intended to interoperate with APs
+	  that disconnect idle clients without any explicit checks. It slightly increases
 	  power consumption.
 
 if NRF_WIFI_FEAT_KEEPALIVE
@@ -816,9 +808,9 @@ config NRF_WIFI_PS_EXIT_EVERY_TIM
 config NRF_WIFI_PS_INT_PS
 	bool "Exit power save based on an intelligent algorithm"
 	help
-	  Exit power save based on an intelligent algorithm to retrieve buffered data from AP.
+	  Exit power save based on an intelligent algorithm to retrieve buffered data from the AP.
 	  The algorithm tracks the buffered data at the AP and then dynamically decides
-	  whether to stay in PS (for lower amount of buffered data) or exit PS (for higher
+	  whether to stay in PS (for a lower amount of buffered data) or exit PS (for a higher
 	  amount of buffered data).
 endchoice
 
@@ -827,5 +819,5 @@ config NRF70_PASSIVE_SCAN_ONLY
 	depends on NRF70_SCAN_ONLY
 	help
 	  Enable this configuration to force passive scan on all channels.
-	  This will override application specified scan type.
+	  This will override application-specified scan type.
 endif # WIFI_NRF70