xref: /openbmc/linux/net/mac80211/agg-tx.c (revision 1802d0be)
1 /*
2  * HT handling
3  *
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 - 2019 Intel Corporation
12  *
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.
16  */
17 
18 #include <linux/ieee80211.h>
19 #include <linux/slab.h>
20 #include <linux/export.h>
21 #include <net/mac80211.h>
22 #include "ieee80211_i.h"
23 #include "driver-ops.h"
24 #include "wme.h"
25 
26 /**
27  * DOC: TX A-MPDU aggregation
28  *
29  * Aggregation on the TX side requires setting the hardware flag
30  * %IEEE80211_HW_AMPDU_AGGREGATION. The driver will then be handed
31  * packets with a flag indicating A-MPDU aggregation. The driver
32  * or device is responsible for actually aggregating the frames,
33  * as well as deciding how many and which to aggregate.
34  *
35  * When TX aggregation is started by some subsystem (usually the rate
36  * control algorithm would be appropriate) by calling the
37  * ieee80211_start_tx_ba_session() function, the driver will be
38  * notified via its @ampdu_action function, with the
39  * %IEEE80211_AMPDU_TX_START action.
40  *
41  * In response to that, the driver is later required to call the
42  * ieee80211_start_tx_ba_cb_irqsafe() function, which will really
43  * start the aggregation session after the peer has also responded.
44  * If the peer responds negatively, the session will be stopped
45  * again right away. Note that it is possible for the aggregation
46  * session to be stopped before the driver has indicated that it
47  * is done setting it up, in which case it must not indicate the
48  * setup completion.
49  *
50  * Also note that, since we also need to wait for a response from
51  * the peer, the driver is notified of the completion of the
52  * handshake by the %IEEE80211_AMPDU_TX_OPERATIONAL action to the
53  * @ampdu_action callback.
54  *
55  * Similarly, when the aggregation session is stopped by the peer
56  * or something calling ieee80211_stop_tx_ba_session(), the driver's
57  * @ampdu_action function will be called with the action
58  * %IEEE80211_AMPDU_TX_STOP. In this case, the call must not fail,
59  * and the driver must later call ieee80211_stop_tx_ba_cb_irqsafe().
60  * Note that the sta can get destroyed before the BA tear down is
61  * complete.
62  */
63 
64 static void ieee80211_send_addba_request(struct ieee80211_sub_if_data *sdata,
65 					 const u8 *da, u16 tid,
66 					 u8 dialog_token, u16 start_seq_num,
67 					 u16 agg_size, u16 timeout)
68 {
69 	struct ieee80211_local *local = sdata->local;
70 	struct sk_buff *skb;
71 	struct ieee80211_mgmt *mgmt;
72 	u16 capab;
73 
74 	skb = dev_alloc_skb(sizeof(*mgmt) + local->hw.extra_tx_headroom);
75 
76 	if (!skb)
77 		return;
78 
79 	skb_reserve(skb, local->hw.extra_tx_headroom);
80 	mgmt = skb_put_zero(skb, 24);
81 	memcpy(mgmt->da, da, ETH_ALEN);
82 	memcpy(mgmt->sa, sdata->vif.addr, ETH_ALEN);
83 	if (sdata->vif.type == NL80211_IFTYPE_AP ||
84 	    sdata->vif.type == NL80211_IFTYPE_AP_VLAN ||
85 	    sdata->vif.type == NL80211_IFTYPE_MESH_POINT)
86 		memcpy(mgmt->bssid, sdata->vif.addr, ETH_ALEN);
87 	else if (sdata->vif.type == NL80211_IFTYPE_STATION)
88 		memcpy(mgmt->bssid, sdata->u.mgd.bssid, ETH_ALEN);
89 	else if (sdata->vif.type == NL80211_IFTYPE_ADHOC)
90 		memcpy(mgmt->bssid, sdata->u.ibss.bssid, ETH_ALEN);
91 
92 	mgmt->frame_control = cpu_to_le16(IEEE80211_FTYPE_MGMT |
93 					  IEEE80211_STYPE_ACTION);
94 
95 	skb_put(skb, 1 + sizeof(mgmt->u.action.u.addba_req));
96 
97 	mgmt->u.action.category = WLAN_CATEGORY_BACK;
98 	mgmt->u.action.u.addba_req.action_code = WLAN_ACTION_ADDBA_REQ;
99 
100 	mgmt->u.action.u.addba_req.dialog_token = dialog_token;
101 	capab = (u16)(1 << 0);		/* bit 0 A-MSDU support */
102 	capab |= (u16)(1 << 1);		/* bit 1 aggregation policy */
103 	capab |= (u16)(tid << 2); 	/* bit 5:2 TID number */
104 	capab |= (u16)(agg_size << 6);	/* bit 15:6 max size of aggergation */
105 
106 	mgmt->u.action.u.addba_req.capab = cpu_to_le16(capab);
107 
108 	mgmt->u.action.u.addba_req.timeout = cpu_to_le16(timeout);
109 	mgmt->u.action.u.addba_req.start_seq_num =
110 					cpu_to_le16(start_seq_num << 4);
111 
112 	ieee80211_tx_skb(sdata, skb);
113 }
114 
115 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn)
116 {
117 	struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
118 	struct ieee80211_local *local = sdata->local;
119 	struct sk_buff *skb;
120 	struct ieee80211_bar *bar;
121 	u16 bar_control = 0;
122 
123 	skb = dev_alloc_skb(sizeof(*bar) + local->hw.extra_tx_headroom);
124 	if (!skb)
125 		return;
126 
127 	skb_reserve(skb, local->hw.extra_tx_headroom);
128 	bar = skb_put_zero(skb, sizeof(*bar));
129 	bar->frame_control = cpu_to_le16(IEEE80211_FTYPE_CTL |
130 					 IEEE80211_STYPE_BACK_REQ);
131 	memcpy(bar->ra, ra, ETH_ALEN);
132 	memcpy(bar->ta, sdata->vif.addr, ETH_ALEN);
133 	bar_control |= (u16)IEEE80211_BAR_CTRL_ACK_POLICY_NORMAL;
134 	bar_control |= (u16)IEEE80211_BAR_CTRL_CBMTID_COMPRESSED_BA;
135 	bar_control |= (u16)(tid << IEEE80211_BAR_CTRL_TID_INFO_SHIFT);
136 	bar->control = cpu_to_le16(bar_control);
137 	bar->start_seq_num = cpu_to_le16(ssn);
138 
139 	IEEE80211_SKB_CB(skb)->flags |= IEEE80211_TX_INTFL_DONT_ENCRYPT |
140 					IEEE80211_TX_CTL_REQ_TX_STATUS;
141 	ieee80211_tx_skb_tid(sdata, skb, tid);
142 }
143 EXPORT_SYMBOL(ieee80211_send_bar);
144 
145 void ieee80211_assign_tid_tx(struct sta_info *sta, int tid,
146 			     struct tid_ampdu_tx *tid_tx)
147 {
148 	lockdep_assert_held(&sta->ampdu_mlme.mtx);
149 	lockdep_assert_held(&sta->lock);
150 	rcu_assign_pointer(sta->ampdu_mlme.tid_tx[tid], tid_tx);
151 }
152 
153 /*
154  * When multiple aggregation sessions on multiple stations
155  * are being created/destroyed simultaneously, we need to
156  * refcount the global queue stop caused by that in order
157  * to not get into a situation where one of the aggregation
158  * setup or teardown re-enables queues before the other is
159  * ready to handle that.
160  *
161  * These two functions take care of this issue by keeping
162  * a global "agg_queue_stop" refcount.
163  */
164 static void __acquires(agg_queue)
165 ieee80211_stop_queue_agg(struct ieee80211_sub_if_data *sdata, int tid)
166 {
167 	int queue = sdata->vif.hw_queue[ieee80211_ac_from_tid(tid)];
168 
169 	/* we do refcounting here, so don't use the queue reason refcounting */
170 
171 	if (atomic_inc_return(&sdata->local->agg_queue_stop[queue]) == 1)
172 		ieee80211_stop_queue_by_reason(
173 			&sdata->local->hw, queue,
174 			IEEE80211_QUEUE_STOP_REASON_AGGREGATION,
175 			false);
176 	__acquire(agg_queue);
177 }
178 
179 static void __releases(agg_queue)
180 ieee80211_wake_queue_agg(struct ieee80211_sub_if_data *sdata, int tid)
181 {
182 	int queue = sdata->vif.hw_queue[ieee80211_ac_from_tid(tid)];
183 
184 	if (atomic_dec_return(&sdata->local->agg_queue_stop[queue]) == 0)
185 		ieee80211_wake_queue_by_reason(
186 			&sdata->local->hw, queue,
187 			IEEE80211_QUEUE_STOP_REASON_AGGREGATION,
188 			false);
189 	__release(agg_queue);
190 }
191 
192 static void
193 ieee80211_agg_stop_txq(struct sta_info *sta, int tid)
194 {
195 	struct ieee80211_txq *txq = sta->sta.txq[tid];
196 	struct ieee80211_sub_if_data *sdata;
197 	struct fq *fq;
198 	struct txq_info *txqi;
199 
200 	if (!txq)
201 		return;
202 
203 	txqi = to_txq_info(txq);
204 	sdata = vif_to_sdata(txq->vif);
205 	fq = &sdata->local->fq;
206 
207 	/* Lock here to protect against further seqno updates on dequeue */
208 	spin_lock_bh(&fq->lock);
209 	set_bit(IEEE80211_TXQ_STOP, &txqi->flags);
210 	spin_unlock_bh(&fq->lock);
211 }
212 
213 static void
214 ieee80211_agg_start_txq(struct sta_info *sta, int tid, bool enable)
215 {
216 	struct ieee80211_txq *txq = sta->sta.txq[tid];
217 	struct txq_info *txqi;
218 
219 	if (!txq)
220 		return;
221 
222 	txqi = to_txq_info(txq);
223 
224 	if (enable)
225 		set_bit(IEEE80211_TXQ_AMPDU, &txqi->flags);
226 	else
227 		clear_bit(IEEE80211_TXQ_AMPDU, &txqi->flags);
228 
229 	clear_bit(IEEE80211_TXQ_STOP, &txqi->flags);
230 	local_bh_disable();
231 	rcu_read_lock();
232 	schedule_and_wake_txq(sta->sdata->local, txqi);
233 	rcu_read_unlock();
234 	local_bh_enable();
235 }
236 
237 /*
238  * splice packets from the STA's pending to the local pending,
239  * requires a call to ieee80211_agg_splice_finish later
240  */
241 static void __acquires(agg_queue)
242 ieee80211_agg_splice_packets(struct ieee80211_sub_if_data *sdata,
243 			     struct tid_ampdu_tx *tid_tx, u16 tid)
244 {
245 	struct ieee80211_local *local = sdata->local;
246 	int queue = sdata->vif.hw_queue[ieee80211_ac_from_tid(tid)];
247 	unsigned long flags;
248 
249 	ieee80211_stop_queue_agg(sdata, tid);
250 
251 	if (WARN(!tid_tx,
252 		 "TID %d gone but expected when splicing aggregates from the pending queue\n",
253 		 tid))
254 		return;
255 
256 	if (!skb_queue_empty(&tid_tx->pending)) {
257 		spin_lock_irqsave(&local->queue_stop_reason_lock, flags);
258 		/* copy over remaining packets */
259 		skb_queue_splice_tail_init(&tid_tx->pending,
260 					   &local->pending[queue]);
261 		spin_unlock_irqrestore(&local->queue_stop_reason_lock, flags);
262 	}
263 }
264 
265 static void __releases(agg_queue)
266 ieee80211_agg_splice_finish(struct ieee80211_sub_if_data *sdata, u16 tid)
267 {
268 	ieee80211_wake_queue_agg(sdata, tid);
269 }
270 
271 static void ieee80211_remove_tid_tx(struct sta_info *sta, int tid)
272 {
273 	struct tid_ampdu_tx *tid_tx;
274 
275 	lockdep_assert_held(&sta->ampdu_mlme.mtx);
276 	lockdep_assert_held(&sta->lock);
277 
278 	tid_tx = rcu_dereference_protected_tid_tx(sta, tid);
279 
280 	/*
281 	 * When we get here, the TX path will not be lockless any more wrt.
282 	 * aggregation, since the OPERATIONAL bit has long been cleared.
283 	 * Thus it will block on getting the lock, if it occurs. So if we
284 	 * stop the queue now, we will not get any more packets, and any
285 	 * that might be being processed will wait for us here, thereby
286 	 * guaranteeing that no packets go to the tid_tx pending queue any
287 	 * more.
288 	 */
289 
290 	ieee80211_agg_splice_packets(sta->sdata, tid_tx, tid);
291 
292 	/* future packets must not find the tid_tx struct any more */
293 	ieee80211_assign_tid_tx(sta, tid, NULL);
294 
295 	ieee80211_agg_splice_finish(sta->sdata, tid);
296 	ieee80211_agg_start_txq(sta, tid, false);
297 
298 	kfree_rcu(tid_tx, rcu_head);
299 }
300 
301 int ___ieee80211_stop_tx_ba_session(struct sta_info *sta, u16 tid,
302 				    enum ieee80211_agg_stop_reason reason)
303 {
304 	struct ieee80211_local *local = sta->local;
305 	struct tid_ampdu_tx *tid_tx;
306 	struct ieee80211_ampdu_params params = {
307 		.sta = &sta->sta,
308 		.tid = tid,
309 		.buf_size = 0,
310 		.amsdu = false,
311 		.timeout = 0,
312 		.ssn = 0,
313 	};
314 	int ret;
315 
316 	lockdep_assert_held(&sta->ampdu_mlme.mtx);
317 
318 	switch (reason) {
319 	case AGG_STOP_DECLINED:
320 	case AGG_STOP_LOCAL_REQUEST:
321 	case AGG_STOP_PEER_REQUEST:
322 		params.action = IEEE80211_AMPDU_TX_STOP_CONT;
323 		break;
324 	case AGG_STOP_DESTROY_STA:
325 		params.action = IEEE80211_AMPDU_TX_STOP_FLUSH;
326 		break;
327 	default:
328 		WARN_ON_ONCE(1);
329 		return -EINVAL;
330 	}
331 
332 	spin_lock_bh(&sta->lock);
333 
334 	/* free struct pending for start, if present */
335 	tid_tx = sta->ampdu_mlme.tid_start_tx[tid];
336 	kfree(tid_tx);
337 	sta->ampdu_mlme.tid_start_tx[tid] = NULL;
338 
339 	tid_tx = rcu_dereference_protected_tid_tx(sta, tid);
340 	if (!tid_tx) {
341 		spin_unlock_bh(&sta->lock);
342 		return -ENOENT;
343 	}
344 
345 	/*
346 	 * if we're already stopping ignore any new requests to stop
347 	 * unless we're destroying it in which case notify the driver
348 	 */
349 	if (test_bit(HT_AGG_STATE_STOPPING, &tid_tx->state)) {
350 		spin_unlock_bh(&sta->lock);
351 		if (reason != AGG_STOP_DESTROY_STA)
352 			return -EALREADY;
353 		params.action = IEEE80211_AMPDU_TX_STOP_FLUSH_CONT;
354 		ret = drv_ampdu_action(local, sta->sdata, &params);
355 		WARN_ON_ONCE(ret);
356 		return 0;
357 	}
358 
359 	if (test_bit(HT_AGG_STATE_WANT_START, &tid_tx->state)) {
360 		/* not even started yet! */
361 		ieee80211_assign_tid_tx(sta, tid, NULL);
362 		spin_unlock_bh(&sta->lock);
363 		kfree_rcu(tid_tx, rcu_head);
364 		return 0;
365 	}
366 
367 	set_bit(HT_AGG_STATE_STOPPING, &tid_tx->state);
368 
369 	ieee80211_agg_stop_txq(sta, tid);
370 
371 	spin_unlock_bh(&sta->lock);
372 
373 	ht_dbg(sta->sdata, "Tx BA session stop requested for %pM tid %u\n",
374 	       sta->sta.addr, tid);
375 
376 	del_timer_sync(&tid_tx->addba_resp_timer);
377 	del_timer_sync(&tid_tx->session_timer);
378 
379 	/*
380 	 * After this packets are no longer handed right through
381 	 * to the driver but are put onto tid_tx->pending instead,
382 	 * with locking to ensure proper access.
383 	 */
384 	clear_bit(HT_AGG_STATE_OPERATIONAL, &tid_tx->state);
385 
386 	/*
387 	 * There might be a few packets being processed right now (on
388 	 * another CPU) that have already gotten past the aggregation
389 	 * check when it was still OPERATIONAL and consequently have
390 	 * IEEE80211_TX_CTL_AMPDU set. In that case, this code might
391 	 * call into the driver at the same time or even before the
392 	 * TX paths calls into it, which could confuse the driver.
393 	 *
394 	 * Wait for all currently running TX paths to finish before
395 	 * telling the driver. New packets will not go through since
396 	 * the aggregation session is no longer OPERATIONAL.
397 	 */
398 	if (!local->in_reconfig)
399 		synchronize_net();
400 
401 	tid_tx->stop_initiator = reason == AGG_STOP_PEER_REQUEST ?
402 					WLAN_BACK_RECIPIENT :
403 					WLAN_BACK_INITIATOR;
404 	tid_tx->tx_stop = reason == AGG_STOP_LOCAL_REQUEST;
405 
406 	ret = drv_ampdu_action(local, sta->sdata, &params);
407 
408 	/* HW shall not deny going back to legacy */
409 	if (WARN_ON(ret)) {
410 		/*
411 		 * We may have pending packets get stuck in this case...
412 		 * Not bothering with a workaround for now.
413 		 */
414 	}
415 
416 	/*
417 	 * In the case of AGG_STOP_DESTROY_STA, the driver won't
418 	 * necessarily call ieee80211_stop_tx_ba_cb(), so this may
419 	 * seem like we can leave the tid_tx data pending forever.
420 	 * This is true, in a way, but "forever" is only until the
421 	 * station struct is actually destroyed. In the meantime,
422 	 * leaving it around ensures that we don't transmit packets
423 	 * to the driver on this TID which might confuse it.
424 	 */
425 
426 	return 0;
427 }
428 
429 /*
430  * After sending add Block Ack request we activated a timer until
431  * add Block Ack response will arrive from the recipient.
432  * If this timer expires sta_addba_resp_timer_expired will be executed.
433  */
434 static void sta_addba_resp_timer_expired(struct timer_list *t)
435 {
436 	struct tid_ampdu_tx *tid_tx = from_timer(tid_tx, t, addba_resp_timer);
437 	struct sta_info *sta = tid_tx->sta;
438 	u8 tid = tid_tx->tid;
439 
440 	/* check if the TID waits for addBA response */
441 	if (test_bit(HT_AGG_STATE_RESPONSE_RECEIVED, &tid_tx->state)) {
442 		ht_dbg(sta->sdata,
443 		       "timer expired on %pM tid %d not expecting addBA response\n",
444 		       sta->sta.addr, tid);
445 		return;
446 	}
447 
448 	ht_dbg(sta->sdata, "addBA response timer expired on %pM tid %d\n",
449 	       sta->sta.addr, tid);
450 
451 	ieee80211_stop_tx_ba_session(&sta->sta, tid);
452 }
453 
454 void ieee80211_tx_ba_session_handle_start(struct sta_info *sta, int tid)
455 {
456 	struct tid_ampdu_tx *tid_tx;
457 	struct ieee80211_local *local = sta->local;
458 	struct ieee80211_sub_if_data *sdata = sta->sdata;
459 	struct ieee80211_ampdu_params params = {
460 		.sta = &sta->sta,
461 		.action = IEEE80211_AMPDU_TX_START,
462 		.tid = tid,
463 		.buf_size = 0,
464 		.amsdu = false,
465 		.timeout = 0,
466 	};
467 	int ret;
468 	u16 buf_size;
469 
470 	tid_tx = rcu_dereference_protected_tid_tx(sta, tid);
471 
472 	/*
473 	 * Start queuing up packets for this aggregation session.
474 	 * We're going to release them once the driver is OK with
475 	 * that.
476 	 */
477 	clear_bit(HT_AGG_STATE_WANT_START, &tid_tx->state);
478 
479 	ieee80211_agg_stop_txq(sta, tid);
480 
481 	/*
482 	 * Make sure no packets are being processed. This ensures that
483 	 * we have a valid starting sequence number and that in-flight
484 	 * packets have been flushed out and no packets for this TID
485 	 * will go into the driver during the ampdu_action call.
486 	 */
487 	synchronize_net();
488 
489 	params.ssn = sta->tid_seq[tid] >> 4;
490 	ret = drv_ampdu_action(local, sdata, &params);
491 	if (ret) {
492 		ht_dbg(sdata,
493 		       "BA request denied - HW unavailable for %pM tid %d\n",
494 		       sta->sta.addr, tid);
495 		spin_lock_bh(&sta->lock);
496 		ieee80211_agg_splice_packets(sdata, tid_tx, tid);
497 		ieee80211_assign_tid_tx(sta, tid, NULL);
498 		ieee80211_agg_splice_finish(sdata, tid);
499 		spin_unlock_bh(&sta->lock);
500 
501 		ieee80211_agg_start_txq(sta, tid, false);
502 
503 		kfree_rcu(tid_tx, rcu_head);
504 		return;
505 	}
506 
507 	/* activate the timer for the recipient's addBA response */
508 	mod_timer(&tid_tx->addba_resp_timer, jiffies + ADDBA_RESP_INTERVAL);
509 	ht_dbg(sdata, "activated addBA response timer on %pM tid %d\n",
510 	       sta->sta.addr, tid);
511 
512 	spin_lock_bh(&sta->lock);
513 	sta->ampdu_mlme.last_addba_req_time[tid] = jiffies;
514 	sta->ampdu_mlme.addba_req_num[tid]++;
515 	spin_unlock_bh(&sta->lock);
516 
517 	if (sta->sta.he_cap.has_he) {
518 		buf_size = local->hw.max_tx_aggregation_subframes;
519 	} else {
520 		/*
521 		 * We really should use what the driver told us it will
522 		 * transmit as the maximum, but certain APs (e.g. the
523 		 * LinkSys WRT120N with FW v1.0.07 build 002 Jun 18 2012)
524 		 * will crash when we use a lower number.
525 		 */
526 		buf_size = IEEE80211_MAX_AMPDU_BUF_HT;
527 	}
528 
529 	/* send AddBA request */
530 	ieee80211_send_addba_request(sdata, sta->sta.addr, tid,
531 				     tid_tx->dialog_token, params.ssn,
532 				     buf_size, tid_tx->timeout);
533 }
534 
535 /*
536  * After accepting the AddBA Response we activated a timer,
537  * resetting it after each frame that we send.
538  */
539 static void sta_tx_agg_session_timer_expired(struct timer_list *t)
540 {
541 	struct tid_ampdu_tx *tid_tx = from_timer(tid_tx, t, session_timer);
542 	struct sta_info *sta = tid_tx->sta;
543 	u8 tid = tid_tx->tid;
544 	unsigned long timeout;
545 
546 	if (test_bit(HT_AGG_STATE_STOPPING, &tid_tx->state)) {
547 		return;
548 	}
549 
550 	timeout = tid_tx->last_tx + TU_TO_JIFFIES(tid_tx->timeout);
551 	if (time_is_after_jiffies(timeout)) {
552 		mod_timer(&tid_tx->session_timer, timeout);
553 		return;
554 	}
555 
556 	ht_dbg(sta->sdata, "tx session timer expired on %pM tid %d\n",
557 	       sta->sta.addr, tid);
558 
559 	ieee80211_stop_tx_ba_session(&sta->sta, tid);
560 }
561 
562 int ieee80211_start_tx_ba_session(struct ieee80211_sta *pubsta, u16 tid,
563 				  u16 timeout)
564 {
565 	struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
566 	struct ieee80211_sub_if_data *sdata = sta->sdata;
567 	struct ieee80211_local *local = sdata->local;
568 	struct tid_ampdu_tx *tid_tx;
569 	int ret = 0;
570 
571 	trace_api_start_tx_ba_session(pubsta, tid);
572 
573 	if (WARN(sta->reserved_tid == tid,
574 		 "Requested to start BA session on reserved tid=%d", tid))
575 		return -EINVAL;
576 
577 	if (!pubsta->ht_cap.ht_supported)
578 		return -EINVAL;
579 
580 	if (WARN_ON_ONCE(!local->ops->ampdu_action))
581 		return -EINVAL;
582 
583 	if ((tid >= IEEE80211_NUM_TIDS) ||
584 	    !ieee80211_hw_check(&local->hw, AMPDU_AGGREGATION) ||
585 	    ieee80211_hw_check(&local->hw, TX_AMPDU_SETUP_IN_HW))
586 		return -EINVAL;
587 
588 	if (WARN_ON(tid >= IEEE80211_FIRST_TSPEC_TSID))
589 		return -EINVAL;
590 
591 	ht_dbg(sdata, "Open BA session requested for %pM tid %u\n",
592 	       pubsta->addr, tid);
593 
594 	if (sdata->vif.type != NL80211_IFTYPE_STATION &&
595 	    sdata->vif.type != NL80211_IFTYPE_MESH_POINT &&
596 	    sdata->vif.type != NL80211_IFTYPE_AP_VLAN &&
597 	    sdata->vif.type != NL80211_IFTYPE_AP &&
598 	    sdata->vif.type != NL80211_IFTYPE_ADHOC)
599 		return -EINVAL;
600 
601 	if (test_sta_flag(sta, WLAN_STA_BLOCK_BA)) {
602 		ht_dbg(sdata,
603 		       "BA sessions blocked - Denying BA session request %pM tid %d\n",
604 		       sta->sta.addr, tid);
605 		return -EINVAL;
606 	}
607 
608 	/*
609 	 * 802.11n-2009 11.5.1.1: If the initiating STA is an HT STA, is a
610 	 * member of an IBSS, and has no other existing Block Ack agreement
611 	 * with the recipient STA, then the initiating STA shall transmit a
612 	 * Probe Request frame to the recipient STA and shall not transmit an
613 	 * ADDBA Request frame unless it receives a Probe Response frame
614 	 * from the recipient within dot11ADDBAFailureTimeout.
615 	 *
616 	 * The probe request mechanism for ADDBA is currently not implemented,
617 	 * but we only build up Block Ack session with HT STAs. This information
618 	 * is set when we receive a bss info from a probe response or a beacon.
619 	 */
620 	if (sta->sdata->vif.type == NL80211_IFTYPE_ADHOC &&
621 	    !sta->sta.ht_cap.ht_supported) {
622 		ht_dbg(sdata,
623 		       "BA request denied - IBSS STA %pM does not advertise HT support\n",
624 		       pubsta->addr);
625 		return -EINVAL;
626 	}
627 
628 	spin_lock_bh(&sta->lock);
629 
630 	/* we have tried too many times, receiver does not want A-MPDU */
631 	if (sta->ampdu_mlme.addba_req_num[tid] > HT_AGG_MAX_RETRIES) {
632 		ret = -EBUSY;
633 		goto err_unlock_sta;
634 	}
635 
636 	/*
637 	 * if we have tried more than HT_AGG_BURST_RETRIES times we
638 	 * will spread our requests in time to avoid stalling connection
639 	 * for too long
640 	 */
641 	if (sta->ampdu_mlme.addba_req_num[tid] > HT_AGG_BURST_RETRIES &&
642 	    time_before(jiffies, sta->ampdu_mlme.last_addba_req_time[tid] +
643 			HT_AGG_RETRIES_PERIOD)) {
644 		ht_dbg(sdata,
645 		       "BA request denied - %d failed requests on %pM tid %u\n",
646 		       sta->ampdu_mlme.addba_req_num[tid], sta->sta.addr, tid);
647 		ret = -EBUSY;
648 		goto err_unlock_sta;
649 	}
650 
651 	tid_tx = rcu_dereference_protected_tid_tx(sta, tid);
652 	/* check if the TID is not in aggregation flow already */
653 	if (tid_tx || sta->ampdu_mlme.tid_start_tx[tid]) {
654 		ht_dbg(sdata,
655 		       "BA request denied - session is not idle on %pM tid %u\n",
656 		       sta->sta.addr, tid);
657 		ret = -EAGAIN;
658 		goto err_unlock_sta;
659 	}
660 
661 	/* prepare A-MPDU MLME for Tx aggregation */
662 	tid_tx = kzalloc(sizeof(struct tid_ampdu_tx), GFP_ATOMIC);
663 	if (!tid_tx) {
664 		ret = -ENOMEM;
665 		goto err_unlock_sta;
666 	}
667 
668 	skb_queue_head_init(&tid_tx->pending);
669 	__set_bit(HT_AGG_STATE_WANT_START, &tid_tx->state);
670 
671 	tid_tx->timeout = timeout;
672 	tid_tx->sta = sta;
673 	tid_tx->tid = tid;
674 
675 	/* response timer */
676 	timer_setup(&tid_tx->addba_resp_timer, sta_addba_resp_timer_expired, 0);
677 
678 	/* tx timer */
679 	timer_setup(&tid_tx->session_timer,
680 		    sta_tx_agg_session_timer_expired, TIMER_DEFERRABLE);
681 
682 	/* assign a dialog token */
683 	sta->ampdu_mlme.dialog_token_allocator++;
684 	tid_tx->dialog_token = sta->ampdu_mlme.dialog_token_allocator;
685 
686 	/*
687 	 * Finally, assign it to the start array; the work item will
688 	 * collect it and move it to the normal array.
689 	 */
690 	sta->ampdu_mlme.tid_start_tx[tid] = tid_tx;
691 
692 	ieee80211_queue_work(&local->hw, &sta->ampdu_mlme.work);
693 
694 	/* this flow continues off the work */
695  err_unlock_sta:
696 	spin_unlock_bh(&sta->lock);
697 	return ret;
698 }
699 EXPORT_SYMBOL(ieee80211_start_tx_ba_session);
700 
701 static void ieee80211_agg_tx_operational(struct ieee80211_local *local,
702 					 struct sta_info *sta, u16 tid)
703 {
704 	struct tid_ampdu_tx *tid_tx;
705 	struct ieee80211_ampdu_params params = {
706 		.sta = &sta->sta,
707 		.action = IEEE80211_AMPDU_TX_OPERATIONAL,
708 		.tid = tid,
709 		.timeout = 0,
710 		.ssn = 0,
711 	};
712 
713 	lockdep_assert_held(&sta->ampdu_mlme.mtx);
714 
715 	tid_tx = rcu_dereference_protected_tid_tx(sta, tid);
716 	params.buf_size = tid_tx->buf_size;
717 	params.amsdu = tid_tx->amsdu;
718 
719 	ht_dbg(sta->sdata, "Aggregation is on for %pM tid %d\n",
720 	       sta->sta.addr, tid);
721 
722 	drv_ampdu_action(local, sta->sdata, &params);
723 
724 	/*
725 	 * synchronize with TX path, while splicing the TX path
726 	 * should block so it won't put more packets onto pending.
727 	 */
728 	spin_lock_bh(&sta->lock);
729 
730 	ieee80211_agg_splice_packets(sta->sdata, tid_tx, tid);
731 	/*
732 	 * Now mark as operational. This will be visible
733 	 * in the TX path, and lets it go lock-free in
734 	 * the common case.
735 	 */
736 	set_bit(HT_AGG_STATE_OPERATIONAL, &tid_tx->state);
737 	ieee80211_agg_splice_finish(sta->sdata, tid);
738 
739 	spin_unlock_bh(&sta->lock);
740 
741 	ieee80211_agg_start_txq(sta, tid, true);
742 }
743 
744 void ieee80211_start_tx_ba_cb(struct sta_info *sta, int tid,
745 			      struct tid_ampdu_tx *tid_tx)
746 {
747 	struct ieee80211_sub_if_data *sdata = sta->sdata;
748 	struct ieee80211_local *local = sdata->local;
749 
750 	if (WARN_ON(test_and_set_bit(HT_AGG_STATE_DRV_READY, &tid_tx->state)))
751 		return;
752 
753 	if (test_bit(HT_AGG_STATE_RESPONSE_RECEIVED, &tid_tx->state))
754 		ieee80211_agg_tx_operational(local, sta, tid);
755 }
756 
757 static struct tid_ampdu_tx *
758 ieee80211_lookup_tid_tx(struct ieee80211_sub_if_data *sdata,
759 			const u8 *ra, u16 tid, struct sta_info **sta)
760 {
761 	struct tid_ampdu_tx *tid_tx;
762 
763 	if (tid >= IEEE80211_NUM_TIDS) {
764 		ht_dbg(sdata, "Bad TID value: tid = %d (>= %d)\n",
765 		       tid, IEEE80211_NUM_TIDS);
766 		return NULL;
767 	}
768 
769 	*sta = sta_info_get_bss(sdata, ra);
770 	if (!*sta) {
771 		ht_dbg(sdata, "Could not find station: %pM\n", ra);
772 		return NULL;
773 	}
774 
775 	tid_tx = rcu_dereference((*sta)->ampdu_mlme.tid_tx[tid]);
776 
777 	if (WARN_ON(!tid_tx))
778 		ht_dbg(sdata, "addBA was not requested!\n");
779 
780 	return tid_tx;
781 }
782 
783 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif,
784 				      const u8 *ra, u16 tid)
785 {
786 	struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
787 	struct ieee80211_local *local = sdata->local;
788 	struct sta_info *sta;
789 	struct tid_ampdu_tx *tid_tx;
790 
791 	trace_api_start_tx_ba_cb(sdata, ra, tid);
792 
793 	rcu_read_lock();
794 	tid_tx = ieee80211_lookup_tid_tx(sdata, ra, tid, &sta);
795 	if (!tid_tx)
796 		goto out;
797 
798 	set_bit(HT_AGG_STATE_START_CB, &tid_tx->state);
799 	ieee80211_queue_work(&local->hw, &sta->ampdu_mlme.work);
800  out:
801 	rcu_read_unlock();
802 }
803 EXPORT_SYMBOL(ieee80211_start_tx_ba_cb_irqsafe);
804 
805 int __ieee80211_stop_tx_ba_session(struct sta_info *sta, u16 tid,
806 				   enum ieee80211_agg_stop_reason reason)
807 {
808 	int ret;
809 
810 	mutex_lock(&sta->ampdu_mlme.mtx);
811 
812 	ret = ___ieee80211_stop_tx_ba_session(sta, tid, reason);
813 
814 	mutex_unlock(&sta->ampdu_mlme.mtx);
815 
816 	return ret;
817 }
818 
819 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *pubsta, u16 tid)
820 {
821 	struct sta_info *sta = container_of(pubsta, struct sta_info, sta);
822 	struct ieee80211_sub_if_data *sdata = sta->sdata;
823 	struct ieee80211_local *local = sdata->local;
824 	struct tid_ampdu_tx *tid_tx;
825 	int ret = 0;
826 
827 	trace_api_stop_tx_ba_session(pubsta, tid);
828 
829 	if (!local->ops->ampdu_action)
830 		return -EINVAL;
831 
832 	if (tid >= IEEE80211_NUM_TIDS)
833 		return -EINVAL;
834 
835 	spin_lock_bh(&sta->lock);
836 	tid_tx = rcu_dereference_protected_tid_tx(sta, tid);
837 
838 	if (!tid_tx) {
839 		ret = -ENOENT;
840 		goto unlock;
841 	}
842 
843 	WARN(sta->reserved_tid == tid,
844 	     "Requested to stop BA session on reserved tid=%d", tid);
845 
846 	if (test_bit(HT_AGG_STATE_STOPPING, &tid_tx->state)) {
847 		/* already in progress stopping it */
848 		ret = 0;
849 		goto unlock;
850 	}
851 
852 	set_bit(HT_AGG_STATE_WANT_STOP, &tid_tx->state);
853 	ieee80211_queue_work(&local->hw, &sta->ampdu_mlme.work);
854 
855  unlock:
856 	spin_unlock_bh(&sta->lock);
857 	return ret;
858 }
859 EXPORT_SYMBOL(ieee80211_stop_tx_ba_session);
860 
861 void ieee80211_stop_tx_ba_cb(struct sta_info *sta, int tid,
862 			     struct tid_ampdu_tx *tid_tx)
863 {
864 	struct ieee80211_sub_if_data *sdata = sta->sdata;
865 	bool send_delba = false;
866 
867 	ht_dbg(sdata, "Stopping Tx BA session for %pM tid %d\n",
868 	       sta->sta.addr, tid);
869 
870 	spin_lock_bh(&sta->lock);
871 
872 	if (!test_bit(HT_AGG_STATE_STOPPING, &tid_tx->state)) {
873 		ht_dbg(sdata,
874 		       "unexpected callback to A-MPDU stop for %pM tid %d\n",
875 		       sta->sta.addr, tid);
876 		goto unlock_sta;
877 	}
878 
879 	if (tid_tx->stop_initiator == WLAN_BACK_INITIATOR && tid_tx->tx_stop)
880 		send_delba = true;
881 
882 	ieee80211_remove_tid_tx(sta, tid);
883 
884  unlock_sta:
885 	spin_unlock_bh(&sta->lock);
886 
887 	if (send_delba)
888 		ieee80211_send_delba(sdata, sta->sta.addr, tid,
889 			WLAN_BACK_INITIATOR, WLAN_REASON_QSTA_NOT_USE);
890 }
891 
892 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif,
893 				     const u8 *ra, u16 tid)
894 {
895 	struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
896 	struct ieee80211_local *local = sdata->local;
897 	struct sta_info *sta;
898 	struct tid_ampdu_tx *tid_tx;
899 
900 	trace_api_stop_tx_ba_cb(sdata, ra, tid);
901 
902 	rcu_read_lock();
903 	tid_tx = ieee80211_lookup_tid_tx(sdata, ra, tid, &sta);
904 	if (!tid_tx)
905 		goto out;
906 
907 	set_bit(HT_AGG_STATE_STOP_CB, &tid_tx->state);
908 	ieee80211_queue_work(&local->hw, &sta->ampdu_mlme.work);
909  out:
910 	rcu_read_unlock();
911 }
912 EXPORT_SYMBOL(ieee80211_stop_tx_ba_cb_irqsafe);
913 
914 
915 void ieee80211_process_addba_resp(struct ieee80211_local *local,
916 				  struct sta_info *sta,
917 				  struct ieee80211_mgmt *mgmt,
918 				  size_t len)
919 {
920 	struct tid_ampdu_tx *tid_tx;
921 	struct ieee80211_txq *txq;
922 	u16 capab, tid, buf_size;
923 	bool amsdu;
924 
925 	capab = le16_to_cpu(mgmt->u.action.u.addba_resp.capab);
926 	amsdu = capab & IEEE80211_ADDBA_PARAM_AMSDU_MASK;
927 	tid = (capab & IEEE80211_ADDBA_PARAM_TID_MASK) >> 2;
928 	buf_size = (capab & IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK) >> 6;
929 	buf_size = min(buf_size, local->hw.max_tx_aggregation_subframes);
930 
931 	txq = sta->sta.txq[tid];
932 	if (!amsdu && txq)
933 		set_bit(IEEE80211_TXQ_NO_AMSDU, &to_txq_info(txq)->flags);
934 
935 	mutex_lock(&sta->ampdu_mlme.mtx);
936 
937 	tid_tx = rcu_dereference_protected_tid_tx(sta, tid);
938 	if (!tid_tx)
939 		goto out;
940 
941 	if (mgmt->u.action.u.addba_resp.dialog_token != tid_tx->dialog_token) {
942 		ht_dbg(sta->sdata, "wrong addBA response token, %pM tid %d\n",
943 		       sta->sta.addr, tid);
944 		goto out;
945 	}
946 
947 	del_timer_sync(&tid_tx->addba_resp_timer);
948 
949 	ht_dbg(sta->sdata, "switched off addBA timer for %pM tid %d\n",
950 	       sta->sta.addr, tid);
951 
952 	/*
953 	 * addba_resp_timer may have fired before we got here, and
954 	 * caused WANT_STOP to be set. If the stop then was already
955 	 * processed further, STOPPING might be set.
956 	 */
957 	if (test_bit(HT_AGG_STATE_WANT_STOP, &tid_tx->state) ||
958 	    test_bit(HT_AGG_STATE_STOPPING, &tid_tx->state)) {
959 		ht_dbg(sta->sdata,
960 		       "got addBA resp for %pM tid %d but we already gave up\n",
961 		       sta->sta.addr, tid);
962 		goto out;
963 	}
964 
965 	/*
966 	 * IEEE 802.11-2007 7.3.1.14:
967 	 * In an ADDBA Response frame, when the Status Code field
968 	 * is set to 0, the Buffer Size subfield is set to a value
969 	 * of at least 1.
970 	 */
971 	if (le16_to_cpu(mgmt->u.action.u.addba_resp.status)
972 			== WLAN_STATUS_SUCCESS && buf_size) {
973 		if (test_and_set_bit(HT_AGG_STATE_RESPONSE_RECEIVED,
974 				     &tid_tx->state)) {
975 			/* ignore duplicate response */
976 			goto out;
977 		}
978 
979 		tid_tx->buf_size = buf_size;
980 		tid_tx->amsdu = amsdu;
981 
982 		if (test_bit(HT_AGG_STATE_DRV_READY, &tid_tx->state))
983 			ieee80211_agg_tx_operational(local, sta, tid);
984 
985 		sta->ampdu_mlme.addba_req_num[tid] = 0;
986 
987 		tid_tx->timeout =
988 			le16_to_cpu(mgmt->u.action.u.addba_resp.timeout);
989 
990 		if (tid_tx->timeout) {
991 			mod_timer(&tid_tx->session_timer,
992 				  TU_TO_EXP_TIME(tid_tx->timeout));
993 			tid_tx->last_tx = jiffies;
994 		}
995 
996 	} else {
997 		___ieee80211_stop_tx_ba_session(sta, tid, AGG_STOP_DECLINED);
998 	}
999 
1000  out:
1001 	mutex_unlock(&sta->ampdu_mlme.mtx);
1002 }
1003