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 13, 2016"
   9 .SH NAME
  10 ixgbe \- Intel 10Gb PCI Express NIC Driver
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fB/dev/ixgbe*\fR
  15 .fi
  16 
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBixgbe\fR 10 Gigabit Ethernet driver is a multi-threaded, loadable,
  21 clonable, GLD-based STREAMS driver supporting the Data Link Provider Interface,
  22 \fBdlpi\fR(7P), on Intel 10-Gigabit PCI Express Ethernet controllers.
  23 .sp
  24 .LP
  25 The \fBixgbe\fR driver functions include controller initialization, frame
  26 transmit and receive, promiscuous and multicast support, and error recovery and
  27 reporting.
  28 .sp
  29 .LP
  30 The \fBixgbe\fR driver supports the following Intel 10-Gigabit PCI Express Ethernet controllers:
  31 .RS +4
  32 .TP
  33 .ie t \(bu
  34 .el o
  35 Intel Ethernet Controller 82598EB Family
  36 .RE
  37 .RS +4
  38 .TP
  39 .ie t \(bu
  40 .el o
  41 Intel Ethernet Controller 82599EB (X520) Family
  42 .RE
  43 .RS +4
  44 .TP
  45 .ie t \(bu
  46 .el o
  47 Intel Ethernet Controller X540 Family
  48 .RE
  49 .RS +4
  50 .TP
  51 .ie t \(bu
  52 .el o
  53 Intel Ethernet Controller X550 Family
  54 .RE
  55 .LP
  56 The \fBixgbe\fR driver and hardware support auto-negotiation, a protocol
  57 specified by the \fIIEEE 802.3ae\fR specification.
  58 .SH APPLICATION PROGRAMMING INTERFACE
  59 .sp
  60 .LP
  61 The cloning character-special device, \fB/dev/ixgbe\fR, is used to access all
  62 Intel 10-Gigabit PCI Express Ethernet devices installed within the system.
  63 .sp
  64 .LP
  65 The \fBixgbe\fR driver is managed by the \fBdladm\fR(1M) command line utility,
  66 which allows VLANs to be defined on top of \fBixgbe\fR instances and for
  67 \fBixgbe\fR instances to be aggregated. See \fBdladm\fR(1M) for more details.
  68 .sp
  69 .LP
  70 You must send an explicit DL_ATTACH_REQ message to associate the opened stream
  71 with a particular device (PPA). The PPA ID is interpreted as an unsigned
  72 integer data type and indicates the corresponding device instance (unit)
  73 number. The driver returns an error (DL_ERROR_ACK) if the PPA field value does
  74 not correspond to a valid device instance number for the system. The device is
  75 initialized on first attach and de-initialized (stopped) at last detach.
  76 .sp
  77 .LP
  78 The values returned by the driver in the DL_INFO_ACK primitive in response to
  79 your DL_INFO_REQ are:
  80 .RS +4
  81 .TP
  82 .ie t \(bu
  83 .el o
  84 Maximum SDU is 16366.
  85 .RE
  86 .RS +4
  87 .TP
  88 .ie t \(bu
  89 .el o
  90 Minimum SDU is 0.
  91 .RE
  92 .RS +4
  93 .TP
  94 .ie t \(bu
  95 .el o
  96 DLSAP address length is 8.
  97 .RE
  98 .RS +4
  99 .TP
 100 .ie t \(bu
 101 .el o
 102 MAC type is DL_ETHER.
 103 .RE
 104 .RS +4
 105 .TP
 106 .ie t \(bu
 107 .el o
 108 SAP (Service Access Point) length value is -2, meaning the physical address
 109 component is followed immediately by a 2-byte SAP component within the DLSAP
 110 address.
 111 .RE
 112 .RS +4
 113 .TP
 114 .ie t \(bu
 115 .el o
 116 Broadcast address value is the Ethernet/IEEE broadcast address
 117 (FF:FF:FF:FF:FF:FF).
 118 .sp
 119 Once in the DL_ATTACHED state, you must send a DL_BIND_REQ to associate a
 120 particular SAP with the stream.
 121 .RE
 122 .SH CONFIGURATION
 123 .sp
 124 .LP
 125 By default, the \fBixgbe\fR driver performs auto-negotiation to select the link
 126 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
 127 \fIIEEE802.3\fR standard for more information.
 128 .SH FILES
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fB/dev/ixgbe*\fR\fR
 133 .ad
 134 .RS 29n
 135 Special character device.
 136 .RE
 137 
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fB/kernel/drv/ixgbe\fR\fR
 142 .ad
 143 .RS 29n
 144 32-bit device driver (x86).
 145 .RE
 146 
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fB/kernel/drv/amd64/ixgbe\fR\fR
 151 .ad
 152 .RS 29n
 153 64-bit device driver (x86).
 154 .RE
 155 
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fB/kernel/drv/sparcv9/ixgbe\fR\fR
 160 .ad
 161 .RS 29n
 162 64-bit device driver (SPARC).
 163 .RE
 164 
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fB/kernel/drv/ixgbe.conf\fR\fR
 169 .ad
 170 .RS 29n
 171 Configuration file.
 172 .RE
 173 
 174 .SH ATTRIBUTES
 175 .sp
 176 .LP
 177 See \fBattributes\fR(5) for descriptions of the following attributes:
 178 .sp
 179 
 180 .sp
 181 .TS
 182 box;
 183 c | c
 184 l | l .
 185 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 186 _
 187 Architecture    SPARC, x86
 188 _
 189 Interface Stability     Committed
 190 .TE
 191 
 192 .SH SEE ALSO
 193 .sp
 194 .LP
 195 \fBdladm\fR(1M), \fBnetstat\fR(1M), \fBdriver.conf\fR(4), \fBattributes\fR(5),
 196 \fBstreamio\fR(7I), \fBdlpi\fR(7P)
 197 .sp
 198 .LP
 199 \fIWriting Device Drivers\fR
 200 .sp
 201 .LP
 202 \fISTREAMS Programming Guide\fR
 203 .sp
 204 .LP
 205 \fINetwork Interfaces Programmer's Guide\fR
 206 .sp
 207 .LP
 208 \fIIEEE 802.3ae Specificiation\fR, IEEE - 2002