cfg80211: Improve Connect/Associate command documentation

The roaming cases for the Connect command were not fully covered and
neither Connect nor Associate command uses of the prev_bssid parameter
were very clear. Add details to describe how the prev_bssid argument is
supposed to be used and when the driver should use association or
reassociation.

Signed-off-by: Jouni Malinen <jouni@qca.qualcomm.com>
Signed-off-by: Johannes Berg <johannes.berg@intel.com>

1 files changed, 13 insertions, 3 deletions

diff --git a/include/uapi/linux/nl80211.h b/include/uapi/linux/nl80211.h
index 6da52d7b48c4..b4606288ef7a 100644
--- a/include/uapi/linux/nl80211.h
+++ b/include/uapi/linux/nl80211.h
@@ -429,7 +429,11 @@
  * @NL80211_CMD_ASSOCIATE: association request and notification; like
  *      NL80211_CMD_AUTHENTICATE but for Association and Reassociation
  *      (similar to MLME-ASSOCIATE.request, MLME-REASSOCIATE.request,
- *      MLME-ASSOCIATE.confirm or MLME-REASSOCIATE.confirm primitives).
+ *      MLME-ASSOCIATE.confirm or MLME-REASSOCIATE.confirm primitives). The
+ *      %NL80211_ATTR_PREV_BSSID attribute is used to specify whether the
+ *      request is for the initial association to an ESS (that attribute not
+ *      included) or for reassociation within the ESS (that attribute is
+ *      included).
  * @NL80211_CMD_DEAUTHENTICATE: deauthentication request and notification; like
  *      NL80211_CMD_AUTHENTICATE but for Deauthentication frames (similar to
  *      MLME-DEAUTHENTICATION.request and MLME-DEAUTHENTICATE.indication
@@ -479,6 +483,9 @@
  *      set of BSSID,frequency parameters is used (i.e., either the enforcing
  *      %NL80211_ATTR_MAC,%NL80211_ATTR_WIPHY_FREQ or the less strict
  *      %NL80211_ATTR_MAC_HINT and %NL80211_ATTR_WIPHY_FREQ_HINT).
+ *      %NL80211_ATTR_PREV_BSSID can be used to request a reassociation within
+ *      the ESS in case the device is already associated and an association with
+ *      a different BSS is desired.
  *      Background scan period can optionally be
  *      specified in %NL80211_ATTR_BG_SCAN_PERIOD,
  *      if not specified default background scan configuration
@@ -1287,8 +1294,11 @@ enum nl80211_commands {
  * @NL80211_ATTR_RESP_IE: (Re)association response information elements as
  *      sent by peer, for ROAM and successful CONNECT events.
  *
- * @NL80211_ATTR_PREV_BSSID: previous BSSID, to be used by in ASSOCIATE
- *      commands to specify using a reassociate frame
+ * @NL80211_ATTR_PREV_BSSID: previous BSSID, to be used in ASSOCIATE and CONNECT
+ *      commands to specify a request to reassociate within an ESS, i.e., to use
+ *      Reassociate Request frame (with the value of this attribute in the
+ *      Current AP address field) instead of Association Request frame which is
+ *      used for the initial association to an ESS.
  *
  * @NL80211_ATTR_KEY: key information in a nested attribute with
  *      %NL80211_KEY_* sub-attributes