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