2 * Copyright (C) 2003 - 2006 NetXen, Inc.
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.
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.
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,
20 * The full GNU General Public License is included in this distribution
21 * in the file called LICENSE.
23 * Contact Information:
26 * 3965 Freedom Circle, Fourth floor,
27 * Santa Clara, CA 95054
30 #ifndef _NETXEN_NIC_H_
31 #define _NETXEN_NIC_H_
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>
46 #include <linux/tcp.h>
47 #include <linux/skbuff.h>
48 #include <linux/version.h>
50 #include <linux/ethtool.h>
51 #include <linux/mii.h>
52 #include <linux/interrupt.h>
53 #include <linux/timer.h>
56 #include <linux/mman.h>
58 #include <asm/system.h>
60 #include <asm/byteorder.h>
61 #include <asm/uaccess.h>
62 #include <asm/pgtable.h>
64 #include "netxen_nic_hw.h"
66 #define _NETXEN_NIC_LINUX_MAJOR 3
67 #define _NETXEN_NIC_LINUX_MINOR 3
68 #define _NETXEN_NIC_LINUX_SUBVERSION 3
69 #define NETXEN_NIC_LINUX_VERSIONID "3.3.3"
71 #define NUM_FLASH_SECTORS (64)
72 #define FLASH_SECTOR_SIZE (64 * 1024)
73 #define FLASH_TOTAL_SIZE (NUM_FLASH_SECTORS * FLASH_SECTOR_SIZE)
75 #define PHAN_VENDOR_ID 0x4040
77 #define RCV_DESC_RINGSIZE \
78 (sizeof(struct rcv_desc) * adapter->max_rx_desc_count)
79 #define STATUS_DESC_RINGSIZE \
80 (sizeof(struct status_desc)* adapter->max_rx_desc_count)
81 #define LRO_DESC_RINGSIZE \
82 (sizeof(rcvDesc_t) * adapter->max_lro_rx_desc_count)
84 (sizeof(struct netxen_cmd_buffer) * adapter->max_tx_desc_count)
85 #define RCV_BUFFSIZE \
86 (sizeof(struct netxen_rx_buffer) * rcv_desc->max_rx_desc_count)
87 #define find_diff_among(a,b,range) ((a)<=(b)?((b)-(a)):((b)+(range)-(a)))
89 #define NETXEN_NETDEV_STATUS 0x1
90 #define NETXEN_RCV_PRODUCER_OFFSET 0
91 #define NETXEN_RCV_PEG_DB_ID 2
92 #define NETXEN_HOST_DUMMY_DMA_SIZE 1024
93 #define FLASH_SUCCESS 0
95 #define ADDR_IN_WINDOW1(off) \
96 ((off > NETXEN_CRB_PCIX_HOST2) && (off < NETXEN_CRB_MAX)) ? 1 : 0
98 * In netxen_nic_down(), we must wait for any pending callback requests into
99 * netxen_watchdog_task() to complete; eg otherwise the watchdog_timer could be
100 * reenabled right after it is deleted in netxen_nic_down(). FLUSH_SCHEDULED_WORK()
101 * does this synchronization.
103 * Normally, schedule_work()/flush_scheduled_work() could have worked, but
104 * netxen_nic_close() is invoked with kernel rtnl lock held. netif_carrier_off()
105 * call in netxen_nic_close() triggers a schedule_work(&linkwatch_work), and a
106 * subsequent call to flush_scheduled_work() in netxen_nic_down() would cause
107 * linkwatch_event() to be executed which also attempts to acquire the rtnl
108 * lock thus causing a deadlock.
111 #define SCHEDULE_WORK(tp) queue_work(netxen_workq, tp)
112 #define FLUSH_SCHEDULED_WORK() flush_workqueue(netxen_workq)
113 extern struct workqueue_struct *netxen_workq;
116 * normalize a 64MB crb address to 32MB PCI window
117 * To use NETXEN_CRB_NORMALIZE, window _must_ be set to 1
119 #define NETXEN_CRB_NORMAL(reg) \
120 ((reg) - NETXEN_CRB_PCIX_HOST2 + NETXEN_CRB_PCIX_HOST)
122 #define NETXEN_CRB_NORMALIZE(adapter, reg) \
123 pci_base_offset(adapter, NETXEN_CRB_NORMAL(reg))
125 #define DB_NORMALIZE(adapter, off) \
126 (adapter->ahw.db_base + (off))
128 #define NX_P2_C0 0x24
129 #define NX_P2_C1 0x25
131 #define FIRST_PAGE_GROUP_START 0
132 #define FIRST_PAGE_GROUP_END 0x100000
134 #define SECOND_PAGE_GROUP_START 0x4000000
135 #define SECOND_PAGE_GROUP_END 0x66BC000
137 #define THIRD_PAGE_GROUP_START 0x70E4000
138 #define THIRD_PAGE_GROUP_END 0x8000000
140 #define FIRST_PAGE_GROUP_SIZE FIRST_PAGE_GROUP_END - FIRST_PAGE_GROUP_START
141 #define SECOND_PAGE_GROUP_SIZE SECOND_PAGE_GROUP_END - SECOND_PAGE_GROUP_START
142 #define THIRD_PAGE_GROUP_SIZE THIRD_PAGE_GROUP_END - THIRD_PAGE_GROUP_START
144 #define MAX_RX_BUFFER_LENGTH 1760
145 #define MAX_RX_JUMBO_BUFFER_LENGTH 8062
146 #define MAX_RX_LRO_BUFFER_LENGTH ((48*1024)-512)
147 #define RX_DMA_MAP_LEN (MAX_RX_BUFFER_LENGTH - 2)
148 #define RX_JUMBO_DMA_MAP_LEN \
149 (MAX_RX_JUMBO_BUFFER_LENGTH - 2)
150 #define RX_LRO_DMA_MAP_LEN (MAX_RX_LRO_BUFFER_LENGTH - 2)
151 #define NETXEN_ROM_ROUNDUP 0x80000000ULL
154 * Maximum number of ring contexts
156 #define MAX_RING_CTX 1
158 /* Opcodes to be used with the commands */
161 /* The following opcodes are for IP checksum */
170 /* The following opcodes are for internal consumption. */
171 #define NETXEN_CONTROL_OP 0x10
172 #define PEGNET_REQUEST 0x11
174 #define MAX_NUM_CARDS 4
176 #define MAX_BUFFERS_PER_CMD 32
179 * Following are the states of the Phantom. Phantom will set them and
180 * Host will read to check if the fields are correct.
182 #define PHAN_INITIALIZE_START 0xff00
183 #define PHAN_INITIALIZE_FAILED 0xffff
184 #define PHAN_INITIALIZE_COMPLETE 0xff01
186 /* Host writes the following to notify that it has done the init-handshake */
187 #define PHAN_INITIALIZE_ACK 0xf00f
189 #define NUM_RCV_DESC_RINGS 3 /* No of Rcv Descriptor contexts */
191 /* descriptor types */
192 #define RCV_DESC_NORMAL 0x01
193 #define RCV_DESC_JUMBO 0x02
194 #define RCV_DESC_LRO 0x04
195 #define RCV_DESC_NORMAL_CTXID 0
196 #define RCV_DESC_JUMBO_CTXID 1
197 #define RCV_DESC_LRO_CTXID 2
199 #define RCV_DESC_TYPE(ID) \
200 ((ID == RCV_DESC_JUMBO_CTXID) \
202 : ((ID == RCV_DESC_LRO_CTXID) \
206 #define MAX_CMD_DESCRIPTORS 1024
207 #define MAX_RCV_DESCRIPTORS 16384
208 #define MAX_JUMBO_RCV_DESCRIPTORS 1024
209 #define MAX_LRO_RCV_DESCRIPTORS 64
210 #define MAX_RCVSTATUS_DESCRIPTORS MAX_RCV_DESCRIPTORS
211 #define MAX_JUMBO_RCV_DESC MAX_JUMBO_RCV_DESCRIPTORS
212 #define MAX_RCV_DESC MAX_RCV_DESCRIPTORS
213 #define MAX_RCVSTATUS_DESC MAX_RCV_DESCRIPTORS
214 #define MAX_EPG_DESCRIPTORS (MAX_CMD_DESCRIPTORS * 8)
215 #define NUM_RCV_DESC (MAX_RCV_DESC + MAX_JUMBO_RCV_DESCRIPTORS + \
216 MAX_LRO_RCV_DESCRIPTORS)
217 #define MIN_TX_COUNT 4096
218 #define MIN_RX_COUNT 4096
219 #define NETXEN_CTX_SIGNATURE 0xdee0
220 #define NETXEN_RCV_PRODUCER(ringid) (ringid)
221 #define MAX_FRAME_SIZE 0x10000 /* 64K MAX size for LSO */
223 #define PHAN_PEG_RCV_INITIALIZED 0xff01
224 #define PHAN_PEG_RCV_START_INITIALIZE 0xff00
226 #define get_next_index(index, length) \
227 (((index) + 1) & ((length) - 1))
229 #define get_index_range(index,length,count) \
230 (((index) + (count)) & ((length) - 1))
232 #define MPORT_SINGLE_FUNCTION_MODE 0x1111
233 #define MPORT_MULTI_FUNCTION_MODE 0x2222
235 #include "netxen_nic_phan_reg.h"
236 extern unsigned long long netxen_dma_mask;
237 extern unsigned long last_schedule_time;
240 * NetXen host-peg signal message structure
242 * Bit 0-1 : peg_id => 0x2 for tx and 01 for rx
243 * Bit 2 : priv_id => must be 1
244 * Bit 3-17 : count => for doorbell
245 * Bit 18-27 : ctx_id => Context id
249 typedef u32 netxen_ctx_msg;
251 #define netxen_set_msg_peg_id(config_word, val) \
252 ((config_word) &= ~3, (config_word) |= val & 3)
253 #define netxen_set_msg_privid(config_word) \
254 ((config_word) |= 1 << 2)
255 #define netxen_set_msg_count(config_word, val) \
256 ((config_word) &= ~(0x7fff<<3), (config_word) |= (val & 0x7fff) << 3)
257 #define netxen_set_msg_ctxid(config_word, val) \
258 ((config_word) &= ~(0x3ff<<18), (config_word) |= (val & 0x3ff) << 18)
259 #define netxen_set_msg_opcode(config_word, val) \
260 ((config_word) &= ~(0xf<<28), (config_word) |= (val & 0xf) << 28)
262 struct netxen_rcv_context {
263 __le64 rcv_ring_addr;
264 __le32 rcv_ring_size;
268 struct netxen_ring_ctx {
270 /* one command ring */
271 __le64 cmd_consumer_offset;
272 __le64 cmd_ring_addr;
273 __le32 cmd_ring_size;
276 /* three receive rings */
277 struct netxen_rcv_context rcv_ctx[3];
279 /* one status ring */
280 __le64 sts_ring_addr;
281 __le32 sts_ring_size;
284 } __attribute__ ((aligned(64)));
287 * Following data structures describe the descriptors that will be used.
288 * Added fileds of tcpHdrSize and ipHdrSize, The driver needs to do it only when
289 * we are doing LSO (above the 1500 size packet) only.
293 * The size of reference handle been changed to 16 bits to pass the MSS fields
297 #define FLAGS_CHECKSUM_ENABLED 0x01
298 #define FLAGS_LSO_ENABLED 0x02
299 #define FLAGS_IPSEC_SA_ADD 0x04
300 #define FLAGS_IPSEC_SA_DELETE 0x08
301 #define FLAGS_VLAN_TAGGED 0x10
303 #define netxen_set_cmd_desc_port(cmd_desc, var) \
304 ((cmd_desc)->port_ctxid |= ((var) & 0x0F))
306 #define netxen_set_cmd_desc_flags(cmd_desc, val) \
307 ((cmd_desc)->flags_opcode &= ~cpu_to_le16(0x7f), \
308 (cmd_desc)->flags_opcode |= cpu_to_le16((val) & 0x7f))
309 #define netxen_set_cmd_desc_opcode(cmd_desc, val) \
310 ((cmd_desc)->flags_opcode &= ~cpu_to_le16(0x3f<<7), \
311 (cmd_desc)->flags_opcode |= cpu_to_le16(((val & 0x3f)<<7)))
313 #define netxen_set_cmd_desc_num_of_buff(cmd_desc, val) \
314 ((cmd_desc)->num_of_buffers_total_length &= ~cpu_to_le32(0xff), \
315 (cmd_desc)->num_of_buffers_total_length |= cpu_to_le32((val) & 0xff))
316 #define netxen_set_cmd_desc_totallength(cmd_desc, val) \
317 ((cmd_desc)->num_of_buffers_total_length &= ~cpu_to_le32(0xffffff00), \
318 (cmd_desc)->num_of_buffers_total_length |= cpu_to_le32(val << 8))
320 #define netxen_get_cmd_desc_opcode(cmd_desc) \
321 ((le16_to_cpu((cmd_desc)->flags_opcode) >> 7) & 0x003F)
322 #define netxen_get_cmd_desc_totallength(cmd_desc) \
323 (le32_to_cpu((cmd_desc)->num_of_buffers_total_length) >> 8)
325 struct cmd_desc_type0 {
326 u8 tcp_hdr_offset; /* For LSO only */
327 u8 ip_hdr_offset; /* For LSO only */
328 /* Bit pattern: 0-6 flags, 7-12 opcode, 13-15 unused */
330 /* Bit pattern: 0-7 total number of segments,
331 8-31 Total size of the packet */
332 __le32 num_of_buffers_total_length;
335 __le32 addr_low_part2;
336 __le32 addr_high_part2;
341 __le16 reference_handle; /* changed to u16 to add mss */
342 __le16 mss; /* passed by NDIS_PACKET for LSO */
343 /* Bit pattern 0-3 port, 0-3 ctx id */
345 u8 total_hdr_length; /* LSO only : MAC+IP+TCP Hdr size */
346 __le16 conn_id; /* IPSec offoad only */
350 __le32 addr_low_part3;
351 __le32 addr_high_part3;
357 __le32 addr_low_part1;
358 __le32 addr_high_part1;
363 __le16 buffer1_length;
364 __le16 buffer2_length;
365 __le16 buffer3_length;
366 __le16 buffer4_length;
370 __le32 addr_low_part4;
371 __le32 addr_high_part4;
378 } __attribute__ ((aligned(64)));
380 /* Note: sizeof(rcv_desc) should always be a mutliple of 2 */
382 __le16 reference_handle;
384 __le32 buffer_length; /* allocated buffer length (usually 2K) */
388 /* opcode field in status_desc */
389 #define RCV_NIC_PKT (0xA)
390 #define STATUS_NIC_PKT ((RCV_NIC_PKT) << 12)
392 /* for status field in status_desc */
393 #define STATUS_NEED_CKSUM (1)
394 #define STATUS_CKSUM_OK (2)
396 /* owner bits of status_desc */
397 #define STATUS_OWNER_HOST (0x1)
398 #define STATUS_OWNER_PHANTOM (0x2)
400 #define NETXEN_PROT_IP (1)
401 #define NETXEN_PROT_UNKNOWN (0)
403 /* Note: sizeof(status_desc) should always be a mutliple of 2 */
405 #define netxen_get_sts_desc_lro_cnt(status_desc) \
406 ((status_desc)->lro & 0x7F)
407 #define netxen_get_sts_desc_lro_last_frag(status_desc) \
408 (((status_desc)->lro & 0x80) >> 7)
410 #define netxen_get_sts_port(status_desc) \
411 (le64_to_cpu((status_desc)->status_desc_data) & 0x0F)
412 #define netxen_get_sts_status(status_desc) \
413 ((le64_to_cpu((status_desc)->status_desc_data) >> 4) & 0x0F)
414 #define netxen_get_sts_type(status_desc) \
415 ((le64_to_cpu((status_desc)->status_desc_data) >> 8) & 0x0F)
416 #define netxen_get_sts_totallength(status_desc) \
417 ((le64_to_cpu((status_desc)->status_desc_data) >> 12) & 0xFFFF)
418 #define netxen_get_sts_refhandle(status_desc) \
419 ((le64_to_cpu((status_desc)->status_desc_data) >> 28) & 0xFFFF)
420 #define netxen_get_sts_prot(status_desc) \
421 ((le64_to_cpu((status_desc)->status_desc_data) >> 44) & 0x0F)
422 #define netxen_get_sts_owner(status_desc) \
423 ((le64_to_cpu((status_desc)->status_desc_data) >> 56) & 0x03)
424 #define netxen_get_sts_opcode(status_desc) \
425 ((le64_to_cpu((status_desc)->status_desc_data) >> 58) & 0x03F)
427 #define netxen_clear_sts_owner(status_desc) \
428 ((status_desc)->status_desc_data &= \
429 ~cpu_to_le64(((unsigned long long)3) << 56 ))
430 #define netxen_set_sts_owner(status_desc, val) \
431 ((status_desc)->status_desc_data |= \
432 cpu_to_le64(((unsigned long long)((val) & 0x3)) << 56 ))
435 /* Bit pattern: 0-3 port, 4-7 status, 8-11 type, 12-27 total_length
436 28-43 reference_handle, 44-47 protocol, 48-52 unused
437 53-55 desc_cnt, 56-57 owner, 58-63 opcode
439 __le64 status_desc_data;
444 /* Bit pattern: 0-6 lro_count indicates frag sequence,
445 7 last_frag indicates last frag */
447 } __attribute__ ((aligned(8)));
450 NETXEN_RCV_PEG_0 = 0,
453 /* The version of the main data structure */
454 #define NETXEN_BDINFO_VERSION 1
456 /* Magic number to let user know flash is programmed */
457 #define NETXEN_BDINFO_MAGIC 0x12345678
459 /* Max number of Gig ports on a Phantom board */
460 #define NETXEN_MAX_PORTS 4
463 NETXEN_BRDTYPE_P1_BD = 0x0000,
464 NETXEN_BRDTYPE_P1_SB = 0x0001,
465 NETXEN_BRDTYPE_P1_SMAX = 0x0002,
466 NETXEN_BRDTYPE_P1_SOCK = 0x0003,
468 NETXEN_BRDTYPE_P2_SOCK_31 = 0x0008,
469 NETXEN_BRDTYPE_P2_SOCK_35 = 0x0009,
470 NETXEN_BRDTYPE_P2_SB35_4G = 0x000a,
471 NETXEN_BRDTYPE_P2_SB31_10G = 0x000b,
472 NETXEN_BRDTYPE_P2_SB31_2G = 0x000c,
474 NETXEN_BRDTYPE_P2_SB31_10G_IMEZ = 0x000d,
475 NETXEN_BRDTYPE_P2_SB31_10G_HMEZ = 0x000e,
476 NETXEN_BRDTYPE_P2_SB31_10G_CX4 = 0x000f
480 NETXEN_BRDMFG_INVENTEC = 1
484 MEM_ORG_128Mbx4 = 0x0, /* DDR1 only */
485 MEM_ORG_128Mbx8 = 0x1, /* DDR1 only */
486 MEM_ORG_128Mbx16 = 0x2, /* DDR1 only */
487 MEM_ORG_256Mbx4 = 0x3,
488 MEM_ORG_256Mbx8 = 0x4,
489 MEM_ORG_256Mbx16 = 0x5,
490 MEM_ORG_512Mbx4 = 0x6,
491 MEM_ORG_512Mbx8 = 0x7,
492 MEM_ORG_512Mbx16 = 0x8,
495 MEM_ORG_1Gbx16 = 0xb,
498 MEM_ORG_2Gbx16 = 0xe,
499 MEM_ORG_128Mbx32 = 0x10002, /* GDDR only */
500 MEM_ORG_256Mbx32 = 0x10005 /* GDDR only */
501 } netxen_mn_mem_org_t;
504 MEM_ORG_512Kx36 = 0x0,
507 } netxen_sn_mem_org_t;
512 MEM_DEPTH_16MB = 0x3,
513 MEM_DEPTH_32MB = 0x4,
514 MEM_DEPTH_64MB = 0x5,
515 MEM_DEPTH_128MB = 0x6,
516 MEM_DEPTH_256MB = 0x7,
517 MEM_DEPTH_512MB = 0x8,
522 MEM_DEPTH_16GB = 0xd,
524 } netxen_mem_depth_t;
526 struct netxen_board_info {
538 u32 port_mask; /* available niu ports */
539 u32 peg_mask; /* available pegs */
540 u32 icache_ok; /* can we run with icache? */
541 u32 dcache_ok; /* can we run with dcache? */
549 /* MN-related config */
550 u32 mn_sync_mode; /* enable/ sync shift cclk/ sync shift mclk */
551 u32 mn_sync_shift_cclk;
552 u32 mn_sync_shift_mclk;
554 u32 mn_crystal_freq; /* in MHz */
555 u32 mn_speed; /* in MHz */
558 u32 mn_ranks_0; /* ranks per slot */
559 u32 mn_ranks_1; /* ranks per slot */
570 u32 mn_mode_reg; /* MIU DDR Mode Register */
571 u32 mn_ext_mode_reg; /* MIU DDR Extended Mode Register */
572 u32 mn_timing_0; /* MIU Memory Control Timing Rgister */
573 u32 mn_timing_1; /* MIU Extended Memory Ctrl Timing Register */
574 u32 mn_timing_2; /* MIU Extended Memory Ctrl Timing2 Register */
576 /* SN-related config */
577 u32 sn_sync_mode; /* enable/ sync shift cclk / sync shift mclk */
578 u32 sn_pt_mode; /* pass through mode */
593 u32 magic; /* indicates flash has been initialized */
600 #define FLASH_NUM_PORTS (4)
602 struct netxen_flash_mac_addr {
606 struct netxen_user_old_info {
618 /* primary image status */
620 u32 secondary_present;
622 /* MAC address , 4 ports */
623 struct netxen_flash_mac_addr mac_addr[FLASH_NUM_PORTS];
625 #define FLASH_NUM_MAC_PER_PORT 32
626 struct netxen_user_info {
627 u8 flash_md5[16 * 64];
634 /* primary image status */
636 u32 secondary_present;
638 /* MAC address , 4 ports, 32 address per port */
639 u64 mac_addr[FLASH_NUM_PORTS * FLASH_NUM_MAC_PER_PORT];
643 /* Any user defined data */
647 * Flash Layout - new format.
649 struct netxen_new_user_info {
650 u8 flash_md5[16 * 64];
657 /* primary image status */
659 u32 secondary_present;
661 /* MAC address , 4 ports, 32 address per port */
662 u64 mac_addr[FLASH_NUM_PORTS * FLASH_NUM_MAC_PER_PORT];
666 /* Any user defined data */
669 #define SECONDARY_IMAGE_PRESENT 0xb3b4b5b6
670 #define SECONDARY_IMAGE_ABSENT 0xffffffff
671 #define PRIMARY_IMAGE_GOOD 0x5a5a5a5a
672 #define PRIMARY_IMAGE_BAD 0xffffffff
674 /* Flash memory map */
676 CRBINIT_START = 0, /* Crbinit section */
677 BRDCFG_START = 0x4000, /* board config */
678 INITCODE_START = 0x6000, /* pegtune code */
679 BOOTLD_START = 0x10000, /* bootld */
680 IMAGE_START = 0x43000, /* compressed image */
681 SECONDARY_START = 0x200000, /* backup images */
682 PXE_START = 0x3E0000, /* user defined region */
683 USER_START = 0x3E8000, /* User defined region for new boards */
684 FIXED_START = 0x3F0000 /* backup of crbinit */
685 } netxen_flash_map_t;
687 #define USER_START_OLD PXE_START /* for backward compatibility */
689 #define FLASH_START (CRBINIT_START)
690 #define INIT_SECTOR (0)
691 #define PRIMARY_START (BOOTLD_START)
692 #define FLASH_CRBINIT_SIZE (0x4000)
693 #define FLASH_BRDCFG_SIZE (sizeof(struct netxen_board_info))
694 #define FLASH_USER_SIZE (sizeof(struct netxen_user_info)/sizeof(u32))
695 #define FLASH_SECONDARY_SIZE (USER_START-SECONDARY_START)
696 #define NUM_PRIMARY_SECTORS (0x20)
697 #define NUM_CONFIG_SECTORS (1)
698 #define PFX "NetXen: "
699 extern char netxen_nic_driver_name[];
701 /* Note: Make sure to not call this before adapter->port is valid */
702 #if !defined(NETXEN_DEBUG)
703 #define DPRINTK(klevel, fmt, args...) do { \
706 #define DPRINTK(klevel, fmt, args...) do { \
707 printk(KERN_##klevel PFX "%s: %s: " fmt, __FUNCTION__,\
708 (adapter != NULL && adapter->netdev != NULL) ? \
709 adapter->netdev->name : NULL, \
713 /* Number of status descriptors to handle per interrupt */
714 #define MAX_STATUS_HANDLE (128)
717 * netxen_skb_frag{} is to contain mapping info for each SG list. This
718 * has to be freed when DMA is complete. This is part of netxen_tx_buffer{}.
720 struct netxen_skb_frag {
725 /* Following defines are for the state of the buffers */
726 #define NETXEN_BUFFER_FREE 0
727 #define NETXEN_BUFFER_BUSY 1
730 * There will be one netxen_buffer per skb packet. These will be
731 * used to save the dma info for pci_unmap_page()
733 struct netxen_cmd_buffer {
735 struct netxen_skb_frag frag_array[MAX_BUFFERS_PER_CMD + 1];
741 unsigned long time_stamp;
745 /* In rx_buffer, we do not need multiple fragments as is a single buffer */
746 struct netxen_rx_buffer {
751 u32 lro_expected_frags;
752 u32 lro_current_frags;
757 #define NETXEN_NIC_GBE 0x01
758 #define NETXEN_NIC_XGBE 0x02
761 * One hardware_context{} per adapter
762 * contains interrupt info as well shared hardware info.
764 struct netxen_hardware_context {
765 struct pci_dev *pdev;
766 void __iomem *pci_base0;
767 void __iomem *pci_base1;
768 void __iomem *pci_base2;
769 void __iomem *db_base;
770 unsigned long db_len;
775 struct netxen_board_info boardcfg;
778 /* Address of cmd ring in Phantom */
779 struct cmd_desc_type0 *cmd_desc_head;
780 struct pci_dev *cmd_desc_pdev;
781 dma_addr_t cmd_desc_phys_addr;
782 struct netxen_adapter *adapter;
785 #define RCV_RING_LRO RCV_DESC_LRO
787 #define MINIMUM_ETHERNET_FRAME_SIZE 64 /* With FCS */
788 #define ETHERNET_FCS_SIZE 4
790 struct netxen_adapter_stats {
815 * Rcv Descriptor Context. One such per Rcv Descriptor. There may
816 * be one Rcv Descriptor for normal packets, one for jumbo and may be others.
818 struct netxen_rcv_desc_ctx {
821 u32 rcv_pending; /* Num of bufs posted in phantom */
822 u32 rcv_free; /* Num of bufs in free list */
823 dma_addr_t phys_addr;
824 struct pci_dev *phys_pdev;
825 struct rcv_desc *desc_head; /* address of rx ring in Phantom */
826 u32 max_rx_desc_count;
829 struct netxen_rx_buffer *rx_buf_arr; /* rx buffers for receive */
834 * Receive context. There is one such structure per instance of the
835 * receive processing. Any state information that is relevant to
836 * the receive, and is must be in this structure. The global data may be
839 struct netxen_recv_context {
840 struct netxen_rcv_desc_ctx rcv_desc[NUM_RCV_DESC_RINGS];
841 u32 status_rx_producer;
842 u32 status_rx_consumer;
843 dma_addr_t rcv_status_desc_phys_addr;
844 struct pci_dev *rcv_status_desc_pdev;
845 struct status_desc *rcv_status_desc_head;
848 #define NETXEN_NIC_MSI_ENABLED 0x02
849 #define NETXEN_DMA_MASK 0xfffffffe
850 #define NETXEN_DB_MAPSIZE_BYTES 0x1000
852 struct netxen_dummy_dma {
854 dma_addr_t phys_addr;
857 struct netxen_adapter {
858 struct netxen_hardware_context ahw;
860 struct netxen_adapter *master;
861 struct net_device *netdev;
862 struct pci_dev *pdev;
863 unsigned char mac_addr[ETH_ALEN];
869 struct work_struct watchdog_task;
870 struct timer_list watchdog_timer;
871 struct work_struct tx_timeout_task;
878 u32 last_cmd_consumer;
879 u32 max_tx_desc_count;
880 u32 max_rx_desc_count;
881 u32 max_jumbo_rx_desc_count;
882 u32 max_lro_rx_desc_count;
883 /* Num of instances active on cmd buffer ring */
884 u32 proc_cmd_buf_counter;
886 u32 num_threads, total_threads; /*Use to keep track of xmit threads */
893 struct netxen_adapter_stats stats;
902 spinlock_t stats_lock;
904 struct netxen_cmd_buffer *cmd_buf_arr; /* Command buffers for xmit */
907 * Receive instances. These can be either one per port,
908 * or one per peg, etc.
910 struct netxen_recv_context recv_ctx[MAX_RCV_CTX];
913 struct netxen_dummy_dma dummy_dma;
915 /* Context interface shared between card and host */
916 struct netxen_ring_ctx *ctx_desc;
917 struct pci_dev *ctx_desc_pdev;
918 dma_addr_t ctx_desc_phys_addr;
919 int (*enable_phy_interrupts) (struct netxen_adapter *, int);
920 int (*disable_phy_interrupts) (struct netxen_adapter *, int);
921 void (*handle_phy_intr) (struct netxen_adapter *);
922 int (*macaddr_set) (struct netxen_adapter *, netxen_ethernet_macaddr_t);
923 int (*set_mtu) (struct netxen_adapter *, int);
924 int (*set_promisc) (struct netxen_adapter *, netxen_niu_prom_mode_t);
925 int (*unset_promisc) (struct netxen_adapter *, netxen_niu_prom_mode_t);
926 int (*phy_read) (struct netxen_adapter *, long phy, long reg, u32 *);
927 int (*phy_write) (struct netxen_adapter *, long phy, long reg, u32 val);
928 int (*init_port) (struct netxen_adapter *, int);
929 void (*init_niu) (struct netxen_adapter *);
930 int (*stop_port) (struct netxen_adapter *);
931 }; /* netxen_adapter structure */
933 /* Max number of xmit producer threads that can run simultaneously */
934 #define MAX_XMIT_PRODUCERS 16
936 #define PCI_OFFSET_FIRST_RANGE(adapter, off) \
937 ((adapter)->ahw.pci_base0 + (off))
938 #define PCI_OFFSET_SECOND_RANGE(adapter, off) \
939 ((adapter)->ahw.pci_base1 + (off) - SECOND_PAGE_GROUP_START)
940 #define PCI_OFFSET_THIRD_RANGE(adapter, off) \
941 ((adapter)->ahw.pci_base2 + (off) - THIRD_PAGE_GROUP_START)
943 static inline void __iomem *pci_base_offset(struct netxen_adapter *adapter,
946 if ((off < FIRST_PAGE_GROUP_END) && (off >= FIRST_PAGE_GROUP_START)) {
947 return (adapter->ahw.pci_base0 + off);
948 } else if ((off < SECOND_PAGE_GROUP_END) &&
949 (off >= SECOND_PAGE_GROUP_START)) {
950 return (adapter->ahw.pci_base1 + off - SECOND_PAGE_GROUP_START);
951 } else if ((off < THIRD_PAGE_GROUP_END) &&
952 (off >= THIRD_PAGE_GROUP_START)) {
953 return (adapter->ahw.pci_base2 + off - THIRD_PAGE_GROUP_START);
958 static inline void __iomem *pci_base(struct netxen_adapter *adapter,
961 if ((off < FIRST_PAGE_GROUP_END) && (off >= FIRST_PAGE_GROUP_START)) {
962 return adapter->ahw.pci_base0;
963 } else if ((off < SECOND_PAGE_GROUP_END) &&
964 (off >= SECOND_PAGE_GROUP_START)) {
965 return adapter->ahw.pci_base1;
966 } else if ((off < THIRD_PAGE_GROUP_END) &&
967 (off >= THIRD_PAGE_GROUP_START)) {
968 return adapter->ahw.pci_base2;
973 int netxen_niu_xgbe_enable_phy_interrupts(struct netxen_adapter *adapter,
975 int netxen_niu_gbe_enable_phy_interrupts(struct netxen_adapter *adapter,
977 int netxen_niu_xgbe_disable_phy_interrupts(struct netxen_adapter *adapter,
979 int netxen_niu_gbe_disable_phy_interrupts(struct netxen_adapter *adapter,
981 int netxen_niu_xgbe_clear_phy_interrupts(struct netxen_adapter *adapter,
983 int netxen_niu_gbe_clear_phy_interrupts(struct netxen_adapter *adapter,
985 void netxen_nic_xgbe_handle_phy_intr(struct netxen_adapter *adapter);
986 void netxen_nic_gbe_handle_phy_intr(struct netxen_adapter *adapter);
987 void netxen_niu_gbe_set_mii_mode(struct netxen_adapter *adapter, int port,
989 void netxen_niu_gbe_set_gmii_mode(struct netxen_adapter *adapter, int port,
991 int netxen_niu_gbe_phy_read(struct netxen_adapter *adapter, long phy, long reg,
993 int netxen_niu_gbe_phy_write(struct netxen_adapter *adapter, long phy,
994 long reg, __u32 val);
996 /* Functions available from netxen_nic_hw.c */
997 int netxen_nic_set_mtu_xgb(struct netxen_adapter *adapter, int new_mtu);
998 int netxen_nic_set_mtu_gb(struct netxen_adapter *adapter, int new_mtu);
999 void netxen_nic_init_niu_gb(struct netxen_adapter *adapter);
1000 void netxen_nic_pci_change_crbwindow(struct netxen_adapter *adapter, u32 wndw);
1001 void netxen_nic_reg_write(struct netxen_adapter *adapter, u64 off, u32 val);
1002 int netxen_nic_reg_read(struct netxen_adapter *adapter, u64 off);
1003 void netxen_nic_write_w0(struct netxen_adapter *adapter, u32 index, u32 value);
1004 void netxen_nic_read_w0(struct netxen_adapter *adapter, u32 index, u32 * value);
1006 int netxen_nic_get_board_info(struct netxen_adapter *adapter);
1007 int netxen_nic_hw_read_wx(struct netxen_adapter *adapter, u64 off, void *data,
1009 int netxen_nic_hw_write_wx(struct netxen_adapter *adapter, u64 off, void *data,
1011 void netxen_crb_writelit_adapter(struct netxen_adapter *adapter,
1012 unsigned long off, int data);
1014 /* Functions from netxen_nic_init.c */
1015 void netxen_free_adapter_offload(struct netxen_adapter *adapter);
1016 int netxen_initialize_adapter_offload(struct netxen_adapter *adapter);
1017 void netxen_phantom_init(struct netxen_adapter *adapter, int pegtune_val);
1018 void netxen_load_firmware(struct netxen_adapter *adapter);
1019 int netxen_pinit_from_rom(struct netxen_adapter *adapter, int verbose);
1020 int netxen_rom_fast_read(struct netxen_adapter *adapter, int addr, int *valp);
1021 int netxen_rom_fast_read_words(struct netxen_adapter *adapter, int addr,
1022 u8 *bytes, size_t size);
1023 int netxen_rom_fast_write_words(struct netxen_adapter *adapter, int addr,
1024 u8 *bytes, size_t size);
1025 int netxen_flash_unlock(struct netxen_adapter *adapter);
1026 int netxen_backup_crbinit(struct netxen_adapter *adapter);
1027 int netxen_flash_erase_secondary(struct netxen_adapter *adapter);
1028 int netxen_flash_erase_primary(struct netxen_adapter *adapter);
1029 void netxen_halt_pegs(struct netxen_adapter *adapter);
1031 int netxen_rom_fast_write(struct netxen_adapter *adapter, int addr, int data);
1032 int netxen_rom_se(struct netxen_adapter *adapter, int addr);
1033 int netxen_do_rom_se(struct netxen_adapter *adapter, int addr);
1035 /* Functions from netxen_nic_isr.c */
1036 void netxen_nic_isr_other(struct netxen_adapter *adapter);
1037 void netxen_indicate_link_status(struct netxen_adapter *adapter, u32 link);
1038 void netxen_handle_port_int(struct netxen_adapter *adapter, u32 enable);
1039 void netxen_initialize_adapter_sw(struct netxen_adapter *adapter);
1040 void netxen_initialize_adapter_hw(struct netxen_adapter *adapter);
1041 void *netxen_alloc(struct pci_dev *pdev, size_t sz, dma_addr_t * ptr,
1042 struct pci_dev **used_dev);
1043 void netxen_initialize_adapter_ops(struct netxen_adapter *adapter);
1044 int netxen_init_firmware(struct netxen_adapter *adapter);
1045 void netxen_free_hw_resources(struct netxen_adapter *adapter);
1046 void netxen_tso_check(struct netxen_adapter *adapter,
1047 struct cmd_desc_type0 *desc, struct sk_buff *skb);
1048 int netxen_nic_hw_resources(struct netxen_adapter *adapter);
1049 void netxen_nic_clear_stats(struct netxen_adapter *adapter);
1050 int netxen_nic_rx_has_work(struct netxen_adapter *adapter);
1051 int netxen_nic_tx_has_work(struct netxen_adapter *adapter);
1052 void netxen_watchdog_task(struct work_struct *work);
1053 void netxen_post_rx_buffers(struct netxen_adapter *adapter, u32 ctx,
1055 void netxen_post_rx_buffers_nodb(struct netxen_adapter *adapter, u32 ctx,
1057 int netxen_process_cmd_ring(unsigned long data);
1058 u32 netxen_process_rcv_ring(struct netxen_adapter *adapter, int ctx, int max);
1059 void netxen_nic_set_multi(struct net_device *netdev);
1060 int netxen_nic_change_mtu(struct net_device *netdev, int new_mtu);
1061 int netxen_nic_set_mac(struct net_device *netdev, void *p);
1062 struct net_device_stats *netxen_nic_get_stats(struct net_device *netdev);
1064 static inline void netxen_nic_disable_int(struct netxen_adapter *adapter)
1067 * ISR_INT_MASK: Can be read from window 0 or 1.
1069 writel(0x7ff, PCI_OFFSET_SECOND_RANGE(adapter, ISR_INT_MASK));
1073 static inline void netxen_nic_enable_int(struct netxen_adapter *adapter)
1077 switch (adapter->ahw.board_type) {
1078 case NETXEN_NIC_GBE:
1081 case NETXEN_NIC_XGBE:
1089 writel(mask, PCI_OFFSET_SECOND_RANGE(adapter, ISR_INT_MASK));
1091 if (!(adapter->flags & NETXEN_NIC_MSI_ENABLED)) {
1093 writel(0X0, NETXEN_CRB_NORMALIZE(adapter, CRB_INT_VECTOR));
1094 writel(mask, PCI_OFFSET_SECOND_RANGE(adapter,
1095 ISR_INT_TARGET_MASK));
1100 * NetXen Board information
1103 #define NETXEN_MAX_SHORT_NAME 16
1104 struct netxen_brdinfo {
1105 netxen_brdtype_t brdtype; /* type of board */
1106 long ports; /* max no of physical ports */
1107 char short_name[NETXEN_MAX_SHORT_NAME];
1110 static const struct netxen_brdinfo netxen_boards[] = {
1111 {NETXEN_BRDTYPE_P2_SB31_10G_CX4, 1, "XGb CX4"},
1112 {NETXEN_BRDTYPE_P2_SB31_10G_HMEZ, 1, "XGb HMEZ"},
1113 {NETXEN_BRDTYPE_P2_SB31_10G_IMEZ, 2, "XGb IMEZ"},
1114 {NETXEN_BRDTYPE_P2_SB31_10G, 1, "XGb XFP"},
1115 {NETXEN_BRDTYPE_P2_SB35_4G, 4, "Quad Gb"},
1116 {NETXEN_BRDTYPE_P2_SB31_2G, 2, "Dual Gb"},
1119 #define NUM_SUPPORTED_BOARDS (sizeof(netxen_boards)/sizeof(struct netxen_brdinfo))
1121 static inline void get_brd_port_by_type(u32 type, int *ports)
1124 for (i = 0; i < NUM_SUPPORTED_BOARDS; ++i) {
1125 if (netxen_boards[i].brdtype == type) {
1126 *ports = netxen_boards[i].ports;
1135 static inline void get_brd_name_by_type(u32 type, char *name)
1138 for (i = 0; i < NUM_SUPPORTED_BOARDS; ++i) {
1139 if (netxen_boards[i].brdtype == type) {
1140 strcpy(name, netxen_boards[i].short_name);
1150 int netxen_is_flash_supported(struct netxen_adapter *adapter);
1151 int netxen_get_flash_mac_addr(struct netxen_adapter *adapter, u64 mac[]);
1152 extern void netxen_change_ringparam(struct netxen_adapter *adapter);
1153 extern int netxen_rom_fast_read(struct netxen_adapter *adapter, int addr,
1156 extern struct ethtool_ops netxen_nic_ethtool_ops;
1158 #endif /* __NETXEN_NIC_H_ */