pcnet_cs: add cis of PreMax PE-200 ethernet pcmcia card
[linux-2.6.git] / 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 #undef SUCCESS
22 #define SUCCESS 0
23 #define FAILURE -1
24 #define S2IO_MINUS_ONE 0xFFFFFFFFFFFFFFFFULL
25 #define S2IO_DISABLE_MAC_ENTRY 0xFFFFFFFFFFFFULL
26 #define S2IO_MAX_PCI_CONFIG_SPACE_REINIT 100
27 #define S2IO_BIT_RESET 1
28 #define S2IO_BIT_SET 2
29 #define CHECKBIT(value, nbit) (value & (1 << nbit))
30
31 /* Maximum time to flicker LED when asked to identify NIC using ethtool */
32 #define MAX_FLICKER_TIME        60000 /* 60 Secs */
33
34 /* Maximum outstanding splits to be configured into xena. */
35 enum {
36         XENA_ONE_SPLIT_TRANSACTION = 0,
37         XENA_TWO_SPLIT_TRANSACTION = 1,
38         XENA_THREE_SPLIT_TRANSACTION = 2,
39         XENA_FOUR_SPLIT_TRANSACTION = 3,
40         XENA_EIGHT_SPLIT_TRANSACTION = 4,
41         XENA_TWELVE_SPLIT_TRANSACTION = 5,
42         XENA_SIXTEEN_SPLIT_TRANSACTION = 6,
43         XENA_THIRTYTWO_SPLIT_TRANSACTION = 7
44 };
45 #define XENA_MAX_OUTSTANDING_SPLITS(n) (n << 4)
46
47 /*  OS concerned variables and constants */
48 #define WATCH_DOG_TIMEOUT               15*HZ
49 #define EFILL                           0x1234
50 #define ALIGN_SIZE                      127
51 #define PCIX_COMMAND_REGISTER           0x62
52
53 /*
54  * Debug related variables.
55  */
56 /* different debug levels. */
57 #define ERR_DBG         0
58 #define INIT_DBG        1
59 #define INFO_DBG        2
60 #define TX_DBG          3
61 #define INTR_DBG        4
62
63 /* Global variable that defines the present debug level of the driver. */
64 static int debug_level = ERR_DBG;
65
66 /* DEBUG message print. */
67 #define DBG_PRINT(dbg_level, fmt, args...) do {                 \
68         if (dbg_level >= debug_level)                           \
69                 pr_info(fmt, ##args);                           \
70         } while (0)
71
72 /* Protocol assist features of the NIC */
73 #define L3_CKSUM_OK 0xFFFF
74 #define L4_CKSUM_OK 0xFFFF
75 #define S2IO_JUMBO_SIZE 9600
76
77 /* Driver statistics maintained by driver */
78 struct swStat {
79         unsigned long long single_ecc_errs;
80         unsigned long long double_ecc_errs;
81         unsigned long long parity_err_cnt;
82         unsigned long long serious_err_cnt;
83         unsigned long long soft_reset_cnt;
84         unsigned long long fifo_full_cnt;
85         unsigned long long ring_full_cnt[8];
86         /* LRO statistics */
87         unsigned long long clubbed_frms_cnt;
88         unsigned long long sending_both;
89         unsigned long long outof_sequence_pkts;
90         unsigned long long flush_max_pkts;
91         unsigned long long sum_avg_pkts_aggregated;
92         unsigned long long num_aggregations;
93         /* Other statistics */
94         unsigned long long mem_alloc_fail_cnt;
95         unsigned long long pci_map_fail_cnt;
96         unsigned long long watchdog_timer_cnt;
97         unsigned long long mem_allocated;
98         unsigned long long mem_freed;
99         unsigned long long link_up_cnt;
100         unsigned long long link_down_cnt;
101         unsigned long long link_up_time;
102         unsigned long long link_down_time;
103
104         /* Transfer Code statistics */
105         unsigned long long tx_buf_abort_cnt;
106         unsigned long long tx_desc_abort_cnt;
107         unsigned long long tx_parity_err_cnt;
108         unsigned long long tx_link_loss_cnt;
109         unsigned long long tx_list_proc_err_cnt;
110
111         unsigned long long rx_parity_err_cnt;
112         unsigned long long rx_abort_cnt;
113         unsigned long long rx_parity_abort_cnt;
114         unsigned long long rx_rda_fail_cnt;
115         unsigned long long rx_unkn_prot_cnt;
116         unsigned long long rx_fcs_err_cnt;
117         unsigned long long rx_buf_size_err_cnt;
118         unsigned long long rx_rxd_corrupt_cnt;
119         unsigned long long rx_unkn_err_cnt;
120
121         /* Error/alarm statistics*/
122         unsigned long long tda_err_cnt;
123         unsigned long long pfc_err_cnt;
124         unsigned long long pcc_err_cnt;
125         unsigned long long tti_err_cnt;
126         unsigned long long lso_err_cnt;
127         unsigned long long tpa_err_cnt;
128         unsigned long long sm_err_cnt;
129         unsigned long long mac_tmac_err_cnt;
130         unsigned long long mac_rmac_err_cnt;
131         unsigned long long xgxs_txgxs_err_cnt;
132         unsigned long long xgxs_rxgxs_err_cnt;
133         unsigned long long rc_err_cnt;
134         unsigned long long prc_pcix_err_cnt;
135         unsigned long long rpa_err_cnt;
136         unsigned long long rda_err_cnt;
137         unsigned long long rti_err_cnt;
138         unsigned long long mc_err_cnt;
139
140 };
141
142 /* Xpak releated alarm and warnings */
143 struct xpakStat {
144         u64 alarm_transceiver_temp_high;
145         u64 alarm_transceiver_temp_low;
146         u64 alarm_laser_bias_current_high;
147         u64 alarm_laser_bias_current_low;
148         u64 alarm_laser_output_power_high;
149         u64 alarm_laser_output_power_low;
150         u64 warn_transceiver_temp_high;
151         u64 warn_transceiver_temp_low;
152         u64 warn_laser_bias_current_high;
153         u64 warn_laser_bias_current_low;
154         u64 warn_laser_output_power_high;
155         u64 warn_laser_output_power_low;
156         u64 xpak_regs_stat;
157         u32 xpak_timer_count;
158 };
159
160
161 /* The statistics block of Xena */
162 struct stat_block {
163 /* Tx MAC statistics counters. */
164         __le32 tmac_data_octets;
165         __le32 tmac_frms;
166         __le64 tmac_drop_frms;
167         __le32 tmac_bcst_frms;
168         __le32 tmac_mcst_frms;
169         __le64 tmac_pause_ctrl_frms;
170         __le32 tmac_ucst_frms;
171         __le32 tmac_ttl_octets;
172         __le32 tmac_any_err_frms;
173         __le32 tmac_nucst_frms;
174         __le64 tmac_ttl_less_fb_octets;
175         __le64 tmac_vld_ip_octets;
176         __le32 tmac_drop_ip;
177         __le32 tmac_vld_ip;
178         __le32 tmac_rst_tcp;
179         __le32 tmac_icmp;
180         __le64 tmac_tcp;
181         __le32 reserved_0;
182         __le32 tmac_udp;
183
184 /* Rx MAC Statistics counters. */
185         __le32 rmac_data_octets;
186         __le32 rmac_vld_frms;
187         __le64 rmac_fcs_err_frms;
188         __le64 rmac_drop_frms;
189         __le32 rmac_vld_bcst_frms;
190         __le32 rmac_vld_mcst_frms;
191         __le32 rmac_out_rng_len_err_frms;
192         __le32 rmac_in_rng_len_err_frms;
193         __le64 rmac_long_frms;
194         __le64 rmac_pause_ctrl_frms;
195         __le64 rmac_unsup_ctrl_frms;
196         __le32 rmac_accepted_ucst_frms;
197         __le32 rmac_ttl_octets;
198         __le32 rmac_discarded_frms;
199         __le32 rmac_accepted_nucst_frms;
200         __le32 reserved_1;
201         __le32 rmac_drop_events;
202         __le64 rmac_ttl_less_fb_octets;
203         __le64 rmac_ttl_frms;
204         __le64 reserved_2;
205         __le32 rmac_usized_frms;
206         __le32 reserved_3;
207         __le32 rmac_frag_frms;
208         __le32 rmac_osized_frms;
209         __le32 reserved_4;
210         __le32 rmac_jabber_frms;
211         __le64 rmac_ttl_64_frms;
212         __le64 rmac_ttl_65_127_frms;
213         __le64 reserved_5;
214         __le64 rmac_ttl_128_255_frms;
215         __le64 rmac_ttl_256_511_frms;
216         __le64 reserved_6;
217         __le64 rmac_ttl_512_1023_frms;
218         __le64 rmac_ttl_1024_1518_frms;
219         __le32 rmac_ip;
220         __le32 reserved_7;
221         __le64 rmac_ip_octets;
222         __le32 rmac_drop_ip;
223         __le32 rmac_hdr_err_ip;
224         __le32 reserved_8;
225         __le32 rmac_icmp;
226         __le64 rmac_tcp;
227         __le32 rmac_err_drp_udp;
228         __le32 rmac_udp;
229         __le64 rmac_xgmii_err_sym;
230         __le64 rmac_frms_q0;
231         __le64 rmac_frms_q1;
232         __le64 rmac_frms_q2;
233         __le64 rmac_frms_q3;
234         __le64 rmac_frms_q4;
235         __le64 rmac_frms_q5;
236         __le64 rmac_frms_q6;
237         __le64 rmac_frms_q7;
238         __le16 rmac_full_q3;
239         __le16 rmac_full_q2;
240         __le16 rmac_full_q1;
241         __le16 rmac_full_q0;
242         __le16 rmac_full_q7;
243         __le16 rmac_full_q6;
244         __le16 rmac_full_q5;
245         __le16 rmac_full_q4;
246         __le32 reserved_9;
247         __le32 rmac_pause_cnt;
248         __le64 rmac_xgmii_data_err_cnt;
249         __le64 rmac_xgmii_ctrl_err_cnt;
250         __le32 rmac_err_tcp;
251         __le32 rmac_accepted_ip;
252
253 /* PCI/PCI-X Read transaction statistics. */
254         __le32 new_rd_req_cnt;
255         __le32 rd_req_cnt;
256         __le32 rd_rtry_cnt;
257         __le32 new_rd_req_rtry_cnt;
258
259 /* PCI/PCI-X Write/Read transaction statistics. */
260         __le32 wr_req_cnt;
261         __le32 wr_rtry_rd_ack_cnt;
262         __le32 new_wr_req_rtry_cnt;
263         __le32 new_wr_req_cnt;
264         __le32 wr_disc_cnt;
265         __le32 wr_rtry_cnt;
266
267 /*      PCI/PCI-X Write / DMA Transaction statistics. */
268         __le32 txp_wr_cnt;
269         __le32 rd_rtry_wr_ack_cnt;
270         __le32 txd_wr_cnt;
271         __le32 txd_rd_cnt;
272         __le32 rxd_wr_cnt;
273         __le32 rxd_rd_cnt;
274         __le32 rxf_wr_cnt;
275         __le32 txf_rd_cnt;
276
277 /* Tx MAC statistics overflow counters. */
278         __le32 tmac_data_octets_oflow;
279         __le32 tmac_frms_oflow;
280         __le32 tmac_bcst_frms_oflow;
281         __le32 tmac_mcst_frms_oflow;
282         __le32 tmac_ucst_frms_oflow;
283         __le32 tmac_ttl_octets_oflow;
284         __le32 tmac_any_err_frms_oflow;
285         __le32 tmac_nucst_frms_oflow;
286         __le64 tmac_vlan_frms;
287         __le32 tmac_drop_ip_oflow;
288         __le32 tmac_vld_ip_oflow;
289         __le32 tmac_rst_tcp_oflow;
290         __le32 tmac_icmp_oflow;
291         __le32 tpa_unknown_protocol;
292         __le32 tmac_udp_oflow;
293         __le32 reserved_10;
294         __le32 tpa_parse_failure;
295
296 /* Rx MAC Statistics overflow counters. */
297         __le32 rmac_data_octets_oflow;
298         __le32 rmac_vld_frms_oflow;
299         __le32 rmac_vld_bcst_frms_oflow;
300         __le32 rmac_vld_mcst_frms_oflow;
301         __le32 rmac_accepted_ucst_frms_oflow;
302         __le32 rmac_ttl_octets_oflow;
303         __le32 rmac_discarded_frms_oflow;
304         __le32 rmac_accepted_nucst_frms_oflow;
305         __le32 rmac_usized_frms_oflow;
306         __le32 rmac_drop_events_oflow;
307         __le32 rmac_frag_frms_oflow;
308         __le32 rmac_osized_frms_oflow;
309         __le32 rmac_ip_oflow;
310         __le32 rmac_jabber_frms_oflow;
311         __le32 rmac_icmp_oflow;
312         __le32 rmac_drop_ip_oflow;
313         __le32 rmac_err_drp_udp_oflow;
314         __le32 rmac_udp_oflow;
315         __le32 reserved_11;
316         __le32 rmac_pause_cnt_oflow;
317         __le64 rmac_ttl_1519_4095_frms;
318         __le64 rmac_ttl_4096_8191_frms;
319         __le64 rmac_ttl_8192_max_frms;
320         __le64 rmac_ttl_gt_max_frms;
321         __le64 rmac_osized_alt_frms;
322         __le64 rmac_jabber_alt_frms;
323         __le64 rmac_gt_max_alt_frms;
324         __le64 rmac_vlan_frms;
325         __le32 rmac_len_discard;
326         __le32 rmac_fcs_discard;
327         __le32 rmac_pf_discard;
328         __le32 rmac_da_discard;
329         __le32 rmac_red_discard;
330         __le32 rmac_rts_discard;
331         __le32 reserved_12;
332         __le32 rmac_ingm_full_discard;
333         __le32 reserved_13;
334         __le32 rmac_accepted_ip_oflow;
335         __le32 reserved_14;
336         __le32 link_fault_cnt;
337         u8  buffer[20];
338         struct swStat sw_stat;
339         struct xpakStat xpak_stat;
340 };
341
342 /* Default value for 'vlan_strip_tag' configuration parameter */
343 #define NO_STRIP_IN_PROMISC 2
344
345 /*
346  * Structures representing different init time configuration
347  * parameters of the NIC.
348  */
349
350 #define MAX_TX_FIFOS 8
351 #define MAX_RX_RINGS 8
352
353 #define FIFO_DEFAULT_NUM        5
354 #define FIFO_UDP_MAX_NUM                        2 /* 0 - even, 1 -odd ports */
355 #define FIFO_OTHER_MAX_NUM                      1
356
357
358 #define MAX_RX_DESC_1  (MAX_RX_RINGS * MAX_RX_BLOCKS_PER_RING * 127 )
359 #define MAX_RX_DESC_2  (MAX_RX_RINGS * MAX_RX_BLOCKS_PER_RING * 85 )
360 #define MAX_RX_DESC_3  (MAX_RX_RINGS * MAX_RX_BLOCKS_PER_RING * 85 )
361 #define MAX_TX_DESC    (MAX_AVAILABLE_TXDS)
362
363 /* FIFO mappings for all possible number of fifos configured */
364 static 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
375 static u16 fifo_selector[MAX_TX_FIFOS] = {0, 1, 3, 3, 7, 7, 7, 7};
376
377 /* Maintains Per FIFO related information. */
378 struct tx_fifo_config {
379 #define MAX_AVAILABLE_TXDS      8192
380         u32 fifo_len;           /* specifies len of FIFO upto 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 */
399 struct 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  */
425 struct 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 */
472 struct mac_addr {
473         u8 mac_addr[ETH_ALEN];
474 };
475
476 /* Structure that represent every FIFO element in the BAR1
477  * Address location.
478  */
479 struct 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 */
493 struct 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. */
527 struct 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 */
533 struct 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 */
561 struct 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
572 struct 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  */
599 struct 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. */
620 struct 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  */
633 struct rx_curr_get_info {
634         u32 block_index;
635         u32 offset;
636         u32 ring_len;
637 };
638
639 struct 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  */
649 struct tx_curr_get_info {
650         u32 offset;
651         u32 fifo_len;
652 };
653
654 struct tx_curr_put_info {
655         u32 offset;
656         u32 fifo_len;
657 };
658
659 struct 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 */
665 struct 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 */
672 struct 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 */
692 struct 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
749         /* per-Ring statistics */
750         unsigned long rx_packets;
751         unsigned long rx_bytes;
752 } ____cacheline_aligned;
753
754 /* Fifo specific structure */
755 struct fifo_info {
756         /* FIFO number */
757         int fifo_no;
758
759         /* Maximum TxDs per TxDL */
760         int max_txds;
761
762         /* Place holder of all the TX List's Phy and Virt addresses. */
763         struct list_info_hold *list_info;
764
765         /*
766          * Current offset within the tx FIFO where driver would write
767          * new Tx frame
768          */
769         struct tx_curr_put_info tx_curr_put_info;
770
771         /*
772          * Current offset within tx FIFO from where the driver would start freeing
773          * the buffers
774          */
775         struct tx_curr_get_info tx_curr_get_info;
776 #define FIFO_QUEUE_START 0
777 #define FIFO_QUEUE_STOP 1
778         int queue_state;
779
780         /* copy of sp->dev pointer */
781         struct net_device *dev;
782
783         /* copy of multiq status */
784         u8 multiq;
785
786         /* Per fifo lock */
787         spinlock_t tx_lock;
788
789         /* Per fifo UFO in band structure */
790         u64 *ufo_in_band_v;
791
792         struct s2io_nic *nic;
793 } ____cacheline_aligned;
794
795 /* Information related to the Tx and Rx FIFOs and Rings of Xena
796  * is maintained in this structure.
797  */
798 struct mac_info {
799 /* tx side stuff */
800         /* logical pointer of start of each Tx FIFO */
801         struct TxFIFO_element __iomem *tx_FIFO_start[MAX_TX_FIFOS];
802
803         /* Fifo specific structure */
804         struct fifo_info fifos[MAX_TX_FIFOS];
805
806         /* Save virtual address of TxD page with zero DMA addr(if any) */
807         void *zerodma_virt_addr;
808
809 /* rx side stuff */
810         /* Ring specific structure */
811         struct ring_info rings[MAX_RX_RINGS];
812
813         u16 rmac_pause_time;
814         u16 mc_pause_threshold_q0q3;
815         u16 mc_pause_threshold_q4q7;
816
817         void *stats_mem;        /* orignal pointer to allocated mem */
818         dma_addr_t stats_mem_phy;       /* Physical address of the stat block */
819         u32 stats_mem_sz;
820         struct stat_block *stats_info;  /* Logical address of the stat block */
821 };
822
823 /* structure representing the user defined MAC addresses */
824 struct usr_addr {
825         char addr[ETH_ALEN];
826         int usage_cnt;
827 };
828
829 /* Default Tunable parameters of the NIC. */
830 #define DEFAULT_FIFO_0_LEN 4096
831 #define DEFAULT_FIFO_1_7_LEN 512
832 #define SMALL_BLK_CNT   30
833 #define LARGE_BLK_CNT   100
834
835 /*
836  * Structure to keep track of the MSI-X vectors and the corresponding
837  * argument registered against each vector
838  */
839 #define MAX_REQUESTED_MSI_X     9
840 struct s2io_msix_entry
841 {
842         u16 vector;
843         u16 entry;
844         void *arg;
845
846         u8 type;
847 #define        MSIX_ALARM_TYPE         1
848 #define        MSIX_RING_TYPE          2
849
850         u8 in_use;
851 #define MSIX_REGISTERED_SUCCESS 0xAA
852 };
853
854 struct msix_info_st {
855         u64 addr;
856         u64 data;
857 };
858
859 /* These flags represent the devices temporary state */
860 enum s2io_device_state_t
861 {
862         __S2IO_STATE_LINK_TASK=0,
863         __S2IO_STATE_CARD_UP
864 };
865
866 /* Structure representing one instance of the NIC */
867 struct s2io_nic {
868         int rxd_mode;
869         /*
870          * Count of packets to be processed in a given iteration, it will be indicated
871          * by the quota field of the device structure when NAPI is enabled.
872          */
873         int pkts_to_process;
874         struct net_device *dev;
875         struct mac_info mac_control;
876         struct config_param config;
877         struct pci_dev *pdev;
878         void __iomem *bar0;
879         void __iomem *bar1;
880 #define MAX_MAC_SUPPORTED   16
881 #define MAX_SUPPORTED_MULTICASTS MAX_MAC_SUPPORTED
882
883         struct mac_addr def_mac_addr[256];
884
885         struct net_device_stats stats;
886         int high_dma_flag;
887         int device_enabled_once;
888
889         char name[60];
890
891         /* Timer that handles I/O errors/exceptions */
892         struct timer_list alarm_timer;
893
894         /* Space to back up the PCI config space */
895         u32 config_space[256 / sizeof(u32)];
896
897 #define PROMISC     1
898 #define ALL_MULTI   2
899
900 #define MAX_ADDRS_SUPPORTED 64
901         u16 usr_addr_count;
902         u16 mc_addr_count;
903         struct usr_addr usr_addrs[256];
904
905         u16 m_cast_flg;
906         u16 all_multi_pos;
907         u16 promisc_flg;
908
909         /*  Id timer, used to blink NIC to physically identify NIC. */
910         struct timer_list id_timer;
911
912         /*  Restart timer, used to restart NIC if the device is stuck and
913          *  a schedule task that will set the correct Link state once the
914          *  NIC's PHY has stabilized after a state change.
915          */
916         struct work_struct rst_timer_task;
917         struct work_struct set_link_task;
918
919         /* Flag that can be used to turn on or turn off the Rx checksum
920          * offload feature.
921          */
922         int rx_csum;
923
924         /* Below variables are used for fifo selection to transmit a packet */
925         u16 fifo_selector[MAX_TX_FIFOS];
926
927         /* Total fifos for tcp packets */
928         u8 total_tcp_fifos;
929
930         /*
931         * Beginning index of udp for udp packets
932         * Value will be equal to
933         * (tx_fifo_num - FIFO_UDP_MAX_NUM - FIFO_OTHER_MAX_NUM)
934         */
935         u8 udp_fifo_idx;
936
937         u8 total_udp_fifos;
938
939         /*
940          * Beginning index of fifo for all other packets
941          * Value will be equal to (tx_fifo_num - FIFO_OTHER_MAX_NUM)
942         */
943         u8 other_fifo_idx;
944
945         struct napi_struct napi;
946         /*  after blink, the adapter must be restored with original
947          *  values.
948          */
949         u64 adapt_ctrl_org;
950
951         /* Last known link state. */
952         u16 last_link_state;
953 #define LINK_DOWN       1
954 #define LINK_UP         2
955
956         int task_flag;
957         unsigned long long start_time;
958         struct vlan_group *vlgrp;
959         int vlan_strip_flag;
960 #define MSIX_FLG                0xA5
961         int num_entries;
962         struct msix_entry *entries;
963         int msi_detected;
964         wait_queue_head_t msi_wait;
965         struct s2io_msix_entry *s2io_entries;
966         char desc[MAX_REQUESTED_MSI_X][25];
967
968         int avail_msix_vectors; /* No. of MSI-X vectors granted by system */
969
970         struct msix_info_st msix_info[0x3f];
971
972 #define XFRAME_I_DEVICE         1
973 #define XFRAME_II_DEVICE        2
974         u8 device_type;
975
976         unsigned long   clubbed_frms_cnt;
977         unsigned long   sending_both;
978         u8              lro;
979         u16             lro_max_aggr_per_sess;
980         volatile unsigned long state;
981         u64             general_int_mask;
982
983 #define VPD_STRING_LEN 80
984         u8  product_name[VPD_STRING_LEN];
985         u8  serial_num[VPD_STRING_LEN];
986 };
987
988 #define RESET_ERROR 1;
989 #define CMD_ERROR   2;
990
991 /*  OS related system calls */
992 #ifndef readq
993 static inline u64 readq(void __iomem *addr)
994 {
995         u64 ret = 0;
996         ret = readl(addr + 4);
997         ret <<= 32;
998         ret |= readl(addr);
999
1000         return ret;
1001 }
1002 #endif
1003
1004 #ifndef writeq
1005 static inline void writeq(u64 val, void __iomem *addr)
1006 {
1007         writel((u32) (val), addr);
1008         writel((u32) (val >> 32), (addr + 4));
1009 }
1010 #endif
1011
1012 /*
1013  * Some registers have to be written in a particular order to
1014  * expect correct hardware operation. The macro SPECIAL_REG_WRITE
1015  * is used to perform such ordered writes. Defines UF (Upper First)
1016  * and LF (Lower First) will be used to specify the required write order.
1017  */
1018 #define UF      1
1019 #define LF      2
1020 static inline void SPECIAL_REG_WRITE(u64 val, void __iomem *addr, int order)
1021 {
1022         u32 ret;
1023
1024         if (order == LF) {
1025                 writel((u32) (val), addr);
1026                 ret = readl(addr);
1027                 writel((u32) (val >> 32), (addr + 4));
1028                 ret = readl(addr + 4);
1029         } else {
1030                 writel((u32) (val >> 32), (addr + 4));
1031                 ret = readl(addr + 4);
1032                 writel((u32) (val), addr);
1033                 ret = readl(addr);
1034         }
1035 }
1036
1037 /*  Interrupt related values of Xena */
1038
1039 #define ENABLE_INTRS    1
1040 #define DISABLE_INTRS   2
1041
1042 /*  Highest level interrupt blocks */
1043 #define TX_PIC_INTR     (0x0001<<0)
1044 #define TX_DMA_INTR     (0x0001<<1)
1045 #define TX_MAC_INTR     (0x0001<<2)
1046 #define TX_XGXS_INTR    (0x0001<<3)
1047 #define TX_TRAFFIC_INTR (0x0001<<4)
1048 #define RX_PIC_INTR     (0x0001<<5)
1049 #define RX_DMA_INTR     (0x0001<<6)
1050 #define RX_MAC_INTR     (0x0001<<7)
1051 #define RX_XGXS_INTR    (0x0001<<8)
1052 #define RX_TRAFFIC_INTR (0x0001<<9)
1053 #define MC_INTR         (0x0001<<10)
1054 #define ENA_ALL_INTRS    (   TX_PIC_INTR     | \
1055                             TX_DMA_INTR     | \
1056                             TX_MAC_INTR     | \
1057                             TX_XGXS_INTR    | \
1058                             TX_TRAFFIC_INTR | \
1059                             RX_PIC_INTR     | \
1060                             RX_DMA_INTR     | \
1061                             RX_MAC_INTR     | \
1062                             RX_XGXS_INTR    | \
1063                             RX_TRAFFIC_INTR | \
1064                             MC_INTR )
1065
1066 /*  Interrupt masks for the general interrupt mask register */
1067 #define DISABLE_ALL_INTRS   0xFFFFFFFFFFFFFFFFULL
1068
1069 #define TXPIC_INT_M         s2BIT(0)
1070 #define TXDMA_INT_M         s2BIT(1)
1071 #define TXMAC_INT_M         s2BIT(2)
1072 #define TXXGXS_INT_M        s2BIT(3)
1073 #define TXTRAFFIC_INT_M     s2BIT(8)
1074 #define PIC_RX_INT_M        s2BIT(32)
1075 #define RXDMA_INT_M         s2BIT(33)
1076 #define RXMAC_INT_M         s2BIT(34)
1077 #define MC_INT_M            s2BIT(35)
1078 #define RXXGXS_INT_M        s2BIT(36)
1079 #define RXTRAFFIC_INT_M     s2BIT(40)
1080
1081 /*  PIC level Interrupts TODO*/
1082
1083 /*  DMA level Inressupts */
1084 #define TXDMA_PFC_INT_M     s2BIT(0)
1085 #define TXDMA_PCC_INT_M     s2BIT(2)
1086
1087 /*  PFC block interrupts */
1088 #define PFC_MISC_ERR_1      s2BIT(0)    /* Interrupt to indicate FIFO full */
1089
1090 /* PCC block interrupts. */
1091 #define PCC_FB_ECC_ERR     vBIT(0xff, 16, 8)    /* Interrupt to indicate
1092                                                    PCC_FB_ECC Error. */
1093
1094 #define RXD_GET_VLAN_TAG(Control_2) (u16)(Control_2 & MASK_VLAN_TAG)
1095 /*
1096  * Prototype declaration.
1097  */
1098 static int __devinit s2io_init_nic(struct pci_dev *pdev,
1099                                    const struct pci_device_id *pre);
1100 static void __devexit s2io_rem_nic(struct pci_dev *pdev);
1101 static int init_shared_mem(struct s2io_nic *sp);
1102 static void free_shared_mem(struct s2io_nic *sp);
1103 static int init_nic(struct s2io_nic *nic);
1104 static int rx_intr_handler(struct ring_info *ring_data, int budget);
1105 static void s2io_txpic_intr_handle(struct s2io_nic *sp);
1106 static void tx_intr_handler(struct fifo_info *fifo_data);
1107 static void s2io_handle_errors(void * dev_id);
1108
1109 static int s2io_starter(void);
1110 static void s2io_closer(void);
1111 static void s2io_tx_watchdog(struct net_device *dev);
1112 static void s2io_set_multicast(struct net_device *dev);
1113 static int rx_osm_handler(struct ring_info *ring_data, struct RxD_t * rxdp);
1114 static void s2io_link(struct s2io_nic * sp, int link);
1115 static void s2io_reset(struct s2io_nic * sp);
1116 static int s2io_poll_msix(struct napi_struct *napi, int budget);
1117 static int s2io_poll_inta(struct napi_struct *napi, int budget);
1118 static void s2io_init_pci(struct s2io_nic * sp);
1119 static int do_s2io_prog_unicast(struct net_device *dev, u8 *addr);
1120 static void s2io_alarm_handle(unsigned long data);
1121 static irqreturn_t
1122 s2io_msix_ring_handle(int irq, void *dev_id);
1123 static irqreturn_t
1124 s2io_msix_fifo_handle(int irq, void *dev_id);
1125 static irqreturn_t s2io_isr(int irq, void *dev_id);
1126 static int verify_xena_quiescence(struct s2io_nic *sp);
1127 static const struct ethtool_ops netdev_ethtool_ops;
1128 static void s2io_set_link(struct work_struct *work);
1129 static int s2io_set_swapper(struct s2io_nic * sp);
1130 static void s2io_card_down(struct s2io_nic *nic);
1131 static int s2io_card_up(struct s2io_nic *nic);
1132 static int wait_for_cmd_complete(void __iomem *addr, u64 busy_bit,
1133                                         int bit_state);
1134 static int s2io_add_isr(struct s2io_nic * sp);
1135 static void s2io_rem_isr(struct s2io_nic * sp);
1136
1137 static void restore_xmsi_data(struct s2io_nic *nic);
1138 static void do_s2io_store_unicast_mc(struct s2io_nic *sp);
1139 static void do_s2io_restore_unicast_mc(struct s2io_nic *sp);
1140 static u64 do_s2io_read_unicast_mc(struct s2io_nic *sp, int offset);
1141 static int do_s2io_add_mc(struct s2io_nic *sp, u8 *addr);
1142 static int do_s2io_add_mac(struct s2io_nic *sp, u64 addr, int offset);
1143 static int do_s2io_delete_unicast_mc(struct s2io_nic *sp, u64 addr);
1144
1145 static int s2io_club_tcp_session(struct ring_info *ring_data, u8 *buffer,
1146         u8 **tcp, u32 *tcp_len, struct lro **lro, struct RxD_t *rxdp,
1147         struct s2io_nic *sp);
1148 static void clear_lro_session(struct lro *lro);
1149 static void queue_rx_frame(struct sk_buff *skb, u16 vlan_tag);
1150 static void update_L3L4_header(struct s2io_nic *sp, struct lro *lro);
1151 static void lro_append_pkt(struct s2io_nic *sp, struct lro *lro,
1152                            struct sk_buff *skb, u32 tcp_len);
1153 static int rts_ds_steer(struct s2io_nic *nic, u8 ds_codepoint, u8 ring);
1154
1155 static pci_ers_result_t s2io_io_error_detected(struct pci_dev *pdev,
1156                                               pci_channel_state_t state);
1157 static pci_ers_result_t s2io_io_slot_reset(struct pci_dev *pdev);
1158 static void s2io_io_resume(struct pci_dev *pdev);
1159
1160 #define s2io_tcp_mss(skb) skb_shinfo(skb)->gso_size
1161 #define s2io_udp_mss(skb) skb_shinfo(skb)->gso_size
1162 #define s2io_offload_type(skb) skb_shinfo(skb)->gso_type
1163
1164 #define S2IO_PARM_INT(X, def_val) \
1165         static unsigned int X = def_val;\
1166                 module_param(X , uint, 0);
1167
1168 #endif                          /* _S2IO_H */