xref: /illumos-gate/usr/src/man/man4d/ixgbe.4d (revision e8d3efa1c56e5f2b5368600a2baeb7b1d54a07f8)
1.\"
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.\" Copyright 2026 Oxide Computer Company
6.\" 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.
7.\"  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
8.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
9.Dd "January 18, 2026"
10.Dt IXGBE 4
11.Os
12.Sh NAME
13.Nm ixgbe
14.Nd Intel 10Gb PCI Express NIC Driver
15.Sh SYNOPSIS
16.Pa /dev/ixgbe*
17.Pa /dev/net/ixgbe*
18.Sh DESCRIPTION
19The
20.Nm
2110 Gigabit Ethernet driver is a GLDV3 NIC driver for various Intel PCIe
22Controllers including:
23.Bl -bullet
24.It
25Intel 82598EB Ethernet Controller Family
26.It
27Intel 82599EB (X520) Ethernet Controller Family
28.It
29Intel X540 Ethernet Controller Family
30.It
31Intel X550 Ethernet Controller Family
32.It
33Intel E610 Ethernet Controller Family
34.El
35.Pp
36The
37.Nm
38driver functions include controller initialization, frame transmit and receive,
39multiple transmit and receive groups with receive side scaling
40.Pq RSS ,
41promiscuous and multicast support, transceiver management, LED control, UFM
42management, and error recovery and reporting.
43.Pp
44The supported speeds vary based on the controller.
45The 82598 and 82599 generally interface with optical transceivers.
46The X540 supports 1 and 10GBASE-T, while the X550 and the E610 support 1, 2.5,
475, and 10GBASE-T.
48The specific supported speeds vary based on the controller.
49.Sh APPLICATION PROGRAMMING INTERFACE
50The cloning character-special device,
51.Pa /dev/ixgbe ,
52is used to access all
53.Nm
54based devices installed within the system.
55.Pp
56The
57.Nm
58driver is managed by the
59.Xr dladm 8
60command line utility, which allows VLANs to be defined on top of
61.Nm
62instances and for
63.Nm
64instances to be aggregated.
65See
66.Xr dladm 8
67for more details.
68.Pp
69You must send an explicit
70.Dv DL_ATTACH_REQ
71message to associate the opened stream with a particular device
72.Pq PPA .
73The PPA ID is interpreted as an unsigned integer data type and indicates the
74corresponding device instance
75.Pq unit
76number.
77The driver returns an error
78.Pq Dv DL_ERROR_ACK
79if the PPA field value does not correspond to a valid device instance number
80for the system.
81The device is initialized on first attach and de-initialized
82.Pq stopped
83at last detach.
84.Pp
85The values returned by the driver in the
86.Dv DL_INFO_ACK
87primitive in response to the
88.Dv DL_INFO_REQ
89are:
90.Bl -bullet -offset indent
91.It
92Maximum SDU for Intel 82598EB is 16366.
93.It
94Maximum SDU for Intel 82599EB, X540 and X550 is 15500.
95.It
96Maximum SDU for Intel E610 is 9710.
97.It
98Minimum SDU is 0.
99.It
100DLSAP address length is 8.
101.It
102MAC type is
103.Dv DL_ETHER .
104.It
105SAP
106.Pq Service Access Point
107length value is -2, meaning the physical address component is followed
108immediately by a 2-byte SAP component within the DLSAP address.
109.It
110Broadcast address value is the Ethernet/IEEE broadcast address
111.Pq FF:FF:FF:FF:FF:FF .
112.Pp
113Once in the
114.Dv DL_ATTACHED
115state, you must send a
116.Dv DL_BIND_REQ
117to associate a particular SAP with the stream.
118.El
119.Sh CONFIGURATION
120By default, the
121.Nm
122driver performs auto-negotiation to select the link speed and mode.
123Link speed and mode can only be 10000 Mbps full-duplex for fiber.
124For copper, supported speeds may include 100, 1000, 2500, 5000, and 10000 Mbps
125full-duplex.
126See the
127.Em IEEE802.3
128standard for more information.
129.Sh FILES
130.Bl -tag -width Pa
131.It Pa /dev/ixgbe* , Pa /dev/net/ixgbe*
132Special character device.
133.It Pa /kernel/drv/amd64/ixgbe
134Device driver
135.Pq x86
136.It Pa /kernel/drv/ixgbe.conf
137Driver configuration file
138.El
139.Sh SEE ALSO
140.Xr streamio 4I ,
141.Xr dlpi 4P ,
142.Xr driver.conf 5 ,
143.Xr attributes 7 ,
144.Xr dladm 8 ,
145.Xr netstat 8
146.Pp
147.Rs
148.%T Writing Device Drivers
149.%U https://www.illumos.org/books/wdd/
150.Re
151