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