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