drivers/net/netxen/netxen_nic.h

   1 /*
   2  * Copyright (C) 2003 - 2006 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,
  26  * 3965 Freedom Circle, Fourth floor,
  27  * Santa Clara, CA 95054
  28  */
  29
  30 #ifndef _NETXEN_NIC_H_
  31 #define _NETXEN_NIC_H_
  32
  33 #include <linux/module.h>
  34 #include <linux/kernel.h>
  35 #include <linux/types.h>
  36 #include <linux/compiler.h>
  37 #include <linux/slab.h>
  38 #include <linux/delay.h>
  39 #include <linux/init.h>
  40 #include <linux/ioport.h>
  41 #include <linux/pci.h>
  42 #include <linux/netdevice.h>
  43 #include <linux/etherdevice.h>
  44 #include <linux/ip.h>
  45 #include <linux/in.h>
  46 #include <linux/tcp.h>
  47 #include <linux/skbuff.h>
  48 #include <linux/version.h>
  49
  50 #include <linux/ethtool.h>
  51 #include <linux/mii.h>
  52 #include <linux/interrupt.h>
  53 #include <linux/timer.h>
  54
  55 #include <linux/mm.h>
  56 #include <linux/mman.h>
  57
  58 #include <asm/system.h>
  59 #include <asm/io.h>
  60 #include <asm/byteorder.h>
  61 #include <asm/uaccess.h>
  62 #include <asm/pgtable.h>
  63
  64 #include "netxen_nic_hw.h"
  65
  66 #define NETXEN_NIC_BUILD_NO     "5"
  67 #define _NETXEN_NIC_LINUX_MAJOR 2
  68 #define _NETXEN_NIC_LINUX_MINOR 3
  69 #define _NETXEN_NIC_LINUX_SUBVERSION 59
  70 #define NETXEN_NIC_LINUX_VERSIONID  "2.3.59" "-" NETXEN_NIC_BUILD_NO
  71 #define NETXEN_NIC_FW_VERSIONID "2.3.59"
  72
  73 #define RCV_DESC_RINGSIZE       \
  74         (sizeof(struct rcv_desc) * adapter->max_rx_desc_count)
  75 #define STATUS_DESC_RINGSIZE    \
  76         (sizeof(struct status_desc)* adapter->max_rx_desc_count)
  77 #define TX_RINGSIZE     \
  78         (sizeof(struct netxen_cmd_buffer) * adapter->max_tx_desc_count)
  79 #define RCV_BUFFSIZE    \
  80         (sizeof(struct netxen_rx_buffer) * rcv_desc->max_rx_desc_count)
  81 #define find_diff_among(a,b,range) ((a)<(b)?((b)-(a)):((b)+(range)-(a)))
  82
  83 #define NETXEN_NETDEV_STATUS 0x1
  84
  85 #define ADDR_IN_WINDOW1(off)    \
  86         ((off > NETXEN_CRB_PCIX_HOST2) && (off < NETXEN_CRB_MAX)) ? 1 : 0
  87
  88 /*
  89  * normalize a 64MB crb address to 32MB PCI window
  90  * To use NETXEN_CRB_NORMALIZE, window _must_ be set to 1
  91  */
  92 #define NETXEN_CRB_NORMAL(reg)        \
  93         (reg) - NETXEN_CRB_PCIX_HOST2 + NETXEN_CRB_PCIX_HOST
  94
  95 #define NETXEN_CRB_NORMALIZE(adapter, reg) \
  96         pci_base_offset(adapter, NETXEN_CRB_NORMAL(reg))
  97
  98 #define FIRST_PAGE_GROUP_START  0
  99 #define FIRST_PAGE_GROUP_END    0x400000
 100
 101 #define SECOND_PAGE_GROUP_START 0x4000000
 102 #define SECOND_PAGE_GROUP_END   0x66BC000
 103
 104 #define THIRD_PAGE_GROUP_START  0x70E4000
 105 #define THIRD_PAGE_GROUP_END    0x8000000
 106
 107 #define FIRST_PAGE_GROUP_SIZE  FIRST_PAGE_GROUP_END - FIRST_PAGE_GROUP_START
 108 #define SECOND_PAGE_GROUP_SIZE SECOND_PAGE_GROUP_END - SECOND_PAGE_GROUP_START
 109 #define THIRD_PAGE_GROUP_SIZE  THIRD_PAGE_GROUP_END - THIRD_PAGE_GROUP_START
 110
 111 #define MAX_RX_BUFFER_LENGTH            2000
 112 #define MAX_RX_JUMBO_BUFFER_LENGTH      9046
 113 #define RX_DMA_MAP_LEN                  (MAX_RX_BUFFER_LENGTH - NET_IP_ALIGN)
 114 #define RX_JUMBO_DMA_MAP_LEN    \
 115         (MAX_RX_JUMBO_BUFFER_LENGTH - NET_IP_ALIGN)
 116 #define NETXEN_ROM_ROUNDUP              0x80000000ULL
 117
 118 /*
 119  * Maximum number of ring contexts
 120  */
 121 #define MAX_RING_CTX 1
 122
 123 /* Opcodes to be used with the commands */
 124 enum {
 125         TX_ETHER_PKT = 0x01,
 126 /* The following opcodes are for IP checksum    */
 127         TX_TCP_PKT,
 128         TX_UDP_PKT,
 129         TX_IP_PKT,
 130         TX_TCP_LSO,
 131         TX_IPSEC,
 132         TX_IPSEC_CMD
 133 };
 134
 135 /* The following opcodes are for internal consumption. */
 136 #define NETXEN_CONTROL_OP       0x10
 137 #define PEGNET_REQUEST          0x11
 138
 139 #define MAX_NUM_CARDS           4
 140
 141 #define MAX_BUFFERS_PER_CMD     32
 142
 143 /*
 144  * Following are the states of the Phantom. Phantom will set them and
 145  * Host will read to check if the fields are correct.
 146  */
 147 #define PHAN_INITIALIZE_START           0xff00
 148 #define PHAN_INITIALIZE_FAILED          0xffff
 149 #define PHAN_INITIALIZE_COMPLETE        0xff01
 150
 151 /* Host writes the following to notify that it has done the init-handshake */
 152 #define PHAN_INITIALIZE_ACK     0xf00f
 153
 154 #define NUM_RCV_DESC_RINGS      2       /* No of Rcv Descriptor contexts */
 155
 156 /* descriptor types */
 157 #define RCV_DESC_NORMAL         0x01
 158 #define RCV_DESC_JUMBO          0x02
 159 #define RCV_DESC_NORMAL_CTXID   0
 160 #define RCV_DESC_JUMBO_CTXID    1
 161
 162 #define RCV_DESC_TYPE(ID) \
 163         ((ID == RCV_DESC_JUMBO_CTXID) ? RCV_DESC_JUMBO : RCV_DESC_NORMAL)
 164
 165 #define MAX_CMD_DESCRIPTORS             1024
 166 #define MAX_RCV_DESCRIPTORS             32768
 167 #define MAX_JUMBO_RCV_DESCRIPTORS       1024
 168 #define MAX_RCVSTATUS_DESCRIPTORS       MAX_RCV_DESCRIPTORS
 169 #define MAX_JUMBO_RCV_DESC      MAX_JUMBO_RCV_DESCRIPTORS
 170 #define MAX_RCV_DESC            MAX_RCV_DESCRIPTORS
 171 #define MAX_RCVSTATUS_DESC      MAX_RCV_DESCRIPTORS
 172 #define NUM_RCV_DESC            (MAX_RCV_DESC + MAX_JUMBO_RCV_DESCRIPTORS)
 173 #define MAX_EPG_DESCRIPTORS     (MAX_CMD_DESCRIPTORS * 8)
 174
 175 #define MIN_TX_COUNT    4096
 176 #define MIN_RX_COUNT    4096
 177
 178 #define MAX_FRAME_SIZE  0x10000 /* 64K MAX size for LSO */
 179
 180 #define PHAN_PEG_RCV_INITIALIZED        0xff01
 181 #define PHAN_PEG_RCV_START_INITIALIZE   0xff00
 182
 183 #define get_next_index(index, length)   \
 184         (((index) + 1) & ((length) - 1))
 185
 186 #define get_index_range(index,length,count)     \
 187         (((index) + (count)) & ((length) - 1))
 188
 189 /*
 190  * Following data structures describe the descriptors that will be used.
 191  * Added fileds of tcpHdrSize and ipHdrSize, The driver needs to do it only when
 192  * we are doing LSO (above the 1500 size packet) only.
 193  */
 194
 195 /*
 196  * The size of reference handle been changed to 16 bits to pass the MSS fields
 197  * for the LSO packet
 198  */
 199
 200 #define FLAGS_CHECKSUM_ENABLED  0x01
 201 #define FLAGS_LSO_ENABLED       0x02
 202 #define FLAGS_IPSEC_SA_ADD      0x04
 203 #define FLAGS_IPSEC_SA_DELETE   0x08
 204 #define FLAGS_VLAN_TAGGED       0x10
 205
 206 #define CMD_DESC_TOTAL_LENGTH(cmd_desc) \
 207                 ((cmd_desc)->length_tcp_hdr & 0x00FFFFFF)
 208 #define CMD_DESC_TCP_HDR_OFFSET(cmd_desc)       \
 209                 (((cmd_desc)->length_tcp_hdr >> 24) & 0x0FF)
 210 #define CMD_DESC_PORT(cmd_desc)         ((cmd_desc)->port_ctxid & 0x0F)
 211 #define CMD_DESC_CTX_ID(cmd_desc)       (((cmd_desc)->port_ctxid >> 4) & 0x0F)
 212
 213 #define CMD_DESC_TOTAL_LENGTH_WRT(cmd_desc, var)        \
 214                 ((cmd_desc)->length_tcp_hdr |= ((var) & 0x00FFFFFF))
 215 #define CMD_DESC_TCP_HDR_OFFSET_WRT(cmd_desc, var)      \
 216                 ((cmd_desc)->length_tcp_hdr |= (((var) << 24) & 0xFF000000))
 217 #define CMD_DESC_PORT_WRT(cmd_desc, var)        \
 218                 ((cmd_desc)->port_ctxid |= ((var) & 0x0F))
 219
 220 struct cmd_desc_type0 {
 221         u64 netxen_next;        /* for fragments handled by Phantom */
 222         union {
 223                 struct {
 224                         u32 addr_low_part2;
 225                         u32 addr_high_part2;
 226                 };
 227                 u64 addr_buffer2;
 228         };
 229
 230         /* Bit pattern: 0-23 total length, 24-32 tcp header offset */
 231         u32 length_tcp_hdr;
 232         u8 ip_hdr_offset;       /* For LSO only */
 233         u8 num_of_buffers;      /* total number of segments */
 234         u8 flags;               /* as defined above */
 235         u8 opcode;
 236
 237         u16 reference_handle;   /* changed to u16 to add mss */
 238         u16 mss;                /* passed by NDIS_PACKET for LSO */
 239         /* Bit pattern 0-3 port, 0-3 ctx id */
 240         u8 port_ctxid;
 241         u8 total_hdr_length;    /* LSO only : MAC+IP+TCP Hdr size */
 242         u16 conn_id;            /* IPSec offoad only */
 243
 244         union {
 245                 struct {
 246                         u32 addr_low_part3;
 247                         u32 addr_high_part3;
 248                 };
 249                 u64 addr_buffer3;
 250         };
 251
 252         union {
 253                 struct {
 254                         u32 addr_low_part1;
 255                         u32 addr_high_part1;
 256                 };
 257                 u64 addr_buffer1;
 258         };
 259
 260         u16 buffer1_length;
 261         u16 buffer2_length;
 262         u16 buffer3_length;
 263         u16 buffer4_length;
 264
 265         union {
 266                 struct {
 267                         u32 addr_low_part4;
 268                         u32 addr_high_part4;
 269                 };
 270                 u64 addr_buffer4;
 271         };
 272
 273 } __attribute__ ((aligned(64)));
 274
 275 /* Note: sizeof(rcv_desc) should always be a mutliple of 2 */
 276 struct rcv_desc {
 277         u16 reference_handle;
 278         u16 reserved;
 279         u32 buffer_length;      /* allocated buffer length (usually 2K) */
 280         u64 addr_buffer;
 281 };
 282
 283 /* opcode field in status_desc */
 284 #define RCV_NIC_PKT     (0xA)
 285 #define STATUS_NIC_PKT  ((RCV_NIC_PKT) << 12)
 286
 287 /* for status field in status_desc */
 288 #define STATUS_NEED_CKSUM       (1)
 289 #define STATUS_CKSUM_OK         (2)
 290
 291 /* owner bits of status_desc */
 292 #define STATUS_OWNER_HOST       (0x1)
 293 #define STATUS_OWNER_PHANTOM    (0x2)
 294
 295 #define NETXEN_PROT_IP          (1)
 296 #define NETXEN_PROT_UNKNOWN     (0)
 297
 298 /* Note: sizeof(status_desc) should always be a mutliple of 2 */
 299 #define STATUS_DESC_PORT(status_desc)   \
 300                 ((status_desc)->port_status_type_op & 0x0F)
 301 #define STATUS_DESC_STATUS(status_desc) \
 302                 (((status_desc)->port_status_type_op >> 4) & 0x0F)
 303 #define STATUS_DESC_TYPE(status_desc)   \
 304                 (((status_desc)->port_status_type_op >> 8) & 0x0F)
 305 #define STATUS_DESC_OPCODE(status_desc) \
 306                 (((status_desc)->port_status_type_op >> 12) & 0x0F)
 307
 308 struct status_desc {
 309         /* Bit pattern: 0-3 port, 4-7 status, 8-11 type, 12-15 opcode */
 310         u16 port_status_type_op;
 311         u16 total_length;       /* NIC mode */
 312         u16 reference_handle;   /* handle for the associated packet */
 313         /* Bit pattern: 0-1 owner, 2-5 protocol */
 314         u16 owner;              /* Owner of the descriptor */
 315 } __attribute__ ((aligned(8)));
 316
 317 enum {
 318         NETXEN_RCV_PEG_0 = 0,
 319         NETXEN_RCV_PEG_1
 320 };
 321 /* The version of the main data structure */
 322 #define NETXEN_BDINFO_VERSION 1
 323
 324 /* Magic number to let user know flash is programmed */
 325 #define NETXEN_BDINFO_MAGIC 0x12345678
 326
 327 /* Max number of Gig ports on a Phantom board */
 328 #define NETXEN_MAX_PORTS 4
 329
 330 typedef enum {
 331         NETXEN_BRDTYPE_P1_BD = 0x0000,
 332         NETXEN_BRDTYPE_P1_SB = 0x0001,
 333         NETXEN_BRDTYPE_P1_SMAX = 0x0002,
 334         NETXEN_BRDTYPE_P1_SOCK = 0x0003,
 335
 336         NETXEN_BRDTYPE_P2_SOCK_31 = 0x0008,
 337         NETXEN_BRDTYPE_P2_SOCK_35 = 0x0009,
 338         NETXEN_BRDTYPE_P2_SB35_4G = 0x000a,
 339         NETXEN_BRDTYPE_P2_SB31_10G = 0x000b,
 340         NETXEN_BRDTYPE_P2_SB31_2G = 0x000c,
 341
 342         NETXEN_BRDTYPE_P2_SB31_10G_IMEZ = 0x000d,
 343         NETXEN_BRDTYPE_P2_SB31_10G_HMEZ = 0x000e,
 344         NETXEN_BRDTYPE_P2_SB31_10G_CX4 = 0x000f
 345 } netxen_brdtype_t;
 346 #define NUM_SUPPORTED_BOARDS (sizeof(netxen_boards)/sizeof(netxen_brdinfo_t))
 347
 348 typedef enum {
 349         NETXEN_BRDMFG_INVENTEC = 1
 350 } netxen_brdmfg;
 351
 352 typedef enum {
 353         MEM_ORG_128Mbx4 = 0x0,  /* DDR1 only */
 354         MEM_ORG_128Mbx8 = 0x1,  /* DDR1 only */
 355         MEM_ORG_128Mbx16 = 0x2, /* DDR1 only */
 356         MEM_ORG_256Mbx4 = 0x3,
 357         MEM_ORG_256Mbx8 = 0x4,
 358         MEM_ORG_256Mbx16 = 0x5,
 359         MEM_ORG_512Mbx4 = 0x6,
 360         MEM_ORG_512Mbx8 = 0x7,
 361         MEM_ORG_512Mbx16 = 0x8,
 362         MEM_ORG_1Gbx4 = 0x9,
 363         MEM_ORG_1Gbx8 = 0xa,
 364         MEM_ORG_1Gbx16 = 0xb,
 365         MEM_ORG_2Gbx4 = 0xc,
 366         MEM_ORG_2Gbx8 = 0xd,
 367         MEM_ORG_2Gbx16 = 0xe,
 368         MEM_ORG_128Mbx32 = 0x10002,     /* GDDR only */
 369         MEM_ORG_256Mbx32 = 0x10005      /* GDDR only */
 370 } netxen_mn_mem_org_t;
 371
 372 typedef enum {
 373         MEM_ORG_512Kx36 = 0x0,
 374         MEM_ORG_1Mx36 = 0x1,
 375         MEM_ORG_2Mx36 = 0x2
 376 } netxen_sn_mem_org_t;
 377
 378 typedef enum {
 379         MEM_DEPTH_4MB = 0x1,
 380         MEM_DEPTH_8MB = 0x2,
 381         MEM_DEPTH_16MB = 0x3,
 382         MEM_DEPTH_32MB = 0x4,
 383         MEM_DEPTH_64MB = 0x5,
 384         MEM_DEPTH_128MB = 0x6,
 385         MEM_DEPTH_256MB = 0x7,
 386         MEM_DEPTH_512MB = 0x8,
 387         MEM_DEPTH_1GB = 0x9,
 388         MEM_DEPTH_2GB = 0xa,
 389         MEM_DEPTH_4GB = 0xb,
 390         MEM_DEPTH_8GB = 0xc,
 391         MEM_DEPTH_16GB = 0xd,
 392         MEM_DEPTH_32GB = 0xe
 393 } netxen_mem_depth_t;
 394
 395 struct netxen_board_info {
 396         u32 header_version;
 397
 398         u32 board_mfg;
 399         u32 board_type;
 400         u32 board_num;
 401         u32 chip_id;
 402         u32 chip_minor;
 403         u32 chip_major;
 404         u32 chip_pkg;
 405         u32 chip_lot;
 406
 407         u32 port_mask;          /* available niu ports */
 408         u32 peg_mask;           /* available pegs */
 409         u32 icache_ok;          /* can we run with icache? */
 410         u32 dcache_ok;          /* can we run with dcache? */
 411         u32 casper_ok;
 412
 413         u32 mac_addr_lo_0;
 414         u32 mac_addr_lo_1;
 415         u32 mac_addr_lo_2;
 416         u32 mac_addr_lo_3;
 417
 418         /* MN-related config */
 419         u32 mn_sync_mode;       /* enable/ sync shift cclk/ sync shift mclk */
 420         u32 mn_sync_shift_cclk;
 421         u32 mn_sync_shift_mclk;
 422         u32 mn_wb_en;
 423         u32 mn_crystal_freq;    /* in MHz */
 424         u32 mn_speed;           /* in MHz */
 425         u32 mn_org;
 426         u32 mn_depth;
 427         u32 mn_ranks_0;         /* ranks per slot */
 428         u32 mn_ranks_1;         /* ranks per slot */
 429         u32 mn_rd_latency_0;
 430         u32 mn_rd_latency_1;
 431         u32 mn_rd_latency_2;
 432         u32 mn_rd_latency_3;
 433         u32 mn_rd_latency_4;
 434         u32 mn_rd_latency_5;
 435         u32 mn_rd_latency_6;
 436         u32 mn_rd_latency_7;
 437         u32 mn_rd_latency_8;
 438         u32 mn_dll_val[18];
 439         u32 mn_mode_reg;        /* MIU DDR Mode Register */
 440         u32 mn_ext_mode_reg;    /* MIU DDR Extended Mode Register */
 441         u32 mn_timing_0;        /* MIU Memory Control Timing Rgister */
 442         u32 mn_timing_1;        /* MIU Extended Memory Ctrl Timing Register */
 443         u32 mn_timing_2;        /* MIU Extended Memory Ctrl Timing2 Register */
 444
 445         /* SN-related config */
 446         u32 sn_sync_mode;       /* enable/ sync shift cclk / sync shift mclk */
 447         u32 sn_pt_mode;         /* pass through mode */
 448         u32 sn_ecc_en;
 449         u32 sn_wb_en;
 450         u32 sn_crystal_freq;
 451         u32 sn_speed;
 452         u32 sn_org;
 453         u32 sn_depth;
 454         u32 sn_dll_tap;
 455         u32 sn_rd_latency;
 456
 457         u32 mac_addr_hi_0;
 458         u32 mac_addr_hi_1;
 459         u32 mac_addr_hi_2;
 460         u32 mac_addr_hi_3;
 461
 462         u32 magic;              /* indicates flash has been initialized */
 463
 464         u32 mn_rdimm;
 465         u32 mn_dll_override;
 466
 467 };
 468
 469 #define FLASH_NUM_PORTS         (4)
 470
 471 struct netxen_flash_mac_addr {
 472         u32 flash_addr[32];
 473 };
 474
 475 struct netxen_user_old_info {
 476         u8 flash_md5[16];
 477         u8 crbinit_md5[16];
 478         u8 brdcfg_md5[16];
 479         /* bootloader */
 480         u32 bootld_version;
 481         u32 bootld_size;
 482         u8 bootld_md5[16];
 483         /* image */
 484         u32 image_version;
 485         u32 image_size;
 486         u8 image_md5[16];
 487         /* primary image status */
 488         u32 primary_status;
 489         u32 secondary_present;
 490
 491         /* MAC address , 4 ports */
 492         struct netxen_flash_mac_addr mac_addr[FLASH_NUM_PORTS];
 493 };
 494 #define FLASH_NUM_MAC_PER_PORT  32
 495 struct netxen_user_info {
 496         u8 flash_md5[16 * 64];
 497         /* bootloader */
 498         u32 bootld_version;
 499         u32 bootld_size;
 500         /* image */
 501         u32 image_version;
 502         u32 image_size;
 503         /* primary image status */
 504         u32 primary_status;
 505         u32 secondary_present;
 506
 507         /* MAC address , 4 ports, 32 address per port */
 508         u64 mac_addr[FLASH_NUM_PORTS * FLASH_NUM_MAC_PER_PORT];
 509         u32 sub_sys_id;
 510         u8 serial_num[32];
 511
 512         /* Any user defined data */
 513 };
 514
 515 /*
 516  * Flash Layout - new format.
 517  */
 518 struct netxen_new_user_info {
 519         u8 flash_md5[16 * 64];
 520         /* bootloader */
 521         u32 bootld_version;
 522         u32 bootld_size;
 523         /* image */
 524         u32 image_version;
 525         u32 image_size;
 526         /* primary image status */
 527         u32 primary_status;
 528         u32 secondary_present;
 529
 530         /* MAC address , 4 ports, 32 address per port */
 531         u64 mac_addr[FLASH_NUM_PORTS * FLASH_NUM_MAC_PER_PORT];
 532         u32 sub_sys_id;
 533         u8 serial_num[32];
 534
 535         /* Any user defined data */
 536 };
 537
 538 #define SECONDARY_IMAGE_PRESENT 0xb3b4b5b6
 539 #define SECONDARY_IMAGE_ABSENT  0xffffffff
 540 #define PRIMARY_IMAGE_GOOD      0x5a5a5a5a
 541 #define PRIMARY_IMAGE_BAD       0xffffffff
 542
 543 /* Flash memory map */
 544 typedef enum {
 545         CRBINIT_START = 0,      /* Crbinit section */
 546         BRDCFG_START = 0x4000,  /* board config */
 547         INITCODE_START = 0x6000,        /* pegtune code */
 548         BOOTLD_START = 0x10000, /* bootld */
 549         IMAGE_START = 0x43000,  /* compressed image */
 550         SECONDARY_START = 0x200000,     /* backup images */
 551         PXE_START = 0x3E0000,   /* user defined region */
 552         USER_START = 0x3E8000,  /* User defined region for new boards */
 553         FIXED_START = 0x3F0000  /* backup of crbinit */
 554 } netxen_flash_map_t;
 555
 556 #define USER_START_OLD PXE_START        /* for backward compatibility */
 557
 558 #define FLASH_START             (CRBINIT_START)
 559 #define INIT_SECTOR             (0)
 560 #define PRIMARY_START           (BOOTLD_START)
 561 #define FLASH_CRBINIT_SIZE      (0x4000)
 562 #define FLASH_BRDCFG_SIZE       (sizeof(struct netxen_board_info))
 563 #define FLASH_USER_SIZE         (sizeof(netxen_user_info)/sizeof(u32))
 564 #define FLASH_SECONDARY_SIZE    (USER_START-SECONDARY_START)
 565 #define NUM_PRIMARY_SECTORS     (0x20)
 566 #define NUM_CONFIG_SECTORS      (1)
 567 #define PFX "netxen: "
 568
 569 /* Note: Make sure to not call this before adapter->port is valid */
 570 #if !defined(NETXEN_DEBUG)
 571 #define DPRINTK(klevel, fmt, args...)   do { \
 572         } while (0)
 573 #else
 574 #define DPRINTK(klevel, fmt, args...)   do { \
 575         printk(KERN_##klevel PFX "%s: %s: " fmt, __FUNCTION__,\
 576                 (adapter != NULL && adapter->port != NULL && \
 577                 adapter->port[0] != NULL && \
 578                 adapter->port[0]->netdev != NULL) ? \
 579                 adapter->port[0]->netdev->name : NULL, \
 580                 ## args); } while(0)
 581 #endif
 582
 583 /* Number of status descriptors to handle per interrupt */
 584 #define MAX_STATUS_HANDLE       (128)
 585
 586 /*
 587  * netxen_skb_frag{} is to contain mapping info for each SG list. This
 588  * has to be freed when DMA is complete. This is part of netxen_tx_buffer{}.
 589  */
 590 struct netxen_skb_frag {
 591         u64 dma;
 592         u32 length;
 593 };
 594
 595 /*    Following defines are for the state of the buffers    */
 596 #define NETXEN_BUFFER_FREE      0
 597 #define NETXEN_BUFFER_BUSY      1
 598
 599 /*
 600  * There will be one netxen_buffer per skb packet.    These will be
 601  * used to save the dma info for pci_unmap_page()
 602  */
 603 struct netxen_cmd_buffer {
 604         struct sk_buff *skb;
 605         struct netxen_skb_frag frag_array[MAX_BUFFERS_PER_CMD + 1];
 606         u32 total_length;
 607         u32 mss;
 608         u16 port;
 609         u8 cmd;
 610         u8 frag_count;
 611         unsigned long time_stamp;
 612         u32 state;
 613         u32 no_of_descriptors;
 614 };
 615
 616 /* In rx_buffer, we do not need multiple fragments as is a single buffer */
 617 struct netxen_rx_buffer {
 618         struct sk_buff *skb;
 619         u64 dma;
 620         u16 ref_handle;
 621         u16 state;
 622 };
 623
 624 /* Board types */
 625 #define NETXEN_NIC_GBE  0x01
 626 #define NETXEN_NIC_XGBE 0x02
 627
 628 /*
 629  * One hardware_context{} per adapter
 630  * contains interrupt info as well shared hardware info.
 631  */
 632 struct netxen_hardware_context {
 633         struct pci_dev *pdev;
 634         void __iomem *pci_base0;
 635         void __iomem *pci_base1;
 636         void __iomem *pci_base2;
 637
 638         u8 revision_id;
 639         u16 board_type;
 640         u16 max_ports;
 641         struct netxen_board_info boardcfg;
 642         u32 xg_linkup;
 643         u32 qg_linksup;
 644         /* Address of cmd ring in Phantom */
 645         struct cmd_desc_type0 *cmd_desc_head;
 646         char *pauseaddr;
 647         struct pci_dev *cmd_desc_pdev;
 648         dma_addr_t cmd_desc_phys_addr;
 649         dma_addr_t pause_physaddr;
 650         struct pci_dev *pause_pdev;
 651         struct netxen_adapter *adapter;
 652 };
 653
 654 #define MINIMUM_ETHERNET_FRAME_SIZE     64      /* With FCS */
 655 #define ETHERNET_FCS_SIZE               4
 656
 657 struct netxen_adapter_stats {
 658         u64 ints;
 659         u64 hostints;
 660         u64 otherints;
 661         u64 process_rcv;
 662         u64 process_xmit;
 663         u64 noxmitdone;
 664         u64 xmitcsummed;
 665         u64 post_called;
 666         u64 posted;
 667         u64 lastposted;
 668         u64 goodskbposts;
 669 };
 670
 671 /*
 672  * Rcv Descriptor Context. One such per Rcv Descriptor. There may
 673  * be one Rcv Descriptor for normal packets, one for jumbo and may be others.
 674  */
 675 struct netxen_rcv_desc_ctx {
 676         u32 flags;
 677         u32 producer;
 678         u32 rcv_pending;        /* Num of bufs posted in phantom */
 679         u32 rcv_free;           /* Num of bufs in free list */
 680         dma_addr_t phys_addr;
 681         struct pci_dev *phys_pdev;
 682         struct rcv_desc *desc_head;     /* address of rx ring in Phantom */
 683         u32 max_rx_desc_count;
 684         u32 dma_size;
 685         u32 skb_size;
 686         struct netxen_rx_buffer *rx_buf_arr;    /* rx buffers for receive   */
 687         int begin_alloc;
 688 };
 689
 690 /*
 691  * Receive context. There is one such structure per instance of the
 692  * receive processing. Any state information that is relevant to
 693  * the receive, and is must be in this structure. The global data may be
 694  * present elsewhere.
 695  */
 696 struct netxen_recv_context {
 697         struct netxen_rcv_desc_ctx rcv_desc[NUM_RCV_DESC_RINGS];
 698         u32 status_rx_producer;
 699         u32 status_rx_consumer;
 700         dma_addr_t rcv_status_desc_phys_addr;
 701         struct pci_dev *rcv_status_desc_pdev;
 702         struct status_desc *rcv_status_desc_head;
 703 };
 704
 705 #define NETXEN_NIC_MSI_ENABLED 0x02
 706
 707 struct netxen_drvops;
 708
 709 struct netxen_adapter {
 710         struct netxen_hardware_context ahw;
 711         int port_count;         /* Number of configured ports  */
 712         int active_ports;       /* Number of open ports */
 713         struct netxen_port *port[NETXEN_MAX_PORTS];     /* ptr to each port  */
 714         spinlock_t tx_lock;
 715         spinlock_t lock;
 716         struct work_struct watchdog_task;
 717         struct work_struct tx_timeout_task;
 718         struct timer_list watchdog_timer;
 719
 720         u32 curr_window;
 721
 722         u32 cmd_producer;
 723         u32 cmd_consumer;
 724
 725         u32 last_cmd_consumer;
 726         u32 max_tx_desc_count;
 727         u32 max_rx_desc_count;
 728         u32 max_jumbo_rx_desc_count;
 729         /* Num of instances active on cmd buffer ring */
 730         u32 proc_cmd_buf_counter;
 731
 732         u32 num_threads, total_threads; /*Use to keep track of xmit threads */
 733
 734         u32 flags;
 735         u32 irq;
 736         int driver_mismatch;
 737         u32 temp;
 738
 739         struct netxen_adapter_stats stats;
 740
 741         struct netxen_cmd_buffer *cmd_buf_arr;  /* Command buffers for xmit */
 742
 743         /*
 744          * Receive instances. These can be either one per port,
 745          * or one per peg, etc.
 746          */
 747         struct netxen_recv_context recv_ctx[MAX_RCV_CTX];
 748
 749         int is_up;
 750         int work_done;
 751         struct netxen_drvops *ops;
 752 };                              /* netxen_adapter structure */
 753
 754 /* Max number of xmit producer threads that can run simultaneously */
 755 #define MAX_XMIT_PRODUCERS              16
 756
 757 struct netxen_port_stats {
 758         u64 rcvdbadskb;
 759         u64 xmitcalled;
 760         u64 xmitedframes;
 761         u64 xmitfinished;
 762         u64 badskblen;
 763         u64 nocmddescriptor;
 764         u64 polled;
 765         u64 uphappy;
 766         u64 updropped;
 767         u64 uplcong;
 768         u64 uphcong;
 769         u64 upmcong;
 770         u64 updunno;
 771         u64 skbfreed;
 772         u64 txdropped;
 773         u64 txnullskb;
 774         u64 csummed;
 775         u64 no_rcv;
 776         u64 rxbytes;
 777         u64 txbytes;
 778 };
 779
 780 struct netxen_port {
 781         struct netxen_adapter *adapter;
 782
 783         u16 portnum;            /* GBE port number */
 784         u16 link_speed;
 785         u16 link_duplex;
 786         u16 link_autoneg;
 787
 788         int flags;
 789
 790         struct net_device *netdev;
 791         struct pci_dev *pdev;
 792         struct net_device_stats net_stats;
 793         struct netxen_port_stats stats;
 794 };
 795
 796 #define PCI_OFFSET_FIRST_RANGE(adapter, off)    \
 797         ((adapter)->ahw.pci_base0 + (off))
 798 #define PCI_OFFSET_SECOND_RANGE(adapter, off)   \
 799         ((adapter)->ahw.pci_base1 + (off) - SECOND_PAGE_GROUP_START)
 800 #define PCI_OFFSET_THIRD_RANGE(adapter, off)    \
 801         ((adapter)->ahw.pci_base2 + (off) - THIRD_PAGE_GROUP_START)
 802
 803 static inline void __iomem *pci_base_offset(struct netxen_adapter *adapter,
 804                                             unsigned long off)
 805 {
 806         if ((off < FIRST_PAGE_GROUP_END) && (off >= FIRST_PAGE_GROUP_START)) {
 807                 return (adapter->ahw.pci_base0 + off);
 808         } else if ((off < SECOND_PAGE_GROUP_END) &&
 809                    (off >= SECOND_PAGE_GROUP_START)) {
 810                 return (adapter->ahw.pci_base1 + off - SECOND_PAGE_GROUP_START);
 811         } else if ((off < THIRD_PAGE_GROUP_END) &&
 812                    (off >= THIRD_PAGE_GROUP_START)) {
 813                 return (adapter->ahw.pci_base2 + off - THIRD_PAGE_GROUP_START);
 814         }
 815         return NULL;
 816 }
 817
 818 static inline void __iomem *pci_base(struct netxen_adapter *adapter,
 819                                      unsigned long off)
 820 {
 821         if ((off < FIRST_PAGE_GROUP_END) && (off >= FIRST_PAGE_GROUP_START)) {
 822                 return adapter->ahw.pci_base0;
 823         } else if ((off < SECOND_PAGE_GROUP_END) &&
 824                    (off >= SECOND_PAGE_GROUP_START)) {
 825                 return adapter->ahw.pci_base1;
 826         } else if ((off < THIRD_PAGE_GROUP_END) &&
 827                    (off >= THIRD_PAGE_GROUP_START)) {
 828                 return adapter->ahw.pci_base2;
 829         }
 830         return NULL;
 831 }
 832
 833 struct netxen_drvops {
 834         int (*enable_phy_interrupts) (struct netxen_adapter *, int);
 835         int (*disable_phy_interrupts) (struct netxen_adapter *, int);
 836         void (*handle_phy_intr) (struct netxen_adapter *);
 837         int (*macaddr_set) (struct netxen_port *, netxen_ethernet_macaddr_t);
 838         int (*set_mtu) (struct netxen_port *, int);
 839         int (*set_promisc) (struct netxen_adapter *, int,
 840                             netxen_niu_prom_mode_t);
 841         int (*unset_promisc) (struct netxen_adapter *, int,
 842                               netxen_niu_prom_mode_t);
 843         int (*phy_read) (struct netxen_adapter *, long phy, long reg, u32 *);
 844         int (*phy_write) (struct netxen_adapter *, long phy, long reg, u32 val);
 845         int (*init_port) (struct netxen_adapter *, int);
 846         void (*init_niu) (struct netxen_adapter *);
 847         int (*stop_port) (struct netxen_adapter *, int);
 848 };
 849
 850 extern char netxen_nic_driver_name[];
 851
 852 int netxen_niu_xgbe_enable_phy_interrupts(struct netxen_adapter *adapter,
 853                                           int port);
 854 int netxen_niu_gbe_enable_phy_interrupts(struct netxen_adapter *adapter,
 855                                          int port);
 856 int netxen_niu_xgbe_disable_phy_interrupts(struct netxen_adapter *adapter,
 857                                            int port);
 858 int netxen_niu_gbe_disable_phy_interrupts(struct netxen_adapter *adapter,
 859                                           int port);
 860 int netxen_niu_xgbe_clear_phy_interrupts(struct netxen_adapter *adapter,
 861                                          int port);
 862 int netxen_niu_gbe_clear_phy_interrupts(struct netxen_adapter *adapter,
 863                                         int port);
 864 void netxen_nic_xgbe_handle_phy_intr(struct netxen_adapter *adapter);
 865 void netxen_nic_gbe_handle_phy_intr(struct netxen_adapter *adapter);
 866 void netxen_niu_gbe_set_mii_mode(struct netxen_adapter *adapter, int port,
 867                                  long enable);
 868 void netxen_niu_gbe_set_gmii_mode(struct netxen_adapter *adapter, int port,
 869                                   long enable);
 870 int netxen_niu_gbe_phy_read(struct netxen_adapter *adapter, long phy, long reg,
 871                             __le32 * readval);
 872 int netxen_niu_gbe_phy_write(struct netxen_adapter *adapter, long phy,
 873                              long reg, __le32 val);
 874
 875 /* Functions available from netxen_nic_hw.c */
 876 int netxen_nic_set_mtu_xgb(struct netxen_port *port, int new_mtu);
 877 int netxen_nic_set_mtu_gb(struct netxen_port *port, int new_mtu);
 878 void netxen_nic_init_niu_gb(struct netxen_adapter *adapter);
 879 void netxen_nic_pci_change_crbwindow(struct netxen_adapter *adapter, u32 wndw);
 880 void netxen_nic_reg_write(struct netxen_adapter *adapter, u64 off, u32 val);
 881 int netxen_nic_reg_read(struct netxen_adapter *adapter, u64 off);
 882 void netxen_nic_write_w0(struct netxen_adapter *adapter, u32 index, u32 value);
 883 void netxen_nic_read_w0(struct netxen_adapter *adapter, u32 index, u32 * value);
 884
 885 int netxen_nic_get_board_info(struct netxen_adapter *adapter);
 886 int netxen_nic_hw_read_wx(struct netxen_adapter *adapter, u64 off, void *data,
 887                           int len);
 888 int netxen_nic_hw_write_wx(struct netxen_adapter *adapter, u64 off, void *data,
 889                            int len);
 890 void netxen_crb_writelit_adapter(struct netxen_adapter *adapter,
 891                                  unsigned long off, int data);
 892
 893 /* Functions from netxen_nic_init.c */
 894 void netxen_phantom_init(struct netxen_adapter *adapter, int pegtune_val);
 895 void netxen_load_firmware(struct netxen_adapter *adapter);
 896 int netxen_pinit_from_rom(struct netxen_adapter *adapter, int verbose);
 897 int netxen_rom_fast_read(struct netxen_adapter *adapter, int addr, int *valp);
 898 int netxen_rom_fast_write(struct netxen_adapter *adapter, int addr, int data);
 899 int netxen_rom_se(struct netxen_adapter *adapter, int addr);
 900 int netxen_do_rom_se(struct netxen_adapter *adapter, int addr);
 901
 902 /* Functions from netxen_nic_isr.c */
 903 void netxen_nic_isr_other(struct netxen_adapter *adapter);
 904 void netxen_indicate_link_status(struct netxen_adapter *adapter, u32 port,
 905                                  u32 link);
 906 void netxen_handle_port_int(struct netxen_adapter *adapter, u32 port,
 907                             u32 enable);
 908 void netxen_nic_stop_all_ports(struct netxen_adapter *adapter);
 909 void netxen_initialize_adapter_sw(struct netxen_adapter *adapter);
 910 void netxen_initialize_adapter_hw(struct netxen_adapter *adapter);
 911 void *netxen_alloc(struct pci_dev *pdev, size_t sz, dma_addr_t * ptr,
 912                    struct pci_dev **used_dev);
 913 void netxen_initialize_adapter_ops(struct netxen_adapter *adapter);
 914 int netxen_init_firmware(struct netxen_adapter *adapter);
 915 void netxen_free_hw_resources(struct netxen_adapter *adapter);
 916 void netxen_tso_check(struct netxen_adapter *adapter,
 917                       struct cmd_desc_type0 *desc, struct sk_buff *skb);
 918 int netxen_nic_hw_resources(struct netxen_adapter *adapter);
 919 void netxen_nic_clear_stats(struct netxen_adapter *adapter);
 920 int
 921 netxen_nic_do_ioctl(struct netxen_adapter *adapter, void *u_data,
 922                     struct netxen_port *port);
 923 int netxen_nic_rx_has_work(struct netxen_adapter *adapter);
 924 int netxen_nic_tx_has_work(struct netxen_adapter *adapter);
 925 void netxen_watchdog_task(unsigned long v);
 926 void netxen_post_rx_buffers(struct netxen_adapter *adapter, u32 ctx,
 927                             u32 ringid);
 928 void netxen_process_cmd_ring(unsigned long data);
 929 u32 netxen_process_rcv_ring(struct netxen_adapter *adapter, int ctx, int max);
 930 void netxen_nic_set_multi(struct net_device *netdev);
 931 int netxen_nic_change_mtu(struct net_device *netdev, int new_mtu);
 932 int netxen_nic_set_mac(struct net_device *netdev, void *p);
 933 struct net_device_stats *netxen_nic_get_stats(struct net_device *netdev);
 934
 935 static inline void netxen_nic_disable_int(struct netxen_adapter *adapter)
 936 {
 937         /*
 938          * ISR_INT_MASK: Can be read from window 0 or 1.
 939          */
 940         writel(0x7ff,
 941                (void __iomem
 942                 *)(PCI_OFFSET_SECOND_RANGE(adapter, ISR_INT_MASK)));
 943
 944 }
 945
 946 static inline void netxen_nic_enable_int(struct netxen_adapter *adapter)
 947 {
 948         u32 mask;
 949
 950         switch (adapter->ahw.board_type) {
 951         case NETXEN_NIC_GBE:
 952                 mask = 0x77b;
 953                 break;
 954         case NETXEN_NIC_XGBE:
 955                 mask = 0x77f;
 956                 break;
 957         default:
 958                 mask = 0x7ff;
 959                 break;
 960         }
 961
 962         writel(mask,
 963                (void __iomem
 964                 *)(PCI_OFFSET_SECOND_RANGE(adapter, ISR_INT_MASK)));
 965
 966         if (!(adapter->flags & NETXEN_NIC_MSI_ENABLED)) {
 967                 mask = 0xbff;
 968                 writel(mask, (void __iomem *)
 969                        (PCI_OFFSET_SECOND_RANGE(adapter, ISR_INT_TARGET_MASK)));
 970         }
 971 }
 972
 973 /*
 974  * NetXen Board information
 975  */
 976
 977 #define NETXEN_MAX_SHORT_NAME 16
 978 typedef struct {
 979         netxen_brdtype_t brdtype;       /* type of board */
 980         long ports;             /* max no of physical ports */
 981         char short_name[NETXEN_MAX_SHORT_NAME];
 982 } netxen_brdinfo_t;
 983
 984 static const netxen_brdinfo_t netxen_boards[] = {
 985         {NETXEN_BRDTYPE_P2_SB31_10G_CX4, 1, "XGb CX4"},
 986         {NETXEN_BRDTYPE_P2_SB31_10G_HMEZ, 1, "XGb HMEZ"},
 987         {NETXEN_BRDTYPE_P2_SB31_10G_IMEZ, 2, "XGb IMEZ"},
 988         {NETXEN_BRDTYPE_P2_SB31_10G, 1, "XGb XFP"},
 989         {NETXEN_BRDTYPE_P2_SB35_4G, 4, "Quad Gb"},
 990         {NETXEN_BRDTYPE_P2_SB31_2G, 2, "Dual Gb"},
 991 };
 992
 993 #define NUM_SUPPORTED_BOARDS (sizeof(netxen_boards)/sizeof(netxen_brdinfo_t))
 994
 995 static inline void get_brd_ports_name_by_type(u32 type, int *ports, char *name)
 996 {
 997         int i, found = 0;
 998         for (i = 0; i < NUM_SUPPORTED_BOARDS; ++i) {
 999                 if (netxen_boards[i].brdtype == type) {
1000                         *ports = netxen_boards[i].ports;
1001                         strcpy(name, netxen_boards[i].short_name);
1002                         found = 1;
1003                         break;
1004                 }
1005         }
1006         if (!found) {
1007                 *ports = 0;
1008                 name = "Unknown";
1009         }
1010 }
1011
1012 static inline void get_brd_port_by_type(u32 type, int *ports)
1013 {
1014         int i, found = 0;
1015         for (i = 0; i < NUM_SUPPORTED_BOARDS; ++i) {
1016                 if (netxen_boards[i].brdtype == type) {
1017                         *ports = netxen_boards[i].ports;
1018                         found = 1;
1019                         break;
1020                 }
1021         }
1022         if (!found)
1023                 *ports = 0;
1024 }
1025
1026 static inline void get_brd_name_by_type(u32 type, char *name)
1027 {
1028         int i, found = 0;
1029         for (i = 0; i < NUM_SUPPORTED_BOARDS; ++i) {
1030                 if (netxen_boards[i].brdtype == type) {
1031                         strcpy(name, netxen_boards[i].short_name);
1032                         found = 1;
1033                         break;
1034                 }
1035
1036         }
1037         if (!found)
1038                 name = "Unknown";
1039 }
1040
1041 int netxen_is_flash_supported(struct netxen_adapter *adapter);
1042 int netxen_get_flash_mac_addr(struct netxen_adapter *adapter, u64 mac[]);
1043
1044 extern void netxen_change_ringparam(struct netxen_adapter *adapter);
1045 extern int netxen_rom_fast_read(struct netxen_adapter *adapter, int addr,
1046                                 int *valp);
1047
1048 extern struct ethtool_ops netxen_nic_ethtool_ops;
1049
1050 #endif                          /* __NETXEN_NIC_H_ */