drivers/net/s2io.h

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