2 .\" This file and its contents are supplied under the terms of the
3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
4 .\" You may only use this file in accordance with the terms of version
7 .\" A full copy of the text of the CDDL should have accompanied this
8 .\" source. A copy of the CDDL is also available via the Internet at
9 .\" http://www.illumos.org/license/CDDL.
12 .\" Copyright 2016 Joyent, Inc.
19 .Nd Intel 710 Ethernet Device Driver
25 driver is a GLDv3, multi-threaded, clonable, loadable device driver that
26 supports the Data Link Provider Interface,
30 driver supports the Intel XL710 Ethernet Controller family of networking
31 interface cards which come in 1 GbE, 10 GbE, 25 GbE, and 40 GbE
34 In addition to basic device initialization and the sending and receiving
35 of frames, it supports the following features:
36 .Bl -dash -offset indent
38 Jumbo frames up to 9710 bytes.
40 Promiscuous access via
46 TCP, UDP, and SCTP checksum offload
51 driver does not enable the use of energy efficient Ethernet (EEE) or
52 support the use of flow control through hardware pause frames.
53 .Sh APPLICATION PROGRAMMING INTERFACE
54 For each device supported by the
56 installed in the system, a character-special file will be created. This
57 file supports the Data Link Provider Interface (DLPI) which is documented
60 For most consumers, the use of
64 Each instance is assigned a unique ascending integer identifier. A
65 device which has multiple ports may appear to the system as separate
66 instances. The system does not provide a guarnatee on how these will be
67 presented. Using this instance identifier, one can determine the exact
68 character-special file to open. For example, the first instance
69 enumerated in the system, with id 0, would be named
71 It exists in the file system at
76 driver always performs auto-negotiation and depending on the model may
77 negotiate to 40 Gbps, 25 Gbps, 10 Gbps, or 1 Gbps. At this time, the
78 driver requires the use of auto-negotiation.
82 driver is managed by the
86 is the preferred interface for setting all properties. While
87 .Xr driver.conf based configuration is possible,
91 driver may be joined into an aggregation based on the link aggregation
92 control protocol (LACP) through
95 The device supports the following properties which may be tuned through
97 .Pa /kernel/drv/i40e.conf .
98 Most of these properties cannot be changed after the device has been
99 started. The device is started in response to a DLPI consumer opening
100 the device and binding to it. This happens when an IP interfaces is
105 or an LLDP daemon is started.
107 Some properties may be tuned at runtime with the
109 utility. Properties that can be will have the name of the dladm property
110 called out explicitly.
112 These properties are not considered stable at this time. They may change
113 and should not be relied on. They are considered
115 It is not expected that administrators of the system will have to tune
130 property determines the starting MTU of the various device instances.
131 Note that the device's MTU also determines the upper bound of the MTU of
132 all VNICs created over the device. The default MTU is
145 proeprty determines whether or not support for multiple rings is enabled
146 for the device. The default is always to enable them. It is not
147 recommended to to disable them.
159 property determines the number of descriptors that will be used in each
160 receive ring on the card. Administrators should not normally need to
161 tune this value. Hardware requires that the ring size be a multiple of
162 32. The system will round up the set value to the nearest multiple of
175 property determines the number of descriptors that will be used in each
176 transmit ring on the card. Administrators should not normally need to
177 tune this value. Hardware requires that the ring size be a multiple of
178 32. The system will round up the set value to the nearest multiple of
181 .It Sy tx_resched_threshold
190 .Sy tx_resched_threshold
191 property determines the number of descriptors that must be available for
192 a frame to be transmitted. The maximum is variable. It is dependent on
195 property. At least eight descriptors must be available for the device to
198 .It Sy rx_limit_per_intr
207 .Sy rx_limit_per_intr
208 property determines the maximum number of packets that will be processed
209 on a given ring during a single interrupt. This is done to try and
210 guarantee some amount of liveness in the system. It is not expected
211 that administrators will have to tune this value.
213 .It Sy tx_hcksum_enable
223 property controls whether or not the device enables support for hardware
224 checksuming of outgoing packets. The default is to always enable support
225 for this. Turning it off will increase latency and decrease throughput
226 when transmitting packets, but should be done if a hardware bug is
229 .It Sy rx_hcksum_enable
239 property controls whether or not the device enables support for hardware
240 checksuming of incoming packets. The default is to always enable support
241 for this. Turning it off will increase latency and decrease throughput
242 when receiving packets, but should be done if a hardware bug is
245 .It Sy rx_dma_threshold
257 indicates the size in bytes of a received frame, including all of its
258 headers, at which the driver should not copy the frame but instead bind
259 DMA memory. By setting this property to its minimum, all frames will be
260 processed with DMA binding. By setting this property to its maximum, all
261 frames will be processed by copying the frame.
267 driver is only supported on
269 systems at this time.
273 Per-instance character device.
274 .It Pa /kernel/drv/i40e
275 32-bit device driver (x86).
276 .It Pa /kernel/drv/amd64/i40e
277 64-bit device driver (x86).
278 .It Pa /kernel/drv/i40e.conf
279 Driver configuration file.