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
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
|
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
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
|