[MAC80211]: Update beacon_update callback documentation
authorMichael Buesch <mb@bu3sch.de>
Tue, 2 Oct 2007 10:17:56 +0000 (12:17 +0200)
committerDavid S. Miller <davem@sunset.davemloft.net>
Wed, 10 Oct 2007 23:54:21 +0000 (16:54 -0700)
Signed-off-by: Michael Buesch <mb@bu3sch.de>
Signed-off-by: John W. Linville <linville@tuxdriver.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
include/net/mac80211.h

index 9bc03f053af0f9cbdfaf6012f40d7bdee67cdf63..5fcc4c1043401cac93ab97a96a5fcb97da0ca031 100644 (file)
@@ -996,7 +996,14 @@ enum ieee80211_erp_change_flags {
  *
  * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point,
  *     IBSS uses a fixed beacon frame which is configured using this
- *     function. This handler is required only for IBSS mode.
+ *     function.
+ *     If the driver returns success (0) from this callback, it owns
+ *     the skb. That means the driver is responsible to kfree_skb() it.
+ *     The control structure is not dynamically allocated. That means the
+ *     driver does not own the pointer and if it needs it somewhere
+ *     outside of the context of this function, it must copy it
+ *     somewhere else.
+ *     This handler is required only for IBSS mode.
  *
  * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
  *     This is needed only for IBSS mode and the result of this function is