Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

mac80211: fix documentation warnings

For a few restructured text warnings in mac80211, making the
documentation warning-free (for now).

In order to not add trailing whitespace, but also not introduce
too much noise into this change, move just the affected docs
into inline comments.

Signed-off-by: Johannes Berg <johannes.berg@intel.com>

+45 -29
+45 -29
include/net/mac80211.h
··· 1768 1768 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single 1769 1769 * A-MSDU. Taken from the Extended Capabilities element. 0 means 1770 1770 * unlimited. 1771 - * @max_amsdu_len: indicates the maximal length of an A-MSDU in bytes. This 1772 - * field is always valid for packets with a VHT preamble. For packets 1773 - * with a HT preamble, additional limits apply: 1774 - * + If the skb is transmitted as part of a BA agreement, the 1775 - * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes. 1776 - * + If the skb is not part of a BA aggreement, the A-MSDU maximal 1777 - * size is min(max_amsdu_len, 7935) bytes. 1778 - * Both additional HT limits must be enforced by the low level driver. 1779 - * This is defined by the spec (IEEE 802.11-2012 section 8.3.2.2 NOTE 2). 1780 1771 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not. 1781 1772 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control. 1782 1773 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction) ··· 1790 1799 bool tdls_initiator; 1791 1800 bool mfp; 1792 1801 u8 max_amsdu_subframes; 1802 + 1803 + /** 1804 + * @max_amsdu_len: 1805 + * indicates the maximal length of an A-MSDU in bytes. 1806 + * This field is always valid for packets with a VHT preamble. 1807 + * For packets with a HT preamble, additional limits apply: 1808 + * 1809 + * * If the skb is transmitted as part of a BA agreement, the 1810 + * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes. 1811 + * * If the skb is not part of a BA aggreement, the A-MSDU maximal 1812 + * size is min(max_amsdu_len, 7935) bytes. 1813 + * 1814 + * Both additional HT limits must be enforced by the low level 1815 + * driver. This is defined by the spec (IEEE 802.11-2012 section 1816 + * 8.3.2.2 NOTE 2). 1817 + */ 1793 1818 u16 max_amsdu_len; 1794 1819 bool support_p2p_ps; 1795 1820 u16 max_rc_amsdu_len; ··· 3210 3203 * Returns non-zero if this device sent the last beacon. 3211 3204 * The callback can sleep. 3212 3205 * 3213 - * @ampdu_action: Perform a certain A-MPDU action 3214 - * The RA/TID combination determines the destination and TID we want 3215 - * the ampdu action to be performed for. The action is defined through 3216 - * ieee80211_ampdu_mlme_action. 3217 - * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver 3218 - * may neither send aggregates containing more subframes than @buf_size 3219 - * nor send aggregates in a way that lost frames would exceed the 3220 - * buffer size. If just limiting the aggregate size, this would be 3221 - * possible with a buf_size of 8: 3222 - * - TX: 1.....7 3223 - * - RX: 2....7 (lost frame #1) 3224 - * - TX: 8..1... 3225 - * which is invalid since #1 was now re-transmitted well past the 3226 - * buffer size of 8. Correct ways to retransmit #1 would be: 3227 - * - TX: 1 or 18 or 81 3228 - * Even "189" would be wrong since 1 could be lost again. 3229 - * 3230 - * Returns a negative error code on failure. 3231 - * The callback can sleep. 3232 - * 3233 3206 * @get_survey: Return per-channel survey information 3234 3207 * 3235 3208 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also ··· 3562 3575 s64 offset); 3563 3576 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 3564 3577 int (*tx_last_beacon)(struct ieee80211_hw *hw); 3578 + 3579 + /** 3580 + * @ampdu_action: 3581 + * Perform a certain A-MPDU action. 3582 + * The RA/TID combination determines the destination and TID we want 3583 + * the ampdu action to be performed for. The action is defined through 3584 + * ieee80211_ampdu_mlme_action. 3585 + * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver 3586 + * may neither send aggregates containing more subframes than @buf_size 3587 + * nor send aggregates in a way that lost frames would exceed the 3588 + * buffer size. If just limiting the aggregate size, this would be 3589 + * possible with a buf_size of 8: 3590 + * 3591 + * - ``TX: 1.....7`` 3592 + * - ``RX: 2....7`` (lost frame #1) 3593 + * - ``TX: 8..1...`` 3594 + * 3595 + * which is invalid since #1 was now re-transmitted well past the 3596 + * buffer size of 8. Correct ways to retransmit #1 would be: 3597 + * 3598 + * - ``TX: 1 or`` 3599 + * - ``TX: 18 or`` 3600 + * - ``TX: 81`` 3601 + * 3602 + * Even ``189`` would be wrong since 1 could be lost again. 3603 + * 3604 + * Returns a negative error code on failure. 3605 + * The callback can sleep. 3606 + */ 3565 3607 int (*ampdu_action)(struct ieee80211_hw *hw, 3566 3608 struct ieee80211_vif *vif, 3567 3609 struct ieee80211_ampdu_params *params);