]> Pileus Git - ~andy/linux/blob - drivers/net/ethernet/qlogic/qlcnic/qlcnic.h
Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/klassert/ipsec...
[~andy/linux] / drivers / net / ethernet / qlogic / qlcnic / qlcnic.h
1 /*
2  * QLogic qlcnic NIC Driver
3  * Copyright (c) 2009-2013 QLogic Corporation
4  *
5  * See LICENSE.qlcnic for copyright and licensing details.
6  */
7
8 #ifndef _QLCNIC_H_
9 #define _QLCNIC_H_
10
11 #include <linux/module.h>
12 #include <linux/kernel.h>
13 #include <linux/types.h>
14 #include <linux/ioport.h>
15 #include <linux/pci.h>
16 #include <linux/netdevice.h>
17 #include <linux/etherdevice.h>
18 #include <linux/ip.h>
19 #include <linux/in.h>
20 #include <linux/tcp.h>
21 #include <linux/skbuff.h>
22 #include <linux/firmware.h>
23 #include <linux/ethtool.h>
24 #include <linux/mii.h>
25 #include <linux/timer.h>
26
27 #include <linux/vmalloc.h>
28
29 #include <linux/io.h>
30 #include <asm/byteorder.h>
31 #include <linux/bitops.h>
32 #include <linux/if_vlan.h>
33
34 #include "qlcnic_hdr.h"
35 #include "qlcnic_hw.h"
36 #include "qlcnic_83xx_hw.h"
37 #include "qlcnic_dcb.h"
38
39 #define _QLCNIC_LINUX_MAJOR 5
40 #define _QLCNIC_LINUX_MINOR 3
41 #define _QLCNIC_LINUX_SUBVERSION 53
42 #define QLCNIC_LINUX_VERSIONID  "5.3.53"
43 #define QLCNIC_DRV_IDC_VER  0x01
44 #define QLCNIC_DRIVER_VERSION  ((_QLCNIC_LINUX_MAJOR << 16) |\
45                  (_QLCNIC_LINUX_MINOR << 8) | (_QLCNIC_LINUX_SUBVERSION))
46
47 #define QLCNIC_VERSION_CODE(a, b, c)    (((a) << 24) + ((b) << 16) + (c))
48 #define _major(v)       (((v) >> 24) & 0xff)
49 #define _minor(v)       (((v) >> 16) & 0xff)
50 #define _build(v)       ((v) & 0xffff)
51
52 /* version in image has weird encoding:
53  *  7:0  - major
54  * 15:8  - minor
55  * 31:16 - build (little endian)
56  */
57 #define QLCNIC_DECODE_VERSION(v) \
58         QLCNIC_VERSION_CODE(((v) & 0xff), (((v) >> 8) & 0xff), ((v) >> 16))
59
60 #define QLCNIC_MIN_FW_VERSION     QLCNIC_VERSION_CODE(4, 4, 2)
61 #define QLCNIC_NUM_FLASH_SECTORS (64)
62 #define QLCNIC_FLASH_SECTOR_SIZE (64 * 1024)
63 #define QLCNIC_FLASH_TOTAL_SIZE  (QLCNIC_NUM_FLASH_SECTORS \
64                                         * QLCNIC_FLASH_SECTOR_SIZE)
65
66 #define RCV_DESC_RINGSIZE(rds_ring)     \
67         (sizeof(struct rcv_desc) * (rds_ring)->num_desc)
68 #define RCV_BUFF_RINGSIZE(rds_ring)     \
69         (sizeof(struct qlcnic_rx_buffer) * rds_ring->num_desc)
70 #define STATUS_DESC_RINGSIZE(sds_ring)  \
71         (sizeof(struct status_desc) * (sds_ring)->num_desc)
72 #define TX_BUFF_RINGSIZE(tx_ring)       \
73         (sizeof(struct qlcnic_cmd_buffer) * tx_ring->num_desc)
74 #define TX_DESC_RINGSIZE(tx_ring)       \
75         (sizeof(struct cmd_desc_type0) * tx_ring->num_desc)
76
77 #define QLCNIC_P3P_A0           0x50
78 #define QLCNIC_P3P_C0           0x58
79
80 #define QLCNIC_IS_REVISION_P3P(REVISION)     (REVISION >= QLCNIC_P3P_A0)
81
82 #define FIRST_PAGE_GROUP_START  0
83 #define FIRST_PAGE_GROUP_END    0x100000
84
85 #define P3P_MAX_MTU                     (9600)
86 #define P3P_MIN_MTU                     (68)
87 #define QLCNIC_MAX_ETHERHDR                32 /* This contains some padding */
88
89 #define QLCNIC_P3P_RX_BUF_MAX_LEN         (QLCNIC_MAX_ETHERHDR + ETH_DATA_LEN)
90 #define QLCNIC_P3P_RX_JUMBO_BUF_MAX_LEN   (QLCNIC_MAX_ETHERHDR + P3P_MAX_MTU)
91 #define QLCNIC_CT_DEFAULT_RX_BUF_LEN    2048
92 #define QLCNIC_LRO_BUFFER_EXTRA         2048
93
94 /* Tx defines */
95 #define QLCNIC_MAX_FRAGS_PER_TX 14
96 #define MAX_TSO_HEADER_DESC     2
97 #define MGMT_CMD_DESC_RESV      4
98 #define TX_STOP_THRESH          ((MAX_SKB_FRAGS >> 2) + MAX_TSO_HEADER_DESC \
99                                                         + MGMT_CMD_DESC_RESV)
100 #define QLCNIC_MAX_TX_TIMEOUTS  2
101
102 /* Driver will use 1 Tx ring in INT-x/MSI/SRIOV mode. */
103 #define QLCNIC_SINGLE_RING              1
104 #define QLCNIC_DEF_SDS_RINGS            4
105 #define QLCNIC_DEF_TX_RINGS             4
106 #define QLCNIC_MAX_VNIC_TX_RINGS        4
107 #define QLCNIC_MAX_VNIC_SDS_RINGS       4
108
109 enum qlcnic_queue_type {
110         QLCNIC_TX_QUEUE = 1,
111         QLCNIC_RX_QUEUE,
112 };
113
114 /* Operational mode for driver */
115 #define QLCNIC_VNIC_MODE        0xFF
116 #define QLCNIC_DEFAULT_MODE     0x0
117
118 /* Virtual NIC function count */
119 #define QLC_DEFAULT_VNIC_COUNT  8
120 #define QLC_84XX_VNIC_COUNT     16
121
122 /*
123  * Following are the states of the Phantom. Phantom will set them and
124  * Host will read to check if the fields are correct.
125  */
126 #define PHAN_INITIALIZE_FAILED          0xffff
127 #define PHAN_INITIALIZE_COMPLETE        0xff01
128
129 /* Host writes the following to notify that it has done the init-handshake */
130 #define PHAN_INITIALIZE_ACK             0xf00f
131 #define PHAN_PEG_RCV_INITIALIZED        0xff01
132
133 #define NUM_RCV_DESC_RINGS      3
134
135 #define RCV_RING_NORMAL 0
136 #define RCV_RING_JUMBO  1
137
138 #define MIN_CMD_DESCRIPTORS             64
139 #define MIN_RCV_DESCRIPTORS             64
140 #define MIN_JUMBO_DESCRIPTORS           32
141
142 #define MAX_CMD_DESCRIPTORS             1024
143 #define MAX_RCV_DESCRIPTORS_1G          4096
144 #define MAX_RCV_DESCRIPTORS_10G         8192
145 #define MAX_RCV_DESCRIPTORS_VF          2048
146 #define MAX_JUMBO_RCV_DESCRIPTORS_1G    512
147 #define MAX_JUMBO_RCV_DESCRIPTORS_10G   1024
148
149 #define DEFAULT_RCV_DESCRIPTORS_1G      2048
150 #define DEFAULT_RCV_DESCRIPTORS_10G     4096
151 #define DEFAULT_RCV_DESCRIPTORS_VF      1024
152 #define MAX_RDS_RINGS                   2
153
154 #define get_next_index(index, length)   \
155         (((index) + 1) & ((length) - 1))
156
157 /*
158  * Following data structures describe the descriptors that will be used.
159  * Added fileds of tcpHdrSize and ipHdrSize, The driver needs to do it only when
160  * we are doing LSO (above the 1500 size packet) only.
161  */
162 struct cmd_desc_type0 {
163         u8 tcp_hdr_offset;      /* For LSO only */
164         u8 ip_hdr_offset;       /* For LSO only */
165         __le16 flags_opcode;    /* 15:13 unused, 12:7 opcode, 6:0 flags */
166         __le32 nfrags__length;  /* 31:8 total len, 7:0 frag count */
167
168         __le64 addr_buffer2;
169
170         __le16 reference_handle;
171         __le16 mss;
172         u8 port_ctxid;          /* 7:4 ctxid 3:0 port */
173         u8 total_hdr_length;    /* LSO only : MAC+IP+TCP Hdr size */
174         __le16 conn_id;         /* IPSec offoad only */
175
176         __le64 addr_buffer3;
177         __le64 addr_buffer1;
178
179         __le16 buffer_length[4];
180
181         __le64 addr_buffer4;
182
183         u8 eth_addr[ETH_ALEN];
184         __le16 vlan_TCI;
185
186 } __attribute__ ((aligned(64)));
187
188 /* Note: sizeof(rcv_desc) should always be a mutliple of 2 */
189 struct rcv_desc {
190         __le16 reference_handle;
191         __le16 reserved;
192         __le32 buffer_length;   /* allocated buffer length (usually 2K) */
193         __le64 addr_buffer;
194 } __packed;
195
196 struct status_desc {
197         __le64 status_desc_data[2];
198 } __attribute__ ((aligned(16)));
199
200 /* UNIFIED ROMIMAGE */
201 #define QLCNIC_UNI_FW_MIN_SIZE          0xc8000
202 #define QLCNIC_UNI_DIR_SECT_PRODUCT_TBL 0x0
203 #define QLCNIC_UNI_DIR_SECT_BOOTLD      0x6
204 #define QLCNIC_UNI_DIR_SECT_FW          0x7
205
206 /*Offsets */
207 #define QLCNIC_UNI_CHIP_REV_OFF         10
208 #define QLCNIC_UNI_FLAGS_OFF            11
209 #define QLCNIC_UNI_BIOS_VERSION_OFF     12
210 #define QLCNIC_UNI_BOOTLD_IDX_OFF       27
211 #define QLCNIC_UNI_FIRMWARE_IDX_OFF     29
212
213 struct uni_table_desc{
214         __le32  findex;
215         __le32  num_entries;
216         __le32  entry_size;
217         __le32  reserved[5];
218 };
219
220 struct uni_data_desc{
221         __le32  findex;
222         __le32  size;
223         __le32  reserved[5];
224 };
225
226 /* Flash Defines and Structures */
227 #define QLCNIC_FLT_LOCATION     0x3F1000
228 #define QLCNIC_FDT_LOCATION     0x3F0000
229 #define QLCNIC_B0_FW_IMAGE_REGION 0x74
230 #define QLCNIC_C0_FW_IMAGE_REGION 0x97
231 #define QLCNIC_BOOTLD_REGION    0X72
232 struct qlcnic_flt_header {
233         u16 version;
234         u16 len;
235         u16 checksum;
236         u16 reserved;
237 };
238
239 struct qlcnic_flt_entry {
240         u8 region;
241         u8 reserved0;
242         u8 attrib;
243         u8 reserved1;
244         u32 size;
245         u32 start_addr;
246         u32 end_addr;
247 };
248
249 /* Flash Descriptor Table */
250 struct qlcnic_fdt {
251         u32     valid;
252         u16     ver;
253         u16     len;
254         u16     cksum;
255         u16     unused;
256         u8      model[16];
257         u16     mfg_id;
258         u16     id;
259         u8      flag;
260         u8      erase_cmd;
261         u8      alt_erase_cmd;
262         u8      write_enable_cmd;
263         u8      write_enable_bits;
264         u8      write_statusreg_cmd;
265         u8      unprotected_sec_cmd;
266         u8      read_manuf_cmd;
267         u32     block_size;
268         u32     alt_block_size;
269         u32     flash_size;
270         u32     write_enable_data;
271         u8      readid_addr_len;
272         u8      write_disable_bits;
273         u8      read_dev_id_len;
274         u8      chip_erase_cmd;
275         u16     read_timeo;
276         u8      protected_sec_cmd;
277         u8      resvd[65];
278 };
279 /* Magic number to let user know flash is programmed */
280 #define QLCNIC_BDINFO_MAGIC 0x12345678
281
282 #define QLCNIC_BRDTYPE_P3P_REF_QG       0x0021
283 #define QLCNIC_BRDTYPE_P3P_HMEZ         0x0022
284 #define QLCNIC_BRDTYPE_P3P_10G_CX4_LP   0x0023
285 #define QLCNIC_BRDTYPE_P3P_4_GB         0x0024
286 #define QLCNIC_BRDTYPE_P3P_IMEZ         0x0025
287 #define QLCNIC_BRDTYPE_P3P_10G_SFP_PLUS 0x0026
288 #define QLCNIC_BRDTYPE_P3P_10000_BASE_T 0x0027
289 #define QLCNIC_BRDTYPE_P3P_XG_LOM       0x0028
290 #define QLCNIC_BRDTYPE_P3P_4_GB_MM      0x0029
291 #define QLCNIC_BRDTYPE_P3P_10G_SFP_CT   0x002a
292 #define QLCNIC_BRDTYPE_P3P_10G_SFP_QT   0x002b
293 #define QLCNIC_BRDTYPE_P3P_10G_CX4      0x0031
294 #define QLCNIC_BRDTYPE_P3P_10G_XFP      0x0032
295 #define QLCNIC_BRDTYPE_P3P_10G_TP       0x0080
296
297 #define QLCNIC_MSIX_TABLE_OFFSET        0x44
298
299 /* Flash memory map */
300 #define QLCNIC_BRDCFG_START     0x4000          /* board config */
301 #define QLCNIC_BOOTLD_START     0x10000         /* bootld */
302 #define QLCNIC_IMAGE_START      0x43000         /* compressed image */
303 #define QLCNIC_USER_START       0x3E8000        /* Firmare info */
304
305 #define QLCNIC_FW_VERSION_OFFSET        (QLCNIC_USER_START+0x408)
306 #define QLCNIC_FW_SIZE_OFFSET           (QLCNIC_USER_START+0x40c)
307 #define QLCNIC_FW_SERIAL_NUM_OFFSET     (QLCNIC_USER_START+0x81c)
308 #define QLCNIC_BIOS_VERSION_OFFSET      (QLCNIC_USER_START+0x83c)
309
310 #define QLCNIC_BRDTYPE_OFFSET           (QLCNIC_BRDCFG_START+0x8)
311 #define QLCNIC_FW_MAGIC_OFFSET          (QLCNIC_BRDCFG_START+0x128)
312
313 #define QLCNIC_FW_MIN_SIZE              (0x3fffff)
314 #define QLCNIC_UNIFIED_ROMIMAGE         0
315 #define QLCNIC_FLASH_ROMIMAGE           1
316 #define QLCNIC_UNKNOWN_ROMIMAGE         0xff
317
318 #define QLCNIC_UNIFIED_ROMIMAGE_NAME    "phanfw.bin"
319 #define QLCNIC_FLASH_ROMIMAGE_NAME      "flash"
320
321 extern char qlcnic_driver_name[];
322
323 extern int qlcnic_use_msi;
324 extern int qlcnic_use_msi_x;
325 extern int qlcnic_auto_fw_reset;
326 extern int qlcnic_load_fw_file;
327
328 /* Number of status descriptors to handle per interrupt */
329 #define MAX_STATUS_HANDLE       (64)
330
331 /*
332  * qlcnic_skb_frag{} is to contain mapping info for each SG list. This
333  * has to be freed when DMA is complete. This is part of qlcnic_tx_buffer{}.
334  */
335 struct qlcnic_skb_frag {
336         u64 dma;
337         u64 length;
338 };
339
340 /*    Following defines are for the state of the buffers    */
341 #define QLCNIC_BUFFER_FREE      0
342 #define QLCNIC_BUFFER_BUSY      1
343
344 /*
345  * There will be one qlcnic_buffer per skb packet.    These will be
346  * used to save the dma info for pci_unmap_page()
347  */
348 struct qlcnic_cmd_buffer {
349         struct sk_buff *skb;
350         struct qlcnic_skb_frag frag_array[MAX_SKB_FRAGS + 1];
351         u32 frag_count;
352 };
353
354 /* In rx_buffer, we do not need multiple fragments as is a single buffer */
355 struct qlcnic_rx_buffer {
356         u16 ref_handle;
357         struct sk_buff *skb;
358         struct list_head list;
359         u64 dma;
360 };
361
362 /* Board types */
363 #define QLCNIC_GBE      0x01
364 #define QLCNIC_XGBE     0x02
365
366 /*
367  * Interrupt coalescing defaults. The defaults are for 1500 MTU. It is
368  * adjusted based on configured MTU.
369  */
370 #define QLCNIC_INTR_COAL_TYPE_RX                1
371 #define QLCNIC_INTR_COAL_TYPE_TX                2
372
373 #define QLCNIC_DEF_INTR_COALESCE_RX_TIME_US     3
374 #define QLCNIC_DEF_INTR_COALESCE_RX_PACKETS     256
375
376 #define QLCNIC_DEF_INTR_COALESCE_TX_TIME_US     64
377 #define QLCNIC_DEF_INTR_COALESCE_TX_PACKETS     64
378
379 #define QLCNIC_INTR_DEFAULT                     0x04
380 #define QLCNIC_CONFIG_INTR_COALESCE             3
381 #define QLCNIC_DEV_INFO_SIZE                    2
382
383 struct qlcnic_nic_intr_coalesce {
384         u8      type;
385         u8      sts_ring_mask;
386         u16     rx_packets;
387         u16     rx_time_us;
388         u16     tx_packets;
389         u16     tx_time_us;
390         u16     flag;
391         u32     timer_out;
392 };
393
394 struct qlcnic_dump_template_hdr {
395         u32     type;
396         u32     offset;
397         u32     size;
398         u32     cap_mask;
399         u32     num_entries;
400         u32     version;
401         u32     timestamp;
402         u32     checksum;
403         u32     drv_cap_mask;
404         u32     sys_info[3];
405         u32     saved_state[16];
406         u32     cap_sizes[8];
407         u32     ocm_wnd_reg[16];
408         u32     rsvd[0];
409 };
410
411 struct qlcnic_fw_dump {
412         u8      clr;    /* flag to indicate if dump is cleared */
413         bool    enable; /* enable/disable dump */
414         u32     size;   /* total size of the dump */
415         void    *data;  /* dump data area */
416         struct  qlcnic_dump_template_hdr *tmpl_hdr;
417         dma_addr_t phys_addr;
418         void    *dma_buffer;
419         bool    use_pex_dma;
420 };
421
422 /*
423  * One hardware_context{} per adapter
424  * contains interrupt info as well shared hardware info.
425  */
426 struct qlcnic_hardware_context {
427         void __iomem *pci_base0;
428         void __iomem *ocm_win_crb;
429
430         unsigned long pci_len0;
431
432         rwlock_t crb_lock;
433         struct mutex mem_lock;
434
435         u8 revision_id;
436         u8 pci_func;
437         u8 linkup;
438         u8 loopback_state;
439         u8 beacon_state;
440         u8 has_link_events;
441         u8 fw_type;
442         u8 physical_port;
443         u8 reset_context;
444         u8 msix_supported;
445         u8 max_mac_filters;
446         u8 mc_enabled;
447         u8 max_mc_count;
448         u8 diag_test;
449         u8 num_msix;
450         u8 nic_mode;
451         int diag_cnt;
452
453         u16 max_uc_count;
454         u16 port_type;
455         u16 board_type;
456         u16 supported_type;
457
458         u16 link_speed;
459         u16 link_duplex;
460         u16 link_autoneg;
461         u16 module_type;
462
463         u16 op_mode;
464         u16 switch_mode;
465         u16 max_tx_ques;
466         u16 max_rx_ques;
467         u16 max_mtu;
468         u32 msg_enable;
469         u16 total_nic_func;
470         u16 max_pci_func;
471         u32 max_vnic_func;
472         u32 total_pci_func;
473
474         u32 capabilities;
475         u32 extra_capability[3];
476         u32 temp;
477         u32 int_vec_bit;
478         u32 fw_hal_version;
479         u32 port_config;
480         struct qlcnic_hardware_ops *hw_ops;
481         struct qlcnic_nic_intr_coalesce coal;
482         struct qlcnic_fw_dump fw_dump;
483         struct qlcnic_fdt fdt;
484         struct qlc_83xx_reset reset;
485         struct qlc_83xx_idc idc;
486         struct qlc_83xx_fw_info *fw_info;
487         struct qlcnic_intrpt_config *intr_tbl;
488         struct qlcnic_sriov *sriov;
489         u32 *reg_tbl;
490         u32 *ext_reg_tbl;
491         u32 mbox_aen[QLC_83XX_MBX_AEN_CNT];
492         u32 mbox_reg[4];
493         struct qlcnic_mailbox *mailbox;
494         u8 extend_lb_time;
495         u8 phys_port_id[ETH_ALEN];
496 };
497
498 struct qlcnic_adapter_stats {
499         u64  xmitcalled;
500         u64  xmitfinished;
501         u64  rxdropped;
502         u64  txdropped;
503         u64  csummed;
504         u64  rx_pkts;
505         u64  lro_pkts;
506         u64  rxbytes;
507         u64  txbytes;
508         u64  lrobytes;
509         u64  lso_frames;
510         u64  xmit_on;
511         u64  xmit_off;
512         u64  skb_alloc_failure;
513         u64  null_rxbuf;
514         u64  rx_dma_map_error;
515         u64  tx_dma_map_error;
516         u64  spurious_intr;
517         u64  mac_filter_limit_overrun;
518 };
519
520 /*
521  * Rcv Descriptor Context. One such per Rcv Descriptor. There may
522  * be one Rcv Descriptor for normal packets, one for jumbo and may be others.
523  */
524 struct qlcnic_host_rds_ring {
525         void __iomem *crb_rcv_producer;
526         struct rcv_desc *desc_head;
527         struct qlcnic_rx_buffer *rx_buf_arr;
528         u32 num_desc;
529         u32 producer;
530         u32 dma_size;
531         u32 skb_size;
532         u32 flags;
533         struct list_head free_list;
534         spinlock_t lock;
535         dma_addr_t phys_addr;
536 } ____cacheline_internodealigned_in_smp;
537
538 struct qlcnic_host_sds_ring {
539         u32 consumer;
540         u32 num_desc;
541         void __iomem *crb_sts_consumer;
542
543         struct qlcnic_host_tx_ring *tx_ring;
544         struct status_desc *desc_head;
545         struct qlcnic_adapter *adapter;
546         struct napi_struct napi;
547         struct list_head free_list[NUM_RCV_DESC_RINGS];
548
549         void __iomem *crb_intr_mask;
550         int irq;
551
552         dma_addr_t phys_addr;
553         char name[IFNAMSIZ + 12];
554 } ____cacheline_internodealigned_in_smp;
555
556 struct qlcnic_tx_queue_stats {
557         u64 xmit_on;
558         u64 xmit_off;
559         u64 xmit_called;
560         u64 xmit_finished;
561         u64 tx_bytes;
562 };
563
564 struct qlcnic_host_tx_ring {
565         int irq;
566         void __iomem *crb_intr_mask;
567         char name[IFNAMSIZ + 12];
568         u16 ctx_id;
569
570         u32 state;
571         u32 producer;
572         u32 sw_consumer;
573         u32 num_desc;
574
575         struct qlcnic_tx_queue_stats tx_stats;
576
577         void __iomem *crb_cmd_producer;
578         struct cmd_desc_type0 *desc_head;
579         struct qlcnic_adapter *adapter;
580         struct napi_struct napi;
581         struct qlcnic_cmd_buffer *cmd_buf_arr;
582         __le32 *hw_consumer;
583
584         dma_addr_t phys_addr;
585         dma_addr_t hw_cons_phys_addr;
586         struct netdev_queue *txq;
587 } ____cacheline_internodealigned_in_smp;
588
589 /*
590  * Receive context. There is one such structure per instance of the
591  * receive processing. Any state information that is relevant to
592  * the receive, and is must be in this structure. The global data may be
593  * present elsewhere.
594  */
595 struct qlcnic_recv_context {
596         struct qlcnic_host_rds_ring *rds_rings;
597         struct qlcnic_host_sds_ring *sds_rings;
598         u32 state;
599         u16 context_id;
600         u16 virt_port;
601 };
602
603 /* HW context creation */
604
605 #define QLCNIC_OS_CRB_RETRY_COUNT       4000
606
607 #define QLCNIC_CDRP_CMD_BIT             0x80000000
608
609 /*
610  * All responses must have the QLCNIC_CDRP_CMD_BIT cleared
611  * in the crb QLCNIC_CDRP_CRB_OFFSET.
612  */
613 #define QLCNIC_CDRP_FORM_RSP(rsp)       (rsp)
614 #define QLCNIC_CDRP_IS_RSP(rsp) (((rsp) & QLCNIC_CDRP_CMD_BIT) == 0)
615
616 #define QLCNIC_CDRP_RSP_OK              0x00000001
617 #define QLCNIC_CDRP_RSP_FAIL            0x00000002
618 #define QLCNIC_CDRP_RSP_TIMEOUT         0x00000003
619
620 /*
621  * All commands must have the QLCNIC_CDRP_CMD_BIT set in
622  * the crb QLCNIC_CDRP_CRB_OFFSET.
623  */
624 #define QLCNIC_CDRP_FORM_CMD(cmd)       (QLCNIC_CDRP_CMD_BIT | (cmd))
625
626 #define QLCNIC_RCODE_SUCCESS            0
627 #define QLCNIC_RCODE_INVALID_ARGS       6
628 #define QLCNIC_RCODE_NOT_SUPPORTED      9
629 #define QLCNIC_RCODE_NOT_PERMITTED      10
630 #define QLCNIC_RCODE_NOT_IMPL           15
631 #define QLCNIC_RCODE_INVALID            16
632 #define QLCNIC_RCODE_TIMEOUT            17
633 #define QLCNIC_DESTROY_CTX_RESET        0
634
635 /*
636  * Capabilities Announced
637  */
638 #define QLCNIC_CAP0_LEGACY_CONTEXT      (1)
639 #define QLCNIC_CAP0_LEGACY_MN           (1 << 2)
640 #define QLCNIC_CAP0_LSO                 (1 << 6)
641 #define QLCNIC_CAP0_JUMBO_CONTIGUOUS    (1 << 7)
642 #define QLCNIC_CAP0_LRO_CONTIGUOUS      (1 << 8)
643 #define QLCNIC_CAP0_VALIDOFF            (1 << 11)
644 #define QLCNIC_CAP0_LRO_MSS             (1 << 21)
645 #define QLCNIC_CAP0_TX_MULTI            (1 << 22)
646
647 /*
648  * Context state
649  */
650 #define QLCNIC_HOST_CTX_STATE_FREED     0
651 #define QLCNIC_HOST_CTX_STATE_ACTIVE    2
652
653 /*
654  * Rx context
655  */
656
657 struct qlcnic_hostrq_sds_ring {
658         __le64 host_phys_addr;  /* Ring base addr */
659         __le32 ring_size;               /* Ring entries */
660         __le16 msi_index;
661         __le16 rsvd;            /* Padding */
662 } __packed;
663
664 struct qlcnic_hostrq_rds_ring {
665         __le64 host_phys_addr;  /* Ring base addr */
666         __le64 buff_size;               /* Packet buffer size */
667         __le32 ring_size;               /* Ring entries */
668         __le32 ring_kind;               /* Class of ring */
669 } __packed;
670
671 struct qlcnic_hostrq_rx_ctx {
672         __le64 host_rsp_dma_addr;       /* Response dma'd here */
673         __le32 capabilities[4];         /* Flag bit vector */
674         __le32 host_int_crb_mode;       /* Interrupt crb usage */
675         __le32 host_rds_crb_mode;       /* RDS crb usage */
676         /* These ring offsets are relative to data[0] below */
677         __le32 rds_ring_offset; /* Offset to RDS config */
678         __le32 sds_ring_offset; /* Offset to SDS config */
679         __le16 num_rds_rings;   /* Count of RDS rings */
680         __le16 num_sds_rings;   /* Count of SDS rings */
681         __le16 valid_field_offset;
682         u8  txrx_sds_binding;
683         u8  msix_handler;
684         u8  reserved[128];      /* reserve space for future expansion*/
685         /* MUST BE 64-bit aligned.
686            The following is packed:
687            - N hostrq_rds_rings
688            - N hostrq_sds_rings */
689         char data[0];
690 } __packed;
691
692 struct qlcnic_cardrsp_rds_ring{
693         __le32 host_producer_crb;       /* Crb to use */
694         __le32 rsvd1;           /* Padding */
695 } __packed;
696
697 struct qlcnic_cardrsp_sds_ring {
698         __le32 host_consumer_crb;       /* Crb to use */
699         __le32 interrupt_crb;   /* Crb to use */
700 } __packed;
701
702 struct qlcnic_cardrsp_rx_ctx {
703         /* These ring offsets are relative to data[0] below */
704         __le32 rds_ring_offset; /* Offset to RDS config */
705         __le32 sds_ring_offset; /* Offset to SDS config */
706         __le32 host_ctx_state;  /* Starting State */
707         __le32 num_fn_per_port; /* How many PCI fn share the port */
708         __le16 num_rds_rings;   /* Count of RDS rings */
709         __le16 num_sds_rings;   /* Count of SDS rings */
710         __le16 context_id;              /* Handle for context */
711         u8  phys_port;          /* Physical id of port */
712         u8  virt_port;          /* Virtual/Logical id of port */
713         u8  reserved[128];      /* save space for future expansion */
714         /*  MUST BE 64-bit aligned.
715            The following is packed:
716            - N cardrsp_rds_rings
717            - N cardrs_sds_rings */
718         char data[0];
719 } __packed;
720
721 #define SIZEOF_HOSTRQ_RX(HOSTRQ_RX, rds_rings, sds_rings)       \
722         (sizeof(HOSTRQ_RX) +                                    \
723         (rds_rings)*(sizeof(struct qlcnic_hostrq_rds_ring)) +           \
724         (sds_rings)*(sizeof(struct qlcnic_hostrq_sds_ring)))
725
726 #define SIZEOF_CARDRSP_RX(CARDRSP_RX, rds_rings, sds_rings)     \
727         (sizeof(CARDRSP_RX) +                                   \
728         (rds_rings)*(sizeof(struct qlcnic_cardrsp_rds_ring)) +          \
729         (sds_rings)*(sizeof(struct qlcnic_cardrsp_sds_ring)))
730
731 /*
732  * Tx context
733  */
734
735 struct qlcnic_hostrq_cds_ring {
736         __le64 host_phys_addr;  /* Ring base addr */
737         __le32 ring_size;               /* Ring entries */
738         __le32 rsvd;            /* Padding */
739 } __packed;
740
741 struct qlcnic_hostrq_tx_ctx {
742         __le64 host_rsp_dma_addr;       /* Response dma'd here */
743         __le64 cmd_cons_dma_addr;       /*  */
744         __le64 dummy_dma_addr;  /*  */
745         __le32 capabilities[4]; /* Flag bit vector */
746         __le32 host_int_crb_mode;       /* Interrupt crb usage */
747         __le32 rsvd1;           /* Padding */
748         __le16 rsvd2;           /* Padding */
749         __le16 interrupt_ctl;
750         __le16 msi_index;
751         __le16 rsvd3;           /* Padding */
752         struct qlcnic_hostrq_cds_ring cds_ring; /* Desc of cds ring */
753         u8  reserved[128];      /* future expansion */
754 } __packed;
755
756 struct qlcnic_cardrsp_cds_ring {
757         __le32 host_producer_crb;       /* Crb to use */
758         __le32 interrupt_crb;   /* Crb to use */
759 } __packed;
760
761 struct qlcnic_cardrsp_tx_ctx {
762         __le32 host_ctx_state;  /* Starting state */
763         __le16 context_id;              /* Handle for context */
764         u8  phys_port;          /* Physical id of port */
765         u8  virt_port;          /* Virtual/Logical id of port */
766         struct qlcnic_cardrsp_cds_ring cds_ring;        /* Card cds settings */
767         u8  reserved[128];      /* future expansion */
768 } __packed;
769
770 #define SIZEOF_HOSTRQ_TX(HOSTRQ_TX)     (sizeof(HOSTRQ_TX))
771 #define SIZEOF_CARDRSP_TX(CARDRSP_TX)   (sizeof(CARDRSP_TX))
772
773 /* CRB */
774
775 #define QLCNIC_HOST_RDS_CRB_MODE_UNIQUE 0
776 #define QLCNIC_HOST_RDS_CRB_MODE_SHARED 1
777 #define QLCNIC_HOST_RDS_CRB_MODE_CUSTOM 2
778 #define QLCNIC_HOST_RDS_CRB_MODE_MAX    3
779
780 #define QLCNIC_HOST_INT_CRB_MODE_UNIQUE 0
781 #define QLCNIC_HOST_INT_CRB_MODE_SHARED 1
782 #define QLCNIC_HOST_INT_CRB_MODE_NORX   2
783 #define QLCNIC_HOST_INT_CRB_MODE_NOTX   3
784 #define QLCNIC_HOST_INT_CRB_MODE_NORXTX 4
785
786
787 /* MAC */
788
789 #define MC_COUNT_P3P    38
790
791 #define QLCNIC_MAC_NOOP 0
792 #define QLCNIC_MAC_ADD  1
793 #define QLCNIC_MAC_DEL  2
794 #define QLCNIC_MAC_VLAN_ADD     3
795 #define QLCNIC_MAC_VLAN_DEL     4
796
797 struct qlcnic_mac_vlan_list {
798         struct list_head list;
799         uint8_t mac_addr[ETH_ALEN+2];
800         u16 vlan_id;
801 };
802
803 /* MAC Learn */
804 #define NO_MAC_LEARN            0
805 #define DRV_MAC_LEARN           1
806 #define FDB_MAC_LEARN           2
807
808 #define QLCNIC_HOST_REQUEST     0x13
809 #define QLCNIC_REQUEST          0x14
810
811 #define QLCNIC_MAC_EVENT        0x1
812
813 #define QLCNIC_IP_UP            2
814 #define QLCNIC_IP_DOWN          3
815
816 #define QLCNIC_ILB_MODE         0x1
817 #define QLCNIC_ELB_MODE         0x2
818
819 #define QLCNIC_LINKEVENT        0x1
820 #define QLCNIC_LB_RESPONSE      0x2
821 #define QLCNIC_IS_LB_CONFIGURED(VAL)    \
822                 (VAL == (QLCNIC_LINKEVENT | QLCNIC_LB_RESPONSE))
823
824 /*
825  * Driver --> Firmware
826  */
827 #define QLCNIC_H2C_OPCODE_CONFIG_RSS                    0x1
828 #define QLCNIC_H2C_OPCODE_CONFIG_INTR_COALESCE          0x3
829 #define QLCNIC_H2C_OPCODE_CONFIG_LED                    0x4
830 #define QLCNIC_H2C_OPCODE_LRO_REQUEST                   0x7
831 #define QLCNIC_H2C_OPCODE_SET_MAC_RECEIVE_MODE          0xc
832 #define QLCNIC_H2C_OPCODE_CONFIG_IPADDR         0x12
833
834 #define QLCNIC_H2C_OPCODE_GET_LINKEVENT         0x15
835 #define QLCNIC_H2C_OPCODE_CONFIG_BRIDGING               0x17
836 #define QLCNIC_H2C_OPCODE_CONFIG_HW_LRO         0x18
837 #define QLCNIC_H2C_OPCODE_CONFIG_LOOPBACK               0x13
838
839 /*
840  * Firmware --> Driver
841  */
842
843 #define QLCNIC_C2H_OPCODE_CONFIG_LOOPBACK               0x8f
844 #define QLCNIC_C2H_OPCODE_GET_LINKEVENT_RESPONSE        0x8D
845 #define QLCNIC_C2H_OPCODE_GET_DCB_AEN                   0x90
846
847 #define VPORT_MISS_MODE_DROP            0 /* drop all unmatched */
848 #define VPORT_MISS_MODE_ACCEPT_ALL      1 /* accept all packets */
849 #define VPORT_MISS_MODE_ACCEPT_MULTI    2 /* accept unmatched multicast */
850
851 #define QLCNIC_LRO_REQUEST_CLEANUP      4
852
853 /* Capabilites received */
854 #define QLCNIC_FW_CAPABILITY_TSO                BIT_1
855 #define QLCNIC_FW_CAPABILITY_BDG                BIT_8
856 #define QLCNIC_FW_CAPABILITY_FVLANTX            BIT_9
857 #define QLCNIC_FW_CAPABILITY_HW_LRO             BIT_10
858 #define QLCNIC_FW_CAPABILITY_2_MULTI_TX         BIT_4
859 #define QLCNIC_FW_CAPABILITY_MULTI_LOOPBACK     BIT_27
860 #define QLCNIC_FW_CAPABILITY_MORE_CAPS          BIT_31
861
862 #define QLCNIC_FW_CAPABILITY_2_LRO_MAX_TCP_SEG  BIT_2
863 #define QLCNIC_FW_CAP2_HW_LRO_IPV6              BIT_3
864 #define QLCNIC_FW_CAPABILITY_SET_DRV_VER        BIT_5
865 #define QLCNIC_FW_CAPABILITY_2_BEACON           BIT_7
866 #define QLCNIC_FW_CAPABILITY_2_PER_PORT_ESWITCH_CFG     BIT_9
867
868 /* module types */
869 #define LINKEVENT_MODULE_NOT_PRESENT                    1
870 #define LINKEVENT_MODULE_OPTICAL_UNKNOWN                2
871 #define LINKEVENT_MODULE_OPTICAL_SRLR                   3
872 #define LINKEVENT_MODULE_OPTICAL_LRM                    4
873 #define LINKEVENT_MODULE_OPTICAL_SFP_1G                 5
874 #define LINKEVENT_MODULE_TWINAX_UNSUPPORTED_CABLE       6
875 #define LINKEVENT_MODULE_TWINAX_UNSUPPORTED_CABLELEN    7
876 #define LINKEVENT_MODULE_TWINAX                         8
877
878 #define LINKSPEED_10GBPS        10000
879 #define LINKSPEED_1GBPS         1000
880 #define LINKSPEED_100MBPS       100
881 #define LINKSPEED_10MBPS        10
882
883 #define LINKSPEED_ENCODED_10MBPS        0
884 #define LINKSPEED_ENCODED_100MBPS       1
885 #define LINKSPEED_ENCODED_1GBPS         2
886
887 #define LINKEVENT_AUTONEG_DISABLED      0
888 #define LINKEVENT_AUTONEG_ENABLED       1
889
890 #define LINKEVENT_HALF_DUPLEX           0
891 #define LINKEVENT_FULL_DUPLEX           1
892
893 #define LINKEVENT_LINKSPEED_MBPS        0
894 #define LINKEVENT_LINKSPEED_ENCODED     1
895
896 /* firmware response header:
897  *      63:58 - message type
898  *      57:56 - owner
899  *      55:53 - desc count
900  *      52:48 - reserved
901  *      47:40 - completion id
902  *      39:32 - opcode
903  *      31:16 - error code
904  *      15:00 - reserved
905  */
906 #define qlcnic_get_nic_msg_opcode(msg_hdr)      \
907         ((msg_hdr >> 32) & 0xFF)
908
909 struct qlcnic_fw_msg {
910         union {
911                 struct {
912                         u64 hdr;
913                         u64 body[7];
914                 };
915                 u64 words[8];
916         };
917 };
918
919 struct qlcnic_nic_req {
920         __le64 qhdr;
921         __le64 req_hdr;
922         __le64 words[6];
923 } __packed;
924
925 struct qlcnic_mac_req {
926         u8 op;
927         u8 tag;
928         u8 mac_addr[6];
929 };
930
931 struct qlcnic_vlan_req {
932         __le16 vlan_id;
933         __le16 rsvd[3];
934 } __packed;
935
936 struct qlcnic_ipaddr {
937         __be32 ipv4;
938         __be32 ipv6[4];
939 };
940
941 #define QLCNIC_MSI_ENABLED              0x02
942 #define QLCNIC_MSIX_ENABLED             0x04
943 #define QLCNIC_LRO_ENABLED              0x01
944 #define QLCNIC_LRO_DISABLED             0x00
945 #define QLCNIC_BRIDGE_ENABLED           0X10
946 #define QLCNIC_DIAG_ENABLED             0x20
947 #define QLCNIC_ESWITCH_ENABLED          0x40
948 #define QLCNIC_ADAPTER_INITIALIZED      0x80
949 #define QLCNIC_TAGGING_ENABLED          0x100
950 #define QLCNIC_MACSPOOF                 0x200
951 #define QLCNIC_MAC_OVERRIDE_DISABLED    0x400
952 #define QLCNIC_PROMISC_DISABLED         0x800
953 #define QLCNIC_NEED_FLR                 0x1000
954 #define QLCNIC_FW_RESET_OWNER           0x2000
955 #define QLCNIC_FW_HANG                  0x4000
956 #define QLCNIC_FW_LRO_MSS_CAP           0x8000
957 #define QLCNIC_TX_INTR_SHARED           0x10000
958 #define QLCNIC_APP_CHANGED_FLAGS        0x20000
959 #define QLCNIC_HAS_PHYS_PORT_ID         0x40000
960
961 #define QLCNIC_IS_MSI_FAMILY(adapter) \
962         ((adapter)->flags & (QLCNIC_MSI_ENABLED | QLCNIC_MSIX_ENABLED))
963 #define QLCNIC_IS_TSO_CAPABLE(adapter)  \
964         ((adapter)->ahw->capabilities & QLCNIC_FW_CAPABILITY_TSO)
965
966 #define QLCNIC_BEACON_EANBLE            0xC
967 #define QLCNIC_BEACON_DISABLE           0xD
968
969 #define QLCNIC_MSIX_TBL_SPACE           8192
970 #define QLCNIC_PCI_REG_MSIX_TBL         0x44
971 #define QLCNIC_MSIX_TBL_PGSIZE          4096
972
973 #define QLCNIC_ADAPTER_UP_MAGIC 777
974
975 #define __QLCNIC_FW_ATTACHED            0
976 #define __QLCNIC_DEV_UP                 1
977 #define __QLCNIC_RESETTING              2
978 #define __QLCNIC_START_FW               4
979 #define __QLCNIC_AER                    5
980 #define __QLCNIC_DIAG_RES_ALLOC         6
981 #define __QLCNIC_LED_ENABLE             7
982 #define __QLCNIC_ELB_INPROGRESS         8
983 #define __QLCNIC_MULTI_TX_UNIQUE        9
984 #define __QLCNIC_SRIOV_ENABLE           10
985 #define __QLCNIC_SRIOV_CAPABLE          11
986 #define __QLCNIC_MBX_POLL_ENABLE        12
987 #define __QLCNIC_DIAG_MODE              13
988 #define __QLCNIC_MAINTENANCE_MODE       16
989
990 #define QLCNIC_INTERRUPT_TEST           1
991 #define QLCNIC_LOOPBACK_TEST            2
992 #define QLCNIC_LED_TEST         3
993
994 #define QLCNIC_FILTER_AGE       80
995 #define QLCNIC_READD_AGE        20
996 #define QLCNIC_LB_MAX_FILTERS   64
997 #define QLCNIC_LB_BUCKET_SIZE   32
998 #define QLCNIC_ILB_MAX_RCV_LOOP 10
999
1000 struct qlcnic_filter {
1001         struct hlist_node fnode;
1002         u8 faddr[ETH_ALEN];
1003         u16 vlan_id;
1004         unsigned long ftime;
1005 };
1006
1007 struct qlcnic_filter_hash {
1008         struct hlist_head *fhead;
1009         u8 fnum;
1010         u16 fmax;
1011         u16 fbucket_size;
1012 };
1013
1014 /* Mailbox specific data structures */
1015 struct qlcnic_mailbox {
1016         struct workqueue_struct *work_q;
1017         struct qlcnic_adapter   *adapter;
1018         struct qlcnic_mbx_ops   *ops;
1019         struct work_struct      work;
1020         struct completion       completion;
1021         struct list_head        cmd_q;
1022         unsigned long           status;
1023         spinlock_t              queue_lock;     /* Mailbox queue lock */
1024         spinlock_t              aen_lock;       /* Mailbox response/AEN lock */
1025         atomic_t                rsp_status;
1026         u32                     num_cmds;
1027 };
1028
1029 struct qlcnic_adapter {
1030         struct qlcnic_hardware_context *ahw;
1031         struct qlcnic_recv_context *recv_ctx;
1032         struct qlcnic_host_tx_ring *tx_ring;
1033         struct net_device *netdev;
1034         struct pci_dev *pdev;
1035
1036         unsigned long state;
1037         u32 flags;
1038
1039         u16 num_txd;
1040         u16 num_rxd;
1041         u16 num_jumbo_rxd;
1042         u16 max_rxd;
1043         u16 max_jumbo_rxd;
1044
1045         u8 max_rds_rings;
1046
1047         u8 max_sds_rings; /* max sds rings supported by adapter */
1048         u8 max_tx_rings;  /* max tx rings supported by adapter */
1049
1050         u8 drv_tx_rings;  /* max tx rings supported by driver */
1051         u8 drv_sds_rings; /* max sds rings supported by driver */
1052
1053         u8 rx_csum;
1054         u8 portnum;
1055
1056         u8 fw_wait_cnt;
1057         u8 fw_fail_cnt;
1058         u8 tx_timeo_cnt;
1059         u8 need_fw_reset;
1060         u8 reset_ctx_cnt;
1061
1062         u16 is_up;
1063         u16 rx_pvid;
1064         u16 tx_pvid;
1065
1066         u32 irq;
1067         u32 heartbeat;
1068
1069         u8 dev_state;
1070         u8 reset_ack_timeo;
1071         u8 dev_init_timeo;
1072
1073         u8 mac_addr[ETH_ALEN];
1074
1075         u64 dev_rst_time;
1076         bool drv_mac_learn;
1077         bool fdb_mac_learn;
1078         unsigned long vlans[BITS_TO_LONGS(VLAN_N_VID)];
1079         u8 flash_mfg_id;
1080         struct qlcnic_npar_info *npars;
1081         struct qlcnic_eswitch *eswitch;
1082         struct qlcnic_nic_template *nic_ops;
1083
1084         struct qlcnic_adapter_stats stats;
1085         struct list_head mac_list;
1086
1087         void __iomem    *tgt_mask_reg;
1088         void __iomem    *tgt_status_reg;
1089         void __iomem    *crb_int_state_reg;
1090         void __iomem    *isr_int_vec;
1091
1092         struct msix_entry *msix_entries;
1093         struct workqueue_struct *qlcnic_wq;
1094         struct delayed_work fw_work;
1095         struct delayed_work idc_aen_work;
1096         struct delayed_work mbx_poll_work;
1097         struct qlcnic_dcb *dcb;
1098
1099         struct qlcnic_filter_hash fhash;
1100         struct qlcnic_filter_hash rx_fhash;
1101         struct list_head vf_mc_list;
1102
1103         spinlock_t tx_clean_lock;
1104         spinlock_t mac_learn_lock;
1105         /* spinlock for catching rcv filters for eswitch traffic */
1106         spinlock_t rx_mac_learn_lock;
1107         u32 file_prd_off;       /*File fw product offset*/
1108         u32 fw_version;
1109         u32 offload_flags;
1110         const struct firmware *fw;
1111 };
1112
1113 struct qlcnic_info_le {
1114         __le16  pci_func;
1115         __le16  op_mode;        /* 1 = Priv, 2 = NP, 3 = NP passthru */
1116         __le16  phys_port;
1117         __le16  switch_mode;    /* 0 = disabled, 1 = int, 2 = ext */
1118
1119         __le32  capabilities;
1120         u8      max_mac_filters;
1121         u8      reserved1;
1122         __le16  max_mtu;
1123
1124         __le16  max_tx_ques;
1125         __le16  max_rx_ques;
1126         __le16  min_tx_bw;
1127         __le16  max_tx_bw;
1128         __le32  op_type;
1129         __le16  max_bw_reg_offset;
1130         __le16  max_linkspeed_reg_offset;
1131         __le32  capability1;
1132         __le32  capability2;
1133         __le32  capability3;
1134         __le16  max_tx_mac_filters;
1135         __le16  max_rx_mcast_mac_filters;
1136         __le16  max_rx_ucast_mac_filters;
1137         __le16  max_rx_ip_addr;
1138         __le16  max_rx_lro_flow;
1139         __le16  max_rx_status_rings;
1140         __le16  max_rx_buf_rings;
1141         __le16  max_tx_vlan_keys;
1142         u8      total_pf;
1143         u8      total_rss_engines;
1144         __le16  max_vports;
1145         __le16  linkstate_reg_offset;
1146         __le16  bit_offsets;
1147         __le16  max_local_ipv6_addrs;
1148         __le16  max_remote_ipv6_addrs;
1149         u8      reserved2[56];
1150 } __packed;
1151
1152 struct qlcnic_info {
1153         u16     pci_func;
1154         u16     op_mode;
1155         u16     phys_port;
1156         u16     switch_mode;
1157         u32     capabilities;
1158         u8      max_mac_filters;
1159         u16     max_mtu;
1160         u16     max_tx_ques;
1161         u16     max_rx_ques;
1162         u16     min_tx_bw;
1163         u16     max_tx_bw;
1164         u32     op_type;
1165         u16     max_bw_reg_offset;
1166         u16     max_linkspeed_reg_offset;
1167         u32     capability1;
1168         u32     capability2;
1169         u32     capability3;
1170         u16     max_tx_mac_filters;
1171         u16     max_rx_mcast_mac_filters;
1172         u16     max_rx_ucast_mac_filters;
1173         u16     max_rx_ip_addr;
1174         u16     max_rx_lro_flow;
1175         u16     max_rx_status_rings;
1176         u16     max_rx_buf_rings;
1177         u16     max_tx_vlan_keys;
1178         u8      total_pf;
1179         u8      total_rss_engines;
1180         u16     max_vports;
1181         u16     linkstate_reg_offset;
1182         u16     bit_offsets;
1183         u16     max_local_ipv6_addrs;
1184         u16     max_remote_ipv6_addrs;
1185 };
1186
1187 struct qlcnic_pci_info_le {
1188         __le16  id;             /* pci function id */
1189         __le16  active;         /* 1 = Enabled */
1190         __le16  type;           /* 1 = NIC, 2 = FCoE, 3 = iSCSI */
1191         __le16  default_port;   /* default port number */
1192
1193         __le16  tx_min_bw;      /* Multiple of 100mbpc */
1194         __le16  tx_max_bw;
1195         __le16  reserved1[2];
1196
1197         u8      mac[ETH_ALEN];
1198         __le16  func_count;
1199         u8      reserved2[104];
1200
1201 } __packed;
1202
1203 struct qlcnic_pci_info {
1204         u16     id;
1205         u16     active;
1206         u16     type;
1207         u16     default_port;
1208         u16     tx_min_bw;
1209         u16     tx_max_bw;
1210         u8      mac[ETH_ALEN];
1211         u16  func_count;
1212 };
1213
1214 struct qlcnic_npar_info {
1215         bool    eswitch_status;
1216         u16     pvid;
1217         u16     min_bw;
1218         u16     max_bw;
1219         u8      phy_port;
1220         u8      type;
1221         u8      active;
1222         u8      enable_pm;
1223         u8      dest_npar;
1224         u8      discard_tagged;
1225         u8      mac_override;
1226         u8      mac_anti_spoof;
1227         u8      promisc_mode;
1228         u8      offload_flags;
1229         u8      pci_func;
1230         u8      mac[ETH_ALEN];
1231 };
1232
1233 struct qlcnic_eswitch {
1234         u8      port;
1235         u8      active_vports;
1236         u8      active_vlans;
1237         u8      active_ucast_filters;
1238         u8      max_ucast_filters;
1239         u8      max_active_vlans;
1240
1241         u32     flags;
1242 #define QLCNIC_SWITCH_ENABLE            BIT_1
1243 #define QLCNIC_SWITCH_VLAN_FILTERING    BIT_2
1244 #define QLCNIC_SWITCH_PROMISC_MODE      BIT_3
1245 #define QLCNIC_SWITCH_PORT_MIRRORING    BIT_4
1246 };
1247
1248
1249 /* Return codes for Error handling */
1250 #define QL_STATUS_INVALID_PARAM -1
1251
1252 #define MAX_BW                  100     /* % of link speed */
1253 #define MAX_VLAN_ID             4095
1254 #define MIN_VLAN_ID             2
1255 #define DEFAULT_MAC_LEARN       1
1256
1257 #define IS_VALID_VLAN(vlan)     (vlan >= MIN_VLAN_ID && vlan < MAX_VLAN_ID)
1258 #define IS_VALID_BW(bw)         (bw <= MAX_BW)
1259
1260 struct qlcnic_pci_func_cfg {
1261         u16     func_type;
1262         u16     min_bw;
1263         u16     max_bw;
1264         u16     port_num;
1265         u8      pci_func;
1266         u8      func_state;
1267         u8      def_mac_addr[6];
1268 };
1269
1270 struct qlcnic_npar_func_cfg {
1271         u32     fw_capab;
1272         u16     port_num;
1273         u16     min_bw;
1274         u16     max_bw;
1275         u16     max_tx_queues;
1276         u16     max_rx_queues;
1277         u8      pci_func;
1278         u8      op_mode;
1279 };
1280
1281 struct qlcnic_pm_func_cfg {
1282         u8      pci_func;
1283         u8      action;
1284         u8      dest_npar;
1285         u8      reserved[5];
1286 };
1287
1288 struct qlcnic_esw_func_cfg {
1289         u16     vlan_id;
1290         u8      op_mode;
1291         u8      op_type;
1292         u8      pci_func;
1293         u8      host_vlan_tag;
1294         u8      promisc_mode;
1295         u8      discard_tagged;
1296         u8      mac_override;
1297         u8      mac_anti_spoof;
1298         u8      offload_flags;
1299         u8      reserved[5];
1300 };
1301
1302 #define QLCNIC_STATS_VERSION            1
1303 #define QLCNIC_STATS_PORT               1
1304 #define QLCNIC_STATS_ESWITCH            2
1305 #define QLCNIC_QUERY_RX_COUNTER         0
1306 #define QLCNIC_QUERY_TX_COUNTER         1
1307 #define QLCNIC_STATS_NOT_AVAIL  0xffffffffffffffffULL
1308 #define QLCNIC_FILL_STATS(VAL1) \
1309         (((VAL1) == QLCNIC_STATS_NOT_AVAIL) ? 0 : VAL1)
1310 #define QLCNIC_MAC_STATS 1
1311 #define QLCNIC_ESW_STATS 2
1312
1313 #define QLCNIC_ADD_ESW_STATS(VAL1, VAL2)\
1314 do {    \
1315         if (((VAL1) == QLCNIC_STATS_NOT_AVAIL) && \
1316             ((VAL2) != QLCNIC_STATS_NOT_AVAIL)) \
1317                 (VAL1) = (VAL2); \
1318         else if (((VAL1) != QLCNIC_STATS_NOT_AVAIL) && \
1319                  ((VAL2) != QLCNIC_STATS_NOT_AVAIL)) \
1320                         (VAL1) += (VAL2); \
1321 } while (0)
1322
1323 struct qlcnic_mac_statistics_le {
1324         __le64  mac_tx_frames;
1325         __le64  mac_tx_bytes;
1326         __le64  mac_tx_mcast_pkts;
1327         __le64  mac_tx_bcast_pkts;
1328         __le64  mac_tx_pause_cnt;
1329         __le64  mac_tx_ctrl_pkt;
1330         __le64  mac_tx_lt_64b_pkts;
1331         __le64  mac_tx_lt_127b_pkts;
1332         __le64  mac_tx_lt_255b_pkts;
1333         __le64  mac_tx_lt_511b_pkts;
1334         __le64  mac_tx_lt_1023b_pkts;
1335         __le64  mac_tx_lt_1518b_pkts;
1336         __le64  mac_tx_gt_1518b_pkts;
1337         __le64  rsvd1[3];
1338
1339         __le64  mac_rx_frames;
1340         __le64  mac_rx_bytes;
1341         __le64  mac_rx_mcast_pkts;
1342         __le64  mac_rx_bcast_pkts;
1343         __le64  mac_rx_pause_cnt;
1344         __le64  mac_rx_ctrl_pkt;
1345         __le64  mac_rx_lt_64b_pkts;
1346         __le64  mac_rx_lt_127b_pkts;
1347         __le64  mac_rx_lt_255b_pkts;
1348         __le64  mac_rx_lt_511b_pkts;
1349         __le64  mac_rx_lt_1023b_pkts;
1350         __le64  mac_rx_lt_1518b_pkts;
1351         __le64  mac_rx_gt_1518b_pkts;
1352         __le64  rsvd2[3];
1353
1354         __le64  mac_rx_length_error;
1355         __le64  mac_rx_length_small;
1356         __le64  mac_rx_length_large;
1357         __le64  mac_rx_jabber;
1358         __le64  mac_rx_dropped;
1359         __le64  mac_rx_crc_error;
1360         __le64  mac_align_error;
1361 } __packed;
1362
1363 struct qlcnic_mac_statistics {
1364         u64     mac_tx_frames;
1365         u64     mac_tx_bytes;
1366         u64     mac_tx_mcast_pkts;
1367         u64     mac_tx_bcast_pkts;
1368         u64     mac_tx_pause_cnt;
1369         u64     mac_tx_ctrl_pkt;
1370         u64     mac_tx_lt_64b_pkts;
1371         u64     mac_tx_lt_127b_pkts;
1372         u64     mac_tx_lt_255b_pkts;
1373         u64     mac_tx_lt_511b_pkts;
1374         u64     mac_tx_lt_1023b_pkts;
1375         u64     mac_tx_lt_1518b_pkts;
1376         u64     mac_tx_gt_1518b_pkts;
1377         u64     rsvd1[3];
1378         u64     mac_rx_frames;
1379         u64     mac_rx_bytes;
1380         u64     mac_rx_mcast_pkts;
1381         u64     mac_rx_bcast_pkts;
1382         u64     mac_rx_pause_cnt;
1383         u64     mac_rx_ctrl_pkt;
1384         u64     mac_rx_lt_64b_pkts;
1385         u64     mac_rx_lt_127b_pkts;
1386         u64     mac_rx_lt_255b_pkts;
1387         u64     mac_rx_lt_511b_pkts;
1388         u64     mac_rx_lt_1023b_pkts;
1389         u64     mac_rx_lt_1518b_pkts;
1390         u64     mac_rx_gt_1518b_pkts;
1391         u64     rsvd2[3];
1392         u64     mac_rx_length_error;
1393         u64     mac_rx_length_small;
1394         u64     mac_rx_length_large;
1395         u64     mac_rx_jabber;
1396         u64     mac_rx_dropped;
1397         u64     mac_rx_crc_error;
1398         u64     mac_align_error;
1399 };
1400
1401 struct qlcnic_esw_stats_le {
1402         __le16 context_id;
1403         __le16 version;
1404         __le16 size;
1405         __le16 unused;
1406         __le64 unicast_frames;
1407         __le64 multicast_frames;
1408         __le64 broadcast_frames;
1409         __le64 dropped_frames;
1410         __le64 errors;
1411         __le64 local_frames;
1412         __le64 numbytes;
1413         __le64 rsvd[3];
1414 } __packed;
1415
1416 struct __qlcnic_esw_statistics {
1417         u16     context_id;
1418         u16     version;
1419         u16     size;
1420         u16     unused;
1421         u64     unicast_frames;
1422         u64     multicast_frames;
1423         u64     broadcast_frames;
1424         u64     dropped_frames;
1425         u64     errors;
1426         u64     local_frames;
1427         u64     numbytes;
1428         u64     rsvd[3];
1429 };
1430
1431 struct qlcnic_esw_statistics {
1432         struct __qlcnic_esw_statistics rx;
1433         struct __qlcnic_esw_statistics tx;
1434 };
1435
1436 #define QLCNIC_FORCE_FW_DUMP_KEY        0xdeadfeed
1437 #define QLCNIC_ENABLE_FW_DUMP           0xaddfeed
1438 #define QLCNIC_DISABLE_FW_DUMP          0xbadfeed
1439 #define QLCNIC_FORCE_FW_RESET           0xdeaddead
1440 #define QLCNIC_SET_QUIESCENT            0xadd00010
1441 #define QLCNIC_RESET_QUIESCENT          0xadd00020
1442
1443 struct _cdrp_cmd {
1444         u32 num;
1445         u32 *arg;
1446 };
1447
1448 struct qlcnic_cmd_args {
1449         struct completion       completion;
1450         struct list_head        list;
1451         struct _cdrp_cmd        req;
1452         struct _cdrp_cmd        rsp;
1453         atomic_t                rsp_status;
1454         int                     pay_size;
1455         u32                     rsp_opcode;
1456         u32                     total_cmds;
1457         u32                     op_type;
1458         u32                     type;
1459         u32                     cmd_op;
1460         u32                     *hdr;   /* Back channel message header */
1461         u32                     *pay;   /* Back channel message payload */
1462         u8                      func_num;
1463 };
1464
1465 int qlcnic_fw_cmd_get_minidump_temp(struct qlcnic_adapter *adapter);
1466 int qlcnic_fw_cmd_set_port(struct qlcnic_adapter *adapter, u32 config);
1467 int qlcnic_pci_mem_write_2M(struct qlcnic_adapter *, u64 off, u64 data);
1468 int qlcnic_pci_mem_read_2M(struct qlcnic_adapter *, u64 off, u64 *data);
1469 void qlcnic_pci_camqm_read_2M(struct qlcnic_adapter *, u64, u64 *);
1470 void qlcnic_pci_camqm_write_2M(struct qlcnic_adapter *, u64, u64);
1471
1472 #define ADDR_IN_RANGE(addr, low, high)  \
1473         (((addr) < (high)) && ((addr) >= (low)))
1474
1475 #define QLCRD32(adapter, off, err) \
1476         (adapter->ahw->hw_ops->read_reg)(adapter, off, err)
1477
1478 #define QLCWR32(adapter, off, val) \
1479         adapter->ahw->hw_ops->write_reg(adapter, off, val)
1480
1481 int qlcnic_pcie_sem_lock(struct qlcnic_adapter *, int, u32);
1482 void qlcnic_pcie_sem_unlock(struct qlcnic_adapter *, int);
1483
1484 #define qlcnic_rom_lock(a)      \
1485         qlcnic_pcie_sem_lock((a), 2, QLCNIC_ROM_LOCK_ID)
1486 #define qlcnic_rom_unlock(a)    \
1487         qlcnic_pcie_sem_unlock((a), 2)
1488 #define qlcnic_phy_lock(a)      \
1489         qlcnic_pcie_sem_lock((a), 3, QLCNIC_PHY_LOCK_ID)
1490 #define qlcnic_phy_unlock(a)    \
1491         qlcnic_pcie_sem_unlock((a), 3)
1492 #define qlcnic_sw_lock(a)       \
1493         qlcnic_pcie_sem_lock((a), 6, 0)
1494 #define qlcnic_sw_unlock(a)     \
1495         qlcnic_pcie_sem_unlock((a), 6)
1496 #define crb_win_lock(a) \
1497         qlcnic_pcie_sem_lock((a), 7, QLCNIC_CRB_WIN_LOCK_ID)
1498 #define crb_win_unlock(a)       \
1499         qlcnic_pcie_sem_unlock((a), 7)
1500
1501 #define __QLCNIC_MAX_LED_RATE   0xf
1502 #define __QLCNIC_MAX_LED_STATE  0x2
1503
1504 #define MAX_CTL_CHECK 1000
1505
1506 int qlcnic_wol_supported(struct qlcnic_adapter *adapter);
1507 void qlcnic_prune_lb_filters(struct qlcnic_adapter *adapter);
1508 void qlcnic_delete_lb_filters(struct qlcnic_adapter *adapter);
1509 int qlcnic_dump_fw(struct qlcnic_adapter *);
1510 int qlcnic_enable_fw_dump_state(struct qlcnic_adapter *);
1511 bool qlcnic_check_fw_dump_state(struct qlcnic_adapter *);
1512 pci_ers_result_t qlcnic_82xx_io_error_detected(struct pci_dev *,
1513                                                pci_channel_state_t);
1514 pci_ers_result_t qlcnic_82xx_io_slot_reset(struct pci_dev *);
1515 void qlcnic_82xx_io_resume(struct pci_dev *);
1516
1517 /* Functions from qlcnic_init.c */
1518 void qlcnic_schedule_work(struct qlcnic_adapter *, work_func_t, int);
1519 int qlcnic_load_firmware(struct qlcnic_adapter *adapter);
1520 int qlcnic_need_fw_reset(struct qlcnic_adapter *adapter);
1521 void qlcnic_request_firmware(struct qlcnic_adapter *adapter);
1522 void qlcnic_release_firmware(struct qlcnic_adapter *adapter);
1523 int qlcnic_pinit_from_rom(struct qlcnic_adapter *adapter);
1524 int qlcnic_setup_idc_param(struct qlcnic_adapter *adapter);
1525 int qlcnic_check_flash_fw_ver(struct qlcnic_adapter *adapter);
1526
1527 int qlcnic_rom_fast_read(struct qlcnic_adapter *adapter, u32 addr, u32 *valp);
1528 int qlcnic_rom_fast_read_words(struct qlcnic_adapter *adapter, int addr,
1529                                 u8 *bytes, size_t size);
1530 int qlcnic_alloc_sw_resources(struct qlcnic_adapter *adapter);
1531 void qlcnic_free_sw_resources(struct qlcnic_adapter *adapter);
1532
1533 void __iomem *qlcnic_get_ioaddr(struct qlcnic_hardware_context *, u32);
1534
1535 int qlcnic_alloc_hw_resources(struct qlcnic_adapter *adapter);
1536 void qlcnic_free_hw_resources(struct qlcnic_adapter *adapter);
1537
1538 int qlcnic_fw_create_ctx(struct qlcnic_adapter *adapter);
1539 void qlcnic_fw_destroy_ctx(struct qlcnic_adapter *adapter);
1540
1541 void qlcnic_reset_rx_buffers_list(struct qlcnic_adapter *adapter);
1542 void qlcnic_release_rx_buffers(struct qlcnic_adapter *adapter);
1543 void qlcnic_release_tx_buffers(struct qlcnic_adapter *,
1544                                struct qlcnic_host_tx_ring *);
1545
1546 int qlcnic_check_fw_status(struct qlcnic_adapter *adapter);
1547 void qlcnic_watchdog_task(struct work_struct *work);
1548 void qlcnic_post_rx_buffers(struct qlcnic_adapter *adapter,
1549                 struct qlcnic_host_rds_ring *rds_ring, u8 ring_id);
1550 int qlcnic_process_rcv_ring(struct qlcnic_host_sds_ring *sds_ring, int max);
1551 void qlcnic_set_multi(struct net_device *netdev);
1552 void __qlcnic_set_multi(struct net_device *, u16);
1553 int qlcnic_nic_add_mac(struct qlcnic_adapter *, const u8 *, u16);
1554 int qlcnic_nic_del_mac(struct qlcnic_adapter *, const u8 *);
1555 void qlcnic_82xx_free_mac_list(struct qlcnic_adapter *adapter);
1556 int qlcnic_82xx_read_phys_port_id(struct qlcnic_adapter *);
1557
1558 int qlcnic_fw_cmd_set_mtu(struct qlcnic_adapter *adapter, int mtu);
1559 int qlcnic_fw_cmd_set_drv_version(struct qlcnic_adapter *, u32);
1560 int qlcnic_change_mtu(struct net_device *netdev, int new_mtu);
1561 netdev_features_t qlcnic_fix_features(struct net_device *netdev,
1562         netdev_features_t features);
1563 int qlcnic_set_features(struct net_device *netdev, netdev_features_t features);
1564 int qlcnic_config_bridged_mode(struct qlcnic_adapter *adapter, u32 enable);
1565 int qlcnic_send_lro_cleanup(struct qlcnic_adapter *adapter);
1566 void qlcnic_update_cmd_producer(struct qlcnic_host_tx_ring *);
1567
1568 /* Functions from qlcnic_ethtool.c */
1569 int qlcnic_check_loopback_buff(unsigned char *, u8 []);
1570 int qlcnic_do_lb_test(struct qlcnic_adapter *, u8);
1571 int qlcnic_loopback_test(struct net_device *, u8);
1572
1573 /* Functions from qlcnic_main.c */
1574 int qlcnic_reset_context(struct qlcnic_adapter *);
1575 void qlcnic_diag_free_res(struct net_device *netdev, int);
1576 int qlcnic_diag_alloc_res(struct net_device *netdev, int);
1577 netdev_tx_t qlcnic_xmit_frame(struct sk_buff *, struct net_device *);
1578 void qlcnic_set_tx_ring_count(struct qlcnic_adapter *, u8);
1579 void qlcnic_set_sds_ring_count(struct qlcnic_adapter *, u8);
1580 int qlcnic_setup_rings(struct qlcnic_adapter *, u8, u8);
1581 int qlcnic_validate_rings(struct qlcnic_adapter *, __u32, int);
1582 void qlcnic_alloc_lb_filters_mem(struct qlcnic_adapter *adapter);
1583 void qlcnic_82xx_set_mac_filter_count(struct qlcnic_adapter *);
1584 int qlcnic_enable_msix(struct qlcnic_adapter *, u32);
1585 void qlcnic_set_drv_version(struct qlcnic_adapter *);
1586
1587 /*  eSwitch management functions */
1588 int qlcnic_config_switch_port(struct qlcnic_adapter *,
1589                                 struct qlcnic_esw_func_cfg *);
1590
1591 int qlcnic_get_eswitch_port_config(struct qlcnic_adapter *,
1592                                 struct qlcnic_esw_func_cfg *);
1593 int qlcnic_config_port_mirroring(struct qlcnic_adapter *, u8, u8, u8);
1594 int qlcnic_get_port_stats(struct qlcnic_adapter *, const u8, const u8,
1595                                         struct __qlcnic_esw_statistics *);
1596 int qlcnic_get_eswitch_stats(struct qlcnic_adapter *, const u8, u8,
1597                                         struct __qlcnic_esw_statistics *);
1598 int qlcnic_clear_esw_stats(struct qlcnic_adapter *adapter, u8, u8, u8);
1599 int qlcnic_get_mac_stats(struct qlcnic_adapter *, struct qlcnic_mac_statistics *);
1600
1601 void qlcnic_free_mbx_args(struct qlcnic_cmd_args *cmd);
1602
1603 int qlcnic_alloc_sds_rings(struct qlcnic_recv_context *, int);
1604 void qlcnic_free_sds_rings(struct qlcnic_recv_context *);
1605 void qlcnic_advert_link_change(struct qlcnic_adapter *, int);
1606 void qlcnic_free_tx_rings(struct qlcnic_adapter *);
1607 int qlcnic_alloc_tx_rings(struct qlcnic_adapter *, struct net_device *);
1608 void qlcnic_dump_mbx(struct qlcnic_adapter *, struct qlcnic_cmd_args *);
1609
1610 void qlcnic_create_sysfs_entries(struct qlcnic_adapter *adapter);
1611 void qlcnic_remove_sysfs_entries(struct qlcnic_adapter *adapter);
1612 void qlcnic_create_diag_entries(struct qlcnic_adapter *adapter);
1613 void qlcnic_remove_diag_entries(struct qlcnic_adapter *adapter);
1614 void qlcnic_82xx_add_sysfs(struct qlcnic_adapter *adapter);
1615 void qlcnic_82xx_remove_sysfs(struct qlcnic_adapter *adapter);
1616 int qlcnic_82xx_get_settings(struct qlcnic_adapter *, struct ethtool_cmd *);
1617
1618 int qlcnicvf_config_bridged_mode(struct qlcnic_adapter *, u32);
1619 int qlcnicvf_config_led(struct qlcnic_adapter *, u32, u32);
1620 void qlcnic_set_vlan_config(struct qlcnic_adapter *,
1621                             struct qlcnic_esw_func_cfg *);
1622 void qlcnic_set_eswitch_port_features(struct qlcnic_adapter *,
1623                                       struct qlcnic_esw_func_cfg *);
1624
1625 void qlcnic_down(struct qlcnic_adapter *, struct net_device *);
1626 int qlcnic_up(struct qlcnic_adapter *, struct net_device *);
1627 void __qlcnic_down(struct qlcnic_adapter *, struct net_device *);
1628 void qlcnic_detach(struct qlcnic_adapter *);
1629 void qlcnic_teardown_intr(struct qlcnic_adapter *);
1630 int qlcnic_attach(struct qlcnic_adapter *);
1631 int __qlcnic_up(struct qlcnic_adapter *, struct net_device *);
1632 void qlcnic_restore_indev_addr(struct net_device *, unsigned long);
1633
1634 int qlcnic_check_temp(struct qlcnic_adapter *);
1635 int qlcnic_init_pci_info(struct qlcnic_adapter *);
1636 int qlcnic_set_default_offload_settings(struct qlcnic_adapter *);
1637 int qlcnic_reset_npar_config(struct qlcnic_adapter *);
1638 int qlcnic_set_eswitch_port_config(struct qlcnic_adapter *);
1639 void qlcnic_add_lb_filter(struct qlcnic_adapter *, struct sk_buff *, int, u16);
1640 int qlcnic_get_beacon_state(struct qlcnic_adapter *, u8 *);
1641 int qlcnic_83xx_configure_opmode(struct qlcnic_adapter *adapter);
1642 int qlcnic_read_mac_addr(struct qlcnic_adapter *);
1643 int qlcnic_setup_netdev(struct qlcnic_adapter *, struct net_device *, int);
1644 void qlcnic_set_netdev_features(struct qlcnic_adapter *,
1645                                 struct qlcnic_esw_func_cfg *);
1646 void qlcnic_sriov_vf_schedule_multi(struct net_device *);
1647 int qlcnic_is_valid_nic_func(struct qlcnic_adapter *, u8);
1648 int qlcnic_get_pci_func_type(struct qlcnic_adapter *, u16, u16 *, u16 *,
1649                              u16 *);
1650
1651 /*
1652  * QLOGIC Board information
1653  */
1654
1655 #define QLCNIC_MAX_BOARD_NAME_LEN 100
1656 struct qlcnic_board_info {
1657         unsigned short  vendor;
1658         unsigned short  device;
1659         unsigned short  sub_vendor;
1660         unsigned short  sub_device;
1661         char short_name[QLCNIC_MAX_BOARD_NAME_LEN];
1662 };
1663
1664 static inline u32 qlcnic_tx_avail(struct qlcnic_host_tx_ring *tx_ring)
1665 {
1666         if (likely(tx_ring->producer < tx_ring->sw_consumer))
1667                 return tx_ring->sw_consumer - tx_ring->producer;
1668         else
1669                 return tx_ring->sw_consumer + tx_ring->num_desc -
1670                                 tx_ring->producer;
1671 }
1672
1673 static inline int qlcnic_set_real_num_queues(struct qlcnic_adapter *adapter,
1674                                              struct net_device *netdev)
1675 {
1676         int err;
1677
1678         netdev->num_tx_queues = adapter->drv_tx_rings;
1679         netdev->real_num_tx_queues = adapter->drv_tx_rings;
1680
1681         err = netif_set_real_num_tx_queues(netdev, adapter->drv_tx_rings);
1682         if (err)
1683                 dev_err(&adapter->pdev->dev, "failed to set %d Tx queues\n",
1684                         adapter->drv_tx_rings);
1685         else
1686                 dev_info(&adapter->pdev->dev, "Set %d Tx queues\n",
1687                          adapter->drv_tx_rings);
1688
1689         return err;
1690 }
1691
1692 struct qlcnic_nic_template {
1693         int (*config_bridged_mode) (struct qlcnic_adapter *, u32);
1694         int (*config_led) (struct qlcnic_adapter *, u32, u32);
1695         int (*start_firmware) (struct qlcnic_adapter *);
1696         int (*init_driver) (struct qlcnic_adapter *);
1697         void (*request_reset) (struct qlcnic_adapter *, u32);
1698         void (*cancel_idc_work) (struct qlcnic_adapter *);
1699         int (*napi_add)(struct qlcnic_adapter *, struct net_device *);
1700         void (*napi_del)(struct qlcnic_adapter *);
1701         void (*config_ipaddr)(struct qlcnic_adapter *, __be32, int);
1702         irqreturn_t (*clear_legacy_intr)(struct qlcnic_adapter *);
1703         int (*shutdown)(struct pci_dev *);
1704         int (*resume)(struct qlcnic_adapter *);
1705 };
1706
1707 struct qlcnic_mbx_ops {
1708         int (*enqueue_cmd) (struct qlcnic_adapter *,
1709                             struct qlcnic_cmd_args *, unsigned long *);
1710         void (*dequeue_cmd) (struct qlcnic_adapter *, struct qlcnic_cmd_args *);
1711         void (*decode_resp) (struct qlcnic_adapter *, struct qlcnic_cmd_args *);
1712         void (*encode_cmd) (struct qlcnic_adapter *, struct qlcnic_cmd_args *);
1713         void (*nofity_fw) (struct qlcnic_adapter *, u8);
1714 };
1715
1716 int qlcnic_83xx_init_mailbox_work(struct qlcnic_adapter *);
1717 void qlcnic_83xx_detach_mailbox_work(struct qlcnic_adapter *);
1718 void qlcnic_83xx_reinit_mbx_work(struct qlcnic_mailbox *mbx);
1719 void qlcnic_83xx_free_mailbox(struct qlcnic_mailbox *mbx);
1720
1721 /* Adapter hardware abstraction */
1722 struct qlcnic_hardware_ops {
1723         void (*read_crb) (struct qlcnic_adapter *, char *, loff_t, size_t);
1724         void (*write_crb) (struct qlcnic_adapter *, char *, loff_t, size_t);
1725         int (*read_reg) (struct qlcnic_adapter *, ulong, int *);
1726         int (*write_reg) (struct qlcnic_adapter *, ulong, u32);
1727         void (*get_ocm_win) (struct qlcnic_hardware_context *);
1728         int (*get_mac_address) (struct qlcnic_adapter *, u8 *, u8);
1729         int (*setup_intr) (struct qlcnic_adapter *);
1730         int (*alloc_mbx_args)(struct qlcnic_cmd_args *,
1731                               struct qlcnic_adapter *, u32);
1732         int (*mbx_cmd) (struct qlcnic_adapter *, struct qlcnic_cmd_args *);
1733         void (*get_func_no) (struct qlcnic_adapter *);
1734         int (*api_lock) (struct qlcnic_adapter *);
1735         void (*api_unlock) (struct qlcnic_adapter *);
1736         void (*add_sysfs) (struct qlcnic_adapter *);
1737         void (*remove_sysfs) (struct qlcnic_adapter *);
1738         void (*process_lb_rcv_ring_diag) (struct qlcnic_host_sds_ring *);
1739         int (*create_rx_ctx) (struct qlcnic_adapter *);
1740         int (*create_tx_ctx) (struct qlcnic_adapter *,
1741         struct qlcnic_host_tx_ring *, int);
1742         void (*del_rx_ctx) (struct qlcnic_adapter *);
1743         void (*del_tx_ctx) (struct qlcnic_adapter *,
1744                             struct qlcnic_host_tx_ring *);
1745         int (*setup_link_event) (struct qlcnic_adapter *, int);
1746         int (*get_nic_info) (struct qlcnic_adapter *, struct qlcnic_info *, u8);
1747         int (*get_pci_info) (struct qlcnic_adapter *, struct qlcnic_pci_info *);
1748         int (*set_nic_info) (struct qlcnic_adapter *, struct qlcnic_info *);
1749         int (*change_macvlan) (struct qlcnic_adapter *, u8*, u16, u8);
1750         void (*napi_enable) (struct qlcnic_adapter *);
1751         void (*napi_disable) (struct qlcnic_adapter *);
1752         void (*config_intr_coal) (struct qlcnic_adapter *);
1753         int (*config_rss) (struct qlcnic_adapter *, int);
1754         int (*config_hw_lro) (struct qlcnic_adapter *, int);
1755         int (*config_loopback) (struct qlcnic_adapter *, u8);
1756         int (*clear_loopback) (struct qlcnic_adapter *, u8);
1757         int (*config_promisc_mode) (struct qlcnic_adapter *, u32);
1758         void (*change_l2_filter) (struct qlcnic_adapter *, u64 *, u16);
1759         int (*get_board_info) (struct qlcnic_adapter *);
1760         void (*set_mac_filter_count) (struct qlcnic_adapter *);
1761         void (*free_mac_list) (struct qlcnic_adapter *);
1762         int (*read_phys_port_id) (struct qlcnic_adapter *);
1763         pci_ers_result_t (*io_error_detected) (struct pci_dev *,
1764                                                pci_channel_state_t);
1765         pci_ers_result_t (*io_slot_reset) (struct pci_dev *);
1766         void (*io_resume) (struct pci_dev *);
1767 };
1768
1769 extern struct qlcnic_nic_template qlcnic_vf_ops;
1770
1771 static inline int qlcnic_start_firmware(struct qlcnic_adapter *adapter)
1772 {
1773         return adapter->nic_ops->start_firmware(adapter);
1774 }
1775
1776 static inline void qlcnic_read_crb(struct qlcnic_adapter *adapter, char *buf,
1777                                    loff_t offset, size_t size)
1778 {
1779         adapter->ahw->hw_ops->read_crb(adapter, buf, offset, size);
1780 }
1781
1782 static inline void qlcnic_write_crb(struct qlcnic_adapter *adapter, char *buf,
1783                                     loff_t offset, size_t size)
1784 {
1785         adapter->ahw->hw_ops->write_crb(adapter, buf, offset, size);
1786 }
1787
1788 static inline int qlcnic_hw_write_wx_2M(struct qlcnic_adapter *adapter,
1789                                         ulong off, u32 data)
1790 {
1791         return adapter->ahw->hw_ops->write_reg(adapter, off, data);
1792 }
1793
1794 static inline int qlcnic_get_mac_address(struct qlcnic_adapter *adapter,
1795                                          u8 *mac, u8 function)
1796 {
1797         return adapter->ahw->hw_ops->get_mac_address(adapter, mac, function);
1798 }
1799
1800 static inline int qlcnic_setup_intr(struct qlcnic_adapter *adapter)
1801 {
1802         return adapter->ahw->hw_ops->setup_intr(adapter);
1803 }
1804
1805 static inline int qlcnic_alloc_mbx_args(struct qlcnic_cmd_args *mbx,
1806                                         struct qlcnic_adapter *adapter, u32 arg)
1807 {
1808         return adapter->ahw->hw_ops->alloc_mbx_args(mbx, adapter, arg);
1809 }
1810
1811 static inline int qlcnic_issue_cmd(struct qlcnic_adapter *adapter,
1812                                    struct qlcnic_cmd_args *cmd)
1813 {
1814         if (adapter->ahw->hw_ops->mbx_cmd)
1815                 return adapter->ahw->hw_ops->mbx_cmd(adapter, cmd);
1816
1817         return -EIO;
1818 }
1819
1820 static inline void qlcnic_get_func_no(struct qlcnic_adapter *adapter)
1821 {
1822         adapter->ahw->hw_ops->get_func_no(adapter);
1823 }
1824
1825 static inline int qlcnic_api_lock(struct qlcnic_adapter *adapter)
1826 {
1827         return adapter->ahw->hw_ops->api_lock(adapter);
1828 }
1829
1830 static inline void qlcnic_api_unlock(struct qlcnic_adapter *adapter)
1831 {
1832         adapter->ahw->hw_ops->api_unlock(adapter);
1833 }
1834
1835 static inline void qlcnic_add_sysfs(struct qlcnic_adapter *adapter)
1836 {
1837         if (adapter->ahw->hw_ops->add_sysfs)
1838                 adapter->ahw->hw_ops->add_sysfs(adapter);
1839 }
1840
1841 static inline void qlcnic_remove_sysfs(struct qlcnic_adapter *adapter)
1842 {
1843         if (adapter->ahw->hw_ops->remove_sysfs)
1844                 adapter->ahw->hw_ops->remove_sysfs(adapter);
1845 }
1846
1847 static inline void
1848 qlcnic_process_rcv_ring_diag(struct qlcnic_host_sds_ring *sds_ring)
1849 {
1850         sds_ring->adapter->ahw->hw_ops->process_lb_rcv_ring_diag(sds_ring);
1851 }
1852
1853 static inline int qlcnic_fw_cmd_create_rx_ctx(struct qlcnic_adapter *adapter)
1854 {
1855         return adapter->ahw->hw_ops->create_rx_ctx(adapter);
1856 }
1857
1858 static inline int qlcnic_fw_cmd_create_tx_ctx(struct qlcnic_adapter *adapter,
1859                                               struct qlcnic_host_tx_ring *ptr,
1860                                               int ring)
1861 {
1862         return adapter->ahw->hw_ops->create_tx_ctx(adapter, ptr, ring);
1863 }
1864
1865 static inline void qlcnic_fw_cmd_del_rx_ctx(struct qlcnic_adapter *adapter)
1866 {
1867         return adapter->ahw->hw_ops->del_rx_ctx(adapter);
1868 }
1869
1870 static inline void qlcnic_fw_cmd_del_tx_ctx(struct qlcnic_adapter *adapter,
1871                                             struct qlcnic_host_tx_ring *ptr)
1872 {
1873         return adapter->ahw->hw_ops->del_tx_ctx(adapter, ptr);
1874 }
1875
1876 static inline int qlcnic_linkevent_request(struct qlcnic_adapter *adapter,
1877                                            int enable)
1878 {
1879         return adapter->ahw->hw_ops->setup_link_event(adapter, enable);
1880 }
1881
1882 static inline int qlcnic_get_nic_info(struct qlcnic_adapter *adapter,
1883                                       struct qlcnic_info *info, u8 id)
1884 {
1885         return adapter->ahw->hw_ops->get_nic_info(adapter, info, id);
1886 }
1887
1888 static inline int qlcnic_get_pci_info(struct qlcnic_adapter *adapter,
1889                                       struct qlcnic_pci_info *info)
1890 {
1891         return adapter->ahw->hw_ops->get_pci_info(adapter, info);
1892 }
1893
1894 static inline int qlcnic_set_nic_info(struct qlcnic_adapter *adapter,
1895                                       struct qlcnic_info *info)
1896 {
1897         return adapter->ahw->hw_ops->set_nic_info(adapter, info);
1898 }
1899
1900 static inline int qlcnic_sre_macaddr_change(struct qlcnic_adapter *adapter,
1901                                             u8 *addr, u16 id, u8 cmd)
1902 {
1903         return adapter->ahw->hw_ops->change_macvlan(adapter, addr, id, cmd);
1904 }
1905
1906 static inline int qlcnic_napi_add(struct qlcnic_adapter *adapter,
1907                                   struct net_device *netdev)
1908 {
1909         return adapter->nic_ops->napi_add(adapter, netdev);
1910 }
1911
1912 static inline void qlcnic_napi_del(struct qlcnic_adapter *adapter)
1913 {
1914         adapter->nic_ops->napi_del(adapter);
1915 }
1916
1917 static inline void qlcnic_napi_enable(struct qlcnic_adapter *adapter)
1918 {
1919         adapter->ahw->hw_ops->napi_enable(adapter);
1920 }
1921
1922 static inline int __qlcnic_shutdown(struct pci_dev *pdev)
1923 {
1924         struct qlcnic_adapter *adapter = pci_get_drvdata(pdev);
1925
1926         return adapter->nic_ops->shutdown(pdev);
1927 }
1928
1929 static inline int __qlcnic_resume(struct qlcnic_adapter *adapter)
1930 {
1931         return adapter->nic_ops->resume(adapter);
1932 }
1933
1934 static inline void qlcnic_napi_disable(struct qlcnic_adapter *adapter)
1935 {
1936         adapter->ahw->hw_ops->napi_disable(adapter);
1937 }
1938
1939 static inline void qlcnic_config_intr_coalesce(struct qlcnic_adapter *adapter)
1940 {
1941         adapter->ahw->hw_ops->config_intr_coal(adapter);
1942 }
1943
1944 static inline int qlcnic_config_rss(struct qlcnic_adapter *adapter, int enable)
1945 {
1946         return adapter->ahw->hw_ops->config_rss(adapter, enable);
1947 }
1948
1949 static inline int qlcnic_config_hw_lro(struct qlcnic_adapter *adapter,
1950                                        int enable)
1951 {
1952         return adapter->ahw->hw_ops->config_hw_lro(adapter, enable);
1953 }
1954
1955 static inline int qlcnic_set_lb_mode(struct qlcnic_adapter *adapter, u8 mode)
1956 {
1957         return adapter->ahw->hw_ops->config_loopback(adapter, mode);
1958 }
1959
1960 static inline int qlcnic_clear_lb_mode(struct qlcnic_adapter *adapter, u8 mode)
1961 {
1962         return adapter->ahw->hw_ops->clear_loopback(adapter, mode);
1963 }
1964
1965 static inline int qlcnic_nic_set_promisc(struct qlcnic_adapter *adapter,
1966                                          u32 mode)
1967 {
1968         return adapter->ahw->hw_ops->config_promisc_mode(adapter, mode);
1969 }
1970
1971 static inline void qlcnic_change_filter(struct qlcnic_adapter *adapter,
1972                                         u64 *addr, u16 id)
1973 {
1974         adapter->ahw->hw_ops->change_l2_filter(adapter, addr, id);
1975 }
1976
1977 static inline int qlcnic_get_board_info(struct qlcnic_adapter *adapter)
1978 {
1979         return adapter->ahw->hw_ops->get_board_info(adapter);
1980 }
1981
1982 static inline void qlcnic_free_mac_list(struct qlcnic_adapter *adapter)
1983 {
1984         return adapter->ahw->hw_ops->free_mac_list(adapter);
1985 }
1986
1987 static inline void qlcnic_set_mac_filter_count(struct qlcnic_adapter *adapter)
1988 {
1989         if (adapter->ahw->hw_ops->set_mac_filter_count)
1990                 adapter->ahw->hw_ops->set_mac_filter_count(adapter);
1991 }
1992
1993 static inline void qlcnic_read_phys_port_id(struct qlcnic_adapter *adapter)
1994 {
1995         if (adapter->ahw->hw_ops->read_phys_port_id)
1996                 adapter->ahw->hw_ops->read_phys_port_id(adapter);
1997 }
1998
1999 static inline void qlcnic_dev_request_reset(struct qlcnic_adapter *adapter,
2000                                             u32 key)
2001 {
2002         if (adapter->nic_ops->request_reset)
2003                 adapter->nic_ops->request_reset(adapter, key);
2004 }
2005
2006 static inline void qlcnic_cancel_idc_work(struct qlcnic_adapter *adapter)
2007 {
2008         if (adapter->nic_ops->cancel_idc_work)
2009                 adapter->nic_ops->cancel_idc_work(adapter);
2010 }
2011
2012 static inline irqreturn_t
2013 qlcnic_clear_legacy_intr(struct qlcnic_adapter *adapter)
2014 {
2015         return adapter->nic_ops->clear_legacy_intr(adapter);
2016 }
2017
2018 static inline int qlcnic_config_led(struct qlcnic_adapter *adapter, u32 state,
2019                                     u32 rate)
2020 {
2021         return adapter->nic_ops->config_led(adapter, state, rate);
2022 }
2023
2024 static inline void qlcnic_config_ipaddr(struct qlcnic_adapter *adapter,
2025                                         __be32 ip, int cmd)
2026 {
2027         adapter->nic_ops->config_ipaddr(adapter, ip, cmd);
2028 }
2029
2030 static inline bool qlcnic_check_multi_tx(struct qlcnic_adapter *adapter)
2031 {
2032         return test_bit(__QLCNIC_MULTI_TX_UNIQUE, &adapter->state);
2033 }
2034
2035 static inline void qlcnic_disable_multi_tx(struct qlcnic_adapter *adapter)
2036 {
2037         test_and_clear_bit(__QLCNIC_MULTI_TX_UNIQUE, &adapter->state);
2038         adapter->drv_tx_rings = QLCNIC_SINGLE_RING;
2039 }
2040
2041 /* When operating in a muti tx mode, driver needs to write 0x1
2042  * to src register, instead of 0x0 to disable receiving interrupt.
2043  */
2044 static inline void qlcnic_disable_int(struct qlcnic_host_sds_ring *sds_ring)
2045 {
2046         struct qlcnic_adapter *adapter = sds_ring->adapter;
2047
2048         if (qlcnic_check_multi_tx(adapter) &&
2049             !adapter->ahw->diag_test &&
2050             (adapter->flags & QLCNIC_MSIX_ENABLED))
2051                 writel(0x1, sds_ring->crb_intr_mask);
2052         else
2053                 writel(0, sds_ring->crb_intr_mask);
2054 }
2055
2056 /* When operating in a muti tx mode, driver needs to write 0x0
2057  * to src register, instead of 0x1 to enable receiving interrupts.
2058  */
2059 static inline void qlcnic_enable_int(struct qlcnic_host_sds_ring *sds_ring)
2060 {
2061         struct qlcnic_adapter *adapter = sds_ring->adapter;
2062
2063         if (qlcnic_check_multi_tx(adapter) &&
2064             !adapter->ahw->diag_test &&
2065             (adapter->flags & QLCNIC_MSIX_ENABLED))
2066                 writel(0, sds_ring->crb_intr_mask);
2067         else
2068                 writel(0x1, sds_ring->crb_intr_mask);
2069
2070         if (!QLCNIC_IS_MSI_FAMILY(adapter))
2071                 writel(0xfbff, adapter->tgt_mask_reg);
2072 }
2073
2074 static inline int qlcnic_get_diag_lock(struct qlcnic_adapter *adapter)
2075 {
2076         return test_and_set_bit(__QLCNIC_DIAG_MODE, &adapter->state);
2077 }
2078
2079 static inline void qlcnic_release_diag_lock(struct qlcnic_adapter *adapter)
2080 {
2081         clear_bit(__QLCNIC_DIAG_MODE, &adapter->state);
2082 }
2083
2084 static inline int qlcnic_check_diag_status(struct qlcnic_adapter *adapter)
2085 {
2086         return test_bit(__QLCNIC_DIAG_MODE, &adapter->state);
2087 }
2088
2089 extern const struct ethtool_ops qlcnic_sriov_vf_ethtool_ops;
2090 extern const struct ethtool_ops qlcnic_ethtool_ops;
2091 extern const struct ethtool_ops qlcnic_ethtool_failed_ops;
2092
2093 #define QLCDB(adapter, lvl, _fmt, _args...) do {        \
2094         if (NETIF_MSG_##lvl & adapter->ahw->msg_enable) \
2095                 printk(KERN_INFO "%s: %s: " _fmt,       \
2096                          dev_name(&adapter->pdev->dev), \
2097                         __func__, ##_args);             \
2098         } while (0)
2099
2100 #define PCI_DEVICE_ID_QLOGIC_QLE824X            0x8020
2101 #define PCI_DEVICE_ID_QLOGIC_QLE834X            0x8030
2102 #define PCI_DEVICE_ID_QLOGIC_VF_QLE834X 0x8430
2103 #define PCI_DEVICE_ID_QLOGIC_QLE844X            0x8040
2104 #define PCI_DEVICE_ID_QLOGIC_VF_QLE844X 0x8440
2105
2106 static inline bool qlcnic_82xx_check(struct qlcnic_adapter *adapter)
2107 {
2108         unsigned short device = adapter->pdev->device;
2109         return (device == PCI_DEVICE_ID_QLOGIC_QLE824X) ? true : false;
2110 }
2111
2112 static inline bool qlcnic_84xx_check(struct qlcnic_adapter *adapter)
2113 {
2114         unsigned short device = adapter->pdev->device;
2115
2116         return ((device == PCI_DEVICE_ID_QLOGIC_QLE844X) ||
2117                 (device == PCI_DEVICE_ID_QLOGIC_VF_QLE844X)) ? true : false;
2118 }
2119
2120 static inline bool qlcnic_83xx_check(struct qlcnic_adapter *adapter)
2121 {
2122         unsigned short device = adapter->pdev->device;
2123         bool status;
2124
2125         status = ((device == PCI_DEVICE_ID_QLOGIC_QLE834X) ||
2126                   (device == PCI_DEVICE_ID_QLOGIC_QLE844X) ||
2127                   (device == PCI_DEVICE_ID_QLOGIC_VF_QLE844X) ||
2128                   (device == PCI_DEVICE_ID_QLOGIC_VF_QLE834X)) ? true : false;
2129
2130         return status;
2131 }
2132
2133 static inline bool qlcnic_sriov_pf_check(struct qlcnic_adapter *adapter)
2134 {
2135         return (adapter->ahw->op_mode == QLCNIC_SRIOV_PF_FUNC) ? true : false;
2136 }
2137
2138 static inline bool qlcnic_sriov_vf_check(struct qlcnic_adapter *adapter)
2139 {
2140         unsigned short device = adapter->pdev->device;
2141         bool status;
2142
2143         status = ((device == PCI_DEVICE_ID_QLOGIC_VF_QLE834X) ||
2144                   (device == PCI_DEVICE_ID_QLOGIC_VF_QLE844X)) ? true : false;
2145
2146         return status;
2147 }
2148
2149 static inline bool qlcnic_83xx_pf_check(struct qlcnic_adapter *adapter)
2150 {
2151         unsigned short device = adapter->pdev->device;
2152
2153         return (device == PCI_DEVICE_ID_QLOGIC_QLE834X) ? true : false;
2154 }
2155
2156 static inline bool qlcnic_83xx_vf_check(struct qlcnic_adapter *adapter)
2157 {
2158         unsigned short device = adapter->pdev->device;
2159
2160         return (device == PCI_DEVICE_ID_QLOGIC_VF_QLE834X) ? true : false;
2161 }
2162
2163 static inline u32 qlcnic_get_vnic_func_count(struct qlcnic_adapter *adapter)
2164 {
2165         if (qlcnic_84xx_check(adapter))
2166                 return QLC_84XX_VNIC_COUNT;
2167         else
2168                 return QLC_DEFAULT_VNIC_COUNT;
2169 }
2170 #endif                          /* __QLCNIC_H_ */