net/mac80211/sta_info.h

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