Loading...
1/******************************************************************************
2 *
3 * Copyright(c) 2003 - 2015 Intel Corporation. All rights reserved.
4 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
5 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
6 *
7 * Portions of this file are derived from the ipw3945 project, as well
8 * as portions of the ieee80211 subsystem header files.
9 *
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 * more details.
18 *
19 * You should have received a copy of the GNU General Public License along with
20 * this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
22 *
23 * The full GNU General Public License is included in this distribution in the
24 * file called LICENSE.
25 *
26 * Contact Information:
27 * Intel Linux Wireless <linuxwifi@intel.com>
28 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
29 *
30 *****************************************************************************/
31#ifndef __iwl_trans_int_pcie_h__
32#define __iwl_trans_int_pcie_h__
33
34#include <linux/spinlock.h>
35#include <linux/interrupt.h>
36#include <linux/skbuff.h>
37#include <linux/wait.h>
38#include <linux/pci.h>
39#include <linux/timer.h>
40#include <linux/cpu.h>
41
42#include "iwl-fh.h"
43#include "iwl-csr.h"
44#include "iwl-trans.h"
45#include "iwl-debug.h"
46#include "iwl-io.h"
47#include "iwl-op-mode.h"
48
49/* We need 2 entries for the TX command and header, and another one might
50 * be needed for potential data in the SKB's head. The remaining ones can
51 * be used for frags.
52 */
53#define IWL_PCIE_MAX_FRAGS(x) (x->max_tbs - 3)
54
55/*
56 * RX related structures and functions
57 */
58#define RX_NUM_QUEUES 1
59#define RX_POST_REQ_ALLOC 2
60#define RX_CLAIM_REQ_ALLOC 8
61#define RX_PENDING_WATERMARK 16
62
63struct iwl_host_cmd;
64
65/*This file includes the declaration that are internal to the
66 * trans_pcie layer */
67
68/**
69 * struct iwl_rx_mem_buffer
70 * @page_dma: bus address of rxb page
71 * @page: driver's pointer to the rxb page
72 * @invalid: rxb is in driver ownership - not owned by HW
73 * @vid: index of this rxb in the global table
74 */
75struct iwl_rx_mem_buffer {
76 dma_addr_t page_dma;
77 struct page *page;
78 u16 vid;
79 bool invalid;
80 struct list_head list;
81};
82
83/**
84 * struct isr_statistics - interrupt statistics
85 *
86 */
87struct isr_statistics {
88 u32 hw;
89 u32 sw;
90 u32 err_code;
91 u32 sch;
92 u32 alive;
93 u32 rfkill;
94 u32 ctkill;
95 u32 wakeup;
96 u32 rx;
97 u32 tx;
98 u32 unhandled;
99};
100
101/**
102 * struct iwl_rxq - Rx queue
103 * @id: queue index
104 * @bd: driver's pointer to buffer of receive buffer descriptors (rbd).
105 * Address size is 32 bit in pre-9000 devices and 64 bit in 9000 devices.
106 * @bd_dma: bus address of buffer of receive buffer descriptors (rbd)
107 * @ubd: driver's pointer to buffer of used receive buffer descriptors (rbd)
108 * @ubd_dma: physical address of buffer of used receive buffer descriptors (rbd)
109 * @read: Shared index to newest available Rx buffer
110 * @write: Shared index to oldest written Rx packet
111 * @free_count: Number of pre-allocated buffers in rx_free
112 * @used_count: Number of RBDs handled to allocator to use for allocation
113 * @write_actual:
114 * @rx_free: list of RBDs with allocated RB ready for use
115 * @rx_used: list of RBDs with no RB attached
116 * @need_update: flag to indicate we need to update read/write index
117 * @rb_stts: driver's pointer to receive buffer status
118 * @rb_stts_dma: bus address of receive buffer status
119 * @lock:
120 * @queue: actual rx queue. Not used for multi-rx queue.
121 *
122 * NOTE: rx_free and rx_used are used as a FIFO for iwl_rx_mem_buffers
123 */
124struct iwl_rxq {
125 int id;
126 void *bd;
127 dma_addr_t bd_dma;
128 __le32 *used_bd;
129 dma_addr_t used_bd_dma;
130 u32 read;
131 u32 write;
132 u32 free_count;
133 u32 used_count;
134 u32 write_actual;
135 u32 queue_size;
136 struct list_head rx_free;
137 struct list_head rx_used;
138 bool need_update;
139 struct iwl_rb_status *rb_stts;
140 dma_addr_t rb_stts_dma;
141 spinlock_t lock;
142 struct napi_struct napi;
143 struct iwl_rx_mem_buffer *queue[RX_QUEUE_SIZE];
144};
145
146/**
147 * struct iwl_rb_allocator - Rx allocator
148 * @req_pending: number of requests the allcator had not processed yet
149 * @req_ready: number of requests honored and ready for claiming
150 * @rbd_allocated: RBDs with pages allocated and ready to be handled to
151 * the queue. This is a list of &struct iwl_rx_mem_buffer
152 * @rbd_empty: RBDs with no page attached for allocator use. This is a list
153 * of &struct iwl_rx_mem_buffer
154 * @lock: protects the rbd_allocated and rbd_empty lists
155 * @alloc_wq: work queue for background calls
156 * @rx_alloc: work struct for background calls
157 */
158struct iwl_rb_allocator {
159 atomic_t req_pending;
160 atomic_t req_ready;
161 struct list_head rbd_allocated;
162 struct list_head rbd_empty;
163 spinlock_t lock;
164 struct workqueue_struct *alloc_wq;
165 struct work_struct rx_alloc;
166};
167
168struct iwl_dma_ptr {
169 dma_addr_t dma;
170 void *addr;
171 size_t size;
172};
173
174/**
175 * iwl_queue_inc_wrap - increment queue index, wrap back to beginning
176 * @index -- current index
177 */
178static inline int iwl_queue_inc_wrap(int index)
179{
180 return ++index & (TFD_QUEUE_SIZE_MAX - 1);
181}
182
183/**
184 * iwl_queue_dec_wrap - decrement queue index, wrap back to end
185 * @index -- current index
186 */
187static inline int iwl_queue_dec_wrap(int index)
188{
189 return --index & (TFD_QUEUE_SIZE_MAX - 1);
190}
191
192struct iwl_cmd_meta {
193 /* only for SYNC commands, iff the reply skb is wanted */
194 struct iwl_host_cmd *source;
195 u32 flags;
196 u32 tbs;
197};
198
199
200#define TFD_TX_CMD_SLOTS 256
201#define TFD_CMD_SLOTS 32
202
203/*
204 * The FH will write back to the first TB only, so we need to copy some data
205 * into the buffer regardless of whether it should be mapped or not.
206 * This indicates how big the first TB must be to include the scratch buffer
207 * and the assigned PN.
208 * Since PN location is 8 bytes at offset 12, it's 20 now.
209 * If we make it bigger then allocations will be bigger and copy slower, so
210 * that's probably not useful.
211 */
212#define IWL_FIRST_TB_SIZE 20
213#define IWL_FIRST_TB_SIZE_ALIGN ALIGN(IWL_FIRST_TB_SIZE, 64)
214
215struct iwl_pcie_txq_entry {
216 struct iwl_device_cmd *cmd;
217 struct sk_buff *skb;
218 /* buffer to free after command completes */
219 const void *free_buf;
220 struct iwl_cmd_meta meta;
221};
222
223struct iwl_pcie_first_tb_buf {
224 u8 buf[IWL_FIRST_TB_SIZE_ALIGN];
225};
226
227/**
228 * struct iwl_txq - Tx Queue for DMA
229 * @q: generic Rx/Tx queue descriptor
230 * @tfds: transmit frame descriptors (DMA memory)
231 * @first_tb_bufs: start of command headers, including scratch buffers, for
232 * the writeback -- this is DMA memory and an array holding one buffer
233 * for each command on the queue
234 * @first_tb_dma: DMA address for the first_tb_bufs start
235 * @entries: transmit entries (driver state)
236 * @lock: queue lock
237 * @stuck_timer: timer that fires if queue gets stuck
238 * @trans_pcie: pointer back to transport (for timer)
239 * @need_update: indicates need to update read/write index
240 * @ampdu: true if this queue is an ampdu queue for an specific RA/TID
241 * @wd_timeout: queue watchdog timeout (jiffies) - per queue
242 * @frozen: tx stuck queue timer is frozen
243 * @frozen_expiry_remainder: remember how long until the timer fires
244 * @bc_tbl: byte count table of the queue (relevant only for gen2 transport)
245 * @write_ptr: 1-st empty entry (index) host_w
246 * @read_ptr: last used entry (index) host_r
247 * @dma_addr: physical addr for BD's
248 * @n_window: safe queue window
249 * @id: queue id
250 * @low_mark: low watermark, resume queue if free space more than this
251 * @high_mark: high watermark, stop queue if free space less than this
252 *
253 * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
254 * descriptors) and required locking structures.
255 *
256 * Note the difference between TFD_QUEUE_SIZE_MAX and n_window: the hardware
257 * always assumes 256 descriptors, so TFD_QUEUE_SIZE_MAX is always 256 (unless
258 * there might be HW changes in the future). For the normal TX
259 * queues, n_window, which is the size of the software queue data
260 * is also 256; however, for the command queue, n_window is only
261 * 32 since we don't need so many commands pending. Since the HW
262 * still uses 256 BDs for DMA though, TFD_QUEUE_SIZE_MAX stays 256.
263 * This means that we end up with the following:
264 * HW entries: | 0 | ... | N * 32 | ... | N * 32 + 31 | ... | 255 |
265 * SW entries: | 0 | ... | 31 |
266 * where N is a number between 0 and 7. This means that the SW
267 * data is a window overlayed over the HW queue.
268 */
269struct iwl_txq {
270 void *tfds;
271 struct iwl_pcie_first_tb_buf *first_tb_bufs;
272 dma_addr_t first_tb_dma;
273 struct iwl_pcie_txq_entry *entries;
274 spinlock_t lock;
275 unsigned long frozen_expiry_remainder;
276 struct timer_list stuck_timer;
277 struct iwl_trans_pcie *trans_pcie;
278 bool need_update;
279 bool frozen;
280 bool ampdu;
281 int block;
282 unsigned long wd_timeout;
283 struct sk_buff_head overflow_q;
284 struct iwl_dma_ptr bc_tbl;
285
286 int write_ptr;
287 int read_ptr;
288 dma_addr_t dma_addr;
289 int n_window;
290 u32 id;
291 int low_mark;
292 int high_mark;
293};
294
295static inline dma_addr_t
296iwl_pcie_get_first_tb_dma(struct iwl_txq *txq, int idx)
297{
298 return txq->first_tb_dma +
299 sizeof(struct iwl_pcie_first_tb_buf) * idx;
300}
301
302struct iwl_tso_hdr_page {
303 struct page *page;
304 u8 *pos;
305};
306
307/**
308 * enum iwl_shared_irq_flags - level of sharing for irq
309 * @IWL_SHARED_IRQ_NON_RX: interrupt vector serves non rx causes.
310 * @IWL_SHARED_IRQ_FIRST_RSS: interrupt vector serves first RSS queue.
311 */
312enum iwl_shared_irq_flags {
313 IWL_SHARED_IRQ_NON_RX = BIT(0),
314 IWL_SHARED_IRQ_FIRST_RSS = BIT(1),
315};
316
317/**
318 * struct iwl_dram_data
319 * @physical: page phy pointer
320 * @block: pointer to the allocated block/page
321 * @size: size of the block/page
322 */
323struct iwl_dram_data {
324 dma_addr_t physical;
325 void *block;
326 int size;
327};
328
329/**
330 * struct iwl_self_init_dram - dram data used by self init process
331 * @fw: lmac and umac dram data
332 * @fw_cnt: total number of items in array
333 * @paging: paging dram data
334 * @paging_cnt: total number of items in array
335 */
336struct iwl_self_init_dram {
337 struct iwl_dram_data *fw;
338 int fw_cnt;
339 struct iwl_dram_data *paging;
340 int paging_cnt;
341};
342
343/**
344 * struct iwl_trans_pcie - PCIe transport specific data
345 * @rxq: all the RX queue data
346 * @rx_pool: initial pool of iwl_rx_mem_buffer for all the queues
347 * @global_table: table mapping received VID from hw to rxb
348 * @rba: allocator for RX replenishing
349 * @ctxt_info: context information for FW self init
350 * @ctxt_info_dma_addr: dma addr of context information
351 * @init_dram: DRAM data of firmware image (including paging).
352 * Context information addresses will be taken from here.
353 * This is driver's local copy for keeping track of size and
354 * count for allocating and freeing the memory.
355 * @trans: pointer to the generic transport area
356 * @scd_base_addr: scheduler sram base address in SRAM
357 * @scd_bc_tbls: pointer to the byte count table of the scheduler
358 * @kw: keep warm address
359 * @pci_dev: basic pci-network driver stuff
360 * @hw_base: pci hardware address support
361 * @ucode_write_complete: indicates that the ucode has been copied.
362 * @ucode_write_waitq: wait queue for uCode load
363 * @cmd_queue - command queue number
364 * @rx_buf_size: Rx buffer size
365 * @bc_table_dword: true if the BC table expects DWORD (as opposed to bytes)
366 * @scd_set_active: should the transport configure the SCD for HCMD queue
367 * @sw_csum_tx: if true, then the transport will compute the csum of the TXed
368 * frame.
369 * @rx_page_order: page order for receive buffer size
370 * @reg_lock: protect hw register access
371 * @mutex: to protect stop_device / start_fw / start_hw
372 * @cmd_in_flight: true when we have a host command in flight
373 * @fw_mon_phys: physical address of the buffer for the firmware monitor
374 * @fw_mon_page: points to the first page of the buffer for the firmware monitor
375 * @fw_mon_size: size of the buffer for the firmware monitor
376 * @msix_entries: array of MSI-X entries
377 * @msix_enabled: true if managed to enable MSI-X
378 * @shared_vec_mask: the type of causes the shared vector handles
379 * (see iwl_shared_irq_flags).
380 * @alloc_vecs: the number of interrupt vectors allocated by the OS
381 * @def_irq: default irq for non rx causes
382 * @fh_init_mask: initial unmasked fh causes
383 * @hw_init_mask: initial unmasked hw causes
384 * @fh_mask: current unmasked fh causes
385 * @hw_mask: current unmasked hw causes
386 * @tx_cmd_queue_size: the size of the tx command queue
387 */
388struct iwl_trans_pcie {
389 struct iwl_rxq *rxq;
390 struct iwl_rx_mem_buffer rx_pool[RX_POOL_SIZE];
391 struct iwl_rx_mem_buffer *global_table[RX_POOL_SIZE];
392 struct iwl_rb_allocator rba;
393 struct iwl_context_info *ctxt_info;
394 dma_addr_t ctxt_info_dma_addr;
395 struct iwl_self_init_dram init_dram;
396 struct iwl_trans *trans;
397
398 struct net_device napi_dev;
399
400 struct __percpu iwl_tso_hdr_page *tso_hdr_page;
401
402 /* INT ICT Table */
403 __le32 *ict_tbl;
404 dma_addr_t ict_tbl_dma;
405 int ict_index;
406 bool use_ict;
407 bool is_down, opmode_down;
408 bool debug_rfkill;
409 struct isr_statistics isr_stats;
410
411 spinlock_t irq_lock;
412 struct mutex mutex;
413 u32 inta_mask;
414 u32 scd_base_addr;
415 struct iwl_dma_ptr scd_bc_tbls;
416 struct iwl_dma_ptr kw;
417
418 struct iwl_txq *txq_memory;
419 struct iwl_txq *txq[IWL_MAX_TVQM_QUEUES];
420 unsigned long queue_used[BITS_TO_LONGS(IWL_MAX_TVQM_QUEUES)];
421 unsigned long queue_stopped[BITS_TO_LONGS(IWL_MAX_TVQM_QUEUES)];
422
423 /* PCI bus related data */
424 struct pci_dev *pci_dev;
425 void __iomem *hw_base;
426
427 bool ucode_write_complete;
428 wait_queue_head_t ucode_write_waitq;
429 wait_queue_head_t wait_command_queue;
430 wait_queue_head_t d0i3_waitq;
431
432 u8 page_offs, dev_cmd_offs;
433
434 u8 cmd_queue;
435 u8 cmd_fifo;
436 unsigned int cmd_q_wdg_timeout;
437 u8 n_no_reclaim_cmds;
438 u8 no_reclaim_cmds[MAX_NO_RECLAIM_CMDS];
439 u8 max_tbs;
440 u16 tfd_size;
441
442 enum iwl_amsdu_size rx_buf_size;
443 bool bc_table_dword;
444 bool scd_set_active;
445 bool sw_csum_tx;
446 bool pcie_dbg_dumped_once;
447 u32 rx_page_order;
448
449 /*protect hw register */
450 spinlock_t reg_lock;
451 bool cmd_hold_nic_awake;
452 bool ref_cmd_in_flight;
453
454 dma_addr_t fw_mon_phys;
455 struct page *fw_mon_page;
456 u32 fw_mon_size;
457
458 struct msix_entry msix_entries[IWL_MAX_RX_HW_QUEUES];
459 bool msix_enabled;
460 u8 shared_vec_mask;
461 u32 alloc_vecs;
462 u32 def_irq;
463 u32 fh_init_mask;
464 u32 hw_init_mask;
465 u32 fh_mask;
466 u32 hw_mask;
467 cpumask_t affinity_mask[IWL_MAX_RX_HW_QUEUES];
468 u16 tx_cmd_queue_size;
469};
470
471static inline struct iwl_trans_pcie *
472IWL_TRANS_GET_PCIE_TRANS(struct iwl_trans *trans)
473{
474 return (void *)trans->trans_specific;
475}
476
477static inline struct iwl_trans *
478iwl_trans_pcie_get_trans(struct iwl_trans_pcie *trans_pcie)
479{
480 return container_of((void *)trans_pcie, struct iwl_trans,
481 trans_specific);
482}
483
484/*
485 * Convention: trans API functions: iwl_trans_pcie_XXX
486 * Other functions: iwl_pcie_XXX
487 */
488struct iwl_trans *iwl_trans_pcie_alloc(struct pci_dev *pdev,
489 const struct pci_device_id *ent,
490 const struct iwl_cfg *cfg);
491void iwl_trans_pcie_free(struct iwl_trans *trans);
492
493/*****************************************************
494* RX
495******************************************************/
496int iwl_pcie_rx_init(struct iwl_trans *trans);
497int iwl_pcie_gen2_rx_init(struct iwl_trans *trans);
498irqreturn_t iwl_pcie_msix_isr(int irq, void *data);
499irqreturn_t iwl_pcie_irq_handler(int irq, void *dev_id);
500irqreturn_t iwl_pcie_irq_msix_handler(int irq, void *dev_id);
501irqreturn_t iwl_pcie_irq_rx_msix_handler(int irq, void *dev_id);
502int iwl_pcie_rx_stop(struct iwl_trans *trans);
503void iwl_pcie_rx_free(struct iwl_trans *trans);
504
505/*****************************************************
506* ICT - interrupt handling
507******************************************************/
508irqreturn_t iwl_pcie_isr(int irq, void *data);
509int iwl_pcie_alloc_ict(struct iwl_trans *trans);
510void iwl_pcie_free_ict(struct iwl_trans *trans);
511void iwl_pcie_reset_ict(struct iwl_trans *trans);
512void iwl_pcie_disable_ict(struct iwl_trans *trans);
513
514/*****************************************************
515* TX / HCMD
516******************************************************/
517int iwl_pcie_tx_init(struct iwl_trans *trans);
518int iwl_pcie_gen2_tx_init(struct iwl_trans *trans);
519void iwl_pcie_tx_start(struct iwl_trans *trans, u32 scd_base_addr);
520int iwl_pcie_tx_stop(struct iwl_trans *trans);
521void iwl_pcie_tx_free(struct iwl_trans *trans);
522bool iwl_trans_pcie_txq_enable(struct iwl_trans *trans, int queue, u16 ssn,
523 const struct iwl_trans_txq_scd_cfg *cfg,
524 unsigned int wdg_timeout);
525void iwl_trans_pcie_txq_disable(struct iwl_trans *trans, int queue,
526 bool configure_scd);
527void iwl_trans_pcie_txq_set_shared_mode(struct iwl_trans *trans, u32 txq_id,
528 bool shared_mode);
529void iwl_trans_pcie_log_scd_error(struct iwl_trans *trans,
530 struct iwl_txq *txq);
531int iwl_trans_pcie_tx(struct iwl_trans *trans, struct sk_buff *skb,
532 struct iwl_device_cmd *dev_cmd, int txq_id);
533void iwl_pcie_txq_check_wrptrs(struct iwl_trans *trans);
534int iwl_trans_pcie_send_hcmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
535void iwl_pcie_hcmd_complete(struct iwl_trans *trans,
536 struct iwl_rx_cmd_buffer *rxb);
537void iwl_trans_pcie_reclaim(struct iwl_trans *trans, int txq_id, int ssn,
538 struct sk_buff_head *skbs);
539void iwl_trans_pcie_tx_reset(struct iwl_trans *trans);
540void iwl_pcie_set_tx_cmd_queue_size(struct iwl_trans *trans);
541
542static inline u16 iwl_pcie_tfd_tb_get_len(struct iwl_trans *trans, void *_tfd,
543 u8 idx)
544{
545 if (trans->cfg->use_tfh) {
546 struct iwl_tfh_tfd *tfd = _tfd;
547 struct iwl_tfh_tb *tb = &tfd->tbs[idx];
548
549 return le16_to_cpu(tb->tb_len);
550 } else {
551 struct iwl_tfd *tfd = _tfd;
552 struct iwl_tfd_tb *tb = &tfd->tbs[idx];
553
554 return le16_to_cpu(tb->hi_n_len) >> 4;
555 }
556}
557
558/*****************************************************
559* Error handling
560******************************************************/
561void iwl_pcie_dump_csr(struct iwl_trans *trans);
562
563/*****************************************************
564* Helpers
565******************************************************/
566static inline void _iwl_disable_interrupts(struct iwl_trans *trans)
567{
568 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
569
570 clear_bit(STATUS_INT_ENABLED, &trans->status);
571 if (!trans_pcie->msix_enabled) {
572 /* disable interrupts from uCode/NIC to host */
573 iwl_write32(trans, CSR_INT_MASK, 0x00000000);
574
575 /* acknowledge/clear/reset any interrupts still pending
576 * from uCode or flow handler (Rx/Tx DMA) */
577 iwl_write32(trans, CSR_INT, 0xffffffff);
578 iwl_write32(trans, CSR_FH_INT_STATUS, 0xffffffff);
579 } else {
580 /* disable all the interrupt we might use */
581 iwl_write32(trans, CSR_MSIX_FH_INT_MASK_AD,
582 trans_pcie->fh_init_mask);
583 iwl_write32(trans, CSR_MSIX_HW_INT_MASK_AD,
584 trans_pcie->hw_init_mask);
585 }
586 IWL_DEBUG_ISR(trans, "Disabled interrupts\n");
587}
588
589static inline void iwl_disable_interrupts(struct iwl_trans *trans)
590{
591 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
592
593 spin_lock(&trans_pcie->irq_lock);
594 _iwl_disable_interrupts(trans);
595 spin_unlock(&trans_pcie->irq_lock);
596}
597
598static inline void _iwl_enable_interrupts(struct iwl_trans *trans)
599{
600 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
601
602 IWL_DEBUG_ISR(trans, "Enabling interrupts\n");
603 set_bit(STATUS_INT_ENABLED, &trans->status);
604 if (!trans_pcie->msix_enabled) {
605 trans_pcie->inta_mask = CSR_INI_SET_MASK;
606 iwl_write32(trans, CSR_INT_MASK, trans_pcie->inta_mask);
607 } else {
608 /*
609 * fh/hw_mask keeps all the unmasked causes.
610 * Unlike msi, in msix cause is enabled when it is unset.
611 */
612 trans_pcie->hw_mask = trans_pcie->hw_init_mask;
613 trans_pcie->fh_mask = trans_pcie->fh_init_mask;
614 iwl_write32(trans, CSR_MSIX_FH_INT_MASK_AD,
615 ~trans_pcie->fh_mask);
616 iwl_write32(trans, CSR_MSIX_HW_INT_MASK_AD,
617 ~trans_pcie->hw_mask);
618 }
619}
620
621static inline void iwl_enable_interrupts(struct iwl_trans *trans)
622{
623 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
624
625 spin_lock(&trans_pcie->irq_lock);
626 _iwl_enable_interrupts(trans);
627 spin_unlock(&trans_pcie->irq_lock);
628}
629static inline void iwl_enable_hw_int_msk_msix(struct iwl_trans *trans, u32 msk)
630{
631 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
632
633 iwl_write32(trans, CSR_MSIX_HW_INT_MASK_AD, ~msk);
634 trans_pcie->hw_mask = msk;
635}
636
637static inline void iwl_enable_fh_int_msk_msix(struct iwl_trans *trans, u32 msk)
638{
639 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
640
641 iwl_write32(trans, CSR_MSIX_FH_INT_MASK_AD, ~msk);
642 trans_pcie->fh_mask = msk;
643}
644
645static inline void iwl_enable_fw_load_int(struct iwl_trans *trans)
646{
647 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
648
649 IWL_DEBUG_ISR(trans, "Enabling FW load interrupt\n");
650 if (!trans_pcie->msix_enabled) {
651 trans_pcie->inta_mask = CSR_INT_BIT_FH_TX;
652 iwl_write32(trans, CSR_INT_MASK, trans_pcie->inta_mask);
653 } else {
654 iwl_write32(trans, CSR_MSIX_HW_INT_MASK_AD,
655 trans_pcie->hw_init_mask);
656 iwl_enable_fh_int_msk_msix(trans,
657 MSIX_FH_INT_CAUSES_D2S_CH0_NUM);
658 }
659}
660
661static inline u8 iwl_pcie_get_cmd_index(struct iwl_txq *q, u32 index)
662{
663 return index & (q->n_window - 1);
664}
665
666static inline void *iwl_pcie_get_tfd(struct iwl_trans *trans,
667 struct iwl_txq *txq, int idx)
668{
669 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
670
671 if (trans->cfg->use_tfh)
672 idx = iwl_pcie_get_cmd_index(txq, idx);
673
674 return txq->tfds + trans_pcie->tfd_size * idx;
675}
676
677static inline void iwl_enable_rfkill_int(struct iwl_trans *trans)
678{
679 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
680
681 IWL_DEBUG_ISR(trans, "Enabling rfkill interrupt\n");
682 if (!trans_pcie->msix_enabled) {
683 trans_pcie->inta_mask = CSR_INT_BIT_RF_KILL;
684 iwl_write32(trans, CSR_INT_MASK, trans_pcie->inta_mask);
685 } else {
686 iwl_write32(trans, CSR_MSIX_FH_INT_MASK_AD,
687 trans_pcie->fh_init_mask);
688 iwl_enable_hw_int_msk_msix(trans,
689 MSIX_HW_INT_CAUSES_REG_RF_KILL);
690 }
691
692 if (trans->cfg->device_family == IWL_DEVICE_FAMILY_9000) {
693 /*
694 * On 9000-series devices this bit isn't enabled by default, so
695 * when we power down the device we need set the bit to allow it
696 * to wake up the PCI-E bus for RF-kill interrupts.
697 */
698 iwl_set_bit(trans, CSR_GP_CNTRL,
699 CSR_GP_CNTRL_REG_FLAG_RFKILL_WAKE_L1A_EN);
700 }
701}
702
703void iwl_pcie_handle_rfkill_irq(struct iwl_trans *trans);
704
705static inline void iwl_wake_queue(struct iwl_trans *trans,
706 struct iwl_txq *txq)
707{
708 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
709
710 if (test_and_clear_bit(txq->id, trans_pcie->queue_stopped)) {
711 IWL_DEBUG_TX_QUEUES(trans, "Wake hwq %d\n", txq->id);
712 iwl_op_mode_queue_not_full(trans->op_mode, txq->id);
713 }
714}
715
716static inline void iwl_stop_queue(struct iwl_trans *trans,
717 struct iwl_txq *txq)
718{
719 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
720
721 if (!test_and_set_bit(txq->id, trans_pcie->queue_stopped)) {
722 iwl_op_mode_queue_full(trans->op_mode, txq->id);
723 IWL_DEBUG_TX_QUEUES(trans, "Stop hwq %d\n", txq->id);
724 } else
725 IWL_DEBUG_TX_QUEUES(trans, "hwq %d already stopped\n",
726 txq->id);
727}
728
729static inline bool iwl_queue_used(const struct iwl_txq *q, int i)
730{
731 return q->write_ptr >= q->read_ptr ?
732 (i >= q->read_ptr && i < q->write_ptr) :
733 !(i < q->read_ptr && i >= q->write_ptr);
734}
735
736static inline bool iwl_is_rfkill_set(struct iwl_trans *trans)
737{
738 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
739
740 lockdep_assert_held(&trans_pcie->mutex);
741
742 if (trans_pcie->debug_rfkill)
743 return true;
744
745 return !(iwl_read32(trans, CSR_GP_CNTRL) &
746 CSR_GP_CNTRL_REG_FLAG_HW_RF_KILL_SW);
747}
748
749static inline void __iwl_trans_pcie_set_bits_mask(struct iwl_trans *trans,
750 u32 reg, u32 mask, u32 value)
751{
752 u32 v;
753
754#ifdef CONFIG_IWLWIFI_DEBUG
755 WARN_ON_ONCE(value & ~mask);
756#endif
757
758 v = iwl_read32(trans, reg);
759 v &= ~mask;
760 v |= value;
761 iwl_write32(trans, reg, v);
762}
763
764static inline void __iwl_trans_pcie_clear_bit(struct iwl_trans *trans,
765 u32 reg, u32 mask)
766{
767 __iwl_trans_pcie_set_bits_mask(trans, reg, mask, 0);
768}
769
770static inline void __iwl_trans_pcie_set_bit(struct iwl_trans *trans,
771 u32 reg, u32 mask)
772{
773 __iwl_trans_pcie_set_bits_mask(trans, reg, mask, mask);
774}
775
776void iwl_trans_pcie_rf_kill(struct iwl_trans *trans, bool state);
777
778#ifdef CONFIG_IWLWIFI_DEBUGFS
779int iwl_trans_pcie_dbgfs_register(struct iwl_trans *trans);
780#else
781static inline int iwl_trans_pcie_dbgfs_register(struct iwl_trans *trans)
782{
783 return 0;
784}
785#endif
786
787int iwl_pci_fw_exit_d0i3(struct iwl_trans *trans);
788int iwl_pci_fw_enter_d0i3(struct iwl_trans *trans);
789
790void iwl_pcie_enable_rx_wake(struct iwl_trans *trans, bool enable);
791
792void iwl_pcie_rx_allocator_work(struct work_struct *data);
793
794/* common functions that are used by gen2 transport */
795void iwl_pcie_apm_config(struct iwl_trans *trans);
796int iwl_pcie_prepare_card_hw(struct iwl_trans *trans);
797void iwl_pcie_synchronize_irqs(struct iwl_trans *trans);
798bool iwl_pcie_check_hw_rf_kill(struct iwl_trans *trans);
799void iwl_trans_pcie_handle_stop_rfkill(struct iwl_trans *trans,
800 bool was_in_rfkill);
801void iwl_pcie_txq_free_tfd(struct iwl_trans *trans, struct iwl_txq *txq);
802int iwl_queue_space(const struct iwl_txq *q);
803void iwl_pcie_apm_stop_master(struct iwl_trans *trans);
804void iwl_pcie_conf_msix_hw(struct iwl_trans_pcie *trans_pcie);
805int iwl_pcie_txq_init(struct iwl_trans *trans, struct iwl_txq *txq,
806 int slots_num, bool cmd_queue);
807int iwl_pcie_txq_alloc(struct iwl_trans *trans,
808 struct iwl_txq *txq, int slots_num, bool cmd_queue);
809int iwl_pcie_alloc_dma_ptr(struct iwl_trans *trans,
810 struct iwl_dma_ptr *ptr, size_t size);
811void iwl_pcie_free_dma_ptr(struct iwl_trans *trans, struct iwl_dma_ptr *ptr);
812void iwl_pcie_apply_destination(struct iwl_trans *trans);
813void iwl_pcie_free_tso_page(struct iwl_trans_pcie *trans_pcie,
814 struct sk_buff *skb);
815#ifdef CONFIG_INET
816struct iwl_tso_hdr_page *get_page_hdr(struct iwl_trans *trans, size_t len);
817#endif
818
819/* transport gen 2 exported functions */
820int iwl_trans_pcie_gen2_start_fw(struct iwl_trans *trans,
821 const struct fw_img *fw, bool run_in_rfkill);
822void iwl_trans_pcie_gen2_fw_alive(struct iwl_trans *trans, u32 scd_addr);
823int iwl_trans_pcie_dyn_txq_alloc(struct iwl_trans *trans,
824 struct iwl_tx_queue_cfg_cmd *cmd,
825 int cmd_id,
826 unsigned int timeout);
827void iwl_trans_pcie_dyn_txq_free(struct iwl_trans *trans, int queue);
828int iwl_trans_pcie_gen2_tx(struct iwl_trans *trans, struct sk_buff *skb,
829 struct iwl_device_cmd *dev_cmd, int txq_id);
830int iwl_trans_pcie_gen2_send_hcmd(struct iwl_trans *trans,
831 struct iwl_host_cmd *cmd);
832void iwl_trans_pcie_gen2_stop_device(struct iwl_trans *trans,
833 bool low_power);
834void _iwl_trans_pcie_gen2_stop_device(struct iwl_trans *trans, bool low_power);
835void iwl_pcie_gen2_txq_unmap(struct iwl_trans *trans, int txq_id);
836void iwl_pcie_gen2_tx_free(struct iwl_trans *trans);
837void iwl_pcie_gen2_tx_stop(struct iwl_trans *trans);
838#endif /* __iwl_trans_int_pcie_h__ */
1/* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2/*
3 * Copyright (C) 2003-2015, 2018-2023 Intel Corporation
4 * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
5 * Copyright (C) 2016-2017 Intel Deutschland GmbH
6 */
7#ifndef __iwl_trans_int_pcie_h__
8#define __iwl_trans_int_pcie_h__
9
10#include <linux/spinlock.h>
11#include <linux/interrupt.h>
12#include <linux/skbuff.h>
13#include <linux/wait.h>
14#include <linux/pci.h>
15#include <linux/timer.h>
16#include <linux/cpu.h>
17
18#include "iwl-fh.h"
19#include "iwl-csr.h"
20#include "iwl-trans.h"
21#include "iwl-debug.h"
22#include "iwl-io.h"
23#include "iwl-op-mode.h"
24#include "iwl-drv.h"
25#include "queue/tx.h"
26#include "iwl-context-info.h"
27
28/*
29 * RX related structures and functions
30 */
31#define RX_NUM_QUEUES 1
32#define RX_POST_REQ_ALLOC 2
33#define RX_CLAIM_REQ_ALLOC 8
34#define RX_PENDING_WATERMARK 16
35#define FIRST_RX_QUEUE 512
36
37struct iwl_host_cmd;
38
39/*This file includes the declaration that are internal to the
40 * trans_pcie layer */
41
42/**
43 * struct iwl_rx_mem_buffer
44 * @page_dma: bus address of rxb page
45 * @page: driver's pointer to the rxb page
46 * @list: list entry for the membuffer
47 * @invalid: rxb is in driver ownership - not owned by HW
48 * @vid: index of this rxb in the global table
49 * @offset: indicates which offset of the page (in bytes)
50 * this buffer uses (if multiple RBs fit into one page)
51 */
52struct iwl_rx_mem_buffer {
53 dma_addr_t page_dma;
54 struct page *page;
55 struct list_head list;
56 u32 offset;
57 u16 vid;
58 bool invalid;
59};
60
61/* interrupt statistics */
62struct isr_statistics {
63 u32 hw;
64 u32 sw;
65 u32 err_code;
66 u32 sch;
67 u32 alive;
68 u32 rfkill;
69 u32 ctkill;
70 u32 wakeup;
71 u32 rx;
72 u32 tx;
73 u32 unhandled;
74};
75
76/**
77 * struct iwl_rx_transfer_desc - transfer descriptor
78 * @addr: ptr to free buffer start address
79 * @rbid: unique tag of the buffer
80 * @reserved: reserved
81 */
82struct iwl_rx_transfer_desc {
83 __le16 rbid;
84 __le16 reserved[3];
85 __le64 addr;
86} __packed;
87
88#define IWL_RX_CD_FLAGS_FRAGMENTED BIT(0)
89
90/**
91 * struct iwl_rx_completion_desc - completion descriptor
92 * @reserved1: reserved
93 * @rbid: unique tag of the received buffer
94 * @flags: flags (0: fragmented, all others: reserved)
95 * @reserved2: reserved
96 */
97struct iwl_rx_completion_desc {
98 __le32 reserved1;
99 __le16 rbid;
100 u8 flags;
101 u8 reserved2[25];
102} __packed;
103
104/**
105 * struct iwl_rx_completion_desc_bz - Bz completion descriptor
106 * @rbid: unique tag of the received buffer
107 * @flags: flags (0: fragmented, all others: reserved)
108 * @reserved: reserved
109 */
110struct iwl_rx_completion_desc_bz {
111 __le16 rbid;
112 u8 flags;
113 u8 reserved[1];
114} __packed;
115
116/**
117 * struct iwl_rxq - Rx queue
118 * @id: queue index
119 * @bd: driver's pointer to buffer of receive buffer descriptors (rbd).
120 * Address size is 32 bit in pre-9000 devices and 64 bit in 9000 devices.
121 * In AX210 devices it is a pointer to a list of iwl_rx_transfer_desc's
122 * @bd_dma: bus address of buffer of receive buffer descriptors (rbd)
123 * @used_bd: driver's pointer to buffer of used receive buffer descriptors (rbd)
124 * @used_bd_dma: physical address of buffer of used receive buffer descriptors (rbd)
125 * @read: Shared index to newest available Rx buffer
126 * @write: Shared index to oldest written Rx packet
127 * @write_actual: actual write pointer written to device, since we update in
128 * blocks of 8 only
129 * @free_count: Number of pre-allocated buffers in rx_free
130 * @used_count: Number of RBDs handled to allocator to use for allocation
131 * @write_actual:
132 * @rx_free: list of RBDs with allocated RB ready for use
133 * @rx_used: list of RBDs with no RB attached
134 * @need_update: flag to indicate we need to update read/write index
135 * @rb_stts: driver's pointer to receive buffer status
136 * @rb_stts_dma: bus address of receive buffer status
137 * @lock: per-queue lock
138 * @queue: actual rx queue. Not used for multi-rx queue.
139 * @next_rb_is_fragment: indicates that the previous RB that we handled set
140 * the fragmented flag, so the next one is still another fragment
141 * @napi: NAPI struct for this queue
142 * @queue_size: size of this queue
143 *
144 * NOTE: rx_free and rx_used are used as a FIFO for iwl_rx_mem_buffers
145 */
146struct iwl_rxq {
147 int id;
148 void *bd;
149 dma_addr_t bd_dma;
150 void *used_bd;
151 dma_addr_t used_bd_dma;
152 u32 read;
153 u32 write;
154 u32 free_count;
155 u32 used_count;
156 u32 write_actual;
157 u32 queue_size;
158 struct list_head rx_free;
159 struct list_head rx_used;
160 bool need_update, next_rb_is_fragment;
161 void *rb_stts;
162 dma_addr_t rb_stts_dma;
163 spinlock_t lock;
164 struct napi_struct napi;
165 struct iwl_rx_mem_buffer *queue[RX_QUEUE_SIZE];
166};
167
168/**
169 * struct iwl_rb_allocator - Rx allocator
170 * @req_pending: number of requests the allcator had not processed yet
171 * @req_ready: number of requests honored and ready for claiming
172 * @rbd_allocated: RBDs with pages allocated and ready to be handled to
173 * the queue. This is a list of &struct iwl_rx_mem_buffer
174 * @rbd_empty: RBDs with no page attached for allocator use. This is a list
175 * of &struct iwl_rx_mem_buffer
176 * @lock: protects the rbd_allocated and rbd_empty lists
177 * @alloc_wq: work queue for background calls
178 * @rx_alloc: work struct for background calls
179 */
180struct iwl_rb_allocator {
181 atomic_t req_pending;
182 atomic_t req_ready;
183 struct list_head rbd_allocated;
184 struct list_head rbd_empty;
185 spinlock_t lock;
186 struct workqueue_struct *alloc_wq;
187 struct work_struct rx_alloc;
188};
189
190/**
191 * iwl_get_closed_rb_stts - get closed rb stts from different structs
192 * @trans: transport pointer (for configuration)
193 * @rxq: the rxq to get the rb stts from
194 */
195static inline u16 iwl_get_closed_rb_stts(struct iwl_trans *trans,
196 struct iwl_rxq *rxq)
197{
198 if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_AX210) {
199 __le16 *rb_stts = rxq->rb_stts;
200
201 return le16_to_cpu(READ_ONCE(*rb_stts));
202 } else {
203 struct iwl_rb_status *rb_stts = rxq->rb_stts;
204
205 return le16_to_cpu(READ_ONCE(rb_stts->closed_rb_num)) & 0xFFF;
206 }
207}
208
209#ifdef CONFIG_IWLWIFI_DEBUGFS
210/**
211 * enum iwl_fw_mon_dbgfs_state - the different states of the monitor_data
212 * debugfs file
213 *
214 * @IWL_FW_MON_DBGFS_STATE_CLOSED: the file is closed.
215 * @IWL_FW_MON_DBGFS_STATE_OPEN: the file is open.
216 * @IWL_FW_MON_DBGFS_STATE_DISABLED: the file is disabled, once this state is
217 * set the file can no longer be used.
218 */
219enum iwl_fw_mon_dbgfs_state {
220 IWL_FW_MON_DBGFS_STATE_CLOSED,
221 IWL_FW_MON_DBGFS_STATE_OPEN,
222 IWL_FW_MON_DBGFS_STATE_DISABLED,
223};
224#endif
225
226/**
227 * enum iwl_shared_irq_flags - level of sharing for irq
228 * @IWL_SHARED_IRQ_NON_RX: interrupt vector serves non rx causes.
229 * @IWL_SHARED_IRQ_FIRST_RSS: interrupt vector serves first RSS queue.
230 */
231enum iwl_shared_irq_flags {
232 IWL_SHARED_IRQ_NON_RX = BIT(0),
233 IWL_SHARED_IRQ_FIRST_RSS = BIT(1),
234};
235
236/**
237 * enum iwl_image_response_code - image response values
238 * @IWL_IMAGE_RESP_DEF: the default value of the register
239 * @IWL_IMAGE_RESP_SUCCESS: iml was read successfully
240 * @IWL_IMAGE_RESP_FAIL: iml reading failed
241 */
242enum iwl_image_response_code {
243 IWL_IMAGE_RESP_DEF = 0,
244 IWL_IMAGE_RESP_SUCCESS = 1,
245 IWL_IMAGE_RESP_FAIL = 2,
246};
247
248#ifdef CONFIG_IWLWIFI_DEBUGFS
249/**
250 * struct cont_rec: continuous recording data structure
251 * @prev_wr_ptr: the last address that was read in monitor_data
252 * debugfs file
253 * @prev_wrap_cnt: the wrap count that was used during the last read in
254 * monitor_data debugfs file
255 * @state: the state of monitor_data debugfs file as described
256 * in &iwl_fw_mon_dbgfs_state enum
257 * @mutex: locked while reading from monitor_data debugfs file
258 */
259struct cont_rec {
260 u32 prev_wr_ptr;
261 u32 prev_wrap_cnt;
262 u8 state;
263 /* Used to sync monitor_data debugfs file with driver unload flow */
264 struct mutex mutex;
265};
266#endif
267
268enum iwl_pcie_fw_reset_state {
269 FW_RESET_IDLE,
270 FW_RESET_REQUESTED,
271 FW_RESET_OK,
272 FW_RESET_ERROR,
273};
274
275/**
276 * enum wl_pcie_imr_status - imr dma transfer state
277 * @IMR_D2S_IDLE: default value of the dma transfer
278 * @IMR_D2S_REQUESTED: dma transfer requested
279 * @IMR_D2S_COMPLETED: dma transfer completed
280 * @IMR_D2S_ERROR: dma transfer error
281 */
282enum iwl_pcie_imr_status {
283 IMR_D2S_IDLE,
284 IMR_D2S_REQUESTED,
285 IMR_D2S_COMPLETED,
286 IMR_D2S_ERROR,
287};
288
289/**
290 * struct iwl_trans_pcie - PCIe transport specific data
291 * @rxq: all the RX queue data
292 * @rx_pool: initial pool of iwl_rx_mem_buffer for all the queues
293 * @global_table: table mapping received VID from hw to rxb
294 * @rba: allocator for RX replenishing
295 * @ctxt_info: context information for FW self init
296 * @ctxt_info_gen3: context information for gen3 devices
297 * @prph_info: prph info for self init
298 * @prph_scratch: prph scratch for self init
299 * @ctxt_info_dma_addr: dma addr of context information
300 * @prph_info_dma_addr: dma addr of prph info
301 * @prph_scratch_dma_addr: dma addr of prph scratch
302 * @ctxt_info_dma_addr: dma addr of context information
303 * @iml: image loader image virtual address
304 * @iml_dma_addr: image loader image DMA address
305 * @trans: pointer to the generic transport area
306 * @scd_base_addr: scheduler sram base address in SRAM
307 * @kw: keep warm address
308 * @pnvm_data: holds info about pnvm payloads allocated in DRAM
309 * @reduced_tables_data: holds info about power reduced tablse
310 * payloads allocated in DRAM
311 * @pci_dev: basic pci-network driver stuff
312 * @hw_base: pci hardware address support
313 * @ucode_write_complete: indicates that the ucode has been copied.
314 * @ucode_write_waitq: wait queue for uCode load
315 * @cmd_queue - command queue number
316 * @rx_buf_size: Rx buffer size
317 * @scd_set_active: should the transport configure the SCD for HCMD queue
318 * @rx_page_order: page order for receive buffer size
319 * @rx_buf_bytes: RX buffer (RB) size in bytes
320 * @reg_lock: protect hw register access
321 * @mutex: to protect stop_device / start_fw / start_hw
322 * @fw_mon_data: fw continuous recording data
323 * @cmd_hold_nic_awake: indicates NIC is held awake for APMG workaround
324 * during commands in flight
325 * @msix_entries: array of MSI-X entries
326 * @msix_enabled: true if managed to enable MSI-X
327 * @shared_vec_mask: the type of causes the shared vector handles
328 * (see iwl_shared_irq_flags).
329 * @alloc_vecs: the number of interrupt vectors allocated by the OS
330 * @def_irq: default irq for non rx causes
331 * @fh_init_mask: initial unmasked fh causes
332 * @hw_init_mask: initial unmasked hw causes
333 * @fh_mask: current unmasked fh causes
334 * @hw_mask: current unmasked hw causes
335 * @in_rescan: true if we have triggered a device rescan
336 * @base_rb_stts: base virtual address of receive buffer status for all queues
337 * @base_rb_stts_dma: base physical address of receive buffer status
338 * @supported_dma_mask: DMA mask to validate the actual address against,
339 * will be DMA_BIT_MASK(11) or DMA_BIT_MASK(12) depending on the device
340 * @alloc_page_lock: spinlock for the page allocator
341 * @alloc_page: allocated page to still use parts of
342 * @alloc_page_used: how much of the allocated page was already used (bytes)
343 * @imr_status: imr dma state machine
344 * @imr_waitq: imr wait queue for dma completion
345 * @rf_name: name/version of the CRF, if any
346 * @use_ict: whether or not ICT (interrupt table) is used
347 * @ict_index: current ICT read index
348 * @ict_tbl: ICT table pointer
349 * @ict_tbl_dma: ICT table DMA address
350 * @inta_mask: interrupt (INT-A) mask
351 * @irq_lock: lock to synchronize IRQ handling
352 * @txq_memory: TXQ allocation array
353 * @sx_waitq: waitqueue for Sx transitions
354 * @sx_complete: completion for Sx transitions
355 * @pcie_dbg_dumped_once: indicates PCIe regs were dumped already
356 * @opmode_down: indicates opmode went away
357 * @num_rx_bufs: number of RX buffers to allocate/use
358 * @no_reclaim_cmds: special commands not using reclaim flow
359 * (firmware workaround)
360 * @n_no_reclaim_cmds: number of special commands not using reclaim flow
361 * @affinity_mask: IRQ affinity mask for each RX queue
362 * @debug_rfkill: RF-kill debugging state, -1 for unset, 0/1 for radio
363 * enable/disable
364 * @fw_reset_handshake: indicates FW reset handshake is needed
365 * @fw_reset_state: state of FW reset handshake
366 * @fw_reset_waitq: waitqueue for FW reset handshake
367 * @is_down: indicates the NIC is down
368 * @isr_stats: interrupt statistics
369 * @napi_dev: (fake) netdev for NAPI registration
370 */
371struct iwl_trans_pcie {
372 struct iwl_rxq *rxq;
373 struct iwl_rx_mem_buffer *rx_pool;
374 struct iwl_rx_mem_buffer **global_table;
375 struct iwl_rb_allocator rba;
376 union {
377 struct iwl_context_info *ctxt_info;
378 struct iwl_context_info_gen3 *ctxt_info_gen3;
379 };
380 struct iwl_prph_info *prph_info;
381 struct iwl_prph_scratch *prph_scratch;
382 void *iml;
383 dma_addr_t ctxt_info_dma_addr;
384 dma_addr_t prph_info_dma_addr;
385 dma_addr_t prph_scratch_dma_addr;
386 dma_addr_t iml_dma_addr;
387 struct iwl_trans *trans;
388
389 struct net_device napi_dev;
390
391 /* INT ICT Table */
392 __le32 *ict_tbl;
393 dma_addr_t ict_tbl_dma;
394 int ict_index;
395 bool use_ict;
396 bool is_down, opmode_down;
397 s8 debug_rfkill;
398 struct isr_statistics isr_stats;
399
400 spinlock_t irq_lock;
401 struct mutex mutex;
402 u32 inta_mask;
403 u32 scd_base_addr;
404 struct iwl_dma_ptr kw;
405
406 /* pnvm data */
407 struct iwl_dram_regions pnvm_data;
408 struct iwl_dram_regions reduced_tables_data;
409
410 struct iwl_txq *txq_memory;
411
412 /* PCI bus related data */
413 struct pci_dev *pci_dev;
414 u8 __iomem *hw_base;
415
416 bool ucode_write_complete;
417 bool sx_complete;
418 wait_queue_head_t ucode_write_waitq;
419 wait_queue_head_t sx_waitq;
420
421 u8 n_no_reclaim_cmds;
422 u8 no_reclaim_cmds[MAX_NO_RECLAIM_CMDS];
423 u16 num_rx_bufs;
424
425 enum iwl_amsdu_size rx_buf_size;
426 bool scd_set_active;
427 bool pcie_dbg_dumped_once;
428 u32 rx_page_order;
429 u32 rx_buf_bytes;
430 u32 supported_dma_mask;
431
432 /* allocator lock for the two values below */
433 spinlock_t alloc_page_lock;
434 struct page *alloc_page;
435 u32 alloc_page_used;
436
437 /*protect hw register */
438 spinlock_t reg_lock;
439 bool cmd_hold_nic_awake;
440
441#ifdef CONFIG_IWLWIFI_DEBUGFS
442 struct cont_rec fw_mon_data;
443#endif
444
445 struct msix_entry msix_entries[IWL_MAX_RX_HW_QUEUES];
446 bool msix_enabled;
447 u8 shared_vec_mask;
448 u32 alloc_vecs;
449 u32 def_irq;
450 u32 fh_init_mask;
451 u32 hw_init_mask;
452 u32 fh_mask;
453 u32 hw_mask;
454 cpumask_t affinity_mask[IWL_MAX_RX_HW_QUEUES];
455 u16 tx_cmd_queue_size;
456 bool in_rescan;
457
458 void *base_rb_stts;
459 dma_addr_t base_rb_stts_dma;
460
461 bool fw_reset_handshake;
462 enum iwl_pcie_fw_reset_state fw_reset_state;
463 wait_queue_head_t fw_reset_waitq;
464 enum iwl_pcie_imr_status imr_status;
465 wait_queue_head_t imr_waitq;
466 char rf_name[32];
467};
468
469static inline struct iwl_trans_pcie *
470IWL_TRANS_GET_PCIE_TRANS(struct iwl_trans *trans)
471{
472 return (void *)trans->trans_specific;
473}
474
475static inline void iwl_pcie_clear_irq(struct iwl_trans *trans, int queue)
476{
477 /*
478 * Before sending the interrupt the HW disables it to prevent
479 * a nested interrupt. This is done by writing 1 to the corresponding
480 * bit in the mask register. After handling the interrupt, it should be
481 * re-enabled by clearing this bit. This register is defined as
482 * write 1 clear (W1C) register, meaning that it's being clear
483 * by writing 1 to the bit.
484 */
485 iwl_write32(trans, CSR_MSIX_AUTOMASK_ST_AD, BIT(queue));
486}
487
488static inline struct iwl_trans *
489iwl_trans_pcie_get_trans(struct iwl_trans_pcie *trans_pcie)
490{
491 return container_of((void *)trans_pcie, struct iwl_trans,
492 trans_specific);
493}
494
495/*
496 * Convention: trans API functions: iwl_trans_pcie_XXX
497 * Other functions: iwl_pcie_XXX
498 */
499struct iwl_trans
500*iwl_trans_pcie_alloc(struct pci_dev *pdev,
501 const struct pci_device_id *ent,
502 const struct iwl_cfg_trans_params *cfg_trans);
503void iwl_trans_pcie_free(struct iwl_trans *trans);
504void iwl_trans_pcie_free_pnvm_dram_regions(struct iwl_dram_regions *dram_regions,
505 struct device *dev);
506
507bool __iwl_trans_pcie_grab_nic_access(struct iwl_trans *trans);
508#define _iwl_trans_pcie_grab_nic_access(trans) \
509 __cond_lock(nic_access_nobh, \
510 likely(__iwl_trans_pcie_grab_nic_access(trans)))
511
512/*****************************************************
513* RX
514******************************************************/
515int iwl_pcie_rx_init(struct iwl_trans *trans);
516int iwl_pcie_gen2_rx_init(struct iwl_trans *trans);
517irqreturn_t iwl_pcie_msix_isr(int irq, void *data);
518irqreturn_t iwl_pcie_irq_handler(int irq, void *dev_id);
519irqreturn_t iwl_pcie_irq_msix_handler(int irq, void *dev_id);
520irqreturn_t iwl_pcie_irq_rx_msix_handler(int irq, void *dev_id);
521int iwl_pcie_rx_stop(struct iwl_trans *trans);
522void iwl_pcie_rx_free(struct iwl_trans *trans);
523void iwl_pcie_free_rbs_pool(struct iwl_trans *trans);
524void iwl_pcie_rx_init_rxb_lists(struct iwl_rxq *rxq);
525void iwl_pcie_rx_napi_sync(struct iwl_trans *trans);
526void iwl_pcie_rxq_alloc_rbs(struct iwl_trans *trans, gfp_t priority,
527 struct iwl_rxq *rxq);
528
529/*****************************************************
530* ICT - interrupt handling
531******************************************************/
532irqreturn_t iwl_pcie_isr(int irq, void *data);
533int iwl_pcie_alloc_ict(struct iwl_trans *trans);
534void iwl_pcie_free_ict(struct iwl_trans *trans);
535void iwl_pcie_reset_ict(struct iwl_trans *trans);
536void iwl_pcie_disable_ict(struct iwl_trans *trans);
537
538/*****************************************************
539* TX / HCMD
540******************************************************/
541int iwl_pcie_tx_init(struct iwl_trans *trans);
542void iwl_pcie_tx_start(struct iwl_trans *trans, u32 scd_base_addr);
543int iwl_pcie_tx_stop(struct iwl_trans *trans);
544void iwl_pcie_tx_free(struct iwl_trans *trans);
545bool iwl_trans_pcie_txq_enable(struct iwl_trans *trans, int queue, u16 ssn,
546 const struct iwl_trans_txq_scd_cfg *cfg,
547 unsigned int wdg_timeout);
548void iwl_trans_pcie_txq_disable(struct iwl_trans *trans, int queue,
549 bool configure_scd);
550void iwl_trans_pcie_txq_set_shared_mode(struct iwl_trans *trans, u32 txq_id,
551 bool shared_mode);
552int iwl_trans_pcie_tx(struct iwl_trans *trans, struct sk_buff *skb,
553 struct iwl_device_tx_cmd *dev_cmd, int txq_id);
554void iwl_pcie_txq_check_wrptrs(struct iwl_trans *trans);
555int iwl_trans_pcie_send_hcmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
556void iwl_pcie_hcmd_complete(struct iwl_trans *trans,
557 struct iwl_rx_cmd_buffer *rxb);
558void iwl_trans_pcie_tx_reset(struct iwl_trans *trans);
559
560/*****************************************************
561* Error handling
562******************************************************/
563void iwl_pcie_dump_csr(struct iwl_trans *trans);
564
565/*****************************************************
566* Helpers
567******************************************************/
568static inline void _iwl_disable_interrupts(struct iwl_trans *trans)
569{
570 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
571
572 clear_bit(STATUS_INT_ENABLED, &trans->status);
573 if (!trans_pcie->msix_enabled) {
574 /* disable interrupts from uCode/NIC to host */
575 iwl_write32(trans, CSR_INT_MASK, 0x00000000);
576
577 /* acknowledge/clear/reset any interrupts still pending
578 * from uCode or flow handler (Rx/Tx DMA) */
579 iwl_write32(trans, CSR_INT, 0xffffffff);
580 iwl_write32(trans, CSR_FH_INT_STATUS, 0xffffffff);
581 } else {
582 /* disable all the interrupt we might use */
583 iwl_write32(trans, CSR_MSIX_FH_INT_MASK_AD,
584 trans_pcie->fh_init_mask);
585 iwl_write32(trans, CSR_MSIX_HW_INT_MASK_AD,
586 trans_pcie->hw_init_mask);
587 }
588 IWL_DEBUG_ISR(trans, "Disabled interrupts\n");
589}
590
591static inline int iwl_pcie_get_num_sections(const struct fw_img *fw,
592 int start)
593{
594 int i = 0;
595
596 while (start < fw->num_sec &&
597 fw->sec[start].offset != CPU1_CPU2_SEPARATOR_SECTION &&
598 fw->sec[start].offset != PAGING_SEPARATOR_SECTION) {
599 start++;
600 i++;
601 }
602
603 return i;
604}
605
606static inline void iwl_pcie_ctxt_info_free_fw_img(struct iwl_trans *trans)
607{
608 struct iwl_self_init_dram *dram = &trans->init_dram;
609 int i;
610
611 if (!dram->fw) {
612 WARN_ON(dram->fw_cnt);
613 return;
614 }
615
616 for (i = 0; i < dram->fw_cnt; i++)
617 dma_free_coherent(trans->dev, dram->fw[i].size,
618 dram->fw[i].block, dram->fw[i].physical);
619
620 kfree(dram->fw);
621 dram->fw_cnt = 0;
622 dram->fw = NULL;
623}
624
625static inline void iwl_disable_interrupts(struct iwl_trans *trans)
626{
627 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
628
629 spin_lock_bh(&trans_pcie->irq_lock);
630 _iwl_disable_interrupts(trans);
631 spin_unlock_bh(&trans_pcie->irq_lock);
632}
633
634static inline void _iwl_enable_interrupts(struct iwl_trans *trans)
635{
636 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
637
638 IWL_DEBUG_ISR(trans, "Enabling interrupts\n");
639 set_bit(STATUS_INT_ENABLED, &trans->status);
640 if (!trans_pcie->msix_enabled) {
641 trans_pcie->inta_mask = CSR_INI_SET_MASK;
642 iwl_write32(trans, CSR_INT_MASK, trans_pcie->inta_mask);
643 } else {
644 /*
645 * fh/hw_mask keeps all the unmasked causes.
646 * Unlike msi, in msix cause is enabled when it is unset.
647 */
648 trans_pcie->hw_mask = trans_pcie->hw_init_mask;
649 trans_pcie->fh_mask = trans_pcie->fh_init_mask;
650 iwl_write32(trans, CSR_MSIX_FH_INT_MASK_AD,
651 ~trans_pcie->fh_mask);
652 iwl_write32(trans, CSR_MSIX_HW_INT_MASK_AD,
653 ~trans_pcie->hw_mask);
654 }
655}
656
657static inline void iwl_enable_interrupts(struct iwl_trans *trans)
658{
659 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
660
661 spin_lock_bh(&trans_pcie->irq_lock);
662 _iwl_enable_interrupts(trans);
663 spin_unlock_bh(&trans_pcie->irq_lock);
664}
665static inline void iwl_enable_hw_int_msk_msix(struct iwl_trans *trans, u32 msk)
666{
667 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
668
669 iwl_write32(trans, CSR_MSIX_HW_INT_MASK_AD, ~msk);
670 trans_pcie->hw_mask = msk;
671}
672
673static inline void iwl_enable_fh_int_msk_msix(struct iwl_trans *trans, u32 msk)
674{
675 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
676
677 iwl_write32(trans, CSR_MSIX_FH_INT_MASK_AD, ~msk);
678 trans_pcie->fh_mask = msk;
679}
680
681static inline void iwl_enable_fw_load_int(struct iwl_trans *trans)
682{
683 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
684
685 IWL_DEBUG_ISR(trans, "Enabling FW load interrupt\n");
686 if (!trans_pcie->msix_enabled) {
687 trans_pcie->inta_mask = CSR_INT_BIT_FH_TX;
688 iwl_write32(trans, CSR_INT_MASK, trans_pcie->inta_mask);
689 } else {
690 iwl_write32(trans, CSR_MSIX_HW_INT_MASK_AD,
691 trans_pcie->hw_init_mask);
692 iwl_enable_fh_int_msk_msix(trans,
693 MSIX_FH_INT_CAUSES_D2S_CH0_NUM);
694 }
695}
696
697static inline void iwl_enable_fw_load_int_ctx_info(struct iwl_trans *trans)
698{
699 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
700
701 IWL_DEBUG_ISR(trans, "Enabling ALIVE interrupt only\n");
702
703 if (!trans_pcie->msix_enabled) {
704 /*
705 * When we'll receive the ALIVE interrupt, the ISR will call
706 * iwl_enable_fw_load_int_ctx_info again to set the ALIVE
707 * interrupt (which is not really needed anymore) but also the
708 * RX interrupt which will allow us to receive the ALIVE
709 * notification (which is Rx) and continue the flow.
710 */
711 trans_pcie->inta_mask = CSR_INT_BIT_ALIVE | CSR_INT_BIT_FH_RX;
712 iwl_write32(trans, CSR_INT_MASK, trans_pcie->inta_mask);
713 } else {
714 iwl_enable_hw_int_msk_msix(trans,
715 MSIX_HW_INT_CAUSES_REG_ALIVE);
716 /*
717 * Leave all the FH causes enabled to get the ALIVE
718 * notification.
719 */
720 iwl_enable_fh_int_msk_msix(trans, trans_pcie->fh_init_mask);
721 }
722}
723
724static inline const char *queue_name(struct device *dev,
725 struct iwl_trans_pcie *trans_p, int i)
726{
727 if (trans_p->shared_vec_mask) {
728 int vec = trans_p->shared_vec_mask &
729 IWL_SHARED_IRQ_FIRST_RSS ? 1 : 0;
730
731 if (i == 0)
732 return DRV_NAME ":shared_IRQ";
733
734 return devm_kasprintf(dev, GFP_KERNEL,
735 DRV_NAME ":queue_%d", i + vec);
736 }
737 if (i == 0)
738 return DRV_NAME ":default_queue";
739
740 if (i == trans_p->alloc_vecs - 1)
741 return DRV_NAME ":exception";
742
743 return devm_kasprintf(dev, GFP_KERNEL,
744 DRV_NAME ":queue_%d", i);
745}
746
747static inline void iwl_enable_rfkill_int(struct iwl_trans *trans)
748{
749 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
750
751 IWL_DEBUG_ISR(trans, "Enabling rfkill interrupt\n");
752 if (!trans_pcie->msix_enabled) {
753 trans_pcie->inta_mask = CSR_INT_BIT_RF_KILL;
754 iwl_write32(trans, CSR_INT_MASK, trans_pcie->inta_mask);
755 } else {
756 iwl_write32(trans, CSR_MSIX_FH_INT_MASK_AD,
757 trans_pcie->fh_init_mask);
758 iwl_enable_hw_int_msk_msix(trans,
759 MSIX_HW_INT_CAUSES_REG_RF_KILL);
760 }
761
762 if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_9000) {
763 /*
764 * On 9000-series devices this bit isn't enabled by default, so
765 * when we power down the device we need set the bit to allow it
766 * to wake up the PCI-E bus for RF-kill interrupts.
767 */
768 iwl_set_bit(trans, CSR_GP_CNTRL,
769 CSR_GP_CNTRL_REG_FLAG_RFKILL_WAKE_L1A_EN);
770 }
771}
772
773void iwl_pcie_handle_rfkill_irq(struct iwl_trans *trans, bool from_irq);
774
775static inline bool iwl_is_rfkill_set(struct iwl_trans *trans)
776{
777 struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
778
779 lockdep_assert_held(&trans_pcie->mutex);
780
781 if (trans_pcie->debug_rfkill == 1)
782 return true;
783
784 return !(iwl_read32(trans, CSR_GP_CNTRL) &
785 CSR_GP_CNTRL_REG_FLAG_HW_RF_KILL_SW);
786}
787
788static inline void __iwl_trans_pcie_set_bits_mask(struct iwl_trans *trans,
789 u32 reg, u32 mask, u32 value)
790{
791 u32 v;
792
793#ifdef CONFIG_IWLWIFI_DEBUG
794 WARN_ON_ONCE(value & ~mask);
795#endif
796
797 v = iwl_read32(trans, reg);
798 v &= ~mask;
799 v |= value;
800 iwl_write32(trans, reg, v);
801}
802
803static inline void __iwl_trans_pcie_clear_bit(struct iwl_trans *trans,
804 u32 reg, u32 mask)
805{
806 __iwl_trans_pcie_set_bits_mask(trans, reg, mask, 0);
807}
808
809static inline void __iwl_trans_pcie_set_bit(struct iwl_trans *trans,
810 u32 reg, u32 mask)
811{
812 __iwl_trans_pcie_set_bits_mask(trans, reg, mask, mask);
813}
814
815static inline bool iwl_pcie_dbg_on(struct iwl_trans *trans)
816{
817 return (trans->dbg.dest_tlv || iwl_trans_dbg_ini_valid(trans));
818}
819
820void iwl_trans_pcie_rf_kill(struct iwl_trans *trans, bool state, bool from_irq);
821void iwl_trans_pcie_dump_regs(struct iwl_trans *trans);
822
823#ifdef CONFIG_IWLWIFI_DEBUGFS
824void iwl_trans_pcie_dbgfs_register(struct iwl_trans *trans);
825#else
826static inline void iwl_trans_pcie_dbgfs_register(struct iwl_trans *trans) { }
827#endif
828
829void iwl_pcie_rx_allocator_work(struct work_struct *data);
830
831/* common functions that are used by gen2 transport */
832int iwl_pcie_gen2_apm_init(struct iwl_trans *trans);
833void iwl_pcie_apm_config(struct iwl_trans *trans);
834int iwl_pcie_prepare_card_hw(struct iwl_trans *trans);
835void iwl_pcie_synchronize_irqs(struct iwl_trans *trans);
836bool iwl_pcie_check_hw_rf_kill(struct iwl_trans *trans);
837void iwl_trans_pcie_handle_stop_rfkill(struct iwl_trans *trans,
838 bool was_in_rfkill);
839void iwl_pcie_apm_stop_master(struct iwl_trans *trans);
840void iwl_pcie_conf_msix_hw(struct iwl_trans_pcie *trans_pcie);
841int iwl_pcie_alloc_dma_ptr(struct iwl_trans *trans,
842 struct iwl_dma_ptr *ptr, size_t size);
843void iwl_pcie_free_dma_ptr(struct iwl_trans *trans, struct iwl_dma_ptr *ptr);
844void iwl_pcie_apply_destination(struct iwl_trans *trans);
845
846/* common functions that are used by gen3 transport */
847void iwl_pcie_alloc_fw_monitor(struct iwl_trans *trans, u8 max_power);
848
849/* transport gen 2 exported functions */
850int iwl_trans_pcie_gen2_start_fw(struct iwl_trans *trans,
851 const struct fw_img *fw, bool run_in_rfkill);
852void iwl_trans_pcie_gen2_fw_alive(struct iwl_trans *trans, u32 scd_addr);
853int iwl_trans_pcie_gen2_send_hcmd(struct iwl_trans *trans,
854 struct iwl_host_cmd *cmd);
855void iwl_trans_pcie_gen2_stop_device(struct iwl_trans *trans);
856void _iwl_trans_pcie_gen2_stop_device(struct iwl_trans *trans);
857void iwl_pcie_d3_complete_suspend(struct iwl_trans *trans,
858 bool test, bool reset);
859int iwl_pcie_gen2_enqueue_hcmd(struct iwl_trans *trans,
860 struct iwl_host_cmd *cmd);
861int iwl_pcie_enqueue_hcmd(struct iwl_trans *trans,
862 struct iwl_host_cmd *cmd);
863void iwl_trans_pcie_copy_imr_fh(struct iwl_trans *trans,
864 u32 dst_addr, u64 src_addr, u32 byte_cnt);
865int iwl_trans_pcie_copy_imr(struct iwl_trans *trans,
866 u32 dst_addr, u64 src_addr, u32 byte_cnt);
867
868#endif /* __iwl_trans_int_pcie_h__ */