Print this page
11641 spelling mistakes in section 7d of the manual
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man7d/i40e.7d
+++ new/usr/src/man/man7d/i40e.7d
1 1 .\"
2 2 .\" This file and its contents are supplied under the terms of the
3 3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
|
↓ open down ↓ |
3 lines elided |
↑ open up ↑ |
4 4 .\" You may only use this file in accordance with the terms of version
5 5 .\" 1.0 of the CDDL.
6 6 .\"
7 7 .\" A full copy of the text of the CDDL should have accompanied this
8 8 .\" source. A copy of the CDDL is also available via the Internet at
9 9 .\" http://www.illumos.org/license/CDDL.
10 10 .\"
11 11 .\"
12 12 .\" Copyright (c) 2018 Joyent, Inc.
13 13 .\"
14 -.Dd May 23, 2018
14 +.Dd Jan 10, 2020
15 15 .Dt I40E 7D
16 16 .Os
17 17 .Sh NAME
18 18 .Nm i40e
19 19 .Nd Intel 710/722 Ethernet Device Driver
20 20 .Sh SYNOPSIS
21 21 .Pa /dev/net/i40e*
22 22 .Sh DESCRIPTION
23 23 The
24 24 .Nm
25 25 driver is a GLDv3, multi-threaded, clonable, loadable device driver that
26 26 supports the Data Link Provider Interface,
27 27 .Xr dlpi 7P .
28 28 The
29 29 .Nm
30 30 driver supports the Intel 710 and 722 Ethernet Controller families of
31 31 networking interface cards which come in 1 GbE, 10 GbE, 25 GbE, and 40
32 32 GbE variants.
33 33 .Pp
34 34 In addition to basic device initialization and the sending and receiving
35 35 of frames, it supports the following features:
36 36 .Bl -dash -offset indent
37 37 .It
38 38 Jumbo frames up to 9710 bytes.
39 39 .It
40 40 Promiscuous access via
41 41 .Xr snoop 1M and
42 42 .Xr dlpi 7P
43 43 .It
44 44 IPv4 Checksum Offload
45 45 .It
46 46 TCP, UDP, and SCTP checksum offload
47 47 .El
48 48 .Pp
49 49 At this time, the
50 50 .Nm
51 51 driver does not enable the use of energy efficient Ethernet (EEE) or
52 52 support the use of flow control through hardware pause frames.
53 53 .Sh APPLICATION PROGRAMMING INTERFACE
54 54 For each device supported by the
55 55 .Nm
56 56 installed in the system, a character-special file will be created.
|
↓ open down ↓ |
32 lines elided |
↑ open up ↑ |
57 57 This file supports the Data Link Provider Interface (DLPI) which is documented
58 58 in
59 59 .Xr dlpi 7P .
60 60 For most consumers, the use of
61 61 .Xr libdlpi 3LIB ,
62 62 is recommended.
63 63 .Pp
64 64 Each instance is assigned a unique ascending integer identifier.
65 65 A device which has multiple ports may appear to the system as separate
66 66 instances.
67 -The system does not provide a guarnatee on how these will be presented.
67 +The system does not provide a guarantee on how these will be presented.
68 68 Using this instance identifier, one can determine the exact character-special
69 69 file to open.
70 70 For example, the first instance enumerated in the system, with id 0, would be
71 71 named
72 72 .Sy i40e0 .
73 73 It exists in the file system at
74 74 .Pa /dev/net/i40e0 .
75 75 .Sh CONFIGURATION
76 76 The
77 77 .Nm i40e
78 78 driver always performs auto-negotiation and depending on the model may
79 79 negotiate to 40 Gbps, 25 Gbps, 10 Gbps, or 1 Gbps.
80 80 At this time, the driver requires the use of auto-negotiation.
81 81 .Pp
82 82 The
83 83 .Nm
84 84 driver is managed by the
85 85 .Xr dladm 1M
86 86 utility.
87 87 .Xr dladm 1M
88 88 is the preferred interface for setting all properties.
89 89 While
90 90 .Xr driver.conf 4
91 91 based configuration is possible,
92 92 .Xr dladm 1M
93 93 is recommended.
94 94 The
95 95 .Nm
96 96 driver may be joined into an aggregation based on the link aggregation
97 97 control protocol (LACP) through
98 98 .Xr dladm 1M .
99 99 .Sh PROPERTIES
100 100 The device supports the following properties which may be tuned through
101 101 its driver.conf file,
102 102 .Pa /kernel/drv/i40e.conf .
103 103 Most of these properties cannot be changed after the device has been started.
104 104 The device is started in response to a DLPI consumer opening the device and
105 105 binding to it.
106 106 This happens when an IP interfaces is plumbed or another
107 107 .Xr dlpi 7P
108 108 consumer such as
109 109 .Xr snoop 1M
110 110 or an LLDP daemon is started.
111 111 .Pp
112 112 Some properties may be tuned at runtime with the
113 113 .Xr dladm 1M
114 114 utility.
115 115 Properties that can be will have the name of the dladm property called out
116 116 explicitly.
117 117 .Pp
118 118 These properties are not considered stable at this time.
119 119 They may change and should not be relied on.
120 120 They are considered
121 121 .Sy Volatile .
122 122 It is not expected that administrators of the system will have to tune
123 123 these values.
124 124 .Bl -hang -width Ds
125 125 .It Sy default_mtu
126 126 .Bd -filled -compact
127 127 Minimum:
128 128 .Sy 1500 |
129 129 Maximum:
130 130 .Sy 9710 |
131 131 Runtime Property:
132 132 .Sy mtu
133 133 .Ed
134 134 .Bd -filled
135 135 The
136 136 .Sy default_mtu
137 137 property determines the starting MTU of the various device instances.
138 138 Note that the device's MTU also determines the upper bound of the MTU of
139 139 all VNICs created over the device.
140 140 The default MTU is
141 141 .Sy 1500 .
142 142 .Ed
|
↓ open down ↓ |
65 lines elided |
↑ open up ↑ |
143 143 .It Sy mr_enable
144 144 .Bd -filled -compact
145 145 Minimum:
146 146 .Sy 0 |
147 147 Maximum:
148 148 .Sy 1
149 149 .Ed
150 150 .Bd -filled
151 151 The
152 152 .Sy mr_enable
153 -proeprty determines whether or not support for multiple rings is enabled
153 +property determines whether or not support for multiple rings is enabled
154 154 for the device.
155 155 The default is always to enable them.
156 156 It is not recommended to to disable them.
157 157 .Ed
158 158 .It Sy rx_ring_size
159 159 .Bd -filled -compact
160 160 Minimum:
161 161 .Sy 64 |
162 162 Maximum:
163 163 .Sy 4096
164 164 .Ed
165 165 .Bd -filled
166 166 The
167 167 .Sy rx_ring_size
168 168 property determines the number of descriptors that will be used in each
169 169 receive ring on the card.
170 170 Administrators should not normally need to tune this value.
171 171 Hardware requires that the ring size be a multiple of 32.
172 172 The system will round up the set value to the nearest multiple of 32.
173 173 .Ed
174 174 .It Sy tx_ring_size
175 175 .Bd -filled -compact
176 176 Minimum:
177 177 .Sy 64 |
178 178 Maximum:
179 179 .Sy 4096
180 180 .Ed
181 181 .Bd -filled
182 182 The
183 183 .Sy tx_ring_size
184 184 property determines the number of descriptors that will be used in each
185 185 transmit ring on the card.
186 186 Administrators should not normally need to tune this value.
187 187 Hardware requires that the ring size be a multiple of 32.
188 188 The system will round up the set value to the nearest multiple of 32.
189 189 .Ed
190 190 .It Sy tx_resched_threshold
191 191 .Bd -filled -compact
192 192 Minimum:
193 193 .Sy 8 |
194 194 Maximum:
195 195 .Sy Variable
196 196 .Ed
197 197 .Bd -filled
198 198 The
199 199 .Sy tx_resched_threshold
200 200 property determines the number of descriptors that must be available for
201 201 a frame to be transmitted.
202 202 The maximum is variable.
203 203 It is dependent on the value of the
204 204 .Sy tx_ring_size
205 205 property.
206 206 At least eight descriptors must be available for the device to function
207 207 correctly.
208 208 .Ed
209 209 .It Sy rx_limit_per_intr
210 210 .Bd -filled -compact
211 211 Minimum:
212 212 .Sy 16 |
213 213 Maximum:
214 214 .Sy 4096
215 215 .Ed
216 216 .Bd -filled
217 217 The
218 218 .Sy rx_limit_per_intr
219 219 property determines the maximum number of packets that will be processed
220 220 on a given ring during a single interrupt.
221 221 This is done to try and guarantee some amount of liveness in the system.
222 222 It is not expected that administrators will have to tune this value.
223 223 .Ed
224 224 .It Sy tx_hcksum_enable
|
↓ open down ↓ |
61 lines elided |
↑ open up ↑ |
225 225 .Bd -filled -compact
226 226 Minimum:
227 227 .Sy 0 |
228 228 Maximum:
229 229 .Sy 1
230 230 .Ed
231 231 .Bd -filled
232 232 The
233 233 .Sy tx_hcksum_enable
234 234 property controls whether or not the device enables support for hardware
235 -checksuming of outgoing packets.
235 +checksumming of outgoing packets.
236 236 The default is to always enable support for this.
237 237 Turning it off will increase latency and decrease throughput when transmitting
238 238 packets, but should be done if a hardware bug is suspected.
239 239 .Ed
240 240 .It Sy rx_hcksum_enable
241 241 .Bd -filled -compact
242 242 Minimum:
243 243 .Sy 0 |
244 244 Maximum:
245 245 .Sy 1
246 246 .Ed
247 247 .Bd -filled
248 248 The
249 249 .Sy rx_hcksum_enable
250 250 property controls whether or not the device enables support for hardware
251 -checksuming of incoming packets.
251 +checksumming of incoming packets.
252 252 The default is to always enable support for this.
253 253 Turning it off will increase latency and decrease throughput when receiving
254 254 packets, but should be done if a hardware bug is suspected.
255 255 .Ed
256 256 .It Sy rx_dma_threshold
257 257 .Bd -filled -compact
258 258 Minimum:
259 259 .Sy 0 |
260 260 Maximum:
261 261 .Sy INT32_MAX |
262 262 Runtime Property:
263 -.Sy _rx_dma_treshold
263 +.Sy _rx_dma_threshold
264 264 .Ed
265 265 .Bd -filled
266 266 The
267 -.Sy rx_dma_treshold
267 +.Sy rx_dma_threshold
268 268 indicates the size in bytes of a received frame, including all of its
269 269 headers, at which the driver should not copy the frame but instead bind
270 270 DMA memory.
271 271 By setting this property to its minimum, all frames will be processed with DMA
272 272 binding.
273 273 By setting this property to its maximum, all frames will be processed by copying
274 274 the frame.
275 275 .Ed
276 276 .It Sy tx_lso_enable
277 277 .Bd -filled -compact
278 278 Minimum:
279 279 .Sy 0 |
280 280 Maximum:
281 281 .Sy 1
282 282 .Ed
283 283 .Bd -filled
284 284 The
285 285 .Sy tx_lso_enable
286 286 property controls whether or not the device enables support for Large Segment
287 287 Offloand (LSO) when transmitting packets.
288 288 The default is to always enable support for this.
289 289 Turning it off will decrease throughput when transmitting packets, but should
290 290 be done if a hardware bug is suspected.
291 291 .Ed
292 292 .El
|
↓ open down ↓ |
15 lines elided |
↑ open up ↑ |
293 293 .Sh ARCHITECTURE
294 294 The
295 295 .Nm
296 296 driver is only supported on
297 297 .Sy x86
298 298 systems at this time.
299 299 .Sh FILES
300 300 .Bl -tag -width Pa
301 301 .It Pa /dev/net/i40e*
302 302 Per-instance character device.
303 -.It Pa /kernel/drv/i40e
304 -32-bit device driver (x86).
305 303 .It Pa /kernel/drv/amd64/i40e
306 -64-bit device driver (x86).
304 +Device driver (x86)
307 305 .It Pa /kernel/drv/i40e.conf
308 -Driver configuration file.
306 +Driver configuration file
309 307 .El
310 308 .Sh SEE ALSO
311 309 .Xr dladm 1M ,
312 310 .Xr snoop 1M ,
313 311 .Xr driver.conf 4 ,
314 312 .Xr dlpi 7P
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX