These changes are the raw update to linux-4.4.6-rt14. Kernel sources
[kvmfornfv.git] / kernel / drivers / net / wireless / iwlwifi / pcie / internal.h
1 /******************************************************************************
2  *
3  * Copyright(c) 2003 - 2015 Intel Corporation. All rights reserved.
4  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
5  *
6  * Portions of this file are derived from the ipw3945 project, as well
7  * as portions of the ieee80211 subsystem header files.
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of version 2 of the GNU General Public License as
11  * published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful, but WITHOUT
14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
16  * more details.
17  *
18  * You should have received a copy of the GNU General Public License along with
19  * this program; if not, write to the Free Software Foundation, Inc.,
20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
21  *
22  * The full GNU General Public License is included in this distribution in the
23  * file called LICENSE.
24  *
25  * Contact Information:
26  *  Intel Linux Wireless <ilw@linux.intel.com>
27  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
28  *
29  *****************************************************************************/
30 #ifndef __iwl_trans_int_pcie_h__
31 #define __iwl_trans_int_pcie_h__
32
33 #include <linux/spinlock.h>
34 #include <linux/interrupt.h>
35 #include <linux/skbuff.h>
36 #include <linux/wait.h>
37 #include <linux/pci.h>
38 #include <linux/timer.h>
39
40 #include "iwl-fh.h"
41 #include "iwl-csr.h"
42 #include "iwl-trans.h"
43 #include "iwl-debug.h"
44 #include "iwl-io.h"
45 #include "iwl-op-mode.h"
46
47 /* We need 2 entries for the TX command and header, and another one might
48  * be needed for potential data in the SKB's head. The remaining ones can
49  * be used for frags.
50  */
51 #define IWL_PCIE_MAX_FRAGS (IWL_NUM_OF_TBS - 3)
52
53 /*
54  * RX related structures and functions
55  */
56 #define RX_NUM_QUEUES 1
57 #define RX_POST_REQ_ALLOC 2
58 #define RX_CLAIM_REQ_ALLOC 8
59 #define RX_POOL_SIZE ((RX_CLAIM_REQ_ALLOC - RX_POST_REQ_ALLOC) * RX_NUM_QUEUES)
60 #define RX_LOW_WATERMARK 8
61
62 struct iwl_host_cmd;
63
64 /*This file includes the declaration that are internal to the
65  * trans_pcie layer */
66
67 struct iwl_rx_mem_buffer {
68         dma_addr_t page_dma;
69         struct page *page;
70         struct list_head list;
71 };
72
73 /**
74  * struct isr_statistics - interrupt statistics
75  *
76  */
77 struct isr_statistics {
78         u32 hw;
79         u32 sw;
80         u32 err_code;
81         u32 sch;
82         u32 alive;
83         u32 rfkill;
84         u32 ctkill;
85         u32 wakeup;
86         u32 rx;
87         u32 tx;
88         u32 unhandled;
89 };
90
91 /**
92  * struct iwl_rxq - Rx queue
93  * @bd: driver's pointer to buffer of receive buffer descriptors (rbd)
94  * @bd_dma: bus address of buffer of receive buffer descriptors (rbd)
95  * @read: Shared index to newest available Rx buffer
96  * @write: Shared index to oldest written Rx packet
97  * @free_count: Number of pre-allocated buffers in rx_free
98  * @used_count: Number of RBDs handled to allocator to use for allocation
99  * @write_actual:
100  * @rx_free: list of RBDs with allocated RB ready for use
101  * @rx_used: list of RBDs with no RB attached
102  * @need_update: flag to indicate we need to update read/write index
103  * @rb_stts: driver's pointer to receive buffer status
104  * @rb_stts_dma: bus address of receive buffer status
105  * @lock:
106  * @pool: initial pool of iwl_rx_mem_buffer for the queue
107  * @queue: actual rx queue
108  *
109  * NOTE:  rx_free and rx_used are used as a FIFO for iwl_rx_mem_buffers
110  */
111 struct iwl_rxq {
112         __le32 *bd;
113         dma_addr_t bd_dma;
114         u32 read;
115         u32 write;
116         u32 free_count;
117         u32 used_count;
118         u32 write_actual;
119         struct list_head rx_free;
120         struct list_head rx_used;
121         bool need_update;
122         struct iwl_rb_status *rb_stts;
123         dma_addr_t rb_stts_dma;
124         spinlock_t lock;
125         struct iwl_rx_mem_buffer pool[RX_QUEUE_SIZE];
126         struct iwl_rx_mem_buffer *queue[RX_QUEUE_SIZE];
127 };
128
129 /**
130  * struct iwl_rb_allocator - Rx allocator
131  * @pool: initial pool of allocator
132  * @req_pending: number of requests the allcator had not processed yet
133  * @req_ready: number of requests honored and ready for claiming
134  * @rbd_allocated: RBDs with pages allocated and ready to be handled to
135  *      the queue. This is a list of &struct iwl_rx_mem_buffer
136  * @rbd_empty: RBDs with no page attached for allocator use. This is a list
137  *      of &struct iwl_rx_mem_buffer
138  * @lock: protects the rbd_allocated and rbd_empty lists
139  * @alloc_wq: work queue for background calls
140  * @rx_alloc: work struct for background calls
141  */
142 struct iwl_rb_allocator {
143         struct iwl_rx_mem_buffer pool[RX_POOL_SIZE];
144         atomic_t req_pending;
145         atomic_t req_ready;
146         struct list_head rbd_allocated;
147         struct list_head rbd_empty;
148         spinlock_t lock;
149         struct workqueue_struct *alloc_wq;
150         struct work_struct rx_alloc;
151 };
152
153 struct iwl_dma_ptr {
154         dma_addr_t dma;
155         void *addr;
156         size_t size;
157 };
158
159 /**
160  * iwl_queue_inc_wrap - increment queue index, wrap back to beginning
161  * @index -- current index
162  */
163 static inline int iwl_queue_inc_wrap(int index)
164 {
165         return ++index & (TFD_QUEUE_SIZE_MAX - 1);
166 }
167
168 /**
169  * iwl_queue_dec_wrap - decrement queue index, wrap back to end
170  * @index -- current index
171  */
172 static inline int iwl_queue_dec_wrap(int index)
173 {
174         return --index & (TFD_QUEUE_SIZE_MAX - 1);
175 }
176
177 struct iwl_cmd_meta {
178         /* only for SYNC commands, iff the reply skb is wanted */
179         struct iwl_host_cmd *source;
180         u32 flags;
181 };
182
183 /*
184  * Generic queue structure
185  *
186  * Contains common data for Rx and Tx queues.
187  *
188  * Note the difference between TFD_QUEUE_SIZE_MAX and n_window: the hardware
189  * always assumes 256 descriptors, so TFD_QUEUE_SIZE_MAX is always 256 (unless
190  * there might be HW changes in the future). For the normal TX
191  * queues, n_window, which is the size of the software queue data
192  * is also 256; however, for the command queue, n_window is only
193  * 32 since we don't need so many commands pending. Since the HW
194  * still uses 256 BDs for DMA though, TFD_QUEUE_SIZE_MAX stays 256. As a result,
195  * the software buffers (in the variables @meta, @txb in struct
196  * iwl_txq) only have 32 entries, while the HW buffers (@tfds in
197  * the same struct) have 256.
198  * This means that we end up with the following:
199  *  HW entries: | 0 | ... | N * 32 | ... | N * 32 + 31 | ... | 255 |
200  *  SW entries:           | 0      | ... | 31          |
201  * where N is a number between 0 and 7. This means that the SW
202  * data is a window overlayed over the HW queue.
203  */
204 struct iwl_queue {
205         int write_ptr;       /* 1-st empty entry (index) host_w*/
206         int read_ptr;         /* last used entry (index) host_r*/
207         /* use for monitoring and recovering the stuck queue */
208         dma_addr_t dma_addr;   /* physical addr for BD's */
209         int n_window;          /* safe queue window */
210         u32 id;
211         int low_mark;          /* low watermark, resume queue if free
212                                 * space more than this */
213         int high_mark;         /* high watermark, stop queue if free
214                                 * space less than this */
215 };
216
217 #define TFD_TX_CMD_SLOTS 256
218 #define TFD_CMD_SLOTS 32
219
220 /*
221  * The FH will write back to the first TB only, so we need
222  * to copy some data into the buffer regardless of whether
223  * it should be mapped or not. This indicates how big the
224  * first TB must be to include the scratch buffer. Since
225  * the scratch is 4 bytes at offset 12, it's 16 now. If we
226  * make it bigger then allocations will be bigger and copy
227  * slower, so that's probably not useful.
228  */
229 #define IWL_HCMD_SCRATCHBUF_SIZE        16
230
231 struct iwl_pcie_txq_entry {
232         struct iwl_device_cmd *cmd;
233         struct sk_buff *skb;
234         /* buffer to free after command completes */
235         const void *free_buf;
236         struct iwl_cmd_meta meta;
237 };
238
239 struct iwl_pcie_txq_scratch_buf {
240         struct iwl_cmd_header hdr;
241         u8 buf[8];
242         __le32 scratch;
243 };
244
245 /**
246  * struct iwl_txq - Tx Queue for DMA
247  * @q: generic Rx/Tx queue descriptor
248  * @tfds: transmit frame descriptors (DMA memory)
249  * @scratchbufs: start of command headers, including scratch buffers, for
250  *      the writeback -- this is DMA memory and an array holding one buffer
251  *      for each command on the queue
252  * @scratchbufs_dma: DMA address for the scratchbufs start
253  * @entries: transmit entries (driver state)
254  * @lock: queue lock
255  * @stuck_timer: timer that fires if queue gets stuck
256  * @trans_pcie: pointer back to transport (for timer)
257  * @need_update: indicates need to update read/write index
258  * @active: stores if queue is active
259  * @ampdu: true if this queue is an ampdu queue for an specific RA/TID
260  * @wd_timeout: queue watchdog timeout (jiffies) - per queue
261  * @frozen: tx stuck queue timer is frozen
262  * @frozen_expiry_remainder: remember how long until the timer fires
263  *
264  * A Tx queue consists of circular buffer of BDs (a.k.a. TFDs, transmit frame
265  * descriptors) and required locking structures.
266  */
267 struct iwl_txq {
268         struct iwl_queue q;
269         struct iwl_tfd *tfds;
270         struct iwl_pcie_txq_scratch_buf *scratchbufs;
271         dma_addr_t scratchbufs_dma;
272         struct iwl_pcie_txq_entry *entries;
273         spinlock_t lock;
274         unsigned long frozen_expiry_remainder;
275         struct timer_list stuck_timer;
276         struct iwl_trans_pcie *trans_pcie;
277         bool need_update;
278         bool frozen;
279         u8 active;
280         bool ampdu;
281         unsigned long wd_timeout;
282 };
283
284 static inline dma_addr_t
285 iwl_pcie_get_scratchbuf_dma(struct iwl_txq *txq, int idx)
286 {
287         return txq->scratchbufs_dma +
288                sizeof(struct iwl_pcie_txq_scratch_buf) * idx;
289 }
290
291 /**
292  * struct iwl_trans_pcie - PCIe transport specific data
293  * @rxq: all the RX queue data
294  * @rba: allocator for RX replenishing
295  * @drv - pointer to iwl_drv
296  * @trans: pointer to the generic transport area
297  * @scd_base_addr: scheduler sram base address in SRAM
298  * @scd_bc_tbls: pointer to the byte count table of the scheduler
299  * @kw: keep warm address
300  * @pci_dev: basic pci-network driver stuff
301  * @hw_base: pci hardware address support
302  * @ucode_write_complete: indicates that the ucode has been copied.
303  * @ucode_write_waitq: wait queue for uCode load
304  * @cmd_queue - command queue number
305  * @rx_buf_size_8k: 8 kB RX buffer size
306  * @bc_table_dword: true if the BC table expects DWORD (as opposed to bytes)
307  * @scd_set_active: should the transport configure the SCD for HCMD queue
308  * @wide_cmd_header: true when ucode supports wide command header format
309  * @rx_page_order: page order for receive buffer size
310  * @reg_lock: protect hw register access
311  * @mutex: to protect stop_device / start_fw / start_hw
312  * @cmd_in_flight: true when we have a host command in flight
313  * @fw_mon_phys: physical address of the buffer for the firmware monitor
314  * @fw_mon_page: points to the first page of the buffer for the firmware monitor
315  * @fw_mon_size: size of the buffer for the firmware monitor
316  */
317 struct iwl_trans_pcie {
318         struct iwl_rxq rxq;
319         struct iwl_rb_allocator rba;
320         struct iwl_trans *trans;
321         struct iwl_drv *drv;
322
323         struct net_device napi_dev;
324         struct napi_struct napi;
325
326         /* INT ICT Table */
327         __le32 *ict_tbl;
328         dma_addr_t ict_tbl_dma;
329         int ict_index;
330         bool use_ict;
331         bool is_down;
332         struct isr_statistics isr_stats;
333
334         spinlock_t irq_lock;
335         struct mutex mutex;
336         u32 inta_mask;
337         u32 scd_base_addr;
338         struct iwl_dma_ptr scd_bc_tbls;
339         struct iwl_dma_ptr kw;
340
341         struct iwl_txq *txq;
342         unsigned long queue_used[BITS_TO_LONGS(IWL_MAX_HW_QUEUES)];
343         unsigned long queue_stopped[BITS_TO_LONGS(IWL_MAX_HW_QUEUES)];
344
345         /* PCI bus related data */
346         struct pci_dev *pci_dev;
347         void __iomem *hw_base;
348
349         bool ucode_write_complete;
350         wait_queue_head_t ucode_write_waitq;
351         wait_queue_head_t wait_command_queue;
352
353         u8 cmd_queue;
354         u8 cmd_fifo;
355         unsigned int cmd_q_wdg_timeout;
356         u8 n_no_reclaim_cmds;
357         u8 no_reclaim_cmds[MAX_NO_RECLAIM_CMDS];
358
359         bool rx_buf_size_8k;
360         bool bc_table_dword;
361         bool scd_set_active;
362         bool wide_cmd_header;
363         u32 rx_page_order;
364
365         const char *const *command_names;
366
367         /*protect hw register */
368         spinlock_t reg_lock;
369         bool cmd_hold_nic_awake;
370         bool ref_cmd_in_flight;
371
372         /* protect ref counter */
373         spinlock_t ref_lock;
374         u32 ref_count;
375
376         dma_addr_t fw_mon_phys;
377         struct page *fw_mon_page;
378         u32 fw_mon_size;
379 };
380
381 #define IWL_TRANS_GET_PCIE_TRANS(_iwl_trans) \
382         ((struct iwl_trans_pcie *) ((_iwl_trans)->trans_specific))
383
384 static inline struct iwl_trans *
385 iwl_trans_pcie_get_trans(struct iwl_trans_pcie *trans_pcie)
386 {
387         return container_of((void *)trans_pcie, struct iwl_trans,
388                             trans_specific);
389 }
390
391 /*
392  * Convention: trans API functions: iwl_trans_pcie_XXX
393  *      Other functions: iwl_pcie_XXX
394  */
395 struct iwl_trans *iwl_trans_pcie_alloc(struct pci_dev *pdev,
396                                        const struct pci_device_id *ent,
397                                        const struct iwl_cfg *cfg);
398 void iwl_trans_pcie_free(struct iwl_trans *trans);
399
400 /*****************************************************
401 * RX
402 ******************************************************/
403 int iwl_pcie_rx_init(struct iwl_trans *trans);
404 irqreturn_t iwl_pcie_irq_handler(int irq, void *dev_id);
405 int iwl_pcie_rx_stop(struct iwl_trans *trans);
406 void iwl_pcie_rx_free(struct iwl_trans *trans);
407
408 /*****************************************************
409 * ICT - interrupt handling
410 ******************************************************/
411 irqreturn_t iwl_pcie_isr(int irq, void *data);
412 int iwl_pcie_alloc_ict(struct iwl_trans *trans);
413 void iwl_pcie_free_ict(struct iwl_trans *trans);
414 void iwl_pcie_reset_ict(struct iwl_trans *trans);
415 void iwl_pcie_disable_ict(struct iwl_trans *trans);
416
417 /*****************************************************
418 * TX / HCMD
419 ******************************************************/
420 int iwl_pcie_tx_init(struct iwl_trans *trans);
421 void iwl_pcie_tx_start(struct iwl_trans *trans, u32 scd_base_addr);
422 int iwl_pcie_tx_stop(struct iwl_trans *trans);
423 void iwl_pcie_tx_free(struct iwl_trans *trans);
424 void iwl_trans_pcie_txq_enable(struct iwl_trans *trans, int queue, u16 ssn,
425                                const struct iwl_trans_txq_scd_cfg *cfg,
426                                unsigned int wdg_timeout);
427 void iwl_trans_pcie_txq_disable(struct iwl_trans *trans, int queue,
428                                 bool configure_scd);
429 int iwl_trans_pcie_tx(struct iwl_trans *trans, struct sk_buff *skb,
430                       struct iwl_device_cmd *dev_cmd, int txq_id);
431 void iwl_pcie_txq_check_wrptrs(struct iwl_trans *trans);
432 int iwl_trans_pcie_send_hcmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
433 void iwl_pcie_hcmd_complete(struct iwl_trans *trans,
434                             struct iwl_rx_cmd_buffer *rxb);
435 void iwl_trans_pcie_reclaim(struct iwl_trans *trans, int txq_id, int ssn,
436                             struct sk_buff_head *skbs);
437 void iwl_trans_pcie_tx_reset(struct iwl_trans *trans);
438
439 void iwl_trans_pcie_ref(struct iwl_trans *trans);
440 void iwl_trans_pcie_unref(struct iwl_trans *trans);
441
442 static inline u16 iwl_pcie_tfd_tb_get_len(struct iwl_tfd *tfd, u8 idx)
443 {
444         struct iwl_tfd_tb *tb = &tfd->tbs[idx];
445
446         return le16_to_cpu(tb->hi_n_len) >> 4;
447 }
448
449 /*****************************************************
450 * Error handling
451 ******************************************************/
452 void iwl_pcie_dump_csr(struct iwl_trans *trans);
453
454 /*****************************************************
455 * Helpers
456 ******************************************************/
457 static inline void iwl_disable_interrupts(struct iwl_trans *trans)
458 {
459         clear_bit(STATUS_INT_ENABLED, &trans->status);
460
461         /* disable interrupts from uCode/NIC to host */
462         iwl_write32(trans, CSR_INT_MASK, 0x00000000);
463
464         /* acknowledge/clear/reset any interrupts still pending
465          * from uCode or flow handler (Rx/Tx DMA) */
466         iwl_write32(trans, CSR_INT, 0xffffffff);
467         iwl_write32(trans, CSR_FH_INT_STATUS, 0xffffffff);
468         IWL_DEBUG_ISR(trans, "Disabled interrupts\n");
469 }
470
471 static inline void iwl_enable_interrupts(struct iwl_trans *trans)
472 {
473         struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
474
475         IWL_DEBUG_ISR(trans, "Enabling interrupts\n");
476         set_bit(STATUS_INT_ENABLED, &trans->status);
477         trans_pcie->inta_mask = CSR_INI_SET_MASK;
478         iwl_write32(trans, CSR_INT_MASK, trans_pcie->inta_mask);
479 }
480
481 static inline void iwl_enable_rfkill_int(struct iwl_trans *trans)
482 {
483         struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
484
485         IWL_DEBUG_ISR(trans, "Enabling rfkill interrupt\n");
486         trans_pcie->inta_mask = CSR_INT_BIT_RF_KILL;
487         iwl_write32(trans, CSR_INT_MASK, trans_pcie->inta_mask);
488 }
489
490 static inline void iwl_wake_queue(struct iwl_trans *trans,
491                                   struct iwl_txq *txq)
492 {
493         struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
494
495         if (test_and_clear_bit(txq->q.id, trans_pcie->queue_stopped)) {
496                 IWL_DEBUG_TX_QUEUES(trans, "Wake hwq %d\n", txq->q.id);
497                 iwl_op_mode_queue_not_full(trans->op_mode, txq->q.id);
498         }
499 }
500
501 static inline void iwl_stop_queue(struct iwl_trans *trans,
502                                   struct iwl_txq *txq)
503 {
504         struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
505
506         if (!test_and_set_bit(txq->q.id, trans_pcie->queue_stopped)) {
507                 iwl_op_mode_queue_full(trans->op_mode, txq->q.id);
508                 IWL_DEBUG_TX_QUEUES(trans, "Stop hwq %d\n", txq->q.id);
509         } else
510                 IWL_DEBUG_TX_QUEUES(trans, "hwq %d already stopped\n",
511                                     txq->q.id);
512 }
513
514 static inline bool iwl_queue_used(const struct iwl_queue *q, int i)
515 {
516         return q->write_ptr >= q->read_ptr ?
517                 (i >= q->read_ptr && i < q->write_ptr) :
518                 !(i < q->read_ptr && i >= q->write_ptr);
519 }
520
521 static inline u8 get_cmd_index(struct iwl_queue *q, u32 index)
522 {
523         return index & (q->n_window - 1);
524 }
525
526 static inline const char *get_cmd_string(struct iwl_trans_pcie *trans_pcie,
527                                          u8 cmd)
528 {
529         if (!trans_pcie->command_names || !trans_pcie->command_names[cmd])
530                 return "UNKNOWN";
531         return trans_pcie->command_names[cmd];
532 }
533
534 static inline bool iwl_is_rfkill_set(struct iwl_trans *trans)
535 {
536         return !(iwl_read32(trans, CSR_GP_CNTRL) &
537                 CSR_GP_CNTRL_REG_FLAG_HW_RF_KILL_SW);
538 }
539
540 static inline void __iwl_trans_pcie_set_bits_mask(struct iwl_trans *trans,
541                                                   u32 reg, u32 mask, u32 value)
542 {
543         u32 v;
544
545 #ifdef CONFIG_IWLWIFI_DEBUG
546         WARN_ON_ONCE(value & ~mask);
547 #endif
548
549         v = iwl_read32(trans, reg);
550         v &= ~mask;
551         v |= value;
552         iwl_write32(trans, reg, v);
553 }
554
555 static inline void __iwl_trans_pcie_clear_bit(struct iwl_trans *trans,
556                                               u32 reg, u32 mask)
557 {
558         __iwl_trans_pcie_set_bits_mask(trans, reg, mask, 0);
559 }
560
561 static inline void __iwl_trans_pcie_set_bit(struct iwl_trans *trans,
562                                             u32 reg, u32 mask)
563 {
564         __iwl_trans_pcie_set_bits_mask(trans, reg, mask, mask);
565 }
566
567 void iwl_trans_pcie_rf_kill(struct iwl_trans *trans, bool state);
568
569 #endif /* __iwl_trans_int_pcie_h__ */