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 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 "key.h"
  22
  23 /**
  24  * enum ieee80211_sta_info_flags - Stations flags
  25  *
  26  * These flags are used with &struct sta_info's @flags member, but
  27  * only indirectly with set_sta_flag() and friends.
  28  *
  29  * @WLAN_STA_AUTH: Station is authenticated.
  30  * @WLAN_STA_ASSOC: Station is associated.
  31  * @WLAN_STA_PS_STA: Station is in power-save mode
  32  * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
  33  *      This bit is always checked so needs to be enabled for all stations
  34  *      when virtual port control is not in use.
  35  * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
  36  *      frames.
  37  * @WLAN_STA_WDS: Station is one of our WDS peers.
  38  * @WLAN_STA_CLEAR_PS_FILT: Clear PS filter in hardware (using the
  39  *      IEEE80211_TX_CTL_CLEAR_PS_FILT control flag) when the next
  40  *      frame to this station is transmitted.
  41  * @WLAN_STA_MFP: Management frame protection is used with this STA.
  42  * @WLAN_STA_BLOCK_BA: Used to deny ADDBA requests (both TX and RX)
  43  *      during suspend/resume and station removal.
  44  * @WLAN_STA_PS_DRIVER: driver requires keeping this station in
  45  *      power-save mode logically to flush frames that might still
  46  *      be in the queues
  47  * @WLAN_STA_PSPOLL: Station sent PS-poll while driver was keeping
  48  *      station in power-save mode, reply when the driver unblocks.
  49  * @WLAN_STA_TDLS_PEER: Station is a TDLS peer.
  50  * @WLAN_STA_TDLS_PEER_AUTH: This TDLS peer is authorized to send direct
  51  *      packets. This means the link is enabled.
  52  * @WLAN_STA_TDLS_INITIATOR: We are the initiator of the TDLS link with this
  53  *      station.
  54  * @WLAN_STA_TDLS_CHAN_SWITCH: This TDLS peer supports TDLS channel-switching
  55  * @WLAN_STA_TDLS_OFF_CHANNEL: The local STA is currently off-channel with this
  56  *      TDLS peer
  57  * @WLAN_STA_TDLS_WIDER_BW: This TDLS peer supports working on a wider bw on
  58  *      the BSS base channel.
  59  * @WLAN_STA_UAPSD: Station requested unscheduled SP while driver was
  60  *      keeping station in power-save mode, reply when the driver
  61  *      unblocks the station.
  62  * @WLAN_STA_SP: Station is in a service period, so don't try to
  63  *      reply to other uAPSD trigger frames or PS-Poll.
  64  * @WLAN_STA_4ADDR_EVENT: 4-addr event was already sent for this frame.
  65  * @WLAN_STA_INSERTED: This station is inserted into the hash table.
  66  * @WLAN_STA_RATE_CONTROL: rate control was initialized for this station.
  67  * @WLAN_STA_TOFFSET_KNOWN: toffset calculated for this station is valid.
  68  * @WLAN_STA_MPSP_OWNER: local STA is owner of a mesh Peer Service Period.
  69  * @WLAN_STA_MPSP_RECIPIENT: local STA is recipient of a MPSP.
  70  * @WLAN_STA_PS_DELIVER: station woke up, but we're still blocking TX
  71  *      until pending frames are delivered
  72  */
  73 enum ieee80211_sta_info_flags {
  74         WLAN_STA_AUTH,
  75         WLAN_STA_ASSOC,
  76         WLAN_STA_PS_STA,
  77         WLAN_STA_AUTHORIZED,
  78         WLAN_STA_SHORT_PREAMBLE,
  79         WLAN_STA_WDS,
  80         WLAN_STA_CLEAR_PS_FILT,
  81         WLAN_STA_MFP,
  82         WLAN_STA_BLOCK_BA,
  83         WLAN_STA_PS_DRIVER,
  84         WLAN_STA_PSPOLL,
  85         WLAN_STA_TDLS_PEER,
  86         WLAN_STA_TDLS_PEER_AUTH,
  87         WLAN_STA_TDLS_INITIATOR,
  88         WLAN_STA_TDLS_CHAN_SWITCH,
  89         WLAN_STA_TDLS_OFF_CHANNEL,
  90         WLAN_STA_TDLS_WIDER_BW,
  91         WLAN_STA_UAPSD,
  92         WLAN_STA_SP,
  93         WLAN_STA_4ADDR_EVENT,
  94         WLAN_STA_INSERTED,
  95         WLAN_STA_RATE_CONTROL,
  96         WLAN_STA_TOFFSET_KNOWN,
  97         WLAN_STA_MPSP_OWNER,
  98         WLAN_STA_MPSP_RECIPIENT,
  99         WLAN_STA_PS_DELIVER,
 100 };
 101
 102 #define ADDBA_RESP_INTERVAL HZ
 103 #define HT_AGG_MAX_RETRIES              15
 104 #define HT_AGG_BURST_RETRIES            3
 105 #define HT_AGG_RETRIES_PERIOD           (15 * HZ)
 106
 107 #define HT_AGG_STATE_DRV_READY          0
 108 #define HT_AGG_STATE_RESPONSE_RECEIVED  1
 109 #define HT_AGG_STATE_OPERATIONAL        2
 110 #define HT_AGG_STATE_STOPPING           3
 111 #define HT_AGG_STATE_WANT_START         4
 112 #define HT_AGG_STATE_WANT_STOP          5
 113
 114 enum ieee80211_agg_stop_reason {
 115         AGG_STOP_DECLINED,
 116         AGG_STOP_LOCAL_REQUEST,
 117         AGG_STOP_PEER_REQUEST,
 118         AGG_STOP_DESTROY_STA,
 119 };
 120
 121 /**
 122  * struct tid_ampdu_tx - TID aggregation information (Tx).
 123  *
 124  * @rcu_head: rcu head for freeing structure
 125  * @session_timer: check if we keep Tx-ing on the TID (by timeout value)
 126  * @addba_resp_timer: timer for peer's response to addba request
 127  * @pending: pending frames queue -- use sta's spinlock to protect
 128  * @dialog_token: dialog token for aggregation session
 129  * @timeout: session timeout value to be filled in ADDBA requests
 130  * @state: session state (see above)
 131  * @last_tx: jiffies of last tx activity
 132  * @stop_initiator: initiator of a session stop
 133  * @tx_stop: TX DelBA frame when stopping
 134  * @buf_size: reorder buffer size at receiver
 135  * @failed_bar_ssn: ssn of the last failed BAR tx attempt
 136  * @bar_pending: BAR needs to be re-sent
 137  * @amsdu: support A-MSDU withing A-MDPU
 138  *
 139  * This structure's lifetime is managed by RCU, assignments to
 140  * the array holding it must hold the aggregation mutex.
 141  *
 142  * The TX path can access it under RCU lock-free if, and
 143  * only if, the state has the flag %HT_AGG_STATE_OPERATIONAL
 144  * set. Otherwise, the TX path must also acquire the spinlock
 145  * and re-check the state, see comments in the tx code
 146  * touching it.
 147  */
 148 struct tid_ampdu_tx {
 149         struct rcu_head rcu_head;
 150         struct timer_list session_timer;
 151         struct timer_list addba_resp_timer;
 152         struct sk_buff_head pending;
 153         unsigned long state;
 154         unsigned long last_tx;
 155         u16 timeout;
 156         u8 dialog_token;
 157         u8 stop_initiator;
 158         bool tx_stop;
 159         u8 buf_size;
 160
 161         u16 failed_bar_ssn;
 162         bool bar_pending;
 163         bool amsdu;
 164 };
 165
 166 /**
 167  * struct tid_ampdu_rx - TID aggregation information (Rx).
 168  *
 169  * @reorder_buf: buffer to reorder incoming aggregated MPDUs. An MPDU may be an
 170  *      A-MSDU with individually reported subframes.
 171  * @reorder_buf_filtered: bitmap indicating where there are filtered frames in
 172  *      the reorder buffer that should be ignored when releasing frames
 173  * @reorder_time: jiffies when skb was added
 174  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
 175  * @reorder_timer: releases expired frames from the reorder buffer.
 176  * @last_rx: jiffies of last rx activity
 177  * @head_seq_num: head sequence number in reordering buffer.
 178  * @stored_mpdu_num: number of MPDUs in reordering buffer
 179  * @ssn: Starting Sequence Number expected to be aggregated.
 180  * @buf_size: buffer size for incoming A-MPDUs
 181  * @timeout: reset timer value (in TUs).
 182  * @dialog_token: dialog token for aggregation session
 183  * @rcu_head: RCU head used for freeing this struct
 184  * @reorder_lock: serializes access to reorder buffer, see below.
 185  * @auto_seq: used for offloaded BA sessions to automatically pick head_seq_and
 186  *      and ssn.
 187  * @removed: this session is removed (but might have been found due to RCU)
 188  *
 189  * This structure's lifetime is managed by RCU, assignments to
 190  * the array holding it must hold the aggregation mutex.
 191  *
 192  * The @reorder_lock is used to protect the members of this
 193  * struct, except for @timeout, @buf_size and @dialog_token,
 194  * which are constant across the lifetime of the struct (the
 195  * dialog token being used only for debugging).
 196  */
 197 struct tid_ampdu_rx {
 198         struct rcu_head rcu_head;
 199         spinlock_t reorder_lock;
 200         u64 reorder_buf_filtered;
 201         struct sk_buff_head *reorder_buf;
 202         unsigned long *reorder_time;
 203         struct timer_list session_timer;
 204         struct timer_list reorder_timer;
 205         unsigned long last_rx;
 206         u16 head_seq_num;
 207         u16 stored_mpdu_num;
 208         u16 ssn;
 209         u16 buf_size;
 210         u16 timeout;
 211         u8 dialog_token;
 212         bool auto_seq;
 213         bool removed;
 214 };
 215
 216 /**
 217  * struct sta_ampdu_mlme - STA aggregation information.
 218  *
 219  * @mtx: mutex to protect all TX data (except non-NULL assignments
 220  *      to tid_tx[idx], which are protected by the sta spinlock)
 221  *      tid_start_tx is also protected by sta->lock.
 222  * @tid_rx: aggregation info for Rx per TID -- RCU protected
 223  * @tid_rx_timer_expired: bitmap indicating on which TIDs the
 224  *      RX timer expired until the work for it runs
 225  * @tid_rx_stop_requested:  bitmap indicating which BA sessions per TID the
 226  *      driver requested to close until the work for it runs
 227  * @agg_session_valid: bitmap indicating which TID has a rx BA session open on
 228  * @work: work struct for starting/stopping aggregation
 229  * @tid_tx: aggregation info for Tx per TID
 230  * @tid_start_tx: sessions where start was requested
 231  * @last_addba_req_time: timestamp of the last addBA request.
 232  * @addba_req_num: number of times addBA request has been sent.
 233  * @dialog_token_allocator: dialog token enumerator for each new session;
 234  */
 235 struct sta_ampdu_mlme {
 236         struct mutex mtx;
 237         /* rx */
 238         struct tid_ampdu_rx __rcu *tid_rx[IEEE80211_NUM_TIDS];
 239         unsigned long tid_rx_timer_expired[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
 240         unsigned long tid_rx_stop_requested[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
 241         unsigned long agg_session_valid[BITS_TO_LONGS(IEEE80211_NUM_TIDS)];
 242         /* tx */
 243         struct work_struct work;
 244         struct tid_ampdu_tx __rcu *tid_tx[IEEE80211_NUM_TIDS];
 245         struct tid_ampdu_tx *tid_start_tx[IEEE80211_NUM_TIDS];
 246         unsigned long last_addba_req_time[IEEE80211_NUM_TIDS];
 247         u8 addba_req_num[IEEE80211_NUM_TIDS];
 248         u8 dialog_token_allocator;
 249 };
 250
 251
 252 /* Value to indicate no TID reservation */
 253 #define IEEE80211_TID_UNRESERVED        0xff
 254
 255 #define IEEE80211_FAST_XMIT_MAX_IV      18
 256
 257 /**
 258  * struct ieee80211_fast_tx - TX fastpath information
 259  * @key: key to use for hw crypto
 260  * @hdr: the 802.11 header to put with the frame
 261  * @hdr_len: actual 802.11 header length
 262  * @sa_offs: offset of the SA
 263  * @da_offs: offset of the DA
 264  * @pn_offs: offset where to put PN for crypto (or 0 if not needed)
 265  * @band: band this will be transmitted on, for tx_info
 266  * @rcu_head: RCU head to free this struct
 267  *
 268  * This struct is small enough so that the common case (maximum crypto
 269  * header length of 8 like for CCMP/GCMP) fits into a single 64-byte
 270  * cache line.
 271  */
 272 struct ieee80211_fast_tx {
 273         struct ieee80211_key *key;
 274         u8 hdr_len;
 275         u8 sa_offs, da_offs, pn_offs;
 276         u8 band;
 277         u8 hdr[30 + 2 + IEEE80211_FAST_XMIT_MAX_IV +
 278                sizeof(rfc1042_header)];
 279
 280         struct rcu_head rcu_head;
 281 };
 282
 283 /**
 284  * struct mesh_sta - mesh STA information
 285  * @plink_lock: serialize access to plink fields
 286  * @llid: Local link ID
 287  * @plid: Peer link ID
 288  * @aid: local aid supplied by peer
 289  * @reason: Cancel reason on PLINK_HOLDING state
 290  * @plink_retries: Retries in establishment
 291  * @plink_state: peer link state
 292  * @plink_timeout: timeout of peer link
 293  * @plink_timer: peer link watch timer
 294  * @t_offset: timing offset relative to this host
 295  * @t_offset_setpoint: reference timing offset of this sta to be used when
 296  *      calculating clockdrift
 297  * @local_pm: local link-specific power save mode
 298  * @peer_pm: peer-specific power save mode towards local STA
 299  * @nonpeer_pm: STA power save mode towards non-peer neighbors
 300  * @processed_beacon: set to true after peer rates and capabilities are
 301  *      processed
 302  * @fail_avg: moving percentage of failed MSDUs
 303  */
 304 struct mesh_sta {
 305         struct timer_list plink_timer;
 306
 307         s64 t_offset;
 308         s64 t_offset_setpoint;
 309
 310         spinlock_t plink_lock;
 311         u16 llid;
 312         u16 plid;
 313         u16 aid;
 314         u16 reason;
 315         u8 plink_retries;
 316
 317         bool processed_beacon;
 318
 319         enum nl80211_plink_state plink_state;
 320         u32 plink_timeout;
 321
 322         /* mesh power save */
 323         enum nl80211_mesh_power_mode local_pm;
 324         enum nl80211_mesh_power_mode peer_pm;
 325         enum nl80211_mesh_power_mode nonpeer_pm;
 326
 327         /* moving percentage of failed MSDUs */
 328         unsigned int fail_avg;
 329 };
 330
 331 DECLARE_EWMA(signal, 1024, 8)
 332
 333 /**
 334  * struct sta_info - STA information
 335  *
 336  * This structure collects information about a station that
 337  * mac80211 is communicating with.
 338  *
 339  * @list: global linked list entry
 340  * @free_list: list entry for keeping track of stations to free
 341  * @hash_node: hash node for rhashtable
 342  * @addr: station's MAC address - duplicated from public part to
 343  *      let the hash table work with just a single cacheline
 344  * @local: pointer to the global information
 345  * @sdata: virtual interface this station belongs to
 346  * @ptk: peer keys negotiated with this station, if any
 347  * @ptk_idx: last installed peer key index
 348  * @gtk: group keys negotiated with this station, if any
 349  * @rate_ctrl: rate control algorithm reference
 350  * @rate_ctrl_lock: spinlock used to protect rate control data
 351  *      (data inside the algorithm, so serializes calls there)
 352  * @rate_ctrl_priv: rate control private per-STA pointer
 353  * @lock: used for locking all fields that require locking, see comments
 354  *      in the header file.
 355  * @drv_deliver_wk: used for delivering frames after driver PS unblocking
 356  * @listen_interval: listen interval of this station, when we're acting as AP
 357  * @_flags: STA flags, see &enum ieee80211_sta_info_flags, do not use directly
 358  * @ps_lock: used for powersave (when mac80211 is the AP) related locking
 359  * @ps_tx_buf: buffers (per AC) of frames to transmit to this station
 360  *      when it leaves power saving state or polls
 361  * @tx_filtered: buffers (per AC) of frames we already tried to
 362  *      transmit but were filtered by hardware due to STA having
 363  *      entered power saving state, these are also delivered to
 364  *      the station when it leaves powersave or polls for frames
 365  * @driver_buffered_tids: bitmap of TIDs the driver has data buffered on
 366  * @txq_buffered_tids: bitmap of TIDs that mac80211 has txq data buffered on
 367  * @last_connected: time (in seconds) when a station got connected
 368  * @last_seq_ctrl: last received seq/frag number from this STA (per TID
 369  *      plus one for non-QoS frames)
 370  * @tid_seq: per-TID sequence numbers for sending to this STA
 371  * @ampdu_mlme: A-MPDU state machine state
 372  * @timer_to_tid: identity mapping to ID timers
 373  * @mesh: mesh STA information
 374  * @debugfs: debug filesystem info
 375  * @dead: set to true when sta is unlinked
 376  * @removed: set to true when sta is being removed from sta_list
 377  * @uploaded: set to true when sta is uploaded to the driver
 378  * @sta: station information we share with the driver
 379  * @sta_state: duplicates information about station state (for debug)
 380  * @beacon_loss_count: number of times beacon loss has triggered
 381  * @rcu_head: RCU head used for freeing this station struct
 382  * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
 383  *      taken from HT/VHT capabilities or VHT operating mode notification
 384  * @known_smps_mode: the smps_mode the client thinks we are in. Relevant for
 385  *      AP only.
 386  * @cipher_scheme: optional cipher scheme for this station
 387  * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED)
 388  * @fast_tx: TX fastpath information
 389  * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to
 390  *      the BSS one.
 391  * @tx_stats: TX statistics
 392  * @rx_stats: RX statistics
 393  * @status_stats: TX status statistics
 394  */
 395 struct sta_info {
 396         /* General information, mostly static */
 397         struct list_head list, free_list;
 398         struct rcu_head rcu_head;
 399         struct rhash_head hash_node;
 400         u8 addr[ETH_ALEN];
 401         struct ieee80211_local *local;
 402         struct ieee80211_sub_if_data *sdata;
 403         struct ieee80211_key __rcu *gtk[NUM_DEFAULT_KEYS + NUM_DEFAULT_MGMT_KEYS];
 404         struct ieee80211_key __rcu *ptk[NUM_DEFAULT_KEYS];
 405         u8 ptk_idx;
 406         struct rate_control_ref *rate_ctrl;
 407         void *rate_ctrl_priv;
 408         spinlock_t rate_ctrl_lock;
 409         spinlock_t lock;
 410
 411         struct ieee80211_fast_tx __rcu *fast_tx;
 412
 413 #ifdef CONFIG_MAC80211_MESH
 414         struct mesh_sta *mesh;
 415 #endif
 416
 417         struct work_struct drv_deliver_wk;
 418
 419         u16 listen_interval;
 420
 421         bool dead;
 422         bool removed;
 423
 424         bool uploaded;
 425
 426         enum ieee80211_sta_state sta_state;
 427
 428         /* use the accessors defined below */
 429         unsigned long _flags;
 430
 431         /* STA powersave lock and frame queues */
 432         spinlock_t ps_lock;
 433         struct sk_buff_head ps_tx_buf[IEEE80211_NUM_ACS];
 434         struct sk_buff_head tx_filtered[IEEE80211_NUM_ACS];
 435         unsigned long driver_buffered_tids;
 436         unsigned long txq_buffered_tids;
 437
 438         long last_connected;
 439
 440         /* Updated from RX path only, no locking requirements */
 441         struct {
 442                 unsigned long packets;
 443                 u64 bytes;
 444                 unsigned long last_rx;
 445                 unsigned long num_duplicates;
 446                 unsigned long fragments;
 447                 unsigned long dropped;
 448                 int last_signal;
 449                 struct ewma_signal avg_signal;
 450                 u8 chains;
 451                 s8 chain_signal_last[IEEE80211_MAX_CHAINS];
 452                 struct ewma_signal chain_signal_avg[IEEE80211_MAX_CHAINS];
 453                 int last_rate_idx;
 454                 u32 last_rate_flag;
 455                 u32 last_rate_vht_flag;
 456                 u8 last_rate_vht_nss;
 457                 u64 msdu[IEEE80211_NUM_TIDS + 1];
 458         } rx_stats;
 459
 460         /* Plus 1 for non-QoS frames */
 461         __le16 last_seq_ctrl[IEEE80211_NUM_TIDS + 1];
 462
 463         /* Updated from TX status path only, no locking requirements */
 464         struct {
 465                 unsigned long filtered;
 466                 unsigned long retry_failed, retry_count;
 467                 unsigned int lost_packets;
 468                 unsigned long last_tdls_pkt_time;
 469                 u64 msdu_retries[IEEE80211_NUM_TIDS + 1];
 470                 u64 msdu_failed[IEEE80211_NUM_TIDS + 1];
 471         } status_stats;
 472
 473         /* Updated from TX path only, no locking requirements */
 474         struct {
 475                 u64 packets[IEEE80211_NUM_ACS];
 476                 u64 bytes[IEEE80211_NUM_ACS];
 477                 struct ieee80211_tx_rate last_rate;
 478                 u64 msdu[IEEE80211_NUM_TIDS + 1];
 479         } tx_stats;
 480         u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
 481
 482         /*
 483          * Aggregation information, locked with lock.
 484          */
 485         struct sta_ampdu_mlme ampdu_mlme;
 486         u8 timer_to_tid[IEEE80211_NUM_TIDS];
 487
 488 #ifdef CONFIG_MAC80211_DEBUGFS
 489         struct sta_info_debugfsdentries {
 490                 struct dentry *dir;
 491                 bool add_has_run;
 492         } debugfs;
 493 #endif
 494
 495         enum ieee80211_sta_rx_bandwidth cur_max_bandwidth;
 496
 497         enum ieee80211_smps_mode known_smps_mode;
 498         const struct ieee80211_cipher_scheme *cipher_scheme;
 499
 500         u8 reserved_tid;
 501
 502         struct cfg80211_chan_def tdls_chandef;
 503
 504         /* keep last! */
 505         struct ieee80211_sta sta;
 506 };
 507
 508 static inline enum nl80211_plink_state sta_plink_state(struct sta_info *sta)
 509 {
 510 #ifdef CONFIG_MAC80211_MESH
 511         return sta->mesh->plink_state;
 512 #endif
 513         return NL80211_PLINK_LISTEN;
 514 }
 515
 516 static inline void set_sta_flag(struct sta_info *sta,
 517                                 enum ieee80211_sta_info_flags flag)
 518 {
 519         WARN_ON(flag == WLAN_STA_AUTH ||
 520                 flag == WLAN_STA_ASSOC ||
 521                 flag == WLAN_STA_AUTHORIZED);
 522         set_bit(flag, &sta->_flags);
 523 }
 524
 525 static inline void clear_sta_flag(struct sta_info *sta,
 526                                   enum ieee80211_sta_info_flags flag)
 527 {
 528         WARN_ON(flag == WLAN_STA_AUTH ||
 529                 flag == WLAN_STA_ASSOC ||
 530                 flag == WLAN_STA_AUTHORIZED);
 531         clear_bit(flag, &sta->_flags);
 532 }
 533
 534 static inline int test_sta_flag(struct sta_info *sta,
 535                                 enum ieee80211_sta_info_flags flag)
 536 {
 537         return test_bit(flag, &sta->_flags);
 538 }
 539
 540 static inline int test_and_clear_sta_flag(struct sta_info *sta,
 541                                           enum ieee80211_sta_info_flags flag)
 542 {
 543         WARN_ON(flag == WLAN_STA_AUTH ||
 544                 flag == WLAN_STA_ASSOC ||
 545                 flag == WLAN_STA_AUTHORIZED);
 546         return test_and_clear_bit(flag, &sta->_flags);
 547 }
 548
 549 static inline int test_and_set_sta_flag(struct sta_info *sta,
 550                                         enum ieee80211_sta_info_flags flag)
 551 {
 552         WARN_ON(flag == WLAN_STA_AUTH ||
 553                 flag == WLAN_STA_ASSOC ||
 554                 flag == WLAN_STA_AUTHORIZED);
 555         return test_and_set_bit(flag, &sta->_flags);
 556 }
 557
 558 int sta_info_move_state(struct sta_info *sta,
 559                         enum ieee80211_sta_state new_state);
 560
 561 static inline void sta_info_pre_move_state(struct sta_info *sta,
 562                                            enum ieee80211_sta_state new_state)
 563 {
 564         int ret;
 565
 566         WARN_ON_ONCE(test_sta_flag(sta, WLAN_STA_INSERTED));
 567
 568         ret = sta_info_move_state(sta, new_state);
 569         WARN_ON_ONCE(ret);
 570 }
 571
 572
 573 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
 574                              struct tid_ampdu_tx *tid_tx);
 575
 576 static inline struct tid_ampdu_tx *
 577 rcu_dereference_protected_tid_tx(struct sta_info *sta, int tid)
 578 {
 579         return rcu_dereference_protected(sta->ampdu_mlme.tid_tx[tid],
 580                                          lockdep_is_held(&sta->lock) ||
 581                                          lockdep_is_held(&sta->ampdu_mlme.mtx));
 582 }
 583
 584 /* Maximum number of frames to buffer per power saving station per AC */
 585 #define STA_MAX_TX_BUFFER       64
 586
 587 /* Minimum buffered frame expiry time. If STA uses listen interval that is
 588  * smaller than this value, the minimum value here is used instead. */
 589 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
 590
 591 /* How often station data is cleaned up (e.g., expiration of buffered frames)
 592  */
 593 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
 594
 595 /*
 596  * Get a STA info, must be under RCU read lock.
 597  */
 598 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
 599                               const u8 *addr);
 600
 601 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
 602                                   const u8 *addr);
 603
 604 u32 sta_addr_hash(const void *key, u32 length, u32 seed);
 605
 606 #define _sta_bucket_idx(_tbl, _a)                                       \
 607         rht_bucket_index(_tbl, sta_addr_hash(_a, ETH_ALEN, (_tbl)->hash_rnd))
 608
 609 #define for_each_sta_info(local, tbl, _addr, _sta, _tmp)                \
 610         rht_for_each_entry_rcu(_sta, _tmp, tbl,                         \
 611                                _sta_bucket_idx(tbl, _addr),             \
 612                                hash_node)                               \
 613         /* compare address and run code only if it matches */           \
 614         if (ether_addr_equal(_sta->addr, (_addr)))
 615
 616 /*
 617  * Get STA info by index, BROKEN!
 618  */
 619 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
 620                                      int idx);
 621 /*
 622  * Create a new STA info, caller owns returned structure
 623  * until sta_info_insert().
 624  */
 625 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
 626                                 const u8 *addr, gfp_t gfp);
 627
 628 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta);
 629
 630 /*
 631  * Insert STA info into hash table/list, returns zero or a
 632  * -EEXIST if (if the same MAC address is already present).
 633  *
 634  * Calling the non-rcu version makes the caller relinquish,
 635  * the _rcu version calls read_lock_rcu() and must be called
 636  * without it held.
 637  */
 638 int sta_info_insert(struct sta_info *sta);
 639 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
 640
 641 int __must_check __sta_info_destroy(struct sta_info *sta);
 642 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
 643                           const u8 *addr);
 644 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
 645                               const u8 *addr);
 646
 647 void sta_info_recalc_tim(struct sta_info *sta);
 648
 649 int sta_info_init(struct ieee80211_local *local);
 650 void sta_info_stop(struct ieee80211_local *local);
 651
 652 /**
 653  * sta_info_flush - flush matching STA entries from the STA table
 654  *
 655  * Returns the number of removed STA entries.
 656  *
 657  * @sdata: sdata to remove all stations from
 658  * @vlans: if the given interface is an AP interface, also flush VLANs
 659  */
 660 int __sta_info_flush(struct ieee80211_sub_if_data *sdata, bool vlans);
 661
 662 static inline int sta_info_flush(struct ieee80211_sub_if_data *sdata)
 663 {
 664         return __sta_info_flush(sdata, false);
 665 }
 666
 667 void sta_set_rate_info_tx(struct sta_info *sta,
 668                           const struct ieee80211_tx_rate *rate,
 669                           struct rate_info *rinfo);
 670 void sta_set_sinfo(struct sta_info *sta, struct station_info *sinfo);
 671
 672 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
 673                           unsigned long exp_time);
 674 u8 sta_info_tx_streams(struct sta_info *sta);
 675
 676 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
 677 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
 678 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta);
 679
 680 #endif /* STA_INFO_H */