xref: /linux/net/mac80211/agg-rx.c (revision 26b0d14106954ae46d2f4f7eec3481828a210f7d)
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  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License version 2 as
13  * published by the Free Software Foundation.
14  */
15 
16 /**
17  * DOC: RX A-MPDU aggregation
18  *
19  * Aggregation on the RX side requires only implementing the
20  * @ampdu_action callback that is invoked to start/stop any
21  * block-ack sessions for RX aggregation.
22  *
23  * When RX aggregation is started by the peer, the driver is
24  * notified via @ampdu_action function, with the
25  * %IEEE80211_AMPDU_RX_START action, and may reject the request
26  * in which case a negative response is sent to the peer, if it
27  * accepts it a positive response is sent.
28  *
29  * While the session is active, the device/driver are required
30  * to de-aggregate frames and pass them up one by one to mac80211,
31  * which will handle the reorder buffer.
32  *
33  * When the aggregation session is stopped again by the peer or
34  * ourselves, the driver's @ampdu_action function will be called
35  * with the action %IEEE80211_AMPDU_RX_STOP. In this case, the
36  * call must not fail.
37  */
38 
39 #include <linux/ieee80211.h>
40 #include <linux/slab.h>
41 #include <linux/export.h>
42 #include <net/mac80211.h>
43 #include "ieee80211_i.h"
44 #include "driver-ops.h"
45 
46 static void ieee80211_free_tid_rx(struct rcu_head *h)
47 {
48 	struct tid_ampdu_rx *tid_rx =
49 		container_of(h, struct tid_ampdu_rx, rcu_head);
50 	int i;
51 
52 	del_timer_sync(&tid_rx->reorder_timer);
53 
54 	for (i = 0; i < tid_rx->buf_size; i++)
55 		dev_kfree_skb(tid_rx->reorder_buf[i]);
56 	kfree(tid_rx->reorder_buf);
57 	kfree(tid_rx->reorder_time);
58 	kfree(tid_rx);
59 }
60 
61 void ___ieee80211_stop_rx_ba_session(struct sta_info *sta, u16 tid,
62 				     u16 initiator, u16 reason, bool tx)
63 {
64 	struct ieee80211_local *local = sta->local;
65 	struct tid_ampdu_rx *tid_rx;
66 
67 	lockdep_assert_held(&sta->ampdu_mlme.mtx);
68 
69 	tid_rx = rcu_dereference_protected(sta->ampdu_mlme.tid_rx[tid],
70 					lockdep_is_held(&sta->ampdu_mlme.mtx));
71 
72 	if (!tid_rx)
73 		return;
74 
75 	RCU_INIT_POINTER(sta->ampdu_mlme.tid_rx[tid], NULL);
76 
77 #ifdef CONFIG_MAC80211_HT_DEBUG
78 	printk(KERN_DEBUG
79 	       "Rx BA session stop requested for %pM tid %u %s reason: %d\n",
80 	       sta->sta.addr, tid,
81 	       initiator == WLAN_BACK_RECIPIENT ? "recipient" : "inititator",
82 	       (int)reason);
83 #endif /* CONFIG_MAC80211_HT_DEBUG */
84 
85 	if (drv_ampdu_action(local, sta->sdata, IEEE80211_AMPDU_RX_STOP,
86 			     &sta->sta, tid, NULL, 0))
87 		printk(KERN_DEBUG "HW problem - can not stop rx "
88 				"aggregation for tid %d\n", tid);
89 
90 	/* check if this is a self generated aggregation halt */
91 	if (initiator == WLAN_BACK_RECIPIENT && tx)
92 		ieee80211_send_delba(sta->sdata, sta->sta.addr,
93 				     tid, WLAN_BACK_RECIPIENT, reason);
94 
95 	del_timer_sync(&tid_rx->session_timer);
96 
97 	call_rcu(&tid_rx->rcu_head, ieee80211_free_tid_rx);
98 }
99 
100 void __ieee80211_stop_rx_ba_session(struct sta_info *sta, u16 tid,
101 				    u16 initiator, u16 reason, bool tx)
102 {
103 	mutex_lock(&sta->ampdu_mlme.mtx);
104 	___ieee80211_stop_rx_ba_session(sta, tid, initiator, reason, tx);
105 	mutex_unlock(&sta->ampdu_mlme.mtx);
106 }
107 
108 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
109 				  const u8 *addr)
110 {
111 	struct ieee80211_sub_if_data *sdata = vif_to_sdata(vif);
112 	struct sta_info *sta;
113 	int i;
114 
115 	rcu_read_lock();
116 	sta = sta_info_get_bss(sdata, addr);
117 	if (!sta) {
118 		rcu_read_unlock();
119 		return;
120 	}
121 
122 	for (i = 0; i < STA_TID_NUM; i++)
123 		if (ba_rx_bitmap & BIT(i))
124 			set_bit(i, sta->ampdu_mlme.tid_rx_stop_requested);
125 
126 	ieee80211_queue_work(&sta->local->hw, &sta->ampdu_mlme.work);
127 	rcu_read_unlock();
128 }
129 EXPORT_SYMBOL(ieee80211_stop_rx_ba_session);
130 
131 /*
132  * After accepting the AddBA Request we activated a timer,
133  * resetting it after each frame that arrives from the originator.
134  */
135 static void sta_rx_agg_session_timer_expired(unsigned long data)
136 {
137 	/* not an elegant detour, but there is no choice as the timer passes
138 	 * only one argument, and various sta_info are needed here, so init
139 	 * flow in sta_info_create gives the TID as data, while the timer_to_id
140 	 * array gives the sta through container_of */
141 	u8 *ptid = (u8 *)data;
142 	u8 *timer_to_id = ptid - *ptid;
143 	struct sta_info *sta = container_of(timer_to_id, struct sta_info,
144 					 timer_to_tid[0]);
145 	struct tid_ampdu_rx *tid_rx;
146 	unsigned long timeout;
147 
148 	rcu_read_lock();
149 	tid_rx = rcu_dereference(sta->ampdu_mlme.tid_rx[*ptid]);
150 	if (!tid_rx) {
151 		rcu_read_unlock();
152 		return;
153 	}
154 
155 	timeout = tid_rx->last_rx + TU_TO_JIFFIES(tid_rx->timeout);
156 	if (time_is_after_jiffies(timeout)) {
157 		mod_timer(&tid_rx->session_timer, timeout);
158 		rcu_read_unlock();
159 		return;
160 	}
161 	rcu_read_unlock();
162 
163 #ifdef CONFIG_MAC80211_HT_DEBUG
164 	printk(KERN_DEBUG "rx session timer expired on tid %d\n", (u16)*ptid);
165 #endif
166 	set_bit(*ptid, sta->ampdu_mlme.tid_rx_timer_expired);
167 	ieee80211_queue_work(&sta->local->hw, &sta->ampdu_mlme.work);
168 }
169 
170 static void sta_rx_agg_reorder_timer_expired(unsigned long data)
171 {
172 	u8 *ptid = (u8 *)data;
173 	u8 *timer_to_id = ptid - *ptid;
174 	struct sta_info *sta = container_of(timer_to_id, struct sta_info,
175 			timer_to_tid[0]);
176 
177 	rcu_read_lock();
178 	ieee80211_release_reorder_timeout(sta, *ptid);
179 	rcu_read_unlock();
180 }
181 
182 static void ieee80211_send_addba_resp(struct ieee80211_sub_if_data *sdata, u8 *da, u16 tid,
183 				      u8 dialog_token, u16 status, u16 policy,
184 				      u16 buf_size, u16 timeout)
185 {
186 	struct ieee80211_local *local = sdata->local;
187 	struct sk_buff *skb;
188 	struct ieee80211_mgmt *mgmt;
189 	u16 capab;
190 
191 	skb = dev_alloc_skb(sizeof(*mgmt) + local->hw.extra_tx_headroom);
192 	if (!skb)
193 		return;
194 
195 	skb_reserve(skb, local->hw.extra_tx_headroom);
196 	mgmt = (struct ieee80211_mgmt *) skb_put(skb, 24);
197 	memset(mgmt, 0, 24);
198 	memcpy(mgmt->da, da, ETH_ALEN);
199 	memcpy(mgmt->sa, sdata->vif.addr, ETH_ALEN);
200 	if (sdata->vif.type == NL80211_IFTYPE_AP ||
201 	    sdata->vif.type == NL80211_IFTYPE_AP_VLAN ||
202 	    sdata->vif.type == NL80211_IFTYPE_MESH_POINT)
203 		memcpy(mgmt->bssid, sdata->vif.addr, ETH_ALEN);
204 	else if (sdata->vif.type == NL80211_IFTYPE_STATION)
205 		memcpy(mgmt->bssid, sdata->u.mgd.bssid, ETH_ALEN);
206 	else if (sdata->vif.type == NL80211_IFTYPE_ADHOC)
207 		memcpy(mgmt->bssid, sdata->u.ibss.bssid, ETH_ALEN);
208 
209 	mgmt->frame_control = cpu_to_le16(IEEE80211_FTYPE_MGMT |
210 					  IEEE80211_STYPE_ACTION);
211 
212 	skb_put(skb, 1 + sizeof(mgmt->u.action.u.addba_resp));
213 	mgmt->u.action.category = WLAN_CATEGORY_BACK;
214 	mgmt->u.action.u.addba_resp.action_code = WLAN_ACTION_ADDBA_RESP;
215 	mgmt->u.action.u.addba_resp.dialog_token = dialog_token;
216 
217 	capab = (u16)(policy << 1);	/* bit 1 aggregation policy */
218 	capab |= (u16)(tid << 2); 	/* bit 5:2 TID number */
219 	capab |= (u16)(buf_size << 6);	/* bit 15:6 max size of aggregation */
220 
221 	mgmt->u.action.u.addba_resp.capab = cpu_to_le16(capab);
222 	mgmt->u.action.u.addba_resp.timeout = cpu_to_le16(timeout);
223 	mgmt->u.action.u.addba_resp.status = cpu_to_le16(status);
224 
225 	ieee80211_tx_skb(sdata, skb);
226 }
227 
228 void ieee80211_process_addba_request(struct ieee80211_local *local,
229 				     struct sta_info *sta,
230 				     struct ieee80211_mgmt *mgmt,
231 				     size_t len)
232 {
233 	struct tid_ampdu_rx *tid_agg_rx;
234 	u16 capab, tid, timeout, ba_policy, buf_size, start_seq_num, status;
235 	u8 dialog_token;
236 	int ret = -EOPNOTSUPP;
237 
238 	/* extract session parameters from addba request frame */
239 	dialog_token = mgmt->u.action.u.addba_req.dialog_token;
240 	timeout = le16_to_cpu(mgmt->u.action.u.addba_req.timeout);
241 	start_seq_num =
242 		le16_to_cpu(mgmt->u.action.u.addba_req.start_seq_num) >> 4;
243 
244 	capab = le16_to_cpu(mgmt->u.action.u.addba_req.capab);
245 	ba_policy = (capab & IEEE80211_ADDBA_PARAM_POLICY_MASK) >> 1;
246 	tid = (capab & IEEE80211_ADDBA_PARAM_TID_MASK) >> 2;
247 	buf_size = (capab & IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK) >> 6;
248 
249 	status = WLAN_STATUS_REQUEST_DECLINED;
250 
251 	if (test_sta_flag(sta, WLAN_STA_BLOCK_BA)) {
252 #ifdef CONFIG_MAC80211_HT_DEBUG
253 		printk(KERN_DEBUG "Suspend in progress. "
254 		       "Denying ADDBA request\n");
255 #endif
256 		goto end_no_lock;
257 	}
258 
259 	/* sanity check for incoming parameters:
260 	 * check if configuration can support the BA policy
261 	 * and if buffer size does not exceeds max value */
262 	/* XXX: check own ht delayed BA capability?? */
263 	if (((ba_policy != 1) &&
264 	     (!(sta->sta.ht_cap.cap & IEEE80211_HT_CAP_DELAY_BA))) ||
265 	    (buf_size > IEEE80211_MAX_AMPDU_BUF)) {
266 		status = WLAN_STATUS_INVALID_QOS_PARAM;
267 #ifdef CONFIG_MAC80211_HT_DEBUG
268 		net_dbg_ratelimited("AddBA Req with bad params from %pM on tid %u. policy %d, buffer size %d\n",
269 				    mgmt->sa, tid, ba_policy, buf_size);
270 #endif /* CONFIG_MAC80211_HT_DEBUG */
271 		goto end_no_lock;
272 	}
273 	/* determine default buffer size */
274 	if (buf_size == 0)
275 		buf_size = IEEE80211_MAX_AMPDU_BUF;
276 
277 	/* make sure the size doesn't exceed the maximum supported by the hw */
278 	if (buf_size > local->hw.max_rx_aggregation_subframes)
279 		buf_size = local->hw.max_rx_aggregation_subframes;
280 
281 	/* examine state machine */
282 	mutex_lock(&sta->ampdu_mlme.mtx);
283 
284 	if (sta->ampdu_mlme.tid_rx[tid]) {
285 #ifdef CONFIG_MAC80211_HT_DEBUG
286 		net_dbg_ratelimited("unexpected AddBA Req from %pM on tid %u\n",
287 				    mgmt->sa, tid);
288 #endif /* CONFIG_MAC80211_HT_DEBUG */
289 
290 		/* delete existing Rx BA session on the same tid */
291 		___ieee80211_stop_rx_ba_session(sta, tid, WLAN_BACK_RECIPIENT,
292 						WLAN_STATUS_UNSPECIFIED_QOS,
293 						false);
294 	}
295 
296 	/* prepare A-MPDU MLME for Rx aggregation */
297 	tid_agg_rx = kmalloc(sizeof(struct tid_ampdu_rx), GFP_KERNEL);
298 	if (!tid_agg_rx)
299 		goto end;
300 
301 	spin_lock_init(&tid_agg_rx->reorder_lock);
302 
303 	/* rx timer */
304 	tid_agg_rx->session_timer.function = sta_rx_agg_session_timer_expired;
305 	tid_agg_rx->session_timer.data = (unsigned long)&sta->timer_to_tid[tid];
306 	init_timer_deferrable(&tid_agg_rx->session_timer);
307 
308 	/* rx reorder timer */
309 	tid_agg_rx->reorder_timer.function = sta_rx_agg_reorder_timer_expired;
310 	tid_agg_rx->reorder_timer.data = (unsigned long)&sta->timer_to_tid[tid];
311 	init_timer(&tid_agg_rx->reorder_timer);
312 
313 	/* prepare reordering buffer */
314 	tid_agg_rx->reorder_buf =
315 		kcalloc(buf_size, sizeof(struct sk_buff *), GFP_KERNEL);
316 	tid_agg_rx->reorder_time =
317 		kcalloc(buf_size, sizeof(unsigned long), GFP_KERNEL);
318 	if (!tid_agg_rx->reorder_buf || !tid_agg_rx->reorder_time) {
319 		kfree(tid_agg_rx->reorder_buf);
320 		kfree(tid_agg_rx->reorder_time);
321 		kfree(tid_agg_rx);
322 		goto end;
323 	}
324 
325 	ret = drv_ampdu_action(local, sta->sdata, IEEE80211_AMPDU_RX_START,
326 			       &sta->sta, tid, &start_seq_num, 0);
327 #ifdef CONFIG_MAC80211_HT_DEBUG
328 	printk(KERN_DEBUG "Rx A-MPDU request on tid %d result %d\n", tid, ret);
329 #endif /* CONFIG_MAC80211_HT_DEBUG */
330 
331 	if (ret) {
332 		kfree(tid_agg_rx->reorder_buf);
333 		kfree(tid_agg_rx->reorder_time);
334 		kfree(tid_agg_rx);
335 		goto end;
336 	}
337 
338 	/* update data */
339 	tid_agg_rx->dialog_token = dialog_token;
340 	tid_agg_rx->ssn = start_seq_num;
341 	tid_agg_rx->head_seq_num = start_seq_num;
342 	tid_agg_rx->buf_size = buf_size;
343 	tid_agg_rx->timeout = timeout;
344 	tid_agg_rx->stored_mpdu_num = 0;
345 	status = WLAN_STATUS_SUCCESS;
346 
347 	/* activate it for RX */
348 	rcu_assign_pointer(sta->ampdu_mlme.tid_rx[tid], tid_agg_rx);
349 
350 	if (timeout) {
351 		mod_timer(&tid_agg_rx->session_timer, TU_TO_EXP_TIME(timeout));
352 		tid_agg_rx->last_rx = jiffies;
353 	}
354 
355 end:
356 	mutex_unlock(&sta->ampdu_mlme.mtx);
357 
358 end_no_lock:
359 	ieee80211_send_addba_resp(sta->sdata, sta->sta.addr, tid,
360 				  dialog_token, status, 1, buf_size, timeout);
361 }
362