cfg80211: add documentation for cfg80211_get_bss()
authorJohannes Berg <johannes.berg@intel.com>
Fri, 31 Mar 2017 07:12:39 +0000 (09:12 +0200)
committerJohannes Berg <johannes.berg@intel.com>
Fri, 31 Mar 2017 07:15:45 +0000 (09:15 +0200)
This was missing, but is referenced a lot in the documentation.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>
include/net/cfg80211.h

index 042137d7d22604a426ae157f2dd2e7e6adf37903..273b1dca0861ffe07c3e5b88ec876bd29d343497 100644 (file)
@@ -4699,12 +4699,22 @@ cfg80211_inform_bss(struct wiphy *wiphy,
                                        gfp);
 }
 
+/**
+ * cfg80211_get_bss - get a BSS reference
+ * @wiphy: the wiphy this BSS struct belongs to
+ * @channel: the channel to search on (or %NULL)
+ * @bssid: the desired BSSID (or %NULL)
+ * @ssid: the desired SSID (or %NULL)
+ * @ssid_len: length of the SSID (or 0)
+ * @bss_type: type of BSS, see &enum ieee80211_bss_type
+ * @privacy: privacy filter, see &enum ieee80211_privacy
+ */
 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
                                      struct ieee80211_channel *channel,
                                      const u8 *bssid,
                                      const u8 *ssid, size_t ssid_len,
                                      enum ieee80211_bss_type bss_type,
-                                     enum ieee80211_privacy);
+                                     enum ieee80211_privacy privacy);
 static inline struct cfg80211_bss *
 cfg80211_get_ibss(struct wiphy *wiphy,
                  struct ieee80211_channel *channel,