2 * Copyright 2002-2005, Instant802 Networks, Inc.
3 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
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.
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>
20 #include <net/mac80211.h>
21 #include "ieee80211_i.h"
22 #include "driver-ops.h"
25 #include "debugfs_sta.h"
30 * DOC: STA information lifetime rules
32 * STA info structures (&struct sta_info) are managed in a hash table
33 * for faster lookup and a list for iteration. They are managed using
34 * RCU, i.e. access to the list and hash table is protected by RCU.
36 * Upon allocating a STA info structure with sta_info_alloc(), the caller
37 * owns that structure. It must then insert it into the hash table using
38 * either sta_info_insert() or sta_info_insert_rcu(); only in the latter
39 * case (which acquires an rcu read section but must not be called from
40 * within one) will the pointer still be valid after the call. Note that
41 * the caller may not do much with the STA info before inserting it, in
42 * particular, it may not start any mesh peer link management or add
45 * When the insertion fails (sta_info_insert()) returns non-zero), the
46 * structure will have been freed by sta_info_insert()!
48 * Station entries are added by mac80211 when you establish a link with a
49 * peer. This means different things for the different type of interfaces
50 * we support. For a regular station this mean we add the AP sta when we
51 * receive an association response from the AP. For IBSS this occurs when
52 * get to know about a peer on the same IBSS. For WDS we add the sta for
53 * the peer immediately upon device open. When using AP mode we add stations
54 * for each respective station upon request from userspace through nl80211.
56 * In order to remove a STA info structure, various sta_info_destroy_*()
57 * calls are available.
59 * There is no concept of ownership on a STA entry, each structure is
60 * owned by the global hash table/list until it is removed. All users of
61 * the structure need to be RCU protected so that the structure won't be
62 * freed before they are done using it.
65 /* Caller must hold local->sta_lock */
66 static int sta_info_hash_del(struct ieee80211_local *local,
71 s = rcu_dereference_protected(local->sta_hash[STA_HASH(sta->sta.addr)],
72 lockdep_is_held(&local->sta_lock));
76 RCU_INIT_POINTER(local->sta_hash[STA_HASH(sta->sta.addr)],
81 while (rcu_access_pointer(s->hnext) &&
82 rcu_access_pointer(s->hnext) != sta)
83 s = rcu_dereference_protected(s->hnext,
84 lockdep_is_held(&local->sta_lock));
85 if (rcu_access_pointer(s->hnext)) {
86 RCU_INIT_POINTER(s->hnext, sta->hnext);
93 /* protected by RCU */
94 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
97 struct ieee80211_local *local = sdata->local;
100 sta = rcu_dereference_check(local->sta_hash[STA_HASH(addr)],
101 lockdep_is_held(&local->sta_lock) ||
102 lockdep_is_held(&local->sta_mtx));
104 if (sta->sdata == sdata && !sta->dummy &&
105 memcmp(sta->sta.addr, addr, ETH_ALEN) == 0)
107 sta = rcu_dereference_check(sta->hnext,
108 lockdep_is_held(&local->sta_lock) ||
109 lockdep_is_held(&local->sta_mtx));
114 /* get a station info entry even if it is a dummy station*/
115 struct sta_info *sta_info_get_rx(struct ieee80211_sub_if_data *sdata,
118 struct ieee80211_local *local = sdata->local;
119 struct sta_info *sta;
121 sta = rcu_dereference_check(local->sta_hash[STA_HASH(addr)],
122 lockdep_is_held(&local->sta_lock) ||
123 lockdep_is_held(&local->sta_mtx));
125 if (sta->sdata == sdata &&
126 memcmp(sta->sta.addr, addr, ETH_ALEN) == 0)
128 sta = rcu_dereference_check(sta->hnext,
129 lockdep_is_held(&local->sta_lock) ||
130 lockdep_is_held(&local->sta_mtx));
136 * Get sta info either from the specified interface
137 * or from one of its vlans
139 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
142 struct ieee80211_local *local = sdata->local;
143 struct sta_info *sta;
145 sta = rcu_dereference_check(local->sta_hash[STA_HASH(addr)],
146 lockdep_is_held(&local->sta_lock) ||
147 lockdep_is_held(&local->sta_mtx));
149 if ((sta->sdata == sdata ||
150 (sta->sdata->bss && sta->sdata->bss == sdata->bss)) &&
152 memcmp(sta->sta.addr, addr, ETH_ALEN) == 0)
154 sta = rcu_dereference_check(sta->hnext,
155 lockdep_is_held(&local->sta_lock) ||
156 lockdep_is_held(&local->sta_mtx));
162 * Get sta info either from the specified interface
163 * or from one of its vlans (including dummy stations)
165 struct sta_info *sta_info_get_bss_rx(struct ieee80211_sub_if_data *sdata,
168 struct ieee80211_local *local = sdata->local;
169 struct sta_info *sta;
171 sta = rcu_dereference_check(local->sta_hash[STA_HASH(addr)],
172 lockdep_is_held(&local->sta_lock) ||
173 lockdep_is_held(&local->sta_mtx));
175 if ((sta->sdata == sdata ||
176 (sta->sdata->bss && sta->sdata->bss == sdata->bss)) &&
177 memcmp(sta->sta.addr, addr, ETH_ALEN) == 0)
179 sta = rcu_dereference_check(sta->hnext,
180 lockdep_is_held(&local->sta_lock) ||
181 lockdep_is_held(&local->sta_mtx));
186 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
189 struct ieee80211_local *local = sdata->local;
190 struct sta_info *sta;
193 list_for_each_entry_rcu(sta, &local->sta_list, list) {
194 if (sdata != sta->sdata)
207 * __sta_info_free - internal STA free helper
209 * @local: pointer to the global information
210 * @sta: STA info to free
212 * This function must undo everything done by sta_info_alloc()
213 * that may happen before sta_info_insert().
215 static void __sta_info_free(struct ieee80211_local *local,
216 struct sta_info *sta)
218 if (sta->rate_ctrl) {
219 rate_control_free_sta(sta);
220 rate_control_put(sta->rate_ctrl);
223 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
224 wiphy_debug(local->hw.wiphy, "Destroyed STA %pM\n", sta->sta.addr);
225 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
230 /* Caller must hold local->sta_lock */
231 static void sta_info_hash_add(struct ieee80211_local *local,
232 struct sta_info *sta)
234 sta->hnext = local->sta_hash[STA_HASH(sta->sta.addr)];
235 RCU_INIT_POINTER(local->sta_hash[STA_HASH(sta->sta.addr)], sta);
238 static void sta_unblock(struct work_struct *wk)
240 struct sta_info *sta;
242 sta = container_of(wk, struct sta_info, drv_unblock_wk);
247 if (!test_sta_flag(sta, WLAN_STA_PS_STA))
248 ieee80211_sta_ps_deliver_wakeup(sta);
249 else if (test_and_clear_sta_flag(sta, WLAN_STA_PSPOLL)) {
250 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
253 ieee80211_sta_ps_deliver_poll_response(sta);
255 } else if (test_and_clear_sta_flag(sta, WLAN_STA_UAPSD)) {
256 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
259 ieee80211_sta_ps_deliver_uapsd(sta);
262 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
265 static int sta_prepare_rate_control(struct ieee80211_local *local,
266 struct sta_info *sta, gfp_t gfp)
268 if (local->hw.flags & IEEE80211_HW_HAS_RATE_CONTROL)
271 sta->rate_ctrl = rate_control_get(local->rate_ctrl);
272 sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
274 if (!sta->rate_ctrl_priv) {
275 rate_control_put(sta->rate_ctrl);
282 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
285 struct ieee80211_local *local = sdata->local;
286 struct sta_info *sta;
287 struct timespec uptime;
290 sta = kzalloc(sizeof(*sta) + local->hw.sta_data_size, gfp);
294 spin_lock_init(&sta->lock);
295 INIT_WORK(&sta->drv_unblock_wk, sta_unblock);
296 INIT_WORK(&sta->ampdu_mlme.work, ieee80211_ba_session_work);
297 mutex_init(&sta->ampdu_mlme.mtx);
299 memcpy(sta->sta.addr, addr, ETH_ALEN);
302 sta->last_rx = jiffies;
304 do_posix_clock_monotonic_gettime(&uptime);
305 sta->last_connected = uptime.tv_sec;
306 ewma_init(&sta->avg_signal, 1024, 8);
308 if (sta_prepare_rate_control(local, sta, gfp)) {
313 for (i = 0; i < STA_TID_NUM; i++) {
315 * timer_to_tid must be initialized with identity mapping
316 * to enable session_timer's data differentiation. See
317 * sta_rx_agg_session_timer_expired for usage.
319 sta->timer_to_tid[i] = i;
321 for (i = 0; i < IEEE80211_NUM_ACS; i++) {
322 skb_queue_head_init(&sta->ps_tx_buf[i]);
323 skb_queue_head_init(&sta->tx_filtered[i]);
326 for (i = 0; i < NUM_RX_DATA_QUEUES; i++)
327 sta->last_seq_ctrl[i] = cpu_to_le16(USHRT_MAX);
329 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
330 wiphy_debug(local->hw.wiphy, "Allocated STA %pM\n", sta->sta.addr);
331 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
333 #ifdef CONFIG_MAC80211_MESH
334 sta->plink_state = NL80211_PLINK_LISTEN;
335 init_timer(&sta->plink_timer);
341 static int sta_info_finish_insert(struct sta_info *sta,
342 bool async, bool dummy_reinsert)
344 struct ieee80211_local *local = sta->local;
345 struct ieee80211_sub_if_data *sdata = sta->sdata;
346 struct station_info sinfo;
350 lockdep_assert_held(&local->sta_mtx);
352 if (!sta->dummy || dummy_reinsert) {
354 err = drv_sta_add(local, sdata, &sta->sta);
358 printk(KERN_DEBUG "%s: failed to add IBSS STA %pM to "
359 "driver (%d) - keeping it anyway.\n",
360 sdata->name, sta->sta.addr, err);
362 sta->uploaded = true;
363 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
365 wiphy_debug(local->hw.wiphy,
366 "Finished adding IBSS STA %pM\n",
374 if (!dummy_reinsert) {
377 local->sta_generation++;
380 /* make the station visible */
381 spin_lock_irqsave(&local->sta_lock, flags);
382 sta_info_hash_add(local, sta);
383 spin_unlock_irqrestore(&local->sta_lock, flags);
386 list_add(&sta->list, &local->sta_list);
392 ieee80211_sta_debugfs_add(sta);
393 rate_control_add_sta_debugfs(sta);
395 memset(&sinfo, 0, sizeof(sinfo));
397 sinfo.generation = local->sta_generation;
398 cfg80211_new_sta(sdata->dev, sta->sta.addr, &sinfo, GFP_KERNEL);
404 static void sta_info_finish_pending(struct ieee80211_local *local)
406 struct sta_info *sta;
409 spin_lock_irqsave(&local->sta_lock, flags);
410 while (!list_empty(&local->sta_pending_list)) {
411 sta = list_first_entry(&local->sta_pending_list,
412 struct sta_info, list);
413 list_del(&sta->list);
414 spin_unlock_irqrestore(&local->sta_lock, flags);
416 sta_info_finish_insert(sta, true, false);
418 spin_lock_irqsave(&local->sta_lock, flags);
420 spin_unlock_irqrestore(&local->sta_lock, flags);
423 static void sta_info_finish_work(struct work_struct *work)
425 struct ieee80211_local *local =
426 container_of(work, struct ieee80211_local, sta_finish_work);
428 mutex_lock(&local->sta_mtx);
429 sta_info_finish_pending(local);
430 mutex_unlock(&local->sta_mtx);
433 static int sta_info_insert_check(struct sta_info *sta)
435 struct ieee80211_sub_if_data *sdata = sta->sdata;
438 * Can't be a WARN_ON because it can be triggered through a race:
439 * something inserts a STA (on one CPU) without holding the RTNL
440 * and another CPU turns off the net device.
442 if (unlikely(!ieee80211_sdata_running(sdata)))
445 if (WARN_ON(compare_ether_addr(sta->sta.addr, sdata->vif.addr) == 0 ||
446 is_multicast_ether_addr(sta->sta.addr)))
452 static int sta_info_insert_ibss(struct sta_info *sta) __acquires(RCU)
454 struct ieee80211_local *local = sta->local;
455 struct ieee80211_sub_if_data *sdata = sta->sdata;
458 spin_lock_irqsave(&local->sta_lock, flags);
459 /* check if STA exists already */
460 if (sta_info_get_bss_rx(sdata, sta->sta.addr)) {
461 spin_unlock_irqrestore(&local->sta_lock, flags);
467 local->sta_generation++;
469 sta_info_hash_add(local, sta);
471 list_add_tail(&sta->list, &local->sta_pending_list);
474 spin_unlock_irqrestore(&local->sta_lock, flags);
476 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
477 wiphy_debug(local->hw.wiphy, "Added IBSS STA %pM\n",
479 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
481 ieee80211_queue_work(&local->hw, &local->sta_finish_work);
487 * should be called with sta_mtx locked
488 * this function replaces the mutex lock
491 static int sta_info_insert_non_ibss(struct sta_info *sta) __acquires(RCU)
493 struct ieee80211_local *local = sta->local;
494 struct ieee80211_sub_if_data *sdata = sta->sdata;
496 struct sta_info *exist_sta;
497 bool dummy_reinsert = false;
500 lockdep_assert_held(&local->sta_mtx);
503 * On first glance, this will look racy, because the code
504 * in this function, which inserts a station with sleeping,
505 * unlocks the sta_lock between checking existence in the
506 * hash table and inserting into it.
508 * However, it is not racy against itself because it keeps
512 spin_lock_irqsave(&local->sta_lock, flags);
514 * check if STA exists already.
515 * only accept a scenario of a second call to sta_info_insert_non_ibss
516 * with a dummy station entry that was inserted earlier
517 * in that case - assume that the dummy station flag should
520 exist_sta = sta_info_get_bss_rx(sdata, sta->sta.addr);
522 if (exist_sta == sta && sta->dummy) {
523 dummy_reinsert = true;
525 spin_unlock_irqrestore(&local->sta_lock, flags);
526 mutex_unlock(&local->sta_mtx);
532 spin_unlock_irqrestore(&local->sta_lock, flags);
534 err = sta_info_finish_insert(sta, false, dummy_reinsert);
536 mutex_unlock(&local->sta_mtx);
541 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
542 wiphy_debug(local->hw.wiphy, "Inserted %sSTA %pM\n",
543 sta->dummy ? "dummy " : "", sta->sta.addr);
544 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
546 /* move reference to rcu-protected */
548 mutex_unlock(&local->sta_mtx);
550 if (ieee80211_vif_is_mesh(&sdata->vif))
551 mesh_accept_plinks_update(sdata);
556 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU)
558 struct ieee80211_local *local = sta->local;
559 struct ieee80211_sub_if_data *sdata = sta->sdata;
562 err = sta_info_insert_check(sta);
569 * In ad-hoc mode, we sometimes need to insert stations
570 * from tasklet context from the RX path. To avoid races,
571 * always do so in that case -- see the comment below.
573 if (sdata->vif.type == NL80211_IFTYPE_ADHOC) {
574 err = sta_info_insert_ibss(sta);
582 * It might seem that the function called below is in race against
583 * the function call above that atomically inserts the station... That,
584 * however, is not true because the above code can only
585 * be invoked for IBSS interfaces, and the below code will
586 * not be -- and the two do not race against each other as
587 * the hash table also keys off the interface.
592 mutex_lock(&local->sta_mtx);
594 err = sta_info_insert_non_ibss(sta);
601 __sta_info_free(local, sta);
605 int sta_info_insert(struct sta_info *sta)
607 int err = sta_info_insert_rcu(sta);
614 /* Caller must hold sta->local->sta_mtx */
615 int sta_info_reinsert(struct sta_info *sta)
617 struct ieee80211_local *local = sta->local;
620 err = sta_info_insert_check(sta);
622 mutex_unlock(&local->sta_mtx);
628 err = sta_info_insert_non_ibss(sta);
633 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
636 * This format has been mandated by the IEEE specifications,
637 * so this line may not be changed to use the __set_bit() format.
639 bss->tim[aid / 8] |= (1 << (aid % 8));
642 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
645 * This format has been mandated by the IEEE specifications,
646 * so this line may not be changed to use the __clear_bit() format.
648 bss->tim[aid / 8] &= ~(1 << (aid % 8));
651 static unsigned long ieee80211_tids_for_ac(int ac)
653 /* If we ever support TIDs > 7, this obviously needs to be adjusted */
655 case IEEE80211_AC_VO:
656 return BIT(6) | BIT(7);
657 case IEEE80211_AC_VI:
658 return BIT(4) | BIT(5);
659 case IEEE80211_AC_BE:
660 return BIT(0) | BIT(3);
661 case IEEE80211_AC_BK:
662 return BIT(1) | BIT(2);
669 void sta_info_recalc_tim(struct sta_info *sta)
671 struct ieee80211_local *local = sta->local;
672 struct ieee80211_if_ap *bss = sta->sdata->bss;
674 bool indicate_tim = false;
675 u8 ignore_for_tim = sta->sta.uapsd_queues;
678 if (WARN_ON_ONCE(!sta->sdata->bss))
681 /* No need to do anything if the driver does all */
682 if (local->hw.flags & IEEE80211_HW_AP_LINK_PS)
689 * If all ACs are delivery-enabled then we should build
690 * the TIM bit for all ACs anyway; if only some are then
691 * we ignore those and build the TIM bit using only the
694 if (ignore_for_tim == BIT(IEEE80211_NUM_ACS) - 1)
697 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
700 if (ignore_for_tim & BIT(ac))
703 indicate_tim |= !skb_queue_empty(&sta->tx_filtered[ac]) ||
704 !skb_queue_empty(&sta->ps_tx_buf[ac]);
708 tids = ieee80211_tids_for_ac(ac);
711 sta->driver_buffered_tids & tids;
715 spin_lock_irqsave(&local->sta_lock, flags);
718 __bss_tim_set(bss, sta->sta.aid);
720 __bss_tim_clear(bss, sta->sta.aid);
722 if (local->ops->set_tim) {
723 local->tim_in_locked_section = true;
724 drv_set_tim(local, &sta->sta, indicate_tim);
725 local->tim_in_locked_section = false;
728 spin_unlock_irqrestore(&local->sta_lock, flags);
731 static bool sta_info_buffer_expired(struct sta_info *sta, struct sk_buff *skb)
733 struct ieee80211_tx_info *info;
739 info = IEEE80211_SKB_CB(skb);
741 /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
742 timeout = (sta->listen_interval *
743 sta->sdata->vif.bss_conf.beacon_int *
745 if (timeout < STA_TX_BUFFER_EXPIRE)
746 timeout = STA_TX_BUFFER_EXPIRE;
747 return time_after(jiffies, info->control.jiffies + timeout);
751 static bool sta_info_cleanup_expire_buffered_ac(struct ieee80211_local *local,
752 struct sta_info *sta, int ac)
758 * First check for frames that should expire on the filtered
759 * queue. Frames here were rejected by the driver and are on
760 * a separate queue to avoid reordering with normal PS-buffered
761 * frames. They also aren't accounted for right now in the
762 * total_ps_buffered counter.
765 spin_lock_irqsave(&sta->tx_filtered[ac].lock, flags);
766 skb = skb_peek(&sta->tx_filtered[ac]);
767 if (sta_info_buffer_expired(sta, skb))
768 skb = __skb_dequeue(&sta->tx_filtered[ac]);
771 spin_unlock_irqrestore(&sta->tx_filtered[ac].lock, flags);
774 * Frames are queued in order, so if this one
775 * hasn't expired yet we can stop testing. If
776 * we actually reached the end of the queue we
777 * also need to stop, of course.
785 * Now also check the normal PS-buffered queue, this will
786 * only find something if the filtered queue was emptied
787 * since the filtered frames are all before the normal PS
791 spin_lock_irqsave(&sta->ps_tx_buf[ac].lock, flags);
792 skb = skb_peek(&sta->ps_tx_buf[ac]);
793 if (sta_info_buffer_expired(sta, skb))
794 skb = __skb_dequeue(&sta->ps_tx_buf[ac]);
797 spin_unlock_irqrestore(&sta->ps_tx_buf[ac].lock, flags);
800 * frames are queued in order, so if this one
801 * hasn't expired yet (or we reached the end of
802 * the queue) we can stop testing
807 local->total_ps_buffered--;
808 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
809 printk(KERN_DEBUG "Buffered frame expired (STA %pM)\n",
816 * Finally, recalculate the TIM bit for this station -- it might
817 * now be clear because the station was too slow to retrieve its
820 sta_info_recalc_tim(sta);
823 * Return whether there are any frames still buffered, this is
824 * used to check whether the cleanup timer still needs to run,
825 * if there are no frames we don't need to rearm the timer.
827 return !(skb_queue_empty(&sta->ps_tx_buf[ac]) &&
828 skb_queue_empty(&sta->tx_filtered[ac]));
831 static bool sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
832 struct sta_info *sta)
834 bool have_buffered = false;
837 /* This is only necessary for stations on BSS interfaces */
838 if (!sta->sdata->bss)
841 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++)
843 sta_info_cleanup_expire_buffered_ac(local, sta, ac);
845 return have_buffered;
848 static int __must_check __sta_info_destroy(struct sta_info *sta)
850 struct ieee80211_local *local;
851 struct ieee80211_sub_if_data *sdata;
854 struct tid_ampdu_tx *tid_tx;
865 * Before removing the station from the driver and
866 * rate control, it might still start new aggregation
867 * sessions -- block that to make sure the tear-down
868 * will be sufficient.
870 set_sta_flag(sta, WLAN_STA_BLOCK_BA);
871 ieee80211_sta_tear_down_BA_sessions(sta, true);
873 spin_lock_irqsave(&local->sta_lock, flags);
874 ret = sta_info_hash_del(local, sta);
875 /* this might still be the pending list ... which is fine */
877 list_del(&sta->list);
878 spin_unlock_irqrestore(&local->sta_lock, flags);
882 mutex_lock(&local->key_mtx);
883 for (i = 0; i < NUM_DEFAULT_KEYS; i++)
884 __ieee80211_key_free(key_mtx_dereference(local, sta->gtk[i]));
886 __ieee80211_key_free(key_mtx_dereference(local, sta->ptk));
887 mutex_unlock(&local->key_mtx);
891 if (test_sta_flag(sta, WLAN_STA_PS_STA) ||
892 test_sta_flag(sta, WLAN_STA_PS_DRIVER)) {
895 clear_sta_flag(sta, WLAN_STA_PS_STA);
896 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
898 atomic_dec(&sdata->bss->num_sta_ps);
899 sta_info_recalc_tim(sta);
903 local->sta_generation++;
905 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
906 RCU_INIT_POINTER(sdata->u.vlan.sta, NULL);
909 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
910 sdata = container_of(sdata->bss,
911 struct ieee80211_sub_if_data,
913 drv_sta_remove(local, sdata, &sta->sta);
918 * At this point, after we wait for an RCU grace period,
919 * neither mac80211 nor the driver can reference this
920 * sta struct any more except by still existing timers
921 * associated with this station that we clean up below.
925 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
926 local->total_ps_buffered -= skb_queue_len(&sta->ps_tx_buf[ac]);
927 __skb_queue_purge(&sta->ps_tx_buf[ac]);
928 __skb_queue_purge(&sta->tx_filtered[ac]);
931 #ifdef CONFIG_MAC80211_MESH
932 if (ieee80211_vif_is_mesh(&sdata->vif))
933 mesh_accept_plinks_update(sdata);
936 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
937 wiphy_debug(local->hw.wiphy, "Removed STA %pM\n", sta->sta.addr);
938 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
939 cancel_work_sync(&sta->drv_unblock_wk);
941 cfg80211_del_sta(sdata->dev, sta->sta.addr, GFP_KERNEL);
943 rate_control_remove_sta_debugfs(sta);
944 ieee80211_sta_debugfs_remove(sta);
946 #ifdef CONFIG_MAC80211_MESH
947 if (ieee80211_vif_is_mesh(&sta->sdata->vif)) {
948 mesh_plink_deactivate(sta);
949 del_timer_sync(&sta->plink_timer);
953 /* There could be some memory leaks because of ampdu tx pending queue
954 * not being freed before destroying the station info.
956 * Make sure that such queues are purged before freeing the station
958 * TODO: We have to somehow postpone the full destruction
959 * until the aggregation stop completes. Refer
960 * http://thread.gmane.org/gmane.linux.kernel.wireless.general/81936
962 for (i = 0; i < STA_TID_NUM; i++) {
963 if (!sta->ampdu_mlme.tid_tx[i])
965 tid_tx = sta->ampdu_mlme.tid_tx[i];
966 if (skb_queue_len(&tid_tx->pending)) {
967 #ifdef CONFIG_MAC80211_HT_DEBUG
968 wiphy_debug(local->hw.wiphy, "TX A-MPDU purging %d "
969 "packets for tid=%d\n",
970 skb_queue_len(&tid_tx->pending), i);
971 #endif /* CONFIG_MAC80211_HT_DEBUG */
972 __skb_queue_purge(&tid_tx->pending);
974 kfree_rcu(tid_tx, rcu_head);
977 __sta_info_free(local, sta);
982 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata, const u8 *addr)
984 struct sta_info *sta;
987 mutex_lock(&sdata->local->sta_mtx);
988 sta = sta_info_get_rx(sdata, addr);
989 ret = __sta_info_destroy(sta);
990 mutex_unlock(&sdata->local->sta_mtx);
995 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
998 struct sta_info *sta;
1001 mutex_lock(&sdata->local->sta_mtx);
1002 sta = sta_info_get_bss_rx(sdata, addr);
1003 ret = __sta_info_destroy(sta);
1004 mutex_unlock(&sdata->local->sta_mtx);
1009 static void sta_info_cleanup(unsigned long data)
1011 struct ieee80211_local *local = (struct ieee80211_local *) data;
1012 struct sta_info *sta;
1013 bool timer_needed = false;
1016 list_for_each_entry_rcu(sta, &local->sta_list, list)
1017 if (sta_info_cleanup_expire_buffered(local, sta))
1018 timer_needed = true;
1021 if (local->quiescing)
1027 mod_timer(&local->sta_cleanup,
1028 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL));
1031 void sta_info_init(struct ieee80211_local *local)
1033 spin_lock_init(&local->sta_lock);
1034 mutex_init(&local->sta_mtx);
1035 INIT_LIST_HEAD(&local->sta_list);
1036 INIT_LIST_HEAD(&local->sta_pending_list);
1037 INIT_WORK(&local->sta_finish_work, sta_info_finish_work);
1039 setup_timer(&local->sta_cleanup, sta_info_cleanup,
1040 (unsigned long)local);
1043 void sta_info_stop(struct ieee80211_local *local)
1045 del_timer(&local->sta_cleanup);
1046 sta_info_flush(local, NULL);
1050 * sta_info_flush - flush matching STA entries from the STA table
1052 * Returns the number of removed STA entries.
1054 * @local: local interface data
1055 * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
1057 int sta_info_flush(struct ieee80211_local *local,
1058 struct ieee80211_sub_if_data *sdata)
1060 struct sta_info *sta, *tmp;
1065 mutex_lock(&local->sta_mtx);
1067 sta_info_finish_pending(local);
1069 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
1070 if (!sdata || sdata == sta->sdata)
1071 WARN_ON(__sta_info_destroy(sta));
1073 mutex_unlock(&local->sta_mtx);
1078 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
1079 unsigned long exp_time)
1081 struct ieee80211_local *local = sdata->local;
1082 struct sta_info *sta, *tmp;
1084 mutex_lock(&local->sta_mtx);
1085 list_for_each_entry_safe(sta, tmp, &local->sta_list, list)
1086 if (time_after(jiffies, sta->last_rx + exp_time)) {
1087 #ifdef CONFIG_MAC80211_IBSS_DEBUG
1088 printk(KERN_DEBUG "%s: expiring inactive STA %pM\n",
1089 sdata->name, sta->sta.addr);
1091 WARN_ON(__sta_info_destroy(sta));
1093 mutex_unlock(&local->sta_mtx);
1096 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
1098 const u8 *localaddr)
1100 struct sta_info *sta, *nxt;
1103 * Just return a random station if localaddr is NULL
1104 * ... first in list.
1106 for_each_sta_info(hw_to_local(hw), addr, sta, nxt) {
1108 compare_ether_addr(sta->sdata->vif.addr, localaddr) != 0)
1117 EXPORT_SYMBOL_GPL(ieee80211_find_sta_by_ifaddr);
1119 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
1122 struct sta_info *sta;
1127 sta = sta_info_get_bss(vif_to_sdata(vif), addr);
1136 EXPORT_SYMBOL(ieee80211_find_sta);
1138 static void clear_sta_ps_flags(void *_sta)
1140 struct sta_info *sta = _sta;
1142 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
1143 clear_sta_flag(sta, WLAN_STA_PS_STA);
1146 /* powersave support code */
1147 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta)
1149 struct ieee80211_sub_if_data *sdata = sta->sdata;
1150 struct ieee80211_local *local = sdata->local;
1151 struct sk_buff_head pending;
1152 int filtered = 0, buffered = 0, ac;
1154 clear_sta_flag(sta, WLAN_STA_SP);
1156 BUILD_BUG_ON(BITS_TO_LONGS(STA_TID_NUM) > 1);
1157 sta->driver_buffered_tids = 0;
1159 if (!(local->hw.flags & IEEE80211_HW_AP_LINK_PS))
1160 drv_sta_notify(local, sdata, STA_NOTIFY_AWAKE, &sta->sta);
1162 skb_queue_head_init(&pending);
1164 /* Send all buffered frames to the station */
1165 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
1166 int count = skb_queue_len(&pending), tmp;
1168 skb_queue_splice_tail_init(&sta->tx_filtered[ac], &pending);
1169 tmp = skb_queue_len(&pending);
1170 filtered += tmp - count;
1173 skb_queue_splice_tail_init(&sta->ps_tx_buf[ac], &pending);
1174 tmp = skb_queue_len(&pending);
1175 buffered += tmp - count;
1178 ieee80211_add_pending_skbs_fn(local, &pending, clear_sta_ps_flags, sta);
1180 local->total_ps_buffered -= buffered;
1182 sta_info_recalc_tim(sta);
1184 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
1185 printk(KERN_DEBUG "%s: STA %pM aid %d sending %d filtered/%d PS frames "
1186 "since STA not sleeping anymore\n", sdata->name,
1187 sta->sta.addr, sta->sta.aid, filtered, buffered);
1188 #endif /* CONFIG_MAC80211_VERBOSE_PS_DEBUG */
1191 static void ieee80211_send_null_response(struct ieee80211_sub_if_data *sdata,
1192 struct sta_info *sta, int tid,
1193 enum ieee80211_frame_release_type reason)
1195 struct ieee80211_local *local = sdata->local;
1196 struct ieee80211_qos_hdr *nullfunc;
1197 struct sk_buff *skb;
1198 int size = sizeof(*nullfunc);
1200 bool qos = test_sta_flag(sta, WLAN_STA_WME);
1201 struct ieee80211_tx_info *info;
1204 fc = cpu_to_le16(IEEE80211_FTYPE_DATA |
1205 IEEE80211_STYPE_QOS_NULLFUNC |
1206 IEEE80211_FCTL_FROMDS);
1209 fc = cpu_to_le16(IEEE80211_FTYPE_DATA |
1210 IEEE80211_STYPE_NULLFUNC |
1211 IEEE80211_FCTL_FROMDS);
1214 skb = dev_alloc_skb(local->hw.extra_tx_headroom + size);
1218 skb_reserve(skb, local->hw.extra_tx_headroom);
1220 nullfunc = (void *) skb_put(skb, size);
1221 nullfunc->frame_control = fc;
1222 nullfunc->duration_id = 0;
1223 memcpy(nullfunc->addr1, sta->sta.addr, ETH_ALEN);
1224 memcpy(nullfunc->addr2, sdata->vif.addr, ETH_ALEN);
1225 memcpy(nullfunc->addr3, sdata->vif.addr, ETH_ALEN);
1227 skb->priority = tid;
1228 skb_set_queue_mapping(skb, ieee802_1d_to_ac[tid]);
1230 nullfunc->qos_ctrl = cpu_to_le16(tid);
1232 if (reason == IEEE80211_FRAME_RELEASE_UAPSD)
1233 nullfunc->qos_ctrl |=
1234 cpu_to_le16(IEEE80211_QOS_CTL_EOSP);
1237 info = IEEE80211_SKB_CB(skb);
1240 * Tell TX path to send this frame even though the
1241 * STA may still remain is PS mode after this frame
1242 * exchange. Also set EOSP to indicate this packet
1243 * ends the poll/service period.
1245 info->flags |= IEEE80211_TX_CTL_POLL_RESPONSE |
1246 IEEE80211_TX_STATUS_EOSP |
1247 IEEE80211_TX_CTL_REQ_TX_STATUS;
1249 drv_allow_buffered_frames(local, sta, BIT(tid), 1, reason, false);
1251 ieee80211_xmit(sdata, skb);
1255 ieee80211_sta_ps_deliver_response(struct sta_info *sta,
1256 int n_frames, u8 ignored_acs,
1257 enum ieee80211_frame_release_type reason)
1259 struct ieee80211_sub_if_data *sdata = sta->sdata;
1260 struct ieee80211_local *local = sdata->local;
1262 bool more_data = false;
1264 unsigned long driver_release_tids = 0;
1265 struct sk_buff_head frames;
1267 /* Service or PS-Poll period starts */
1268 set_sta_flag(sta, WLAN_STA_SP);
1270 __skb_queue_head_init(&frames);
1273 * Get response frame(s) and more data bit for it.
1275 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
1278 if (ignored_acs & BIT(ac))
1281 tids = ieee80211_tids_for_ac(ac);
1284 driver_release_tids = sta->driver_buffered_tids & tids;
1285 if (driver_release_tids) {
1288 struct sk_buff *skb;
1290 while (n_frames > 0) {
1291 skb = skb_dequeue(&sta->tx_filtered[ac]);
1294 &sta->ps_tx_buf[ac]);
1296 local->total_ps_buffered--;
1302 __skb_queue_tail(&frames, skb);
1307 * If the driver has data on more than one TID then
1308 * certainly there's more data if we release just a
1309 * single frame now (from a single TID).
1311 if (reason == IEEE80211_FRAME_RELEASE_PSPOLL &&
1312 hweight16(driver_release_tids) > 1) {
1314 driver_release_tids =
1315 BIT(ffs(driver_release_tids) - 1);
1320 if (!skb_queue_empty(&sta->tx_filtered[ac]) ||
1321 !skb_queue_empty(&sta->ps_tx_buf[ac])) {
1331 * For PS-Poll, this can only happen due to a race condition
1332 * when we set the TIM bit and the station notices it, but
1333 * before it can poll for the frame we expire it.
1335 * For uAPSD, this is said in the standard (11.2.1.5 h):
1336 * At each unscheduled SP for a non-AP STA, the AP shall
1337 * attempt to transmit at least one MSDU or MMPDU, but no
1338 * more than the value specified in the Max SP Length field
1339 * in the QoS Capability element from delivery-enabled ACs,
1340 * that are destined for the non-AP STA.
1342 * Since we have no other MSDU/MMPDU, transmit a QoS null frame.
1345 /* This will evaluate to 1, 3, 5 or 7. */
1346 tid = 7 - ((ffs(~ignored_acs) - 1) << 1);
1348 ieee80211_send_null_response(sdata, sta, tid, reason);
1352 if (!driver_release_tids) {
1353 struct sk_buff_head pending;
1354 struct sk_buff *skb;
1358 skb_queue_head_init(&pending);
1360 while ((skb = __skb_dequeue(&frames))) {
1361 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
1362 struct ieee80211_hdr *hdr = (void *) skb->data;
1368 * Tell TX path to send this frame even though the
1369 * STA may still remain is PS mode after this frame
1372 info->flags |= IEEE80211_TX_CTL_POLL_RESPONSE;
1375 * Use MoreData flag to indicate whether there are
1376 * more buffered frames for this STA
1378 if (more_data || !skb_queue_empty(&frames))
1379 hdr->frame_control |=
1380 cpu_to_le16(IEEE80211_FCTL_MOREDATA);
1382 hdr->frame_control &=
1383 cpu_to_le16(~IEEE80211_FCTL_MOREDATA);
1385 if (ieee80211_is_data_qos(hdr->frame_control) ||
1386 ieee80211_is_qos_nullfunc(hdr->frame_control))
1387 qoshdr = ieee80211_get_qos_ctl(hdr);
1389 /* set EOSP for the frame */
1390 if (reason == IEEE80211_FRAME_RELEASE_UAPSD &&
1391 qoshdr && skb_queue_empty(&frames))
1392 *qoshdr |= IEEE80211_QOS_CTL_EOSP;
1394 info->flags |= IEEE80211_TX_STATUS_EOSP |
1395 IEEE80211_TX_CTL_REQ_TX_STATUS;
1398 tids |= BIT(*qoshdr & IEEE80211_QOS_CTL_TID_MASK);
1402 __skb_queue_tail(&pending, skb);
1405 drv_allow_buffered_frames(local, sta, tids, num,
1408 ieee80211_add_pending_skbs(local, &pending);
1410 sta_info_recalc_tim(sta);
1413 * We need to release a frame that is buffered somewhere in the
1414 * driver ... it'll have to handle that.
1415 * Note that, as per the comment above, it'll also have to see
1416 * if there is more than just one frame on the specific TID that
1417 * we're releasing from, and it needs to set the more-data bit
1418 * accordingly if we tell it that there's no more data. If we do
1419 * tell it there's more data, then of course the more-data bit
1420 * needs to be set anyway.
1422 drv_release_buffered_frames(local, sta, driver_release_tids,
1423 n_frames, reason, more_data);
1426 * Note that we don't recalculate the TIM bit here as it would
1427 * most likely have no effect at all unless the driver told us
1428 * that the TID became empty before returning here from the
1430 * Either way, however, when the driver tells us that the TID
1431 * became empty we'll do the TIM recalculation.
1436 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta)
1438 u8 ignore_for_response = sta->sta.uapsd_queues;
1441 * If all ACs are delivery-enabled then we should reply
1442 * from any of them, if only some are enabled we reply
1443 * only from the non-enabled ones.
1445 if (ignore_for_response == BIT(IEEE80211_NUM_ACS) - 1)
1446 ignore_for_response = 0;
1448 ieee80211_sta_ps_deliver_response(sta, 1, ignore_for_response,
1449 IEEE80211_FRAME_RELEASE_PSPOLL);
1452 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta)
1454 int n_frames = sta->sta.max_sp;
1455 u8 delivery_enabled = sta->sta.uapsd_queues;
1458 * If we ever grow support for TSPEC this might happen if
1459 * the TSPEC update from hostapd comes in between a trigger
1460 * frame setting WLAN_STA_UAPSD in the RX path and this
1461 * actually getting called.
1463 if (!delivery_enabled)
1466 switch (sta->sta.max_sp) {
1477 /* XXX: what is a good value? */
1482 ieee80211_sta_ps_deliver_response(sta, n_frames, ~delivery_enabled,
1483 IEEE80211_FRAME_RELEASE_UAPSD);
1486 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
1487 struct ieee80211_sta *pubsta, bool block)
1489 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1491 trace_api_sta_block_awake(sta->local, pubsta, block);
1494 set_sta_flag(sta, WLAN_STA_PS_DRIVER);
1495 else if (test_sta_flag(sta, WLAN_STA_PS_DRIVER))
1496 ieee80211_queue_work(hw, &sta->drv_unblock_wk);
1498 EXPORT_SYMBOL(ieee80211_sta_block_awake);
1500 void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta *pubsta)
1502 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1503 struct ieee80211_local *local = sta->local;
1504 struct sk_buff *skb;
1505 struct skb_eosp_msg_data *data;
1507 trace_api_eosp(local, pubsta);
1509 skb = alloc_skb(0, GFP_ATOMIC);
1511 /* too bad ... but race is better than loss */
1512 clear_sta_flag(sta, WLAN_STA_SP);
1516 data = (void *)skb->cb;
1517 memcpy(data->sta, pubsta->addr, ETH_ALEN);
1518 memcpy(data->iface, sta->sdata->vif.addr, ETH_ALEN);
1519 skb->pkt_type = IEEE80211_EOSP_MSG;
1520 skb_queue_tail(&local->skb_queue, skb);
1521 tasklet_schedule(&local->tasklet);
1523 EXPORT_SYMBOL(ieee80211_sta_eosp_irqsafe);
1525 void ieee80211_sta_set_buffered(struct ieee80211_sta *pubsta,
1526 u8 tid, bool buffered)
1528 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1530 if (WARN_ON(tid >= STA_TID_NUM))
1534 set_bit(tid, &sta->driver_buffered_tids);
1536 clear_bit(tid, &sta->driver_buffered_tids);
1538 sta_info_recalc_tim(sta);
1540 EXPORT_SYMBOL(ieee80211_sta_set_buffered);