]> err.no Git - linux-2.6/blob - net/mac80211/sta_info.c
mac80211: consolidate TIM handling code
[linux-2.6] / net / mac80211 / sta_info.c
1 /*
2  * Copyright 2002-2005, Instant802 Networks, Inc.
3  * Copyright 2006-2007  Jiri Benc <jbenc@suse.cz>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation.
8  */
9
10 #include <linux/module.h>
11 #include <linux/init.h>
12 #include <linux/netdevice.h>
13 #include <linux/types.h>
14 #include <linux/slab.h>
15 #include <linux/skbuff.h>
16 #include <linux/if_arp.h>
17 #include <linux/timer.h>
18
19 #include <net/mac80211.h>
20 #include "ieee80211_i.h"
21 #include "ieee80211_rate.h"
22 #include "sta_info.h"
23 #include "debugfs_sta.h"
24
25 /* Caller must hold local->sta_lock */
26 static void sta_info_hash_add(struct ieee80211_local *local,
27                               struct sta_info *sta)
28 {
29         sta->hnext = local->sta_hash[STA_HASH(sta->addr)];
30         local->sta_hash[STA_HASH(sta->addr)] = sta;
31 }
32
33
34 /* Caller must hold local->sta_lock */
35 static int sta_info_hash_del(struct ieee80211_local *local,
36                              struct sta_info *sta)
37 {
38         struct sta_info *s;
39
40         s = local->sta_hash[STA_HASH(sta->addr)];
41         if (!s)
42                 return -ENOENT;
43         if (s == sta) {
44                 local->sta_hash[STA_HASH(sta->addr)] = s->hnext;
45                 return 0;
46         }
47
48         while (s->hnext && s->hnext != sta)
49                 s = s->hnext;
50         if (s->hnext) {
51                 s->hnext = sta->hnext;
52                 return 0;
53         }
54
55         return -ENOENT;
56 }
57
58 struct sta_info *sta_info_get(struct ieee80211_local *local, u8 *addr)
59 {
60         struct sta_info *sta;
61
62         read_lock_bh(&local->sta_lock);
63         sta = local->sta_hash[STA_HASH(addr)];
64         while (sta) {
65                 if (memcmp(sta->addr, addr, ETH_ALEN) == 0) {
66                         __sta_info_get(sta);
67                         break;
68                 }
69                 sta = sta->hnext;
70         }
71         read_unlock_bh(&local->sta_lock);
72
73         return sta;
74 }
75 EXPORT_SYMBOL(sta_info_get);
76
77
78 static void sta_info_release(struct kref *kref)
79 {
80         struct sta_info *sta = container_of(kref, struct sta_info, kref);
81         struct ieee80211_local *local = sta->local;
82         struct sk_buff *skb;
83         int i;
84
85         /* free sta structure; it has already been removed from
86          * hash table etc. external structures. Make sure that all
87          * buffered frames are release (one might have been added
88          * after sta_info_free() was called). */
89         while ((skb = skb_dequeue(&sta->ps_tx_buf)) != NULL) {
90                 local->total_ps_buffered--;
91                 dev_kfree_skb_any(skb);
92         }
93         while ((skb = skb_dequeue(&sta->tx_filtered)) != NULL) {
94                 dev_kfree_skb_any(skb);
95         }
96         for (i = 0; i <  STA_TID_NUM; i++) {
97                 del_timer_sync(&sta->ampdu_mlme.tid_rx[i].session_timer);
98                 del_timer_sync(&sta->ampdu_mlme.tid_tx[i].addba_resp_timer);
99         }
100         rate_control_free_sta(sta->rate_ctrl, sta->rate_ctrl_priv);
101         rate_control_put(sta->rate_ctrl);
102         kfree(sta);
103 }
104
105
106 void sta_info_put(struct sta_info *sta)
107 {
108         kref_put(&sta->kref, sta_info_release);
109 }
110 EXPORT_SYMBOL(sta_info_put);
111
112
113 struct sta_info * sta_info_add(struct ieee80211_local *local,
114                                struct net_device *dev, u8 *addr, gfp_t gfp)
115 {
116         struct sta_info *sta;
117         int i;
118         DECLARE_MAC_BUF(mac);
119
120         sta = kzalloc(sizeof(*sta), gfp);
121         if (!sta)
122                 return NULL;
123
124         kref_init(&sta->kref);
125
126         sta->rate_ctrl = rate_control_get(local->rate_ctrl);
127         sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl, gfp);
128         if (!sta->rate_ctrl_priv) {
129                 rate_control_put(sta->rate_ctrl);
130                 kfree(sta);
131                 return NULL;
132         }
133
134         memcpy(sta->addr, addr, ETH_ALEN);
135         sta->local = local;
136         sta->dev = dev;
137         spin_lock_init(&sta->ampdu_mlme.ampdu_rx);
138         spin_lock_init(&sta->ampdu_mlme.ampdu_tx);
139         for (i = 0; i < STA_TID_NUM; i++) {
140                 /* timer_to_tid must be initialized with identity mapping to
141                  * enable session_timer's data differentiation. refer to
142                  * sta_rx_agg_session_timer_expired for useage */
143                 sta->timer_to_tid[i] = i;
144                 /* tid to tx queue: initialize according to HW (0 is valid) */
145                 sta->tid_to_tx_q[i] = local->hw.queues;
146                 /* rx timers */
147                 sta->ampdu_mlme.tid_rx[i].session_timer.function =
148                         sta_rx_agg_session_timer_expired;
149                 sta->ampdu_mlme.tid_rx[i].session_timer.data =
150                         (unsigned long)&sta->timer_to_tid[i];
151                 init_timer(&sta->ampdu_mlme.tid_rx[i].session_timer);
152                 /* tx timers */
153                 sta->ampdu_mlme.tid_tx[i].addba_resp_timer.function =
154                         sta_addba_resp_timer_expired;
155                 sta->ampdu_mlme.tid_tx[i].addba_resp_timer.data =
156                         (unsigned long)&sta->timer_to_tid[i];
157                 init_timer(&sta->ampdu_mlme.tid_tx[i].addba_resp_timer);
158         }
159         skb_queue_head_init(&sta->ps_tx_buf);
160         skb_queue_head_init(&sta->tx_filtered);
161         __sta_info_get(sta);    /* sta used by caller, decremented by
162                                  * sta_info_put() */
163         write_lock_bh(&local->sta_lock);
164         list_add(&sta->list, &local->sta_list);
165         local->num_sta++;
166         sta_info_hash_add(local, sta);
167         if (local->ops->sta_notify) {
168                 struct ieee80211_sub_if_data *sdata;
169
170                 sdata = IEEE80211_DEV_TO_SUB_IF(dev);
171                 if (sdata->vif.type == IEEE80211_IF_TYPE_VLAN)
172                         sdata = sdata->u.vlan.ap;
173
174                 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
175                                        STA_NOTIFY_ADD, addr);
176         }
177         write_unlock_bh(&local->sta_lock);
178
179 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
180         printk(KERN_DEBUG "%s: Added STA %s\n",
181                wiphy_name(local->hw.wiphy), print_mac(mac, addr));
182 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
183
184 #ifdef CONFIG_MAC80211_DEBUGFS
185         /* debugfs entry adding might sleep, so schedule process
186          * context task for adding entry for STAs that do not yet
187          * have one. */
188         queue_work(local->hw.workqueue, &local->sta_debugfs_add);
189 #endif
190
191         return sta;
192 }
193
194 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
195 {
196         /*
197          * This format has been mandated by the IEEE specifications,
198          * so this line may not be changed to use the __set_bit() format.
199          */
200         bss->tim[aid / 8] |= (1 << (aid % 8));
201 }
202
203 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
204 {
205         /*
206          * This format has been mandated by the IEEE specifications,
207          * so this line may not be changed to use the __clear_bit() format.
208          */
209         bss->tim[aid / 8] &= ~(1 << (aid % 8));
210 }
211
212 static void __sta_info_set_tim_bit(struct ieee80211_if_ap *bss,
213                                    struct sta_info *sta)
214 {
215         if (bss)
216                 __bss_tim_set(bss, sta->aid);
217         if (sta->local->ops->set_tim)
218                 sta->local->ops->set_tim(local_to_hw(sta->local), sta->aid, 1);
219 }
220
221 void sta_info_set_tim_bit(struct sta_info *sta)
222 {
223         struct ieee80211_sub_if_data *sdata;
224
225         sdata = IEEE80211_DEV_TO_SUB_IF(sta->dev);
226
227         read_lock_bh(&sta->local->sta_lock);
228         __sta_info_set_tim_bit(sdata->bss, sta);
229         read_unlock_bh(&sta->local->sta_lock);
230 }
231
232 static void __sta_info_clear_tim_bit(struct ieee80211_if_ap *bss,
233                                      struct sta_info *sta)
234 {
235         if (bss)
236                 __bss_tim_clear(bss, sta->aid);
237         if (sta->local->ops->set_tim)
238                 sta->local->ops->set_tim(local_to_hw(sta->local), sta->aid, 0);
239 }
240
241 void sta_info_clear_tim_bit(struct sta_info *sta)
242 {
243         struct ieee80211_sub_if_data *sdata;
244
245         sdata = IEEE80211_DEV_TO_SUB_IF(sta->dev);
246
247         read_lock_bh(&sta->local->sta_lock);
248         __sta_info_clear_tim_bit(sdata->bss, sta);
249         read_unlock_bh(&sta->local->sta_lock);
250 }
251
252 /* Caller must hold local->sta_lock */
253 void sta_info_remove(struct sta_info *sta)
254 {
255         struct ieee80211_local *local = sta->local;
256         struct ieee80211_sub_if_data *sdata;
257
258         /* don't do anything if we've been removed already */
259         if (sta_info_hash_del(local, sta))
260                 return;
261
262         list_del(&sta->list);
263         sdata = IEEE80211_DEV_TO_SUB_IF(sta->dev);
264         if (sta->flags & WLAN_STA_PS) {
265                 sta->flags &= ~WLAN_STA_PS;
266                 if (sdata->bss)
267                         atomic_dec(&sdata->bss->num_sta_ps);
268                 __sta_info_clear_tim_bit(sdata->bss, sta);
269         }
270         local->num_sta--;
271 }
272
273 void sta_info_free(struct sta_info *sta)
274 {
275         struct sk_buff *skb;
276         struct ieee80211_local *local = sta->local;
277         DECLARE_MAC_BUF(mac);
278
279         might_sleep();
280
281         write_lock_bh(&local->sta_lock);
282         sta_info_remove(sta);
283         write_unlock_bh(&local->sta_lock);
284
285         while ((skb = skb_dequeue(&sta->ps_tx_buf)) != NULL) {
286                 local->total_ps_buffered--;
287                 dev_kfree_skb(skb);
288         }
289         while ((skb = skb_dequeue(&sta->tx_filtered)) != NULL) {
290                 dev_kfree_skb(skb);
291         }
292
293 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
294         printk(KERN_DEBUG "%s: Removed STA %s\n",
295                wiphy_name(local->hw.wiphy), print_mac(mac, sta->addr));
296 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
297
298         ieee80211_key_free(sta->key);
299         sta->key = NULL;
300
301         if (local->ops->sta_notify) {
302                 struct ieee80211_sub_if_data *sdata;
303
304                 sdata = IEEE80211_DEV_TO_SUB_IF(sta->dev);
305
306                 if (sdata->vif.type == IEEE80211_IF_TYPE_VLAN)
307                         sdata = sdata->u.vlan.ap;
308
309                 local->ops->sta_notify(local_to_hw(local), &sdata->vif,
310                                        STA_NOTIFY_REMOVE, sta->addr);
311         }
312
313         rate_control_remove_sta_debugfs(sta);
314         ieee80211_sta_debugfs_remove(sta);
315
316         sta_info_put(sta);
317 }
318
319
320 static inline int sta_info_buffer_expired(struct ieee80211_local *local,
321                                           struct sta_info *sta,
322                                           struct sk_buff *skb)
323 {
324         struct ieee80211_tx_packet_data *pkt_data;
325         int timeout;
326
327         if (!skb)
328                 return 0;
329
330         pkt_data = (struct ieee80211_tx_packet_data *) skb->cb;
331
332         /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
333         timeout = (sta->listen_interval * local->hw.conf.beacon_int * 32 /
334                    15625) * HZ;
335         if (timeout < STA_TX_BUFFER_EXPIRE)
336                 timeout = STA_TX_BUFFER_EXPIRE;
337         return time_after(jiffies, pkt_data->jiffies + timeout);
338 }
339
340
341 static void sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
342                                              struct sta_info *sta)
343 {
344         unsigned long flags;
345         struct sk_buff *skb;
346         struct ieee80211_sub_if_data *sdata;
347         DECLARE_MAC_BUF(mac);
348
349         if (skb_queue_empty(&sta->ps_tx_buf))
350                 return;
351
352         for (;;) {
353                 spin_lock_irqsave(&sta->ps_tx_buf.lock, flags);
354                 skb = skb_peek(&sta->ps_tx_buf);
355                 if (sta_info_buffer_expired(local, sta, skb))
356                         skb = __skb_dequeue(&sta->ps_tx_buf);
357                 else
358                         skb = NULL;
359                 spin_unlock_irqrestore(&sta->ps_tx_buf.lock, flags);
360
361                 if (!skb)
362                         break;
363
364                 sdata = IEEE80211_DEV_TO_SUB_IF(sta->dev);
365                 local->total_ps_buffered--;
366                 printk(KERN_DEBUG "Buffered frame expired (STA "
367                        "%s)\n", print_mac(mac, sta->addr));
368                 dev_kfree_skb(skb);
369
370                 if (skb_queue_empty(&sta->ps_tx_buf))
371                         sta_info_clear_tim_bit(sta);
372         }
373 }
374
375
376 static void sta_info_cleanup(unsigned long data)
377 {
378         struct ieee80211_local *local = (struct ieee80211_local *) data;
379         struct sta_info *sta;
380
381         read_lock_bh(&local->sta_lock);
382         list_for_each_entry(sta, &local->sta_list, list) {
383                 __sta_info_get(sta);
384                 sta_info_cleanup_expire_buffered(local, sta);
385                 sta_info_put(sta);
386         }
387         read_unlock_bh(&local->sta_lock);
388
389         local->sta_cleanup.expires =
390                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
391         add_timer(&local->sta_cleanup);
392 }
393
394 #ifdef CONFIG_MAC80211_DEBUGFS
395 static void sta_info_debugfs_add_task(struct work_struct *work)
396 {
397         struct ieee80211_local *local =
398                 container_of(work, struct ieee80211_local, sta_debugfs_add);
399         struct sta_info *sta, *tmp;
400
401         while (1) {
402                 sta = NULL;
403                 read_lock_bh(&local->sta_lock);
404                 list_for_each_entry(tmp, &local->sta_list, list) {
405                         if (!tmp->debugfs.dir) {
406                                 sta = tmp;
407                                 __sta_info_get(sta);
408                                 break;
409                         }
410                 }
411                 read_unlock_bh(&local->sta_lock);
412
413                 if (!sta)
414                         break;
415
416                 ieee80211_sta_debugfs_add(sta);
417                 rate_control_add_sta_debugfs(sta);
418                 sta_info_put(sta);
419         }
420 }
421 #endif
422
423 void sta_info_init(struct ieee80211_local *local)
424 {
425         rwlock_init(&local->sta_lock);
426         INIT_LIST_HEAD(&local->sta_list);
427
428         setup_timer(&local->sta_cleanup, sta_info_cleanup,
429                     (unsigned long)local);
430         local->sta_cleanup.expires =
431                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
432
433 #ifdef CONFIG_MAC80211_DEBUGFS
434         INIT_WORK(&local->sta_debugfs_add, sta_info_debugfs_add_task);
435 #endif
436 }
437
438 int sta_info_start(struct ieee80211_local *local)
439 {
440         add_timer(&local->sta_cleanup);
441         return 0;
442 }
443
444 void sta_info_stop(struct ieee80211_local *local)
445 {
446         del_timer(&local->sta_cleanup);
447         sta_info_flush(local, NULL);
448 }
449
450 /**
451  * sta_info_flush - flush matching STA entries from the STA table
452  * @local: local interface data
453  * @dev: matching rule for the net device (sta->dev) or %NULL to match all STAs
454  */
455 void sta_info_flush(struct ieee80211_local *local, struct net_device *dev)
456 {
457         struct sta_info *sta, *tmp;
458         LIST_HEAD(tmp_list);
459
460         write_lock_bh(&local->sta_lock);
461         list_for_each_entry_safe(sta, tmp, &local->sta_list, list)
462                 if (!dev || dev == sta->dev) {
463                         __sta_info_get(sta);
464                         sta_info_remove(sta);
465                         list_add_tail(&sta->list, &tmp_list);
466                 }
467         write_unlock_bh(&local->sta_lock);
468
469         list_for_each_entry_safe(sta, tmp, &tmp_list, list) {
470                 sta_info_free(sta);
471                 sta_info_put(sta);
472         }
473 }