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 if (priv
->bss_role
== MWIFIEX_BSS_ROLE_UAP
)
59 mwifiex_handle_uap_rx_forward(priv
, rx_tmp_ptr
);
61 mwifiex_process_rx_packet(priv
->adapter
,
66 spin_lock_irqsave(&priv
->rx_pkt_lock
, flags
);
68 * We don't have a circular buffer, hence use rotation to simulate
71 for (i
= 0; i
< tbl
->win_size
- pkt_to_send
; ++i
) {
72 tbl
->rx_reorder_ptr
[i
] = tbl
->rx_reorder_ptr
[pkt_to_send
+ i
];
73 tbl
->rx_reorder_ptr
[pkt_to_send
+ i
] = NULL
;
76 tbl
->start_win
= start_win
;
77 spin_unlock_irqrestore(&priv
->rx_pkt_lock
, flags
);
81 * This function dispatches all packets in the Rx reorder table until
84 * The start window is adjusted automatically when a hole is located.
85 * Since the buffer is linear, the function uses rotation to simulate
89 mwifiex_11n_scan_and_dispatch(struct mwifiex_private
*priv
,
90 struct mwifiex_rx_reorder_tbl
*tbl
)
96 for (i
= 0; i
< tbl
->win_size
; ++i
) {
97 spin_lock_irqsave(&priv
->rx_pkt_lock
, flags
);
98 if (!tbl
->rx_reorder_ptr
[i
]) {
99 spin_unlock_irqrestore(&priv
->rx_pkt_lock
, flags
);
102 rx_tmp_ptr
= tbl
->rx_reorder_ptr
[i
];
103 tbl
->rx_reorder_ptr
[i
] = NULL
;
104 spin_unlock_irqrestore(&priv
->rx_pkt_lock
, flags
);
106 if (priv
->bss_role
== MWIFIEX_BSS_ROLE_UAP
)
107 mwifiex_handle_uap_rx_forward(priv
, rx_tmp_ptr
);
109 mwifiex_process_rx_packet(priv
->adapter
, rx_tmp_ptr
);
112 spin_lock_irqsave(&priv
->rx_pkt_lock
, flags
);
114 * We don't have a circular buffer, hence use rotation to simulate
118 xchg
= tbl
->win_size
- i
;
119 for (j
= 0; j
< xchg
; ++j
) {
120 tbl
->rx_reorder_ptr
[j
] = tbl
->rx_reorder_ptr
[i
+ j
];
121 tbl
->rx_reorder_ptr
[i
+ j
] = NULL
;
124 tbl
->start_win
= (tbl
->start_win
+ i
) & (MAX_TID_VALUE
- 1);
125 spin_unlock_irqrestore(&priv
->rx_pkt_lock
, flags
);
129 * This function deletes the Rx reorder table and frees the memory.
131 * The function stops the associated timer and dispatches all the
132 * pending packets in the Rx reorder table before deletion.
135 mwifiex_del_rx_reorder_entry(struct mwifiex_private
*priv
,
136 struct mwifiex_rx_reorder_tbl
*tbl
)
143 mwifiex_11n_dispatch_pkt(priv
, tbl
, (tbl
->start_win
+ tbl
->win_size
) &
144 (MAX_TID_VALUE
- 1));
146 del_timer(&tbl
->timer_context
.timer
);
148 spin_lock_irqsave(&priv
->rx_reorder_tbl_lock
, flags
);
149 list_del(&tbl
->list
);
150 spin_unlock_irqrestore(&priv
->rx_reorder_tbl_lock
, flags
);
152 kfree(tbl
->rx_reorder_ptr
);
157 * This function returns the pointer to an entry in Rx reordering
158 * table which matches the given TA/TID pair.
160 struct mwifiex_rx_reorder_tbl
*
161 mwifiex_11n_get_rx_reorder_tbl(struct mwifiex_private
*priv
, int tid
, u8
*ta
)
163 struct mwifiex_rx_reorder_tbl
*tbl
;
166 spin_lock_irqsave(&priv
->rx_reorder_tbl_lock
, flags
);
167 list_for_each_entry(tbl
, &priv
->rx_reorder_tbl_ptr
, list
) {
168 if (!memcmp(tbl
->ta
, ta
, ETH_ALEN
) && tbl
->tid
== tid
) {
169 spin_unlock_irqrestore(&priv
->rx_reorder_tbl_lock
,
174 spin_unlock_irqrestore(&priv
->rx_reorder_tbl_lock
, flags
);
179 /* This function retrieves the pointer to an entry in Rx reordering
180 * table which matches the given TA and deletes it.
182 void mwifiex_11n_del_rx_reorder_tbl_by_ta(struct mwifiex_private
*priv
, u8
*ta
)
184 struct mwifiex_rx_reorder_tbl
*tbl
, *tmp
;
190 spin_lock_irqsave(&priv
->rx_reorder_tbl_lock
, flags
);
191 list_for_each_entry_safe(tbl
, tmp
, &priv
->rx_reorder_tbl_ptr
, list
) {
192 if (!memcmp(tbl
->ta
, ta
, ETH_ALEN
)) {
193 spin_unlock_irqrestore(&priv
->rx_reorder_tbl_lock
,
195 mwifiex_del_rx_reorder_entry(priv
, tbl
);
196 spin_lock_irqsave(&priv
->rx_reorder_tbl_lock
, flags
);
199 spin_unlock_irqrestore(&priv
->rx_reorder_tbl_lock
, flags
);
205 * This function finds the last sequence number used in the packets
206 * buffered in Rx reordering table.
209 mwifiex_11n_find_last_seq_num(struct mwifiex_rx_reorder_tbl
*rx_reorder_tbl_ptr
)
213 for (i
= (rx_reorder_tbl_ptr
->win_size
- 1); i
>= 0; --i
)
214 if (rx_reorder_tbl_ptr
->rx_reorder_ptr
[i
])
221 * This function flushes all the packets in Rx reordering table.
223 * The function checks if any packets are currently buffered in the
224 * table or not. In case there are packets available, it dispatches
225 * them and then dumps the Rx reordering table.
228 mwifiex_flush_data(unsigned long context
)
230 struct reorder_tmr_cnxt
*ctx
=
231 (struct reorder_tmr_cnxt
*) context
;
234 start_win
= mwifiex_11n_find_last_seq_num(ctx
->ptr
);
239 dev_dbg(ctx
->priv
->adapter
->dev
, "info: flush data %d\n", start_win
);
240 mwifiex_11n_dispatch_pkt(ctx
->priv
, ctx
->ptr
,
241 (ctx
->ptr
->start_win
+ start_win
+ 1) &
242 (MAX_TID_VALUE
- 1));
246 * This function creates an entry in Rx reordering table for the
249 * The function also initializes the entry with sequence number, window
250 * size as well as initializes the timer.
252 * If the received TA/TID pair is already present, all the packets are
253 * dispatched and the window size is moved until the SSN.
256 mwifiex_11n_create_rx_reorder_tbl(struct mwifiex_private
*priv
, u8
*ta
,
257 int tid
, int win_size
, int seq_num
)
260 struct mwifiex_rx_reorder_tbl
*tbl
, *new_node
;
263 struct mwifiex_sta_node
*node
;
266 * If we get a TID, ta pair which is already present dispatch all the
267 * the packets and move the window size until the ssn
269 tbl
= mwifiex_11n_get_rx_reorder_tbl(priv
, tid
, ta
);
271 mwifiex_11n_dispatch_pkt(priv
, tbl
, seq_num
);
274 /* if !tbl then create one */
275 new_node
= kzalloc(sizeof(struct mwifiex_rx_reorder_tbl
), GFP_KERNEL
);
277 dev_err(priv
->adapter
->dev
, "%s: failed to alloc new_node\n",
282 INIT_LIST_HEAD(&new_node
->list
);
284 memcpy(new_node
->ta
, ta
, ETH_ALEN
);
285 new_node
->start_win
= seq_num
;
287 if (mwifiex_queuing_ra_based(priv
)) {
288 dev_dbg(priv
->adapter
->dev
,
289 "info: AP/ADHOC:last_seq=%d start_win=%d\n",
290 last_seq
, new_node
->start_win
);
291 if (priv
->bss_role
== MWIFIEX_BSS_ROLE_UAP
) {
292 node
= mwifiex_get_sta_entry(priv
, ta
);
294 last_seq
= node
->rx_seq
[tid
];
297 last_seq
= priv
->rx_seq
[tid
];
300 if (last_seq
!= MWIFIEX_DEF_11N_RX_SEQ_NUM
&&
301 last_seq
>= new_node
->start_win
)
302 new_node
->start_win
= last_seq
+ 1;
304 new_node
->win_size
= win_size
;
306 new_node
->rx_reorder_ptr
= kzalloc(sizeof(void *) * win_size
,
308 if (!new_node
->rx_reorder_ptr
) {
309 kfree((u8
*) new_node
);
310 dev_err(priv
->adapter
->dev
,
311 "%s: failed to alloc reorder_ptr\n", __func__
);
315 new_node
->timer_context
.ptr
= new_node
;
316 new_node
->timer_context
.priv
= priv
;
318 init_timer(&new_node
->timer_context
.timer
);
319 new_node
->timer_context
.timer
.function
= mwifiex_flush_data
;
320 new_node
->timer_context
.timer
.data
=
321 (unsigned long) &new_node
->timer_context
;
323 for (i
= 0; i
< win_size
; ++i
)
324 new_node
->rx_reorder_ptr
[i
] = NULL
;
326 spin_lock_irqsave(&priv
->rx_reorder_tbl_lock
, flags
);
327 list_add_tail(&new_node
->list
, &priv
->rx_reorder_tbl_ptr
);
328 spin_unlock_irqrestore(&priv
->rx_reorder_tbl_lock
, flags
);
332 * This function prepares command for adding a BA request.
334 * Preparation includes -
335 * - Setting command ID and proper size
336 * - Setting add BA request buffer
337 * - Ensuring correct endian-ness
339 int mwifiex_cmd_11n_addba_req(struct host_cmd_ds_command
*cmd
, void *data_buf
)
341 struct host_cmd_ds_11n_addba_req
*add_ba_req
= &cmd
->params
.add_ba_req
;
343 cmd
->command
= cpu_to_le16(HostCmd_CMD_11N_ADDBA_REQ
);
344 cmd
->size
= cpu_to_le16(sizeof(*add_ba_req
) + S_DS_GEN
);
345 memcpy(add_ba_req
, data_buf
, sizeof(*add_ba_req
));
351 * This function prepares command for adding a BA response.
353 * Preparation includes -
354 * - Setting command ID and proper size
355 * - Setting add BA response buffer
356 * - Ensuring correct endian-ness
358 int mwifiex_cmd_11n_addba_rsp_gen(struct mwifiex_private
*priv
,
359 struct host_cmd_ds_command
*cmd
,
360 struct host_cmd_ds_11n_addba_req
363 struct host_cmd_ds_11n_addba_rsp
*add_ba_rsp
= &cmd
->params
.add_ba_rsp
;
366 uint16_t block_ack_param_set
;
368 cmd
->command
= cpu_to_le16(HostCmd_CMD_11N_ADDBA_RSP
);
369 cmd
->size
= cpu_to_le16(sizeof(*add_ba_rsp
) + S_DS_GEN
);
371 memcpy(add_ba_rsp
->peer_mac_addr
, cmd_addba_req
->peer_mac_addr
,
373 add_ba_rsp
->dialog_token
= cmd_addba_req
->dialog_token
;
374 add_ba_rsp
->block_ack_tmo
= cmd_addba_req
->block_ack_tmo
;
375 add_ba_rsp
->ssn
= cmd_addba_req
->ssn
;
377 block_ack_param_set
= le16_to_cpu(cmd_addba_req
->block_ack_param_set
);
378 tid
= (block_ack_param_set
& IEEE80211_ADDBA_PARAM_TID_MASK
)
379 >> BLOCKACKPARAM_TID_POS
;
380 add_ba_rsp
->status_code
= cpu_to_le16(ADDBA_RSP_STATUS_ACCEPT
);
381 block_ack_param_set
&= ~IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK
;
382 /* We donot support AMSDU inside AMPDU, hence reset the bit */
383 block_ack_param_set
&= ~BLOCKACKPARAM_AMSDU_SUPP_MASK
;
384 block_ack_param_set
|= (priv
->add_ba_param
.rx_win_size
<<
385 BLOCKACKPARAM_WINSIZE_POS
);
386 add_ba_rsp
->block_ack_param_set
= cpu_to_le16(block_ack_param_set
);
387 win_size
= (le16_to_cpu(add_ba_rsp
->block_ack_param_set
)
388 & IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK
)
389 >> BLOCKACKPARAM_WINSIZE_POS
;
390 cmd_addba_req
->block_ack_param_set
= cpu_to_le16(block_ack_param_set
);
392 mwifiex_11n_create_rx_reorder_tbl(priv
, cmd_addba_req
->peer_mac_addr
,
394 le16_to_cpu(cmd_addba_req
->ssn
));
399 * This function prepares command for deleting a BA request.
401 * Preparation includes -
402 * - Setting command ID and proper size
403 * - Setting del BA request buffer
404 * - Ensuring correct endian-ness
406 int mwifiex_cmd_11n_delba(struct host_cmd_ds_command
*cmd
, void *data_buf
)
408 struct host_cmd_ds_11n_delba
*del_ba
= &cmd
->params
.del_ba
;
410 cmd
->command
= cpu_to_le16(HostCmd_CMD_11N_DELBA
);
411 cmd
->size
= cpu_to_le16(sizeof(*del_ba
) + S_DS_GEN
);
412 memcpy(del_ba
, data_buf
, sizeof(*del_ba
));
418 * This function identifies if Rx reordering is needed for a received packet.
420 * In case reordering is required, the function will do the reordering
421 * before sending it to kernel.
423 * The Rx reorder table is checked first with the received TID/TA pair. If
424 * not found, the received packet is dispatched immediately. But if found,
425 * the packet is reordered and all the packets in the updated Rx reordering
426 * table is dispatched until a hole is found.
428 * For sequence number less than the starting window, the packet is dropped.
430 int mwifiex_11n_rx_reorder_pkt(struct mwifiex_private
*priv
,
431 u16 seq_num
, u16 tid
,
432 u8
*ta
, u8 pkt_type
, void *payload
)
434 struct mwifiex_rx_reorder_tbl
*tbl
;
435 int start_win
, end_win
, win_size
;
438 tbl
= mwifiex_11n_get_rx_reorder_tbl(priv
, tid
, ta
);
440 if (pkt_type
!= PKT_TYPE_BAR
) {
441 if (priv
->bss_role
== MWIFIEX_BSS_ROLE_UAP
)
442 mwifiex_handle_uap_rx_forward(priv
, payload
);
444 mwifiex_process_rx_packet(priv
->adapter
,
449 start_win
= tbl
->start_win
;
450 win_size
= tbl
->win_size
;
451 end_win
= ((start_win
+ win_size
) - 1) & (MAX_TID_VALUE
- 1);
452 del_timer(&tbl
->timer_context
.timer
);
453 mod_timer(&tbl
->timer_context
.timer
,
454 jiffies
+ (MIN_FLUSH_TIMER_MS
* win_size
* HZ
) / 1000);
457 * If seq_num is less then starting win then ignore and drop the
460 if ((start_win
+ TWOPOW11
) > (MAX_TID_VALUE
- 1)) {/* Wrap */
461 if (seq_num
>= ((start_win
+ TWOPOW11
) &
462 (MAX_TID_VALUE
- 1)) && (seq_num
< start_win
))
464 } else if ((seq_num
< start_win
) ||
465 (seq_num
> (start_win
+ TWOPOW11
))) {
470 * If this packet is a BAR we adjust seq_num as
473 if (pkt_type
== PKT_TYPE_BAR
)
474 seq_num
= ((seq_num
+ win_size
) - 1) & (MAX_TID_VALUE
- 1);
476 if (((end_win
< start_win
) &&
477 (seq_num
< (TWOPOW11
- (MAX_TID_VALUE
- start_win
))) &&
478 (seq_num
> end_win
)) ||
479 ((end_win
> start_win
) && ((seq_num
> end_win
) ||
480 (seq_num
< start_win
)))) {
482 if (((seq_num
- win_size
) + 1) >= 0)
483 start_win
= (end_win
- win_size
) + 1;
485 start_win
= (MAX_TID_VALUE
- (win_size
- seq_num
)) + 1;
486 mwifiex_11n_dispatch_pkt(priv
, tbl
, start_win
);
489 if (pkt_type
!= PKT_TYPE_BAR
) {
490 if (seq_num
>= start_win
)
491 pkt_index
= seq_num
- start_win
;
493 pkt_index
= (seq_num
+MAX_TID_VALUE
) - start_win
;
495 if (tbl
->rx_reorder_ptr
[pkt_index
])
498 tbl
->rx_reorder_ptr
[pkt_index
] = payload
;
502 * Dispatch all packets sequentially from start_win until a
503 * hole is found and adjust the start_win appropriately
505 mwifiex_11n_scan_and_dispatch(priv
, tbl
);
511 * This function deletes an entry for a given TID/TA pair.
513 * The TID/TA are taken from del BA event body.
516 mwifiex_del_ba_tbl(struct mwifiex_private
*priv
, int tid
, u8
*peer_mac
,
517 u8 type
, int initiator
)
519 struct mwifiex_rx_reorder_tbl
*tbl
;
520 struct mwifiex_tx_ba_stream_tbl
*ptx_tbl
;
521 u8 cleanup_rx_reorder_tbl
;
524 if (type
== TYPE_DELBA_RECEIVE
)
525 cleanup_rx_reorder_tbl
= (initiator
) ? true : false;
527 cleanup_rx_reorder_tbl
= (initiator
) ? false : true;
529 dev_dbg(priv
->adapter
->dev
, "event: DELBA: %pM tid=%d initiator=%d\n",
530 peer_mac
, tid
, initiator
);
532 if (cleanup_rx_reorder_tbl
) {
533 tbl
= mwifiex_11n_get_rx_reorder_tbl(priv
, tid
,
536 dev_dbg(priv
->adapter
->dev
,
537 "event: TID, TA not found in table\n");
540 mwifiex_del_rx_reorder_entry(priv
, tbl
);
542 ptx_tbl
= mwifiex_get_ba_tbl(priv
, tid
, peer_mac
);
544 dev_dbg(priv
->adapter
->dev
,
545 "event: TID, RA not found in table\n");
549 spin_lock_irqsave(&priv
->tx_ba_stream_tbl_lock
, flags
);
550 mwifiex_11n_delete_tx_ba_stream_tbl_entry(priv
, ptx_tbl
);
551 spin_unlock_irqrestore(&priv
->tx_ba_stream_tbl_lock
, flags
);
556 * This function handles the command response of an add BA response.
558 * Handling includes changing the header fields into CPU format and
559 * creating the stream, provided the add BA is accepted.
561 int mwifiex_ret_11n_addba_resp(struct mwifiex_private
*priv
,
562 struct host_cmd_ds_command
*resp
)
564 struct host_cmd_ds_11n_addba_rsp
*add_ba_rsp
= &resp
->params
.add_ba_rsp
;
566 struct mwifiex_rx_reorder_tbl
*tbl
;
567 uint16_t block_ack_param_set
;
569 block_ack_param_set
= le16_to_cpu(add_ba_rsp
->block_ack_param_set
);
571 tid
= (block_ack_param_set
& IEEE80211_ADDBA_PARAM_TID_MASK
)
572 >> BLOCKACKPARAM_TID_POS
;
574 * Check if we had rejected the ADDBA, if yes then do not create
577 if (le16_to_cpu(add_ba_rsp
->status_code
) == BA_RESULT_SUCCESS
) {
578 win_size
= (block_ack_param_set
&
579 IEEE80211_ADDBA_PARAM_BUF_SIZE_MASK
)
580 >> BLOCKACKPARAM_WINSIZE_POS
;
582 dev_dbg(priv
->adapter
->dev
,
583 "cmd: ADDBA RSP: %pM tid=%d ssn=%d win_size=%d\n",
584 add_ba_rsp
->peer_mac_addr
, tid
,
585 add_ba_rsp
->ssn
, win_size
);
587 dev_err(priv
->adapter
->dev
, "ADDBA RSP: failed %pM tid=%d)\n",
588 add_ba_rsp
->peer_mac_addr
, tid
);
590 tbl
= mwifiex_11n_get_rx_reorder_tbl(priv
, tid
,
591 add_ba_rsp
->peer_mac_addr
);
593 mwifiex_del_rx_reorder_entry(priv
, tbl
);
600 * This function handles BA stream timeout event by preparing and sending
601 * a command to the firmware.
603 void mwifiex_11n_ba_stream_timeout(struct mwifiex_private
*priv
,
604 struct host_cmd_ds_11n_batimeout
*event
)
606 struct host_cmd_ds_11n_delba delba
;
608 memset(&delba
, 0, sizeof(struct host_cmd_ds_11n_delba
));
609 memcpy(delba
.peer_mac_addr
, event
->peer_mac_addr
, ETH_ALEN
);
611 delba
.del_ba_param_set
|=
612 cpu_to_le16((u16
) event
->tid
<< DELBA_TID_POS
);
613 delba
.del_ba_param_set
|= cpu_to_le16(
614 (u16
) event
->origninator
<< DELBA_INITIATOR_POS
);
615 delba
.reason_code
= cpu_to_le16(WLAN_REASON_QSTA_TIMEOUT
);
616 mwifiex_send_cmd_async(priv
, HostCmd_CMD_11N_DELBA
, 0, 0, &delba
);
620 * This function cleans up the Rx reorder table by deleting all the entries
621 * and re-initializing.
623 void mwifiex_11n_cleanup_reorder_tbl(struct mwifiex_private
*priv
)
625 struct mwifiex_rx_reorder_tbl
*del_tbl_ptr
, *tmp_node
;
628 spin_lock_irqsave(&priv
->rx_reorder_tbl_lock
, flags
);
629 list_for_each_entry_safe(del_tbl_ptr
, tmp_node
,
630 &priv
->rx_reorder_tbl_ptr
, list
) {
631 spin_unlock_irqrestore(&priv
->rx_reorder_tbl_lock
, flags
);
632 mwifiex_del_rx_reorder_entry(priv
, del_tbl_ptr
);
633 spin_lock_irqsave(&priv
->rx_reorder_tbl_lock
, flags
);
635 spin_unlock_irqrestore(&priv
->rx_reorder_tbl_lock
, flags
);
637 INIT_LIST_HEAD(&priv
->rx_reorder_tbl_ptr
);
638 mwifiex_reset_11n_rx_seq_num(priv
);