drivers/net/s2io.h

   1 /************************************************************************
   2  * s2io.h: A Linux PCI-X Ethernet driver for Neterion 10GbE Server NIC
   3  * Copyright(c) 2002-2007 Neterion Inc.
   4
   5  * This software may be used and distributed according to the terms of
   6  * the GNU General Public License (GPL), incorporated herein by reference.
   7  * Drivers based on or derived from this code fall under the GPL and must
   8  * retain the authorship, copyright and license notice.  This file is not
   9  * a complete program and may only be used when the entire operating
  10  * system is licensed under the GPL.
  11  * See the file COPYING in this distribution for more information.
  12  ************************************************************************/
  13 #ifndef _S2IO_H
  14 #define _S2IO_H
  15
  16 #define TBD 0
  17 #define BIT(loc)                (0x8000000000000000ULL >> (loc))
  18 #define vBIT(val, loc, sz)      (((u64)val) << (64-loc-sz))
  19 #define INV(d)  ((d&0xff)<<24) | (((d>>8)&0xff)<<16) | (((d>>16)&0xff)<<8)| ((d>>24)&0xff)
  20
  21 #ifndef BOOL
  22 #define BOOL    int
  23 #endif
  24
  25 #ifndef TRUE
  26 #define TRUE    1
  27 #define FALSE   0
  28 #endif
  29
  30 #undef SUCCESS
  31 #define SUCCESS 0
  32 #define FAILURE -1
  33 #define S2IO_MINUS_ONE 0xFFFFFFFFFFFFFFFFULL
  34 #define S2IO_MAX_PCI_CONFIG_SPACE_REINIT 100
  35 #define S2IO_BIT_RESET 1
  36 #define S2IO_BIT_SET 2
  37 #define CHECKBIT(value, nbit) (value & (1 << nbit))
  38
  39 /* Maximum time to flicker LED when asked to identify NIC using ethtool */
  40 #define MAX_FLICKER_TIME        60000 /* 60 Secs */
  41
  42 /* Maximum outstanding splits to be configured into xena. */
  43 enum {
  44         XENA_ONE_SPLIT_TRANSACTION = 0,
  45         XENA_TWO_SPLIT_TRANSACTION = 1,
  46         XENA_THREE_SPLIT_TRANSACTION = 2,
  47         XENA_FOUR_SPLIT_TRANSACTION = 3,
  48         XENA_EIGHT_SPLIT_TRANSACTION = 4,
  49         XENA_TWELVE_SPLIT_TRANSACTION = 5,
  50         XENA_SIXTEEN_SPLIT_TRANSACTION = 6,
  51         XENA_THIRTYTWO_SPLIT_TRANSACTION = 7
  52 };
  53 #define XENA_MAX_OUTSTANDING_SPLITS(n) (n << 4)
  54
  55 /*  OS concerned variables and constants */
  56 #define WATCH_DOG_TIMEOUT               15*HZ
  57 #define EFILL                           0x1234
  58 #define ALIGN_SIZE                      127
  59 #define PCIX_COMMAND_REGISTER           0x62
  60
  61 /*
  62  * Debug related variables.
  63  */
  64 /* different debug levels. */
  65 #define ERR_DBG         0
  66 #define INIT_DBG        1
  67 #define INFO_DBG        2
  68 #define TX_DBG          3
  69 #define INTR_DBG        4
  70
  71 /* Global variable that defines the present debug level of the driver. */
  72 static int debug_level = ERR_DBG;
  73
  74 /* DEBUG message print. */
  75 #define DBG_PRINT(dbg_level, args...)  if(!(debug_level<dbg_level)) printk(args)
  76
  77 /* Protocol assist features of the NIC */
  78 #define L3_CKSUM_OK 0xFFFF
  79 #define L4_CKSUM_OK 0xFFFF
  80 #define S2IO_JUMBO_SIZE 9600
  81
  82 /* Driver statistics maintained by driver */
  83 struct swStat {
  84         unsigned long long single_ecc_errs;
  85         unsigned long long double_ecc_errs;
  86         unsigned long long parity_err_cnt;
  87         unsigned long long serious_err_cnt;
  88         unsigned long long soft_reset_cnt;
  89         unsigned long long fifo_full_cnt;
  90         unsigned long long ring_full_cnt;
  91         /* LRO statistics */
  92         unsigned long long clubbed_frms_cnt;
  93         unsigned long long sending_both;
  94         unsigned long long outof_sequence_pkts;
  95         unsigned long long flush_max_pkts;
  96         unsigned long long sum_avg_pkts_aggregated;
  97         unsigned long long num_aggregations;
  98 };
  99
 100 /* Xpak releated alarm and warnings */
 101 struct xpakStat {
 102         u64 alarm_transceiver_temp_high;
 103         u64 alarm_transceiver_temp_low;
 104         u64 alarm_laser_bias_current_high;
 105         u64 alarm_laser_bias_current_low;
 106         u64 alarm_laser_output_power_high;
 107         u64 alarm_laser_output_power_low;
 108         u64 warn_transceiver_temp_high;
 109         u64 warn_transceiver_temp_low;
 110         u64 warn_laser_bias_current_high;
 111         u64 warn_laser_bias_current_low;
 112         u64 warn_laser_output_power_high;
 113         u64 warn_laser_output_power_low;
 114         u64 xpak_regs_stat;
 115         u32 xpak_timer_count;
 116 };
 117
 118
 119 /* The statistics block of Xena */
 120 struct stat_block {
 121 /* Tx MAC statistics counters. */
 122         __le32 tmac_data_octets;
 123         __le32 tmac_frms;
 124         __le64 tmac_drop_frms;
 125         __le32 tmac_bcst_frms;
 126         __le32 tmac_mcst_frms;
 127         __le64 tmac_pause_ctrl_frms;
 128         __le32 tmac_ucst_frms;
 129         __le32 tmac_ttl_octets;
 130         __le32 tmac_any_err_frms;
 131         __le32 tmac_nucst_frms;
 132         __le64 tmac_ttl_less_fb_octets;
 133         __le64 tmac_vld_ip_octets;
 134         __le32 tmac_drop_ip;
 135         __le32 tmac_vld_ip;
 136         __le32 tmac_rst_tcp;
 137         __le32 tmac_icmp;
 138         __le64 tmac_tcp;
 139         __le32 reserved_0;
 140         __le32 tmac_udp;
 141
 142 /* Rx MAC Statistics counters. */
 143         __le32 rmac_data_octets;
 144         __le32 rmac_vld_frms;
 145         __le64 rmac_fcs_err_frms;
 146         __le64 rmac_drop_frms;
 147         __le32 rmac_vld_bcst_frms;
 148         __le32 rmac_vld_mcst_frms;
 149         __le32 rmac_out_rng_len_err_frms;
 150         __le32 rmac_in_rng_len_err_frms;
 151         __le64 rmac_long_frms;
 152         __le64 rmac_pause_ctrl_frms;
 153         __le64 rmac_unsup_ctrl_frms;
 154         __le32 rmac_accepted_ucst_frms;
 155         __le32 rmac_ttl_octets;
 156         __le32 rmac_discarded_frms;
 157         __le32 rmac_accepted_nucst_frms;
 158         __le32 reserved_1;
 159         __le32 rmac_drop_events;
 160         __le64 rmac_ttl_less_fb_octets;
 161         __le64 rmac_ttl_frms;
 162         __le64 reserved_2;
 163         __le32 rmac_usized_frms;
 164         __le32 reserved_3;
 165         __le32 rmac_frag_frms;
 166         __le32 rmac_osized_frms;
 167         __le32 reserved_4;
 168         __le32 rmac_jabber_frms;
 169         __le64 rmac_ttl_64_frms;
 170         __le64 rmac_ttl_65_127_frms;
 171         __le64 reserved_5;
 172         __le64 rmac_ttl_128_255_frms;
 173         __le64 rmac_ttl_256_511_frms;
 174         __le64 reserved_6;
 175         __le64 rmac_ttl_512_1023_frms;
 176         __le64 rmac_ttl_1024_1518_frms;
 177         __le32 rmac_ip;
 178         __le32 reserved_7;
 179         __le64 rmac_ip_octets;
 180         __le32 rmac_drop_ip;
 181         __le32 rmac_hdr_err_ip;
 182         __le32 reserved_8;
 183         __le32 rmac_icmp;
 184         __le64 rmac_tcp;
 185         __le32 rmac_err_drp_udp;
 186         __le32 rmac_udp;
 187         __le64 rmac_xgmii_err_sym;
 188         __le64 rmac_frms_q0;
 189         __le64 rmac_frms_q1;
 190         __le64 rmac_frms_q2;
 191         __le64 rmac_frms_q3;
 192         __le64 rmac_frms_q4;
 193         __le64 rmac_frms_q5;
 194         __le64 rmac_frms_q6;
 195         __le64 rmac_frms_q7;
 196         __le16 rmac_full_q3;
 197         __le16 rmac_full_q2;
 198         __le16 rmac_full_q1;
 199         __le16 rmac_full_q0;
 200         __le16 rmac_full_q7;
 201         __le16 rmac_full_q6;
 202         __le16 rmac_full_q5;
 203         __le16 rmac_full_q4;
 204         __le32 reserved_9;
 205         __le32 rmac_pause_cnt;
 206         __le64 rmac_xgmii_data_err_cnt;
 207         __le64 rmac_xgmii_ctrl_err_cnt;
 208         __le32 rmac_err_tcp;
 209         __le32 rmac_accepted_ip;
 210
 211 /* PCI/PCI-X Read transaction statistics. */
 212         __le32 new_rd_req_cnt;
 213         __le32 rd_req_cnt;
 214         __le32 rd_rtry_cnt;
 215         __le32 new_rd_req_rtry_cnt;
 216
 217 /* PCI/PCI-X Write/Read transaction statistics. */
 218         __le32 wr_req_cnt;
 219         __le32 wr_rtry_rd_ack_cnt;
 220         __le32 new_wr_req_rtry_cnt;
 221         __le32 new_wr_req_cnt;
 222         __le32 wr_disc_cnt;
 223         __le32 wr_rtry_cnt;
 224
 225 /*      PCI/PCI-X Write / DMA Transaction statistics. */
 226         __le32 txp_wr_cnt;
 227         __le32 rd_rtry_wr_ack_cnt;
 228         __le32 txd_wr_cnt;
 229         __le32 txd_rd_cnt;
 230         __le32 rxd_wr_cnt;
 231         __le32 rxd_rd_cnt;
 232         __le32 rxf_wr_cnt;
 233         __le32 txf_rd_cnt;
 234
 235 /* Tx MAC statistics overflow counters. */
 236         __le32 tmac_data_octets_oflow;
 237         __le32 tmac_frms_oflow;
 238         __le32 tmac_bcst_frms_oflow;
 239         __le32 tmac_mcst_frms_oflow;
 240         __le32 tmac_ucst_frms_oflow;
 241         __le32 tmac_ttl_octets_oflow;
 242         __le32 tmac_any_err_frms_oflow;
 243         __le32 tmac_nucst_frms_oflow;
 244         __le64 tmac_vlan_frms;
 245         __le32 tmac_drop_ip_oflow;
 246         __le32 tmac_vld_ip_oflow;
 247         __le32 tmac_rst_tcp_oflow;
 248         __le32 tmac_icmp_oflow;
 249         __le32 tpa_unknown_protocol;
 250         __le32 tmac_udp_oflow;
 251         __le32 reserved_10;
 252         __le32 tpa_parse_failure;
 253
 254 /* Rx MAC Statistics overflow counters. */
 255         __le32 rmac_data_octets_oflow;
 256         __le32 rmac_vld_frms_oflow;
 257         __le32 rmac_vld_bcst_frms_oflow;
 258         __le32 rmac_vld_mcst_frms_oflow;
 259         __le32 rmac_accepted_ucst_frms_oflow;
 260         __le32 rmac_ttl_octets_oflow;
 261         __le32 rmac_discarded_frms_oflow;
 262         __le32 rmac_accepted_nucst_frms_oflow;
 263         __le32 rmac_usized_frms_oflow;
 264         __le32 rmac_drop_events_oflow;
 265         __le32 rmac_frag_frms_oflow;
 266         __le32 rmac_osized_frms_oflow;
 267         __le32 rmac_ip_oflow;
 268         __le32 rmac_jabber_frms_oflow;
 269         __le32 rmac_icmp_oflow;
 270         __le32 rmac_drop_ip_oflow;
 271         __le32 rmac_err_drp_udp_oflow;
 272         __le32 rmac_udp_oflow;
 273         __le32 reserved_11;
 274         __le32 rmac_pause_cnt_oflow;
 275         __le64 rmac_ttl_1519_4095_frms;
 276         __le64 rmac_ttl_4096_8191_frms;
 277         __le64 rmac_ttl_8192_max_frms;
 278         __le64 rmac_ttl_gt_max_frms;
 279         __le64 rmac_osized_alt_frms;
 280         __le64 rmac_jabber_alt_frms;
 281         __le64 rmac_gt_max_alt_frms;
 282         __le64 rmac_vlan_frms;
 283         __le32 rmac_len_discard;
 284         __le32 rmac_fcs_discard;
 285         __le32 rmac_pf_discard;
 286         __le32 rmac_da_discard;
 287         __le32 rmac_red_discard;
 288         __le32 rmac_rts_discard;
 289         __le32 reserved_12;
 290         __le32 rmac_ingm_full_discard;
 291         __le32 reserved_13;
 292         __le32 rmac_accepted_ip_oflow;
 293         __le32 reserved_14;
 294         __le32 link_fault_cnt;
 295         u8  buffer[20];
 296         struct swStat sw_stat;
 297         struct xpakStat xpak_stat;
 298 };
 299
 300 /* Default value for 'vlan_strip_tag' configuration parameter */
 301 #define NO_STRIP_IN_PROMISC 2
 302
 303 /*
 304  * Structures representing different init time configuration
 305  * parameters of the NIC.
 306  */
 307
 308 #define MAX_TX_FIFOS 8
 309 #define MAX_RX_RINGS 8
 310
 311 /* FIFO mappings for all possible number of fifos configured */
 312 static int fifo_map[][MAX_TX_FIFOS] = {
 313         {0, 0, 0, 0, 0, 0, 0, 0},
 314         {0, 0, 0, 0, 1, 1, 1, 1},
 315         {0, 0, 0, 1, 1, 1, 2, 2},
 316         {0, 0, 1, 1, 2, 2, 3, 3},
 317         {0, 0, 1, 1, 2, 2, 3, 4},
 318         {0, 0, 1, 1, 2, 3, 4, 5},
 319         {0, 0, 1, 2, 3, 4, 5, 6},
 320         {0, 1, 2, 3, 4, 5, 6, 7},
 321 };
 322
 323 /* Maintains Per FIFO related information. */
 324 struct tx_fifo_config {
 325 #define MAX_AVAILABLE_TXDS      8192
 326         u32 fifo_len;           /* specifies len of FIFO upto 8192, ie no of TxDLs */
 327 /* Priority definition */
 328 #define TX_FIFO_PRI_0               0   /*Highest */
 329 #define TX_FIFO_PRI_1               1
 330 #define TX_FIFO_PRI_2               2
 331 #define TX_FIFO_PRI_3               3
 332 #define TX_FIFO_PRI_4               4
 333 #define TX_FIFO_PRI_5               5
 334 #define TX_FIFO_PRI_6               6
 335 #define TX_FIFO_PRI_7               7   /*lowest */
 336         u8 fifo_priority;       /* specifies pointer level for FIFO */
 337         /* user should not set twos fifos with same pri */
 338         u8 f_no_snoop;
 339 #define NO_SNOOP_TXD                0x01
 340 #define NO_SNOOP_TXD_BUFFER          0x02
 341 };
 342
 343
 344 /* Maintains per Ring related information */
 345 struct rx_ring_config {
 346         u32 num_rxd;            /*No of RxDs per Rx Ring */
 347 #define RX_RING_PRI_0               0   /* highest */
 348 #define RX_RING_PRI_1               1
 349 #define RX_RING_PRI_2               2
 350 #define RX_RING_PRI_3               3
 351 #define RX_RING_PRI_4               4
 352 #define RX_RING_PRI_5               5
 353 #define RX_RING_PRI_6               6
 354 #define RX_RING_PRI_7               7   /* lowest */
 355
 356         u8 ring_priority;       /*Specifies service priority of ring */
 357         /* OSM should not set any two rings with same priority */
 358         u8 ring_org;            /*Organization of ring */
 359 #define RING_ORG_BUFF1          0x01
 360 #define RX_RING_ORG_BUFF3       0x03
 361 #define RX_RING_ORG_BUFF5       0x05
 362
 363         u8 f_no_snoop;
 364 #define NO_SNOOP_RXD                0x01
 365 #define NO_SNOOP_RXD_BUFFER         0x02
 366 };
 367
 368 /* This structure provides contains values of the tunable parameters
 369  * of the H/W
 370  */
 371 struct config_param {
 372 /* Tx Side */
 373         u32 tx_fifo_num;        /*Number of Tx FIFOs */
 374
 375         u8 fifo_mapping[MAX_TX_FIFOS];
 376         struct tx_fifo_config tx_cfg[MAX_TX_FIFOS];     /*Per-Tx FIFO config */
 377         u32 max_txds;           /*Max no. of Tx buffer descriptor per TxDL */
 378         u64 tx_intr_type;
 379         /* Specifies if Tx Intr is UTILZ or PER_LIST type. */
 380
 381 /* Rx Side */
 382         u32 rx_ring_num;        /*Number of receive rings */
 383 #define MAX_RX_BLOCKS_PER_RING  150
 384
 385         struct rx_ring_config rx_cfg[MAX_RX_RINGS];     /*Per-Rx Ring config */
 386         u8 bimodal;             /*Flag for setting bimodal interrupts*/
 387
 388 #define HEADER_ETHERNET_II_802_3_SIZE 14
 389 #define HEADER_802_2_SIZE              3
 390 #define HEADER_SNAP_SIZE               5
 391 #define HEADER_VLAN_SIZE               4
 392
 393 #define MIN_MTU                       46
 394 #define MAX_PYLD                    1500
 395 #define MAX_MTU                     (MAX_PYLD+18)
 396 #define MAX_MTU_VLAN                (MAX_PYLD+22)
 397 #define MAX_PYLD_JUMBO              9600
 398 #define MAX_MTU_JUMBO               (MAX_PYLD_JUMBO+18)
 399 #define MAX_MTU_JUMBO_VLAN          (MAX_PYLD_JUMBO+22)
 400         u16 bus_speed;
 401 };
 402
 403 /* Structure representing MAC Addrs */
 404 struct mac_addr {
 405         u8 mac_addr[ETH_ALEN];
 406 };
 407
 408 /* Structure that represent every FIFO element in the BAR1
 409  * Address location.
 410  */
 411 struct TxFIFO_element {
 412         u64 TxDL_Pointer;
 413
 414         u64 List_Control;
 415 #define TX_FIFO_LAST_TXD_NUM( val)     vBIT(val,0,8)
 416 #define TX_FIFO_FIRST_LIST             BIT(14)
 417 #define TX_FIFO_LAST_LIST              BIT(15)
 418 #define TX_FIFO_FIRSTNLAST_LIST        vBIT(3,14,2)
 419 #define TX_FIFO_SPECIAL_FUNC           BIT(23)
 420 #define TX_FIFO_DS_NO_SNOOP            BIT(31)
 421 #define TX_FIFO_BUFF_NO_SNOOP          BIT(30)
 422 };
 423
 424 /* Tx descriptor structure */
 425 struct TxD {
 426         u64 Control_1;
 427 /* bit mask */
 428 #define TXD_LIST_OWN_XENA       BIT(7)
 429 #define TXD_T_CODE              (BIT(12)|BIT(13)|BIT(14)|BIT(15))
 430 #define TXD_T_CODE_OK(val)      (|(val & TXD_T_CODE))
 431 #define GET_TXD_T_CODE(val)     ((val & TXD_T_CODE)<<12)
 432 #define TXD_GATHER_CODE         (BIT(22) | BIT(23))
 433 #define TXD_GATHER_CODE_FIRST   BIT(22)
 434 #define TXD_GATHER_CODE_LAST    BIT(23)
 435 #define TXD_TCP_LSO_EN          BIT(30)
 436 #define TXD_UDP_COF_EN          BIT(31)
 437 #define TXD_UFO_EN              BIT(31) | BIT(30)
 438 #define TXD_TCP_LSO_MSS(val)    vBIT(val,34,14)
 439 #define TXD_UFO_MSS(val)        vBIT(val,34,14)
 440 #define TXD_BUFFER0_SIZE(val)   vBIT(val,48,16)
 441
 442         u64 Control_2;
 443 #define TXD_TX_CKO_CONTROL      (BIT(5)|BIT(6)|BIT(7))
 444 #define TXD_TX_CKO_IPV4_EN      BIT(5)
 445 #define TXD_TX_CKO_TCP_EN       BIT(6)
 446 #define TXD_TX_CKO_UDP_EN       BIT(7)
 447 #define TXD_VLAN_ENABLE         BIT(15)
 448 #define TXD_VLAN_TAG(val)       vBIT(val,16,16)
 449 #define TXD_INT_NUMBER(val)     vBIT(val,34,6)
 450 #define TXD_INT_TYPE_PER_LIST   BIT(47)
 451 #define TXD_INT_TYPE_UTILZ      BIT(46)
 452 #define TXD_SET_MARKER         vBIT(0x6,0,4)
 453
 454         u64 Buffer_Pointer;
 455         u64 Host_Control;       /* reserved for host */
 456 };
 457
 458 /* Structure to hold the phy and virt addr of every TxDL. */
 459 struct list_info_hold {
 460         dma_addr_t list_phy_addr;
 461         void *list_virt_addr;
 462 };
 463
 464 /* Rx descriptor structure for 1 buffer mode */
 465 struct RxD_t {
 466         u64 Host_Control;       /* reserved for host */
 467         u64 Control_1;
 468 #define RXD_OWN_XENA            BIT(7)
 469 #define RXD_T_CODE              (BIT(12)|BIT(13)|BIT(14)|BIT(15))
 470 #define RXD_FRAME_PROTO         vBIT(0xFFFF,24,8)
 471 #define RXD_FRAME_PROTO_IPV4    BIT(27)
 472 #define RXD_FRAME_PROTO_IPV6    BIT(28)
 473 #define RXD_FRAME_IP_FRAG       BIT(29)
 474 #define RXD_FRAME_PROTO_TCP     BIT(30)
 475 #define RXD_FRAME_PROTO_UDP     BIT(31)
 476 #define TCP_OR_UDP_FRAME        (RXD_FRAME_PROTO_TCP | RXD_FRAME_PROTO_UDP)
 477 #define RXD_GET_L3_CKSUM(val)   ((u16)(val>> 16) & 0xFFFF)
 478 #define RXD_GET_L4_CKSUM(val)   ((u16)(val) & 0xFFFF)
 479
 480         u64 Control_2;
 481 #define THE_RXD_MARK            0x3
 482 #define SET_RXD_MARKER          vBIT(THE_RXD_MARK, 0, 2)
 483 #define GET_RXD_MARKER(ctrl)    ((ctrl & SET_RXD_MARKER) >> 62)
 484
 485 #define MASK_VLAN_TAG           vBIT(0xFFFF,48,16)
 486 #define SET_VLAN_TAG(val)       vBIT(val,48,16)
 487 #define SET_NUM_TAG(val)       vBIT(val,16,32)
 488
 489
 490 };
 491 /* Rx descriptor structure for 1 buffer mode */
 492 struct RxD1 {
 493         struct RxD_t h;
 494
 495 #define MASK_BUFFER0_SIZE_1       vBIT(0x3FFF,2,14)
 496 #define SET_BUFFER0_SIZE_1(val)   vBIT(val,2,14)
 497 #define RXD_GET_BUFFER0_SIZE_1(_Control_2) \
 498         (u16)((_Control_2 & MASK_BUFFER0_SIZE_1) >> 48)
 499         u64 Buffer0_ptr;
 500 };
 501 /* Rx descriptor structure for 3 or 2 buffer mode */
 502
 503 struct RxD3 {
 504         struct RxD_t h;
 505
 506 #define MASK_BUFFER0_SIZE_3       vBIT(0xFF,2,14)
 507 #define MASK_BUFFER1_SIZE_3       vBIT(0xFFFF,16,16)
 508 #define MASK_BUFFER2_SIZE_3       vBIT(0xFFFF,32,16)
 509 #define SET_BUFFER0_SIZE_3(val)   vBIT(val,8,8)
 510 #define SET_BUFFER1_SIZE_3(val)   vBIT(val,16,16)
 511 #define SET_BUFFER2_SIZE_3(val)   vBIT(val,32,16)
 512 #define RXD_GET_BUFFER0_SIZE_3(Control_2) \
 513         (u8)((Control_2 & MASK_BUFFER0_SIZE_3) >> 48)
 514 #define RXD_GET_BUFFER1_SIZE_3(Control_2) \
 515         (u16)((Control_2 & MASK_BUFFER1_SIZE_3) >> 32)
 516 #define RXD_GET_BUFFER2_SIZE_3(Control_2) \
 517         (u16)((Control_2 & MASK_BUFFER2_SIZE_3) >> 16)
 518 #define BUF0_LEN        40
 519 #define BUF1_LEN        1
 520
 521         u64 Buffer0_ptr;
 522         u64 Buffer1_ptr;
 523         u64 Buffer2_ptr;
 524 };
 525
 526
 527 /* Structure that represents the Rx descriptor block which contains
 528  * 128 Rx descriptors.
 529  */
 530 struct RxD_block {
 531 #define MAX_RXDS_PER_BLOCK_1            127
 532         struct RxD1 rxd[MAX_RXDS_PER_BLOCK_1];
 533
 534         u64 reserved_0;
 535 #define END_OF_BLOCK    0xFEFFFFFFFFFFFFFFULL
 536         u64 reserved_1;         /* 0xFEFFFFFFFFFFFFFF to mark last
 537                                  * Rxd in this blk */
 538         u64 reserved_2_pNext_RxD_block; /* Logical ptr to next */
 539         u64 pNext_RxD_Blk_physical;     /* Buff0_ptr.In a 32 bit arch
 540                                          * the upper 32 bits should
 541                                          * be 0 */
 542 };
 543
 544 #define SIZE_OF_BLOCK   4096
 545
 546 #define RXD_MODE_1      0 /* One Buffer mode */
 547 #define RXD_MODE_3A     1 /* Three Buffer mode */
 548 #define RXD_MODE_3B     2 /* Two Buffer mode */
 549
 550 /* Structure to hold virtual addresses of Buf0 and Buf1 in
 551  * 2buf mode. */
 552 struct buffAdd {
 553         void *ba_0_org;
 554         void *ba_1_org;
 555         void *ba_0;
 556         void *ba_1;
 557 };
 558
 559 /* Structure which stores all the MAC control parameters */
 560
 561 /* This structure stores the offset of the RxD in the ring
 562  * from which the Rx Interrupt processor can start picking
 563  * up the RxDs for processing.
 564  */
 565 struct rx_curr_get_info {
 566         u32 block_index;
 567         u32 offset;
 568         u32 ring_len;
 569 };
 570
 571 struct rx_curr_put_info {
 572         u32 block_index;
 573         u32 offset;
 574         u32 ring_len;
 575 };
 576
 577 /* This structure stores the offset of the TxDl in the FIFO
 578  * from which the Tx Interrupt processor can start picking
 579  * up the TxDLs for send complete interrupt processing.
 580  */
 581 struct tx_curr_get_info {
 582         u32 offset;
 583         u32 fifo_len;
 584 };
 585
 586 struct tx_curr_put_info {
 587         u32 offset;
 588         u32 fifo_len;
 589 };
 590
 591 struct rxd_info {
 592         void *virt_addr;
 593         dma_addr_t dma_addr;
 594 };
 595
 596 /* Structure that holds the Phy and virt addresses of the Blocks */
 597 struct rx_block_info {
 598         void *block_virt_addr;
 599         dma_addr_t block_dma_addr;
 600         struct rxd_info *rxds;
 601 };
 602
 603 /* Ring specific structure */
 604 struct ring_info {
 605         /* The ring number */
 606         int ring_no;
 607
 608         /*
 609          *  Place holders for the virtual and physical addresses of
 610          *  all the Rx Blocks
 611          */
 612         struct rx_block_info rx_blocks[MAX_RX_BLOCKS_PER_RING];
 613         int block_count;
 614         int pkt_cnt;
 615
 616         /*
 617          * Put pointer info which indictes which RxD has to be replenished
 618          * with a new buffer.
 619          */
 620         struct rx_curr_put_info rx_curr_put_info;
 621
 622         /*
 623          * Get pointer info which indictes which is the last RxD that was
 624          * processed by the driver.
 625          */
 626         struct rx_curr_get_info rx_curr_get_info;
 627
 628         /* Index to the absolute position of the put pointer of Rx ring */
 629         int put_pos;
 630
 631         /* Buffer Address store. */
 632         struct buffAdd **ba;
 633         struct s2io_nic *nic;
 634 };
 635
 636 /* Fifo specific structure */
 637 struct fifo_info {
 638         /* FIFO number */
 639         int fifo_no;
 640
 641         /* Maximum TxDs per TxDL */
 642         int max_txds;
 643
 644         /* Place holder of all the TX List's Phy and Virt addresses. */
 645         struct list_info_hold *list_info;
 646
 647         /*
 648          * Current offset within the tx FIFO where driver would write
 649          * new Tx frame
 650          */
 651         struct tx_curr_put_info tx_curr_put_info;
 652
 653         /*
 654          * Current offset within tx FIFO from where the driver would start freeing
 655          * the buffers
 656          */
 657         struct tx_curr_get_info tx_curr_get_info;
 658
 659         struct s2io_nic *nic;
 660 };
 661
 662 /* Information related to the Tx and Rx FIFOs and Rings of Xena
 663  * is maintained in this structure.
 664  */
 665 struct mac_info {
 666 /* tx side stuff */
 667         /* logical pointer of start of each Tx FIFO */
 668         struct TxFIFO_element __iomem *tx_FIFO_start[MAX_TX_FIFOS];
 669
 670         /* Fifo specific structure */
 671         struct fifo_info fifos[MAX_TX_FIFOS];
 672
 673         /* Save virtual address of TxD page with zero DMA addr(if any) */
 674         void *zerodma_virt_addr;
 675
 676 /* rx side stuff */
 677         /* Ring specific structure */
 678         struct ring_info rings[MAX_RX_RINGS];
 679
 680         u16 rmac_pause_time;
 681         u16 mc_pause_threshold_q0q3;
 682         u16 mc_pause_threshold_q4q7;
 683
 684         void *stats_mem;        /* orignal pointer to allocated mem */
 685         dma_addr_t stats_mem_phy;       /* Physical address of the stat block */
 686         u32 stats_mem_sz;
 687         struct stat_block *stats_info;  /* Logical address of the stat block */
 688 };
 689
 690 /* structure representing the user defined MAC addresses */
 691 struct usr_addr {
 692         char addr[ETH_ALEN];
 693         int usage_cnt;
 694 };
 695
 696 /* Default Tunable parameters of the NIC. */
 697 #define DEFAULT_FIFO_0_LEN 4096
 698 #define DEFAULT_FIFO_1_7_LEN 512
 699 #define SMALL_BLK_CNT   30
 700 #define LARGE_BLK_CNT   100
 701
 702 /*
 703  * Structure to keep track of the MSI-X vectors and the corresponding
 704  * argument registered against each vector
 705  */
 706 #define MAX_REQUESTED_MSI_X     17
 707 struct s2io_msix_entry
 708 {
 709         u16 vector;
 710         u16 entry;
 711         void *arg;
 712
 713         u8 type;
 714 #define MSIX_FIFO_TYPE  1
 715 #define MSIX_RING_TYPE  2
 716
 717         u8 in_use;
 718 #define MSIX_REGISTERED_SUCCESS 0xAA
 719 };
 720
 721 struct msix_info_st {
 722         u64 addr;
 723         u64 data;
 724 };
 725
 726 /* Data structure to represent a LRO session */
 727 struct lro {
 728         struct sk_buff  *parent;
 729         struct sk_buff  *last_frag;
 730         u8              *l2h;
 731         struct iphdr    *iph;
 732         struct tcphdr   *tcph;
 733         u32             tcp_next_seq;
 734         __be32          tcp_ack;
 735         int             total_len;
 736         int             frags_len;
 737         int             sg_num;
 738         int             in_use;
 739         __be16          window;
 740         u32             cur_tsval;
 741         u32             cur_tsecr;
 742         u8              saw_ts;
 743 };
 744
 745 /* Structure representing one instance of the NIC */
 746 struct s2io_nic {
 747         int rxd_mode;
 748         /*
 749          * Count of packets to be processed in a given iteration, it will be indicated
 750          * by the quota field of the device structure when NAPI is enabled.
 751          */
 752         int pkts_to_process;
 753         struct net_device *dev;
 754         struct mac_info mac_control;
 755         struct config_param config;
 756         struct pci_dev *pdev;
 757         void __iomem *bar0;
 758         void __iomem *bar1;
 759 #define MAX_MAC_SUPPORTED   16
 760 #define MAX_SUPPORTED_MULTICASTS MAX_MAC_SUPPORTED
 761
 762         struct mac_addr def_mac_addr[MAX_MAC_SUPPORTED];
 763
 764         struct net_device_stats stats;
 765         int high_dma_flag;
 766         int device_close_flag;
 767         int device_enabled_once;
 768
 769         char name[60];
 770         struct tasklet_struct task;
 771         volatile unsigned long tasklet_status;
 772
 773         /* Timer that handles I/O errors/exceptions */
 774         struct timer_list alarm_timer;
 775
 776         /* Space to back up the PCI config space */
 777         u32 config_space[256 / sizeof(u32)];
 778
 779         atomic_t rx_bufs_left[MAX_RX_RINGS];
 780
 781         spinlock_t tx_lock;
 782         spinlock_t put_lock;
 783
 784 #define PROMISC     1
 785 #define ALL_MULTI   2
 786
 787 #define MAX_ADDRS_SUPPORTED 64
 788         u16 usr_addr_count;
 789         u16 mc_addr_count;
 790         struct usr_addr usr_addrs[MAX_ADDRS_SUPPORTED];
 791
 792         u16 m_cast_flg;
 793         u16 all_multi_pos;
 794         u16 promisc_flg;
 795
 796         /*  Id timer, used to blink NIC to physically identify NIC. */
 797         struct timer_list id_timer;
 798
 799         /*  Restart timer, used to restart NIC if the device is stuck and
 800          *  a schedule task that will set the correct Link state once the
 801          *  NIC's PHY has stabilized after a state change.
 802          */
 803         struct work_struct rst_timer_task;
 804         struct work_struct set_link_task;
 805
 806         /* Flag that can be used to turn on or turn off the Rx checksum
 807          * offload feature.
 808          */
 809         int rx_csum;
 810
 811         /*  after blink, the adapter must be restored with original
 812          *  values.
 813          */
 814         u64 adapt_ctrl_org;
 815
 816         /* Last known link state. */
 817         u16 last_link_state;
 818 #define LINK_DOWN       1
 819 #define LINK_UP         2
 820
 821         int task_flag;
 822 #define CARD_DOWN 1
 823 #define CARD_UP 2
 824         atomic_t card_state;
 825         volatile unsigned long link_state;
 826         struct vlan_group *vlgrp;
 827 #define MSIX_FLG                0xA5
 828         struct msix_entry *entries;
 829         struct s2io_msix_entry *s2io_entries;
 830         char desc[MAX_REQUESTED_MSI_X][25];
 831
 832         int avail_msix_vectors; /* No. of MSI-X vectors granted by system */
 833
 834         struct msix_info_st msix_info[0x3f];
 835
 836 #define XFRAME_I_DEVICE         1
 837 #define XFRAME_II_DEVICE        2
 838         u8 device_type;
 839
 840 #define MAX_LRO_SESSIONS        32
 841         struct lro lro0_n[MAX_LRO_SESSIONS];
 842         unsigned long   clubbed_frms_cnt;
 843         unsigned long   sending_both;
 844         u8              lro;
 845         u16             lro_max_aggr_per_sess;
 846
 847 #define INTA    0
 848 #define MSI     1
 849 #define MSI_X   2
 850         u8 intr_type;
 851
 852         spinlock_t      rx_lock;
 853         atomic_t        isr_cnt;
 854         u64 *ufo_in_band_v;
 855 #define VPD_STRING_LEN 80
 856         u8  product_name[VPD_STRING_LEN];
 857         u8  serial_num[VPD_STRING_LEN];
 858 };
 859
 860 #define RESET_ERROR 1;
 861 #define CMD_ERROR   2;
 862
 863 /*  OS related system calls */
 864 #ifndef readq
 865 static inline u64 readq(void __iomem *addr)
 866 {
 867         u64 ret = 0;
 868         ret = readl(addr + 4);
 869         ret <<= 32;
 870         ret |= readl(addr);
 871
 872         return ret;
 873 }
 874 #endif
 875
 876 #ifndef writeq
 877 static inline void writeq(u64 val, void __iomem *addr)
 878 {
 879         writel((u32) (val), addr);
 880         writel((u32) (val >> 32), (addr + 4));
 881 }
 882 #endif
 883
 884 /*
 885  * Some registers have to be written in a particular order to
 886  * expect correct hardware operation. The macro SPECIAL_REG_WRITE
 887  * is used to perform such ordered writes. Defines UF (Upper First)
 888  * and LF (Lower First) will be used to specify the required write order.
 889  */
 890 #define UF      1
 891 #define LF      2
 892 static inline void SPECIAL_REG_WRITE(u64 val, void __iomem *addr, int order)
 893 {
 894         u32 ret;
 895
 896         if (order == LF) {
 897                 writel((u32) (val), addr);
 898                 ret = readl(addr);
 899                 writel((u32) (val >> 32), (addr + 4));
 900                 ret = readl(addr + 4);
 901         } else {
 902                 writel((u32) (val >> 32), (addr + 4));
 903                 ret = readl(addr + 4);
 904                 writel((u32) (val), addr);
 905                 ret = readl(addr);
 906         }
 907 }
 908
 909 /*  Interrupt related values of Xena */
 910
 911 #define ENABLE_INTRS    1
 912 #define DISABLE_INTRS   2
 913
 914 /*  Highest level interrupt blocks */
 915 #define TX_PIC_INTR     (0x0001<<0)
 916 #define TX_DMA_INTR     (0x0001<<1)
 917 #define TX_MAC_INTR     (0x0001<<2)
 918 #define TX_XGXS_INTR    (0x0001<<3)
 919 #define TX_TRAFFIC_INTR (0x0001<<4)
 920 #define RX_PIC_INTR     (0x0001<<5)
 921 #define RX_DMA_INTR     (0x0001<<6)
 922 #define RX_MAC_INTR     (0x0001<<7)
 923 #define RX_XGXS_INTR    (0x0001<<8)
 924 #define RX_TRAFFIC_INTR (0x0001<<9)
 925 #define MC_INTR         (0x0001<<10)
 926 #define ENA_ALL_INTRS    (   TX_PIC_INTR     | \
 927                             TX_DMA_INTR     | \
 928                             TX_MAC_INTR     | \
 929                             TX_XGXS_INTR    | \
 930                             TX_TRAFFIC_INTR | \
 931                             RX_PIC_INTR     | \
 932                             RX_DMA_INTR     | \
 933                             RX_MAC_INTR     | \
 934                             RX_XGXS_INTR    | \
 935                             RX_TRAFFIC_INTR | \
 936                             MC_INTR )
 937
 938 /*  Interrupt masks for the general interrupt mask register */
 939 #define DISABLE_ALL_INTRS   0xFFFFFFFFFFFFFFFFULL
 940
 941 #define TXPIC_INT_M         BIT(0)
 942 #define TXDMA_INT_M         BIT(1)
 943 #define TXMAC_INT_M         BIT(2)
 944 #define TXXGXS_INT_M        BIT(3)
 945 #define TXTRAFFIC_INT_M     BIT(8)
 946 #define PIC_RX_INT_M        BIT(32)
 947 #define RXDMA_INT_M         BIT(33)
 948 #define RXMAC_INT_M         BIT(34)
 949 #define MC_INT_M            BIT(35)
 950 #define RXXGXS_INT_M        BIT(36)
 951 #define RXTRAFFIC_INT_M     BIT(40)
 952
 953 /*  PIC level Interrupts TODO*/
 954
 955 /*  DMA level Inressupts */
 956 #define TXDMA_PFC_INT_M     BIT(0)
 957 #define TXDMA_PCC_INT_M     BIT(2)
 958
 959 /*  PFC block interrupts */
 960 #define PFC_MISC_ERR_1      BIT(0)      /* Interrupt to indicate FIFO full */
 961
 962 /* PCC block interrupts. */
 963 #define PCC_FB_ECC_ERR     vBIT(0xff, 16, 8)    /* Interrupt to indicate
 964                                                    PCC_FB_ECC Error. */
 965
 966 #define RXD_GET_VLAN_TAG(Control_2) (u16)(Control_2 & MASK_VLAN_TAG)
 967 /*
 968  * Prototype declaration.
 969  */
 970 static int __devinit s2io_init_nic(struct pci_dev *pdev,
 971                                    const struct pci_device_id *pre);
 972 static void __devexit s2io_rem_nic(struct pci_dev *pdev);
 973 static int init_shared_mem(struct s2io_nic *sp);
 974 static void free_shared_mem(struct s2io_nic *sp);
 975 static int init_nic(struct s2io_nic *nic);
 976 static void rx_intr_handler(struct ring_info *ring_data);
 977 static void tx_intr_handler(struct fifo_info *fifo_data);
 978 static void alarm_intr_handler(struct s2io_nic *sp);
 979
 980 static int s2io_starter(void);
 981 static void s2io_closer(void);
 982 static void s2io_tx_watchdog(struct net_device *dev);
 983 static void s2io_tasklet(unsigned long dev_addr);
 984 static void s2io_set_multicast(struct net_device *dev);
 985 static int rx_osm_handler(struct ring_info *ring_data, struct RxD_t * rxdp);
 986 static void s2io_link(struct s2io_nic * sp, int link);
 987 static void s2io_reset(struct s2io_nic * sp);
 988 static int s2io_poll(struct net_device *dev, int *budget);
 989 static void s2io_init_pci(struct s2io_nic * sp);
 990 static int s2io_set_mac_addr(struct net_device *dev, u8 * addr);
 991 static void s2io_alarm_handle(unsigned long data);
 992 static int s2io_enable_msi(struct s2io_nic *nic);
 993 static irqreturn_t s2io_msi_handle(int irq, void *dev_id);
 994 static irqreturn_t
 995 s2io_msix_ring_handle(int irq, void *dev_id);
 996 static irqreturn_t
 997 s2io_msix_fifo_handle(int irq, void *dev_id);
 998 static irqreturn_t s2io_isr(int irq, void *dev_id);
 999 static int verify_xena_quiescence(struct s2io_nic *sp);
