4 * Copyright 2003, Jouni Malinen <jkmaline@cc.hut.fi>
5 * Copyright 2002-2005, Instant802 Networks, Inc.
6 * Copyright 2005-2006, Devicescape Software, Inc.
7 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
8 * Copyright 2007, Michael Wu <flamingice@sourmilk.net>
9 * Copyright 2007-2010, Intel Corporation
10 * Copyright(c) 2015-2017 Intel Deutschland GmbH
11 * Copyright (C) 2018 Intel Corporation
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2 as
15 * published by the Free Software Foundation.
19 * DOC: RX A-MPDU aggregation
21 * Aggregation on the RX side requires only implementing the
22 * @ampdu_action callback that is invoked to start/stop any
23 * block-ack sessions for RX aggregation.
25 * When RX aggregation is started by the peer, the driver is
26 * notified via @ampdu_action function, with the
27 * %IEEE80211_AMPDU_RX_START action, and may reject the request
28 * in which case a negative response is sent to the peer, if it
29 * accepts it a positive response is sent.
31 * While the session is active, the device/driver are required
32 * to de-aggregate frames and pass them up one by one to mac80211,
33 * which will handle the reorder buffer.
35 * When the aggregation session is stopped again by the peer or
36 * ourselves, the driver's @ampdu_action function will be called
37 * with the action %IEEE80211_AMPDU_RX_STOP. In this case, the
41 #include <linux/ieee80211.h>
42 #include <linux/slab.h>
43 #include <linux/export.h>
44 #include <net/mac80211.h>
45 #include "ieee80211_i.h"
46 #include "driver-ops.h"
48 static void ieee80211_free_tid_rx(struct rcu_head *h)
50 struct tid_ampdu_rx *tid_rx =
51 container_of(h, struct tid_ampdu_rx, rcu_head);
54 for (i = 0; i < tid_rx->buf_size; i++)
55 __skb_queue_purge(&tid_rx->reorder_buf[i]);
56 kfree(tid_rx->reorder_buf);
57 kfree(tid_rx->reorder_time);
61 void ___ieee80211_stop_rx_ba_session(struct sta_info *sta, u16 tid,
62 u16 initiator, u16 reason, bool tx)
64 struct ieee80211_local *local = sta->local;
65 struct tid_ampdu_rx *tid_rx;
66 struct ieee80211_ampdu_params params = {
68 .action = IEEE80211_AMPDU_RX_STOP,
75 lockdep_assert_held(&sta->ampdu_mlme.mtx);
77 tid_rx = rcu_dereference_protected(sta->ampdu_mlme.tid_rx[tid],
78 lockdep_is_held(&sta->ampdu_mlme.mtx));
80 if (!test_bit(tid, sta->ampdu_mlme.agg_session_valid))
83 RCU_INIT_POINTER(sta->ampdu_mlme.tid_rx[tid], NULL);
84 __clear_bit(tid, sta->ampdu_mlme.agg_session_valid);
87 "Rx BA session stop requested for %pM tid %u %s reason: %d\n",
89 initiator == WLAN_BACK_RECIPIENT ? "recipient" : "initiator",
92 if (drv_ampdu_action(local, sta->sdata, ¶ms))
93 sdata_info(sta->sdata,
94 "HW problem - can not stop rx aggregation for %pM tid %d\n",
97 /* check if this is a self generated aggregation halt */
98 if (initiator == WLAN_BACK_RECIPIENT && tx)
99 ieee80211_send_delba(sta->sdata, sta->sta.addr,
100 tid, WLAN_BACK_RECIPIENT, reason);
103 * return here in case tid_rx is not assigned - which will happen if
104 * IEEE80211_HW_SUPPORTS_REORDERING_BUFFER is set.
109 del_timer_sync(&tid_rx->session_timer);
111 /* make sure ieee80211_sta_reorder_release() doesn't re-arm the timer */
112 spin_lock_bh(&tid_rx->reorder_lock);
113 tid_rx->removed = true;
114 spin_unlock_bh(&tid_rx->reorder_lock);
115 del_timer_sync(&tid_rx->reorder_timer);
117 call_rcu(&tid_rx->rcu_head, ieee80211_free_tid_rx);
120 void __ieee80211_stop_rx_ba_session(struct sta_info *sta, u16 tid,
121 u16 initiator, u16 reason, bool tx)
123 mutex_lock(&sta->ampdu_mlme.mtx);
124 ___ieee80211_stop_rx_ba_session(sta, tid, initiator, reason, tx);
125 mutex_unlock(&sta->ampdu_mlme.mtx);
128 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
131 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
132 struct sta_info *sta;
136 sta = sta_info_get_bss(sdata, addr);
142 for (i = 0; i < IEEE80211_NUM_TIDS; i++)
143 if (ba_rx_bitmap & BIT(i))
144 set_bit(i, sta->ampdu_mlme.tid_rx_stop_requested);
146 ieee80211_queue_work(&sta->local->hw, &sta->ampdu_mlme.work);
149 EXPORT_SYMBOL(ieee80211_stop_rx_ba_session);
152 * After accepting the AddBA Request we activated a timer,
153 * resetting it after each frame that arrives from the originator.
155 static void sta_rx_agg_session_timer_expired(unsigned long data)
157 /* not an elegant detour, but there is no choice as the timer passes
158 * only one argument, and various sta_info are needed here, so init
159 * flow in sta_info_create gives the TID as data, while the timer_to_id
160 * array gives the sta through container_of */
161 u8 *ptid = (u8 *)data;
162 u8 *timer_to_id = ptid - *ptid;
163 struct sta_info *sta = container_of(timer_to_id, struct sta_info,
165 struct tid_ampdu_rx *tid_rx;
166 unsigned long timeout;
169 tid_rx = rcu_dereference(sta->ampdu_mlme.tid_rx[*ptid]);
175 timeout = tid_rx->last_rx + TU_TO_JIFFIES(tid_rx->timeout);
176 if (time_is_after_jiffies(timeout)) {
177 mod_timer(&tid_rx->session_timer, timeout);
183 ht_dbg(sta->sdata, "RX session timer expired on %pM tid %d\n",
184 sta->sta.addr, (u16)*ptid);
186 set_bit(*ptid, sta->ampdu_mlme.tid_rx_timer_expired);
187 ieee80211_queue_work(&sta->local->hw, &sta->ampdu_mlme.work);
190 static void sta_rx_agg_reorder_timer_expired(unsigned long data)
192 u8 *ptid = (u8 *)data;
193 u8 *timer_to_id = ptid - *ptid;
194 struct sta_info *sta = container_of(timer_to_id, struct sta_info,
198 ieee80211_release_reorder_timeout(sta, *ptid);
202 static void ieee80211_send_addba_resp(struct ieee80211_sub_if_data *sdata, u8 *da, u16 tid,
203 u8 dialog_token, u16 status, u16 policy,
204 u16 buf_size, u16 timeout)
206 struct ieee80211_local *local = sdata->local;
208 struct ieee80211_mgmt *mgmt;
209 bool amsdu = ieee80211_hw_check(&local->hw, SUPPORTS_AMSDU_IN_AMPDU);
212 skb = dev_alloc_skb(sizeof(*mgmt) + local->hw.extra_tx_headroom);
216 skb_reserve(skb, local->hw.extra_tx_headroom);
217 mgmt = skb_put_zero(skb, 24);
218 memcpy(mgmt->da, da, ETH_ALEN);
219 memcpy(mgmt->sa, sdata->vif.addr, ETH_ALEN);
220 if (sdata->vif.type == NL80211_IFTYPE_AP ||
221 sdata->vif.type == NL80211_IFTYPE_AP_VLAN ||
222 sdata->vif.type == NL80211_IFTYPE_MESH_POINT)
223 memcpy(mgmt->bssid, sdata->vif.addr, ETH_ALEN);
224 else if (sdata->vif.type == NL80211_IFTYPE_STATION)
225 memcpy(mgmt->bssid, sdata->u.mgd.bssid, ETH_ALEN);
226 else if (sdata->vif.type == NL80211_IFTYPE_ADHOC)
227 memcpy(mgmt->bssid, sdata->u.ibss.bssid, ETH_ALEN);
229 mgmt->frame_control = cpu_to_le16(IEEE80211_FTYPE_MGMT |
230 IEEE80211_STYPE_ACTION);
232 skb_put(skb, 1 + sizeof(mgmt->u.action.u.addba_resp));
233 mgmt->u.action.category = WLAN_CATEGORY_BACK;
234 mgmt->u.action.u.addba_resp.action_code = WLAN_ACTION_ADDBA_RESP;
235 mgmt->u.action.u.addba_resp.dialog_token = dialog_token;
237 capab = (u16)(amsdu << 0); /* bit 0 A-MSDU support */
238 capab |= (u16)(policy << 1); /* bit 1 aggregation policy */
239 capab |= (u16)(tid << 2); /* bit 5:2 TID number */
240 capab |= (u16)(buf_size << 6); /* bit 15:6 max size of aggregation */
242 mgmt->u.action.u.addba_resp.capab = cpu_to_le16(capab);
243 mgmt->u.action.u.addba_resp.timeout = cpu_to_le16(timeout);
244 mgmt->u.action.u.addba_resp.status = cpu_to_le16(status);
246 ieee80211_tx_skb(sdata, skb);
249 void ___ieee80211_start_rx_ba_session(struct sta_info *sta,
250 u8 dialog_token, u16 timeout,
251 u16 start_seq_num, u16 ba_policy, u16 tid,
252 u16 buf_size, bool tx, bool auto_seq)
254 struct ieee80211_local *local = sta->sdata->local;
255 struct tid_ampdu_rx *tid_agg_rx;
256 struct ieee80211_ampdu_params params = {
258 .action = IEEE80211_AMPDU_RX_START,
262 .ssn = start_seq_num,
264 int i, ret = -EOPNOTSUPP;
265 u16 status = WLAN_STATUS_REQUEST_DECLINED;
267 if (tid >= IEEE80211_FIRST_TSPEC_TSID) {
269 "STA %pM requests BA session on unsupported tid %d\n",
274 if (!sta->sta.ht_cap.ht_supported) {
276 "STA %pM erroneously requests BA session on tid %d w/o QoS\n",
278 /* send a response anyway, it's an error case if we get here */
282 if (test_sta_flag(sta, WLAN_STA_BLOCK_BA)) {
284 "Suspend in progress - Denying ADDBA request (%pM tid %d)\n",
289 /* sanity check for incoming parameters:
290 * check if configuration can support the BA policy
291 * and if buffer size does not exceeds max value */
292 /* XXX: check own ht delayed BA capability?? */
293 if (((ba_policy != 1) &&
294 (!(sta->sta.ht_cap.cap & IEEE80211_HT_CAP_DELAY_BA))) ||
295 (buf_size > IEEE80211_MAX_AMPDU_BUF)) {
296 status = WLAN_STATUS_INVALID_QOS_PARAM;
297 ht_dbg_ratelimited(sta->sdata,
298 "AddBA Req with bad params from %pM on tid %u. policy %d, buffer size %d\n",
299 sta->sta.addr, tid, ba_policy, buf_size);
302 /* determine default buffer size */
304 buf_size = IEEE80211_MAX_AMPDU_BUF;
306 /* make sure the size doesn't exceed the maximum supported by the hw */
307 if (buf_size > sta->sta.max_rx_aggregation_subframes)
308 buf_size = sta->sta.max_rx_aggregation_subframes;
309 params.buf_size = buf_size;
311 ht_dbg(sta->sdata, "AddBA Req buf_size=%d for %pM\n",
312 buf_size, sta->sta.addr);
314 /* examine state machine */
315 lockdep_assert_held(&sta->ampdu_mlme.mtx);
317 if (test_bit(tid, sta->ampdu_mlme.agg_session_valid)) {
318 if (sta->ampdu_mlme.tid_rx_token[tid] == dialog_token) {
319 ht_dbg_ratelimited(sta->sdata,
320 "updated AddBA Req from %pM on tid %u\n",
322 /* We have no API to update the timeout value in the
323 * driver so reject the timeout update.
325 status = WLAN_STATUS_REQUEST_DECLINED;
329 ht_dbg_ratelimited(sta->sdata,
330 "unexpected AddBA Req from %pM on tid %u\n",
333 /* delete existing Rx BA session on the same tid */
334 ___ieee80211_stop_rx_ba_session(sta, tid, WLAN_BACK_RECIPIENT,
335 WLAN_STATUS_UNSPECIFIED_QOS,
339 if (ieee80211_hw_check(&local->hw, SUPPORTS_REORDERING_BUFFER)) {
340 ret = drv_ampdu_action(local, sta->sdata, ¶ms);
342 "Rx A-MPDU request on %pM tid %d result %d\n",
343 sta->sta.addr, tid, ret);
345 status = WLAN_STATUS_SUCCESS;
349 /* prepare A-MPDU MLME for Rx aggregation */
350 tid_agg_rx = kzalloc(sizeof(*tid_agg_rx), GFP_KERNEL);
354 spin_lock_init(&tid_agg_rx->reorder_lock);
357 setup_deferrable_timer(&tid_agg_rx->session_timer,
358 sta_rx_agg_session_timer_expired,
359 (unsigned long)&sta->timer_to_tid[tid]);
361 /* rx reorder timer */
362 setup_timer(&tid_agg_rx->reorder_timer,
363 sta_rx_agg_reorder_timer_expired,
364 (unsigned long)&sta->timer_to_tid[tid]);
366 /* prepare reordering buffer */
367 tid_agg_rx->reorder_buf =
368 kcalloc(buf_size, sizeof(struct sk_buff_head), GFP_KERNEL);
369 tid_agg_rx->reorder_time =
370 kcalloc(buf_size, sizeof(unsigned long), GFP_KERNEL);
371 if (!tid_agg_rx->reorder_buf || !tid_agg_rx->reorder_time) {
372 kfree(tid_agg_rx->reorder_buf);
373 kfree(tid_agg_rx->reorder_time);
378 for (i = 0; i < buf_size; i++)
379 __skb_queue_head_init(&tid_agg_rx->reorder_buf[i]);
381 ret = drv_ampdu_action(local, sta->sdata, ¶ms);
382 ht_dbg(sta->sdata, "Rx A-MPDU request on %pM tid %d result %d\n",
383 sta->sta.addr, tid, ret);
385 kfree(tid_agg_rx->reorder_buf);
386 kfree(tid_agg_rx->reorder_time);
392 tid_agg_rx->ssn = start_seq_num;
393 tid_agg_rx->head_seq_num = start_seq_num;
394 tid_agg_rx->buf_size = buf_size;
395 tid_agg_rx->timeout = timeout;
396 tid_agg_rx->stored_mpdu_num = 0;
397 tid_agg_rx->auto_seq = auto_seq;
398 tid_agg_rx->started = false;
399 tid_agg_rx->reorder_buf_filtered = 0;
400 status = WLAN_STATUS_SUCCESS;
402 /* activate it for RX */
403 rcu_assign_pointer(sta->ampdu_mlme.tid_rx[tid], tid_agg_rx);
406 mod_timer(&tid_agg_rx->session_timer, TU_TO_EXP_TIME(timeout));
407 tid_agg_rx->last_rx = jiffies;
411 if (status == WLAN_STATUS_SUCCESS) {
412 __set_bit(tid, sta->ampdu_mlme.agg_session_valid);
413 __clear_bit(tid, sta->ampdu_mlme.unexpected_agg);
414 sta->ampdu_mlme.tid_rx_token[tid] = dialog_token;
418 ieee80211_send_addba_resp(sta->sdata, sta->sta.addr, tid,
419 dialog_token, status, 1, buf_size,
423 void __ieee80211_start_rx_ba_session(struct sta_info *sta,
424 u8 dialog_token, u16 timeout,
425 u16 start_seq_num, u16 ba_policy, u16 tid,
426 u16 buf_size, bool tx, bool auto_seq)
428 mutex_lock(&sta->ampdu_mlme.mtx);
429 ___ieee80211_start_rx_ba_session(sta, dialog_token, timeout,
430 start_seq_num, ba_policy, tid,
431 buf_size, tx, auto_seq);
432 mutex_unlock(&sta->ampdu_mlme.mtx);
435 void ieee80211_process_addba_request(struct ieee80211_local *local,
436 struct sta_info *sta,
437 struct ieee80211_mgmt *mgmt,
440 u16 capab, tid, timeout, ba_policy, buf_size, start_seq_num;
443 /* extract session parameters from addba request frame */
444 dialog_token = mgmt->u.action.u.addba_req.dialog_token;
445 timeout = le16_to_cpu(mgmt->u.action.u.addba_req.timeout);
447 le16_to_cpu(mgmt->u.action.u.addba_req.start_seq_num) >> 4;
449 capab = le16_to_cpu(mgmt->u.action.u.addba_req.capab);
450 ba_policy = (capab & IEEE80211_ADDBA_PARAM_POLICY_MASK) >> 1;
451 tid = (capab & IEEE80211_ADDBA_PARAM_TID_MASK) >> 2;
452 buf_size = (capab & IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK) >> 6;
454 __ieee80211_start_rx_ba_session(sta, dialog_token, timeout,
455 start_seq_num, ba_policy, tid,
456 buf_size, true, false);
459 void ieee80211_manage_rx_ba_offl(struct ieee80211_vif *vif,
460 const u8 *addr, unsigned int bit)
462 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
463 struct ieee80211_local *local = sdata->local;
464 struct sta_info *sta;
467 sta = sta_info_get_bss(sdata, addr);
471 set_bit(bit, sta->ampdu_mlme.tid_rx_manage_offl);
472 ieee80211_queue_work(&local->hw, &sta->ampdu_mlme.work);
476 EXPORT_SYMBOL(ieee80211_manage_rx_ba_offl);
478 void ieee80211_rx_ba_timer_expired(struct ieee80211_vif *vif,
479 const u8 *addr, unsigned int tid)
481 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
482 struct ieee80211_local *local = sdata->local;
483 struct sta_info *sta;
486 sta = sta_info_get_bss(sdata, addr);
490 set_bit(tid, sta->ampdu_mlme.tid_rx_timer_expired);
491 ieee80211_queue_work(&local->hw, &sta->ampdu_mlme.work);
496 EXPORT_SYMBOL(ieee80211_rx_ba_timer_expired);