drivers/net/qlcnic/qlcnic.h

   1 /*
   2  * Copyright (C) 2009 - QLogic Corporation.
   3  * All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  18  * MA  02111-1307, USA.
  19  *
  20  * The full GNU General Public License is included in this distribution
  21  * in the file called "COPYING".
  22  *
  23  */
  24
  25 #ifndef _QLCNIC_H_
  26 #define _QLCNIC_H_
  27
  28 #include <linux/module.h>
  29 #include <linux/kernel.h>
  30 #include <linux/types.h>
  31 #include <linux/ioport.h>
  32 #include <linux/pci.h>
  33 #include <linux/netdevice.h>
  34 #include <linux/etherdevice.h>
  35 #include <linux/ip.h>
  36 #include <linux/in.h>
  37 #include <linux/tcp.h>
  38 #include <linux/skbuff.h>
  39 #include <linux/firmware.h>
  40
  41 #include <linux/ethtool.h>
  42 #include <linux/mii.h>
  43 #include <linux/timer.h>
  44
  45 #include <linux/vmalloc.h>
  46
  47 #include <linux/io.h>
  48 #include <asm/byteorder.h>
  49
  50 #include "qlcnic_hdr.h"
  51
  52 #define _QLCNIC_LINUX_MAJOR 5
  53 #define _QLCNIC_LINUX_MINOR 0
  54 #define _QLCNIC_LINUX_SUBVERSION 10
  55 #define QLCNIC_LINUX_VERSIONID  "5.0.10"
  56 #define QLCNIC_DRV_IDC_VER  0x01
  57 #define QLCNIC_DRIVER_VERSION  ((_QLCNIC_LINUX_MAJOR << 16) |\
  58                  (_QLCNIC_LINUX_MINOR << 8) | (_QLCNIC_LINUX_SUBVERSION))
  59
  60 #define QLCNIC_VERSION_CODE(a, b, c)    (((a) << 24) + ((b) << 16) + (c))
  61 #define _major(v)       (((v) >> 24) & 0xff)
  62 #define _minor(v)       (((v) >> 16) & 0xff)
  63 #define _build(v)       ((v) & 0xffff)
  64
  65 /* version in image has weird encoding:
  66  *  7:0  - major
  67  * 15:8  - minor
  68  * 31:16 - build (little endian)
  69  */
  70 #define QLCNIC_DECODE_VERSION(v) \
  71         QLCNIC_VERSION_CODE(((v) & 0xff), (((v) >> 8) & 0xff), ((v) >> 16))
  72
  73 #define QLCNIC_MIN_FW_VERSION     QLCNIC_VERSION_CODE(4, 4, 2)
  74 #define QLCNIC_NUM_FLASH_SECTORS (64)
  75 #define QLCNIC_FLASH_SECTOR_SIZE (64 * 1024)
  76 #define QLCNIC_FLASH_TOTAL_SIZE  (QLCNIC_NUM_FLASH_SECTORS \
  77                                         * QLCNIC_FLASH_SECTOR_SIZE)
  78
  79 #define RCV_DESC_RINGSIZE(rds_ring)     \
  80         (sizeof(struct rcv_desc) * (rds_ring)->num_desc)
  81 #define RCV_BUFF_RINGSIZE(rds_ring)     \
  82         (sizeof(struct qlcnic_rx_buffer) * rds_ring->num_desc)
  83 #define STATUS_DESC_RINGSIZE(sds_ring)  \
  84         (sizeof(struct status_desc) * (sds_ring)->num_desc)
  85 #define TX_BUFF_RINGSIZE(tx_ring)       \
  86         (sizeof(struct qlcnic_cmd_buffer) * tx_ring->num_desc)
  87 #define TX_DESC_RINGSIZE(tx_ring)       \
  88         (sizeof(struct cmd_desc_type0) * tx_ring->num_desc)
  89
  90 #define QLCNIC_P3P_A0           0x50
  91
  92 #define QLCNIC_IS_REVISION_P3P(REVISION)     (REVISION >= QLCNIC_P3P_A0)
  93
  94 #define FIRST_PAGE_GROUP_START  0
  95 #define FIRST_PAGE_GROUP_END    0x100000
  96
  97 #define P3_MAX_MTU                     (9600)
  98 #define P3_MIN_MTU                     (68)
  99 #define QLCNIC_MAX_ETHERHDR                32 /* This contains some padding */
 100
 101 #define QLCNIC_P3_RX_BUF_MAX_LEN         (QLCNIC_MAX_ETHERHDR + ETH_DATA_LEN)
 102 #define QLCNIC_P3_RX_JUMBO_BUF_MAX_LEN   (QLCNIC_MAX_ETHERHDR + P3_MAX_MTU)
 103 #define QLCNIC_CT_DEFAULT_RX_BUF_LEN    2048
 104 #define QLCNIC_LRO_BUFFER_EXTRA         2048
 105
 106 /* Opcodes to be used with the commands */
 107 #define TX_ETHER_PKT    0x01
 108 #define TX_TCP_PKT      0x02
 109 #define TX_UDP_PKT      0x03
 110 #define TX_IP_PKT       0x04
 111 #define TX_TCP_LSO      0x05
 112 #define TX_TCP_LSO6     0x06
 113 #define TX_IPSEC        0x07
 114 #define TX_IPSEC_CMD    0x0a
 115 #define TX_TCPV6_PKT    0x0b
 116 #define TX_UDPV6_PKT    0x0c
 117
 118 /* Tx defines */
 119 #define MAX_TSO_HEADER_DESC     2
 120 #define MGMT_CMD_DESC_RESV      4
 121 #define TX_STOP_THRESH          ((MAX_SKB_FRAGS >> 2) + MAX_TSO_HEADER_DESC \
 122                                                         + MGMT_CMD_DESC_RESV)
 123 #define QLCNIC_MAX_TX_TIMEOUTS  2
 124
 125 /*
 126  * Following are the states of the Phantom. Phantom will set them and
 127  * Host will read to check if the fields are correct.
 128  */
 129 #define PHAN_INITIALIZE_FAILED          0xffff
 130 #define PHAN_INITIALIZE_COMPLETE        0xff01
 131
 132 /* Host writes the following to notify that it has done the init-handshake */
 133 #define PHAN_INITIALIZE_ACK             0xf00f
 134 #define PHAN_PEG_RCV_INITIALIZED        0xff01
 135
 136 #define NUM_RCV_DESC_RINGS      3
 137 #define NUM_STS_DESC_RINGS      4
 138
 139 #define RCV_RING_NORMAL 0
 140 #define RCV_RING_JUMBO  1
 141
 142 #define MIN_CMD_DESCRIPTORS             64
 143 #define MIN_RCV_DESCRIPTORS             64
 144 #define MIN_JUMBO_DESCRIPTORS           32
 145
 146 #define MAX_CMD_DESCRIPTORS             1024
 147 #define MAX_RCV_DESCRIPTORS_1G          4096
 148 #define MAX_RCV_DESCRIPTORS_10G         8192
 149 #define MAX_JUMBO_RCV_DESCRIPTORS_1G    512
 150 #define MAX_JUMBO_RCV_DESCRIPTORS_10G   1024
 151
 152 #define DEFAULT_RCV_DESCRIPTORS_1G      2048
 153 #define DEFAULT_RCV_DESCRIPTORS_10G     4096
 154 #define MAX_RDS_RINGS                   2
 155
 156 #define get_next_index(index, length)   \
 157         (((index) + 1) & ((length) - 1))
 158
 159 /*
 160  * Following data structures describe the descriptors that will be used.
 161  * Added fileds of tcpHdrSize and ipHdrSize, The driver needs to do it only when
 162  * we are doing LSO (above the 1500 size packet) only.
 163  */
 164
 165 #define FLAGS_VLAN_TAGGED       0x10
 166 #define FLAGS_VLAN_OOB          0x40
 167
 168 #define qlcnic_set_tx_vlan_tci(cmd_desc, v)     \
 169         (cmd_desc)->vlan_TCI = cpu_to_le16(v);
 170 #define qlcnic_set_cmd_desc_port(cmd_desc, var) \
 171         ((cmd_desc)->port_ctxid |= ((var) & 0x0F))
 172 #define qlcnic_set_cmd_desc_ctxid(cmd_desc, var)        \
 173         ((cmd_desc)->port_ctxid |= ((var) << 4 & 0xF0))
 174
 175 #define qlcnic_set_tx_port(_desc, _port) \
 176         ((_desc)->port_ctxid = ((_port) & 0xf) | (((_port) << 4) & 0xf0))
 177
 178 #define qlcnic_set_tx_flags_opcode(_desc, _flags, _opcode) \
 179         ((_desc)->flags_opcode |= \
 180         cpu_to_le16(((_flags) & 0x7f) | (((_opcode) & 0x3f) << 7)))
 181
 182 #define qlcnic_set_tx_frags_len(_desc, _frags, _len) \
 183         ((_desc)->nfrags__length = \
 184         cpu_to_le32(((_frags) & 0xff) | (((_len) & 0xffffff) << 8)))
 185
 186 struct cmd_desc_type0 {
 187         u8 tcp_hdr_offset;      /* For LSO only */
 188         u8 ip_hdr_offset;       /* For LSO only */
 189         __le16 flags_opcode;    /* 15:13 unused, 12:7 opcode, 6:0 flags */
 190         __le32 nfrags__length;  /* 31:8 total len, 7:0 frag count */
 191
 192         __le64 addr_buffer2;
 193
 194         __le16 reference_handle;
 195         __le16 mss;
 196         u8 port_ctxid;          /* 7:4 ctxid 3:0 port */
 197         u8 total_hdr_length;    /* LSO only : MAC+IP+TCP Hdr size */
 198         __le16 conn_id;         /* IPSec offoad only */
 199
 200         __le64 addr_buffer3;
 201         __le64 addr_buffer1;
 202
 203         __le16 buffer_length[4];
 204
 205         __le64 addr_buffer4;
 206
 207         u8 eth_addr[ETH_ALEN];
 208         __le16 vlan_TCI;
 209
 210 } __attribute__ ((aligned(64)));
 211
 212 /* Note: sizeof(rcv_desc) should always be a mutliple of 2 */
 213 struct rcv_desc {
 214         __le16 reference_handle;
 215         __le16 reserved;
 216         __le32 buffer_length;   /* allocated buffer length (usually 2K) */
 217         __le64 addr_buffer;
 218 };
 219
 220 /* opcode field in status_desc */
 221 #define QLCNIC_SYN_OFFLOAD      0x03
 222 #define QLCNIC_RXPKT_DESC       0x04
 223 #define QLCNIC_OLD_RXPKT_DESC   0x3f
 224 #define QLCNIC_RESPONSE_DESC    0x05
 225 #define QLCNIC_LRO_DESC         0x12
 226
 227 /* for status field in status_desc */
 228 #define STATUS_CKSUM_LOOP       0
 229 #define STATUS_CKSUM_OK         2
 230
 231 /* owner bits of status_desc */
 232 #define STATUS_OWNER_HOST       (0x1ULL << 56)
 233 #define STATUS_OWNER_PHANTOM    (0x2ULL << 56)
 234
 235 /* Status descriptor:
 236    0-3 port, 4-7 status, 8-11 type, 12-27 total_length
 237    28-43 reference_handle, 44-47 protocol, 48-52 pkt_offset
 238    53-55 desc_cnt, 56-57 owner, 58-63 opcode
 239  */
 240 #define qlcnic_get_sts_port(sts_data)   \
 241         ((sts_data) & 0x0F)
 242 #define qlcnic_get_sts_status(sts_data) \
 243         (((sts_data) >> 4) & 0x0F)
 244 #define qlcnic_get_sts_type(sts_data)   \
 245         (((sts_data) >> 8) & 0x0F)
 246 #define qlcnic_get_sts_totallength(sts_data)    \
 247         (((sts_data) >> 12) & 0xFFFF)
 248 #define qlcnic_get_sts_refhandle(sts_data)      \
 249         (((sts_data) >> 28) & 0xFFFF)
 250 #define qlcnic_get_sts_prot(sts_data)   \
 251         (((sts_data) >> 44) & 0x0F)
 252 #define qlcnic_get_sts_pkt_offset(sts_data)     \
 253         (((sts_data) >> 48) & 0x1F)
 254 #define qlcnic_get_sts_desc_cnt(sts_data)       \
 255         (((sts_data) >> 53) & 0x7)
 256 #define qlcnic_get_sts_opcode(sts_data) \
 257         (((sts_data) >> 58) & 0x03F)
 258
 259 #define qlcnic_get_lro_sts_refhandle(sts_data)  \
 260         ((sts_data) & 0x0FFFF)
 261 #define qlcnic_get_lro_sts_length(sts_data)     \
 262         (((sts_data) >> 16) & 0x0FFFF)
 263 #define qlcnic_get_lro_sts_l2_hdr_offset(sts_data)      \
 264         (((sts_data) >> 32) & 0x0FF)
 265 #define qlcnic_get_lro_sts_l4_hdr_offset(sts_data)      \
 266         (((sts_data) >> 40) & 0x0FF)
 267 #define qlcnic_get_lro_sts_timestamp(sts_data)  \
 268         (((sts_data) >> 48) & 0x1)
 269 #define qlcnic_get_lro_sts_type(sts_data)       \
 270         (((sts_data) >> 49) & 0x7)
 271 #define qlcnic_get_lro_sts_push_flag(sts_data)          \
 272         (((sts_data) >> 52) & 0x1)
 273 #define qlcnic_get_lro_sts_seq_number(sts_data)         \
 274         ((sts_data) & 0x0FFFFFFFF)
 275
 276
 277 struct status_desc {
 278         __le64 status_desc_data[2];
 279 } __attribute__ ((aligned(16)));
 280
 281 /* UNIFIED ROMIMAGE */
 282 #define QLCNIC_UNI_FW_MIN_SIZE          0xc8000
 283 #define QLCNIC_UNI_DIR_SECT_PRODUCT_TBL 0x0
 284 #define QLCNIC_UNI_DIR_SECT_BOOTLD      0x6
 285 #define QLCNIC_UNI_DIR_SECT_FW          0x7
 286
 287 /*Offsets */
 288 #define QLCNIC_UNI_CHIP_REV_OFF         10
 289 #define QLCNIC_UNI_FLAGS_OFF            11
 290 #define QLCNIC_UNI_BIOS_VERSION_OFF     12
 291 #define QLCNIC_UNI_BOOTLD_IDX_OFF       27
 292 #define QLCNIC_UNI_FIRMWARE_IDX_OFF     29
 293
 294 struct uni_table_desc{
 295         u32     findex;
 296         u32     num_entries;
 297         u32     entry_size;
 298         u32     reserved[5];
 299 };
 300
 301 struct uni_data_desc{
 302         u32     findex;
 303         u32     size;
 304         u32     reserved[5];
 305 };
 306
 307 /* Magic number to let user know flash is programmed */
 308 #define QLCNIC_BDINFO_MAGIC 0x12345678
 309
 310 #define QLCNIC_BRDTYPE_P3_REF_QG        0x0021
 311 #define QLCNIC_BRDTYPE_P3_HMEZ          0x0022
 312 #define QLCNIC_BRDTYPE_P3_10G_CX4_LP    0x0023
 313 #define QLCNIC_BRDTYPE_P3_4_GB          0x0024
 314 #define QLCNIC_BRDTYPE_P3_IMEZ          0x0025
 315 #define QLCNIC_BRDTYPE_P3_10G_SFP_PLUS  0x0026
 316 #define QLCNIC_BRDTYPE_P3_10000_BASE_T  0x0027
 317 #define QLCNIC_BRDTYPE_P3_XG_LOM        0x0028
 318 #define QLCNIC_BRDTYPE_P3_4_GB_MM       0x0029
 319 #define QLCNIC_BRDTYPE_P3_10G_SFP_CT    0x002a
 320 #define QLCNIC_BRDTYPE_P3_10G_SFP_QT    0x002b
 321 #define QLCNIC_BRDTYPE_P3_10G_CX4       0x0031
 322 #define QLCNIC_BRDTYPE_P3_10G_XFP       0x0032
 323 #define QLCNIC_BRDTYPE_P3_10G_TP        0x0080
 324
 325 #define QLCNIC_MSIX_TABLE_OFFSET        0x44
 326
 327 /* Flash memory map */
 328 #define QLCNIC_BRDCFG_START     0x4000          /* board config */
 329 #define QLCNIC_BOOTLD_START     0x10000         /* bootld */
 330 #define QLCNIC_IMAGE_START      0x43000         /* compressed image */
 331 #define QLCNIC_USER_START       0x3E8000        /* Firmare info */
 332
 333 #define QLCNIC_FW_VERSION_OFFSET        (QLCNIC_USER_START+0x408)
 334 #define QLCNIC_FW_SIZE_OFFSET           (QLCNIC_USER_START+0x40c)
 335 #define QLCNIC_FW_SERIAL_NUM_OFFSET     (QLCNIC_USER_START+0x81c)
 336 #define QLCNIC_BIOS_VERSION_OFFSET      (QLCNIC_USER_START+0x83c)
 337
 338 #define QLCNIC_BRDTYPE_OFFSET           (QLCNIC_BRDCFG_START+0x8)
 339 #define QLCNIC_FW_MAGIC_OFFSET          (QLCNIC_BRDCFG_START+0x128)
 340
 341 #define QLCNIC_FW_MIN_SIZE              (0x3fffff)
 342 #define QLCNIC_UNIFIED_ROMIMAGE         0
 343 #define QLCNIC_FLASH_ROMIMAGE           1
 344 #define QLCNIC_UNKNOWN_ROMIMAGE         0xff
 345
 346 #define QLCNIC_UNIFIED_ROMIMAGE_NAME    "phanfw.bin"
 347 #define QLCNIC_FLASH_ROMIMAGE_NAME      "flash"
 348
 349 extern char qlcnic_driver_name[];
 350
 351 /* Number of status descriptors to handle per interrupt */
 352 #define MAX_STATUS_HANDLE       (64)
 353
 354 /*
 355  * qlcnic_skb_frag{} is to contain mapping info for each SG list. This
 356  * has to be freed when DMA is complete. This is part of qlcnic_tx_buffer{}.
 357  */
 358 struct qlcnic_skb_frag {
 359         u64 dma;
 360         u64 length;
 361 };
 362
 363 struct qlcnic_recv_crb {
 364         u32 crb_rcv_producer[NUM_RCV_DESC_RINGS];
 365         u32 crb_sts_consumer[NUM_STS_DESC_RINGS];
 366         u32 sw_int_mask[NUM_STS_DESC_RINGS];
 367 };
 368
 369 /*    Following defines are for the state of the buffers    */
 370 #define QLCNIC_BUFFER_FREE      0
 371 #define QLCNIC_BUFFER_BUSY      1
 372
 373 /*
 374  * There will be one qlcnic_buffer per skb packet.    These will be
 375  * used to save the dma info for pci_unmap_page()
 376  */
 377 struct qlcnic_cmd_buffer {
 378         struct sk_buff *skb;
 379         struct qlcnic_skb_frag frag_array[MAX_SKB_FRAGS + 1];
 380         u32 frag_count;
 381 };
 382
 383 /* In rx_buffer, we do not need multiple fragments as is a single buffer */
 384 struct qlcnic_rx_buffer {
 385         struct list_head list;
 386         struct sk_buff *skb;
 387         u64 dma;
 388         u16 ref_handle;
 389 };
 390
 391 /* Board types */
 392 #define QLCNIC_GBE      0x01
 393 #define QLCNIC_XGBE     0x02
 394
 395 /*
 396  * One hardware_context{} per adapter
 397  * contains interrupt info as well shared hardware info.
 398  */
 399 struct qlcnic_hardware_context {
 400         void __iomem *pci_base0;
 401         void __iomem *ocm_win_crb;
 402
 403         unsigned long pci_len0;
 404
 405         rwlock_t crb_lock;
 406         struct mutex mem_lock;
 407
 408         u8 revision_id;
 409         u8 pci_func;
 410         u8 linkup;
 411         u16 port_type;
 412         u16 board_type;
 413 };
 414
 415 struct qlcnic_adapter_stats {
 416         u64  xmitcalled;
 417         u64  xmitfinished;
 418         u64  rxdropped;
 419         u64  txdropped;
 420         u64  csummed;
 421         u64  rx_pkts;
 422         u64  lro_pkts;
 423         u64  rxbytes;
 424         u64  txbytes;
 425         u64  lrobytes;
 426         u64  lso_frames;
 427         u64  xmit_on;
 428         u64  xmit_off;
 429         u64  skb_alloc_failure;
 430         u64  null_rxbuf;
 431         u64  rx_dma_map_error;
 432         u64  tx_dma_map_error;
 433 };
 434
 435 /*
 436  * Rcv Descriptor Context. One such per Rcv Descriptor. There may
 437  * be one Rcv Descriptor for normal packets, one for jumbo and may be others.
 438  */
 439 struct qlcnic_host_rds_ring {
 440         u32 producer;
 441         u32 num_desc;
 442         u32 dma_size;
 443         u32 skb_size;
 444         u32 flags;
 445         void __iomem *crb_rcv_producer;
 446         struct rcv_desc *desc_head;
 447         struct qlcnic_rx_buffer *rx_buf_arr;
 448         struct list_head free_list;
 449         spinlock_t lock;
 450         dma_addr_t phys_addr;
 451 };
 452
 453 struct qlcnic_host_sds_ring {
 454         u32 consumer;
 455         u32 num_desc;
 456         void __iomem *crb_sts_consumer;
 457         void __iomem *crb_intr_mask;
 458
 459         struct status_desc *desc_head;
 460         struct qlcnic_adapter *adapter;
 461         struct napi_struct napi;
 462         struct list_head free_list[NUM_RCV_DESC_RINGS];
 463
 464         int irq;
 465
 466         dma_addr_t phys_addr;
 467         char name[IFNAMSIZ+4];
 468 };
 469
 470 struct qlcnic_host_tx_ring {
 471         u32 producer;
 472         __le32 *hw_consumer;
 473         u32 sw_consumer;
 474         void __iomem *crb_cmd_producer;
 475         u32 num_desc;
 476
 477         struct netdev_queue *txq;
 478
 479         struct qlcnic_cmd_buffer *cmd_buf_arr;
 480         struct cmd_desc_type0 *desc_head;
 481         dma_addr_t phys_addr;
 482         dma_addr_t hw_cons_phys_addr;
 483 };
 484
 485 /*
 486  * Receive context. There is one such structure per instance of the
 487  * receive processing. Any state information that is relevant to
 488  * the receive, and is must be in this structure. The global data may be
 489  * present elsewhere.
 490  */
 491 struct qlcnic_recv_context {
 492         u32 state;
 493         u16 context_id;
 494         u16 virt_port;
 495
 496         struct qlcnic_host_rds_ring *rds_rings;
 497         struct qlcnic_host_sds_ring *sds_rings;
 498 };
 499
 500 /* HW context creation */
 501
 502 #define QLCNIC_OS_CRB_RETRY_COUNT       4000
 503 #define QLCNIC_CDRP_SIGNATURE_MAKE(pcifn, version) \
 504         (((pcifn) & 0xff) | (((version) & 0xff) << 8) | (0xcafe << 16))
 505
 506 #define QLCNIC_CDRP_CMD_BIT             0x80000000
 507
 508 /*
 509  * All responses must have the QLCNIC_CDRP_CMD_BIT cleared
 510  * in the crb QLCNIC_CDRP_CRB_OFFSET.
 511  */
 512 #define QLCNIC_CDRP_FORM_RSP(rsp)       (rsp)
 513 #define QLCNIC_CDRP_IS_RSP(rsp) (((rsp) & QLCNIC_CDRP_CMD_BIT) == 0)
 514
 515 #define QLCNIC_CDRP_RSP_OK              0x00000001
 516 #define QLCNIC_CDRP_RSP_FAIL            0x00000002
 517 #define QLCNIC_CDRP_RSP_TIMEOUT         0x00000003
 518
 519 /*
 520  * All commands must have the QLCNIC_CDRP_CMD_BIT set in
 521  * the crb QLCNIC_CDRP_CRB_OFFSET.
 522  */
 523 #define QLCNIC_CDRP_FORM_CMD(cmd)       (QLCNIC_CDRP_CMD_BIT | (cmd))
 524 #define QLCNIC_CDRP_IS_CMD(cmd) (((cmd) & QLCNIC_CDRP_CMD_BIT) != 0)
 525
 526 #define QLCNIC_CDRP_CMD_SUBMIT_CAPABILITIES     0x00000001
 527 #define QLCNIC_CDRP_CMD_READ_MAX_RDS_PER_CTX    0x00000002
 528 #define QLCNIC_CDRP_CMD_READ_MAX_SDS_PER_CTX    0x00000003
 529 #define QLCNIC_CDRP_CMD_READ_MAX_RULES_PER_CTX  0x00000004
 530 #define QLCNIC_CDRP_CMD_READ_MAX_RX_CTX         0x00000005
 531 #define QLCNIC_CDRP_CMD_READ_MAX_TX_CTX         0x00000006
 532 #define QLCNIC_CDRP_CMD_CREATE_RX_CTX           0x00000007
 533 #define QLCNIC_CDRP_CMD_DESTROY_RX_CTX          0x00000008
 534 #define QLCNIC_CDRP_CMD_CREATE_TX_CTX           0x00000009
 535 #define QLCNIC_CDRP_CMD_DESTROY_TX_CTX          0x0000000a
 536 #define QLCNIC_CDRP_CMD_SETUP_STATISTICS        0x0000000e
 537 #define QLCNIC_CDRP_CMD_GET_STATISTICS          0x0000000f
 538 #define QLCNIC_CDRP_CMD_DELETE_STATISTICS       0x00000010
 539 #define QLCNIC_CDRP_CMD_SET_MTU                 0x00000012
 540 #define QLCNIC_CDRP_CMD_READ_PHY                0x00000013
 541 #define QLCNIC_CDRP_CMD_WRITE_PHY               0x00000014
 542 #define QLCNIC_CDRP_CMD_READ_HW_REG             0x00000015
 543 #define QLCNIC_CDRP_CMD_GET_FLOW_CTL            0x00000016
 544 #define QLCNIC_CDRP_CMD_SET_FLOW_CTL            0x00000017
 545 #define QLCNIC_CDRP_CMD_READ_MAX_MTU            0x00000018
 546 #define QLCNIC_CDRP_CMD_READ_MAX_LRO            0x00000019
 547 #define QLCNIC_CDRP_CMD_CONFIGURE_TOE           0x0000001a
 548 #define QLCNIC_CDRP_CMD_FUNC_ATTRIB             0x0000001b
 549 #define QLCNIC_CDRP_CMD_READ_PEXQ_PARAMETERS    0x0000001c
 550 #define QLCNIC_CDRP_CMD_GET_LIC_CAPABILITIES    0x0000001d
 551 #define QLCNIC_CDRP_CMD_READ_MAX_LRO_PER_BOARD  0x0000001e
 552 #define QLCNIC_CDRP_CMD_MAC_ADDRESS             0x0000001f
 553
 554 #define QLCNIC_CDRP_CMD_GET_PCI_INFO            0x00000020
 555 #define QLCNIC_CDRP_CMD_GET_NIC_INFO            0x00000021
 556 #define QLCNIC_CDRP_CMD_SET_NIC_INFO            0x00000022
 557 #define QLCNIC_CDRP_CMD_RESET_NPAR              0x00000023
 558 #define QLCNIC_CDRP_CMD_GET_ESWITCH_CAPABILITY  0x00000024
 559 #define QLCNIC_CDRP_CMD_TOGGLE_ESWITCH          0x00000025
 560 #define QLCNIC_CDRP_CMD_GET_ESWITCH_STATUS      0x00000026
 561 #define QLCNIC_CDRP_CMD_SET_PORTMIRRORING       0x00000027
 562 #define QLCNIC_CDRP_CMD_CONFIGURE_ESWITCH       0x00000028
 563 #define QLCNIC_CDRP_CMD_GET_ESWITCH_PORT_CONFIG 0x00000029
 564 #define QLCNIC_CDRP_CMD_GET_ESWITCH_STATS       0x0000002a
 565
 566 #define QLCNIC_RCODE_SUCCESS            0
 567 #define QLCNIC_RCODE_TIMEOUT            17
 568 #define QLCNIC_DESTROY_CTX_RESET        0
 569
 570 /*
 571  * Capabilities Announced
 572  */
 573 #define QLCNIC_CAP0_LEGACY_CONTEXT      (1)
 574 #define QLCNIC_CAP0_LEGACY_MN           (1 << 2)
 575 #define QLCNIC_CAP0_LSO                 (1 << 6)
 576 #define QLCNIC_CAP0_JUMBO_CONTIGUOUS    (1 << 7)
 577 #define QLCNIC_CAP0_LRO_CONTIGUOUS      (1 << 8)
 578 #define QLCNIC_CAP0_VALIDOFF            (1 << 11)
 579
 580 /*
 581  * Context state
 582  */
 583 #define QLCNIC_HOST_CTX_STATE_FREED     0
 584 #define QLCNIC_HOST_CTX_STATE_ACTIVE    2
 585
 586 /*
 587  * Rx context
 588  */
 589
 590 struct qlcnic_hostrq_sds_ring {
 591         __le64 host_phys_addr;  /* Ring base addr */
 592         __le32 ring_size;               /* Ring entries */
 593         __le16 msi_index;
 594         __le16 rsvd;            /* Padding */
 595 };
 596
 597 struct qlcnic_hostrq_rds_ring {
 598         __le64 host_phys_addr;  /* Ring base addr */
 599         __le64 buff_size;               /* Packet buffer size */
 600         __le32 ring_size;               /* Ring entries */
 601         __le32 ring_kind;               /* Class of ring */
 602 };
 603
 604 struct qlcnic_hostrq_rx_ctx {
 605         __le64 host_rsp_dma_addr;       /* Response dma'd here */
 606         __le32 capabilities[4]; /* Flag bit vector */
 607         __le32 host_int_crb_mode;       /* Interrupt crb usage */
 608         __le32 host_rds_crb_mode;       /* RDS crb usage */
 609         /* These ring offsets are relative to data[0] below */
 610         __le32 rds_ring_offset; /* Offset to RDS config */
 611         __le32 sds_ring_offset; /* Offset to SDS config */
 612         __le16 num_rds_rings;   /* Count of RDS rings */
 613         __le16 num_sds_rings;   /* Count of SDS rings */
 614         __le16 valid_field_offset;
 615         u8  txrx_sds_binding;
 616         u8  msix_handler;
 617         u8  reserved[128];      /* reserve space for future expansion*/
 618         /* MUST BE 64-bit aligned.
 619            The following is packed:
 620            - N hostrq_rds_rings
 621            - N hostrq_sds_rings */
 622         char data[0];
 623 };
 624
 625 struct qlcnic_cardrsp_rds_ring{
 626         __le32 host_producer_crb;       /* Crb to use */
 627         __le32 rsvd1;           /* Padding */
 628 };
 629
 630 struct qlcnic_cardrsp_sds_ring {
 631         __le32 host_consumer_crb;       /* Crb to use */
 632         __le32 interrupt_crb;   /* Crb to use */
 633 };
 634
 635 struct qlcnic_cardrsp_rx_ctx {
 636         /* These ring offsets are relative to data[0] below */
 637         __le32 rds_ring_offset; /* Offset to RDS config */
 638         __le32 sds_ring_offset; /* Offset to SDS config */
 639         __le32 host_ctx_state;  /* Starting State */
 640         __le32 num_fn_per_port; /* How many PCI fn share the port */
 641         __le16 num_rds_rings;   /* Count of RDS rings */
 642         __le16 num_sds_rings;   /* Count of SDS rings */
 643         __le16 context_id;              /* Handle for context */
 644         u8  phys_port;          /* Physical id of port */
 645         u8  virt_port;          /* Virtual/Logical id of port */
 646         u8  reserved[128];      /* save space for future expansion */
 647         /*  MUST BE 64-bit aligned.
 648            The following is packed:
 649            - N cardrsp_rds_rings
 650            - N cardrs_sds_rings */
 651         char data[0];
 652 };
 653
 654 #define SIZEOF_HOSTRQ_RX(HOSTRQ_RX, rds_rings, sds_rings)       \
 655         (sizeof(HOSTRQ_RX) +                                    \
 656         (rds_rings)*(sizeof(struct qlcnic_hostrq_rds_ring)) +           \
 657         (sds_rings)*(sizeof(struct qlcnic_hostrq_sds_ring)))
 658
 659 #define SIZEOF_CARDRSP_RX(CARDRSP_RX, rds_rings, sds_rings)     \
 660         (sizeof(CARDRSP_RX) +                                   \
 661         (rds_rings)*(sizeof(struct qlcnic_cardrsp_rds_ring)) +          \
 662         (sds_rings)*(sizeof(struct qlcnic_cardrsp_sds_ring)))
 663
 664 /*
 665  * Tx context
 666  */
 667
 668 struct qlcnic_hostrq_cds_ring {
 669         __le64 host_phys_addr;  /* Ring base addr */
 670         __le32 ring_size;               /* Ring entries */
 671         __le32 rsvd;            /* Padding */
 672 };
 673
 674 struct qlcnic_hostrq_tx_ctx {
 675         __le64 host_rsp_dma_addr;       /* Response dma'd here */
 676         __le64 cmd_cons_dma_addr;       /*  */
 677         __le64 dummy_dma_addr;  /*  */
 678         __le32 capabilities[4]; /* Flag bit vector */
 679         __le32 host_int_crb_mode;       /* Interrupt crb usage */
 680         __le32 rsvd1;           /* Padding */
 681         __le16 rsvd2;           /* Padding */
 682         __le16 interrupt_ctl;
 683         __le16 msi_index;
 684         __le16 rsvd3;           /* Padding */
 685         struct qlcnic_hostrq_cds_ring cds_ring; /* Desc of cds ring */
 686         u8  reserved[128];      /* future expansion */
 687 };
 688
 689 struct qlcnic_cardrsp_cds_ring {
 690         __le32 host_producer_crb;       /* Crb to use */
 691         __le32 interrupt_crb;   /* Crb to use */
 692 };
 693
 694 struct qlcnic_cardrsp_tx_ctx {
 695         __le32 host_ctx_state;  /* Starting state */
 696         __le16 context_id;              /* Handle for context */
 697         u8  phys_port;          /* Physical id of port */
 698         u8  virt_port;          /* Virtual/Logical id of port */
 699         struct qlcnic_cardrsp_cds_ring cds_ring;        /* Card cds settings */
 700         u8  reserved[128];      /* future expansion */
 701 };
 702
 703 #define SIZEOF_HOSTRQ_TX(HOSTRQ_TX)     (sizeof(HOSTRQ_TX))
 704 #define SIZEOF_CARDRSP_TX(CARDRSP_TX)   (sizeof(CARDRSP_TX))
 705
 706 /* CRB */
 707
 708 #define QLCNIC_HOST_RDS_CRB_MODE_UNIQUE 0
 709 #define QLCNIC_HOST_RDS_CRB_MODE_SHARED 1
 710 #define QLCNIC_HOST_RDS_CRB_MODE_CUSTOM 2
 711 #define QLCNIC_HOST_RDS_CRB_MODE_MAX    3
 712
 713 #define QLCNIC_HOST_INT_CRB_MODE_UNIQUE 0
 714 #define QLCNIC_HOST_INT_CRB_MODE_SHARED 1
 715 #define QLCNIC_HOST_INT_CRB_MODE_NORX   2
 716 #define QLCNIC_HOST_INT_CRB_MODE_NOTX   3
 717 #define QLCNIC_HOST_INT_CRB_MODE_NORXTX 4
 718
 719
 720 /* MAC */
 721
 722 #define MC_COUNT_P3     38
 723
 724 #define QLCNIC_MAC_NOOP 0
 725 #define QLCNIC_MAC_ADD  1
 726 #define QLCNIC_MAC_DEL  2
 727 #define QLCNIC_MAC_VLAN_ADD     3
 728 #define QLCNIC_MAC_VLAN_DEL     4
 729
 730 struct qlcnic_mac_list_s {
 731         struct list_head list;
 732         uint8_t mac_addr[ETH_ALEN+2];
 733 };
 734
 735 /*
 736  * Interrupt coalescing defaults. The defaults are for 1500 MTU. It is
 737  * adjusted based on configured MTU.
 738  */
 739 #define QLCNIC_DEFAULT_INTR_COALESCE_RX_TIME_US 3
 740 #define QLCNIC_DEFAULT_INTR_COALESCE_RX_PACKETS 256
 741 #define QLCNIC_DEFAULT_INTR_COALESCE_TX_PACKETS 64
 742 #define QLCNIC_DEFAULT_INTR_COALESCE_TX_TIME_US 4
 743
 744 #define QLCNIC_INTR_DEFAULT                     0x04
 745
 746 union qlcnic_nic_intr_coalesce_data {
 747         struct {
 748                 u16     rx_packets;
 749                 u16     rx_time_us;
 750                 u16     tx_packets;
 751                 u16     tx_time_us;
 752         } data;
 753         u64             word;
 754 };
 755
 756 struct qlcnic_nic_intr_coalesce {
 757         u16             stats_time_us;
 758         u16             rate_sample_time;
 759         u16             flags;
 760         u16             rsvd_1;
 761         u32             low_threshold;
 762         u32             high_threshold;
 763         union qlcnic_nic_intr_coalesce_data     normal;
 764         union qlcnic_nic_intr_coalesce_data     low;
 765         union qlcnic_nic_intr_coalesce_data     high;
 766         union qlcnic_nic_intr_coalesce_data     irq;
 767 };
 768
 769 #define QLCNIC_HOST_REQUEST     0x13
 770 #define QLCNIC_REQUEST          0x14
 771
 772 #define QLCNIC_MAC_EVENT        0x1
 773
 774 #define QLCNIC_IP_UP            2
 775 #define QLCNIC_IP_DOWN          3
 776
 777 /*
 778  * Driver --> Firmware
 779  */
 780 #define QLCNIC_H2C_OPCODE_START                         0
 781 #define QLCNIC_H2C_OPCODE_CONFIG_RSS                    1
 782 #define QLCNIC_H2C_OPCODE_CONFIG_RSS_TBL                2
 783 #define QLCNIC_H2C_OPCODE_CONFIG_INTR_COALESCE          3
 784 #define QLCNIC_H2C_OPCODE_CONFIG_LED                    4
 785 #define QLCNIC_H2C_OPCODE_CONFIG_PROMISCUOUS            5
 786 #define QLCNIC_H2C_OPCODE_CONFIG_L2_MAC                 6
 787 #define QLCNIC_H2C_OPCODE_LRO_REQUEST                   7
 788 #define QLCNIC_H2C_OPCODE_GET_SNMP_STATS                8
 789 #define QLCNIC_H2C_OPCODE_PROXY_START_REQUEST           9
 790 #define QLCNIC_H2C_OPCODE_PROXY_STOP_REQUEST            10
 791 #define QLCNIC_H2C_OPCODE_PROXY_SET_MTU                 11
 792 #define QLCNIC_H2C_OPCODE_PROXY_SET_VPORT_MISS_MODE     12
 793 #define QLCNIC_H2C_OPCODE_GET_FINGER_PRINT_REQUEST      13
 794 #define QLCNIC_H2C_OPCODE_INSTALL_LICENSE_REQUEST       14
 795 #define QLCNIC_H2C_OPCODE_GET_LICENSE_CAPABILITY_REQUEST        15
 796 #define QLCNIC_H2C_OPCODE_GET_NET_STATS                 16
 797 #define QLCNIC_H2C_OPCODE_PROXY_UPDATE_P2V              17
 798 #define QLCNIC_H2C_OPCODE_CONFIG_IPADDR                 18
 799 #define QLCNIC_H2C_OPCODE_CONFIG_LOOPBACK               19
 800 #define QLCNIC_H2C_OPCODE_PROXY_STOP_DONE               20
 801 #define QLCNIC_H2C_OPCODE_GET_LINKEVENT                 21
 802 #define QLCNIC_C2C_OPCODE                               22
 803 #define QLCNIC_H2C_OPCODE_CONFIG_BRIDGING               23
 804 #define QLCNIC_H2C_OPCODE_CONFIG_HW_LRO                 24
 805 #define QLCNIC_H2C_OPCODE_LAST                          25
 806 /*
 807  * Firmware --> Driver
 808  */
 809
 810 #define QLCNIC_C2H_OPCODE_START                         128
 811 #define QLCNIC_C2H_OPCODE_CONFIG_RSS_RESPONSE           129
 812 #define QLCNIC_C2H_OPCODE_CONFIG_RSS_TBL_RESPONSE       130
 813 #define QLCNIC_C2H_OPCODE_CONFIG_MAC_RESPONSE           131
 814 #define QLCNIC_C2H_OPCODE_CONFIG_PROMISCUOUS_RESPONSE   132
 815 #define QLCNIC_C2H_OPCODE_CONFIG_L2_MAC_RESPONSE        133
 816 #define QLCNIC_C2H_OPCODE_LRO_DELETE_RESPONSE           134
 817 #define QLCNIC_C2H_OPCODE_LRO_ADD_FAILURE_RESPONSE      135
 818 #define QLCNIC_C2H_OPCODE_GET_SNMP_STATS                136
 819 #define QLCNIC_C2H_OPCODE_GET_FINGER_PRINT_REPLY        137
 820 #define QLCNIC_C2H_OPCODE_INSTALL_LICENSE_REPLY         138
 821 #define QLCNIC_C2H_OPCODE_GET_LICENSE_CAPABILITIES_REPLY 139
 822 #define QLCNIC_C2H_OPCODE_GET_NET_STATS_RESPONSE        140
 823 #define QLCNIC_C2H_OPCODE_GET_LINKEVENT_RESPONSE        141
 824 #define QLCNIC_C2H_OPCODE_LAST                          142
 825
 826 #define VPORT_MISS_MODE_DROP            0 /* drop all unmatched */
 827 #define VPORT_MISS_MODE_ACCEPT_ALL      1 /* accept all packets */
 828 #define VPORT_MISS_MODE_ACCEPT_MULTI    2 /* accept unmatched multicast */
 829
 830 #define QLCNIC_LRO_REQUEST_CLEANUP      4
 831
 832 /* Capabilites received */
 833 #define QLCNIC_FW_CAPABILITY_TSO                BIT_1
 834 #define QLCNIC_FW_CAPABILITY_BDG                BIT_8
 835 #define QLCNIC_FW_CAPABILITY_FVLANTX            BIT_9
 836 #define QLCNIC_FW_CAPABILITY_HW_LRO             BIT_10
 837
 838 /* module types */
 839 #define LINKEVENT_MODULE_NOT_PRESENT                    1
 840 #define LINKEVENT_MODULE_OPTICAL_UNKNOWN                2
 841 #define LINKEVENT_MODULE_OPTICAL_SRLR                   3
 842 #define LINKEVENT_MODULE_OPTICAL_LRM                    4
 843 #define LINKEVENT_MODULE_OPTICAL_SFP_1G                 5
 844 #define LINKEVENT_MODULE_TWINAX_UNSUPPORTED_CABLE       6
 845 #define LINKEVENT_MODULE_TWINAX_UNSUPPORTED_CABLELEN    7
 846 #define LINKEVENT_MODULE_TWINAX                         8
 847
 848 #define LINKSPEED_10GBPS        10000
 849 #define LINKSPEED_1GBPS         1000
 850 #define LINKSPEED_100MBPS       100
 851 #define LINKSPEED_10MBPS        10
 852
 853 #define LINKSPEED_ENCODED_10MBPS        0
 854 #define LINKSPEED_ENCODED_100MBPS       1
 855 #define LINKSPEED_ENCODED_1GBPS         2
 856
 857 #define LINKEVENT_AUTONEG_DISABLED      0
 858 #define LINKEVENT_AUTONEG_ENABLED       1
 859
 860 #define LINKEVENT_HALF_DUPLEX           0
 861 #define LINKEVENT_FULL_DUPLEX           1
 862
 863 #define LINKEVENT_LINKSPEED_MBPS        0
 864 #define LINKEVENT_LINKSPEED_ENCODED     1
 865
 866 #define AUTO_FW_RESET_ENABLED   0x01
 867 /* firmware response header:
 868  *      63:58 - message type
 869  *      57:56 - owner
 870  *      55:53 - desc count
 871  *      52:48 - reserved
 872  *      47:40 - completion id
 873  *      39:32 - opcode
 874  *      31:16 - error code
 875  *      15:00 - reserved
 876  */
 877 #define qlcnic_get_nic_msg_opcode(msg_hdr)      \
 878         ((msg_hdr >> 32) & 0xFF)
 879
 880 struct qlcnic_fw_msg {
 881         union {
 882                 struct {
 883                         u64 hdr;
 884                         u64 body[7];
 885                 };
 886                 u64 words[8];
 887         };
 888 };
 889
 890 struct qlcnic_nic_req {
 891         __le64 qhdr;
 892         __le64 req_hdr;
 893         __le64 words[6];
 894 };
 895
 896 struct qlcnic_mac_req {
 897         u8 op;
 898         u8 tag;
 899         u8 mac_addr[6];
 900 };
 901
 902 struct qlcnic_vlan_req {
 903         __le16 vlan_id;
 904         __le16 rsvd[3];
 905 };
 906
 907 struct qlcnic_ipaddr {
 908         __be32 ipv4;
 909         __be32 ipv6[4];
 910 };
 911
 912 #define QLCNIC_MSI_ENABLED              0x02
 913 #define QLCNIC_MSIX_ENABLED             0x04
 914 #define QLCNIC_LRO_ENABLED              0x08
 915 #define QLCNIC_LRO_DISABLED             0x00
 916 #define QLCNIC_BRIDGE_ENABLED           0X10
 917 #define QLCNIC_DIAG_ENABLED             0x20
 918 #define QLCNIC_ESWITCH_ENABLED          0x40
 919 #define QLCNIC_ADAPTER_INITIALIZED      0x80
 920 #define QLCNIC_TAGGING_ENABLED          0x100
 921 #define QLCNIC_MACSPOOF                 0x200
 922 #define QLCNIC_MAC_OVERRIDE_DISABLED    0x400
 923 #define QLCNIC_PROMISC_DISABLED         0x800
 924 #define QLCNIC_IS_MSI_FAMILY(adapter) \
 925         ((adapter)->flags & (QLCNIC_MSI_ENABLED | QLCNIC_MSIX_ENABLED))
 926
 927 #define MSIX_ENTRIES_PER_ADAPTER        NUM_STS_DESC_RINGS
 928 #define QLCNIC_MSIX_TBL_SPACE           8192
 929 #define QLCNIC_PCI_REG_MSIX_TBL         0x44
 930 #define QLCNIC_MSIX_TBL_PGSIZE          4096
 931
 932 #define QLCNIC_NETDEV_WEIGHT    128
 933 #define QLCNIC_ADAPTER_UP_MAGIC 777
 934
 935 #define __QLCNIC_FW_ATTACHED            0
 936 #define __QLCNIC_DEV_UP                 1
 937 #define __QLCNIC_RESETTING              2
 938 #define __QLCNIC_START_FW               4
 939 #define __QLCNIC_AER                    5
 940
 941 #define QLCNIC_INTERRUPT_TEST           1
 942 #define QLCNIC_LOOPBACK_TEST            2
 943
 944 #define QLCNIC_FILTER_AGE       80
 945 #define QLCNIC_LB_MAX_FILTERS   64
 946
 947 struct qlcnic_filter {
 948         struct hlist_node fnode;
 949         u8 faddr[ETH_ALEN];
 950         __le16 vlan_id;
 951         unsigned long ftime;
 952 };
 953
 954 struct qlcnic_filter_hash {
 955         struct hlist_head *fhead;
 956         u8 fnum;
 957         u8 fmax;
 958 };
 959
 960 struct qlcnic_adapter {
 961         struct qlcnic_hardware_context ahw;
 962
 963         struct net_device *netdev;
 964         struct pci_dev *pdev;
 965         struct list_head mac_list;
 966
 967         spinlock_t tx_clean_lock;
 968         spinlock_t mac_learn_lock;
 969
 970         u16 num_txd;
 971         u16 num_rxd;
 972         u16 num_jumbo_rxd;
 973
 974         u8 max_rds_rings;
 975         u8 max_sds_rings;
 976         u8 msix_supported;
 977         u8 rx_csum;
 978         u8 portnum;
 979         u8 physical_port;
 980         u8 reset_context;
 981
 982         u8 mc_enabled;
 983         u8 max_mc_count;
 984         u8 rss_supported;
 985         u8 fw_wait_cnt;
 986         u8 fw_fail_cnt;
 987         u8 tx_timeo_cnt;
 988         u8 need_fw_reset;
 989
 990         u8 has_link_events;
 991         u8 fw_type;
 992         u16 tx_context_id;
 993         u16 is_up;
 994
 995         u16 link_speed;
 996         u16 link_duplex;
 997         u16 link_autoneg;
 998         u16 module_type;
 999
1000         u16 op_mode;
1001         u16 switch_mode;
1002         u16 max_tx_ques;
1003         u16 max_rx_ques;
1004         u16 max_mtu;
1005         u16 pvid;
1006
1007         u32 fw_hal_version;
1008         u32 capabilities;
1009         u32 flags;
1010         u32 irq;
1011         u32 temp;
1012
1013         u32 int_vec_bit;
1014         u32 heartbeat;
1015
1016         u8 max_mac_filters;
1017         u8 dev_state;
1018         u8 diag_test;
1019         u8 diag_cnt;
1020         u8 reset_ack_timeo;
1021         u8 dev_init_timeo;
1022         u16 msg_enable;
1023
1024         u8 mac_addr[ETH_ALEN];
1025
1026         u64 dev_rst_time;
1027
1028         struct vlan_group *vlgrp;
1029         struct qlcnic_npar_info *npars;
1030         struct qlcnic_eswitch *eswitch;
1031         struct qlcnic_nic_template *nic_ops;
1032
1033         struct qlcnic_adapter_stats stats;
1034
1035         struct qlcnic_recv_context recv_ctx;
1036         struct qlcnic_host_tx_ring *tx_ring;
1037
1038         void __iomem    *tgt_mask_reg;
1039         void __iomem    *tgt_status_reg;
1040         void __iomem    *crb_int_state_reg;
1041         void __iomem    *isr_int_vec;
1042
1043         struct msix_entry msix_entries[MSIX_ENTRIES_PER_ADAPTER];
1044
1045         struct delayed_work fw_work;
1046
1047         struct qlcnic_nic_intr_coalesce coal;
1048
1049         struct qlcnic_filter_hash fhash;
1050
1051         unsigned long state;
1052         __le32 file_prd_off;    /*File fw product offset*/
1053         u32 fw_version;
1054         const struct firmware *fw;
1055 };
1056
1057 struct qlcnic_info {
1058         __le16  pci_func;
1059         __le16  op_mode; /* 1 = Priv, 2 = NP, 3 = NP passthru */
1060         __le16  phys_port;
1061         __le16  switch_mode; /* 0 = disabled, 1 = int, 2 = ext */
1062
1063         __le32  capabilities;
1064         u8      max_mac_filters;
1065         u8      reserved1;
1066         __le16  max_mtu;
1067
1068         __le16  max_tx_ques;
1069         __le16  max_rx_ques;
1070         __le16  min_tx_bw;
1071         __le16  max_tx_bw;
1072         u8      reserved2[104];
1073 };
1074
1075 struct qlcnic_pci_info {
1076         __le16  id; /* pci function id */
1077         __le16  active; /* 1 = Enabled */
1078         __le16  type; /* 1 = NIC, 2 = FCoE, 3 = iSCSI */
1079         __le16  default_port; /* default port number */
1080
1081         __le16  tx_min_bw; /* Multiple of 100mbpc */
1082         __le16  tx_max_bw;
1083         __le16  reserved1[2];
1084
1085         u8      mac[ETH_ALEN];
1086         u8      reserved2[106];
1087 };
1088
1089 struct qlcnic_npar_info {
1090         u16     pvid;
1091         u16     min_bw;
1092         u16     max_bw;
1093         u8      phy_port;
1094         u8      type;
1095         u8      active;
1096         u8      enable_pm;
1097         u8      dest_npar;
1098         u8      discard_tagged;
1099         u8      mac_override;
1100         u8      mac_anti_spoof;
1101         u8      promisc_mode;
1102         u8      offload_flags;
1103 };
1104
1105 struct qlcnic_eswitch {
1106         u8      port;
1107         u8      active_vports;
1108         u8      active_vlans;
1109         u8      active_ucast_filters;
1110         u8      max_ucast_filters;
1111         u8      max_active_vlans;
1112
1113         u32     flags;
1114 #define QLCNIC_SWITCH_ENABLE            BIT_1
1115 #define QLCNIC_SWITCH_VLAN_FILTERING    BIT_2
1116 #define QLCNIC_SWITCH_PROMISC_MODE      BIT_3
1117 #define QLCNIC_SWITCH_PORT_MIRRORING    BIT_4
1118 };
1119
1120
1121 /* Return codes for Error handling */
1122 #define QL_STATUS_INVALID_PARAM -1
1123
1124 #define MAX_BW                  100
1125 #define MIN_BW                  1
1126 #define MAX_VLAN_ID             4095
1127 #define MIN_VLAN_ID             2
1128 #define MAX_TX_QUEUES           1
1129 #define MAX_RX_QUEUES           4
1130 #define DEFAULT_MAC_LEARN       1
1131
1132 #define IS_VALID_VLAN(vlan)     (vlan >= MIN_VLAN_ID && vlan <= MAX_VLAN_ID)
1133 #define IS_VALID_BW(bw)         (bw >= MIN_BW && bw <= MAX_BW)
1134 #define IS_VALID_TX_QUEUES(que) (que > 0 && que <= MAX_TX_QUEUES)
1135 #define IS_VALID_RX_QUEUES(que) (que > 0 && que <= MAX_RX_QUEUES)
1136
1137 struct qlcnic_pci_func_cfg {
1138         u16     func_type;
1139         u16     min_bw;
1140         u16     max_bw;
1141         u16     port_num;
1142         u8      pci_func;
1143         u8      func_state;
1144         u8      def_mac_addr[6];
1145 };
1146
1147 struct qlcnic_npar_func_cfg {
1148         u32     fw_capab;
1149         u16     port_num;
1150         u16     min_bw;
1151         u16     max_bw;
1152         u16     max_tx_queues;
1153         u16     max_rx_queues;
1154         u8      pci_func;
1155         u8      op_mode;
1156 };
1157
1158 struct qlcnic_pm_func_cfg {
1159         u8      pci_func;
1160         u8      action;
1161         u8      dest_npar;
1162         u8      reserved[5];
1163 };
1164
1165 struct qlcnic_esw_func_cfg {
1166         u16     vlan_id;
1167         u8      op_mode;
1168         u8      op_type;
1169         u8      pci_func;
1170         u8      host_vlan_tag;
1171         u8      promisc_mode;
1172         u8      discard_tagged;
1173         u8      mac_override;
1174         u8      mac_anti_spoof;
1175         u8      offload_flags;
1176         u8      reserved[5];
1177 };
1178
1179 #define QLCNIC_STATS_VERSION            1
1180 #define QLCNIC_STATS_PORT               1
1181 #define QLCNIC_STATS_ESWITCH            2
1182 #define QLCNIC_QUERY_RX_COUNTER         0
1183 #define QLCNIC_QUERY_TX_COUNTER         1
1184 #define QLCNIC_ESW_STATS_NOT_AVAIL      0xffffffffffffffffULL
1185
1186 #define QLCNIC_ADD_ESW_STATS(VAL1, VAL2)\
1187 do {    \
1188         if (((VAL1) == QLCNIC_ESW_STATS_NOT_AVAIL) && \
1189             ((VAL2) != QLCNIC_ESW_STATS_NOT_AVAIL)) \
1190                 (VAL1) = (VAL2); \
1191         else if (((VAL1) != QLCNIC_ESW_STATS_NOT_AVAIL) && \
1192                  ((VAL2) != QLCNIC_ESW_STATS_NOT_AVAIL)) \
1193                         (VAL1) += (VAL2); \
1194 } while (0)
1195
1196 struct __qlcnic_esw_statistics {
1197         __le16 context_id;
1198         __le16 version;
1199         __le16 size;
1200         __le16 unused;
1201         __le64 unicast_frames;
1202         __le64 multicast_frames;
1203         __le64 broadcast_frames;
1204         __le64 dropped_frames;
1205         __le64 errors;
1206         __le64 local_frames;
1207         __le64 numbytes;
1208         __le64 rsvd[3];
1209 };
1210
1211 struct qlcnic_esw_statistics {
1212         struct __qlcnic_esw_statistics rx;
1213         struct __qlcnic_esw_statistics tx;
1214 };
1215
1216 int qlcnic_fw_cmd_query_phy(struct qlcnic_adapter *adapter, u32 reg, u32 *val);
1217 int qlcnic_fw_cmd_set_phy(struct qlcnic_adapter *adapter, u32 reg, u32 val);
1218
1219 u32 qlcnic_hw_read_wx_2M(struct qlcnic_adapter *adapter, ulong off);
1220 int qlcnic_hw_write_wx_2M(struct qlcnic_adapter *, ulong off, u32 data);
1221 int qlcnic_pci_mem_write_2M(struct qlcnic_adapter *, u64 off, u64 data);
1222 int qlcnic_pci_mem_read_2M(struct qlcnic_adapter *, u64 off, u64 *data);
1223 void qlcnic_pci_camqm_read_2M(struct qlcnic_adapter *, u64, u64 *);
1224 void qlcnic_pci_camqm_write_2M(struct qlcnic_adapter *, u64, u64);
1225
1226 #define ADDR_IN_RANGE(addr, low, high)  \
1227         (((addr) < (high)) && ((addr) >= (low)))
1228
1229 #define QLCRD32(adapter, off) \
1230         (qlcnic_hw_read_wx_2M(adapter, off))
1231 #define QLCWR32(adapter, off, val) \
1232         (qlcnic_hw_write_wx_2M(adapter, off, val))
1233
1234 int qlcnic_pcie_sem_lock(struct qlcnic_adapter *, int, u32);
1235 void qlcnic_pcie_sem_unlock(struct qlcnic_adapter *, int);
1236
1237 #define qlcnic_rom_lock(a)      \
1238         qlcnic_pcie_sem_lock((a), 2, QLCNIC_ROM_LOCK_ID)
1239 #define qlcnic_rom_unlock(a)    \
1240         qlcnic_pcie_sem_unlock((a), 2)
1241 #define qlcnic_phy_lock(a)      \
1242         qlcnic_pcie_sem_lock((a), 3, QLCNIC_PHY_LOCK_ID)
1243 #define qlcnic_phy_unlock(a)    \
1244         qlcnic_pcie_sem_unlock((a), 3)
1245 #define qlcnic_api_lock(a)      \
1246         qlcnic_pcie_sem_lock((a), 5, 0)
1247 #define qlcnic_api_unlock(a)    \
1248         qlcnic_pcie_sem_unlock((a), 5)
1249 #define qlcnic_sw_lock(a)       \
1250         qlcnic_pcie_sem_lock((a), 6, 0)
1251 #define qlcnic_sw_unlock(a)     \
1252         qlcnic_pcie_sem_unlock((a), 6)
1253 #define crb_win_lock(a) \
1254         qlcnic_pcie_sem_lock((a), 7, QLCNIC_CRB_WIN_LOCK_ID)
1255 #define crb_win_unlock(a)       \
1256         qlcnic_pcie_sem_unlock((a), 7)
1257
1258 int qlcnic_get_board_info(struct qlcnic_adapter *adapter);
1259 int qlcnic_wol_supported(struct qlcnic_adapter *adapter);
1260 int qlcnic_config_led(struct qlcnic_adapter *adapter, u32 state, u32 rate);
1261 void qlcnic_prune_lb_filters(struct qlcnic_adapter *adapter);
1262 void qlcnic_delete_lb_filters(struct qlcnic_adapter *adapter);
1263
1264 /* Functions from qlcnic_init.c */
1265 int qlcnic_load_firmware(struct qlcnic_adapter *adapter);
1266 int qlcnic_need_fw_reset(struct qlcnic_adapter *adapter);
1267 void qlcnic_request_firmware(struct qlcnic_adapter *adapter);
1268 void qlcnic_release_firmware(struct qlcnic_adapter *adapter);
1269 int qlcnic_pinit_from_rom(struct qlcnic_adapter *adapter);
1270 int qlcnic_setup_idc_param(struct qlcnic_adapter *adapter);
1271 int qlcnic_check_flash_fw_ver(struct qlcnic_adapter *adapter);
1272
1273 int qlcnic_rom_fast_read(struct qlcnic_adapter *adapter, int addr, int *valp);
1274 int qlcnic_rom_fast_read_words(struct qlcnic_adapter *adapter, int addr,
1275                                 u8 *bytes, size_t size);
1276 int qlcnic_alloc_sw_resources(struct qlcnic_adapter *adapter);
1277 void qlcnic_free_sw_resources(struct qlcnic_adapter *adapter);
1278
1279 void __iomem *qlcnic_get_ioaddr(struct qlcnic_adapter *, u32);
1280
1281 int qlcnic_alloc_hw_resources(struct qlcnic_adapter *adapter);
1282 void qlcnic_free_hw_resources(struct qlcnic_adapter *adapter);
1283
1284 int qlcnic_fw_create_ctx(struct qlcnic_adapter *adapter);
1285 void qlcnic_fw_destroy_ctx(struct qlcnic_adapter *adapter);
1286
1287 void qlcnic_reset_rx_buffers_list(struct qlcnic_adapter *adapter);
1288 void qlcnic_release_rx_buffers(struct qlcnic_adapter *adapter);
1289 void qlcnic_release_tx_buffers(struct qlcnic_adapter *adapter);
1290
1291 int qlcnic_check_fw_status(struct qlcnic_adapter *adapter);
1292 void qlcnic_watchdog_task(struct work_struct *work);
1293 void qlcnic_post_rx_buffers(struct qlcnic_adapter *adapter, u32 ringid,
1294                 struct qlcnic_host_rds_ring *rds_ring);
1295 int qlcnic_process_rcv_ring(struct qlcnic_host_sds_ring *sds_ring, int max);
1296 void qlcnic_set_multi(struct net_device *netdev);
1297 void qlcnic_free_mac_list(struct qlcnic_adapter *adapter);
1298 int qlcnic_nic_set_promisc(struct qlcnic_adapter *adapter, u32);
1299 int qlcnic_config_intr_coalesce(struct qlcnic_adapter *adapter);
1300 int qlcnic_config_rss(struct qlcnic_adapter *adapter, int enable);
1301 int qlcnic_config_ipaddr(struct qlcnic_adapter *adapter, __be32 ip, int cmd);
1302 int qlcnic_linkevent_request(struct qlcnic_adapter *adapter, int enable);
1303 void qlcnic_advert_link_change(struct qlcnic_adapter *adapter, int linkup);
1304
1305 int qlcnic_fw_cmd_set_mtu(struct qlcnic_adapter *adapter, int mtu);
1306 int qlcnic_change_mtu(struct net_device *netdev, int new_mtu);
1307 int qlcnic_config_hw_lro(struct qlcnic_adapter *adapter, int enable);
1308 int qlcnic_config_bridged_mode(struct qlcnic_adapter *adapter, u32 enable);
1309 int qlcnic_send_lro_cleanup(struct qlcnic_adapter *adapter);
1310 void qlcnic_update_cmd_producer(struct qlcnic_adapter *adapter,
1311                 struct qlcnic_host_tx_ring *tx_ring);
1312 void qlcnic_clear_ilb_mode(struct qlcnic_adapter *adapter);
1313 int qlcnic_set_ilb_mode(struct qlcnic_adapter *adapter);
1314 void qlcnic_fetch_mac(struct qlcnic_adapter *, u32, u32, u8, u8 *);
1315
1316 /* Functions from qlcnic_main.c */
1317 int qlcnic_request_quiscent_mode(struct qlcnic_adapter *adapter);
1318 void qlcnic_clear_quiscent_mode(struct qlcnic_adapter *adapter);
1319 int qlcnic_reset_context(struct qlcnic_adapter *);
1320 u32 qlcnic_issue_cmd(struct qlcnic_adapter *adapter,
1321         u32 pci_fn, u32 version, u32 arg1, u32 arg2, u32 arg3, u32 cmd);
1322 void qlcnic_diag_free_res(struct net_device *netdev, int max_sds_rings);
1323 int qlcnic_diag_alloc_res(struct net_device *netdev, int test);
1324 int qlcnic_check_loopback_buff(unsigned char *data);
1325 netdev_tx_t qlcnic_xmit_frame(struct sk_buff *skb, struct net_device *netdev);
1326 void qlcnic_process_rcv_ring_diag(struct qlcnic_host_sds_ring *sds_ring);
1327
1328 /* Management functions */
1329 int qlcnic_get_mac_address(struct qlcnic_adapter *, u8*);
1330 int qlcnic_get_nic_info(struct qlcnic_adapter *, struct qlcnic_info *, u8);
1331 int qlcnic_set_nic_info(struct qlcnic_adapter *, struct qlcnic_info *);
1332 int qlcnic_get_pci_info(struct qlcnic_adapter *, struct qlcnic_pci_info*);
1333
1334 /*  eSwitch management functions */
1335 int qlcnic_config_switch_port(struct qlcnic_adapter *,
1336                                 struct qlcnic_esw_func_cfg *);
1337 int qlcnic_get_eswitch_port_config(struct qlcnic_adapter *,
1338                                 struct qlcnic_esw_func_cfg *);
1339 int qlcnic_config_port_mirroring(struct qlcnic_adapter *, u8, u8, u8);
1340 int qlcnic_get_port_stats(struct qlcnic_adapter *, const u8, const u8,
1341                                         struct __qlcnic_esw_statistics *);
1342 int qlcnic_get_eswitch_stats(struct qlcnic_adapter *, const u8, u8,
1343                                         struct __qlcnic_esw_statistics *);
1344 int qlcnic_clear_esw_stats(struct qlcnic_adapter *adapter, u8, u8, u8);
1345 extern int qlcnic_config_tso;
1346
1347 /*
1348  * QLOGIC Board information
1349  */
1350
1351 #define QLCNIC_MAX_BOARD_NAME_LEN 100
1352 struct qlcnic_brdinfo {
1353         unsigned short  vendor;
1354         unsigned short  device;
1355         unsigned short  sub_vendor;
1356         unsigned short  sub_device;
1357         char short_name[QLCNIC_MAX_BOARD_NAME_LEN];
1358 };
1359
1360 static const struct qlcnic_brdinfo qlcnic_boards[] = {
1361         {0x1077, 0x8020, 0x1077, 0x203,
1362                 "8200 Series Single Port 10GbE Converged Network Adapter "
1363                 "(TCP/IP Networking)"},
1364         {0x1077, 0x8020, 0x1077, 0x207,
1365                 "8200 Series Dual Port 10GbE Converged Network Adapter "
1366                 "(TCP/IP Networking)"},
1367         {0x1077, 0x8020, 0x1077, 0x20b,
1368                 "3200 Series Dual Port 10Gb Intelligent Ethernet Adapter"},
1369         {0x1077, 0x8020, 0x1077, 0x20c,
1370                 "3200 Series Quad Port 1Gb Intelligent Ethernet Adapter"},
1371         {0x1077, 0x8020, 0x1077, 0x20f,
1372                 "3200 Series Single Port 10Gb Intelligent Ethernet Adapter"},
1373         {0x1077, 0x8020, 0x103c, 0x3733,
1374                 "NC523SFP 10Gb 2-port Server Adapter"},
1375         {0x1077, 0x8020, 0x0, 0x0, "cLOM8214 1/10GbE Controller"},
1376 };
1377
1378 #define NUM_SUPPORTED_BOARDS ARRAY_SIZE(qlcnic_boards)
1379
1380 static inline u32 qlcnic_tx_avail(struct qlcnic_host_tx_ring *tx_ring)
1381 {
1382         smp_mb();
1383         if (tx_ring->producer < tx_ring->sw_consumer)
1384                 return tx_ring->sw_consumer - tx_ring->producer;
1385         else
1386                 return tx_ring->sw_consumer + tx_ring->num_desc -
1387                                 tx_ring->producer;
1388 }
1389
1390 extern const struct ethtool_ops qlcnic_ethtool_ops;
1391
1392 struct qlcnic_nic_template {
1393         int (*config_bridged_mode) (struct qlcnic_adapter *, u32);
1394         int (*config_led) (struct qlcnic_adapter *, u32, u32);
1395         int (*start_firmware) (struct qlcnic_adapter *);
1396 };
1397
1398 #define QLCDB(adapter, lvl, _fmt, _args...) do {        \
1399         if (NETIF_MSG_##lvl & adapter->msg_enable)      \
1400                 printk(KERN_INFO "%s: %s: " _fmt,       \
1401                          dev_name(&adapter->pdev->dev), \
1402                         __func__, ##_args);             \
1403         } while (0)
1404
1405 #endif                          /* __QLCNIC_H_ */