-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Changes from 23.11.0 to 24.02.0: * Added Heartbeat support. * Added support for QAT GEN 5 devices, including support for a range of crypto wireless algorithms. * RAS - Device error reset and recovery handling. * Bug fixes (See Resolved section in README.md) Signed-off-by: Firos Sadarul <[email protected]>
- Loading branch information
1 parent
abe15d7
commit ec81762
Showing
98 changed files
with
4,002 additions
and
666 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,7 +6,7 @@ Reference | |
| ========= | ||
|
|
||
|
|
||
| - Intel® Communications Chipset 4xxx Series Software for Linux* | ||
| - Intel® Communications Chipset 4xxx/4xxxx Series Software for Linux* | ||
| Getting Started Guide | ||
|
|
||
| =============================================================================== | ||
|
|
@@ -70,13 +70,15 @@ Check System Prerequisites | |
| 4xxx : Use "lspci -d 8086:4940" to check Physical Function (PF) | ||
| devices are present. | ||
| 401xx : Use "lspci -d 8086:4942" to check PF devices are present. | ||
| 420xx : Use "lspci -d 8086:4946" to check PF devices are present. | ||
| Note: Later, after "systemctl start qat" or "make install" steps, the | ||
| corresponding Virtual Function devices will also be visible and bound | ||
| to the vfio-pci driver. | ||
| 4xxx : Use "lspci -d 8086:4941" to check VF devices have been created. | ||
| 401xx : Use "lspci -d 8086:4943" to check VF devices have been created. | ||
| 420xx : Use "lspci -d 8086:4947" to check VF devices have been created. | ||
| * firmware must be available | ||
| Check that these files exist: | ||
| For 4xxx or 401xx devices check that these files exist: | ||
| /lib/firmware/qat_4xxx.bin or /lib/firmware/qat_4xxx.bin.xz | ||
| /lib/firmware/qat_4xxx_mmp.bin or /lib/firmware/qat_4xxx_mmp.bin.xz | ||
| If not, download the firmware images from linux-firmware and copy them | ||
|
|
@@ -85,17 +87,23 @@ Check System Prerequisites | |
| wget https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/plain/qat_4xxx_mmp.bin | ||
| sudo mv qat_4xxx.bin /lib/firmware | ||
| sudo mv qat_4xxx_mmp.bin /lib/firmware | ||
| On updating these files run "sudo dracut --force" to update initramfs. | ||
| For 420xx, these firmware files are needed: | ||
| /lib/firmware/qat_420xx.bin | ||
| /lib/firmware/qat_420xx_mmp.bin | ||
| If not present please contact [email protected] | ||
| On updating any firmware files run "sudo dracut --force" to update | ||
| initramfs. | ||
| * kernel driver must be running | ||
| Use "lsmod | grep qat" to check that these kernel modules are running: | ||
| intel_qat | ||
| qat_4xxx | ||
| qat_4xxx or qat_420xx | ||
| They should load by default if using any of the following: | ||
| * A recent Linux kernel (see https://intel.github.io/quickassist/qatlib/requirements.html#kernel-firmware-requirements ) | ||
| * Fedora 36+ | ||
| * Fedora 36+ (39+ for 420xx) | ||
| * RHEL 8.4+ (for compression use 9.0+) | ||
| * each PF device must be bound to the 4xxx driver | ||
| Use "ls /sys/bus/pci/drivers/4xxx/" to show the BDFs of each bound PF | ||
| * each PF device must be bound to the 4xxx or 420xx driver | ||
| Use "cd /sys/bus/pci/drivers; ls 4xxx; ls 420xx" to show the BDFs of | ||
| each bound PF | ||
| * BIOS settings | ||
| Intel VT-d and SR-IOV must be enabled in the platform BIOS. | ||
| Consult your platform guide on how to do this. | ||
|
|
@@ -367,7 +375,9 @@ Compilation and installation - detailed instructions | |
|
|
||
| In Managed mode, qatmgr manages allocation of the VF resources to | ||
| each process on process startup. | ||
| The following parameters can be set in /etc/sysconfig/qat: | ||
| A sample config file can be found in quickassist/utilities/service/qat. | ||
| it can be copied to /etc/sysconfig/qat and used to set the following | ||
| parameters: | ||
|
|
||
| POLICY | ||
| Indicates how many VFs will be assigned to each process. | ||
|
|
@@ -572,7 +582,7 @@ Compilation and installation - detailed instructions | |
| continue | ||
| fi | ||
|
|
||
| if [ "$did" != "0x4941" ] && [ "$did" != "0x4943" ]; then | ||
| if [ "$did" != "0x4941" ] && [ "$did" != "0x4943" ] && [ "$did" != "0x4947" ]; then | ||
| continue | ||
| fi | ||
|
|
||
|
|
@@ -661,6 +671,9 @@ Full list of Configuration options | |
| --enable-dc-error-simulation | ||
| Enables Data Compression Error Simulation. | ||
|
|
||
| --enable-hb-error-simulation | ||
| Enables Heartbeat Error Simulation. | ||
|
|
||
| --enable-legacy-lib-names | ||
| Enables legacy names for libraries. | ||
|
|
||
|
|
@@ -719,10 +732,12 @@ Common issues | |
| bound to qat_4xxx: | ||
| sudo lspci -vvd:4940 | grep "Kernel driver in use". | ||
| sudo lspci -vvd:4942 | grep "Kernel driver in use" | ||
| sudo lspci -vvd:4946 | grep "Kernel driver in use" | ||
| upgrade to a recent Linux Kernel. | ||
| (2) No VFs available. Check VFs are available and bound to vfio-pci | ||
| sudo lspci -vvd:4941 | grep "Kernel driver in use" | ||
| sudo lspci -vvd:4943 | grep "Kernel driver in use" | ||
| sudo lspci -vvd:4947 | grep "Kernel driver in use" | ||
|
|
||
| Issue: On running ./autogen.sh following warning appears: | ||
| aclocal: warning: couldn't open directory 'm4': No such file or dir... | ||
|
|
@@ -786,6 +801,14 @@ Common issues | |
| extra 's'. Sorry if it causes confusion. | ||
| Fix: sudo make samples-uninstall | ||
|
|
||
| Issue: on Ubuntu on make install, this error may be seen: | ||
| “Failed to start qat.service: Unit qat.service not found.” | ||
| Likely cause: The qat.service file is not installed by Ubuntu in the | ||
| expected directory | ||
| Fix: Explicitly configure the systemd path to where Ubuntu has installed | ||
| the qat.service, e.g. | ||
| ./configure --enable-service systemdsystemunitdir=/lib/systemd/system/ | ||
|
|
||
| =============================================================================== | ||
|
|
||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
| # Process this file with autoconf to produce a configure script. | ||
|
|
||
| AC_PREREQ([2.69]) | ||
| AC_INIT([qatlib], [23.11.0], [[email protected]]) | ||
| AC_INIT([qatlib], [24.02.0], [[email protected]]) | ||
| AM_INIT_AUTOMAKE([-Wall -Werror -Wno-portability foreign subdir-objects tar-pax]) | ||
|
|
||
| AM_SILENT_RULES([yes]) | ||
|
|
@@ -11,7 +11,7 @@ AC_USE_SYSTEM_EXTENSIONS | |
| AC_CONFIG_MACRO_DIRS([m4]) | ||
| AC_CONFIG_HEADERS([config.h]) | ||
|
|
||
| AC_SUBST([LIBQAT_VERSION], [5:0:1]) | ||
| AC_SUBST([LIBQAT_VERSION], [6:0:2]) | ||
| AC_SUBST([LIBUSDM_VERSION], [1:0:1]) | ||
|
|
||
| # Checks for programs. | ||
|
|
@@ -220,6 +220,13 @@ AC_ARG_ENABLE(dc-error-simulation, | |
| ) | ||
| AM_CONDITIONAL([ICP_DC_ERROR_SIMULATION_AC], [test x$dc_error_simulation = xtrue]) | ||
|
|
||
| # ICP_HB_ERROR_SIMULATION | ||
| AC_ARG_ENABLE(hb-error-simulation, | ||
| AS_HELP_STRING([--enable-hb-error-simulation], [Enables Heartbeat Error Simulation.]), | ||
| [hb_error_simulation=true], [hb_error_simulation=false] | ||
| ) | ||
| AM_CONDITIONAL([ICP_HB_ERROR_SIMULATION_AC], [test x$hb_error_simulation = xtrue]) | ||
|
|
||
| AC_ARG_ENABLE(legacy-lib-names, | ||
| AS_HELP_STRING([--enable-legacy-lib-names], [Enables legacy names for libraries.]), | ||
| [ | ||
|
|
||
Oops, something went wrong.