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  *
  83  * This structure is protected by RCU and the per-station
  84  * spinlock. Assignments to the array holding it must hold
  85  * the spinlock, only the TX path can access it under RCU
  86  * lock-free if, and only if, the state has  the flag
  87  * %HT_AGG_STATE_OPERATIONAL set. Otherwise, the TX path
  88  * must also acquire the spinlock and re-check the state,
  89  * see comments in the tx code touching it.
  90  */
  91 struct tid_ampdu_tx {
  92         struct rcu_head rcu_head;
  93         struct timer_list addba_resp_timer;
  94         struct sk_buff_head pending;
  95         unsigned long state;
  96         u8 dialog_token;
  97         u8 stop_initiator;
  98 };
  99
 100 /**
 101  * struct tid_ampdu_rx - TID aggregation information (Rx).
 102  *
 103  * @reorder_buf: buffer to reorder incoming aggregated MPDUs
 104  * @reorder_time: jiffies when skb was added
 105  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
 106  * @head_seq_num: head sequence number in reordering buffer.
 107  * @stored_mpdu_num: number of MPDUs in reordering buffer
 108  * @ssn: Starting Sequence Number expected to be aggregated.
 109  * @buf_size: buffer size for incoming A-MPDUs
 110  * @timeout: reset timer value (in TUs).
 111  * @dialog_token: dialog token for aggregation session
 112  * @rcu_head: RCU head used for freeing this struct
 113  *
 114  * This structure is protected by RCU and the per-station
 115  * spinlock. Assignments to the array holding it must hold
 116  * the spinlock, only the RX path can access it under RCU
 117  * lock-free. The RX path, since it is single-threaded,
 118  * can even modify the structure without locking since the
 119  * only other modifications to it are done when the struct
 120  * can not yet or no longer be found by the RX path.
 121  */
 122 struct tid_ampdu_rx {
 123         struct rcu_head rcu_head;
 124         struct sk_buff **reorder_buf;
 125         unsigned long *reorder_time;
 126         struct timer_list session_timer;
 127         u16 head_seq_num;
 128         u16 stored_mpdu_num;
 129         u16 ssn;
 130         u16 buf_size;
 131         u16 timeout;
 132         u8 dialog_token;
 133 };
 134
 135 /**
 136  * struct sta_ampdu_mlme - STA aggregation information.
 137  *
 138  * @tid_rx: aggregation info for Rx per TID -- RCU protected
 139  * @tid_tx: aggregation info for Tx per TID
 140  * @addba_req_num: number of times addBA request has been sent.
 141  * @dialog_token_allocator: dialog token enumerator for each new session;
 142  * @work: work struct for starting/stopping aggregation
 143  */
 144 struct sta_ampdu_mlme {
 145         /* rx */
 146         struct tid_ampdu_rx *tid_rx[STA_TID_NUM];
 147         /* tx */
 148         struct work_struct work;
 149         struct tid_ampdu_tx *tid_tx[STA_TID_NUM];
 150         u8 addba_req_num[STA_TID_NUM];
 151         u8 dialog_token_allocator;
 152 };
 153
 154
 155 /**
 156  * enum plink_state - state of a mesh peer link finite state machine
 157  *
 158  * @PLINK_LISTEN: initial state, considered the implicit state of non existant
 159  *      mesh peer links
 160  * @PLINK_OPN_SNT: mesh plink open frame has been sent to this mesh peer
 161  * @PLINK_OPN_RCVD: mesh plink open frame has been received from this mesh peer
 162  * @PLINK_CNF_RCVD: mesh plink confirm frame has been received from this mesh
 163  *      peer
 164  * @PLINK_ESTAB: mesh peer link is established
 165  * @PLINK_HOLDING: mesh peer link is being closed or cancelled
 166  * @PLINK_BLOCKED: all frames transmitted from this mesh plink are discarded
 167  */
 168 enum plink_state {
 169         PLINK_LISTEN,
 170         PLINK_OPN_SNT,
 171         PLINK_OPN_RCVD,
 172         PLINK_CNF_RCVD,
 173         PLINK_ESTAB,
 174         PLINK_HOLDING,
 175         PLINK_BLOCKED
 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  * @key: peer key negotiated with this station, if any
 189  * @rate_ctrl: rate control algorithm reference
 190  * @rate_ctrl_priv: rate control private per-STA pointer
 191  * @last_tx_rate: rate used for last transmit, to report to userspace as
 192  *      "the" transmit rate
 193  * @lock: used for locking all fields that require locking, see comments
 194  *      in the header file.
 195  * @flaglock: spinlock for flags accesses
 196  * @drv_unblock_wk: used for driver PS unblocking
 197  * @listen_interval: listen interval of this station, when we're acting as AP
 198  * @flags: STA flags, see &enum ieee80211_sta_info_flags
 199  * @ps_tx_buf: buffer of frames to transmit to this station
 200  *      when it leaves power saving state
 201  * @tx_filtered: buffer of frames we already tried to transmit
 202  *      but were filtered by hardware due to STA having entered
 203  *      power saving state
 204  * @rx_packets: Number of MSDUs received from this STA
 205  * @rx_bytes: Number of bytes received from this STA
 206  * @wep_weak_iv_count: number of weak WEP IVs received from this station
 207  * @last_rx: time (in jiffies) when last frame was received from this STA
 208  * @num_duplicates: number of duplicate frames received from this STA
 209  * @rx_fragments: number of received MPDUs
 210  * @rx_dropped: number of dropped MPDUs from this STA
 211  * @last_signal: signal of last received frame from this STA
 212  * @last_seq_ctrl: last received seq/frag number from this STA (per RX queue)
 213  * @tx_filtered_count: number of frames the hardware filtered for this STA
 214  * @tx_retry_failed: number of frames that failed retry
 215  * @tx_retry_count: total number of retries for frames to this STA
 216  * @fail_avg: moving percentage of failed MSDUs
 217  * @tx_packets: number of RX/TX MSDUs
 218  * @tx_bytes: number of bytes transmitted to this STA
 219  * @tx_fragments: number of transmitted MPDUs
 220  * @tid_seq: per-TID sequence numbers for sending to this STA
 221  * @ampdu_mlme: A-MPDU state machine state
 222  * @timer_to_tid: identity mapping to ID timers
 223  * @llid: Local link ID
 224  * @plid: Peer link ID
 225  * @reason: Cancel reason on PLINK_HOLDING state
 226  * @plink_retries: Retries in establishment
 227  * @ignore_plink_timer: ignore the peer-link timer (used internally)
 228  * @plink_state: peer link state
 229  * @plink_timeout: timeout of peer link
 230  * @plink_timer: peer link watch timer
 231  * @plink_timer_was_running: used by suspend/resume to restore timers
 232  * @debugfs: debug filesystem info
 233  * @sta: station information we share with the driver
 234  * @dead: set to true when sta is unlinked
 235  * @uploaded: set to true when sta is uploaded to the driver
 236  */
 237 struct sta_info {
 238         /* General information, mostly static */
 239         struct list_head list;
 240         struct sta_info *hnext;
 241         struct ieee80211_local *local;
 242         struct ieee80211_sub_if_data *sdata;
 243         struct ieee80211_key *key;
 244         struct rate_control_ref *rate_ctrl;
 245         void *rate_ctrl_priv;
 246         spinlock_t lock;
 247         spinlock_t flaglock;
 248
 249         struct work_struct drv_unblock_wk;
 250
 251         u16 listen_interval;
 252
 253         bool dead;
 254
 255         bool uploaded;
 256
 257         /*
 258          * frequently updated, locked with own spinlock (flaglock),
 259          * use the accessors defined below
 260          */
 261         u32 flags;
 262
 263         /*
 264          * STA powersave frame queues, no more than the internal
 265          * locking required.
 266          */
 267         struct sk_buff_head ps_tx_buf;
 268         struct sk_buff_head tx_filtered;
 269
 270         /* Updated from RX path only, no locking requirements */
 271         unsigned long rx_packets, rx_bytes;
 272         unsigned long wep_weak_iv_count;
 273         unsigned long last_rx;
 274         unsigned long num_duplicates;
 275         unsigned long rx_fragments;
 276         unsigned long rx_dropped;
 277         int last_signal;
 278         __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
 279
 280         /* Updated from TX status path only, no locking requirements */
 281         unsigned long tx_filtered_count;
 282         unsigned long tx_retry_failed, tx_retry_count;
 283         /* moving percentage of failed MSDUs */
 284         unsigned int fail_avg;
 285
 286         /* Updated from TX path only, no locking requirements */
 287         unsigned long tx_packets;
 288         unsigned long tx_bytes;
 289         unsigned long tx_fragments;
 290         struct ieee80211_tx_rate last_tx_rate;
 291         u16 tid_seq[IEEE80211_QOS_CTL_TID_MASK + 1];
 292
 293         /*
 294          * Aggregation information, locked with lock.
 295          */
 296         struct sta_ampdu_mlme ampdu_mlme;
 297         u8 timer_to_tid[STA_TID_NUM];
 298
 299 #ifdef CONFIG_MAC80211_MESH
 300         /*
 301          * Mesh peer link attributes
 302          * TODO: move to a sub-structure that is referenced with pointer?
 303          */
 304         __le16 llid;
 305         __le16 plid;
 306         __le16 reason;
 307         u8 plink_retries;
 308         bool ignore_plink_timer;
 309         bool plink_timer_was_running;
 310         enum plink_state plink_state;
 311         u32 plink_timeout;
 312         struct timer_list plink_timer;
 313 #endif
 314
 315 #ifdef CONFIG_MAC80211_DEBUGFS
 316         struct sta_info_debugfsdentries {
 317                 struct dentry *dir;
 318                 bool add_has_run;
 319         } debugfs;
 320 #endif
 321
 322         /* keep last! */
 323         struct ieee80211_sta sta;
 324 };
 325
 326 static inline enum plink_state sta_plink_state(struct sta_info *sta)
 327 {
 328 #ifdef CONFIG_MAC80211_MESH
 329         return sta->plink_state;
 330 #endif
 331         return PLINK_LISTEN;
 332 }
 333
 334 static inline void set_sta_flags(struct sta_info *sta, const u32 flags)
 335 {
 336         unsigned long irqfl;
 337
 338         spin_lock_irqsave(&sta->flaglock, irqfl);
 339         sta->flags |= flags;
 340         spin_unlock_irqrestore(&sta->flaglock, irqfl);
 341 }
 342
 343 static inline void clear_sta_flags(struct sta_info *sta, const u32 flags)
 344 {
 345         unsigned long irqfl;
 346
 347         spin_lock_irqsave(&sta->flaglock, irqfl);
 348         sta->flags &= ~flags;
 349         spin_unlock_irqrestore(&sta->flaglock, irqfl);
 350 }
 351
 352 static inline u32 test_sta_flags(struct sta_info *sta, const u32 flags)
 353 {
 354         u32 ret;
 355         unsigned long irqfl;
 356
 357         spin_lock_irqsave(&sta->flaglock, irqfl);
 358         ret = sta->flags & flags;
 359         spin_unlock_irqrestore(&sta->flaglock, irqfl);
 360
 361         return ret;
 362 }
 363
 364 static inline u32 test_and_clear_sta_flags(struct sta_info *sta,
 365                                            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         sta->flags &= ~flags;
 373         spin_unlock_irqrestore(&sta->flaglock, irqfl);
 374
 375         return ret;
 376 }
 377
 378 static inline u32 get_sta_flags(struct sta_info *sta)
 379 {
 380         u32 ret;
 381         unsigned long irqfl;
 382
 383         spin_lock_irqsave(&sta->flaglock, irqfl);
 384         ret = sta->flags;
 385         spin_unlock_irqrestore(&sta->flaglock, irqfl);
 386
 387         return ret;
 388 }
 389
 390
 391
 392 #define STA_HASH_SIZE 256
 393 #define STA_HASH(sta) (sta[5])
 394
 395
 396 /* Maximum number of frames to buffer per power saving station */
 397 #define STA_MAX_TX_BUFFER 128
 398
 399 /* Minimum buffered frame expiry time. If STA uses listen interval that is
 400  * smaller than this value, the minimum value here is used instead. */
 401 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
 402
 403 /* How often station data is cleaned up (e.g., expiration of buffered frames)
 404  */
 405 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
 406
 407 /*
 408  * Get a STA info, must be under RCU read lock.
 409  */
 410 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
 411                               const u8 *addr);
 412
 413 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
 414                                   const u8 *addr);
 415
 416 static inline
 417 void for_each_sta_info_type_check(struct ieee80211_local *local,
 418                                   const u8 *addr,
 419                                   struct sta_info *sta,
 420                                   struct sta_info *nxt)
 421 {
 422 }
 423
 424 #define for_each_sta_info(local, _addr, sta, nxt)                       \
 425         for (   /* initialise loop */                                   \
 426                 sta = rcu_dereference(local->sta_hash[STA_HASH(_addr)]),\
 427                 nxt = sta ? rcu_dereference(sta->hnext) : NULL;         \
 428                 /* typecheck */                                         \
 429                 for_each_sta_info_type_check(local, (_addr), sta, nxt), \
 430                 /* continue condition */                                \
 431                 sta;                                                    \
 432                 /* advance loop */                                      \
 433                 sta = nxt,                                              \
 434                 nxt = sta ? rcu_dereference(sta->hnext) : NULL          \
 435              )                                                          \
 436         /* compare address and run code only if it matches */           \
 437         if (memcmp(sta->sta.addr, (_addr), ETH_ALEN) == 0)
 438
 439 /*
 440  * Get STA info by index, BROKEN!
 441  */
 442 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
 443                                      int idx);
 444 /*
 445  * Create a new STA info, caller owns returned structure
 446  * until sta_info_insert().
 447  */
 448 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
 449                                 u8 *addr, gfp_t gfp);
 450 /*
 451  * Insert STA info into hash table/list, returns zero or a
 452  * -EEXIST if (if the same MAC address is already present).
 453  *
 454  * Calling the non-rcu version makes the caller relinquish,
 455  * the _rcu version calls read_lock_rcu() and must be called
 456  * without it held.
 457  */
 458 int sta_info_insert(struct sta_info *sta);
 459 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU);
 460 int sta_info_insert_atomic(struct sta_info *sta);
 461
 462 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata,
 463                           const u8 *addr);
 464 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
 465                               const u8 *addr);
 466
 467 void sta_info_set_tim_bit(struct sta_info *sta);
 468 void sta_info_clear_tim_bit(struct sta_info *sta);
 469
 470 void sta_info_init(struct ieee80211_local *local);
 471 int sta_info_start(struct ieee80211_local *local);
 472 void sta_info_stop(struct ieee80211_local *local);
 473 int sta_info_flush(struct ieee80211_local *local,
 474                    struct ieee80211_sub_if_data *sdata);
 475 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
 476                           unsigned long exp_time);
 477
 478 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta);
 479 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta);
 480
 481 #endif /* STA_INFO_H */