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 cleanup_single_sta(struct sta_info *sta)
97 struct tid_ampdu_tx *tid_tx;
98 struct ieee80211_sub_if_data *sdata = sta->sdata;
99 struct ieee80211_local *local = sdata->local;
103 * At this point, when being called as call_rcu callback,
104 * neither mac80211 nor the driver can reference this
105 * sta struct any more except by still existing timers
106 * associated with this station that we clean up below.
108 * Note though that this still uses the sdata and even
109 * calls the driver in AP and mesh mode, so interfaces
110 * of those types mush use call sta_info_flush_cleanup()
111 * (typically via sta_info_flush()) before deconfiguring
114 * In station mode, nothing happens here so it doesn't
115 * have to (and doesn't) do that, this is intentional to
119 if (test_sta_flag(sta, WLAN_STA_PS_STA)) {
120 if (sta->sdata->vif.type == NL80211_IFTYPE_AP ||
121 sta->sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
122 ps = &sdata->bss->ps;
123 else if (ieee80211_vif_is_mesh(&sdata->vif))
124 ps = &sdata->u.mesh.ps;
128 clear_sta_flag(sta, WLAN_STA_PS_STA);
130 atomic_dec(&ps->num_sta_ps);
131 sta_info_recalc_tim(sta);
134 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
135 local->total_ps_buffered -= skb_queue_len(&sta->ps_tx_buf[ac]);
136 ieee80211_purge_tx_queue(&local->hw, &sta->ps_tx_buf[ac]);
137 ieee80211_purge_tx_queue(&local->hw, &sta->tx_filtered[ac]);
140 if (ieee80211_vif_is_mesh(&sdata->vif))
141 mesh_sta_cleanup(sta);
143 cancel_work_sync(&sta->drv_unblock_wk);
146 * Destroy aggregation state here. It would be nice to wait for the
147 * driver to finish aggregation stop and then clean up, but for now
148 * drivers have to handle aggregation stop being requested, followed
149 * directly by station destruction.
151 for (i = 0; i < IEEE80211_NUM_TIDS; i++) {
152 tid_tx = rcu_dereference_raw(sta->ampdu_mlme.tid_tx[i]);
155 ieee80211_purge_tx_queue(&local->hw, &tid_tx->pending);
159 sta_info_free(local, sta);
162 void ieee80211_cleanup_sdata_stas(struct ieee80211_sub_if_data *sdata)
164 struct sta_info *sta;
166 spin_lock_bh(&sdata->cleanup_stations_lock);
167 while (!list_empty(&sdata->cleanup_stations)) {
168 sta = list_first_entry(&sdata->cleanup_stations,
169 struct sta_info, list);
170 list_del(&sta->list);
171 spin_unlock_bh(&sdata->cleanup_stations_lock);
173 cleanup_single_sta(sta);
175 spin_lock_bh(&sdata->cleanup_stations_lock);
178 spin_unlock_bh(&sdata->cleanup_stations_lock);
181 static void free_sta_rcu(struct rcu_head *h)
183 struct sta_info *sta = container_of(h, struct sta_info, rcu_head);
184 struct ieee80211_sub_if_data *sdata = sta->sdata;
186 spin_lock(&sdata->cleanup_stations_lock);
187 list_add_tail(&sta->list, &sdata->cleanup_stations);
188 spin_unlock(&sdata->cleanup_stations_lock);
190 ieee80211_queue_work(&sdata->local->hw, &sdata->cleanup_stations_wk);
193 /* protected by RCU */
194 struct sta_info *sta_info_get(struct ieee80211_sub_if_data *sdata,
197 struct ieee80211_local *local = sdata->local;
198 struct sta_info *sta;
200 sta = rcu_dereference_check(local->sta_hash[STA_HASH(addr)],
201 lockdep_is_held(&local->sta_mtx));
203 if (sta->sdata == sdata &&
204 ether_addr_equal(sta->sta.addr, addr))
206 sta = rcu_dereference_check(sta->hnext,
207 lockdep_is_held(&local->sta_mtx));
213 * Get sta info either from the specified interface
214 * or from one of its vlans
216 struct sta_info *sta_info_get_bss(struct ieee80211_sub_if_data *sdata,
219 struct ieee80211_local *local = sdata->local;
220 struct sta_info *sta;
222 sta = rcu_dereference_check(local->sta_hash[STA_HASH(addr)],
223 lockdep_is_held(&local->sta_mtx));
225 if ((sta->sdata == sdata ||
226 (sta->sdata->bss && sta->sdata->bss == sdata->bss)) &&
227 ether_addr_equal(sta->sta.addr, addr))
229 sta = rcu_dereference_check(sta->hnext,
230 lockdep_is_held(&local->sta_mtx));
235 struct sta_info *sta_info_get_by_idx(struct ieee80211_sub_if_data *sdata,
238 struct ieee80211_local *local = sdata->local;
239 struct sta_info *sta;
242 list_for_each_entry_rcu(sta, &local->sta_list, list) {
243 if (sdata != sta->sdata)
256 * sta_info_free - free STA
258 * @local: pointer to the global information
259 * @sta: STA info to free
261 * This function must undo everything done by sta_info_alloc()
262 * that may happen before sta_info_insert(). It may only be
263 * called when sta_info_insert() has not been attempted (and
264 * if that fails, the station is freed anyway.)
266 void sta_info_free(struct ieee80211_local *local, struct sta_info *sta)
269 rate_control_free_sta(sta);
271 sta_dbg(sta->sdata, "Destroyed STA %pM\n", sta->sta.addr);
276 /* Caller must hold local->sta_mtx */
277 static void sta_info_hash_add(struct ieee80211_local *local,
278 struct sta_info *sta)
280 lockdep_assert_held(&local->sta_mtx);
281 sta->hnext = local->sta_hash[STA_HASH(sta->sta.addr)];
282 rcu_assign_pointer(local->sta_hash[STA_HASH(sta->sta.addr)], sta);
285 static void sta_unblock(struct work_struct *wk)
287 struct sta_info *sta;
289 sta = container_of(wk, struct sta_info, drv_unblock_wk);
294 if (!test_sta_flag(sta, WLAN_STA_PS_STA)) {
296 ieee80211_sta_ps_deliver_wakeup(sta);
298 } else if (test_and_clear_sta_flag(sta, WLAN_STA_PSPOLL)) {
299 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
302 ieee80211_sta_ps_deliver_poll_response(sta);
304 } else if (test_and_clear_sta_flag(sta, WLAN_STA_UAPSD)) {
305 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
308 ieee80211_sta_ps_deliver_uapsd(sta);
311 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
314 static int sta_prepare_rate_control(struct ieee80211_local *local,
315 struct sta_info *sta, gfp_t gfp)
317 if (local->hw.flags & IEEE80211_HW_HAS_RATE_CONTROL)
320 sta->rate_ctrl = local->rate_ctrl;
321 sta->rate_ctrl_priv = rate_control_alloc_sta(sta->rate_ctrl,
323 if (!sta->rate_ctrl_priv)
329 struct sta_info *sta_info_alloc(struct ieee80211_sub_if_data *sdata,
330 const u8 *addr, gfp_t gfp)
332 struct ieee80211_local *local = sdata->local;
333 struct sta_info *sta;
334 struct timespec uptime;
337 sta = kzalloc(sizeof(*sta) + local->hw.sta_data_size, gfp);
341 spin_lock_init(&sta->lock);
342 INIT_WORK(&sta->drv_unblock_wk, sta_unblock);
343 INIT_WORK(&sta->ampdu_mlme.work, ieee80211_ba_session_work);
344 mutex_init(&sta->ampdu_mlme.mtx);
345 #ifdef CONFIG_MAC80211_MESH
346 if (ieee80211_vif_is_mesh(&sdata->vif) &&
347 !sdata->u.mesh.user_mpm)
348 init_timer(&sta->plink_timer);
351 memcpy(sta->sta.addr, addr, ETH_ALEN);
354 sta->last_rx = jiffies;
356 sta->sta_state = IEEE80211_STA_NONE;
358 do_posix_clock_monotonic_gettime(&uptime);
359 sta->last_connected = uptime.tv_sec;
360 ewma_init(&sta->avg_signal, 1024, 8);
362 if (sta_prepare_rate_control(local, sta, gfp)) {
367 for (i = 0; i < IEEE80211_NUM_TIDS; i++) {
369 * timer_to_tid must be initialized with identity mapping
370 * to enable session_timer's data differentiation. See
371 * sta_rx_agg_session_timer_expired for usage.
373 sta->timer_to_tid[i] = i;
375 for (i = 0; i < IEEE80211_NUM_ACS; i++) {
376 skb_queue_head_init(&sta->ps_tx_buf[i]);
377 skb_queue_head_init(&sta->tx_filtered[i]);
380 for (i = 0; i < IEEE80211_NUM_TIDS; i++)
381 sta->last_seq_ctrl[i] = cpu_to_le16(USHRT_MAX);
383 sta->sta.smps_mode = IEEE80211_SMPS_OFF;
385 sta_dbg(sdata, "Allocated STA %pM\n", sta->sta.addr);
390 static int sta_info_insert_check(struct sta_info *sta)
392 struct ieee80211_sub_if_data *sdata = sta->sdata;
395 * Can't be a WARN_ON because it can be triggered through a race:
396 * something inserts a STA (on one CPU) without holding the RTNL
397 * and another CPU turns off the net device.
399 if (unlikely(!ieee80211_sdata_running(sdata)))
402 if (WARN_ON(ether_addr_equal(sta->sta.addr, sdata->vif.addr) ||
403 is_multicast_ether_addr(sta->sta.addr)))
409 static int sta_info_insert_drv_state(struct ieee80211_local *local,
410 struct ieee80211_sub_if_data *sdata,
411 struct sta_info *sta)
413 enum ieee80211_sta_state state;
416 for (state = IEEE80211_STA_NOTEXIST; state < sta->sta_state; state++) {
417 err = drv_sta_state(local, sdata, sta, state, state + 1);
424 * Drivers using legacy sta_add/sta_remove callbacks only
425 * get uploaded set to true after sta_add is called.
427 if (!local->ops->sta_add)
428 sta->uploaded = true;
432 if (sdata->vif.type == NL80211_IFTYPE_ADHOC) {
434 "failed to move IBSS STA %pM to state %d (%d) - keeping it anyway\n",
435 sta->sta.addr, state + 1, err);
439 /* unwind on error */
440 for (; state > IEEE80211_STA_NOTEXIST; state--)
441 WARN_ON(drv_sta_state(local, sdata, sta, state, state - 1));
447 * should be called with sta_mtx locked
448 * this function replaces the mutex lock
451 static int sta_info_insert_finish(struct sta_info *sta) __acquires(RCU)
453 struct ieee80211_local *local = sta->local;
454 struct ieee80211_sub_if_data *sdata = sta->sdata;
455 struct station_info sinfo;
458 lockdep_assert_held(&local->sta_mtx);
460 /* check if STA exists already */
461 if (sta_info_get_bss(sdata, sta->sta.addr)) {
467 err = sta_info_insert_drv_state(local, sdata, sta);
472 local->sta_generation++;
475 /* make the station visible */
476 sta_info_hash_add(local, sta);
478 list_add_rcu(&sta->list, &local->sta_list);
480 set_sta_flag(sta, WLAN_STA_INSERTED);
482 ieee80211_sta_debugfs_add(sta);
483 rate_control_add_sta_debugfs(sta);
485 memset(&sinfo, 0, sizeof(sinfo));
487 sinfo.generation = local->sta_generation;
488 cfg80211_new_sta(sdata->dev, sta->sta.addr, &sinfo, GFP_KERNEL);
490 sta_dbg(sdata, "Inserted STA %pM\n", sta->sta.addr);
492 /* move reference to rcu-protected */
494 mutex_unlock(&local->sta_mtx);
496 if (ieee80211_vif_is_mesh(&sdata->vif))
497 mesh_accept_plinks_update(sdata);
501 mutex_unlock(&local->sta_mtx);
506 int sta_info_insert_rcu(struct sta_info *sta) __acquires(RCU)
508 struct ieee80211_local *local = sta->local;
513 err = sta_info_insert_check(sta);
519 mutex_lock(&local->sta_mtx);
521 err = sta_info_insert_finish(sta);
528 sta_info_free(local, sta);
532 int sta_info_insert(struct sta_info *sta)
534 int err = sta_info_insert_rcu(sta);
541 static inline void __bss_tim_set(u8 *tim, u16 id)
544 * This format has been mandated by the IEEE specifications,
545 * so this line may not be changed to use the __set_bit() format.
547 tim[id / 8] |= (1 << (id % 8));
550 static inline void __bss_tim_clear(u8 *tim, u16 id)
553 * This format has been mandated by the IEEE specifications,
554 * so this line may not be changed to use the __clear_bit() format.
556 tim[id / 8] &= ~(1 << (id % 8));
559 static unsigned long ieee80211_tids_for_ac(int ac)
561 /* If we ever support TIDs > 7, this obviously needs to be adjusted */
563 case IEEE80211_AC_VO:
564 return BIT(6) | BIT(7);
565 case IEEE80211_AC_VI:
566 return BIT(4) | BIT(5);
567 case IEEE80211_AC_BE:
568 return BIT(0) | BIT(3);
569 case IEEE80211_AC_BK:
570 return BIT(1) | BIT(2);
577 void sta_info_recalc_tim(struct sta_info *sta)
579 struct ieee80211_local *local = sta->local;
581 bool indicate_tim = false;
582 u8 ignore_for_tim = sta->sta.uapsd_queues;
586 if (sta->sdata->vif.type == NL80211_IFTYPE_AP ||
587 sta->sdata->vif.type == NL80211_IFTYPE_AP_VLAN) {
588 if (WARN_ON_ONCE(!sta->sdata->bss))
591 ps = &sta->sdata->bss->ps;
593 #ifdef CONFIG_MAC80211_MESH
594 } else if (ieee80211_vif_is_mesh(&sta->sdata->vif)) {
595 ps = &sta->sdata->u.mesh.ps;
596 /* TIM map only for PLID <= IEEE80211_MAX_AID */
597 id = le16_to_cpu(sta->plid) % IEEE80211_MAX_AID;
603 /* No need to do anything if the driver does all */
604 if (local->hw.flags & IEEE80211_HW_AP_LINK_PS)
611 * If all ACs are delivery-enabled then we should build
612 * the TIM bit for all ACs anyway; if only some are then
613 * we ignore those and build the TIM bit using only the
616 if (ignore_for_tim == BIT(IEEE80211_NUM_ACS) - 1)
619 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
622 if (ignore_for_tim & BIT(ac))
625 indicate_tim |= !skb_queue_empty(&sta->tx_filtered[ac]) ||
626 !skb_queue_empty(&sta->ps_tx_buf[ac]);
630 tids = ieee80211_tids_for_ac(ac);
633 sta->driver_buffered_tids & tids;
637 spin_lock_bh(&local->tim_lock);
640 __bss_tim_set(ps->tim, id);
642 __bss_tim_clear(ps->tim, id);
644 if (local->ops->set_tim) {
645 local->tim_in_locked_section = true;
646 drv_set_tim(local, &sta->sta, indicate_tim);
647 local->tim_in_locked_section = false;
650 spin_unlock_bh(&local->tim_lock);
653 static bool sta_info_buffer_expired(struct sta_info *sta, struct sk_buff *skb)
655 struct ieee80211_tx_info *info;
661 info = IEEE80211_SKB_CB(skb);
663 /* Timeout: (2 * listen_interval * beacon_int * 1024 / 1000000) sec */
664 timeout = (sta->listen_interval *
665 sta->sdata->vif.bss_conf.beacon_int *
667 if (timeout < STA_TX_BUFFER_EXPIRE)
668 timeout = STA_TX_BUFFER_EXPIRE;
669 return time_after(jiffies, info->control.jiffies + timeout);
673 static bool sta_info_cleanup_expire_buffered_ac(struct ieee80211_local *local,
674 struct sta_info *sta, int ac)
680 * First check for frames that should expire on the filtered
681 * queue. Frames here were rejected by the driver and are on
682 * a separate queue to avoid reordering with normal PS-buffered
683 * frames. They also aren't accounted for right now in the
684 * total_ps_buffered counter.
687 spin_lock_irqsave(&sta->tx_filtered[ac].lock, flags);
688 skb = skb_peek(&sta->tx_filtered[ac]);
689 if (sta_info_buffer_expired(sta, skb))
690 skb = __skb_dequeue(&sta->tx_filtered[ac]);
693 spin_unlock_irqrestore(&sta->tx_filtered[ac].lock, flags);
696 * Frames are queued in order, so if this one
697 * hasn't expired yet we can stop testing. If
698 * we actually reached the end of the queue we
699 * also need to stop, of course.
703 ieee80211_free_txskb(&local->hw, skb);
707 * Now also check the normal PS-buffered queue, this will
708 * only find something if the filtered queue was emptied
709 * since the filtered frames are all before the normal PS
713 spin_lock_irqsave(&sta->ps_tx_buf[ac].lock, flags);
714 skb = skb_peek(&sta->ps_tx_buf[ac]);
715 if (sta_info_buffer_expired(sta, skb))
716 skb = __skb_dequeue(&sta->ps_tx_buf[ac]);
719 spin_unlock_irqrestore(&sta->ps_tx_buf[ac].lock, flags);
722 * frames are queued in order, so if this one
723 * hasn't expired yet (or we reached the end of
724 * the queue) we can stop testing
729 local->total_ps_buffered--;
730 ps_dbg(sta->sdata, "Buffered frame expired (STA %pM)\n",
732 ieee80211_free_txskb(&local->hw, skb);
736 * Finally, recalculate the TIM bit for this station -- it might
737 * now be clear because the station was too slow to retrieve its
740 sta_info_recalc_tim(sta);
743 * Return whether there are any frames still buffered, this is
744 * used to check whether the cleanup timer still needs to run,
745 * if there are no frames we don't need to rearm the timer.
747 return !(skb_queue_empty(&sta->ps_tx_buf[ac]) &&
748 skb_queue_empty(&sta->tx_filtered[ac]));
751 static bool sta_info_cleanup_expire_buffered(struct ieee80211_local *local,
752 struct sta_info *sta)
754 bool have_buffered = false;
757 /* This is only necessary for stations on BSS/MBSS interfaces */
758 if (!sta->sdata->bss &&
759 !ieee80211_vif_is_mesh(&sta->sdata->vif))
762 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++)
764 sta_info_cleanup_expire_buffered_ac(local, sta, ac);
766 return have_buffered;
769 int __must_check __sta_info_destroy(struct sta_info *sta)
771 struct ieee80211_local *local;
772 struct ieee80211_sub_if_data *sdata;
783 lockdep_assert_held(&local->sta_mtx);
786 * Before removing the station from the driver and
787 * rate control, it might still start new aggregation
788 * sessions -- block that to make sure the tear-down
789 * will be sufficient.
791 set_sta_flag(sta, WLAN_STA_BLOCK_BA);
792 ieee80211_sta_tear_down_BA_sessions(sta, AGG_STOP_DESTROY_STA);
794 ret = sta_info_hash_del(local, sta);
798 list_del_rcu(&sta->list);
800 mutex_lock(&local->key_mtx);
801 for (i = 0; i < NUM_DEFAULT_KEYS; i++)
802 __ieee80211_key_free(key_mtx_dereference(local, sta->gtk[i]),
805 __ieee80211_key_free(key_mtx_dereference(local, sta->ptk),
807 mutex_unlock(&local->key_mtx);
812 local->sta_generation++;
814 if (sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
815 RCU_INIT_POINTER(sdata->u.vlan.sta, NULL);
817 while (sta->sta_state > IEEE80211_STA_NONE) {
818 ret = sta_info_move_state(sta, sta->sta_state - 1);
826 ret = drv_sta_state(local, sdata, sta, IEEE80211_STA_NONE,
827 IEEE80211_STA_NOTEXIST);
828 WARN_ON_ONCE(ret != 0);
831 sta_dbg(sdata, "Removed STA %pM\n", sta->sta.addr);
833 cfg80211_del_sta(sdata->dev, sta->sta.addr, GFP_KERNEL);
835 rate_control_remove_sta_debugfs(sta);
836 ieee80211_sta_debugfs_remove(sta);
838 call_rcu(&sta->rcu_head, free_sta_rcu);
843 int sta_info_destroy_addr(struct ieee80211_sub_if_data *sdata, const u8 *addr)
845 struct sta_info *sta;
848 mutex_lock(&sdata->local->sta_mtx);
849 sta = sta_info_get(sdata, addr);
850 ret = __sta_info_destroy(sta);
851 mutex_unlock(&sdata->local->sta_mtx);
856 int sta_info_destroy_addr_bss(struct ieee80211_sub_if_data *sdata,
859 struct sta_info *sta;
862 mutex_lock(&sdata->local->sta_mtx);
863 sta = sta_info_get_bss(sdata, addr);
864 ret = __sta_info_destroy(sta);
865 mutex_unlock(&sdata->local->sta_mtx);
870 static void sta_info_cleanup(unsigned long data)
872 struct ieee80211_local *local = (struct ieee80211_local *) data;
873 struct sta_info *sta;
874 bool timer_needed = false;
877 list_for_each_entry_rcu(sta, &local->sta_list, list)
878 if (sta_info_cleanup_expire_buffered(local, sta))
882 if (local->quiescing)
888 mod_timer(&local->sta_cleanup,
889 round_jiffies(jiffies + STA_INFO_CLEANUP_INTERVAL));
892 void sta_info_init(struct ieee80211_local *local)
894 spin_lock_init(&local->tim_lock);
895 mutex_init(&local->sta_mtx);
896 INIT_LIST_HEAD(&local->sta_list);
898 setup_timer(&local->sta_cleanup, sta_info_cleanup,
899 (unsigned long)local);
902 void sta_info_stop(struct ieee80211_local *local)
904 del_timer_sync(&local->sta_cleanup);
908 int sta_info_flush_defer(struct ieee80211_sub_if_data *sdata)
910 struct ieee80211_local *local = sdata->local;
911 struct sta_info *sta, *tmp;
916 mutex_lock(&local->sta_mtx);
917 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
918 if (sdata == sta->sdata) {
919 WARN_ON(__sta_info_destroy(sta));
923 mutex_unlock(&local->sta_mtx);
928 void sta_info_flush_cleanup(struct ieee80211_sub_if_data *sdata)
930 ieee80211_cleanup_sdata_stas(sdata);
931 cancel_work_sync(&sdata->cleanup_stations_wk);
934 void ieee80211_sta_expire(struct ieee80211_sub_if_data *sdata,
935 unsigned long exp_time)
937 struct ieee80211_local *local = sdata->local;
938 struct sta_info *sta, *tmp;
940 mutex_lock(&local->sta_mtx);
942 list_for_each_entry_safe(sta, tmp, &local->sta_list, list) {
943 if (sdata != sta->sdata)
946 if (time_after(jiffies, sta->last_rx + exp_time)) {
947 sta_dbg(sta->sdata, "expiring inactive STA %pM\n",
950 if (ieee80211_vif_is_mesh(&sdata->vif) &&
951 test_sta_flag(sta, WLAN_STA_PS_STA))
952 atomic_dec(&sdata->u.mesh.ps.num_sta_ps);
954 WARN_ON(__sta_info_destroy(sta));
958 mutex_unlock(&local->sta_mtx);
961 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
965 struct sta_info *sta, *nxt;
968 * Just return a random station if localaddr is NULL
971 for_each_sta_info(hw_to_local(hw), addr, sta, nxt) {
973 !ether_addr_equal(sta->sdata->vif.addr, localaddr))
982 EXPORT_SYMBOL_GPL(ieee80211_find_sta_by_ifaddr);
984 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
987 struct sta_info *sta;
992 sta = sta_info_get_bss(vif_to_sdata(vif), addr);
1001 EXPORT_SYMBOL(ieee80211_find_sta);
1003 static void clear_sta_ps_flags(void *_sta)
1005 struct sta_info *sta = _sta;
1006 struct ieee80211_sub_if_data *sdata = sta->sdata;
1009 if (sdata->vif.type == NL80211_IFTYPE_AP ||
1010 sdata->vif.type == NL80211_IFTYPE_AP_VLAN)
1011 ps = &sdata->bss->ps;
1012 else if (ieee80211_vif_is_mesh(&sdata->vif))
1013 ps = &sdata->u.mesh.ps;
1017 clear_sta_flag(sta, WLAN_STA_PS_DRIVER);
1018 if (test_and_clear_sta_flag(sta, WLAN_STA_PS_STA))
1019 atomic_dec(&ps->num_sta_ps);
1022 /* powersave support code */
1023 void ieee80211_sta_ps_deliver_wakeup(struct sta_info *sta)
1025 struct ieee80211_sub_if_data *sdata = sta->sdata;
1026 struct ieee80211_local *local = sdata->local;
1027 struct sk_buff_head pending;
1028 int filtered = 0, buffered = 0, ac;
1029 unsigned long flags;
1031 clear_sta_flag(sta, WLAN_STA_SP);
1033 BUILD_BUG_ON(BITS_TO_LONGS(IEEE80211_NUM_TIDS) > 1);
1034 sta->driver_buffered_tids = 0;
1036 if (!(local->hw.flags & IEEE80211_HW_AP_LINK_PS))
1037 drv_sta_notify(local, sdata, STA_NOTIFY_AWAKE, &sta->sta);
1039 skb_queue_head_init(&pending);
1041 /* Send all buffered frames to the station */
1042 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
1043 int count = skb_queue_len(&pending), tmp;
1045 spin_lock_irqsave(&sta->tx_filtered[ac].lock, flags);
1046 skb_queue_splice_tail_init(&sta->tx_filtered[ac], &pending);
1047 spin_unlock_irqrestore(&sta->tx_filtered[ac].lock, flags);
1048 tmp = skb_queue_len(&pending);
1049 filtered += tmp - count;
1052 spin_lock_irqsave(&sta->ps_tx_buf[ac].lock, flags);
1053 skb_queue_splice_tail_init(&sta->ps_tx_buf[ac], &pending);
1054 spin_unlock_irqrestore(&sta->ps_tx_buf[ac].lock, flags);
1055 tmp = skb_queue_len(&pending);
1056 buffered += tmp - count;
1059 ieee80211_add_pending_skbs_fn(local, &pending, clear_sta_ps_flags, sta);
1061 local->total_ps_buffered -= buffered;
1063 sta_info_recalc_tim(sta);
1066 "STA %pM aid %d sending %d filtered/%d PS frames since STA not sleeping anymore\n",
1067 sta->sta.addr, sta->sta.aid, filtered, buffered);
1070 static void ieee80211_send_null_response(struct ieee80211_sub_if_data *sdata,
1071 struct sta_info *sta, int tid,
1072 enum ieee80211_frame_release_type reason)
1074 struct ieee80211_local *local = sdata->local;
1075 struct ieee80211_qos_hdr *nullfunc;
1076 struct sk_buff *skb;
1077 int size = sizeof(*nullfunc);
1079 bool qos = test_sta_flag(sta, WLAN_STA_WME);
1080 struct ieee80211_tx_info *info;
1081 struct ieee80211_chanctx_conf *chanctx_conf;
1084 fc = cpu_to_le16(IEEE80211_FTYPE_DATA |
1085 IEEE80211_STYPE_QOS_NULLFUNC |
1086 IEEE80211_FCTL_FROMDS);
1089 fc = cpu_to_le16(IEEE80211_FTYPE_DATA |
1090 IEEE80211_STYPE_NULLFUNC |
1091 IEEE80211_FCTL_FROMDS);
1094 skb = dev_alloc_skb(local->hw.extra_tx_headroom + size);
1098 skb_reserve(skb, local->hw.extra_tx_headroom);
1100 nullfunc = (void *) skb_put(skb, size);
1101 nullfunc->frame_control = fc;
1102 nullfunc->duration_id = 0;
1103 memcpy(nullfunc->addr1, sta->sta.addr, ETH_ALEN);
1104 memcpy(nullfunc->addr2, sdata->vif.addr, ETH_ALEN);
1105 memcpy(nullfunc->addr3, sdata->vif.addr, ETH_ALEN);
1107 skb->priority = tid;
1108 skb_set_queue_mapping(skb, ieee802_1d_to_ac[tid]);
1110 nullfunc->qos_ctrl = cpu_to_le16(tid);
1112 if (reason == IEEE80211_FRAME_RELEASE_UAPSD)
1113 nullfunc->qos_ctrl |=
1114 cpu_to_le16(IEEE80211_QOS_CTL_EOSP);
1117 info = IEEE80211_SKB_CB(skb);
1120 * Tell TX path to send this frame even though the
1121 * STA may still remain is PS mode after this frame
1122 * exchange. Also set EOSP to indicate this packet
1123 * ends the poll/service period.
1125 info->flags |= IEEE80211_TX_CTL_NO_PS_BUFFER |
1126 IEEE80211_TX_STATUS_EOSP |
1127 IEEE80211_TX_CTL_REQ_TX_STATUS;
1129 drv_allow_buffered_frames(local, sta, BIT(tid), 1, reason, false);
1131 skb->dev = sdata->dev;
1134 chanctx_conf = rcu_dereference(sdata->vif.chanctx_conf);
1135 if (WARN_ON(!chanctx_conf)) {
1141 ieee80211_xmit(sdata, skb, chanctx_conf->def.chan->band);
1146 ieee80211_sta_ps_deliver_response(struct sta_info *sta,
1147 int n_frames, u8 ignored_acs,
1148 enum ieee80211_frame_release_type reason)
1150 struct ieee80211_sub_if_data *sdata = sta->sdata;
1151 struct ieee80211_local *local = sdata->local;
1153 bool more_data = false;
1155 unsigned long driver_release_tids = 0;
1156 struct sk_buff_head frames;
1158 /* Service or PS-Poll period starts */
1159 set_sta_flag(sta, WLAN_STA_SP);
1161 __skb_queue_head_init(&frames);
1164 * Get response frame(s) and more data bit for it.
1166 for (ac = 0; ac < IEEE80211_NUM_ACS; ac++) {
1169 if (ignored_acs & BIT(ac))
1172 tids = ieee80211_tids_for_ac(ac);
1175 driver_release_tids = sta->driver_buffered_tids & tids;
1176 if (driver_release_tids) {
1179 struct sk_buff *skb;
1181 while (n_frames > 0) {
1182 skb = skb_dequeue(&sta->tx_filtered[ac]);
1185 &sta->ps_tx_buf[ac]);
1187 local->total_ps_buffered--;
1193 __skb_queue_tail(&frames, skb);
1198 * If the driver has data on more than one TID then
1199 * certainly there's more data if we release just a
1200 * single frame now (from a single TID).
1202 if (reason == IEEE80211_FRAME_RELEASE_PSPOLL &&
1203 hweight16(driver_release_tids) > 1) {
1205 driver_release_tids =
1206 BIT(ffs(driver_release_tids) - 1);
1211 if (!skb_queue_empty(&sta->tx_filtered[ac]) ||
1212 !skb_queue_empty(&sta->ps_tx_buf[ac])) {
1222 * For PS-Poll, this can only happen due to a race condition
1223 * when we set the TIM bit and the station notices it, but
1224 * before it can poll for the frame we expire it.
1226 * For uAPSD, this is said in the standard (11.2.1.5 h):
1227 * At each unscheduled SP for a non-AP STA, the AP shall
1228 * attempt to transmit at least one MSDU or MMPDU, but no
1229 * more than the value specified in the Max SP Length field
1230 * in the QoS Capability element from delivery-enabled ACs,
1231 * that are destined for the non-AP STA.
1233 * Since we have no other MSDU/MMPDU, transmit a QoS null frame.
1236 /* This will evaluate to 1, 3, 5 or 7. */
1237 tid = 7 - ((ffs(~ignored_acs) - 1) << 1);
1239 ieee80211_send_null_response(sdata, sta, tid, reason);
1243 if (!driver_release_tids) {
1244 struct sk_buff_head pending;
1245 struct sk_buff *skb;
1249 skb_queue_head_init(&pending);
1251 while ((skb = __skb_dequeue(&frames))) {
1252 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
1253 struct ieee80211_hdr *hdr = (void *) skb->data;
1259 * Tell TX path to send this frame even though the
1260 * STA may still remain is PS mode after this frame
1263 info->flags |= IEEE80211_TX_CTL_NO_PS_BUFFER;
1266 * Use MoreData flag to indicate whether there are
1267 * more buffered frames for this STA
1269 if (more_data || !skb_queue_empty(&frames))
1270 hdr->frame_control |=
1271 cpu_to_le16(IEEE80211_FCTL_MOREDATA);
1273 hdr->frame_control &=
1274 cpu_to_le16(~IEEE80211_FCTL_MOREDATA);
1276 if (ieee80211_is_data_qos(hdr->frame_control) ||
1277 ieee80211_is_qos_nullfunc(hdr->frame_control))
1278 qoshdr = ieee80211_get_qos_ctl(hdr);
1280 /* end service period after last frame */
1281 if (skb_queue_empty(&frames)) {
1282 if (reason == IEEE80211_FRAME_RELEASE_UAPSD &&
1284 *qoshdr |= IEEE80211_QOS_CTL_EOSP;
1286 info->flags |= IEEE80211_TX_STATUS_EOSP |
1287 IEEE80211_TX_CTL_REQ_TX_STATUS;
1291 tids |= BIT(*qoshdr & IEEE80211_QOS_CTL_TID_MASK);
1295 __skb_queue_tail(&pending, skb);
1298 drv_allow_buffered_frames(local, sta, tids, num,
1301 ieee80211_add_pending_skbs(local, &pending);
1303 sta_info_recalc_tim(sta);
1306 * We need to release a frame that is buffered somewhere in the
1307 * driver ... it'll have to handle that.
1308 * Note that, as per the comment above, it'll also have to see
1309 * if there is more than just one frame on the specific TID that
1310 * we're releasing from, and it needs to set the more-data bit
1311 * accordingly if we tell it that there's no more data. If we do
1312 * tell it there's more data, then of course the more-data bit
1313 * needs to be set anyway.
1315 drv_release_buffered_frames(local, sta, driver_release_tids,
1316 n_frames, reason, more_data);
1319 * Note that we don't recalculate the TIM bit here as it would
1320 * most likely have no effect at all unless the driver told us
1321 * that the TID became empty before returning here from the
1323 * Either way, however, when the driver tells us that the TID
1324 * became empty we'll do the TIM recalculation.
1329 void ieee80211_sta_ps_deliver_poll_response(struct sta_info *sta)
1331 u8 ignore_for_response = sta->sta.uapsd_queues;
1334 * If all ACs are delivery-enabled then we should reply
1335 * from any of them, if only some are enabled we reply
1336 * only from the non-enabled ones.
1338 if (ignore_for_response == BIT(IEEE80211_NUM_ACS) - 1)
1339 ignore_for_response = 0;
1341 ieee80211_sta_ps_deliver_response(sta, 1, ignore_for_response,
1342 IEEE80211_FRAME_RELEASE_PSPOLL);
1345 void ieee80211_sta_ps_deliver_uapsd(struct sta_info *sta)
1347 int n_frames = sta->sta.max_sp;
1348 u8 delivery_enabled = sta->sta.uapsd_queues;
1351 * If we ever grow support for TSPEC this might happen if
1352 * the TSPEC update from hostapd comes in between a trigger
1353 * frame setting WLAN_STA_UAPSD in the RX path and this
1354 * actually getting called.
1356 if (!delivery_enabled)
1359 switch (sta->sta.max_sp) {
1370 /* XXX: what is a good value? */
1375 ieee80211_sta_ps_deliver_response(sta, n_frames, ~delivery_enabled,
1376 IEEE80211_FRAME_RELEASE_UAPSD);
1379 void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
1380 struct ieee80211_sta *pubsta, bool block)
1382 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1384 trace_api_sta_block_awake(sta->local, pubsta, block);
1387 set_sta_flag(sta, WLAN_STA_PS_DRIVER);
1388 else if (test_sta_flag(sta, WLAN_STA_PS_DRIVER))
1389 ieee80211_queue_work(hw, &sta->drv_unblock_wk);
1391 EXPORT_SYMBOL(ieee80211_sta_block_awake);
1393 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta)
1395 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1396 struct ieee80211_local *local = sta->local;
1398 trace_api_eosp(local, pubsta);
1400 clear_sta_flag(sta, WLAN_STA_SP);
1402 EXPORT_SYMBOL(ieee80211_sta_eosp);
1404 void ieee80211_sta_set_buffered(struct ieee80211_sta *pubsta,
1405 u8 tid, bool buffered)
1407 struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
1409 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
1413 set_bit(tid, &sta->driver_buffered_tids);
1415 clear_bit(tid, &sta->driver_buffered_tids);
1417 sta_info_recalc_tim(sta);
1419 EXPORT_SYMBOL(ieee80211_sta_set_buffered);
1421 int sta_info_move_state(struct sta_info *sta,
1422 enum ieee80211_sta_state new_state)
1426 if (sta->sta_state == new_state)
1429 /* check allowed transitions first */
1431 switch (new_state) {
1432 case IEEE80211_STA_NONE:
1433 if (sta->sta_state != IEEE80211_STA_AUTH)
1436 case IEEE80211_STA_AUTH:
1437 if (sta->sta_state != IEEE80211_STA_NONE &&
1438 sta->sta_state != IEEE80211_STA_ASSOC)
1441 case IEEE80211_STA_ASSOC:
1442 if (sta->sta_state != IEEE80211_STA_AUTH &&
1443 sta->sta_state != IEEE80211_STA_AUTHORIZED)
1446 case IEEE80211_STA_AUTHORIZED:
1447 if (sta->sta_state != IEEE80211_STA_ASSOC)
1451 WARN(1, "invalid state %d", new_state);
1455 sta_dbg(sta->sdata, "moving STA %pM to state %d\n",
1456 sta->sta.addr, new_state);
1459 * notify the driver before the actual changes so it can
1460 * fail the transition
1462 if (test_sta_flag(sta, WLAN_STA_INSERTED)) {
1463 int err = drv_sta_state(sta->local, sta->sdata, sta,
1464 sta->sta_state, new_state);
1469 /* reflect the change in all state variables */
1471 switch (new_state) {
1472 case IEEE80211_STA_NONE:
1473 if (sta->sta_state == IEEE80211_STA_AUTH)
1474 clear_bit(WLAN_STA_AUTH, &sta->_flags);
1476 case IEEE80211_STA_AUTH:
1477 if (sta->sta_state == IEEE80211_STA_NONE)
1478 set_bit(WLAN_STA_AUTH, &sta->_flags);
1479 else if (sta->sta_state == IEEE80211_STA_ASSOC)
1480 clear_bit(WLAN_STA_ASSOC, &sta->_flags);
1482 case IEEE80211_STA_ASSOC:
1483 if (sta->sta_state == IEEE80211_STA_AUTH) {
1484 set_bit(WLAN_STA_ASSOC, &sta->_flags);
1485 } else if (sta->sta_state == IEEE80211_STA_AUTHORIZED) {
1486 if (sta->sdata->vif.type == NL80211_IFTYPE_AP ||
1487 (sta->sdata->vif.type == NL80211_IFTYPE_AP_VLAN &&
1488 !sta->sdata->u.vlan.sta))
1489 atomic_dec(&sta->sdata->bss->num_mcast_sta);
1490 clear_bit(WLAN_STA_AUTHORIZED, &sta->_flags);
1493 case IEEE80211_STA_AUTHORIZED:
1494 if (sta->sta_state == IEEE80211_STA_ASSOC) {
1495 if (sta->sdata->vif.type == NL80211_IFTYPE_AP ||
1496 (sta->sdata->vif.type == NL80211_IFTYPE_AP_VLAN &&
1497 !sta->sdata->u.vlan.sta))
1498 atomic_inc(&sta->sdata->bss->num_mcast_sta);
1499 set_bit(WLAN_STA_AUTHORIZED, &sta->_flags);
1506 sta->sta_state = new_state;