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);
367 printk(KERN_DEBUG "%s: failed to add IBSS STA %pM to "
368 "driver (%d) - keeping it anyway.\n",
369 sdata->name, sta->sta.addr, err);
371 sta->uploaded = true;
372 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
374 wiphy_debug(local->hw.wiphy,
375 "Finished adding IBSS STA %pM\n",
383 if (!dummy_reinsert) {
386 local->sta_generation++;
389 /* make the station visible */
390 spin_lock_irqsave(&local->sta_lock, flags);
391 sta_info_hash_add(local, sta);
392 spin_unlock_irqrestore(&local->sta_lock, flags);
395 list_add(&sta->list, &local->sta_list);
401 ieee80211_sta_debugfs_add(sta);
402 rate_control_add_sta_debugfs(sta);
404 sinfo->generation = local->sta_generation;
405 cfg80211_new_sta(sdata->dev, sta->sta.addr, sinfo, GFP_KERNEL);
412 static void sta_info_finish_pending(struct ieee80211_local *local)
414 struct sta_info *sta;
417 spin_lock_irqsave(&local->sta_lock, flags);
418 while (!list_empty(&local->sta_pending_list)) {
419 sta = list_first_entry(&local->sta_pending_list,
420 struct sta_info, list);
421 list_del(&sta->list);
422 spin_unlock_irqrestore(&local->sta_lock, flags);
424 sta_info_finish_insert(sta, true, false);
426 spin_lock_irqsave(&local->sta_lock, flags);
428 spin_unlock_irqrestore(&local->sta_lock, flags);
431 static void sta_info_finish_work(struct work_struct *work)
433 struct ieee80211_local *local =
434 container_of(work, struct ieee80211_local, sta_finish_work);
436 mutex_lock(&local->sta_mtx);
437 sta_info_finish_pending(local);
438 mutex_unlock(&local->sta_mtx);
441 static int sta_info_insert_check(struct sta_info *sta)
443 struct ieee80211_sub_if_data *sdata = sta->sdata;
446 * Can't be a WARN_ON because it can be triggered through a race:
447 * something inserts a STA (on one CPU) without holding the RTNL
448 * and another CPU turns off the net device.
450 if (unlikely(!ieee80211_sdata_running(sdata)))
453 if (WARN_ON(compare_ether_addr(sta->sta.addr, sdata->vif.addr) == 0 ||
454 is_multicast_ether_addr(sta->sta.addr)))
460 static int sta_info_insert_ibss(struct sta_info *sta) __acquires(RCU)
462 struct ieee80211_local *local = sta->local;
463 struct ieee80211_sub_if_data *sdata = sta->sdata;
466 spin_lock_irqsave(&local->sta_lock, flags);
467 /* check if STA exists already */
468 if (sta_info_get_bss_rx(sdata, sta->sta.addr)) {
469 spin_unlock_irqrestore(&local->sta_lock, flags);
475 local->sta_generation++;
477 sta_info_hash_add(local, sta);
479 list_add_tail(&sta->list, &local->sta_pending_list);
482 spin_unlock_irqrestore(&local->sta_lock, flags);
484 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
485 wiphy_debug(local->hw.wiphy, "Added IBSS STA %pM\n",
487 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
489 ieee80211_queue_work(&local->hw, &local->sta_finish_work);
495 * should be called with sta_mtx locked
496 * this function replaces the mutex lock
499 static int sta_info_insert_non_ibss(struct sta_info *sta) __acquires(RCU)
501 struct ieee80211_local *local = sta->local;
502 struct ieee80211_sub_if_data *sdata = sta->sdata;
504 struct sta_info *exist_sta;
505 bool dummy_reinsert = false;
508 lockdep_assert_held(&local->sta_mtx);
511 * On first glance, this will look racy, because the code
512 * in this function, which inserts a station with sleeping,
513 * unlocks the sta_lock between checking existence in the
514 * hash table and inserting into it.
516 * However, it is not racy against itself because it keeps
520 spin_lock_irqsave(&local->sta_lock, flags);
522 * check if STA exists already.
523 * only accept a scenario of a second call to sta_info_insert_non_ibss
524 * with a dummy station entry that was inserted earlier
525 * in that case - assume that the dummy station flag should
528 exist_sta = sta_info_get_bss_rx(sdata, sta->sta.addr);
530 if (exist_sta == sta && sta->dummy) {
531 dummy_reinsert = true;
533 spin_unlock_irqrestore(&local->sta_lock, flags);
534 mutex_unlock(&local->sta_mtx);
540 spin_unlock_irqrestore(&local->sta_lock, flags);
542 err = sta_info_finish_insert(sta, false, dummy_reinsert);
544 mutex_unlock(&local->sta_mtx);
549 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
550 wiphy_debug(local->hw.wiphy, "Inserted %sSTA %pM\n",
551 sta->dummy ? "dummy " : "", sta->sta.addr);
552 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
554 /* move reference to rcu-protected */
556 mutex_unlock(&local->sta_mtx);
558 if (ieee80211_vif_is_mesh(&sdata->vif))
559 mesh_accept_plinks_update(sdata);
564 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU)
566 struct ieee80211_local *local = sta->local;
567 struct ieee80211_sub_if_data *sdata = sta->sdata;
570 err = sta_info_insert_check(sta);
577 * In ad-hoc mode, we sometimes need to insert stations
578 * from tasklet context from the RX path. To avoid races,
579 * always do so in that case -- see the comment below.
581 if (sdata->vif.type == NL80211_IFTYPE_ADHOC) {
582 err = sta_info_insert_ibss(sta);
590 * It might seem that the function called below is in race against
591 * the function call above that atomically inserts the station... That,
592 * however, is not true because the above code can only
593 * be invoked for IBSS interfaces, and the below code will
594 * not be -- and the two do not race against each other as
595 * the hash table also keys off the interface.
600 mutex_lock(&local->sta_mtx);
602 err = sta_info_insert_non_ibss(sta);
609 __sta_info_free(local, sta);
613 int sta_info_insert(struct sta_info *sta)
615 int err = sta_info_insert_rcu(sta);
622 /* Caller must hold sta->local->sta_mtx */
623 int sta_info_reinsert(struct sta_info *sta)
625 struct ieee80211_local *local = sta->local;
628 err = sta_info_insert_check(sta);
630 mutex_unlock(&local->sta_mtx);
636 err = sta_info_insert_non_ibss(sta);
641 static inline void __bss_tim_set(struct ieee80211_if_ap *bss, u16 aid)
644 * This format has been mandated by the IEEE specifications,
645 * so this line may not be changed to use the __set_bit() format.
647 bss->tim[aid / 8] |= (1 << (aid % 8));
650 static inline void __bss_tim_clear(struct ieee80211_if_ap *bss, u16 aid)
653 * This format has been mandated by the IEEE specifications,
654 * so this line may not be changed to use the __clear_bit() format.
656 bss->tim[aid / 8] &= ~(1 << (aid % 8));
659 static unsigned long ieee80211_tids_for_ac(int ac)
661 /* If we ever support TIDs > 7, this obviously needs to be adjusted */
663 case IEEE80211_AC_VO:
664 return BIT(6) | BIT(7);
665 case IEEE80211_AC_VI:
666 return BIT(4) | BIT(5);
667 case IEEE80211_AC_BE:
668 return BIT(0) | BIT(3);
669 case IEEE80211_AC_BK:
670 return BIT(1) | BIT(2);
677 void sta_info_recalc_tim(struct sta_info *sta)
679 struct ieee80211_local *local = sta->local;
680 struct ieee80211_if_ap *bss = sta->sdata->bss;
682 bool indicate_tim = false;
683 u8 ignore_for_tim = sta->sta.uapsd_queues;
686 if (WARN_ON_ONCE(!sta->sdata->bss))
689 /* No need to do anything if the driver does all */
690 if (local->hw.flags & IEEE80211_HW_AP_LINK_PS)
697 * If all ACs are delivery-enabled then we should build
698 * the TIM bit for all ACs anyway; if only some are then
699 * we ignore those and build the TIM bit using only the
702 if (ignore_for_tim == BIT(IEEE80211_NUM_ACS) - 1)
705 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
708 if (ignore_for_tim & BIT(ac))
711 indicate_tim |= !skb_queue_empty(&sta->tx_filtered[ac]) ||
712 !skb_queue_empty(&sta->ps_tx_buf[ac]);
716 tids = ieee80211_tids_for_ac(ac);
719 sta->driver_buffered_tids & tids;
723 spin_lock_irqsave(&local->sta_lock, flags);
726 __bss_tim_set(bss, sta->sta.aid);
728 __bss_tim_clear(bss, sta->sta.aid);
730 if (local->ops->set_tim) {
731 local->tim_in_locked_section = true;
732 drv_set_tim(local, &sta->sta, indicate_tim);
733 local->tim_in_locked_section = false;
736 spin_unlock_irqrestore(&local->sta_lock, flags);
739 static bool sta_info_buffer_expired(struct sta_info *sta, struct sk_buff *skb)
741 struct ieee80211_tx_info *info;
747 info = IEEE80211_SKB_CB(skb);
749 /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
750 timeout = (sta->listen_interval *
751 sta->sdata->vif.bss_conf.beacon_int *
753 if (timeout < STA_TX_BUFFER_EXPIRE)
754 timeout = STA_TX_BUFFER_EXPIRE;
755 return time_after(jiffies, info->control.jiffies + timeout);
759 static bool sta_info_cleanup_expire_buffered_ac(struct ieee80211_local *local,
760 struct sta_info *sta, int ac)
766 * First check for frames that should expire on the filtered
767 * queue. Frames here were rejected by the driver and are on
768 * a separate queue to avoid reordering with normal PS-buffered
769 * frames. They also aren't accounted for right now in the
770 * total_ps_buffered counter.
773 spin_lock_irqsave(&sta->tx_filtered[ac].lock, flags);
774 skb = skb_peek(&sta->tx_filtered[ac]);
775 if (sta_info_buffer_expired(sta, skb))
776 skb = __skb_dequeue(&sta->tx_filtered[ac]);
779 spin_unlock_irqrestore(&sta->tx_filtered[ac].lock, flags);
782 * Frames are queued in order, so if this one
783 * hasn't expired yet we can stop testing. If
784 * we actually reached the end of the queue we
785 * also need to stop, of course.
793 * Now also check the normal PS-buffered queue, this will
794 * only find something if the filtered queue was emptied
795 * since the filtered frames are all before the normal PS
799 spin_lock_irqsave(&sta->ps_tx_buf[ac].lock, flags);
800 skb = skb_peek(&sta->ps_tx_buf[ac]);
801 if (sta_info_buffer_expired(sta, skb))
802 skb = __skb_dequeue(&sta->ps_tx_buf[ac]);
805 spin_unlock_irqrestore(&sta->ps_tx_buf[ac].lock, flags);
808 * frames are queued in order, so if this one
809 * hasn't expired yet (or we reached the end of
810 * the queue) we can stop testing
815 local->total_ps_buffered--;
816 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
817 printk(KERN_DEBUG "Buffered frame expired (STA %pM)\n",
824 * Finally, recalculate the TIM bit for this station -- it might
825 * now be clear because the station was too slow to retrieve its
828 sta_info_recalc_tim(sta);
831 * Return whether there are any frames still buffered, this is
832 * used to check whether the cleanup timer still needs to run,
833 * if there are no frames we don't need to rearm the timer.
835 return !(skb_queue_empty(&sta->ps_tx_buf[ac]) &&
836 skb_queue_empty(&sta->tx_filtered[ac]));
839 static bool sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
840 struct sta_info *sta)
842 bool have_buffered = false;
845 /* This is only necessary for stations on BSS interfaces */
846 if (!sta->sdata->bss)
849 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++)
851 sta_info_cleanup_expire_buffered_ac(local, sta, ac);
853 return have_buffered;
856 static int __must_check __sta_info_destroy(struct sta_info *sta)
858 struct ieee80211_local *local;
859 struct ieee80211_sub_if_data *sdata;
872 * Before removing the station from the driver and
873 * rate control, it might still start new aggregation
874 * sessions -- block that to make sure the tear-down
875 * will be sufficient.
877 set_sta_flag(sta, WLAN_STA_BLOCK_BA);
878 ieee80211_sta_tear_down_BA_sessions(sta, true);
880 spin_lock_irqsave(&local->sta_lock, flags);
881 ret = sta_info_hash_del(local, sta);
882 /* this might still be the pending list ... which is fine */
884 list_del(&sta->list);
885 spin_unlock_irqrestore(&local->sta_lock, flags);
889 mutex_lock(&local->key_mtx);
890 for (i = 0; i < NUM_DEFAULT_KEYS; i++)
891 __ieee80211_key_free(key_mtx_dereference(local, sta->gtk[i]));
893 __ieee80211_key_free(key_mtx_dereference(local, sta->ptk));
894 mutex_unlock(&local->key_mtx);
898 if (test_sta_flag(sta, WLAN_STA_PS_STA) ||
899 test_sta_flag(sta, WLAN_STA_PS_DRIVER)) {
902 clear_sta_flag(sta, WLAN_STA_PS_STA);
903 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
905 atomic_dec(&sdata->bss->num_sta_ps);
906 sta_info_recalc_tim(sta);
910 local->sta_generation++;
912 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
913 RCU_INIT_POINTER(sdata->u.vlan.sta, NULL);
916 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
917 sdata = container_of(sdata->bss,
918 struct ieee80211_sub_if_data,
920 drv_sta_remove(local, sdata, &sta->sta);
925 * At this point, after we wait for an RCU grace period,
926 * neither mac80211 nor the driver can reference this
927 * sta struct any more except by still existing timers
928 * associated with this station that we clean up below.
932 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
933 local->total_ps_buffered -= skb_queue_len(&sta->ps_tx_buf[ac]);
934 __skb_queue_purge(&sta->ps_tx_buf[ac]);
935 __skb_queue_purge(&sta->tx_filtered[ac]);
938 #ifdef CONFIG_MAC80211_MESH
939 if (ieee80211_vif_is_mesh(&sdata->vif))
940 mesh_accept_plinks_update(sdata);
943 #ifdef CONFIG_MAC80211_VERBOSE_DEBUG
944 wiphy_debug(local->hw.wiphy, "Removed STA %pM\n", sta->sta.addr);
945 #endif /* CONFIG_MAC80211_VERBOSE_DEBUG */
946 cancel_work_sync(&sta->drv_unblock_wk);
948 cfg80211_del_sta(sdata->dev, sta->sta.addr, GFP_KERNEL);
950 rate_control_remove_sta_debugfs(sta);
951 ieee80211_sta_debugfs_remove(sta);
953 #ifdef CONFIG_MAC80211_MESH
954 if (ieee80211_vif_is_mesh(&sta->sdata->vif)) {
955 mesh_plink_deactivate(sta);
956 del_timer_sync(&sta->plink_timer);
960 __sta_info_free(local, sta);
965 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata, const u8 *addr)
967 struct sta_info *sta;
970 mutex_lock(&sdata->local->sta_mtx);
971 sta = sta_info_get_rx(sdata, addr);
972 ret = __sta_info_destroy(sta);
973 mutex_unlock(&sdata->local->sta_mtx);
978 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
981 struct sta_info *sta;
984 mutex_lock(&sdata->local->sta_mtx);
985 sta = sta_info_get_bss_rx(sdata, addr);
986 ret = __sta_info_destroy(sta);
987 mutex_unlock(&sdata->local->sta_mtx);
992 static void sta_info_cleanup(unsigned long data)
994 struct ieee80211_local *local = (struct ieee80211_local *) data;
995 struct sta_info *sta;
996 bool timer_needed = false;
999 list_for_each_entry_rcu(sta, &local->sta_list, list)
1000 if (sta_info_cleanup_expire_buffered(local, sta))
1001 timer_needed = true;
1004 if (local->quiescing)
1010 mod_timer(&local->sta_cleanup,
1011 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL));
1014 void sta_info_init(struct ieee80211_local *local)
1016 spin_lock_init(&local->sta_lock);
1017 mutex_init(&local->sta_mtx);
1018 INIT_LIST_HEAD(&local->sta_list);
1019 INIT_LIST_HEAD(&local->sta_pending_list);
1020 INIT_WORK(&local->sta_finish_work, sta_info_finish_work);
1022 setup_timer(&local->sta_cleanup, sta_info_cleanup,
1023 (unsigned long)local);
1026 void sta_info_stop(struct ieee80211_local *local)
1028 del_timer_sync(&local->sta_cleanup);
1029 sta_info_flush(local, NULL);
1033 * sta_info_flush - flush matching STA entries from the STA table
1035 * Returns the number of removed STA entries.
1037 * @local: local interface data
1038 * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
1040 int sta_info_flush(struct ieee80211_local *local,
1041 struct ieee80211_sub_if_data *sdata)
1043 struct sta_info *sta, *tmp;
1048 mutex_lock(&local->sta_mtx);
1050 sta_info_finish_pending(local);
1052 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
1053 if (!sdata || sdata == sta->sdata)
1054 WARN_ON(__sta_info_destroy(sta));
1056 mutex_unlock(&local->sta_mtx);
1061 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
1062 unsigned long exp_time)
1064 struct ieee80211_local *local = sdata->local;
1065 struct sta_info *sta, *tmp;
1067 mutex_lock(&local->sta_mtx);
1068 list_for_each_entry_safe(sta, tmp, &local->sta_list, list)
1069 if (time_after(jiffies, sta->last_rx + exp_time)) {
1070 #ifdef CONFIG_MAC80211_IBSS_DEBUG
1071 printk(KERN_DEBUG "%s: expiring inactive STA %pM\n",
1072 sdata->name, sta->sta.addr);
1074 WARN_ON(__sta_info_destroy(sta));
1076 mutex_unlock(&local->sta_mtx);
1079 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
1081 const u8 *localaddr)
1083 struct sta_info *sta, *nxt;
1086 * Just return a random station if localaddr is NULL
1087 * ... first in list.
1089 for_each_sta_info(hw_to_local(hw), addr, sta, nxt) {
1091 compare_ether_addr(sta->sdata->vif.addr, localaddr) != 0)
1100 EXPORT_SYMBOL_GPL(ieee80211_find_sta_by_ifaddr);
1102 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
1105 struct sta_info *sta;
1110 sta = sta_info_get_bss(vif_to_sdata(vif), addr);
1119 EXPORT_SYMBOL(ieee80211_find_sta);
1121 static void clear_sta_ps_flags(void *_sta)
1123 struct sta_info *sta = _sta;
1125 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
1126 clear_sta_flag(sta, WLAN_STA_PS_STA);
1129 /* powersave support code */
1130 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta)
1132 struct ieee80211_sub_if_data *sdata = sta->sdata;
1133 struct ieee80211_local *local = sdata->local;
1134 struct sk_buff_head pending;
1135 int filtered = 0, buffered = 0, ac;
1136 unsigned long flags;
1138 clear_sta_flag(sta, WLAN_STA_SP);
1140 BUILD_BUG_ON(BITS_TO_LONGS(STA_TID_NUM) > 1);
1141 sta->driver_buffered_tids = 0;
1143 if (!(local->hw.flags & IEEE80211_HW_AP_LINK_PS))
1144 drv_sta_notify(local, sdata, STA_NOTIFY_AWAKE, &sta->sta);
1146 skb_queue_head_init(&pending);
1148 /* sync with ieee80211_tx_h_unicast_ps_buf */
1149 spin_lock(&sta->ps_lock);
1150 /* Send all buffered frames to the station */
1151 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
1152 int count = skb_queue_len(&pending), tmp;
1154 spin_lock_irqsave(&sta->tx_filtered[ac].lock, flags);
1155 skb_queue_splice_tail_init(&sta->tx_filtered[ac], &pending);
1156 spin_unlock_irqrestore(&sta->tx_filtered[ac].lock, flags);
1157 tmp = skb_queue_len(&pending);
1158 filtered += tmp - count;
1161 spin_lock_irqsave(&sta->ps_tx_buf[ac].lock, flags);
1162 skb_queue_splice_tail_init(&sta->ps_tx_buf[ac], &pending);
1163 spin_unlock_irqrestore(&sta->ps_tx_buf[ac].lock, flags);
1164 tmp = skb_queue_len(&pending);
1165 buffered += tmp - count;
1168 ieee80211_add_pending_skbs_fn(local, &pending, clear_sta_ps_flags, sta);
1169 spin_unlock(&sta->ps_lock);
1171 local->total_ps_buffered -= buffered;
1173 sta_info_recalc_tim(sta);
1175 #ifdef CONFIG_MAC80211_VERBOSE_PS_DEBUG
1176 printk(KERN_DEBUG "%s: STA %pM aid %d sending %d filtered/%d PS frames "
1177 "since STA not sleeping anymore\n", sdata->name,
1178 sta->sta.addr, sta->sta.aid, filtered, buffered);
1179 #endif /* CONFIG_MAC80211_VERBOSE_PS_DEBUG */
1182 static void ieee80211_send_null_response(struct ieee80211_sub_if_data *sdata,
1183 struct sta_info *sta, int tid,
1184 enum ieee80211_frame_release_type reason)
1186 struct ieee80211_local *local = sdata->local;
1187 struct ieee80211_qos_hdr *nullfunc;
1188 struct sk_buff *skb;
1189 int size = sizeof(*nullfunc);
1191 bool qos = test_sta_flag(sta, WLAN_STA_WME);
1192 struct ieee80211_tx_info *info;
1195 fc = cpu_to_le16(IEEE80211_FTYPE_DATA |
1196 IEEE80211_STYPE_QOS_NULLFUNC |
1197 IEEE80211_FCTL_FROMDS);
1200 fc = cpu_to_le16(IEEE80211_FTYPE_DATA |
1201 IEEE80211_STYPE_NULLFUNC |
1202 IEEE80211_FCTL_FROMDS);
1205 skb = dev_alloc_skb(local->hw.extra_tx_headroom + size);
1209 skb_reserve(skb, local->hw.extra_tx_headroom);
1211 nullfunc = (void *) skb_put(skb, size);
1212 nullfunc->frame_control = fc;
1213 nullfunc->duration_id = 0;
1214 memcpy(nullfunc->addr1, sta->sta.addr, ETH_ALEN);
1215 memcpy(nullfunc->addr2, sdata->vif.addr, ETH_ALEN);
1216 memcpy(nullfunc->addr3, sdata->vif.addr, ETH_ALEN);
1217 nullfunc->seq_ctrl = 0;
1219 skb->priority = tid;
1220 skb_set_queue_mapping(skb, ieee802_1d_to_ac[tid]);
1222 nullfunc->qos_ctrl = cpu_to_le16(tid);
1224 if (reason == IEEE80211_FRAME_RELEASE_UAPSD)
1225 nullfunc->qos_ctrl |=
1226 cpu_to_le16(IEEE80211_QOS_CTL_EOSP);
1229 info = IEEE80211_SKB_CB(skb);
1232 * Tell TX path to send this frame even though the
1233 * STA may still remain is PS mode after this frame
1234 * exchange. Also set EOSP to indicate this packet
1235 * ends the poll/service period.
1237 info->flags |= IEEE80211_TX_CTL_POLL_RESPONSE |
1238 IEEE80211_TX_STATUS_EOSP |
1239 IEEE80211_TX_CTL_REQ_TX_STATUS;
1241 drv_allow_buffered_frames(local, sta, BIT(tid), 1, reason, false);
1243 ieee80211_xmit(sdata, skb);
1247 ieee80211_sta_ps_deliver_response(struct sta_info *sta,
1248 int n_frames, u8 ignored_acs,
1249 enum ieee80211_frame_release_type reason)
1251 struct ieee80211_sub_if_data *sdata = sta->sdata;
1252 struct ieee80211_local *local = sdata->local;
1254 bool more_data = false;
1256 unsigned long driver_release_tids = 0;
1257 struct sk_buff_head frames;
1259 /* Service or PS-Poll period starts */
1260 set_sta_flag(sta, WLAN_STA_SP);
1262 __skb_queue_head_init(&frames);
1265 * Get response frame(s) and more data bit for it.
1267 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
1270 if (ignored_acs & BIT(ac))
1273 tids = ieee80211_tids_for_ac(ac);
1276 driver_release_tids = sta->driver_buffered_tids & tids;
1277 if (driver_release_tids) {
1280 struct sk_buff *skb;
1282 while (n_frames > 0) {
1283 skb = skb_dequeue(&sta->tx_filtered[ac]);
1286 &sta->ps_tx_buf[ac]);
1288 local->total_ps_buffered--;
1294 __skb_queue_tail(&frames, skb);
1299 * If the driver has data on more than one TID then
1300 * certainly there's more data if we release just a
1301 * single frame now (from a single TID).
1303 if (reason == IEEE80211_FRAME_RELEASE_PSPOLL &&
1304 hweight16(driver_release_tids) > 1) {
1306 driver_release_tids =
1307 BIT(ffs(driver_release_tids) - 1);
1312 if (!skb_queue_empty(&sta->tx_filtered[ac]) ||
1313 !skb_queue_empty(&sta->ps_tx_buf[ac])) {
1323 * For PS-Poll, this can only happen due to a race condition
1324 * when we set the TIM bit and the station notices it, but
1325 * before it can poll for the frame we expire it.
1327 * For uAPSD, this is said in the standard (11.2.1.5 h):
1328 * At each unscheduled SP for a non-AP STA, the AP shall
1329 * attempt to transmit at least one MSDU or MMPDU, but no
1330 * more than the value specified in the Max SP Length field
1331 * in the QoS Capability element from delivery-enabled ACs,
1332 * that are destined for the non-AP STA.
1334 * Since we have no other MSDU/MMPDU, transmit a QoS null frame.
1337 /* This will evaluate to 1, 3, 5 or 7. */
1338 tid = 7 - ((ffs(~ignored_acs) - 1) << 1);
1340 ieee80211_send_null_response(sdata, sta, tid, reason);
1344 if (!driver_release_tids) {
1345 struct sk_buff_head pending;
1346 struct sk_buff *skb;
1350 skb_queue_head_init(&pending);
1352 while ((skb = __skb_dequeue(&frames))) {
1353 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
1354 struct ieee80211_hdr *hdr = (void *) skb->data;
1360 * Tell TX path to send this frame even though the
1361 * STA may still remain is PS mode after this frame
1364 info->flags |= IEEE80211_TX_CTL_POLL_RESPONSE;
1367 * Use MoreData flag to indicate whether there are
1368 * more buffered frames for this STA
1370 if (more_data || !skb_queue_empty(&frames))
1371 hdr->frame_control |=
1372 cpu_to_le16(IEEE80211_FCTL_MOREDATA);
1374 hdr->frame_control &=
1375 cpu_to_le16(~IEEE80211_FCTL_MOREDATA);
1377 if (ieee80211_is_data_qos(hdr->frame_control) ||
1378 ieee80211_is_qos_nullfunc(hdr->frame_control))
1379 qoshdr = ieee80211_get_qos_ctl(hdr);
1381 /* set EOSP for the frame */
1382 if (reason == IEEE80211_FRAME_RELEASE_UAPSD &&
1383 qoshdr && skb_queue_empty(&frames))
1384 *qoshdr |= IEEE80211_QOS_CTL_EOSP;
1386 info->flags |= IEEE80211_TX_STATUS_EOSP |
1387 IEEE80211_TX_CTL_REQ_TX_STATUS;
1390 tids |= BIT(*qoshdr & IEEE80211_QOS_CTL_TID_MASK);
1394 __skb_queue_tail(&pending, skb);
1397 drv_allow_buffered_frames(local, sta, tids, num,
1400 ieee80211_add_pending_skbs(local, &pending);
1402 sta_info_recalc_tim(sta);
1405 * We need to release a frame that is buffered somewhere in the
1406 * driver ... it'll have to handle that.
1407 * Note that, as per the comment above, it'll also have to see
1408 * if there is more than just one frame on the specific TID that
1409 * we're releasing from, and it needs to set the more-data bit
1410 * accordingly if we tell it that there's no more data. If we do
1411 * tell it there's more data, then of course the more-data bit
1412 * needs to be set anyway.
1414 drv_release_buffered_frames(local, sta, driver_release_tids,
1415 n_frames, reason, more_data);
1418 * Note that we don't recalculate the TIM bit here as it would
1419 * most likely have no effect at all unless the driver told us
1420 * that the TID became empty before returning here from the
1422 * Either way, however, when the driver tells us that the TID
1423 * became empty we'll do the TIM recalculation.
1428 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta)
1430 u8 ignore_for_response = sta->sta.uapsd_queues;
1433 * If all ACs are delivery-enabled then we should reply
1434 * from any of them, if only some are enabled we reply
1435 * only from the non-enabled ones.
1437 if (ignore_for_response == BIT(IEEE80211_NUM_ACS) - 1)
1438 ignore_for_response = 0;
1440 ieee80211_sta_ps_deliver_response(sta, 1, ignore_for_response,
1441 IEEE80211_FRAME_RELEASE_PSPOLL);
1444 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta)
1446 int n_frames = sta->sta.max_sp;
1447 u8 delivery_enabled = sta->sta.uapsd_queues;
1450 * If we ever grow support for TSPEC this might happen if
1451 * the TSPEC update from hostapd comes in between a trigger
1452 * frame setting WLAN_STA_UAPSD in the RX path and this
1453 * actually getting called.
1455 if (!delivery_enabled)
1458 switch (sta->sta.max_sp) {
1469 /* XXX: what is a good value? */
1474 ieee80211_sta_ps_deliver_response(sta, n_frames, ~delivery_enabled,
1475 IEEE80211_FRAME_RELEASE_UAPSD);
1478 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
1479 struct ieee80211_sta *pubsta, bool block)
1481 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1483 trace_api_sta_block_awake(sta->local, pubsta, block);
1486 set_sta_flag(sta, WLAN_STA_PS_DRIVER);
1487 else if (test_sta_flag(sta, WLAN_STA_PS_DRIVER))
1488 ieee80211_queue_work(hw, &sta->drv_unblock_wk);
1490 EXPORT_SYMBOL(ieee80211_sta_block_awake);
1492 void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta *pubsta)
1494 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1495 struct ieee80211_local *local = sta->local;
1496 struct sk_buff *skb;
1497 struct skb_eosp_msg_data *data;
1499 trace_api_eosp(local, pubsta);
1501 skb = alloc_skb(0, GFP_ATOMIC);
1503 /* too bad ... but race is better than loss */
1504 clear_sta_flag(sta, WLAN_STA_SP);
1508 data = (void *)skb->cb;
1509 memcpy(data->sta, pubsta->addr, ETH_ALEN);
1510 memcpy(data->iface, sta->sdata->vif.addr, ETH_ALEN);
1511 skb->pkt_type = IEEE80211_EOSP_MSG;
1512 skb_queue_tail(&local->skb_queue, skb);
1513 tasklet_schedule(&local->tasklet);
1515 EXPORT_SYMBOL(ieee80211_sta_eosp_irqsafe);
1517 void ieee80211_sta_set_buffered(struct ieee80211_sta *pubsta,
1518 u8 tid, bool buffered)
1520 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1522 if (WARN_ON(tid >= STA_TID_NUM))
1526 set_bit(tid, &sta->driver_buffered_tids);
1528 clear_bit(tid, &sta->driver_buffered_tids);
1530 sta_info_recalc_tim(sta);
1532 EXPORT_SYMBOL(ieee80211_sta_set_buffered);