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