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