drivers/net/netxen/netxen_nic.h

   1 /*
   2  * Copyright (C) 2003 - 2009 NetXen, Inc.
   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 LICENSE.
  22  *
  23  * Contact Information:
  24  *    info@netxen.com
  25  * NetXen Inc,
  26  * 18922 Forge Drive
  27  * Cupertino, CA 95014-0701
  28  *
  29  */
  30
  31 #ifndef _NETXEN_NIC_H_
  32 #define _NETXEN_NIC_H_
  33
  34 #include <linux/module.h>
  35 #include <linux/kernel.h>
  36 #include <linux/types.h>
  37 #include <linux/ioport.h>
  38 #include <linux/pci.h>
  39 #include <linux/netdevice.h>
  40 #include <linux/etherdevice.h>
  41 #include <linux/ip.h>
  42 #include <linux/in.h>
  43 #include <linux/tcp.h>
  44 #include <linux/skbuff.h>
  45 #include <linux/firmware.h>
  46
  47 #include <linux/ethtool.h>
  48 #include <linux/mii.h>
  49 #include <linux/timer.h>
  50
  51 #include <linux/vmalloc.h>
  52
  53 #include <asm/io.h>
  54 #include <asm/byteorder.h>
  55
  56 #include "netxen_nic_hdr.h"
  57 #include "netxen_nic_hw.h"
  58
  59 #define _NETXEN_NIC_LINUX_MAJOR 4
  60 #define _NETXEN_NIC_LINUX_MINOR 0
  61 #define _NETXEN_NIC_LINUX_SUBVERSION 50
  62 #define NETXEN_NIC_LINUX_VERSIONID  "4.0.50"
  63
  64 #define NETXEN_VERSION_CODE(a, b, c)    (((a) << 24) + ((b) << 16) + (c))
  65 #define _major(v)       (((v) >> 24) & 0xff)
  66 #define _minor(v)       (((v) >> 16) & 0xff)
  67 #define _build(v)       ((v) & 0xffff)
  68
  69 /* version in image has weird encoding:
  70  *  7:0  - major
  71  * 15:8  - minor
  72  * 31:16 - build (little endian)
  73  */
  74 #define NETXEN_DECODE_VERSION(v) \
  75         NETXEN_VERSION_CODE(((v) & 0xff), (((v) >> 8) & 0xff), ((v) >> 16))
  76
  77 #define NETXEN_NUM_FLASH_SECTORS (64)
  78 #define NETXEN_FLASH_SECTOR_SIZE (64 * 1024)
  79 #define NETXEN_FLASH_TOTAL_SIZE  (NETXEN_NUM_FLASH_SECTORS \
  80                                         * NETXEN_FLASH_SECTOR_SIZE)
  81
  82 #define PHAN_VENDOR_ID 0x4040
  83
  84 #define RCV_DESC_RINGSIZE(rds_ring)     \
  85         (sizeof(struct rcv_desc) * (rds_ring)->num_desc)
  86 #define RCV_BUFF_RINGSIZE(rds_ring)     \
  87         (sizeof(struct netxen_rx_buffer) * rds_ring->num_desc)
  88 #define STATUS_DESC_RINGSIZE(sds_ring)  \
  89         (sizeof(struct status_desc) * (sds_ring)->num_desc)
  90 #define TX_BUFF_RINGSIZE(tx_ring)       \
  91         (sizeof(struct netxen_cmd_buffer) * tx_ring->num_desc)
  92 #define TX_DESC_RINGSIZE(tx_ring)       \
  93         (sizeof(struct cmd_desc_type0) * tx_ring->num_desc)
  94
  95 #define find_diff_among(a,b,range) ((a)<(b)?((b)-(a)):((b)+(range)-(a)))
  96
  97 #define NETXEN_RCV_PRODUCER_OFFSET      0
  98 #define NETXEN_RCV_PEG_DB_ID            2
  99 #define NETXEN_HOST_DUMMY_DMA_SIZE 1024
 100 #define FLASH_SUCCESS 0
 101
 102 #define ADDR_IN_WINDOW1(off)    \
 103         ((off > NETXEN_CRB_PCIX_HOST2) && (off < NETXEN_CRB_MAX)) ? 1 : 0
 104
 105 /*
 106  * normalize a 64MB crb address to 32MB PCI window
 107  * To use NETXEN_CRB_NORMALIZE, window _must_ be set to 1
 108  */
 109 #define NETXEN_CRB_NORMAL(reg)  \
 110         ((reg) - NETXEN_CRB_PCIX_HOST2 + NETXEN_CRB_PCIX_HOST)
 111
 112 #define NETXEN_CRB_NORMALIZE(adapter, reg) \
 113         pci_base_offset(adapter, NETXEN_CRB_NORMAL(reg))
 114
 115 #define DB_NORMALIZE(adapter, off) \
 116         (adapter->ahw.db_base + (off))
 117
 118 #define NX_P2_C0                0x24
 119 #define NX_P2_C1                0x25
 120 #define NX_P3_A0                0x30
 121 #define NX_P3_A2                0x30
 122 #define NX_P3_B0                0x40
 123 #define NX_P3_B1                0x41
 124 #define NX_P3_B2                0x42
 125
 126 #define NX_IS_REVISION_P2(REVISION)     (REVISION <= NX_P2_C1)
 127 #define NX_IS_REVISION_P3(REVISION)     (REVISION >= NX_P3_A0)
 128
 129 #define FIRST_PAGE_GROUP_START  0
 130 #define FIRST_PAGE_GROUP_END    0x100000
 131
 132 #define SECOND_PAGE_GROUP_START 0x6000000
 133 #define SECOND_PAGE_GROUP_END   0x68BC000
 134
 135 #define THIRD_PAGE_GROUP_START  0x70E4000
 136 #define THIRD_PAGE_GROUP_END    0x8000000
 137
 138 #define FIRST_PAGE_GROUP_SIZE  FIRST_PAGE_GROUP_END - FIRST_PAGE_GROUP_START
 139 #define SECOND_PAGE_GROUP_SIZE SECOND_PAGE_GROUP_END - SECOND_PAGE_GROUP_START
 140 #define THIRD_PAGE_GROUP_SIZE  THIRD_PAGE_GROUP_END - THIRD_PAGE_GROUP_START
 141
 142 #define P2_MAX_MTU                     (8000)
 143 #define P3_MAX_MTU                     (9600)
 144 #define NX_ETHERMTU                    1500
 145 #define NX_MAX_ETHERHDR                32 /* This contains some padding */
 146
 147 #define NX_P2_RX_BUF_MAX_LEN           1760
 148 #define NX_P3_RX_BUF_MAX_LEN           (NX_MAX_ETHERHDR + NX_ETHERMTU)
 149 #define NX_P2_RX_JUMBO_BUF_MAX_LEN     (NX_MAX_ETHERHDR + P2_MAX_MTU)
 150 #define NX_P3_RX_JUMBO_BUF_MAX_LEN     (NX_MAX_ETHERHDR + P3_MAX_MTU)
 151 #define NX_CT_DEFAULT_RX_BUF_LEN        2048
 152 #define NX_LRO_BUFFER_EXTRA             2048
 153
 154 #define NX_RX_LRO_BUFFER_LENGTH         (8060)
 155
 156 /*
 157  * Maximum number of ring contexts
 158  */
 159 #define MAX_RING_CTX 1
 160
 161 /* Opcodes to be used with the commands */
 162 #define TX_ETHER_PKT    0x01
 163 #define TX_TCP_PKT      0x02
 164 #define TX_UDP_PKT      0x03
 165 #define TX_IP_PKT       0x04
 166 #define TX_TCP_LSO      0x05
 167 #define TX_TCP_LSO6     0x06
 168 #define TX_IPSEC        0x07
 169 #define TX_IPSEC_CMD    0x0a
 170 #define TX_TCPV6_PKT    0x0b
 171 #define TX_UDPV6_PKT    0x0c
 172
 173 /* The following opcodes are for internal consumption. */
 174 #define NETXEN_CONTROL_OP       0x10
 175 #define PEGNET_REQUEST          0x11
 176
 177 #define MAX_NUM_CARDS           4
 178
 179 #define MAX_BUFFERS_PER_CMD     32
 180 #define TX_STOP_THRESH          ((MAX_SKB_FRAGS >> 2) + 4)
 181
 182 /*
 183  * Following are the states of the Phantom. Phantom will set them and
 184  * Host will read to check if the fields are correct.
 185  */
 186 #define PHAN_INITIALIZE_START           0xff00
 187 #define PHAN_INITIALIZE_FAILED          0xffff
 188 #define PHAN_INITIALIZE_COMPLETE        0xff01
 189
 190 /* Host writes the following to notify that it has done the init-handshake */
 191 #define PHAN_INITIALIZE_ACK     0xf00f
 192
 193 #define NUM_RCV_DESC_RINGS      3
 194 #define NUM_STS_DESC_RINGS      4
 195
 196 #define RCV_RING_NORMAL 0
 197 #define RCV_RING_JUMBO  1
 198 #define RCV_RING_LRO    2
 199
 200 #define MIN_CMD_DESCRIPTORS             64
 201 #define MIN_RCV_DESCRIPTORS             64
 202 #define MIN_JUMBO_DESCRIPTORS           32
 203
 204 #define MAX_CMD_DESCRIPTORS             1024
 205 #define MAX_RCV_DESCRIPTORS_1G          4096
 206 #define MAX_RCV_DESCRIPTORS_10G         8192
 207 #define MAX_JUMBO_RCV_DESCRIPTORS_1G    512
 208 #define MAX_JUMBO_RCV_DESCRIPTORS_10G   1024
 209 #define MAX_LRO_RCV_DESCRIPTORS         8
 210
 211 #define DEFAULT_RCV_DESCRIPTORS_1G      2048
 212 #define DEFAULT_RCV_DESCRIPTORS_10G     4096
 213
 214 #define NETXEN_CTX_SIGNATURE    0xdee0
 215 #define NETXEN_CTX_SIGNATURE_V2 0x0002dee0
 216 #define NETXEN_CTX_RESET        0xbad0
 217 #define NETXEN_CTX_D3_RESET     0xacc0
 218 #define NETXEN_RCV_PRODUCER(ringid)     (ringid)
 219
 220 #define PHAN_PEG_RCV_INITIALIZED        0xff01
 221 #define PHAN_PEG_RCV_START_INITIALIZE   0xff00
 222
 223 #define get_next_index(index, length)   \
 224         (((index) + 1) & ((length) - 1))
 225
 226 #define get_index_range(index,length,count)     \
 227         (((index) + (count)) & ((length) - 1))
 228
 229 #define MPORT_SINGLE_FUNCTION_MODE 0x1111
 230 #define MPORT_MULTI_FUNCTION_MODE 0x2222
 231
 232 #define NX_MAX_PCI_FUNC         8
 233
 234 /*
 235  * NetXen host-peg signal message structure
 236  *
 237  *      Bit 0-1         : peg_id => 0x2 for tx and 01 for rx
 238  *      Bit 2           : priv_id => must be 1
 239  *      Bit 3-17        : count => for doorbell
 240  *      Bit 18-27       : ctx_id => Context id
 241  *      Bit 28-31       : opcode
 242  */
 243
 244 typedef u32 netxen_ctx_msg;
 245
 246 #define netxen_set_msg_peg_id(config_word, val) \
 247         ((config_word) &= ~3, (config_word) |= val & 3)
 248 #define netxen_set_msg_privid(config_word)      \
 249         ((config_word) |= 1 << 2)
 250 #define netxen_set_msg_count(config_word, val)  \
 251         ((config_word) &= ~(0x7fff<<3), (config_word) |= (val & 0x7fff) << 3)
 252 #define netxen_set_msg_ctxid(config_word, val)  \
 253         ((config_word) &= ~(0x3ff<<18), (config_word) |= (val & 0x3ff) << 18)
 254 #define netxen_set_msg_opcode(config_word, val) \
 255         ((config_word) &= ~(0xf<<28), (config_word) |= (val & 0xf) << 28)
 256
 257 struct netxen_rcv_ring {
 258         __le64 addr;
 259         __le32 size;
 260         __le32 rsrvd;
 261 };
 262
 263 struct netxen_sts_ring {
 264         __le64 addr;
 265         __le32 size;
 266         __le16 msi_index;
 267         __le16 rsvd;
 268 } ;
 269
 270 struct netxen_ring_ctx {
 271
 272         /* one command ring */
 273         __le64 cmd_consumer_offset;
 274         __le64 cmd_ring_addr;
 275         __le32 cmd_ring_size;
 276         __le32 rsrvd;
 277
 278         /* three receive rings */
 279         struct netxen_rcv_ring rcv_rings[NUM_RCV_DESC_RINGS];
 280
 281         __le64 sts_ring_addr;
 282         __le32 sts_ring_size;
 283
 284         __le32 ctx_id;
 285
 286         __le64 rsrvd_2[3];
 287         __le32 sts_ring_count;
 288         __le32 rsrvd_3;
 289         struct netxen_sts_ring sts_rings[NUM_STS_DESC_RINGS];
 290
 291 } __attribute__ ((aligned(64)));
 292
 293 /*
 294  * Following data structures describe the descriptors that will be used.
 295  * Added fileds of tcpHdrSize and ipHdrSize, The driver needs to do it only when
 296  * we are doing LSO (above the 1500 size packet) only.
 297  */
 298
 299 /*
 300  * The size of reference handle been changed to 16 bits to pass the MSS fields
 301  * for the LSO packet
 302  */
 303
 304 #define FLAGS_CHECKSUM_ENABLED  0x01
 305 #define FLAGS_LSO_ENABLED       0x02
 306 #define FLAGS_IPSEC_SA_ADD      0x04
 307 #define FLAGS_IPSEC_SA_DELETE   0x08
 308 #define FLAGS_VLAN_TAGGED       0x10
 309 #define FLAGS_VLAN_OOB          0x40
 310
 311 #define netxen_set_tx_vlan_tci(cmd_desc, v)     \
 312         (cmd_desc)->vlan_TCI = cpu_to_le16(v);
 313
 314 #define netxen_set_cmd_desc_port(cmd_desc, var) \
 315         ((cmd_desc)->port_ctxid |= ((var) & 0x0F))
 316 #define netxen_set_cmd_desc_ctxid(cmd_desc, var)        \
 317         ((cmd_desc)->port_ctxid |= ((var) << 4 & 0xF0))
 318
 319 #define netxen_set_tx_port(_desc, _port) \
 320         (_desc)->port_ctxid = ((_port) & 0xf) | (((_port) << 4) & 0xf0)
 321
 322 #define netxen_set_tx_flags_opcode(_desc, _flags, _opcode) \
 323         (_desc)->flags_opcode = \
 324         cpu_to_le16(((_flags) & 0x7f) | (((_opcode) & 0x3f) << 7))
 325
 326 #define netxen_set_tx_frags_len(_desc, _frags, _len) \
 327         (_desc)->nfrags__length = \
 328         cpu_to_le32(((_frags) & 0xff) | (((_len) & 0xffffff) << 8))
 329
 330 struct cmd_desc_type0 {
 331         u8 tcp_hdr_offset;      /* For LSO only */
 332         u8 ip_hdr_offset;       /* For LSO only */
 333         __le16 flags_opcode;    /* 15:13 unused, 12:7 opcode, 6:0 flags */
 334         __le32 nfrags__length;  /* 31:8 total len, 7:0 frag count */
 335
 336         __le64 addr_buffer2;
 337
 338         __le16 reference_handle;
 339         __le16 mss;
 340         u8 port_ctxid;          /* 7:4 ctxid 3:0 port */
 341         u8 total_hdr_length;    /* LSO only : MAC+IP+TCP Hdr size */
 342         __le16 conn_id;         /* IPSec offoad only */
 343
 344         __le64 addr_buffer3;
 345         __le64 addr_buffer1;
 346
 347         __le16 buffer_length[4];
 348
 349         __le64 addr_buffer4;
 350
 351         __le32 reserved2;
 352         __le16 reserved;
 353         __le16 vlan_TCI;
 354
 355 } __attribute__ ((aligned(64)));
 356
 357 /* Note: sizeof(rcv_desc) should always be a mutliple of 2 */
 358 struct rcv_desc {
 359         __le16 reference_handle;
 360         __le16 reserved;
 361         __le32 buffer_length;   /* allocated buffer length (usually 2K) */
 362         __le64 addr_buffer;
 363 };
 364
 365 /* opcode field in status_desc */
 366 #define NETXEN_NIC_SYN_OFFLOAD  0x03
 367 #define NETXEN_NIC_RXPKT_DESC  0x04
 368 #define NETXEN_OLD_RXPKT_DESC  0x3f
 369 #define NETXEN_NIC_RESPONSE_DESC 0x05
 370 #define NETXEN_NIC_LRO_DESC     0x12
 371
 372 /* for status field in status_desc */
 373 #define STATUS_NEED_CKSUM       (1)
 374 #define STATUS_CKSUM_OK         (2)
 375
 376 /* owner bits of status_desc */
 377 #define STATUS_OWNER_HOST       (0x1ULL << 56)
 378 #define STATUS_OWNER_PHANTOM    (0x2ULL << 56)
 379
 380 /* Status descriptor:
 381    0-3 port, 4-7 status, 8-11 type, 12-27 total_length
 382    28-43 reference_handle, 44-47 protocol, 48-52 pkt_offset
 383    53-55 desc_cnt, 56-57 owner, 58-63 opcode
 384  */
 385 #define netxen_get_sts_port(sts_data)   \
 386         ((sts_data) & 0x0F)
 387 #define netxen_get_sts_status(sts_data) \
 388         (((sts_data) >> 4) & 0x0F)
 389 #define netxen_get_sts_type(sts_data)   \
 390         (((sts_data) >> 8) & 0x0F)
 391 #define netxen_get_sts_totallength(sts_data)    \
 392         (((sts_data) >> 12) & 0xFFFF)
 393 #define netxen_get_sts_refhandle(sts_data)      \
 394         (((sts_data) >> 28) & 0xFFFF)
 395 #define netxen_get_sts_prot(sts_data)   \
 396         (((sts_data) >> 44) & 0x0F)
 397 #define netxen_get_sts_pkt_offset(sts_data)     \
 398         (((sts_data) >> 48) & 0x1F)
 399 #define netxen_get_sts_desc_cnt(sts_data)       \
 400         (((sts_data) >> 53) & 0x7)
 401 #define netxen_get_sts_opcode(sts_data) \
 402         (((sts_data) >> 58) & 0x03F)
 403
 404 #define netxen_get_lro_sts_refhandle(sts_data)  \
 405         ((sts_data) & 0x0FFFF)
 406 #define netxen_get_lro_sts_length(sts_data)     \
 407         (((sts_data) >> 16) & 0x0FFFF)
 408 #define netxen_get_lro_sts_l2_hdr_offset(sts_data)      \
 409         (((sts_data) >> 32) & 0x0FF)
 410 #define netxen_get_lro_sts_l4_hdr_offset(sts_data)      \
 411         (((sts_data) >> 40) & 0x0FF)
 412 #define netxen_get_lro_sts_timestamp(sts_data)  \
 413         (((sts_data) >> 48) & 0x1)
 414 #define netxen_get_lro_sts_type(sts_data)       \
 415         (((sts_data) >> 49) & 0x7)
 416 #define netxen_get_lro_sts_push_flag(sts_data)          \
 417         (((sts_data) >> 52) & 0x1)
 418 #define netxen_get_lro_sts_seq_number(sts_data)         \
 419         ((sts_data) & 0x0FFFFFFFF)
 420
 421
 422 struct status_desc {
 423         __le64 status_desc_data[2];
 424 } __attribute__ ((aligned(16)));
 425
 426 /* The version of the main data structure */
 427 #define NETXEN_BDINFO_VERSION 1
 428
 429 /* Magic number to let user know flash is programmed */
 430 #define NETXEN_BDINFO_MAGIC 0x12345678
 431
 432 /* Max number of Gig ports on a Phantom board */
 433 #define NETXEN_MAX_PORTS 4
 434
 435 #define NETXEN_BRDTYPE_P1_BD            0x0000
 436 #define NETXEN_BRDTYPE_P1_SB            0x0001
 437 #define NETXEN_BRDTYPE_P1_SMAX          0x0002
 438 #define NETXEN_BRDTYPE_P1_SOCK          0x0003
 439
 440 #define NETXEN_BRDTYPE_P2_SOCK_31       0x0008
 441 #define NETXEN_BRDTYPE_P2_SOCK_35       0x0009
 442 #define NETXEN_BRDTYPE_P2_SB35_4G       0x000a
 443 #define NETXEN_BRDTYPE_P2_SB31_10G      0x000b
 444 #define NETXEN_BRDTYPE_P2_SB31_2G       0x000c
 445
 446 #define NETXEN_BRDTYPE_P2_SB31_10G_IMEZ         0x000d
 447 #define NETXEN_BRDTYPE_P2_SB31_10G_HMEZ         0x000e
 448 #define NETXEN_BRDTYPE_P2_SB31_10G_CX4          0x000f
 449
 450 #define NETXEN_BRDTYPE_P3_REF_QG        0x0021
 451 #define NETXEN_BRDTYPE_P3_HMEZ          0x0022
 452 #define NETXEN_BRDTYPE_P3_10G_CX4_LP    0x0023
 453 #define NETXEN_BRDTYPE_P3_4_GB          0x0024
 454 #define NETXEN_BRDTYPE_P3_IMEZ          0x0025
 455 #define NETXEN_BRDTYPE_P3_10G_SFP_PLUS  0x0026
 456 #define NETXEN_BRDTYPE_P3_10000_BASE_T  0x0027
 457 #define NETXEN_BRDTYPE_P3_XG_LOM        0x0028
 458 #define NETXEN_BRDTYPE_P3_4_GB_MM       0x0029
 459 #define NETXEN_BRDTYPE_P3_10G_SFP_CT    0x002a
 460 #define NETXEN_BRDTYPE_P3_10G_SFP_QT    0x002b
 461 #define NETXEN_BRDTYPE_P3_10G_CX4       0x0031
 462 #define NETXEN_BRDTYPE_P3_10G_XFP       0x0032
 463 #define NETXEN_BRDTYPE_P3_10G_TP        0x0080
 464
 465 /* Flash memory map */
 466 #define NETXEN_CRBINIT_START    0       /* crbinit section */
 467 #define NETXEN_BRDCFG_START     0x4000  /* board config */
 468 #define NETXEN_INITCODE_START   0x6000  /* pegtune code */
 469 #define NETXEN_BOOTLD_START     0x10000 /* bootld */
 470 #define NETXEN_IMAGE_START      0x43000 /* compressed image */
 471 #define NETXEN_SECONDARY_START  0x200000        /* backup images */
 472 #define NETXEN_PXE_START        0x3E0000        /* PXE boot rom */
 473 #define NETXEN_USER_START       0x3E8000        /* Firmare info */
 474 #define NETXEN_FIXED_START      0x3F0000        /* backup of crbinit */
 475 #define NETXEN_USER_START_OLD   NETXEN_PXE_START /* very old flash */
 476
 477 #define NX_OLD_MAC_ADDR_OFFSET  (NETXEN_USER_START)
 478 #define NX_FW_VERSION_OFFSET    (NETXEN_USER_START+0x408)
 479 #define NX_FW_SIZE_OFFSET       (NETXEN_USER_START+0x40c)
 480 #define NX_FW_MAC_ADDR_OFFSET   (NETXEN_USER_START+0x418)
 481 #define NX_FW_SERIAL_NUM_OFFSET (NETXEN_USER_START+0x81c)
 482 #define NX_BIOS_VERSION_OFFSET  (NETXEN_USER_START+0x83c)
 483
 484 #define NX_HDR_VERSION_OFFSET   (NETXEN_BRDCFG_START)
 485 #define NX_BRDTYPE_OFFSET       (NETXEN_BRDCFG_START+0x8)
 486 #define NX_FW_MAGIC_OFFSET      (NETXEN_BRDCFG_START+0x128)
 487
 488 #define NX_FW_MIN_SIZE          (0x3fffff)
 489 #define NX_P2_MN_ROMIMAGE       0
 490 #define NX_P3_CT_ROMIMAGE       1
 491 #define NX_P3_MN_ROMIMAGE       2
 492 #define NX_FLASH_ROMIMAGE       3
 493
 494 extern char netxen_nic_driver_name[];
 495
 496 /* Number of status descriptors to handle per interrupt */
 497 #define MAX_STATUS_HANDLE       (64)
 498
 499 /*
 500  * netxen_skb_frag{} is to contain mapping info for each SG list. This
 501  * has to be freed when DMA is complete. This is part of netxen_tx_buffer{}.
 502  */
 503 struct netxen_skb_frag {
 504         u64 dma;
 505         u64 length;
 506 };
 507
 508 struct netxen_recv_crb {
 509         u32 crb_rcv_producer[NUM_RCV_DESC_RINGS];
 510         u32 crb_sts_consumer[NUM_STS_DESC_RINGS];
 511         u32 sw_int_mask[NUM_STS_DESC_RINGS];
 512 };
 513
 514 /*    Following defines are for the state of the buffers    */
 515 #define NETXEN_BUFFER_FREE      0
 516 #define NETXEN_BUFFER_BUSY      1
 517
 518 /*
 519  * There will be one netxen_buffer per skb packet.    These will be
 520  * used to save the dma info for pci_unmap_page()
 521  */
 522 struct netxen_cmd_buffer {
 523         struct sk_buff *skb;
 524         struct netxen_skb_frag frag_array[MAX_BUFFERS_PER_CMD + 1];
 525         u32 frag_count;
 526 };
 527
 528 /* In rx_buffer, we do not need multiple fragments as is a single buffer */
 529 struct netxen_rx_buffer {
 530         struct list_head list;
 531         struct sk_buff *skb;
 532         u64 dma;
 533         u16 ref_handle;
 534         u16 state;
 535 };
 536
 537 /* Board types */
 538 #define NETXEN_NIC_GBE  0x01
 539 #define NETXEN_NIC_XGBE 0x02
 540
 541 /*
 542  * One hardware_context{} per adapter
 543  * contains interrupt info as well shared hardware info.
 544  */
 545 struct netxen_hardware_context {
 546         void __iomem *pci_base0;
 547         void __iomem *pci_base1;
 548         void __iomem *pci_base2;
 549         void __iomem *db_base;
 550         unsigned long db_len;
 551         unsigned long pci_len0;
 552
 553         int qdr_sn_window;
 554         int ddr_mn_window;
 555         u32 mn_win_crb;
 556         u32 ms_win_crb;
 557
 558         u8 cut_through;
 559         u8 revision_id;
 560         u8 pci_func;
 561         u8 linkup;
 562         u16 port_type;
 563         u16 board_type;
 564 };
 565
 566 #define MINIMUM_ETHERNET_FRAME_SIZE     64      /* With FCS */
 567 #define ETHERNET_FCS_SIZE               4
 568
 569 struct netxen_adapter_stats {
 570         u64  xmitcalled;
 571         u64  xmitfinished;
 572         u64  rxdropped;
 573         u64  txdropped;
 574         u64  csummed;
 575         u64  rx_pkts;
 576         u64  lro_pkts;
 577         u64  rxbytes;
 578         u64  txbytes;
 579 };
 580
 581 /*
 582  * Rcv Descriptor Context. One such per Rcv Descriptor. There may
 583  * be one Rcv Descriptor for normal packets, one for jumbo and may be others.
 584  */
 585 struct nx_host_rds_ring {
 586         u32 producer;
 587         u32 num_desc;
 588         u32 dma_size;
 589         u32 skb_size;
 590         u32 flags;
 591         void __iomem *crb_rcv_producer;
 592         struct rcv_desc *desc_head;
 593         struct netxen_rx_buffer *rx_buf_arr;
 594         struct list_head free_list;
 595         spinlock_t lock;
 596         dma_addr_t phys_addr;
 597 };
 598
 599 struct nx_host_sds_ring {
 600         u32 consumer;
 601         u32 num_desc;
 602         void __iomem *crb_sts_consumer;
 603         void __iomem *crb_intr_mask;
 604
 605         struct status_desc *desc_head;
 606         struct netxen_adapter *adapter;
 607         struct napi_struct napi;
 608         struct list_head free_list[NUM_RCV_DESC_RINGS];
 609
 610         int irq;
 611
 612         dma_addr_t phys_addr;
 613         char name[IFNAMSIZ+4];
 614 };
 615
 616 struct nx_host_tx_ring {
 617         u32 producer;
 618         __le32 *hw_consumer;
 619         u32 sw_consumer;
 620         void __iomem *crb_cmd_producer;
 621         void __iomem *crb_cmd_consumer;
 622         u32 num_desc;
 623
 624         struct netdev_queue *txq;
 625
 626         struct netxen_cmd_buffer *cmd_buf_arr;
 627         struct cmd_desc_type0 *desc_head;
 628         dma_addr_t phys_addr;
 629 };
 630
 631 /*
 632  * Receive context. There is one such structure per instance of the
 633  * receive processing. Any state information that is relevant to
 634  * the receive, and is must be in this structure. The global data may be
 635  * present elsewhere.
 636  */
 637 struct netxen_recv_context {
 638         u32 state;
 639         u16 context_id;
 640         u16 virt_port;
 641
 642         struct nx_host_rds_ring *rds_rings;
 643         struct nx_host_sds_ring *sds_rings;
 644
 645         struct netxen_ring_ctx *hwctx;
 646         dma_addr_t phys_addr;
 647 };
 648
 649 /* New HW context creation */
 650
 651 #define NX_OS_CRB_RETRY_COUNT   4000
 652 #define NX_CDRP_SIGNATURE_MAKE(pcifn, version) \
 653         (((pcifn) & 0xff) | (((version) & 0xff) << 8) | (0xcafe << 16))
 654
 655 #define NX_CDRP_CLEAR           0x00000000
 656 #define NX_CDRP_CMD_BIT         0x80000000
 657
 658 /*
 659  * All responses must have the NX_CDRP_CMD_BIT cleared
 660  * in the crb NX_CDRP_CRB_OFFSET.
 661  */
 662 #define NX_CDRP_FORM_RSP(rsp)   (rsp)
 663 #define NX_CDRP_IS_RSP(rsp)     (((rsp) & NX_CDRP_CMD_BIT) == 0)
 664
 665 #define NX_CDRP_RSP_OK          0x00000001
 666 #define NX_CDRP_RSP_FAIL        0x00000002
 667 #define NX_CDRP_RSP_TIMEOUT     0x00000003
 668
 669 /*
 670  * All commands must have the NX_CDRP_CMD_BIT set in
 671  * the crb NX_CDRP_CRB_OFFSET.
 672  */
 673 #define NX_CDRP_FORM_CMD(cmd)   (NX_CDRP_CMD_BIT | (cmd))
 674 #define NX_CDRP_IS_CMD(cmd)     (((cmd) & NX_CDRP_CMD_BIT) != 0)
 675
 676 #define NX_CDRP_CMD_SUBMIT_CAPABILITIES     0x00000001
 677 #define NX_CDRP_CMD_READ_MAX_RDS_PER_CTX    0x00000002
 678 #define NX_CDRP_CMD_READ_MAX_SDS_PER_CTX    0x00000003
 679 #define NX_CDRP_CMD_READ_MAX_RULES_PER_CTX  0x00000004
 680 #define NX_CDRP_CMD_READ_MAX_RX_CTX         0x00000005
 681 #define NX_CDRP_CMD_READ_MAX_TX_CTX         0x00000006
 682 #define NX_CDRP_CMD_CREATE_RX_CTX           0x00000007
 683 #define NX_CDRP_CMD_DESTROY_RX_CTX          0x00000008
 684 #define NX_CDRP_CMD_CREATE_TX_CTX           0x00000009
 685 #define NX_CDRP_CMD_DESTROY_TX_CTX          0x0000000a
 686 #define NX_CDRP_CMD_SETUP_STATISTICS        0x0000000e
 687 #define NX_CDRP_CMD_GET_STATISTICS          0x0000000f
 688 #define NX_CDRP_CMD_DELETE_STATISTICS       0x00000010
 689 #define NX_CDRP_CMD_SET_MTU                 0x00000012
 690 #define NX_CDRP_CMD_READ_PHY                    0x00000013
 691 #define NX_CDRP_CMD_WRITE_PHY                   0x00000014
 692 #define NX_CDRP_CMD_READ_HW_REG                 0x00000015
 693 #define NX_CDRP_CMD_GET_FLOW_CTL                0x00000016
 694 #define NX_CDRP_CMD_SET_FLOW_CTL                0x00000017
 695 #define NX_CDRP_CMD_READ_MAX_MTU                0x00000018
 696 #define NX_CDRP_CMD_READ_MAX_LRO                0x00000019
 697 #define NX_CDRP_CMD_CONFIGURE_TOE               0x0000001a
 698 #define NX_CDRP_CMD_FUNC_ATTRIB                 0x0000001b
 699 #define NX_CDRP_CMD_READ_PEXQ_PARAMETERS        0x0000001c
 700 #define NX_CDRP_CMD_GET_LIC_CAPABILITIES        0x0000001d
 701 #define NX_CDRP_CMD_READ_MAX_LRO_PER_BOARD      0x0000001e
 702 #define NX_CDRP_CMD_MAX                         0x0000001f
 703
 704 #define NX_RCODE_SUCCESS                0
 705 #define NX_RCODE_NO_HOST_MEM            1
 706 #define NX_RCODE_NO_HOST_RESOURCE       2
 707 #define NX_RCODE_NO_CARD_CRB            3
 708 #define NX_RCODE_NO_CARD_MEM            4
 709 #define NX_RCODE_NO_CARD_RESOURCE       5
 710 #define NX_RCODE_INVALID_ARGS           6
 711 #define NX_RCODE_INVALID_ACTION         7
 712 #define NX_RCODE_INVALID_STATE          8
 713 #define NX_RCODE_NOT_SUPPORTED          9
 714 #define NX_RCODE_NOT_PERMITTED          10
 715 #define NX_RCODE_NOT_READY              11
 716 #define NX_RCODE_DOES_NOT_EXIST         12
 717 #define NX_RCODE_ALREADY_EXISTS         13
 718 #define NX_RCODE_BAD_SIGNATURE          14
 719 #define NX_RCODE_CMD_NOT_IMPL           15
 720 #define NX_RCODE_CMD_INVALID            16
 721 #define NX_RCODE_TIMEOUT                17
 722 #define NX_RCODE_CMD_FAILED             18
 723 #define NX_RCODE_MAX_EXCEEDED           19
 724 #define NX_RCODE_MAX                    20
 725
 726 #define NX_DESTROY_CTX_RESET            0
 727 #define NX_DESTROY_CTX_D3_RESET         1
 728 #define NX_DESTROY_CTX_MAX              2
 729
 730 /*
 731  * Capabilities
 732  */
 733 #define NX_CAP_BIT(class, bit)          (1 << bit)
 734 #define NX_CAP0_LEGACY_CONTEXT          NX_CAP_BIT(0, 0)
 735 #define NX_CAP0_MULTI_CONTEXT           NX_CAP_BIT(0, 1)
 736 #define NX_CAP0_LEGACY_MN               NX_CAP_BIT(0, 2)
 737 #define NX_CAP0_LEGACY_MS               NX_CAP_BIT(0, 3)
 738 #define NX_CAP0_CUT_THROUGH             NX_CAP_BIT(0, 4)
 739 #define NX_CAP0_LRO                     NX_CAP_BIT(0, 5)
 740 #define NX_CAP0_LSO                     NX_CAP_BIT(0, 6)
 741 #define NX_CAP0_JUMBO_CONTIGUOUS        NX_CAP_BIT(0, 7)
 742 #define NX_CAP0_LRO_CONTIGUOUS          NX_CAP_BIT(0, 8)
 743 #define NX_CAP0_HW_LRO                  NX_CAP_BIT(0, 10)
 744
 745 /*
 746  * Context state
 747  */
 748 #define NX_HOST_CTX_STATE_FREED         0
 749 #define NX_HOST_CTX_STATE_ALLOCATED     1
 750 #define NX_HOST_CTX_STATE_ACTIVE        2
 751 #define NX_HOST_CTX_STATE_DISABLED      3
 752 #define NX_HOST_CTX_STATE_QUIESCED      4
 753 #define NX_HOST_CTX_STATE_MAX           5
 754
 755 /*
 756  * Rx context
 757  */
 758
 759 typedef struct {
 760         __le64 host_phys_addr;  /* Ring base addr */
 761         __le32 ring_size;               /* Ring entries */
 762         __le16 msi_index;
 763         __le16 rsvd;            /* Padding */
 764 } nx_hostrq_sds_ring_t;
 765
 766 typedef struct {
 767         __le64 host_phys_addr;  /* Ring base addr */
 768         __le64 buff_size;               /* Packet buffer size */
 769         __le32 ring_size;               /* Ring entries */
 770         __le32 ring_kind;               /* Class of ring */
 771 } nx_hostrq_rds_ring_t;
 772
 773 typedef struct {
 774         __le64 host_rsp_dma_addr;       /* Response dma'd here */
 775         __le32 capabilities[4]; /* Flag bit vector */
 776         __le32 host_int_crb_mode;       /* Interrupt crb usage */
 777         __le32 host_rds_crb_mode;       /* RDS crb usage */
 778         /* These ring offsets are relative to data[0] below */
 779         __le32 rds_ring_offset; /* Offset to RDS config */
 780         __le32 sds_ring_offset; /* Offset to SDS config */
 781         __le16 num_rds_rings;   /* Count of RDS rings */
 782         __le16 num_sds_rings;   /* Count of SDS rings */
 783         __le16 rsvd1;           /* Padding */
 784         __le16 rsvd2;           /* Padding */
 785         u8  reserved[128];      /* reserve space for future expansion*/
 786         /* MUST BE 64-bit aligned.
 787            The following is packed:
 788            - N hostrq_rds_rings
 789            - N hostrq_sds_rings */
 790         char data[0];
 791 } nx_hostrq_rx_ctx_t;
 792
 793 typedef struct {
 794         __le32 host_producer_crb;       /* Crb to use */
 795         __le32 rsvd1;           /* Padding */
 796 } nx_cardrsp_rds_ring_t;
 797
 798 typedef struct {
 799         __le32 host_consumer_crb;       /* Crb to use */
 800         __le32 interrupt_crb;   /* Crb to use */
 801 } nx_cardrsp_sds_ring_t;
 802
 803 typedef struct {
 804         /* These ring offsets are relative to data[0] below */
 805         __le32 rds_ring_offset; /* Offset to RDS config */
 806         __le32 sds_ring_offset; /* Offset to SDS config */
 807         __le32 host_ctx_state;  /* Starting State */
 808         __le32 num_fn_per_port; /* How many PCI fn share the port */
 809         __le16 num_rds_rings;   /* Count of RDS rings */
 810         __le16 num_sds_rings;   /* Count of SDS rings */
 811         __le16 context_id;              /* Handle for context */
 812         u8  phys_port;          /* Physical id of port */
 813         u8  virt_port;          /* Virtual/Logical id of port */
 814         u8  reserved[128];      /* save space for future expansion */
 815         /*  MUST BE 64-bit aligned.
 816            The following is packed:
 817            - N cardrsp_rds_rings
 818            - N cardrs_sds_rings */
 819         char data[0];
 820 } nx_cardrsp_rx_ctx_t;
 821
 822 #define SIZEOF_HOSTRQ_RX(HOSTRQ_RX, rds_rings, sds_rings)       \
 823         (sizeof(HOSTRQ_RX) +                                    \
 824         (rds_rings)*(sizeof(nx_hostrq_rds_ring_t)) +            \
 825         (sds_rings)*(sizeof(nx_hostrq_sds_ring_t)))
 826
 827 #define SIZEOF_CARDRSP_RX(CARDRSP_RX, rds_rings, sds_rings)     \
 828         (sizeof(CARDRSP_RX) +                                   \
 829         (rds_rings)*(sizeof(nx_cardrsp_rds_ring_t)) +           \
 830         (sds_rings)*(sizeof(nx_cardrsp_sds_ring_t)))
 831
 832 /*
 833  * Tx context
 834  */
 835
 836 typedef struct {
 837         __le64 host_phys_addr;  /* Ring base addr */
 838         __le32 ring_size;               /* Ring entries */
 839         __le32 rsvd;            /* Padding */
 840 } nx_hostrq_cds_ring_t;
 841
 842 typedef struct {
 843         __le64 host_rsp_dma_addr;       /* Response dma'd here */
 844         __le64 cmd_cons_dma_addr;       /*  */
 845         __le64 dummy_dma_addr;  /*  */
 846         __le32 capabilities[4]; /* Flag bit vector */
 847         __le32 host_int_crb_mode;       /* Interrupt crb usage */
 848         __le32 rsvd1;           /* Padding */
 849         __le16 rsvd2;           /* Padding */
 850         __le16 interrupt_ctl;
 851         __le16 msi_index;
 852         __le16 rsvd3;           /* Padding */
 853         nx_hostrq_cds_ring_t cds_ring;  /* Desc of cds ring */
 854         u8  reserved[128];      /* future expansion */
 855 } nx_hostrq_tx_ctx_t;
 856
 857 typedef struct {
 858         __le32 host_producer_crb;       /* Crb to use */
 859         __le32 interrupt_crb;   /* Crb to use */
 860 } nx_cardrsp_cds_ring_t;
 861
 862 typedef struct {
 863         __le32 host_ctx_state;  /* Starting state */
 864         __le16 context_id;              /* Handle for context */
 865         u8  phys_port;          /* Physical id of port */
 866         u8  virt_port;          /* Virtual/Logical id of port */
 867         nx_cardrsp_cds_ring_t cds_ring; /* Card cds settings */
 868         u8  reserved[128];      /* future expansion */
 869 } nx_cardrsp_tx_ctx_t;
 870
 871 #define SIZEOF_HOSTRQ_TX(HOSTRQ_TX)     (sizeof(HOSTRQ_TX))
 872 #define SIZEOF_CARDRSP_TX(CARDRSP_TX)   (sizeof(CARDRSP_TX))
 873
 874 /* CRB */
 875
 876 #define NX_HOST_RDS_CRB_MODE_UNIQUE     0
 877 #define NX_HOST_RDS_CRB_MODE_SHARED     1
 878 #define NX_HOST_RDS_CRB_MODE_CUSTOM     2
 879 #define NX_HOST_RDS_CRB_MODE_MAX        3
 880
 881 #define NX_HOST_INT_CRB_MODE_UNIQUE     0
 882 #define NX_HOST_INT_CRB_MODE_SHARED     1
 883 #define NX_HOST_INT_CRB_MODE_NORX       2
 884 #define NX_HOST_INT_CRB_MODE_NOTX       3
 885 #define NX_HOST_INT_CRB_MODE_NORXTX     4
 886
 887
 888 /* MAC */
 889
 890 #define MC_COUNT_P2     16
 891 #define MC_COUNT_P3     38
 892
 893 #define NETXEN_MAC_NOOP 0
 894 #define NETXEN_MAC_ADD  1
 895 #define NETXEN_MAC_DEL  2
 896
 897 typedef struct nx_mac_list_s {
 898         struct list_head list;
 899         uint8_t mac_addr[ETH_ALEN+2];
 900 } nx_mac_list_t;
 901
 902 /*
 903  * Interrupt coalescing defaults. The defaults are for 1500 MTU. It is
 904  * adjusted based on configured MTU.
 905  */
 906 #define NETXEN_DEFAULT_INTR_COALESCE_RX_TIME_US 3
 907 #define NETXEN_DEFAULT_INTR_COALESCE_RX_PACKETS 256
 908 #define NETXEN_DEFAULT_INTR_COALESCE_TX_PACKETS 64
 909 #define NETXEN_DEFAULT_INTR_COALESCE_TX_TIME_US 4
 910
 911 #define NETXEN_NIC_INTR_DEFAULT                 0x04
 912
 913 typedef union {
 914         struct {
 915                 uint16_t        rx_packets;
 916                 uint16_t        rx_time_us;
 917                 uint16_t        tx_packets;
 918                 uint16_t        tx_time_us;
 919         } data;
 920         uint64_t                word;
 921 } nx_nic_intr_coalesce_data_t;
 922
 923 typedef struct {
 924         uint16_t                        stats_time_us;
 925         uint16_t                        rate_sample_time;
 926         uint16_t                        flags;
 927         uint16_t                        rsvd_1;
 928         uint32_t                        low_threshold;
 929         uint32_t                        high_threshold;
 930         nx_nic_intr_coalesce_data_t     normal;
 931         nx_nic_intr_coalesce_data_t     low;
 932         nx_nic_intr_coalesce_data_t     high;
 933         nx_nic_intr_coalesce_data_t     irq;
 934 } nx_nic_intr_coalesce_t;
 935
 936 #define NX_HOST_REQUEST         0x13
 937 #define NX_NIC_REQUEST          0x14
 938
 939 #define NX_MAC_EVENT            0x1
 940
 941 #define NX_IP_UP                2
 942 #define NX_IP_DOWN              3
 943
 944 /*
 945  * Driver --> Firmware
 946  */
 947 #define NX_NIC_H2C_OPCODE_START                         0
 948 #define NX_NIC_H2C_OPCODE_CONFIG_RSS                    1
 949 #define NX_NIC_H2C_OPCODE_CONFIG_RSS_TBL                2
 950 #define NX_NIC_H2C_OPCODE_CONFIG_INTR_COALESCE          3
 951 #define NX_NIC_H2C_OPCODE_CONFIG_LED                    4
 952 #define NX_NIC_H2C_OPCODE_CONFIG_PROMISCUOUS            5
 953 #define NX_NIC_H2C_OPCODE_CONFIG_L2_MAC                 6
 954 #define NX_NIC_H2C_OPCODE_LRO_REQUEST                   7
 955 #define NX_NIC_H2C_OPCODE_GET_SNMP_STATS                8
 956 #define NX_NIC_H2C_OPCODE_PROXY_START_REQUEST           9
 957 #define NX_NIC_H2C_OPCODE_PROXY_STOP_REQUEST            10
 958 #define NX_NIC_H2C_OPCODE_PROXY_SET_MTU                 11
 959 #define NX_NIC_H2C_OPCODE_PROXY_SET_VPORT_MISS_MODE     12
 960 #define NX_NIC_H2C_OPCODE_GET_FINGER_PRINT_REQUEST      13
 961 #define NX_NIC_H2C_OPCODE_INSTALL_LICENSE_REQUEST       14
 962 #define NX_NIC_H2C_OPCODE_GET_LICENSE_CAPABILITY_REQUEST        15
 963 #define NX_NIC_H2C_OPCODE_GET_NET_STATS                 16
 964 #define NX_NIC_H2C_OPCODE_PROXY_UPDATE_P2V              17
 965 #define NX_NIC_H2C_OPCODE_CONFIG_IPADDR                 18
 966 #define NX_NIC_H2C_OPCODE_CONFIG_LOOPBACK               19
 967 #define NX_NIC_H2C_OPCODE_PROXY_STOP_DONE               20
 968 #define NX_NIC_H2C_OPCODE_GET_LINKEVENT                 21
 969 #define NX_NIC_C2C_OPCODE                               22
 970 #define NX_NIC_H2C_OPCODE_CONFIG_BRIDGING               23
 971 #define NX_NIC_H2C_OPCODE_CONFIG_HW_LRO                 24
 972 #define NX_NIC_H2C_OPCODE_LAST                          25
 973
 974 /*
 975  * Firmware --> Driver
 976  */
 977
 978 #define NX_NIC_C2H_OPCODE_START                         128
 979 #define NX_NIC_C2H_OPCODE_CONFIG_RSS_RESPONSE           129
 980 #define NX_NIC_C2H_OPCODE_CONFIG_RSS_TBL_RESPONSE       130
 981 #define NX_NIC_C2H_OPCODE_CONFIG_MAC_RESPONSE           131
 982 #define NX_NIC_C2H_OPCODE_CONFIG_PROMISCUOUS_RESPONSE   132
 983 #define NX_NIC_C2H_OPCODE_CONFIG_L2_MAC_RESPONSE        133
 984 #define NX_NIC_C2H_OPCODE_LRO_DELETE_RESPONSE           134
 985 #define NX_NIC_C2H_OPCODE_LRO_ADD_FAILURE_RESPONSE      135
 986 #define NX_NIC_C2H_OPCODE_GET_SNMP_STATS                136
 987 #define NX_NIC_C2H_OPCODE_GET_FINGER_PRINT_REPLY        137
 988 #define NX_NIC_C2H_OPCODE_INSTALL_LICENSE_REPLY         138
 989 #define NX_NIC_C2H_OPCODE_GET_LICENSE_CAPABILITIES_REPLY 139
 990 #define NX_NIC_C2H_OPCODE_GET_NET_STATS_RESPONSE        140
 991 #define NX_NIC_C2H_OPCODE_GET_LINKEVENT_RESPONSE        141
 992 #define NX_NIC_C2H_OPCODE_LAST                          142
 993
 994 #define VPORT_MISS_MODE_DROP            0 /* drop all unmatched */
 995 #define VPORT_MISS_MODE_ACCEPT_ALL      1 /* accept all packets */
 996 #define VPORT_MISS_MODE_ACCEPT_MULTI    2 /* accept unmatched multicast */
 997
 998 #define NX_NIC_LRO_REQUEST_FIRST                0
 999 #define NX_NIC_LRO_REQUEST_ADD_FLOW             1
