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