1 /******************************************************************************
3 Copyright (c) 2001-2012, Intel Corporation
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions are met:
9 1. Redistributions of source code must retain the above copyright notice,
10 this list of conditions and the following disclaimer.
12 2. Redistributions in binary form must reproduce the above copyright
13 notice, this list of conditions and the following disclaimer in the
14 documentation and/or other materials provided with the distribution.
16 3. Neither the name of the Intel Corporation nor the names of its
17 contributors may be used to endorse or promote products derived from
18 this software without specific prior written permission.
20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 POSSIBILITY OF SUCH DAMAGE.
32 ******************************************************************************/
33 /*$FreeBSD: src/sys/dev/ixgbe/ixgbe.h,v 1.26 2012/04/23 22:05:09 bz Exp $*/
40 #include <sys/param.h>
41 #include <sys/systm.h>
43 #include <sys/protosw.h>
44 #include <sys/socket.h>
45 #include <sys/malloc.h>
46 #include <sys/kernel.h>
47 #include <sys/module.h>
48 #include <sys/sockio.h>
51 #include <net/if_arp.h>
52 #include <net/ifq_var.h>
54 #include <net/ethernet.h>
55 #include <net/if_dl.h>
56 #include <net/if_media.h>
59 #include <net/if_types.h>
60 #include <net/vlan/if_vlan_var.h>
61 #include <net/vlan/if_vlan_ether.h>
63 #include <netinet/in_systm.h>
64 #include <netinet/in.h>
65 #include <netinet/if_ether.h>
66 #include <netinet/ip.h>
67 #include <netinet/ip6.h>
68 #include <netinet/tcp.h>
70 #include <netinet/tcp_lro.h> /* XXX: IPv4 only */
72 #include <netinet/udp.h>
74 #include <sys/in_cksum.h>
78 #include <sys/resource.h>
81 #include <machine/clock.h>
82 #include <bus/pci/pcivar.h>
83 #include <bus/pci/pcireg.h>
85 #include <sys/sysctl.h>
86 #include <sys/endian.h>
87 #include <sys/taskqueue.h>
88 #include <machine/smp.h>
90 #include <sys/spinlock.h>
91 #include <sys/spinlock2.h>
94 #include <sys/ieee1588.h>
97 #include "ixgbe_api.h"
98 #include "ixgbe_defines.h"
103 * TxDescriptors Valid Range: 64-4096 Default Value: 256 This value is the
104 * number of transmit descriptors allocated by the driver. Increasing this
105 * value allows the driver to queue more transmits. Each descriptor is 16
106 * bytes. Performance tests have show the 2K value to be optimal for top
109 #define DEFAULT_TXD 1024
110 #define PERFORM_TXD 2048
115 * RxDescriptors Valid Range: 64-4096 Default Value: 256 This value is the
116 * number of receive descriptors allocated for each RX queue. Increasing this
117 * value allows the driver to buffer more incoming packets. Each descriptor
118 * is 16 bytes. A receive buffer is also allocated for each descriptor.
120 * Note: with 8 rings and a dual port card, it is possible to bump up
121 * against the system mbuf pool limit, you can tune nmbclusters
122 * to adjust for this.
124 #define DEFAULT_RXD 1024
125 #define PERFORM_RXD 2048
129 /* Alignment for rings */
130 #define DBA_ALIGN 128
133 * This parameter controls the maximum no of times the driver will loop in
134 * the isr. Minimum Value = 1
139 * This is the max watchdog interval, ie. the time that can
140 * pass between any two TX clean operations, such only happening
141 * when the TX hardware is functioning.
143 #define IXGBE_WATCHDOG (10 * hz)
146 * This parameters control when the driver calls the routine to reclaim
147 * transmit descriptors.
149 #define IXGBE_TX_CLEANUP_THRESHOLD (adapter->num_tx_desc / 8)
150 #define IXGBE_TX_OP_THRESHOLD (adapter->num_tx_desc / 32)
152 #define IXGBE_MAX_FRAME_SIZE 0x3F00
154 /* Flow control constants */
155 #define IXGBE_FC_PAUSE 0xFFFF
156 #define IXGBE_FC_HI 0x20000
157 #define IXGBE_FC_LO 0x10000
159 /* Keep older OS drivers building... */
160 #if !defined(SYSCTL_ADD_UQUAD)
161 #define SYSCTL_ADD_UQUAD SYSCTL_ADD_QUAD
164 /* Defines for printing debug information */
166 #define DEBUG_IOCTL 0
169 #define INIT_DEBUGOUT(S) if (DEBUG_INIT) kprintf(S "\n")
170 #define INIT_DEBUGOUT1(S, A) if (DEBUG_INIT) kprintf(S "\n", A)
171 #define INIT_DEBUGOUT2(S, A, B) if (DEBUG_INIT) kprintf(S "\n", A, B)
172 #define IOCTL_DEBUGOUT(S) if (DEBUG_IOCTL) kprintf(S "\n")
173 #define IOCTL_DEBUGOUT1(S, A) if (DEBUG_IOCTL) kprintf(S "\n", A)
174 #define IOCTL_DEBUGOUT2(S, A, B) if (DEBUG_IOCTL) kprintf(S "\n", A, B)
175 #define HW_DEBUGOUT(S) if (DEBUG_HW) kprintf(S "\n")
176 #define HW_DEBUGOUT1(S, A) if (DEBUG_HW) kprintf(S "\n", A)
177 #define HW_DEBUGOUT2(S, A, B) if (DEBUG_HW) kprintf(S "\n", A, B)
179 #define MAX_NUM_MULTICAST_ADDRESSES 128
180 #define IXGBE_82598_SCATTER 100
181 #define IXGBE_82599_SCATTER 32
182 #define MSIX_82598_BAR 3
183 #define MSIX_82599_BAR 4
184 #define IXGBE_TSO_SIZE 262140
185 #define IXGBE_TX_BUFFER_SIZE ((u32) 1514)
186 #define IXGBE_RX_HDR 128
187 #define IXGBE_VFTA_SIZE 128
188 #define IXGBE_BR_SIZE 4096
189 #define IXGBE_QUEUE_MIN_FREE 32
190 #define IXGBE_QUEUE_IDLE 1
191 #define IXGBE_QUEUE_WORKING 2
192 #define IXGBE_QUEUE_HUNG 4
193 #define IXGBE_QUEUE_DEPLETED 8
195 /* Offload bits in mbuf flag */
196 #define CSUM_OFFLOAD (CSUM_IP|CSUM_TCP|CSUM_UDP)
199 * Interrupt Moderation parameters
201 #define IXGBE_LOW_LATENCY 128
202 #define IXGBE_AVE_LATENCY 400
203 #define IXGBE_BULK_LATENCY 1200
204 #define IXGBE_LINK_ITR 2000
207 *****************************************************************************
210 * This array contains the list of Subvendor/Subdevice IDs on which the driver
213 *****************************************************************************
215 typedef struct _ixgbe_vendor_info_t {
216 unsigned int vendor_id;
217 unsigned int device_id;
218 unsigned int subvendor_id;
219 unsigned int subdevice_id;
221 } ixgbe_vendor_info_t;
224 struct ixgbe_tx_buf {
230 struct ixgbe_rx_buf {
239 * Bus dma allocation structure used by ixgbe_dma_malloc and ixgbe_dma_free.
241 struct ixgbe_dma_alloc {
242 bus_addr_t dma_paddr;
244 bus_dma_tag_t dma_tag;
245 bus_dmamap_t dma_map;
246 bus_dma_segment_t dma_seg;
252 ** Driver queue struct: this is the interrupt container
253 ** for the associated tx and rx ring.
256 struct adapter *adapter;
257 u32 msix; /* This queue's MSIX vector */
258 u32 eims; /* This queue's EIMS bit */
260 struct resource *res;
264 struct task que_task;
265 struct taskqueue *tq;
267 struct lwkt_serialize serializer;
271 * The transmit ring, one per queue
274 struct adapter *adapter;
279 union ixgbe_adv_tx_desc *tx_base;
280 struct ixgbe_dma_alloc txdma;
283 struct ixgbe_tx_buf *tx_buffers;
284 volatile u16 tx_avail;
288 #ifdef IFNET_BUF_RING
295 u32 bytes; /* used for AIM */
304 * The Receive ring, one per rx queue
307 struct adapter *adapter;
310 union ixgbe_adv_rx_desc *rx_base;
311 struct ixgbe_dma_alloc rxdma;
323 struct ixgbe_rx_buf *rx_buffers;
327 u32 bytes; /* Used for AIM calc */
332 u64 rx_split_packets;
342 /* Our adapter structure */
347 struct ixgbe_osdep osdep;
350 struct resource *pci_mem;
351 struct resource *msix_mem;
354 * Interrupt resources: this set is
355 * either used for legacy, or for Link
359 struct resource *res;
362 struct ifmedia media;
363 struct callout timer;
367 struct lock core_lock;
369 eventhandler_tag vlan_attach;
370 eventhandler_tag vlan_detach;
376 ** Shadow VFTA table, this is needed because
377 ** the real vlan filter table gets cleared during
378 ** a soft reset and the driver needs to be able
381 u32 shadow_vfta[IXGBE_VFTA_SIZE];
383 /* Info about the interface */
385 u32 fc; /* local flow ctrl setting */
386 int advertise; /* link speeds */
394 /* Mbuf cluster size */
397 /* Support for pluggable optics */
399 struct task link_task; /* Link tasklet */
400 struct task mod_task; /* SFP tasklet */
401 struct task msf_task; /* Multispeed Fiber */
404 struct task fdir_task;
406 struct taskqueue *tq;
410 ** This is the irq holder, it has
411 ** and RX/TX pair or rings associated
414 struct ix_queue *queues;
418 * Allocated at run time, an array of rings.
420 struct tx_ring *tx_rings;
425 * Allocated at run time, an array of rings.
427 struct rx_ring *rx_rings;
430 u32 rx_process_limit;
432 /* Multicast array memory */
435 /* Misc stats maintained by the driver */
436 unsigned long dropped_pkts;
437 unsigned long mbuf_defrag_failed;
438 unsigned long mbuf_header_failed;
439 unsigned long mbuf_packet_failed;
440 unsigned long no_tx_map_avail;
441 unsigned long no_tx_dma_setup;
442 unsigned long watchdog_events;
443 unsigned long tso_tx;
444 unsigned long link_irq;
446 struct ixgbe_hw_stats stats;
448 struct lwkt_serialize serializer;
449 struct sysctl_ctx_list sysctl_ctx;
450 struct sysctl_oid *sysctl_tree;
453 /* Precision Time Sync (IEEE 1588) defines */
454 #define ETHERTYPE_IEEE1588 0x88F7
455 #define PICOSECS_PER_TICK 20833
456 #define TSYNC_UDP_PORT 319 /* UDP port for the protocol */
457 #define IXGBE_ADVTXD_TSTAMP 0x00080000
460 #define IXGBE_CORE_LOCK_INIT(_sc, _name) \
461 lockinit(&(_sc)->core_lock, _name, 0, LK_CANRECURSE)
462 #define IXGBE_CORE_LOCK_DESTROY(_sc) lockuninit(&(_sc)->core_lock)
463 #define IXGBE_TX_LOCK_DESTROY(_sc) lockuninit(&(_sc)->tx_lock)
464 #define IXGBE_RX_LOCK_DESTROY(_sc) lockuninit(&(_sc)->rx_lock)
465 #define IXGBE_CORE_LOCK(_sc) lockmgr(&(_sc)->core_lock, LK_EXCLUSIVE)
466 #define IXGBE_TX_LOCK(_sc) lockmgr(&(_sc)->tx_lock, LK_EXCLUSIVE)
467 #define IXGBE_TX_TRYLOCK(_sc) lockmgr(&(_sc)->tx_mtx, LK_EXCLUSIVE|LK_NOWAIT)
468 #define IXGBE_RX_LOCK(_sc) lockmgr(&(_sc)->rx_lock, LK_EXCLUSIVE)
469 #define IXGBE_CORE_UNLOCK(_sc) lockmgr(&(_sc)->core_lock, LK_RELEASE)
470 #define IXGBE_TX_UNLOCK(_sc) lockmgr(&(_sc)->tx_lock, LK_RELEASE)
471 #define IXGBE_RX_UNLOCK(_sc) lockmgr(&(_sc)->rx_lock, LK_RELEASE)
472 #define IXGBE_CORE_LOCK_ASSERT(_sc) KKASSERT(lockstatus(&(_sc)->core_lock, curthread) !=0)
473 #define IXGBE_TX_LOCK_ASSERT(_sc) KKASSERT(lockstatus(&(_sc)->tx_lock, curthread) != 0)
477 ixgbe_is_sfp(struct ixgbe_hw *hw)
479 switch (hw->phy.type) {
480 case ixgbe_phy_sfp_avago:
481 case ixgbe_phy_sfp_ftl:
482 case ixgbe_phy_sfp_intel:
483 case ixgbe_phy_sfp_unknown:
484 case ixgbe_phy_sfp_passive_tyco:
485 case ixgbe_phy_sfp_passive_unknown:
493 ** Find the number of unrefreshed RX descriptors
496 ixgbe_rx_unrefreshed(struct rx_ring *rxr)
498 struct adapter *adapter = rxr->adapter;
500 if (rxr->next_to_check > rxr->next_to_refresh)
501 return (rxr->next_to_check - rxr->next_to_refresh - 1);
503 return ((adapter->num_rx_desc + rxr->next_to_check) -
504 rxr->next_to_refresh - 1);
507 #endif /* _IXGBE_H_ */