1 // SPDX-License-Identifier: GPL-2.0-only
6 * Copyright 2002-2005, Instant802 Networks, Inc.
7 * Copyright 2005-2006, Devicescape Software, Inc.
10 * Copyright 2007-2010, Intel Corporation
11 * Copyright(c) 2015-2017 Intel Deutschland GmbH
12 * Copyright (C) 2018-2022 Intel Corporation
16 * DOC: RX A-MPDU aggregation
18 * Aggregation on the RX side requires only implementing the
19 * @ampdu_action callback that is invoked to start/stop any
20 * block-ack sessions for RX aggregation.
22 * When RX aggregation is started by the peer, the driver is
23 * notified via @ampdu_action function, with the
24 * %IEEE80211_AMPDU_RX_START action, and may reject the request
25 * in which case a negative response is sent to the peer, if it
26 * accepts it a positive response is sent.
28 * While the session is active, the device/driver are required
29 * to de-aggregate frames and pass them up one by one to mac80211,
30 * which will handle the reorder buffer.
32 * When the aggregation session is stopped again by the peer or
33 * ourselves, the driver's @ampdu_action function will be called
34 * with the action %IEEE80211_AMPDU_RX_STOP. In this case, the
38 #include <linux/ieee80211.h>
39 #include <linux/slab.h>
40 #include <linux/export.h>
41 #include <net/mac80211.h>
42 #include "ieee80211_i.h"
43 #include "driver-ops.h"
45 static void ieee80211_free_tid_rx(struct rcu_head *h)
47 struct tid_ampdu_rx *tid_rx =
48 container_of(h, struct tid_ampdu_rx, rcu_head);
51 for (i = 0; i < tid_rx->buf_size; i++)
52 __skb_queue_purge(&tid_rx->reorder_buf[i]);
53 kfree(tid_rx->reorder_buf);
54 kfree(tid_rx->reorder_time);
58 void ___ieee80211_stop_rx_ba_session(struct sta_info *sta, u16 tid,
59 u16 initiator, u16 reason, bool tx)
61 struct ieee80211_local *local = sta->local;
62 struct tid_ampdu_rx *tid_rx;
63 struct ieee80211_ampdu_params params = {
65 .action = IEEE80211_AMPDU_RX_STOP,
72 lockdep_assert_held(&sta->ampdu_mlme.mtx);
74 tid_rx = rcu_dereference_protected(sta->ampdu_mlme.tid_rx[tid],
75 lockdep_is_held(&sta->ampdu_mlme.mtx));
77 if (!test_bit(tid, sta->ampdu_mlme.agg_session_valid))
80 RCU_INIT_POINTER(sta->ampdu_mlme.tid_rx[tid], NULL);
81 __clear_bit(tid, sta->ampdu_mlme.agg_session_valid);
84 "Rx BA session stop requested for %pM tid %u %s reason: %d\n",
86 initiator == WLAN_BACK_RECIPIENT ? "recipient" : "initiator",
89 if (drv_ampdu_action(local, sta->sdata, ¶ms))
90 sdata_info(sta->sdata,
91 "HW problem - can not stop rx aggregation for %pM tid %d\n",
94 /* check if this is a self generated aggregation halt */
95 if (initiator == WLAN_BACK_RECIPIENT && tx)
96 ieee80211_send_delba(sta->sdata, sta->sta.addr,
97 tid, WLAN_BACK_RECIPIENT, reason);
100 * return here in case tid_rx is not assigned - which will happen if
101 * IEEE80211_HW_SUPPORTS_REORDERING_BUFFER is set.
106 del_timer_sync(&tid_rx->session_timer);
108 /* make sure ieee80211_sta_reorder_release() doesn't re-arm the timer */
109 spin_lock_bh(&tid_rx->reorder_lock);
110 tid_rx->removed = true;
111 spin_unlock_bh(&tid_rx->reorder_lock);
112 del_timer_sync(&tid_rx->reorder_timer);
114 call_rcu(&tid_rx->rcu_head, ieee80211_free_tid_rx);
117 void __ieee80211_stop_rx_ba_session(struct sta_info *sta, u16 tid,
118 u16 initiator, u16 reason, bool tx)
120 mutex_lock(&sta->ampdu_mlme.mtx);
121 ___ieee80211_stop_rx_ba_session(sta, tid, initiator, reason, tx);
122 mutex_unlock(&sta->ampdu_mlme.mtx);
125 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
128 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
129 struct sta_info *sta;
133 sta = sta_info_get_bss(sdata, addr);
139 for (i = 0; i < IEEE80211_NUM_TIDS; i++)
140 if (ba_rx_bitmap & BIT(i))
141 set_bit(i, sta->ampdu_mlme.tid_rx_stop_requested);
143 ieee80211_queue_work(&sta->local->hw, &sta->ampdu_mlme.work);
146 EXPORT_SYMBOL(ieee80211_stop_rx_ba_session);
149 * After accepting the AddBA Request we activated a timer,
150 * resetting it after each frame that arrives from the originator.
152 static void sta_rx_agg_session_timer_expired(struct timer_list *t)
154 struct tid_ampdu_rx *tid_rx = from_timer(tid_rx, t, session_timer);
155 struct sta_info *sta = tid_rx->sta;
156 u8 tid = tid_rx->tid;
157 unsigned long timeout;
159 timeout = tid_rx->last_rx + TU_TO_JIFFIES(tid_rx->timeout);
160 if (time_is_after_jiffies(timeout)) {
161 mod_timer(&tid_rx->session_timer, timeout);
165 ht_dbg(sta->sdata, "RX session timer expired on %pM tid %d\n",
168 set_bit(tid, sta->ampdu_mlme.tid_rx_timer_expired);
169 ieee80211_queue_work(&sta->local->hw, &sta->ampdu_mlme.work);
172 static void sta_rx_agg_reorder_timer_expired(struct timer_list *t)
174 struct tid_ampdu_rx *tid_rx = from_timer(tid_rx, t, reorder_timer);
177 ieee80211_release_reorder_timeout(tid_rx->sta, tid_rx->tid);
181 static void ieee80211_add_addbaext(struct ieee80211_sub_if_data *sdata,
183 const struct ieee80211_addba_ext_ie *req,
186 struct ieee80211_supported_band *sband;
187 struct ieee80211_addba_ext_ie *resp;
188 const struct ieee80211_sta_he_cap *he_cap;
189 u8 frag_level, cap_frag_level;
192 sband = ieee80211_get_sband(sdata);
195 he_cap = ieee80211_get_he_iftype_cap(sband,
196 ieee80211_vif_type_p2p(&sdata->vif));
200 pos = skb_put_zero(skb, 2 + sizeof(struct ieee80211_addba_ext_ie));
201 *pos++ = WLAN_EID_ADDBA_EXT;
202 *pos++ = sizeof(struct ieee80211_addba_ext_ie);
203 resp = (struct ieee80211_addba_ext_ie *)pos;
204 resp->data = req->data & IEEE80211_ADDBA_EXT_NO_FRAG;
206 frag_level = u32_get_bits(req->data,
207 IEEE80211_ADDBA_EXT_FRAG_LEVEL_MASK);
208 cap_frag_level = u32_get_bits(he_cap->he_cap_elem.mac_cap_info[0],
209 IEEE80211_HE_MAC_CAP0_DYNAMIC_FRAG_MASK);
210 if (frag_level > cap_frag_level)
211 frag_level = cap_frag_level;
212 resp->data |= u8_encode_bits(frag_level,
213 IEEE80211_ADDBA_EXT_FRAG_LEVEL_MASK);
214 resp->data |= u8_encode_bits(buf_size >> IEEE80211_ADDBA_EXT_BUF_SIZE_SHIFT,
215 IEEE80211_ADDBA_EXT_BUF_SIZE_MASK);
218 static void ieee80211_send_addba_resp(struct sta_info *sta, u8 *da, u16 tid,
219 u8 dialog_token, u16 status, u16 policy,
220 u16 buf_size, u16 timeout,
221 const struct ieee80211_addba_ext_ie *addbaext)
223 struct ieee80211_sub_if_data *sdata = sta->sdata;
224 struct ieee80211_local *local = sdata->local;
226 struct ieee80211_mgmt *mgmt;
227 bool amsdu = ieee80211_hw_check(&local->hw, SUPPORTS_AMSDU_IN_AMPDU);
230 skb = dev_alloc_skb(sizeof(*mgmt) +
231 2 + sizeof(struct ieee80211_addba_ext_ie) +
232 local->hw.extra_tx_headroom);
236 skb_reserve(skb, local->hw.extra_tx_headroom);
237 mgmt = skb_put_zero(skb, 24);
238 memcpy(mgmt->da, da, ETH_ALEN);
239 memcpy(mgmt->sa, sdata->vif.addr, ETH_ALEN);
240 if (sdata->vif.type == NL80211_IFTYPE_AP ||
241 sdata->vif.type == NL80211_IFTYPE_AP_VLAN ||
242 sdata->vif.type == NL80211_IFTYPE_MESH_POINT)
243 memcpy(mgmt->bssid, sdata->vif.addr, ETH_ALEN);
244 else if (sdata->vif.type == NL80211_IFTYPE_STATION)
245 memcpy(mgmt->bssid, sdata->deflink.u.mgd.bssid, ETH_ALEN);
246 else if (sdata->vif.type == NL80211_IFTYPE_ADHOC)
247 memcpy(mgmt->bssid, sdata->u.ibss.bssid, ETH_ALEN);
249 mgmt->frame_control = cpu_to_le16(IEEE80211_FTYPE_MGMT |
250 IEEE80211_STYPE_ACTION);
252 skb_put(skb, 1 + sizeof(mgmt->u.action.u.addba_resp));
253 mgmt->u.action.category = WLAN_CATEGORY_BACK;
254 mgmt->u.action.u.addba_resp.action_code = WLAN_ACTION_ADDBA_RESP;
255 mgmt->u.action.u.addba_resp.dialog_token = dialog_token;
257 capab = u16_encode_bits(amsdu, IEEE80211_ADDBA_PARAM_AMSDU_MASK);
258 capab |= u16_encode_bits(policy, IEEE80211_ADDBA_PARAM_POLICY_MASK);
259 capab |= u16_encode_bits(tid, IEEE80211_ADDBA_PARAM_TID_MASK);
260 capab |= u16_encode_bits(buf_size, IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK);
262 mgmt->u.action.u.addba_resp.capab = cpu_to_le16(capab);
263 mgmt->u.action.u.addba_resp.timeout = cpu_to_le16(timeout);
264 mgmt->u.action.u.addba_resp.status = cpu_to_le16(status);
266 if (sta->sta.deflink.he_cap.has_he && addbaext)
267 ieee80211_add_addbaext(sdata, skb, addbaext, buf_size);
269 ieee80211_tx_skb(sdata, skb);
272 void ___ieee80211_start_rx_ba_session(struct sta_info *sta,
273 u8 dialog_token, u16 timeout,
274 u16 start_seq_num, u16 ba_policy, u16 tid,
275 u16 buf_size, bool tx, bool auto_seq,
276 const struct ieee80211_addba_ext_ie *addbaext)
278 struct ieee80211_local *local = sta->sdata->local;
279 struct tid_ampdu_rx *tid_agg_rx;
280 struct ieee80211_ampdu_params params = {
282 .action = IEEE80211_AMPDU_RX_START,
286 .ssn = start_seq_num,
288 int i, ret = -EOPNOTSUPP;
289 u16 status = WLAN_STATUS_REQUEST_DECLINED;
292 if (tid >= IEEE80211_FIRST_TSPEC_TSID) {
294 "STA %pM requests BA session on unsupported tid %d\n",
299 if (!sta->sta.deflink.ht_cap.ht_supported &&
300 sta->sdata->vif.bss_conf.chandef.chan->band != NL80211_BAND_6GHZ) {
302 "STA %pM erroneously requests BA session on tid %d w/o QoS\n",
304 /* send a response anyway, it's an error case if we get here */
308 if (test_sta_flag(sta, WLAN_STA_BLOCK_BA)) {
310 "Suspend in progress - Denying ADDBA request (%pM tid %d)\n",
315 if (sta->sta.deflink.eht_cap.has_eht)
316 max_buf_size = IEEE80211_MAX_AMPDU_BUF_EHT;
317 else if (sta->sta.deflink.he_cap.has_he)
318 max_buf_size = IEEE80211_MAX_AMPDU_BUF_HE;
320 max_buf_size = IEEE80211_MAX_AMPDU_BUF_HT;
322 /* sanity check for incoming parameters:
323 * check if configuration can support the BA policy
324 * and if buffer size does not exceeds max value */
325 /* XXX: check own ht delayed BA capability?? */
326 if (((ba_policy != 1) &&
327 (!(sta->sta.deflink.ht_cap.cap & IEEE80211_HT_CAP_DELAY_BA))) ||
328 (buf_size > max_buf_size)) {
329 status = WLAN_STATUS_INVALID_QOS_PARAM;
330 ht_dbg_ratelimited(sta->sdata,
331 "AddBA Req with bad params from %pM on tid %u. policy %d, buffer size %d\n",
332 sta->sta.addr, tid, ba_policy, buf_size);
335 /* determine default buffer size */
337 buf_size = max_buf_size;
339 /* make sure the size doesn't exceed the maximum supported by the hw */
340 if (buf_size > sta->sta.max_rx_aggregation_subframes)
341 buf_size = sta->sta.max_rx_aggregation_subframes;
342 params.buf_size = buf_size;
344 ht_dbg(sta->sdata, "AddBA Req buf_size=%d for %pM\n",
345 buf_size, sta->sta.addr);
347 /* examine state machine */
348 lockdep_assert_held(&sta->ampdu_mlme.mtx);
350 if (test_bit(tid, sta->ampdu_mlme.agg_session_valid)) {
351 if (sta->ampdu_mlme.tid_rx_token[tid] == dialog_token) {
352 struct tid_ampdu_rx *tid_rx;
354 ht_dbg_ratelimited(sta->sdata,
355 "updated AddBA Req from %pM on tid %u\n",
357 /* We have no API to update the timeout value in the
358 * driver so reject the timeout update if the timeout
359 * changed. If it did not change, i.e., no real update,
360 * just reply with success.
363 tid_rx = rcu_dereference(sta->ampdu_mlme.tid_rx[tid]);
364 if (tid_rx && tid_rx->timeout == timeout)
365 status = WLAN_STATUS_SUCCESS;
367 status = WLAN_STATUS_REQUEST_DECLINED;
372 ht_dbg_ratelimited(sta->sdata,
373 "unexpected AddBA Req from %pM on tid %u\n",
376 /* delete existing Rx BA session on the same tid */
377 ___ieee80211_stop_rx_ba_session(sta, tid, WLAN_BACK_RECIPIENT,
378 WLAN_STATUS_UNSPECIFIED_QOS,
382 if (ieee80211_hw_check(&local->hw, SUPPORTS_REORDERING_BUFFER)) {
383 ret = drv_ampdu_action(local, sta->sdata, ¶ms);
385 "Rx A-MPDU request on %pM tid %d result %d\n",
386 sta->sta.addr, tid, ret);
388 status = WLAN_STATUS_SUCCESS;
392 /* prepare A-MPDU MLME for Rx aggregation */
393 tid_agg_rx = kzalloc(sizeof(*tid_agg_rx), GFP_KERNEL);
397 spin_lock_init(&tid_agg_rx->reorder_lock);
400 timer_setup(&tid_agg_rx->session_timer,
401 sta_rx_agg_session_timer_expired, TIMER_DEFERRABLE);
403 /* rx reorder timer */
404 timer_setup(&tid_agg_rx->reorder_timer,
405 sta_rx_agg_reorder_timer_expired, 0);
407 /* prepare reordering buffer */
408 tid_agg_rx->reorder_buf =
409 kcalloc(buf_size, sizeof(struct sk_buff_head), GFP_KERNEL);
410 tid_agg_rx->reorder_time =
411 kcalloc(buf_size, sizeof(unsigned long), GFP_KERNEL);
412 if (!tid_agg_rx->reorder_buf || !tid_agg_rx->reorder_time) {
413 kfree(tid_agg_rx->reorder_buf);
414 kfree(tid_agg_rx->reorder_time);
419 for (i = 0; i < buf_size; i++)
420 __skb_queue_head_init(&tid_agg_rx->reorder_buf[i]);
422 ret = drv_ampdu_action(local, sta->sdata, ¶ms);
423 ht_dbg(sta->sdata, "Rx A-MPDU request on %pM tid %d result %d\n",
424 sta->sta.addr, tid, ret);
426 kfree(tid_agg_rx->reorder_buf);
427 kfree(tid_agg_rx->reorder_time);
433 tid_agg_rx->ssn = start_seq_num;
434 tid_agg_rx->head_seq_num = start_seq_num;
435 tid_agg_rx->buf_size = buf_size;
436 tid_agg_rx->timeout = timeout;
437 tid_agg_rx->stored_mpdu_num = 0;
438 tid_agg_rx->auto_seq = auto_seq;
439 tid_agg_rx->started = false;
440 tid_agg_rx->reorder_buf_filtered = 0;
441 tid_agg_rx->tid = tid;
442 tid_agg_rx->sta = sta;
443 status = WLAN_STATUS_SUCCESS;
445 /* activate it for RX */
446 rcu_assign_pointer(sta->ampdu_mlme.tid_rx[tid], tid_agg_rx);
449 mod_timer(&tid_agg_rx->session_timer, TU_TO_EXP_TIME(timeout));
450 tid_agg_rx->last_rx = jiffies;
454 if (status == WLAN_STATUS_SUCCESS) {
455 __set_bit(tid, sta->ampdu_mlme.agg_session_valid);
456 __clear_bit(tid, sta->ampdu_mlme.unexpected_agg);
457 sta->ampdu_mlme.tid_rx_token[tid] = dialog_token;
461 ieee80211_send_addba_resp(sta, sta->sta.addr, tid,
462 dialog_token, status, 1, buf_size,
466 static void __ieee80211_start_rx_ba_session(struct sta_info *sta,
467 u8 dialog_token, u16 timeout,
468 u16 start_seq_num, u16 ba_policy,
469 u16 tid, u16 buf_size, bool tx,
471 const struct ieee80211_addba_ext_ie *addbaext)
473 mutex_lock(&sta->ampdu_mlme.mtx);
474 ___ieee80211_start_rx_ba_session(sta, dialog_token, timeout,
475 start_seq_num, ba_policy, tid,
476 buf_size, tx, auto_seq, addbaext);
477 mutex_unlock(&sta->ampdu_mlme.mtx);
480 void ieee80211_process_addba_request(struct ieee80211_local *local,
481 struct sta_info *sta,
482 struct ieee80211_mgmt *mgmt,
485 u16 capab, tid, timeout, ba_policy, buf_size, start_seq_num;
486 struct ieee802_11_elems *elems = NULL;
490 /* extract session parameters from addba request frame */
491 dialog_token = mgmt->u.action.u.addba_req.dialog_token;
492 timeout = le16_to_cpu(mgmt->u.action.u.addba_req.timeout);
494 le16_to_cpu(mgmt->u.action.u.addba_req.start_seq_num) >> 4;
496 capab = le16_to_cpu(mgmt->u.action.u.addba_req.capab);
497 ba_policy = (capab & IEEE80211_ADDBA_PARAM_POLICY_MASK) >> 1;
498 tid = (capab & IEEE80211_ADDBA_PARAM_TID_MASK) >> 2;
499 buf_size = (capab & IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK) >> 6;
501 ies_len = len - offsetof(struct ieee80211_mgmt,
502 u.action.u.addba_req.variable);
504 elems = ieee802_11_parse_elems(mgmt->u.action.u.addba_req.variable,
505 ies_len, true, NULL);
506 if (!elems || elems->parse_error)
510 if (sta->sta.deflink.eht_cap.has_eht && elems && elems->addba_ext_ie) {
511 u8 buf_size_1k = u8_get_bits(elems->addba_ext_ie->data,
512 IEEE80211_ADDBA_EXT_BUF_SIZE_MASK);
514 buf_size |= buf_size_1k << IEEE80211_ADDBA_EXT_BUF_SIZE_SHIFT;
517 __ieee80211_start_rx_ba_session(sta, dialog_token, timeout,
518 start_seq_num, ba_policy, tid,
519 buf_size, true, false,
520 elems ? elems->addba_ext_ie : NULL);
525 void ieee80211_manage_rx_ba_offl(struct ieee80211_vif *vif,
526 const u8 *addr, unsigned int tid)
528 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
529 struct ieee80211_local *local = sdata->local;
530 struct sta_info *sta;
533 sta = sta_info_get_bss(sdata, addr);
537 set_bit(tid, sta->ampdu_mlme.tid_rx_manage_offl);
538 ieee80211_queue_work(&local->hw, &sta->ampdu_mlme.work);
542 EXPORT_SYMBOL(ieee80211_manage_rx_ba_offl);
544 void ieee80211_rx_ba_timer_expired(struct ieee80211_vif *vif,
545 const u8 *addr, unsigned int tid)
547 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
548 struct ieee80211_local *local = sdata->local;
549 struct sta_info *sta;
552 sta = sta_info_get_bss(sdata, addr);
556 set_bit(tid, sta->ampdu_mlme.tid_rx_timer_expired);
557 ieee80211_queue_work(&local->hw, &sta->ampdu_mlme.work);
562 EXPORT_SYMBOL(ieee80211_rx_ba_timer_expired);