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