1 /******************************************************************************
3 * Copyright(c) 2003 - 2013 Intel Corporation. All rights reserved.
5 * Portions of this file are derived from the ipw3945 project, as well
6 * as portions of the ieee80211 subsystem header files.
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of version 2 of the GNU General Public License as
10 * published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 * You should have received a copy of the GNU General Public License along with
18 * this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
21 * The full GNU General Public License is included in this distribution in the
22 * file called LICENSE.
24 * Contact Information:
25 * Intel Linux Wireless <ilw@linux.intel.com>
26 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
28 *****************************************************************************/
29 #include <linux/sched.h>
30 #include <linux/wait.h>
31 #include <linux/gfp.h>
36 #include "iwl-op-mode.h"
38 /******************************************************************************
42 ******************************************************************************/
45 * Rx theory of operation
47 * Driver allocates a circular buffer of Receive Buffer Descriptors (RBDs),
48 * each of which point to Receive Buffers to be filled by the NIC. These get
49 * used not only for Rx frames, but for any command response or notification
50 * from the NIC. The driver and NIC manage the Rx buffers by means
51 * of indexes into the circular buffer.
54 * The host/firmware share two index registers for managing the Rx buffers.
56 * The READ index maps to the first position that the firmware may be writing
57 * to -- the driver can read up to (but not including) this position and get
59 * The READ index is managed by the firmware once the card is enabled.
61 * The WRITE index maps to the last position the driver has read from -- the
62 * position preceding WRITE is the last slot the firmware can place a packet.
64 * The queue is empty (no good data) if WRITE = READ - 1, and is full if
67 * During initialization, the host sets up the READ queue position to the first
68 * INDEX position, and WRITE to the last (READ - 1 wrapped)
70 * When the firmware places a packet in a buffer, it will advance the READ index
71 * and fire the RX interrupt. The driver can then query the READ index and
72 * process as many packets as possible, moving the WRITE index forward as it
73 * resets the Rx queue buffers with new memory.
75 * The management in the driver is as follows:
76 * + A list of pre-allocated SKBs is stored in iwl->rxq->rx_free. When
77 * iwl->rxq->free_count drops to or below RX_LOW_WATERMARK, work is scheduled
78 * to replenish the iwl->rxq->rx_free.
79 * + In iwl_pcie_rx_replenish (scheduled) if 'processed' != 'read' then the
80 * iwl->rxq is replenished and the READ INDEX is updated (updating the
81 * 'processed' and 'read' driver indexes as well)
82 * + A received packet is processed and handed to the kernel network stack,
83 * detached from the iwl->rxq. The driver 'processed' index is updated.
84 * + The Host/Firmware iwl->rxq is replenished at irq thread time from the
85 * rx_free list. If there are no allocated buffers in iwl->rxq->rx_free,
86 * the READ INDEX is not incremented and iwl->status(RX_STALLED) is set.
87 * If there were enough free buffers and RX_STALLED is set it is cleared.
92 * iwl_rxq_alloc() Allocates rx_free
93 * iwl_pcie_rx_replenish() Replenishes rx_free list from rx_used, and calls
94 * iwl_pcie_rxq_restock
95 * iwl_pcie_rxq_restock() Moves available buffers from rx_free into Rx
96 * queue, updates firmware pointers, and updates
97 * the WRITE index. If insufficient rx_free buffers
98 * are available, schedules iwl_pcie_rx_replenish
100 * -- enable interrupts --
101 * ISR - iwl_rx() Detach iwl_rx_mem_buffers from pool up to the
102 * READ INDEX, detaching the SKB from the pool.
103 * Moves the packet buffer from queue to rx_used.
104 * Calls iwl_pcie_rxq_restock to refill any empty
111 * iwl_rxq_space - Return number of free slots available in queue.
113 static int iwl_rxq_space(const struct iwl_rxq *q)
115 int s = q->read - q->write;
118 /* keep some buffer to not confuse full and empty queue */
126 * iwl_dma_addr2rbd_ptr - convert a DMA address to a uCode read buffer ptr
128 static inline __le32 iwl_pcie_dma_addr2rbd_ptr(dma_addr_t dma_addr)
130 return cpu_to_le32((u32)(dma_addr >> 8));
134 * iwl_pcie_rx_stop - stops the Rx DMA
136 int iwl_pcie_rx_stop(struct iwl_trans *trans)
138 iwl_write_direct32(trans, FH_MEM_RCSR_CHNL0_CONFIG_REG, 0);
139 return iwl_poll_direct_bit(trans, FH_MEM_RSSR_RX_STATUS_REG,
140 FH_RSSR_CHNL0_RX_STATUS_CHNL_IDLE, 1000);
144 * iwl_pcie_rxq_inc_wr_ptr - Update the write pointer for the RX queue
146 static void iwl_pcie_rxq_inc_wr_ptr(struct iwl_trans *trans, struct iwl_rxq *q)
151 spin_lock_irqsave(&q->lock, flags);
153 if (q->need_update == 0)
156 if (trans->cfg->base_params->shadow_reg_enable) {
157 /* shadow register enabled */
158 /* Device expects a multiple of 8 */
159 q->write_actual = (q->write & ~0x7);
160 iwl_write32(trans, FH_RSCSR_CHNL0_WPTR, q->write_actual);
162 struct iwl_trans_pcie *trans_pcie =
163 IWL_TRANS_GET_PCIE_TRANS(trans);
165 /* If power-saving is in use, make sure device is awake */
166 if (test_bit(STATUS_TPOWER_PMI, &trans_pcie->status)) {
167 reg = iwl_read32(trans, CSR_UCODE_DRV_GP1);
169 if (reg & CSR_UCODE_DRV_GP1_BIT_MAC_SLEEP) {
170 IWL_DEBUG_INFO(trans,
171 "Rx queue requesting wakeup,"
172 " GP1 = 0x%x\n", reg);
173 iwl_set_bit(trans, CSR_GP_CNTRL,
174 CSR_GP_CNTRL_REG_FLAG_MAC_ACCESS_REQ);
178 q->write_actual = (q->write & ~0x7);
179 iwl_write_direct32(trans, FH_RSCSR_CHNL0_WPTR,
182 /* Else device is assumed to be awake */
184 /* Device expects a multiple of 8 */
185 q->write_actual = (q->write & ~0x7);
186 iwl_write_direct32(trans, FH_RSCSR_CHNL0_WPTR,
193 spin_unlock_irqrestore(&q->lock, flags);
197 * iwl_pcie_rxq_restock - refill RX queue from pre-allocated pool
199 * If there are slots in the RX queue that need to be restocked,
200 * and we have free pre-allocated buffers, fill the ranks as much
201 * as we can, pulling from rx_free.
203 * This moves the 'write' index forward to catch up with 'processed', and
204 * also updates the memory address in the firmware to reference the new
207 static void iwl_pcie_rxq_restock(struct iwl_trans *trans)
209 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
210 struct iwl_rxq *rxq = &trans_pcie->rxq;
211 struct iwl_rx_mem_buffer *rxb;
215 * If the device isn't enabled - not need to try to add buffers...
216 * This can happen when we stop the device and still have an interrupt
217 * pending. We stop the APM before we sync the interrupts because we
218 * have to (see comment there). On the other hand, since the APM is
219 * stopped, we cannot access the HW (in particular not prph).
220 * So don't try to restock if the APM has been already stopped.
222 if (!test_bit(STATUS_DEVICE_ENABLED, &trans_pcie->status))
225 spin_lock_irqsave(&rxq->lock, flags);
226 while ((iwl_rxq_space(rxq) > 0) && (rxq->free_count)) {
227 /* The overwritten rxb must be a used one */
228 rxb = rxq->queue[rxq->write];
229 BUG_ON(rxb && rxb->page);
231 /* Get next free Rx buffer, remove from free list */
232 rxb = list_first_entry(&rxq->rx_free, struct iwl_rx_mem_buffer,
234 list_del(&rxb->list);
236 /* Point to Rx buffer via next RBD in circular buffer */
237 rxq->bd[rxq->write] = iwl_pcie_dma_addr2rbd_ptr(rxb->page_dma);
238 rxq->queue[rxq->write] = rxb;
239 rxq->write = (rxq->write + 1) & RX_QUEUE_MASK;
242 spin_unlock_irqrestore(&rxq->lock, flags);
243 /* If the pre-allocated buffer pool is dropping low, schedule to
245 if (rxq->free_count <= RX_LOW_WATERMARK)
246 schedule_work(&trans_pcie->rx_replenish);
248 /* If we've added more space for the firmware to place data, tell it.
249 * Increment device's write pointer in multiples of 8. */
250 if (rxq->write_actual != (rxq->write & ~0x7)) {
251 spin_lock_irqsave(&rxq->lock, flags);
252 rxq->need_update = 1;
253 spin_unlock_irqrestore(&rxq->lock, flags);
254 iwl_pcie_rxq_inc_wr_ptr(trans, rxq);
259 * iwl_pcie_rxq_alloc_rbs - allocate a page for each used RBD
261 * A used RBD is an Rx buffer that has been given to the stack. To use it again
262 * a page must be allocated and the RBD must point to the page. This function
263 * doesn't change the HW pointer but handles the list of pages that is used by
264 * iwl_pcie_rxq_restock. The latter function will update the HW to use the newly
267 static void iwl_pcie_rxq_alloc_rbs(struct iwl_trans *trans, gfp_t priority)
269 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
270 struct iwl_rxq *rxq = &trans_pcie->rxq;
271 struct iwl_rx_mem_buffer *rxb;
274 gfp_t gfp_mask = priority;
277 spin_lock_irqsave(&rxq->lock, flags);
278 if (list_empty(&rxq->rx_used)) {
279 spin_unlock_irqrestore(&rxq->lock, flags);
282 spin_unlock_irqrestore(&rxq->lock, flags);
284 if (rxq->free_count > RX_LOW_WATERMARK)
285 gfp_mask |= __GFP_NOWARN;
287 if (trans_pcie->rx_page_order > 0)
288 gfp_mask |= __GFP_COMP;
290 /* Alloc a new receive buffer */
291 page = alloc_pages(gfp_mask, trans_pcie->rx_page_order);
294 IWL_DEBUG_INFO(trans, "alloc_pages failed, "
296 trans_pcie->rx_page_order);
298 if ((rxq->free_count <= RX_LOW_WATERMARK) &&
300 IWL_CRIT(trans, "Failed to alloc_pages with %s."
301 "Only %u free buffers remaining.\n",
302 priority == GFP_ATOMIC ?
303 "GFP_ATOMIC" : "GFP_KERNEL",
305 /* We don't reschedule replenish work here -- we will
306 * call the restock method and if it still needs
307 * more buffers it will schedule replenish */
311 spin_lock_irqsave(&rxq->lock, flags);
313 if (list_empty(&rxq->rx_used)) {
314 spin_unlock_irqrestore(&rxq->lock, flags);
315 __free_pages(page, trans_pcie->rx_page_order);
318 rxb = list_first_entry(&rxq->rx_used, struct iwl_rx_mem_buffer,
320 list_del(&rxb->list);
321 spin_unlock_irqrestore(&rxq->lock, flags);
325 /* Get physical address of the RB */
327 dma_map_page(trans->dev, page, 0,
328 PAGE_SIZE << trans_pcie->rx_page_order,
330 if (dma_mapping_error(trans->dev, rxb->page_dma)) {
332 spin_lock_irqsave(&rxq->lock, flags);
333 list_add(&rxb->list, &rxq->rx_used);
334 spin_unlock_irqrestore(&rxq->lock, flags);
335 __free_pages(page, trans_pcie->rx_page_order);
338 /* dma address must be no more than 36 bits */
339 BUG_ON(rxb->page_dma & ~DMA_BIT_MASK(36));
340 /* and also 256 byte aligned! */
341 BUG_ON(rxb->page_dma & DMA_BIT_MASK(8));
343 spin_lock_irqsave(&rxq->lock, flags);
345 list_add_tail(&rxb->list, &rxq->rx_free);
348 spin_unlock_irqrestore(&rxq->lock, flags);
352 static void iwl_pcie_rxq_free_rbs(struct iwl_trans *trans)
354 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
355 struct iwl_rxq *rxq = &trans_pcie->rxq;
358 /* Fill the rx_used queue with _all_ of the Rx buffers */
359 for (i = 0; i < RX_FREE_BUFFERS + RX_QUEUE_SIZE; i++) {
360 /* In the reset function, these buffers may have been allocated
361 * to an SKB, so we need to unmap and free potential storage */
362 if (rxq->pool[i].page != NULL) {
363 dma_unmap_page(trans->dev, rxq->pool[i].page_dma,
364 PAGE_SIZE << trans_pcie->rx_page_order,
366 __free_pages(rxq->pool[i].page,
367 trans_pcie->rx_page_order);
368 rxq->pool[i].page = NULL;
370 list_add_tail(&rxq->pool[i].list, &rxq->rx_used);
375 * iwl_pcie_rx_replenish - Move all used buffers from rx_used to rx_free
377 * When moving to rx_free an page is allocated for the slot.
379 * Also restock the Rx queue via iwl_pcie_rxq_restock.
380 * This is called as a scheduled work item (except for during initialization)
382 static void iwl_pcie_rx_replenish(struct iwl_trans *trans)
384 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
387 iwl_pcie_rxq_alloc_rbs(trans, GFP_KERNEL);
389 spin_lock_irqsave(&trans_pcie->irq_lock, flags);
390 iwl_pcie_rxq_restock(trans);
391 spin_unlock_irqrestore(&trans_pcie->irq_lock, flags);
394 static void iwl_pcie_rx_replenish_now(struct iwl_trans *trans)
396 iwl_pcie_rxq_alloc_rbs(trans, GFP_ATOMIC);
398 iwl_pcie_rxq_restock(trans);
401 static void iwl_pcie_rx_replenish_work(struct work_struct *data)
403 struct iwl_trans_pcie *trans_pcie =
404 container_of(data, struct iwl_trans_pcie, rx_replenish);
406 iwl_pcie_rx_replenish(trans_pcie->trans);
409 static int iwl_pcie_rx_alloc(struct iwl_trans *trans)
411 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
412 struct iwl_rxq *rxq = &trans_pcie->rxq;
413 struct device *dev = trans->dev;
415 memset(&trans_pcie->rxq, 0, sizeof(trans_pcie->rxq));
417 spin_lock_init(&rxq->lock);
419 if (WARN_ON(rxq->bd || rxq->rb_stts))
422 /* Allocate the circular buffer of Read Buffer Descriptors (RBDs) */
423 rxq->bd = dma_zalloc_coherent(dev, sizeof(__le32) * RX_QUEUE_SIZE,
424 &rxq->bd_dma, GFP_KERNEL);
428 /*Allocate the driver's pointer to receive buffer status */
429 rxq->rb_stts = dma_zalloc_coherent(dev, sizeof(*rxq->rb_stts),
430 &rxq->rb_stts_dma, GFP_KERNEL);
437 dma_free_coherent(dev, sizeof(__le32) * RX_QUEUE_SIZE,
438 rxq->bd, rxq->bd_dma);
445 static void iwl_pcie_rx_hw_init(struct iwl_trans *trans, struct iwl_rxq *rxq)
447 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
449 const u32 rfdnlog = RX_QUEUE_SIZE_LOG; /* 256 RBDs */
451 if (trans_pcie->rx_buf_size_8k)
452 rb_size = FH_RCSR_RX_CONFIG_REG_VAL_RB_SIZE_8K;
454 rb_size = FH_RCSR_RX_CONFIG_REG_VAL_RB_SIZE_4K;
457 iwl_write_direct32(trans, FH_MEM_RCSR_CHNL0_CONFIG_REG, 0);
458 /* reset and flush pointers */
459 iwl_write_direct32(trans, FH_MEM_RCSR_CHNL0_RBDCB_WPTR, 0);
460 iwl_write_direct32(trans, FH_MEM_RCSR_CHNL0_FLUSH_RB_REQ, 0);
461 iwl_write_direct32(trans, FH_RSCSR_CHNL0_RDPTR, 0);
463 /* Reset driver's Rx queue write index */
464 iwl_write_direct32(trans, FH_RSCSR_CHNL0_RBDCB_WPTR_REG, 0);
466 /* Tell device where to find RBD circular buffer in DRAM */
467 iwl_write_direct32(trans, FH_RSCSR_CHNL0_RBDCB_BASE_REG,
468 (u32)(rxq->bd_dma >> 8));
470 /* Tell device where in DRAM to update its Rx status */
471 iwl_write_direct32(trans, FH_RSCSR_CHNL0_STTS_WPTR_REG,
472 rxq->rb_stts_dma >> 4);
475 * FH_RCSR_CHNL0_RX_IGNORE_RXF_EMPTY is set because of HW bug in
476 * the credit mechanism in 5000 HW RX FIFO
477 * Direct rx interrupts to hosts
478 * Rx buffer size 4 or 8k
482 iwl_write_direct32(trans, FH_MEM_RCSR_CHNL0_CONFIG_REG,
483 FH_RCSR_RX_CONFIG_CHNL_EN_ENABLE_VAL |
484 FH_RCSR_CHNL0_RX_IGNORE_RXF_EMPTY |
485 FH_RCSR_CHNL0_RX_CONFIG_IRQ_DEST_INT_HOST_VAL |
487 (RX_RB_TIMEOUT << FH_RCSR_RX_CONFIG_REG_IRQ_RBTH_POS)|
488 (rfdnlog << FH_RCSR_RX_CONFIG_RBDCB_SIZE_POS));
490 /* Set interrupt coalescing timer to default (2048 usecs) */
491 iwl_write8(trans, CSR_INT_COALESCING, IWL_HOST_INT_TIMEOUT_DEF);
494 int iwl_pcie_rx_init(struct iwl_trans *trans)
496 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
497 struct iwl_rxq *rxq = &trans_pcie->rxq;
502 err = iwl_pcie_rx_alloc(trans);
507 spin_lock_irqsave(&rxq->lock, flags);
508 INIT_LIST_HEAD(&rxq->rx_free);
509 INIT_LIST_HEAD(&rxq->rx_used);
511 INIT_WORK(&trans_pcie->rx_replenish,
512 iwl_pcie_rx_replenish_work);
514 iwl_pcie_rxq_free_rbs(trans);
516 for (i = 0; i < RX_QUEUE_SIZE; i++)
517 rxq->queue[i] = NULL;
519 /* Set us so that we have processed and used all buffers, but have
520 * not restocked the Rx queue with fresh buffers */
521 rxq->read = rxq->write = 0;
522 rxq->write_actual = 0;
524 memset(rxq->rb_stts, 0, sizeof(*rxq->rb_stts));
525 spin_unlock_irqrestore(&rxq->lock, flags);
527 iwl_pcie_rx_replenish(trans);
529 iwl_pcie_rx_hw_init(trans, rxq);
531 spin_lock_irqsave(&trans_pcie->irq_lock, flags);
532 rxq->need_update = 1;
533 iwl_pcie_rxq_inc_wr_ptr(trans, rxq);
534 spin_unlock_irqrestore(&trans_pcie->irq_lock, flags);
539 void iwl_pcie_rx_free(struct iwl_trans *trans)
541 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
542 struct iwl_rxq *rxq = &trans_pcie->rxq;
545 /*if rxq->bd is NULL, it means that nothing has been allocated,
548 IWL_DEBUG_INFO(trans, "Free NULL rx context\n");
552 cancel_work_sync(&trans_pcie->rx_replenish);
554 spin_lock_irqsave(&rxq->lock, flags);
555 iwl_pcie_rxq_free_rbs(trans);
556 spin_unlock_irqrestore(&rxq->lock, flags);
558 dma_free_coherent(trans->dev, sizeof(__le32) * RX_QUEUE_SIZE,
559 rxq->bd, rxq->bd_dma);
564 dma_free_coherent(trans->dev,
565 sizeof(struct iwl_rb_status),
566 rxq->rb_stts, rxq->rb_stts_dma);
568 IWL_DEBUG_INFO(trans, "Free rxq->rb_stts which is NULL\n");
569 rxq->rb_stts_dma = 0;
573 static void iwl_pcie_rx_handle_rb(struct iwl_trans *trans,
574 struct iwl_rx_mem_buffer *rxb)
576 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
577 struct iwl_rxq *rxq = &trans_pcie->rxq;
578 struct iwl_txq *txq = &trans_pcie->txq[trans_pcie->cmd_queue];
580 bool page_stolen = false;
581 int max_len = PAGE_SIZE << trans_pcie->rx_page_order;
587 dma_unmap_page(trans->dev, rxb->page_dma, max_len, DMA_FROM_DEVICE);
589 while (offset + sizeof(u32) + sizeof(struct iwl_cmd_header) < max_len) {
590 struct iwl_rx_packet *pkt;
591 struct iwl_device_cmd *cmd;
594 int index, cmd_index, err, len;
595 struct iwl_rx_cmd_buffer rxcb = {
597 ._rx_page_order = trans_pcie->rx_page_order,
599 ._page_stolen = false,
603 pkt = rxb_addr(&rxcb);
605 if (pkt->len_n_flags == cpu_to_le32(FH_RSCSR_FRAME_INVALID))
608 IWL_DEBUG_RX(trans, "cmd at offset %d: %s (0x%.2x)\n",
609 rxcb._offset, get_cmd_string(trans_pcie, pkt->hdr.cmd),
612 len = le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK;
613 len += sizeof(u32); /* account for status word */
614 trace_iwlwifi_dev_rx(trans->dev, trans, pkt, len);
615 trace_iwlwifi_dev_rx_data(trans->dev, trans, pkt, len);
617 /* Reclaim a command buffer only if this packet is a response
618 * to a (driver-originated) command.
619 * If the packet (e.g. Rx frame) originated from uCode,
620 * there is no command buffer to reclaim.
621 * Ucode should set SEQ_RX_FRAME bit if ucode-originated,
622 * but apparently a few don't get set; catch them here. */
623 reclaim = !(pkt->hdr.sequence & SEQ_RX_FRAME);
627 for (i = 0; i < trans_pcie->n_no_reclaim_cmds; i++) {
628 if (trans_pcie->no_reclaim_cmds[i] ==
636 sequence = le16_to_cpu(pkt->hdr.sequence);
637 index = SEQ_TO_INDEX(sequence);
638 cmd_index = get_cmd_index(&txq->q, index);
641 struct iwl_pcie_txq_entry *ent;
642 ent = &txq->entries[cmd_index];
644 WARN_ON_ONCE(!cmd && ent->meta.flags & CMD_WANT_HCMD);
649 err = iwl_op_mode_rx(trans->op_mode, &rxcb, cmd);
652 /* The original command isn't needed any more */
653 kfree(txq->entries[cmd_index].copy_cmd);
654 txq->entries[cmd_index].copy_cmd = NULL;
655 /* nor is the duplicated part of the command */
656 kfree(txq->entries[cmd_index].free_buf);
657 txq->entries[cmd_index].free_buf = NULL;
661 * After here, we should always check rxcb._page_stolen,
662 * if it is true then one of the handlers took the page.
666 /* Invoke any callbacks, transfer the buffer to caller,
667 * and fire off the (possibly) blocking
668 * iwl_trans_send_cmd()
669 * as we reclaim the driver command queue */
670 if (!rxcb._page_stolen)
671 iwl_pcie_hcmd_complete(trans, &rxcb, err);
673 IWL_WARN(trans, "Claim null rxb?\n");
676 page_stolen |= rxcb._page_stolen;
677 offset += ALIGN(len, FH_RSCSR_FRAME_ALIGN);
680 /* page was stolen from us -- free our reference */
682 __free_pages(rxb->page, trans_pcie->rx_page_order);
686 /* Reuse the page if possible. For notification packets and
687 * SKBs that fail to Rx correctly, add them back into the
688 * rx_free list for reuse later. */
689 spin_lock_irqsave(&rxq->lock, flags);
690 if (rxb->page != NULL) {
692 dma_map_page(trans->dev, rxb->page, 0,
693 PAGE_SIZE << trans_pcie->rx_page_order,
695 if (dma_mapping_error(trans->dev, rxb->page_dma)) {
697 * free the page(s) as well to not break
698 * the invariant that the items on the used
699 * list have no page(s)
701 __free_pages(rxb->page, trans_pcie->rx_page_order);
703 list_add_tail(&rxb->list, &rxq->rx_used);
705 list_add_tail(&rxb->list, &rxq->rx_free);
709 list_add_tail(&rxb->list, &rxq->rx_used);
710 spin_unlock_irqrestore(&rxq->lock, flags);
714 * iwl_pcie_rx_handle - Main entry function for receiving responses from fw
716 static void iwl_pcie_rx_handle(struct iwl_trans *trans)
718 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
719 struct iwl_rxq *rxq = &trans_pcie->rxq;
725 /* uCode's read index (stored in shared DRAM) indicates the last Rx
726 * buffer that the driver may process (last buffer filled by ucode). */
727 r = le16_to_cpu(ACCESS_ONCE(rxq->rb_stts->closed_rb_num)) & 0x0FFF;
730 /* Rx interrupt, but nothing sent from uCode */
732 IWL_DEBUG_RX(trans, "HW = SW = %d\n", r);
734 /* calculate total frames need to be restock after handling RX */
735 total_empty = r - rxq->write_actual;
737 total_empty += RX_QUEUE_SIZE;
739 if (total_empty > (RX_QUEUE_SIZE / 2))
743 struct iwl_rx_mem_buffer *rxb;
746 rxq->queue[i] = NULL;
748 IWL_DEBUG_RX(trans, "rxbuf: HW = %d, SW = %d (%p)\n",
750 iwl_pcie_rx_handle_rb(trans, rxb);
752 i = (i + 1) & RX_QUEUE_MASK;
753 /* If there are a lot of unused frames,
754 * restock the Rx queue so ucode wont assert. */
759 iwl_pcie_rx_replenish_now(trans);
765 /* Backtrack one entry */
768 iwl_pcie_rx_replenish_now(trans);
770 iwl_pcie_rxq_restock(trans);
774 * iwl_pcie_irq_handle_error - called for HW or SW error interrupt from card
776 static void iwl_pcie_irq_handle_error(struct iwl_trans *trans)
778 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
780 /* W/A for WiFi/WiMAX coex and WiMAX own the RF */
781 if (trans->cfg->internal_wimax_coex &&
782 (!(iwl_read_prph(trans, APMG_CLK_CTRL_REG) &
783 APMS_CLK_VAL_MRB_FUNC_MODE) ||
784 (iwl_read_prph(trans, APMG_PS_CTRL_REG) &
785 APMG_PS_CTRL_VAL_RESET_REQ))) {
786 clear_bit(STATUS_HCMD_ACTIVE, &trans_pcie->status);
787 iwl_op_mode_wimax_active(trans->op_mode);
788 wake_up(&trans_pcie->wait_command_queue);
792 iwl_pcie_dump_csr(trans);
793 iwl_pcie_dump_fh(trans, NULL);
795 set_bit(STATUS_FW_ERROR, &trans_pcie->status);
796 clear_bit(STATUS_HCMD_ACTIVE, &trans_pcie->status);
797 wake_up(&trans_pcie->wait_command_queue);
800 iwl_op_mode_nic_error(trans->op_mode);
804 irqreturn_t iwl_pcie_irq_handler(int irq, void *dev_id)
806 struct iwl_trans *trans = dev_id;
807 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
808 struct isr_statistics *isr_stats = &trans_pcie->isr_stats;
813 #ifdef CONFIG_IWLWIFI_DEBUG
817 lock_map_acquire(&trans->sync_cmd_lockdep_map);
819 spin_lock_irqsave(&trans_pcie->irq_lock, flags);
821 /* Ack/clear/reset pending uCode interrupts.
822 * Note: Some bits in CSR_INT are "OR" of bits in CSR_FH_INT_STATUS,
824 /* There is a hardware bug in the interrupt mask function that some
825 * interrupts (i.e. CSR_INT_BIT_SCD) can still be generated even if
826 * they are disabled in the CSR_INT_MASK register. Furthermore the
827 * ICT interrupt handling mechanism has another bug that might cause
828 * these unmasked interrupts fail to be detected. We workaround the
829 * hardware bugs here by ACKing all the possible interrupts so that
830 * interrupt coalescing can still be achieved.
832 iwl_write32(trans, CSR_INT,
833 trans_pcie->inta | ~trans_pcie->inta_mask);
835 inta = trans_pcie->inta;
837 #ifdef CONFIG_IWLWIFI_DEBUG
838 if (iwl_have_debug_level(IWL_DL_ISR)) {
840 inta_mask = iwl_read32(trans, CSR_INT_MASK);
841 IWL_DEBUG_ISR(trans, "inta 0x%08x, enabled 0x%08x\n",
846 /* saved interrupt in inta variable now we can reset trans_pcie->inta */
847 trans_pcie->inta = 0;
849 spin_unlock_irqrestore(&trans_pcie->irq_lock, flags);
851 /* Now service all interrupt bits discovered above. */
852 if (inta & CSR_INT_BIT_HW_ERR) {
853 IWL_ERR(trans, "Hardware error detected. Restarting.\n");
855 /* Tell the device to stop sending interrupts */
856 iwl_disable_interrupts(trans);
859 iwl_pcie_irq_handle_error(trans);
861 handled |= CSR_INT_BIT_HW_ERR;
866 #ifdef CONFIG_IWLWIFI_DEBUG
867 if (iwl_have_debug_level(IWL_DL_ISR)) {
868 /* NIC fires this, but we don't use it, redundant with WAKEUP */
869 if (inta & CSR_INT_BIT_SCD) {
870 IWL_DEBUG_ISR(trans, "Scheduler finished to transmit "
871 "the frame/frames.\n");
875 /* Alive notification via Rx interrupt will do the real work */
876 if (inta & CSR_INT_BIT_ALIVE) {
877 IWL_DEBUG_ISR(trans, "Alive interrupt\n");
882 /* Safely ignore these bits for debug checks below */
883 inta &= ~(CSR_INT_BIT_SCD | CSR_INT_BIT_ALIVE);
885 /* HW RF KILL switch toggled */
886 if (inta & CSR_INT_BIT_RF_KILL) {
889 hw_rfkill = iwl_is_rfkill_set(trans);
890 IWL_WARN(trans, "RF_KILL bit toggled to %s.\n",
891 hw_rfkill ? "disable radio" : "enable radio");
895 iwl_op_mode_hw_rf_kill(trans->op_mode, hw_rfkill);
897 set_bit(STATUS_RFKILL, &trans_pcie->status);
898 if (test_and_clear_bit(STATUS_HCMD_ACTIVE,
899 &trans_pcie->status))
900 IWL_DEBUG_RF_KILL(trans,
901 "Rfkill while SYNC HCMD in flight\n");
902 wake_up(&trans_pcie->wait_command_queue);
904 clear_bit(STATUS_RFKILL, &trans_pcie->status);
907 handled |= CSR_INT_BIT_RF_KILL;
910 /* Chip got too hot and stopped itself */
911 if (inta & CSR_INT_BIT_CT_KILL) {
912 IWL_ERR(trans, "Microcode CT kill error detected.\n");
914 handled |= CSR_INT_BIT_CT_KILL;
917 /* Error detected by uCode */
918 if (inta & CSR_INT_BIT_SW_ERR) {
919 IWL_ERR(trans, "Microcode SW error detected. "
920 " Restarting 0x%X.\n", inta);
922 iwl_pcie_irq_handle_error(trans);
923 handled |= CSR_INT_BIT_SW_ERR;
926 /* uCode wakes up after power-down sleep */
927 if (inta & CSR_INT_BIT_WAKEUP) {
928 IWL_DEBUG_ISR(trans, "Wakeup interrupt\n");
929 iwl_pcie_rxq_inc_wr_ptr(trans, &trans_pcie->rxq);
930 for (i = 0; i < trans->cfg->base_params->num_of_queues; i++)
931 iwl_pcie_txq_inc_wr_ptr(trans, &trans_pcie->txq[i]);
935 handled |= CSR_INT_BIT_WAKEUP;
938 /* All uCode command responses, including Tx command responses,
939 * Rx "responses" (frame-received notification), and other
940 * notifications from uCode come through here*/
941 if (inta & (CSR_INT_BIT_FH_RX | CSR_INT_BIT_SW_RX |
942 CSR_INT_BIT_RX_PERIODIC)) {
943 IWL_DEBUG_ISR(trans, "Rx interrupt\n");
944 if (inta & (CSR_INT_BIT_FH_RX | CSR_INT_BIT_SW_RX)) {
945 handled |= (CSR_INT_BIT_FH_RX | CSR_INT_BIT_SW_RX);
946 iwl_write32(trans, CSR_FH_INT_STATUS,
949 if (inta & CSR_INT_BIT_RX_PERIODIC) {
950 handled |= CSR_INT_BIT_RX_PERIODIC;
952 CSR_INT, CSR_INT_BIT_RX_PERIODIC);
954 /* Sending RX interrupt require many steps to be done in the
956 * 1- write interrupt to current index in ICT table.
958 * 3- update RX shared data to indicate last write index.
960 * This could lead to RX race, driver could receive RX interrupt
961 * but the shared data changes does not reflect this;
962 * periodic interrupt will detect any dangling Rx activity.
965 /* Disable periodic interrupt; we use it as just a one-shot. */
966 iwl_write8(trans, CSR_INT_PERIODIC_REG,
967 CSR_INT_PERIODIC_DIS);
969 iwl_pcie_rx_handle(trans);
972 * Enable periodic interrupt in 8 msec only if we received
973 * real RX interrupt (instead of just periodic int), to catch
974 * any dangling Rx interrupt. If it was just the periodic
975 * interrupt, there was no dangling Rx activity, and no need
976 * to extend the periodic interrupt; one-shot is enough.
978 if (inta & (CSR_INT_BIT_FH_RX | CSR_INT_BIT_SW_RX))
979 iwl_write8(trans, CSR_INT_PERIODIC_REG,
980 CSR_INT_PERIODIC_ENA);
985 /* This "Tx" DMA channel is used only for loading uCode */
986 if (inta & CSR_INT_BIT_FH_TX) {
987 iwl_write32(trans, CSR_FH_INT_STATUS, CSR_FH_INT_TX_MASK);
988 IWL_DEBUG_ISR(trans, "uCode load interrupt\n");
990 handled |= CSR_INT_BIT_FH_TX;
991 /* Wake up uCode load routine, now that load is complete */
992 trans_pcie->ucode_write_complete = true;
993 wake_up(&trans_pcie->ucode_write_waitq);
996 if (inta & ~handled) {
997 IWL_ERR(trans, "Unhandled INTA bits 0x%08x\n", inta & ~handled);
998 isr_stats->unhandled++;
1001 if (inta & ~(trans_pcie->inta_mask)) {
1002 IWL_WARN(trans, "Disabled INTA bits 0x%08x were pending\n",
1003 inta & ~trans_pcie->inta_mask);
1006 /* Re-enable all interrupts */
1007 /* only Re-enable if disabled by irq */
1008 if (test_bit(STATUS_INT_ENABLED, &trans_pcie->status))
1009 iwl_enable_interrupts(trans);
1010 /* Re-enable RF_KILL if it occurred */
1011 else if (handled & CSR_INT_BIT_RF_KILL)
1012 iwl_enable_rfkill_int(trans);
1015 lock_map_release(&trans->sync_cmd_lockdep_map);
1019 /******************************************************************************
1023 ******************************************************************************/
1025 /* a device (PCI-E) page is 4096 bytes long */
1026 #define ICT_SHIFT 12
1027 #define ICT_SIZE (1 << ICT_SHIFT)
1028 #define ICT_COUNT (ICT_SIZE / sizeof(u32))
1030 /* Free dram table */
1031 void iwl_pcie_free_ict(struct iwl_trans *trans)
1033 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
1035 if (trans_pcie->ict_tbl) {
1036 dma_free_coherent(trans->dev, ICT_SIZE,
1037 trans_pcie->ict_tbl,
1038 trans_pcie->ict_tbl_dma);
1039 trans_pcie->ict_tbl = NULL;
1040 trans_pcie->ict_tbl_dma = 0;
1045 * allocate dram shared table, it is an aligned memory
1046 * block of ICT_SIZE.
1047 * also reset all data related to ICT table interrupt.
1049 int iwl_pcie_alloc_ict(struct iwl_trans *trans)
1051 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
1053 trans_pcie->ict_tbl =
1054 dma_alloc_coherent(trans->dev, ICT_SIZE,
1055 &trans_pcie->ict_tbl_dma,
1057 if (!trans_pcie->ict_tbl)
1060 /* just an API sanity check ... it is guaranteed to be aligned */
1061 if (WARN_ON(trans_pcie->ict_tbl_dma & (ICT_SIZE - 1))) {
1062 iwl_pcie_free_ict(trans);
1066 IWL_DEBUG_ISR(trans, "ict dma addr %Lx\n",
1067 (unsigned long long)trans_pcie->ict_tbl_dma);
1069 IWL_DEBUG_ISR(trans, "ict vir addr %p\n", trans_pcie->ict_tbl);
1071 /* reset table and index to all 0 */
1072 memset(trans_pcie->ict_tbl, 0, ICT_SIZE);
1073 trans_pcie->ict_index = 0;
1075 /* add periodic RX interrupt */
1076 trans_pcie->inta_mask |= CSR_INT_BIT_RX_PERIODIC;
1080 /* Device is going up inform it about using ICT interrupt table,
1081 * also we need to tell the driver to start using ICT interrupt.
1083 void iwl_pcie_reset_ict(struct iwl_trans *trans)
1085 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
1087 unsigned long flags;
1089 if (!trans_pcie->ict_tbl)
1092 spin_lock_irqsave(&trans_pcie->irq_lock, flags);
1093 iwl_disable_interrupts(trans);
1095 memset(trans_pcie->ict_tbl, 0, ICT_SIZE);
1097 val = trans_pcie->ict_tbl_dma >> ICT_SHIFT;
1099 val |= CSR_DRAM_INT_TBL_ENABLE;
1100 val |= CSR_DRAM_INIT_TBL_WRAP_CHECK;
1102 IWL_DEBUG_ISR(trans, "CSR_DRAM_INT_TBL_REG =0x%x\n", val);
1104 iwl_write32(trans, CSR_DRAM_INT_TBL_REG, val);
1105 trans_pcie->use_ict = true;
1106 trans_pcie->ict_index = 0;
1107 iwl_write32(trans, CSR_INT, trans_pcie->inta_mask);
1108 iwl_enable_interrupts(trans);
1109 spin_unlock_irqrestore(&trans_pcie->irq_lock, flags);
1112 /* Device is going down disable ict interrupt usage */
1113 void iwl_pcie_disable_ict(struct iwl_trans *trans)
1115 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
1116 unsigned long flags;
1118 spin_lock_irqsave(&trans_pcie->irq_lock, flags);
1119 trans_pcie->use_ict = false;
1120 spin_unlock_irqrestore(&trans_pcie->irq_lock, flags);
1123 /* legacy (non-ICT) ISR. Assumes that trans_pcie->irq_lock is held */
1124 static irqreturn_t iwl_pcie_isr(int irq, void *data)
1126 struct iwl_trans *trans = data;
1127 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
1128 u32 inta, inta_mask;
1129 #ifdef CONFIG_IWLWIFI_DEBUG
1133 lockdep_assert_held(&trans_pcie->irq_lock);
1135 trace_iwlwifi_dev_irq(trans->dev);
1137 /* Disable (but don't clear!) interrupts here to avoid
1138 * back-to-back ISRs and sporadic interrupts from our NIC.
1139 * If we have something to service, the irq thread will re-enable ints.
1140 * If we *don't* have something, we'll re-enable before leaving here. */
1141 inta_mask = iwl_read32(trans, CSR_INT_MASK);
1142 iwl_write32(trans, CSR_INT_MASK, 0x00000000);
1144 /* Discover which interrupts are active/pending */
1145 inta = iwl_read32(trans, CSR_INT);
1147 if (inta & (~inta_mask)) {
1148 IWL_DEBUG_ISR(trans,
1149 "We got a masked interrupt (0x%08x)...Ack and ignore\n",
1150 inta & (~inta_mask));
1151 iwl_write32(trans, CSR_INT, inta & (~inta_mask));
1155 /* Ignore interrupt if there's nothing in NIC to service.
1156 * This may be due to IRQ shared with another device,
1157 * or due to sporadic interrupts thrown from our NIC. */
1159 IWL_DEBUG_ISR(trans, "Ignore interrupt, inta == 0\n");
1163 if ((inta == 0xFFFFFFFF) || ((inta & 0xFFFFFFF0) == 0xa5a5a5a0)) {
1164 /* Hardware disappeared. It might have already raised
1166 IWL_WARN(trans, "HARDWARE GONE?? INTA == 0x%08x\n", inta);
1170 #ifdef CONFIG_IWLWIFI_DEBUG
1171 if (iwl_have_debug_level(IWL_DL_ISR)) {
1172 inta_fh = iwl_read32(trans, CSR_FH_INT_STATUS);
1173 IWL_DEBUG_ISR(trans, "ISR inta 0x%08x, enabled 0x%08x, "
1174 "fh 0x%08x\n", inta, inta_mask, inta_fh);
1178 trans_pcie->inta |= inta;
1179 /* the thread will service interrupts and re-enable them */
1181 return IRQ_WAKE_THREAD;
1182 else if (test_bit(STATUS_INT_ENABLED, &trans_pcie->status) &&
1184 iwl_enable_interrupts(trans);
1188 /* re-enable interrupts here since we don't have anything to service. */
1189 /* only Re-enable if disabled by irq and no schedules tasklet. */
1190 if (test_bit(STATUS_INT_ENABLED, &trans_pcie->status) &&
1192 iwl_enable_interrupts(trans);
1197 /* interrupt handler using ict table, with this interrupt driver will
1198 * stop using INTA register to get device's interrupt, reading this register
1199 * is expensive, device will write interrupts in ICT dram table, increment
1200 * index then will fire interrupt to driver, driver will OR all ICT table
1201 * entries from current index up to table entry with 0 value. the result is
1202 * the interrupt we need to service, driver will set the entries back to 0 and
1205 irqreturn_t iwl_pcie_isr_ict(int irq, void *data)
1207 struct iwl_trans *trans = data;
1208 struct iwl_trans_pcie *trans_pcie;
1209 u32 inta, inta_mask;
1212 unsigned long flags;
1217 trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
1219 spin_lock_irqsave(&trans_pcie->irq_lock, flags);
1221 /* dram interrupt table not set yet,
1222 * use legacy interrupt.
1224 if (unlikely(!trans_pcie->use_ict)) {
1225 irqreturn_t ret = iwl_pcie_isr(irq, data);
1226 spin_unlock_irqrestore(&trans_pcie->irq_lock, flags);
1230 trace_iwlwifi_dev_irq(trans->dev);
1232 /* Disable (but don't clear!) interrupts here to avoid
1233 * back-to-back ISRs and sporadic interrupts from our NIC.
1234 * If we have something to service, the tasklet will re-enable ints.
1235 * If we *don't* have something, we'll re-enable before leaving here.
1237 inta_mask = iwl_read32(trans, CSR_INT_MASK);
1238 iwl_write32(trans, CSR_INT_MASK, 0x00000000);
1240 /* Ignore interrupt if there's nothing in NIC to service.
1241 * This may be due to IRQ shared with another device,
1242 * or due to sporadic interrupts thrown from our NIC. */
1243 read = le32_to_cpu(trans_pcie->ict_tbl[trans_pcie->ict_index]);
1244 trace_iwlwifi_dev_ict_read(trans->dev, trans_pcie->ict_index, read);
1246 IWL_DEBUG_ISR(trans, "Ignore interrupt, inta == 0\n");
1251 * Collect all entries up to the first 0, starting from ict_index;
1252 * note we already read at ict_index.
1256 IWL_DEBUG_ISR(trans, "ICT index %d value 0x%08X\n",
1257 trans_pcie->ict_index, read);
1258 trans_pcie->ict_tbl[trans_pcie->ict_index] = 0;
1259 trans_pcie->ict_index =
1260 iwl_queue_inc_wrap(trans_pcie->ict_index, ICT_COUNT);
1262 read = le32_to_cpu(trans_pcie->ict_tbl[trans_pcie->ict_index]);
1263 trace_iwlwifi_dev_ict_read(trans->dev, trans_pcie->ict_index,
1267 /* We should not get this value, just ignore it. */
1268 if (val == 0xffffffff)
1272 * this is a w/a for a h/w bug. the h/w bug may cause the Rx bit
1273 * (bit 15 before shifting it to 31) to clear when using interrupt
1274 * coalescing. fortunately, bits 18 and 19 stay set when this happens
1275 * so we use them to decide on the real state of the Rx bit.
1276 * In order words, bit 15 is set if bit 18 or bit 19 are set.
1281 inta = (0xff & val) | ((0xff00 & val) << 16);
1282 IWL_DEBUG_ISR(trans, "ISR inta 0x%08x, enabled 0x%08x ict 0x%08x\n",
1283 inta, inta_mask, val);
1285 inta &= trans_pcie->inta_mask;
1286 trans_pcie->inta |= inta;
1288 /* iwl_pcie_tasklet() will service interrupts and re-enable them */
1290 spin_unlock_irqrestore(&trans_pcie->irq_lock, flags);
1291 return IRQ_WAKE_THREAD;
1292 } else if (test_bit(STATUS_INT_ENABLED, &trans_pcie->status) &&
1293 !trans_pcie->inta) {
1294 /* Allow interrupt if was disabled by this handler and
1295 * no tasklet was schedules, We should not enable interrupt,
1296 * tasklet will enable it.
1298 iwl_enable_interrupts(trans);
1301 spin_unlock_irqrestore(&trans_pcie->irq_lock, flags);
1305 /* re-enable interrupts here since we don't have anything to service.
1306 * only Re-enable if disabled by irq.
1308 if (test_bit(STATUS_INT_ENABLED, &trans_pcie->status) &&
1310 iwl_enable_interrupts(trans);
1312 spin_unlock_irqrestore(&trans_pcie->irq_lock, flags);