f51014749eb62c260d4a730dded88b96b1505275
[dragonfly.git] / sys / dev / netif / ixgbe / ixgbe.h
1 /******************************************************************************
2
3   Copyright (c) 2001-2012, Intel Corporation 
4   All rights reserved.
5   
6   Redistribution and use in source and binary forms, with or without 
7   modification, are permitted provided that the following conditions are met:
8   
9    1. Redistributions of source code must retain the above copyright notice, 
10       this list of conditions and the following disclaimer.
11   
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.
15   
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.
19   
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.
31
32 ******************************************************************************/
33 /*$FreeBSD: src/sys/dev/ixgbe/ixgbe.h,v 1.26 2012/04/23 22:05:09 bz Exp $*/
34
35
36 #ifndef _IXGBE_H_
37 #define _IXGBE_H_
38
39
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/mbuf.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>
49
50 #include <net/if.h>
51 #include <net/if_arp.h>
52 #include <net/ifq_var.h>
53 #include <net/bpf.h>
54 #include <net/ethernet.h>
55 #include <net/if_dl.h>
56 #include <net/if_media.h>
57
58 #include <net/bpf.h>
59 #include <net/if_types.h>
60 #include <net/vlan/if_vlan_var.h>
61 #include <net/vlan/if_vlan_ether.h>
62
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>
69 #ifdef NET_LRO
70 #include <netinet/tcp_lro.h>    /* XXX: IPv4 only */
71 #endif
72 #include <netinet/udp.h>
73
74 #include <sys/in_cksum.h>
75
76 #include <sys/bus.h>
77 #include <sys/rman.h>
78 #include <sys/resource.h>
79 #include <vm/vm.h>
80 #include <vm/pmap.h>
81 #include <machine/clock.h>
82 #include <bus/pci/pcivar.h>
83 #include <bus/pci/pcireg.h>
84 #include <sys/proc.h>
85 #include <sys/sysctl.h>
86 #include <sys/endian.h>
87 #include <sys/taskqueue.h>
88 #include <machine/smp.h>
89
90 #include <sys/spinlock.h>
91 #include <sys/spinlock2.h>
92
93 #ifdef IXGBE_IEEE1588
94 #include <sys/ieee1588.h>
95 #endif
96
97 #include "ixgbe_api.h"
98 #include "ixgbe_defines.h"
99
100 /* Tunables */
101
102 /*
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
107  * performance.
108  */
109 #define DEFAULT_TXD     1024
110 #define PERFORM_TXD     2048
111 #define MAX_TXD         4096
112 #define MIN_TXD         64
113
114 /*
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. 
119  * 
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.
123  */
124 #define DEFAULT_RXD     1024
125 #define PERFORM_RXD     2048
126 #define MAX_RXD         4096
127 #define MIN_RXD         64
128
129 /* Alignment for rings */
130 #define DBA_ALIGN       128
131
132 /*
133  * This parameter controls the maximum no of times the driver will loop in
134  * the isr. Minimum Value = 1
135  */
136 #define MAX_LOOP        10
137
138 /*
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.
142  */
143 #define IXGBE_WATCHDOG                   (10 * hz)
144
145 /*
146  * This parameters control when the driver calls the routine to reclaim
147  * transmit descriptors.
148  */
149 #define IXGBE_TX_CLEANUP_THRESHOLD      (adapter->num_tx_desc / 8)
150 #define IXGBE_TX_OP_THRESHOLD           (adapter->num_tx_desc / 32)
151
152 #define IXGBE_MAX_FRAME_SIZE    0x3F00
153
154 /* Flow control constants */
155 #define IXGBE_FC_PAUSE          0xFFFF
156 #define IXGBE_FC_HI             0x20000
157 #define IXGBE_FC_LO             0x10000
158
159 /* Keep older OS drivers building... */
160 #if !defined(SYSCTL_ADD_UQUAD)
161 #define SYSCTL_ADD_UQUAD SYSCTL_ADD_QUAD
162 #endif
163
164 /* Defines for printing debug information */
165 #define DEBUG_INIT  0
166 #define DEBUG_IOCTL 0
167 #define DEBUG_HW    0
168
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)
178
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
194
195 /* Offload bits in mbuf flag */
196 #define CSUM_OFFLOAD            (CSUM_IP|CSUM_TCP|CSUM_UDP)
197
198 /*
199  * Interrupt Moderation parameters 
200  */
201 #define IXGBE_LOW_LATENCY       128
202 #define IXGBE_AVE_LATENCY       400
203 #define IXGBE_BULK_LATENCY      1200
204 #define IXGBE_LINK_ITR          2000
205
206 /*
207  *****************************************************************************
208  * vendor_info_array
209  * 
210  * This array contains the list of Subvendor/Subdevice IDs on which the driver
211  * should load.
212  * 
213  *****************************************************************************
214  */
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;
220         unsigned int    index;
221 } ixgbe_vendor_info_t;
222
223
224 struct ixgbe_tx_buf {
225         u32             eop_index;
226         struct mbuf     *m_head;
227         bus_dmamap_t    map;
228 };
229
230 struct ixgbe_rx_buf {
231         struct mbuf     *m_head;
232         struct mbuf     *m_pack;
233         struct mbuf     *fmp;
234         bus_dmamap_t    hmap;
235         bus_dmamap_t    pmap;
236 };
237
238 /*
239  * Bus dma allocation structure used by ixgbe_dma_malloc and ixgbe_dma_free.
240  */
241 struct ixgbe_dma_alloc {
242         bus_addr_t              dma_paddr;
243         caddr_t                 dma_vaddr;
244         bus_dma_tag_t           dma_tag;
245         bus_dmamap_t            dma_map;
246         bus_dma_segment_t       dma_seg;
247         bus_size_t              dma_size;
248         int                     dma_nseg;
249 };
250
251 /*
252 ** Driver queue struct: this is the interrupt container
253 **  for the associated tx and rx ring.
254 */
255 struct ix_queue {
256         struct adapter          *adapter;
257         u32                     msix;           /* This queue's MSIX vector */
258         u32                     eims;           /* This queue's EIMS bit */
259         u32                     eitr_setting;
260         struct resource         *res;
261         void                    *tag;
262         struct tx_ring          *txr;
263         struct rx_ring          *rxr;
264         struct task             que_task;
265         struct taskqueue        *tq;
266         u64                     irqs;
267         struct lwkt_serialize   serializer;
268 };
269
270 /*
271  * The transmit ring, one per queue
272  */
273 struct tx_ring {
274         struct adapter          *adapter;
275         struct lock             tx_lock;
276         u32                     me;
277         int                     queue_status;
278         int                     watchdog_time;
279         union ixgbe_adv_tx_desc *tx_base;
280         struct ixgbe_dma_alloc  txdma;
281         u32                     next_avail_desc;
282         u32                     next_to_clean;
283         struct ixgbe_tx_buf     *tx_buffers;
284         volatile u16            tx_avail;
285         u32                     txd_cmd;
286         bus_dma_tag_t           txtag;
287         char                    lock_name[16];
288 #ifdef IFNET_BUF_RING
289         struct buf_ring         *br;
290 #endif
291 #ifdef IXGBE_FDIR
292         u16                     atr_sample;
293         u16                     atr_count;
294 #endif
295         u32                     bytes;  /* used for AIM */
296         u32                     packets;
297         /* Soft Stats */
298         u64                     no_desc_avail;
299         u64                     total_packets;
300 };
301
302
303 /*
304  * The Receive ring, one per rx queue
305  */
306 struct rx_ring {
307         struct adapter          *adapter;
308         struct lock             rx_lock;
309         u32                     me;
310         union ixgbe_adv_rx_desc *rx_base;
311         struct ixgbe_dma_alloc  rxdma;
312 #ifdef NET_LRO
313         struct lro_ctrl         lro;
314 #endif
315         bool                    lro_enabled;
316         bool                    hdr_split;
317         bool                    hw_rsc;
318         bool                    discard;
319         bool                    vtag_strip;
320         u32                     next_to_refresh;
321         u32                     next_to_check;
322         char                    lock_name[16];
323         struct ixgbe_rx_buf     *rx_buffers;
324         bus_dma_tag_t           htag;
325         bus_dma_tag_t           ptag;
326
327         u32                     bytes; /* Used for AIM calc */
328         u32                     packets;
329
330         /* Soft stats */
331         u64                     rx_irq;
332         u64                     rx_split_packets;
333         u64                     rx_packets;
334         u64                     rx_bytes;
335         u64                     rx_discarded;
336         u64                     rsc_num;
337 #ifdef IXGBE_FDIR
338         u64                     flm;
339 #endif
340 };
341
342 /* Our adapter structure */
343 struct adapter {
344         struct ifnet            *ifp;
345         struct ixgbe_hw         hw;
346
347         struct ixgbe_osdep      osdep;
348         struct device           *dev;
349
350         struct resource         *pci_mem;
351         struct resource         *msix_mem;
352
353         /*
354          * Interrupt resources: this set is
355          * either used for legacy, or for Link
356          * when doing MSIX
357          */
358         void                    *tag;
359         struct resource         *res;
360         int                     intr_type;
361
362         struct ifmedia          media;
363         struct callout          timer;
364         int                     msix;
365         int                     if_flags;
366
367         struct lock             core_lock;
368         struct spinlock         mcast_spin;
369
370         eventhandler_tag        vlan_attach;
371         eventhandler_tag        vlan_detach;
372
373         u16                     num_vlans;
374         u16                     num_queues;
375
376         /*
377         ** Shadow VFTA table, this is needed because
378         ** the real vlan filter table gets cleared during
379         ** a soft reset and the driver needs to be able
380         ** to repopulate it.
381         */
382         u32                     shadow_vfta[IXGBE_VFTA_SIZE];
383
384         /* Info about the interface */
385         u32                     optics;
386         u32                     fc; /* local flow ctrl setting */
387         int                     advertise;  /* link speeds */
388         bool                    link_active;
389         u16                     max_frame_size;
390         u16                     num_segs;
391         u32                     link_speed;
392         bool                    link_up;
393         u32                     linkvec;
394
395         /* Mbuf cluster size */
396         u32                     rx_mbuf_sz;
397
398         /* Support for pluggable optics */
399         bool                    sfp_probe;
400         struct task             link_task;  /* Link tasklet */
401         struct task             mod_task;   /* SFP tasklet */
402         struct task             msf_task;   /* Multispeed Fiber */
403 #ifdef IXGBE_FDIR
404         int                     fdir_reinit;
405         struct task             fdir_task;
406 #endif
407         struct taskqueue        *tq;
408
409         /*
410         ** Queues: 
411         **   This is the irq holder, it has
412         **   and RX/TX pair or rings associated
413         **   with it.
414         */
415         struct ix_queue         *queues;
416
417         /*
418          * Transmit rings:
419          *      Allocated at run time, an array of rings.
420          */
421         struct tx_ring          *tx_rings;
422         int                     num_tx_desc;
423
424         /*
425          * Receive rings:
426          *      Allocated at run time, an array of rings.
427          */
428         struct rx_ring          *rx_rings;
429         int                     num_rx_desc;
430         u64                     que_mask;
431         u32                     rx_process_limit;
432
433         /* Multicast array memory */
434         u8                      *mta;
435
436         /* Misc stats maintained by the driver */
437         unsigned long           dropped_pkts;
438         unsigned long           mbuf_defrag_failed;
439         unsigned long           mbuf_header_failed;
440         unsigned long           mbuf_packet_failed;
441         unsigned long           no_tx_map_avail;
442         unsigned long           no_tx_dma_setup;
443         unsigned long           watchdog_events;
444         unsigned long           tso_tx;
445         unsigned long           link_irq;
446
447         struct ixgbe_hw_stats   stats;
448
449         struct lwkt_serialize   serializer;
450         struct sysctl_ctx_list  sysctl_ctx;
451         struct sysctl_oid       *sysctl_tree;
452 };
453
454 /* Precision Time Sync (IEEE 1588) defines */
455 #define ETHERTYPE_IEEE1588      0x88F7
456 #define PICOSECS_PER_TICK       20833
457 #define TSYNC_UDP_PORT          319 /* UDP port for the protocol */
458 #define IXGBE_ADVTXD_TSTAMP     0x00080000
459
460
461 #define IXGBE_CORE_LOCK_INIT(_sc, _name) \
462         lockinit(&(_sc)->core_lock, _name, 0, LK_CANRECURSE)
463 #define IXGBE_CORE_LOCK_DESTROY(_sc)      lockuninit(&(_sc)->core_lock)
464 #define IXGBE_TX_LOCK_DESTROY(_sc)        lockuninit(&(_sc)->tx_lock)
465 #define IXGBE_RX_LOCK_DESTROY(_sc)        lockuninit(&(_sc)->rx_lock)
466 #define IXGBE_CORE_LOCK(_sc)              lockmgr(&(_sc)->core_lock, LK_EXCLUSIVE)
467 #define IXGBE_TX_LOCK(_sc)                lockmgr(&(_sc)->tx_lock, LK_EXCLUSIVE)
468 #define IXGBE_TX_TRYLOCK(_sc)             lockmgr(&(_sc)->tx_mtx, LK_EXCLUSIVE|LK_NOWAIT)
469 #define IXGBE_RX_LOCK(_sc)                lockmgr(&(_sc)->rx_lock, LK_EXCLUSIVE)
470 #define IXGBE_CORE_UNLOCK(_sc)            lockmgr(&(_sc)->core_lock, LK_RELEASE)
471 #define IXGBE_TX_UNLOCK(_sc)              lockmgr(&(_sc)->tx_lock, LK_RELEASE)
472 #define IXGBE_RX_UNLOCK(_sc)              lockmgr(&(_sc)->rx_lock, LK_RELEASE)
473 #define IXGBE_CORE_LOCK_ASSERT(_sc)       KKASSERT(lockstatus(&(_sc)->core_lock, curthread) !=0)
474 #define IXGBE_TX_LOCK_ASSERT(_sc)         KKASSERT(lockstatus(&(_sc)->tx_lock, curthread) != 0)
475
476
477 static inline bool
478 ixgbe_is_sfp(struct ixgbe_hw *hw)
479 {
480         switch (hw->phy.type) {
481         case ixgbe_phy_sfp_avago:
482         case ixgbe_phy_sfp_ftl:
483         case ixgbe_phy_sfp_intel:
484         case ixgbe_phy_sfp_unknown:
485         case ixgbe_phy_sfp_passive_tyco:
486         case ixgbe_phy_sfp_passive_unknown:
487                 return TRUE;
488         default:
489                 return FALSE;
490         }
491 }
492
493 /*
494 ** Find the number of unrefreshed RX descriptors
495 */
496 static inline u16
497 ixgbe_rx_unrefreshed(struct rx_ring *rxr)
498 {       
499         struct adapter  *adapter = rxr->adapter;
500         
501         if (rxr->next_to_check > rxr->next_to_refresh)
502                 return (rxr->next_to_check - rxr->next_to_refresh - 1);
503         else
504                 return ((adapter->num_rx_desc + rxr->next_to_check) -
505                     rxr->next_to_refresh - 1);
506 }       
507
508 #endif /* _IXGBE_H_ */