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