Merge tag 'printk-for-4.20' of git://git.kernel.org/pub/scm/linux/kernel/git/pmladek...
[linux-2.6-microblaze.git] / Documentation / networking / i40e.rst
1 .. SPDX-License-Identifier: GPL-2.0+
2
3 Linux* Base Driver for the Intel(R) Ethernet Controller 700 Series
4 ==================================================================
5
6 Intel 40 Gigabit Linux driver.
7 Copyright(c) 1999-2018 Intel Corporation.
8
9 Contents
10 ========
11
12 - Overview
13 - Identifying Your Adapter
14 - Intel(R) Ethernet Flow Director
15 - Additional Configurations
16 - Known Issues
17 - Support
18
19
20 Driver information can be obtained using ethtool, lspci, and ifconfig.
21 Instructions on updating ethtool can be found in the section Additional
22 Configurations later in this document.
23
24 For questions related to hardware requirements, refer to the documentation
25 supplied with your Intel adapter. All hardware requirements listed apply to use
26 with Linux.
27
28
29 Identifying Your Adapter
30 ========================
31 The driver is compatible with devices based on the following:
32
33  * Intel(R) Ethernet Controller X710
34  * Intel(R) Ethernet Controller XL710
35  * Intel(R) Ethernet Network Connection X722
36  * Intel(R) Ethernet Controller XXV710
37
38 For the best performance, make sure the latest NVM/FW is installed on your
39 device.
40
41 For information on how to identify your adapter, and for the latest NVM/FW
42 images and Intel network drivers, refer to the Intel Support website:
43 https://www.intel.com/support
44
45 SFP+ and QSFP+ Devices
46 ----------------------
47 For information about supported media, refer to this document:
48 https://www.intel.com/content/dam/www/public/us/en/documents/release-notes/xl710-ethernet-controller-feature-matrix.pdf
49
50 NOTE: Some adapters based on the Intel(R) Ethernet Controller 700 Series only
51 support Intel Ethernet Optics modules. On these adapters, other modules are not
52 supported and will not function.  In all cases Intel recommends using Intel
53 Ethernet Optics; other modules may function but are not validated by Intel.
54 Contact Intel for supported media types.
55
56 NOTE: For connections based on Intel(R) Ethernet Controller 700 Series, support
57 is dependent on your system board. Please see your vendor for details.
58
59 NOTE: In systems that do not have adequate airflow to cool the adapter and
60 optical modules, you must use high temperature optical modules.
61
62 Virtual Functions (VFs)
63 -----------------------
64 Use sysfs to enable VFs. For example::
65
66   #echo $num_vf_enabled > /sys/class/net/$dev/device/sriov_numvfs #enable VFs
67   #echo 0 > /sys/class/net/$dev/device/sriov_numvfs #disable VFs
68
69 For example, the following instructions will configure PF eth0 and the first VF
70 on VLAN 10::
71
72   $ ip link set dev eth0 vf 0 vlan 10
73
74 VLAN Tag Packet Steering
75 ------------------------
76 Allows you to send all packets with a specific VLAN tag to a particular SR-IOV
77 virtual function (VF). Further, this feature allows you to designate a
78 particular VF as trusted, and allows that trusted VF to request selective
79 promiscuous mode on the Physical Function (PF).
80
81 To set a VF as trusted or untrusted, enter the following command in the
82 Hypervisor::
83
84   # ip link set dev eth0 vf 1 trust [on|off]
85
86 Once the VF is designated as trusted, use the following commands in the VM to
87 set the VF to promiscuous mode.
88
89 ::
90
91   For promiscuous all:
92   #ip link set eth2 promisc on
93   Where eth2 is a VF interface in the VM
94
95   For promiscuous Multicast:
96   #ip link set eth2 allmulticast on
97   Where eth2 is a VF interface in the VM
98
99 NOTE: By default, the ethtool priv-flag vf-true-promisc-support is set to
100 "off",meaning that promiscuous mode for the VF will be limited. To set the
101 promiscuous mode for the VF to true promiscuous and allow the VF to see all
102 ingress traffic, use the following command::
103
104   #ethtool -set-priv-flags p261p1 vf-true-promisc-support on
105
106 The vf-true-promisc-support priv-flag does not enable promiscuous mode; rather,
107 it designates which type of promiscuous mode (limited or true) you will get
108 when you enable promiscuous mode using the ip link commands above. Note that
109 this is a global setting that affects the entire device. However,the
110 vf-true-promisc-support priv-flag is only exposed to the first PF of the
111 device. The PF remains in limited promiscuous mode (unless it is in MFP mode)
112 regardless of the vf-true-promisc-support setting.
113
114 Now add a VLAN interface on the VF interface::
115
116   #ip link add link eth2 name eth2.100 type vlan id 100
117
118 Note that the order in which you set the VF to promiscuous mode and add the
119 VLAN interface does not matter (you can do either first). The end result in
120 this example is that the VF will get all traffic that is tagged with VLAN 100.
121
122 Intel(R) Ethernet Flow Director
123 -------------------------------
124 The Intel Ethernet Flow Director performs the following tasks:
125
126 - Directs receive packets according to their flows to different queues.
127 - Enables tight control on routing a flow in the platform.
128 - Matches flows and CPU cores for flow affinity.
129 - Supports multiple parameters for flexible flow classification and load
130   balancing (in SFP mode only).
131
132 NOTE: The Linux i40e driver supports the following flow types: IPv4, TCPv4, and
133 UDPv4. For a given flow type, it supports valid combinations of IP addresses
134 (source or destination) and UDP/TCP ports (source and destination). For
135 example, you can supply only a source IP address, a source IP address and a
136 destination port, or any combination of one or more of these four parameters.
137
138 NOTE: The Linux i40e driver allows you to filter traffic based on a
139 user-defined flexible two-byte pattern and offset by using the ethtool user-def
140 and mask fields. Only L3 and L4 flow types are supported for user-defined
141 flexible filters. For a given flow type, you must clear all Intel Ethernet Flow
142 Director filters before changing the input set (for that flow type).
143
144 To enable or disable the Intel Ethernet Flow Director::
145
146   # ethtool -K ethX ntuple <on|off>
147
148 When disabling ntuple filters, all the user programmed filters are flushed from
149 the driver cache and hardware. All needed filters must be re-added when ntuple
150 is re-enabled.
151
152 To add a filter that directs packet to queue 2, use -U or -N switch::
153
154   # ethtool -N ethX flow-type tcp4 src-ip 192.168.10.1 dst-ip \
155   192.168.10.2 src-port 2000 dst-port 2001 action 2 [loc 1]
156
157 To set a filter using only the source and destination IP address::
158
159   # ethtool -N ethX flow-type tcp4 src-ip 192.168.10.1 dst-ip \
160   192.168.10.2 action 2 [loc 1]
161
162 To see the list of filters currently present::
163
164   # ethtool <-u|-n> ethX
165
166 Application Targeted Routing (ATR) Perfect Filters
167 --------------------------------------------------
168 ATR is enabled by default when the kernel is in multiple transmit queue mode.
169 An ATR Intel Ethernet Flow Director filter rule is added when a TCP-IP flow
170 starts and is deleted when the flow ends. When a TCP-IP Intel Ethernet Flow
171 Director rule is added from ethtool (Sideband filter), ATR is turned off by the
172 driver. To re-enable ATR, the sideband can be disabled with the ethtool -K
173 option. For example::
174
175   ethtool –K [adapter] ntuple [off|on]
176
177 If sideband is re-enabled after ATR is re-enabled, ATR remains enabled until a
178 TCP-IP flow is added. When all TCP-IP sideband rules are deleted, ATR is
179 automatically re-enabled.
180
181 Packets that match the ATR rules are counted in fdir_atr_match stats in
182 ethtool, which also can be used to verify whether ATR rules still exist.
183
184 Sideband Perfect Filters
185 ------------------------
186 Sideband Perfect Filters are used to direct traffic that matches specified
187 characteristics. They are enabled through ethtool's ntuple interface. To add a
188 new filter use the following command::
189
190   ethtool -U <device> flow-type <type> src-ip <ip> dst-ip <ip> src-port <port> \
191   dst-port <port> action <queue>
192
193 Where:
194   <device> - the ethernet device to program
195   <type> - can be ip4, tcp4, udp4, or sctp4
196   <ip> - the ip address to match on
197   <port> - the port number to match on
198   <queue> - the queue to direct traffic towards (-1 discards matching traffic)
199
200 Use the following command to display all of the active filters::
201
202   ethtool -u <device>
203
204 Use the following command to delete a filter::
205
206   ethtool -U <device> delete <N>
207
208 Where <N> is the filter id displayed when printing all the active filters, and
209 may also have been specified using "loc <N>" when adding the filter.
210
211 The following example matches TCP traffic sent from 192.168.0.1, port 5300,
212 directed to 192.168.0.5, port 80, and sends it to queue 7::
213
214   ethtool -U enp130s0 flow-type tcp4 src-ip 192.168.0.1 dst-ip 192.168.0.5 \
215   src-port 5300 dst-port 80 action 7
216
217 For each flow-type, the programmed filters must all have the same matching
218 input set. For example, issuing the following two commands is acceptable::
219
220   ethtool -U enp130s0 flow-type ip4 src-ip 192.168.0.1 src-port 5300 action 7
221   ethtool -U enp130s0 flow-type ip4 src-ip 192.168.0.5 src-port 55 action 10
222
223 Issuing the next two commands, however, is not acceptable, since the first
224 specifies src-ip and the second specifies dst-ip::
225
226   ethtool -U enp130s0 flow-type ip4 src-ip 192.168.0.1 src-port 5300 action 7
227   ethtool -U enp130s0 flow-type ip4 dst-ip 192.168.0.5 src-port 55 action 10
228
229 The second command will fail with an error. You may program multiple filters
230 with the same fields, using different values, but, on one device, you may not
231 program two tcp4 filters with different matching fields.
232
233 Matching on a sub-portion of a field is not supported by the i40e driver, thus
234 partial mask fields are not supported.
235
236 The driver also supports matching user-defined data within the packet payload.
237 This flexible data is specified using the "user-def" field of the ethtool
238 command in the following way:
239
240 +----------------------------+--------------------------+
241 | 31    28    24    20    16 | 15    12    8    4    0  |
242 +----------------------------+--------------------------+
243 | offset into packet payload | 2 bytes of flexible data |
244 +----------------------------+--------------------------+
245
246 For example,
247
248 ::
249
250   ... user-def 0x4FFFF ...
251
252 tells the filter to look 4 bytes into the payload and match that value against
253 0xFFFF. The offset is based on the beginning of the payload, and not the
254 beginning of the packet. Thus
255
256 ::
257
258   flow-type tcp4 ... user-def 0x8BEAF ...
259
260 would match TCP/IPv4 packets which have the value 0xBEAF 8 bytes into the
261 TCP/IPv4 payload.
262
263 Note that ICMP headers are parsed as 4 bytes of header and 4 bytes of payload.
264 Thus to match the first byte of the payload, you must actually add 4 bytes to
265 the offset. Also note that ip4 filters match both ICMP frames as well as raw
266 (unknown) ip4 frames, where the payload will be the L3 payload of the IP4 frame.
267
268 The maximum offset is 64. The hardware will only read up to 64 bytes of data
269 from the payload. The offset must be even because the flexible data is 2 bytes
270 long and must be aligned to byte 0 of the packet payload.
271
272 The user-defined flexible offset is also considered part of the input set and
273 cannot be programmed separately for multiple filters of the same type. However,
274 the flexible data is not part of the input set and multiple filters may use the
275 same offset but match against different data.
276
277 To create filters that direct traffic to a specific Virtual Function, use the
278 "action" parameter. Specify the action as a 64 bit value, where the lower 32
279 bits represents the queue number, while the next 8 bits represent which VF.
280 Note that 0 is the PF, so the VF identifier is offset by 1. For example::
281
282   ... action 0x800000002 ...
283
284 specifies to direct traffic to Virtual Function 7 (8 minus 1) into queue 2 of
285 that VF.
286
287 Note that these filters will not break internal routing rules, and will not
288 route traffic that otherwise would not have been sent to the specified Virtual
289 Function.
290
291 Setting the link-down-on-close Private Flag
292 -------------------------------------------
293 When the link-down-on-close private flag is set to "on", the port's link will
294 go down when the interface is brought down using the ifconfig ethX down command.
295
296 Use ethtool to view and set link-down-on-close, as follows::
297
298   ethtool --show-priv-flags ethX
299   ethtool --set-priv-flags ethX link-down-on-close [on|off]
300
301 Viewing Link Messages
302 ---------------------
303 Link messages will not be displayed to the console if the distribution is
304 restricting system messages. In order to see network driver link messages on
305 your console, set dmesg to eight by entering the following::
306
307   dmesg -n 8
308
309 NOTE: This setting is not saved across reboots.
310
311 Jumbo Frames
312 ------------
313 Jumbo Frames support is enabled by changing the Maximum Transmission Unit (MTU)
314 to a value larger than the default value of 1500.
315
316 Use the ifconfig command to increase the MTU size. For example, enter the
317 following where <x> is the interface number::
318
319   ifconfig eth<x> mtu 9000 up
320
321 Alternatively, you can use the ip command as follows::
322
323   ip link set mtu 9000 dev eth<x>
324   ip link set up dev eth<x>
325
326 This setting is not saved across reboots. The setting change can be made
327 permanent by adding 'MTU=9000' to the file::
328
329   /etc/sysconfig/network-scripts/ifcfg-eth<x> // for RHEL
330   /etc/sysconfig/network/<config_file> // for SLES
331
332 NOTE: The maximum MTU setting for Jumbo Frames is 9702. This value coincides
333 with the maximum Jumbo Frames size of 9728 bytes.
334
335 NOTE: This driver will attempt to use multiple page sized buffers to receive
336 each jumbo packet. This should help to avoid buffer starvation issues when
337 allocating receive packets.
338
339 ethtool
340 -------
341 The driver utilizes the ethtool interface for driver configuration and
342 diagnostics, as well as displaying statistical information. The latest ethtool
343 version is required for this functionality. Download it at:
344 https://www.kernel.org/pub/software/network/ethtool/
345
346 Supported ethtool Commands and Options for Filtering
347 ----------------------------------------------------
348 -n --show-nfc
349   Retrieves the receive network flow classification configurations.
350
351 rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6
352   Retrieves the hash options for the specified network traffic type.
353
354 -N --config-nfc
355   Configures the receive network flow classification.
356
357 rx-flow-hash tcp4|udp4|ah4|esp4|sctp4|tcp6|udp6|ah6|esp6|sctp6 m|v|t|s|d|f|n|r...
358   Configures the hash options for the specified network traffic type.
359
360 udp4 UDP over IPv4
361 udp6 UDP over IPv6
362
363 f Hash on bytes 0 and 1 of the Layer 4 header of the Rx packet.
364 n Hash on bytes 2 and 3 of the Layer 4 header of the Rx packet.
365
366 Speed and Duplex Configuration
367 ------------------------------
368 In addressing speed and duplex configuration issues, you need to distinguish
369 between copper-based adapters and fiber-based adapters.
370
371 In the default mode, an Intel(R) Ethernet Network Adapter using copper
372 connections will attempt to auto-negotiate with its link partner to determine
373 the best setting. If the adapter cannot establish link with the link partner
374 using auto-negotiation, you may need to manually configure the adapter and link
375 partner to identical settings to establish link and pass packets. This should
376 only be needed when attempting to link with an older switch that does not
377 support auto-negotiation or one that has been forced to a specific speed or
378 duplex mode. Your link partner must match the setting you choose. 1 Gbps speeds
379 and higher cannot be forced. Use the autonegotiation advertising setting to
380 manually set devices for 1 Gbps and higher.
381
382 NOTE: You cannot set the speed for devices based on the Intel(R) Ethernet
383 Network Adapter XXV710 based devices.
384
385 Speed, duplex, and autonegotiation advertising are configured through the
386 ethtool* utility.
387
388 Caution: Only experienced network administrators should force speed and duplex
389 or change autonegotiation advertising manually. The settings at the switch must
390 always match the adapter settings. Adapter performance may suffer or your
391 adapter may not operate if you configure the adapter differently from your
392 switch.
393
394 An Intel(R) Ethernet Network Adapter using fiber-based connections, however,
395 will not attempt to auto-negotiate with its link partner since those adapters
396 operate only in full duplex and only at their native speed.
397
398 NAPI
399 ----
400 NAPI (Rx polling mode) is supported in the i40e driver.
401 For more information on NAPI, see
402 https://wiki.linuxfoundation.org/networking/napi
403
404 Flow Control
405 ------------
406 Ethernet Flow Control (IEEE 802.3x) can be configured with ethtool to enable
407 receiving and transmitting pause frames for i40e. When transmit is enabled,
408 pause frames are generated when the receive packet buffer crosses a predefined
409 threshold. When receive is enabled, the transmit unit will halt for the time
410 delay specified when a pause frame is received.
411
412 NOTE: You must have a flow control capable link partner.
413
414 Flow Control is on by default.
415
416 Use ethtool to change the flow control settings.
417
418 To enable or disable Rx or Tx Flow Control::
419
420   ethtool -A eth? rx <on|off> tx <on|off>
421
422 Note: This command only enables or disables Flow Control if auto-negotiation is
423 disabled. If auto-negotiation is enabled, this command changes the parameters
424 used for auto-negotiation with the link partner.
425
426 To enable or disable auto-negotiation::
427
428   ethtool -s eth? autoneg <on|off>
429
430 Note: Flow Control auto-negotiation is part of link auto-negotiation. Depending
431 on your device, you may not be able to change the auto-negotiation setting.
432
433 RSS Hash Flow
434 -------------
435 Allows you to set the hash bytes per flow type and any combination of one or
436 more options for Receive Side Scaling (RSS) hash byte configuration.
437
438 ::
439
440   # ethtool -N <dev> rx-flow-hash <type> <option>
441
442 Where <type> is:
443   tcp4  signifying TCP over IPv4
444   udp4  signifying UDP over IPv4
445   tcp6  signifying TCP over IPv6
446   udp6  signifying UDP over IPv6
447 And <option> is one or more of:
448   s     Hash on the IP source address of the Rx packet.
449   d     Hash on the IP destination address of the Rx packet.
450   f     Hash on bytes 0 and 1 of the Layer 4 header of the Rx packet.
451   n     Hash on bytes 2 and 3 of the Layer 4 header of the Rx packet.
452
453 MAC and VLAN anti-spoofing feature
454 ----------------------------------
455 When a malicious driver attempts to send a spoofed packet, it is dropped by the
456 hardware and not transmitted.
457 NOTE: This feature can be disabled for a specific Virtual Function (VF)::
458
459   ip link set <pf dev> vf <vf id> spoofchk {off|on}
460
461 IEEE 1588 Precision Time Protocol (PTP) Hardware Clock (PHC)
462 ------------------------------------------------------------
463 Precision Time Protocol (PTP) is used to synchronize clocks in a computer
464 network. PTP support varies among Intel devices that support this driver. Use
465 "ethtool -T <netdev name>" to get a definitive list of PTP capabilities
466 supported by the device.
467
468 IEEE 802.1ad (QinQ) Support
469 ---------------------------
470 The IEEE 802.1ad standard, informally known as QinQ, allows for multiple VLAN
471 IDs within a single Ethernet frame. VLAN IDs are sometimes referred to as
472 "tags," and multiple VLAN IDs are thus referred to as a "tag stack." Tag stacks
473 allow L2 tunneling and the ability to segregate traffic within a particular
474 VLAN ID, among other uses.
475
476 The following are examples of how to configure 802.1ad (QinQ)::
477
478   ip link add link eth0 eth0.24 type vlan proto 802.1ad id 24
479   ip link add link eth0.24 eth0.24.371 type vlan proto 802.1Q id 371
480
481 Where "24" and "371" are example VLAN IDs.
482
483 NOTES:
484   Receive checksum offloads, cloud filters, and VLAN acceleration are not
485   supported for 802.1ad (QinQ) packets.
486
487 VXLAN and GENEVE Overlay HW Offloading
488 --------------------------------------
489 Virtual Extensible LAN (VXLAN) allows you to extend an L2 network over an L3
490 network, which may be useful in a virtualized or cloud environment. Some
491 Intel(R) Ethernet Network devices perform VXLAN processing, offloading it from
492 the operating system. This reduces CPU utilization.
493
494 VXLAN offloading is controlled by the Tx and Rx checksum offload options
495 provided by ethtool. That is, if Tx checksum offload is enabled, and the
496 adapter has the capability, VXLAN offloading is also enabled.
497
498 Support for VXLAN and GENEVE HW offloading is dependent on kernel support of
499 the HW offloading features.
500
501 Multiple Functions per Port
502 ---------------------------
503 Some adapters based on the Intel Ethernet Controller X710/XL710 support
504 multiple functions on a single physical port. Configure these functions through
505 the System Setup/BIOS.
506
507 Minimum TX Bandwidth is the guaranteed minimum data transmission bandwidth, as
508 a percentage of the full physical port link speed, that the partition will
509 receive. The bandwidth the partition is awarded will never fall below the level
510 you specify.
511
512 The range for the minimum bandwidth values is:
513 1 to ((100 minus # of partitions on the physical port) plus 1)
514 For example, if a physical port has 4 partitions, the range would be:
515 1 to ((100 - 4) + 1 = 97)
516
517 The Maximum Bandwidth percentage represents the maximum transmit bandwidth
518 allocated to the partition as a percentage of the full physical port link
519 speed. The accepted range of values is 1-100. The value is used as a limiter,
520 should you chose that any one particular function not be able to consume 100%
521 of a port's bandwidth (should it be available). The sum of all the values for
522 Maximum Bandwidth is not restricted, because no more than 100% of a port's
523 bandwidth can ever be used.
524
525 NOTE: X710/XXV710 devices fail to enable Max VFs (64) when Multiple Functions
526 per Port (MFP) and SR-IOV are enabled. An error from i40e is logged that says
527 "add vsi failed for VF N, aq_err 16". To workaround the issue, enable less than
528 64 virtual functions (VFs).
529
530 Data Center Bridging (DCB)
531 --------------------------
532 DCB is a configuration Quality of Service implementation in hardware. It uses
533 the VLAN priority tag (802.1p) to filter traffic. That means that there are 8
534 different priorities that traffic can be filtered into. It also enables
535 priority flow control (802.1Qbb) which can limit or eliminate the number of
536 dropped packets during network stress. Bandwidth can be allocated to each of
537 these priorities, which is enforced at the hardware level (802.1Qaz).
538
539 Adapter firmware implements LLDP and DCBX protocol agents as per 802.1AB and
540 802.1Qaz respectively. The firmware based DCBX agent runs in willing mode only
541 and can accept settings from a DCBX capable peer. Software configuration of
542 DCBX parameters via dcbtool/lldptool are not supported.
543
544 NOTE: Firmware LLDP can be disabled by setting the private flag disable-fw-lldp.
545
546 The i40e driver implements the DCB netlink interface layer to allow user-space
547 to communicate with the driver and query DCB configuration for the port.
548
549 NOTE:
550 The kernel assumes that TC0 is available, and will disable Priority Flow
551 Control (PFC) on the device if TC0 is not available. To fix this, ensure TC0 is
552 enabled when setting up DCB on your switch.
553
554 Interrupt Rate Limiting
555 -----------------------
556 :Valid Range: 0-235 (0=no limit)
557
558 The Intel(R) Ethernet Controller XL710 family supports an interrupt rate
559 limiting mechanism. The user can control, via ethtool, the number of
560 microseconds between interrupts.
561
562 Syntax::
563
564   # ethtool -C ethX rx-usecs-high N
565
566 The range of 0-235 microseconds provides an effective range of 4,310 to 250,000
567 interrupts per second. The value of rx-usecs-high can be set independently of
568 rx-usecs and tx-usecs in the same ethtool command, and is also independent of
569 the adaptive interrupt moderation algorithm. The underlying hardware supports
570 granularity in 4-microsecond intervals, so adjacent values may result in the
571 same interrupt rate.
572
573 One possible use case is the following::
574
575   # ethtool -C ethX adaptive-rx off adaptive-tx off rx-usecs-high 20 rx-usecs \
576     5 tx-usecs 5
577
578 The above command would disable adaptive interrupt moderation, and allow a
579 maximum of 5 microseconds before indicating a receive or transmit was complete.
580 However, instead of resulting in as many as 200,000 interrupts per second, it
581 limits total interrupts per second to 50,000 via the rx-usecs-high parameter.
582
583 Performance Optimization
584 ========================
585 Driver defaults are meant to fit a wide variety of workloads, but if further
586 optimization is required we recommend experimenting with the following settings.
587
588 NOTE: For better performance when processing small (64B) frame sizes, try
589 enabling Hyper threading in the BIOS in order to increase the number of logical
590 cores in the system and subsequently increase the number of queues available to
591 the adapter.
592
593 Virtualized Environments
594 ------------------------
595 1. Disable XPS on both ends by using the included virt_perf_default script
596 or by running the following command as root::
597
598   for file in `ls /sys/class/net/<ethX>/queues/tx-*/xps_cpus`;
599   do echo 0 > $file; done
600
601 2. Using the appropriate mechanism (vcpupin) in the vm, pin the cpu's to
602 individual lcpu's, making sure to use a set of cpu's included in the
603 device's local_cpulist: /sys/class/net/<ethX>/device/local_cpulist.
604
605 3. Configure as many Rx/Tx queues in the VM as available. Do not rely on
606 the default setting of 1.
607
608
609 Non-virtualized Environments
610 ----------------------------
611 Pin the adapter's IRQs to specific cores by disabling the irqbalance service
612 and using the included set_irq_affinity script. Please see the script's help
613 text for further options.
614
615 - The following settings will distribute the IRQs across all the cores evenly::
616
617   # scripts/set_irq_affinity -x all <interface1> , [ <interface2>, ... ]
618
619 - The following settings will distribute the IRQs across all the cores that are
620   local to the adapter (same NUMA node)::
621
622   # scripts/set_irq_affinity -x local <interface1> ,[ <interface2>, ... ]
623
624 For very CPU intensive workloads, we recommend pinning the IRQs to all cores.
625
626 For IP Forwarding: Disable Adaptive ITR and lower Rx and Tx interrupts per
627 queue using ethtool.
628
629 - Setting rx-usecs and tx-usecs to 125 will limit interrupts to about 8000
630   interrupts per second per queue.
631
632 ::
633
634   # ethtool -C <interface> adaptive-rx off adaptive-tx off rx-usecs 125 \
635     tx-usecs 125
636
637 For lower CPU utilization: Disable Adaptive ITR and lower Rx and Tx interrupts
638 per queue using ethtool.
639
640 - Setting rx-usecs and tx-usecs to 250 will limit interrupts to about 4000
641   interrupts per second per queue.
642
643 ::
644
645   # ethtool -C <interface> adaptive-rx off adaptive-tx off rx-usecs 250 \
646     tx-usecs 250
647
648 For lower latency: Disable Adaptive ITR and ITR by setting Rx and Tx to 0 using
649 ethtool.
650
651 ::
652
653   # ethtool -C <interface> adaptive-rx off adaptive-tx off rx-usecs 0 \
654     tx-usecs 0
655
656 Application Device Queues (ADq)
657 -------------------------------
658 Application Device Queues (ADq) allows you to dedicate one or more queues to a
659 specific application. This can reduce latency for the specified application,
660 and allow Tx traffic to be rate limited per application. Follow the steps below
661 to set ADq.
662
663 1. Create traffic classes (TCs). Maximum of 8 TCs can be created per interface.
664 The shaper bw_rlimit parameter is optional.
665
666 Example: Sets up two tcs, tc0 and tc1, with 16 queues each and max tx rate set
667 to 1Gbit for tc0 and 3Gbit for tc1.
668
669 ::
670
671   # tc qdisc add dev <interface> root mqprio num_tc 2 map 0 0 0 0 1 1 1 1
672   queues 16@0 16@16 hw 1 mode channel shaper bw_rlimit min_rate 1Gbit 2Gbit
673   max_rate 1Gbit 3Gbit
674
675 map: priority mapping for up to 16 priorities to tcs (e.g. map 0 0 0 0 1 1 1 1
676 sets priorities 0-3 to use tc0 and 4-7 to use tc1)
677
678 queues: for each tc, <num queues>@<offset> (e.g. queues 16@0 16@16 assigns
679 16 queues to tc0 at offset 0 and 16 queues to tc1 at offset 16. Max total
680 number of queues for all tcs is 64 or number of cores, whichever is lower.)
681
682 hw 1 mode channel: ‘channel’ with ‘hw’ set to 1 is a new new hardware
683 offload mode in mqprio that makes full use of the mqprio options, the
684 TCs, the queue configurations, and the QoS parameters.
685
686 shaper bw_rlimit: for each tc, sets minimum and maximum bandwidth rates.
687 Totals must be equal or less than port speed.
688
689 For example: min_rate 1Gbit 3Gbit: Verify bandwidth limit using network
690 monitoring tools such as ifstat or sar –n DEV [interval] [number of samples]
691
692 2. Enable HW TC offload on interface::
693
694     # ethtool -K <interface> hw-tc-offload on
695
696 3. Apply TCs to ingress (RX) flow of interface::
697
698     # tc qdisc add dev <interface> ingress
699
700 NOTES:
701  - Run all tc commands from the iproute2 <pathtoiproute2>/tc/ directory.
702  - ADq is not compatible with cloud filters.
703  - Setting up channels via ethtool (ethtool -L) is not supported when the
704    TCs are configured using mqprio.
705  - You must have iproute2 latest version
706  - NVM version 6.01 or later is required.
707  - ADq cannot be enabled when any the following features are enabled: Data
708    Center Bridging (DCB), Multiple Functions per Port (MFP), or Sideband
709    Filters.
710  - If another driver (for example, DPDK) has set cloud filters, you cannot
711    enable ADq.
712  - Tunnel filters are not supported in ADq. If encapsulated packets do
713    arrive in non-tunnel mode, filtering will be done on the inner headers.
714    For example, for VXLAN traffic in non-tunnel mode, PCTYPE is identified
715    as a VXLAN encapsulated packet, outer headers are ignored. Therefore,
716    inner headers are matched.
717  - If a TC filter on a PF matches traffic over a VF (on the PF), that
718    traffic will be routed to the appropriate queue of the PF, and will
719    not be passed on the VF. Such traffic will end up getting dropped higher
720    up in the TCP/IP stack as it does not match PF address data.
721  - If traffic matches multiple TC filters that point to different TCs,
722    that traffic will be duplicated and sent to all matching TC queues.
723    The hardware switch mirrors the packet to a VSI list when multiple
724    filters are matched.
725
726
727 Known Issues/Troubleshooting
728 ============================
729
730 NOTE: 1 Gb devices based on the Intel(R) Ethernet Network Connection X722 do
731 not support the following features:
732
733   * Data Center Bridging (DCB)
734   * QOS
735   * VMQ
736   * SR-IOV
737   * Task Encapsulation offload (VXLAN, NVGRE)
738   * Energy Efficient Ethernet (EEE)
739   * Auto-media detect
740
741 Unexpected Issues when the device driver and DPDK share a device
742 ----------------------------------------------------------------
743 Unexpected issues may result when an i40e device is in multi driver mode and
744 the kernel driver and DPDK driver are sharing the device. This is because
745 access to the global NIC resources is not synchronized between multiple
746 drivers. Any change to the global NIC configuration (writing to a global
747 register, setting global configuration by AQ, or changing switch modes) will
748 affect all ports and drivers on the device. Loading DPDK with the
749 "multi-driver" module parameter may mitigate some of the issues.
750
751 TC0 must be enabled when setting up DCB on a switch
752 ---------------------------------------------------
753 The kernel assumes that TC0 is available, and will disable Priority Flow
754 Control (PFC) on the device if TC0 is not available. To fix this, ensure TC0 is
755 enabled when setting up DCB on your switch.
756
757
758 Support
759 =======
760 For general information, go to the Intel support website at:
761
762 https://www.intel.com/support/
763
764 or the Intel Wired Networking project hosted by Sourceforge at:
765
766 https://sourceforge.net/projects/e1000
767
768 If an issue is identified with the released source code on a supported kernel
769 with a supported adapter, email the specific information related to the issue
770 to e1000-devel@lists.sf.net.