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