]> Pileus Git - ~andy/linux/blob - drivers/net/ethernet/qlogic/qlcnic/qlcnic.h
Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net
[~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 54
42 #define QLCNIC_LINUX_VERSIONID  "5.3.54"
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         u8 lb_mode;
497 };
498
499 struct qlcnic_adapter_stats {
500         u64  xmitcalled;
501         u64  xmitfinished;
502         u64  rxdropped;
503         u64  txdropped;
504         u64  csummed;
505         u64  rx_pkts;
506         u64  lro_pkts;
507         u64  rxbytes;
508         u64  txbytes;
509         u64  lrobytes;
510         u64  lso_frames;
511         u64  xmit_on;
512         u64  xmit_off;
513         u64  skb_alloc_failure;
514         u64  null_rxbuf;
515         u64  rx_dma_map_error;
516         u64  tx_dma_map_error;
517         u64  spurious_intr;
518         u64  mac_filter_limit_overrun;
519 };
520
521 /*
522  * Rcv Descriptor Context. One such per Rcv Descriptor. There may
523  * be one Rcv Descriptor for normal packets, one for jumbo and may be others.
524  */
525 struct qlcnic_host_rds_ring {
526         void __iomem *crb_rcv_producer;
527         struct rcv_desc *desc_head;
528         struct qlcnic_rx_buffer *rx_buf_arr;
529         u32 num_desc;
530         u32 producer;
531         u32 dma_size;
532         u32 skb_size;
533         u32 flags;
534         struct list_head free_list;
535         spinlock_t lock;
536         dma_addr_t phys_addr;
537 } ____cacheline_internodealigned_in_smp;
538
539 struct qlcnic_host_sds_ring {
540         u32 consumer;
541         u32 num_desc;
542         void __iomem *crb_sts_consumer;
543
544         struct qlcnic_host_tx_ring *tx_ring;
545         struct status_desc *desc_head;
546         struct qlcnic_adapter *adapter;
547         struct napi_struct napi;
548         struct list_head free_list[NUM_RCV_DESC_RINGS];
549
550         void __iomem *crb_intr_mask;
551         int irq;
552
553         dma_addr_t phys_addr;
554         char name[IFNAMSIZ + 12];
555 } ____cacheline_internodealigned_in_smp;
556
557 struct qlcnic_tx_queue_stats {
558         u64 xmit_on;
559         u64 xmit_off;
560         u64 xmit_called;
561         u64 xmit_finished;
562         u64 tx_bytes;
563 };
564
565 struct qlcnic_host_tx_ring {
566         int irq;
567         void __iomem *crb_intr_mask;
568         char name[IFNAMSIZ + 12];
569         u16 ctx_id;
570
571         u32 state;
572         u32 producer;
573         u32 sw_consumer;
574         u32 num_desc;
575
576         struct qlcnic_tx_queue_stats tx_stats;
577
578         void __iomem *crb_cmd_producer;
579         struct cmd_desc_type0 *desc_head;
580         struct qlcnic_adapter *adapter;
581         struct napi_struct napi;
582         struct qlcnic_cmd_buffer *cmd_buf_arr;
583         __le32 *hw_consumer;
584
585         dma_addr_t phys_addr;
586         dma_addr_t hw_cons_phys_addr;
587         struct netdev_queue *txq;
588         /* Lock to protect Tx descriptors cleanup */
589         spinlock_t tx_clean_lock;
590 } ____cacheline_internodealigned_in_smp;
591
592 /*
593  * Receive context. There is one such structure per instance of the
594  * receive processing. Any state information that is relevant to
595  * the receive, and is must be in this structure. The global data may be
596  * present elsewhere.
597  */
598 struct qlcnic_recv_context {
599         struct qlcnic_host_rds_ring *rds_rings;
600         struct qlcnic_host_sds_ring *sds_rings;
601         u32 state;
602         u16 context_id;
603         u16 virt_port;
604 };
605
606 /* HW context creation */
607
608 #define QLCNIC_OS_CRB_RETRY_COUNT       4000
609
610 #define QLCNIC_CDRP_CMD_BIT             0x80000000
611
612 /*
613  * All responses must have the QLCNIC_CDRP_CMD_BIT cleared
614  * in the crb QLCNIC_CDRP_CRB_OFFSET.
615  */
616 #define QLCNIC_CDRP_FORM_RSP(rsp)       (rsp)
617 #define QLCNIC_CDRP_IS_RSP(rsp) (((rsp) & QLCNIC_CDRP_CMD_BIT) == 0)
618
619 #define QLCNIC_CDRP_RSP_OK              0x00000001
620 #define QLCNIC_CDRP_RSP_FAIL            0x00000002
621 #define QLCNIC_CDRP_RSP_TIMEOUT         0x00000003
622
623 /*
624  * All commands must have the QLCNIC_CDRP_CMD_BIT set in
625  * the crb QLCNIC_CDRP_CRB_OFFSET.
626  */
627 #define QLCNIC_CDRP_FORM_CMD(cmd)       (QLCNIC_CDRP_CMD_BIT | (cmd))
628
629 #define QLCNIC_RCODE_SUCCESS            0
630 #define QLCNIC_RCODE_INVALID_ARGS       6
631 #define QLCNIC_RCODE_NOT_SUPPORTED      9
632 #define QLCNIC_RCODE_NOT_PERMITTED      10
633 #define QLCNIC_RCODE_NOT_IMPL           15
634 #define QLCNIC_RCODE_INVALID            16
635 #define QLCNIC_RCODE_TIMEOUT            17
636 #define QLCNIC_DESTROY_CTX_RESET        0
637
638 /*
639  * Capabilities Announced
640  */
641 #define QLCNIC_CAP0_LEGACY_CONTEXT      (1)
642 #define QLCNIC_CAP0_LEGACY_MN           (1 << 2)
643 #define QLCNIC_CAP0_LSO                 (1 << 6)
644 #define QLCNIC_CAP0_JUMBO_CONTIGUOUS    (1 << 7)
645 #define QLCNIC_CAP0_LRO_CONTIGUOUS      (1 << 8)
646 #define QLCNIC_CAP0_VALIDOFF            (1 << 11)
647 #define QLCNIC_CAP0_LRO_MSS             (1 << 21)
648 #define QLCNIC_CAP0_TX_MULTI            (1 << 22)
649
650 /*
651  * Context state
652  */
653 #define QLCNIC_HOST_CTX_STATE_FREED     0
654 #define QLCNIC_HOST_CTX_STATE_ACTIVE    2
655
656 /*
657  * Rx context
658  */
659
660 struct qlcnic_hostrq_sds_ring {
661         __le64 host_phys_addr;  /* Ring base addr */
662         __le32 ring_size;               /* Ring entries */
663         __le16 msi_index;
664         __le16 rsvd;            /* Padding */
665 } __packed;
666
667 struct qlcnic_hostrq_rds_ring {
668         __le64 host_phys_addr;  /* Ring base addr */
669         __le64 buff_size;               /* Packet buffer size */
670         __le32 ring_size;               /* Ring entries */
671         __le32 ring_kind;               /* Class of ring */
672 } __packed;
673
674 struct qlcnic_hostrq_rx_ctx {
675         __le64 host_rsp_dma_addr;       /* Response dma'd here */
676         __le32 capabilities[4];         /* Flag bit vector */
677         __le32 host_int_crb_mode;       /* Interrupt crb usage */
678         __le32 host_rds_crb_mode;       /* RDS crb usage */
679         /* These ring offsets are relative to data[0] below */
680         __le32 rds_ring_offset; /* Offset to RDS config */
681         __le32 sds_ring_offset; /* Offset to SDS config */
682         __le16 num_rds_rings;   /* Count of RDS rings */
683         __le16 num_sds_rings;   /* Count of SDS rings */
684         __le16 valid_field_offset;
685         u8  txrx_sds_binding;
686         u8  msix_handler;
687         u8  reserved[128];      /* reserve space for future expansion*/
688         /* MUST BE 64-bit aligned.
689            The following is packed:
690            - N hostrq_rds_rings
691            - N hostrq_sds_rings */
692         char data[0];
693 } __packed;
694
695 struct qlcnic_cardrsp_rds_ring{
696         __le32 host_producer_crb;       /* Crb to use */
697         __le32 rsvd1;           /* Padding */
698 } __packed;
699
700 struct qlcnic_cardrsp_sds_ring {
701         __le32 host_consumer_crb;       /* Crb to use */
702         __le32 interrupt_crb;   /* Crb to use */
703 } __packed;
704
705 struct qlcnic_cardrsp_rx_ctx {
706         /* These ring offsets are relative to data[0] below */
707         __le32 rds_ring_offset; /* Offset to RDS config */
708         __le32 sds_ring_offset; /* Offset to SDS config */
709         __le32 host_ctx_state;  /* Starting State */
710         __le32 num_fn_per_port; /* How many PCI fn share the port */
711         __le16 num_rds_rings;   /* Count of RDS rings */
712         __le16 num_sds_rings;   /* Count of SDS rings */
713         __le16 context_id;              /* Handle for context */
714         u8  phys_port;          /* Physical id of port */
715         u8  virt_port;          /* Virtual/Logical id of port */
716         u8  reserved[128];      /* save space for future expansion */
717         /*  MUST BE 64-bit aligned.
718            The following is packed:
719            - N cardrsp_rds_rings
720            - N cardrs_sds_rings */
721         char data[0];
722 } __packed;
723
724 #define SIZEOF_HOSTRQ_RX(HOSTRQ_RX, rds_rings, sds_rings)       \
725         (sizeof(HOSTRQ_RX) +                                    \
726         (rds_rings)*(sizeof(struct qlcnic_hostrq_rds_ring)) +           \
727         (sds_rings)*(sizeof(struct qlcnic_hostrq_sds_ring)))
728
729 #define SIZEOF_CARDRSP_RX(CARDRSP_RX, rds_rings, sds_rings)     \
730         (sizeof(CARDRSP_RX) +                                   \
731         (rds_rings)*(sizeof(struct qlcnic_cardrsp_rds_ring)) +          \
732         (sds_rings)*(sizeof(struct qlcnic_cardrsp_sds_ring)))
733
734 /*
735  * Tx context
736  */
737
738 struct qlcnic_hostrq_cds_ring {
739         __le64 host_phys_addr;  /* Ring base addr */
740         __le32 ring_size;               /* Ring entries */
741         __le32 rsvd;            /* Padding */
742 } __packed;
743
744 struct qlcnic_hostrq_tx_ctx {
745         __le64 host_rsp_dma_addr;       /* Response dma'd here */
746         __le64 cmd_cons_dma_addr;       /*  */
747         __le64 dummy_dma_addr;  /*  */
748         __le32 capabilities[4]; /* Flag bit vector */
749         __le32 host_int_crb_mode;       /* Interrupt crb usage */
750         __le32 rsvd1;           /* Padding */
751         __le16 rsvd2;           /* Padding */
752         __le16 interrupt_ctl;
753         __le16 msi_index;
754         __le16 rsvd3;           /* Padding */
755         struct qlcnic_hostrq_cds_ring cds_ring; /* Desc of cds ring */
756         u8  reserved[128];      /* future expansion */
757 } __packed;
758
759 struct qlcnic_cardrsp_cds_ring {
760         __le32 host_producer_crb;       /* Crb to use */
761         __le32 interrupt_crb;   /* Crb to use */
762 } __packed;
763
764 struct qlcnic_cardrsp_tx_ctx {
765         __le32 host_ctx_state;  /* Starting state */
766         __le16 context_id;              /* Handle for context */
767         u8  phys_port;          /* Physical id of port */
768         u8  virt_port;          /* Virtual/Logical id of port */
769         struct qlcnic_cardrsp_cds_ring cds_ring;        /* Card cds settings */
770         u8  reserved[128];      /* future expansion */
771 } __packed;
772
773 #define SIZEOF_HOSTRQ_TX(HOSTRQ_TX)     (sizeof(HOSTRQ_TX))
774 #define SIZEOF_CARDRSP_TX(CARDRSP_TX)   (sizeof(CARDRSP_TX))
775
776 /* CRB */
777
778 #define QLCNIC_HOST_RDS_CRB_MODE_UNIQUE 0
779 #define QLCNIC_HOST_RDS_CRB_MODE_SHARED 1
780 #define QLCNIC_HOST_RDS_CRB_MODE_CUSTOM 2
781 #define QLCNIC_HOST_RDS_CRB_MODE_MAX    3
782
783 #define QLCNIC_HOST_INT_CRB_MODE_UNIQUE 0
784 #define QLCNIC_HOST_INT_CRB_MODE_SHARED 1
785 #define QLCNIC_HOST_INT_CRB_MODE_NORX   2
786 #define QLCNIC_HOST_INT_CRB_MODE_NOTX   3
787 #define QLCNIC_HOST_INT_CRB_MODE_NORXTX 4
788
789
790 /* MAC */
791
792 #define MC_COUNT_P3P    38
793
794 #define QLCNIC_MAC_NOOP 0
795 #define QLCNIC_MAC_ADD  1
796 #define QLCNIC_MAC_DEL  2
797 #define QLCNIC_MAC_VLAN_ADD     3
798 #define QLCNIC_MAC_VLAN_DEL     4
799
800 struct qlcnic_mac_vlan_list {
801         struct list_head list;
802         uint8_t mac_addr[ETH_ALEN+2];
803         u16 vlan_id;
804 };
805
806 /* MAC Learn */
807 #define NO_MAC_LEARN            0
808 #define DRV_MAC_LEARN           1
809 #define FDB_MAC_LEARN           2
810
811 #define QLCNIC_HOST_REQUEST     0x13
812 #define QLCNIC_REQUEST          0x14
813
814 #define QLCNIC_MAC_EVENT        0x1
815
816 #define QLCNIC_IP_UP            2
817 #define QLCNIC_IP_DOWN          3
818
819 #define QLCNIC_ILB_MODE         0x1
820 #define QLCNIC_ELB_MODE         0x2
821 #define QLCNIC_LB_MODE_MASK     0x3
822
823 #define QLCNIC_LINKEVENT        0x1
824 #define QLCNIC_LB_RESPONSE      0x2
825 #define QLCNIC_IS_LB_CONFIGURED(VAL)    \
826                 (VAL == (QLCNIC_LINKEVENT | QLCNIC_LB_RESPONSE))
827
828 /*
829  * Driver --> Firmware
830  */
831 #define QLCNIC_H2C_OPCODE_CONFIG_RSS                    0x1
832 #define QLCNIC_H2C_OPCODE_CONFIG_INTR_COALESCE          0x3
833 #define QLCNIC_H2C_OPCODE_CONFIG_LED                    0x4
834 #define QLCNIC_H2C_OPCODE_LRO_REQUEST                   0x7
835 #define QLCNIC_H2C_OPCODE_SET_MAC_RECEIVE_MODE          0xc
836 #define QLCNIC_H2C_OPCODE_CONFIG_IPADDR         0x12
837
838 #define QLCNIC_H2C_OPCODE_GET_LINKEVENT         0x15
839 #define QLCNIC_H2C_OPCODE_CONFIG_BRIDGING               0x17
840 #define QLCNIC_H2C_OPCODE_CONFIG_HW_LRO         0x18
841 #define QLCNIC_H2C_OPCODE_CONFIG_LOOPBACK               0x13
842
843 /*
844  * Firmware --> Driver
845  */
846
847 #define QLCNIC_C2H_OPCODE_CONFIG_LOOPBACK               0x8f
848 #define QLCNIC_C2H_OPCODE_GET_LINKEVENT_RESPONSE        0x8D
849 #define QLCNIC_C2H_OPCODE_GET_DCB_AEN                   0x90
850
851 #define VPORT_MISS_MODE_DROP            0 /* drop all unmatched */
852 #define VPORT_MISS_MODE_ACCEPT_ALL      1 /* accept all packets */
853 #define VPORT_MISS_MODE_ACCEPT_MULTI    2 /* accept unmatched multicast */
854
855 #define QLCNIC_LRO_REQUEST_CLEANUP      4
856
857 /* Capabilites received */
858 #define QLCNIC_FW_CAPABILITY_TSO                BIT_1
859 #define QLCNIC_FW_CAPABILITY_BDG                BIT_8
860 #define QLCNIC_FW_CAPABILITY_FVLANTX            BIT_9
861 #define QLCNIC_FW_CAPABILITY_HW_LRO             BIT_10
862 #define QLCNIC_FW_CAPABILITY_2_MULTI_TX         BIT_4
863 #define QLCNIC_FW_CAPABILITY_MULTI_LOOPBACK     BIT_27
864 #define QLCNIC_FW_CAPABILITY_MORE_CAPS          BIT_31
865
866 #define QLCNIC_FW_CAPABILITY_2_LRO_MAX_TCP_SEG  BIT_2
867 #define QLCNIC_FW_CAP2_HW_LRO_IPV6              BIT_3
868 #define QLCNIC_FW_CAPABILITY_SET_DRV_VER        BIT_5
869 #define QLCNIC_FW_CAPABILITY_2_BEACON           BIT_7
870 #define QLCNIC_FW_CAPABILITY_2_PER_PORT_ESWITCH_CFG     BIT_9
871
872 /* module types */
873 #define LINKEVENT_MODULE_NOT_PRESENT                    1
874 #define LINKEVENT_MODULE_OPTICAL_UNKNOWN                2
875 #define LINKEVENT_MODULE_OPTICAL_SRLR                   3
876 #define LINKEVENT_MODULE_OPTICAL_LRM                    4
877 #define LINKEVENT_MODULE_OPTICAL_SFP_1G                 5
878 #define LINKEVENT_MODULE_TWINAX_UNSUPPORTED_CABLE       6
879 #define LINKEVENT_MODULE_TWINAX_UNSUPPORTED_CABLELEN    7
880 #define LINKEVENT_MODULE_TWINAX                         8
881
882 #define LINKSPEED_10GBPS        10000
883 #define LINKSPEED_1GBPS         1000
884 #define LINKSPEED_100MBPS       100
885 #define LINKSPEED_10MBPS        10
886
887 #define LINKSPEED_ENCODED_10MBPS        0
888 #define LINKSPEED_ENCODED_100MBPS       1
889 #define LINKSPEED_ENCODED_1GBPS         2
890
891 #define LINKEVENT_AUTONEG_DISABLED      0
892 #define LINKEVENT_AUTONEG_ENABLED       1
893
894 #define LINKEVENT_HALF_DUPLEX           0
895 #define LINKEVENT_FULL_DUPLEX           1
896
897 #define LINKEVENT_LINKSPEED_MBPS        0
898 #define LINKEVENT_LINKSPEED_ENCODED     1
899
900 /* firmware response header:
901  *      63:58 - message type
902  *      57:56 - owner
903  *      55:53 - desc count
904  *      52:48 - reserved
905  *      47:40 - completion id
906  *      39:32 - opcode
907  *      31:16 - error code
908  *      15:00 - reserved
909  */
910 #define qlcnic_get_nic_msg_opcode(msg_hdr)      \
911         ((msg_hdr >> 32) & 0xFF)
912
913 struct qlcnic_fw_msg {
914         union {
915                 struct {
916                         u64 hdr;
917                         u64 body[7];
918                 };
919                 u64 words[8];
920         };
921 };
922
923 struct qlcnic_nic_req {
924         __le64 qhdr;
925         __le64 req_hdr;
926         __le64 words[6];
927 } __packed;
928
929 struct qlcnic_mac_req {
930         u8 op;
931         u8 tag;
932         u8 mac_addr[6];
933 };
934
935 struct qlcnic_vlan_req {
936         __le16 vlan_id;
937         __le16 rsvd[3];
938 } __packed;
939
940 struct qlcnic_ipaddr {
941         __be32 ipv4;
942         __be32 ipv6[4];
943 };
944
945 #define QLCNIC_MSI_ENABLED              0x02
946 #define QLCNIC_MSIX_ENABLED             0x04
947 #define QLCNIC_LRO_ENABLED              0x01
948 #define QLCNIC_LRO_DISABLED             0x00
949 #define QLCNIC_BRIDGE_ENABLED           0X10
950 #define QLCNIC_DIAG_ENABLED             0x20
951 #define QLCNIC_ESWITCH_ENABLED          0x40
952 #define QLCNIC_ADAPTER_INITIALIZED      0x80
953 #define QLCNIC_TAGGING_ENABLED          0x100
954 #define QLCNIC_MACSPOOF                 0x200
955 #define QLCNIC_MAC_OVERRIDE_DISABLED    0x400
956 #define QLCNIC_PROMISC_DISABLED         0x800
957 #define QLCNIC_NEED_FLR                 0x1000
958 #define QLCNIC_FW_RESET_OWNER           0x2000
959 #define QLCNIC_FW_HANG                  0x4000
960 #define QLCNIC_FW_LRO_MSS_CAP           0x8000
961 #define QLCNIC_TX_INTR_SHARED           0x10000
962 #define QLCNIC_APP_CHANGED_FLAGS        0x20000
963 #define QLCNIC_HAS_PHYS_PORT_ID         0x40000
964
965 #define QLCNIC_IS_MSI_FAMILY(adapter) \
966         ((adapter)->flags & (QLCNIC_MSI_ENABLED | QLCNIC_MSIX_ENABLED))
967 #define QLCNIC_IS_TSO_CAPABLE(adapter)  \
968         ((adapter)->ahw->capabilities & QLCNIC_FW_CAPABILITY_TSO)
969
970 #define QLCNIC_BEACON_EANBLE            0xC
971 #define QLCNIC_BEACON_DISABLE           0xD
972
973 #define QLCNIC_BEACON_ON                2
974 #define QLCNIC_BEACON_OFF               0
975
976 #define QLCNIC_MSIX_TBL_SPACE           8192
977 #define QLCNIC_PCI_REG_MSIX_TBL         0x44
978 #define QLCNIC_MSIX_TBL_PGSIZE          4096
979
980 #define QLCNIC_ADAPTER_UP_MAGIC 777
981
982 #define __QLCNIC_FW_ATTACHED            0
983 #define __QLCNIC_DEV_UP                 1
984 #define __QLCNIC_RESETTING              2
985 #define __QLCNIC_START_FW               4
986 #define __QLCNIC_AER                    5
987 #define __QLCNIC_DIAG_RES_ALLOC         6
988 #define __QLCNIC_LED_ENABLE             7
989 #define __QLCNIC_ELB_INPROGRESS         8
990 #define __QLCNIC_MULTI_TX_UNIQUE        9
991 #define __QLCNIC_SRIOV_ENABLE           10
992 #define __QLCNIC_SRIOV_CAPABLE          11
993 #define __QLCNIC_MBX_POLL_ENABLE        12
994 #define __QLCNIC_DIAG_MODE              13
995 #define __QLCNIC_MAINTENANCE_MODE       16
996
997 #define QLCNIC_INTERRUPT_TEST           1
998 #define QLCNIC_LOOPBACK_TEST            2
999 #define QLCNIC_LED_TEST         3
1000
1001 #define QLCNIC_FILTER_AGE       80
1002 #define QLCNIC_READD_AGE        20
1003 #define QLCNIC_LB_MAX_FILTERS   64
1004 #define QLCNIC_LB_BUCKET_SIZE   32
1005 #define QLCNIC_ILB_MAX_RCV_LOOP 10
1006
1007 struct qlcnic_filter {
1008         struct hlist_node fnode;
1009         u8 faddr[ETH_ALEN];
1010         u16 vlan_id;
1011         unsigned long ftime;
1012 };
1013
1014 struct qlcnic_filter_hash {
1015         struct hlist_head *fhead;
1016         u8 fnum;
1017         u16 fmax;
1018         u16 fbucket_size;
1019 };
1020
1021 /* Mailbox specific data structures */
1022 struct qlcnic_mailbox {
1023         struct workqueue_struct *work_q;
1024         struct qlcnic_adapter   *adapter;
1025         struct qlcnic_mbx_ops   *ops;
1026         struct work_struct      work;
1027         struct completion       completion;
1028         struct list_head        cmd_q;
1029         unsigned long           status;
1030         spinlock_t              queue_lock;     /* Mailbox queue lock */
1031         spinlock_t              aen_lock;       /* Mailbox response/AEN lock */
1032         atomic_t                rsp_status;
1033         u32                     num_cmds;
1034 };
1035
1036 struct qlcnic_adapter {
1037         struct qlcnic_hardware_context *ahw;
1038         struct qlcnic_recv_context *recv_ctx;
1039         struct qlcnic_host_tx_ring *tx_ring;
1040         struct net_device *netdev;
1041         struct pci_dev *pdev;
1042
1043         unsigned long state;
1044         u32 flags;
1045
1046         u16 num_txd;
1047         u16 num_rxd;
1048         u16 num_jumbo_rxd;
1049         u16 max_rxd;
1050         u16 max_jumbo_rxd;
1051
1052         u8 max_rds_rings;
1053
1054         u8 max_sds_rings; /* max sds rings supported by adapter */
1055         u8 max_tx_rings;  /* max tx rings supported by adapter */
1056
1057         u8 drv_tx_rings;  /* max tx rings supported by driver */
1058         u8 drv_sds_rings; /* max sds rings supported by driver */
1059
1060         u8 rx_csum;
1061         u8 portnum;
1062
1063         u8 fw_wait_cnt;
1064         u8 fw_fail_cnt;
1065         u8 tx_timeo_cnt;
1066         u8 need_fw_reset;
1067         u8 reset_ctx_cnt;
1068
1069         u16 is_up;
1070         u16 rx_pvid;
1071         u16 tx_pvid;
1072
1073         u32 irq;
1074         u32 heartbeat;
1075
1076         u8 dev_state;
1077         u8 reset_ack_timeo;
1078         u8 dev_init_timeo;
1079
1080         u8 mac_addr[ETH_ALEN];
1081
1082         u64 dev_rst_time;
1083         bool drv_mac_learn;
1084         bool fdb_mac_learn;
1085         u8 rx_mac_learn;
1086         unsigned long vlans[BITS_TO_LONGS(VLAN_N_VID)];
1087         u8 flash_mfg_id;
1088         struct qlcnic_npar_info *npars;
1089         struct qlcnic_eswitch *eswitch;
1090         struct qlcnic_nic_template *nic_ops;
1091
1092         struct qlcnic_adapter_stats stats;
1093         struct list_head mac_list;
1094
1095         void __iomem    *tgt_mask_reg;
1096         void __iomem    *tgt_status_reg;
1097         void __iomem    *crb_int_state_reg;
1098         void __iomem    *isr_int_vec;
1099
1100         struct msix_entry *msix_entries;
1101         struct workqueue_struct *qlcnic_wq;
1102         struct delayed_work fw_work;
1103         struct delayed_work idc_aen_work;
1104         struct delayed_work mbx_poll_work;
1105         struct qlcnic_dcb *dcb;
1106
1107         struct qlcnic_filter_hash fhash;
1108         struct qlcnic_filter_hash rx_fhash;
1109         struct list_head vf_mc_list;
1110
1111         spinlock_t mac_learn_lock;
1112         /* spinlock for catching rcv filters for eswitch traffic */
1113         spinlock_t rx_mac_learn_lock;
1114         u32 file_prd_off;       /*File fw product offset*/
1115         u32 fw_version;
1116         u32 offload_flags;
1117         const struct firmware *fw;
1118 };
1119
1120 struct qlcnic_info_le {
1121         __le16  pci_func;
1122         __le16  op_mode;        /* 1 = Priv, 2 = NP, 3 = NP passthru */
1123         __le16  phys_port;
1124         __le16  switch_mode;    /* 0 = disabled, 1 = int, 2 = ext */
1125
1126         __le32  capabilities;
1127         u8      max_mac_filters;
1128         u8      reserved1;
1129         __le16  max_mtu;
1130
1131         __le16  max_tx_ques;
1132         __le16  max_rx_ques;
1133         __le16  min_tx_bw;
1134         __le16  max_tx_bw;
1135         __le32  op_type;
1136         __le16  max_bw_reg_offset;
1137         __le16  max_linkspeed_reg_offset;
1138         __le32  capability1;
1139         __le32  capability2;
1140         __le32  capability3;
1141         __le16  max_tx_mac_filters;
1142         __le16  max_rx_mcast_mac_filters;
1143         __le16  max_rx_ucast_mac_filters;
1144         __le16  max_rx_ip_addr;
1145         __le16  max_rx_lro_flow;
1146         __le16  max_rx_status_rings;
1147         __le16  max_rx_buf_rings;
1148         __le16  max_tx_vlan_keys;
1149         u8      total_pf;
1150         u8      total_rss_engines;
1151         __le16  max_vports;
1152         __le16  linkstate_reg_offset;
1153         __le16  bit_offsets;
1154         __le16  max_local_ipv6_addrs;
1155         __le16  max_remote_ipv6_addrs;
1156         u8      reserved2[56];
1157 } __packed;
1158
1159 struct qlcnic_info {
1160         u16     pci_func;
1161         u16     op_mode;
1162         u16     phys_port;
1163         u16     switch_mode;
1164         u32     capabilities;
1165         u8      max_mac_filters;
1166         u16     max_mtu;
1167         u16     max_tx_ques;
1168         u16     max_rx_ques;
1169         u16     min_tx_bw;
1170         u16     max_tx_bw;
1171         u32     op_type;
1172         u16     max_bw_reg_offset;
1173         u16     max_linkspeed_reg_offset;
1174         u32     capability1;
1175         u32     capability2;
1176         u32     capability3;
1177         u16     max_tx_mac_filters;
1178         u16     max_rx_mcast_mac_filters;
1179         u16     max_rx_ucast_mac_filters;
1180         u16     max_rx_ip_addr;
1181         u16     max_rx_lro_flow;
1182         u16     max_rx_status_rings;
1183         u16     max_rx_buf_rings;
1184         u16     max_tx_vlan_keys;
1185         u8      total_pf;
1186         u8      total_rss_engines;
1187         u16     max_vports;
1188         u16     linkstate_reg_offset;
1189         u16     bit_offsets;
1190         u16     max_local_ipv6_addrs;
1191         u16     max_remote_ipv6_addrs;
1192 };
1193
1194 struct qlcnic_pci_info_le {
1195         __le16  id;             /* pci function id */
1196         __le16  active;         /* 1 = Enabled */
1197         __le16  type;           /* 1 = NIC, 2 = FCoE, 3 = iSCSI */
1198         __le16  default_port;   /* default port number */
1199
1200         __le16  tx_min_bw;      /* Multiple of 100mbpc */
1201         __le16  tx_max_bw;
1202         __le16  reserved1[2];
1203
1204         u8      mac[ETH_ALEN];
1205         __le16  func_count;
1206         u8      reserved2[104];
1207
1208 } __packed;
1209
1210 struct qlcnic_pci_info {
1211         u16     id;
1212         u16     active;
1213         u16     type;
1214         u16     default_port;
1215         u16     tx_min_bw;
1216         u16     tx_max_bw;
1217         u8      mac[ETH_ALEN];
1218         u16  func_count;
1219 };
1220
1221 struct qlcnic_npar_info {
1222         bool    eswitch_status;
1223         u16     pvid;
1224         u16     min_bw;
1225         u16     max_bw;
1226         u8      phy_port;
1227         u8      type;
1228         u8      active;
1229         u8      enable_pm;
1230         u8      dest_npar;
1231         u8      discard_tagged;
1232         u8      mac_override;
1233         u8      mac_anti_spoof;
1234         u8      promisc_mode;
1235         u8      offload_flags;
1236         u8      pci_func;
1237         u8      mac[ETH_ALEN];
1238 };
1239
1240 struct qlcnic_eswitch {
1241         u8      port;
1242         u8      active_vports;
1243         u8      active_vlans;
1244         u8      active_ucast_filters;
1245         u8      max_ucast_filters;
1246         u8      max_active_vlans;
1247
1248         u32     flags;
1249 #define QLCNIC_SWITCH_ENABLE            BIT_1
1250 #define QLCNIC_SWITCH_VLAN_FILTERING    BIT_2
1251 #define QLCNIC_SWITCH_PROMISC_MODE      BIT_3
1252 #define QLCNIC_SWITCH_PORT_MIRRORING    BIT_4
1253 };
1254
1255
1256 /* Return codes for Error handling */
1257 #define QL_STATUS_INVALID_PARAM -1
1258
1259 #define MAX_BW                  100     /* % of link speed */
1260 #define MAX_VLAN_ID             4095
1261 #define MIN_VLAN_ID             2
1262 #define DEFAULT_MAC_LEARN       1
1263
1264 #define IS_VALID_VLAN(vlan)     (vlan >= MIN_VLAN_ID && vlan < MAX_VLAN_ID)
1265 #define IS_VALID_BW(bw)         (bw <= MAX_BW)
1266
1267 struct qlcnic_pci_func_cfg {
1268         u16     func_type;
1269         u16     min_bw;
1270         u16     max_bw;
1271         u16     port_num;
1272         u8      pci_func;
1273         u8      func_state;
1274         u8      def_mac_addr[ETH_ALEN];
1275 };
1276
1277 struct qlcnic_npar_func_cfg {
1278         u32     fw_capab;
1279         u16     port_num;
1280         u16     min_bw;
1281         u16     max_bw;
1282         u16     max_tx_queues;
1283         u16     max_rx_queues;
1284         u8      pci_func;
1285         u8      op_mode;
1286 };
1287
1288 struct qlcnic_pm_func_cfg {
1289         u8      pci_func;
1290         u8      action;
1291         u8      dest_npar;
1292         u8      reserved[5];
1293 };
1294
1295 struct qlcnic_esw_func_cfg {
1296         u16     vlan_id;
1297         u8      op_mode;
1298         u8      op_type;
1299         u8      pci_func;
1300         u8      host_vlan_tag;
1301         u8      promisc_mode;
1302         u8      discard_tagged;
1303         u8      mac_override;
1304         u8      mac_anti_spoof;
1305         u8      offload_flags;
1306         u8      reserved[5];
1307 };
1308
1309 #define QLCNIC_STATS_VERSION            1
1310 #define QLCNIC_STATS_PORT               1
1311 #define QLCNIC_STATS_ESWITCH            2
1312 #define QLCNIC_QUERY_RX_COUNTER         0
1313 #define QLCNIC_QUERY_TX_COUNTER         1
1314 #define QLCNIC_STATS_NOT_AVAIL  0xffffffffffffffffULL
1315 #define QLCNIC_FILL_STATS(VAL1) \
1316         (((VAL1) == QLCNIC_STATS_NOT_AVAIL) ? 0 : VAL1)
1317 #define QLCNIC_MAC_STATS 1
1318 #define QLCNIC_ESW_STATS 2
1319
1320 #define QLCNIC_ADD_ESW_STATS(VAL1, VAL2)\
1321 do {    \
1322         if (((VAL1) == QLCNIC_STATS_NOT_AVAIL) && \
1323             ((VAL2) != QLCNIC_STATS_NOT_AVAIL)) \
1324                 (VAL1) = (VAL2); \
1325         else if (((VAL1) != QLCNIC_STATS_NOT_AVAIL) && \
1326                  ((VAL2) != QLCNIC_STATS_NOT_AVAIL)) \
1327                         (VAL1) += (VAL2); \
1328 } while (0)
1329
1330 struct qlcnic_mac_statistics_le {
1331         __le64  mac_tx_frames;
1332         __le64  mac_tx_bytes;
1333         __le64  mac_tx_mcast_pkts;
1334         __le64  mac_tx_bcast_pkts;
1335         __le64  mac_tx_pause_cnt;
1336         __le64  mac_tx_ctrl_pkt;
1337         __le64  mac_tx_lt_64b_pkts;
1338         __le64  mac_tx_lt_127b_pkts;
1339         __le64  mac_tx_lt_255b_pkts;
1340         __le64  mac_tx_lt_511b_pkts;
1341         __le64  mac_tx_lt_1023b_pkts;
1342         __le64  mac_tx_lt_1518b_pkts;
1343         __le64  mac_tx_gt_1518b_pkts;
1344         __le64  rsvd1[3];
1345
1346         __le64  mac_rx_frames;
1347         __le64  mac_rx_bytes;
1348         __le64  mac_rx_mcast_pkts;
1349         __le64  mac_rx_bcast_pkts;
1350         __le64  mac_rx_pause_cnt;
1351         __le64  mac_rx_ctrl_pkt;
1352         __le64  mac_rx_lt_64b_pkts;
1353         __le64  mac_rx_lt_127b_pkts;
1354         __le64  mac_rx_lt_255b_pkts;
1355         __le64  mac_rx_lt_511b_pkts;
1356         __le64  mac_rx_lt_1023b_pkts;
1357         __le64  mac_rx_lt_1518b_pkts;
1358         __le64  mac_rx_gt_1518b_pkts;
1359         __le64  rsvd2[3];
1360
1361         __le64  mac_rx_length_error;
1362         __le64  mac_rx_length_small;
1363         __le64  mac_rx_length_large;
1364         __le64  mac_rx_jabber;
1365         __le64  mac_rx_dropped;
1366         __le64  mac_rx_crc_error;
1367         __le64  mac_align_error;
1368 } __packed;
1369
1370 struct qlcnic_mac_statistics {
1371         u64     mac_tx_frames;
1372         u64     mac_tx_bytes;
1373         u64     mac_tx_mcast_pkts;
1374         u64     mac_tx_bcast_pkts;
1375         u64     mac_tx_pause_cnt;
1376         u64     mac_tx_ctrl_pkt;
1377         u64     mac_tx_lt_64b_pkts;
1378         u64     mac_tx_lt_127b_pkts;
1379         u64     mac_tx_lt_255b_pkts;
1380         u64     mac_tx_lt_511b_pkts;
1381         u64     mac_tx_lt_1023b_pkts;
1382         u64     mac_tx_lt_1518b_pkts;
1383         u64     mac_tx_gt_1518b_pkts;
1384         u64     rsvd1[3];
1385         u64     mac_rx_frames;
1386         u64     mac_rx_bytes;
1387         u64     mac_rx_mcast_pkts;
1388         u64     mac_rx_bcast_pkts;
1389         u64     mac_rx_pause_cnt;
1390         u64     mac_rx_ctrl_pkt;
1391         u64     mac_rx_lt_64b_pkts;
1392         u64     mac_rx_lt_127b_pkts;
1393         u64     mac_rx_lt_255b_pkts;
1394         u64     mac_rx_lt_511b_pkts;
1395         u64     mac_rx_lt_1023b_pkts;
1396         u64     mac_rx_lt_1518b_pkts;
1397         u64     mac_rx_gt_1518b_pkts;
1398         u64     rsvd2[3];
1399         u64     mac_rx_length_error;
1400         u64     mac_rx_length_small;
1401         u64     mac_rx_length_large;
1402         u64     mac_rx_jabber;
1403         u64     mac_rx_dropped;
1404         u64     mac_rx_crc_error;
1405         u64     mac_align_error;
1406 };
1407
1408 struct qlcnic_esw_stats_le {
1409         __le16 context_id;
1410         __le16 version;
1411         __le16 size;
1412         __le16 unused;
1413         __le64 unicast_frames;
1414         __le64 multicast_frames;
1415         __le64 broadcast_frames;
1416         __le64 dropped_frames;
1417         __le64 errors;
1418         __le64 local_frames;
1419         __le64 numbytes;
1420         __le64 rsvd[3];
1421 } __packed;
1422
1423 struct __qlcnic_esw_statistics {
1424         u16     context_id;
1425         u16     version;
1426         u16     size;
1427         u16     unused;
1428         u64     unicast_frames;
1429         u64     multicast_frames;
1430         u64     broadcast_frames;
1431         u64     dropped_frames;
1432         u64     errors;
1433         u64     local_frames;
1434         u64     numbytes;
1435         u64     rsvd[3];
1436 };
1437
1438 struct qlcnic_esw_statistics {
1439         struct __qlcnic_esw_statistics rx;
1440         struct __qlcnic_esw_statistics tx;
1441 };
1442
1443 #define QLCNIC_FORCE_FW_DUMP_KEY        0xdeadfeed
1444 #define QLCNIC_ENABLE_FW_DUMP           0xaddfeed
1445 #define QLCNIC_DISABLE_FW_DUMP          0xbadfeed
1446 #define QLCNIC_FORCE_FW_RESET           0xdeaddead
1447 #define QLCNIC_SET_QUIESCENT            0xadd00010
1448 #define QLCNIC_RESET_QUIESCENT          0xadd00020
1449
1450 struct _cdrp_cmd {
1451         u32 num;
1452         u32 *arg;
1453 };
1454
1455 struct qlcnic_cmd_args {
1456         struct completion       completion;
1457         struct list_head        list;
1458         struct _cdrp_cmd        req;
1459         struct _cdrp_cmd        rsp;
1460         atomic_t                rsp_status;
1461         int                     pay_size;
1462         u32                     rsp_opcode;
1463         u32                     total_cmds;
1464         u32                     op_type;
1465         u32                     type;
1466         u32                     cmd_op;
1467         u32                     *hdr;   /* Back channel message header */
1468         u32                     *pay;   /* Back channel message payload */
1469         u8                      func_num;
1470 };
1471
1472 int qlcnic_fw_cmd_get_minidump_temp(struct qlcnic_adapter *adapter);
1473 int qlcnic_fw_cmd_set_port(struct qlcnic_adapter *adapter, u32 config);
1474 int qlcnic_pci_mem_write_2M(struct qlcnic_adapter *, u64 off, u64 data);
1475 int qlcnic_pci_mem_read_2M(struct qlcnic_adapter *, u64 off, u64 *data);
1476 void qlcnic_pci_camqm_read_2M(struct qlcnic_adapter *, u64, u64 *);
1477 void qlcnic_pci_camqm_write_2M(struct qlcnic_adapter *, u64, u64);
1478
1479 #define ADDR_IN_RANGE(addr, low, high)  \
1480         (((addr) < (high)) && ((addr) >= (low)))
1481
1482 #define QLCRD32(adapter, off, err) \
1483         (adapter->ahw->hw_ops->read_reg)(adapter, off, err)
1484
1485 #define QLCWR32(adapter, off, val) \
1486         adapter->ahw->hw_ops->write_reg(adapter, off, val)
1487
1488 int qlcnic_pcie_sem_lock(struct qlcnic_adapter *, int, u32);
1489 void qlcnic_pcie_sem_unlock(struct qlcnic_adapter *, int);
1490
1491 #define qlcnic_rom_lock(a)      \
1492         qlcnic_pcie_sem_lock((a), 2, QLCNIC_ROM_LOCK_ID)
1493 #define qlcnic_rom_unlock(a)    \
1494         qlcnic_pcie_sem_unlock((a), 2)
1495 #define qlcnic_phy_lock(a)      \
1496         qlcnic_pcie_sem_lock((a), 3, QLCNIC_PHY_LOCK_ID)
1497 #define qlcnic_phy_unlock(a)    \
1498         qlcnic_pcie_sem_unlock((a), 3)
1499 #define qlcnic_sw_lock(a)       \
1500         qlcnic_pcie_sem_lock((a), 6, 0)
1501 #define qlcnic_sw_unlock(a)     \
1502         qlcnic_pcie_sem_unlock((a), 6)
1503 #define crb_win_lock(a) \
1504         qlcnic_pcie_sem_lock((a), 7, QLCNIC_CRB_WIN_LOCK_ID)
1505 #define crb_win_unlock(a)       \
1506         qlcnic_pcie_sem_unlock((a), 7)
1507
1508 #define __QLCNIC_MAX_LED_RATE   0xf
1509 #define __QLCNIC_MAX_LED_STATE  0x2
1510
1511 #define MAX_CTL_CHECK 1000
1512
1513 int qlcnic_wol_supported(struct qlcnic_adapter *adapter);
1514 void qlcnic_prune_lb_filters(struct qlcnic_adapter *adapter);
1515 void qlcnic_delete_lb_filters(struct qlcnic_adapter *adapter);
1516 int qlcnic_dump_fw(struct qlcnic_adapter *);
1517 int qlcnic_enable_fw_dump_state(struct qlcnic_adapter *);
1518 bool qlcnic_check_fw_dump_state(struct qlcnic_adapter *);
1519 pci_ers_result_t qlcnic_82xx_io_error_detected(struct pci_dev *,
1520                                                pci_channel_state_t);
1521 pci_ers_result_t qlcnic_82xx_io_slot_reset(struct pci_dev *);
1522 void qlcnic_82xx_io_resume(struct pci_dev *);
1523
1524 /* Functions from qlcnic_init.c */
1525 void qlcnic_schedule_work(struct qlcnic_adapter *, work_func_t, int);
1526 int qlcnic_load_firmware(struct qlcnic_adapter *adapter);
1527 int qlcnic_need_fw_reset(struct qlcnic_adapter *adapter);
1528 void qlcnic_request_firmware(struct qlcnic_adapter *adapter);
1529 void qlcnic_release_firmware(struct qlcnic_adapter *adapter);
1530 int qlcnic_pinit_from_rom(struct qlcnic_adapter *adapter);
1531 int qlcnic_setup_idc_param(struct qlcnic_adapter *adapter);
1532 int qlcnic_check_flash_fw_ver(struct qlcnic_adapter *adapter);
1533
1534 int qlcnic_rom_fast_read(struct qlcnic_adapter *adapter, u32 addr, u32 *valp);
1535 int qlcnic_rom_fast_read_words(struct qlcnic_adapter *adapter, int addr,
1536                                 u8 *bytes, size_t size);
1537 int qlcnic_alloc_sw_resources(struct qlcnic_adapter *adapter);
1538 void qlcnic_free_sw_resources(struct qlcnic_adapter *adapter);
1539
1540 void __iomem *qlcnic_get_ioaddr(struct qlcnic_hardware_context *, u32);
1541
1542 int qlcnic_alloc_hw_resources(struct qlcnic_adapter *adapter);
1543 void qlcnic_free_hw_resources(struct qlcnic_adapter *adapter);
1544
1545 int qlcnic_fw_create_ctx(struct qlcnic_adapter *adapter);
1546 void qlcnic_fw_destroy_ctx(struct qlcnic_adapter *adapter);
1547
1548 void qlcnic_reset_rx_buffers_list(struct qlcnic_adapter *adapter);
1549 void qlcnic_release_rx_buffers(struct qlcnic_adapter *adapter);
1550 void qlcnic_release_tx_buffers(struct qlcnic_adapter *,
1551                                struct qlcnic_host_tx_ring *);
1552
1553 int qlcnic_check_fw_status(struct qlcnic_adapter *adapter);
1554 void qlcnic_watchdog_task(struct work_struct *work);
1555 void qlcnic_post_rx_buffers(struct qlcnic_adapter *adapter,
1556                 struct qlcnic_host_rds_ring *rds_ring, u8 ring_id);
1557 int qlcnic_process_rcv_ring(struct qlcnic_host_sds_ring *sds_ring, int max);
1558 void qlcnic_set_multi(struct net_device *netdev);
1559 void __qlcnic_set_multi(struct net_device *, u16);
1560 int qlcnic_nic_add_mac(struct qlcnic_adapter *, const u8 *, u16);
1561 int qlcnic_nic_del_mac(struct qlcnic_adapter *, const u8 *);
1562 void qlcnic_82xx_free_mac_list(struct qlcnic_adapter *adapter);
1563 int qlcnic_82xx_read_phys_port_id(struct qlcnic_adapter *);
1564
1565 int qlcnic_fw_cmd_set_mtu(struct qlcnic_adapter *adapter, int mtu);
1566 int qlcnic_fw_cmd_set_drv_version(struct qlcnic_adapter *, u32);
1567 int qlcnic_change_mtu(struct net_device *netdev, int new_mtu);
1568 netdev_features_t qlcnic_fix_features(struct net_device *netdev,
1569         netdev_features_t features);
1570 int qlcnic_set_features(struct net_device *netdev, netdev_features_t features);
1571 int qlcnic_config_bridged_mode(struct qlcnic_adapter *adapter, u32 enable);
1572 int qlcnic_send_lro_cleanup(struct qlcnic_adapter *adapter);
1573 void qlcnic_update_cmd_producer(struct qlcnic_host_tx_ring *);
1574
1575 /* Functions from qlcnic_ethtool.c */
1576 int qlcnic_check_loopback_buff(unsigned char *, u8 []);
1577 int qlcnic_do_lb_test(struct qlcnic_adapter *, u8);
1578 int qlcnic_loopback_test(struct net_device *, u8);
1579
1580 /* Functions from qlcnic_main.c */
1581 int qlcnic_reset_context(struct qlcnic_adapter *);
1582 void qlcnic_diag_free_res(struct net_device *netdev, int);
1583 int qlcnic_diag_alloc_res(struct net_device *netdev, int);
1584 netdev_tx_t qlcnic_xmit_frame(struct sk_buff *, struct net_device *);
1585 void qlcnic_set_tx_ring_count(struct qlcnic_adapter *, u8);
1586 void qlcnic_set_sds_ring_count(struct qlcnic_adapter *, u8);
1587 int qlcnic_setup_rings(struct qlcnic_adapter *, u8, u8);
1588 int qlcnic_validate_rings(struct qlcnic_adapter *, __u32, int);
1589 void qlcnic_alloc_lb_filters_mem(struct qlcnic_adapter *adapter);
1590 void qlcnic_82xx_set_mac_filter_count(struct qlcnic_adapter *);
1591 int qlcnic_enable_msix(struct qlcnic_adapter *, u32);
1592 void qlcnic_set_drv_version(struct qlcnic_adapter *);
1593
1594 /*  eSwitch management functions */
1595 int qlcnic_config_switch_port(struct qlcnic_adapter *,
1596                                 struct qlcnic_esw_func_cfg *);
1597
1598 int qlcnic_get_eswitch_port_config(struct qlcnic_adapter *,
1599                                 struct qlcnic_esw_func_cfg *);
1600 int qlcnic_config_port_mirroring(struct qlcnic_adapter *, u8, u8, u8);
1601 int qlcnic_get_port_stats(struct qlcnic_adapter *, const u8, const u8,
1602                                         struct __qlcnic_esw_statistics *);
1603 int qlcnic_get_eswitch_stats(struct qlcnic_adapter *, const u8, u8,
1604                                         struct __qlcnic_esw_statistics *);
1605 int qlcnic_clear_esw_stats(struct qlcnic_adapter *adapter, u8, u8, u8);
1606 int qlcnic_get_mac_stats(struct qlcnic_adapter *, struct qlcnic_mac_statistics *);
1607
1608 void qlcnic_free_mbx_args(struct qlcnic_cmd_args *cmd);
1609
1610 int qlcnic_alloc_sds_rings(struct qlcnic_recv_context *, int);
1611 void qlcnic_free_sds_rings(struct qlcnic_recv_context *);
1612 void qlcnic_advert_link_change(struct qlcnic_adapter *, int);
1613 void qlcnic_free_tx_rings(struct qlcnic_adapter *);
1614 int qlcnic_alloc_tx_rings(struct qlcnic_adapter *, struct net_device *);
1615 void qlcnic_dump_mbx(struct qlcnic_adapter *, struct qlcnic_cmd_args *);
1616
1617 void qlcnic_create_sysfs_entries(struct qlcnic_adapter *adapter);
1618 void qlcnic_remove_sysfs_entries(struct qlcnic_adapter *adapter);
1619 void qlcnic_create_diag_entries(struct qlcnic_adapter *adapter);
1620 void qlcnic_remove_diag_entries(struct qlcnic_adapter *adapter);
1621 void qlcnic_82xx_add_sysfs(struct qlcnic_adapter *adapter);
1622 void qlcnic_82xx_remove_sysfs(struct qlcnic_adapter *adapter);
1623 int qlcnic_82xx_get_settings(struct qlcnic_adapter *, struct ethtool_cmd *);
1624
1625 int qlcnicvf_config_bridged_mode(struct qlcnic_adapter *, u32);
1626 int qlcnicvf_config_led(struct qlcnic_adapter *, u32, u32);
1627 void qlcnic_set_vlan_config(struct qlcnic_adapter *,
1628                             struct qlcnic_esw_func_cfg *);
1629 void qlcnic_set_eswitch_port_features(struct qlcnic_adapter *,
1630                                       struct qlcnic_esw_func_cfg *);
1631
1632 void qlcnic_down(struct qlcnic_adapter *, struct net_device *);
1633 int qlcnic_up(struct qlcnic_adapter *, struct net_device *);
1634 void __qlcnic_down(struct qlcnic_adapter *, struct net_device *);
1635 void qlcnic_detach(struct qlcnic_adapter *);
1636 void qlcnic_teardown_intr(struct qlcnic_adapter *);
1637 int qlcnic_attach(struct qlcnic_adapter *);
1638 int __qlcnic_up(struct qlcnic_adapter *, struct net_device *);
1639 void qlcnic_restore_indev_addr(struct net_device *, unsigned long);
1640
1641 int qlcnic_check_temp(struct qlcnic_adapter *);
1642 int qlcnic_init_pci_info(struct qlcnic_adapter *);
1643 int qlcnic_set_default_offload_settings(struct qlcnic_adapter *);
1644 int qlcnic_reset_npar_config(struct qlcnic_adapter *);
1645 int qlcnic_set_eswitch_port_config(struct qlcnic_adapter *);
1646 void qlcnic_add_lb_filter(struct qlcnic_adapter *, struct sk_buff *, int, u16);
1647 int qlcnic_83xx_configure_opmode(struct qlcnic_adapter *adapter);
1648 int qlcnic_read_mac_addr(struct qlcnic_adapter *);
1649 int qlcnic_setup_netdev(struct qlcnic_adapter *, struct net_device *, int);
1650 void qlcnic_set_netdev_features(struct qlcnic_adapter *,
1651                                 struct qlcnic_esw_func_cfg *);
1652 void qlcnic_sriov_vf_schedule_multi(struct net_device *);
1653 int qlcnic_is_valid_nic_func(struct qlcnic_adapter *, u8);
1654 int qlcnic_get_pci_func_type(struct qlcnic_adapter *, u16, u16 *, u16 *,
1655                              u16 *);
1656
1657 /*
1658  * QLOGIC Board information
1659  */
1660
1661 #define QLCNIC_MAX_BOARD_NAME_LEN 100
1662 struct qlcnic_board_info {
1663         unsigned short  vendor;
1664         unsigned short  device;
1665         unsigned short  sub_vendor;
1666         unsigned short  sub_device;
1667         char short_name[QLCNIC_MAX_BOARD_NAME_LEN];
1668 };
1669
1670 static inline u32 qlcnic_tx_avail(struct qlcnic_host_tx_ring *tx_ring)
1671 {
1672         if (likely(tx_ring->producer < tx_ring->sw_consumer))
1673                 return tx_ring->sw_consumer - tx_ring->producer;
1674         else
1675                 return tx_ring->sw_consumer + tx_ring->num_desc -
1676                                 tx_ring->producer;
1677 }
1678
1679 static inline int qlcnic_set_real_num_queues(struct qlcnic_adapter *adapter,
1680                                              struct net_device *netdev)
1681 {
1682         int err;
1683
1684         netdev->num_tx_queues = adapter->drv_tx_rings;
1685         netdev->real_num_tx_queues = adapter->drv_tx_rings;
1686
1687         err = netif_set_real_num_tx_queues(netdev, adapter->drv_tx_rings);
1688         if (err)
1689                 dev_err(&adapter->pdev->dev, "failed to set %d Tx queues\n",
1690                         adapter->drv_tx_rings);
1691         else
1692                 dev_info(&adapter->pdev->dev, "Set %d Tx queues\n",
1693                          adapter->drv_tx_rings);
1694
1695         return err;
1696 }
1697
1698 struct qlcnic_nic_template {
1699         int (*config_bridged_mode) (struct qlcnic_adapter *, u32);
1700         int (*config_led) (struct qlcnic_adapter *, u32, u32);
1701         int (*start_firmware) (struct qlcnic_adapter *);
1702         int (*init_driver) (struct qlcnic_adapter *);
1703         void (*request_reset) (struct qlcnic_adapter *, u32);
1704         void (*cancel_idc_work) (struct qlcnic_adapter *);
1705         int (*napi_add)(struct qlcnic_adapter *, struct net_device *);
1706         void (*napi_del)(struct qlcnic_adapter *);
1707         void (*config_ipaddr)(struct qlcnic_adapter *, __be32, int);
1708         irqreturn_t (*clear_legacy_intr)(struct qlcnic_adapter *);
1709         int (*shutdown)(struct pci_dev *);
1710         int (*resume)(struct qlcnic_adapter *);
1711 };
1712
1713 struct qlcnic_mbx_ops {
1714         int (*enqueue_cmd) (struct qlcnic_adapter *,
1715                             struct qlcnic_cmd_args *, unsigned long *);
1716         void (*dequeue_cmd) (struct qlcnic_adapter *, struct qlcnic_cmd_args *);
1717         void (*decode_resp) (struct qlcnic_adapter *, struct qlcnic_cmd_args *);
1718         void (*encode_cmd) (struct qlcnic_adapter *, struct qlcnic_cmd_args *);
1719         void (*nofity_fw) (struct qlcnic_adapter *, u8);
1720 };
1721
1722 int qlcnic_83xx_init_mailbox_work(struct qlcnic_adapter *);
1723 void qlcnic_83xx_detach_mailbox_work(struct qlcnic_adapter *);
1724 void qlcnic_83xx_reinit_mbx_work(struct qlcnic_mailbox *mbx);
1725 void qlcnic_83xx_free_mailbox(struct qlcnic_mailbox *mbx);
1726 void qlcnic_update_stats(struct qlcnic_adapter *);
1727
1728 /* Adapter hardware abstraction */
1729 struct qlcnic_hardware_ops {
1730         void (*read_crb) (struct qlcnic_adapter *, char *, loff_t, size_t);
1731         void (*write_crb) (struct qlcnic_adapter *, char *, loff_t, size_t);
1732         int (*read_reg) (struct qlcnic_adapter *, ulong, int *);
1733         int (*write_reg) (struct qlcnic_adapter *, ulong, u32);
1734         void (*get_ocm_win) (struct qlcnic_hardware_context *);
1735         int (*get_mac_address) (struct qlcnic_adapter *, u8 *, u8);
1736         int (*setup_intr) (struct qlcnic_adapter *);
1737         int (*alloc_mbx_args)(struct qlcnic_cmd_args *,
1738                               struct qlcnic_adapter *, u32);
1739         int (*mbx_cmd) (struct qlcnic_adapter *, struct qlcnic_cmd_args *);
1740         void (*get_func_no) (struct qlcnic_adapter *);
1741         int (*api_lock) (struct qlcnic_adapter *);
1742         void (*api_unlock) (struct qlcnic_adapter *);
1743         void (*add_sysfs) (struct qlcnic_adapter *);
1744         void (*remove_sysfs) (struct qlcnic_adapter *);
1745         void (*process_lb_rcv_ring_diag) (struct qlcnic_host_sds_ring *);
1746         int (*create_rx_ctx) (struct qlcnic_adapter *);
1747         int (*create_tx_ctx) (struct qlcnic_adapter *,
1748         struct qlcnic_host_tx_ring *, int);
1749         void (*del_rx_ctx) (struct qlcnic_adapter *);
1750         void (*del_tx_ctx) (struct qlcnic_adapter *,
1751                             struct qlcnic_host_tx_ring *);
1752         int (*setup_link_event) (struct qlcnic_adapter *, int);
1753         int (*get_nic_info) (struct qlcnic_adapter *, struct qlcnic_info *, u8);
1754         int (*get_pci_info) (struct qlcnic_adapter *, struct qlcnic_pci_info *);
1755         int (*set_nic_info) (struct qlcnic_adapter *, struct qlcnic_info *);
1756         int (*change_macvlan) (struct qlcnic_adapter *, u8*, u16, u8);
1757         void (*napi_enable) (struct qlcnic_adapter *);
1758         void (*napi_disable) (struct qlcnic_adapter *);
1759         void (*config_intr_coal) (struct qlcnic_adapter *);
1760         int (*config_rss) (struct qlcnic_adapter *, int);
1761         int (*config_hw_lro) (struct qlcnic_adapter *, int);
1762         int (*config_loopback) (struct qlcnic_adapter *, u8);
1763         int (*clear_loopback) (struct qlcnic_adapter *, u8);
1764         int (*config_promisc_mode) (struct qlcnic_adapter *, u32);
1765         void (*change_l2_filter) (struct qlcnic_adapter *, u64 *, u16);
1766         int (*get_board_info) (struct qlcnic_adapter *);
1767         void (*set_mac_filter_count) (struct qlcnic_adapter *);
1768         void (*free_mac_list) (struct qlcnic_adapter *);
1769         int (*read_phys_port_id) (struct qlcnic_adapter *);
1770         pci_ers_result_t (*io_error_detected) (struct pci_dev *,
1771                                                pci_channel_state_t);
1772         pci_ers_result_t (*io_slot_reset) (struct pci_dev *);
1773         void (*io_resume) (struct pci_dev *);
1774         void (*get_beacon_state)(struct qlcnic_adapter *);
1775 };
1776
1777 extern struct qlcnic_nic_template qlcnic_vf_ops;
1778
1779 static inline int qlcnic_start_firmware(struct qlcnic_adapter *adapter)
1780 {
1781         return adapter->nic_ops->start_firmware(adapter);
1782 }
1783
1784 static inline void qlcnic_read_crb(struct qlcnic_adapter *adapter, char *buf,
1785                                    loff_t offset, size_t size)
1786 {
1787         adapter->ahw->hw_ops->read_crb(adapter, buf, offset, size);
1788 }
1789
1790 static inline void qlcnic_write_crb(struct qlcnic_adapter *adapter, char *buf,
1791                                     loff_t offset, size_t size)
1792 {
1793         adapter->ahw->hw_ops->write_crb(adapter, buf, offset, size);
1794 }
1795
1796 static inline int qlcnic_hw_write_wx_2M(struct qlcnic_adapter *adapter,
1797                                         ulong off, u32 data)
1798 {
1799         return adapter->ahw->hw_ops->write_reg(adapter, off, data);
1800 }
1801
1802 static inline int qlcnic_get_mac_address(struct qlcnic_adapter *adapter,
1803                                          u8 *mac, u8 function)
1804 {
1805         return adapter->ahw->hw_ops->get_mac_address(adapter, mac, function);
1806 }
1807
1808 static inline int qlcnic_setup_intr(struct qlcnic_adapter *adapter)
1809 {
1810         return adapter->ahw->hw_ops->setup_intr(adapter);
1811 }
1812
1813 static inline int qlcnic_alloc_mbx_args(struct qlcnic_cmd_args *mbx,
1814                                         struct qlcnic_adapter *adapter, u32 arg)
1815 {
1816         return adapter->ahw->hw_ops->alloc_mbx_args(mbx, adapter, arg);
1817 }
1818
1819 static inline int qlcnic_issue_cmd(struct qlcnic_adapter *adapter,
1820                                    struct qlcnic_cmd_args *cmd)
1821 {
1822         if (adapter->ahw->hw_ops->mbx_cmd)
1823                 return adapter->ahw->hw_ops->mbx_cmd(adapter, cmd);
1824
1825         return -EIO;
1826 }
1827
1828 static inline void qlcnic_get_func_no(struct qlcnic_adapter *adapter)
1829 {
1830         adapter->ahw->hw_ops->get_func_no(adapter);
1831 }
1832
1833 static inline int qlcnic_api_lock(struct qlcnic_adapter *adapter)
1834 {
1835         return adapter->ahw->hw_ops->api_lock(adapter);
1836 }
1837
1838 static inline void qlcnic_api_unlock(struct qlcnic_adapter *adapter)
1839 {
1840         adapter->ahw->hw_ops->api_unlock(adapter);
1841 }
1842
1843 static inline void qlcnic_add_sysfs(struct qlcnic_adapter *adapter)
1844 {
1845         if (adapter->ahw->hw_ops->add_sysfs)
1846                 adapter->ahw->hw_ops->add_sysfs(adapter);
1847 }
1848
1849 static inline void qlcnic_remove_sysfs(struct qlcnic_adapter *adapter)
1850 {
1851         if (adapter->ahw->hw_ops->remove_sysfs)
1852                 adapter->ahw->hw_ops->remove_sysfs(adapter);
1853 }
1854
1855 static inline void
1856 qlcnic_process_rcv_ring_diag(struct qlcnic_host_sds_ring *sds_ring)
1857 {
1858         sds_ring->adapter->ahw->hw_ops->process_lb_rcv_ring_diag(sds_ring);
1859 }
1860
1861 static inline int qlcnic_fw_cmd_create_rx_ctx(struct qlcnic_adapter *adapter)
1862 {
1863         return adapter->ahw->hw_ops->create_rx_ctx(adapter);
1864 }
1865
1866 static inline int qlcnic_fw_cmd_create_tx_ctx(struct qlcnic_adapter *adapter,
1867                                               struct qlcnic_host_tx_ring *ptr,
1868                                               int ring)
1869 {
1870         return adapter->ahw->hw_ops->create_tx_ctx(adapter, ptr, ring);
1871 }
1872
1873 static inline void qlcnic_fw_cmd_del_rx_ctx(struct qlcnic_adapter *adapter)
1874 {
1875         return adapter->ahw->hw_ops->del_rx_ctx(adapter);
1876 }
1877
1878 static inline void qlcnic_fw_cmd_del_tx_ctx(struct qlcnic_adapter *adapter,
1879                                             struct qlcnic_host_tx_ring *ptr)
1880 {
1881         return adapter->ahw->hw_ops->del_tx_ctx(adapter, ptr);
1882 }
1883
1884 static inline int qlcnic_linkevent_request(struct qlcnic_adapter *adapter,
1885                                            int enable)
1886 {
1887         return adapter->ahw->hw_ops->setup_link_event(adapter, enable);
1888 }
1889
1890 static inline int qlcnic_get_nic_info(struct qlcnic_adapter *adapter,
1891                                       struct qlcnic_info *info, u8 id)
1892 {
1893         return adapter->ahw->hw_ops->get_nic_info(adapter, info, id);
1894 }
1895
1896 static inline int qlcnic_get_pci_info(struct qlcnic_adapter *adapter,
1897                                       struct qlcnic_pci_info *info)
1898 {
1899         return adapter->ahw->hw_ops->get_pci_info(adapter, info);
1900 }
1901
1902 static inline int qlcnic_set_nic_info(struct qlcnic_adapter *adapter,
1903                                       struct qlcnic_info *info)
1904 {
1905         return adapter->ahw->hw_ops->set_nic_info(adapter, info);
1906 }
1907
1908 static inline int qlcnic_sre_macaddr_change(struct qlcnic_adapter *adapter,
1909                                             u8 *addr, u16 id, u8 cmd)
1910 {
1911         return adapter->ahw->hw_ops->change_macvlan(adapter, addr, id, cmd);
1912 }
1913
1914 static inline int qlcnic_napi_add(struct qlcnic_adapter *adapter,
1915                                   struct net_device *netdev)
1916 {
1917         return adapter->nic_ops->napi_add(adapter, netdev);
1918 }
1919
1920 static inline void qlcnic_napi_del(struct qlcnic_adapter *adapter)
1921 {
1922         adapter->nic_ops->napi_del(adapter);
1923 }
1924
1925 static inline void qlcnic_napi_enable(struct qlcnic_adapter *adapter)
1926 {
1927         adapter->ahw->hw_ops->napi_enable(adapter);
1928 }
1929
1930 static inline int __qlcnic_shutdown(struct pci_dev *pdev)
1931 {
1932         struct qlcnic_adapter *adapter = pci_get_drvdata(pdev);
1933
1934         return adapter->nic_ops->shutdown(pdev);
1935 }
1936
1937 static inline int __qlcnic_resume(struct qlcnic_adapter *adapter)
1938 {
1939         return adapter->nic_ops->resume(adapter);
1940 }
1941
1942 static inline void qlcnic_napi_disable(struct qlcnic_adapter *adapter)
1943 {
1944         adapter->ahw->hw_ops->napi_disable(adapter);
1945 }
1946
1947 static inline void qlcnic_config_intr_coalesce(struct qlcnic_adapter *adapter)
1948 {
1949         adapter->ahw->hw_ops->config_intr_coal(adapter);
1950 }
1951
1952 static inline int qlcnic_config_rss(struct qlcnic_adapter *adapter, int enable)
1953 {
1954         return adapter->ahw->hw_ops->config_rss(adapter, enable);
1955 }
1956
1957 static inline int qlcnic_config_hw_lro(struct qlcnic_adapter *adapter,
1958                                        int enable)
1959 {
1960         return adapter->ahw->hw_ops->config_hw_lro(adapter, enable);
1961 }
1962
1963 static inline int qlcnic_set_lb_mode(struct qlcnic_adapter *adapter, u8 mode)
1964 {
1965         return adapter->ahw->hw_ops->config_loopback(adapter, mode);
1966 }
1967
1968 static inline int qlcnic_clear_lb_mode(struct qlcnic_adapter *adapter, u8 mode)
1969 {
1970         return adapter->ahw->hw_ops->clear_loopback(adapter, mode);
1971 }
1972
1973 static inline int qlcnic_nic_set_promisc(struct qlcnic_adapter *adapter,
1974                                          u32 mode)
1975 {
1976         return adapter->ahw->hw_ops->config_promisc_mode(adapter, mode);
1977 }
1978
1979 static inline void qlcnic_change_filter(struct qlcnic_adapter *adapter,
1980                                         u64 *addr, u16 id)
1981 {
1982         adapter->ahw->hw_ops->change_l2_filter(adapter, addr, id);
1983 }
1984
1985 static inline int qlcnic_get_board_info(struct qlcnic_adapter *adapter)
1986 {
1987         return adapter->ahw->hw_ops->get_board_info(adapter);
1988 }
1989
1990 static inline void qlcnic_free_mac_list(struct qlcnic_adapter *adapter)
1991 {
1992         return adapter->ahw->hw_ops->free_mac_list(adapter);
1993 }
1994
1995 static inline void qlcnic_set_mac_filter_count(struct qlcnic_adapter *adapter)
1996 {
1997         if (adapter->ahw->hw_ops->set_mac_filter_count)
1998                 adapter->ahw->hw_ops->set_mac_filter_count(adapter);
1999 }
2000
2001 static inline void qlcnic_get_beacon_state(struct qlcnic_adapter *adapter)
2002 {
2003         adapter->ahw->hw_ops->get_beacon_state(adapter);
2004 }
2005
2006 static inline void qlcnic_read_phys_port_id(struct qlcnic_adapter *adapter)
2007 {
2008         if (adapter->ahw->hw_ops->read_phys_port_id)
2009                 adapter->ahw->hw_ops->read_phys_port_id(adapter);
2010 }
2011
2012 static inline void qlcnic_dev_request_reset(struct qlcnic_adapter *adapter,
2013                                             u32 key)
2014 {
2015         if (adapter->nic_ops->request_reset)
2016                 adapter->nic_ops->request_reset(adapter, key);
2017 }
2018
2019 static inline void qlcnic_cancel_idc_work(struct qlcnic_adapter *adapter)
2020 {
2021         if (adapter->nic_ops->cancel_idc_work)
2022                 adapter->nic_ops->cancel_idc_work(adapter);
2023 }
2024
2025 static inline irqreturn_t
2026 qlcnic_clear_legacy_intr(struct qlcnic_adapter *adapter)
2027 {
2028         return adapter->nic_ops->clear_legacy_intr(adapter);
2029 }
2030
2031 static inline int qlcnic_config_led(struct qlcnic_adapter *adapter, u32 state,
2032                                     u32 rate)
2033 {
2034         return adapter->nic_ops->config_led(adapter, state, rate);
2035 }
2036
2037 static inline void qlcnic_config_ipaddr(struct qlcnic_adapter *adapter,
2038                                         __be32 ip, int cmd)
2039 {
2040         adapter->nic_ops->config_ipaddr(adapter, ip, cmd);
2041 }
2042
2043 static inline bool qlcnic_check_multi_tx(struct qlcnic_adapter *adapter)
2044 {
2045         return test_bit(__QLCNIC_MULTI_TX_UNIQUE, &adapter->state);
2046 }
2047
2048 static inline void qlcnic_disable_multi_tx(struct qlcnic_adapter *adapter)
2049 {
2050         test_and_clear_bit(__QLCNIC_MULTI_TX_UNIQUE, &adapter->state);
2051         adapter->drv_tx_rings = QLCNIC_SINGLE_RING;
2052 }
2053
2054 /* When operating in a muti tx mode, driver needs to write 0x1
2055  * to src register, instead of 0x0 to disable receiving interrupt.
2056  */
2057 static inline void qlcnic_disable_int(struct qlcnic_host_sds_ring *sds_ring)
2058 {
2059         struct qlcnic_adapter *adapter = sds_ring->adapter;
2060
2061         if (qlcnic_check_multi_tx(adapter) &&
2062             !adapter->ahw->diag_test &&
2063             (adapter->flags & QLCNIC_MSIX_ENABLED))
2064                 writel(0x1, sds_ring->crb_intr_mask);
2065         else
2066                 writel(0, sds_ring->crb_intr_mask);
2067 }
2068
2069 /* When operating in a muti tx mode, driver needs to write 0x0
2070  * to src register, instead of 0x1 to enable receiving interrupts.
2071  */
2072 static inline void qlcnic_enable_int(struct qlcnic_host_sds_ring *sds_ring)
2073 {
2074         struct qlcnic_adapter *adapter = sds_ring->adapter;
2075
2076         if (qlcnic_check_multi_tx(adapter) &&
2077             !adapter->ahw->diag_test &&
2078             (adapter->flags & QLCNIC_MSIX_ENABLED))
2079                 writel(0, sds_ring->crb_intr_mask);
2080         else
2081                 writel(0x1, sds_ring->crb_intr_mask);
2082
2083         if (!QLCNIC_IS_MSI_FAMILY(adapter))
2084                 writel(0xfbff, adapter->tgt_mask_reg);
2085 }
2086
2087 static inline int qlcnic_get_diag_lock(struct qlcnic_adapter *adapter)
2088 {
2089         return test_and_set_bit(__QLCNIC_DIAG_MODE, &adapter->state);
2090 }
2091
2092 static inline void qlcnic_release_diag_lock(struct qlcnic_adapter *adapter)
2093 {
2094         clear_bit(__QLCNIC_DIAG_MODE, &adapter->state);
2095 }
2096
2097 static inline int qlcnic_check_diag_status(struct qlcnic_adapter *adapter)
2098 {
2099         return test_bit(__QLCNIC_DIAG_MODE, &adapter->state);
2100 }
2101
2102 extern const struct ethtool_ops qlcnic_sriov_vf_ethtool_ops;
2103 extern const struct ethtool_ops qlcnic_ethtool_ops;
2104 extern const struct ethtool_ops qlcnic_ethtool_failed_ops;
2105
2106 #define QLCDB(adapter, lvl, _fmt, _args...) do {        \
2107         if (NETIF_MSG_##lvl & adapter->ahw->msg_enable) \
2108                 printk(KERN_INFO "%s: %s: " _fmt,       \
2109                          dev_name(&adapter->pdev->dev), \
2110                         __func__, ##_args);             \
2111         } while (0)
2112
2113 #define PCI_DEVICE_ID_QLOGIC_QLE824X            0x8020
2114 #define PCI_DEVICE_ID_QLOGIC_QLE834X            0x8030
2115 #define PCI_DEVICE_ID_QLOGIC_VF_QLE834X 0x8430
2116 #define PCI_DEVICE_ID_QLOGIC_QLE844X            0x8040
2117 #define PCI_DEVICE_ID_QLOGIC_VF_QLE844X 0x8440
2118
2119 static inline bool qlcnic_82xx_check(struct qlcnic_adapter *adapter)
2120 {
2121         unsigned short device = adapter->pdev->device;
2122         return (device == PCI_DEVICE_ID_QLOGIC_QLE824X) ? true : false;
2123 }
2124
2125 static inline bool qlcnic_84xx_check(struct qlcnic_adapter *adapter)
2126 {
2127         unsigned short device = adapter->pdev->device;
2128
2129         return ((device == PCI_DEVICE_ID_QLOGIC_QLE844X) ||
2130                 (device == PCI_DEVICE_ID_QLOGIC_VF_QLE844X)) ? true : false;
2131 }
2132
2133 static inline bool qlcnic_83xx_check(struct qlcnic_adapter *adapter)
2134 {
2135         unsigned short device = adapter->pdev->device;
2136         bool status;
2137
2138         status = ((device == PCI_DEVICE_ID_QLOGIC_QLE834X) ||
2139                   (device == PCI_DEVICE_ID_QLOGIC_QLE844X) ||
2140                   (device == PCI_DEVICE_ID_QLOGIC_VF_QLE844X) ||
2141                   (device == PCI_DEVICE_ID_QLOGIC_VF_QLE834X)) ? true : false;
2142
2143         return status;
2144 }
2145
2146 static inline bool qlcnic_sriov_pf_check(struct qlcnic_adapter *adapter)
2147 {
2148         return (adapter->ahw->op_mode == QLCNIC_SRIOV_PF_FUNC) ? true : false;
2149 }
2150
2151 static inline bool qlcnic_sriov_vf_check(struct qlcnic_adapter *adapter)
2152 {
2153         unsigned short device = adapter->pdev->device;
2154         bool status;
2155
2156         status = ((device == PCI_DEVICE_ID_QLOGIC_VF_QLE834X) ||
2157                   (device == PCI_DEVICE_ID_QLOGIC_VF_QLE844X)) ? true : false;
2158
2159         return status;
2160 }
2161
2162 static inline bool qlcnic_83xx_pf_check(struct qlcnic_adapter *adapter)
2163 {
2164         unsigned short device = adapter->pdev->device;
2165
2166         return (device == PCI_DEVICE_ID_QLOGIC_QLE834X) ? true : false;
2167 }
2168
2169 static inline bool qlcnic_83xx_vf_check(struct qlcnic_adapter *adapter)
2170 {
2171         unsigned short device = adapter->pdev->device;
2172
2173         return (device == PCI_DEVICE_ID_QLOGIC_VF_QLE834X) ? true : false;
2174 }
2175
2176 static inline u32 qlcnic_get_vnic_func_count(struct qlcnic_adapter *adapter)
2177 {
2178         if (qlcnic_84xx_check(adapter))
2179                 return QLC_84XX_VNIC_COUNT;
2180         else
2181                 return QLC_DEFAULT_VNIC_COUNT;
2182 }
2183 #endif                          /* __QLCNIC_H_ */