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