]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/dev/ixgbe/ixgbe.h
Add support for USB 3.0 XHCI via ACPI
[FreeBSD/FreeBSD.git] / sys / dev / ixgbe / ixgbe.h
1 /******************************************************************************
2   SPDX-License-Identifier: BSD-3-Clause
3
4   Copyright (c) 2001-2017, Intel Corporation
5   All rights reserved.
6
7   Redistribution and use in source and binary forms, with or without
8   modification, are permitted provided that the following conditions are met:
9
10    1. Redistributions of source code must retain the above copyright notice,
11       this list of conditions and the following disclaimer.
12
13    2. Redistributions in binary form must reproduce the above copyright
14       notice, this list of conditions and the following disclaimer in the
15       documentation and/or other materials provided with the distribution.
16
17    3. Neither the name of the Intel Corporation nor the names of its
18       contributors may be used to endorse or promote products derived from
19       this software without specific prior written permission.
20
21   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22   AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24   ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
25   LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26   CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27   SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29   CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30   ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31   POSSIBILITY OF SUCH DAMAGE.
32
33 ******************************************************************************/
34 /*$FreeBSD$*/
35
36
37 #ifndef _IXGBE_H_
38 #define _IXGBE_H_
39
40
41 #include <sys/param.h>
42 #include <sys/systm.h>
43 #include <sys/buf_ring.h>
44 #include <sys/mbuf.h>
45 #include <sys/protosw.h>
46 #include <sys/socket.h>
47 #include <sys/malloc.h>
48 #include <sys/kernel.h>
49 #include <sys/module.h>
50 #include <sys/sockio.h>
51 #include <sys/eventhandler.h>
52
53 #include <net/if.h>
54 #include <net/if_var.h>
55 #include <net/if_arp.h>
56 #include <net/bpf.h>
57 #include <net/ethernet.h>
58 #include <net/if_dl.h>
59 #include <net/if_media.h>
60
61 #include <net/if_types.h>
62 #include <net/if_vlan_var.h>
63 #include <net/iflib.h>
64
65 #include <netinet/in_systm.h>
66 #include <netinet/in.h>
67 #include <netinet/if_ether.h>
68
69 #include <sys/bus.h>
70 #include <machine/bus.h>
71 #include <sys/rman.h>
72 #include <machine/resource.h>
73 #include <vm/vm.h>
74 #include <vm/pmap.h>
75 #include <machine/clock.h>
76 #include <dev/pci/pcivar.h>
77 #include <dev/pci/pcireg.h>
78 #include <sys/proc.h>
79 #include <sys/sysctl.h>
80 #include <sys/endian.h>
81 #include <sys/gtaskqueue.h>
82 #include <sys/pcpu.h>
83 #include <sys/smp.h>
84 #include <machine/smp.h>
85 #include <sys/sbuf.h>
86
87 #include "ixgbe_api.h"
88 #include "ixgbe_common.h"
89 #include "ixgbe_phy.h"
90 #include "ixgbe_vf.h"
91 #include "ixgbe_features.h"
92
93 /* Tunables */
94
95 /*
96  * TxDescriptors Valid Range: 64-4096 Default Value: 256 This value is the
97  * number of transmit descriptors allocated by the driver. Increasing this
98  * value allows the driver to queue more transmits. Each descriptor is 16
99  * bytes. Performance tests have show the 2K value to be optimal for top
100  * performance.
101  */
102 #define DEFAULT_TXD     2048
103 #define PERFORM_TXD     2048
104 #define MAX_TXD         4096
105 #define MIN_TXD         64
106
107 /*
108  * RxDescriptors Valid Range: 64-4096 Default Value: 256 This value is the
109  * number of receive descriptors allocated for each RX queue. Increasing this
110  * value allows the driver to buffer more incoming packets. Each descriptor
111  * is 16 bytes.  A receive buffer is also allocated for each descriptor.
112  *
113  * Note: with 8 rings and a dual port card, it is possible to bump up
114  *       against the system mbuf pool limit, you can tune nmbclusters
115  *       to adjust for this.
116  */
117 #define DEFAULT_RXD     2048
118 #define PERFORM_RXD     2048
119 #define MAX_RXD         4096
120 #define MIN_RXD         64
121
122 /* Alignment for rings */
123 #define DBA_ALIGN       128
124
125 /*
126  * This is the max watchdog interval, ie. the time that can
127  * pass between any two TX clean operations, such only happening
128  * when the TX hardware is functioning.
129  */
130 #define IXGBE_WATCHDOG  (10 * hz)
131
132 /*
133  * This parameters control when the driver calls the routine to reclaim
134  * transmit descriptors.
135  */
136 #define IXGBE_TX_CLEANUP_THRESHOLD(_a)  ((_a)->num_tx_desc / 8)
137 #define IXGBE_TX_OP_THRESHOLD(_a)       ((_a)->num_tx_desc / 32)
138
139 /* These defines are used in MTU calculations */
140 #define IXGBE_MAX_FRAME_SIZE  9728
141 #define IXGBE_MTU_HDR         (ETHER_HDR_LEN + ETHER_CRC_LEN)
142 #define IXGBE_MTU_HDR_VLAN    (ETHER_HDR_LEN + ETHER_CRC_LEN + \
143                                ETHER_VLAN_ENCAP_LEN)
144 #define IXGBE_MAX_MTU         (IXGBE_MAX_FRAME_SIZE - IXGBE_MTU_HDR)
145 #define IXGBE_MAX_MTU_VLAN    (IXGBE_MAX_FRAME_SIZE - IXGBE_MTU_HDR_VLAN)
146
147 /* Flow control constants */
148 #define IXGBE_FC_PAUSE        0xFFFF
149 #define IXGBE_FC_HI           0x20000
150 #define IXGBE_FC_LO           0x10000
151
152 /*
153  * Used for optimizing small rx mbufs.  Effort is made to keep the copy
154  * small and aligned for the CPU L1 cache.
155  *
156  * MHLEN is typically 168 bytes, giving us 8-byte alignment.  Getting
157  * 32 byte alignment needed for the fast bcopy results in 8 bytes being
158  * wasted.  Getting 64 byte alignment, which _should_ be ideal for
159  * modern Intel CPUs, results in 40 bytes wasted and a significant drop
160  * in observed efficiency of the optimization, 97.9% -> 81.8%.
161  */
162 #if __FreeBSD_version < 1002000
163 #define MPKTHSIZE                 (sizeof(struct m_hdr) + sizeof(struct pkthdr))
164 #endif
165 #define IXGBE_RX_COPY_HDR_PADDED  ((((MPKTHSIZE - 1) / 32) + 1) * 32)
166 #define IXGBE_RX_COPY_LEN         (MSIZE - IXGBE_RX_COPY_HDR_PADDED)
167 #define IXGBE_RX_COPY_ALIGN       (IXGBE_RX_COPY_HDR_PADDED - MPKTHSIZE)
168
169 /* Keep older OS drivers building... */
170 #if !defined(SYSCTL_ADD_UQUAD)
171 #define SYSCTL_ADD_UQUAD SYSCTL_ADD_QUAD
172 #endif
173
174 /* Defines for printing debug information */
175 #define DEBUG_INIT  0
176 #define DEBUG_IOCTL 0
177 #define DEBUG_HW    0
178
179 #define INIT_DEBUGOUT(S)            if (DEBUG_INIT)  printf(S "\n")
180 #define INIT_DEBUGOUT1(S, A)        if (DEBUG_INIT)  printf(S "\n", A)
181 #define INIT_DEBUGOUT2(S, A, B)     if (DEBUG_INIT)  printf(S "\n", A, B)
182 #define IOCTL_DEBUGOUT(S)           if (DEBUG_IOCTL) printf(S "\n")
183 #define IOCTL_DEBUGOUT1(S, A)       if (DEBUG_IOCTL) printf(S "\n", A)
184 #define IOCTL_DEBUGOUT2(S, A, B)    if (DEBUG_IOCTL) printf(S "\n", A, B)
185 #define HW_DEBUGOUT(S)              if (DEBUG_HW) printf(S "\n")
186 #define HW_DEBUGOUT1(S, A)          if (DEBUG_HW) printf(S "\n", A)
187 #define HW_DEBUGOUT2(S, A, B)       if (DEBUG_HW) printf(S "\n", A, B)
188
189 #define MAX_NUM_MULTICAST_ADDRESSES     128
190 #define IXGBE_82598_SCATTER             100
191 #define IXGBE_82599_SCATTER             32
192 #define MSIX_82598_BAR                  3
193 #define MSIX_82599_BAR                  4
194 #define IXGBE_TSO_SIZE                  262140
195 #define IXGBE_RX_HDR                    128
196 #define IXGBE_VFTA_SIZE                 128
197 #define IXGBE_BR_SIZE                   4096
198 #define IXGBE_QUEUE_MIN_FREE            32
199 #define IXGBE_MAX_TX_BUSY               10
200 #define IXGBE_QUEUE_HUNG                0x80000000
201
202 #define IXGBE_EITR_DEFAULT              128
203
204 /* Supported offload bits in mbuf flag */
205 #if __FreeBSD_version >= 1000000
206 #define CSUM_OFFLOAD  (CSUM_IP_TSO|CSUM_IP6_TSO|CSUM_IP| \
207                        CSUM_IP_UDP|CSUM_IP_TCP|CSUM_IP_SCTP| \
208                        CSUM_IP6_UDP|CSUM_IP6_TCP|CSUM_IP6_SCTP)
209 #elif __FreeBSD_version >= 800000
210 #define CSUM_OFFLOAD  (CSUM_IP|CSUM_TCP|CSUM_UDP|CSUM_SCTP)
211 #else
212 #define CSUM_OFFLOAD  (CSUM_IP|CSUM_TCP|CSUM_UDP)
213 #endif
214
215 #define IXGBE_CAPS (IFCAP_HWCSUM | IFCAP_HWCSUM_IPV6 | IFCAP_TSO | \
216                 IFCAP_LRO | IFCAP_VLAN_HWTAGGING | IFCAP_VLAN_HWTSO | \
217                 IFCAP_VLAN_HWCSUM | IFCAP_JUMBO_MTU | IFCAP_VLAN_MTU | \
218                 IFCAP_VLAN_HWFILTER | IFCAP_WOL)
219
220 /* Backward compatibility items for very old versions */
221 #ifndef pci_find_cap
222 #define pci_find_cap pci_find_extcap
223 #endif
224
225 #ifndef DEVMETHOD_END
226 #define DEVMETHOD_END { NULL, NULL }
227 #endif
228
229 /*
230  * Interrupt Moderation parameters
231  */
232 #define IXGBE_LOW_LATENCY   128
233 #define IXGBE_AVE_LATENCY   400
234 #define IXGBE_BULK_LATENCY  1200
235
236 /* Using 1FF (the max value), the interval is ~1.05ms */
237 #define IXGBE_LINK_ITR_QUANTA  0x1FF
238 #define IXGBE_LINK_ITR         ((IXGBE_LINK_ITR_QUANTA << 3) & \
239                                 IXGBE_EITR_ITR_INT_MASK)
240
241
242 /************************************************************************
243  * vendor_info_array
244  *
245  *   Contains the list of Subvendor/Subdevice IDs on
246  *   which the driver should load.
247  ************************************************************************/
248 typedef struct _ixgbe_vendor_info_t {
249         unsigned int vendor_id;
250         unsigned int device_id;
251         unsigned int subvendor_id;
252         unsigned int subdevice_id;
253         unsigned int index;
254 } ixgbe_vendor_info_t;
255
256 struct ixgbe_bp_data {
257         u32 low;
258         u32 high;
259         u32 log;
260 };
261
262
263 /*
264  */
265 struct ixgbe_dma_alloc {
266         bus_addr_t        dma_paddr;
267         caddr_t           dma_vaddr;
268         bus_dma_tag_t     dma_tag;
269         bus_dmamap_t      dma_map;
270         bus_dma_segment_t dma_seg;
271         bus_size_t        dma_size;
272         int               dma_nseg;
273 };
274
275 struct ixgbe_mc_addr {
276         u8  addr[IXGBE_ETH_LENGTH_OF_ADDRESS];
277         u32 vmdq;
278 };
279
280 /*
281  * The transmit ring, one per queue
282  */
283 struct tx_ring {
284         struct adapter          *adapter;
285         union ixgbe_adv_tx_desc *tx_base;
286         uint64_t                tx_paddr;
287         u32                     tail;
288         qidx_t                  *tx_rsq;
289         qidx_t                  tx_rs_cidx;
290         qidx_t                  tx_rs_pidx;
291         qidx_t                  tx_cidx_processed;
292         uint8_t                 me;
293
294         /* Flow Director */
295         u16                     atr_sample;
296         u16                     atr_count;
297
298         u32                     bytes;  /* used for AIM */
299         u32                     packets;
300         /* Soft Stats */
301         u64                     tso_tx;
302         u64                     total_packets;
303 };
304
305
306 /*
307  * The Receive ring, one per rx queue
308  */
309 struct rx_ring {
310         struct ix_rx_queue      *que;
311         struct adapter          *adapter;
312         u32                     me;
313         u32                     tail;
314         union ixgbe_adv_rx_desc *rx_base;
315         bool                    hw_rsc;
316         bool                    vtag_strip;
317         uint64_t rx_paddr;
318         bus_dma_tag_t           ptag;
319
320         u32                     bytes; /* Used for AIM calc */
321         u32                     packets;
322
323         /* Soft stats */
324         u64                     rx_irq;
325         u64                     rx_copies;
326         u64                     rx_packets;
327         u64                     rx_bytes;
328         u64                     rx_discarded;
329         u64                     rsc_num;
330
331         /* Flow Director */
332         u64                     flm;
333 };
334
335 /*
336  * Driver queue struct: this is the interrupt container
337  *  for the associated tx and rx ring.
338  */
339 struct ix_rx_queue {
340         struct adapter          *adapter;
341         u32                     msix;           /* This queue's MSIX vector */
342         u32                     eims;           /* This queue's EIMS bit */
343         u32                     eitr_setting;
344         struct resource         *res;
345         void                    *tag;
346         int                     busy;
347         struct rx_ring          rxr;
348         struct if_irq           que_irq;
349         u64                     irqs;
350 };
351
352 struct ix_tx_queue {
353         struct adapter          *adapter;
354         u32                     msix;           /* This queue's MSIX vector */
355         struct tx_ring          txr;
356 };
357
358 #define IXGBE_MAX_VF_MC 30  /* Max number of multicast entries */
359
360 struct ixgbe_vf {
361         u_int    pool;
362         u_int    rar_index;
363         u_int    maximum_frame_size;
364         uint32_t flags;
365         uint8_t  ether_addr[ETHER_ADDR_LEN];
366         uint16_t mc_hash[IXGBE_MAX_VF_MC];
367         uint16_t num_mc_hashes;
368         uint16_t default_vlan;
369         uint16_t vlan_tag;
370         uint16_t api_ver;
371 };
372
373 /* Our adapter structure */
374 struct adapter {
375         struct ixgbe_hw         hw;
376         struct ixgbe_osdep      osdep;
377         if_ctx_t                ctx;
378         if_softc_ctx_t          shared;
379 #define num_tx_queues shared->isc_ntxqsets
380 #define num_rx_queues shared->isc_nrxqsets
381 #define max_frame_size shared->isc_max_frame_size
382 #define intr_type shared->isc_intr
383
384         device_t                dev;
385         struct ifnet            *ifp;
386
387         struct resource         *pci_mem;
388
389         /*
390          * Interrupt resources: this set is
391          * either used for legacy, or for Link
392          * when doing MSI-X
393          */
394         struct if_irq           irq;
395         void                    *tag;
396         struct resource         *res;
397
398         struct ifmedia          *media;
399         int                     if_flags;
400         int                     msix;
401
402         u16                     num_vlans;
403
404         /*
405          * Shadow VFTA table, this is needed because
406          * the real vlan filter table gets cleared during
407          * a soft reset and the driver needs to be able
408          * to repopulate it.
409          */
410         u32                     shadow_vfta[IXGBE_VFTA_SIZE];
411
412         /* Info about the interface */
413         int                     advertise;  /* link speeds */
414         bool                    link_active;
415         u16                     num_segs;
416         u32                     link_speed;
417         bool                    link_up;
418         u32                     vector;
419         u16                     dmac;
420         u32                     phy_layer;
421
422         /* Power management-related */
423         bool                    wol_support;
424         u32                     wufc;
425
426         /* Mbuf cluster size */
427         u32                     rx_mbuf_sz;
428
429         /* Support for pluggable optics */
430         bool                    sfp_probe;
431
432         /* Flow Director */
433         int                     fdir_reinit;
434
435         u32                     task_requests;
436
437         /*
438          * Queues:
439          *   This is the irq holder, it has
440          *   and RX/TX pair or rings associated
441          *   with it.
442          */
443         struct ix_tx_queue      *tx_queues;
444         struct ix_rx_queue      *rx_queues;
445         u64                     active_queues;
446
447         /* Multicast array memory */
448         struct ixgbe_mc_addr    *mta;
449
450         /* SR-IOV */
451         int                     iov_mode;
452         int                     num_vfs;
453         int                     pool;
454         struct ixgbe_vf         *vfs;
455
456         /* Bypass */
457         struct ixgbe_bp_data    bypass;
458
459         /* Misc stats maintained by the driver */
460         unsigned long           dropped_pkts;
461         unsigned long           mbuf_header_failed;
462         unsigned long           mbuf_packet_failed;
463         unsigned long           watchdog_events;
464         unsigned long           link_irq;
465         union {
466                 struct ixgbe_hw_stats pf;
467                 struct ixgbevf_hw_stats vf;
468         } stats;
469 #if __FreeBSD_version >= 1100036
470         /* counter(9) stats */
471         u64                     ipackets;
472         u64                     ierrors;
473         u64                     opackets;
474         u64                     oerrors;
475         u64                     ibytes;
476         u64                     obytes;
477         u64                     imcasts;
478         u64                     omcasts;
479         u64                     iqdrops;
480         u64                     noproto;
481 #endif
482         /* Feature capable/enabled flags.  See ixgbe_features.h */
483         u32                     feat_cap;
484         u32                     feat_en;
485 };
486
487 /* Precision Time Sync (IEEE 1588) defines */
488 #define ETHERTYPE_IEEE1588      0x88F7
489 #define PICOSECS_PER_TICK       20833
490 #define TSYNC_UDP_PORT          319 /* UDP port for the protocol */
491 #define IXGBE_ADVTXD_TSTAMP     0x00080000
492
493 /* For backward compatibility */
494 #if !defined(PCIER_LINK_STA)
495 #define PCIER_LINK_STA PCIR_EXPRESS_LINK_STA
496 #endif
497
498 /* Stats macros */
499 #if __FreeBSD_version >= 1100036
500 #define IXGBE_SET_IPACKETS(sc, count)    (sc)->ipackets = (count)
501 #define IXGBE_SET_IERRORS(sc, count)     (sc)->ierrors = (count)
502 #define IXGBE_SET_OPACKETS(sc, count)    (sc)->opackets = (count)
503 #define IXGBE_SET_OERRORS(sc, count)     (sc)->oerrors = (count)
504 #define IXGBE_SET_COLLISIONS(sc, count)
505 #define IXGBE_SET_IBYTES(sc, count)      (sc)->ibytes = (count)
506 #define IXGBE_SET_OBYTES(sc, count)      (sc)->obytes = (count)
507 #define IXGBE_SET_IMCASTS(sc, count)     (sc)->imcasts = (count)
508 #define IXGBE_SET_OMCASTS(sc, count)     (sc)->omcasts = (count)
509 #define IXGBE_SET_IQDROPS(sc, count)     (sc)->iqdrops = (count)
510 #else
511 #define IXGBE_SET_IPACKETS(sc, count)    (sc)->ifp->if_ipackets = (count)
512 #define IXGBE_SET_IERRORS(sc, count)     (sc)->ifp->if_ierrors = (count)
513 #define IXGBE_SET_OPACKETS(sc, count)    (sc)->ifp->if_opackets = (count)
514 #define IXGBE_SET_OERRORS(sc, count)     (sc)->ifp->if_oerrors = (count)
515 #define IXGBE_SET_COLLISIONS(sc, count)  (sc)->ifp->if_collisions = (count)
516 #define IXGBE_SET_IBYTES(sc, count)      (sc)->ifp->if_ibytes = (count)
517 #define IXGBE_SET_OBYTES(sc, count)      (sc)->ifp->if_obytes = (count)
518 #define IXGBE_SET_IMCASTS(sc, count)     (sc)->ifp->if_imcasts = (count)
519 #define IXGBE_SET_OMCASTS(sc, count)     (sc)->ifp->if_omcasts = (count)
520 #define IXGBE_SET_IQDROPS(sc, count)     (sc)->ifp->if_iqdrops = (count)
521 #endif
522
523 /* External PHY register addresses */
524 #define IXGBE_PHY_CURRENT_TEMP     0xC820
525 #define IXGBE_PHY_OVERTEMP_STATUS  0xC830
526
527 /* Sysctl help messages; displayed with sysctl -d */
528 #define IXGBE_SYSCTL_DESC_ADV_SPEED \
529         "\nControl advertised link speed using these flags:\n" \
530         "\t0x1 - advertise 100M\n" \
531         "\t0x2 - advertise 1G\n" \
532         "\t0x4 - advertise 10G\n" \
533         "\t0x8 - advertise 10M\n\n" \
534         "\t100M and 10M are only supported on certain adapters.\n"
535
536 #define IXGBE_SYSCTL_DESC_SET_FC \
537         "\nSet flow control mode using these values:\n" \
538         "\t0 - off\n" \
539         "\t1 - rx pause\n" \
540         "\t2 - tx pause\n" \
541         "\t3 - tx and rx pause"
542
543 /* Workaround to make 8.0 buildable */
544 #if __FreeBSD_version >= 800000 && __FreeBSD_version < 800504
545 static __inline int
546 drbr_needs_enqueue(struct ifnet *ifp, struct buf_ring *br)
547 {
548 #ifdef ALTQ
549         if (ALTQ_IS_ENABLED(&ifp->if_snd))
550                 return (1);
551 #endif
552         return (!buf_ring_empty(br));
553 }
554 #endif
555
556 /*
557  * This checks for a zero mac addr, something that will be likely
558  * unless the Admin on the Host has created one.
559  */
560 static inline bool
561 ixv_check_ether_addr(u8 *addr)
562 {
563         bool status = TRUE;
564
565         if ((addr[0] == 0 && addr[1]== 0 && addr[2] == 0 &&
566             addr[3] == 0 && addr[4]== 0 && addr[5] == 0))
567                 status = FALSE;
568
569         return (status);
570 }
571
572 /* Shared Prototypes */
573
574 int  ixgbe_allocate_queues(struct adapter *);
575 int  ixgbe_setup_transmit_structures(struct adapter *);
576 void ixgbe_free_transmit_structures(struct adapter *);
577 int  ixgbe_setup_receive_structures(struct adapter *);
578 void ixgbe_free_receive_structures(struct adapter *);
579 int  ixgbe_get_regs(SYSCTL_HANDLER_ARGS);
580
581 #include "ixgbe_bypass.h"
582 #include "ixgbe_fdir.h"
583 #include "ixgbe_rss.h"
584
585 #endif /* _IXGBE_H_ */