drivers/net/netxen/netxen_nic.h

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