5 * Copyright 2002-2005, Instant802 Networks, Inc.
6 * Copyright 2005-2006, Devicescape Software, Inc.
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(struct timer_list *t)
157 struct tid_ampdu_rx *tid_rx = from_timer(tid_rx, t, session_timer);
158 struct sta_info *sta = tid_rx->sta;
159 u8 tid = tid_rx->tid;
160 unsigned long timeout;
162 timeout = tid_rx->last_rx + TU_TO_JIFFIES(tid_rx->timeout);
163 if (time_is_after_jiffies(timeout)) {
164 mod_timer(&tid_rx->session_timer, timeout);
168 ht_dbg(sta->sdata, "RX session timer expired on %pM tid %d\n",
171 set_bit(tid, sta->ampdu_mlme.tid_rx_timer_expired);
172 ieee80211_queue_work(&sta->local->hw, &sta->ampdu_mlme.work);
175 static void sta_rx_agg_reorder_timer_expired(struct timer_list *t)
177 struct tid_ampdu_rx *tid_rx = from_timer(tid_rx, t, reorder_timer);
180 ieee80211_release_reorder_timeout(tid_rx->sta, tid_rx->tid);
184 static void ieee80211_send_addba_resp(struct ieee80211_sub_if_data *sdata, u8 *da, u16 tid,
185 u8 dialog_token, u16 status, u16 policy,
186 u16 buf_size, u16 timeout)
188 struct ieee80211_local *local = sdata->local;
190 struct ieee80211_mgmt *mgmt;
191 bool amsdu = ieee80211_hw_check(&local->hw, SUPPORTS_AMSDU_IN_AMPDU);
194 skb = dev_alloc_skb(sizeof(*mgmt) + local->hw.extra_tx_headroom);
198 skb_reserve(skb, local->hw.extra_tx_headroom);
199 mgmt = skb_put_zero(skb, 24);
200 memcpy(mgmt->da, da, ETH_ALEN);
201 memcpy(mgmt->sa, sdata->vif.addr, ETH_ALEN);
202 if (sdata->vif.type == NL80211_IFTYPE_AP ||
203 sdata->vif.type == NL80211_IFTYPE_AP_VLAN ||
204 sdata->vif.type == NL80211_IFTYPE_MESH_POINT)
205 memcpy(mgmt->bssid, sdata->vif.addr, ETH_ALEN);
206 else if (sdata->vif.type == NL80211_IFTYPE_STATION)
207 memcpy(mgmt->bssid, sdata->u.mgd.bssid, ETH_ALEN);
208 else if (sdata->vif.type == NL80211_IFTYPE_ADHOC)
209 memcpy(mgmt->bssid, sdata->u.ibss.bssid, ETH_ALEN);
211 mgmt->frame_control = cpu_to_le16(IEEE80211_FTYPE_MGMT |
212 IEEE80211_STYPE_ACTION);
214 skb_put(skb, 1 + sizeof(mgmt->u.action.u.addba_resp));
215 mgmt->u.action.category = WLAN_CATEGORY_BACK;
216 mgmt->u.action.u.addba_resp.action_code = WLAN_ACTION_ADDBA_RESP;
217 mgmt->u.action.u.addba_resp.dialog_token = dialog_token;
219 capab = (u16)(amsdu << 0); /* bit 0 A-MSDU support */
220 capab |= (u16)(policy << 1); /* bit 1 aggregation policy */
221 capab |= (u16)(tid << 2); /* bit 5:2 TID number */
222 capab |= (u16)(buf_size << 6); /* bit 15:6 max size of aggregation */
224 mgmt->u.action.u.addba_resp.capab = cpu_to_le16(capab);
225 mgmt->u.action.u.addba_resp.timeout = cpu_to_le16(timeout);
226 mgmt->u.action.u.addba_resp.status = cpu_to_le16(status);
228 ieee80211_tx_skb(sdata, skb);
231 void ___ieee80211_start_rx_ba_session(struct sta_info *sta,
232 u8 dialog_token, u16 timeout,
233 u16 start_seq_num, u16 ba_policy, u16 tid,
234 u16 buf_size, bool tx, bool auto_seq)
236 struct ieee80211_local *local = sta->sdata->local;
237 struct tid_ampdu_rx *tid_agg_rx;
238 struct ieee80211_ampdu_params params = {
240 .action = IEEE80211_AMPDU_RX_START,
244 .ssn = start_seq_num,
246 int i, ret = -EOPNOTSUPP;
247 u16 status = WLAN_STATUS_REQUEST_DECLINED;
250 if (tid >= IEEE80211_FIRST_TSPEC_TSID) {
252 "STA %pM requests BA session on unsupported tid %d\n",
257 if (!sta->sta.ht_cap.ht_supported) {
259 "STA %pM erroneously requests BA session on tid %d w/o QoS\n",
261 /* send a response anyway, it's an error case if we get here */
265 if (test_sta_flag(sta, WLAN_STA_BLOCK_BA)) {
267 "Suspend in progress - Denying ADDBA request (%pM tid %d)\n",
272 if (sta->sta.he_cap.has_he)
273 max_buf_size = IEEE80211_MAX_AMPDU_BUF;
275 max_buf_size = IEEE80211_MAX_AMPDU_BUF_HT;
277 /* sanity check for incoming parameters:
278 * check if configuration can support the BA policy
279 * and if buffer size does not exceeds max value */
280 /* XXX: check own ht delayed BA capability?? */
281 if (((ba_policy != 1) &&
282 (!(sta->sta.ht_cap.cap & IEEE80211_HT_CAP_DELAY_BA))) ||
283 (buf_size > max_buf_size)) {
284 status = WLAN_STATUS_INVALID_QOS_PARAM;
285 ht_dbg_ratelimited(sta->sdata,
286 "AddBA Req with bad params from %pM on tid %u. policy %d, buffer size %d\n",
287 sta->sta.addr, tid, ba_policy, buf_size);
290 /* determine default buffer size */
292 buf_size = max_buf_size;
294 /* make sure the size doesn't exceed the maximum supported by the hw */
295 if (buf_size > sta->sta.max_rx_aggregation_subframes)
296 buf_size = sta->sta.max_rx_aggregation_subframes;
297 params.buf_size = buf_size;
299 ht_dbg(sta->sdata, "AddBA Req buf_size=%d for %pM\n",
300 buf_size, sta->sta.addr);
302 /* examine state machine */
303 lockdep_assert_held(&sta->ampdu_mlme.mtx);
305 if (test_bit(tid, sta->ampdu_mlme.agg_session_valid)) {
306 if (sta->ampdu_mlme.tid_rx_token[tid] == dialog_token) {
307 struct tid_ampdu_rx *tid_rx;
309 ht_dbg_ratelimited(sta->sdata,
310 "updated AddBA Req from %pM on tid %u\n",
312 /* We have no API to update the timeout value in the
313 * driver so reject the timeout update if the timeout
314 * changed. If if did not change, i.e., no real update,
315 * just reply with success.
318 tid_rx = rcu_dereference(sta->ampdu_mlme.tid_rx[tid]);
319 if (tid_rx && tid_rx->timeout == timeout)
320 status = WLAN_STATUS_SUCCESS;
322 status = WLAN_STATUS_REQUEST_DECLINED;
327 ht_dbg_ratelimited(sta->sdata,
328 "unexpected AddBA Req from %pM on tid %u\n",
331 /* delete existing Rx BA session on the same tid */
332 ___ieee80211_stop_rx_ba_session(sta, tid, WLAN_BACK_RECIPIENT,
333 WLAN_STATUS_UNSPECIFIED_QOS,
337 if (ieee80211_hw_check(&local->hw, SUPPORTS_REORDERING_BUFFER)) {
338 ret = drv_ampdu_action(local, sta->sdata, ¶ms);
340 "Rx A-MPDU request on %pM tid %d result %d\n",
341 sta->sta.addr, tid, ret);
343 status = WLAN_STATUS_SUCCESS;
347 /* prepare A-MPDU MLME for Rx aggregation */
348 tid_agg_rx = kzalloc(sizeof(*tid_agg_rx), GFP_KERNEL);
352 spin_lock_init(&tid_agg_rx->reorder_lock);
355 timer_setup(&tid_agg_rx->session_timer,
356 sta_rx_agg_session_timer_expired, TIMER_DEFERRABLE);
358 /* rx reorder timer */
359 timer_setup(&tid_agg_rx->reorder_timer,
360 sta_rx_agg_reorder_timer_expired, 0);
362 /* prepare reordering buffer */
363 tid_agg_rx->reorder_buf =
364 kcalloc(buf_size, sizeof(struct sk_buff_head), GFP_KERNEL);
365 tid_agg_rx->reorder_time =
366 kcalloc(buf_size, sizeof(unsigned long), GFP_KERNEL);
367 if (!tid_agg_rx->reorder_buf || !tid_agg_rx->reorder_time) {
368 kfree(tid_agg_rx->reorder_buf);
369 kfree(tid_agg_rx->reorder_time);
374 for (i = 0; i < buf_size; i++)
375 __skb_queue_head_init(&tid_agg_rx->reorder_buf[i]);
377 ret = drv_ampdu_action(local, sta->sdata, ¶ms);
378 ht_dbg(sta->sdata, "Rx A-MPDU request on %pM tid %d result %d\n",
379 sta->sta.addr, tid, ret);
381 kfree(tid_agg_rx->reorder_buf);
382 kfree(tid_agg_rx->reorder_time);
388 tid_agg_rx->ssn = start_seq_num;
389 tid_agg_rx->head_seq_num = start_seq_num;
390 tid_agg_rx->buf_size = buf_size;
391 tid_agg_rx->timeout = timeout;
392 tid_agg_rx->stored_mpdu_num = 0;
393 tid_agg_rx->auto_seq = auto_seq;
394 tid_agg_rx->started = false;
395 tid_agg_rx->reorder_buf_filtered = 0;
396 tid_agg_rx->tid = tid;
397 tid_agg_rx->sta = sta;
398 status = WLAN_STATUS_SUCCESS;
400 /* activate it for RX */
401 rcu_assign_pointer(sta->ampdu_mlme.tid_rx[tid], tid_agg_rx);
404 mod_timer(&tid_agg_rx->session_timer, TU_TO_EXP_TIME(timeout));
405 tid_agg_rx->last_rx = jiffies;
409 if (status == WLAN_STATUS_SUCCESS) {
410 __set_bit(tid, sta->ampdu_mlme.agg_session_valid);
411 __clear_bit(tid, sta->ampdu_mlme.unexpected_agg);
412 sta->ampdu_mlme.tid_rx_token[tid] = dialog_token;
416 ieee80211_send_addba_resp(sta->sdata, sta->sta.addr, tid,
417 dialog_token, status, 1, buf_size,
421 static void __ieee80211_start_rx_ba_session(struct sta_info *sta,
422 u8 dialog_token, u16 timeout,
423 u16 start_seq_num, u16 ba_policy,
424 u16 tid, u16 buf_size, bool tx,
427 mutex_lock(&sta->ampdu_mlme.mtx);
428 ___ieee80211_start_rx_ba_session(sta, dialog_token, timeout,
429 start_seq_num, ba_policy, tid,
430 buf_size, tx, auto_seq);
431 mutex_unlock(&sta->ampdu_mlme.mtx);
434 void ieee80211_process_addba_request(struct ieee80211_local *local,
435 struct sta_info *sta,
436 struct ieee80211_mgmt *mgmt,
439 u16 capab, tid, timeout, ba_policy, buf_size, start_seq_num;
442 /* extract session parameters from addba request frame */
443 dialog_token = mgmt->u.action.u.addba_req.dialog_token;
444 timeout = le16_to_cpu(mgmt->u.action.u.addba_req.timeout);
446 le16_to_cpu(mgmt->u.action.u.addba_req.start_seq_num) >> 4;
448 capab = le16_to_cpu(mgmt->u.action.u.addba_req.capab);
449 ba_policy = (capab & IEEE80211_ADDBA_PARAM_POLICY_MASK) >> 1;
450 tid = (capab & IEEE80211_ADDBA_PARAM_TID_MASK) >> 2;
451 buf_size = (capab & IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK) >> 6;
453 __ieee80211_start_rx_ba_session(sta, dialog_token, timeout,
454 start_seq_num, ba_policy, tid,
455 buf_size, true, false);
458 void ieee80211_manage_rx_ba_offl(struct ieee80211_vif *vif,
459 const u8 *addr, unsigned int tid)
461 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
462 struct ieee80211_local *local = sdata->local;
463 struct sta_info *sta;
466 sta = sta_info_get_bss(sdata, addr);
470 set_bit(tid, sta->ampdu_mlme.tid_rx_manage_offl);
471 ieee80211_queue_work(&local->hw, &sta->ampdu_mlme.work);
475 EXPORT_SYMBOL(ieee80211_manage_rx_ba_offl);
477 void ieee80211_rx_ba_timer_expired(struct ieee80211_vif *vif,
478 const u8 *addr, unsigned int tid)
480 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
481 struct ieee80211_local *local = sdata->local;
482 struct sta_info *sta;
485 sta = sta_info_get_bss(sdata, addr);
489 set_bit(tid, sta->ampdu_mlme.tid_rx_timer_expired);
490 ieee80211_queue_work(&local->hw, &sta->ampdu_mlme.work);
495 EXPORT_SYMBOL(ieee80211_rx_ba_timer_expired);