usr/src/man/man7d/igb.7d

   1 '\" te
   2 .\"  Copyright (c) 2007, 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.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH IGB 7D "Jul 20, 2007"
   7 .SH NAME
   8 igb \- Intel 82575 1Gb PCI Express NIC Driver
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/dev/igb*\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBigb\fR 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 82575 Gigabit Ethernet controllers.
  21 .sp
  22 .LP
  23 The \fBigb\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 \fBigb\fR driver and hardware support auto-negotiation, a protocol
  29 specified by the 1000  Base-T  standard.  Auto-negotiation allows each device
  30 to advertise its capabilities and discover those of its peer (link partner).
  31 The highest common  denominator  supported  by  both link  partners  is
  32 automatically  selected,  yielding  the  greatest  available throughput, while
  33 requiring no manual configuration. The \fBigb\fR driver also allows you to
  34 configure the advertised capabilities to less than the maximum (where the full
  35 speed  of  the interface is not required), or to force a specific mode of
  36 operation, irrespective of  the  link  partner's  advertised capabilities.
  37 .SH APPLICATION PROGRAMMING INTERFACE
  38 .sp
  39 .LP
  40 The cloning character-special device, \fB /dev/igb\fR, is used to access all
  41 Intel 82575 Gigabit devices installed within the system.
  42 .sp
  43 .LP
  44 The igb driver is managed  by the \fBdladm\fR(1M) command  line utility, which
  45 allows  VLANs to be defined on top of \fBigb\fR instances and  for \fBigb\fR
  46 instances to be aggregated.  See \fBdladm\fR(1M) for more details.
  47 .sp
  48 .LP
  49 You must send an explicit DL_ATTACH_REQ message to associate the opened stream
  50 with a particular device (PPA). The PPA ID is interpreted as an unsigned
  51 integer data type and  indicates the corresponding device instance (unit)
  52 number. The driver returns an error (DL_ERROR_ACK) if  the PPA field value does
  53 not correspond to a valid device instance number for the system. The device is
  54 initialized on first attach and de-initialized (stopped) at last detach.
  55 .sp
  56 .LP
  57 The values returned by the driver in the DL_INFO_ACK primitive in response to
  58 your DL_INFO_REQ are:
  59 .RS +4
  60 .TP
  61 .ie t \(bu
  62 .el o
  63 Maximum SDU is 9000.
  64 .RE
  65 .RS +4
  66 .TP
  67 .ie t \(bu
  68 .el o
  69 Minimum SDU is 0.
  70 .RE
  71 .RS +4
  72 .TP
  73 .ie t \(bu
  74 .el o
  75 DLSAP address length is 8.
  76 .RE
  77 .RS +4
  78 .TP
  79 .ie t \(bu
  80 .el o
  81 MAC type is DL_ETHER.
  82 .RE
  83 .RS +4
  84 .TP
  85 .ie t \(bu
  86 .el o
  87 SAP (Service Access Point) length value is -2, meaning the physical address
  88 component is followed immediately by a 2-byte SAP component within the DLSAP
  89 address.
  90 .RE
  91 .RS +4
  92 .TP
  93 .ie t \(bu
  94 .el o
  95 Broadcast address value is the Ethernet/IEEE broadcast address
  96 (FF:FF:FF:FF:FF:FF).
  97 .sp
  98 Once in the DL_ATTACHED state, you must send a DL_BIND_REQ to associate a
  99 particular SAP with the stream.
 100 .RE
 101 .SH CONFIGURATION
 102 .sp
 103 .LP
 104 By default, the  igb driver performs auto-negotiation to select the link speed
 105 and mode. Link speed and mode can be any one of the following, (as described
 106 in  the \fIIEEE803.2\fR standard):
 107 .sp
 108 .LP
 109 1000 Mbps, full-duplex.
 110 .sp
 111 .LP
 112 100 Mbps, full-duplex.
 113 .sp
 114 .LP
 115 100 Mbps, half-duplex.
 116 .sp
 117 .LP
 118 10 Mbps, full-duplex.
 119 .sp
 120 .LP
 121 10 Mbps, half-duplex.
 122 .sp
 123 .LP
 124 The auto-negotiation protocol automatically selects speed (1000 Mbps, 100 Mbps,
 125 or 10 Mbps) and operation mode (full-duplex or half-duplex) as the highest
 126 common denominator supported by both link partners.
 127 .sp
 128 .LP
 129 Alternatively, you can set the capabilities advertised by the \fBigb\fR device
 130 using \fBndd\fR(1M). The driver supports a number of parameters whose names
 131 begin with \fIadv_\fR (see below). Each of these parameters contains a boolean
 132 value that determines if the device advertises that mode of operation. For
 133 example,  the \fIadv_1000fdx_cap\fR parameter indicates if 1000M full duplex is
 134 advertised to link partner. The  \fIadv_autoneg\fR cap parameter controls
 135 whether auto-negotiation is performed. If \fIadv_autoneg_cap\fR is set to 0,
 136 the driver forces the mode of operation  selected by the first  non-zero
 137 parameter in priority order as shown below:
 138 .sp
 139 .in +2
 140 .nf
 141                         (highest priority/greatest throughput)
 142         adv_1000fdx_cap         1000Mbps full duplex
 143         adv_100fdx_cap          100Mbps full duplex
 144         adv_100hdx_cap          100Mbps half duplex
 145         adv_10fdx_cap           10Mbps full duplex
 146         adv_10hdx_cap           10Mbps half duplex
 147                                 (lowest priority/least throughput)
 148 .fi
 149 .in -2
 150
 151 .sp
 152 .LP
 153 All capabilities default to enabled. Note that changing any capability
 154 parameter causes the link to go down while the link partners renegotiate the
 155 link speed/duplex using the newly changed capabilities.
 156 .SH FILES
 157 .sp
 158 .ne 2
 159 .na
 160 \fB\fB/dev/igb*\fR\fR
 161 .ad
 162 .RS 27n
 163 Special character device.
 164 .RE
 165
 166 .sp
 167 .ne 2
 168 .na
 169 \fB\fB/kernel/drv/igb\fR\fR
 170 .ad
 171 .RS 27n
 172 32-bit device driver (x86).
 173 .RE
 174
 175 .sp
 176 .ne 2
 177 .na
 178 \fB\fB/kernel/drv/amd64/igb\fR\fR
 179 .ad
 180 .RS 27n
 181 64-bit device driver (x86).
 182 .RE
 183
 184 .sp
 185 .ne 2
 186 .na
 187 \fB\fB/kernel/drv/sparcv9/igb\fR\fR
 188 .ad
 189 .RS 27n
 190 64-bit device driver (SPARC).
 191 .RE
 192
 193 .sp
 194 .ne 2
 195 .na
 196 \fB\fB/kernel/drv/igb.conf\fR\fR
 197 .ad
 198 .RS 27n
 199 Configuration file.
 200 .RE
 201
 202 .SH SEE ALSO
 203 .sp
 204 .LP
 205 \fBdladm\fR(1M), \fBndd\fR(1M), \fBnetstat\fR(1M), \fBdriver.conf\fR(4),
 206 \fBattributes\fR(5), \fBstreamio\fR(7I), \fBdlpi\fR(7P),
 207 .sp
 208 .LP
 209 \fIWriting Device Drivers\fR
 210 .sp
 211 .LP
 212 \fISTREAMS Programming Guide\fR
 213 .sp
 214 .LP
 215 \fINetwork Interfaces Programmer's Guide\fR