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 2
69 #define NETXEN_NIC_LINUX_VERSIONID "3.4.2"
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 &= ~cpu_to_le16(0x7f), \
313 (cmd_desc)->flags_opcode |= cpu_to_le16((val) & 0x7f))
314 #define netxen_set_cmd_desc_opcode(cmd_desc, val) \
315 ((cmd_desc)->flags_opcode &= ~cpu_to_le16(0x3f<<7), \
316 (cmd_desc)->flags_opcode |= 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 &= ~cpu_to_le32(0xff), \
320 (cmd_desc)->num_of_buffers_total_length |= cpu_to_le32((val) & 0xff))
321 #define netxen_set_cmd_desc_totallength(cmd_desc, val) \
322 ((cmd_desc)->num_of_buffers_total_length &= ~cpu_to_le32(0xffffff00), \
323 (cmd_desc)->num_of_buffers_total_length |= cpu_to_le32(val << 8))
325 #define netxen_get_cmd_desc_opcode(cmd_desc) \
326 ((le16_to_cpu((cmd_desc)->flags_opcode) >> 7) & 0x003F)
327 #define netxen_get_cmd_desc_totallength(cmd_desc) \
328 (le32_to_cpu((cmd_desc)->num_of_buffers_total_length) >> 8)
330 struct cmd_desc_type0
{
331 u8 tcp_hdr_offset
; /* For LSO only */
332 u8 ip_hdr_offset
; /* For LSO only */
333 /* Bit pattern: 0-6 flags, 7-12 opcode, 13-15 unused */
335 /* Bit pattern: 0-7 total number of segments,
336 8-31 Total size of the packet */
337 __le32 num_of_buffers_total_length
;
340 __le32 addr_low_part2
;
341 __le32 addr_high_part2
;
346 __le16 reference_handle
; /* changed to u16 to add mss */
347 __le16 mss
; /* passed by NDIS_PACKET for LSO */
348 /* Bit pattern 0-3 port, 0-3 ctx id */
350 u8 total_hdr_length
; /* LSO only : MAC+IP+TCP Hdr size */
351 __le16 conn_id
; /* IPSec offoad only */
355 __le32 addr_low_part3
;
356 __le32 addr_high_part3
;
362 __le32 addr_low_part1
;
363 __le32 addr_high_part1
;
368 __le16 buffer1_length
;
369 __le16 buffer2_length
;
370 __le16 buffer3_length
;
371 __le16 buffer4_length
;
375 __le32 addr_low_part4
;
376 __le32 addr_high_part4
;
383 } __attribute__ ((aligned(64)));
385 /* Note: sizeof(rcv_desc) should always be a mutliple of 2 */
387 __le16 reference_handle
;
389 __le32 buffer_length
; /* allocated buffer length (usually 2K) */
393 /* opcode field in status_desc */
394 #define RCV_NIC_PKT (0xA)
395 #define STATUS_NIC_PKT ((RCV_NIC_PKT) << 12)
397 /* for status field in status_desc */
398 #define STATUS_NEED_CKSUM (1)
399 #define STATUS_CKSUM_OK (2)
401 /* owner bits of status_desc */
402 #define STATUS_OWNER_HOST (0x1)
403 #define STATUS_OWNER_PHANTOM (0x2)
405 #define NETXEN_PROT_IP (1)
406 #define NETXEN_PROT_UNKNOWN (0)
408 /* Note: sizeof(status_desc) should always be a mutliple of 2 */
410 #define netxen_get_sts_desc_lro_cnt(status_desc) \
411 ((status_desc)->lro & 0x7F)
412 #define netxen_get_sts_desc_lro_last_frag(status_desc) \
413 (((status_desc)->lro & 0x80) >> 7)
415 #define netxen_get_sts_port(status_desc) \
416 (le64_to_cpu((status_desc)->status_desc_data) & 0x0F)
417 #define netxen_get_sts_status(status_desc) \
418 ((le64_to_cpu((status_desc)->status_desc_data) >> 4) & 0x0F)
419 #define netxen_get_sts_type(status_desc) \
420 ((le64_to_cpu((status_desc)->status_desc_data) >> 8) & 0x0F)
421 #define netxen_get_sts_totallength(status_desc) \
422 ((le64_to_cpu((status_desc)->status_desc_data) >> 12) & 0xFFFF)
423 #define netxen_get_sts_refhandle(status_desc) \
424 ((le64_to_cpu((status_desc)->status_desc_data) >> 28) & 0xFFFF)
425 #define netxen_get_sts_prot(status_desc) \
426 ((le64_to_cpu((status_desc)->status_desc_data) >> 44) & 0x0F)
427 #define netxen_get_sts_owner(status_desc) \
428 ((le64_to_cpu((status_desc)->status_desc_data) >> 56) & 0x03)
429 #define netxen_get_sts_opcode(status_desc) \
430 ((le64_to_cpu((status_desc)->status_desc_data) >> 58) & 0x03F)
432 #define netxen_clear_sts_owner(status_desc) \
433 ((status_desc)->status_desc_data &= \
434 ~cpu_to_le64(((unsigned long long)3) << 56 ))
435 #define netxen_set_sts_owner(status_desc, val) \
436 ((status_desc)->status_desc_data |= \
437 cpu_to_le64(((unsigned long long)((val) & 0x3)) << 56 ))
440 /* Bit pattern: 0-3 port, 4-7 status, 8-11 type, 12-27 total_length
441 28-43 reference_handle, 44-47 protocol, 48-52 unused
442 53-55 desc_cnt, 56-57 owner, 58-63 opcode
444 __le64 status_desc_data
;
449 /* Bit pattern: 0-6 lro_count indicates frag sequence,
450 7 last_frag indicates last frag */
452 } __attribute__ ((aligned(16)));
455 NETXEN_RCV_PEG_0
= 0,
458 /* The version of the main data structure */
459 #define NETXEN_BDINFO_VERSION 1
461 /* Magic number to let user know flash is programmed */
462 #define NETXEN_BDINFO_MAGIC 0x12345678
464 /* Max number of Gig ports on a Phantom board */
465 #define NETXEN_MAX_PORTS 4
468 NETXEN_BRDTYPE_P1_BD
= 0x0000,
469 NETXEN_BRDTYPE_P1_SB
= 0x0001,
470 NETXEN_BRDTYPE_P1_SMAX
= 0x0002,
471 NETXEN_BRDTYPE_P1_SOCK
= 0x0003,
473 NETXEN_BRDTYPE_P2_SOCK_31
= 0x0008,
474 NETXEN_BRDTYPE_P2_SOCK_35
= 0x0009,
475 NETXEN_BRDTYPE_P2_SB35_4G
= 0x000a,
476 NETXEN_BRDTYPE_P2_SB31_10G
= 0x000b,
477 NETXEN_BRDTYPE_P2_SB31_2G
= 0x000c,
479 NETXEN_BRDTYPE_P2_SB31_10G_IMEZ
= 0x000d,
480 NETXEN_BRDTYPE_P2_SB31_10G_HMEZ
= 0x000e,
481 NETXEN_BRDTYPE_P2_SB31_10G_CX4
= 0x000f
485 NETXEN_BRDMFG_INVENTEC
= 1
489 MEM_ORG_128Mbx4
= 0x0, /* DDR1 only */
490 MEM_ORG_128Mbx8
= 0x1, /* DDR1 only */
491 MEM_ORG_128Mbx16
= 0x2, /* DDR1 only */
492 MEM_ORG_256Mbx4
= 0x3,
493 MEM_ORG_256Mbx8
= 0x4,
494 MEM_ORG_256Mbx16
= 0x5,
495 MEM_ORG_512Mbx4
= 0x6,
496 MEM_ORG_512Mbx8
= 0x7,
497 MEM_ORG_512Mbx16
= 0x8,
500 MEM_ORG_1Gbx16
= 0xb,
503 MEM_ORG_2Gbx16
= 0xe,
504 MEM_ORG_128Mbx32
= 0x10002, /* GDDR only */
505 MEM_ORG_256Mbx32
= 0x10005 /* GDDR only */
506 } netxen_mn_mem_org_t
;
509 MEM_ORG_512Kx36
= 0x0,
512 } netxen_sn_mem_org_t
;
517 MEM_DEPTH_16MB
= 0x3,
518 MEM_DEPTH_32MB
= 0x4,
519 MEM_DEPTH_64MB
= 0x5,
520 MEM_DEPTH_128MB
= 0x6,
521 MEM_DEPTH_256MB
= 0x7,
522 MEM_DEPTH_512MB
= 0x8,
527 MEM_DEPTH_16GB
= 0xd,
529 } netxen_mem_depth_t
;
531 struct netxen_board_info
{
543 u32 port_mask
; /* available niu ports */
544 u32 peg_mask
; /* available pegs */
545 u32 icache_ok
; /* can we run with icache? */
546 u32 dcache_ok
; /* can we run with dcache? */
554 /* MN-related config */
555 u32 mn_sync_mode
; /* enable/ sync shift cclk/ sync shift mclk */
556 u32 mn_sync_shift_cclk
;
557 u32 mn_sync_shift_mclk
;
559 u32 mn_crystal_freq
; /* in MHz */
560 u32 mn_speed
; /* in MHz */
563 u32 mn_ranks_0
; /* ranks per slot */
564 u32 mn_ranks_1
; /* ranks per slot */
575 u32 mn_mode_reg
; /* MIU DDR Mode Register */
576 u32 mn_ext_mode_reg
; /* MIU DDR Extended Mode Register */
577 u32 mn_timing_0
; /* MIU Memory Control Timing Rgister */
578 u32 mn_timing_1
; /* MIU Extended Memory Ctrl Timing Register */
579 u32 mn_timing_2
; /* MIU Extended Memory Ctrl Timing2 Register */
581 /* SN-related config */
582 u32 sn_sync_mode
; /* enable/ sync shift cclk / sync shift mclk */
583 u32 sn_pt_mode
; /* pass through mode */
598 u32 magic
; /* indicates flash has been initialized */
605 #define FLASH_NUM_PORTS (4)
607 struct netxen_flash_mac_addr
{
611 struct netxen_user_old_info
{
623 /* primary image status */
625 u32 secondary_present
;
627 /* MAC address , 4 ports */
628 struct netxen_flash_mac_addr mac_addr
[FLASH_NUM_PORTS
];
630 #define FLASH_NUM_MAC_PER_PORT 32
631 struct netxen_user_info
{
632 u8 flash_md5
[16 * 64];
639 /* primary image status */
641 u32 secondary_present
;
643 /* MAC address , 4 ports, 32 address per port */
644 u64 mac_addr
[FLASH_NUM_PORTS
* FLASH_NUM_MAC_PER_PORT
];
648 /* Any user defined data */
652 * Flash Layout - new format.
654 struct netxen_new_user_info
{
655 u8 flash_md5
[16 * 64];
662 /* primary image status */
664 u32 secondary_present
;
666 /* MAC address , 4 ports, 32 address per port */
667 u64 mac_addr
[FLASH_NUM_PORTS
* FLASH_NUM_MAC_PER_PORT
];
671 /* Any user defined data */
674 #define SECONDARY_IMAGE_PRESENT 0xb3b4b5b6
675 #define SECONDARY_IMAGE_ABSENT 0xffffffff
676 #define PRIMARY_IMAGE_GOOD 0x5a5a5a5a
677 #define PRIMARY_IMAGE_BAD 0xffffffff
679 /* Flash memory map */
681 NETXEN_CRBINIT_START
= 0, /* Crbinit section */
682 NETXEN_BRDCFG_START
= 0x4000, /* board config */
683 NETXEN_INITCODE_START
= 0x6000, /* pegtune code */
684 NETXEN_BOOTLD_START
= 0x10000, /* bootld */
685 NETXEN_IMAGE_START
= 0x43000, /* compressed image */
686 NETXEN_SECONDARY_START
= 0x200000, /* backup images */
687 NETXEN_PXE_START
= 0x3E0000, /* user defined region */
688 NETXEN_USER_START
= 0x3E8000, /* User defined region for new boards */
689 NETXEN_FIXED_START
= 0x3F0000 /* backup of crbinit */
690 } netxen_flash_map_t
;
692 #define NETXEN_USER_START_OLD NETXEN_PXE_START /* for backward compatibility */
694 #define NETXEN_FLASH_START (NETXEN_CRBINIT_START)
695 #define NETXEN_INIT_SECTOR (0)
696 #define NETXEN_PRIMARY_START (NETXEN_BOOTLD_START)
697 #define NETXEN_FLASH_CRBINIT_SIZE (0x4000)
698 #define NETXEN_FLASH_BRDCFG_SIZE (sizeof(struct netxen_board_info))
699 #define NETXEN_FLASH_USER_SIZE (sizeof(struct netxen_user_info)/sizeof(u32))
700 #define NETXEN_FLASH_SECONDARY_SIZE (NETXEN_USER_START-NETXEN_SECONDARY_START)
701 #define NETXEN_NUM_PRIMARY_SECTORS (0x20)
702 #define NETXEN_NUM_CONFIG_SECTORS (1)
703 #define PFX "NetXen: "
704 extern char netxen_nic_driver_name
[];
706 /* Note: Make sure to not call this before adapter->port is valid */
707 #if !defined(NETXEN_DEBUG)
708 #define DPRINTK(klevel, fmt, args...) do { \
711 #define DPRINTK(klevel, fmt, args...) do { \
712 printk(KERN_##klevel PFX "%s: %s: " fmt, __FUNCTION__,\
713 (adapter != NULL && adapter->netdev != NULL) ? \
714 adapter->netdev->name : NULL, \
718 /* Number of status descriptors to handle per interrupt */
719 #define MAX_STATUS_HANDLE (128)
722 * netxen_skb_frag{} is to contain mapping info for each SG list. This
723 * has to be freed when DMA is complete. This is part of netxen_tx_buffer{}.
725 struct netxen_skb_frag
{
730 #define _netxen_set_bits(config_word, start, bits, val) {\
731 unsigned long long __tmask = (((1ULL << (bits)) - 1) << (start));\
732 unsigned long long __tvalue = (val); \
733 (config_word) &= ~__tmask; \
734 (config_word) |= (((__tvalue) << (start)) & __tmask); \
737 #define _netxen_clear_bits(config_word, start, bits) {\
738 unsigned long long __tmask = (((1ULL << (bits)) - 1) << (start)); \
739 (config_word) &= ~__tmask; \
742 /* Following defines are for the state of the buffers */
743 #define NETXEN_BUFFER_FREE 0
744 #define NETXEN_BUFFER_BUSY 1
747 * There will be one netxen_buffer per skb packet. These will be
748 * used to save the dma info for pci_unmap_page()
750 struct netxen_cmd_buffer
{
752 struct netxen_skb_frag frag_array
[MAX_BUFFERS_PER_CMD
+ 1];
758 unsigned long time_stamp
;
762 /* In rx_buffer, we do not need multiple fragments as is a single buffer */
763 struct netxen_rx_buffer
{
768 u32 lro_expected_frags
;
769 u32 lro_current_frags
;
774 #define NETXEN_NIC_GBE 0x01
775 #define NETXEN_NIC_XGBE 0x02
778 * One hardware_context{} per adapter
779 * contains interrupt info as well shared hardware info.
781 struct netxen_hardware_context
{
782 struct pci_dev
*pdev
;
783 void __iomem
*pci_base0
;
784 void __iomem
*pci_base1
;
785 void __iomem
*pci_base2
;
786 unsigned long first_page_group_end
;
787 unsigned long first_page_group_start
;
788 void __iomem
*db_base
;
789 unsigned long db_len
;
794 struct netxen_board_info boardcfg
;
797 /* Address of cmd ring in Phantom */
798 struct cmd_desc_type0
*cmd_desc_head
;
799 struct pci_dev
*cmd_desc_pdev
;
800 dma_addr_t cmd_desc_phys_addr
;
801 struct netxen_adapter
*adapter
;
805 #define RCV_RING_LRO RCV_DESC_LRO
807 #define MINIMUM_ETHERNET_FRAME_SIZE 64 /* With FCS */
808 #define ETHERNET_FCS_SIZE 4
810 struct netxen_adapter_stats
{
835 * Rcv Descriptor Context. One such per Rcv Descriptor. There may
836 * be one Rcv Descriptor for normal packets, one for jumbo and may be others.
838 struct netxen_rcv_desc_ctx
{
841 u32 rcv_pending
; /* Num of bufs posted in phantom */
842 u32 rcv_free
; /* Num of bufs in free list */
843 dma_addr_t phys_addr
;
844 struct pci_dev
*phys_pdev
;
845 struct rcv_desc
*desc_head
; /* address of rx ring in Phantom */
846 u32 max_rx_desc_count
;
849 struct netxen_rx_buffer
*rx_buf_arr
; /* rx buffers for receive */
854 * Receive context. There is one such structure per instance of the
855 * receive processing. Any state information that is relevant to
856 * the receive, and is must be in this structure. The global data may be
859 struct netxen_recv_context
{
860 struct netxen_rcv_desc_ctx rcv_desc
[NUM_RCV_DESC_RINGS
];
861 u32 status_rx_producer
;
862 u32 status_rx_consumer
;
863 dma_addr_t rcv_status_desc_phys_addr
;
864 struct pci_dev
*rcv_status_desc_pdev
;
865 struct status_desc
*rcv_status_desc_head
;
868 #define NETXEN_NIC_MSI_ENABLED 0x02
869 #define NETXEN_DMA_MASK 0xfffffffe
870 #define NETXEN_DB_MAPSIZE_BYTES 0x1000
872 struct netxen_dummy_dma
{
874 dma_addr_t phys_addr
;
877 struct netxen_adapter
{
878 struct netxen_hardware_context ahw
;
880 struct netxen_adapter
*master
;
881 struct net_device
*netdev
;
882 struct pci_dev
*pdev
;
883 struct net_device_stats net_stats
;
884 unsigned char mac_addr
[ETH_ALEN
];
890 struct work_struct watchdog_task
;
891 struct timer_list watchdog_timer
;
892 struct work_struct tx_timeout_task
;
899 u32 last_cmd_consumer
;
900 u32 max_tx_desc_count
;
901 u32 max_rx_desc_count
;
902 u32 max_jumbo_rx_desc_count
;
903 u32 max_lro_rx_desc_count
;
904 /* Num of instances active on cmd buffer ring */
905 u32 proc_cmd_buf_counter
;
907 u32 num_threads
, total_threads
; /*Use to keep track of xmit threads */
914 struct netxen_adapter_stats stats
;
923 spinlock_t stats_lock
;
925 struct netxen_cmd_buffer
*cmd_buf_arr
; /* Command buffers for xmit */
928 * Receive instances. These can be either one per port,
929 * or one per peg, etc.
931 struct netxen_recv_context recv_ctx
[MAX_RCV_CTX
];
934 struct netxen_dummy_dma dummy_dma
;
936 /* Context interface shared between card and host */
937 struct netxen_ring_ctx
*ctx_desc
;
938 struct pci_dev
*ctx_desc_pdev
;
939 dma_addr_t ctx_desc_phys_addr
;
941 int (*enable_phy_interrupts
) (struct netxen_adapter
*);
942 int (*disable_phy_interrupts
) (struct netxen_adapter
*);
943 void (*handle_phy_intr
) (struct netxen_adapter
*);
944 int (*macaddr_set
) (struct netxen_adapter
*, netxen_ethernet_macaddr_t
);
945 int (*set_mtu
) (struct netxen_adapter
*, int);
946 int (*set_promisc
) (struct netxen_adapter
*, netxen_niu_prom_mode_t
);
947 int (*unset_promisc
) (struct netxen_adapter
*, netxen_niu_prom_mode_t
);
948 int (*phy_read
) (struct netxen_adapter
*, long reg
, u32
*);
949 int (*phy_write
) (struct netxen_adapter
*, long reg
, u32 val
);
950 int (*init_port
) (struct netxen_adapter
*, int);
951 void (*init_niu
) (struct netxen_adapter
*);
952 int (*stop_port
) (struct netxen_adapter
*);
953 }; /* netxen_adapter structure */
956 * NetXen dma watchdog control structure
958 * Bit 0 : enabled => R/O: 1 watchdog active, 0 inactive
959 * Bit 1 : disable_request => 1 req disable dma watchdog
960 * Bit 2 : enable_request => 1 req enable dma watchdog
964 #define netxen_set_dma_watchdog_disable_req(config_word) \
965 _netxen_set_bits(config_word, 1, 1, 1)
966 #define netxen_set_dma_watchdog_enable_req(config_word) \
967 _netxen_set_bits(config_word, 2, 1, 1)
968 #define netxen_get_dma_watchdog_enabled(config_word) \
969 ((config_word) & 0x1)
970 #define netxen_get_dma_watchdog_disabled(config_word) \
971 (((config_word) >> 1) & 0x1)
973 /* Max number of xmit producer threads that can run simultaneously */
974 #define MAX_XMIT_PRODUCERS 16
976 #define PCI_OFFSET_FIRST_RANGE(adapter, off) \
977 ((adapter)->ahw.pci_base0 + (off))
978 #define PCI_OFFSET_SECOND_RANGE(adapter, off) \
979 ((adapter)->ahw.pci_base1 + (off) - SECOND_PAGE_GROUP_START)
980 #define PCI_OFFSET_THIRD_RANGE(adapter, off) \
981 ((adapter)->ahw.pci_base2 + (off) - THIRD_PAGE_GROUP_START)
983 static inline void __iomem
*pci_base_offset(struct netxen_adapter
*adapter
,
986 if ((off
< FIRST_PAGE_GROUP_END
) && (off
>= FIRST_PAGE_GROUP_START
)) {
987 return (adapter
->ahw
.pci_base0
+ off
);
988 } else if ((off
< SECOND_PAGE_GROUP_END
) &&
989 (off
>= SECOND_PAGE_GROUP_START
)) {
990 return (adapter
->ahw
.pci_base1
+ off
- SECOND_PAGE_GROUP_START
);
991 } else if ((off
< THIRD_PAGE_GROUP_END
) &&
992 (off
>= THIRD_PAGE_GROUP_START
)) {
993 return (adapter
->ahw
.pci_base2
+ off
- THIRD_PAGE_GROUP_START
);
998 static inline void __iomem
*pci_base(struct netxen_adapter
*adapter
,
1001 if ((off
< FIRST_PAGE_GROUP_END
) && (off
>= FIRST_PAGE_GROUP_START
)) {
1002 return adapter
->ahw
.pci_base0
;
1003 } else if ((off
< SECOND_PAGE_GROUP_END
) &&
1004 (off
>= SECOND_PAGE_GROUP_START
)) {
1005 return adapter
->ahw
.pci_base1
;
1006 } else if ((off
< THIRD_PAGE_GROUP_END
) &&
1007 (off
>= THIRD_PAGE_GROUP_START
)) {
1008 return adapter
->ahw
.pci_base2
;
1013 int netxen_niu_xgbe_enable_phy_interrupts(struct netxen_adapter
*adapter
);
1014 int netxen_niu_gbe_enable_phy_interrupts(struct netxen_adapter
*adapter
);
1015 int netxen_niu_xgbe_disable_phy_interrupts(struct netxen_adapter
*adapter
);
1016 int netxen_niu_gbe_disable_phy_interrupts(struct netxen_adapter
*adapter
);
1017 int netxen_niu_xgbe_clear_phy_interrupts(struct netxen_adapter
*adapter
);
1018 int netxen_niu_gbe_clear_phy_interrupts(struct netxen_adapter
*adapter
);
1019 void netxen_nic_xgbe_handle_phy_intr(struct netxen_adapter
*adapter
);
1020 void netxen_nic_gbe_handle_phy_intr(struct netxen_adapter
*adapter
);
1021 void netxen_niu_gbe_set_mii_mode(struct netxen_adapter
*adapter
, int port
,
1023 void netxen_niu_gbe_set_gmii_mode(struct netxen_adapter
*adapter
, int port
,
1025 int netxen_niu_gbe_phy_read(struct netxen_adapter
*adapter
, long reg
,
1027 int netxen_niu_gbe_phy_write(struct netxen_adapter
*adapter
,
1028 long reg
, __u32 val
);
1030 /* Functions available from netxen_nic_hw.c */
1031 int netxen_nic_set_mtu_xgb(struct netxen_adapter
*adapter
, int new_mtu
);
1032 int netxen_nic_set_mtu_gb(struct netxen_adapter
*adapter
, int new_mtu
);
1033 void netxen_nic_init_niu_gb(struct netxen_adapter
*adapter
);
1034 void netxen_nic_pci_change_crbwindow(struct netxen_adapter
*adapter
, u32 wndw
);
1035 void netxen_nic_reg_write(struct netxen_adapter
*adapter
, u64 off
, u32 val
);
1036 int netxen_nic_reg_read(struct netxen_adapter
*adapter
, u64 off
);
1037 void netxen_nic_write_w0(struct netxen_adapter
*adapter
, u32 index
, u32 value
);
1038 void netxen_nic_read_w0(struct netxen_adapter
*adapter
, u32 index
, u32
* value
);
1040 int netxen_nic_get_board_info(struct netxen_adapter
*adapter
);
1041 int netxen_nic_hw_read_wx(struct netxen_adapter
*adapter
, u64 off
, void *data
,
1043 int netxen_nic_hw_write_wx(struct netxen_adapter
*adapter
, u64 off
, void *data
,
1045 void netxen_crb_writelit_adapter(struct netxen_adapter
*adapter
,
1046 unsigned long off
, int data
);
1047 int netxen_nic_erase_pxe(struct netxen_adapter
*adapter
);
1049 /* Functions from netxen_nic_init.c */
1050 void netxen_free_adapter_offload(struct netxen_adapter
*adapter
);
1051 int netxen_initialize_adapter_offload(struct netxen_adapter
*adapter
);
1052 int netxen_phantom_init(struct netxen_adapter
*adapter
, int pegtune_val
);
1053 int netxen_load_firmware(struct netxen_adapter
*adapter
);
1054 int netxen_pinit_from_rom(struct netxen_adapter
*adapter
, int verbose
);
1055 int netxen_rom_fast_read(struct netxen_adapter
*adapter
, int addr
, int *valp
);
1056 int netxen_rom_fast_read_words(struct netxen_adapter
*adapter
, int addr
,
1057 u8
*bytes
, size_t size
);
1058 int netxen_rom_fast_write_words(struct netxen_adapter
*adapter
, int addr
,
1059 u8
*bytes
, size_t size
);
1060 int netxen_flash_unlock(struct netxen_adapter
*adapter
);
1061 int netxen_backup_crbinit(struct netxen_adapter
*adapter
);
1062 int netxen_flash_erase_secondary(struct netxen_adapter
*adapter
);
1063 int netxen_flash_erase_primary(struct netxen_adapter
*adapter
);
1064 void netxen_halt_pegs(struct netxen_adapter
*adapter
);
1066 int netxen_rom_fast_write(struct netxen_adapter
*adapter
, int addr
, int data
);
1067 int netxen_rom_se(struct netxen_adapter
*adapter
, int addr
);
1068 int netxen_do_rom_se(struct netxen_adapter
*adapter
, int addr
);
1070 /* Functions from netxen_nic_isr.c */
1071 int netxen_nic_link_ok(struct netxen_adapter
*adapter
);
1072 void netxen_nic_isr_other(struct netxen_adapter
*adapter
);
1073 void netxen_indicate_link_status(struct netxen_adapter
*adapter
, u32 link
);
1074 void netxen_handle_port_int(struct netxen_adapter
*adapter
, u32 enable
);
1075 void netxen_initialize_adapter_sw(struct netxen_adapter
*adapter
);
1076 void netxen_initialize_adapter_hw(struct netxen_adapter
*adapter
);
1077 void *netxen_alloc(struct pci_dev
*pdev
, size_t sz
, dma_addr_t
* ptr
,
1078 struct pci_dev
**used_dev
);
1079 void netxen_initialize_adapter_ops(struct netxen_adapter
*adapter
);
1080 int netxen_init_firmware(struct netxen_adapter
*adapter
);
1081 void netxen_free_hw_resources(struct netxen_adapter
*adapter
);
1082 void netxen_tso_check(struct netxen_adapter
*adapter
,
1083 struct cmd_desc_type0
*desc
, struct sk_buff
*skb
);
1084 int netxen_nic_hw_resources(struct netxen_adapter
*adapter
);
1085 void netxen_nic_clear_stats(struct netxen_adapter
*adapter
);
1086 int netxen_nic_rx_has_work(struct netxen_adapter
*adapter
);
1087 int netxen_nic_tx_has_work(struct netxen_adapter
*adapter
);
1088 void netxen_watchdog_task(struct work_struct
*work
);
1089 void netxen_post_rx_buffers(struct netxen_adapter
*adapter
, u32 ctx
,
1091 void netxen_post_rx_buffers_nodb(struct netxen_adapter
*adapter
, u32 ctx
,
1093 int netxen_process_cmd_ring(unsigned long data
);
1094 u32
netxen_process_rcv_ring(struct netxen_adapter
*adapter
, int ctx
, int max
);
1095 void netxen_nic_set_multi(struct net_device
*netdev
);
1096 int netxen_nic_change_mtu(struct net_device
*netdev
, int new_mtu
);
1097 int netxen_nic_set_mac(struct net_device
*netdev
, void *p
);
1098 struct net_device_stats
*netxen_nic_get_stats(struct net_device
*netdev
);
1102 * NetXen Board information
1105 #define NETXEN_MAX_SHORT_NAME 16
1106 struct netxen_brdinfo
{
1107 netxen_brdtype_t brdtype
; /* type of board */
1108 long ports
; /* max no of physical ports */
1109 char short_name
[NETXEN_MAX_SHORT_NAME
];
1112 static const struct netxen_brdinfo netxen_boards
[] = {
1113 {NETXEN_BRDTYPE_P2_SB31_10G_CX4
, 1, "XGb CX4"},
1114 {NETXEN_BRDTYPE_P2_SB31_10G_HMEZ
, 1, "XGb HMEZ"},
1115 {NETXEN_BRDTYPE_P2_SB31_10G_IMEZ
, 2, "XGb IMEZ"},
1116 {NETXEN_BRDTYPE_P2_SB31_10G
, 1, "XGb XFP"},
1117 {NETXEN_BRDTYPE_P2_SB35_4G
, 4, "Quad Gb"},
1118 {NETXEN_BRDTYPE_P2_SB31_2G
, 2, "Dual Gb"},
1121 #define NUM_SUPPORTED_BOARDS (sizeof(netxen_boards)/sizeof(struct netxen_brdinfo))
1123 static inline void get_brd_port_by_type(u32 type
, int *ports
)
1126 for (i
= 0; i
< NUM_SUPPORTED_BOARDS
; ++i
) {
1127 if (netxen_boards
[i
].brdtype
== type
) {
1128 *ports
= netxen_boards
[i
].ports
;
1137 static inline void get_brd_name_by_type(u32 type
, char *name
)
1140 for (i
= 0; i
< NUM_SUPPORTED_BOARDS
; ++i
) {
1141 if (netxen_boards
[i
].brdtype
== type
) {
1142 strcpy(name
, netxen_boards
[i
].short_name
);
1153 dma_watchdog_shutdown_request(struct netxen_adapter
*adapter
)
1157 /* check if already inactive */
1158 if (netxen_nic_hw_read_wx(adapter
,
1159 NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL
), &ctrl
, 4))
1160 printk(KERN_ERR
"failed to read dma watchdog status\n");
1162 if (netxen_get_dma_watchdog_enabled(ctrl
) == 0)
1165 /* Send the disable request */
1166 netxen_set_dma_watchdog_disable_req(ctrl
);
1167 netxen_crb_writelit_adapter(adapter
,
1168 NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL
), ctrl
);
1174 dma_watchdog_shutdown_poll_result(struct netxen_adapter
*adapter
)
1178 if (netxen_nic_hw_read_wx(adapter
,
1179 NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL
), &ctrl
, 4))
1180 printk(KERN_ERR
"failed to read dma watchdog status\n");
1182 return ((netxen_get_dma_watchdog_enabled(ctrl
) == 0) &&
1183 (netxen_get_dma_watchdog_disabled(ctrl
) == 0));
1187 dma_watchdog_wakeup(struct netxen_adapter
*adapter
)
1191 if (netxen_nic_hw_read_wx(adapter
,
1192 NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL
), &ctrl
, 4))
1193 printk(KERN_ERR
"failed to read dma watchdog status\n");
1195 if (netxen_get_dma_watchdog_enabled(ctrl
))
1198 /* send the wakeup request */
1199 netxen_set_dma_watchdog_enable_req(ctrl
);
1201 netxen_crb_writelit_adapter(adapter
,
1202 NETXEN_CAM_RAM(NETXEN_CAM_RAM_DMA_WATCHDOG_CTRL
), ctrl
);
1208 int netxen_is_flash_supported(struct netxen_adapter
*adapter
);
1209 int netxen_get_flash_mac_addr(struct netxen_adapter
*adapter
, u64 mac
[]);
1210 extern void netxen_change_ringparam(struct netxen_adapter
*adapter
);
1211 extern int netxen_rom_fast_read(struct netxen_adapter
*adapter
, int addr
,
1214 extern struct ethtool_ops netxen_nic_ethtool_ops
;
1216 extern int physical_port
[]; /* physical port # from virtual port.*/
1217 #endif /* __NETXEN_NIC_H_ */