2 * Marvell Wireless LAN device driver: 802.11n RX Re-ordering
4 * Copyright (C) 2011, Marvell International Ltd.
6 * This software file (the "File") is distributed by Marvell International
7 * Ltd. under the terms of the GNU General Public License Version 2, June 1991
8 * (the "License"). You may use, redistribute and/or modify this File in
9 * accordance with the terms and conditions of the License, a copy of which
10 * is available by writing to the Free Software Foundation, Inc.,
11 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or on the
12 * worldwide web at http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
14 * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
16 * ARE EXPRESSLY DISCLAIMED. The License provides additional details about
17 * this warranty disclaimer.
27 #include "11n_rxreorder.h"
30 * This function dispatches all packets in the Rx reorder table until the
33 * There could be holes in the buffer, which are skipped by the function.
34 * Since the buffer is linear, the function uses rotation to simulate
38 mwifiex_11n_dispatch_pkt(struct mwifiex_private *priv,
39 struct mwifiex_rx_reorder_tbl *tbl, int start_win)
45 pkt_to_send = (start_win > tbl->start_win) ?
46 min((start_win - tbl->start_win), tbl->win_size) :
49 for (i = 0; i < pkt_to_send; ++i) {
50 spin_lock_irqsave(&priv->rx_pkt_lock, flags);
52 if (tbl->rx_reorder_ptr[i]) {
53 rx_tmp_ptr = tbl->rx_reorder_ptr[i];
54 tbl->rx_reorder_ptr[i] = NULL;
56 spin_unlock_irqrestore(&priv->rx_pkt_lock, flags);
58 mwifiex_process_rx_packet(priv->adapter, rx_tmp_ptr);
61 spin_lock_irqsave(&priv->rx_pkt_lock, flags);
63 * We don't have a circular buffer, hence use rotation to simulate
66 for (i = 0; i < tbl->win_size - pkt_to_send; ++i) {
67 tbl->rx_reorder_ptr[i] = tbl->rx_reorder_ptr[pkt_to_send + i];
68 tbl->rx_reorder_ptr[pkt_to_send + i] = NULL;
71 tbl->start_win = start_win;
72 spin_unlock_irqrestore(&priv->rx_pkt_lock, flags);
76 * This function dispatches all packets in the Rx reorder table until
79 * The start window is adjusted automatically when a hole is located.
80 * Since the buffer is linear, the function uses rotation to simulate
84 mwifiex_11n_scan_and_dispatch(struct mwifiex_private *priv,
85 struct mwifiex_rx_reorder_tbl *tbl)
91 for (i = 0; i < tbl->win_size; ++i) {
92 spin_lock_irqsave(&priv->rx_pkt_lock, flags);
93 if (!tbl->rx_reorder_ptr[i]) {
94 spin_unlock_irqrestore(&priv->rx_pkt_lock, flags);
97 rx_tmp_ptr = tbl->rx_reorder_ptr[i];
98 tbl->rx_reorder_ptr[i] = NULL;
99 spin_unlock_irqrestore(&priv->rx_pkt_lock, flags);
100 mwifiex_process_rx_packet(priv->adapter, rx_tmp_ptr);
103 spin_lock_irqsave(&priv->rx_pkt_lock, flags);
105 * We don't have a circular buffer, hence use rotation to simulate
109 xchg = tbl->win_size - i;
110 for (j = 0; j < xchg; ++j) {
111 tbl->rx_reorder_ptr[j] = tbl->rx_reorder_ptr[i + j];
112 tbl->rx_reorder_ptr[i + j] = NULL;
115 tbl->start_win = (tbl->start_win + i) & (MAX_TID_VALUE - 1);
116 spin_unlock_irqrestore(&priv->rx_pkt_lock, flags);
120 * This function deletes the Rx reorder table and frees the memory.
122 * The function stops the associated timer and dispatches all the
123 * pending packets in the Rx reorder table before deletion.
126 mwifiex_del_rx_reorder_entry(struct mwifiex_private *priv,
127 struct mwifiex_rx_reorder_tbl *tbl)
134 mwifiex_11n_dispatch_pkt(priv, tbl, (tbl->start_win + tbl->win_size) &
135 (MAX_TID_VALUE - 1));
137 del_timer(&tbl->timer_context.timer);
139 spin_lock_irqsave(&priv->rx_reorder_tbl_lock, flags);
140 list_del(&tbl->list);
141 spin_unlock_irqrestore(&priv->rx_reorder_tbl_lock, flags);
143 kfree(tbl->rx_reorder_ptr);
148 * This function returns the pointer to an entry in Rx reordering
149 * table which matches the given TA/TID pair.
151 static struct mwifiex_rx_reorder_tbl *
152 mwifiex_11n_get_rx_reorder_tbl(struct mwifiex_private *priv, int tid, u8 *ta)
154 struct mwifiex_rx_reorder_tbl *tbl;
157 spin_lock_irqsave(&priv->rx_reorder_tbl_lock, flags);
158 list_for_each_entry(tbl, &priv->rx_reorder_tbl_ptr, list) {
159 if (!memcmp(tbl->ta, ta, ETH_ALEN) && tbl->tid == tid) {
160 spin_unlock_irqrestore(&priv->rx_reorder_tbl_lock,
165 spin_unlock_irqrestore(&priv->rx_reorder_tbl_lock, flags);
171 * This function finds the last sequence number used in the packets
172 * buffered in Rx reordering table.
175 mwifiex_11n_find_last_seq_num(struct mwifiex_rx_reorder_tbl *rx_reorder_tbl_ptr)
179 for (i = (rx_reorder_tbl_ptr->win_size - 1); i >= 0; --i)
180 if (rx_reorder_tbl_ptr->rx_reorder_ptr[i])
187 * This function flushes all the packets in Rx reordering table.
189 * The function checks if any packets are currently buffered in the
190 * table or not. In case there are packets available, it dispatches
191 * them and then dumps the Rx reordering table.
194 mwifiex_flush_data(unsigned long context)
196 struct reorder_tmr_cnxt *ctx =
197 (struct reorder_tmr_cnxt *) context;
200 start_win = mwifiex_11n_find_last_seq_num(ctx->ptr);
205 dev_dbg(ctx->priv->adapter->dev, "info: flush data %d\n", start_win);
206 mwifiex_11n_dispatch_pkt(ctx->priv, ctx->ptr,
207 (ctx->ptr->start_win + start_win + 1) &
208 (MAX_TID_VALUE - 1));
212 * This function creates an entry in Rx reordering table for the
215 * The function also initializes the entry with sequence number, window
216 * size as well as initializes the timer.
218 * If the received TA/TID pair is already present, all the packets are
219 * dispatched and the window size is moved until the SSN.
222 mwifiex_11n_create_rx_reorder_tbl(struct mwifiex_private *priv, u8 *ta,
223 int tid, int win_size, int seq_num)
226 struct mwifiex_rx_reorder_tbl *tbl, *new_node;
231 * If we get a TID, ta pair which is already present dispatch all the
232 * the packets and move the window size until the ssn
234 tbl = mwifiex_11n_get_rx_reorder_tbl(priv, tid, ta);
236 mwifiex_11n_dispatch_pkt(priv, tbl, seq_num);
239 /* if !tbl then create one */
240 new_node = kzalloc(sizeof(struct mwifiex_rx_reorder_tbl), GFP_KERNEL);
242 dev_err(priv->adapter->dev, "%s: failed to alloc new_node\n",
247 INIT_LIST_HEAD(&new_node->list);
249 memcpy(new_node->ta, ta, ETH_ALEN);
250 new_node->start_win = seq_num;
251 if (mwifiex_queuing_ra_based(priv))
253 dev_dbg(priv->adapter->dev,
254 "info: ADHOC:last_seq=%d start_win=%d\n",
255 last_seq, new_node->start_win);
257 last_seq = priv->rx_seq[tid];
259 if (last_seq >= new_node->start_win)
260 new_node->start_win = last_seq + 1;
262 new_node->win_size = win_size;
264 new_node->rx_reorder_ptr = kzalloc(sizeof(void *) * win_size,
266 if (!new_node->rx_reorder_ptr) {
267 kfree((u8 *) new_node);
268 dev_err(priv->adapter->dev,
269 "%s: failed to alloc reorder_ptr\n", __func__);
273 new_node->timer_context.ptr = new_node;
274 new_node->timer_context.priv = priv;
276 init_timer(&new_node->timer_context.timer);
277 new_node->timer_context.timer.function = mwifiex_flush_data;
278 new_node->timer_context.timer.data =
279 (unsigned long) &new_node->timer_context;
281 for (i = 0; i < win_size; ++i)
282 new_node->rx_reorder_ptr[i] = NULL;
284 spin_lock_irqsave(&priv->rx_reorder_tbl_lock, flags);
285 list_add_tail(&new_node->list, &priv->rx_reorder_tbl_ptr);
286 spin_unlock_irqrestore(&priv->rx_reorder_tbl_lock, flags);
290 * This function prepares command for adding a BA request.
292 * Preparation includes -
293 * - Setting command ID and proper size
294 * - Setting add BA request buffer
295 * - Ensuring correct endian-ness
297 int mwifiex_cmd_11n_addba_req(struct host_cmd_ds_command *cmd, void *data_buf)
299 struct host_cmd_ds_11n_addba_req *add_ba_req =
300 (struct host_cmd_ds_11n_addba_req *)
301 &cmd->params.add_ba_req;
303 cmd->command = cpu_to_le16(HostCmd_CMD_11N_ADDBA_REQ);
304 cmd->size = cpu_to_le16(sizeof(*add_ba_req) + S_DS_GEN);
305 memcpy(add_ba_req, data_buf, sizeof(*add_ba_req));
311 * This function prepares command for adding a BA response.
313 * Preparation includes -
314 * - Setting command ID and proper size
315 * - Setting add BA response buffer
316 * - Ensuring correct endian-ness
318 int mwifiex_cmd_11n_addba_rsp_gen(struct mwifiex_private *priv,
319 struct host_cmd_ds_command *cmd,
320 struct host_cmd_ds_11n_addba_req
323 struct host_cmd_ds_11n_addba_rsp *add_ba_rsp =
324 (struct host_cmd_ds_11n_addba_rsp *)
325 &cmd->params.add_ba_rsp;
328 uint16_t block_ack_param_set;
330 cmd->command = cpu_to_le16(HostCmd_CMD_11N_ADDBA_RSP);
331 cmd->size = cpu_to_le16(sizeof(*add_ba_rsp) + S_DS_GEN);
333 memcpy(add_ba_rsp->peer_mac_addr, cmd_addba_req->peer_mac_addr,
335 add_ba_rsp->dialog_token = cmd_addba_req->dialog_token;
336 add_ba_rsp->block_ack_tmo = cmd_addba_req->block_ack_tmo;
337 add_ba_rsp->ssn = cmd_addba_req->ssn;
339 block_ack_param_set = le16_to_cpu(cmd_addba_req->block_ack_param_set);
340 tid = (block_ack_param_set & IEEE80211_ADDBA_PARAM_TID_MASK)
341 >> BLOCKACKPARAM_TID_POS;
342 add_ba_rsp->status_code = cpu_to_le16(ADDBA_RSP_STATUS_ACCEPT);
343 block_ack_param_set &= ~IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK;
344 /* We donot support AMSDU inside AMPDU, hence reset the bit */
345 block_ack_param_set &= ~BLOCKACKPARAM_AMSDU_SUPP_MASK;
346 block_ack_param_set |= (priv->add_ba_param.rx_win_size <<
347 BLOCKACKPARAM_WINSIZE_POS);
348 add_ba_rsp->block_ack_param_set = cpu_to_le16(block_ack_param_set);
349 win_size = (le16_to_cpu(add_ba_rsp->block_ack_param_set)
350 & IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK)
351 >> BLOCKACKPARAM_WINSIZE_POS;
352 cmd_addba_req->block_ack_param_set = cpu_to_le16(block_ack_param_set);
354 mwifiex_11n_create_rx_reorder_tbl(priv, cmd_addba_req->peer_mac_addr,
356 le16_to_cpu(cmd_addba_req->ssn));
361 * This function prepares command for deleting a BA request.
363 * Preparation includes -
364 * - Setting command ID and proper size
365 * - Setting del BA request buffer
366 * - Ensuring correct endian-ness
368 int mwifiex_cmd_11n_delba(struct host_cmd_ds_command *cmd, void *data_buf)
370 struct host_cmd_ds_11n_delba *del_ba = (struct host_cmd_ds_11n_delba *)
373 cmd->command = cpu_to_le16(HostCmd_CMD_11N_DELBA);
374 cmd->size = cpu_to_le16(sizeof(*del_ba) + S_DS_GEN);
375 memcpy(del_ba, data_buf, sizeof(*del_ba));
381 * This function identifies if Rx reordering is needed for a received packet.
383 * In case reordering is required, the function will do the reordering
384 * before sending it to kernel.
386 * The Rx reorder table is checked first with the received TID/TA pair. If
387 * not found, the received packet is dispatched immediately. But if found,
388 * the packet is reordered and all the packets in the updated Rx reordering
389 * table is dispatched until a hole is found.
391 * For sequence number less than the starting window, the packet is dropped.
393 int mwifiex_11n_rx_reorder_pkt(struct mwifiex_private *priv,
394 u16 seq_num, u16 tid,
395 u8 *ta, u8 pkt_type, void *payload)
397 struct mwifiex_rx_reorder_tbl *tbl;
398 int start_win, end_win, win_size;
401 tbl = mwifiex_11n_get_rx_reorder_tbl((struct mwifiex_private *) priv,
404 if (pkt_type != PKT_TYPE_BAR)
405 mwifiex_process_rx_packet(priv->adapter, payload);
408 start_win = tbl->start_win;
409 win_size = tbl->win_size;
410 end_win = ((start_win + win_size) - 1) & (MAX_TID_VALUE - 1);
411 del_timer(&tbl->timer_context.timer);
412 mod_timer(&tbl->timer_context.timer,
413 jiffies + (MIN_FLUSH_TIMER_MS * win_size * HZ) / 1000);
416 * If seq_num is less then starting win then ignore and drop the
419 if ((start_win + TWOPOW11) > (MAX_TID_VALUE - 1)) {/* Wrap */
420 if (seq_num >= ((start_win + TWOPOW11) &
421 (MAX_TID_VALUE - 1)) && (seq_num < start_win))
423 } else if ((seq_num < start_win) ||
424 (seq_num > (start_win + TWOPOW11))) {
429 * If this packet is a BAR we adjust seq_num as
432 if (pkt_type == PKT_TYPE_BAR)
433 seq_num = ((seq_num + win_size) - 1) & (MAX_TID_VALUE - 1);
435 if (((end_win < start_win) &&
436 (seq_num < (TWOPOW11 - (MAX_TID_VALUE - start_win))) &&
437 (seq_num > end_win)) ||
438 ((end_win > start_win) && ((seq_num > end_win) ||
439 (seq_num < start_win)))) {
441 if (((seq_num - win_size) + 1) >= 0)
442 start_win = (end_win - win_size) + 1;
444 start_win = (MAX_TID_VALUE - (win_size - seq_num)) + 1;
445 mwifiex_11n_dispatch_pkt(priv, tbl, start_win);
448 if (pkt_type != PKT_TYPE_BAR) {
449 if (seq_num >= start_win)
450 pkt_index = seq_num - start_win;
452 pkt_index = (seq_num+MAX_TID_VALUE) - start_win;
454 if (tbl->rx_reorder_ptr[pkt_index])
457 tbl->rx_reorder_ptr[pkt_index] = payload;
461 * Dispatch all packets sequentially from start_win until a
462 * hole is found and adjust the start_win appropriately
464 mwifiex_11n_scan_and_dispatch(priv, tbl);
470 * This function deletes an entry for a given TID/TA pair.
472 * The TID/TA are taken from del BA event body.
475 mwifiex_del_ba_tbl(struct mwifiex_private *priv, int tid, u8 *peer_mac,
476 u8 type, int initiator)
478 struct mwifiex_rx_reorder_tbl *tbl;
479 struct mwifiex_tx_ba_stream_tbl *ptx_tbl;
480 u8 cleanup_rx_reorder_tbl;
483 if (type == TYPE_DELBA_RECEIVE)
484 cleanup_rx_reorder_tbl = (initiator) ? true : false;
486 cleanup_rx_reorder_tbl = (initiator) ? false : true;
488 dev_dbg(priv->adapter->dev, "event: DELBA: %pM tid=%d initiator=%d\n",
489 peer_mac, tid, initiator);
491 if (cleanup_rx_reorder_tbl) {
492 tbl = mwifiex_11n_get_rx_reorder_tbl(priv, tid,
495 dev_dbg(priv->adapter->dev,
496 "event: TID, TA not found in table\n");
499 mwifiex_del_rx_reorder_entry(priv, tbl);
501 ptx_tbl = mwifiex_get_ba_tbl(priv, tid, peer_mac);
503 dev_dbg(priv->adapter->dev,
504 "event: TID, RA not found in table\n");
508 spin_lock_irqsave(&priv->tx_ba_stream_tbl_lock, flags);
509 mwifiex_11n_delete_tx_ba_stream_tbl_entry(priv, ptx_tbl);
510 spin_unlock_irqrestore(&priv->tx_ba_stream_tbl_lock, flags);
515 * This function handles the command response of an add BA response.
517 * Handling includes changing the header fields into CPU format and
518 * creating the stream, provided the add BA is accepted.
520 int mwifiex_ret_11n_addba_resp(struct mwifiex_private *priv,
521 struct host_cmd_ds_command *resp)
523 struct host_cmd_ds_11n_addba_rsp *add_ba_rsp =
524 (struct host_cmd_ds_11n_addba_rsp *)
525 &resp->params.add_ba_rsp;
527 struct mwifiex_rx_reorder_tbl *tbl;
528 uint16_t block_ack_param_set;
530 block_ack_param_set = le16_to_cpu(add_ba_rsp->block_ack_param_set);
532 tid = (block_ack_param_set & IEEE80211_ADDBA_PARAM_TID_MASK)
533 >> BLOCKACKPARAM_TID_POS;
535 * Check if we had rejected the ADDBA, if yes then do not create
538 if (le16_to_cpu(add_ba_rsp->status_code) == BA_RESULT_SUCCESS) {
539 win_size = (block_ack_param_set &
540 IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK)
541 >> BLOCKACKPARAM_WINSIZE_POS;
543 dev_dbg(priv->adapter->dev,
544 "cmd: ADDBA RSP: %pM tid=%d ssn=%d win_size=%d\n",
545 add_ba_rsp->peer_mac_addr, tid,
546 add_ba_rsp->ssn, win_size);
548 dev_err(priv->adapter->dev, "ADDBA RSP: failed %pM tid=%d)\n",
549 add_ba_rsp->peer_mac_addr, tid);
551 tbl = mwifiex_11n_get_rx_reorder_tbl(priv, tid,
552 add_ba_rsp->peer_mac_addr);
554 mwifiex_del_rx_reorder_entry(priv, tbl);
561 * This function handles BA stream timeout event by preparing and sending
562 * a command to the firmware.
564 void mwifiex_11n_ba_stream_timeout(struct mwifiex_private *priv,
565 struct host_cmd_ds_11n_batimeout *event)
567 struct host_cmd_ds_11n_delba delba;
569 memset(&delba, 0, sizeof(struct host_cmd_ds_11n_delba));
570 memcpy(delba.peer_mac_addr, event->peer_mac_addr, ETH_ALEN);
572 delba.del_ba_param_set |=
573 cpu_to_le16((u16) event->tid << DELBA_TID_POS);
574 delba.del_ba_param_set |= cpu_to_le16(
575 (u16) event->origninator << DELBA_INITIATOR_POS);
576 delba.reason_code = cpu_to_le16(WLAN_REASON_QSTA_TIMEOUT);
577 mwifiex_send_cmd_async(priv, HostCmd_CMD_11N_DELBA, 0, 0, &delba);
581 * This function cleans up the Rx reorder table by deleting all the entries
582 * and re-initializing.
584 void mwifiex_11n_cleanup_reorder_tbl(struct mwifiex_private *priv)
586 struct mwifiex_rx_reorder_tbl *del_tbl_ptr, *tmp_node;
589 spin_lock_irqsave(&priv->rx_reorder_tbl_lock, flags);
590 list_for_each_entry_safe(del_tbl_ptr, tmp_node,
591 &priv->rx_reorder_tbl_ptr, list) {
592 spin_unlock_irqrestore(&priv->rx_reorder_tbl_lock, flags);
593 mwifiex_del_rx_reorder_entry(priv, del_tbl_ptr);
594 spin_lock_irqsave(&priv->rx_reorder_tbl_lock, flags);
596 spin_unlock_irqrestore(&priv->rx_reorder_tbl_lock, flags);
598 INIT_LIST_HEAD(&priv->rx_reorder_tbl_ptr);
599 memset(priv->rx_seq, 0, sizeof(priv->rx_seq));