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