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_assign_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_assign_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_assign_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)) {
243 ieee80211_sta_ps_deliver_wakeup(sta);
245 } else if (test_and_clear_sta_flag(sta, WLAN_STA_PSPOLL)) {
246 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
249 ieee80211_sta_ps_deliver_poll_response(sta);
251 } else if (test_and_clear_sta_flag(sta, WLAN_STA_UAPSD)) {
252 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
255 ieee80211_sta_ps_deliver_uapsd(sta);
258 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
261 static int sta_prepare_rate_control(struct ieee80211_local *local,
262 struct sta_info *sta, gfp_t gfp)
264 if (local->hw.flags & IEEE80211_HW_HAS_RATE_CONTROL)
267 sta->rate_ctrl = rate_control_get(local->rate_ctrl);
268 sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
270 if (!sta->rate_ctrl_priv) {
271 rate_control_put(sta->rate_ctrl);
278 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
279 const u8 *addr, gfp_t gfp)
281 struct ieee80211_local *local = sdata->local;
282 struct sta_info *sta;
283 struct timespec uptime;
286 sta = kzalloc(sizeof(*sta) + local->hw.sta_data_size, gfp);
290 spin_lock_init(&sta->lock);
291 INIT_WORK(&sta->drv_unblock_wk, sta_unblock);
292 INIT_WORK(&sta->ampdu_mlme.work, ieee80211_ba_session_work);
293 mutex_init(&sta->ampdu_mlme.mtx);
295 memcpy(sta->sta.addr, addr, ETH_ALEN);
298 sta->last_rx = jiffies;
300 do_posix_clock_monotonic_gettime(&uptime);
301 sta->last_connected = uptime.tv_sec;
302 ewma_init(&sta->avg_signal, 1024, 8);
304 if (sta_prepare_rate_control(local, sta, gfp)) {
309 for (i = 0; i < STA_TID_NUM; i++) {
311 * timer_to_tid must be initialized with identity mapping
312 * to enable session_timer's data differentiation. See
313 * sta_rx_agg_session_timer_expired for usage.
315 sta->timer_to_tid[i] = i;
317 for (i = 0; i < IEEE80211_NUM_ACS; i++) {
318 skb_queue_head_init(&sta->ps_tx_buf[i]);
319 skb_queue_head_init(&sta->tx_filtered[i]);
322 for (i = 0; i < NUM_RX_DATA_QUEUES; i++)
323 sta->last_seq_ctrl[i] = cpu_to_le16(USHRT_MAX);
325 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
326 wiphy_debug(local->hw.wiphy, "Allocated STA %pM\n", sta->sta.addr);
327 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
329 #ifdef CONFIG_MAC80211_MESH
330 sta->plink_state = NL80211_PLINK_LISTEN;
331 init_timer(&sta->plink_timer);
337 static int sta_info_insert_check(struct sta_info *sta)
339 struct ieee80211_sub_if_data *sdata = sta->sdata;
342 * Can't be a WARN_ON because it can be triggered through a race:
343 * something inserts a STA (on one CPU) without holding the RTNL
344 * and another CPU turns off the net device.
346 if (unlikely(!ieee80211_sdata_running(sdata)))
349 if (WARN_ON(compare_ether_addr(sta->sta.addr, sdata->vif.addr) == 0 ||
350 is_multicast_ether_addr(sta->sta.addr)))
357 * should be called with sta_mtx locked
358 * this function replaces the mutex lock
361 static int sta_info_insert_finish(struct sta_info *sta) __acquires(RCU)
363 struct ieee80211_local *local = sta->local;
364 struct ieee80211_sub_if_data *sdata = sta->sdata;
365 struct sta_info *exist_sta;
366 bool dummy_reinsert = false;
369 lockdep_assert_held(&local->sta_mtx);
372 * check if STA exists already.
373 * only accept a scenario of a second call to sta_info_insert_finish
374 * with a dummy station entry that was inserted earlier
375 * in that case - assume that the dummy station flag should
378 exist_sta = sta_info_get_bss_rx(sdata, sta->sta.addr);
380 if (exist_sta == sta && sta->dummy) {
381 dummy_reinsert = true;
388 if (!sta->dummy || dummy_reinsert) {
390 err = drv_sta_add(local, sdata, &sta->sta);
392 if (sdata->vif.type != NL80211_IFTYPE_ADHOC)
394 printk(KERN_DEBUG "%s: failed to add IBSS STA %pM to "
395 "driver (%d) - keeping it anyway.\n",
396 sdata->name, sta->sta.addr, err);
398 sta->uploaded = true;
401 if (!dummy_reinsert) {
403 local->sta_generation++;
406 /* make the station visible */
407 sta_info_hash_add(local, sta);
409 list_add(&sta->list, &local->sta_list);
415 struct station_info sinfo;
417 ieee80211_sta_debugfs_add(sta);
418 rate_control_add_sta_debugfs(sta);
420 memset(&sinfo, 0, sizeof(sinfo));
422 sinfo.generation = local->sta_generation;
423 cfg80211_new_sta(sdata->dev, sta->sta.addr, &sinfo, GFP_KERNEL);
426 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
427 wiphy_debug(local->hw.wiphy, "Inserted %sSTA %pM\n",
428 sta->dummy ? "dummy " : "", sta->sta.addr);
429 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
431 /* move reference to rcu-protected */
433 mutex_unlock(&local->sta_mtx);
435 if (ieee80211_vif_is_mesh(&sdata->vif))
436 mesh_accept_plinks_update(sdata);
440 mutex_unlock(&local->sta_mtx);
445 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU)
447 struct ieee80211_local *local = sta->local;
452 err = sta_info_insert_check(sta);
458 mutex_lock(&local->sta_mtx);
460 err = sta_info_insert_finish(sta);
467 sta_info_free(local, sta);
471 int sta_info_insert(struct sta_info *sta)
473 int err = sta_info_insert_rcu(sta);
480 /* Caller must hold sta->local->sta_mtx */
481 int sta_info_reinsert(struct sta_info *sta)
483 struct ieee80211_local *local = sta->local;
486 err = sta_info_insert_check(sta);
488 mutex_unlock(&local->sta_mtx);
494 err = sta_info_insert_finish(sta);
499 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
502 * This format has been mandated by the IEEE specifications,
503 * so this line may not be changed to use the __set_bit() format.
505 bss->tim[aid / 8] |= (1 << (aid % 8));
508 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
511 * This format has been mandated by the IEEE specifications,
512 * so this line may not be changed to use the __clear_bit() format.
514 bss->tim[aid / 8] &= ~(1 << (aid % 8));
517 static unsigned long ieee80211_tids_for_ac(int ac)
519 /* If we ever support TIDs > 7, this obviously needs to be adjusted */
521 case IEEE80211_AC_VO:
522 return BIT(6) | BIT(7);
523 case IEEE80211_AC_VI:
524 return BIT(4) | BIT(5);
525 case IEEE80211_AC_BE:
526 return BIT(0) | BIT(3);
527 case IEEE80211_AC_BK:
528 return BIT(1) | BIT(2);
535 void sta_info_recalc_tim(struct sta_info *sta)
537 struct ieee80211_local *local = sta->local;
538 struct ieee80211_if_ap *bss = sta->sdata->bss;
540 bool indicate_tim = false;
541 u8 ignore_for_tim = sta->sta.uapsd_queues;
544 if (WARN_ON_ONCE(!sta->sdata->bss))
547 /* No need to do anything if the driver does all */
548 if (local->hw.flags & IEEE80211_HW_AP_LINK_PS)
555 * If all ACs are delivery-enabled then we should build
556 * the TIM bit for all ACs anyway; if only some are then
557 * we ignore those and build the TIM bit using only the
560 if (ignore_for_tim == BIT(IEEE80211_NUM_ACS) - 1)
563 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
566 if (ignore_for_tim & BIT(ac))
569 indicate_tim |= !skb_queue_empty(&sta->tx_filtered[ac]) ||
570 !skb_queue_empty(&sta->ps_tx_buf[ac]);
574 tids = ieee80211_tids_for_ac(ac);
577 sta->driver_buffered_tids & tids;
581 spin_lock_irqsave(&local->tim_lock, flags);
584 __bss_tim_set(bss, sta->sta.aid);
586 __bss_tim_clear(bss, sta->sta.aid);
588 if (local->ops->set_tim) {
589 local->tim_in_locked_section = true;
590 drv_set_tim(local, &sta->sta, indicate_tim);
591 local->tim_in_locked_section = false;
594 spin_unlock_irqrestore(&local->tim_lock, flags);
597 static bool sta_info_buffer_expired(struct sta_info *sta, struct sk_buff *skb)
599 struct ieee80211_tx_info *info;
605 info = IEEE80211_SKB_CB(skb);
607 /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
608 timeout = (sta->listen_interval *
609 sta->sdata->vif.bss_conf.beacon_int *
611 if (timeout < STA_TX_BUFFER_EXPIRE)
612 timeout = STA_TX_BUFFER_EXPIRE;
613 return time_after(jiffies, info->control.jiffies + timeout);
617 static bool sta_info_cleanup_expire_buffered_ac(struct ieee80211_local *local,
618 struct sta_info *sta, int ac)
624 * First check for frames that should expire on the filtered
625 * queue. Frames here were rejected by the driver and are on
626 * a separate queue to avoid reordering with normal PS-buffered
627 * frames. They also aren't accounted for right now in the
628 * total_ps_buffered counter.
631 spin_lock_irqsave(&sta->tx_filtered[ac].lock, flags);
632 skb = skb_peek(&sta->tx_filtered[ac]);
633 if (sta_info_buffer_expired(sta, skb))
634 skb = __skb_dequeue(&sta->tx_filtered[ac]);
637 spin_unlock_irqrestore(&sta->tx_filtered[ac].lock, flags);
640 * Frames are queued in order, so if this one
641 * hasn't expired yet we can stop testing. If
642 * we actually reached the end of the queue we
643 * also need to stop, of course.
651 * Now also check the normal PS-buffered queue, this will
652 * only find something if the filtered queue was emptied
653 * since the filtered frames are all before the normal PS
657 spin_lock_irqsave(&sta->ps_tx_buf[ac].lock, flags);
658 skb = skb_peek(&sta->ps_tx_buf[ac]);
659 if (sta_info_buffer_expired(sta, skb))
660 skb = __skb_dequeue(&sta->ps_tx_buf[ac]);
663 spin_unlock_irqrestore(&sta->ps_tx_buf[ac].lock, flags);
666 * frames are queued in order, so if this one
667 * hasn't expired yet (or we reached the end of
668 * the queue) we can stop testing
673 local->total_ps_buffered--;
674 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
675 printk(KERN_DEBUG "Buffered frame expired (STA %pM)\n",
682 * Finally, recalculate the TIM bit for this station -- it might
683 * now be clear because the station was too slow to retrieve its
686 sta_info_recalc_tim(sta);
689 * Return whether there are any frames still buffered, this is
690 * used to check whether the cleanup timer still needs to run,
691 * if there are no frames we don't need to rearm the timer.
693 return !(skb_queue_empty(&sta->ps_tx_buf[ac]) &&
694 skb_queue_empty(&sta->tx_filtered[ac]));
697 static bool sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
698 struct sta_info *sta)
700 bool have_buffered = false;
703 /* This is only necessary for stations on BSS interfaces */
704 if (!sta->sdata->bss)
707 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++)
709 sta_info_cleanup_expire_buffered_ac(local, sta, ac);
711 return have_buffered;
714 static int __must_check __sta_info_destroy(struct sta_info *sta)
716 struct ieee80211_local *local;
717 struct ieee80211_sub_if_data *sdata;
719 struct tid_ampdu_tx *tid_tx;
730 * Before removing the station from the driver and
731 * rate control, it might still start new aggregation
732 * sessions -- block that to make sure the tear-down
733 * will be sufficient.
735 set_sta_flag(sta, WLAN_STA_BLOCK_BA);
736 ieee80211_sta_tear_down_BA_sessions(sta, true);
738 ret = sta_info_hash_del(local, sta);
742 list_del(&sta->list);
744 mutex_lock(&local->key_mtx);
745 for (i = 0; i < NUM_DEFAULT_KEYS; i++)
746 __ieee80211_key_free(key_mtx_dereference(local, sta->gtk[i]));
748 __ieee80211_key_free(key_mtx_dereference(local, sta->ptk));
749 mutex_unlock(&local->key_mtx);
753 if (test_sta_flag(sta, WLAN_STA_PS_STA) ||
754 test_sta_flag(sta, WLAN_STA_PS_DRIVER)) {
757 clear_sta_flag(sta, WLAN_STA_PS_STA);
758 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
760 atomic_dec(&sdata->bss->num_sta_ps);
761 sta_info_recalc_tim(sta);
765 local->sta_generation++;
767 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
768 RCU_INIT_POINTER(sdata->u.vlan.sta, NULL);
770 while (sta->sta_state > IEEE80211_STA_NONE)
771 sta_info_move_state(sta, sta->sta_state - 1);
774 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
775 sdata = container_of(sdata->bss,
776 struct ieee80211_sub_if_data,
778 drv_sta_remove(local, sdata, &sta->sta);
783 * At this point, after we wait for an RCU grace period,
784 * neither mac80211 nor the driver can reference this
785 * sta struct any more except by still existing timers
786 * associated with this station that we clean up below.
790 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
791 local->total_ps_buffered -= skb_queue_len(&sta->ps_tx_buf[ac]);
792 __skb_queue_purge(&sta->ps_tx_buf[ac]);
793 __skb_queue_purge(&sta->tx_filtered[ac]);
796 #ifdef CONFIG_MAC80211_MESH
797 if (ieee80211_vif_is_mesh(&sdata->vif))
798 mesh_accept_plinks_update(sdata);
801 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
802 wiphy_debug(local->hw.wiphy, "Removed STA %pM\n", sta->sta.addr);
803 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
804 cancel_work_sync(&sta->drv_unblock_wk);
806 cfg80211_del_sta(sdata->dev, sta->sta.addr, GFP_KERNEL);
808 rate_control_remove_sta_debugfs(sta);
809 ieee80211_sta_debugfs_remove(sta);
811 #ifdef CONFIG_MAC80211_MESH
812 if (ieee80211_vif_is_mesh(&sta->sdata->vif)) {
813 mesh_plink_deactivate(sta);
814 del_timer_sync(&sta->plink_timer);
818 /* There could be some memory leaks because of ampdu tx pending queue
819 * not being freed before destroying the station info.
821 * Make sure that such queues are purged before freeing the station
823 * TODO: We have to somehow postpone the full destruction
824 * until the aggregation stop completes. Refer
825 * http://thread.gmane.org/gmane.linux.kernel.wireless.general/81936
828 mutex_lock(&sta->ampdu_mlme.mtx);
830 for (i = 0; i < STA_TID_NUM; i++) {
831 tid_tx = rcu_dereference_protected_tid_tx(sta, i);
834 if (skb_queue_len(&tid_tx->pending)) {
835 #ifdef CONFIG_MAC80211_HT_DEBUG
836 wiphy_debug(local->hw.wiphy, "TX A-MPDU purging %d "
837 "packets for tid=%d\n",
838 skb_queue_len(&tid_tx->pending), i);
839 #endif /* CONFIG_MAC80211_HT_DEBUG */
840 __skb_queue_purge(&tid_tx->pending);
842 kfree_rcu(tid_tx, rcu_head);
845 mutex_unlock(&sta->ampdu_mlme.mtx);
847 sta_info_free(local, sta);
852 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata, const u8 *addr)
854 struct sta_info *sta;
857 mutex_lock(&sdata->local->sta_mtx);
858 sta = sta_info_get_rx(sdata, addr);
859 ret = __sta_info_destroy(sta);
860 mutex_unlock(&sdata->local->sta_mtx);
865 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
868 struct sta_info *sta;
871 mutex_lock(&sdata->local->sta_mtx);
872 sta = sta_info_get_bss_rx(sdata, addr);
873 ret = __sta_info_destroy(sta);
874 mutex_unlock(&sdata->local->sta_mtx);
879 static void sta_info_cleanup(unsigned long data)
881 struct ieee80211_local *local = (struct ieee80211_local *) data;
882 struct sta_info *sta;
883 bool timer_needed = false;
886 list_for_each_entry_rcu(sta, &local->sta_list, list)
887 if (sta_info_cleanup_expire_buffered(local, sta))
891 if (local->quiescing)
897 mod_timer(&local->sta_cleanup,
898 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL));
901 void sta_info_init(struct ieee80211_local *local)
903 spin_lock_init(&local->tim_lock);
904 mutex_init(&local->sta_mtx);
905 INIT_LIST_HEAD(&local->sta_list);
907 setup_timer(&local->sta_cleanup, sta_info_cleanup,
908 (unsigned long)local);
911 void sta_info_stop(struct ieee80211_local *local)
913 del_timer(&local->sta_cleanup);
914 sta_info_flush(local, NULL);
918 * sta_info_flush - flush matching STA entries from the STA table
920 * Returns the number of removed STA entries.
922 * @local: local interface data
923 * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
925 int sta_info_flush(struct ieee80211_local *local,
926 struct ieee80211_sub_if_data *sdata)
928 struct sta_info *sta, *tmp;
933 mutex_lock(&local->sta_mtx);
934 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
935 if (!sdata || sdata == sta->sdata)
936 WARN_ON(__sta_info_destroy(sta));
938 mutex_unlock(&local->sta_mtx);
943 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
944 unsigned long exp_time)
946 struct ieee80211_local *local = sdata->local;
947 struct sta_info *sta, *tmp;
949 mutex_lock(&local->sta_mtx);
951 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
952 if (sdata != sta->sdata)
955 if (time_after(jiffies, sta->last_rx + exp_time)) {
956 #ifdef CONFIG_MAC80211_IBSS_DEBUG
957 printk(KERN_DEBUG "%s: expiring inactive STA %pM\n",
958 sdata->name, sta->sta.addr);
960 WARN_ON(__sta_info_destroy(sta));
964 mutex_unlock(&local->sta_mtx);
967 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
971 struct sta_info *sta, *nxt;
974 * Just return a random station if localaddr is NULL
977 for_each_sta_info(hw_to_local(hw), addr, sta, nxt) {
979 compare_ether_addr(sta->sdata->vif.addr, localaddr) != 0)
988 EXPORT_SYMBOL_GPL(ieee80211_find_sta_by_ifaddr);
990 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
993 struct sta_info *sta;
998 sta = sta_info_get_bss(vif_to_sdata(vif), addr);
1007 EXPORT_SYMBOL(ieee80211_find_sta);
1009 static void clear_sta_ps_flags(void *_sta)
1011 struct sta_info *sta = _sta;
1013 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
1014 clear_sta_flag(sta, WLAN_STA_PS_STA);
1017 /* powersave support code */
1018 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta)
1020 struct ieee80211_sub_if_data *sdata = sta->sdata;
1021 struct ieee80211_local *local = sdata->local;
1022 struct sk_buff_head pending;
1023 int filtered = 0, buffered = 0, ac;
1025 clear_sta_flag(sta, WLAN_STA_SP);
1027 BUILD_BUG_ON(BITS_TO_LONGS(STA_TID_NUM) > 1);
1028 sta->driver_buffered_tids = 0;
1030 if (!(local->hw.flags & IEEE80211_HW_AP_LINK_PS))
1031 drv_sta_notify(local, sdata, STA_NOTIFY_AWAKE, &sta->sta);
1033 skb_queue_head_init(&pending);
1035 /* Send all buffered frames to the station */
1036 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
1037 int count = skb_queue_len(&pending), tmp;
1039 skb_queue_splice_tail_init(&sta->tx_filtered[ac], &pending);
1040 tmp = skb_queue_len(&pending);
1041 filtered += tmp - count;
1044 skb_queue_splice_tail_init(&sta->ps_tx_buf[ac], &pending);
1045 tmp = skb_queue_len(&pending);
1046 buffered += tmp - count;
1049 ieee80211_add_pending_skbs_fn(local, &pending, clear_sta_ps_flags, sta);
1051 local->total_ps_buffered -= buffered;
1053 sta_info_recalc_tim(sta);
1055 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
1056 printk(KERN_DEBUG "%s: STA %pM aid %d sending %d filtered/%d PS frames "
1057 "since STA not sleeping anymore\n", sdata->name,
1058 sta->sta.addr, sta->sta.aid, filtered, buffered);
1059 #endif /* CONFIG_MAC80211_VERBOSE_PS_DEBUG */
1062 static void ieee80211_send_null_response(struct ieee80211_sub_if_data *sdata,
1063 struct sta_info *sta, int tid,
1064 enum ieee80211_frame_release_type reason)
1066 struct ieee80211_local *local = sdata->local;
1067 struct ieee80211_qos_hdr *nullfunc;
1068 struct sk_buff *skb;
1069 int size = sizeof(*nullfunc);
1071 bool qos = test_sta_flag(sta, WLAN_STA_WME);
1072 struct ieee80211_tx_info *info;
1075 fc = cpu_to_le16(IEEE80211_FTYPE_DATA |
1076 IEEE80211_STYPE_QOS_NULLFUNC |
1077 IEEE80211_FCTL_FROMDS);
1080 fc = cpu_to_le16(IEEE80211_FTYPE_DATA |
1081 IEEE80211_STYPE_NULLFUNC |
1082 IEEE80211_FCTL_FROMDS);
1085 skb = dev_alloc_skb(local->hw.extra_tx_headroom + size);
1089 skb_reserve(skb, local->hw.extra_tx_headroom);
1091 nullfunc = (void *) skb_put(skb, size);
1092 nullfunc->frame_control = fc;
1093 nullfunc->duration_id = 0;
1094 memcpy(nullfunc->addr1, sta->sta.addr, ETH_ALEN);
1095 memcpy(nullfunc->addr2, sdata->vif.addr, ETH_ALEN);
1096 memcpy(nullfunc->addr3, sdata->vif.addr, ETH_ALEN);
1098 skb->priority = tid;
1099 skb_set_queue_mapping(skb, ieee802_1d_to_ac[tid]);
1101 nullfunc->qos_ctrl = cpu_to_le16(tid);
1103 if (reason == IEEE80211_FRAME_RELEASE_UAPSD)
1104 nullfunc->qos_ctrl |=
1105 cpu_to_le16(IEEE80211_QOS_CTL_EOSP);
1108 info = IEEE80211_SKB_CB(skb);
1111 * Tell TX path to send this frame even though the
1112 * STA may still remain is PS mode after this frame
1113 * exchange. Also set EOSP to indicate this packet
1114 * ends the poll/service period.
1116 info->flags |= IEEE80211_TX_CTL_POLL_RESPONSE |
1117 IEEE80211_TX_STATUS_EOSP |
1118 IEEE80211_TX_CTL_REQ_TX_STATUS;
1120 drv_allow_buffered_frames(local, sta, BIT(tid), 1, reason, false);
1122 ieee80211_xmit(sdata, skb);
1126 ieee80211_sta_ps_deliver_response(struct sta_info *sta,
1127 int n_frames, u8 ignored_acs,
1128 enum ieee80211_frame_release_type reason)
1130 struct ieee80211_sub_if_data *sdata = sta->sdata;
1131 struct ieee80211_local *local = sdata->local;
1133 bool more_data = false;
1135 unsigned long driver_release_tids = 0;
1136 struct sk_buff_head frames;
1138 /* Service or PS-Poll period starts */
1139 set_sta_flag(sta, WLAN_STA_SP);
1141 __skb_queue_head_init(&frames);
1144 * Get response frame(s) and more data bit for it.
1146 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
1149 if (ignored_acs & BIT(ac))
1152 tids = ieee80211_tids_for_ac(ac);
1155 driver_release_tids = sta->driver_buffered_tids & tids;
1156 if (driver_release_tids) {
1159 struct sk_buff *skb;
1161 while (n_frames > 0) {
1162 skb = skb_dequeue(&sta->tx_filtered[ac]);
1165 &sta->ps_tx_buf[ac]);
1167 local->total_ps_buffered--;
1173 __skb_queue_tail(&frames, skb);
1178 * If the driver has data on more than one TID then
1179 * certainly there's more data if we release just a
1180 * single frame now (from a single TID).
1182 if (reason == IEEE80211_FRAME_RELEASE_PSPOLL &&
1183 hweight16(driver_release_tids) > 1) {
1185 driver_release_tids =
1186 BIT(ffs(driver_release_tids) - 1);
1191 if (!skb_queue_empty(&sta->tx_filtered[ac]) ||
1192 !skb_queue_empty(&sta->ps_tx_buf[ac])) {
1202 * For PS-Poll, this can only happen due to a race condition
1203 * when we set the TIM bit and the station notices it, but
1204 * before it can poll for the frame we expire it.
1206 * For uAPSD, this is said in the standard (11.2.1.5 h):
1207 * At each unscheduled SP for a non-AP STA, the AP shall
1208 * attempt to transmit at least one MSDU or MMPDU, but no
1209 * more than the value specified in the Max SP Length field
1210 * in the QoS Capability element from delivery-enabled ACs,
1211 * that are destined for the non-AP STA.
1213 * Since we have no other MSDU/MMPDU, transmit a QoS null frame.
1216 /* This will evaluate to 1, 3, 5 or 7. */
1217 tid = 7 - ((ffs(~ignored_acs) - 1) << 1);
1219 ieee80211_send_null_response(sdata, sta, tid, reason);
1223 if (!driver_release_tids) {
1224 struct sk_buff_head pending;
1225 struct sk_buff *skb;
1229 skb_queue_head_init(&pending);
1231 while ((skb = __skb_dequeue(&frames))) {
1232 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
1233 struct ieee80211_hdr *hdr = (void *) skb->data;
1239 * Tell TX path to send this frame even though the
1240 * STA may still remain is PS mode after this frame
1243 info->flags |= IEEE80211_TX_CTL_POLL_RESPONSE;
1246 * Use MoreData flag to indicate whether there are
1247 * more buffered frames for this STA
1249 if (more_data || !skb_queue_empty(&frames))
1250 hdr->frame_control |=
1251 cpu_to_le16(IEEE80211_FCTL_MOREDATA);
1253 hdr->frame_control &=
1254 cpu_to_le16(~IEEE80211_FCTL_MOREDATA);
1256 if (ieee80211_is_data_qos(hdr->frame_control) ||
1257 ieee80211_is_qos_nullfunc(hdr->frame_control))
1258 qoshdr = ieee80211_get_qos_ctl(hdr);
1260 /* set EOSP for the frame */
1261 if (reason == IEEE80211_FRAME_RELEASE_UAPSD &&
1262 qoshdr && skb_queue_empty(&frames))
1263 *qoshdr |= IEEE80211_QOS_CTL_EOSP;
1265 info->flags |= IEEE80211_TX_STATUS_EOSP |
1266 IEEE80211_TX_CTL_REQ_TX_STATUS;
1269 tids |= BIT(*qoshdr & IEEE80211_QOS_CTL_TID_MASK);
1273 __skb_queue_tail(&pending, skb);
1276 drv_allow_buffered_frames(local, sta, tids, num,
1279 ieee80211_add_pending_skbs(local, &pending);
1281 sta_info_recalc_tim(sta);
1284 * We need to release a frame that is buffered somewhere in the
1285 * driver ... it'll have to handle that.
1286 * Note that, as per the comment above, it'll also have to see
1287 * if there is more than just one frame on the specific TID that
1288 * we're releasing from, and it needs to set the more-data bit
1289 * accordingly if we tell it that there's no more data. If we do
1290 * tell it there's more data, then of course the more-data bit
1291 * needs to be set anyway.
1293 drv_release_buffered_frames(local, sta, driver_release_tids,
1294 n_frames, reason, more_data);
1297 * Note that we don't recalculate the TIM bit here as it would
1298 * most likely have no effect at all unless the driver told us
1299 * that the TID became empty before returning here from the
1301 * Either way, however, when the driver tells us that the TID
1302 * became empty we'll do the TIM recalculation.
1307 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta)
1309 u8 ignore_for_response = sta->sta.uapsd_queues;
1312 * If all ACs are delivery-enabled then we should reply
1313 * from any of them, if only some are enabled we reply
1314 * only from the non-enabled ones.
1316 if (ignore_for_response == BIT(IEEE80211_NUM_ACS) - 1)
1317 ignore_for_response = 0;
1319 ieee80211_sta_ps_deliver_response(sta, 1, ignore_for_response,
1320 IEEE80211_FRAME_RELEASE_PSPOLL);
1323 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta)
1325 int n_frames = sta->sta.max_sp;
1326 u8 delivery_enabled = sta->sta.uapsd_queues;
1329 * If we ever grow support for TSPEC this might happen if
1330 * the TSPEC update from hostapd comes in between a trigger
1331 * frame setting WLAN_STA_UAPSD in the RX path and this
1332 * actually getting called.
1334 if (!delivery_enabled)
1337 switch (sta->sta.max_sp) {
1348 /* XXX: what is a good value? */
1353 ieee80211_sta_ps_deliver_response(sta, n_frames, ~delivery_enabled,
1354 IEEE80211_FRAME_RELEASE_UAPSD);
1357 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
1358 struct ieee80211_sta *pubsta, bool block)
1360 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1362 trace_api_sta_block_awake(sta->local, pubsta, block);
1365 set_sta_flag(sta, WLAN_STA_PS_DRIVER);
1366 else if (test_sta_flag(sta, WLAN_STA_PS_DRIVER))
1367 ieee80211_queue_work(hw, &sta->drv_unblock_wk);
1369 EXPORT_SYMBOL(ieee80211_sta_block_awake);
1371 void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta *pubsta)
1373 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1374 struct ieee80211_local *local = sta->local;
1375 struct sk_buff *skb;
1376 struct skb_eosp_msg_data *data;
1378 trace_api_eosp(local, pubsta);
1380 skb = alloc_skb(0, GFP_ATOMIC);
1382 /* too bad ... but race is better than loss */
1383 clear_sta_flag(sta, WLAN_STA_SP);
1387 data = (void *)skb->cb;
1388 memcpy(data->sta, pubsta->addr, ETH_ALEN);
1389 memcpy(data->iface, sta->sdata->vif.addr, ETH_ALEN);
1390 skb->pkt_type = IEEE80211_EOSP_MSG;
1391 skb_queue_tail(&local->skb_queue, skb);
1392 tasklet_schedule(&local->tasklet);
1394 EXPORT_SYMBOL(ieee80211_sta_eosp_irqsafe);
1396 void ieee80211_sta_set_buffered(struct ieee80211_sta *pubsta,
1397 u8 tid, bool buffered)
1399 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1401 if (WARN_ON(tid >= STA_TID_NUM))
1405 set_bit(tid, &sta->driver_buffered_tids);
1407 clear_bit(tid, &sta->driver_buffered_tids);
1409 sta_info_recalc_tim(sta);
1411 EXPORT_SYMBOL(ieee80211_sta_set_buffered);
1413 int sta_info_move_state_checked(struct sta_info *sta,
1414 enum ieee80211_sta_state new_state)
1418 if (sta->sta_state == new_state)
1421 switch (new_state) {
1422 case IEEE80211_STA_NONE:
1423 if (sta->sta_state == IEEE80211_STA_AUTH)
1424 clear_bit(WLAN_STA_AUTH, &sta->_flags);
1428 case IEEE80211_STA_AUTH:
1429 if (sta->sta_state == IEEE80211_STA_NONE)
1430 set_bit(WLAN_STA_AUTH, &sta->_flags);
1431 else if (sta->sta_state == IEEE80211_STA_ASSOC)
1432 clear_bit(WLAN_STA_ASSOC, &sta->_flags);
1436 case IEEE80211_STA_ASSOC:
1437 if (sta->sta_state == IEEE80211_STA_AUTH) {
1438 set_bit(WLAN_STA_ASSOC, &sta->_flags);
1439 } else if (sta->sta_state == IEEE80211_STA_AUTHORIZED) {
1440 if (sta->sdata->vif.type == NL80211_IFTYPE_AP)
1441 atomic_dec(&sta->sdata->u.ap.num_sta_authorized);
1442 clear_bit(WLAN_STA_AUTHORIZED, &sta->_flags);
1446 case IEEE80211_STA_AUTHORIZED:
1447 if (sta->sta_state == IEEE80211_STA_ASSOC) {
1448 if (sta->sdata->vif.type == NL80211_IFTYPE_AP)
1449 atomic_inc(&sta->sdata->u.ap.num_sta_authorized);
1450 set_bit(WLAN_STA_AUTHORIZED, &sta->_flags);
1455 WARN(1, "invalid state %d", new_state);
1459 printk(KERN_DEBUG "%s: moving STA %pM to state %d\n",
1460 sta->sdata->name, sta->sta.addr, new_state);
1461 sta->sta_state = new_state;