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