Commit ea2d8b59 authored by Randy Dunlap's avatar Randy Dunlap Committed by John W. Linville

mac80211.h: fix kernel-doc excesses

Fix mac80211.h kernel-doc: it had some extra parameters that were
no longer valid and incorrect format for a return value in 2 places.

Warning(lin2628-rc2//include/net/mac80211.h:1487): Excess function parameter or struct member 'control' description in 'ieee80211_beacon_get'
Warning(lin2628-rc2//include/net/mac80211.h:1596): Excess function parameter or struct member 'control' description in 'ieee80211_get_buffered_bc'
Warning(lin2628-rc2//include/net/mac80211.h:1632): Excess function parameter or struct member 'rc4key' description in 'ieee80211_get_tkip_key'
Warning(lin2628-rc2//include/net/mac80211.h:1735): Excess function parameter or struct member 'return' description in 'ieee80211_start_tx_ba_session'
Warning(lin2628-rc2//include/net/mac80211.h:1775): Excess function parameter or struct member 'return' description in 'ieee80211_stop_tx_ba_session'
Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Acked-by: default avatarJohannes Berg <johannes@sipsolutions.net>
Signed-off-by: default avatarJohn W. Linville <linville@tuxdriver.com>
parent f2c2e255
...@@ -1474,7 +1474,6 @@ void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, ...@@ -1474,7 +1474,6 @@ void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
* ieee80211_beacon_get - beacon generation function * ieee80211_beacon_get - beacon generation function
* @hw: pointer obtained from ieee80211_alloc_hw(). * @hw: pointer obtained from ieee80211_alloc_hw().
* @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
* @control: will be filled with information needed to send this beacon.
* *
* If the beacon frames are generated by the host system (i.e., not in * If the beacon frames are generated by the host system (i.e., not in
* hardware/firmware), the low-level driver uses this function to receive * hardware/firmware), the low-level driver uses this function to receive
...@@ -1575,7 +1574,6 @@ __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, ...@@ -1575,7 +1574,6 @@ __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
* ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
* @hw: pointer as obtained from ieee80211_alloc_hw(). * @hw: pointer as obtained from ieee80211_alloc_hw().
* @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf. * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
* @control: will be filled with information needed to send returned frame.
* *
* Function for accessing buffered broadcast and multicast frames. If * Function for accessing buffered broadcast and multicast frames. If
* hardware/firmware does not implement buffering of broadcast/multicast * hardware/firmware does not implement buffering of broadcast/multicast
...@@ -1623,9 +1621,8 @@ unsigned int ieee80211_hdrlen(__le16 fc); ...@@ -1623,9 +1621,8 @@ unsigned int ieee80211_hdrlen(__le16 fc);
* *
* @keyconf: the parameter passed with the set key * @keyconf: the parameter passed with the set key
* @skb: the skb for which the key is needed * @skb: the skb for which the key is needed
* @rc4key: a buffer to which the key will be written
* @type: TBD * @type: TBD
* @key: TBD * @key: a buffer to which the key will be written
*/ */
void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf, void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
struct sk_buff *skb, struct sk_buff *skb,
...@@ -1726,7 +1723,8 @@ void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw, ...@@ -1726,7 +1723,8 @@ void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
* @hw: pointer as obtained from ieee80211_alloc_hw(). * @hw: pointer as obtained from ieee80211_alloc_hw().
* @ra: receiver address of the BA session recipient * @ra: receiver address of the BA session recipient
* @tid: the TID to BA on. * @tid: the TID to BA on.
* @return: success if addBA request was sent, failure otherwise *
* Return: success if addBA request was sent, failure otherwise
* *
* Although mac80211/low level driver/user space application can estimate * Although mac80211/low level driver/user space application can estimate
* the need to start aggregation on a certain RA/TID, the session level * the need to start aggregation on a certain RA/TID, the session level
...@@ -1764,7 +1762,8 @@ void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra, ...@@ -1764,7 +1762,8 @@ void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
* @ra: receiver address of the BA session recipient * @ra: receiver address of the BA session recipient
* @tid: the TID to stop BA. * @tid: the TID to stop BA.
* @initiator: if indicates initiator DELBA frame will be sent. * @initiator: if indicates initiator DELBA frame will be sent.
* @return: error if no sta with matching da found, success otherwise *
* Return: error if no sta with matching da found, success otherwise
* *
* Although mac80211/low level driver/user space application can estimate * Although mac80211/low level driver/user space application can estimate
* the need to stop aggregation on a certain RA/TID, the session level * the need to stop aggregation on a certain RA/TID, the session level
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment