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_mtx */
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_mtx));
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_mtx));
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_mtx));
103 if (sta->sdata == sdata && !sta->dummy &&
104 memcmp(sta->sta.addr, addr, ETH_ALEN) == 0)
106 sta = rcu_dereference_check(sta->hnext,
107 lockdep_is_held(&local->sta_mtx));
112 /* get a station info entry even if it is a dummy station*/
113 struct sta_info *sta_info_get_rx(struct ieee80211_sub_if_data *sdata,
116 struct ieee80211_local *local = sdata->local;
117 struct sta_info *sta;
119 sta = rcu_dereference_check(local->sta_hash[STA_HASH(addr)],
120 lockdep_is_held(&local->sta_mtx));
122 if (sta->sdata == sdata &&
123 memcmp(sta->sta.addr, addr, ETH_ALEN) == 0)
125 sta = rcu_dereference_check(sta->hnext,
126 lockdep_is_held(&local->sta_mtx));
132 * Get sta info either from the specified interface
133 * or from one of its vlans
135 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
138 struct ieee80211_local *local = sdata->local;
139 struct sta_info *sta;
141 sta = rcu_dereference_check(local->sta_hash[STA_HASH(addr)],
142 lockdep_is_held(&local->sta_mtx));
144 if ((sta->sdata == sdata ||
145 (sta->sdata->bss && sta->sdata->bss == sdata->bss)) &&
147 memcmp(sta->sta.addr, addr, ETH_ALEN) == 0)
149 sta = rcu_dereference_check(sta->hnext,
150 lockdep_is_held(&local->sta_mtx));
156 * Get sta info either from the specified interface
157 * or from one of its vlans (including dummy stations)
159 struct sta_info *sta_info_get_bss_rx(struct ieee80211_sub_if_data *sdata,
162 struct ieee80211_local *local = sdata->local;
163 struct sta_info *sta;
165 sta = rcu_dereference_check(local->sta_hash[STA_HASH(addr)],
166 lockdep_is_held(&local->sta_mtx));
168 if ((sta->sdata == sdata ||
169 (sta->sdata->bss && sta->sdata->bss == sdata->bss)) &&
170 memcmp(sta->sta.addr, addr, ETH_ALEN) == 0)
172 sta = rcu_dereference_check(sta->hnext,
173 lockdep_is_held(&local->sta_mtx));
178 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
181 struct ieee80211_local *local = sdata->local;
182 struct sta_info *sta;
185 list_for_each_entry_rcu(sta, &local->sta_list, list) {
186 if (sdata != sta->sdata)
199 * sta_info_free - free STA
201 * @local: pointer to the global information
202 * @sta: STA info to free
204 * This function must undo everything done by sta_info_alloc()
205 * that may happen before sta_info_insert(). It may only be
206 * called when sta_info_insert() has not been attempted (and
207 * if that fails, the station is freed anyway.)
209 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta)
211 if (sta->rate_ctrl) {
212 rate_control_free_sta(sta);
213 rate_control_put(sta->rate_ctrl);
216 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
217 wiphy_debug(local->hw.wiphy, "Destroyed STA %pM\n", sta->sta.addr);
218 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
223 /* Caller must hold local->sta_mtx */
224 static void sta_info_hash_add(struct ieee80211_local *local,
225 struct sta_info *sta)
227 lockdep_assert_held(&local->sta_mtx);
228 sta->hnext = local->sta_hash[STA_HASH(sta->sta.addr)];
229 RCU_INIT_POINTER(local->sta_hash[STA_HASH(sta->sta.addr)], sta);
232 static void sta_unblock(struct work_struct *wk)
234 struct sta_info *sta;
236 sta = container_of(wk, struct sta_info, drv_unblock_wk);
241 if (!test_sta_flag(sta, WLAN_STA_PS_STA))
242 ieee80211_sta_ps_deliver_wakeup(sta);
243 else if (test_and_clear_sta_flag(sta, WLAN_STA_PSPOLL)) {
244 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
247 ieee80211_sta_ps_deliver_poll_response(sta);
249 } else if (test_and_clear_sta_flag(sta, WLAN_STA_UAPSD)) {
250 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
253 ieee80211_sta_ps_deliver_uapsd(sta);
256 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
259 static int sta_prepare_rate_control(struct ieee80211_local *local,
260 struct sta_info *sta, gfp_t gfp)
262 if (local->hw.flags & IEEE80211_HW_HAS_RATE_CONTROL)
265 sta->rate_ctrl = rate_control_get(local->rate_ctrl);
266 sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
268 if (!sta->rate_ctrl_priv) {
269 rate_control_put(sta->rate_ctrl);
276 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
277 const u8 *addr, gfp_t gfp)
279 struct ieee80211_local *local = sdata->local;
280 struct sta_info *sta;
281 struct timespec uptime;
284 sta = kzalloc(sizeof(*sta) + local->hw.sta_data_size, gfp);
288 spin_lock_init(&sta->lock);
289 INIT_WORK(&sta->drv_unblock_wk, sta_unblock);
290 INIT_WORK(&sta->ampdu_mlme.work, ieee80211_ba_session_work);
291 mutex_init(&sta->ampdu_mlme.mtx);
293 memcpy(sta->sta.addr, addr, ETH_ALEN);
296 sta->last_rx = jiffies;
298 do_posix_clock_monotonic_gettime(&uptime);
299 sta->last_connected = uptime.tv_sec;
300 ewma_init(&sta->avg_signal, 1024, 8);
302 if (sta_prepare_rate_control(local, sta, gfp)) {
307 for (i = 0; i < STA_TID_NUM; i++) {
309 * timer_to_tid must be initialized with identity mapping
310 * to enable session_timer's data differentiation. See
311 * sta_rx_agg_session_timer_expired for usage.
313 sta->timer_to_tid[i] = i;
315 for (i = 0; i < IEEE80211_NUM_ACS; i++) {
316 skb_queue_head_init(&sta->ps_tx_buf[i]);
317 skb_queue_head_init(&sta->tx_filtered[i]);
320 for (i = 0; i < NUM_RX_DATA_QUEUES; i++)
321 sta->last_seq_ctrl[i] = cpu_to_le16(USHRT_MAX);
323 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
324 wiphy_debug(local->hw.wiphy, "Allocated STA %pM\n", sta->sta.addr);
325 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
327 #ifdef CONFIG_MAC80211_MESH
328 sta->plink_state = NL80211_PLINK_LISTEN;
329 init_timer(&sta->plink_timer);
335 static int sta_info_insert_check(struct sta_info *sta)
337 struct ieee80211_sub_if_data *sdata = sta->sdata;
340 * Can't be a WARN_ON because it can be triggered through a race:
341 * something inserts a STA (on one CPU) without holding the RTNL
342 * and another CPU turns off the net device.
344 if (unlikely(!ieee80211_sdata_running(sdata)))
347 if (WARN_ON(compare_ether_addr(sta->sta.addr, sdata->vif.addr) == 0 ||
348 is_multicast_ether_addr(sta->sta.addr)))
355 * should be called with sta_mtx locked
356 * this function replaces the mutex lock
359 static int sta_info_insert_finish(struct sta_info *sta) __acquires(RCU)
361 struct ieee80211_local *local = sta->local;
362 struct ieee80211_sub_if_data *sdata = sta->sdata;
363 struct sta_info *exist_sta;
364 bool dummy_reinsert = false;
367 lockdep_assert_held(&local->sta_mtx);
370 * check if STA exists already.
371 * only accept a scenario of a second call to sta_info_insert_finish
372 * with a dummy station entry that was inserted earlier
373 * in that case - assume that the dummy station flag should
376 exist_sta = sta_info_get_bss_rx(sdata, sta->sta.addr);
378 if (exist_sta == sta && sta->dummy) {
379 dummy_reinsert = true;
386 if (!sta->dummy || dummy_reinsert) {
388 err = drv_sta_add(local, sdata, &sta->sta);
390 if (sdata->vif.type != NL80211_IFTYPE_ADHOC)
392 printk(KERN_DEBUG "%s: failed to add IBSS STA %pM to "
393 "driver (%d) - keeping it anyway.\n",
394 sdata->name, sta->sta.addr, err);
396 sta->uploaded = true;
399 if (!dummy_reinsert) {
401 local->sta_generation++;
404 /* make the station visible */
405 sta_info_hash_add(local, sta);
407 list_add(&sta->list, &local->sta_list);
413 struct station_info sinfo;
415 ieee80211_sta_debugfs_add(sta);
416 rate_control_add_sta_debugfs(sta);
418 memset(&sinfo, 0, sizeof(sinfo));
420 sinfo.generation = local->sta_generation;
421 cfg80211_new_sta(sdata->dev, sta->sta.addr, &sinfo, GFP_KERNEL);
424 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
425 wiphy_debug(local->hw.wiphy, "Inserted %sSTA %pM\n",
426 sta->dummy ? "dummy " : "", sta->sta.addr);
427 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
429 /* move reference to rcu-protected */
431 mutex_unlock(&local->sta_mtx);
433 if (ieee80211_vif_is_mesh(&sdata->vif))
434 mesh_accept_plinks_update(sdata);
438 mutex_unlock(&local->sta_mtx);
443 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU)
445 struct ieee80211_local *local = sta->local;
450 err = sta_info_insert_check(sta);
456 mutex_lock(&local->sta_mtx);
458 err = sta_info_insert_finish(sta);
465 sta_info_free(local, sta);
469 int sta_info_insert(struct sta_info *sta)
471 int err = sta_info_insert_rcu(sta);
478 /* Caller must hold sta->local->sta_mtx */
479 int sta_info_reinsert(struct sta_info *sta)
481 struct ieee80211_local *local = sta->local;
484 err = sta_info_insert_check(sta);
486 mutex_unlock(&local->sta_mtx);
492 err = sta_info_insert_finish(sta);
497 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
500 * This format has been mandated by the IEEE specifications,
501 * so this line may not be changed to use the __set_bit() format.
503 bss->tim[aid / 8] |= (1 << (aid % 8));
506 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
509 * This format has been mandated by the IEEE specifications,
510 * so this line may not be changed to use the __clear_bit() format.
512 bss->tim[aid / 8] &= ~(1 << (aid % 8));
515 static unsigned long ieee80211_tids_for_ac(int ac)
517 /* If we ever support TIDs > 7, this obviously needs to be adjusted */
519 case IEEE80211_AC_VO:
520 return BIT(6) | BIT(7);
521 case IEEE80211_AC_VI:
522 return BIT(4) | BIT(5);
523 case IEEE80211_AC_BE:
524 return BIT(0) | BIT(3);
525 case IEEE80211_AC_BK:
526 return BIT(1) | BIT(2);
533 void sta_info_recalc_tim(struct sta_info *sta)
535 struct ieee80211_local *local = sta->local;
536 struct ieee80211_if_ap *bss = sta->sdata->bss;
538 bool indicate_tim = false;
539 u8 ignore_for_tim = sta->sta.uapsd_queues;
542 if (WARN_ON_ONCE(!sta->sdata->bss))
545 /* No need to do anything if the driver does all */
546 if (local->hw.flags & IEEE80211_HW_AP_LINK_PS)
553 * If all ACs are delivery-enabled then we should build
554 * the TIM bit for all ACs anyway; if only some are then
555 * we ignore those and build the TIM bit using only the
558 if (ignore_for_tim == BIT(IEEE80211_NUM_ACS) - 1)
561 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
564 if (ignore_for_tim & BIT(ac))
567 indicate_tim |= !skb_queue_empty(&sta->tx_filtered[ac]) ||
568 !skb_queue_empty(&sta->ps_tx_buf[ac]);
572 tids = ieee80211_tids_for_ac(ac);
575 sta->driver_buffered_tids & tids;
579 spin_lock_irqsave(&local->tim_lock, flags);
582 __bss_tim_set(bss, sta->sta.aid);
584 __bss_tim_clear(bss, sta->sta.aid);
586 if (local->ops->set_tim) {
587 local->tim_in_locked_section = true;
588 drv_set_tim(local, &sta->sta, indicate_tim);
589 local->tim_in_locked_section = false;
592 spin_unlock_irqrestore(&local->tim_lock, flags);
595 static bool sta_info_buffer_expired(struct sta_info *sta, struct sk_buff *skb)
597 struct ieee80211_tx_info *info;
603 info = IEEE80211_SKB_CB(skb);
605 /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
606 timeout = (sta->listen_interval *
607 sta->sdata->vif.bss_conf.beacon_int *
609 if (timeout < STA_TX_BUFFER_EXPIRE)
610 timeout = STA_TX_BUFFER_EXPIRE;
611 return time_after(jiffies, info->control.jiffies + timeout);
615 static bool sta_info_cleanup_expire_buffered_ac(struct ieee80211_local *local,
616 struct sta_info *sta, int ac)
622 * First check for frames that should expire on the filtered
623 * queue. Frames here were rejected by the driver and are on
624 * a separate queue to avoid reordering with normal PS-buffered
625 * frames. They also aren't accounted for right now in the
626 * total_ps_buffered counter.
629 spin_lock_irqsave(&sta->tx_filtered[ac].lock, flags);
630 skb = skb_peek(&sta->tx_filtered[ac]);
631 if (sta_info_buffer_expired(sta, skb))
632 skb = __skb_dequeue(&sta->tx_filtered[ac]);
635 spin_unlock_irqrestore(&sta->tx_filtered[ac].lock, flags);
638 * Frames are queued in order, so if this one
639 * hasn't expired yet we can stop testing. If
640 * we actually reached the end of the queue we
641 * also need to stop, of course.
649 * Now also check the normal PS-buffered queue, this will
650 * only find something if the filtered queue was emptied
651 * since the filtered frames are all before the normal PS
655 spin_lock_irqsave(&sta->ps_tx_buf[ac].lock, flags);
656 skb = skb_peek(&sta->ps_tx_buf[ac]);
657 if (sta_info_buffer_expired(sta, skb))
658 skb = __skb_dequeue(&sta->ps_tx_buf[ac]);
661 spin_unlock_irqrestore(&sta->ps_tx_buf[ac].lock, flags);
664 * frames are queued in order, so if this one
665 * hasn't expired yet (or we reached the end of
666 * the queue) we can stop testing
671 local->total_ps_buffered--;
672 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
673 printk(KERN_DEBUG "Buffered frame expired (STA %pM)\n",
680 * Finally, recalculate the TIM bit for this station -- it might
681 * now be clear because the station was too slow to retrieve its
684 sta_info_recalc_tim(sta);
687 * Return whether there are any frames still buffered, this is
688 * used to check whether the cleanup timer still needs to run,
689 * if there are no frames we don't need to rearm the timer.
691 return !(skb_queue_empty(&sta->ps_tx_buf[ac]) &&
692 skb_queue_empty(&sta->tx_filtered[ac]));
695 static bool sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
696 struct sta_info *sta)
698 bool have_buffered = false;
701 /* This is only necessary for stations on BSS interfaces */
702 if (!sta->sdata->bss)
705 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++)
707 sta_info_cleanup_expire_buffered_ac(local, sta, ac);
709 return have_buffered;
712 static int __must_check __sta_info_destroy(struct sta_info *sta)
714 struct ieee80211_local *local;
715 struct ieee80211_sub_if_data *sdata;
717 struct tid_ampdu_tx *tid_tx;
728 * Before removing the station from the driver and
729 * rate control, it might still start new aggregation
730 * sessions -- block that to make sure the tear-down
731 * will be sufficient.
733 set_sta_flag(sta, WLAN_STA_BLOCK_BA);
734 ieee80211_sta_tear_down_BA_sessions(sta, true);
736 ret = sta_info_hash_del(local, sta);
740 list_del(&sta->list);
742 mutex_lock(&local->key_mtx);
743 for (i = 0; i < NUM_DEFAULT_KEYS; i++)
744 __ieee80211_key_free(key_mtx_dereference(local, sta->gtk[i]));
746 __ieee80211_key_free(key_mtx_dereference(local, sta->ptk));
747 mutex_unlock(&local->key_mtx);
751 if (test_sta_flag(sta, WLAN_STA_PS_STA) ||
752 test_sta_flag(sta, WLAN_STA_PS_DRIVER)) {
755 clear_sta_flag(sta, WLAN_STA_PS_STA);
756 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
758 atomic_dec(&sdata->bss->num_sta_ps);
759 sta_info_recalc_tim(sta);
763 local->sta_generation++;
765 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
766 RCU_INIT_POINTER(sdata->u.vlan.sta, NULL);
768 while (sta->sta_state > IEEE80211_STA_NONE)
769 sta_info_move_state(sta, sta->sta_state - 1);
772 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
773 sdata = container_of(sdata->bss,
774 struct ieee80211_sub_if_data,
776 drv_sta_remove(local, sdata, &sta->sta);
781 * At this point, after we wait for an RCU grace period,
782 * neither mac80211 nor the driver can reference this
783 * sta struct any more except by still existing timers
784 * associated with this station that we clean up below.
788 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
789 local->total_ps_buffered -= skb_queue_len(&sta->ps_tx_buf[ac]);
790 __skb_queue_purge(&sta->ps_tx_buf[ac]);
791 __skb_queue_purge(&sta->tx_filtered[ac]);
794 #ifdef CONFIG_MAC80211_MESH
795 if (ieee80211_vif_is_mesh(&sdata->vif))
796 mesh_accept_plinks_update(sdata);
799 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
800 wiphy_debug(local->hw.wiphy, "Removed STA %pM\n", sta->sta.addr);
801 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
802 cancel_work_sync(&sta->drv_unblock_wk);
804 cfg80211_del_sta(sdata->dev, sta->sta.addr, GFP_KERNEL);
806 rate_control_remove_sta_debugfs(sta);
807 ieee80211_sta_debugfs_remove(sta);
809 #ifdef CONFIG_MAC80211_MESH
810 if (ieee80211_vif_is_mesh(&sta->sdata->vif)) {
811 mesh_plink_deactivate(sta);
812 del_timer_sync(&sta->plink_timer);
816 /* There could be some memory leaks because of ampdu tx pending queue
817 * not being freed before destroying the station info.
819 * Make sure that such queues are purged before freeing the station
821 * TODO: We have to somehow postpone the full destruction
822 * until the aggregation stop completes. Refer
823 * http://thread.gmane.org/gmane.linux.kernel.wireless.general/81936
826 mutex_lock(&sta->ampdu_mlme.mtx);
828 for (i = 0; i < STA_TID_NUM; i++) {
829 tid_tx = rcu_dereference_protected_tid_tx(sta, i);
832 if (skb_queue_len(&tid_tx->pending)) {
833 #ifdef CONFIG_MAC80211_HT_DEBUG
834 wiphy_debug(local->hw.wiphy, "TX A-MPDU purging %d "
835 "packets for tid=%d\n",
836 skb_queue_len(&tid_tx->pending), i);
837 #endif /* CONFIG_MAC80211_HT_DEBUG */
838 __skb_queue_purge(&tid_tx->pending);
840 kfree_rcu(tid_tx, rcu_head);
843 mutex_unlock(&sta->ampdu_mlme.mtx);
845 sta_info_free(local, sta);
850 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata, const u8 *addr)
852 struct sta_info *sta;
855 mutex_lock(&sdata->local->sta_mtx);
856 sta = sta_info_get_rx(sdata, addr);
857 ret = __sta_info_destroy(sta);
858 mutex_unlock(&sdata->local->sta_mtx);
863 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
866 struct sta_info *sta;
869 mutex_lock(&sdata->local->sta_mtx);
870 sta = sta_info_get_bss_rx(sdata, addr);
871 ret = __sta_info_destroy(sta);
872 mutex_unlock(&sdata->local->sta_mtx);
877 static void sta_info_cleanup(unsigned long data)
879 struct ieee80211_local *local = (struct ieee80211_local *) data;
880 struct sta_info *sta;
881 bool timer_needed = false;
884 list_for_each_entry_rcu(sta, &local->sta_list, list)
885 if (sta_info_cleanup_expire_buffered(local, sta))
889 if (local->quiescing)
895 mod_timer(&local->sta_cleanup,
896 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL));
899 void sta_info_init(struct ieee80211_local *local)
901 spin_lock_init(&local->tim_lock);
902 mutex_init(&local->sta_mtx);
903 INIT_LIST_HEAD(&local->sta_list);
905 setup_timer(&local->sta_cleanup, sta_info_cleanup,
906 (unsigned long)local);
909 void sta_info_stop(struct ieee80211_local *local)
911 del_timer(&local->sta_cleanup);
912 sta_info_flush(local, NULL);
916 * sta_info_flush - flush matching STA entries from the STA table
918 * Returns the number of removed STA entries.
920 * @local: local interface data
921 * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
923 int sta_info_flush(struct ieee80211_local *local,
924 struct ieee80211_sub_if_data *sdata)
926 struct sta_info *sta, *tmp;
931 mutex_lock(&local->sta_mtx);
932 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
933 if (!sdata || sdata == sta->sdata)
934 WARN_ON(__sta_info_destroy(sta));
936 mutex_unlock(&local->sta_mtx);
941 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
942 unsigned long exp_time)
944 struct ieee80211_local *local = sdata->local;
945 struct sta_info *sta, *tmp;
947 mutex_lock(&local->sta_mtx);
949 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
950 if (sdata != sta->sdata)
953 if (time_after(jiffies, sta->last_rx + exp_time)) {
954 #ifdef CONFIG_MAC80211_IBSS_DEBUG
955 printk(KERN_DEBUG "%s: expiring inactive STA %pM\n",
956 sdata->name, sta->sta.addr);
958 WARN_ON(__sta_info_destroy(sta));
962 mutex_unlock(&local->sta_mtx);
965 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
969 struct sta_info *sta, *nxt;
972 * Just return a random station if localaddr is NULL
975 for_each_sta_info(hw_to_local(hw), addr, sta, nxt) {
977 compare_ether_addr(sta->sdata->vif.addr, localaddr) != 0)
986 EXPORT_SYMBOL_GPL(ieee80211_find_sta_by_ifaddr);
988 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
991 struct sta_info *sta;
996 sta = sta_info_get_bss(vif_to_sdata(vif), addr);
1005 EXPORT_SYMBOL(ieee80211_find_sta);
1007 static void clear_sta_ps_flags(void *_sta)
1009 struct sta_info *sta = _sta;
1011 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
1012 clear_sta_flag(sta, WLAN_STA_PS_STA);
1015 /* powersave support code */
1016 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta)
1018 struct ieee80211_sub_if_data *sdata = sta->sdata;
1019 struct ieee80211_local *local = sdata->local;
1020 struct sk_buff_head pending;
1021 int filtered = 0, buffered = 0, ac;
1023 clear_sta_flag(sta, WLAN_STA_SP);
1025 BUILD_BUG_ON(BITS_TO_LONGS(STA_TID_NUM) > 1);
1026 sta->driver_buffered_tids = 0;
1028 if (!(local->hw.flags & IEEE80211_HW_AP_LINK_PS))
1029 drv_sta_notify(local, sdata, STA_NOTIFY_AWAKE, &sta->sta);
1031 skb_queue_head_init(&pending);
1033 /* Send all buffered frames to the station */
1034 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
1035 int count = skb_queue_len(&pending), tmp;
1037 skb_queue_splice_tail_init(&sta->tx_filtered[ac], &pending);
1038 tmp = skb_queue_len(&pending);
1039 filtered += tmp - count;
1042 skb_queue_splice_tail_init(&sta->ps_tx_buf[ac], &pending);
1043 tmp = skb_queue_len(&pending);
1044 buffered += tmp - count;
1047 ieee80211_add_pending_skbs_fn(local, &pending, clear_sta_ps_flags, sta);
1049 local->total_ps_buffered -= buffered;
1051 sta_info_recalc_tim(sta);
1053 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
1054 printk(KERN_DEBUG "%s: STA %pM aid %d sending %d filtered/%d PS frames "
1055 "since STA not sleeping anymore\n", sdata->name,
1056 sta->sta.addr, sta->sta.aid, filtered, buffered);
1057 #endif /* CONFIG_MAC80211_VERBOSE_PS_DEBUG */
1060 static void ieee80211_send_null_response(struct ieee80211_sub_if_data *sdata,
1061 struct sta_info *sta, int tid,
1062 enum ieee80211_frame_release_type reason)
1064 struct ieee80211_local *local = sdata->local;
1065 struct ieee80211_qos_hdr *nullfunc;
1066 struct sk_buff *skb;
1067 int size = sizeof(*nullfunc);
1069 bool qos = test_sta_flag(sta, WLAN_STA_WME);
1070 struct ieee80211_tx_info *info;
1073 fc = cpu_to_le16(IEEE80211_FTYPE_DATA |
1074 IEEE80211_STYPE_QOS_NULLFUNC |
1075 IEEE80211_FCTL_FROMDS);
1078 fc = cpu_to_le16(IEEE80211_FTYPE_DATA |
1079 IEEE80211_STYPE_NULLFUNC |
1080 IEEE80211_FCTL_FROMDS);
1083 skb = dev_alloc_skb(local->hw.extra_tx_headroom + size);
1087 skb_reserve(skb, local->hw.extra_tx_headroom);
1089 nullfunc = (void *) skb_put(skb, size);
1090 nullfunc->frame_control = fc;
1091 nullfunc->duration_id = 0;
1092 memcpy(nullfunc->addr1, sta->sta.addr, ETH_ALEN);
1093 memcpy(nullfunc->addr2, sdata->vif.addr, ETH_ALEN);
1094 memcpy(nullfunc->addr3, sdata->vif.addr, ETH_ALEN);
1096 skb->priority = tid;
1097 skb_set_queue_mapping(skb, ieee802_1d_to_ac[tid]);
1099 nullfunc->qos_ctrl = cpu_to_le16(tid);
1101 if (reason == IEEE80211_FRAME_RELEASE_UAPSD)
1102 nullfunc->qos_ctrl |=
1103 cpu_to_le16(IEEE80211_QOS_CTL_EOSP);
1106 info = IEEE80211_SKB_CB(skb);
1109 * Tell TX path to send this frame even though the
1110 * STA may still remain is PS mode after this frame
1111 * exchange. Also set EOSP to indicate this packet
1112 * ends the poll/service period.
1114 info->flags |= IEEE80211_TX_CTL_POLL_RESPONSE |
1115 IEEE80211_TX_STATUS_EOSP |
1116 IEEE80211_TX_CTL_REQ_TX_STATUS;
1118 drv_allow_buffered_frames(local, sta, BIT(tid), 1, reason, false);
1120 ieee80211_xmit(sdata, skb);
1124 ieee80211_sta_ps_deliver_response(struct sta_info *sta,
1125 int n_frames, u8 ignored_acs,
1126 enum ieee80211_frame_release_type reason)
1128 struct ieee80211_sub_if_data *sdata = sta->sdata;
1129 struct ieee80211_local *local = sdata->local;
1131 bool more_data = false;
1133 unsigned long driver_release_tids = 0;
1134 struct sk_buff_head frames;
1136 /* Service or PS-Poll period starts */
1137 set_sta_flag(sta, WLAN_STA_SP);
1139 __skb_queue_head_init(&frames);
1142 * Get response frame(s) and more data bit for it.
1144 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
1147 if (ignored_acs & BIT(ac))
1150 tids = ieee80211_tids_for_ac(ac);
1153 driver_release_tids = sta->driver_buffered_tids & tids;
1154 if (driver_release_tids) {
1157 struct sk_buff *skb;
1159 while (n_frames > 0) {
1160 skb = skb_dequeue(&sta->tx_filtered[ac]);
1163 &sta->ps_tx_buf[ac]);
1165 local->total_ps_buffered--;
1171 __skb_queue_tail(&frames, skb);
1176 * If the driver has data on more than one TID then
1177 * certainly there's more data if we release just a
1178 * single frame now (from a single TID).
1180 if (reason == IEEE80211_FRAME_RELEASE_PSPOLL &&
1181 hweight16(driver_release_tids) > 1) {
1183 driver_release_tids =
1184 BIT(ffs(driver_release_tids) - 1);
1189 if (!skb_queue_empty(&sta->tx_filtered[ac]) ||
1190 !skb_queue_empty(&sta->ps_tx_buf[ac])) {
1200 * For PS-Poll, this can only happen due to a race condition
1201 * when we set the TIM bit and the station notices it, but
1202 * before it can poll for the frame we expire it.
1204 * For uAPSD, this is said in the standard (11.2.1.5 h):
1205 * At each unscheduled SP for a non-AP STA, the AP shall
1206 * attempt to transmit at least one MSDU or MMPDU, but no
1207 * more than the value specified in the Max SP Length field
1208 * in the QoS Capability element from delivery-enabled ACs,
1209 * that are destined for the non-AP STA.
1211 * Since we have no other MSDU/MMPDU, transmit a QoS null frame.
1214 /* This will evaluate to 1, 3, 5 or 7. */
1215 tid = 7 - ((ffs(~ignored_acs) - 1) << 1);
1217 ieee80211_send_null_response(sdata, sta, tid, reason);
1221 if (!driver_release_tids) {
1222 struct sk_buff_head pending;
1223 struct sk_buff *skb;
1227 skb_queue_head_init(&pending);
1229 while ((skb = __skb_dequeue(&frames))) {
1230 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
1231 struct ieee80211_hdr *hdr = (void *) skb->data;
1237 * Tell TX path to send this frame even though the
1238 * STA may still remain is PS mode after this frame
1241 info->flags |= IEEE80211_TX_CTL_POLL_RESPONSE;
1244 * Use MoreData flag to indicate whether there are
1245 * more buffered frames for this STA
1247 if (more_data || !skb_queue_empty(&frames))
1248 hdr->frame_control |=
1249 cpu_to_le16(IEEE80211_FCTL_MOREDATA);
1251 hdr->frame_control &=
1252 cpu_to_le16(~IEEE80211_FCTL_MOREDATA);
1254 if (ieee80211_is_data_qos(hdr->frame_control) ||
1255 ieee80211_is_qos_nullfunc(hdr->frame_control))
1256 qoshdr = ieee80211_get_qos_ctl(hdr);
1258 /* set EOSP for the frame */
1259 if (reason == IEEE80211_FRAME_RELEASE_UAPSD &&
1260 qoshdr && skb_queue_empty(&frames))
1261 *qoshdr |= IEEE80211_QOS_CTL_EOSP;
1263 info->flags |= IEEE80211_TX_STATUS_EOSP |
1264 IEEE80211_TX_CTL_REQ_TX_STATUS;
1267 tids |= BIT(*qoshdr & IEEE80211_QOS_CTL_TID_MASK);
1271 __skb_queue_tail(&pending, skb);
1274 drv_allow_buffered_frames(local, sta, tids, num,
1277 ieee80211_add_pending_skbs(local, &pending);
1279 sta_info_recalc_tim(sta);
1282 * We need to release a frame that is buffered somewhere in the
1283 * driver ... it'll have to handle that.
1284 * Note that, as per the comment above, it'll also have to see
1285 * if there is more than just one frame on the specific TID that
1286 * we're releasing from, and it needs to set the more-data bit
1287 * accordingly if we tell it that there's no more data. If we do
1288 * tell it there's more data, then of course the more-data bit
1289 * needs to be set anyway.
1291 drv_release_buffered_frames(local, sta, driver_release_tids,
1292 n_frames, reason, more_data);
1295 * Note that we don't recalculate the TIM bit here as it would
1296 * most likely have no effect at all unless the driver told us
1297 * that the TID became empty before returning here from the
1299 * Either way, however, when the driver tells us that the TID
1300 * became empty we'll do the TIM recalculation.
1305 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta)
1307 u8 ignore_for_response = sta->sta.uapsd_queues;
1310 * If all ACs are delivery-enabled then we should reply
1311 * from any of them, if only some are enabled we reply
1312 * only from the non-enabled ones.
1314 if (ignore_for_response == BIT(IEEE80211_NUM_ACS) - 1)
1315 ignore_for_response = 0;
1317 ieee80211_sta_ps_deliver_response(sta, 1, ignore_for_response,
1318 IEEE80211_FRAME_RELEASE_PSPOLL);
1321 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta)
1323 int n_frames = sta->sta.max_sp;
1324 u8 delivery_enabled = sta->sta.uapsd_queues;
1327 * If we ever grow support for TSPEC this might happen if
1328 * the TSPEC update from hostapd comes in between a trigger
1329 * frame setting WLAN_STA_UAPSD in the RX path and this
1330 * actually getting called.
1332 if (!delivery_enabled)
1335 switch (sta->sta.max_sp) {
1346 /* XXX: what is a good value? */
1351 ieee80211_sta_ps_deliver_response(sta, n_frames, ~delivery_enabled,
1352 IEEE80211_FRAME_RELEASE_UAPSD);
1355 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
1356 struct ieee80211_sta *pubsta, bool block)
1358 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1360 trace_api_sta_block_awake(sta->local, pubsta, block);
1363 set_sta_flag(sta, WLAN_STA_PS_DRIVER);
1364 else if (test_sta_flag(sta, WLAN_STA_PS_DRIVER))
1365 ieee80211_queue_work(hw, &sta->drv_unblock_wk);
1367 EXPORT_SYMBOL(ieee80211_sta_block_awake);
1369 void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta *pubsta)
1371 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1372 struct ieee80211_local *local = sta->local;
1373 struct sk_buff *skb;
1374 struct skb_eosp_msg_data *data;
1376 trace_api_eosp(local, pubsta);
1378 skb = alloc_skb(0, GFP_ATOMIC);
1380 /* too bad ... but race is better than loss */
1381 clear_sta_flag(sta, WLAN_STA_SP);
1385 data = (void *)skb->cb;
1386 memcpy(data->sta, pubsta->addr, ETH_ALEN);
1387 memcpy(data->iface, sta->sdata->vif.addr, ETH_ALEN);
1388 skb->pkt_type = IEEE80211_EOSP_MSG;
1389 skb_queue_tail(&local->skb_queue, skb);
1390 tasklet_schedule(&local->tasklet);
1392 EXPORT_SYMBOL(ieee80211_sta_eosp_irqsafe);
1394 void ieee80211_sta_set_buffered(struct ieee80211_sta *pubsta,
1395 u8 tid, bool buffered)
1397 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1399 if (WARN_ON(tid >= STA_TID_NUM))
1403 set_bit(tid, &sta->driver_buffered_tids);
1405 clear_bit(tid, &sta->driver_buffered_tids);
1407 sta_info_recalc_tim(sta);
1409 EXPORT_SYMBOL(ieee80211_sta_set_buffered);
1411 int sta_info_move_state_checked(struct sta_info *sta,
1412 enum ieee80211_sta_state new_state)
1416 if (sta->sta_state == new_state)
1419 switch (new_state) {
1420 case IEEE80211_STA_NONE:
1421 if (sta->sta_state == IEEE80211_STA_AUTH)
1422 clear_bit(WLAN_STA_AUTH, &sta->_flags);
1426 case IEEE80211_STA_AUTH:
1427 if (sta->sta_state == IEEE80211_STA_NONE)
1428 set_bit(WLAN_STA_AUTH, &sta->_flags);
1429 else if (sta->sta_state == IEEE80211_STA_ASSOC)
1430 clear_bit(WLAN_STA_ASSOC, &sta->_flags);
1434 case IEEE80211_STA_ASSOC:
1435 if (sta->sta_state == IEEE80211_STA_AUTH) {
1436 set_bit(WLAN_STA_ASSOC, &sta->_flags);
1437 } else if (sta->sta_state == IEEE80211_STA_AUTHORIZED) {
1438 if (sta->sdata->vif.type == NL80211_IFTYPE_AP)
1439 atomic_dec(&sta->sdata->u.ap.num_sta_authorized);
1440 clear_bit(WLAN_STA_AUTHORIZED, &sta->_flags);
1444 case IEEE80211_STA_AUTHORIZED:
1445 if (sta->sta_state == IEEE80211_STA_ASSOC) {
1446 if (sta->sdata->vif.type == NL80211_IFTYPE_AP)
1447 atomic_inc(&sta->sdata->u.ap.num_sta_authorized);
1448 set_bit(WLAN_STA_AUTHORIZED, &sta->_flags);
1453 WARN(1, "invalid state %d", new_state);
1457 printk(KERN_DEBUG "%s: moving STA %pM to state %d\n",
1458 sta->sdata->name, sta->sta.addr, new_state);
1459 sta->sta_state = new_state;