mac80211: implement support for 4-address frames for AP and client mode
[safe/jmp/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 #include <linux/rtnetlink.h>
19
20 #include <net/mac80211.h>
21 #include "ieee80211_i.h"
22 #include "driver-ops.h"
23 #include "rate.h"
24 #include "sta_info.h"
25 #include "debugfs_sta.h"
26 #include "mesh.h"
27
28 /**
29  * DOC: STA information lifetime rules
30  *
31  * STA info structures (&struct sta_info) are managed in a hash table
32  * for faster lookup and a list for iteration. They are managed using
33  * RCU, i.e. access to the list and hash table is protected by RCU.
34  *
35  * Upon allocating a STA info structure with sta_info_alloc(), the caller owns
36  * that structure. It must then either destroy it using sta_info_destroy()
37  * (which is pretty useless) or insert it into the hash table using
38  * sta_info_insert() which demotes the reference from ownership to a regular
39  * RCU-protected reference; if the function is called without protection by an
40  * RCU critical section the reference is instantly invalidated. Note that the
41  * caller may not do much with the STA info before inserting it, in particular,
42  * it may not start any mesh peer link management or add encryption keys.
43  *
44  * When the insertion fails (sta_info_insert()) returns non-zero), the
45  * structure will have been freed by sta_info_insert()!
46  *
47  * sta entries are added by mac80211 when you establish a link with a
48  * peer. This means different things for the different type of interfaces
49  * we support. For a regular station this mean we add the AP sta when we
50  * receive an assocation response from the AP. For IBSS this occurs when
51  * we receive a probe response or a beacon from target IBSS network. For
52  * WDS we add the sta for the peer imediately upon device open. When using
53  * AP mode we add stations for each respective station upon request from
54  * userspace through nl80211.
55  *
56  * Because there are debugfs entries for each station, and adding those
57  * must be able to sleep, it is also possible to "pin" a station entry,
58  * that means it can be removed from the hash table but not be freed.
59  * See the comment in __sta_info_unlink() for more information, this is
60  * an internal capability only.
61  *
62  * In order to remove a STA info structure, the caller needs to first
63  * unlink it (sta_info_unlink()) from the list and hash tables and
64  * then destroy it; sta_info_destroy() will wait for an RCU grace period
65  * to elapse before actually freeing it. Due to the pinning and the
66  * possibility of multiple callers trying to remove the same STA info at
67  * the same time, sta_info_unlink() can clear the STA info pointer it is
68  * passed to indicate that the STA info is owned by somebody else now.
69  *
70  * If sta_info_unlink() did not clear the pointer then the caller owns
71  * the STA info structure now and is responsible of destroying it with
72  * a call to sta_info_destroy().
73  *
74  * In all other cases, there is no concept of ownership on a STA entry,
75  * each structure is owned by the global hash table/list until it is
76  * removed. All users of the structure need to be RCU protected so that
77  * the structure won't be freed before they are done using it.
78  */
79
80 /* Caller must hold local->sta_lock */
81 static int sta_info_hash_del(struct ieee80211_local *local,
82                              struct sta_info *sta)
83 {
84         struct sta_info *s;
85
86         s = local->sta_hash[STA_HASH(sta->sta.addr)];
87         if (!s)
88                 return -ENOENT;
89         if (s == sta) {
90                 rcu_assign_pointer(local->sta_hash[STA_HASH(sta->sta.addr)],
91                                    s->hnext);
92                 return 0;
93         }
94
95         while (s->hnext && s->hnext != sta)
96                 s = s->hnext;
97         if (s->hnext) {
98                 rcu_assign_pointer(s->hnext, sta->hnext);
99                 return 0;
100         }
101
102         return -ENOENT;
103 }
104
105 /* protected by RCU */
106 struct sta_info *sta_info_get(struct ieee80211_local *local, const u8 *addr)
107 {
108         struct sta_info *sta;
109
110         sta = rcu_dereference(local->sta_hash[STA_HASH(addr)]);
111         while (sta) {
112                 if (memcmp(sta->sta.addr, addr, ETH_ALEN) == 0)
113                         break;
114                 sta = rcu_dereference(sta->hnext);
115         }
116         return sta;
117 }
118
119 struct sta_info *sta_info_get_by_idx(struct ieee80211_local *local, int idx,
120                                      struct net_device *dev)
121 {
122         struct sta_info *sta;
123         int i = 0;
124
125         list_for_each_entry_rcu(sta, &local->sta_list, list) {
126                 if (dev && dev != sta->sdata->dev)
127                         continue;
128                 if (i < idx) {
129                         ++i;
130                         continue;
131                 }
132                 return sta;
133         }
134
135         return NULL;
136 }
137
138 /**
139  * __sta_info_free - internal STA free helper
140  *
141  * @local: pointer to the global information
142  * @sta: STA info to free
143  *
144  * This function must undo everything done by sta_info_alloc()
145  * that may happen before sta_info_insert().
146  */
147 static void __sta_info_free(struct ieee80211_local *local,
148                             struct sta_info *sta)
149 {
150         rate_control_free_sta(sta);
151         rate_control_put(sta->rate_ctrl);
152
153 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
154         printk(KERN_DEBUG "%s: Destroyed STA %pM\n",
155                wiphy_name(local->hw.wiphy), sta->sta.addr);
156 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
157
158         kfree(sta);
159 }
160
161 void sta_info_destroy(struct sta_info *sta)
162 {
163         struct ieee80211_local *local;
164         struct sk_buff *skb;
165         int i;
166
167         might_sleep();
168
169         if (!sta)
170                 return;
171
172         local = sta->local;
173
174         cancel_work_sync(&sta->drv_unblock_wk);
175
176         rate_control_remove_sta_debugfs(sta);
177         ieee80211_sta_debugfs_remove(sta);
178
179 #ifdef CONFIG_MAC80211_MESH
180         if (ieee80211_vif_is_mesh(&sta->sdata->vif))
181                 mesh_plink_deactivate(sta);
182 #endif
183
184         /*
185          * We have only unlinked the key, and actually destroying it
186          * may mean it is removed from hardware which requires that
187          * the key->sta pointer is still valid, so flush the key todo
188          * list here.
189          *
190          * ieee80211_key_todo() will synchronize_rcu() so after this
191          * nothing can reference this sta struct any more.
192          */
193         ieee80211_key_todo();
194
195 #ifdef CONFIG_MAC80211_MESH
196         if (ieee80211_vif_is_mesh(&sta->sdata->vif))
197                 del_timer_sync(&sta->plink_timer);
198 #endif
199
200         while ((skb = skb_dequeue(&sta->ps_tx_buf)) != NULL) {
201                 local->total_ps_buffered--;
202                 dev_kfree_skb_any(skb);
203         }
204
205         while ((skb = skb_dequeue(&sta->tx_filtered)) != NULL)
206                 dev_kfree_skb_any(skb);
207
208         for (i = 0; i <  STA_TID_NUM; i++) {
209                 struct tid_ampdu_rx *tid_rx;
210                 struct tid_ampdu_tx *tid_tx;
211
212                 spin_lock_bh(&sta->lock);
213                 tid_rx = sta->ampdu_mlme.tid_rx[i];
214                 /* Make sure timer won't free the tid_rx struct, see below */
215                 if (tid_rx)
216                         tid_rx->shutdown = true;
217
218                 spin_unlock_bh(&sta->lock);
219
220                 /*
221                  * Outside spinlock - shutdown is true now so that the timer
222                  * won't free tid_rx, we have to do that now. Can't let the
223                  * timer do it because we have to sync the timer outside the
224                  * lock that it takes itself.
225                  */
226                 if (tid_rx) {
227                         del_timer_sync(&tid_rx->session_timer);
228                         kfree(tid_rx);
229                 }
230
231                 /*
232                  * No need to do such complications for TX agg sessions, the
233                  * path leading to freeing the tid_tx struct goes via a call
234                  * from the driver, and thus needs to look up the sta struct
235                  * again, which cannot be found when we get here. Hence, we
236                  * just need to delete the timer and free the aggregation
237                  * info; we won't be telling the peer about it then but that
238                  * doesn't matter if we're not talking to it again anyway.
239                  */
240                 tid_tx = sta->ampdu_mlme.tid_tx[i];
241                 if (tid_tx) {
242                         del_timer_sync(&tid_tx->addba_resp_timer);
243                         /*
244                          * STA removed while aggregation session being
245                          * started? Bit odd, but purge frames anyway.
246                          */
247                         skb_queue_purge(&tid_tx->pending);
248                         kfree(tid_tx);
249                 }
250         }
251
252         __sta_info_free(local, sta);
253 }
254
255
256 /* Caller must hold local->sta_lock */
257 static void sta_info_hash_add(struct ieee80211_local *local,
258                               struct sta_info *sta)
259 {
260         sta->hnext = local->sta_hash[STA_HASH(sta->sta.addr)];
261         rcu_assign_pointer(local->sta_hash[STA_HASH(sta->sta.addr)], sta);
262 }
263
264 static void sta_unblock(struct work_struct *wk)
265 {
266         struct sta_info *sta;
267
268         sta = container_of(wk, struct sta_info, drv_unblock_wk);
269
270         if (sta->dead)
271                 return;
272
273         if (!test_sta_flags(sta, WLAN_STA_PS_STA))
274                 ieee80211_sta_ps_deliver_wakeup(sta);
275         else if (test_and_clear_sta_flags(sta, WLAN_STA_PSPOLL))
276                 ieee80211_sta_ps_deliver_poll_response(sta);
277 }
278
279 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
280                                 u8 *addr, gfp_t gfp)
281 {
282         struct ieee80211_local *local = sdata->local;
283         struct sta_info *sta;
284         int i;
285
286         sta = kzalloc(sizeof(*sta) + local->hw.sta_data_size, gfp);
287         if (!sta)
288                 return NULL;
289
290         spin_lock_init(&sta->lock);
291         spin_lock_init(&sta->flaglock);
292         INIT_WORK(&sta->drv_unblock_wk, sta_unblock);
293
294         memcpy(sta->sta.addr, addr, ETH_ALEN);
295         sta->local = local;
296         sta->sdata = sdata;
297
298         sta->rate_ctrl = rate_control_get(local->rate_ctrl);
299         sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
300                                                      &sta->sta, gfp);
301         if (!sta->rate_ctrl_priv) {
302                 rate_control_put(sta->rate_ctrl);
303                 kfree(sta);
304                 return NULL;
305         }
306
307         for (i = 0; i < STA_TID_NUM; i++) {
308                 /* timer_to_tid must be initialized with identity mapping to
309                  * enable session_timer's data differentiation. refer to
310                  * sta_rx_agg_session_timer_expired for useage */
311                 sta->timer_to_tid[i] = i;
312                 /* rx */
313                 sta->ampdu_mlme.tid_state_rx[i] = HT_AGG_STATE_IDLE;
314                 sta->ampdu_mlme.tid_rx[i] = NULL;
315                 /* tx */
316                 sta->ampdu_mlme.tid_state_tx[i] = HT_AGG_STATE_IDLE;
317                 sta->ampdu_mlme.tid_tx[i] = NULL;
318                 sta->ampdu_mlme.addba_req_num[i] = 0;
319         }
320         skb_queue_head_init(&sta->ps_tx_buf);
321         skb_queue_head_init(&sta->tx_filtered);
322
323         for (i = 0; i < NUM_RX_DATA_QUEUES; i++)
324                 sta->last_seq_ctrl[i] = cpu_to_le16(USHORT_MAX);
325
326 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
327         printk(KERN_DEBUG "%s: Allocated STA %pM\n",
328                wiphy_name(local->hw.wiphy), sta->sta.addr);
329 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
330
331 #ifdef CONFIG_MAC80211_MESH
332         sta->plink_state = PLINK_LISTEN;
333         init_timer(&sta->plink_timer);
334 #endif
335
336         return sta;
337 }
338
339 int sta_info_insert(struct sta_info *sta)
340 {
341         struct ieee80211_local *local = sta->local;
342         struct ieee80211_sub_if_data *sdata = sta->sdata;
343         unsigned long flags;
344         int err = 0;
345
346         /*
347          * Can't be a WARN_ON because it can be triggered through a race:
348          * something inserts a STA (on one CPU) without holding the RTNL
349          * and another CPU turns off the net device.
350          */
351         if (unlikely(!netif_running(sdata->dev))) {
352                 err = -ENETDOWN;
353                 goto out_free;
354         }
355
356         if (WARN_ON(compare_ether_addr(sta->sta.addr, sdata->dev->dev_addr) == 0 ||
357                     is_multicast_ether_addr(sta->sta.addr))) {
358                 err = -EINVAL;
359                 goto out_free;
360         }
361
362         spin_lock_irqsave(&local->sta_lock, flags);
363         /* check if STA exists already */
364         if (sta_info_get(local, sta->sta.addr)) {
365                 spin_unlock_irqrestore(&local->sta_lock, flags);
366                 err = -EEXIST;
367                 goto out_free;
368         }
369         list_add(&sta->list, &local->sta_list);
370         local->sta_generation++;
371         local->num_sta++;
372         sta_info_hash_add(local, sta);
373
374         /* notify driver */
375         if (local->ops->sta_notify) {
376                 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
377                         sdata = container_of(sdata->bss,
378                                              struct ieee80211_sub_if_data,
379                                              u.ap);
380
381                 drv_sta_notify(local, &sdata->vif, STA_NOTIFY_ADD, &sta->sta);
382                 sdata = sta->sdata;
383         }
384
385 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
386         printk(KERN_DEBUG "%s: Inserted STA %pM\n",
387                wiphy_name(local->hw.wiphy), sta->sta.addr);
388 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
389
390         spin_unlock_irqrestore(&local->sta_lock, flags);
391
392 #ifdef CONFIG_MAC80211_DEBUGFS
393         /*
394          * Debugfs entry adding might sleep, so schedule process
395          * context task for adding entry for STAs that do not yet
396          * have one.
397          * NOTE: due to auto-freeing semantics this may only be done
398          *       if the insertion is successful!
399          */
400         schedule_work(&local->sta_debugfs_add);
401 #endif
402
403         if (ieee80211_vif_is_mesh(&sdata->vif))
404                 mesh_accept_plinks_update(sdata);
405
406         return 0;
407  out_free:
408         BUG_ON(!err);
409         __sta_info_free(local, sta);
410         return err;
411 }
412
413 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
414 {
415         /*
416          * This format has been mandated by the IEEE specifications,
417          * so this line may not be changed to use the __set_bit() format.
418          */
419         bss->tim[aid / 8] |= (1 << (aid % 8));
420 }
421
422 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
423 {
424         /*
425          * This format has been mandated by the IEEE specifications,
426          * so this line may not be changed to use the __clear_bit() format.
427          */
428         bss->tim[aid / 8] &= ~(1 << (aid % 8));
429 }
430
431 static void __sta_info_set_tim_bit(struct ieee80211_if_ap *bss,
432                                    struct sta_info *sta)
433 {
434         BUG_ON(!bss);
435
436         __bss_tim_set(bss, sta->sta.aid);
437
438         if (sta->local->ops->set_tim) {
439                 sta->local->tim_in_locked_section = true;
440                 drv_set_tim(sta->local, &sta->sta, true);
441                 sta->local->tim_in_locked_section = false;
442         }
443 }
444
445 void sta_info_set_tim_bit(struct sta_info *sta)
446 {
447         unsigned long flags;
448
449         BUG_ON(!sta->sdata->bss);
450
451         spin_lock_irqsave(&sta->local->sta_lock, flags);
452         __sta_info_set_tim_bit(sta->sdata->bss, sta);
453         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
454 }
455
456 static void __sta_info_clear_tim_bit(struct ieee80211_if_ap *bss,
457                                      struct sta_info *sta)
458 {
459         BUG_ON(!bss);
460
461         __bss_tim_clear(bss, sta->sta.aid);
462
463         if (sta->local->ops->set_tim) {
464                 sta->local->tim_in_locked_section = true;
465                 drv_set_tim(sta->local, &sta->sta, false);
466                 sta->local->tim_in_locked_section = false;
467         }
468 }
469
470 void sta_info_clear_tim_bit(struct sta_info *sta)
471 {
472         unsigned long flags;
473
474         BUG_ON(!sta->sdata->bss);
475
476         spin_lock_irqsave(&sta->local->sta_lock, flags);
477         __sta_info_clear_tim_bit(sta->sdata->bss, sta);
478         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
479 }
480
481 static void __sta_info_unlink(struct sta_info **sta)
482 {
483         struct ieee80211_local *local = (*sta)->local;
484         struct ieee80211_sub_if_data *sdata = (*sta)->sdata;
485         /*
486          * pull caller's reference if we're already gone.
487          */
488         if (sta_info_hash_del(local, *sta)) {
489                 *sta = NULL;
490                 return;
491         }
492
493         if ((*sta)->key) {
494                 ieee80211_key_free((*sta)->key);
495                 WARN_ON((*sta)->key);
496         }
497
498         list_del(&(*sta)->list);
499         (*sta)->dead = true;
500
501         if (test_and_clear_sta_flags(*sta,
502                                 WLAN_STA_PS_STA | WLAN_STA_PS_DRIVER)) {
503                 BUG_ON(!sdata->bss);
504
505                 atomic_dec(&sdata->bss->num_sta_ps);
506                 __sta_info_clear_tim_bit(sdata->bss, *sta);
507         }
508
509         local->num_sta--;
510         local->sta_generation++;
511
512         if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
513                 rcu_assign_pointer(sdata->u.vlan.sta, NULL);
514
515         if (local->ops->sta_notify) {
516                 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
517                         sdata = container_of(sdata->bss,
518                                              struct ieee80211_sub_if_data,
519                                              u.ap);
520
521                 drv_sta_notify(local, &sdata->vif, STA_NOTIFY_REMOVE,
522                                &(*sta)->sta);
523                 sdata = (*sta)->sdata;
524         }
525
526         if (ieee80211_vif_is_mesh(&sdata->vif)) {
527                 mesh_accept_plinks_update(sdata);
528 #ifdef CONFIG_MAC80211_MESH
529                 del_timer(&(*sta)->plink_timer);
530 #endif
531         }
532
533 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
534         printk(KERN_DEBUG "%s: Removed STA %pM\n",
535                wiphy_name(local->hw.wiphy), (*sta)->sta.addr);
536 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
537
538         /*
539          * Finally, pull caller's reference if the STA is pinned by the
540          * task that is adding the debugfs entries. In that case, we
541          * leave the STA "to be freed".
542          *
543          * The rules are not trivial, but not too complex either:
544          *  (1) pin_status is only modified under the sta_lock
545          *  (2) STAs may only be pinned under the RTNL so that
546          *      sta_info_flush() is guaranteed to actually destroy
547          *      all STAs that are active for a given interface, this
548          *      is required for correctness because otherwise we
549          *      could notify a driver that an interface is going
550          *      away and only after that (!) notify it about a STA
551          *      on that interface going away.
552          *  (3) sta_info_debugfs_add_work() will set the status
553          *      to PINNED when it found an item that needs a new
554          *      debugfs directory created. In that case, that item
555          *      must not be freed although all *RCU* users are done
556          *      with it. Hence, we tell the caller of _unlink()
557          *      that the item is already gone (as can happen when
558          *      two tasks try to unlink/destroy at the same time)
559          *  (4) We set the pin_status to DESTROY here when we
560          *      find such an item.
561          *  (5) sta_info_debugfs_add_work() will reset the pin_status
562          *      from PINNED to NORMAL when it is done with the item,
563          *      but will check for DESTROY before resetting it in
564          *      which case it will free the item.
565          */
566         if ((*sta)->pin_status == STA_INFO_PIN_STAT_PINNED) {
567                 (*sta)->pin_status = STA_INFO_PIN_STAT_DESTROY;
568                 *sta = NULL;
569                 return;
570         }
571 }
572
573 void sta_info_unlink(struct sta_info **sta)
574 {
575         struct ieee80211_local *local = (*sta)->local;
576         unsigned long flags;
577
578         spin_lock_irqsave(&local->sta_lock, flags);
579         __sta_info_unlink(sta);
580         spin_unlock_irqrestore(&local->sta_lock, flags);
581 }
582
583 static int sta_info_buffer_expired(struct sta_info *sta,
584                                    struct sk_buff *skb)
585 {
586         struct ieee80211_tx_info *info;
587         int timeout;
588
589         if (!skb)
590                 return 0;
591
592         info = IEEE80211_SKB_CB(skb);
593
594         /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
595         timeout = (sta->listen_interval *
596                    sta->sdata->vif.bss_conf.beacon_int *
597                    32 / 15625) * HZ;
598         if (timeout < STA_TX_BUFFER_EXPIRE)
599                 timeout = STA_TX_BUFFER_EXPIRE;
600         return time_after(jiffies, info->control.jiffies + timeout);
601 }
602
603
604 static void sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
605                                              struct sta_info *sta)
606 {
607         unsigned long flags;
608         struct sk_buff *skb;
609         struct ieee80211_sub_if_data *sdata;
610
611         if (skb_queue_empty(&sta->ps_tx_buf))
612                 return;
613
614         for (;;) {
615                 spin_lock_irqsave(&sta->ps_tx_buf.lock, flags);
616                 skb = skb_peek(&sta->ps_tx_buf);
617                 if (sta_info_buffer_expired(sta, skb))
618                         skb = __skb_dequeue(&sta->ps_tx_buf);
619                 else
620                         skb = NULL;
621                 spin_unlock_irqrestore(&sta->ps_tx_buf.lock, flags);
622
623                 if (!skb)
624                         break;
625
626                 sdata = sta->sdata;
627                 local->total_ps_buffered--;
628 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
629                 printk(KERN_DEBUG "Buffered frame expired (STA %pM)\n",
630                        sta->sta.addr);
631 #endif
632                 dev_kfree_skb(skb);
633
634                 if (skb_queue_empty(&sta->ps_tx_buf))
635                         sta_info_clear_tim_bit(sta);
636         }
637 }
638
639
640 static void sta_info_cleanup(unsigned long data)
641 {
642         struct ieee80211_local *local = (struct ieee80211_local *) data;
643         struct sta_info *sta;
644
645         rcu_read_lock();
646         list_for_each_entry_rcu(sta, &local->sta_list, list)
647                 sta_info_cleanup_expire_buffered(local, sta);
648         rcu_read_unlock();
649
650         if (local->quiescing)
651                 return;
652
653         local->sta_cleanup.expires =
654                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
655         add_timer(&local->sta_cleanup);
656 }
657
658 #ifdef CONFIG_MAC80211_DEBUGFS
659 /*
660  * See comment in __sta_info_unlink,
661  * caller must hold local->sta_lock.
662  */
663 static void __sta_info_pin(struct sta_info *sta)
664 {
665         WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_NORMAL);
666         sta->pin_status = STA_INFO_PIN_STAT_PINNED;
667 }
668
669 /*
670  * See comment in __sta_info_unlink, returns sta if it
671  * needs to be destroyed.
672  */
673 static struct sta_info *__sta_info_unpin(struct sta_info *sta)
674 {
675         struct sta_info *ret = NULL;
676         unsigned long flags;
677
678         spin_lock_irqsave(&sta->local->sta_lock, flags);
679         WARN_ON(sta->pin_status != STA_INFO_PIN_STAT_DESTROY &&
680                 sta->pin_status != STA_INFO_PIN_STAT_PINNED);
681         if (sta->pin_status == STA_INFO_PIN_STAT_DESTROY)
682                 ret = sta;
683         sta->pin_status = STA_INFO_PIN_STAT_NORMAL;
684         spin_unlock_irqrestore(&sta->local->sta_lock, flags);
685
686         return ret;
687 }
688
689 static void sta_info_debugfs_add_work(struct work_struct *work)
690 {
691         struct ieee80211_local *local =
692                 container_of(work, struct ieee80211_local, sta_debugfs_add);
693         struct sta_info *sta, *tmp;
694         unsigned long flags;
695
696         /* We need to keep the RTNL across the whole pinned status. */
697         rtnl_lock();
698         while (1) {
699                 sta = NULL;
700
701                 spin_lock_irqsave(&local->sta_lock, flags);
702                 list_for_each_entry(tmp, &local->sta_list, list) {
703                         /*
704                          * debugfs.add_has_run will be set by
705                          * ieee80211_sta_debugfs_add regardless
706                          * of what else it does.
707                          */
708                         if (!tmp->debugfs.add_has_run) {
709                                 sta = tmp;
710                                 __sta_info_pin(sta);
711                                 break;
712                         }
713                 }
714                 spin_unlock_irqrestore(&local->sta_lock, flags);
715
716                 if (!sta)
717                         break;
718
719                 ieee80211_sta_debugfs_add(sta);
720                 rate_control_add_sta_debugfs(sta);
721
722                 sta = __sta_info_unpin(sta);
723                 sta_info_destroy(sta);
724         }
725         rtnl_unlock();
726 }
727 #endif
728
729 void sta_info_init(struct ieee80211_local *local)
730 {
731         spin_lock_init(&local->sta_lock);
732         INIT_LIST_HEAD(&local->sta_list);
733
734         setup_timer(&local->sta_cleanup, sta_info_cleanup,
735                     (unsigned long)local);
736         local->sta_cleanup.expires =
737                 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL);
738
739 #ifdef CONFIG_MAC80211_DEBUGFS
740         INIT_WORK(&local->sta_debugfs_add, sta_info_debugfs_add_work);
741 #endif
742 }
743
744 int sta_info_start(struct ieee80211_local *local)
745 {
746         add_timer(&local->sta_cleanup);
747         return 0;
748 }
749
750 void sta_info_stop(struct ieee80211_local *local)
751 {
752         del_timer(&local->sta_cleanup);
753 #ifdef CONFIG_MAC80211_DEBUGFS
754         /*
755          * Make sure the debugfs adding work isn't pending after this
756          * because we're about to be destroyed. It doesn't matter
757          * whether it ran or not since we're going to flush all STAs
758          * anyway.
759          */
760         cancel_work_sync(&local->sta_debugfs_add);
761 #endif
762
763         sta_info_flush(local, NULL);
764 }
765
766 /**
767  * sta_info_flush - flush matching STA entries from the STA table
768  *
769  * Returns the number of removed STA entries.
770  *
771  * @local: local interface data
772  * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
773  */
774 int sta_info_flush(struct ieee80211_local *local,
775                    struct ieee80211_sub_if_data *sdata)
776 {
777         struct sta_info *sta, *tmp;
778         LIST_HEAD(tmp_list);
779         int ret = 0;
780         unsigned long flags;
781
782         might_sleep();
783
784         spin_lock_irqsave(&local->sta_lock, flags);
785         list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
786                 if (!sdata || sdata == sta->sdata) {
787                         __sta_info_unlink(&sta);
788                         if (sta) {
789                                 list_add_tail(&sta->list, &tmp_list);
790                                 ret++;
791                         }
792                 }
793         }
794         spin_unlock_irqrestore(&local->sta_lock, flags);
795
796         list_for_each_entry_safe(sta, tmp, &tmp_list, list)
797                 sta_info_destroy(sta);
798
799         return ret;
800 }
801
802 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
803                           unsigned long exp_time)
804 {
805         struct ieee80211_local *local = sdata->local;
806         struct sta_info *sta, *tmp;
807         LIST_HEAD(tmp_list);
808         unsigned long flags;
809
810         spin_lock_irqsave(&local->sta_lock, flags);
811         list_for_each_entry_safe(sta, tmp, &local->sta_list, list)
812                 if (time_after(jiffies, sta->last_rx + exp_time)) {
813 #ifdef CONFIG_MAC80211_IBSS_DEBUG
814                         printk(KERN_DEBUG "%s: expiring inactive STA %pM\n",
815                                sdata->dev->name, sta->sta.addr);
816 #endif
817                         __sta_info_unlink(&sta);
818                         if (sta)
819                                 list_add(&sta->list, &tmp_list);
820                 }
821         spin_unlock_irqrestore(&local->sta_lock, flags);
822
823         list_for_each_entry_safe(sta, tmp, &tmp_list, list)
824                 sta_info_destroy(sta);
825 }
826
827 struct ieee80211_sta *ieee80211_find_sta_by_hw(struct ieee80211_hw *hw,
828                                                const u8 *addr)
829 {
830         struct sta_info *sta = sta_info_get(hw_to_local(hw), addr);
831
832         if (!sta)
833                 return NULL;
834         return &sta->sta;
835 }
836 EXPORT_SYMBOL_GPL(ieee80211_find_sta_by_hw);
837
838 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
839                                          const u8 *addr)
840 {
841         struct ieee80211_sub_if_data *sdata;
842
843         if (!vif)
844                 return NULL;
845
846         sdata = vif_to_sdata(vif);
847
848         return ieee80211_find_sta_by_hw(&sdata->local->hw, addr);
849 }
850 EXPORT_SYMBOL(ieee80211_find_sta);
851
852 /* powersave support code */
853 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta)
854 {
855         struct ieee80211_sub_if_data *sdata = sta->sdata;
856         struct ieee80211_local *local = sdata->local;
857         int sent, buffered;
858
859         drv_sta_notify(local, &sdata->vif, STA_NOTIFY_AWAKE, &sta->sta);
860
861         if (!skb_queue_empty(&sta->ps_tx_buf))
862                 sta_info_clear_tim_bit(sta);
863
864         /* Send all buffered frames to the station */
865         sent = ieee80211_add_pending_skbs(local, &sta->tx_filtered);
866         buffered = ieee80211_add_pending_skbs(local, &sta->ps_tx_buf);
867         sent += buffered;
868         local->total_ps_buffered -= buffered;
869
870 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
871         printk(KERN_DEBUG "%s: STA %pM aid %d sending %d filtered/%d PS frames "
872                "since STA not sleeping anymore\n", sdata->dev->name,
873                sta->sta.addr, sta->sta.aid, sent - buffered, buffered);
874 #endif /* CONFIG_MAC80211_VERBOSE_PS_DEBUG */
875 }
876
877 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta)
878 {
879         struct ieee80211_sub_if_data *sdata = sta->sdata;
880         struct ieee80211_local *local = sdata->local;
881         struct sk_buff *skb;
882         int no_pending_pkts;
883
884         skb = skb_dequeue(&sta->tx_filtered);
885         if (!skb) {
886                 skb = skb_dequeue(&sta->ps_tx_buf);
887                 if (skb)
888                         local->total_ps_buffered--;
889         }
890         no_pending_pkts = skb_queue_empty(&sta->tx_filtered) &&
891                 skb_queue_empty(&sta->ps_tx_buf);
892
893         if (skb) {
894                 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
895                 struct ieee80211_hdr *hdr =
896                         (struct ieee80211_hdr *) skb->data;
897
898                 /*
899                  * Tell TX path to send this frame even though the STA may
900                  * still remain is PS mode after this frame exchange.
901                  */
902                 info->flags |= IEEE80211_TX_CTL_PSPOLL_RESPONSE;
903
904 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
905                 printk(KERN_DEBUG "STA %pM aid %d: PS Poll (entries after %d)\n",
906                        sta->sta.addr, sta->sta.aid,
907                        skb_queue_len(&sta->ps_tx_buf));
908 #endif /* CONFIG_MAC80211_VERBOSE_PS_DEBUG */
909
910                 /* Use MoreData flag to indicate whether there are more
911                  * buffered frames for this STA */
912                 if (no_pending_pkts)
913                         hdr->frame_control &= cpu_to_le16(~IEEE80211_FCTL_MOREDATA);
914                 else
915                         hdr->frame_control |= cpu_to_le16(IEEE80211_FCTL_MOREDATA);
916
917                 ieee80211_add_pending_skb(local, skb);
918
919                 if (no_pending_pkts)
920                         sta_info_clear_tim_bit(sta);
921 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
922         } else {
923                 /*
924                  * FIXME: This can be the result of a race condition between
925                  *        us expiring a frame and the station polling for it.
926                  *        Should we send it a null-func frame indicating we
927                  *        have nothing buffered for it?
928                  */
929                 printk(KERN_DEBUG "%s: STA %pM sent PS Poll even "
930                        "though there are no buffered frames for it\n",
931                        sdata->dev->name, sta->sta.addr);
932 #endif /* CONFIG_MAC80211_VERBOSE_PS_DEBUG */
933         }
934 }
935
936 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
937                                struct ieee80211_sta *pubsta, bool block)
938 {
939         struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
940
941         if (block)
942                 set_sta_flags(sta, WLAN_STA_PS_DRIVER);
943         else
944                 ieee80211_queue_work(hw, &sta->drv_unblock_wk);
945 }
946 EXPORT_SYMBOL(ieee80211_sta_block_awake);