1 '\" te
   2 .\"  Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
   3 .\"  Copyright 2012, Nexenta Systems, Inc. All rights reserved.
   4 .\"  Copyright 2016, OmniTI Computer Consulting, Inc. All rights reserved.
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   6 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with
   7 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH IXGBE 7D "Jan 10, 2020"
   9 .SH NAME
  10 ixgbe \- Intel 10Gb PCI Express NIC Driver
  11 .SH SYNOPSIS
  12 .nf
  13 \fB/dev/ixgbe*\fR
  14 .fi
  15 
  16 .SH DESCRIPTION
  17 The \fBixgbe\fR 10 Gigabit Ethernet driver is a multi-threaded, loadable,
  18 clonable, GLD-based STREAMS driver supporting the Data Link Provider Interface,
  19 \fBdlpi\fR(7P), on Intel 10-Gigabit PCI Express Ethernet controllers.
  20 .sp
  21 .LP
  22 The \fBixgbe\fR driver functions include controller initialization, frame
  23 transmit and receive, promiscuous and multicast support, and error recovery and
  24 reporting.
  25 .sp
  26 .LP
  27 The \fBixgbe\fR driver supports the following Intel 10-Gigabit PCI Express Ethernet controllers:
  28 .RS +4
  29 .TP
  30 .ie t \(bu
  31 .el o
  32 Intel Ethernet Controller 82598EB Family
  33 .RE
  34 .RS +4
  35 .TP
  36 .ie t \(bu
  37 .el o
  38 Intel Ethernet Controller 82599EB (X520) Family
  39 .RE
  40 .RS +4
  41 .TP
  42 .ie t \(bu
  43 .el o
  44 Intel Ethernet Controller X540 Family
  45 .RE
  46 .RS +4
  47 .TP
  48 .ie t \(bu
  49 .el o
  50 Intel Ethernet Controller X550 Family
  51 .RE
  52 .LP
  53 The \fBixgbe\fR driver and hardware support auto-negotiation, a protocol
  54 specified by the \fIIEEE 802.3ae\fR specification.
  55 .SH APPLICATION PROGRAMMING INTERFACE
  56 The cloning character-special device, \fB/dev/ixgbe\fR, is used to access all
  57 Intel 10-Gigabit PCI Express Ethernet devices installed within the system.
  58 .sp
  59 .LP
  60 The \fBixgbe\fR driver is managed by the \fBdladm\fR(1M) command line utility,
  61 which allows VLANs to be defined on top of \fBixgbe\fR instances and for
  62 \fBixgbe\fR instances to be aggregated. See \fBdladm\fR(1M) for more details.
  63 .sp
  64 .LP
  65 You must send an explicit DL_ATTACH_REQ message to associate the opened stream
  66 with a particular device (PPA). The PPA ID is interpreted as an unsigned
  67 integer data type and indicates the corresponding device instance (unit)
  68 number. The driver returns an error (DL_ERROR_ACK) if the PPA field value does
  69 not correspond to a valid device instance number for the system. The device is
  70 initialized on first attach and de-initialized (stopped) at last detach.
  71 .sp
  72 .LP
  73 The values returned by the driver in the DL_INFO_ACK primitive in response to
  74 your DL_INFO_REQ are:
  75 .RS +4
  76 .TP
  77 .ie t \(bu
  78 .el o
  79 Maximum SDU for Intel 82598EB is 16366.
  80 .RE
  81 .RS +4
  82 .TP
  83 .ie t \(bu
  84 .el o
  85 Maximum SDU for Intel 82599EB, X540 and X550 is 15500.
  86 .RE
  87 .RS +4
  88 .TP
  89 .ie t \(bu
  90 .el o
  91 Minimum SDU is 0.
  92 .RE
  93 .RS +4
  94 .TP
  95 .ie t \(bu
  96 .el o
  97 DLSAP address length is 8.
  98 .RE
  99 .RS +4
 100 .TP
 101 .ie t \(bu
 102 .el o
 103 MAC type is DL_ETHER.
 104 .RE
 105 .RS +4
 106 .TP
 107 .ie t \(bu
 108 .el o
 109 SAP (Service Access Point) length value is -2, meaning the physical address
 110 component is followed immediately by a 2-byte SAP component within the DLSAP
 111 address.
 112 .RE
 113 .RS +4
 114 .TP
 115 .ie t \(bu
 116 .el o
 117 Broadcast address value is the Ethernet/IEEE broadcast address
 118 (FF:FF:FF:FF:FF:FF).
 119 .sp
 120 Once in the DL_ATTACHED state, you must send a DL_BIND_REQ to associate a
 121 particular SAP with the stream.
 122 .RE
 123 .SH CONFIGURATION
 124 By default, the \fBixgbe\fR driver performs auto-negotiation to select the link
 125 speed and mode. Link speed and mode can only be 10000 Mbps full-duplex for fiber, and only 10000, 1000, or 100 Mbps full-duplex for copper. See the
 126 \fIIEEE802.3\fR standard for more information.
 127 .SH FILES
 128 .ne 2
 129 .na
 130 \fB\fB/dev/ixgbe*\fR\fR
 131 .ad
 132 .RS 29n
 133 Special character device.
 134 .RE
 135 
 136 .sp
 137 .ne 2
 138 .na
 139 \fB\fB/kernel/drv/amd64/ixgbe\fR\fR
 140 .ad
 141 .RS 29n
 142 Device driver (x86)
 143 .RE
 144 
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fB/kernel/drv/sparcv9/ixgbe\fR\fR
 149 .ad
 150 .RS 29n
 151 Device driver (SPARC)
 152 .RE
 153 
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fB/kernel/drv/ixgbe.conf\fR\fR
 158 .ad
 159 .RS 29n
 160 Driver configuration file
 161 .RE
 162 
 163 .SH ATTRIBUTES
 164 See \fBattributes\fR(5) for descriptions of the following attributes:
 165 .sp
 166 
 167 .sp
 168 .TS
 169 box;
 170 c | c
 171 l | l .
 172 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 173 _
 174 Architecture    SPARC, x86
 175 _
 176 Interface Stability     Committed
 177 .TE
 178 
 179 .SH SEE ALSO
 180 \fBdladm\fR(1M), \fBnetstat\fR(1M), \fBdriver.conf\fR(4), \fBattributes\fR(5),
 181 \fBstreamio\fR(7I), \fBdlpi\fR(7P)
 182 .sp
 183 .LP
 184 \fIWriting Device Drivers\fR
 185 .sp
 186 .LP
 187 \fISTREAMS Programming Guide\fR
 188 .sp
 189 .LP
 190 \fINetwork Interfaces Programmer's Guide\fR
 191 .sp
 192 .LP
 193 \fIIEEE 802.3ae Specification\fR, IEEE - 2002