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