netxen: refactor netxen_recv_context struct
[linux-2.6] / drivers / net / netxen / netxen_nic.h
1 /*
2  * Copyright (C) 2003 - 2009 NetXen, Inc.
3  * All rights reserved.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
18  * MA  02111-1307, USA.
19  *
20  * The full GNU General Public License is included in this distribution
21  * in the file called LICENSE.
22  *
23  * Contact Information:
24  *    info@netxen.com
25  * NetXen Inc,
26  * 18922 Forge Drive
27  * Cupertino, CA 95014-0701
28  *
29  */
30
31 #ifndef _NETXEN_NIC_H_
32 #define _NETXEN_NIC_H_
33
34 #include <linux/module.h>
35 #include <linux/kernel.h>
36 #include <linux/types.h>
37 #include <linux/ioport.h>
38 #include <linux/pci.h>
39 #include <linux/netdevice.h>
40 #include <linux/etherdevice.h>
41 #include <linux/ip.h>
42 #include <linux/in.h>
43 #include <linux/tcp.h>
44 #include <linux/skbuff.h>
45
46 #include <linux/ethtool.h>
47 #include <linux/mii.h>
48 #include <linux/timer.h>
49
50 #include <linux/vmalloc.h>
51
52 #include <asm/io.h>
53 #include <asm/byteorder.h>
54
55 #include "netxen_nic_hw.h"
56
57 #define _NETXEN_NIC_LINUX_MAJOR 4
58 #define _NETXEN_NIC_LINUX_MINOR 0
59 #define _NETXEN_NIC_LINUX_SUBVERSION 30
60 #define NETXEN_NIC_LINUX_VERSIONID  "4.0.30"
61
62 #define NETXEN_VERSION_CODE(a, b, c)    (((a) << 16) + ((b) << 8) + (c))
63
64 #define NETXEN_NUM_FLASH_SECTORS (64)
65 #define NETXEN_FLASH_SECTOR_SIZE (64 * 1024)
66 #define NETXEN_FLASH_TOTAL_SIZE  (NETXEN_NUM_FLASH_SECTORS \
67                                         * NETXEN_FLASH_SECTOR_SIZE)
68
69 #define PHAN_VENDOR_ID 0x4040
70
71 #define RCV_DESC_RINGSIZE(rds_ring)     \
72         (sizeof(struct rcv_desc) * (rds_ring)->num_desc)
73 #define RCV_BUFF_RINGSIZE(rds_ring)     \
74         (sizeof(struct netxen_rx_buffer) * rds_ring->num_desc)
75 #define STATUS_DESC_RINGSIZE(sds_ring)  \
76         (sizeof(struct status_desc) * (sds_ring)->num_desc)
77 #define TX_BUFF_RINGSIZE(tx_ring)       \
78         (sizeof(struct netxen_cmd_buffer) * tx_ring->num_desc)
79 #define TX_DESC_RINGSIZE(tx_ring)       \
80         (sizeof(struct cmd_desc_type0) * tx_ring->num_desc)
81
82 #define find_diff_among(a,b,range) ((a)<(b)?((b)-(a)):((b)+(range)-(a)))
83
84 #define NETXEN_RCV_PRODUCER_OFFSET      0
85 #define NETXEN_RCV_PEG_DB_ID            2
86 #define NETXEN_HOST_DUMMY_DMA_SIZE 1024
87 #define FLASH_SUCCESS 0
88
89 #define ADDR_IN_WINDOW1(off)    \
90         ((off > NETXEN_CRB_PCIX_HOST2) && (off < NETXEN_CRB_MAX)) ? 1 : 0
91
92 /*
93  * normalize a 64MB crb address to 32MB PCI window
94  * To use NETXEN_CRB_NORMALIZE, window _must_ be set to 1
95  */
96 #define NETXEN_CRB_NORMAL(reg)  \
97         ((reg) - NETXEN_CRB_PCIX_HOST2 + NETXEN_CRB_PCIX_HOST)
98
99 #define NETXEN_CRB_NORMALIZE(adapter, reg) \
100         pci_base_offset(adapter, NETXEN_CRB_NORMAL(reg))
101
102 #define DB_NORMALIZE(adapter, off) \
103         (adapter->ahw.db_base + (off))
104
105 #define NX_P2_C0                0x24
106 #define NX_P2_C1                0x25
107 #define NX_P3_A0                0x30
108 #define NX_P3_A2                0x30
109 #define NX_P3_B0                0x40
110 #define NX_P3_B1                0x41
111 #define NX_P3_B2                0x42
112
113 #define NX_IS_REVISION_P2(REVISION)     (REVISION <= NX_P2_C1)
114 #define NX_IS_REVISION_P3(REVISION)     (REVISION >= NX_P3_A0)
115
116 #define FIRST_PAGE_GROUP_START  0
117 #define FIRST_PAGE_GROUP_END    0x100000
118
119 #define SECOND_PAGE_GROUP_START 0x6000000
120 #define SECOND_PAGE_GROUP_END   0x68BC000
121
122 #define THIRD_PAGE_GROUP_START  0x70E4000
123 #define THIRD_PAGE_GROUP_END    0x8000000
124
125 #define FIRST_PAGE_GROUP_SIZE  FIRST_PAGE_GROUP_END - FIRST_PAGE_GROUP_START
126 #define SECOND_PAGE_GROUP_SIZE SECOND_PAGE_GROUP_END - SECOND_PAGE_GROUP_START
127 #define THIRD_PAGE_GROUP_SIZE  THIRD_PAGE_GROUP_END - THIRD_PAGE_GROUP_START
128
129 #define P2_MAX_MTU                     (8000)
130 #define P3_MAX_MTU                     (9600)
131 #define NX_ETHERMTU                    1500
132 #define NX_MAX_ETHERHDR                32 /* This contains some padding */
133
134 #define NX_RX_NORMAL_BUF_MAX_LEN       (NX_MAX_ETHERHDR + NX_ETHERMTU)
135 #define NX_P2_RX_JUMBO_BUF_MAX_LEN     (NX_MAX_ETHERHDR + P2_MAX_MTU)
136 #define NX_P3_RX_JUMBO_BUF_MAX_LEN     (NX_MAX_ETHERHDR + P3_MAX_MTU)
137 #define NX_CT_DEFAULT_RX_BUF_LEN        2048
138
139 #define MAX_RX_BUFFER_LENGTH            1760
140 #define MAX_RX_JUMBO_BUFFER_LENGTH      8062
141 #define MAX_RX_LRO_BUFFER_LENGTH        (8062)
142 #define RX_DMA_MAP_LEN                  (MAX_RX_BUFFER_LENGTH - 2)
143 #define RX_JUMBO_DMA_MAP_LEN    \
144         (MAX_RX_JUMBO_BUFFER_LENGTH - 2)
145 #define RX_LRO_DMA_MAP_LEN              (MAX_RX_LRO_BUFFER_LENGTH - 2)
146
147 /*
148  * Maximum number of ring contexts
149  */
150 #define MAX_RING_CTX 1
151
152 /* Opcodes to be used with the commands */
153 #define TX_ETHER_PKT    0x01
154 #define TX_TCP_PKT      0x02
155 #define TX_UDP_PKT      0x03
156 #define TX_IP_PKT       0x04
157 #define TX_TCP_LSO      0x05
158 #define TX_TCP_LSO6     0x06
159 #define TX_IPSEC        0x07
160 #define TX_IPSEC_CMD    0x0a
161 #define TX_TCPV6_PKT    0x0b
162 #define TX_UDPV6_PKT    0x0c
163
164 /* The following opcodes are for internal consumption. */
165 #define NETXEN_CONTROL_OP       0x10
166 #define PEGNET_REQUEST          0x11
167
168 #define MAX_NUM_CARDS           4
169
170 #define MAX_BUFFERS_PER_CMD     32
171
172 /*
173  * Following are the states of the Phantom. Phantom will set them and
174  * Host will read to check if the fields are correct.
175  */
176 #define PHAN_INITIALIZE_START           0xff00
177 #define PHAN_INITIALIZE_FAILED          0xffff
178 #define PHAN_INITIALIZE_COMPLETE        0xff01
179
180 /* Host writes the following to notify that it has done the init-handshake */
181 #define PHAN_INITIALIZE_ACK     0xf00f
182
183 #define NUM_RCV_DESC_RINGS      3
184 #define NUM_STS_DESC_RINGS      4
185
186 #define RCV_RING_NORMAL 0
187 #define RCV_RING_JUMBO  1
188 #define RCV_RING_LRO    2
189
190 #define MAX_CMD_DESCRIPTORS             4096
191 #define MAX_RCV_DESCRIPTORS             16384
192 #define MAX_CMD_DESCRIPTORS_HOST        1024
193 #define MAX_RCV_DESCRIPTORS_1G          2048
194 #define MAX_RCV_DESCRIPTORS_10G         4096
195 #define MAX_JUMBO_RCV_DESCRIPTORS       1024
196 #define MAX_LRO_RCV_DESCRIPTORS         8
197 #define NETXEN_CTX_SIGNATURE    0xdee0
198 #define NETXEN_CTX_SIGNATURE_V2 0x0002dee0
199 #define NETXEN_CTX_RESET        0xbad0
200 #define NETXEN_RCV_PRODUCER(ringid)     (ringid)
201
202 #define PHAN_PEG_RCV_INITIALIZED        0xff01
203 #define PHAN_PEG_RCV_START_INITIALIZE   0xff00
204
205 #define get_next_index(index, length)   \
206         (((index) + 1) & ((length) - 1))
207
208 #define get_index_range(index,length,count)     \
209         (((index) + (count)) & ((length) - 1))
210
211 #define MPORT_SINGLE_FUNCTION_MODE 0x1111
212 #define MPORT_MULTI_FUNCTION_MODE 0x2222
213
214 #include "netxen_nic_phan_reg.h"
215
216 /*
217  * NetXen host-peg signal message structure
218  *
219  *      Bit 0-1         : peg_id => 0x2 for tx and 01 for rx
220  *      Bit 2           : priv_id => must be 1
221  *      Bit 3-17        : count => for doorbell
222  *      Bit 18-27       : ctx_id => Context id
223  *      Bit 28-31       : opcode
224  */
225
226 typedef u32 netxen_ctx_msg;
227
228 #define netxen_set_msg_peg_id(config_word, val) \
229         ((config_word) &= ~3, (config_word) |= val & 3)
230 #define netxen_set_msg_privid(config_word)      \
231         ((config_word) |= 1 << 2)
232 #define netxen_set_msg_count(config_word, val)  \
233         ((config_word) &= ~(0x7fff<<3), (config_word) |= (val & 0x7fff) << 3)
234 #define netxen_set_msg_ctxid(config_word, val)  \
235         ((config_word) &= ~(0x3ff<<18), (config_word) |= (val & 0x3ff) << 18)
236 #define netxen_set_msg_opcode(config_word, val) \
237         ((config_word) &= ~(0xf<<28), (config_word) |= (val & 0xf) << 28)
238
239 struct netxen_rcv_ring {
240         __le64 addr;
241         __le32 size;
242         __le32 rsrvd;
243 };
244
245 struct netxen_sts_ring {
246         __le64 addr;
247         __le32 size;
248         __le16 msi_index;
249         __le16 rsvd;
250 } ;
251
252 struct netxen_ring_ctx {
253
254         /* one command ring */
255         __le64 cmd_consumer_offset;
256         __le64 cmd_ring_addr;
257         __le32 cmd_ring_size;
258         __le32 rsrvd;
259
260         /* three receive rings */
261         struct netxen_rcv_ring rcv_rings[NUM_RCV_DESC_RINGS];
262
263         __le64 sts_ring_addr;
264         __le32 sts_ring_size;
265
266         __le32 ctx_id;
267
268         __le64 rsrvd_2[3];
269         __le32 sts_ring_count;
270         __le32 rsrvd_3;
271         struct netxen_sts_ring sts_rings[NUM_STS_DESC_RINGS];
272
273 } __attribute__ ((aligned(64)));
274
275 /*
276  * Following data structures describe the descriptors that will be used.
277  * Added fileds of tcpHdrSize and ipHdrSize, The driver needs to do it only when
278  * we are doing LSO (above the 1500 size packet) only.
279  */
280
281 /*
282  * The size of reference handle been changed to 16 bits to pass the MSS fields
283  * for the LSO packet
284  */
285
286 #define FLAGS_CHECKSUM_ENABLED  0x01
287 #define FLAGS_LSO_ENABLED       0x02
288 #define FLAGS_IPSEC_SA_ADD      0x04
289 #define FLAGS_IPSEC_SA_DELETE   0x08
290 #define FLAGS_VLAN_TAGGED       0x10
291
292 #define netxen_set_cmd_desc_port(cmd_desc, var) \
293         ((cmd_desc)->port_ctxid |= ((var) & 0x0F))
294 #define netxen_set_cmd_desc_ctxid(cmd_desc, var)        \
295         ((cmd_desc)->port_ctxid |= ((var) << 4 & 0xF0))
296
297 #define netxen_set_tx_port(_desc, _port) \
298         (_desc)->port_ctxid = ((_port) & 0xf) | (((_port) << 4) & 0xf0)
299
300 #define netxen_set_tx_flags_opcode(_desc, _flags, _opcode) \
301         (_desc)->flags_opcode = \
302         cpu_to_le16(((_flags) & 0x7f) | (((_opcode) & 0x3f) << 7))
303
304 #define netxen_set_tx_frags_len(_desc, _frags, _len) \
305         (_desc)->num_of_buffers_total_length = \
306         cpu_to_le32(((_frags) & 0xff) | (((_len) & 0xffffff) << 8))
307
308 struct cmd_desc_type0 {
309         u8 tcp_hdr_offset;      /* For LSO only */
310         u8 ip_hdr_offset;       /* For LSO only */
311         /* Bit pattern: 0-6 flags, 7-12 opcode, 13-15 unused */
312         __le16 flags_opcode;
313         /* Bit pattern: 0-7 total number of segments,
314            8-31 Total size of the packet */
315         __le32 num_of_buffers_total_length;
316         union {
317                 struct {
318                         __le32 addr_low_part2;
319                         __le32 addr_high_part2;
320                 };
321                 __le64 addr_buffer2;
322         };
323
324         __le16 reference_handle;        /* changed to u16 to add mss */
325         __le16 mss;             /* passed by NDIS_PACKET for LSO */
326         /* Bit pattern 0-3 port, 0-3 ctx id */
327         u8 port_ctxid;
328         u8 total_hdr_length;    /* LSO only : MAC+IP+TCP Hdr size */
329         __le16 conn_id;         /* IPSec offoad only */
330
331         union {
332                 struct {
333                         __le32 addr_low_part3;
334                         __le32 addr_high_part3;
335                 };
336                 __le64 addr_buffer3;
337         };
338         union {
339                 struct {
340                         __le32 addr_low_part1;
341                         __le32 addr_high_part1;
342                 };
343                 __le64 addr_buffer1;
344         };
345
346         __le16 buffer_length[4];
347
348         union {
349                 struct {
350                         __le32 addr_low_part4;
351                         __le32 addr_high_part4;
352                 };
353                 __le64 addr_buffer4;
354         };
355
356         __le64 unused;
357
358 } __attribute__ ((aligned(64)));
359
360 /* Note: sizeof(rcv_desc) should always be a mutliple of 2 */
361 struct rcv_desc {
362         __le16 reference_handle;
363         __le16 reserved;
364         __le32 buffer_length;   /* allocated buffer length (usually 2K) */
365         __le64 addr_buffer;
366 };
367
368 /* opcode field in status_desc */
369 #define NETXEN_NIC_RXPKT_DESC  0x04
370 #define NETXEN_OLD_RXPKT_DESC  0x3f
371 #define NETXEN_NIC_RESPONSE_DESC 0x05
372
373 /* for status field in status_desc */
374 #define STATUS_NEED_CKSUM       (1)
375 #define STATUS_CKSUM_OK         (2)
376
377 /* owner bits of status_desc */
378 #define STATUS_OWNER_HOST       (0x1ULL << 56)
379 #define STATUS_OWNER_PHANTOM    (0x2ULL << 56)
380
381 /* Status descriptor:
382    0-3 port, 4-7 status, 8-11 type, 12-27 total_length
383    28-43 reference_handle, 44-47 protocol, 48-52 pkt_offset
384    53-55 desc_cnt, 56-57 owner, 58-63 opcode
385  */
386 #define netxen_get_sts_port(sts_data)   \
387         ((sts_data) & 0x0F)
388 #define netxen_get_sts_status(sts_data) \
389         (((sts_data) >> 4) & 0x0F)
390 #define netxen_get_sts_type(sts_data)   \
391         (((sts_data) >> 8) & 0x0F)
392 #define netxen_get_sts_totallength(sts_data)    \
393         (((sts_data) >> 12) & 0xFFFF)
394 #define netxen_get_sts_refhandle(sts_data)      \
395         (((sts_data) >> 28) & 0xFFFF)
396 #define netxen_get_sts_prot(sts_data)   \
397         (((sts_data) >> 44) & 0x0F)
398 #define netxen_get_sts_pkt_offset(sts_data)     \
399         (((sts_data) >> 48) & 0x1F)
400 #define netxen_get_sts_desc_cnt(sts_data)       \
401         (((sts_data) >> 53) & 0x7)
402 #define netxen_get_sts_opcode(sts_data) \
403         (((sts_data) >> 58) & 0x03F)
404
405 struct status_desc {
406         __le64 status_desc_data[2];
407 } __attribute__ ((aligned(16)));
408
409 /* The version of the main data structure */
410 #define NETXEN_BDINFO_VERSION 1
411
412 /* Magic number to let user know flash is programmed */
413 #define NETXEN_BDINFO_MAGIC 0x12345678
414
415 /* Max number of Gig ports on a Phantom board */
416 #define NETXEN_MAX_PORTS 4
417
418 #define NETXEN_BRDTYPE_P1_BD            0x0000
419 #define NETXEN_BRDTYPE_P1_SB            0x0001
420 #define NETXEN_BRDTYPE_P1_SMAX          0x0002
421 #define NETXEN_BRDTYPE_P1_SOCK          0x0003
422
423 #define NETXEN_BRDTYPE_P2_SOCK_31       0x0008
424 #define NETXEN_BRDTYPE_P2_SOCK_35       0x0009
425 #define NETXEN_BRDTYPE_P2_SB35_4G       0x000a
426 #define NETXEN_BRDTYPE_P2_SB31_10G      0x000b
427 #define NETXEN_BRDTYPE_P2_SB31_2G       0x000c
428
429 #define NETXEN_BRDTYPE_P2_SB31_10G_IMEZ         0x000d
430 #define NETXEN_BRDTYPE_P2_SB31_10G_HMEZ         0x000e
431 #define NETXEN_BRDTYPE_P2_SB31_10G_CX4          0x000f
432
433 #define NETXEN_BRDTYPE_P3_REF_QG        0x0021
434 #define NETXEN_BRDTYPE_P3_HMEZ          0x0022
435 #define NETXEN_BRDTYPE_P3_10G_CX4_LP    0x0023
436 #define NETXEN_BRDTYPE_P3_4_GB          0x0024
437 #define NETXEN_BRDTYPE_P3_IMEZ          0x0025
438 #define NETXEN_BRDTYPE_P3_10G_SFP_PLUS  0x0026
439 #define NETXEN_BRDTYPE_P3_10000_BASE_T  0x0027
440 #define NETXEN_BRDTYPE_P3_XG_LOM        0x0028
441 #define NETXEN_BRDTYPE_P3_4_GB_MM       0x0029
442 #define NETXEN_BRDTYPE_P3_10G_SFP_CT    0x002a
443 #define NETXEN_BRDTYPE_P3_10G_SFP_QT    0x002b
444 #define NETXEN_BRDTYPE_P3_10G_CX4       0x0031
445 #define NETXEN_BRDTYPE_P3_10G_XFP       0x0032
446 #define NETXEN_BRDTYPE_P3_10G_TP        0x0080
447
448 struct netxen_board_info {
449         u32 header_version;
450
451         u32 board_mfg;
452         u32 board_type;
453         u32 board_num;
454         u32 chip_id;
455         u32 chip_minor;
456         u32 chip_major;
457         u32 chip_pkg;
458         u32 chip_lot;
459
460         u32 port_mask;          /* available niu ports */
461         u32 peg_mask;           /* available pegs */
462         u32 icache_ok;          /* can we run with icache? */
463         u32 dcache_ok;          /* can we run with dcache? */
464         u32 casper_ok;
465
466         u32 mac_addr_lo_0;
467         u32 mac_addr_lo_1;
468         u32 mac_addr_lo_2;
469         u32 mac_addr_lo_3;
470
471         /* MN-related config */
472         u32 mn_sync_mode;       /* enable/ sync shift cclk/ sync shift mclk */
473         u32 mn_sync_shift_cclk;
474         u32 mn_sync_shift_mclk;
475         u32 mn_wb_en;
476         u32 mn_crystal_freq;    /* in MHz */
477         u32 mn_speed;           /* in MHz */
478         u32 mn_org;
479         u32 mn_depth;
480         u32 mn_ranks_0;         /* ranks per slot */
481         u32 mn_ranks_1;         /* ranks per slot */
482         u32 mn_rd_latency_0;
483         u32 mn_rd_latency_1;
484         u32 mn_rd_latency_2;
485         u32 mn_rd_latency_3;
486         u32 mn_rd_latency_4;
487         u32 mn_rd_latency_5;
488         u32 mn_rd_latency_6;
489         u32 mn_rd_latency_7;
490         u32 mn_rd_latency_8;
491         u32 mn_dll_val[18];
492         u32 mn_mode_reg;        /* MIU DDR Mode Register */
493         u32 mn_ext_mode_reg;    /* MIU DDR Extended Mode Register */
494         u32 mn_timing_0;        /* MIU Memory Control Timing Rgister */
495         u32 mn_timing_1;        /* MIU Extended Memory Ctrl Timing Register */
496         u32 mn_timing_2;        /* MIU Extended Memory Ctrl Timing2 Register */
497
498         /* SN-related config */
499         u32 sn_sync_mode;       /* enable/ sync shift cclk / sync shift mclk */
500         u32 sn_pt_mode;         /* pass through mode */
501         u32 sn_ecc_en;
502         u32 sn_wb_en;
503         u32 sn_crystal_freq;
504         u32 sn_speed;
505         u32 sn_org;
506         u32 sn_depth;
507         u32 sn_dll_tap;
508         u32 sn_rd_latency;
509
510         u32 mac_addr_hi_0;
511         u32 mac_addr_hi_1;
512         u32 mac_addr_hi_2;
513         u32 mac_addr_hi_3;
514
515         u32 magic;              /* indicates flash has been initialized */
516
517         u32 mn_rdimm;
518         u32 mn_dll_override;
519
520 };
521
522 #define FLASH_NUM_PORTS         (4)
523
524 struct netxen_flash_mac_addr {
525         u32 flash_addr[32];
526 };
527
528 struct netxen_user_old_info {
529         u8 flash_md5[16];
530         u8 crbinit_md5[16];
531         u8 brdcfg_md5[16];
532         /* bootloader */
533         u32 bootld_version;
534         u32 bootld_size;
535         u8 bootld_md5[16];
536         /* image */
537         u32 image_version;
538         u32 image_size;
539         u8 image_md5[16];
540         /* primary image status */
541         u32 primary_status;
542         u32 secondary_present;
543
544         /* MAC address , 4 ports */
545         struct netxen_flash_mac_addr mac_addr[FLASH_NUM_PORTS];
546 };
547 #define FLASH_NUM_MAC_PER_PORT  32
548 struct netxen_user_info {
549         u8 flash_md5[16 * 64];
550         /* bootloader */
551         u32 bootld_version;
552         u32 bootld_size;
553         /* image */
554         u32 image_version;
555         u32 image_size;
556         /* primary image status */
557         u32 primary_status;
558         u32 secondary_present;
559
560         /* MAC address , 4 ports, 32 address per port */
561         u64 mac_addr[FLASH_NUM_PORTS * FLASH_NUM_MAC_PER_PORT];
562         u32 sub_sys_id;
563         u8 serial_num[32];
564
565         /* Any user defined data */
566 };
567
568 /*
569  * Flash Layout - new format.
570  */
571 struct netxen_new_user_info {
572         u8 flash_md5[16 * 64];
573         /* bootloader */
574         u32 bootld_version;
575         u32 bootld_size;
576         /* image */
577         u32 image_version;
578         u32 image_size;
579         /* primary image status */
580         u32 primary_status;
581         u32 secondary_present;
582
583         /* MAC address , 4 ports, 32 address per port */
584         u64 mac_addr[FLASH_NUM_PORTS * FLASH_NUM_MAC_PER_PORT];
585         u32 sub_sys_id;
586         u8 serial_num[32];
587
588         /* Any user defined data */
589 };
590
591 #define SECONDARY_IMAGE_PRESENT 0xb3b4b5b6
592 #define SECONDARY_IMAGE_ABSENT  0xffffffff
593 #define PRIMARY_IMAGE_GOOD      0x5a5a5a5a
594 #define PRIMARY_IMAGE_BAD       0xffffffff
595
596 /* Flash memory map */
597 #define NETXEN_CRBINIT_START    0       /* crbinit section */
598 #define NETXEN_BRDCFG_START     0x4000  /* board config */
599 #define NETXEN_INITCODE_START   0x6000  /* pegtune code */
600 #define NETXEN_BOOTLD_START     0x10000 /* bootld */
601 #define NETXEN_IMAGE_START      0x43000 /* compressed image */
602 #define NETXEN_SECONDARY_START  0x200000        /* backup images */
603 #define NETXEN_PXE_START        0x3E0000        /* PXE boot rom */
604 #define NETXEN_USER_START       0x3E8000        /* Firmare info */
605 #define NETXEN_FIXED_START      0x3F0000        /* backup of crbinit */
606
607 #define NX_FW_VERSION_OFFSET    (NETXEN_USER_START+0x408)
608 #define NX_FW_SIZE_OFFSET       (NETXEN_USER_START+0x40c)
609 #define NX_BIOS_VERSION_OFFSET  (NETXEN_USER_START+0x83c)
610 #define NX_FW_MAGIC_OFFSET      (NETXEN_BRDCFG_START+0x128)
611 #define NX_FW_MIN_SIZE          (0x3fffff)
612 #define NX_P2_MN_ROMIMAGE       0
613 #define NX_P3_CT_ROMIMAGE       1
614 #define NX_P3_MN_ROMIMAGE       2
615
616 #define NETXEN_USER_START_OLD NETXEN_PXE_START  /* for backward compatibility */
617
618 #define NETXEN_FLASH_START              (NETXEN_CRBINIT_START)
619 #define NETXEN_INIT_SECTOR              (0)
620 #define NETXEN_PRIMARY_START            (NETXEN_BOOTLD_START)
621 #define NETXEN_FLASH_CRBINIT_SIZE       (0x4000)
622 #define NETXEN_FLASH_BRDCFG_SIZE        (sizeof(struct netxen_board_info))
623 #define NETXEN_FLASH_USER_SIZE          (sizeof(struct netxen_user_info)/sizeof(u32))
624 #define NETXEN_FLASH_SECONDARY_SIZE     (NETXEN_USER_START-NETXEN_SECONDARY_START)
625 #define NETXEN_NUM_PRIMARY_SECTORS      (0x20)
626 #define NETXEN_NUM_CONFIG_SECTORS       (1)
627 extern char netxen_nic_driver_name[];
628
629 /* Number of status descriptors to handle per interrupt */
630 #define MAX_STATUS_HANDLE       (64)
631
632 /*
633  * netxen_skb_frag{} is to contain mapping info for each SG list. This
634  * has to be freed when DMA is complete. This is part of netxen_tx_buffer{}.
635  */
636 struct netxen_skb_frag {
637         u64 dma;
638         u64 length;
639 };
640
641 #define _netxen_set_bits(config_word, start, bits, val) {\
642         unsigned long long __tmask = (((1ULL << (bits)) - 1) << (start));\
643         unsigned long long __tvalue = (val);    \
644         (config_word) &= ~__tmask;      \
645         (config_word) |= (((__tvalue) << (start)) & __tmask); \
646 }
647
648 #define _netxen_clear_bits(config_word, start, bits) {\
649         unsigned long long __tmask = (((1ULL << (bits)) - 1) << (start));  \
650         (config_word) &= ~__tmask; \
651 }
652
653 /*    Following defines are for the state of the buffers    */
654 #define NETXEN_BUFFER_FREE      0
655 #define NETXEN_BUFFER_BUSY      1
656
657 /*
658  * There will be one netxen_buffer per skb packet.    These will be
659  * used to save the dma info for pci_unmap_page()
660  */
661 struct netxen_cmd_buffer {
662         struct sk_buff *skb;
663         struct netxen_skb_frag frag_array[MAX_BUFFERS_PER_CMD + 1];
664         u32 frag_count;
665 };
666
667 /* In rx_buffer, we do not need multiple fragments as is a single buffer */
668 struct netxen_rx_buffer {
669         struct list_head list;
670         struct sk_buff *skb;
671         u64 dma;
672         u16 ref_handle;
673         u16 state;
674 };
675
676 /* Board types */
677 #define NETXEN_NIC_GBE  0x01
678 #define NETXEN_NIC_XGBE 0x02
679
680 /*
681  * One hardware_context{} per adapter
682  * contains interrupt info as well shared hardware info.
683  */
684 struct netxen_hardware_context {
685         void __iomem *pci_base0;
686         void __iomem *pci_base1;
687         void __iomem *pci_base2;
688         void __iomem *db_base;
689         unsigned long db_len;
690         unsigned long pci_len0;
691
692         int qdr_sn_window;
693         int ddr_mn_window;
694         unsigned long mn_win_crb;
695         unsigned long ms_win_crb;
696
697         u8 cut_through;
698         u8 revision_id;
699         u8 pci_func;
700         u8 linkup;
701         u16 port_type;
702         u16 board_type;
703 };
704
705 #define MINIMUM_ETHERNET_FRAME_SIZE     64      /* With FCS */
706 #define ETHERNET_FCS_SIZE               4
707
708 struct netxen_adapter_stats {
709         u64  xmitcalled;
710         u64  xmitfinished;
711         u64  rxdropped;
712         u64  txdropped;
713         u64  csummed;
714         u64  no_rcv;
715         u64  rxbytes;
716         u64  txbytes;
717 };
718
719 /*
720  * Rcv Descriptor Context. One such per Rcv Descriptor. There may
721  * be one Rcv Descriptor for normal packets, one for jumbo and may be others.
722  */
723 struct nx_host_rds_ring {
724         u32 producer;
725         u32 crb_rcv_producer;
726         u32 num_desc;
727         u32 dma_size;
728         u32 skb_size;
729         u32 flags;
730         struct rcv_desc *desc_head;
731         struct netxen_rx_buffer *rx_buf_arr;
732         struct list_head free_list;
733         spinlock_t lock;
734         dma_addr_t phys_addr;
735 };
736
737 struct nx_host_sds_ring {
738         u32 consumer;
739         u32 crb_sts_consumer;
740         u32 crb_intr_mask;
741         u32 num_desc;
742
743         struct status_desc *desc_head;
744         struct netxen_adapter *adapter;
745         struct napi_struct napi;
746         struct list_head free_list[NUM_RCV_DESC_RINGS];
747
748         int irq;
749
750         dma_addr_t phys_addr;
751         char name[IFNAMSIZ+4];
752 };
753
754 struct nx_host_tx_ring {
755         u32 producer;
756         __le32 *hw_consumer;
757         u32 sw_consumer;
758         u32 crb_cmd_producer;
759         u32 crb_cmd_consumer;
760         u32 num_desc;
761
762         struct netxen_cmd_buffer *cmd_buf_arr;
763         struct cmd_desc_type0 *desc_head;
764         dma_addr_t phys_addr;
765 };
766
767 /*
768  * Receive context. There is one such structure per instance of the
769  * receive processing. Any state information that is relevant to
770  * the receive, and is must be in this structure. The global data may be
771  * present elsewhere.
772  */
773 struct netxen_recv_context {
774         u32 state;
775         u16 context_id;
776         u16 virt_port;
777
778         struct nx_host_rds_ring *rds_rings;
779         struct nx_host_sds_ring *sds_rings;
780
781         struct netxen_ring_ctx *hwctx;
782         dma_addr_t phys_addr;
783 };
784
785 /* New HW context creation */
786
787 #define NX_OS_CRB_RETRY_COUNT   4000
788 #define NX_CDRP_SIGNATURE_MAKE(pcifn, version) \
789         (((pcifn) & 0xff) | (((version) & 0xff) << 8) | (0xcafe << 16))
790
791 #define NX_CDRP_CLEAR           0x00000000
792 #define NX_CDRP_CMD_BIT         0x80000000
793
794 /*
795  * All responses must have the NX_CDRP_CMD_BIT cleared
796  * in the crb NX_CDRP_CRB_OFFSET.
797  */
798 #define NX_CDRP_FORM_RSP(rsp)   (rsp)
799 #define NX_CDRP_IS_RSP(rsp)     (((rsp) & NX_CDRP_CMD_BIT) == 0)
800
801 #define NX_CDRP_RSP_OK          0x00000001
802 #define NX_CDRP_RSP_FAIL        0x00000002
803 #define NX_CDRP_RSP_TIMEOUT     0x00000003
804
805 /*
806  * All commands must have the NX_CDRP_CMD_BIT set in
807  * the crb NX_CDRP_CRB_OFFSET.
808  */
809 #define NX_CDRP_FORM_CMD(cmd)   (NX_CDRP_CMD_BIT | (cmd))
810 #define NX_CDRP_IS_CMD(cmd)     (((cmd) & NX_CDRP_CMD_BIT) != 0)
811
812 #define NX_CDRP_CMD_SUBMIT_CAPABILITIES     0x00000001
813 #define NX_CDRP_CMD_READ_MAX_RDS_PER_CTX    0x00000002
814 #define NX_CDRP_CMD_READ_MAX_SDS_PER_CTX    0x00000003
815 #define NX_CDRP_CMD_READ_MAX_RULES_PER_CTX  0x00000004
816 #define NX_CDRP_CMD_READ_MAX_RX_CTX         0x00000005
817 #define NX_CDRP_CMD_READ_MAX_TX_CTX         0x00000006
818 #define NX_CDRP_CMD_CREATE_RX_CTX           0x00000007
819 #define NX_CDRP_CMD_DESTROY_RX_CTX          0x00000008
820 #define NX_CDRP_CMD_CREATE_TX_CTX           0x00000009
821 #define NX_CDRP_CMD_DESTROY_TX_CTX          0x0000000a
822 #define NX_CDRP_CMD_SETUP_STATISTICS        0x0000000e
823 #define NX_CDRP_CMD_GET_STATISTICS          0x0000000f
824 #define NX_CDRP_CMD_DELETE_STATISTICS       0x00000010
825 #define NX_CDRP_CMD_SET_MTU                 0x00000012
826 #define NX_CDRP_CMD_MAX                     0x00000013
827
828 #define NX_RCODE_SUCCESS                0
829 #define NX_RCODE_NO_HOST_MEM            1
830 #define NX_RCODE_NO_HOST_RESOURCE       2
831 #define NX_RCODE_NO_CARD_CRB            3
832 #define NX_RCODE_NO_CARD_MEM            4
833 #define NX_RCODE_NO_CARD_RESOURCE       5
834 #define NX_RCODE_INVALID_ARGS           6
835 #define NX_RCODE_INVALID_ACTION         7
836 #define NX_RCODE_INVALID_STATE          8
837 #define NX_RCODE_NOT_SUPPORTED          9
838 #define NX_RCODE_NOT_PERMITTED          10
839 #define NX_RCODE_NOT_READY              11
840 #define NX_RCODE_DOES_NOT_EXIST         12
841 #define NX_RCODE_ALREADY_EXISTS         13
842 #define NX_RCODE_BAD_SIGNATURE          14
843 #define NX_RCODE_CMD_NOT_IMPL           15
844 #define NX_RCODE_CMD_INVALID            16
845 #define NX_RCODE_TIMEOUT                17
846 #define NX_RCODE_CMD_FAILED             18
847 #define NX_RCODE_MAX_EXCEEDED           19
848 #define NX_RCODE_MAX                    20
849
850 #define NX_DESTROY_CTX_RESET            0
851 #define NX_DESTROY_CTX_D3_RESET         1
852 #define NX_DESTROY_CTX_MAX              2
853
854 /*
855  * Capabilities
856  */
857 #define NX_CAP_BIT(class, bit)          (1 << bit)
858 #define NX_CAP0_LEGACY_CONTEXT          NX_CAP_BIT(0, 0)
859 #define NX_CAP0_MULTI_CONTEXT           NX_CAP_BIT(0, 1)
860 #define NX_CAP0_LEGACY_MN               NX_CAP_BIT(0, 2)
861 #define NX_CAP0_LEGACY_MS               NX_CAP_BIT(0, 3)
862 #define NX_CAP0_CUT_THROUGH             NX_CAP_BIT(0, 4)
863 #define NX_CAP0_LRO                     NX_CAP_BIT(0, 5)
864 #define NX_CAP0_LSO                     NX_CAP_BIT(0, 6)
865 #define NX_CAP0_JUMBO_CONTIGUOUS        NX_CAP_BIT(0, 7)
866 #define NX_CAP0_LRO_CONTIGUOUS          NX_CAP_BIT(0, 8)
867
868 /*
869  * Context state
870  */
871 #define NX_HOST_CTX_STATE_FREED         0
872 #define NX_HOST_CTX_STATE_ALLOCATED     1
873 #define NX_HOST_CTX_STATE_ACTIVE        2
874 #define NX_HOST_CTX_STATE_DISABLED      3
875 #define NX_HOST_CTX_STATE_QUIESCED      4
876 #define NX_HOST_CTX_STATE_MAX           5
877
878 /*
879  * Rx context
880  */
881
882 typedef struct {
883         __le64 host_phys_addr;  /* Ring base addr */
884         __le32 ring_size;               /* Ring entries */
885         __le16 msi_index;
886         __le16 rsvd;            /* Padding */
887 } nx_hostrq_sds_ring_t;
888
889 typedef struct {
890         __le64 host_phys_addr;  /* Ring base addr */
891         __le64 buff_size;               /* Packet buffer size */
892         __le32 ring_size;               /* Ring entries */
893         __le32 ring_kind;               /* Class of ring */
894 } nx_hostrq_rds_ring_t;
895
896 typedef struct {
897         __le64 host_rsp_dma_addr;       /* Response dma'd here */
898         __le32 capabilities[4]; /* Flag bit vector */
899         __le32 host_int_crb_mode;       /* Interrupt crb usage */
900         __le32 host_rds_crb_mode;       /* RDS crb usage */
901         /* These ring offsets are relative to data[0] below */
902         __le32 rds_ring_offset; /* Offset to RDS config */
903         __le32 sds_ring_offset; /* Offset to SDS config */
904         __le16 num_rds_rings;   /* Count of RDS rings */
905         __le16 num_sds_rings;   /* Count of SDS rings */
906         __le16 rsvd1;           /* Padding */
907         __le16 rsvd2;           /* Padding */
908         u8  reserved[128];      /* reserve space for future expansion*/
909         /* MUST BE 64-bit aligned.
910            The following is packed:
911            - N hostrq_rds_rings
912            - N hostrq_sds_rings */
913         char data[0];
914 } nx_hostrq_rx_ctx_t;
915
916 typedef struct {
917         __le32 host_producer_crb;       /* Crb to use */
918         __le32 rsvd1;           /* Padding */
919 } nx_cardrsp_rds_ring_t;
920
921 typedef struct {
922         __le32 host_consumer_crb;       /* Crb to use */
923         __le32 interrupt_crb;   /* Crb to use */
924 } nx_cardrsp_sds_ring_t;
925
926 typedef struct {
927         /* These ring offsets are relative to data[0] below */
928         __le32 rds_ring_offset; /* Offset to RDS config */
929         __le32 sds_ring_offset; /* Offset to SDS config */
930         __le32 host_ctx_state;  /* Starting State */
931         __le32 num_fn_per_port; /* How many PCI fn share the port */
932         __le16 num_rds_rings;   /* Count of RDS rings */
933         __le16 num_sds_rings;   /* Count of SDS rings */
934         __le16 context_id;              /* Handle for context */
935         u8  phys_port;          /* Physical id of port */
936         u8  virt_port;          /* Virtual/Logical id of port */
937         u8  reserved[128];      /* save space for future expansion */
938         /*  MUST BE 64-bit aligned.
939            The following is packed:
940            - N cardrsp_rds_rings
941            - N cardrs_sds_rings */
942         char data[0];
943 } nx_cardrsp_rx_ctx_t;
944
945 #define SIZEOF_HOSTRQ_RX(HOSTRQ_RX, rds_rings, sds_rings)       \
946         (sizeof(HOSTRQ_RX) +                                    \
947         (rds_rings)*(sizeof(nx_hostrq_rds_ring_t)) +            \
948         (sds_rings)*(sizeof(nx_hostrq_sds_ring_t)))
949
950 #define SIZEOF_CARDRSP_RX(CARDRSP_RX, rds_rings, sds_rings)     \
951         (sizeof(CARDRSP_RX) +                                   \
952         (rds_rings)*(sizeof(nx_cardrsp_rds_ring_t)) +           \
953         (sds_rings)*(sizeof(nx_cardrsp_sds_ring_t)))
954
955 /*
956  * Tx context
957  */
958
959 typedef struct {
960         __le64 host_phys_addr;  /* Ring base addr */
961         __le32 ring_size;               /* Ring entries */
962         __le32 rsvd;            /* Padding */
963 } nx_hostrq_cds_ring_t;
964
965 typedef struct {
966         __le64 host_rsp_dma_addr;       /* Response dma'd here */
967         __le64 cmd_cons_dma_addr;       /*  */
968         __le64 dummy_dma_addr;  /*  */
969         __le32 capabilities[4]; /* Flag bit vector */
970         __le32 host_int_crb_mode;       /* Interrupt crb usage */
971         __le32 rsvd1;           /* Padding */
972         __le16 rsvd2;           /* Padding */
973         __le16 interrupt_ctl;
974         __le16 msi_index;
975         __le16 rsvd3;           /* Padding */
976         nx_hostrq_cds_ring_t cds_ring;  /* Desc of cds ring */
977         u8  reserved[128];      /* future expansion */
978 } nx_hostrq_tx_ctx_t;
979
980 typedef struct {
981         __le32 host_producer_crb;       /* Crb to use */
982         __le32 interrupt_crb;   /* Crb to use */
983 } nx_cardrsp_cds_ring_t;
984
985 typedef struct {
986         __le32 host_ctx_state;  /* Starting state */
987         __le16 context_id;              /* Handle for context */
988         u8  phys_port;          /* Physical id of port */
989         u8  virt_port;          /* Virtual/Logical id of port */
990         nx_cardrsp_cds_ring_t cds_ring; /* Card cds settings */
991         u8  reserved[128];      /* future expansion */
992 } nx_cardrsp_tx_ctx_t;
993
994 #define SIZEOF_HOSTRQ_TX(HOSTRQ_TX)     (sizeof(HOSTRQ_TX))
995 #define SIZEOF_CARDRSP_TX(CARDRSP_TX)   (sizeof(CARDRSP_TX))
996
997 /* CRB */
998
999 #define NX_HOST_RDS_CRB_MODE_UNIQUE     0
1000 #define NX_HOST_RDS_CRB_MODE_SHARED     1
1001 #define NX_HOST_RDS_CRB_MODE_CUSTOM     2
1002 #define NX_HOST_RDS_CRB_MODE_MAX        3
1003
1004 #define NX_HOST_INT_CRB_MODE_UNIQUE     0
1005 #define NX_HOST_INT_CRB_MODE_SHARED     1
1006 #define NX_HOST_INT_CRB_MODE_NORX       2
1007 #define NX_HOST_INT_CRB_MODE_NOTX       3
1008 #define NX_HOST_INT_CRB_MODE_NORXTX     4
1009
1010
1011 /* MAC */
1012
1013 #define MC_COUNT_P2     16
1014 #define MC_COUNT_P3     38
1015
1016 #define NETXEN_MAC_NOOP 0
1017 #define NETXEN_MAC_ADD  1
1018 #define NETXEN_MAC_DEL  2
1019
1020 typedef struct nx_mac_list_s {
1021         struct nx_mac_list_s *next;
1022         uint8_t mac_addr[MAX_ADDR_LEN];
1023 } nx_mac_list_t;
1024
1025 /*
1026  * Interrupt coalescing defaults. The defaults are for 1500 MTU. It is
1027  * adjusted based on configured MTU.
1028  */
1029 #define NETXEN_DEFAULT_INTR_COALESCE_RX_TIME_US 3
1030 #define NETXEN_DEFAULT_INTR_COALESCE_RX_PACKETS 256
1031 #define NETXEN_DEFAULT_INTR_COALESCE_TX_PACKETS 64
1032 #define NETXEN_DEFAULT_INTR_COALESCE_TX_TIME_US 4
1033
1034 #define NETXEN_NIC_INTR_DEFAULT                 0x04
1035
1036 typedef union {
1037         struct {
1038                 uint16_t        rx_packets;
1039                 uint16_t        rx_time_us;
1040                 uint16_t        tx_packets;
1041                 uint16_t        tx_time_us;
1042         } data;
1043         uint64_t                word;
1044 } nx_nic_intr_coalesce_data_t;
1045
1046 typedef struct {
1047         uint16_t                        stats_time_us;
1048         uint16_t                        rate_sample_time;
1049         uint16_t                        flags;
1050         uint16_t                        rsvd_1;
1051         uint32_t                        low_threshold;
1052         uint32_t                        high_threshold;
1053         nx_nic_intr_coalesce_data_t     normal;
1054         nx_nic_intr_coalesce_data_t     low;
1055         nx_nic_intr_coalesce_data_t     high;
1056         nx_nic_intr_coalesce_data_t     irq;
1057 } nx_nic_intr_coalesce_t;
1058
1059 #define NX_HOST_REQUEST         0x13
1060 #define NX_NIC_REQUEST          0x14
1061
1062 #define NX_MAC_EVENT            0x1
1063
1064 /*
1065  * Driver --> Firmware
1066  */
1067 #define NX_NIC_H2C_OPCODE_START                         0
1068 #define NX_NIC_H2C_OPCODE_CONFIG_RSS                    1
1069 #define NX_NIC_H2C_OPCODE_CONFIG_RSS_TBL                2
1070 #define NX_NIC_H2C_OPCODE_CONFIG_INTR_COALESCE          3
1071 #define NX_NIC_H2C_OPCODE_CONFIG_LED                    4
1072 #define NX_NIC_H2C_OPCODE_CONFIG_PROMISCUOUS            5
1073 #define NX_NIC_H2C_OPCODE_CONFIG_L2_MAC                 6
1074 #define NX_NIC_H2C_OPCODE_LRO_REQUEST                   7
1075 #define NX_NIC_H2C_OPCODE_GET_SNMP_STATS                8
1076 #define NX_NIC_H2C_OPCODE_PROXY_START_REQUEST           9
1077 #define NX_NIC_H2C_OPCODE_PROXY_STOP_REQUEST            10
1078 #define NX_NIC_H2C_OPCODE_PROXY_SET_MTU                 11
1079 #define NX_NIC_H2C_OPCODE_PROXY_SET_VPORT_MISS_MODE     12
1080 #define NX_NIC_H2C_OPCODE_GET_FINGER_PRINT_REQUEST      13
1081 #define NX_NIC_H2C_OPCODE_INSTALL_LICENSE_REQUEST       14
1082 #define NX_NIC_H2C_OPCODE_GET_LICENSE_CAPABILITY_REQUEST        15
1083 #define NX_NIC_H2C_OPCODE_GET_NET_STATS                 16
1084 #define NX_NIC_H2C_OPCODE_PROXY_UPDATE_P2V              17
1085 #define NX_NIC_H2C_OPCODE_CONFIG_IPADDR                 18
1086 #define NX_NIC_H2C_OPCODE_CONFIG_LOOPBACK               19
1087 #define NX_NIC_H2C_OPCODE_PROXY_STOP_DONE               20
1088 #define NX_NIC_H2C_OPCODE_GET_LINKEVENT                 21
1089 #define NX_NIC_C2C_OPCODE                               22
1090 #define NX_NIC_H2C_OPCODE_LAST                          23
1091
1092 /*
1093  * Firmware --> Driver
1094  */
1095
1096 #define NX_NIC_C2H_OPCODE_START                         128
1097 #define NX_NIC_C2H_OPCODE_CONFIG_RSS_RESPONSE           129
1098 #define NX_NIC_C2H_OPCODE_CONFIG_RSS_TBL_RESPONSE       130
1099 #define NX_NIC_C2H_OPCODE_CONFIG_MAC_RESPONSE           131
1100 #define NX_NIC_C2H_OPCODE_CONFIG_PROMISCUOUS_RESPONSE   132
1101 #define NX_NIC_C2H_OPCODE_CONFIG_L2_MAC_RESPONSE        133
1102 #define NX_NIC_C2H_OPCODE_LRO_DELETE_RESPONSE           134
1103 #define NX_NIC_C2H_OPCODE_LRO_ADD_FAILURE_RESPONSE      135
1104 #define NX_NIC_C2H_OPCODE_GET_SNMP_STATS                136
1105 #define NX_NIC_C2H_OPCODE_GET_FINGER_PRINT_REPLY        137
1106 #define NX_NIC_C2H_OPCODE_INSTALL_LICENSE_REPLY         138
1107 #define NX_NIC_C2H_OPCODE_GET_LICENSE_CAPABILITIES_REPLY 139
1108 #define NX_NIC_C2H_OPCODE_GET_NET_STATS_RESPONSE        140
1109 #define NX_NIC_C2H_OPCODE_GET_LINKEVENT_RESPONSE        141
1110 #define NX_NIC_C2H_OPCODE_LAST                          142
1111
1112 #define VPORT_MISS_MODE_DROP            0 /* drop all unmatched */
1113 #define VPORT_MISS_MODE_ACCEPT_ALL      1 /* accept all packets */
1114 #define VPORT_MISS_MODE_ACCEPT_MULTI    2 /* accept unmatched multicast */
1115
1116 #define NX_FW_CAPABILITY_LINK_NOTIFICATION      (1 << 5)
1117 #define NX_FW_CAPABILITY_SWITCHING              (1 << 6)
1118
1119 /* module types */
1120 #define LINKEVENT_MODULE_NOT_PRESENT                    1
1121 #define LINKEVENT_MODULE_OPTICAL_UNKNOWN                2
1122 #define LINKEVENT_MODULE_OPTICAL_SRLR                   3
1123 #define LINKEVENT_MODULE_OPTICAL_LRM                    4
1124 #define LINKEVENT_MODULE_OPTICAL_SFP_1G                 5
1125 #define LINKEVENT_MODULE_TWINAX_UNSUPPORTED_CABLE       6
1126 #define LINKEVENT_MODULE_TWINAX_UNSUPPORTED_CABLELEN    7
1127 #define LINKEVENT_MODULE_TWINAX                         8
1128
1129 #define LINKSPEED_10GBPS        10000
1130 #define LINKSPEED_1GBPS         1000
1131 #define LINKSPEED_100MBPS       100
1132 #define LINKSPEED_10MBPS        10
1133
1134 #define LINKSPEED_ENCODED_10MBPS        0
1135 #define LINKSPEED_ENCODED_100MBPS       1
1136 #define LINKSPEED_ENCODED_1GBPS         2
1137
1138 #define LINKEVENT_AUTONEG_DISABLED      0
1139 #define LINKEVENT_AUTONEG_ENABLED       1
1140
1141 #define LINKEVENT_HALF_DUPLEX           0
1142 #define LINKEVENT_FULL_DUPLEX           1
1143
1144 #define LINKEVENT_LINKSPEED_MBPS        0
1145 #define LINKEVENT_LINKSPEED_ENCODED     1
1146
1147 /* firmware response header:
1148  *      63:58 - message type
1149  *      57:56 - owner
1150  *      55:53 - desc count
1151  *      52:48 - reserved
1152  *      47:40 - completion id
1153  *      39:32 - opcode
1154  *      31:16 - error code
1155  *      15:00 - reserved
1156  */
1157 #define netxen_get_nic_msgtype(msg_hdr) \
1158         ((msg_hdr >> 58) & 0x3F)
1159 #define netxen_get_nic_msg_compid(msg_hdr)      \
1160         ((msg_hdr >> 40) & 0xFF)
1161 #define netxen_get_nic_msg_opcode(msg_hdr)      \
1162         ((msg_hdr >> 32) & 0xFF)
1163 #define netxen_get_nic_msg_errcode(msg_hdr)     \
1164         ((msg_hdr >> 16) & 0xFFFF)
1165
1166 typedef struct {
1167         union {
1168                 struct {
1169                         u64 hdr;
1170                         u64 body[7];
1171                 };
1172                 u64 words[8];
1173         };
1174 } nx_fw_msg_t;
1175
1176 typedef struct {
1177         __le64 qhdr;
1178         __le64 req_hdr;
1179         __le64 words[6];
1180 } nx_nic_req_t;
1181
1182 typedef struct {
1183         u8 op;
1184         u8 tag;
1185         u8 mac_addr[6];
1186 } nx_mac_req_t;
1187
1188 #define MAX_PENDING_DESC_BLOCK_SIZE     64
1189
1190 #define NETXEN_NIC_MSI_ENABLED          0x02
1191 #define NETXEN_NIC_MSIX_ENABLED         0x04
1192 #define NETXEN_IS_MSI_FAMILY(adapter) \
1193         ((adapter)->flags & (NETXEN_NIC_MSI_ENABLED | NETXEN_NIC_MSIX_ENABLED))
1194
1195 #define MSIX_ENTRIES_PER_ADAPTER        NUM_STS_DESC_RINGS
1196 #define NETXEN_MSIX_TBL_SPACE           8192
1197 #define NETXEN_PCI_REG_MSIX_TBL         0x44
1198
1199 #define NETXEN_DB_MAPSIZE_BYTES         0x1000
1200
1201 #define NETXEN_NETDEV_WEIGHT 128
1202 #define NETXEN_ADAPTER_UP_MAGIC 777
1203 #define NETXEN_NIC_PEG_TUNE 0
1204
1205 struct netxen_dummy_dma {
1206         void *addr;
1207         dma_addr_t phys_addr;
1208 };
1209
1210 struct netxen_adapter {
1211         struct netxen_hardware_context ahw;
1212
1213         struct net_device *netdev;
1214         struct pci_dev *pdev;
1215         nx_mac_list_t   *mac_list;
1216
1217         u32 curr_window;
1218         u32 crb_win;
1219         rwlock_t adapter_lock;
1220
1221         spinlock_t tx_clean_lock;
1222
1223         u16 num_txd;
1224         u16 num_rxd;
1225         u16 num_jumbo_rxd;
1226         u16 num_lro_rxd;
1227
1228         u8 max_rds_rings;
1229         u8 max_sds_rings;
1230         u8 driver_mismatch;
1231         u8 msix_supported;
1232         u8 rx_csum;
1233         u8 pci_using_dac;
1234         u8 portnum;
1235         u8 physical_port;
1236
1237         u8 mc_enabled;
1238         u8 max_mc_count;
1239         u8 rss_supported;
1240         u8 resv2;
1241         u32 resv3;
1242
1243         u8 has_link_events;
1244         u8 resv1;
1245         u16 tx_context_id;
1246         u16 mtu;
1247         u16 is_up;
1248
1249         u16 link_speed;
1250         u16 link_duplex;
1251         u16 link_autoneg;
1252         u16 module_type;
1253
1254         u32 capabilities;
1255         u32 flags;
1256         u32 irq;
1257         u32 temp;
1258         u32 fw_major;
1259         u32 fw_version;
1260
1261         struct netxen_adapter_stats stats;
1262
1263         struct netxen_recv_context recv_ctx;
1264         struct nx_host_tx_ring *tx_ring;
1265
1266         int (*enable_phy_interrupts) (struct netxen_adapter *);
1267         int (*disable_phy_interrupts) (struct netxen_adapter *);
1268         int (*macaddr_set) (struct netxen_adapter *, netxen_ethernet_macaddr_t);
1269         int (*set_mtu) (struct netxen_adapter *, int);
1270         int (*set_promisc) (struct netxen_adapter *, u32);
1271         int (*phy_read) (struct netxen_adapter *, long reg, u32 *);
1272         int (*phy_write) (struct netxen_adapter *, long reg, u32 val);
1273         int (*init_port) (struct netxen_adapter *, int);
1274         int (*stop_port) (struct netxen_adapter *);
1275
1276         u32 (*hw_read_wx)(struct netxen_adapter *, ulong);
1277         int (*hw_write_wx)(struct netxen_adapter *, ulong, u32);
1278         int (*pci_mem_read)(struct netxen_adapter *, u64, void *, int);
1279         int (*pci_mem_write)(struct netxen_adapter *, u64, void *, int);
1280         int (*pci_write_immediate)(struct netxen_adapter *, u64, u32);
1281         u32 (*pci_read_immediate)(struct netxen_adapter *, u64);
1282         unsigned long (*pci_set_window)(struct netxen_adapter *,
1283                         unsigned long long);
1284
1285         struct netxen_legacy_intr_set legacy_intr;
1286
1287         struct msix_entry msix_entries[MSIX_ENTRIES_PER_ADAPTER];
1288
1289         struct netxen_dummy_dma dummy_dma;
1290
1291         struct work_struct watchdog_task;
1292         struct timer_list watchdog_timer;
1293         struct work_struct  tx_timeout_task;
1294
1295         struct net_device_stats net_stats;
1296
1297         nx_nic_intr_coalesce_t coal;
1298 };
1299
1300 /*
1301  * NetXen dma watchdog control structure
1302  *
1303  *      Bit 0           : enabled => R/O: 1 watchdog active, 0 inactive
1304  *      Bit 1           : disable_request => 1 req disable dma watchdog
1305  *      Bit 2           : enable_request =>  1 req enable dma watchdog
1306  *      Bit 3-31        : unused
1307  */
1308
1309 #define netxen_set_dma_watchdog_disable_req(config_word) \
1310         _netxen_set_bits(config_word, 1, 1, 1)
1311 #define netxen_set_dma_watchdog_enable_req(config_word) \
1312         _netxen_set_bits(config_word, 2, 1, 1)
1313 #define netxen_get_dma_watchdog_enabled(config_word) \
1314         ((config_word) & 0x1)
1315 #define netxen_get_dma_watchdog_disabled(config_word) \
1316         (((config_word) >> 1) & 0x1)
1317
1318 int netxen_niu_xgbe_enable_phy_interrupts(struct netxen_adapter *adapter);
1319 int netxen_niu_gbe_enable_phy_interrupts(struct netxen_adapter *adapter);
1320 int netxen_niu_xgbe_disable_phy_interrupts(struct netxen_adapter *adapter);
1321 int netxen_niu_gbe_disable_phy_interrupts(struct netxen_adapter *adapter);
1322 int netxen_niu_gbe_phy_read(struct netxen_adapter *adapter, long reg,
1323                             __u32 * readval);
1324 int netxen_niu_gbe_phy_write(struct netxen_adapter *adapter,
1325                              long reg, __u32 val);
1326
1327 /* Functions available from netxen_nic_hw.c */
1328 int netxen_nic_set_mtu_xgb(struct netxen_adapter *adapter, int new_mtu);
1329 int netxen_nic_set_mtu_gb(struct netxen_adapter *adapter, int new_mtu);
1330
1331 #define NXRD32(adapter, off) \
1332         (adapter->hw_read_wx(adapter, off))
1333 #define NXWR32(adapter, off, val) \
1334         (adapter->hw_write_wx(adapter, off, val))
1335
1336 int netxen_nic_get_board_info(struct netxen_adapter *adapter);
1337 void netxen_nic_get_firmware_info(struct netxen_adapter *adapter);
1338 int netxen_nic_wol_supported(struct netxen_adapter *adapter);
1339
1340 u32 netxen_nic_hw_read_wx_128M(struct netxen_adapter *adapter, ulong off);
1341 int netxen_nic_hw_write_wx_128M(struct netxen_adapter *adapter,
1342                 ulong off, u32 data);
1343 int netxen_nic_pci_mem_read_128M(struct netxen_adapter *adapter,
1344                 u64 off, void *data, int size);
1345 int netxen_nic_pci_mem_write_128M(struct netxen_adapter *adapter,
1346                 u64 off, void *data, int size);
1347 int netxen_nic_pci_write_immediate_128M(struct netxen_adapter *adapter,
1348                 u64 off, u32 data);
1349 u32 netxen_nic_pci_read_immediate_128M(struct netxen_adapter *adapter, u64 off);
1350 void netxen_nic_pci_write_normalize_128M(struct netxen_adapter *adapter,
1351                 u64 off, u32 data);
1352 u32 netxen_nic_pci_read_normalize_128M(struct netxen_adapter *adapter, u64 off);
1353 unsigned long netxen_nic_pci_set_window_128M(struct netxen_adapter *adapter,
1354                 unsigned long long addr);
1355 void netxen_nic_pci_change_crbwindow_128M(struct netxen_adapter *adapter,
1356                 u32 wndw);
1357
1358 u32 netxen_nic_hw_read_wx_2M(struct netxen_adapter *adapter, ulong off);
1359 int netxen_nic_hw_write_wx_2M(struct netxen_adapter *adapter,
1360                 ulong off, u32 data);
1361 int netxen_nic_pci_mem_read_2M(struct netxen_adapter *adapter,
1362                 u64 off, void *data, int size);
1363 int netxen_nic_pci_mem_write_2M(struct netxen_adapter *adapter,
1364                 u64 off, void *data, int size);
1365 int netxen_nic_pci_write_immediate_2M(struct netxen_adapter *adapter,
1366                 u64 off, u32 data);
1367 u32 netxen_nic_pci_read_immediate_2M(struct netxen_adapter *adapter, u64 off);
1368 void netxen_nic_pci_write_normalize_2M(struct netxen_adapter *adapter,
1369                 u64 off, u32 data);
1370 u32 netxen_nic_pci_read_normalize_2M(struct netxen_adapter *adapter, u64 off);
1371 unsigned long netxen_nic_pci_set_window_2M(struct netxen_adapter *adapter,
1372                 unsigned long long addr);
1373
1374 /* Functions from netxen_nic_init.c */
1375 void netxen_free_adapter_offload(struct netxen_adapter *adapter);
1376 int netxen_initialize_adapter_offload(struct netxen_adapter *adapter);
1377 int netxen_phantom_init(struct netxen_adapter *adapter, int pegtune_val);
1378 int netxen_load_firmware(struct netxen_adapter *adapter);
1379 int netxen_pinit_from_rom(struct netxen_adapter *adapter, int verbose);
1380
1381 int netxen_rom_fast_read(struct netxen_adapter *adapter, int addr, int *valp);
1382 int netxen_rom_fast_read_words(struct netxen_adapter *adapter, int addr,
1383                                 u8 *bytes, size_t size);
1384 int netxen_rom_fast_write_words(struct netxen_adapter *adapter, int addr,
1385                                 u8 *bytes, size_t size);
1386 int netxen_flash_unlock(struct netxen_adapter *adapter);
1387 int netxen_backup_crbinit(struct netxen_adapter *adapter);
1388 int netxen_flash_erase_secondary(struct netxen_adapter *adapter);
1389 int netxen_flash_erase_primary(struct netxen_adapter *adapter);
1390 void netxen_halt_pegs(struct netxen_adapter *adapter);
1391
1392 int netxen_rom_se(struct netxen_adapter *adapter, int addr);
1393
1394 int netxen_alloc_sw_resources(struct netxen_adapter *adapter);
1395 void netxen_free_sw_resources(struct netxen_adapter *adapter);
1396
1397 int netxen_alloc_hw_resources(struct netxen_adapter *adapter);
1398 void netxen_free_hw_resources(struct netxen_adapter *adapter);
1399
1400 void netxen_release_rx_buffers(struct netxen_adapter *adapter);
1401 void netxen_release_tx_buffers(struct netxen_adapter *adapter);
1402
1403 void netxen_initialize_adapter_ops(struct netxen_adapter *adapter);
1404 int netxen_init_firmware(struct netxen_adapter *adapter);
1405 void netxen_nic_clear_stats(struct netxen_adapter *adapter);
1406 void netxen_watchdog_task(struct work_struct *work);
1407 void netxen_post_rx_buffers(struct netxen_adapter *adapter, u32 ringid,
1408                 struct nx_host_rds_ring *rds_ring);
1409 int netxen_process_cmd_ring(struct netxen_adapter *adapter);
1410 int netxen_process_rcv_ring(struct nx_host_sds_ring *sds_ring, int max);
1411 void netxen_p2_nic_set_multi(struct net_device *netdev);
1412 void netxen_p3_nic_set_multi(struct net_device *netdev);
1413 void netxen_p3_free_mac_list(struct netxen_adapter *adapter);
1414 int netxen_p3_nic_set_promisc(struct netxen_adapter *adapter, u32);
1415 int netxen_config_intr_coalesce(struct netxen_adapter *adapter);
1416 int netxen_config_rss(struct netxen_adapter *adapter, int enable);
1417 int netxen_linkevent_request(struct netxen_adapter *adapter, int enable);
1418 void netxen_advert_link_change(struct netxen_adapter *adapter, int linkup);
1419
1420 int nx_fw_cmd_set_mtu(struct netxen_adapter *adapter, int mtu);
1421 int netxen_nic_change_mtu(struct net_device *netdev, int new_mtu);
1422
1423 int netxen_nic_set_mac(struct net_device *netdev, void *p);
1424 struct net_device_stats *netxen_nic_get_stats(struct net_device *netdev);
1425
1426 void netxen_nic_update_cmd_producer(struct netxen_adapter *adapter,
1427                 struct nx_host_tx_ring *tx_ring, uint32_t crb_producer);
1428
1429 /*
1430  * NetXen Board information
1431  */
1432
1433 #define NETXEN_MAX_SHORT_NAME 32
1434 struct netxen_brdinfo {
1435         int brdtype;    /* type of board */
1436         long ports;             /* max no of physical ports */
1437         char short_name[NETXEN_MAX_SHORT_NAME];
1438 };
1439
1440 static const struct netxen_brdinfo netxen_boards[] = {
1441         {NETXEN_BRDTYPE_P2_SB31_10G_CX4, 1, "XGb CX4"},
1442         {NETXEN_BRDTYPE_P2_SB31_10G_HMEZ, 1, "XGb HMEZ"},
1443         {NETXEN_BRDTYPE_P2_SB31_10G_IMEZ, 2, "XGb IMEZ"},
1444         {NETXEN_BRDTYPE_P2_SB31_10G, 1, "XGb XFP"},
1445         {NETXEN_BRDTYPE_P2_SB35_4G, 4, "Quad Gb"},
1446         {NETXEN_BRDTYPE_P2_SB31_2G, 2, "Dual Gb"},
1447         {NETXEN_BRDTYPE_P3_REF_QG,  4, "Reference Quad Gig "},
1448         {NETXEN_BRDTYPE_P3_HMEZ,    2, "Dual XGb HMEZ"},
1449         {NETXEN_BRDTYPE_P3_10G_CX4_LP,   2, "Dual XGb CX4 LP"},
1450         {NETXEN_BRDTYPE_P3_4_GB,    4, "Quad Gig LP"},
1451         {NETXEN_BRDTYPE_P3_IMEZ,    2, "Dual XGb IMEZ"},
1452         {NETXEN_BRDTYPE_P3_10G_SFP_PLUS, 2, "Dual XGb SFP+ LP"},
1453         {NETXEN_BRDTYPE_P3_10000_BASE_T, 1, "XGB 10G BaseT LP"},
1454         {NETXEN_BRDTYPE_P3_XG_LOM,  2, "Dual XGb LOM"},
1455         {NETXEN_BRDTYPE_P3_4_GB_MM, 4, "NX3031 Gigabit Ethernet"},
1456         {NETXEN_BRDTYPE_P3_10G_SFP_CT, 2, "NX3031 10 Gigabit Ethernet"},
1457         {NETXEN_BRDTYPE_P3_10G_SFP_QT, 2, "Quanta Dual XGb SFP+"},
1458         {NETXEN_BRDTYPE_P3_10G_CX4, 2, "Reference Dual CX4 Option"},
1459         {NETXEN_BRDTYPE_P3_10G_XFP, 1, "Reference Single XFP Option"}
1460 };
1461
1462 #define NUM_SUPPORTED_BOARDS ARRAY_SIZE(netxen_boards)
1463
1464 static inline void get_brd_name_by_type(u32 type, char *name)
1465 {
1466         int i, found = 0;
1467         for (i = 0; i < NUM_SUPPORTED_BOARDS; ++i) {
1468                 if (netxen_boards[i].brdtype == type) {
1469                         strcpy(name, netxen_boards[i].short_name);
1470                         found = 1;
1471                         break;
1472                 }
1473
1474         }
1475         if (!found)
1476                 name = "Unknown";
1477 }
1478
1479 static inline int
1480 dma_watchdog_shutdown_request(struct netxen_adapter *adapter)
1481 {
1482         u32 ctrl;
1483
1484         /* check if already inactive */
1485         ctrl = adapter->hw_read_wx(adapter,
1486                         NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL));
1487
1488         if (netxen_get_dma_watchdog_enabled(ctrl) == 0)
1489                 return 1;
1490
1491         /* Send the disable request */
1492         netxen_set_dma_watchdog_disable_req(ctrl);
1493         NXWR32(adapter, NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL), ctrl);
1494
1495         return 0;
1496 }
1497
1498 static inline int
1499 dma_watchdog_shutdown_poll_result(struct netxen_adapter *adapter)
1500 {
1501         u32 ctrl;
1502
1503         ctrl = adapter->hw_read_wx(adapter,
1504                         NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL));
1505
1506         return (netxen_get_dma_watchdog_enabled(ctrl) == 0);
1507 }
1508
1509 static inline int
1510 dma_watchdog_wakeup(struct netxen_adapter *adapter)
1511 {
1512         u32 ctrl;
1513
1514         ctrl = adapter->hw_read_wx(adapter,
1515                         NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL));
1516
1517         if (netxen_get_dma_watchdog_enabled(ctrl))
1518                 return 1;
1519
1520         /* send the wakeup request */
1521         netxen_set_dma_watchdog_enable_req(ctrl);
1522
1523         NXWR32(adapter, NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL), ctrl);
1524
1525         return 0;
1526 }
1527
1528
1529 int netxen_get_flash_mac_addr(struct netxen_adapter *adapter, __le64 *mac);
1530 int netxen_p3_get_mac_addr(struct netxen_adapter *adapter, __le64 *mac);
1531 extern void netxen_change_ringparam(struct netxen_adapter *adapter);
1532 extern int netxen_rom_fast_read(struct netxen_adapter *adapter, int addr,
1533                                 int *valp);
1534
1535 extern struct ethtool_ops netxen_nic_ethtool_ops;
1536
1537 #endif                          /* __NETXEN_NIC_H_ */