Commit 7d419463 authored by Johannes Berg's avatar Johannes Berg

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: default avatarJohannes Berg <johannes.berg@intel.com>
parent 9874b71f
...@@ -125,6 +125,9 @@ functions/definitions ...@@ -125,6 +125,9 @@ functions/definitions
.. kernel-doc:: include/net/mac80211.h .. kernel-doc:: include/net/mac80211.h
:functions: ieee80211_rx_status :functions: ieee80211_rx_status
.. kernel-doc:: include/net/mac80211.h
:functions: mac80211_rx_encoding_flags
.. kernel-doc:: include/net/mac80211.h .. kernel-doc:: include/net/mac80211.h
:functions: mac80211_rx_flags :functions: mac80211_rx_flags
......
...@@ -942,8 +942,32 @@ ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate) ...@@ -942,8 +942,32 @@ ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
* @band: the band to transmit on (use for checking for races) * @band: the band to transmit on (use for checking for races)
* @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
* @ack_frame_id: internal frame ID for TX status, used internally * @ack_frame_id: internal frame ID for TX status, used internally
* @control: union for control data * @control: union part for control data
* @status: union for status data * @control.rates: TX rates array to try
* @control.rts_cts_rate_idx: rate for RTS or CTS
* @control.use_rts: use RTS
* @control.use_cts_prot: use RTS/CTS
* @control.short_preamble: use short preamble (CCK only)
* @control.skip_table: skip externally configured rate table
* @control.jiffies: timestamp for expiry on powersave clients
* @control.vif: virtual interface (may be NULL)
* @control.hw_key: key to encrypt with (may be NULL)
* @control.flags: control flags, see &enum mac80211_tx_control_flags
* @control.enqueue_time: enqueue time (for iTXQs)
* @driver_rates: alias to @control.rates to reserve space
* @pad: padding
* @rate_driver_data: driver use area if driver needs @control.rates
* @status: union part for status data
* @status.rates: attempted rates
* @status.ack_signal: ACK signal
* @status.ampdu_ack_len: AMPDU ack length
* @status.ampdu_len: AMPDU length
* @status.antenna: (legacy, kept only for iwlegacy)
* @status.tx_time: airtime consumed for transmission
* @status.is_valid_ack_signal: ACK signal is valid
* @status.status_driver_data: driver use area
* @ack: union part for pure ACK data
* @ack.cookie: cookie for the ACK
* @driver_data: array of driver_data pointers * @driver_data: array of driver_data pointers
* @ampdu_ack_len: number of acked aggregated frames. * @ampdu_ack_len: number of acked aggregated frames.
* relevant only if IEEE80211_TX_STAT_AMPDU was set. * relevant only if IEEE80211_TX_STAT_AMPDU was set.
...@@ -1163,6 +1187,7 @@ ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info) ...@@ -1163,6 +1187,7 @@ ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
* @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known * @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known
* @RX_FLAG_RADIOTAP_HE: HE radiotap data is present * @RX_FLAG_RADIOTAP_HE: HE radiotap data is present
* (&struct ieee80211_radiotap_he, mac80211 will fill in * (&struct ieee80211_radiotap_he, mac80211 will fill in
*
* - DATA3_DATA_MCS * - DATA3_DATA_MCS
* - DATA3_DATA_DCM * - DATA3_DATA_DCM
* - DATA3_CODING * - DATA3_CODING
...@@ -1170,6 +1195,7 @@ ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info) ...@@ -1170,6 +1195,7 @@ ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
* - DATA5_DATA_BW_RU_ALLOC * - DATA5_DATA_BW_RU_ALLOC
* - DATA6_NSTS * - DATA6_NSTS
* - DATA3_STBC * - DATA3_STBC
*
* from the RX info data, so leave those zeroed when building this data) * from the RX info data, so leave those zeroed when building this data)
* @RX_FLAG_RADIOTAP_HE_MU: HE MU radiotap data is present * @RX_FLAG_RADIOTAP_HE_MU: HE MU radiotap data is present
* (&struct ieee80211_radiotap_he_mu) * (&struct ieee80211_radiotap_he_mu)
...@@ -1220,7 +1246,7 @@ enum mac80211_rx_flags { ...@@ -1220,7 +1246,7 @@ enum mac80211_rx_flags {
* @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
* if the driver fills this value it should add * if the driver fills this value it should add
* %IEEE80211_RADIOTAP_MCS_HAVE_FMT * %IEEE80211_RADIOTAP_MCS_HAVE_FMT
* to hw.radiotap_mcs_details to advertise that fact * to @hw.radiotap_mcs_details to advertise that fact.
* @RX_ENC_FLAG_LDPC: LDPC was used * @RX_ENC_FLAG_LDPC: LDPC was used
* @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
* @RX_ENC_FLAG_BF: packet was beamformed * @RX_ENC_FLAG_BF: packet was beamformed
...@@ -2333,12 +2359,14 @@ enum ieee80211_hw_flags { ...@@ -2333,12 +2359,14 @@ enum ieee80211_hw_flags {
* @radiotap_he: HE radiotap validity flags * @radiotap_he: HE radiotap validity flags
* *
* @radiotap_timestamp: Information for the radiotap timestamp field; if the * @radiotap_timestamp: Information for the radiotap timestamp field; if the
* 'units_pos' member is set to a non-negative value it must be set to * @units_pos member is set to a non-negative value then the timestamp
* a combination of a IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
* IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value, and then the timestamp
* field will be added and populated from the &struct ieee80211_rx_status * field will be added and populated from the &struct ieee80211_rx_status
* device_timestamp. If the 'accuracy' member is non-negative, it's put * device_timestamp.
* into the accuracy radiotap field and the accuracy known flag is set. * @radiotap_timestamp.units_pos: Must be set to a combination of a
* IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
* IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value.
* @radiotap_timestamp.accuracy: If non-negative, fills the accuracy in the
* radiotap field and the accuracy known flag will be set.
* *
* @netdev_features: netdev features to be set in each netdev created * @netdev_features: netdev features to be set in each netdev created
* from this HW. Note that not all features are usable with mac80211, * from this HW. Note that not all features are usable with mac80211,
......
...@@ -497,10 +497,28 @@ struct ieee80211_sta_rx_stats { ...@@ -497,10 +497,28 @@ struct ieee80211_sta_rx_stats {
* @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to
* the BSS one. * the BSS one.
* @tx_stats: TX statistics * @tx_stats: TX statistics
* @tx_stats.packets: # of packets transmitted
* @tx_stats.bytes: # of bytes in all packets transmitted
* @tx_stats.last_rate: last TX rate
* @tx_stats.msdu: # of transmitted MSDUs per TID
* @rx_stats: RX statistics * @rx_stats: RX statistics
* @rx_stats_avg: averaged RX statistics
* @rx_stats_avg.signal: averaged signal
* @rx_stats_avg.chain_signal: averaged per-chain signal
* @pcpu_rx_stats: per-CPU RX statistics, assigned only if the driver needs * @pcpu_rx_stats: per-CPU RX statistics, assigned only if the driver needs
* this (by advertising the USES_RSS hw flag) * this (by advertising the USES_RSS hw flag)
* @status_stats: TX status statistics * @status_stats: TX status statistics
* @status_stats.filtered: # of filtered frames
* @status_stats.retry_failed: # of frames that failed after retry
* @status_stats.retry_count: # of retries attempted
* @status_stats.lost_packets: # of lost packets
* @status_stats.last_tdls_pkt_time: timestamp of last TDLS packet
* @status_stats.msdu_retries: # of MSDU retries
* @status_stats.msdu_failed: # of failed MSDUs
* @status_stats.last_ack: last ack timestamp (jiffies)
* @status_stats.last_ack_signal: last ACK signal
* @status_stats.ack_signal_filled: last ACK signal validity
* @status_stats.avg_ack_signal: average ACK signal
*/ */
struct sta_info { struct sta_info {
/* General information, mostly static */ /* General information, mostly static */
......
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