doc/qat: update QAT driver location
Checks
Commit Message
This commit removes any references to the old QAT
driver location 01.org in the documentation and
replaces them with the updated location intel.com.
This commit also adds a note to the docs to alert
users of a possible error when building the new QAT
driver and provides the patch needed to resolve this
error.
Signed-off-by: Rebecca Troy <rebecca.troy@intel.com>
---
doc/guides/cryptodevs/qat.rst | 108 ++++++++++++++++++++++------------
1 file changed, 71 insertions(+), 37 deletions(-)
Comments
> -----Original Message-----
> From: Troy, Rebecca <rebecca.troy@intel.com>
> Sent: Wednesday, June 22, 2022 11:35 AM
> To: Zhang, Roy Fan <roy.fan.zhang@intel.com>
> Cc: dev@dpdk.org; Troy, Rebecca <rebecca.troy@intel.com>
> Subject: [PATCH] doc/qat: update QAT driver location
>
> This commit removes any references to the old QAT
> driver location 01.org in the documentation and
> replaces them with the updated location intel.com.
>
> This commit also adds a note to the docs to alert
> users of a possible error when building the new QAT
> driver and provides the patch needed to resolve this
> error.
>
> Signed-off-by: Rebecca Troy <rebecca.troy@intel.com>
> ---
Acked-by: Fan Zhang <roy.fan.zhang@intel.com>
Thanks for sharing the update Roy.
Hello Rebecca,
Quick summary of the proposed updates:
1) update URL for the release notes doc 336211 v015 https://01.org/sites/default/files/downloads/336211-015-qatsoftwareforlinux-rn-hwv1.7-final.pdf
with 336211 v23 https://cdrdv2.intel.com/v1/dl/getContent/710057?explicitVersion=true
2) 01.org to be replaced by Intel Developer Zone(IDZ) for first usage. Subsequently, we can mention IDZ.
The URL for Intel QAT downloads, tech guides is developer.intel.com/quickassist
Best regards,
Catalin
-----Original Message-----
From: Zhang, Roy Fan <roy.fan.zhang@intel.com>
Sent: Wednesday, June 29, 2022 10:10 AM
To: Troy, Rebecca <rebecca.troy@intel.com>
Cc: dev@dpdk.org; Tataru, AlexandruX Catalin <alexandrux.catalin.tataru@intel.com>
Subject: RE: [PATCH] doc/qat: update QAT driver location
> -----Original Message-----
> From: Troy, Rebecca <rebecca.troy@intel.com>
> Sent: Wednesday, June 22, 2022 11:35 AM
> To: Zhang, Roy Fan <roy.fan.zhang@intel.com>
> Cc: dev@dpdk.org; Troy, Rebecca <rebecca.troy@intel.com>
> Subject: [PATCH] doc/qat: update QAT driver location
>
> This commit removes any references to the old QAT driver location
> 01.org in the documentation and replaces them with the updated
> location intel.com.
>
> This commit also adds a note to the docs to alert users of a possible
> error when building the new QAT driver and provides the patch needed
> to resolve this error.
>
> Signed-off-by: Rebecca Troy <rebecca.troy@intel.com>
> ---
Acked-by: Fan Zhang <roy.fan.zhang@intel.com>
@@ -369,35 +369,35 @@ to see the full table)
.. table:: QAT device generations, devices and drivers
- +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
- | S | A | C | Gen | Device | Driver/ver | Kernel Module | Pci Driver | PF Did | #PFs | VF Did | VFs/PF |
- +=====+=====+=====+=====+==========+===============+===============+============+========+======+========+========+
- | Yes | No | No | 1 | DH895xCC | linux/4.4+ | qat_dh895xcc | dh895xcc | 435 | 1 | 443 | 32 |
- +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
- | Yes | Yes | No | " | " | 01.org/4.2.0+ | " | " | " | " | " | " |
- +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
- | Yes | Yes | Yes | " | " | 01.org/4.3.0+ | " | " | " | " | " | " |
- +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
- | Yes | No | No | 2 | C62x | linux/4.5+ | qat_c62x | c6xx | 37c8 | 3 | 37c9 | 16 |
- +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
- | Yes | Yes | Yes | " | " | 01.org/4.2.0+ | " | " | " | " | " | " |
- +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
- | Yes | No | No | 2 | C3xxx | linux/4.5+ | qat_c3xxx | c3xxx | 19e2 | 1 | 19e3 | 16 |
- +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
- | Yes | Yes | Yes | " | " | 01.org/4.2.0+ | " | " | " | " | " | " |
- +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
- | Yes | No | No | 2 | 200xx | p | qat_200xx | 200xx | 18ee | 1 | 18ef | 16 |
- +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
- | Yes | No | No | 2 | D15xx | 01.org/4.2.0+ | qat_d15xx | d15xx | 6f54 | 1 | 6f55 | 16 |
- +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
- | Yes | No | No | 3 | C4xxx | p | qat_c4xxx | c4xxx | 18a0 | 1 | 18a1 | 128 |
- +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
- | Yes | No | No | 4 | 4xxx | N/A | qat_4xxx | 4xxx | 4940 | 4 | 4941 | 16 |
- +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
- | Yes | No | No | 4 | 401xxx | N/A | qat_401xxx | 4xxx | 4942 | 2 | 4943 | 16 |
- +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
-
-* Note: Symmetric mixed crypto algorithms feature on Gen 2 works only with 01.org driver version 4.9.0+
+ +-----+-----+-----+-----+----------+-------------------+---------------+------------+--------+------+--------+--------+
+ | S | A | C | Gen | Device | Driver/ver | Kernel Module | Pci Driver | PF Did | #PFs | VF Did | VFs/PF |
+ +=====+=====+=====+=====+==========+===================+===============+============+========+======+========+========+
+ | Yes | No | No | 1 | DH895xCC | linux/4.4+ | qat_dh895xcc | dh895xcc | 435 | 1 | 443 | 32 |
+ +-----+-----+-----+-----+----------+-------------------+---------------+------------+--------+------+--------+--------+
+ | Yes | Yes | No | " | " | intel.com/4.12.0+ | " | " | " | " | " | " |
+ +-----+-----+-----+-----+----------+-------------------+---------------+------------+--------+------+--------+--------+
+ | Yes | Yes | Yes | " | " | intel.com/4.13.0+ | " | " | " | " | " | " |
+ +-----+-----+-----+-----+----------+-------------------+---------------+------------+--------+------+--------+--------+
+ | Yes | No | No | 2 | C62x | linux/4.5+ | qat_c62x | c6xx | 37c8 | 3 | 37c9 | 16 |
+ +-----+-----+-----+-----+----------+-------------------+---------------+------------+--------+------+--------+--------+
+ | Yes | Yes | Yes | " | " | intel.com/4.12.0+ | " | " | " | " | " | " |
+ +-----+-----+-----+-----+----------+-------------------+---------------+------------+--------+------+--------+--------+
+ | Yes | No | No | 2 | C3xxx | linux/4.5+ | qat_c3xxx | c3xxx | 19e2 | 1 | 19e3 | 16 |
+ +-----+-----+-----+-----+----------+-------------------+---------------+------------+--------+------+--------+--------+
+ | Yes | Yes | Yes | " | " | intel.com/4.12.0+ | " | " | " | " | " | " |
+ +-----+-----+-----+-----+----------+-------------------+---------------+------------+--------+------+--------+--------+
+ | Yes | No | No | 2 | 200xx | p | qat_200xx | 200xx | 18ee | 1 | 18ef | 16 |
+ +-----+-----+-----+-----+----------+-------------------+---------------+------------+--------+------+--------+--------+
+ | Yes | No | No | 2 | D15xx | p | qat_d15xx | d15xx | 6f54 | 1 | 6f55 | 16 |
+ +-----+-----+-----+-----+----------+-------------------+---------------+------------+--------+------+--------+--------+
+ | Yes | No | No | 3 | C4xxx | p | qat_c4xxx | c4xxx | 18a0 | 1 | 18a1 | 128 |
+ +-----+-----+-----+-----+----------+-------------------+---------------+------------+--------+------+--------+--------+
+ | Yes | No | No | 4 | 4xxx | N/A | qat_4xxx | 4xxx | 4940 | 4 | 4941 | 16 |
+ +-----+-----+-----+-----+----------+-------------------+---------------+------------+--------+------+--------+--------+
+ | Yes | No | No | 4 | 401xxx | N/A | qat_401xxx | 4xxx | 4942 | 2 | 4943 | 16 |
+ +-----+-----+-----+-----+----------+-------------------+---------------+------------+--------+------+--------+--------+
+
+* Note: Symmetric mixed crypto algorithms feature on Gen 2 works only with intel.com driver version 4.9.0+
The first 3 columns indicate the service:
@@ -406,13 +406,13 @@ The first 3 columns indicate the service:
* C = Compression service (via compressdev API)
The ``Driver`` column indicates either the Linux kernel version in which
-support for this device was introduced or a driver available on Intel's 01.org
-website. There are both linux in-tree and 01.org kernel drivers available for some
+support for this device was introduced or a driver available on Intel's website
+intel.com. There are both linux in-tree and intel.com kernel drivers available for some
devices. p = release pending.
If you are running on a kernel which includes a driver for your device, see
`Installation using kernel.org driver`_ below. Otherwise see
-`Installation using 01.org QAT driver`_.
+`Installation using intel.com QAT driver`_.
Installation using kernel.org driver
@@ -485,12 +485,12 @@ To complete the installation follow the instructions in
``IOMMU should be enabled for SR-IOV to work correctly``.
-Installation using 01.org QAT driver
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Installation using intel.com QAT driver
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Download the latest QuickAssist Technology Driver from `01.org
-<https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_.
-Consult the *Getting Started Guide* at the same URL for further information.
+Download the latest QuickAssist Technology Driver from `intel.com
+<https://www.intel.com/content/www/us/en/developer/topic-technology/open/quick-assist-technology/overview.html>`_.
+Consult the *Quick Start Guide* at the same URL for further information.
The steps below assume you are:
@@ -579,6 +579,40 @@ To complete the installation - follow instructions in
sudo yum install kernel-src-`uname -r`
sudo yum install kernel-devel-`uname -r`
+.. Note::
+
+ If the build fails on newer GCC versions (such as GCC 12) with an error relating to
+ ``-lc`` not being found, apply the following patch:
+
+ .. code-block:: diff
+
+ /QAT/quickassist/lookaside/access_layer/src/Makefile
+ cd $(ICP_FINAL_OUTPUT_DIR);\
+ cmd="$(LINKER) $(LIB_SHARED_FLAGS) -o \
+ $(LIB_SHARED) $(ADDITIONAL_OBJECTS) $(ADDITIONAL_LIBS) *.o -lpthread -ludev \
+ - -Bstatic -L$(ADF_DIR)/src/build/$(ICP_OS)/$(ICP_OS_LEVEL) \
+ - -ladf_user -L$(OSAL_DIR)/src/build/$(ICP_OS)/$(ICP_OS_LEVEL)/ \
+ - -losal -Bdynamic -lc"; \
+ + -Bstatic -L$(ADF_DIR)/src/build/$(ICP_OS)/$(ICP_OS_LEVEL) \
+ + -ladf_user -L$(OSAL_DIR)/src/build/$(ICP_OS)/$(ICP_OS_LEVEL)/ \
+ + -losal -Bdynamic -L/lib/x86_64-linux-gnu/ -lc"; \
+ echo "$$cmd"; \
+ $$cmd
+
+ Followed by this patch:
+
+ .. code-block:: diff
+
+ /QAT/quickassist/build_system/build_files/OS/linux_common_user_space_rules.mk
+ @echo 'Creating shared library ${LIB_SHARED}'; \
+ cd $($(PROG_ACY)_FINAL_OUTPUT_DIR);\
+ - echo $(LINKER) $(LIB_SHARED_FLAGS) -o $@ $(OBJECTS) $(ADDITIONAL_OBJECTS) -lc;\
+ - $(LINKER) $(LIB_SHARED_FLAGS) -o $@ $(OBJECTS) $(ADDITIONAL_OBJECTS) -lc ;
+ + echo $(LINKER) $(LIB_SHARED_FLAGS) -o $@ $(OBJECTS) $(ADDITIONAL_OBJECTS) \
+ + -L/lib/x86_64-linux-gnu/ -lc;\
+ + $(LINKER) $(LIB_SHARED_FLAGS) -o $@ $(OBJECTS) $(ADDITIONAL_OBJECTS) \
+ + -L/lib/x86_64-linux-gnu/ -lc ;
+
Binding the available VFs to the vfio-pci driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~