[1/2] drivers: document struct wpa_signal_info

Message ID 1536169473-19181-1-git-send-email-andrei.otcheretianski@intel.com
State New
Headers show
Series
  • [1/2] drivers: document struct wpa_signal_info
Related show

Commit Message

Otcheretianski, Andrei Sept. 5, 2018, 5:44 p.m.
From: Emmanuel Grumbach <emmanuel.grumbach@intel.com>

Add documentation to the wpa_signal_info structure.
Add a define for an invalid noise value.

Signed-off-by: Emmanuel Grumbach <emmanuel.grumbach@intel.com>
---
 src/drivers/driver.h         | 13 +++++++++++++
 src/drivers/driver_nl80211.c |  4 ++--
 src/drivers/driver_wext.c    |  4 ++--
 3 files changed, 17 insertions(+), 4 deletions(-)

Patch

diff --git a/src/drivers/driver.h b/src/drivers/driver.h
index 22a37cc..0e0b0db 100644
--- a/src/drivers/driver.h
+++ b/src/drivers/driver.h
@@ -1911,8 +1911,21 @@  enum chan_width {
 	CHAN_WIDTH_UNKNOWN
 };
 
+#define WPA_INVALID_NOISE 9999
+
 /**
  * struct wpa_signal_info - Information about channel signal quality
+ * @frequency: control frequency
+ * @above_threshold: true if the above threshold was crossed
+ *	(relevant for CQM a event)
+ * @current_signal: in dBm
+ * @avg_signal: in dBm
+ * @avg_beacon_signal: in dBm
+ * @current_noise: %WPA_INVALID_NOISE if not supported
+ * @current_txrate: current Tx rate
+ * @chanwidth: the channel width
+ * @center_frq1: center frequency for the first segment
+ * @center_frq2: center frequency for the second segment (if relevant)
  */
 struct wpa_signal_info {
 	u32 frequency;
diff --git a/src/drivers/driver_nl80211.c b/src/drivers/driver_nl80211.c
index 39a02d3..c023de3 100644
--- a/src/drivers/driver_nl80211.c
+++ b/src/drivers/driver_nl80211.c
@@ -1414,7 +1414,7 @@  int nl80211_get_link_signal(struct wpa_driver_nl80211_data *drv,
 {
 	struct nl_msg *msg;
 
-	sig->current_signal = -9999;
+	sig->current_signal = -WPA_INVALID_NOISE;
 	sig->current_txrate = 0;
 
 	if (!(msg = nl80211_drv_msg(drv, 0, NL80211_CMD_GET_STATION)) ||
@@ -1476,7 +1476,7 @@  int nl80211_get_link_noise(struct wpa_driver_nl80211_data *drv,
 {
 	struct nl_msg *msg;
 
-	sig_change->current_noise = 9999;
+	sig_change->current_noise = WPA_INVALID_NOISE;
 	sig_change->frequency = drv->assoc_freq;
 
 	msg = nl80211_drv_msg(drv, NLM_F_DUMP, NL80211_CMD_GET_SURVEY);
diff --git a/src/drivers/driver_wext.c b/src/drivers/driver_wext.c
index 933b8d9..20abaab 100644
--- a/src/drivers/driver_wext.c
+++ b/src/drivers/driver_wext.c
@@ -2428,8 +2428,8 @@  static int wpa_driver_wext_signal_poll(void *priv, struct wpa_signal_info *si)
 	struct iwreq iwr;
 
 	os_memset(si, 0, sizeof(*si));
-	si->current_signal = -9999;
-	si->current_noise = 9999;
+	si->current_signal = -WPA_INVALID_NOISE;
+	si->current_noise = WPA_INVALID_NOISE;
 	si->chanwidth = CHAN_WIDTH_UNKNOWN;
 
 	os_memset(&iwr, 0, sizeof(iwr));