net/mac80211/sta_info.h

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