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