-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathice.7
5835 lines (5830 loc) · 147 KB
/
ice.7
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "ICE" "7" "December 09, 2024" "" "Linux ice readme"
.SH NAME
ice \- ice Linux* Base Driver for the Intel(R) Ethernet 800 Series
.SS Contents
.INDENT 0.0
.IP \(bu 2
\fI\%ice Linux* Base Driver for the Intel(R) Ethernet 800 Series\fP
.INDENT 2.0
.IP \(bu 2
\fI\%Overview\fP
.IP \(bu 2
\fI\%Related Documentation\fP
.IP \(bu 2
\fI\%Identifying Your Adapter\fP
.IP \(bu 2
\fI\%Important Notes\fP
.IP \(bu 2
\fI\%Building and Installation\fP
.IP \(bu 2
\fI\%Command Line Parameters\fP
.IP \(bu 2
\fI\%Additional Features and Configurations\fP
.IP \(bu 2
\fI\%Performance Optimization\fP
.IP \(bu 2
\fI\%Known Issues/Troubleshooting\fP
.IP \(bu 2
\fI\%Support\fP
.IP \(bu 2
\fI\%License\fP
.IP \(bu 2
\fI\%Trademarks\fP
.UNINDENT
.UNINDENT
.SH OVERVIEW
.sp
This driver supports Linux* kernel versions 3.10.0 and newer. However, some
features may require a newer kernel version. The associated Virtual Function
(VF) driver for this driver is iavf. The associated RDMA driver for this driver
is irdma.
.sp
Driver information can be obtained using ethtool, devlink, lspci, and ip.
Instructions on updating ethtool can be found in the section Additional
Configurations later in this document.
.sp
This driver is only supported as a loadable module at this time. Intel is not
supplying patches against the kernel source to allow for static linking of the
drivers.
.sp
For questions related to hardware requirements, refer to the documentation
supplied with your Intel adapter. All hardware requirements listed apply to use
with Linux.
.sp
This driver supports XDP (Express Data Path) on kernel 4.14 and later and
AF_XDP zero\-copy on kernel 4.18 and later. Note that XDP is blocked for frame
sizes larger than 3KB.
.SH RELATED DOCUMENTATION
.sp
See the \(dqIntel(R) Ethernet Adapters and Devices User Guide\(dq for additional
information on features. It is available on the Intel website at
\fI\%https://cdrdv2.intel.com/v1/dl/getContent/705831\fP\&.
.SH IDENTIFYING YOUR ADAPTER
.sp
The driver is compatible with devices based on the following:
.INDENT 0.0
.IP \(bu 2
Intel(R) Ethernet Controller E810\-C
.IP \(bu 2
Intel(R) Ethernet Controller E810\-XXV
.IP \(bu 2
Intel(R) Ethernet Connection E822\-C
.IP \(bu 2
Intel(R) Ethernet Connection E822\-L
.IP \(bu 2
Intel(R) Ethernet Connection E823\-C
.IP \(bu 2
Intel(R) Ethernet Connection E823\-L
.IP \(bu 2
Intel(R) Ethernet Controller E830
.UNINDENT
.sp
For information on how to identify your adapter, and for the latest Intel
network drivers, refer to the Intel Support website at
\fI\%https://www.intel.com/support\fP\&.
.SH IMPORTANT NOTES
.SS Configuring SR\-IOV for improved network security
.sp
In a virtualized environment, on Intel(R) Ethernet Network Adapters that
support SR\-IOV, the virtual function (VF) may be subject to malicious behavior.
Software\-generated layer two frames, like IEEE 802.3x (link flow control), IEEE
802.1Qbb (priority based flow\-control), and others of this type, are not
expected and can throttle traffic between the host and the virtual switch,
reducing performance. To resolve this issue, and to ensure isolation from
unintended traffic streams, configure all SR\-IOV enabled
ports for VLAN tagging from the administrative interface on the PF. This
configuration allows unexpected, and potentially malicious, frames to be
dropped.
.sp
See \fI\%Configuring VLAN Tagging on SR\-IOV Enabled Adapter Ports\fP later in this README for configuration
instructions.
.SS Do not unload port driver if VF with active VM is bound to it
.sp
Do not unload a port\(aqs driver if a Virtual Function (VF) with an active Virtual
Machine (VM) is bound to it. Doing so will cause the port to appear to hang.
Once the VM shuts down, or otherwise releases the VF, the command will complete.
.SS Firmware Recovery Mode
.sp
A device will enter Firmware Recovery mode if it detects a problem that
requires the firmware to be reprogrammed. When a device is in Firmware Recovery
mode it will not pass traffic or allow any configuration; you can only attempt
to recover the device\(aqs firmware. Refer to the \(dqIntel(R) Ethernet Adapters and
Devices User Guide\(dq for details on Firmware Recovery Mode and how to recover
from it.
.SS Important Notes for SR\-IOV, RDMA, and Link Aggregation
.sp
The VF driver will not block teaming/bonding/link aggregation, but this is not
a supported feature. Do not expect failover or load balancing on the VF
interface.
.sp
LAG and RDMA are compatible only in certain conditions. See the \fI\%RDMA (Remote Direct Memory Access)\fP
section later in this README for more information.
.sp
Bridging and MACVLAN are also affected by this. If you wish to use bridging or
MACVLAN with RDMA/SR\-IOV, you must set up bridging or MACVLAN before enabling
RDMA or SR\-IOV. If you are using bridging or MACVLAN in conjunction with SR\-IOV
and/or RDMA, and you want to remove the interface from the bridge or MACVLAN,
you must follow these steps:
.INDENT 0.0
.IP 1. 3
Remove RDMA if it is active
.IP 2. 3
Destroy SR\-IOV VFs if they exist
.IP 3. 3
Remove the interface from the bridge or MACVLAN
.IP 4. 3
Reactivate RDMA and recreate SR\-IOV VFs as needed
.UNINDENT
.SH BUILDING AND INSTALLATION
.sp
The ice driver requires the Dynamic Device Personalization (DDP) package file
to enable advanced features (such as dynamic tunneling, Intel(R) Ethernet Flow
Director, RSS, and ADQ, or others). The driver installation process installs
the default DDP package file and creates a soft link \fBice.pkg\fP to the physical
package \fBice\-x.x.x.x.pkg\fP in the firmware root directory (typically
\fB/lib/firmware/\fP or \fB/lib/firmware/updates/\fP). The driver install process
also puts both the driver module and the DDP file in the \fBinitramfs/initrd\fP
image.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
When the driver loads, it looks for \fBintel/ice/ddp/ice.pkg\fP in the
firmware root. If this file exists, the driver will download it into the
device. If not, the driver will go into Safe Mode where it will use the
configuration contained in the device\(aqs NVM. This is NOT a supported
configuration and many advanced features will not be functional. See
\fI\%Dynamic Device Personalization\fP later for more information.
.UNINDENT
.UNINDENT
.SS To manually build the driver
.INDENT 0.0
.IP 1. 3
Move the base driver tar file to the directory of your choice.
For example, use \fB/home/username/ice\fP or \fB/usr/local/src/ice\fP\&.
.IP 2. 3
Untar/unzip the archive, where \fB<x.x.x>\fP is the version number for the
driver tar file:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
tar zxf ice\-<x.x.x>.tar.gz
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
Change to the driver src directory, where \fB<x.x.x>\fP is the version number
for the driver tar:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
cd ice\-<x.x.x>/src/
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 4. 3
Compile the driver module:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
make install
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The binary will be installed as:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
/lib/modules/<KERNEL VER>/updates/drivers/net/ethernet/intel/ice/ice.ko
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The install location listed above is the default location. This may differ
for various Linux distributions.
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
To build the driver using the schema for unified ethtool statistics,
use the following command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
make CFLAGS_EXTRA=\(aq\-DUNIFIED_STATS\(aq install
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
To compile the driver with ADQ (Application Device Queues) flags
set, use the following command, where \fB<nproc>\fP is the number of logical
cores:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
make \-j<nproc> CFLAGS_EXTRA=\(aq\-DADQ_PERF_COUNTERS\(aq install
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
(This will also apply the above \fBmake install\fP command.)
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
You may see warnings from depmod related to unknown RDMA symbols
during the make of the out\-of\-tree base driver. These warnings are normal and
appear because the in\-tree RDMA driver will not work with the out\-of\-tree base
driver. To address the issue, you need to install the latest out\-of\-tree versions
of the base and RDMA drivers.
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
Some Linux distributions require you to manually regenerate initramfs/initrd
after installing the driver to allow the driver to properly load with the firmware
at boot time. Please refer to the distribution documentation for instructions.
.UNINDENT
.UNINDENT
.IP 5. 3
Load the module using the modprobe command.
.sp
To check the version of the driver and then load it:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
modinfo ice
modprobe ice
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Alternately, make sure that any older ice drivers are removed from the
kernel before loading the new module:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
rmmod ice; modprobe ice
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
To enable verbose debug messages in the kernel log, use the
dynamic debug feature (dyndbg). See \fI\%Dynamic Debug\fP later in this
README for more information.
.UNINDENT
.UNINDENT
.IP 6. 3
Assign an IP address to the interface by entering the following,
where \fB<ethX>\fP is the interface name that was shown in dmesg after
modprobe:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
ip address add <IP_address>/<netmask bits> dev <ethX>
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 7. 3
Verify that the interface works. Enter the following, where \fBIP_address\fP
is the IP address for another machine on the same subnet as the interface
that is being tested:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
ping <IP_address>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS To build a binary RPM package of this driver
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
RPM functionality has only been tested in Red Hat distributions.
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 1. 3
Run the following command, where \fB<x.x.x>\fP is the version number for the
driver tar file:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
rpmbuild \-tb ice\-<x.x.x>.tar.gz
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
For the build to work properly, the currently running kernel MUST
match the version and configuration of the installed kernel sources. If
you have just recompiled the kernel, reboot the system before building.
.UNINDENT
.UNINDENT
.IP 2. 3
After building the RPM, the last few lines of the tool output contain the
location of the RPM file that was built. Install the RPM with one of the
following commands, where \fB<RPM>\fP is the location of the RPM file:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
rpm \-Uvh <RPM>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
dnf/yum localinstall <RPM>
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
If your distribution or kernel does not contain inbox support for auxiliary
bus, you must also install the auxiliary RPM:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
rpm \-Uvh <ice RPM> <auxiliary RPM>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
dnf/yum localinstall <ice RPM> <auxiliary RPM>
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 3.0
.INDENT 3.5
On some distributions, the auxiliary RPM may fail to install due
to missing kernel\-devel headers. To workaround this issue, specify
\fB\-\-excludepath\fP during installation. For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
rpm \-Uvh auxiliary\-1.0.0\-1.x86_64.rpm \-\-excludepath=/lib/modules/3.10.0\-957.el7.x86_64/source/include/linux/auxiliary_bus.h
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
To compile the driver on some kernel/arch combinations, you may need to
install a package with the development version of libelf (e.g. libelf\-dev,
libelf\-devel, elfutils\-libelf\-devel).
.IP \(bu 2
When compiling an out\-of\-tree driver, details will vary by distribution.
However, you will usually need a kernel\-devel RPM or some RPM that provides
the kernel headers at a minimum. The RPM kernel\-devel will usually fill in
the link at \fB/lib/modules/\(aquname \-r\(aq/build\fP\&.
.UNINDENT
.UNINDENT
.UNINDENT
.SH COMMAND LINE PARAMETERS
.sp
The only command line parameter the ice driver supports is the debug parameter
that can control the default logging verbosity of the driver. (Note: dyndbg
also provides dynamic debug information.)
.sp
In general, use ethtool and other OS\-specific commands to configure
user\-changeable parameters after the driver is loaded.
.SH ADDITIONAL FEATURES AND CONFIGURATIONS
.SS ethtool
.sp
The driver utilizes the ethtool interface for driver configuration and
diagnostics, as well as displaying statistical information. The latest ethtool
version is required for this functionality. Download it at
\fI\%https://kernel.org/pub/software/network/ethtool/\fP\&.
.SS Viewing Link Messages
.sp
Link messages will not be displayed to the console if the distribution is
restricting system messages. In order to see network driver link messages on
your console, set dmesg to eight by entering the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
dmesg \-n 8
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This setting is not saved across reboots.
.UNINDENT
.UNINDENT
.SS Dynamic Device Personalization
.sp
Dynamic Device Personalization (DDP) allows you to change the packet processing
pipeline of a device by applying a profile package to the device at runtime.
Profiles can be used to, for example, add support for new protocols, change
existing protocols, or change default settings. DDP profiles can also be rolled
back without rebooting the system.
.sp
The ice driver automatically installs the default DDP package file during
driver installation.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
It\(aqs important to do \fBmake install\fP during initial ice driver
installation so that the driver loads the DDP package automatically.
.UNINDENT
.UNINDENT
.sp
The DDP package loads during device initialization. The driver looks for
\fBintel/ice/ddp/ice.pkg\fP in your firmware root (typically \fB/lib/firmware/\fP
or \fB/lib/firmware/updates/\fP) and checks that it contains a valid DDP package
file.
.sp
If the driver is unable to load the DDP package, the device will enter Safe
Mode. Safe Mode disables advanced and performance features and supports only
basic traffic and minimal functionality, such as updating the NVM or
downloading a new driver or DDP package. Safe Mode only applies to the affected
physical function and does not impact any other PFs. See the \(dqIntel(R) Ethernet
Adapters and Devices User Guide\(dq for more details on DDP and Safe Mode.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
If you encounter issues with the DDP package file, you may need to download
an updated driver or DDP package file. See the log messages for more
information.
.IP \(bu 2
The \fBice.pkg\fP file is a symbolic link to the default DDP package file
installed by the Linux\-firmware software package or the ice out\-of\-tree
driver installation.
.IP \(bu 2
You cannot update the DDP package if any PF drivers are already loaded. To
overwrite a package, unload all PFs and then reload the driver with the
new package.
.IP \(bu 2
Only the first loaded PF per device can download a package for that device.
.UNINDENT
.UNINDENT
.UNINDENT
.sp
You can install specific DDP package files for different physical devices in
the same system. To install a specific DDP package file:
.INDENT 0.0
.IP 1. 3
Download the DDP package file you want for your device.
.IP 2. 3
Rename the file \fBice\-xxxxxxxxxxxxxxxx.pkg\fP, where \fBxxxxxxxxxxxxxxxx\fP is
the unique 64\-bit PCI Express device serial number (in hex) of the device
you want the package downloaded on. The file name must include the complete
serial number (including leading zeros) and be all lowercase. For example,
if the 64\-bit serial number is b887a3ffffca0568, then the file name would be
\fBice\-b887a3ffffca0568.pkg\fP\&.
.UNINDENT
.INDENT 0.0
.INDENT 3.5
To find the serial number from the PCI bus address, you can use the following
command:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lspci \-vv \-s af:00.0 | grep \-i Serial
Capabilities: [150 v1] Device Serial Number b8\-87\-a3\-ff\-ff\-ca\-05\-68
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
You can use the following command to format the serial number without the
dashes:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
lspci \-vv \-s af:00.0 | grep \-i Serial | awk \(aq{print $7}\(aq | sed s/\-//g b887a3ffffca0568
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP 3. 3
Copy the renamed DDP package file to \fB/lib/firmware/updates/intel/ice/ddp/\fP\&.
If the directory does not yet exist, create it before copying the file.
.IP 4. 3
Unload all of the PFs on the device.
.IP 5. 3
Reload the driver with the new package.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The presence of a device\-specific DDP package file overrides the
loading of the default DDP package file (\fBice.pkg\fP).
.UNINDENT
.UNINDENT
.SS RDMA (Remote Direct Memory Access)
.sp
Remote Direct Memory Access, or RDMA, allows a network device to transfer data
directly to and from application memory on another system, increasing
throughput and lowering latency in certain networking environments.
.sp
The ice driver supports the following RDMA protocols:
.INDENT 0.0
.IP \(bu 2
iWARP (Internet Wide Area RDMA Protocol)
.IP \(bu 2
RoCEv2 (RDMA over Converged Ethernet)
.UNINDENT
.sp
The major difference is that iWARP performs RDMA over TCP, while RoCEv2 uses
UDP.
.sp
RDMA requires auxiliary bus support. Refer to \fI\%Auxiliary Bus\fP in this README
for more information.
.sp
Devices based on the Intel(R) Ethernet 800 Series do not support RDMA when
operating in multiport mode with more than 4 ports.
.sp
For detailed installation and configuration information for RDMA, see the
README file in the irdma driver tarball.
.SS RDMA in the VF
.sp
Devices based on the Intel(R) Ethernet 800 Series support RDMA in a Linux VF,
on supported Windows or Linux hosts.
.sp
The iavf driver supports the following RDMA protocols in the VF:
.INDENT 0.0
.IP \(bu 2
iWARP (Internet Wide Area RDMA Protocol)
.IP \(bu 2
RoCEv2 (RDMA over Converged Ethernet)
.UNINDENT
.sp
Refer to the README inside the irdma driver tarball for details on configuring
RDMA in the VF.
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
To support VF RDMA, load the irdma driver on the host before creating
VFs. Otherwise VF RDMA support may not be negotiated between the VF and PF
driver.
.UNINDENT
.UNINDENT
.SS Auxiliary Bus
.sp
Inter\-Driver Communication (IDC) is the mechanism in which LAN drivers (such as
ice) communicate with peer drivers (such as irdma). Starting in kernel 5.11,
Intel LAN and RDMA drivers use an auxiliary bus mechanism for IDC.
.sp
RDMA functionality requires use of the auxiliary bus.
.sp
If your kernel supports the auxiliary bus, the LAN and RDMA drivers will use
the inbox auxiliary bus for IDC. For kernels lower than 5.11, the base driver
will automatically install an out\-of\-tree auxiliary bus module.
.SS NVM Express* (NVMe) over TCP and Fabrics
.sp
RDMA provides a high throughput, low latency means to directly access NVM
Express* (NVMe*) drives on a remote server.
.sp
Refer to the following configuration guides for details on supported operating
systems and how to set up and configure your server and client systems:
.INDENT 0.0
.IP \(bu 2
NVM Express over TCP for Intel(R) Ethernet Products Configuration Guide
.IP \(bu 2
NVM Express over Fabrics for Intel(R) Ethernet Products with RDMA
Configuration Guide
.UNINDENT
.sp
Both guides are available on the Intel Technical Library at:
\fI\%https://www.intel.com/content/www/us/en/design/products\-and\-solutions/networking\-and\-io/ethernet\-controller\-e810/technical\-library.html\fP
.SS Link Aggregation and RDMA
.sp
Link aggregation (LAG) and RDMA are compatible only if all the following are
true:
.INDENT 0.0
.IP \(bu 2
You are using an Intel Ethernet 810 Series device with the latest drivers and
NVM installed.
.IP \(bu 2
RDMA technology is set to RoCEv2.
.IP \(bu 2
LAG configuration is either active\-backup or active\-active.
.IP \(bu 2
Bonding is between two ports within the same device.
.IP \(bu 2
The QoS configuration of the two ports matches prior to the bonding of the
devices.
.UNINDENT
.sp
If the above conditions are not met:
.INDENT 0.0
.IP \(bu 2
The PF driver will not enable RDMA.
.IP \(bu 2
RDMA peers will not be able to register with the PF.
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
The first interface added to an aggregate (bond) is assigned as the
\(dqprimary\(dq interface for RDMA and LAG functionality. If LAN interfaces are
assigned to the bond and you remove the primary interface from the bond,
RDMA will not function properly over the bonded interface. To address the
issue, remove all interfaces from the bond and add them again. Interfaces
that are not assigned to the bond will operate normally.
.UNINDENT
.UNINDENT
.sp
If the ice driver is configured for active\-backup or active\-active LAG:
.INDENT 0.0
.IP \(bu 2
The ice driver will block any DCB/hardware QoS configuration changes on the
bonded ports.
.IP \(bu 2
Only the primary port is available for the RDMA driver.
.IP \(bu 2
The ice driver will forward RoCEv2 traffic from the secondary port to the
primary port by creating an appropriate switch rule.
.UNINDENT
.sp
If the ice driver is configured for active\-active LAG:
.INDENT 0.0
.IP \(bu 2
The ice driver will allow the RDMA driver to configure QSets for both active
ports.
.IP \(bu 2
A port failure on the active port will trigger a failover mechanism and move
the queue pairs to the currently active port. Once the port has recovered,
the RDMA driver will move RDMA QSets back to the originally allocated port.
.UNINDENT
.SS Application Device Queues (ADQ)
.sp
Application Device Queues (ADQ) allow you to dedicate one or more queues to a
specific application. This can reduce latency for the specified application,
and allow Tx traffic to be rate limited per application.
.sp
The ADQ information contained here is specific to the ice driver. For more
details, refer to the E810 ADQ Configuration Guide at
\fI\%https://cdrdv2.intel.com/v1/dl/getContent/609008\fP\&.
.sp
Requirements:
.INDENT 0.0
.IP \(bu 2
Kernel version: Varies by feature. Refer to the E810 ADQ Configuration Guide
for more information on required kernel versions for different ADQ features.
.IP \(bu 2
Operating system: Red Hat* Enterprise Linux* 7.5+ or SUSE* Linux Enterprise
Server* 12+
.IP \(bu 2
The latest ice driver and NVM image (Note: You must compile the ice driver
with the ADQ flag as shown in the \fI\%Building and Installation\fP section.)
.IP \(bu 2
The \fBsch_mqprio\fP, \fBact_mirred\fP, and \fBcls_flower\fP modules must be loaded.
For example:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
modprobe sch_mqprio
modprobe act_mirred
modprobe cls_flower
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
The latest version of iproute2
.sp
We recommend the following installation method:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
cd iproute2
\&./configure
make DESTDIR=/opt/iproute2 install
ln \-s /opt/iproute2/sbin/tc /usr/local/sbin/tc
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
When ADQ is enabled:
.INDENT 0.0
.IP \(bu 2
You cannot change RSS parameters, the number of queues, or the MAC address in
the PF or VF. Delete the ADQ configuration before changing these settings.
.IP \(bu 2
The driver supports subnet masks for IP addresses in the PF and VF. When you
add a subnet mask filter, the driver forwards packets to the ADQ VSI instead of
the main VSI.
.IP \(bu 2
When the PF adds or deletes a port VLAN filter for the VF, it will extend to
all the VSIs within that VF.
.IP \(bu 2
The driver supports ADQ and GTP filters in the PF. Note: You must have a DDP
package that supports GTP; the default OS package does not. Download the
appropriate package from your hardware vendor and load it on your device.
.IP \(bu 2
ADQ allows tc ingress filters that include any destination MAC address.
.IP \(bu 2
You can configure up to 256 queue pairs (256 MSI\-X interrupts) per PF.
.UNINDENT
.sp
See \fI\%Creating Traffic Class Filters\fP in this README for more information on
configuring filters, including examples. See the E810 ADQ Configuration Guide
for detailed instructions.
.sp
ADQ KNOWN ISSUES:
.INDENT 0.0
.IP \(bu 2
The latest RHEL and SLES distros have kernels with back\-ported support for
ADQ. For all other Linux distributions, you must use LTS Linux kernel v4.19.58
or higher to use ADQ. The latest out\-of\-tree driver is required for ADQ on all
operating systems.
.IP \(bu 2
You must clear ADQ configuration in the reverse order of the initial
configuration steps. Issues may result if you do not execute the steps to clear
ADQ configuration in the correct order.
.IP \(bu 2
ADQ configuration is not supported on a bonded or teamed ice interface.
Issuing the ethtool or tc commands to a bonded ice interface will result in
error messages from the ice driver to indicate the operation is not supported.
.IP \(bu 2
If the application stalls, the application\-specific queues may stall for up
to two seconds. Configuring only one application per Traffic Class (TC) channel
may resolve the issue.
.IP \(bu 2
DCB and ADQ cannot coexist. A switch with DCB enabled might remove the ADQ
configuration from the device. To resolve the issue, do not enable DCB on the
switch ports being used for ADQ. You must disable LLDP on the interface and
stop the firmware LLDP agent using the following command:
.INDENT 2.0
.INDENT 3.5
.sp
.nf
.ft C
ethtool \-\-set\-priv\-flags <ethX> fw\-lldp\-agent off
.ft P
.fi
.UNINDENT
.UNINDENT
.IP \(bu 2
MACVLAN offloads and ADQ are mutually exclusive. System instability may occur
if you enable \fBl2\-fwd\-offload\fP and then set up ADQ, or if you set up ADQ and
then enable \fBl2\-fwd\-offload\fP\&.
.IP \(bu 2
Note (unrelated to Intel drivers): The version 5.8.0 Linux kernel introduced
a bug that broke the interrupt affinity setting mechanism, which breaks the
ability to pin interrupts to ADQ hardware queues. Use an earlier or later
version of the Linux kernel.
.IP \(bu 2
A core\-level reset of an ADQ\-configured PF port (rare events usually
triggered by other failures in the device or ice driver) results in loss of ADQ
configuration. To recover, reapply the ADQ configuration to the PF interface.
.IP \(bu 2
Commands such as \fBtc qdisc add\fP and \fBethtool \-L\fP will cause the driver
to close the associated RDMA interface and reopen it. This will disrupt RDMA
traffic for 3\-5 seconds until the RDMA interface is available again for
traffic.
.IP \(bu 2
Commands such as \fBtc qdisc add\fP and \fBethtool \-L\fP will clear other tuning
settings such as interrupt affinity. These tuning settings will need to be
reapplied. When the number of queues are increased using \fBethtool \-L\fP, the
new queues will have the same interrupt moderation settings as queue 0 (i.e.,
Tx queue 0 for new Tx queues and Rx queue 0 for new Rx queues). You can change
this using the ethtool per\-queue coalesce commands.
.IP \(bu 2
TC filters may not get offloaded in hardware if you apply them immediately
after issuing the \fBtc qdisc add\fP command. We recommend you wait 5 seconds
after issuing \fBtc qdisc add\fP before adding TC filters. Dmesg will report
the error if TC filters fail to add properly.
.UNINDENT
.SS Setting Up ADQ
.sp
To set up the adapter for ADQ, where \fB<ethX>\fP is the interface in use:
.INDENT 0.0
.IP 1. 3
Reload the ice driver to remove any previous TC configuration:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
rmmod ice
modprobe ice
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 2. 3
Enable hardware TC offload on the interface:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
ethtool \-K <ethX> hw\-tc\-offload on
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 3. 3
Disable LLDP on the interface, if it isn\(aqt already:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
ethtool \-\-set\-priv\-flags <ethX> fw\-lldp\-agent off
.ft P
.fi
.UNINDENT
.UNINDENT
.IP 4. 3
Verify settings:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
ethtool \-k <ethX> | grep \(dqhw\-tc\(dq
ethtool \-\-show\-priv\-flags <ethX>
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.SS ADQ Configuration Script
.sp
Intel also provides a script to configure ADQ. This script allows you configure
ADQ\-specific parameters such as traffic classes, priority, filters, and ethtool
parameters.
.sp
Refer to the \fBREADME.md\fP file in \fBscripts/adqsetup\fP inside the driver
tarball for more information.
.sp
The script and README are also available as part of the Python Package Index
at \fI\%https://pypi.org/project/adqsetup\fP\&.
.SS Using ADQ with Independent Pollers
.sp
The ice driver supports ADQ acceleration using independent pollers. Independent
pollers are kernel threads invoked by interrupts and are used for busy polling
on behalf of the application.
.sp
You can configure the number of queues per poller and poller timeout per ADQ
traffic class (TC) or queue group using the \fBdevlink dev param\fP interface.
.sp