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/kref.h>
  16 #include "ieee80211_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: Station is in power-save mode
  26  * @WLAN_STA_TIM: TIM bit is on for this PS station (traffic buffered)
  27  * @WLAN_STA_AUTHORIZED: Station is authorized to send/receive traffic.
  28  *      This bit is always checked so needs to be enabled for all stations
  29  *      when virtual port control is not in use.
  30  * @WLAN_STA_SHORT_PREAMBLE: Station is capable of receiving short-preamble
  31  *      frames.
  32  * @WLAN_STA_ASSOC_AP: We're associated to that station, it is an AP.
  33  * @WLAN_STA_WME: Station is a QoS-STA.
  34  * @WLAN_STA_WDS: Station is one of our WDS peers.
  35  */
  36 enum ieee80211_sta_info_flags {
  37         WLAN_STA_AUTH           = 1<<0,
  38         WLAN_STA_ASSOC          = 1<<1,
  39         WLAN_STA_PS             = 1<<2,
  40         WLAN_STA_TIM            = 1<<3,
  41         WLAN_STA_AUTHORIZED     = 1<<4,
  42         WLAN_STA_SHORT_PREAMBLE = 1<<5,
  43         WLAN_STA_ASSOC_AP       = 1<<6,
  44         WLAN_STA_WME            = 1<<7,
  45         WLAN_STA_WDS            = 1<<8,
  46 };
  47
  48 #define STA_TID_NUM 16
  49 #define ADDBA_RESP_INTERVAL HZ
  50 #define HT_AGG_MAX_RETRIES              (0x3)
  51
  52 #define HT_AGG_STATE_INITIATOR_SHIFT    (4)
  53
  54 #define HT_ADDBA_REQUESTED_MSK          BIT(0)
  55 #define HT_ADDBA_DRV_READY_MSK          BIT(1)
  56 #define HT_ADDBA_RECEIVED_MSK           BIT(2)
  57 #define HT_AGG_STATE_REQ_STOP_BA_MSK    BIT(3)
  58 #define HT_AGG_STATE_INITIATOR_MSK      BIT(HT_AGG_STATE_INITIATOR_SHIFT)
  59 #define HT_AGG_STATE_IDLE               (0x0)
  60 #define HT_AGG_STATE_OPERATIONAL        (HT_ADDBA_REQUESTED_MSK |       \
  61                                          HT_ADDBA_DRV_READY_MSK |       \
  62                                          HT_ADDBA_RECEIVED_MSK)
  63
  64 /**
  65  * struct tid_ampdu_tx - TID aggregation information (Tx).
  66  *
  67  * @state: TID's state in session state machine.
  68  * @dialog_token: dialog token for aggregation session
  69  * @ssn: Starting Sequence Number expected to be aggregated.
  70  * @addba_resp_timer: timer for peer's response to addba request
  71  * @addba_req_num: number of times addBA request has been sent.
  72  */
  73 struct tid_ampdu_tx {
  74         u8 state;
  75         u8 dialog_token;
  76         u16 ssn;
  77         struct timer_list addba_resp_timer;
  78         u8 addba_req_num;
  79 };
  80
  81 /**
  82  * struct tid_ampdu_rx - TID aggregation information (Rx).
  83  *
  84  * @state: TID's state in session state machine.
  85  * @dialog_token: dialog token for aggregation session
  86  * @ssn: Starting Sequence Number expected to be aggregated.
  87  * @buf_size: buffer size for incoming A-MPDUs
  88  * @timeout: reset timer value.
  89  * @head_seq_num: head sequence number in reordering buffer.
  90  * @stored_mpdu_num: number of MPDUs in reordering buffer
  91  * @reorder_buf: buffer to reorder incoming aggregated MPDUs
  92  * @session_timer: check if peer keeps Tx-ing on the TID (by timeout value)
  93  */
  94 struct tid_ampdu_rx {
  95         u8 state;
  96         u8 dialog_token;
  97         u16 ssn;
  98         u16 buf_size;
  99         u16 timeout;
 100         u16 head_seq_num;
 101         u16 stored_mpdu_num;
 102         struct sk_buff **reorder_buf;
 103         struct timer_list session_timer;
 104 };
 105
 106 /**
 107  * struct sta_ampdu_mlme - STA aggregation information.
 108  *
 109  * @tid_rx: aggregation info for Rx per TID
 110  * @tid_tx: aggregation info for Tx per TID
 111  * @ampdu_rx: for locking sections in aggregation Rx flow
 112  * @ampdu_tx: for locking sectionsi in aggregation Tx flow
 113  * @dialog_token_allocator: dialog token enumerator for each new session;
 114  */
 115 struct sta_ampdu_mlme {
 116         struct tid_ampdu_rx tid_rx[STA_TID_NUM];
 117         struct tid_ampdu_tx tid_tx[STA_TID_NUM];
 118         spinlock_t ampdu_rx;
 119         spinlock_t ampdu_tx;
 120         u8 dialog_token_allocator;
 121 };
 122
 123 struct sta_info {
 124         struct kref kref;
 125         struct list_head list;
 126         struct sta_info *hnext; /* next entry in hash table list */
 127
 128         struct ieee80211_local *local;
 129
 130         u8 addr[ETH_ALEN];
 131         u16 aid; /* STA's unique AID (1..2007), 0 = not yet assigned */
 132         u32 flags; /* WLAN_STA_ */
 133
 134         struct sk_buff_head ps_tx_buf; /* buffer of TX frames for station in
 135                                         * power saving state */
 136         int pspoll; /* whether STA has send a PS Poll frame */
 137         struct sk_buff_head tx_filtered; /* buffer of TX frames that were
 138                                           * already given to low-level driver,
 139                                           * but were filtered */
 140         int clear_dst_mask;
 141
 142         unsigned long rx_packets, tx_packets; /* number of RX/TX MSDUs */
 143         unsigned long rx_bytes, tx_bytes;
 144         unsigned long tx_retry_failed, tx_retry_count;
 145         unsigned long tx_filtered_count;
 146
 147         unsigned int wep_weak_iv_count; /* number of RX frames with weak IV */
 148
 149         unsigned long last_rx;
 150         /* bitmap of supported rates per band */
 151         u64 supp_rates[IEEE80211_NUM_BANDS];
 152         int txrate_idx;
 153         /* last rates used to send a frame to this STA */
 154         int last_txrate_idx, last_nonerp_txrate_idx;
 155
 156         struct net_device *dev; /* which net device is this station associated
 157                                  * to */
 158
 159         struct ieee80211_key *key;
 160
 161         u32 tx_num_consecutive_failures;
 162         u32 tx_num_mpdu_ok;
 163         u32 tx_num_mpdu_fail;
 164
 165         struct rate_control_ref *rate_ctrl;
 166         void *rate_ctrl_priv;
 167
 168         /* last received seq/frag number from this STA (per RX queue) */
 169         __le16 last_seq_ctrl[NUM_RX_DATA_QUEUES];
 170         unsigned long num_duplicates; /* number of duplicate frames received
 171                                        * from this STA */
 172         unsigned long tx_fragments; /* number of transmitted MPDUs */
 173         unsigned long rx_fragments; /* number of received MPDUs */
 174         unsigned long rx_dropped; /* number of dropped MPDUs from this STA */
 175
 176         int last_rssi; /* RSSI of last received frame from this STA */
 177         int last_signal; /* signal of last received frame from this STA */
 178         int last_noise; /* noise of last received frame from this STA */
 179         int last_ack_rssi[3]; /* RSSI of last received ACKs from this STA */
 180         unsigned long last_ack;
 181         int channel_use;
 182         int channel_use_raw;
 183
 184 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
 185         unsigned int wme_rx_queue[NUM_RX_DATA_QUEUES];
 186         unsigned int wme_tx_queue[NUM_RX_DATA_QUEUES];
 187 #endif /* CONFIG_MAC80211_DEBUG_COUNTERS */
 188
 189         u16 listen_interval;
 190
 191         struct ieee80211_ht_info ht_info; /* 802.11n HT capabilities
 192                                              of this STA */
 193         struct sta_ampdu_mlme ampdu_mlme;
 194         u8 timer_to_tid[STA_TID_NUM];   /* convert timer id to tid */
 195         u8 tid_to_tx_q[STA_TID_NUM];    /* map tid to tx queue */
 196
 197 #ifdef CONFIG_MAC80211_DEBUGFS
 198         struct sta_info_debugfsdentries {
 199                 struct dentry *dir;
 200                 struct dentry *flags;
 201                 struct dentry *num_ps_buf_frames;
 202                 struct dentry *last_ack_rssi;
 203                 struct dentry *last_ack_ms;
 204                 struct dentry *inactive_ms;
 205                 struct dentry *last_seq_ctrl;
 206 #ifdef CONFIG_MAC80211_DEBUG_COUNTERS
 207                 struct dentry *wme_rx_queue;
 208                 struct dentry *wme_tx_queue;
 209 #endif
 210                 struct dentry *agg_status;
 211         } debugfs;
 212 #endif
 213 };
 214
 215
 216 /* Maximum number of concurrently registered stations */
 217 #define MAX_STA_COUNT 2007
 218
 219 #define STA_HASH_SIZE 256
 220 #define STA_HASH(sta) (sta[5])
 221
 222
 223 /* Maximum number of frames to buffer per power saving station */
 224 #define STA_MAX_TX_BUFFER 128
 225
 226 /* Minimum buffered frame expiry time. If STA uses listen interval that is
 227  * smaller than this value, the minimum value here is used instead. */
 228 #define STA_TX_BUFFER_EXPIRE (10 * HZ)
 229
 230 /* How often station data is cleaned up (e.g., expiration of buffered frames)
 231  */
 232 #define STA_INFO_CLEANUP_INTERVAL (10 * HZ)
 233
 234 static inline void __sta_info_get(struct sta_info *sta)
 235 {
 236         kref_get(&sta->kref);
 237 }
 238
 239 struct sta_info * sta_info_get(struct ieee80211_local *local, u8 *addr);
 240 void sta_info_put(struct sta_info *sta);
 241 struct sta_info * sta_info_add(struct ieee80211_local *local,
 242                                struct net_device *dev, u8 *addr, gfp_t gfp);
 243 void sta_info_remove(struct sta_info *sta);
 244 void sta_info_free(struct sta_info *sta);
 245 void sta_info_init(struct ieee80211_local *local);
 246 int sta_info_start(struct ieee80211_local *local);
 247 void sta_info_stop(struct ieee80211_local *local);
 248 void sta_info_remove_aid_ptr(struct sta_info *sta);
 249 void sta_info_flush(struct ieee80211_local *local, struct net_device *dev);
 250
 251 #endif /* STA_INFO_H */