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