net/mac80211/sta_info.h

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