net/mac80211/sta_info.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright 2002-2005, Devicescape Software, Inc.
   4  * Copyright 2013-2014  Intel Mobile Communications GmbH
   5  * Copyright(c) 2015-2017 Intel Deutschland GmbH
   6  * Copyright(c) 2020 Intel Corporation
   7  */
   8
   9 #ifndef STA_INFO_H
  10 #define STA_INFO_H
  11
  12 #include <linux/list.h>
  13 #include <linux/types.h>
  14 #include <linux/if_ether.h>
  15 #include <linux/workqueue.h>
  16 #include <linux/average.h>
  17 #include <linux/bitfield.h>
  18 #include <linux/etherdevice.h>
  19 #include <linux/rhashtable.h>
  20 #include <linux/u64_stats_sync.h>
  21 #include "key.h"
  22
  23 /**
  24  * enum ieee80211_sta_info_flags - Stations flags
  25  *
  26  * These flags are used with &struct sta_info's @flags member, but
  27  * only indirectly with set_sta_flag() and friends.
  28  *
  29  * @WLAN_STA_AUTH: Station is authenticated.
  30  * @WLAN_STA_ASSOC: Station is associated.
  31  * @WLAN_STA_PS_STA: Station is in power-save mode
  32  * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
  33  *      This bit is always checked so needs to be enabled for all stations
  34  *      when virtual port control is not in use.
  35  * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
  36  *      frames.
  37  * @WLAN_STA_WDS: Station is one of our WDS peers.
  38  * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
  39  *      IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
  40  *      frame to this station is transmitted.
  41  * @WLAN_STA_MFP: Management frame protection is used with this STA.
  42  * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
  43  *      during suspend/resume and station removal.
  44  * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
  45  *      power-save mode logically to flush frames that might still
  46  *      be in the queues
  47  * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
  48  *      station in power-save mode, reply when the driver unblocks.
  49  * @WLAN_STA_TDLS_PEER: Station is a TDLS peer.
  50  * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct
  51  *      packets. This means the link is enabled.
  52  * @WLAN_STA_TDLS_INITIATOR: We are the initiator of the TDLS link with this
  53  *      station.
  54  * @WLAN_STA_TDLS_CHAN_SWITCH: This TDLS peer supports TDLS channel-switching
  55  * @WLAN_STA_TDLS_OFF_CHANNEL: The local STA is currently off-channel with this
  56  *      TDLS peer
  57  * @WLAN_STA_TDLS_WIDER_BW: This TDLS peer supports working on a wider bw on
  58  *      the BSS base channel.
  59  * @WLAN_STA_UAPSD: Station requested unscheduled SP while driver was
  60  *      keeping station in power-save mode, reply when the driver
  61  *      unblocks the station.
  62  * @WLAN_STA_SP: Station is in a service period, so don't try to
  63  *      reply to other uAPSD trigger frames or PS-Poll.
  64  * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
  65  * @WLAN_STA_INSERTED: This station is inserted into the hash table.
  66  * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
  67  * @WLAN_STA_TOFFSET_KNOWN: toffset calculated for this station is valid.
  68  * @WLAN_STA_MPSP_OWNER: local STA is owner of a mesh Peer Service Period.
  69  * @WLAN_STA_MPSP_RECIPIENT: local STA is recipient of a MPSP.
  70  * @WLAN_STA_PS_DELIVER: station woke up, but we're still blocking TX
  71  *      until pending frames are delivered
  72  * @WLAN_STA_USES_ENCRYPTION: This station was configured for encryption,
  73  *      so drop all packets without a key later.
  74  *
  75  * @NUM_WLAN_STA_FLAGS: number of defined flags
  76  */
  77 enum ieee80211_sta_info_flags {
  78         WLAN_STA_AUTH,
  79         WLAN_STA_ASSOC,
  80         WLAN_STA_PS_STA,
  81         WLAN_STA_AUTHORIZED,
  82         WLAN_STA_SHORT_PREAMBLE,
  83         WLAN_STA_WDS,
  84         WLAN_STA_CLEAR_PS_FILT,
  85         WLAN_STA_MFP,
  86         WLAN_STA_BLOCK_BA,
  87         WLAN_STA_PS_DRIVER,
  88         WLAN_STA_PSPOLL,
  89         WLAN_STA_TDLS_PEER,
  90         WLAN_STA_TDLS_PEER_AUTH,
  91         WLAN_STA_TDLS_INITIATOR,
  92         WLAN_STA_TDLS_CHAN_SWITCH,
  93         WLAN_STA_TDLS_OFF_CHANNEL,
  94         WLAN_STA_TDLS_WIDER_BW,
  95         WLAN_STA_UAPSD,
  96         WLAN_STA_SP,
  97         WLAN_STA_4ADDR_EVENT,
  98         WLAN_STA_INSERTED,
  99         WLAN_STA_RATE_CONTROL,
 100         WLAN_STA_TOFFSET_KNOWN,
 101         WLAN_STA_MPSP_OWNER,
 102         WLAN_STA_MPSP_RECIPIENT,
 103         WLAN_STA_PS_DELIVER,
 104         WLAN_STA_USES_ENCRYPTION,
 105
 106         NUM_WLAN_STA_FLAGS,
 107 };
 108
 109 #define ADDBA_RESP_INTERVAL HZ
 110 #define HT_AGG_MAX_RETRIES              15
 111 #define HT_AGG_BURST_RETRIES            3
 112 #define HT_AGG_RETRIES_PERIOD           (15 * HZ)
 113
 114 #define HT_AGG_STATE_DRV_READY          0
 115 #define HT_AGG_STATE_RESPONSE_RECEIVED  1
 116 #define HT_AGG_STATE_OPERATIONAL        2
 117 #define HT_AGG_STATE_STOPPING           3
 118 #define HT_AGG_STATE_WANT_START         4
 119 #define HT_AGG_STATE_WANT_STOP          5
 120 #define HT_AGG_STATE_START_CB           6
 121 #define HT_AGG_STATE_STOP_CB            7
 122 #define HT_AGG_STATE_SENT_ADDBA         8
 123
 124 DECLARE_EWMA(avg_signal, 10, 8)
 125 enum ieee80211_agg_stop_reason {
 126         AGG_STOP_DECLINED,
 127         AGG_STOP_LOCAL_REQUEST,
 128         AGG_STOP_PEER_REQUEST,
 129         AGG_STOP_DESTROY_STA,
 130 };
 131
 132 /* Debugfs flags to enable/disable use of RX/TX airtime in scheduler */
 133 #define AIRTIME_USE_TX          BIT(0)
 134 #define AIRTIME_USE_RX          BIT(1)
 135
 136 struct airtime_info {
 137         u64 rx_airtime;
 138         u64 tx_airtime;
 139         s64 deficit;
 140         atomic_t aql_tx_pending; /* Estimated airtime for frames pending */
 141         u32 aql_limit_low;
 142         u32 aql_limit_high;
 143 };
 144
 145 void ieee80211_sta_update_pending_airtime(struct ieee80211_local *local,
 146                                           struct sta_info *sta, u8 ac,
 147                                           u16 tx_airtime, bool tx_completed);
 148
 149 struct sta_info;
 150
 151 /**
 152  * struct tid_ampdu_tx - TID aggregation information (Tx).
 153  *
 154  * @rcu_head: rcu head for freeing structure
 155  * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
 156  * @addba_resp_timer: timer for peer's response to addba request
 157  * @pending: pending frames queue -- use sta's spinlock to protect
 158  * @sta: station we are attached to
 159  * @dialog_token: dialog token for aggregation session
 160  * @timeout: session timeout value to be filled in ADDBA requests
 161  * @tid: TID number
 162  * @state: session state (see above)
 163  * @last_tx: jiffies of last tx activity
 164  * @stop_initiator: initiator of a session stop
 165  * @tx_stop: TX DelBA frame when stopping
 166  * @buf_size: reorder buffer size at receiver
 167  * @failed_bar_ssn: ssn of the last failed BAR tx attempt
 168  * @bar_pending: BAR needs to be re-sent
 169  * @amsdu: support A-MSDU withing A-MDPU
 170  *
 171  * This structure's lifetime is managed by RCU, assignments to
 172  * the array holding it must hold the aggregation mutex.
 173  *
 174  * The TX path can access it under RCU lock-free if, and
 175  * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
 176  * set. Otherwise, the TX path must also acquire the spinlock
 177  * and re-check the state, see comments in the tx code
 178  * touching it.
 179  */
 180 struct tid_ampdu_tx {
 181         struct rcu_head rcu_head;
 182         struct timer_list session_timer;
 183         struct timer_list addba_resp_timer;
 184         struct sk_buff_head pending;
 185         struct sta_info *sta;
 186         unsigned long state;
 187         unsigned long last_tx;
 188         u16 timeout;
 189         u8 dialog_token;
 190         u8 stop_initiator;
 191         bool tx_stop;
 192         u16 buf_size;
 193
 194         u16 failed_bar_ssn;
 195         bool bar_pending;
 196         bool amsdu;
 197         u8 tid;
 198 };
 199
 200 /**
 201  * struct tid_ampdu_rx - TID aggregation information (Rx).
 202  *
 203  * @reorder_buf: buffer to reorder incoming aggregated MPDUs. An MPDU may be an
 204  *      A-MSDU with individually reported subframes.
 205  * @reorder_buf_filtered: bitmap indicating where there are filtered frames in
 206  *      the reorder buffer that should be ignored when releasing frames
 207  * @reorder_time: jiffies when skb was added
 208  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
 209  * @reorder_timer: releases expired frames from the reorder buffer.
 210  * @sta: station we are attached to
 211  * @last_rx: jiffies of last rx activity
 212  * @head_seq_num: head sequence number in reordering buffer.
 213  * @stored_mpdu_num: number of MPDUs in reordering buffer
 214  * @ssn: Starting Sequence Number expected to be aggregated.
 215  * @buf_size: buffer size for incoming A-MPDUs
 216  * @timeout: reset timer value (in TUs).
 217  * @tid: TID number
 218  * @rcu_head: RCU head used for freeing this struct
 219  * @reorder_lock: serializes access to reorder buffer, see below.
 220  * @auto_seq: used for offloaded BA sessions to automatically pick head_seq_and
 221  *      and ssn.
 222  * @removed: this session is removed (but might have been found due to RCU)
 223  * @started: this session has started (head ssn or higher was received)
 224  *
 225  * This structure's lifetime is managed by RCU, assignments to
 226  * the array holding it must hold the aggregation mutex.
 227  *
 228  * The @reorder_lock is used to protect the members of this
 229  * struct, except for @timeout, @buf_size and @dialog_token,
 230  * which are constant across the lifetime of the struct (the
 231  * dialog token being used only for debugging).
 232  */
 233 struct tid_ampdu_rx {
 234         struct rcu_head rcu_head;
 235         spinlock_t reorder_lock;
 236         u64 reorder_buf_filtered;
 237         struct sk_buff_head *reorder_buf;
 238         unsigned long *reorder_time;
 239         struct sta_info *sta;
 240         struct timer_list session_timer;
 241         struct timer_list reorder_timer;
 242         unsigned long last_rx;
 243         u16 head_seq_num;
 244         u16 stored_mpdu_num;
 245         u16 ssn;
 246         u16 buf_size;
 247         u16 timeout;
 248         u8 tid;
 249         u8 auto_seq:1,
 250            removed:1,
 251            started:1;
 252 };
 253
 254 /**
 255  * struct sta_ampdu_mlme - STA aggregation information.
 256  *
 257  * @mtx: mutex to protect all TX data (except non-NULL assignments
 258  *      to tid_tx[idx], which are protected by the sta spinlock)
 259  *      tid_start_tx is also protected by sta->lock.
 260  * @tid_rx: aggregation info for Rx per TID -- RCU protected
 261  * @tid_rx_token: dialog tokens for valid aggregation sessions
 262  * @tid_rx_timer_expired: bitmap indicating on which TIDs the
 263  *      RX timer expired until the work for it runs
 264  * @tid_rx_stop_requested:  bitmap indicating which BA sessions per TID the
 265  *      driver requested to close until the work for it runs
 266  * @tid_rx_manage_offl: bitmap indicating which BA sessions were requested
 267  *      to be treated as started/stopped due to offloading
 268  * @agg_session_valid: bitmap indicating which TID has a rx BA session open on
 269  * @unexpected_agg: bitmap indicating which TID already sent a delBA due to
 270  *      unexpected aggregation related frames outside a session
 271  * @work: work struct for starting/stopping aggregation
 272  * @tid_tx: aggregation info for Tx per TID
 273  * @tid_start_tx: sessions where start was requested
 274  * @last_addba_req_time: timestamp of the last addBA request.
 275  * @addba_req_num: number of times addBA request has been sent.
 276  * @dialog_token_allocator: dialog token enumerator for each new session;
 277  */
 278 struct sta_ampdu_mlme {
 279         struct mutex mtx;
 280         /* rx */
 281         struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS];
 282         u8 tid_rx_token[IEEE80211_NUM_TIDS];
 283         unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
 284         unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
 285         unsigned long tid_rx_manage_offl[BITS_TO_LONGS(2 * IEEE80211_NUM_TIDS)];
 286         unsigned long agg_session_valid[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
 287         unsigned long unexpected_agg[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
 288         /* tx */
 289         struct work_struct work;
 290         struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS];
 291         struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS];
 292         unsigned long last_addba_req_time[IEEE80211_NUM_TIDS];
 293         u8 addba_req_num[IEEE80211_NUM_TIDS];
 294         u8 dialog_token_allocator;
 295 };
 296
 297
 298 /* Value to indicate no TID reservation */
 299 #define IEEE80211_TID_UNRESERVED        0xff
 300
 301 #define IEEE80211_FAST_XMIT_MAX_IV      18
 302
 303 /**
 304  * struct ieee80211_fast_tx - TX fastpath information
 305  * @key: key to use for hw crypto
 306  * @hdr: the 802.11 header to put with the frame
 307  * @hdr_len: actual 802.11 header length
 308  * @sa_offs: offset of the SA
 309  * @da_offs: offset of the DA
 310  * @pn_offs: offset where to put PN for crypto (or 0 if not needed)
 311  * @band: band this will be transmitted on, for tx_info
 312  * @rcu_head: RCU head to free this struct
 313  *
 314  * This struct is small enough so that the common case (maximum crypto
 315  * header length of 8 like for CCMP/GCMP) fits into a single 64-byte
 316  * cache line.
 317  */
 318 struct ieee80211_fast_tx {
 319         struct ieee80211_key *key;
 320         u8 hdr_len;
 321         u8 sa_offs, da_offs, pn_offs;
 322         u8 band;
 323         u8 hdr[30 + 2 + IEEE80211_FAST_XMIT_MAX_IV +
 324                sizeof(rfc1042_header)] __aligned(2);
 325
 326         struct rcu_head rcu_head;
 327 };
 328
 329 /**
 330  * struct ieee80211_fast_rx - RX fastpath information
 331  * @dev: netdevice for reporting the SKB
 332  * @vif_type: (P2P-less) interface type of the original sdata (sdata->vif.type)
 333  * @vif_addr: interface address
 334  * @rfc1042_hdr: copy of the RFC 1042 SNAP header (to have in cache)
 335  * @control_port_protocol: control port protocol copied from sdata
 336  * @expected_ds_bits: from/to DS bits expected
 337  * @icv_len: length of the MIC if present
 338  * @key: bool indicating encryption is expected (key is set)
 339  * @internal_forward: forward froms internally on AP/VLAN type interfaces
 340  * @uses_rss: copy of USES_RSS hw flag
 341  * @da_offs: offset of the DA in the header (for header conversion)
 342  * @sa_offs: offset of the SA in the header (for header conversion)
 343  * @rcu_head: RCU head for freeing this structure
 344  */
 345 struct ieee80211_fast_rx {
 346         struct net_device *dev;
 347         enum nl80211_iftype vif_type;
 348         u8 vif_addr[ETH_ALEN] __aligned(2);
 349         u8 rfc1042_hdr[6] __aligned(2);
 350         __be16 control_port_protocol;
 351         __le16 expected_ds_bits;
 352         u8 icv_len;
 353         u8 key:1,
 354            internal_forward:1,
 355            uses_rss:1;
 356         u8 da_offs, sa_offs;
 357
 358         struct rcu_head rcu_head;
 359 };
 360
 361 /* we use only values in the range 0-100, so pick a large precision */
 362 DECLARE_EWMA(mesh_fail_avg, 20, 8)
 363 DECLARE_EWMA(mesh_tx_rate_avg, 8, 16)
 364
 365 /**
 366  * struct mesh_sta - mesh STA information
 367  * @plink_lock: serialize access to plink fields
 368  * @llid: Local link ID
 369  * @plid: Peer link ID
 370  * @aid: local aid supplied by peer
 371  * @reason: Cancel reason on PLINK_HOLDING state
 372  * @plink_retries: Retries in establishment
 373  * @plink_state: peer link state
 374  * @plink_timeout: timeout of peer link
 375  * @plink_timer: peer link watch timer
 376  * @plink_sta: peer link watch timer's sta_info
 377  * @t_offset: timing offset relative to this host
 378  * @t_offset_setpoint: reference timing offset of this sta to be used when
 379  *      calculating clockdrift
 380  * @local_pm: local link-specific power save mode
 381  * @peer_pm: peer-specific power save mode towards local STA
 382  * @nonpeer_pm: STA power save mode towards non-peer neighbors
 383  * @processed_beacon: set to true after peer rates and capabilities are
 384  *      processed
 385  * @connected_to_gate: true if mesh STA has a path to a mesh gate
 386  * @connected_to_as: true if mesh STA has a path to a authentication server
 387  * @fail_avg: moving percentage of failed MSDUs
 388  * @tx_rate_avg: moving average of tx bitrate
 389  */
 390 struct mesh_sta {
 391         struct timer_list plink_timer;
 392         struct sta_info *plink_sta;
 393
 394         s64 t_offset;
 395         s64 t_offset_setpoint;
 396
 397         spinlock_t plink_lock;
 398         u16 llid;
 399         u16 plid;
 400         u16 aid;
 401         u16 reason;
 402         u8 plink_retries;
 403
 404         bool processed_beacon;
 405         bool connected_to_gate;
 406         bool connected_to_as;
 407
 408         enum nl80211_plink_state plink_state;
 409         u32 plink_timeout;
 410
 411         /* mesh power save */
 412         enum nl80211_mesh_power_mode local_pm;
 413         enum nl80211_mesh_power_mode peer_pm;
 414         enum nl80211_mesh_power_mode nonpeer_pm;
 415
 416         /* moving percentage of failed MSDUs */
 417         struct ewma_mesh_fail_avg fail_avg;
 418         /* moving average of tx bitrate */
 419         struct ewma_mesh_tx_rate_avg tx_rate_avg;
 420 };
 421
 422 DECLARE_EWMA(signal, 10, 8)
 423
 424 struct ieee80211_sta_rx_stats {
 425         unsigned long packets;
 426         unsigned long last_rx;
 427         unsigned long num_duplicates;
 428         unsigned long fragments;
 429         unsigned long dropped;
 430         int last_signal;
 431         u8 chains;
 432         s8 chain_signal_last[IEEE80211_MAX_CHAINS];
 433         u32 last_rate;
 434         struct u64_stats_sync syncp;
 435         u64 bytes;
 436         u64 msdu[IEEE80211_NUM_TIDS + 1];
 437 };
 438
 439 /*
 440  * The bandwidth threshold below which the per-station CoDel parameters will be
 441  * scaled to be more lenient (to prevent starvation of slow stations). This
 442  * value will be scaled by the number of active stations when it is being
 443  * applied.
 444  */
 445 #define STA_SLOW_THRESHOLD 6000 /* 6 Mbps */
 446
 447 /**
 448  * struct sta_info - STA information
 449  *
 450  * This structure collects information about a station that
 451  * mac80211 is communicating with.
 452  *
 453  * @list: global linked list entry
 454  * @free_list: list entry for keeping track of stations to free
 455  * @hash_node: hash node for rhashtable
 456  * @addr: station's MAC address - duplicated from public part to
 457  *      let the hash table work with just a single cacheline
 458  * @local: pointer to the global information
 459  * @sdata: virtual interface this station belongs to
 460  * @ptk: peer keys negotiated with this station, if any
 461  * @ptk_idx: last installed peer key index
 462  * @gtk: group keys negotiated with this station, if any
 463  * @rate_ctrl: rate control algorithm reference
 464  * @rate_ctrl_lock: spinlock used to protect rate control data
 465  *      (data inside the algorithm, so serializes calls there)
 466  * @rate_ctrl_priv: rate control private per-STA pointer
 467  * @lock: used for locking all fields that require locking, see comments
 468  *      in the header file.
 469  * @drv_deliver_wk: used for delivering frames after driver PS unblocking
 470  * @listen_interval: listen interval of this station, when we're acting as AP
 471  * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
 472  * @ps_lock: used for powersave (when mac80211 is the AP) related locking
 473  * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
 474  *      when it leaves power saving state or polls
 475  * @tx_filtered: buffers (per AC) of frames we already tried to
 476  *      transmit but were filtered by hardware due to STA having
 477  *      entered power saving state, these are also delivered to
 478  *      the station when it leaves powersave or polls for frames
 479  * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
 480  * @txq_buffered_tids: bitmap of TIDs that mac80211 has txq data buffered on
 481  * @assoc_at: clock boottime (in ns) of last association
 482  * @last_connected: time (in seconds) when a station got connected
 483  * @last_seq_ctrl: last received seq/frag number from this STA (per TID
 484  *      plus one for non-QoS frames)
 485  * @tid_seq: per-TID sequence numbers for sending to this STA
 486  * @airtime: per-AC struct airtime_info describing airtime statistics for this
 487  *      station
 488  * @airtime_weight: station weight for airtime fairness calculation purposes
 489  * @ampdu_mlme: A-MPDU state machine state
 490  * @mesh: mesh STA information
 491  * @debugfs_dir: debug filesystem directory dentry
 492  * @dead: set to true when sta is unlinked
 493  * @removed: set to true when sta is being removed from sta_list
 494  * @uploaded: set to true when sta is uploaded to the driver
 495  * @sta: station information we share with the driver
 496  * @sta_state: duplicates information about station state (for debug)
 497  * @rcu_head: RCU head used for freeing this station struct
 498  * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
 499  *      taken from HT/VHT capabilities or VHT operating mode notification
 500  * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
 501  *      AP only.
 502  * @cipher_scheme: optional cipher scheme for this station
 503  * @cparams: CoDel parameters for this station.
 504  * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED)
 505  * @fast_tx: TX fastpath information
 506  * @fast_rx: RX fastpath information
 507  * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to
 508  *      the BSS one.
 509  * @tx_stats: TX statistics
 510  * @tx_stats.packets: # of packets transmitted
 511  * @tx_stats.bytes: # of bytes in all packets transmitted
 512  * @tx_stats.last_rate: last TX rate
 513  * @tx_stats.msdu: # of transmitted MSDUs per TID
 514  * @rx_stats: RX statistics
 515  * @rx_stats_avg: averaged RX statistics
 516  * @rx_stats_avg.signal: averaged signal
 517  * @rx_stats_avg.chain_signal: averaged per-chain signal
 518  * @pcpu_rx_stats: per-CPU RX statistics, assigned only if the driver needs
 519  *      this (by advertising the USES_RSS hw flag)
 520  * @status_stats: TX status statistics
 521  * @status_stats.filtered: # of filtered frames
 522  * @status_stats.retry_failed: # of frames that failed after retry
 523  * @status_stats.retry_count: # of retries attempted
 524  * @status_stats.lost_packets: # of lost packets
 525  * @status_stats.last_pkt_time: timestamp of last ACKed packet
 526  * @status_stats.msdu_retries: # of MSDU retries
 527  * @status_stats.msdu_failed: # of failed MSDUs
 528  * @status_stats.last_ack: last ack timestamp (jiffies)
 529  * @status_stats.last_ack_signal: last ACK signal
 530  * @status_stats.ack_signal_filled: last ACK signal validity
 531  * @status_stats.avg_ack_signal: average ACK signal
 532  */
 533 struct sta_info {
 534         /* General information, mostly static */
 535         struct list_head list, free_list;
 536         struct rcu_head rcu_head;
 537         struct rhlist_head hash_node;
 538         u8 addr[ETH_ALEN];
 539         struct ieee80211_local *local;
 540         struct ieee80211_sub_if_data *sdata;
 541         struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS +
 542                                         NUM_DEFAULT_MGMT_KEYS +
 543                                         NUM_DEFAULT_BEACON_KEYS];
 544         struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
 545         u8 ptk_idx;
 546         struct rate_control_ref *rate_ctrl;
 547         void *rate_ctrl_priv;
 548         spinlock_t rate_ctrl_lock;
 549         spinlock_t lock;
 550
 551         struct ieee80211_fast_tx __rcu *fast_tx;
 552         struct ieee80211_fast_rx __rcu *fast_rx;
 553         struct ieee80211_sta_rx_stats __percpu *pcpu_rx_stats;
 554
 555 #ifdef CONFIG_MAC80211_MESH
 556         struct mesh_sta *mesh;
 557 #endif
 558
 559         struct work_struct drv_deliver_wk;
 560
 561         u16 listen_interval;
 562
 563         bool dead;
 564         bool removed;
 565
 566         bool uploaded;
 567
 568         enum ieee80211_sta_state sta_state;
 569
 570         /* use the accessors defined below */
 571         unsigned long _flags;
 572
 573         /* STA powersave lock and frame queues */
 574         spinlock_t ps_lock;
 575         struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
 576         struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
 577         unsigned long driver_buffered_tids;
 578         unsigned long txq_buffered_tids;
 579
 580         u64 assoc_at;
 581         long last_connected;
 582
 583         /* Updated from RX path only, no locking requirements */
 584         struct ieee80211_sta_rx_stats rx_stats;
 585         struct {
 586                 struct ewma_signal signal;
 587                 struct ewma_signal chain_signal[IEEE80211_MAX_CHAINS];
 588         } rx_stats_avg;
 589
 590         /* Plus 1 for non-QoS frames */
 591         __le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
 592
 593         /* Updated from TX status path only, no locking requirements */
 594         struct {
 595                 unsigned long filtered;
 596                 unsigned long retry_failed, retry_count;
 597                 unsigned int lost_packets;
 598                 unsigned long last_pkt_time;
 599                 u64 msdu_retries[IEEE80211_NUM_TIDS + 1];
 600                 u64 msdu_failed[IEEE80211_NUM_TIDS + 1];
 601                 unsigned long last_ack;
 602                 s8 last_ack_signal;
 603                 bool ack_signal_filled;
 604                 struct ewma_avg_signal avg_ack_signal;
 605         } status_stats;
 606
 607         /* Updated from TX path only, no locking requirements */
 608         struct {
 609                 u64 packets[IEEE80211_NUM_ACS];
 610                 u64 bytes[IEEE80211_NUM_ACS];
 611                 struct ieee80211_tx_rate last_rate;
 612                 struct rate_info last_rate_info;
 613                 u64 msdu[IEEE80211_NUM_TIDS + 1];
 614         } tx_stats;
 615         u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
 616
 617         struct airtime_info airtime[IEEE80211_NUM_ACS];
 618         u16 airtime_weight;
 619
 620         /*
 621          * Aggregation information, locked with lock.
 622          */
 623         struct sta_ampdu_mlme ampdu_mlme;
 624
 625 #ifdef CONFIG_MAC80211_DEBUGFS
 626         struct dentry *debugfs_dir;
 627 #endif
 628
 629         enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;
 630
 631         enum ieee80211_smps_mode known_smps_mode;
 632         const struct ieee80211_cipher_scheme *cipher_scheme;
 633
 634         struct codel_params cparams;
 635
 636         u8 reserved_tid;
 637
 638         struct cfg80211_chan_def tdls_chandef;
 639
 640         /* keep last! */
 641         struct ieee80211_sta sta;
 642 };
 643
 644 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
 645 {
 646 #ifdef CONFIG_MAC80211_MESH
 647         return sta->mesh->plink_state;
 648 #endif
 649         return NL80211_PLINK_LISTEN;
 650 }
 651
 652 static inline void set_sta_flag(struct sta_info *sta,
 653                                 enum ieee80211_sta_info_flags flag)
 654 {
 655         WARN_ON(flag == WLAN_STA_AUTH ||
 656                 flag == WLAN_STA_ASSOC ||
 657                 flag == WLAN_STA_AUTHORIZED);
 658         set_bit(flag, &sta->_flags);
 659 }
 660
 661 static inline void clear_sta_flag(struct sta_info *sta,
 662                                   enum ieee80211_sta_info_flags flag)
 663 {
 664         WARN_ON(flag == WLAN_STA_AUTH ||
 665                 flag == WLAN_STA_ASSOC ||
 666                 flag == WLAN_STA_AUTHORIZED);
 667         clear_bit(flag, &sta->_flags);
 668 }
 669
 670 static inline int test_sta_flag(struct sta_info *sta,
 671                                 enum ieee80211_sta_info_flags flag)
 672 {
 673         return test_bit(flag, &sta->_flags);
 674 }
 675
 676 static inline int test_and_clear_sta_flag(struct sta_info *sta,
 677                                           enum ieee80211_sta_info_flags flag)
 678 {
 679         WARN_ON(flag == WLAN_STA_AUTH ||
 680                 flag == WLAN_STA_ASSOC ||
 681                 flag == WLAN_STA_AUTHORIZED);
 682         return test_and_clear_bit(flag, &sta->_flags);
 683 }
 684
 685 static inline int test_and_set_sta_flag(struct sta_info *sta,
 686                                         enum ieee80211_sta_info_flags flag)
 687 {
 688         WARN_ON(flag == WLAN_STA_AUTH ||
 689                 flag == WLAN_STA_ASSOC ||
 690                 flag == WLAN_STA_AUTHORIZED);
 691         return test_and_set_bit(flag, &sta->_flags);
 692 }
 693
 694 int sta_info_move_state(struct sta_info *sta,
 695                         enum ieee80211_sta_state new_state);
 696
 697 static inline void sta_info_pre_move_state(struct sta_info *sta,
 698                                            enum ieee80211_sta_state new_state)
 699 {
 700         int ret;
 701
 702         WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
 703
 704         ret = sta_info_move_state(sta, new_state);
 705         WARN_ON_ONCE(ret);
 706 }
 707
 708
 709 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
 710                              struct tid_ampdu_tx *tid_tx);
 711
 712 static inline struct tid_ampdu_tx *
 713 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
 714 {
 715         return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
 716                                          lockdep_is_held(&sta->lock) ||
 717                                          lockdep_is_held(&sta->ampdu_mlme.mtx));
 718 }
 719
 720 /* Maximum number of frames to buffer per power saving station per AC */
 721 #define STA_MAX_TX_BUFFER       64
 722
 723 /* Minimum buffered frame expiry time. If STA uses listen interval that is
 724  * smaller than this value, the minimum value here is used instead. */
 725 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
 726
 727 /* How often station data is cleaned up (e.g., expiration of buffered frames)
 728  */
 729 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
 730
 731 struct rhlist_head *sta_info_hash_lookup(struct ieee80211_local *local,
 732                                          const u8 *addr);
 733
 734 /*
 735  * Get a STA info, must be under RCU read lock.
 736  */
 737 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
 738                               const u8 *addr);
 739
 740 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
 741                                   const u8 *addr);
 742
 743 /* user must hold sta_mtx or be in RCU critical section */
 744 struct sta_info *sta_info_get_by_addrs(struct ieee80211_local *local,
 745                                        const u8 *sta_addr, const u8 *vif_addr);
 746
 747 #define for_each_sta_info(local, _addr, _sta, _tmp)                     \
 748         rhl_for_each_entry_rcu(_sta, _tmp,                              \
 749                                sta_info_hash_lookup(local, _addr), hash_node)
 750
 751 /*
 752  * Get STA info by index, BROKEN!
 753  */
 754 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
 755                                      int idx);
 756 /*
 757  * Create a new STA info, caller owns returned structure
 758  * until sta_info_insert().
 759  */
 760 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
 761                                 const u8 *addr, gfp_t gfp);
 762
 763 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
 764
 765 /*
 766  * Insert STA info into hash table/list, returns zero or a
 767  * -EEXIST if (if the same MAC address is already present).
 768  *
 769  * Calling the non-rcu version makes the caller relinquish,
 770  * the _rcu version calls read_lock_rcu() and must be called
 771  * without it held.
 772  */
 773 int sta_info_insert(struct sta_info *sta);
 774 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
 775
 776 int __must_check __sta_info_destroy(struct sta_info *sta);
 777 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
 778                           const u8 *addr);
 779 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
 780                               const u8 *addr);
 781
 782 void sta_info_recalc_tim(struct sta_info *sta);
 783
 784 int sta_info_init(struct ieee80211_local *local);
 785 void sta_info_stop(struct ieee80211_local *local);
 786
 787 /**
 788  * __sta_info_flush - flush matching STA entries from the STA table
 789  *
 790  * Returns the number of removed STA entries.
 791  *
 792  * @sdata: sdata to remove all stations from
 793  * @vlans: if the given interface is an AP interface, also flush VLANs
 794  */
 795 int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans);
 796
 797 /**
 798  * sta_info_flush - flush matching STA entries from the STA table
 799  *
 800  * Returns the number of removed STA entries.
 801  *
 802  * @sdata: sdata to remove all stations from
 803  */
 804 static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
 805 {
 806         return __sta_info_flush(sdata, false);
 807 }
 808
 809 void sta_set_rate_info_tx(struct sta_info *sta,
 810                           const struct ieee80211_tx_rate *rate,
 811                           struct rate_info *rinfo);
 812 void sta_set_sinfo(struct sta_info *sta, struct station_info *sinfo,
 813                    bool tidstats);
 814
 815 u32 sta_get_expected_throughput(struct sta_info *sta);
 816
 817 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
 818                           unsigned long exp_time);
 819 u8 sta_info_tx_streams(struct sta_info *sta);
 820
 821 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
 822 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
 823 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
 824
 825 unsigned long ieee80211_sta_last_active(struct sta_info *sta);
 826
 827 enum sta_stats_type {
 828         STA_STATS_RATE_TYPE_INVALID = 0,
 829         STA_STATS_RATE_TYPE_LEGACY,
 830         STA_STATS_RATE_TYPE_HT,
 831         STA_STATS_RATE_TYPE_VHT,
 832         STA_STATS_RATE_TYPE_HE,
 833         STA_STATS_RATE_TYPE_S1G,
 834 };
 835
 836 #define STA_STATS_FIELD_HT_MCS          GENMASK( 7,  0)
 837 #define STA_STATS_FIELD_LEGACY_IDX      GENMASK( 3,  0)
 838 #define STA_STATS_FIELD_LEGACY_BAND     GENMASK( 7,  4)
 839 #define STA_STATS_FIELD_VHT_MCS         GENMASK( 3,  0)
 840 #define STA_STATS_FIELD_VHT_NSS         GENMASK( 7,  4)
 841 #define STA_STATS_FIELD_HE_MCS          GENMASK( 3,  0)
 842 #define STA_STATS_FIELD_HE_NSS          GENMASK( 7,  4)
 843 #define STA_STATS_FIELD_BW              GENMASK(11,  8)
 844 #define STA_STATS_FIELD_SGI             GENMASK(12, 12)
 845 #define STA_STATS_FIELD_TYPE            GENMASK(15, 13)
 846 #define STA_STATS_FIELD_HE_RU           GENMASK(18, 16)
 847 #define STA_STATS_FIELD_HE_GI           GENMASK(20, 19)
 848 #define STA_STATS_FIELD_HE_DCM          GENMASK(21, 21)
 849
 850 #define STA_STATS_FIELD(_n, _v)         FIELD_PREP(STA_STATS_FIELD_ ## _n, _v)
 851 #define STA_STATS_GET(_n, _v)           FIELD_GET(STA_STATS_FIELD_ ## _n, _v)
 852
 853 #define STA_STATS_RATE_INVALID          0
 854
 855 static inline u32 sta_stats_encode_rate(struct ieee80211_rx_status *s)
 856 {
 857         u32 r;
 858
 859         r = STA_STATS_FIELD(BW, s->bw);
 860
 861         if (s->enc_flags & RX_ENC_FLAG_SHORT_GI)
 862                 r |= STA_STATS_FIELD(SGI, 1);
 863
 864         switch (s->encoding) {
 865         case RX_ENC_VHT:
 866                 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_VHT);
 867                 r |= STA_STATS_FIELD(VHT_NSS, s->nss);
 868                 r |= STA_STATS_FIELD(VHT_MCS, s->rate_idx);
 869                 break;
 870         case RX_ENC_HT:
 871                 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HT);
 872                 r |= STA_STATS_FIELD(HT_MCS, s->rate_idx);
 873                 break;
 874         case RX_ENC_LEGACY:
 875                 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_LEGACY);
 876                 r |= STA_STATS_FIELD(LEGACY_BAND, s->band);
 877                 r |= STA_STATS_FIELD(LEGACY_IDX, s->rate_idx);
 878                 break;
 879         case RX_ENC_HE:
 880                 r |= STA_STATS_FIELD(TYPE, STA_STATS_RATE_TYPE_HE);
 881                 r |= STA_STATS_FIELD(HE_NSS, s->nss);
 882                 r |= STA_STATS_FIELD(HE_MCS, s->rate_idx);
 883                 r |= STA_STATS_FIELD(HE_GI, s->he_gi);
 884                 r |= STA_STATS_FIELD(HE_RU, s->he_ru);
 885                 r |= STA_STATS_FIELD(HE_DCM, s->he_dcm);
 886                 break;
 887         default:
 888                 WARN_ON(1);
 889                 return STA_STATS_RATE_INVALID;
 890         }
 891
 892         return r;
 893 }
 894
 895 #endif /* STA_INFO_H */