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 Intel Deutschland GmbH
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License version 2 as
14 * published by the Free Software Foundation.
18 * DOC: RX A-MPDU aggregation
20 * Aggregation on the RX side requires only implementing the
21 * @ampdu_action callback that is invoked to start/stop any
22 * block-ack sessions for RX aggregation.
24 * When RX aggregation is started by the peer, the driver is
25 * notified via @ampdu_action function, with the
26 * %IEEE80211_AMPDU_RX_START action, and may reject the request
27 * in which case a negative response is sent to the peer, if it
28 * accepts it a positive response is sent.
30 * While the session is active, the device/driver are required
31 * to de-aggregate frames and pass them up one by one to mac80211,
32 * which will handle the reorder buffer.
34 * When the aggregation session is stopped again by the peer or
35 * ourselves, the driver's @ampdu_action function will be called
36 * with the action %IEEE80211_AMPDU_RX_STOP. In this case, the
40 #include <linux/ieee80211.h>
41 #include <linux/slab.h>
42 #include <linux/export.h>
43 #include <net/mac80211.h>
44 #include "ieee80211_i.h"
45 #include "driver-ops.h"
47 static void ieee80211_free_tid_rx(struct rcu_head *h)
49 struct tid_ampdu_rx *tid_rx =
50 container_of(h, struct tid_ampdu_rx, rcu_head);
53 for (i = 0; i < tid_rx->buf_size; i++)
54 __skb_queue_purge(&tid_rx->reorder_buf[i]);
55 kfree(tid_rx->reorder_buf);
56 kfree(tid_rx->reorder_time);
60 void ___ieee80211_stop_rx_ba_session(struct sta_info *sta, u16 tid,
61 u16 initiator, u16 reason, bool tx)
63 struct ieee80211_local *local = sta->local;
64 struct tid_ampdu_rx *tid_rx;
65 struct ieee80211_ampdu_params params = {
67 .action = IEEE80211_AMPDU_RX_STOP,
74 lockdep_assert_held(&sta->ampdu_mlme.mtx);
76 tid_rx = rcu_dereference_protected(sta->ampdu_mlme.tid_rx[tid],
77 lockdep_is_held(&sta->ampdu_mlme.mtx));
79 if (!test_bit(tid, sta->ampdu_mlme.agg_session_valid))
82 RCU_INIT_POINTER(sta->ampdu_mlme.tid_rx[tid], NULL);
83 __clear_bit(tid, sta->ampdu_mlme.agg_session_valid);
86 "Rx BA session stop requested for %pM tid %u %s reason: %d\n",
88 initiator == WLAN_BACK_RECIPIENT ? "recipient" : "inititator",
91 if (drv_ampdu_action(local, sta->sdata, ¶ms))
92 sdata_info(sta->sdata,
93 "HW problem - can not stop rx aggregation for %pM tid %d\n",
96 /* check if this is a self generated aggregation halt */
97 if (initiator == WLAN_BACK_RECIPIENT && tx)
98 ieee80211_send_delba(sta->sdata, sta->sta.addr,
99 tid, WLAN_BACK_RECIPIENT, reason);
102 * return here in case tid_rx is not assigned - which will happen if
103 * IEEE80211_HW_SUPPORTS_REORDERING_BUFFER is set.
108 del_timer_sync(&tid_rx->session_timer);
110 /* make sure ieee80211_sta_reorder_release() doesn't re-arm the timer */
111 spin_lock_bh(&tid_rx->reorder_lock);
112 tid_rx->removed = true;
113 spin_unlock_bh(&tid_rx->reorder_lock);
114 del_timer_sync(&tid_rx->reorder_timer);
116 call_rcu(&tid_rx->rcu_head, ieee80211_free_tid_rx);
119 void __ieee80211_stop_rx_ba_session(struct sta_info *sta, u16 tid,
120 u16 initiator, u16 reason, bool tx)
122 mutex_lock(&sta->ampdu_mlme.mtx);
123 ___ieee80211_stop_rx_ba_session(sta, tid, initiator, reason, tx);
124 mutex_unlock(&sta->ampdu_mlme.mtx);
127 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
130 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
131 struct sta_info *sta;
135 sta = sta_info_get_bss(sdata, addr);
141 for (i = 0; i < IEEE80211_NUM_TIDS; i++)
142 if (ba_rx_bitmap & BIT(i))
143 set_bit(i, sta->ampdu_mlme.tid_rx_stop_requested);
145 ieee80211_queue_work(&sta->local->hw, &sta->ampdu_mlme.work);
148 EXPORT_SYMBOL(ieee80211_stop_rx_ba_session);
151 * After accepting the AddBA Request we activated a timer,
152 * resetting it after each frame that arrives from the originator.
154 static void sta_rx_agg_session_timer_expired(unsigned long data)
156 /* not an elegant detour, but there is no choice as the timer passes
157 * only one argument, and various sta_info are needed here, so init
158 * flow in sta_info_create gives the TID as data, while the timer_to_id
159 * array gives the sta through container_of */
160 u8 *ptid = (u8 *)data;
161 u8 *timer_to_id = ptid - *ptid;
162 struct sta_info *sta = container_of(timer_to_id, struct sta_info,
164 struct tid_ampdu_rx *tid_rx;
165 unsigned long timeout;
168 tid_rx = rcu_dereference(sta->ampdu_mlme.tid_rx[*ptid]);
174 timeout = tid_rx->last_rx + TU_TO_JIFFIES(tid_rx->timeout);
175 if (time_is_after_jiffies(timeout)) {
176 mod_timer(&tid_rx->session_timer, timeout);
182 ht_dbg(sta->sdata, "RX session timer expired on %pM tid %d\n",
183 sta->sta.addr, (u16)*ptid);
185 set_bit(*ptid, sta->ampdu_mlme.tid_rx_timer_expired);
186 ieee80211_queue_work(&sta->local->hw, &sta->ampdu_mlme.work);
189 static void sta_rx_agg_reorder_timer_expired(unsigned long data)
191 u8 *ptid = (u8 *)data;
192 u8 *timer_to_id = ptid - *ptid;
193 struct sta_info *sta = container_of(timer_to_id, struct sta_info,
197 ieee80211_release_reorder_timeout(sta, *ptid);
201 static void ieee80211_send_addba_resp(struct ieee80211_sub_if_data *sdata, u8 *da, u16 tid,
202 u8 dialog_token, u16 status, u16 policy,
203 u16 buf_size, u16 timeout)
205 struct ieee80211_local *local = sdata->local;
207 struct ieee80211_mgmt *mgmt;
208 bool amsdu = ieee80211_hw_check(&local->hw, SUPPORTS_AMSDU_IN_AMPDU);
211 skb = dev_alloc_skb(sizeof(*mgmt) + local->hw.extra_tx_headroom);
215 skb_reserve(skb, local->hw.extra_tx_headroom);
216 mgmt = (struct ieee80211_mgmt *) skb_put(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 > local->hw.max_rx_aggregation_subframes)
308 buf_size = local->hw.max_rx_aggregation_subframes;
309 params.buf_size = buf_size;
311 /* examine state machine */
312 mutex_lock(&sta->ampdu_mlme.mtx);
314 if (test_bit(tid, sta->ampdu_mlme.agg_session_valid)) {
315 tid_agg_rx = rcu_dereference_protected(
316 sta->ampdu_mlme.tid_rx[tid],
317 lockdep_is_held(&sta->ampdu_mlme.mtx));
319 if (tid_agg_rx->dialog_token == dialog_token) {
320 ht_dbg_ratelimited(sta->sdata,
321 "updated AddBA Req from %pM on tid %u\n",
323 /* We have no API to update the timeout value in the
324 * driver so reject the timeout update.
326 status = WLAN_STATUS_REQUEST_DECLINED;
327 ieee80211_send_addba_resp(sta->sdata, sta->sta.addr,
328 tid, dialog_token, status,
329 1, buf_size, timeout);
333 ht_dbg_ratelimited(sta->sdata,
334 "unexpected AddBA Req from %pM on tid %u\n",
337 /* delete existing Rx BA session on the same tid */
338 ___ieee80211_stop_rx_ba_session(sta, tid, WLAN_BACK_RECIPIENT,
339 WLAN_STATUS_UNSPECIFIED_QOS,
343 if (ieee80211_hw_check(&local->hw, SUPPORTS_REORDERING_BUFFER)) {
344 ret = drv_ampdu_action(local, sta->sdata, ¶ms);
346 "Rx A-MPDU request on %pM tid %d result %d\n",
347 sta->sta.addr, tid, ret);
349 status = WLAN_STATUS_SUCCESS;
353 /* prepare A-MPDU MLME for Rx aggregation */
354 tid_agg_rx = kzalloc(sizeof(*tid_agg_rx), GFP_KERNEL);
358 spin_lock_init(&tid_agg_rx->reorder_lock);
361 tid_agg_rx->session_timer.function = sta_rx_agg_session_timer_expired;
362 tid_agg_rx->session_timer.data = (unsigned long)&sta->timer_to_tid[tid];
363 init_timer_deferrable(&tid_agg_rx->session_timer);
365 /* rx reorder timer */
366 tid_agg_rx->reorder_timer.function = sta_rx_agg_reorder_timer_expired;
367 tid_agg_rx->reorder_timer.data = (unsigned long)&sta->timer_to_tid[tid];
368 init_timer(&tid_agg_rx->reorder_timer);
370 /* prepare reordering buffer */
371 tid_agg_rx->reorder_buf =
372 kcalloc(buf_size, sizeof(struct sk_buff_head), GFP_KERNEL);
373 tid_agg_rx->reorder_time =
374 kcalloc(buf_size, sizeof(unsigned long), GFP_KERNEL);
375 if (!tid_agg_rx->reorder_buf || !tid_agg_rx->reorder_time) {
376 kfree(tid_agg_rx->reorder_buf);
377 kfree(tid_agg_rx->reorder_time);
382 for (i = 0; i < buf_size; i++)
383 __skb_queue_head_init(&tid_agg_rx->reorder_buf[i]);
385 ret = drv_ampdu_action(local, sta->sdata, ¶ms);
386 ht_dbg(sta->sdata, "Rx A-MPDU request on %pM tid %d result %d\n",
387 sta->sta.addr, tid, ret);
389 kfree(tid_agg_rx->reorder_buf);
390 kfree(tid_agg_rx->reorder_time);
396 tid_agg_rx->dialog_token = dialog_token;
397 tid_agg_rx->ssn = start_seq_num;
398 tid_agg_rx->head_seq_num = start_seq_num;
399 tid_agg_rx->buf_size = buf_size;
400 tid_agg_rx->timeout = timeout;
401 tid_agg_rx->stored_mpdu_num = 0;
402 tid_agg_rx->auto_seq = auto_seq;
403 tid_agg_rx->reorder_buf_filtered = 0;
404 status = WLAN_STATUS_SUCCESS;
406 /* activate it for RX */
407 rcu_assign_pointer(sta->ampdu_mlme.tid_rx[tid], tid_agg_rx);
410 mod_timer(&tid_agg_rx->session_timer, TU_TO_EXP_TIME(timeout));
411 tid_agg_rx->last_rx = jiffies;
415 if (status == WLAN_STATUS_SUCCESS)
416 __set_bit(tid, sta->ampdu_mlme.agg_session_valid);
417 mutex_unlock(&sta->ampdu_mlme.mtx);
421 ieee80211_send_addba_resp(sta->sdata, sta->sta.addr, tid,
422 dialog_token, status, 1, buf_size,
426 void ieee80211_process_addba_request(struct ieee80211_local *local,
427 struct sta_info *sta,
428 struct ieee80211_mgmt *mgmt,
431 u16 capab, tid, timeout, ba_policy, buf_size, start_seq_num;
434 /* extract session parameters from addba request frame */
435 dialog_token = mgmt->u.action.u.addba_req.dialog_token;
436 timeout = le16_to_cpu(mgmt->u.action.u.addba_req.timeout);
438 le16_to_cpu(mgmt->u.action.u.addba_req.start_seq_num) >> 4;
440 capab = le16_to_cpu(mgmt->u.action.u.addba_req.capab);
441 ba_policy = (capab & IEEE80211_ADDBA_PARAM_POLICY_MASK) >> 1;
442 tid = (capab & IEEE80211_ADDBA_PARAM_TID_MASK) >> 2;
443 buf_size = (capab & IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK) >> 6;
445 __ieee80211_start_rx_ba_session(sta, dialog_token, timeout,
446 start_seq_num, ba_policy, tid,
447 buf_size, true, false);
450 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
451 const u8 *addr, u16 tid)
453 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
454 struct ieee80211_local *local = sdata->local;
455 struct ieee80211_rx_agg *rx_agg;
456 struct sk_buff *skb = dev_alloc_skb(0);
461 rx_agg = (struct ieee80211_rx_agg *) &skb->cb;
462 memcpy(&rx_agg->addr, addr, ETH_ALEN);
465 skb->pkt_type = IEEE80211_SDATA_QUEUE_RX_AGG_START;
466 skb_queue_tail(&sdata->skb_queue, skb);
467 ieee80211_queue_work(&local->hw, &sdata->work);
469 EXPORT_SYMBOL(ieee80211_start_rx_ba_session_offl);
471 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
472 const u8 *addr, u16 tid)
474 struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
475 struct ieee80211_local *local = sdata->local;
476 struct ieee80211_rx_agg *rx_agg;
477 struct sk_buff *skb = dev_alloc_skb(0);
482 rx_agg = (struct ieee80211_rx_agg *) &skb->cb;
483 memcpy(&rx_agg->addr, addr, ETH_ALEN);
486 skb->pkt_type = IEEE80211_SDATA_QUEUE_RX_AGG_STOP;
487 skb_queue_tail(&sdata->skb_queue, skb);
488 ieee80211_queue_work(&local->hw, &sdata->work);
490 EXPORT_SYMBOL(ieee80211_stop_rx_ba_session_offl);