[PATCH] mac80211: clarify some mac80211 things

The semantics of not having an add_interface callback are not well
defined, this callback is required because otherwise you cannot obtain
the requested MAC address of the device. Change the documentation to
reflect this, add a note about having no MAC address at all, add a
warning that mac_addr in struct ieee80211_if_init_conf can be NULL and
finally verify that a few callbacks are assigned by way of BUG_ON()

Signed-off-by: Johannes Berg <johannes@sipsolutions.net>
Signed-off-by: Jiri Benc <jbenc@suse.cz>
Signed-off-by: John W. Linville <linville@tuxdriver.com>

1 files changed, 12 insertions, 4 deletions

diff --git a/include/net/mac80211.h b/include/net/mac80211.h
index 627885765a36..c34fd9a6160a 100644
--- a/include/net/mac80211.h
+++ b/include/net/mac80211.h
@@ -347,9 +347,16 @@ enum ieee80211_if_types {
  * @mac_addr: pointer to MAC address of the interface. This pointer is valid
  *      until the interface is removed (i.e. it cannot be used after
  *      remove_interface() callback was called for this interface).
+ *      This pointer will be %NULL for monitor interfaces, be careful.
  *
  * This structure is used in add_interface() and remove_interface()
  * callbacks of &struct ieee80211_hw.
+ *
+ * When you allow multiple interfaces to be added to your PHY, take care
+ * that the hardware can actually handle multiple MAC addresses. However,
+ * also take care that when there's no interface left with mac_addr != %NULL
+ * you remove the MAC address from the device to avoid acknowledging packets
+ * in pure monitor mode.
  */
 struct ieee80211_if_init_conf {
         int if_id;
@@ -574,10 +581,11 @@ struct ieee80211_ops {
          * to returning zero. By returning non-zero addition of the interface
          * is inhibited. Unless monitor_during_oper is set, it is guaranteed
          * that monitor interfaces and normal interfaces are mutually
-         * exclusive. The open() handler is called after add_interface()
-         * if this is the first device added. At least one of the open()
-         * open() and add_interface() callbacks has to be assigned. If
-         * add_interface() is NULL, one STA interface is permitted only. */
+         * exclusive. If assigned, the open() handler is called after
+         * add_interface() if this is the first device added. The
+         * add_interface() callback has to be assigned because it is the only
+         * way to obtain the requested MAC address for any interface.
+         */
         int (*add_interface)(struct ieee80211_hw *hw,
                              struct ieee80211_if_init_conf *conf);