1000 #define NX_NIC_LRO_REQUEST_DELETE_FLOW          2
1001 #define NX_NIC_LRO_REQUEST_TIMER                3
1002 #define NX_NIC_LRO_REQUEST_CLEANUP              4
1003 #define NX_NIC_LRO_REQUEST_ADD_FLOW_SCHEDULED   5
1004 #define NX_TOE_LRO_REQUEST_ADD_FLOW             6
1005 #define NX_TOE_LRO_REQUEST_ADD_FLOW_RESPONSE    7
1006 #define NX_TOE_LRO_REQUEST_DELETE_FLOW          8
1007 #define NX_TOE_LRO_REQUEST_DELETE_FLOW_RESPONSE 9
1008 #define NX_TOE_LRO_REQUEST_TIMER                10
1009 #define NX_NIC_LRO_REQUEST_LAST                 11
1010
1011 #define NX_FW_CAPABILITY_LINK_NOTIFICATION      (1 << 5)
1012 #define NX_FW_CAPABILITY_SWITCHING              (1 << 6)
1013 #define NX_FW_CAPABILITY_PEXQ                   (1 << 7)
1014 #define NX_FW_CAPABILITY_BDG                    (1 << 8)
1015 #define NX_FW_CAPABILITY_FVLANTX                (1 << 9)
1016 #define NX_FW_CAPABILITY_HW_LRO                 (1 << 10)
1017
1018 /* module types */
1019 #define LINKEVENT_MODULE_NOT_PRESENT                    1
1020 #define LINKEVENT_MODULE_OPTICAL_UNKNOWN                2
1021 #define LINKEVENT_MODULE_OPTICAL_SRLR                   3
1022 #define LINKEVENT_MODULE_OPTICAL_LRM                    4
1023 #define LINKEVENT_MODULE_OPTICAL_SFP_1G                 5
1024 #define LINKEVENT_MODULE_TWINAX_UNSUPPORTED_CABLE       6
1025 #define LINKEVENT_MODULE_TWINAX_UNSUPPORTED_CABLELEN    7
1026 #define LINKEVENT_MODULE_TWINAX                         8
1027
1028 #define LINKSPEED_10GBPS        10000
1029 #define LINKSPEED_1GBPS         1000
1030 #define LINKSPEED_100MBPS       100
1031 #define LINKSPEED_10MBPS        10
1032
1033 #define LINKSPEED_ENCODED_10MBPS        0
1034 #define LINKSPEED_ENCODED_100MBPS       1
1035 #define LINKSPEED_ENCODED_1GBPS         2
1036
1037 #define LINKEVENT_AUTONEG_DISABLED      0
1038 #define LINKEVENT_AUTONEG_ENABLED       1
1039
1040 #define LINKEVENT_HALF_DUPLEX           0
1041 #define LINKEVENT_FULL_DUPLEX           1
1042
1043 #define LINKEVENT_LINKSPEED_MBPS        0
1044 #define LINKEVENT_LINKSPEED_ENCODED     1
1045
1046 /* firmware response header:
1047  *      63:58 - message type
1048  *      57:56 - owner
1049  *      55:53 - desc count
1050  *      52:48 - reserved
1051  *      47:40 - completion id
1052  *      39:32 - opcode
1053  *      31:16 - error code
1054  *      15:00 - reserved
1055  */
1056 #define netxen_get_nic_msgtype(msg_hdr) \
1057         ((msg_hdr >> 58) & 0x3F)
1058 #define netxen_get_nic_msg_compid(msg_hdr)      \
1059         ((msg_hdr >> 40) & 0xFF)
1060 #define netxen_get_nic_msg_opcode(msg_hdr)      \
1061         ((msg_hdr >> 32) & 0xFF)
1062 #define netxen_get_nic_msg_errcode(msg_hdr)     \
1063         ((msg_hdr >> 16) & 0xFFFF)
1064
1065 typedef struct {
1066         union {
1067                 struct {
1068                         u64 hdr;
1069                         u64 body[7];
1070                 };
1071                 u64 words[8];
1072         };
1073 } nx_fw_msg_t;
1074
1075 typedef struct {
1076         __le64 qhdr;
1077         __le64 req_hdr;
1078         __le64 words[6];
1079 } nx_nic_req_t;
1080
1081 typedef struct {
1082         u8 op;
1083         u8 tag;
1084         u8 mac_addr[6];
1085 } nx_mac_req_t;
1086
1087 #define MAX_PENDING_DESC_BLOCK_SIZE     64
1088
1089 #define NETXEN_NIC_MSI_ENABLED          0x02
1090 #define NETXEN_NIC_MSIX_ENABLED         0x04
1091 #define NETXEN_NIC_LRO_ENABLED          0x08
1092 #define NETXEN_NIC_BRIDGE_ENABLED       0X10
1093 #define NETXEN_IS_MSI_FAMILY(adapter) \
1094         ((adapter)->flags & (NETXEN_NIC_MSI_ENABLED | NETXEN_NIC_MSIX_ENABLED))
1095
1096 #define MSIX_ENTRIES_PER_ADAPTER        NUM_STS_DESC_RINGS
1097 #define NETXEN_MSIX_TBL_SPACE           8192
1098 #define NETXEN_PCI_REG_MSIX_TBL         0x44
1099
1100 #define NETXEN_DB_MAPSIZE_BYTES         0x1000
1101
1102 #define NETXEN_NETDEV_WEIGHT 128
1103 #define NETXEN_ADAPTER_UP_MAGIC 777
1104 #define NETXEN_NIC_PEG_TUNE 0
1105
1106 #define __NX_FW_ATTACHED                0
1107 #define __NX_DEV_UP                     1
1108 #define __NX_RESETTING                  2
1109
1110 struct netxen_dummy_dma {
1111         void *addr;
1112         dma_addr_t phys_addr;
1113 };
1114
1115 struct netxen_adapter {
1116         struct netxen_hardware_context ahw;
1117
1118         struct net_device *netdev;
1119         struct pci_dev *pdev;
1120         struct list_head mac_list;
1121
1122         u32 curr_window;
1123         u32 crb_win;
1124         rwlock_t adapter_lock;
1125
1126         spinlock_t tx_clean_lock;
1127
1128         u16 num_txd;
1129         u16 num_rxd;
1130         u16 num_jumbo_rxd;
1131         u16 num_lro_rxd;
1132
1133         u8 max_rds_rings;
1134         u8 max_sds_rings;
1135         u8 driver_mismatch;
1136         u8 msix_supported;
1137         u8 rx_csum;
1138         u8 pci_using_dac;
1139         u8 portnum;
1140         u8 physical_port;
1141
1142         u8 mc_enabled;
1143         u8 max_mc_count;
1144         u8 rss_supported;
1145         u8 link_changed;
1146         u8 fw_wait_cnt;
1147         u8 fw_fail_cnt;
1148         u16 resv4;
1149
1150         u8 has_link_events;
1151         u8 fw_type;
1152         u16 tx_context_id;
1153         u16 mtu;
1154         u16 is_up;
1155
1156         u16 link_speed;
1157         u16 link_duplex;
1158         u16 link_autoneg;
1159         u16 module_type;
1160
1161         u32 capabilities;
1162         u32 flags;
1163         u32 irq;
1164         u32 temp;
1165
1166         u32 int_vec_bit;
1167         u32 heartbit;
1168
1169         struct netxen_adapter_stats stats;
1170
1171         struct netxen_recv_context recv_ctx;
1172         struct nx_host_tx_ring *tx_ring;
1173
1174         int (*macaddr_set) (struct netxen_adapter *, u8 *);
1175         int (*set_mtu) (struct netxen_adapter *, int);
1176         int (*set_promisc) (struct netxen_adapter *, u32);
1177         void (*set_multi) (struct net_device *);
1178         int (*phy_read) (struct netxen_adapter *, u32 reg, u32 *);
1179         int (*phy_write) (struct netxen_adapter *, u32 reg, u32 val);
1180         int (*init_port) (struct netxen_adapter *, int);
1181         int (*stop_port) (struct netxen_adapter *);
1182
1183         u32 (*crb_read)(struct netxen_adapter *, ulong);
1184         int (*crb_write)(struct netxen_adapter *, ulong, u32);
1185
1186         int (*pci_mem_read)(struct netxen_adapter *, u64, void *, int);
1187         int (*pci_mem_write)(struct netxen_adapter *, u64, void *, int);
1188
1189         unsigned long (*pci_set_window)(struct netxen_adapter *,
1190                         unsigned long long);
1191
1192         u32 (*io_read)(struct netxen_adapter *, void __iomem *);
1193         void (*io_write)(struct netxen_adapter *, void __iomem *, u32);
1194
1195         void __iomem    *tgt_mask_reg;
1196         void __iomem    *pci_int_reg;
1197         void __iomem    *tgt_status_reg;
1198         void __iomem    *crb_int_state_reg;
1199         void __iomem    *isr_int_vec;
1200
1201         struct msix_entry msix_entries[MSIX_ENTRIES_PER_ADAPTER];
1202
1203         struct netxen_dummy_dma dummy_dma;
1204
1205         struct delayed_work fw_work;
1206
1207         struct work_struct  tx_timeout_task;
1208
1209         struct net_device_stats net_stats;
1210
1211         nx_nic_intr_coalesce_t coal;
1212
1213         unsigned long state;
1214         u32 resv5;
1215         u32 fw_version;
1216         const struct firmware *fw;
1217 };
1218
1219 int netxen_niu_xg_init_port(struct netxen_adapter *adapter, int port);
1220 int netxen_niu_disable_xg_port(struct netxen_adapter *adapter);
1221
1222 int nx_fw_cmd_query_phy(struct netxen_adapter *adapter, u32 reg, u32 *val);
1223 int nx_fw_cmd_set_phy(struct netxen_adapter *adapter, u32 reg, u32 val);
1224
1225 /* Functions available from netxen_nic_hw.c */
1226 int netxen_nic_set_mtu_xgb(struct netxen_adapter *adapter, int new_mtu);
1227 int netxen_nic_set_mtu_gb(struct netxen_adapter *adapter, int new_mtu);
1228
1229 int netxen_p2_nic_set_mac_addr(struct netxen_adapter *adapter, u8 *addr);
1230 int netxen_p3_nic_set_mac_addr(struct netxen_adapter *adapter, u8 *addr);
1231
1232 #define NXRD32(adapter, off) \
1233         (adapter->crb_read(adapter, off))
1234 #define NXWR32(adapter, off, val) \
1235         (adapter->crb_write(adapter, off, val))
1236 #define NXRDIO(adapter, addr) \
1237         (adapter->io_read(adapter, addr))
1238 #define NXWRIO(adapter, addr, val) \
1239         (adapter->io_write(adapter, addr, val))
1240
1241 int netxen_pcie_sem_lock(struct netxen_adapter *, int, u32);
1242 void netxen_pcie_sem_unlock(struct netxen_adapter *, int);
1243
1244 #define netxen_rom_lock(a)      \
1245         netxen_pcie_sem_lock((a), 2, NETXEN_ROM_LOCK_ID)
1246 #define netxen_rom_unlock(a)    \
1247         netxen_pcie_sem_unlock((a), 2)
1248 #define netxen_phy_lock(a)      \
1249         netxen_pcie_sem_lock((a), 3, NETXEN_PHY_LOCK_ID)
1250 #define netxen_phy_unlock(a)    \
1251         netxen_pcie_sem_unlock((a), 3)
1252 #define netxen_api_lock(a)      \
1253         netxen_pcie_sem_lock((a), 5, 0)
1254 #define netxen_api_unlock(a)    \
1255         netxen_pcie_sem_unlock((a), 5)
1256 #define netxen_sw_lock(a)       \
1257         netxen_pcie_sem_lock((a), 6, 0)
1258 #define netxen_sw_unlock(a)     \
1259         netxen_pcie_sem_unlock((a), 6)
1260 #define crb_win_lock(a) \
1261         netxen_pcie_sem_lock((a), 7, NETXEN_CRB_WIN_LOCK_ID)
1262 #define crb_win_unlock(a)       \
1263         netxen_pcie_sem_unlock((a), 7)
1264
1265 int netxen_nic_get_board_info(struct netxen_adapter *adapter);
1266 int netxen_nic_wol_supported(struct netxen_adapter *adapter);
1267
1268 /* Functions from netxen_nic_init.c */
1269 int netxen_init_dummy_dma(struct netxen_adapter *adapter);
1270 void netxen_free_dummy_dma(struct netxen_adapter *adapter);
1271
1272 int netxen_phantom_init(struct netxen_adapter *adapter, int pegtune_val);
1273 int netxen_load_firmware(struct netxen_adapter *adapter);
1274 int netxen_need_fw_reset(struct netxen_adapter *adapter);
1275 void netxen_request_firmware(struct netxen_adapter *adapter);
1276 void netxen_release_firmware(struct netxen_adapter *adapter);
1277 int netxen_pinit_from_rom(struct netxen_adapter *adapter, int verbose);
1278
1279 int netxen_rom_fast_read(struct netxen_adapter *adapter, int addr, int *valp);
1280 int netxen_rom_fast_read_words(struct netxen_adapter *adapter, int addr,
1281                                 u8 *bytes, size_t size);
1282 int netxen_rom_fast_write_words(struct netxen_adapter *adapter, int addr,
1283                                 u8 *bytes, size_t size);
1284 int netxen_flash_unlock(struct netxen_adapter *adapter);
1285 int netxen_backup_crbinit(struct netxen_adapter *adapter);
1286 int netxen_flash_erase_secondary(struct netxen_adapter *adapter);
1287 int netxen_flash_erase_primary(struct netxen_adapter *adapter);
1288 void netxen_halt_pegs(struct netxen_adapter *adapter);
1289
1290 int netxen_rom_se(struct netxen_adapter *adapter, int addr);
1291
1292 int netxen_alloc_sw_resources(struct netxen_adapter *adapter);
1293 void netxen_free_sw_resources(struct netxen_adapter *adapter);
1294
1295 void netxen_setup_hwops(struct netxen_adapter *adapter);
1296 void __iomem *netxen_get_ioaddr(struct netxen_adapter *, u32);
1297
1298 int netxen_alloc_hw_resources(struct netxen_adapter *adapter);
1299 void netxen_free_hw_resources(struct netxen_adapter *adapter);
1300
1301 void netxen_release_rx_buffers(struct netxen_adapter *adapter);
1302 void netxen_release_tx_buffers(struct netxen_adapter *adapter);
1303
1304 int netxen_init_firmware(struct netxen_adapter *adapter);
1305 void netxen_nic_clear_stats(struct netxen_adapter *adapter);
1306 void netxen_watchdog_task(struct work_struct *work);
1307 void netxen_post_rx_buffers(struct netxen_adapter *adapter, u32 ringid,
1308                 struct nx_host_rds_ring *rds_ring);
1309 int netxen_process_cmd_ring(struct netxen_adapter *adapter);
1310 int netxen_process_rcv_ring(struct nx_host_sds_ring *sds_ring, int max);
1311 void netxen_p2_nic_set_multi(struct net_device *netdev);
1312 void netxen_p3_nic_set_multi(struct net_device *netdev);
1313 void netxen_p3_free_mac_list(struct netxen_adapter *adapter);
1314 int netxen_p2_nic_set_promisc(struct netxen_adapter *adapter, u32 mode);
1315 int netxen_p3_nic_set_promisc(struct netxen_adapter *adapter, u32);
1316 int netxen_config_intr_coalesce(struct netxen_adapter *adapter);
1317 int netxen_config_rss(struct netxen_adapter *adapter, int enable);
1318 int netxen_config_ipaddr(struct netxen_adapter *adapter, u32 ip, int cmd);
1319 int netxen_linkevent_request(struct netxen_adapter *adapter, int enable);
1320 void netxen_advert_link_change(struct netxen_adapter *adapter, int linkup);
1321
1322 int nx_fw_cmd_set_mtu(struct netxen_adapter *adapter, int mtu);
1323 int netxen_nic_change_mtu(struct net_device *netdev, int new_mtu);
1324 int netxen_config_hw_lro(struct netxen_adapter *adapter, int enable);
1325 int netxen_config_bridged_mode(struct netxen_adapter *adapter, int enable);
1326 int netxen_send_lro_cleanup(struct netxen_adapter *adapter);
1327
1328 int netxen_nic_set_mac(struct net_device *netdev, void *p);
1329 struct net_device_stats *netxen_nic_get_stats(struct net_device *netdev);
1330
1331 void netxen_nic_update_cmd_producer(struct netxen_adapter *adapter,
1332                 struct nx_host_tx_ring *tx_ring);
1333
1334 /* Functions from netxen_nic_main.c */
1335 int netxen_nic_reset_context(struct netxen_adapter *);
1336
1337 /*
1338  * NetXen Board information
1339  */
1340
1341 #define NETXEN_MAX_SHORT_NAME 32
1342 struct netxen_brdinfo {
1343         int brdtype;    /* type of board */
1344         long ports;             /* max no of physical ports */
1345         char short_name[NETXEN_MAX_SHORT_NAME];
1346 };
1347
1348 static const struct netxen_brdinfo netxen_boards[] = {
1349         {NETXEN_BRDTYPE_P2_SB31_10G_CX4, 1, "XGb CX4"},
1350         {NETXEN_BRDTYPE_P2_SB31_10G_HMEZ, 1, "XGb HMEZ"},
1351         {NETXEN_BRDTYPE_P2_SB31_10G_IMEZ, 2, "XGb IMEZ"},
1352         {NETXEN_BRDTYPE_P2_SB31_10G, 1, "XGb XFP"},
1353         {NETXEN_BRDTYPE_P2_SB35_4G, 4, "Quad Gb"},
1354         {NETXEN_BRDTYPE_P2_SB31_2G, 2, "Dual Gb"},
1355         {NETXEN_BRDTYPE_P3_REF_QG,  4, "Reference Quad Gig "},
1356         {NETXEN_BRDTYPE_P3_HMEZ,    2, "Dual XGb HMEZ"},
1357         {NETXEN_BRDTYPE_P3_10G_CX4_LP,   2, "Dual XGb CX4 LP"},
1358         {NETXEN_BRDTYPE_P3_4_GB,    4, "Quad Gig LP"},
1359         {NETXEN_BRDTYPE_P3_IMEZ,    2, "Dual XGb IMEZ"},
1360         {NETXEN_BRDTYPE_P3_10G_SFP_PLUS, 2, "Dual XGb SFP+ LP"},
1361         {NETXEN_BRDTYPE_P3_10000_BASE_T, 1, "XGB 10G BaseT LP"},
1362         {NETXEN_BRDTYPE_P3_XG_LOM,  2, "Dual XGb LOM"},
1363         {NETXEN_BRDTYPE_P3_4_GB_MM, 4, "NX3031 Gigabit Ethernet"},
1364         {NETXEN_BRDTYPE_P3_10G_SFP_CT, 2, "NX3031 10 Gigabit Ethernet"},
1365         {NETXEN_BRDTYPE_P3_10G_SFP_QT, 2, "Quanta Dual XGb SFP+"},
1366         {NETXEN_BRDTYPE_P3_10G_CX4, 2, "Reference Dual CX4 Option"},
1367         {NETXEN_BRDTYPE_P3_10G_XFP, 1, "Reference Single XFP Option"}
1368 };
1369
1370 #define NUM_SUPPORTED_BOARDS ARRAY_SIZE(netxen_boards)
1371
1372 static inline void get_brd_name_by_type(u32 type, char *name)
1373 {
1374         int i, found = 0;
1375         for (i = 0; i < NUM_SUPPORTED_BOARDS; ++i) {
1376                 if (netxen_boards[i].brdtype == type) {
1377                         strcpy(name, netxen_boards[i].short_name);
1378                         found = 1;
1379                         break;
1380                 }
1381
1382         }
1383         if (!found)
1384                 name = "Unknown";
1385 }
1386
1387 static inline u32 netxen_tx_avail(struct nx_host_tx_ring *tx_ring)
1388 {
1389         smp_mb();
1390         return find_diff_among(tx_ring->producer,
1391                         tx_ring->sw_consumer, tx_ring->num_desc);
1392
1393 }
1394
1395 int netxen_get_flash_mac_addr(struct netxen_adapter *adapter, __le64 *mac);
1396 int netxen_p3_get_mac_addr(struct netxen_adapter *adapter, __le64 *mac);
1397 extern void netxen_change_ringparam(struct netxen_adapter *adapter);
1398 extern int netxen_rom_fast_read(struct netxen_adapter *adapter, int addr,
1399                                 int *valp);
1400
1401 extern const struct ethtool_ops netxen_nic_ethtool_ops;
1402
1403 #endif                          /* __NETXEN_NIC_H_ */