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