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-2016 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/etherdevice.h>
  20 #include <linux/rhashtable.h>
  21 #include <linux/u64_stats_sync.h>
  22 #include "key.h"
  23
  24 /**
  25  * enum ieee80211_sta_info_flags - Stations flags
  26  *
  27  * These flags are used with &struct sta_info's @flags member, but
  28  * only indirectly with set_sta_flag() and friends.
  29  *
  30  * @WLAN_STA_AUTH: Station is authenticated.
  31  * @WLAN_STA_ASSOC: Station is associated.
  32  * @WLAN_STA_PS_STA: Station is in power-save mode
  33  * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
  34  *      This bit is always checked so needs to be enabled for all stations
  35  *      when virtual port control is not in use.
  36  * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
  37  *      frames.
  38  * @WLAN_STA_WDS: Station is one of our WDS peers.
  39  * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
  40  *      IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
  41  *      frame to this station is transmitted.
  42  * @WLAN_STA_MFP: Management frame protection is used with this STA.
  43  * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
  44  *      during suspend/resume and station removal.
  45  * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
  46  *      power-save mode logically to flush frames that might still
  47  *      be in the queues
  48  * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
  49  *      station in power-save mode, reply when the driver unblocks.
  50  * @WLAN_STA_TDLS_PEER: Station is a TDLS peer.
  51  * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct
  52  *      packets. This means the link is enabled.
  53  * @WLAN_STA_TDLS_INITIATOR: We are the initiator of the TDLS link with this
  54  *      station.
  55  * @WLAN_STA_TDLS_CHAN_SWITCH: This TDLS peer supports TDLS channel-switching
  56  * @WLAN_STA_TDLS_OFF_CHANNEL: The local STA is currently off-channel with this
  57  *      TDLS peer
  58  * @WLAN_STA_TDLS_WIDER_BW: This TDLS peer supports working on a wider bw on
  59  *      the BSS base channel.
  60  * @WLAN_STA_UAPSD: Station requested unscheduled SP while driver was
  61  *      keeping station in power-save mode, reply when the driver
  62  *      unblocks the station.
  63  * @WLAN_STA_SP: Station is in a service period, so don't try to
  64  *      reply to other uAPSD trigger frames or PS-Poll.
  65  * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
  66  * @WLAN_STA_INSERTED: This station is inserted into the hash table.
  67  * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
  68  * @WLAN_STA_TOFFSET_KNOWN: toffset calculated for this station is valid.
  69  * @WLAN_STA_MPSP_OWNER: local STA is owner of a mesh Peer Service Period.
  70  * @WLAN_STA_MPSP_RECIPIENT: local STA is recipient of a MPSP.
  71  * @WLAN_STA_PS_DELIVER: station woke up, but we're still blocking TX
  72  *      until pending frames are delivered
  73  *
  74  * @NUM_WLAN_STA_FLAGS: number of defined flags
  75  */
  76 enum ieee80211_sta_info_flags {
  77         WLAN_STA_AUTH,
  78         WLAN_STA_ASSOC,
  79         WLAN_STA_PS_STA,
  80         WLAN_STA_AUTHORIZED,
  81         WLAN_STA_SHORT_PREAMBLE,
  82         WLAN_STA_WDS,
  83         WLAN_STA_CLEAR_PS_FILT,
  84         WLAN_STA_MFP,
  85         WLAN_STA_BLOCK_BA,
  86         WLAN_STA_PS_DRIVER,
  87         WLAN_STA_PSPOLL,
  88         WLAN_STA_TDLS_PEER,
  89         WLAN_STA_TDLS_PEER_AUTH,
  90         WLAN_STA_TDLS_INITIATOR,
  91         WLAN_STA_TDLS_CHAN_SWITCH,
  92         WLAN_STA_TDLS_OFF_CHANNEL,
  93         WLAN_STA_TDLS_WIDER_BW,
  94         WLAN_STA_UAPSD,
  95         WLAN_STA_SP,
  96         WLAN_STA_4ADDR_EVENT,
  97         WLAN_STA_INSERTED,
  98         WLAN_STA_RATE_CONTROL,
  99         WLAN_STA_TOFFSET_KNOWN,
 100         WLAN_STA_MPSP_OWNER,
 101         WLAN_STA_MPSP_RECIPIENT,
 102         WLAN_STA_PS_DELIVER,
 103         WLAN_STA_USES_ENCRYPTION,
 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 /**
 331  * struct mesh_sta - mesh STA information
 332  * @plink_lock: serialize access to plink fields
 333  * @llid: Local link ID
 334  * @plid: Peer link ID
 335  * @aid: local aid supplied by peer
 336  * @reason: Cancel reason on PLINK_HOLDING state
 337  * @plink_retries: Retries in establishment
 338  * @plink_state: peer link state
 339  * @plink_timeout: timeout of peer link
 340  * @plink_timer: peer link watch timer
 341  * @t_offset: timing offset relative to this host
 342  * @t_offset_setpoint: reference timing offset of this sta to be used when
 343  *      calculating clockdrift
 344  * @local_pm: local link-specific power save mode
 345  * @peer_pm: peer-specific power save mode towards local STA
 346  * @nonpeer_pm: STA power save mode towards non-peer neighbors
 347  * @processed_beacon: set to true after peer rates and capabilities are
 348  *      processed
 349  * @fail_avg: moving percentage of failed MSDUs
 350  */
 351 struct mesh_sta {
 352         struct timer_list plink_timer;
 353
 354         s64 t_offset;
 355         s64 t_offset_setpoint;
 356
 357         spinlock_t plink_lock;
 358         u16 llid;
 359         u16 plid;
 360         u16 aid;
 361         u16 reason;
 362         u8 plink_retries;
 363
 364         bool processed_beacon;
 365
 366         enum nl80211_plink_state plink_state;
 367         u32 plink_timeout;
 368
 369         /* mesh power save */
 370         enum nl80211_mesh_power_mode local_pm;
 371         enum nl80211_mesh_power_mode peer_pm;
 372         enum nl80211_mesh_power_mode nonpeer_pm;
 373
 374         /* moving percentage of failed MSDUs */
 375         unsigned int fail_avg;
 376 };
 377
 378 DECLARE_EWMA(signal, 1024, 8)
 379
 380 struct ieee80211_sta_rx_stats {
 381         unsigned long packets;
 382         unsigned long last_rx;
 383         unsigned long num_duplicates;
 384         unsigned long fragments;
 385         unsigned long dropped;
 386         int last_signal;
 387         u8 chains;
 388         s8 chain_signal_last[IEEE80211_MAX_CHAINS];
 389         u16 last_rate;
 390         struct u64_stats_sync syncp;
 391         u64 bytes;
 392         u64 msdu[IEEE80211_NUM_TIDS + 1];
 393 };
 394
 395 /*
 396  * IEEE 802.11-2016 (10.6 "Defragmentation") recommends support for "concurrent
 397  * reception of at least one MSDU per access category per associated STA"
 398  * on APs, or "at least one MSDU per access category" on other interface types.
 399  *
 400  * This limit can be increased by changing this define, at the cost of slower
 401  * frame reassembly and increased memory use while fragments are pending.
 402  */
 403 #define IEEE80211_FRAGMENT_MAX 4
 404
 405 struct ieee80211_fragment_entry {
 406         struct sk_buff_head skb_list;
 407         unsigned long first_frag_time;
 408         u16 seq;
 409         u16 extra_len;
 410         u16 last_frag;
 411         u8 rx_queue;
 412         u8 check_sequential_pn:1, /* needed for CCMP/GCMP */
 413            is_protected:1;
 414         u8 last_pn[6]; /* PN of the last fragment if CCMP was used */
 415         unsigned int key_color;
 416 };
 417
 418 struct ieee80211_fragment_cache {
 419         struct ieee80211_fragment_entry entries[IEEE80211_FRAGMENT_MAX];
 420         unsigned int next;
 421 };
 422
 423 /**
 424  * struct sta_info - STA information
 425  *
 426  * This structure collects information about a station that
 427  * mac80211 is communicating with.
 428  *
 429  * @list: global linked list entry
 430  * @free_list: list entry for keeping track of stations to free
 431  * @hash_node: hash node for rhashtable
 432  * @addr: station's MAC address - duplicated from public part to
 433  *      let the hash table work with just a single cacheline
 434  * @local: pointer to the global information
 435  * @sdata: virtual interface this station belongs to
 436  * @ptk: peer keys negotiated with this station, if any
 437  * @ptk_idx: last installed peer key index
 438  * @gtk: group keys negotiated with this station, if any
 439  * @rate_ctrl: rate control algorithm reference
 440  * @rate_ctrl_lock: spinlock used to protect rate control data
 441  *      (data inside the algorithm, so serializes calls there)
 442  * @rate_ctrl_priv: rate control private per-STA pointer
 443  * @lock: used for locking all fields that require locking, see comments
 444  *      in the header file.
 445  * @drv_deliver_wk: used for delivering frames after driver PS unblocking
 446  * @listen_interval: listen interval of this station, when we're acting as AP
 447  * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
 448  * @ps_lock: used for powersave (when mac80211 is the AP) related locking
 449  * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
 450  *      when it leaves power saving state or polls
 451  * @tx_filtered: buffers (per AC) of frames we already tried to
 452  *      transmit but were filtered by hardware due to STA having
 453  *      entered power saving state, these are also delivered to
 454  *      the station when it leaves powersave or polls for frames
 455  * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
 456  * @txq_buffered_tids: bitmap of TIDs that mac80211 has txq data buffered on
 457  * @last_connected: time (in seconds) when a station got connected
 458  * @last_seq_ctrl: last received seq/frag number from this STA (per TID
 459  *      plus one for non-QoS frames)
 460  * @tid_seq: per-TID sequence numbers for sending to this STA
 461  * @ampdu_mlme: A-MPDU state machine state
 462  * @timer_to_tid: identity mapping to ID timers
 463  * @mesh: mesh STA information
 464  * @debugfs_dir: debug filesystem directory dentry
 465  * @dead: set to true when sta is unlinked
 466  * @removed: set to true when sta is being removed from sta_list
 467  * @uploaded: set to true when sta is uploaded to the driver
 468  * @sta: station information we share with the driver
 469  * @sta_state: duplicates information about station state (for debug)
 470  * @rcu_head: RCU head used for freeing this station struct
 471  * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
 472  *      taken from HT/VHT capabilities or VHT operating mode notification
 473  * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
 474  *      AP only.
 475  * @cipher_scheme: optional cipher scheme for this station
 476  * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED)
 477  * @fast_tx: TX fastpath information
 478  * @fast_rx: RX fastpath information
 479  * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to
 480  *      the BSS one.
 481  * @tx_stats: TX statistics
 482  * @rx_stats: RX statistics
 483  * @pcpu_rx_stats: per-CPU RX statistics, assigned only if the driver needs
 484  *      this (by advertising the USES_RSS hw flag)
 485  * @status_stats: TX status statistics
 486  * @frags: fragment cache
 487  */
 488 struct sta_info {
 489         /* General information, mostly static */
 490         struct list_head list, free_list;
 491         struct rcu_head rcu_head;
 492         struct rhlist_head hash_node;
 493         u8 addr[ETH_ALEN];
 494         struct ieee80211_local *local;
 495         struct ieee80211_sub_if_data *sdata;
 496         struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
 497         struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
 498         u8 ptk_idx;
 499         struct rate_control_ref *rate_ctrl;
 500         void *rate_ctrl_priv;
 501         spinlock_t rate_ctrl_lock;
 502         spinlock_t lock;
 503
 504         struct ieee80211_fast_tx __rcu *fast_tx;
 505         struct ieee80211_fast_rx __rcu *fast_rx;
 506         struct ieee80211_sta_rx_stats __percpu *pcpu_rx_stats;
 507
 508 #ifdef CONFIG_MAC80211_MESH
 509         struct mesh_sta *mesh;
 510 #endif
 511
 512         struct work_struct drv_deliver_wk;
 513
 514         u16 listen_interval;
 515
 516         bool dead;
 517         bool removed;
 518
 519         bool uploaded;
 520
 521         enum ieee80211_sta_state sta_state;
 522
 523         /* use the accessors defined below */
 524         unsigned long _flags;
 525
 526         /* STA powersave lock and frame queues */
 527         spinlock_t ps_lock;
 528         struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
 529         struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
 530         unsigned long driver_buffered_tids;
 531         unsigned long txq_buffered_tids;
 532
 533         long last_connected;
 534
 535         /* Updated from RX path only, no locking requirements */
 536         struct ieee80211_sta_rx_stats rx_stats;
 537         struct {
 538                 struct ewma_signal signal;
 539                 struct ewma_signal chain_signal[IEEE80211_MAX_CHAINS];
 540         } rx_stats_avg;
 541
 542         /* Plus 1 for non-QoS frames */
 543         __le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
 544
 545         /* Updated from TX status path only, no locking requirements */
 546         struct {
 547                 unsigned long filtered;
 548                 unsigned long retry_failed, retry_count;
 549                 unsigned int lost_packets;
 550                 unsigned long last_tdls_pkt_time;
 551                 u64 msdu_retries[IEEE80211_NUM_TIDS + 1];
 552                 u64 msdu_failed[IEEE80211_NUM_TIDS + 1];
 553                 unsigned long last_ack;
 554         } status_stats;
 555
 556         /* Updated from TX path only, no locking requirements */
 557         struct {
 558                 u64 packets[IEEE80211_NUM_ACS];
 559                 u64 bytes[IEEE80211_NUM_ACS];
 560                 struct ieee80211_tx_rate last_rate;
 561                 u64 msdu[IEEE80211_NUM_TIDS + 1];
 562         } tx_stats;
 563         u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
 564
 565         /*
 566          * Aggregation information, locked with lock.
 567          */
 568         struct sta_ampdu_mlme ampdu_mlme;
 569         u8 timer_to_tid[IEEE80211_NUM_TIDS];
 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         u8 reserved_tid;
 581
 582         struct cfg80211_chan_def tdls_chandef;
 583
 584         struct ieee80211_fragment_cache frags;
 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
 749 u32 sta_get_expected_throughput(struct sta_info *sta);
 750
 751 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
 752                           unsigned long exp_time);
 753 u8 sta_info_tx_streams(struct sta_info *sta);
 754
 755 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
 756 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
 757 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
 758
 759 unsigned long ieee80211_sta_last_active(struct sta_info *sta);
 760
 761 #define STA_STATS_RATE_INVALID          0
 762 #define STA_STATS_RATE_VHT              0x8000
 763 #define STA_STATS_RATE_HT               0x4000
 764 #define STA_STATS_RATE_LEGACY           0x2000
 765 #define STA_STATS_RATE_SGI              0x1000
 766 #define STA_STATS_RATE_BW_SHIFT         9
 767 #define STA_STATS_RATE_BW_MASK          (0x7 << STA_STATS_RATE_BW_SHIFT)
 768
 769 static inline u16 sta_stats_encode_rate(struct ieee80211_rx_status *s)
 770 {
 771         u16 r = s->rate_idx;
 772
 773         if (s->vht_flag & RX_VHT_FLAG_80MHZ)
 774                 r |= RATE_INFO_BW_80 << STA_STATS_RATE_BW_SHIFT;
 775         else if (s->vht_flag & RX_VHT_FLAG_160MHZ)
 776                 r |= RATE_INFO_BW_160 << STA_STATS_RATE_BW_SHIFT;
 777         else if (s->flag & RX_FLAG_40MHZ)
 778                 r |= RATE_INFO_BW_40 << STA_STATS_RATE_BW_SHIFT;
 779         else if (s->flag & RX_FLAG_10MHZ)
 780                 r |= RATE_INFO_BW_10 << STA_STATS_RATE_BW_SHIFT;
 781         else if (s->flag & RX_FLAG_5MHZ)
 782                 r |= RATE_INFO_BW_5 << STA_STATS_RATE_BW_SHIFT;
 783         else
 784                 r |= RATE_INFO_BW_20 << STA_STATS_RATE_BW_SHIFT;
 785
 786         if (s->flag & RX_FLAG_SHORT_GI)
 787                 r |= STA_STATS_RATE_SGI;
 788
 789         if (s->flag & RX_FLAG_VHT)
 790                 r |= STA_STATS_RATE_VHT | (s->vht_nss << 4);
 791         else if (s->flag & RX_FLAG_HT)
 792                 r |= STA_STATS_RATE_HT;
 793         else
 794                 r |= STA_STATS_RATE_LEGACY | (s->band << 4);
 795
 796         return r;
 797 }
 798
 799 #endif /* STA_INFO_H */