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