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