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