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