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