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/etherdevice.h>
13 #include <linux/netdevice.h>
14 #include <linux/types.h>
15 #include <linux/slab.h>
16 #include <linux/skbuff.h>
17 #include <linux/if_arp.h>
18 #include <linux/timer.h>
19 #include <linux/rtnetlink.h>
21 #include <net/mac80211.h>
22 #include "ieee80211_i.h"
23 #include "driver-ops.h"
26 #include "debugfs_sta.h"
31 * DOC: STA information lifetime rules
33 * STA info structures (&struct sta_info) are managed in a hash table
34 * for faster lookup and a list for iteration. They are managed using
35 * RCU, i.e. access to the list and hash table is protected by RCU.
37 * Upon allocating a STA info structure with sta_info_alloc(), the caller
38 * owns that structure. It must then insert it into the hash table using
39 * either sta_info_insert() or sta_info_insert_rcu(); only in the latter
40 * case (which acquires an rcu read section but must not be called from
41 * within one) will the pointer still be valid after the call. Note that
42 * the caller may not do much with the STA info before inserting it, in
43 * particular, it may not start any mesh peer link management or add
46 * When the insertion fails (sta_info_insert()) returns non-zero), the
47 * structure will have been freed by sta_info_insert()!
49 * Station entries are added by mac80211 when you establish a link with a
50 * peer. This means different things for the different type of interfaces
51 * we support. For a regular station this mean we add the AP sta when we
52 * receive an association response from the AP. For IBSS this occurs when
53 * get to know about a peer on the same IBSS. For WDS we add the sta for
54 * the peer immediately upon device open. When using AP mode we add stations
55 * for each respective station upon request from userspace through nl80211.
57 * In order to remove a STA info structure, various sta_info_destroy_*()
58 * calls are available.
60 * There is no concept of ownership on a STA entry, each structure is
61 * owned by the global hash table/list until it is removed. All users of
62 * the structure need to be RCU protected so that the structure won't be
63 * freed before they are done using it.
66 /* Caller must hold local->sta_mtx */
67 static int sta_info_hash_del(struct ieee80211_local *local,
72 s = rcu_dereference_protected(local->sta_hash[STA_HASH(sta->sta.addr)],
73 lockdep_is_held(&local->sta_mtx));
77 rcu_assign_pointer(local->sta_hash[STA_HASH(sta->sta.addr)],
82 while (rcu_access_pointer(s->hnext) &&
83 rcu_access_pointer(s->hnext) != sta)
84 s = rcu_dereference_protected(s->hnext,
85 lockdep_is_held(&local->sta_mtx));
86 if (rcu_access_pointer(s->hnext)) {
87 rcu_assign_pointer(s->hnext, sta->hnext);
94 static void free_sta_work(struct work_struct *wk)
96 struct sta_info *sta = container_of(wk, struct sta_info, free_sta_wk);
98 struct tid_ampdu_tx *tid_tx;
99 struct ieee80211_sub_if_data *sdata = sta->sdata;
100 struct ieee80211_local *local = sdata->local;
104 * At this point, when being called as call_rcu callback,
105 * neither mac80211 nor the driver can reference this
106 * sta struct any more except by still existing timers
107 * associated with this station that we clean up below.
110 if (test_sta_flag(sta, WLAN_STA_PS_STA)) {
111 if (sta->sdata->vif.type == NL80211_IFTYPE_AP ||
112 sta->sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
113 ps = &sdata->bss->ps;
117 clear_sta_flag(sta, WLAN_STA_PS_STA);
119 atomic_dec(&ps->num_sta_ps);
120 sta_info_recalc_tim(sta);
123 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
124 local->total_ps_buffered -= skb_queue_len(&sta->ps_tx_buf[ac]);
125 __skb_queue_purge(&sta->ps_tx_buf[ac]);
126 __skb_queue_purge(&sta->tx_filtered[ac]);
129 #ifdef CONFIG_MAC80211_MESH
130 if (ieee80211_vif_is_mesh(&sdata->vif)) {
131 mesh_accept_plinks_update(sdata);
132 mesh_plink_deactivate(sta);
133 del_timer_sync(&sta->plink_timer);
137 cancel_work_sync(&sta->drv_unblock_wk);
140 * Destroy aggregation state here. It would be nice to wait for the
141 * driver to finish aggregation stop and then clean up, but for now
142 * drivers have to handle aggregation stop being requested, followed
143 * directly by station destruction.
145 for (i = 0; i < STA_TID_NUM; i++) {
146 tid_tx = rcu_dereference_raw(sta->ampdu_mlme.tid_tx[i]);
149 __skb_queue_purge(&tid_tx->pending);
153 sta_info_free(local, sta);
156 static void free_sta_rcu(struct rcu_head *h)
158 struct sta_info *sta = container_of(h, struct sta_info, rcu_head);
160 ieee80211_queue_work(&sta->local->hw, &sta->free_sta_wk);
163 /* protected by RCU */
164 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
167 struct ieee80211_local *local = sdata->local;
168 struct sta_info *sta;
170 sta = rcu_dereference_check(local->sta_hash[STA_HASH(addr)],
171 lockdep_is_held(&local->sta_mtx));
173 if (sta->sdata == sdata &&
174 ether_addr_equal(sta->sta.addr, addr))
176 sta = rcu_dereference_check(sta->hnext,
177 lockdep_is_held(&local->sta_mtx));
183 * Get sta info either from the specified interface
184 * or from one of its vlans
186 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
189 struct ieee80211_local *local = sdata->local;
190 struct sta_info *sta;
192 sta = rcu_dereference_check(local->sta_hash[STA_HASH(addr)],
193 lockdep_is_held(&local->sta_mtx));
195 if ((sta->sdata == sdata ||
196 (sta->sdata->bss && sta->sdata->bss == sdata->bss)) &&
197 ether_addr_equal(sta->sta.addr, addr))
199 sta = rcu_dereference_check(sta->hnext,
200 lockdep_is_held(&local->sta_mtx));
205 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
208 struct ieee80211_local *local = sdata->local;
209 struct sta_info *sta;
212 list_for_each_entry_rcu(sta, &local->sta_list, list) {
213 if (sdata != sta->sdata)
226 * sta_info_free - free STA
228 * @local: pointer to the global information
229 * @sta: STA info to free
231 * This function must undo everything done by sta_info_alloc()
232 * that may happen before sta_info_insert(). It may only be
233 * called when sta_info_insert() has not been attempted (and
234 * if that fails, the station is freed anyway.)
236 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta)
239 rate_control_free_sta(sta);
241 sta_dbg(sta->sdata, "Destroyed STA %pM\n", sta->sta.addr);
246 /* Caller must hold local->sta_mtx */
247 static void sta_info_hash_add(struct ieee80211_local *local,
248 struct sta_info *sta)
250 lockdep_assert_held(&local->sta_mtx);
251 sta->hnext = local->sta_hash[STA_HASH(sta->sta.addr)];
252 rcu_assign_pointer(local->sta_hash[STA_HASH(sta->sta.addr)], sta);
255 static void sta_unblock(struct work_struct *wk)
257 struct sta_info *sta;
259 sta = container_of(wk, struct sta_info, drv_unblock_wk);
264 if (!test_sta_flag(sta, WLAN_STA_PS_STA)) {
266 ieee80211_sta_ps_deliver_wakeup(sta);
268 } else if (test_and_clear_sta_flag(sta, WLAN_STA_PSPOLL)) {
269 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
272 ieee80211_sta_ps_deliver_poll_response(sta);
274 } else if (test_and_clear_sta_flag(sta, WLAN_STA_UAPSD)) {
275 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
278 ieee80211_sta_ps_deliver_uapsd(sta);
281 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
284 static int sta_prepare_rate_control(struct ieee80211_local *local,
285 struct sta_info *sta, gfp_t gfp)
287 if (local->hw.flags & IEEE80211_HW_HAS_RATE_CONTROL)
290 sta->rate_ctrl = local->rate_ctrl;
291 sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
293 if (!sta->rate_ctrl_priv)
299 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
300 const u8 *addr, gfp_t gfp)
302 struct ieee80211_local *local = sdata->local;
303 struct sta_info *sta;
304 struct timespec uptime;
307 sta = kzalloc(sizeof(*sta) + local->hw.sta_data_size, gfp);
311 spin_lock_init(&sta->lock);
312 INIT_WORK(&sta->drv_unblock_wk, sta_unblock);
313 INIT_WORK(&sta->free_sta_wk, free_sta_work);
314 INIT_WORK(&sta->ampdu_mlme.work, ieee80211_ba_session_work);
315 mutex_init(&sta->ampdu_mlme.mtx);
317 memcpy(sta->sta.addr, addr, ETH_ALEN);
320 sta->last_rx = jiffies;
322 sta->sta_state = IEEE80211_STA_NONE;
324 do_posix_clock_monotonic_gettime(&uptime);
325 sta->last_connected = uptime.tv_sec;
326 ewma_init(&sta->avg_signal, 1024, 8);
328 if (sta_prepare_rate_control(local, sta, gfp)) {
333 for (i = 0; i < STA_TID_NUM; i++) {
335 * timer_to_tid must be initialized with identity mapping
336 * to enable session_timer's data differentiation. See
337 * sta_rx_agg_session_timer_expired for usage.
339 sta->timer_to_tid[i] = i;
341 for (i = 0; i < IEEE80211_NUM_ACS; i++) {
342 skb_queue_head_init(&sta->ps_tx_buf[i]);
343 skb_queue_head_init(&sta->tx_filtered[i]);
346 for (i = 0; i < NUM_RX_DATA_QUEUES; i++)
347 sta->last_seq_ctrl[i] = cpu_to_le16(USHRT_MAX);
349 sta_dbg(sdata, "Allocated STA %pM\n", sta->sta.addr);
351 #ifdef CONFIG_MAC80211_MESH
352 sta->plink_state = NL80211_PLINK_LISTEN;
353 init_timer(&sta->plink_timer);
359 static int sta_info_insert_check(struct sta_info *sta)
361 struct ieee80211_sub_if_data *sdata = sta->sdata;
364 * Can't be a WARN_ON because it can be triggered through a race:
365 * something inserts a STA (on one CPU) without holding the RTNL
366 * and another CPU turns off the net device.
368 if (unlikely(!ieee80211_sdata_running(sdata)))
371 if (WARN_ON(ether_addr_equal(sta->sta.addr, sdata->vif.addr) ||
372 is_multicast_ether_addr(sta->sta.addr)))
378 static int sta_info_insert_drv_state(struct ieee80211_local *local,
379 struct ieee80211_sub_if_data *sdata,
380 struct sta_info *sta)
382 enum ieee80211_sta_state state;
385 for (state = IEEE80211_STA_NOTEXIST; state < sta->sta_state; state++) {
386 err = drv_sta_state(local, sdata, sta, state, state + 1);
393 * Drivers using legacy sta_add/sta_remove callbacks only
394 * get uploaded set to true after sta_add is called.
396 if (!local->ops->sta_add)
397 sta->uploaded = true;
401 if (sdata->vif.type == NL80211_IFTYPE_ADHOC) {
403 "failed to move IBSS STA %pM to state %d (%d) - keeping it anyway\n",
404 sta->sta.addr, state + 1, err);
408 /* unwind on error */
409 for (; state > IEEE80211_STA_NOTEXIST; state--)
410 WARN_ON(drv_sta_state(local, sdata, sta, state, state - 1));
416 * should be called with sta_mtx locked
417 * this function replaces the mutex lock
420 static int sta_info_insert_finish(struct sta_info *sta) __acquires(RCU)
422 struct ieee80211_local *local = sta->local;
423 struct ieee80211_sub_if_data *sdata = sta->sdata;
424 struct station_info sinfo;
427 lockdep_assert_held(&local->sta_mtx);
429 /* check if STA exists already */
430 if (sta_info_get_bss(sdata, sta->sta.addr)) {
436 err = sta_info_insert_drv_state(local, sdata, sta);
441 local->sta_generation++;
444 /* make the station visible */
445 sta_info_hash_add(local, sta);
447 list_add_rcu(&sta->list, &local->sta_list);
449 set_sta_flag(sta, WLAN_STA_INSERTED);
451 ieee80211_sta_debugfs_add(sta);
452 rate_control_add_sta_debugfs(sta);
454 memset(&sinfo, 0, sizeof(sinfo));
456 sinfo.generation = local->sta_generation;
457 cfg80211_new_sta(sdata->dev, sta->sta.addr, &sinfo, GFP_KERNEL);
459 sta_dbg(sdata, "Inserted STA %pM\n", sta->sta.addr);
461 /* move reference to rcu-protected */
463 mutex_unlock(&local->sta_mtx);
465 if (ieee80211_vif_is_mesh(&sdata->vif))
466 mesh_accept_plinks_update(sdata);
470 mutex_unlock(&local->sta_mtx);
475 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU)
477 struct ieee80211_local *local = sta->local;
482 err = sta_info_insert_check(sta);
488 mutex_lock(&local->sta_mtx);
490 err = sta_info_insert_finish(sta);
497 sta_info_free(local, sta);
501 int sta_info_insert(struct sta_info *sta)
503 int err = sta_info_insert_rcu(sta);
510 static inline void __bss_tim_set(u8 *tim, u16 id)
513 * This format has been mandated by the IEEE specifications,
514 * so this line may not be changed to use the __set_bit() format.
516 tim[id / 8] |= (1 << (id % 8));
519 static inline void __bss_tim_clear(u8 *tim, u16 id)
522 * This format has been mandated by the IEEE specifications,
523 * so this line may not be changed to use the __clear_bit() format.
525 tim[id / 8] &= ~(1 << (id % 8));
528 static unsigned long ieee80211_tids_for_ac(int ac)
530 /* If we ever support TIDs > 7, this obviously needs to be adjusted */
532 case IEEE80211_AC_VO:
533 return BIT(6) | BIT(7);
534 case IEEE80211_AC_VI:
535 return BIT(4) | BIT(5);
536 case IEEE80211_AC_BE:
537 return BIT(0) | BIT(3);
538 case IEEE80211_AC_BK:
539 return BIT(1) | BIT(2);
546 void sta_info_recalc_tim(struct sta_info *sta)
548 struct ieee80211_local *local = sta->local;
551 bool indicate_tim = false;
552 u8 ignore_for_tim = sta->sta.uapsd_queues;
556 if (sta->sdata->vif.type == NL80211_IFTYPE_AP ||
557 sta->sdata->vif.type == NL80211_IFTYPE_AP_VLAN) {
558 if (WARN_ON_ONCE(!sta->sdata->bss))
561 ps = &sta->sdata->bss->ps;
567 /* No need to do anything if the driver does all */
568 if (local->hw.flags & IEEE80211_HW_AP_LINK_PS)
575 * If all ACs are delivery-enabled then we should build
576 * the TIM bit for all ACs anyway; if only some are then
577 * we ignore those and build the TIM bit using only the
580 if (ignore_for_tim == BIT(IEEE80211_NUM_ACS) - 1)
583 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
586 if (ignore_for_tim & BIT(ac))
589 indicate_tim |= !skb_queue_empty(&sta->tx_filtered[ac]) ||
590 !skb_queue_empty(&sta->ps_tx_buf[ac]);
594 tids = ieee80211_tids_for_ac(ac);
597 sta->driver_buffered_tids & tids;
601 spin_lock_irqsave(&local->tim_lock, flags);
604 __bss_tim_set(ps->tim, id);
606 __bss_tim_clear(ps->tim, id);
608 if (local->ops->set_tim) {
609 local->tim_in_locked_section = true;
610 drv_set_tim(local, &sta->sta, indicate_tim);
611 local->tim_in_locked_section = false;
614 spin_unlock_irqrestore(&local->tim_lock, flags);
617 static bool sta_info_buffer_expired(struct sta_info *sta, struct sk_buff *skb)
619 struct ieee80211_tx_info *info;
625 info = IEEE80211_SKB_CB(skb);
627 /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
628 timeout = (sta->listen_interval *
629 sta->sdata->vif.bss_conf.beacon_int *
631 if (timeout < STA_TX_BUFFER_EXPIRE)
632 timeout = STA_TX_BUFFER_EXPIRE;
633 return time_after(jiffies, info->control.jiffies + timeout);
637 static bool sta_info_cleanup_expire_buffered_ac(struct ieee80211_local *local,
638 struct sta_info *sta, int ac)
644 * First check for frames that should expire on the filtered
645 * queue. Frames here were rejected by the driver and are on
646 * a separate queue to avoid reordering with normal PS-buffered
647 * frames. They also aren't accounted for right now in the
648 * total_ps_buffered counter.
651 spin_lock_irqsave(&sta->tx_filtered[ac].lock, flags);
652 skb = skb_peek(&sta->tx_filtered[ac]);
653 if (sta_info_buffer_expired(sta, skb))
654 skb = __skb_dequeue(&sta->tx_filtered[ac]);
657 spin_unlock_irqrestore(&sta->tx_filtered[ac].lock, flags);
660 * Frames are queued in order, so if this one
661 * hasn't expired yet we can stop testing. If
662 * we actually reached the end of the queue we
663 * also need to stop, of course.
671 * Now also check the normal PS-buffered queue, this will
672 * only find something if the filtered queue was emptied
673 * since the filtered frames are all before the normal PS
677 spin_lock_irqsave(&sta->ps_tx_buf[ac].lock, flags);
678 skb = skb_peek(&sta->ps_tx_buf[ac]);
679 if (sta_info_buffer_expired(sta, skb))
680 skb = __skb_dequeue(&sta->ps_tx_buf[ac]);
683 spin_unlock_irqrestore(&sta->ps_tx_buf[ac].lock, flags);
686 * frames are queued in order, so if this one
687 * hasn't expired yet (or we reached the end of
688 * the queue) we can stop testing
693 local->total_ps_buffered--;
694 ps_dbg(sta->sdata, "Buffered frame expired (STA %pM)\n",
700 * Finally, recalculate the TIM bit for this station -- it might
701 * now be clear because the station was too slow to retrieve its
704 sta_info_recalc_tim(sta);
707 * Return whether there are any frames still buffered, this is
708 * used to check whether the cleanup timer still needs to run,
709 * if there are no frames we don't need to rearm the timer.
711 return !(skb_queue_empty(&sta->ps_tx_buf[ac]) &&
712 skb_queue_empty(&sta->tx_filtered[ac]));
715 static bool sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
716 struct sta_info *sta)
718 bool have_buffered = false;
721 /* This is only necessary for stations on BSS interfaces */
722 if (!sta->sdata->bss)
725 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++)
727 sta_info_cleanup_expire_buffered_ac(local, sta, ac);
729 return have_buffered;
732 int __must_check __sta_info_destroy(struct sta_info *sta)
734 struct ieee80211_local *local;
735 struct ieee80211_sub_if_data *sdata;
746 lockdep_assert_held(&local->sta_mtx);
749 * Before removing the station from the driver and
750 * rate control, it might still start new aggregation
751 * sessions -- block that to make sure the tear-down
752 * will be sufficient.
754 set_sta_flag(sta, WLAN_STA_BLOCK_BA);
755 ieee80211_sta_tear_down_BA_sessions(sta, false);
757 ret = sta_info_hash_del(local, sta);
761 list_del_rcu(&sta->list);
763 mutex_lock(&local->key_mtx);
764 for (i = 0; i < NUM_DEFAULT_KEYS; i++)
765 __ieee80211_key_free(key_mtx_dereference(local, sta->gtk[i]));
767 __ieee80211_key_free(key_mtx_dereference(local, sta->ptk));
768 mutex_unlock(&local->key_mtx);
773 local->sta_generation++;
775 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
776 RCU_INIT_POINTER(sdata->u.vlan.sta, NULL);
778 while (sta->sta_state > IEEE80211_STA_NONE) {
779 ret = sta_info_move_state(sta, sta->sta_state - 1);
787 ret = drv_sta_state(local, sdata, sta, IEEE80211_STA_NONE,
788 IEEE80211_STA_NOTEXIST);
789 WARN_ON_ONCE(ret != 0);
792 sta_dbg(sdata, "Removed STA %pM\n", sta->sta.addr);
794 cfg80211_del_sta(sdata->dev, sta->sta.addr, GFP_KERNEL);
796 rate_control_remove_sta_debugfs(sta);
797 ieee80211_sta_debugfs_remove(sta);
799 call_rcu(&sta->rcu_head, free_sta_rcu);
804 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata, const u8 *addr)
806 struct sta_info *sta;
809 mutex_lock(&sdata->local->sta_mtx);
810 sta = sta_info_get(sdata, addr);
811 ret = __sta_info_destroy(sta);
812 mutex_unlock(&sdata->local->sta_mtx);
817 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
820 struct sta_info *sta;
823 mutex_lock(&sdata->local->sta_mtx);
824 sta = sta_info_get_bss(sdata, addr);
825 ret = __sta_info_destroy(sta);
826 mutex_unlock(&sdata->local->sta_mtx);
831 static void sta_info_cleanup(unsigned long data)
833 struct ieee80211_local *local = (struct ieee80211_local *) data;
834 struct sta_info *sta;
835 bool timer_needed = false;
838 list_for_each_entry_rcu(sta, &local->sta_list, list)
839 if (sta_info_cleanup_expire_buffered(local, sta))
843 if (local->quiescing)
849 mod_timer(&local->sta_cleanup,
850 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL));
853 void sta_info_init(struct ieee80211_local *local)
855 spin_lock_init(&local->tim_lock);
856 mutex_init(&local->sta_mtx);
857 INIT_LIST_HEAD(&local->sta_list);
859 setup_timer(&local->sta_cleanup, sta_info_cleanup,
860 (unsigned long)local);
863 void sta_info_stop(struct ieee80211_local *local)
865 del_timer(&local->sta_cleanup);
866 sta_info_flush(local, NULL);
870 * sta_info_flush - flush matching STA entries from the STA table
872 * Returns the number of removed STA entries.
874 * @local: local interface data
875 * @sdata: matching rule for the net device (sta->dev) or %NULL to match all STAs
877 int sta_info_flush(struct ieee80211_local *local,
878 struct ieee80211_sub_if_data *sdata)
880 struct sta_info *sta, *tmp;
885 mutex_lock(&local->sta_mtx);
886 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
887 if (!sdata || sdata == sta->sdata) {
888 WARN_ON(__sta_info_destroy(sta));
892 mutex_unlock(&local->sta_mtx);
897 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
898 unsigned long exp_time)
900 struct ieee80211_local *local = sdata->local;
901 struct sta_info *sta, *tmp;
903 mutex_lock(&local->sta_mtx);
905 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
906 if (sdata != sta->sdata)
909 if (time_after(jiffies, sta->last_rx + exp_time)) {
910 sta_dbg(sta->sdata, "expiring inactive STA %pM\n",
912 WARN_ON(__sta_info_destroy(sta));
916 mutex_unlock(&local->sta_mtx);
919 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
923 struct sta_info *sta, *nxt;
926 * Just return a random station if localaddr is NULL
929 for_each_sta_info(hw_to_local(hw), addr, sta, nxt) {
931 !ether_addr_equal(sta->sdata->vif.addr, localaddr))
940 EXPORT_SYMBOL_GPL(ieee80211_find_sta_by_ifaddr);
942 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
945 struct sta_info *sta;
950 sta = sta_info_get_bss(vif_to_sdata(vif), addr);
959 EXPORT_SYMBOL(ieee80211_find_sta);
961 static void clear_sta_ps_flags(void *_sta)
963 struct sta_info *sta = _sta;
964 struct ieee80211_sub_if_data *sdata = sta->sdata;
967 if (sdata->vif.type == NL80211_IFTYPE_AP ||
968 sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
969 ps = &sdata->bss->ps;
973 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
974 if (test_and_clear_sta_flag(sta, WLAN_STA_PS_STA))
975 atomic_dec(&ps->num_sta_ps);
978 /* powersave support code */
979 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta)
981 struct ieee80211_sub_if_data *sdata = sta->sdata;
982 struct ieee80211_local *local = sdata->local;
983 struct sk_buff_head pending;
984 int filtered = 0, buffered = 0, ac;
986 clear_sta_flag(sta, WLAN_STA_SP);
988 BUILD_BUG_ON(BITS_TO_LONGS(STA_TID_NUM) > 1);
989 sta->driver_buffered_tids = 0;
991 if (!(local->hw.flags & IEEE80211_HW_AP_LINK_PS))
992 drv_sta_notify(local, sdata, STA_NOTIFY_AWAKE, &sta->sta);
994 skb_queue_head_init(&pending);
996 /* Send all buffered frames to the station */
997 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
998 int count = skb_queue_len(&pending), tmp;
1000 skb_queue_splice_tail_init(&sta->tx_filtered[ac], &pending);
1001 tmp = skb_queue_len(&pending);
1002 filtered += tmp - count;
1005 skb_queue_splice_tail_init(&sta->ps_tx_buf[ac], &pending);
1006 tmp = skb_queue_len(&pending);
1007 buffered += tmp - count;
1010 ieee80211_add_pending_skbs_fn(local, &pending, clear_sta_ps_flags, sta);
1012 local->total_ps_buffered -= buffered;
1014 sta_info_recalc_tim(sta);
1017 "STA %pM aid %d sending %d filtered/%d PS frames since STA not sleeping anymore\n",
1018 sta->sta.addr, sta->sta.aid, filtered, buffered);
1021 static void ieee80211_send_null_response(struct ieee80211_sub_if_data *sdata,
1022 struct sta_info *sta, int tid,
1023 enum ieee80211_frame_release_type reason)
1025 struct ieee80211_local *local = sdata->local;
1026 struct ieee80211_qos_hdr *nullfunc;
1027 struct sk_buff *skb;
1028 int size = sizeof(*nullfunc);
1030 bool qos = test_sta_flag(sta, WLAN_STA_WME);
1031 struct ieee80211_tx_info *info;
1032 struct ieee80211_chanctx_conf *chanctx_conf;
1035 fc = cpu_to_le16(IEEE80211_FTYPE_DATA |
1036 IEEE80211_STYPE_QOS_NULLFUNC |
1037 IEEE80211_FCTL_FROMDS);
1040 fc = cpu_to_le16(IEEE80211_FTYPE_DATA |
1041 IEEE80211_STYPE_NULLFUNC |
1042 IEEE80211_FCTL_FROMDS);
1045 skb = dev_alloc_skb(local->hw.extra_tx_headroom + size);
1049 skb_reserve(skb, local->hw.extra_tx_headroom);
1051 nullfunc = (void *) skb_put(skb, size);
1052 nullfunc->frame_control = fc;
1053 nullfunc->duration_id = 0;
1054 memcpy(nullfunc->addr1, sta->sta.addr, ETH_ALEN);
1055 memcpy(nullfunc->addr2, sdata->vif.addr, ETH_ALEN);
1056 memcpy(nullfunc->addr3, sdata->vif.addr, ETH_ALEN);
1058 skb->priority = tid;
1059 skb_set_queue_mapping(skb, ieee802_1d_to_ac[tid]);
1061 nullfunc->qos_ctrl = cpu_to_le16(tid);
1063 if (reason == IEEE80211_FRAME_RELEASE_UAPSD)
1064 nullfunc->qos_ctrl |=
1065 cpu_to_le16(IEEE80211_QOS_CTL_EOSP);
1068 info = IEEE80211_SKB_CB(skb);
1071 * Tell TX path to send this frame even though the
1072 * STA may still remain is PS mode after this frame
1073 * exchange. Also set EOSP to indicate this packet
1074 * ends the poll/service period.
1076 info->flags |= IEEE80211_TX_CTL_NO_PS_BUFFER |
1077 IEEE80211_TX_STATUS_EOSP |
1078 IEEE80211_TX_CTL_REQ_TX_STATUS;
1080 drv_allow_buffered_frames(local, sta, BIT(tid), 1, reason, false);
1083 chanctx_conf = rcu_dereference(sdata->vif.chanctx_conf);
1084 if (WARN_ON(!chanctx_conf)) {
1090 ieee80211_xmit(sdata, skb, chanctx_conf->channel->band);
1095 ieee80211_sta_ps_deliver_response(struct sta_info *sta,
1096 int n_frames, u8 ignored_acs,
1097 enum ieee80211_frame_release_type reason)
1099 struct ieee80211_sub_if_data *sdata = sta->sdata;
1100 struct ieee80211_local *local = sdata->local;
1102 bool more_data = false;
1104 unsigned long driver_release_tids = 0;
1105 struct sk_buff_head frames;
1107 /* Service or PS-Poll period starts */
1108 set_sta_flag(sta, WLAN_STA_SP);
1110 __skb_queue_head_init(&frames);
1113 * Get response frame(s) and more data bit for it.
1115 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
1118 if (ignored_acs & BIT(ac))
1121 tids = ieee80211_tids_for_ac(ac);
1124 driver_release_tids = sta->driver_buffered_tids & tids;
1125 if (driver_release_tids) {
1128 struct sk_buff *skb;
1130 while (n_frames > 0) {
1131 skb = skb_dequeue(&sta->tx_filtered[ac]);
1134 &sta->ps_tx_buf[ac]);
1136 local->total_ps_buffered--;
1142 __skb_queue_tail(&frames, skb);
1147 * If the driver has data on more than one TID then
1148 * certainly there's more data if we release just a
1149 * single frame now (from a single TID).
1151 if (reason == IEEE80211_FRAME_RELEASE_PSPOLL &&
1152 hweight16(driver_release_tids) > 1) {
1154 driver_release_tids =
1155 BIT(ffs(driver_release_tids) - 1);
1160 if (!skb_queue_empty(&sta->tx_filtered[ac]) ||
1161 !skb_queue_empty(&sta->ps_tx_buf[ac])) {
1171 * For PS-Poll, this can only happen due to a race condition
1172 * when we set the TIM bit and the station notices it, but
1173 * before it can poll for the frame we expire it.
1175 * For uAPSD, this is said in the standard (11.2.1.5 h):
1176 * At each unscheduled SP for a non-AP STA, the AP shall
1177 * attempt to transmit at least one MSDU or MMPDU, but no
1178 * more than the value specified in the Max SP Length field
1179 * in the QoS Capability element from delivery-enabled ACs,
1180 * that are destined for the non-AP STA.
1182 * Since we have no other MSDU/MMPDU, transmit a QoS null frame.
1185 /* This will evaluate to 1, 3, 5 or 7. */
1186 tid = 7 - ((ffs(~ignored_acs) - 1) << 1);
1188 ieee80211_send_null_response(sdata, sta, tid, reason);
1192 if (!driver_release_tids) {
1193 struct sk_buff_head pending;
1194 struct sk_buff *skb;
1198 skb_queue_head_init(&pending);
1200 while ((skb = __skb_dequeue(&frames))) {
1201 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
1202 struct ieee80211_hdr *hdr = (void *) skb->data;
1208 * Tell TX path to send this frame even though the
1209 * STA may still remain is PS mode after this frame
1212 info->flags |= IEEE80211_TX_CTL_NO_PS_BUFFER;
1215 * Use MoreData flag to indicate whether there are
1216 * more buffered frames for this STA
1218 if (more_data || !skb_queue_empty(&frames))
1219 hdr->frame_control |=
1220 cpu_to_le16(IEEE80211_FCTL_MOREDATA);
1222 hdr->frame_control &=
1223 cpu_to_le16(~IEEE80211_FCTL_MOREDATA);
1225 if (ieee80211_is_data_qos(hdr->frame_control) ||
1226 ieee80211_is_qos_nullfunc(hdr->frame_control))
1227 qoshdr = ieee80211_get_qos_ctl(hdr);
1229 /* end service period after last frame */
1230 if (skb_queue_empty(&frames)) {
1231 if (reason == IEEE80211_FRAME_RELEASE_UAPSD &&
1233 *qoshdr |= IEEE80211_QOS_CTL_EOSP;
1235 info->flags |= IEEE80211_TX_STATUS_EOSP |
1236 IEEE80211_TX_CTL_REQ_TX_STATUS;
1240 tids |= BIT(*qoshdr & IEEE80211_QOS_CTL_TID_MASK);
1244 __skb_queue_tail(&pending, skb);
1247 drv_allow_buffered_frames(local, sta, tids, num,
1250 ieee80211_add_pending_skbs(local, &pending);
1252 sta_info_recalc_tim(sta);
1255 * We need to release a frame that is buffered somewhere in the
1256 * driver ... it'll have to handle that.
1257 * Note that, as per the comment above, it'll also have to see
1258 * if there is more than just one frame on the specific TID that
1259 * we're releasing from, and it needs to set the more-data bit
1260 * accordingly if we tell it that there's no more data. If we do
1261 * tell it there's more data, then of course the more-data bit
1262 * needs to be set anyway.
1264 drv_release_buffered_frames(local, sta, driver_release_tids,
1265 n_frames, reason, more_data);
1268 * Note that we don't recalculate the TIM bit here as it would
1269 * most likely have no effect at all unless the driver told us
1270 * that the TID became empty before returning here from the
1272 * Either way, however, when the driver tells us that the TID
1273 * became empty we'll do the TIM recalculation.
1278 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta)
1280 u8 ignore_for_response = sta->sta.uapsd_queues;
1283 * If all ACs are delivery-enabled then we should reply
1284 * from any of them, if only some are enabled we reply
1285 * only from the non-enabled ones.
1287 if (ignore_for_response == BIT(IEEE80211_NUM_ACS) - 1)
1288 ignore_for_response = 0;
1290 ieee80211_sta_ps_deliver_response(sta, 1, ignore_for_response,
1291 IEEE80211_FRAME_RELEASE_PSPOLL);
1294 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta)
1296 int n_frames = sta->sta.max_sp;
1297 u8 delivery_enabled = sta->sta.uapsd_queues;
1300 * If we ever grow support for TSPEC this might happen if
1301 * the TSPEC update from hostapd comes in between a trigger
1302 * frame setting WLAN_STA_UAPSD in the RX path and this
1303 * actually getting called.
1305 if (!delivery_enabled)
1308 switch (sta->sta.max_sp) {
1319 /* XXX: what is a good value? */
1324 ieee80211_sta_ps_deliver_response(sta, n_frames, ~delivery_enabled,
1325 IEEE80211_FRAME_RELEASE_UAPSD);
1328 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
1329 struct ieee80211_sta *pubsta, bool block)
1331 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1333 trace_api_sta_block_awake(sta->local, pubsta, block);
1336 set_sta_flag(sta, WLAN_STA_PS_DRIVER);
1337 else if (test_sta_flag(sta, WLAN_STA_PS_DRIVER))
1338 ieee80211_queue_work(hw, &sta->drv_unblock_wk);
1340 EXPORT_SYMBOL(ieee80211_sta_block_awake);
1342 void ieee80211_sta_eosp_irqsafe(struct ieee80211_sta *pubsta)
1344 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1345 struct ieee80211_local *local = sta->local;
1346 struct sk_buff *skb;
1347 struct skb_eosp_msg_data *data;
1349 trace_api_eosp(local, pubsta);
1351 skb = alloc_skb(0, GFP_ATOMIC);
1353 /* too bad ... but race is better than loss */
1354 clear_sta_flag(sta, WLAN_STA_SP);
1358 data = (void *)skb->cb;
1359 memcpy(data->sta, pubsta->addr, ETH_ALEN);
1360 memcpy(data->iface, sta->sdata->vif.addr, ETH_ALEN);
1361 skb->pkt_type = IEEE80211_EOSP_MSG;
1362 skb_queue_tail(&local->skb_queue, skb);
1363 tasklet_schedule(&local->tasklet);
1365 EXPORT_SYMBOL(ieee80211_sta_eosp_irqsafe);
1367 void ieee80211_sta_set_buffered(struct ieee80211_sta *pubsta,
1368 u8 tid, bool buffered)
1370 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1372 if (WARN_ON(tid >= STA_TID_NUM))
1376 set_bit(tid, &sta->driver_buffered_tids);
1378 clear_bit(tid, &sta->driver_buffered_tids);
1380 sta_info_recalc_tim(sta);
1382 EXPORT_SYMBOL(ieee80211_sta_set_buffered);
1384 int sta_info_move_state(struct sta_info *sta,
1385 enum ieee80211_sta_state new_state)
1389 if (sta->sta_state == new_state)
1392 /* check allowed transitions first */
1394 switch (new_state) {
1395 case IEEE80211_STA_NONE:
1396 if (sta->sta_state != IEEE80211_STA_AUTH)
1399 case IEEE80211_STA_AUTH:
1400 if (sta->sta_state != IEEE80211_STA_NONE &&
1401 sta->sta_state != IEEE80211_STA_ASSOC)
1404 case IEEE80211_STA_ASSOC:
1405 if (sta->sta_state != IEEE80211_STA_AUTH &&
1406 sta->sta_state != IEEE80211_STA_AUTHORIZED)
1409 case IEEE80211_STA_AUTHORIZED:
1410 if (sta->sta_state != IEEE80211_STA_ASSOC)
1414 WARN(1, "invalid state %d", new_state);
1418 sta_dbg(sta->sdata, "moving STA %pM to state %d\n",
1419 sta->sta.addr, new_state);
1422 * notify the driver before the actual changes so it can
1423 * fail the transition
1425 if (test_sta_flag(sta, WLAN_STA_INSERTED)) {
1426 int err = drv_sta_state(sta->local, sta->sdata, sta,
1427 sta->sta_state, new_state);
1432 /* reflect the change in all state variables */
1434 switch (new_state) {
1435 case IEEE80211_STA_NONE:
1436 if (sta->sta_state == IEEE80211_STA_AUTH)
1437 clear_bit(WLAN_STA_AUTH, &sta->_flags);
1439 case IEEE80211_STA_AUTH:
1440 if (sta->sta_state == IEEE80211_STA_NONE)
1441 set_bit(WLAN_STA_AUTH, &sta->_flags);
1442 else if (sta->sta_state == IEEE80211_STA_ASSOC)
1443 clear_bit(WLAN_STA_ASSOC, &sta->_flags);
1445 case IEEE80211_STA_ASSOC:
1446 if (sta->sta_state == IEEE80211_STA_AUTH) {
1447 set_bit(WLAN_STA_ASSOC, &sta->_flags);
1448 } else if (sta->sta_state == IEEE80211_STA_AUTHORIZED) {
1449 if (sta->sdata->vif.type == NL80211_IFTYPE_AP ||
1450 (sta->sdata->vif.type == NL80211_IFTYPE_AP_VLAN &&
1451 !sta->sdata->u.vlan.sta))
1452 atomic_dec(&sta->sdata->bss->num_mcast_sta);
1453 clear_bit(WLAN_STA_AUTHORIZED, &sta->_flags);
1456 case IEEE80211_STA_AUTHORIZED:
1457 if (sta->sta_state == IEEE80211_STA_ASSOC) {
1458 if (sta->sdata->vif.type == NL80211_IFTYPE_AP ||
1459 (sta->sdata->vif.type == NL80211_IFTYPE_AP_VLAN &&
1460 !sta->sdata->u.vlan.sta))
1461 atomic_inc(&sta->sdata->bss->num_mcast_sta);
1462 set_bit(WLAN_STA_AUTHORIZED, &sta->_flags);
1469 sta->sta_state = new_state;