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