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_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_lock));
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_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_assign_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 spin_lock_init(&sta->ps_lock);
296 INIT_WORK(&sta->drv_unblock_wk, sta_unblock);
297 INIT_WORK(&sta->ampdu_mlme.work, ieee80211_ba_session_work);
298 mutex_init(&sta->ampdu_mlme.mtx);
300 memcpy(sta->sta.addr, addr, ETH_ALEN);
303 sta->last_rx = jiffies;
305 do_posix_clock_monotonic_gettime(&uptime);
306 sta->last_connected = uptime.tv_sec;
307 ewma_init(&sta->avg_signal, 1024, 8);
309 if (sta_prepare_rate_control(local, sta, gfp)) {
314 for (i = 0; i < STA_TID_NUM; i++) {
316 * timer_to_tid must be initialized with identity mapping
317 * to enable session_timer's data differentiation. See
318 * sta_rx_agg_session_timer_expired for usage.
320 sta->timer_to_tid[i] = i;
322 for (i = 0; i < IEEE80211_NUM_ACS; i++) {
323 skb_queue_head_init(&sta->ps_tx_buf[i]);
324 skb_queue_head_init(&sta->tx_filtered[i]);
327 for (i = 0; i < NUM_RX_DATA_QUEUES; i++)
328 sta->last_seq_ctrl[i] = cpu_to_le16(USHRT_MAX);
330 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
331 wiphy_debug(local->hw.wiphy, "Allocated STA %pM\n", sta->sta.addr);
332 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
334 #ifdef CONFIG_MAC80211_MESH
335 sta->plink_state = NL80211_PLINK_LISTEN;
336 init_timer(&sta->plink_timer);
342 static int sta_info_finish_insert(struct sta_info *sta,
343 bool async, bool dummy_reinsert)
345 struct ieee80211_local *local = sta->local;
346 struct ieee80211_sub_if_data *sdata = sta->sdata;
347 struct station_info *sinfo;
351 lockdep_assert_held(&local->sta_mtx);
353 sinfo = kzalloc(sizeof(struct station_info), GFP_KERNEL);
357 if (!sta->dummy || dummy_reinsert) {
359 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
360 sdata = container_of(sdata->bss,
361 struct ieee80211_sub_if_data,
363 err = drv_sta_add(local, sdata, &sta->sta);
369 printk(KERN_DEBUG "%s: failed to add IBSS STA %pM to "
370 "driver (%d) - keeping it anyway.\n",
371 sdata->name, sta->sta.addr, err);
373 sta->uploaded = true;
374 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
376 wiphy_debug(local->hw.wiphy,
377 "Finished adding IBSS STA %pM\n",
385 if (!dummy_reinsert) {
388 local->sta_generation++;
391 /* make the station visible */
392 spin_lock_irqsave(&local->sta_lock, flags);
393 sta_info_hash_add(local, sta);
394 spin_unlock_irqrestore(&local->sta_lock, flags);
397 list_add(&sta->list, &local->sta_list);
403 ieee80211_sta_debugfs_add(sta);
404 rate_control_add_sta_debugfs(sta);
406 sinfo->generation = local->sta_generation;
407 cfg80211_new_sta(sdata->dev, sta->sta.addr, sinfo, GFP_KERNEL);
414 static void sta_info_finish_pending(struct ieee80211_local *local)
416 struct sta_info *sta;
419 spin_lock_irqsave(&local->sta_lock, flags);
420 while (!list_empty(&local->sta_pending_list)) {
421 sta = list_first_entry(&local->sta_pending_list,
422 struct sta_info, list);
423 list_del(&sta->list);
424 spin_unlock_irqrestore(&local->sta_lock, flags);
426 sta_info_finish_insert(sta, true, false);
428 spin_lock_irqsave(&local->sta_lock, flags);
430 spin_unlock_irqrestore(&local->sta_lock, flags);
433 static void sta_info_finish_work(struct work_struct *work)
435 struct ieee80211_local *local =
436 container_of(work, struct ieee80211_local, sta_finish_work);
438 mutex_lock(&local->sta_mtx);
439 sta_info_finish_pending(local);
440 mutex_unlock(&local->sta_mtx);
443 static int sta_info_insert_check(struct sta_info *sta)
445 struct ieee80211_sub_if_data *sdata = sta->sdata;
448 * Can't be a WARN_ON because it can be triggered through a race:
449 * something inserts a STA (on one CPU) without holding the RTNL
450 * and another CPU turns off the net device.
452 if (unlikely(!ieee80211_sdata_running(sdata)))
455 if (WARN_ON(compare_ether_addr(sta->sta.addr, sdata->vif.addr) == 0 ||
456 is_multicast_ether_addr(sta->sta.addr)))
462 static int sta_info_insert_ibss(struct sta_info *sta) __acquires(RCU)
464 struct ieee80211_local *local = sta->local;
465 struct ieee80211_sub_if_data *sdata = sta->sdata;
468 spin_lock_irqsave(&local->sta_lock, flags);
469 /* check if STA exists already */
470 if (sta_info_get_bss_rx(sdata, sta->sta.addr)) {
471 spin_unlock_irqrestore(&local->sta_lock, flags);
477 local->sta_generation++;
479 sta_info_hash_add(local, sta);
481 list_add_tail(&sta->list, &local->sta_pending_list);
484 spin_unlock_irqrestore(&local->sta_lock, flags);
486 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
487 wiphy_debug(local->hw.wiphy, "Added IBSS STA %pM\n",
489 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
491 ieee80211_queue_work(&local->hw, &local->sta_finish_work);
497 * should be called with sta_mtx locked
498 * this function replaces the mutex lock
501 static int sta_info_insert_non_ibss(struct sta_info *sta) __acquires(RCU)
503 struct ieee80211_local *local = sta->local;
504 struct ieee80211_sub_if_data *sdata = sta->sdata;
506 struct sta_info *exist_sta;
507 bool dummy_reinsert = false;
510 lockdep_assert_held(&local->sta_mtx);
513 * On first glance, this will look racy, because the code
514 * in this function, which inserts a station with sleeping,
515 * unlocks the sta_lock between checking existence in the
516 * hash table and inserting into it.
518 * However, it is not racy against itself because it keeps
522 spin_lock_irqsave(&local->sta_lock, flags);
524 * check if STA exists already.
525 * only accept a scenario of a second call to sta_info_insert_non_ibss
526 * with a dummy station entry that was inserted earlier
527 * in that case - assume that the dummy station flag should
530 exist_sta = sta_info_get_bss_rx(sdata, sta->sta.addr);
532 if (exist_sta == sta && sta->dummy) {
533 dummy_reinsert = true;
535 spin_unlock_irqrestore(&local->sta_lock, flags);
536 mutex_unlock(&local->sta_mtx);
542 spin_unlock_irqrestore(&local->sta_lock, flags);
544 err = sta_info_finish_insert(sta, false, dummy_reinsert);
546 mutex_unlock(&local->sta_mtx);
551 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
552 wiphy_debug(local->hw.wiphy, "Inserted %sSTA %pM\n",
553 sta->dummy ? "dummy " : "", sta->sta.addr);
554 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
556 /* move reference to rcu-protected */
558 mutex_unlock(&local->sta_mtx);
560 if (ieee80211_vif_is_mesh(&sdata->vif))
561 mesh_accept_plinks_update(sdata);
566 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU)
568 struct ieee80211_local *local = sta->local;
569 struct ieee80211_sub_if_data *sdata = sta->sdata;
572 err = sta_info_insert_check(sta);
579 * In ad-hoc mode, we sometimes need to insert stations
580 * from tasklet context from the RX path. To avoid races,
581 * always do so in that case -- see the comment below.
583 if (sdata->vif.type == NL80211_IFTYPE_ADHOC) {
584 err = sta_info_insert_ibss(sta);
592 * It might seem that the function called below is in race against
593 * the function call above that atomically inserts the station... That,
594 * however, is not true because the above code can only
595 * be invoked for IBSS interfaces, and the below code will
596 * not be -- and the two do not race against each other as
597 * the hash table also keys off the interface.
602 mutex_lock(&local->sta_mtx);
604 err = sta_info_insert_non_ibss(sta);
611 __sta_info_free(local, sta);
615 int sta_info_insert(struct sta_info *sta)
617 int err = sta_info_insert_rcu(sta);
624 /* Caller must hold sta->local->sta_mtx */
625 int sta_info_reinsert(struct sta_info *sta)
627 struct ieee80211_local *local = sta->local;
630 err = sta_info_insert_check(sta);
632 mutex_unlock(&local->sta_mtx);
638 err = sta_info_insert_non_ibss(sta);
643 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
646 * This format has been mandated by the IEEE specifications,
647 * so this line may not be changed to use the __set_bit() format.
649 bss->tim[aid / 8] |= (1 << (aid % 8));
652 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
655 * This format has been mandated by the IEEE specifications,
656 * so this line may not be changed to use the __clear_bit() format.
658 bss->tim[aid / 8] &= ~(1 << (aid % 8));
661 static unsigned long ieee80211_tids_for_ac(int ac)
663 /* If we ever support TIDs > 7, this obviously needs to be adjusted */
665 case IEEE80211_AC_VO:
666 return BIT(6) | BIT(7);
667 case IEEE80211_AC_VI:
668 return BIT(4) | BIT(5);
669 case IEEE80211_AC_BE:
670 return BIT(0) | BIT(3);
671 case IEEE80211_AC_BK:
672 return BIT(1) | BIT(2);
679 void sta_info_recalc_tim(struct sta_info *sta)
681 struct ieee80211_local *local = sta->local;
682 struct ieee80211_if_ap *bss = sta->sdata->bss;
684 bool indicate_tim = false;
685 u8 ignore_for_tim = sta->sta.uapsd_queues;
688 if (WARN_ON_ONCE(!sta->sdata->bss))
691 /* No need to do anything if the driver does all */
692 if (local->hw.flags & IEEE80211_HW_AP_LINK_PS)
699 * If all ACs are delivery-enabled then we should build
700 * the TIM bit for all ACs anyway; if only some are then
701 * we ignore those and build the TIM bit using only the
704 if (ignore_for_tim == BIT(IEEE80211_NUM_ACS) - 1)
707 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
710 if (ignore_for_tim & BIT(ac))
713 indicate_tim |= !skb_queue_empty(&sta->tx_filtered[ac]) ||
714 !skb_queue_empty(&sta->ps_tx_buf[ac]);
718 tids = ieee80211_tids_for_ac(ac);
721 sta->driver_buffered_tids & tids;
725 spin_lock_irqsave(&local->sta_lock, flags);
728 __bss_tim_set(bss, sta->sta.aid);
730 __bss_tim_clear(bss, sta->sta.aid);
732 if (local->ops->set_tim) {
733 local->tim_in_locked_section = true;
734 drv_set_tim(local, &sta->sta, indicate_tim);
735 local->tim_in_locked_section = false;
738 spin_unlock_irqrestore(&local->sta_lock, flags);
741 static bool sta_info_buffer_expired(struct sta_info *sta, struct sk_buff *skb)
743 struct ieee80211_tx_info *info;
749 info = IEEE80211_SKB_CB(skb);
751 /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
752 timeout = (sta->listen_interval *
753 sta->sdata->vif.bss_conf.beacon_int *
755 if (timeout < STA_TX_BUFFER_EXPIRE)
756 timeout = STA_TX_BUFFER_EXPIRE;
757 return time_after(jiffies, info->control.jiffies + timeout);
761 static bool sta_info_cleanup_expire_buffered_ac(struct ieee80211_local *local,
762 struct sta_info *sta, int ac)
768 * First check for frames that should expire on the filtered
769 * queue. Frames here were rejected by the driver and are on
770 * a separate queue to avoid reordering with normal PS-buffered
771 * frames. They also aren't accounted for right now in the
772 * total_ps_buffered counter.
775 spin_lock_irqsave(&sta->tx_filtered[ac].lock, flags);
776 skb = skb_peek(&sta->tx_filtered[ac]);
777 if (sta_info_buffer_expired(sta, skb))
778 skb = __skb_dequeue(&sta->tx_filtered[ac]);
781 spin_unlock_irqrestore(&sta->tx_filtered[ac].lock, flags);
784 * Frames are queued in order, so if this one
785 * hasn't expired yet we can stop testing. If
786 * we actually reached the end of the queue we
787 * also need to stop, of course.
795 * Now also check the normal PS-buffered queue, this will
796 * only find something if the filtered queue was emptied
797 * since the filtered frames are all before the normal PS
801 spin_lock_irqsave(&sta->ps_tx_buf[ac].lock, flags);
802 skb = skb_peek(&sta->ps_tx_buf[ac]);
803 if (sta_info_buffer_expired(sta, skb))
804 skb = __skb_dequeue(&sta->ps_tx_buf[ac]);
807 spin_unlock_irqrestore(&sta->ps_tx_buf[ac].lock, flags);
810 * frames are queued in order, so if this one
811 * hasn't expired yet (or we reached the end of
812 * the queue) we can stop testing
817 local->total_ps_buffered--;
818 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
819 printk(KERN_DEBUG "Buffered frame expired (STA %pM)\n",
826 * Finally, recalculate the TIM bit for this station -- it might
827 * now be clear because the station was too slow to retrieve its
830 sta_info_recalc_tim(sta);
833 * Return whether there are any frames still buffered, this is
834 * used to check whether the cleanup timer still needs to run,
835 * if there are no frames we don't need to rearm the timer.
837 return !(skb_queue_empty(&sta->ps_tx_buf[ac]) &&
838 skb_queue_empty(&sta->tx_filtered[ac]));
841 static bool sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
842 struct sta_info *sta)
844 bool have_buffered = false;
847 /* This is only necessary for stations on BSS interfaces */
848 if (!sta->sdata->bss)
851 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++)
853 sta_info_cleanup_expire_buffered_ac(local, sta, ac);
855 return have_buffered;
858 static int __must_check __sta_info_destroy(struct sta_info *sta)
860 struct ieee80211_local *local;
861 struct ieee80211_sub_if_data *sdata;
874 * Before removing the station from the driver and
875 * rate control, it might still start new aggregation
876 * sessions -- block that to make sure the tear-down
877 * will be sufficient.
879 set_sta_flag(sta, WLAN_STA_BLOCK_BA);
880 ieee80211_sta_tear_down_BA_sessions(sta, true);
882 spin_lock_irqsave(&local->sta_lock, flags);
883 ret = sta_info_hash_del(local, sta);
884 /* this might still be the pending list ... which is fine */
886 list_del(&sta->list);
887 spin_unlock_irqrestore(&local->sta_lock, flags);
891 mutex_lock(&local->key_mtx);
892 for (i = 0; i < NUM_DEFAULT_KEYS; i++)
893 __ieee80211_key_free(key_mtx_dereference(local, sta->gtk[i]));
895 __ieee80211_key_free(key_mtx_dereference(local, sta->ptk));
896 mutex_unlock(&local->key_mtx);
900 if (test_sta_flag(sta, WLAN_STA_PS_STA) ||
901 test_sta_flag(sta, WLAN_STA_PS_DRIVER)) {
904 clear_sta_flag(sta, WLAN_STA_PS_STA);
905 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
907 atomic_dec(&sdata->bss->num_sta_ps);
908 sta_info_recalc_tim(sta);
912 local->sta_generation++;
914 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
915 RCU_INIT_POINTER(sdata->u.vlan.sta, NULL);
918 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
919 sdata = container_of(sdata->bss,
920 struct ieee80211_sub_if_data,
922 drv_sta_remove(local, sdata, &sta->sta);
927 * At this point, after we wait for an RCU grace period,
928 * neither mac80211 nor the driver can reference this
929 * sta struct any more except by still existing timers
930 * associated with this station that we clean up below.
934 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
935 local->total_ps_buffered -= skb_queue_len(&sta->ps_tx_buf[ac]);
936 __skb_queue_purge(&sta->ps_tx_buf[ac]);
937 __skb_queue_purge(&sta->tx_filtered[ac]);
940 #ifdef CONFIG_MAC80211_MESH
941 if (ieee80211_vif_is_mesh(&sdata->vif))
942 mesh_accept_plinks_update(sdata);
945 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
946 wiphy_debug(local->hw.wiphy, "Removed STA %pM\n", sta->sta.addr);
947 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
948 cancel_work_sync(&sta->drv_unblock_wk);
950 cfg80211_del_sta(sdata->dev, sta->sta.addr, GFP_KERNEL);
952 rate_control_remove_sta_debugfs(sta);
953 ieee80211_sta_debugfs_remove(sta);
955 #ifdef CONFIG_MAC80211_MESH
956 if (ieee80211_vif_is_mesh(&sta->sdata->vif)) {
957 mesh_plink_deactivate(sta);
958 del_timer_sync(&sta->plink_timer);
962 __sta_info_free(local, sta);
967 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata, const u8 *addr)
969 struct sta_info *sta;
972 mutex_lock(&sdata->local->sta_mtx);
973 sta = sta_info_get_rx(sdata, addr);
974 ret = __sta_info_destroy(sta);
975 mutex_unlock(&sdata->local->sta_mtx);
980 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
983 struct sta_info *sta;
986 mutex_lock(&sdata->local->sta_mtx);
987 sta = sta_info_get_bss_rx(sdata, addr);
988 ret = __sta_info_destroy(sta);
989 mutex_unlock(&sdata->local->sta_mtx);
994 static void sta_info_cleanup(unsigned long data)
996 struct ieee80211_local *local = (struct ieee80211_local *) data;
997 struct sta_info *sta;
998 bool timer_needed = false;
1001 list_for_each_entry_rcu(sta, &local->sta_list, list)
1002 if (sta_info_cleanup_expire_buffered(local, sta))
1003 timer_needed = true;
1006 if (local->quiescing)
1012 mod_timer(&local->sta_cleanup,
1013 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL));
1016 void sta_info_init(struct ieee80211_local *local)
1018 spin_lock_init(&local->sta_lock);
1019 mutex_init(&local->sta_mtx);
1020 INIT_LIST_HEAD(&local->sta_list);
1021 INIT_LIST_HEAD(&local->sta_pending_list);
1022 INIT_WORK(&local->sta_finish_work, sta_info_finish_work);
1024 setup_timer(&local->sta_cleanup, sta_info_cleanup,
1025 (unsigned long)local);
1028 void sta_info_stop(struct ieee80211_local *local)
1030 del_timer_sync(&local->sta_cleanup);
1031 sta_info_flush(local, NULL);
1035 * sta_info_flush - flush matching STA entries from the STA table
1037 * Returns the number of removed STA entries.
1039 * @local: local interface data
1040 * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
1042 int sta_info_flush(struct ieee80211_local *local,
1043 struct ieee80211_sub_if_data *sdata)
1045 struct sta_info *sta, *tmp;
1050 mutex_lock(&local->sta_mtx);
1052 sta_info_finish_pending(local);
1054 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
1055 if (!sdata || sdata == sta->sdata)
1056 WARN_ON(__sta_info_destroy(sta));
1058 mutex_unlock(&local->sta_mtx);
1063 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
1064 unsigned long exp_time)
1066 struct ieee80211_local *local = sdata->local;
1067 struct sta_info *sta, *tmp;
1069 mutex_lock(&local->sta_mtx);
1070 list_for_each_entry_safe(sta, tmp, &local->sta_list, list)
1071 if (time_after(jiffies, sta->last_rx + exp_time)) {
1072 #ifdef CONFIG_MAC80211_IBSS_DEBUG
1073 printk(KERN_DEBUG "%s: expiring inactive STA %pM\n",
1074 sdata->name, sta->sta.addr);
1076 WARN_ON(__sta_info_destroy(sta));
1078 mutex_unlock(&local->sta_mtx);
1081 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
1083 const u8 *localaddr)
1085 struct sta_info *sta, *nxt;
1088 * Just return a random station if localaddr is NULL
1089 * ... first in list.
1091 for_each_sta_info(hw_to_local(hw), addr, sta, nxt) {
1093 compare_ether_addr(sta->sdata->vif.addr, localaddr) != 0)
1102 EXPORT_SYMBOL_GPL(ieee80211_find_sta_by_ifaddr);
1104 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
1107 struct sta_info *sta;
1112 sta = sta_info_get_bss(vif_to_sdata(vif), addr);
1121 EXPORT_SYMBOL(ieee80211_find_sta);
1123 static void clear_sta_ps_flags(void *_sta)
1125 struct sta_info *sta = _sta;
1127 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
1128 clear_sta_flag(sta, WLAN_STA_PS_STA);
1131 /* powersave support code */
1132 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta)
1134 struct ieee80211_sub_if_data *sdata = sta->sdata;
1135 struct ieee80211_local *local = sdata->local;
1136 struct sk_buff_head pending;
1137 int filtered = 0, buffered = 0, ac;
1138 unsigned long flags;
1140 clear_sta_flag(sta, WLAN_STA_SP);
1142 BUILD_BUG_ON(BITS_TO_LONGS(STA_TID_NUM) > 1);
1143 sta->driver_buffered_tids = 0;
1145 if (!(local->hw.flags & IEEE80211_HW_AP_LINK_PS))
1146 drv_sta_notify(local, sdata, STA_NOTIFY_AWAKE, &sta->sta);
1148 skb_queue_head_init(&pending);
1150 /* sync with ieee80211_tx_h_unicast_ps_buf */
1151 spin_lock(&sta->ps_lock);
1152 /* Send all buffered frames to the station */
1153 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
1154 int count = skb_queue_len(&pending), tmp;
1156 spin_lock_irqsave(&sta->tx_filtered[ac].lock, flags);
1157 skb_queue_splice_tail_init(&sta->tx_filtered[ac], &pending);
1158 spin_unlock_irqrestore(&sta->tx_filtered[ac].lock, flags);
1159 tmp = skb_queue_len(&pending);
1160 filtered += tmp - count;
1163 spin_lock_irqsave(&sta->ps_tx_buf[ac].lock, flags);
1164 skb_queue_splice_tail_init(&sta->ps_tx_buf[ac], &pending);
1165 spin_unlock_irqrestore(&sta->ps_tx_buf[ac].lock, flags);
1166 tmp = skb_queue_len(&pending);
1167 buffered += tmp - count;
1170 ieee80211_add_pending_skbs_fn(local, &pending, clear_sta_ps_flags, sta);
1171 spin_unlock(&sta->ps_lock);
1173 local->total_ps_buffered -= buffered;
1175 sta_info_recalc_tim(sta);
1177 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
1178 printk(KERN_DEBUG "%s: STA %pM aid %d sending %d filtered/%d PS frames "
1179 "since STA not sleeping anymore\n", sdata->name,
1180 sta->sta.addr, sta->sta.aid, filtered, buffered);
1181 #endif /* CONFIG_MAC80211_VERBOSE_PS_DEBUG */
1184 static void ieee80211_send_null_response(struct ieee80211_sub_if_data *sdata,
1185 struct sta_info *sta, int tid,
1186 enum ieee80211_frame_release_type reason)
1188 struct ieee80211_local *local = sdata->local;
1189 struct ieee80211_qos_hdr *nullfunc;
1190 struct sk_buff *skb;
1191 int size = sizeof(*nullfunc);
1193 bool qos = test_sta_flag(sta, WLAN_STA_WME);
1194 struct ieee80211_tx_info *info;
1197 fc = cpu_to_le16(IEEE80211_FTYPE_DATA |
1198 IEEE80211_STYPE_QOS_NULLFUNC |
1199 IEEE80211_FCTL_FROMDS);
1202 fc = cpu_to_le16(IEEE80211_FTYPE_DATA |
1203 IEEE80211_STYPE_NULLFUNC |
1204 IEEE80211_FCTL_FROMDS);
1207 skb = dev_alloc_skb(local->hw.extra_tx_headroom + size);
1211 skb_reserve(skb, local->hw.extra_tx_headroom);
1213 nullfunc = (void *) skb_put(skb, size);
1214 nullfunc->frame_control = fc;
1215 nullfunc->duration_id = 0;
1216 memcpy(nullfunc->addr1, sta->sta.addr, ETH_ALEN);
1217 memcpy(nullfunc->addr2, sdata->vif.addr, ETH_ALEN);
1218 memcpy(nullfunc->addr3, sdata->vif.addr, ETH_ALEN);
1219 nullfunc->seq_ctrl = 0;
1221 skb->priority = tid;
1222 skb_set_queue_mapping(skb, ieee802_1d_to_ac[tid]);
1224 nullfunc->qos_ctrl = cpu_to_le16(tid);
1226 if (reason == IEEE80211_FRAME_RELEASE_UAPSD)
1227 nullfunc->qos_ctrl |=
1228 cpu_to_le16(IEEE80211_QOS_CTL_EOSP);
1231 info = IEEE80211_SKB_CB(skb);
1234 * Tell TX path to send this frame even though the
1235 * STA may still remain is PS mode after this frame
1236 * exchange. Also set EOSP to indicate this packet
1237 * ends the poll/service period.
1239 info->flags |= IEEE80211_TX_CTL_POLL_RESPONSE |
1240 IEEE80211_TX_STATUS_EOSP |
1241 IEEE80211_TX_CTL_REQ_TX_STATUS;
1243 drv_allow_buffered_frames(local, sta, BIT(tid), 1, reason, false);
1245 ieee80211_xmit(sdata, skb);
1249 ieee80211_sta_ps_deliver_response(struct sta_info *sta,
1250 int n_frames, u8 ignored_acs,
1251 enum ieee80211_frame_release_type reason)
1253 struct ieee80211_sub_if_data *sdata = sta->sdata;
1254 struct ieee80211_local *local = sdata->local;
1256 bool more_data = false;
1258 unsigned long driver_release_tids = 0;
1259 struct sk_buff_head frames;
1261 /* Service or PS-Poll period starts */
1262 set_sta_flag(sta, WLAN_STA_SP);
1264 __skb_queue_head_init(&frames);
1267 * Get response frame(s) and more data bit for it.
1269 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
1272 if (ignored_acs & BIT(ac))
1275 tids = ieee80211_tids_for_ac(ac);
1278 driver_release_tids = sta->driver_buffered_tids & tids;
1279 if (driver_release_tids) {
1282 struct sk_buff *skb;
1284 while (n_frames > 0) {
1285 skb = skb_dequeue(&sta->tx_filtered[ac]);
1288 &sta->ps_tx_buf[ac]);
1290 local->total_ps_buffered--;
1296 __skb_queue_tail(&frames, skb);
1301 * If the driver has data on more than one TID then
1302 * certainly there's more data if we release just a
1303 * single frame now (from a single TID).
1305 if (reason == IEEE80211_FRAME_RELEASE_PSPOLL &&
1306 hweight16(driver_release_tids) > 1) {
1308 driver_release_tids =
1309 BIT(ffs(driver_release_tids) - 1);
1314 if (!skb_queue_empty(&sta->tx_filtered[ac]) ||
1315 !skb_queue_empty(&sta->ps_tx_buf[ac])) {
1325 * For PS-Poll, this can only happen due to a race condition
1326 * when we set the TIM bit and the station notices it, but
1327 * before it can poll for the frame we expire it.
1329 * For uAPSD, this is said in the standard (11.2.1.5 h):
1330 * At each unscheduled SP for a non-AP STA, the AP shall
1331 * attempt to transmit at least one MSDU or MMPDU, but no
1332 * more than the value specified in the Max SP Length field
1333 * in the QoS Capability element from delivery-enabled ACs,
1334 * that are destined for the non-AP STA.
1336 * Since we have no other MSDU/MMPDU, transmit a QoS null frame.
1339 /* This will evaluate to 1, 3, 5 or 7. */
1340 tid = 7 - ((ffs(~ignored_acs) - 1) << 1);
1342 ieee80211_send_null_response(sdata, sta, tid, reason);
1346 if (!driver_release_tids) {
1347 struct sk_buff_head pending;
1348 struct sk_buff *skb;
1352 skb_queue_head_init(&pending);
1354 while ((skb = __skb_dequeue(&frames))) {
1355 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
1356 struct ieee80211_hdr *hdr = (void *) skb->data;
1362 * Tell TX path to send this frame even though the
1363 * STA may still remain is PS mode after this frame
1366 info->flags |= IEEE80211_TX_CTL_POLL_RESPONSE;
1369 * Use MoreData flag to indicate whether there are
1370 * more buffered frames for this STA
1372 if (more_data || !skb_queue_empty(&frames))
1373 hdr->frame_control |=
1374 cpu_to_le16(IEEE80211_FCTL_MOREDATA);
1376 hdr->frame_control &=
1377 cpu_to_le16(~IEEE80211_FCTL_MOREDATA);
1379 if (ieee80211_is_data_qos(hdr->frame_control) ||
1380 ieee80211_is_qos_nullfunc(hdr->frame_control))
1381 qoshdr = ieee80211_get_qos_ctl(hdr);
1383 /* set EOSP for the frame */
1384 if (reason == IEEE80211_FRAME_RELEASE_UAPSD &&
1385 qoshdr && skb_queue_empty(&frames))
1386 *qoshdr |= IEEE80211_QOS_CTL_EOSP;
1388 info->flags |= IEEE80211_TX_STATUS_EOSP |
1389 IEEE80211_TX_CTL_REQ_TX_STATUS;
1392 tids |= BIT(*qoshdr & IEEE80211_QOS_CTL_TID_MASK);
1396 __skb_queue_tail(&pending, skb);
1399 drv_allow_buffered_frames(local, sta, tids, num,
1402 ieee80211_add_pending_skbs(local, &pending);
1404 sta_info_recalc_tim(sta);
1407 * We need to release a frame that is buffered somewhere in the
1408 * driver ... it'll have to handle that.
1409 * Note that, as per the comment above, it'll also have to see
1410 * if there is more than just one frame on the specific TID that
1411 * we're releasing from, and it needs to set the more-data bit
1412 * accordingly if we tell it that there's no more data. If we do
1413 * tell it there's more data, then of course the more-data bit
1414 * needs to be set anyway.
1416 drv_release_buffered_frames(local, sta, driver_release_tids,
1417 n_frames, reason, more_data);
1420 * Note that we don't recalculate the TIM bit here as it would
1421 * most likely have no effect at all unless the driver told us
1422 * that the TID became empty before returning here from the
1424 * Either way, however, when the driver tells us that the TID
1425 * became empty we'll do the TIM recalculation.
1430 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta)
1432 u8 ignore_for_response = sta->sta.uapsd_queues;
1435 * If all ACs are delivery-enabled then we should reply
1436 * from any of them, if only some are enabled we reply
1437 * only from the non-enabled ones.
1439 if (ignore_for_response == BIT(IEEE80211_NUM_ACS) - 1)
1440 ignore_for_response = 0;
1442 ieee80211_sta_ps_deliver_response(sta, 1, ignore_for_response,
1443 IEEE80211_FRAME_RELEASE_PSPOLL);
1446 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta)
1448 int n_frames = sta->sta.max_sp;
1449 u8 delivery_enabled = sta->sta.uapsd_queues;
1452 * If we ever grow support for TSPEC this might happen if
1453 * the TSPEC update from hostapd comes in between a trigger
1454 * frame setting WLAN_STA_UAPSD in the RX path and this
1455 * actually getting called.
1457 if (!delivery_enabled)
1460 switch (sta->sta.max_sp) {
1471 /* XXX: what is a good value? */
1476 ieee80211_sta_ps_deliver_response(sta, n_frames, ~delivery_enabled,
1477 IEEE80211_FRAME_RELEASE_UAPSD);
1480 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
1481 struct ieee80211_sta *pubsta, bool block)
1483 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1485 trace_api_sta_block_awake(sta->local, pubsta, block);
1488 set_sta_flag(sta, WLAN_STA_PS_DRIVER);
1489 else if (test_sta_flag(sta, WLAN_STA_PS_DRIVER))
1490 ieee80211_queue_work(hw, &sta->drv_unblock_wk);
1492 EXPORT_SYMBOL(ieee80211_sta_block_awake);
1494 void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta *pubsta)
1496 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1497 struct ieee80211_local *local = sta->local;
1498 struct sk_buff *skb;
1499 struct skb_eosp_msg_data *data;
1501 trace_api_eosp(local, pubsta);
1503 skb = alloc_skb(0, GFP_ATOMIC);
1505 /* too bad ... but race is better than loss */
1506 clear_sta_flag(sta, WLAN_STA_SP);
1510 data = (void *)skb->cb;
1511 memcpy(data->sta, pubsta->addr, ETH_ALEN);
1512 memcpy(data->iface, sta->sdata->vif.addr, ETH_ALEN);
1513 skb->pkt_type = IEEE80211_EOSP_MSG;
1514 skb_queue_tail(&local->skb_queue, skb);
1515 tasklet_schedule(&local->tasklet);
1517 EXPORT_SYMBOL(ieee80211_sta_eosp_irqsafe);
1519 void ieee80211_sta_set_buffered(struct ieee80211_sta *pubsta,
1520 u8 tid, bool buffered)
1522 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1524 if (WARN_ON(tid >= STA_TID_NUM))
1528 set_bit(tid, &sta->driver_buffered_tids);
1530 clear_bit(tid, &sta->driver_buffered_tids);
1532 sta_info_recalc_tim(sta);
1534 EXPORT_SYMBOL(ieee80211_sta_set_buffered);