1000 static const struct ethtool_ops netdev_ethtool_ops;
1001 static void s2io_set_link(struct work_struct *work);
1002 static int s2io_set_swapper(struct s2io_nic * sp);
1003 static void s2io_card_down(struct s2io_nic *nic);
1004 static int s2io_card_up(struct s2io_nic *nic);
1005 static int get_xena_rev_id(struct pci_dev *pdev);
1006 static int wait_for_cmd_complete(void __iomem *addr, u64 busy_bit,
1007                                         int bit_state);
1008 static int s2io_add_isr(struct s2io_nic * sp);
1009 static void s2io_rem_isr(struct s2io_nic * sp);
1010
1011 static void restore_xmsi_data(struct s2io_nic *nic);
1012
1013 static int
1014 s2io_club_tcp_session(u8 *buffer, u8 **tcp, u32 *tcp_len, struct lro **lro,
1015                       struct RxD_t *rxdp, struct s2io_nic *sp);
1016 static void clear_lro_session(struct lro *lro);
1017 static void queue_rx_frame(struct sk_buff *skb);
1018 static void update_L3L4_header(struct s2io_nic *sp, struct lro *lro);
1019 static void lro_append_pkt(struct s2io_nic *sp, struct lro *lro,
1020                            struct sk_buff *skb, u32 tcp_len);
1021 static int rts_ds_steer(struct s2io_nic *nic, u8 ds_codepoint, u8 ring);
1022
1023 #define s2io_tcp_mss(skb) skb_shinfo(skb)->gso_size
1024 #define s2io_udp_mss(skb) skb_shinfo(skb)->gso_size
1025 #define s2io_offload_type(skb) skb_shinfo(skb)->gso_type
1026
1027 #define S2IO_PARM_INT(X, def_val) \
1028         static unsigned int X = def_val;\
1029                 module_param(X , uint, 0);
1030
1031 #endif                          /* _S2IO_H */