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

mac80211: fix missing/malformed documentation

Fix the missing and malformed documentation that kernel-doc and
sphinx warn about. While at it, also add some things to the docs
to fix missing links.

Sadly, the only way I could find to fix this was to add some
trailing whitespace.

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

+57 -8
+3
Documentation/driver-api/80211/mac80211.rst
··· 126 126 :functions: ieee80211_rx_status 127 127 128 128 .. kernel-doc:: include/net/mac80211.h 129 + :functions: mac80211_rx_encoding_flags 130 + 131 + .. kernel-doc:: include/net/mac80211.h 129 132 :functions: mac80211_rx_flags 130 133 131 134 .. kernel-doc:: include/net/mac80211.h
+36 -8
include/net/mac80211.h
··· 942 942 * @band: the band to transmit on (use for checking for races) 943 943 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC 944 944 * @ack_frame_id: internal frame ID for TX status, used internally 945 - * @control: union for control data 946 - * @status: union for status data 945 + * @control: union part for control data 946 + * @control.rates: TX rates array to try 947 + * @control.rts_cts_rate_idx: rate for RTS or CTS 948 + * @control.use_rts: use RTS 949 + * @control.use_cts_prot: use RTS/CTS 950 + * @control.short_preamble: use short preamble (CCK only) 951 + * @control.skip_table: skip externally configured rate table 952 + * @control.jiffies: timestamp for expiry on powersave clients 953 + * @control.vif: virtual interface (may be NULL) 954 + * @control.hw_key: key to encrypt with (may be NULL) 955 + * @control.flags: control flags, see &enum mac80211_tx_control_flags 956 + * @control.enqueue_time: enqueue time (for iTXQs) 957 + * @driver_rates: alias to @control.rates to reserve space 958 + * @pad: padding 959 + * @rate_driver_data: driver use area if driver needs @control.rates 960 + * @status: union part for status data 961 + * @status.rates: attempted rates 962 + * @status.ack_signal: ACK signal 963 + * @status.ampdu_ack_len: AMPDU ack length 964 + * @status.ampdu_len: AMPDU length 965 + * @status.antenna: (legacy, kept only for iwlegacy) 966 + * @status.tx_time: airtime consumed for transmission 967 + * @status.is_valid_ack_signal: ACK signal is valid 968 + * @status.status_driver_data: driver use area 969 + * @ack: union part for pure ACK data 970 + * @ack.cookie: cookie for the ACK 947 971 * @driver_data: array of driver_data pointers 948 972 * @ampdu_ack_len: number of acked aggregated frames. 949 973 * relevant only if IEEE80211_TX_STAT_AMPDU was set. ··· 1187 1163 * @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known 1188 1164 * @RX_FLAG_RADIOTAP_HE: HE radiotap data is present 1189 1165 * (&struct ieee80211_radiotap_he, mac80211 will fill in 1166 + * 1190 1167 * - DATA3_DATA_MCS 1191 1168 * - DATA3_DATA_DCM 1192 1169 * - DATA3_CODING ··· 1195 1170 * - DATA5_DATA_BW_RU_ALLOC 1196 1171 * - DATA6_NSTS 1197 1172 * - DATA3_STBC 1173 + * 1198 1174 * from the RX info data, so leave those zeroed when building this data) 1199 1175 * @RX_FLAG_RADIOTAP_HE_MU: HE MU radiotap data is present 1200 1176 * (&struct ieee80211_radiotap_he_mu) ··· 1246 1220 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, 1247 1221 * if the driver fills this value it should add 1248 1222 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT 1249 - * to hw.radiotap_mcs_details to advertise that fact 1223 + * to @hw.radiotap_mcs_details to advertise that fact. 1250 1224 * @RX_ENC_FLAG_LDPC: LDPC was used 1251 1225 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3 1252 1226 * @RX_ENC_FLAG_BF: packet was beamformed ··· 2359 2333 * @radiotap_he: HE radiotap validity flags 2360 2334 * 2361 2335 * @radiotap_timestamp: Information for the radiotap timestamp field; if the 2362 - * 'units_pos' member is set to a non-negative value it must be set to 2363 - * a combination of a IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a 2364 - * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value, and then the timestamp 2336 + * @units_pos member is set to a non-negative value then the timestamp 2365 2337 * field will be added and populated from the &struct ieee80211_rx_status 2366 - * device_timestamp. If the 'accuracy' member is non-negative, it's put 2367 - * into the accuracy radiotap field and the accuracy known flag is set. 2338 + * device_timestamp. 2339 + * @radiotap_timestamp.units_pos: Must be set to a combination of a 2340 + * IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a 2341 + * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value. 2342 + * @radiotap_timestamp.accuracy: If non-negative, fills the accuracy in the 2343 + * radiotap field and the accuracy known flag will be set. 2368 2344 * 2369 2345 * @netdev_features: netdev features to be set in each netdev created 2370 2346 * from this HW. Note that not all features are usable with mac80211,
+18
net/mac80211/sta_info.h
··· 497 497 * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to 498 498 * the BSS one. 499 499 * @tx_stats: TX statistics 500 + * @tx_stats.packets: # of packets transmitted 501 + * @tx_stats.bytes: # of bytes in all packets transmitted 502 + * @tx_stats.last_rate: last TX rate 503 + * @tx_stats.msdu: # of transmitted MSDUs per TID 500 504 * @rx_stats: RX statistics 505 + * @rx_stats_avg: averaged RX statistics 506 + * @rx_stats_avg.signal: averaged signal 507 + * @rx_stats_avg.chain_signal: averaged per-chain signal 501 508 * @pcpu_rx_stats: per-CPU RX statistics, assigned only if the driver needs 502 509 * this (by advertising the USES_RSS hw flag) 503 510 * @status_stats: TX status statistics 511 + * @status_stats.filtered: # of filtered frames 512 + * @status_stats.retry_failed: # of frames that failed after retry 513 + * @status_stats.retry_count: # of retries attempted 514 + * @status_stats.lost_packets: # of lost packets 515 + * @status_stats.last_tdls_pkt_time: timestamp of last TDLS packet 516 + * @status_stats.msdu_retries: # of MSDU retries 517 + * @status_stats.msdu_failed: # of failed MSDUs 518 + * @status_stats.last_ack: last ack timestamp (jiffies) 519 + * @status_stats.last_ack_signal: last ACK signal 520 + * @status_stats.ack_signal_filled: last ACK signal validity 521 + * @status_stats.avg_ack_signal: average ACK signal 504 522 */ 505 523 struct sta_info { 506 524 /* General information, mostly static */