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 4
68 #define _NETXEN_NIC_LINUX_SUBVERSION 18
69 #define NETXEN_NIC_LINUX_VERSIONID "3.4.18"
71 #define NETXEN_NUM_FLASH_SECTORS (64)
72 #define NETXEN_FLASH_SECTOR_SIZE (64 * 1024)
73 #define NETXEN_FLASH_TOTAL_SIZE (NETXEN_NUM_FLASH_SECTORS \
74 * NETXEN_FLASH_SECTOR_SIZE)
76 #define PHAN_VENDOR_ID 0x4040
78 #define RCV_DESC_RINGSIZE \
79 (sizeof(struct rcv_desc) * adapter->max_rx_desc_count)
80 #define STATUS_DESC_RINGSIZE \
81 (sizeof(struct status_desc)* adapter->max_rx_desc_count)
82 #define LRO_DESC_RINGSIZE \
83 (sizeof(rcvDesc_t) * adapter->max_lro_rx_desc_count)
85 (sizeof(struct netxen_cmd_buffer) * adapter->max_tx_desc_count)
86 #define RCV_BUFFSIZE \
87 (sizeof(struct netxen_rx_buffer) * rcv_desc->max_rx_desc_count)
88 #define find_diff_among(a,b,range) ((a)<=(b)?((b)-(a)):((b)+(range)-(a)))
90 #define NETXEN_NETDEV_STATUS 0x1
91 #define NETXEN_RCV_PRODUCER_OFFSET 0
92 #define NETXEN_RCV_PEG_DB_ID 2
93 #define NETXEN_HOST_DUMMY_DMA_SIZE 1024
94 #define FLASH_SUCCESS 0
96 #define ADDR_IN_WINDOW1(off) \
97 ((off > NETXEN_CRB_PCIX_HOST2) && (off < NETXEN_CRB_MAX)) ? 1 : 0
99 * In netxen_nic_down(), we must wait for any pending callback requests into
100 * netxen_watchdog_task() to complete; eg otherwise the watchdog_timer could be
101 * reenabled right after it is deleted in netxen_nic_down(). FLUSH_SCHEDULED_WORK()
102 * does this synchronization.
104 * Normally, schedule_work()/flush_scheduled_work() could have worked, but
105 * netxen_nic_close() is invoked with kernel rtnl lock held. netif_carrier_off()
106 * call in netxen_nic_close() triggers a schedule_work(&linkwatch_work), and a
107 * subsequent call to flush_scheduled_work() in netxen_nic_down() would cause
108 * linkwatch_event() to be executed which also attempts to acquire the rtnl
109 * lock thus causing a deadlock.
112 #define SCHEDULE_WORK(tp) queue_work(netxen_workq, tp)
113 #define FLUSH_SCHEDULED_WORK() flush_workqueue(netxen_workq)
114 extern struct workqueue_struct *netxen_workq;
117 * normalize a 64MB crb address to 32MB PCI window
118 * To use NETXEN_CRB_NORMALIZE, window _must_ be set to 1
120 #define NETXEN_CRB_NORMAL(reg) \
121 ((reg) - NETXEN_CRB_PCIX_HOST2 + NETXEN_CRB_PCIX_HOST)
123 #define NETXEN_CRB_NORMALIZE(adapter, reg) \
124 pci_base_offset(adapter, NETXEN_CRB_NORMAL(reg))
126 #define DB_NORMALIZE(adapter, off) \
127 (adapter->ahw.db_base + (off))
129 #define NX_P2_C0 0x24
130 #define NX_P2_C1 0x25
132 #define FIRST_PAGE_GROUP_START 0
133 #define FIRST_PAGE_GROUP_END 0x100000
135 #define SECOND_PAGE_GROUP_START 0x6000000
136 #define SECOND_PAGE_GROUP_END 0x68BC000
138 #define THIRD_PAGE_GROUP_START 0x70E4000
139 #define THIRD_PAGE_GROUP_END 0x8000000
141 #define FIRST_PAGE_GROUP_SIZE FIRST_PAGE_GROUP_END - FIRST_PAGE_GROUP_START
142 #define SECOND_PAGE_GROUP_SIZE SECOND_PAGE_GROUP_END - SECOND_PAGE_GROUP_START
143 #define THIRD_PAGE_GROUP_SIZE THIRD_PAGE_GROUP_END - THIRD_PAGE_GROUP_START
145 #define MAX_RX_BUFFER_LENGTH 1760
146 #define MAX_RX_JUMBO_BUFFER_LENGTH 8062
147 #define MAX_RX_LRO_BUFFER_LENGTH ((48*1024)-512)
148 #define RX_DMA_MAP_LEN (MAX_RX_BUFFER_LENGTH - 2)
149 #define RX_JUMBO_DMA_MAP_LEN \
150 (MAX_RX_JUMBO_BUFFER_LENGTH - 2)
151 #define RX_LRO_DMA_MAP_LEN (MAX_RX_LRO_BUFFER_LENGTH - 2)
152 #define NETXEN_ROM_ROUNDUP 0x80000000ULL
155 * Maximum number of ring contexts
157 #define MAX_RING_CTX 1
159 /* Opcodes to be used with the commands */
162 /* The following opcodes are for IP checksum */
171 /* The following opcodes are for internal consumption. */
172 #define NETXEN_CONTROL_OP 0x10
173 #define PEGNET_REQUEST 0x11
175 #define MAX_NUM_CARDS 4
177 #define MAX_BUFFERS_PER_CMD 32
180 * Following are the states of the Phantom. Phantom will set them and
181 * Host will read to check if the fields are correct.
183 #define PHAN_INITIALIZE_START 0xff00
184 #define PHAN_INITIALIZE_FAILED 0xffff
185 #define PHAN_INITIALIZE_COMPLETE 0xff01
187 /* Host writes the following to notify that it has done the init-handshake */
188 #define PHAN_INITIALIZE_ACK 0xf00f
190 #define NUM_RCV_DESC_RINGS 3 /* No of Rcv Descriptor contexts */
192 /* descriptor types */
193 #define RCV_DESC_NORMAL 0x01
194 #define RCV_DESC_JUMBO 0x02
195 #define RCV_DESC_LRO 0x04
196 #define RCV_DESC_NORMAL_CTXID 0
197 #define RCV_DESC_JUMBO_CTXID 1
198 #define RCV_DESC_LRO_CTXID 2
200 #define RCV_DESC_TYPE(ID) \
201 ((ID == RCV_DESC_JUMBO_CTXID) \
203 : ((ID == RCV_DESC_LRO_CTXID) \
207 #define MAX_CMD_DESCRIPTORS 1024
208 #define MAX_RCV_DESCRIPTORS 16384
209 #define MAX_CMD_DESCRIPTORS_HOST (MAX_CMD_DESCRIPTORS / 4)
210 #define MAX_RCV_DESCRIPTORS_1G (MAX_RCV_DESCRIPTORS / 4)
211 #define MAX_JUMBO_RCV_DESCRIPTORS 1024
212 #define MAX_LRO_RCV_DESCRIPTORS 64
213 #define MAX_RCVSTATUS_DESCRIPTORS MAX_RCV_DESCRIPTORS
214 #define MAX_JUMBO_RCV_DESC MAX_JUMBO_RCV_DESCRIPTORS
215 #define MAX_RCV_DESC MAX_RCV_DESCRIPTORS
216 #define MAX_RCVSTATUS_DESC MAX_RCV_DESCRIPTORS
217 #define MAX_EPG_DESCRIPTORS (MAX_CMD_DESCRIPTORS * 8)
218 #define NUM_RCV_DESC (MAX_RCV_DESC + MAX_JUMBO_RCV_DESCRIPTORS + \
219 MAX_LRO_RCV_DESCRIPTORS)
220 #define MIN_TX_COUNT 4096
221 #define MIN_RX_COUNT 4096
222 #define NETXEN_CTX_SIGNATURE 0xdee0
223 #define NETXEN_RCV_PRODUCER(ringid) (ringid)
224 #define MAX_FRAME_SIZE 0x10000 /* 64K MAX size for LSO */
226 #define PHAN_PEG_RCV_INITIALIZED 0xff01
227 #define PHAN_PEG_RCV_START_INITIALIZE 0xff00
229 #define get_next_index(index, length) \
230 (((index) + 1) & ((length) - 1))
232 #define get_index_range(index,length,count) \
233 (((index) + (count)) & ((length) - 1))
235 #define MPORT_SINGLE_FUNCTION_MODE 0x1111
236 #define MPORT_MULTI_FUNCTION_MODE 0x2222
238 #include "netxen_nic_phan_reg.h"
239 extern unsigned long long netxen_dma_mask;
240 extern unsigned long last_schedule_time;
243 * NetXen host-peg signal message structure
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
252 typedef u32 netxen_ctx_msg;
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)
265 struct netxen_rcv_context {
266 __le64 rcv_ring_addr;
267 __le32 rcv_ring_size;
271 struct netxen_ring_ctx {
273 /* one command ring */
274 __le64 cmd_consumer_offset;
275 __le64 cmd_ring_addr;
276 __le32 cmd_ring_size;
279 /* three receive rings */
280 struct netxen_rcv_context rcv_ctx[3];
282 /* one status ring */
283 __le64 sts_ring_addr;
284 __le32 sts_ring_size;
287 } __attribute__ ((aligned(64)));
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.
296 * The size of reference handle been changed to 16 bits to pass the MSS fields
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
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) & 0xF0))
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)
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)
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)
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 */
338 /* Bit pattern: 0-7 total number of segments,
339 8-31 Total size of the packet */
340 __le32 num_of_buffers_total_length;
343 __le32 addr_low_part2;
344 __le32 addr_high_part2;
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 */
353 u8 total_hdr_length; /* LSO only : MAC+IP+TCP Hdr size */
354 __le16 conn_id; /* IPSec offoad only */
358 __le32 addr_low_part3;
359 __le32 addr_high_part3;
365 __le32 addr_low_part1;
366 __le32 addr_high_part1;
371 __le16 buffer1_length;
372 __le16 buffer2_length;
373 __le16 buffer3_length;
374 __le16 buffer4_length;
378 __le32 addr_low_part4;
379 __le32 addr_high_part4;
386 } __attribute__ ((aligned(64)));
388 /* Note: sizeof(rcv_desc) should always be a mutliple of 2 */
390 __le16 reference_handle;
392 __le32 buffer_length; /* allocated buffer length (usually 2K) */
396 /* opcode field in status_desc */
397 #define RCV_NIC_PKT (0xA)
398 #define STATUS_NIC_PKT ((RCV_NIC_PKT) << 12)
400 /* for status field in status_desc */
401 #define STATUS_NEED_CKSUM (1)
402 #define STATUS_CKSUM_OK (2)
404 /* owner bits of status_desc */
405 #define STATUS_OWNER_HOST (0x1)
406 #define STATUS_OWNER_PHANTOM (0x2)
408 #define NETXEN_PROT_IP (1)
409 #define NETXEN_PROT_UNKNOWN (0)
411 /* Note: sizeof(status_desc) should always be a mutliple of 2 */
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)
418 #define netxen_get_sts_port(sts_data) \
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_opcode(sts_data) \
431 (((sts_data) >> 58) & 0x03F)
433 #define netxen_get_sts_owner(status_desc) \
434 ((le64_to_cpu((status_desc)->status_desc_data) >> 56) & 0x03)
435 #define netxen_set_sts_owner(status_desc, val) { \
436 (status_desc)->status_desc_data = \
437 ((status_desc)->status_desc_data & \
438 ~cpu_to_le64(0x3ULL << 56)) | \
439 cpu_to_le64((u64)((val) & 0x3) << 56); \
443 /* Bit pattern: 0-3 port, 4-7 status, 8-11 type, 12-27 total_length
444 28-43 reference_handle, 44-47 protocol, 48-52 unused
445 53-55 desc_cnt, 56-57 owner, 58-63 opcode
447 __le64 status_desc_data;
452 /* Bit pattern: 0-6 lro_count indicates frag sequence,
453 7 last_frag indicates last frag */
455 } __attribute__ ((aligned(16)));
458 NETXEN_RCV_PEG_0 = 0,
461 /* The version of the main data structure */
462 #define NETXEN_BDINFO_VERSION 1
464 /* Magic number to let user know flash is programmed */
465 #define NETXEN_BDINFO_MAGIC 0x12345678
467 /* Max number of Gig ports on a Phantom board */
468 #define NETXEN_MAX_PORTS 4
471 NETXEN_BRDTYPE_P1_BD = 0x0000,
472 NETXEN_BRDTYPE_P1_SB = 0x0001,
473 NETXEN_BRDTYPE_P1_SMAX = 0x0002,
474 NETXEN_BRDTYPE_P1_SOCK = 0x0003,
476 NETXEN_BRDTYPE_P2_SOCK_31 = 0x0008,
477 NETXEN_BRDTYPE_P2_SOCK_35 = 0x0009,
478 NETXEN_BRDTYPE_P2_SB35_4G = 0x000a,
479 NETXEN_BRDTYPE_P2_SB31_10G = 0x000b,
480 NETXEN_BRDTYPE_P2_SB31_2G = 0x000c,
482 NETXEN_BRDTYPE_P2_SB31_10G_IMEZ = 0x000d,
483 NETXEN_BRDTYPE_P2_SB31_10G_HMEZ = 0x000e,
484 NETXEN_BRDTYPE_P2_SB31_10G_CX4 = 0x000f
488 NETXEN_BRDMFG_INVENTEC = 1
492 MEM_ORG_128Mbx4 = 0x0, /* DDR1 only */
493 MEM_ORG_128Mbx8 = 0x1, /* DDR1 only */
494 MEM_ORG_128Mbx16 = 0x2, /* DDR1 only */
495 MEM_ORG_256Mbx4 = 0x3,
496 MEM_ORG_256Mbx8 = 0x4,
497 MEM_ORG_256Mbx16 = 0x5,
498 MEM_ORG_512Mbx4 = 0x6,
499 MEM_ORG_512Mbx8 = 0x7,
500 MEM_ORG_512Mbx16 = 0x8,
503 MEM_ORG_1Gbx16 = 0xb,
506 MEM_ORG_2Gbx16 = 0xe,
507 MEM_ORG_128Mbx32 = 0x10002, /* GDDR only */
508 MEM_ORG_256Mbx32 = 0x10005 /* GDDR only */
509 } netxen_mn_mem_org_t;
512 MEM_ORG_512Kx36 = 0x0,
515 } netxen_sn_mem_org_t;
520 MEM_DEPTH_16MB = 0x3,
521 MEM_DEPTH_32MB = 0x4,
522 MEM_DEPTH_64MB = 0x5,
523 MEM_DEPTH_128MB = 0x6,
524 MEM_DEPTH_256MB = 0x7,
525 MEM_DEPTH_512MB = 0x8,
530 MEM_DEPTH_16GB = 0xd,
532 } netxen_mem_depth_t;
534 struct netxen_board_info {
546 u32 port_mask; /* available niu ports */
547 u32 peg_mask; /* available pegs */
548 u32 icache_ok; /* can we run with icache? */
549 u32 dcache_ok; /* can we run with dcache? */
557 /* MN-related config */
558 u32 mn_sync_mode; /* enable/ sync shift cclk/ sync shift mclk */
559 u32 mn_sync_shift_cclk;
560 u32 mn_sync_shift_mclk;
562 u32 mn_crystal_freq; /* in MHz */
563 u32 mn_speed; /* in MHz */
566 u32 mn_ranks_0; /* ranks per slot */
567 u32 mn_ranks_1; /* ranks per slot */
578 u32 mn_mode_reg; /* MIU DDR Mode Register */
579 u32 mn_ext_mode_reg; /* MIU DDR Extended Mode Register */
580 u32 mn_timing_0; /* MIU Memory Control Timing Rgister */
581 u32 mn_timing_1; /* MIU Extended Memory Ctrl Timing Register */
582 u32 mn_timing_2; /* MIU Extended Memory Ctrl Timing2 Register */
584 /* SN-related config */
585 u32 sn_sync_mode; /* enable/ sync shift cclk / sync shift mclk */
586 u32 sn_pt_mode; /* pass through mode */
601 u32 magic; /* indicates flash has been initialized */
608 #define FLASH_NUM_PORTS (4)
610 struct netxen_flash_mac_addr {
614 struct netxen_user_old_info {
626 /* primary image status */
628 u32 secondary_present;
630 /* MAC address , 4 ports */
631 struct netxen_flash_mac_addr mac_addr[FLASH_NUM_PORTS];
633 #define FLASH_NUM_MAC_PER_PORT 32
634 struct netxen_user_info {
635 u8 flash_md5[16 * 64];
642 /* primary image status */
644 u32 secondary_present;
646 /* MAC address , 4 ports, 32 address per port */
647 u64 mac_addr[FLASH_NUM_PORTS * FLASH_NUM_MAC_PER_PORT];
651 /* Any user defined data */
655 * Flash Layout - new format.
657 struct netxen_new_user_info {
658 u8 flash_md5[16 * 64];
665 /* primary image status */
667 u32 secondary_present;
669 /* MAC address , 4 ports, 32 address per port */
670 u64 mac_addr[FLASH_NUM_PORTS * FLASH_NUM_MAC_PER_PORT];
674 /* Any user defined data */
677 #define SECONDARY_IMAGE_PRESENT 0xb3b4b5b6
678 #define SECONDARY_IMAGE_ABSENT 0xffffffff
679 #define PRIMARY_IMAGE_GOOD 0x5a5a5a5a
680 #define PRIMARY_IMAGE_BAD 0xffffffff
682 /* Flash memory map */
684 NETXEN_CRBINIT_START = 0, /* Crbinit section */
685 NETXEN_BRDCFG_START = 0x4000, /* board config */
686 NETXEN_INITCODE_START = 0x6000, /* pegtune code */
687 NETXEN_BOOTLD_START = 0x10000, /* bootld */
688 NETXEN_IMAGE_START = 0x43000, /* compressed image */
689 NETXEN_SECONDARY_START = 0x200000, /* backup images */
690 NETXEN_PXE_START = 0x3E0000, /* user defined region */
691 NETXEN_USER_START = 0x3E8000, /* User defined region for new boards */
692 NETXEN_FIXED_START = 0x3F0000 /* backup of crbinit */
693 } netxen_flash_map_t;
695 #define NETXEN_USER_START_OLD NETXEN_PXE_START /* for backward compatibility */
697 #define NETXEN_FLASH_START (NETXEN_CRBINIT_START)
698 #define NETXEN_INIT_SECTOR (0)
699 #define NETXEN_PRIMARY_START (NETXEN_BOOTLD_START)
700 #define NETXEN_FLASH_CRBINIT_SIZE (0x4000)
701 #define NETXEN_FLASH_BRDCFG_SIZE (sizeof(struct netxen_board_info))
702 #define NETXEN_FLASH_USER_SIZE (sizeof(struct netxen_user_info)/sizeof(u32))
703 #define NETXEN_FLASH_SECONDARY_SIZE (NETXEN_USER_START-NETXEN_SECONDARY_START)
704 #define NETXEN_NUM_PRIMARY_SECTORS (0x20)
705 #define NETXEN_NUM_CONFIG_SECTORS (1)
706 #define PFX "NetXen: "
707 extern char netxen_nic_driver_name[];
709 /* Note: Make sure to not call this before adapter->port is valid */
710 #if !defined(NETXEN_DEBUG)
711 #define DPRINTK(klevel, fmt, args...) do { \
714 #define DPRINTK(klevel, fmt, args...) do { \
715 printk(KERN_##klevel PFX "%s: %s: " fmt, __FUNCTION__,\
716 (adapter != NULL && adapter->netdev != NULL) ? \
717 adapter->netdev->name : NULL, \
721 /* Number of status descriptors to handle per interrupt */
722 #define MAX_STATUS_HANDLE (128)
725 * netxen_skb_frag{} is to contain mapping info for each SG list. This
726 * has to be freed when DMA is complete. This is part of netxen_tx_buffer{}.
728 struct netxen_skb_frag {
733 #define _netxen_set_bits(config_word, start, bits, val) {\
734 unsigned long long __tmask = (((1ULL << (bits)) - 1) << (start));\
735 unsigned long long __tvalue = (val); \
736 (config_word) &= ~__tmask; \
737 (config_word) |= (((__tvalue) << (start)) & __tmask); \
740 #define _netxen_clear_bits(config_word, start, bits) {\
741 unsigned long long __tmask = (((1ULL << (bits)) - 1) << (start)); \
742 (config_word) &= ~__tmask; \
745 /* Following defines are for the state of the buffers */
746 #define NETXEN_BUFFER_FREE 0
747 #define NETXEN_BUFFER_BUSY 1
750 * There will be one netxen_buffer per skb packet. These will be
751 * used to save the dma info for pci_unmap_page()
753 struct netxen_cmd_buffer {
755 struct netxen_skb_frag frag_array[MAX_BUFFERS_PER_CMD + 1];
761 unsigned long time_stamp;
765 /* In rx_buffer, we do not need multiple fragments as is a single buffer */
766 struct netxen_rx_buffer {
771 u32 lro_expected_frags;
772 u32 lro_current_frags;
777 #define NETXEN_NIC_GBE 0x01
778 #define NETXEN_NIC_XGBE 0x02
781 * One hardware_context{} per adapter
782 * contains interrupt info as well shared hardware info.
784 struct netxen_hardware_context {
785 struct pci_dev *pdev;
786 void __iomem *pci_base0;
787 void __iomem *pci_base1;
788 void __iomem *pci_base2;
789 unsigned long first_page_group_end;
790 unsigned long first_page_group_start;
791 void __iomem *db_base;
792 unsigned long db_len;
797 struct netxen_board_info boardcfg;
800 /* Address of cmd ring in Phantom */
801 struct cmd_desc_type0 *cmd_desc_head;
802 struct pci_dev *cmd_desc_pdev;
803 dma_addr_t cmd_desc_phys_addr;
804 struct netxen_adapter *adapter;
808 #define RCV_RING_LRO RCV_DESC_LRO
810 #define MINIMUM_ETHERNET_FRAME_SIZE 64 /* With FCS */
811 #define ETHERNET_FCS_SIZE 4
813 struct netxen_adapter_stats {
838 * Rcv Descriptor Context. One such per Rcv Descriptor. There may
839 * be one Rcv Descriptor for normal packets, one for jumbo and may be others.
841 struct netxen_rcv_desc_ctx {
844 u32 rcv_pending; /* Num of bufs posted in phantom */
845 u32 rcv_free; /* Num of bufs in free list */
846 dma_addr_t phys_addr;
847 struct pci_dev *phys_pdev;
848 struct rcv_desc *desc_head; /* address of rx ring in Phantom */
849 u32 max_rx_desc_count;
852 struct netxen_rx_buffer *rx_buf_arr; /* rx buffers for receive */
857 * Receive context. There is one such structure per instance of the
858 * receive processing. Any state information that is relevant to
859 * the receive, and is must be in this structure. The global data may be
862 struct netxen_recv_context {
863 struct netxen_rcv_desc_ctx rcv_desc[NUM_RCV_DESC_RINGS];
864 u32 status_rx_producer;
865 u32 status_rx_consumer;
866 dma_addr_t rcv_status_desc_phys_addr;
867 struct pci_dev *rcv_status_desc_pdev;
868 struct status_desc *rcv_status_desc_head;
871 #define NETXEN_NIC_MSI_ENABLED 0x02
872 #define NETXEN_DMA_MASK 0xfffffffe
873 #define NETXEN_DB_MAPSIZE_BYTES 0x1000
875 struct netxen_dummy_dma {
877 dma_addr_t phys_addr;
880 struct netxen_adapter {
881 struct netxen_hardware_context ahw;
883 struct netxen_adapter *master;
884 struct net_device *netdev;
885 struct pci_dev *pdev;
886 struct napi_struct napi;
887 struct net_device_stats net_stats;
888 unsigned char mac_addr[ETH_ALEN];
894 struct work_struct watchdog_task;
895 struct timer_list watchdog_timer;
896 struct work_struct tx_timeout_task;
901 __le32 *cmd_consumer;
903 u32 last_cmd_consumer;
904 u32 max_tx_desc_count;
905 u32 max_rx_desc_count;
906 u32 max_jumbo_rx_desc_count;
907 u32 max_lro_rx_desc_count;
908 /* Num of instances active on cmd buffer ring */
909 u32 proc_cmd_buf_counter;
911 u32 num_threads, total_threads; /*Use to keep track of xmit threads */
918 struct netxen_adapter_stats stats;
927 spinlock_t stats_lock;
929 struct netxen_cmd_buffer *cmd_buf_arr; /* Command buffers for xmit */
932 * Receive instances. These can be either one per port,
933 * or one per peg, etc.
935 struct netxen_recv_context recv_ctx[MAX_RCV_CTX];
938 struct netxen_dummy_dma dummy_dma;
940 /* Context interface shared between card and host */
941 struct netxen_ring_ctx *ctx_desc;
942 struct pci_dev *ctx_desc_pdev;
943 dma_addr_t ctx_desc_phys_addr;
945 int (*enable_phy_interrupts) (struct netxen_adapter *);
946 int (*disable_phy_interrupts) (struct netxen_adapter *);
947 void (*handle_phy_intr) (struct netxen_adapter *);
948 int (*macaddr_set) (struct netxen_adapter *, netxen_ethernet_macaddr_t);
949 int (*set_mtu) (struct netxen_adapter *, int);
950 int (*set_promisc) (struct netxen_adapter *, netxen_niu_prom_mode_t);
951 int (*unset_promisc) (struct netxen_adapter *, netxen_niu_prom_mode_t);
952 int (*phy_read) (struct netxen_adapter *, long reg, u32 *);
953 int (*phy_write) (struct netxen_adapter *, long reg, u32 val);
954 int (*init_port) (struct netxen_adapter *, int);
955 void (*init_niu) (struct netxen_adapter *);
956 int (*stop_port) (struct netxen_adapter *);
957 }; /* netxen_adapter structure */
960 * NetXen dma watchdog control structure
962 * Bit 0 : enabled => R/O: 1 watchdog active, 0 inactive
963 * Bit 1 : disable_request => 1 req disable dma watchdog
964 * Bit 2 : enable_request => 1 req enable dma watchdog
968 #define netxen_set_dma_watchdog_disable_req(config_word) \
969 _netxen_set_bits(config_word, 1, 1, 1)
970 #define netxen_set_dma_watchdog_enable_req(config_word) \
971 _netxen_set_bits(config_word, 2, 1, 1)
972 #define netxen_get_dma_watchdog_enabled(config_word) \
973 ((config_word) & 0x1)
974 #define netxen_get_dma_watchdog_disabled(config_word) \
975 (((config_word) >> 1) & 0x1)
977 /* Max number of xmit producer threads that can run simultaneously */
978 #define MAX_XMIT_PRODUCERS 16
980 #define PCI_OFFSET_FIRST_RANGE(adapter, off) \
981 ((adapter)->ahw.pci_base0 + (off))
982 #define PCI_OFFSET_SECOND_RANGE(adapter, off) \
983 ((adapter)->ahw.pci_base1 + (off) - SECOND_PAGE_GROUP_START)
984 #define PCI_OFFSET_THIRD_RANGE(adapter, off) \
985 ((adapter)->ahw.pci_base2 + (off) - THIRD_PAGE_GROUP_START)
987 static inline void __iomem *pci_base_offset(struct netxen_adapter *adapter,
990 if ((off < FIRST_PAGE_GROUP_END) && (off >= FIRST_PAGE_GROUP_START)) {
991 return (adapter->ahw.pci_base0 + off);
992 } else if ((off < SECOND_PAGE_GROUP_END) &&
993 (off >= SECOND_PAGE_GROUP_START)) {
994 return (adapter->ahw.pci_base1 + off - SECOND_PAGE_GROUP_START);
995 } else if ((off < THIRD_PAGE_GROUP_END) &&
996 (off >= THIRD_PAGE_GROUP_START)) {
997 return (adapter->ahw.pci_base2 + off - THIRD_PAGE_GROUP_START);
1002 static inline void __iomem *pci_base(struct netxen_adapter *adapter,
1005 if ((off < FIRST_PAGE_GROUP_END) && (off >= FIRST_PAGE_GROUP_START)) {
1006 return adapter->ahw.pci_base0;
1007 } else if ((off < SECOND_PAGE_GROUP_END) &&
1008 (off >= SECOND_PAGE_GROUP_START)) {
1009 return adapter->ahw.pci_base1;
1010 } else if ((off < THIRD_PAGE_GROUP_END) &&
1011 (off >= THIRD_PAGE_GROUP_START)) {
1012 return adapter->ahw.pci_base2;
1017 int netxen_niu_xgbe_enable_phy_interrupts(struct netxen_adapter *adapter);
1018 int netxen_niu_gbe_enable_phy_interrupts(struct netxen_adapter *adapter);
1019 int netxen_niu_xgbe_disable_phy_interrupts(struct netxen_adapter *adapter);
1020 int netxen_niu_gbe_disable_phy_interrupts(struct netxen_adapter *adapter);
1021 void netxen_nic_xgbe_handle_phy_intr(struct netxen_adapter *adapter);
1022 void netxen_nic_gbe_handle_phy_intr(struct netxen_adapter *adapter);
1023 int netxen_niu_gbe_phy_read(struct netxen_adapter *adapter, long reg,
1025 int netxen_niu_gbe_phy_write(struct netxen_adapter *adapter,
1026 long reg, __u32 val);
1028 /* Functions available from netxen_nic_hw.c */
1029 int netxen_nic_set_mtu_xgb(struct netxen_adapter *adapter, int new_mtu);
1030 int netxen_nic_set_mtu_gb(struct netxen_adapter *adapter, int new_mtu);
1031 void netxen_nic_init_niu_gb(struct netxen_adapter *adapter);
1032 void netxen_nic_pci_change_crbwindow(struct netxen_adapter *adapter, u32 wndw);
1033 void netxen_nic_reg_write(struct netxen_adapter *adapter, u64 off, u32 val);
1034 int netxen_nic_reg_read(struct netxen_adapter *adapter, u64 off);
1035 void netxen_nic_write_w0(struct netxen_adapter *adapter, u32 index, u32 value);
1036 void netxen_nic_read_w0(struct netxen_adapter *adapter, u32 index, u32 * value);
1038 int netxen_nic_get_board_info(struct netxen_adapter *adapter);
1039 int netxen_nic_hw_read_wx(struct netxen_adapter *adapter, u64 off, void *data,
1041 int netxen_nic_hw_write_wx(struct netxen_adapter *adapter, u64 off, void *data,
1043 void netxen_crb_writelit_adapter(struct netxen_adapter *adapter,
1044 unsigned long off, int data);
1046 /* Functions from netxen_nic_init.c */
1047 void netxen_free_adapter_offload(struct netxen_adapter *adapter);
1048 int netxen_initialize_adapter_offload(struct netxen_adapter *adapter);
1049 int netxen_phantom_init(struct netxen_adapter *adapter, int pegtune_val);
1050 int netxen_load_firmware(struct netxen_adapter *adapter);
1051 int netxen_pinit_from_rom(struct netxen_adapter *adapter, int verbose);
1052 int netxen_rom_fast_read(struct netxen_adapter *adapter, int addr, int *valp);
1053 int netxen_rom_fast_read_words(struct netxen_adapter *adapter, int addr,
1054 u8 *bytes, size_t size);
1055 int netxen_rom_fast_write_words(struct netxen_adapter *adapter, int addr,
1056 u8 *bytes, size_t size);
1057 int netxen_flash_unlock(struct netxen_adapter *adapter);
1058 int netxen_backup_crbinit(struct netxen_adapter *adapter);
1059 int netxen_flash_erase_secondary(struct netxen_adapter *adapter);
1060 int netxen_flash_erase_primary(struct netxen_adapter *adapter);
1061 void netxen_halt_pegs(struct netxen_adapter *adapter);
1063 int netxen_rom_se(struct netxen_adapter *adapter, int addr);
1065 /* Functions from netxen_nic_isr.c */
1066 int netxen_nic_link_ok(struct netxen_adapter *adapter);
1067 void netxen_initialize_adapter_sw(struct netxen_adapter *adapter);
1068 void netxen_initialize_adapter_hw(struct netxen_adapter *adapter);
1069 void *netxen_alloc(struct pci_dev *pdev, size_t sz, dma_addr_t * ptr,
1070 struct pci_dev **used_dev);
1071 void netxen_initialize_adapter_ops(struct netxen_adapter *adapter);
1072 int netxen_init_firmware(struct netxen_adapter *adapter);
1073 void netxen_free_hw_resources(struct netxen_adapter *adapter);
1074 void netxen_tso_check(struct netxen_adapter *adapter,
1075 struct cmd_desc_type0 *desc, struct sk_buff *skb);
1076 int netxen_nic_hw_resources(struct netxen_adapter *adapter);
1077 void netxen_nic_clear_stats(struct netxen_adapter *adapter);
1078 int netxen_nic_rx_has_work(struct netxen_adapter *adapter);
1079 int netxen_nic_tx_has_work(struct netxen_adapter *adapter);
1080 void netxen_watchdog_task(struct work_struct *work);
1081 void netxen_post_rx_buffers(struct netxen_adapter *adapter, u32 ctx,
1083 int netxen_process_cmd_ring(unsigned long data);
1084 u32 netxen_process_rcv_ring(struct netxen_adapter *adapter, int ctx, int max);
1085 void netxen_nic_set_multi(struct net_device *netdev);
1086 int netxen_nic_change_mtu(struct net_device *netdev, int new_mtu);
1087 int netxen_nic_set_mac(struct net_device *netdev, void *p);
1088 struct net_device_stats *netxen_nic_get_stats(struct net_device *netdev);
1092 * NetXen Board information
1095 #define NETXEN_MAX_SHORT_NAME 16
1096 struct netxen_brdinfo {
1097 netxen_brdtype_t brdtype; /* type of board */
1098 long ports; /* max no of physical ports */
1099 char short_name[NETXEN_MAX_SHORT_NAME];
1102 static const struct netxen_brdinfo netxen_boards[] = {
1103 {NETXEN_BRDTYPE_P2_SB31_10G_CX4, 1, "XGb CX4"},
1104 {NETXEN_BRDTYPE_P2_SB31_10G_HMEZ, 1, "XGb HMEZ"},
1105 {NETXEN_BRDTYPE_P2_SB31_10G_IMEZ, 2, "XGb IMEZ"},
1106 {NETXEN_BRDTYPE_P2_SB31_10G, 1, "XGb XFP"},
1107 {NETXEN_BRDTYPE_P2_SB35_4G, 4, "Quad Gb"},
1108 {NETXEN_BRDTYPE_P2_SB31_2G, 2, "Dual Gb"},
1111 #define NUM_SUPPORTED_BOARDS ARRAY_SIZE(netxen_boards)
1113 static inline void get_brd_port_by_type(u32 type, int *ports)
1116 for (i = 0; i < NUM_SUPPORTED_BOARDS; ++i) {
1117 if (netxen_boards[i].brdtype == type) {
1118 *ports = netxen_boards[i].ports;
1127 static inline void get_brd_name_by_type(u32 type, char *name)
1130 for (i = 0; i < NUM_SUPPORTED_BOARDS; ++i) {
1131 if (netxen_boards[i].brdtype == type) {
1132 strcpy(name, netxen_boards[i].short_name);
1143 dma_watchdog_shutdown_request(struct netxen_adapter *adapter)
1147 /* check if already inactive */
1148 if (netxen_nic_hw_read_wx(adapter,
1149 NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL), &ctrl, 4))
1150 printk(KERN_ERR "failed to read dma watchdog status\n");
1152 if (netxen_get_dma_watchdog_enabled(ctrl) == 0)
1155 /* Send the disable request */
1156 netxen_set_dma_watchdog_disable_req(ctrl);
1157 netxen_crb_writelit_adapter(adapter,
1158 NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL), ctrl);
1164 dma_watchdog_shutdown_poll_result(struct netxen_adapter *adapter)
1168 if (netxen_nic_hw_read_wx(adapter,
1169 NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL), &ctrl, 4))
1170 printk(KERN_ERR "failed to read dma watchdog status\n");
1172 return (netxen_get_dma_watchdog_enabled(ctrl) == 0);
1176 dma_watchdog_wakeup(struct netxen_adapter *adapter)
1180 if (netxen_nic_hw_read_wx(adapter,
1181 NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL), &ctrl, 4))
1182 printk(KERN_ERR "failed to read dma watchdog status\n");
1184 if (netxen_get_dma_watchdog_enabled(ctrl))
1187 /* send the wakeup request */
1188 netxen_set_dma_watchdog_enable_req(ctrl);
1190 netxen_crb_writelit_adapter(adapter,
1191 NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL), ctrl);
1197 int netxen_is_flash_supported(struct netxen_adapter *adapter);
1198 int netxen_get_flash_mac_addr(struct netxen_adapter *adapter, __le64 mac[]);
1199 extern void netxen_change_ringparam(struct netxen_adapter *adapter);
1200 extern int netxen_rom_fast_read(struct netxen_adapter *adapter, int addr,
1203 extern struct ethtool_ops netxen_nic_ethtool_ops;
1205 extern int physical_port[]; /* physical port # from virtual port.*/
1206 #endif /* __NETXEN_NIC_H_ */