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