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