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